openai/codex-securityCLI de Codex Security de OpenAI y SDK de TypeScript para encontrar, validar y corregir vulnerabilidades de seguridad. npm: https://www.npmjs.com/package/@openai/codex-security
Codex Security te ayuda a encontrar, investigar y corregir vulnerabilidades en tu código.
Usa sus flujos de trabajo de seguridad en Codex, o automatízalos con la
CLI @openai/codex-security y el SDK de TypeScript.
SECURITY.md y guarda modelos de amenazas para su revisión posterior.Abre tu repositorio en una sesión de Codex con el plugin de Codex Security habilitado, y luego solicita:
Ejecuta un escaneo de Codex Security en este repositorio, centrándote en la autenticación y la autorización. Devuelve el informe guardado, la evidencia de origen y los límites de cobertura.
Un escaneo completado guarda un informe, hallazgos, cobertura y un modelo de amenazas cuando esté disponible. Usa esos resultados para investigar hallazgos, solicitar un parche o verificar una corrección existente. Consulta la guía de flujos de trabajo del agente para la configuración del plugin, la selección de tareas y la recuperación cuando las herramientas requeridas no estén disponibles.
Requiere Node.js 22.13.0+ dentro de 22.x, o Node.js 24.x o 26.x, y Python 3.10+.
Python 3.10 también requiere tomli.
Instala la CLI globalmente e inicia sesión:
npm install --global @openai/codex-security
cs login
cs es un alias corto para codex-security; ambos comandos ejecutan la misma CLI.
La instalación crea ambos comandos en el directorio global de ejecutables de npm,
que debe estar en tu PATH. Si cs ya resuelve a otra herramienta, usa
codex-security en su lugar. Si npm se detiene con un error EEXIST para cs, usa
npx @openai/codex-security sin una instalación global.
Ejecuta tu escaneo desde el directorio del repositorio:
cs scan .
Si tienes acceso a Daybreak Blue, añade --cyber-access-program daybreak_blue
al comando de escaneo. De lo contrario, omite la opción o usa
--cyber-access-program standard.
Para usar el interruptor Daybreak de Codex, pasa --codex daybreak=true. Está desactivado por defecto
y requiere acceso compatible. Consulta Configuración de Daybreak
para el uso del SDK y de plugins, incluidos los workers de Deep Scan.
Los escaneos usan tu guía SECURITY.md existente. Para definirla o actualizarla,
opcionalmente redacta una política:
cs policy .
El borrador se guarda fuera de tu repositorio. Revisa el diff y las notas, edita el
borrador y luego copia solo SECURITY.md al destino de la política indicado. Puedes escanear
sin generar una política.
Para ejecutar sin una instalación global, reemplaza cs en estos ejemplos con
npx @openai/codex-security, por ejemplo:
npx @openai/codex-security scan .
Para CI, establece OPENAI_API_KEY o CODEX_API_KEY en el entorno del proceso de escaneo.
En máquinas remotas o sin interfaz gráfica, usa login --device-auth si tu espacio de trabajo
lo permite, o inicia sesión por SSH.
Algunas solicitudes de ciberseguridad y hallazgos protegidos requieren la aprobación de Trusted Access for Cyber.
Elige un alcance y un modo de escaneo:
# Scan selected paths.
cs scan . --path src --path tests
# Scan committed changes from a base revision to HEAD.
cs scan . --diff origin/main
# Run a deep scan of the repository.
cs scan . --mode deep
Use cs scan . --max-time 15 para una asignación de investigación Estándar orientativa de 15 minutos. Consulte investigation time para la semántica de tiempos y los límites de Deep Scan.
Use cs --help para explorar los comandos, o cs scan --help para las opciones de escaneo, los límites de coste y el parcheo después de un escaneo.
Para una aplicación distribuida entre repositorios, consulte review one system across repositories. Use bulk scans para revisiones independientes de repositorios en una única campaña reanudable.
Después de un escaneo, inspect its scope and follow-up work para comprender las exclusiones registradas y decidir si revisar los hallazgos, ejecutar un escaneo enfocado o recuperar una ejecución interrumpida.
Instale el paquete localmente en su proyecto de TypeScript:
npm install @openai/codex-security
Luego impórtalo:
import { CodexSecurity } from "@openai/codex-security";
const security = new CodexSecurity();
try {
const result = await security.run("/path/to/repository");
console.log(result.reportPath);
} finally {
await security.close();
}
La guía del SDK incluye la configuración de análisis profundo, validación, clasificación de severidad, sugerencias de propietarios y manejo de resultados.
Cuando Codex Security Cloud está disponible para tu cuenta, la habilidad $cloud-findings del plugin de Security puede leer hallazgos, informes, asignaciones y verificaciones registradas, y el estado de los escaneos en Codex desktop o en la CLI de Codex. Cloud es una conexión opcional; los escaneos locales funcionan sin ella.
Consulta Configuración de la conexión a Cloud y lecturas mediante CLI para conocer los requisitos de autenticación y un ejemplo de solo lectura.
Usa policy para redactar un nuevo SECURITY.md o actualizar uno existente. Usa --path para seleccionar un componente:
cs policy .
cs policy . --path services/api --knowledge-base architecture.md
El comando guarda su borrador fuera del repositorio y deja los archivos existentes
sin cambios. Revise el diff y las notas, edite el borrador y luego copie solo SECURITY.md
al Policy target mostrado. Mantenga los documentos de arquitectura y modelo de amenazas
guardados fuera del repositorio.
Los escaneos ya utilizan archivos SECURITY.md raíz y de componentes. Mantenga su política actual
si no necesita cambios. Al actualizarla, conserve sus instrucciones de notificación de vulnerabilidades. Si el comando indica que la política ya está actualizada, no se
necesita copia.