Anwendungsfall für Codex
Mehrere Repositorys scannen
Führe Sicherheitsscans in mehreren Repositorys durch und prüfe die Befunde und die Scanabdeckung.
Scanne mit der Codex Security CLI die Repositorys auf deiner Liste jeweils auf dem Stand eines bestimmten Commits. Prüfe jedes Ergebnis und entscheide, welche Befunde du genauer untersuchen und welche Probleme du beheben musst.
Besonders geeignet für
- Sicherheitsteams, die mehrere Dienste auf dem Stand bestimmter Commits prüfen.
- Entwicklungsteams, die ihre Repositorys nach einem einheitlichen Verfahren erfassen und für jedes Repository eigene Scanergebnisse benötigen.
- Alle, die bei der Prüfung mehrerer Repositorys entscheiden, welche Befunde und Lücken in der Scanabdeckung Vorrang haben.
Inhalt
Mehrere Repositorys scannen
Führe Sicherheitsscans in mehreren Repositorys durch und prüfe die Befunde und die Scanabdeckung.
Scanne mit der Codex Security CLI die Repositorys auf deiner Liste jeweils auf dem Stand eines bestimmten Commits. Prüfe jedes Ergebnis und entscheide, welche Befunde du genauer untersuchen und welche Probleme du beheben musst.
Scanne mit der Codex Security CLI die Repositorys auf deiner Liste jeweils auf dem Stand eines bestimmten Commits. Prüfe jedes Ergebnis und entscheide, welche Befunde du genauer untersuchen und welche Probleme du beheben musst.
Besonders geeignet für
- Sicherheitsteams, die mehrere Dienste auf dem Stand bestimmter Commits prüfen.
- Entwicklungsteams, die ihre Repositorys nach einem einheitlichen Verfahren erfassen und für jedes Repository eigene Scanergebnisse benötigen.
- Alle, die bei der Prüfung mehrerer Repositorys entscheiden, welche Befunde und Lücken in der Scanabdeckung Vorrang haben.
Bevor du beginnst
Folge der CLI-Schnellstartanleitung, um Codex Security zu installieren und dich zu authentifizieren. Prüfe, ob du Sicherheitsscans ausführen darfst und Git-Zugriff auf die Repositorys hast, die dir gehören oder die du prüfen darfst. Die Scans verwenden deine lokalen Berechtigungen und laufen ohne Rückfrage zur Genehmigung. Lies dazu die Hinweise zu Scanberechtigungen.
Repository-Liste vorbereiten
Beginne mit wenigen Repositorys. Speichere das folgende Beispiel als repositories.csv und ersetze anschließend die Beispiel-URLs und die Platzhalter für die Commits.
id,repository,revision
payments,https://github.com/YOUR-ORG/payments.git,REPLACE_WITH_FULL_COMMIT_SHA
identity,https://github.com/YOUR-ORG/identity.git,REPLACE_WITH_FULL_COMMIT_SHA
Gib für jedes Repository eine eindeutige id und den vollständigen SHA-Hash des Commits an. Mit folgendem Befehl ermittelst du den SHA-Hash in einem lokalen Checkout.
git -C /path/to/repository rev-parse HEAD
Jeder Scan prüft das gesamte Repository auf dem Stand des angegebenen Commits. Branch-Namen, verkürzte Hashes und nicht eingecheckte Änderungen sind in diesem Ablauf nicht vorgesehen. Wie du den Scan auf bestimmte Ordner beschränkst oder Anweisungen für einzelne Repositorys angibst, erfährst du in den CSV-Optionen.
Auswahl über GitHub: Du kannst Repositorys interaktiv auswählen, die zu deinem GitHub-Konto oder deiner GitHub-Organisation gehören. So sparst du dir das Erstellen der CSV-Datei.
Scans ausführen
Wechsle in das Verzeichnis mit der Datei repositories.csv. Ersetze im folgenden Befehl den Ausgabepfad durch den Pfad zu einem privaten Verzeichnis außerhalb der zu scannenden Repositorys und führe den Befehl aus.
npx @openai/codex-security bulk-scan repositories.csv \
--output-dir /path/outside/repositories/security-scans \
--workers 2 \
--mode standard \
--max-attempts 1 \
--max-cost 5
Damit laufen jeweils zwei Standardscans gleichzeitig, mit einem Versuch pro Repository. --max-cost 5 beendet einen Versuch, sobald die geschätzten Kosten für diesen Versuch 5 USD übersteigen. Bereits laufende Vorgänge können höhere Kosten verursachen als geschätzt. Der Wert ist daher weder eine feste Kostenobergrenze noch ein gemeinsames Budget für den gesamten Durchlauf. Lege die Werte vor dem Start fest.
Die CLI speichert die Ergebnisse für jedes Repository in einem eigenen Ordner unter security-scans/artifacts/. Halte die Ergebnisse vertraulich, da sie Auszüge aus dem Quellcode und Details zu Schwachstellen enthalten können.
Ergebnisse prüfen
Öffne das Ergebnisverzeichnis und prüfe folgende Punkte:
- Repository-Liste: Prüfe, ob
manifest.jsondie vorgesehenen Repositorys und Commits enthält. - Status: In
results.jsonlfindest du für jeden Versuch den Status und den Speicherort der Artefakte. - Abdeckung und Befunde: Prüfe im Ordner jedes Versuchs zuerst
coverage.jsonauf Lücken und Ausschlüsse. Lies anschließendreport.mdundfindings.json, um die Befunde und die zugehörigen Belege nachzuvollziehen.
Exit-Code 0 bedeutet, dass die Scans für alle Repositorys erfolgreich abgeschlossen wurden. Auch dann können Schwachstellen vorhanden sein. Exit-Code 2 weist auf eine unvollständige Abdeckung, einen nicht abgeschlossenen Scan eines Repositorys oder einen Eingabe- oder Laufzeitfehler hin. Bei unvollständiger Abdeckung belegt eine leere Befundliste nicht, dass der Code sicher ist.
Halte für jedes Repository den nächsten Schritt fest. Untersuche einen Befund, behebe eine zur Behebung angenommene Schwachstelle oder gehe Lücken in der Abdeckung nach. Gib bei der Übergabe an das zuständige Team den gescannten Commit und die zugehörigen Belege an.
Um einen unterbrochenen Durchlauf fortzusetzen, führe denselben Befehl mit derselben CSV-Datei, denselben Anweisungen und demselben Ausgabeverzeichnis erneut aus. Die CLI überspringt abgeschlossene Scans. Scans mit unvollständiger Abdeckung wiederholt sie nicht automatisch. Verwende ein neues Ausgabeverzeichnis, wenn du die Repository-Liste, die Revisionen, den Scanumfang, die Scanmodi oder die Anweisungen änderst. Weitere Einzelheiten findest du in den Hinweisen zum Fortsetzen und Wiederholen von Scans.
Verwandte Anwendungsfälle
Codeänderungen auf Sicherheitslücken prüfen
Mit dem Plugin für Codex Security kannst du Änderungen in einem Git-Repository untersuchen...
Einen umfassenden Sicherheitsscan durchführen
Mit dem Plugin für Codex Security kannst du ein Repository oder einen ausgewählten Ordner...
Führe deinen ersten Sicherheitsscan durch
Scanne mit dem Plugin für Codex Security ein lokales Repository