openai/codex-securityCLI Codex Security di OpenAI e SDK TypeScript per individuare, validare e correggere le vulnerabilità di sicurezza. npm: https://www.npmjs.com/package/@openai/codex-security
Codex Security ti aiuta a trovare, analizzare e correggere le vulnerabilità nel tuo codice.
Usa i suoi flussi di lavoro di sicurezza in Codex, oppure automatizzali con la
CLI @openai/codex-security e l'SDK TypeScript.
SECURITY.md e salva modelli di minaccia per revisioni future.Apri il tuo repository in una sessione Codex con il plugin Codex Security abilitato, poi chiedi:
Esegui una scansione Codex Security su questo repository, concentrandoti su autenticazione e autorizzazione. Restituisci il report salvato, le evidenze nel codice sorgente e i limiti di copertura.
Una scansione completata salva un report, i risultati, la copertura e un modello di minaccia quando disponibile. Usa questi risultati per analizzare i findings, richiedere una patch o verificare una correzione esistente. Consulta la guida ai flussi di lavoro dell'agente per la configurazione del plugin, la selezione delle attività e il recupero quando gli strumenti richiesti non sono disponibili.
Richiede Node.js 22.13.0+ all'interno della serie 22.x, oppure Node.js 24.x o 26.x, e Python 3.10+.
Python 3.10 richiede anche tomli.
Installa la CLI a livello globale e accedi:
npm install --global @openai/codex-security
cs login
cs è un alias breve per codex-security; entrambi i comandi eseguono la stessa CLI.
L'installazione crea entrambi i comandi nella directory degli eseguibili globali di npm,
che deve trovarsi nel tuo PATH. Se cs è già associato a un altro strumento, usa
codex-security invece. Se npm si interrompe con un errore EEXIST per cs, usa
npx @openai/codex-security senza un'installazione globale.
Esegui la tua scansione dalla directory del repository:
cs scan .
Se hai accesso a Daybreak Blue, aggiungi --cyber-access-program daybreak_blue
al comando di scansione. Altrimenti, ometti il flag o usa
--cyber-access-program standard.
Per usare l'interruttore Daybreak di Codex, passa --codex daybreak=true. È disattivato per impostazione predefinita
e richiede un accesso compatibile. Consulta Configurazione di Daybreak
per l'utilizzo con SDK e plugin, inclusi i worker Deep Scan.
Le scansioni utilizzano le indicazioni esistenti del tuo SECURITY.md. Per definirlo o aggiornarlo,
puoi facoltativamente redigere una policy:
cs policy .
La bozza viene salvata al di fuori del tuo repository. Esamina il diff e le note, modifica la bozza, quindi copia solo SECURITY.md nella Policy target indicata. Puoi eseguire la scansione senza generare una policy.
Per eseguire senza un'installazione globale, sostituisci cs in questi esempi con npx @openai/codex-security, ad esempio:
npx @openai/codex-security scan .
Per la CI, imposta OPENAI_API_KEY o CODEX_API_KEY nell'ambiente del processo di scansione.
Su macchine remote o headless, usa login --device-auth se il tuo workspace
lo consente, oppure accedi tramite SSH.
Alcune richieste di cybersecurity e risultati protetti richiedono l'approvazione di Trusted Access for Cyber.
Scegli un ambito e una modalità di scansione:
# 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
Usa cs scan . --max-time 15 per un'indagine Standard con un limite indicativo di 15 minuti. Consulta investigation time per la semantica temporale e i limiti di Deep Scan.
Usa cs --help per sfogliare i comandi, oppure cs scan --help per le opzioni di scansione, i limiti di costo e il patching dopo una scansione.
Per un'applicazione distribuita su più repository, consulta review one system across repositories. Usa le bulk scans per revisioni indipendenti dei repository in un'unica campagna ripristinabile.
Dopo una scansione, inspect its scope and follow-up work per comprendere le esclusioni registrate e decidere se revisionare i risultati, eseguire una scansione mirata o recuperare un'esecuzione interrotta.
Installa il pacchetto localmente nel tuo progetto TypeScript:
npm install @openai/codex-security
Poi importalo:
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 guida SDK include la configurazione della scansione approfondita, la validazione, la classificazione della gravità, i suggerimenti sui proprietari e la gestione dei risultati.
Quando Codex Security Cloud è disponibile per il tuo account, la skill $cloud-findings del plugin Security può leggere risultati, report, assegnazioni e verifiche registrate e lo stato delle scansioni in Codex desktop o nella Codex CLI. Cloud è una connessione opzionale; le scansioni locali funzionano senza di essa.
Consulta Configurazione della connessione Cloud e letture CLI per i requisiti di autenticazione e un esempio di sola lettura.
Usa policy per redigere un nuovo SECURITY.md o aggiornarne uno esistente. Usa --path per selezionare un componente:
cs policy .
cs policy . --path services/api --knowledge-base architecture.md
Il comando salva la sua bozza fuori dal repository e lascia invariati i file
esistenti. Rivedi il diff e le note, modifica la bozza, quindi copia solo SECURITY.md
nel Policy target visualizzato. Mantieni i documenti salvati di architettura e
modello di minaccia fuori dal repository.
Le scansioni utilizzano già i file SECURITY.md nella radice e nei componenti. Mantieni la tua policy attuale
se non necessita di modifiche. Quando la aggiorni, preserva le sue istruzioni
per la segnalazione delle vulnerabilità. Se il comando indica che la policy è già aggiornata, non è
necessaria alcuna copia.