Den vollständigen Index der Dokumentation findest du in llms.txt. Die Markdown-Version einer Dokumentationsseite erhältst du, indem du .md an die URL der Seite anhängst.
Hauptnavigation
Design

Codex Security in CI/CD im Überblick

Wähle eine CI-Integration, richte den Zugriff für Scans ein und lege fest, wie sich Befunde und Scanabdeckung auf deine Pipeline auswirken.

Mit Codex Security kannst du in deiner CI-Pipeline Änderungen in Pull Requests oder Merge Requests prüfen, deinen Standard-Branch scannen und Befunde sowie Angaben zur Scanabdeckung speichern. Die Anleitung für deinen CI-Anbieter beschreibt den Workflow, den Umgang mit Berichten und die Möglichkeiten zur Durchsetzung von Richtlinien.

Workflow vorbereiten

Für Scans brauchst du Zugriff auf Codex Security. Speichere einen API-Schlüssel von OpenAI unter dem Namen CODEX_SECURITY_API_KEY im Secret-Speicher deines CI-Anbieters. Übergib seinen Wert über die Umgebungsvariable OPENAI_API_KEY an den Scanprozess.

Scanne nur Repositorys und Änderungen, denen du vertraust. Scans laufen mit den lokalen Berechtigungen des Runners und warten nicht auf eine Genehmigung. Verwende separate Jobs für Zugangsdaten, die der Scan nicht benötigt, und für Deployment-Schritte.

Ein zugelassenes Daybreak-Modell verwenden

Für den Zugriff auf Daybreak Blue über Trusted Access for Cyber setze in der GitHub Action den Eingabeparameter model auf gpt-6-sol und cyber-access-program auf daybreak_blue. Wenn du Scans direkt über die CLI ausführst, verwende --model gpt-6-sol und --cyber-access-program daybreak_blue.

Verwende einen API-Schlüssel aus einem Projekt, für das Daybreak Blue aktiviert ist und das Zugriff auf das ausgewählte Modell hat. Die Auswahl des Modells oder Programms gewährt keinen Zugriff. Die Einstellungen für die Action findest du im Abschnitt Optionalen Zugriff auf Daybreak konfigurieren.

Integration auswählen

Workflow für GitHub Actions hinzufügen

Die Anleitung für GitHub Actions zeigt dir, wie du Pull Requests prüfst und zeitgesteuerte Repository-Scans einrichtest. Die Codex Security Action installiert die CLI, speichert Berichte und fügt eine Jobzusammenfassung sowie Anmerkungen zum Quellcode hinzu. Die Anleitung erklärt, wie du den Runner einrichtest, den optionalen Daybreak-Zugriff konfigurierst, SARIF-Berichte hochlädst und eine Richtlinie zum Schweregrad durchsetzt.

Pipeline für GitLab CI/CD hinzufügen

Die Anleitung für GitLab CI/CD zeigt dir, wie du Scans für Merge Requests, für den Standard-Branch und nach Zeitplan einrichtest. Beginne mit einer Pipeline, die nur Scans ausführt. Ergänze anschließend die Verarbeitung von Berichten, die Durchsetzung von Richtlinien und bei Bedarf die verifizierte Behebung von Schwachstellen.

Ein anderes CI-System verwenden

Installiere das öffentliche Paket @openai/codex-security und führe die CLI direkt aus. Verwende --auth api-key, wähle einen Repository- oder Diff-Scan und speichere die Ausgabe in einem privaten Verzeichnis außerhalb des Git-Worktrees. Dein Runner muss die Abhängigkeiten bereitstellen, die in der CLI-Kurzanleitung beschrieben sind.

In der CLI-Referenz findest du Informationen zu Scanoptionen, Revisionen für Diffs, Berichtsformaten, Verzeichnissen für Statusdaten und Ausgaben sowie zum Verhalten bei Wiederholungsversuchen.

Richtlinie zum Schweregrad festlegen

Nutze die Ergebnisse zunächst als Hinweise. Prüfe typische Befunde, die Scanabdeckung, die Kosten und die Laufzeit, bevor du festlegst, welche Ergebnisse einen Merge blockieren sollen.

Bewerte sowohl die Befunde als auch die Vollständigkeit des Scans. Die Richtlinie berücksichtigt Befunde aus dem aktuellen Scan, deren Schweregrad den konfigurierten Schwellenwert erreicht oder überschreitet. Frühere offene Befunde in der Repository-Zusammenfassung haben keinen Einfluss auf diese Richtlinie. Bei einem unvollständigen Scan können Bereiche ungeprüft bleiben, selbst wenn der Scan keine Befunde meldet.

Wie du die Durchsetzung der Richtlinie konfigurierst, erfährst du in der Anleitung für GitHub Actions oder in der Anleitung für GitLab CI/CD. Wenn du die CLI direkt integrierst, findest du weitere Informationen im Abschnitt Durchsetzung der Richtlinie zum Schweregrad und Exitcodes.