openai/codex-securityCLI Codex Security d'OpenAI et SDK TypeScript pour détecter, valider et corriger les vulnérabilités de sécurité. npm : https://www.npmjs.com/package/@openai/codex-security
Codex Security vous aide à trouver, analyser et corriger les vulnérabilités dans votre code.
Utilisez ses workflows de sécurité dans Codex, ou automatisez-les avec la
CLI @openai/codex-security et le SDK TypeScript.
SECURITY.md et enregistrez des modèles de menace pour un examen ultérieur.Ouvrez votre dépôt dans une session Codex avec le plugin Codex Security activé, puis demandez :
Lancez une analyse Codex Security sur ce dépôt, en vous concentrant sur l'authentification et l'autorisation. Renvoyez le rapport enregistré, les preuves sources et les limites de couverture.
Une analyse terminée enregistre un rapport, les constats, la couverture et un modèle de menace lorsqu'il est disponible. Utilisez ces résultats pour analyser les constats, demander un correctif ou vérifier une correction existante. Consultez le guide des workflows d'agent pour la configuration du plugin, la sélection des tâches et la récupération lorsque les outils requis sont indisponibles.
Nécessite Node.js 22.13.0+ dans la branche 22.x, ou Node.js 24.x ou 26.x, ainsi que Python 3.10+.
Python 3.10 nécessite également tomli.
Installez la CLI globalement et connectez-vous :
npm install --global @openai/codex-security
cs login
cs est un alias court pour codex-security ; les deux commandes exécutent la même CLI.
L'installation crée les deux commandes dans le répertoire des exécutables globaux de npm,
qui doit se trouver dans votre PATH. Si cs correspond déjà à un autre outil, utilisez
codex-security à la place. Si npm s'arrête avec une erreur EEXIST pour cs, utilisez
npx @openai/codex-security sans installation globale.
Lancez votre analyse depuis le répertoire du dépôt :
cs scan .
Si vous disposez d'un accès Daybreak Blue, ajoutez --cyber-access-program daybreak_blue
à la commande de scan. Sinon, omettez le flag ou utilisez
--cyber-access-program standard.
Pour utiliser le basculement Daybreak de Codex, passez --codex daybreak=true. Il est désactivé par défaut
et nécessite un accès compatible. Consultez Configuration de Daybreak
pour l'utilisation du SDK et des plugins, y compris les workers Deep Scan.
Les scans utilisent vos directives SECURITY.md existantes. Pour les définir ou les mettre à jour,
vous pouvez éventuellement rédiger une politique :
cs policy .
Le brouillon est enregistré en dehors de votre dépôt. Examinez le diff et les notes, modifiez le brouillon, puis copiez uniquement SECURITY.md vers la Policy target indiquée. Vous pouvez effectuer une analyse sans générer de politique.
Pour exécuter sans installation globale, remplacez cs dans ces exemples par npx @openai/codex-security, par exemple :
npx @openai/codex-security scan .
Pour la CI, définissez OPENAI_API_KEY ou CODEX_API_KEY dans l'environnement du processus de scan.
Sur les machines distantes ou sans interface graphique, utilisez login --device-auth si votre espace de travail
le permet, ou connectez-vous via SSH.
Certaines requêtes de cybersécurité et découvertes protégées nécessitent l'approbation Trusted Access for Cyber.
Choisissez une portée et un mode de scan :
# 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
Utilisez cs scan . --max-time 15 pour une allocation d'investigation Standard consultative de 15 minutes. Consultez investigation time pour la sémantique temporelle et les limites de Deep Scan.
Utilisez cs --help pour parcourir les commandes, ou cs scan --help pour les options de scan, les limites de coût et le patching après un scan.
Pour une application répartie sur plusieurs dépôts, consultez review one system across repositories. Utilisez les bulk scans pour des revues de dépôts indépendants dans une seule campagne reprenable.
Après un scan, inspect its scope and follow-up work pour comprendre les exclusions enregistrées et décider s'il faut examiner les résultats, lancer un scan ciblé ou récupérer une exécution interrompue.
Installez le paquet localement dans votre projet TypeScript :
npm install @openai/codex-security
Puis importez-le :
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();
}
Le guide du SDK couvre la configuration de l'analyse approfondie, la validation, la classification des gravités, les suggestions de responsables et la gestion des résultats.
Lorsque Codex Security Cloud est disponible pour votre compte, la compétence $cloud-findings du plugin Security peut lire les constats, les rapports, l'attribution et la vérification enregistrées, ainsi que l'état des analyses dans Codex desktop ou la CLI Codex. Cloud est une connexion facultative ; les analyses locales fonctionnent sans elle.
Consultez Configuration de la connexion Cloud et lectures via la CLI pour les exigences d'authentification et un exemple en lecture seule.
Utilisez policy pour rédiger un nouveau SECURITY.md ou mettre à jour un fichier existant. Utilisez --path pour sélectionner un composant :
cs policy .
cs policy . --path services/api --knowledge-base architecture.md