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

Anwendungsfall für Codex

Sicherheitsscans in der CI-Pipeline automatisieren

Scanne Pull Requests oder Commits auf main oder prüfe dein Repository nach Zeitplan.

Schwierigkeitsgrad Intermediate
Zeithorizont Long-running

Integriere die Codex Security CLI in deine CI-Pipeline. Lege fest, wann die Scans laufen und welchen Code sie prüfen. Halte fest, was die Scans abgedeckt und welche Befunde sie geliefert haben. Entscheide, wie sich die Ergebnisse auf die Auslieferung auswirken sollen.

Besonders geeignet für

  • Teams, die Sicherheitsprüfungen für Pull Requests oder Merge Requests einrichten.
  • Alle, die ein Repository pflegen und den Standard-Branch scannen, sobald Änderungen dort übernommen wurden.
  • Sicherheitsteams, die regelmäßige Sicherheitsprüfungen ihrer Repositorys planen.

Inhalt

    ← Alle Anwendungsfälle

    Sicherheitsscans in der CI-Pipeline automatisieren

    Scanne Pull Requests oder Commits auf main oder prüfe dein Repository nach Zeitplan.

    Integriere die Codex Security CLI in deine CI-Pipeline. Lege fest, wann die Scans laufen und welchen Code sie prüfen. Halte fest, was die Scans abgedeckt und welche Befunde sie geliefert haben. Entscheide, wie sich die Ergebnisse auf die Auslieferung auswirken sollen.

    Intermediate
    Long-running
    CI-Scans einrichten

    Integriere die Codex Security CLI in deine CI-Pipeline. Lege fest, wann die Scans laufen und welchen Code sie prüfen. Halte fest, was die Scans abgedeckt und welche Befunde sie geliefert haben. Entscheide, wie sich die Ergebnisse auf die Auslieferung auswirken sollen.

    Intermediate
    Long-running

    Besonders geeignet für

    • Teams, die Sicherheitsprüfungen für Pull Requests oder Merge Requests einrichten.
    • Alle, die ein Repository pflegen und den Standard-Branch scannen, sobald Änderungen dort übernommen wurden.
    • Sicherheitsteams, die regelmäßige Sicherheitsprüfungen ihrer Repositorys planen.

    Integriere Sicherheitsscans in deinen Entwicklungsworkflow. Du kannst Codex Security bei Pull Requests ausführen, nach der Übernahme von Änderungen in deinen Standard-Branch oder in regelmäßigen Abständen. Lege für jeden Auslöser fest, welchen Code der Scan prüfen soll. Halte die Befunde und die tatsächliche Scanabdeckung fest, damit dein Team die Ergebnisse nach einem einheitlichen Verfahren prüfen kann.

    Zeitpunkt für Scans wählen

    Beginne mit einem Auslöser, der zum Workflow deines Teams passt. Ergänze weitere, sobald du einschätzen kannst, wie lange die Scans dauern, was sie kosten und wie dein Team mit den Befunden arbeitet.

    Zeitpunkt Empfohlener Scanumfang Was du damit prüfst
    Nach Zeitplan Gesamtes Repository, optional mit einem Tiefenscan Die Codebasis als Ganzes in regelmäßigen Abständen.
    Bei Commits auf main Gesamtes Repository auf dem Stand des gepushten Commits Den integrierten Code, nachdem die Änderungen in deinen Standard-Branch gelangt sind.
    Bei Pull Requests oder Merge Requests Änderungen zwischen der Merge-Basis und dem vorgeschlagenen Commit Mögliche sicherheitsrelevante Regressionen vor dem Merge.

    Wenn der Standard-Branch deines Repositorys anders heißt als main, verwende seinen Namen. Konfiguriere sowohl den Auslöser als auch den Scanumfang. Ein Diff-Scan für einen Pull Request prüft nur die vorgeschlagenen Änderungen. Ein Scan, der erst nach der Übernahme der Änderungen in main läuft, kann den Merge dieses Pull Requests nicht mehr blockieren.

    Bevor du beginnst

    Du brauchst ein Repository, das du auf Schwachstellen prüfen darfst, die Berechtigung zum Konfigurieren seiner CI-Pipeline und ihrer Secrets sowie einen OpenAI-API-Schlüssel mit Zugriff auf Codex Security. Prüfe anhand des CLI-Schnellstarts, welche Voraussetzungen für den Zugriff und das Setup gelten.

    Verwende einen vertrauenswürdigen Runner, der die CI-Anforderungen erfüllt. Scans laufen mit den lokalen Berechtigungen des Runners. Stelle dem Scan-Job nur die benötigten Zugangsdaten zur Verfügung. Beachte die Einschränkungen deiner Plattform für Pull Requests aus Forks und für anderen nicht vertrauenswürdigen Code.

    Pipeline einrichten

    1. Codex Security in deine Pipeline integrieren

      Wähle das Beispiel für deine CI-Plattform. Folge der Anleitung, um die CLI von Codex Security zu installieren und einen API-Schlüssel über den Secret-Speicher deines CI-Anbieters bereitzustellen.

      Wähle die passende Anleitung:

      • GitHub Actions: Nutze den Workflow für Pull Requests, um vorgeschlagene Änderungen zu scannen und die Ergebnisse zu speichern.
      • GitLab CI/CD: Nutze die Pipeline-Anleitung für Merge Requests, Scans des Standard-Branchs und zeitgesteuerte Scans. Sie enthält eine Pipeline zum Herunterladen und erklärt, welche Optionen du aktivieren solltest.
      • Andere CI-Plattformen: Passe die Scan- und Exportbefehle aus der Anleitung Codex Security in CI ausführen an die Auslöser, den Secret-Speicher, den Checkout und die Artefaktverwaltung deines Anbieters an.
    2. Auslöser und Scanumfang konfigurieren

      Wenn Änderungen in main gelangen, scanne das Repository auf dem Stand des gepushten Commits. Richte außerdem regelmäßige Scans für den Branch deiner Wahl ein. Beginne beispielsweise mit einem wöchentlichen Scan. Passe das Intervall daran an, wie häufig sich das Repository ändert, wie lange die Scans dauern und was sie kosten.

      Rufe bei Pull Requests oder Merge Requests den Commit-Verlauf des Basis- und des Head-Branchs ab. Scanne den Diff zwischen der gemeinsamen Merge-Basis und dem vorgeschlagenen Commit.

      Konfiguriere jeden Job so, dass er den vorgesehenen Code prüft. Bei zeitgesteuerten Scans und Commits auf main ist das das gesamte Repository, bei Pull Requests sind es die vorgeschlagenen Änderungen. Richte den jeweiligen Scan anhand des Beispiels für deine Plattform ein.

      Lege ein Budget fest, das zum Umfang und zur Häufigkeit der Scans passt. Scans des gesamten Repositorys können länger dauern und mehr kosten als Diff-Scans. Mit --max-cost gibst du ein Limit auf Basis geschätzter Kosten an. Die tatsächlichen Ausgaben können darüber liegen. Erreicht der Scan das Limit, können Teile des Codes ungeprüft bleiben.

    3. Pipeline ausführen und Ergebnisse prüfen

      Reiche die Änderung an der Pipeline über das übliche Review-Verfahren deines Teams ein und löse anschließend einen Scan aus. Prüfe im Pipeline-Lauf und in scan-manifest.json, ob Zielrevision und Scanumfang stimmen.

      Prüfe die Befunde und die zugehörigen Belege in den gespeicherten Berichten. Sieh in coverage.json nach, für welche Bereiche die Prüfung unvollständig ist oder zurückgestellt wurde. Das gilt auch, wenn der Scan keine Befunde gemeldet hat. Prüfe Laufzeit und Kosten, bevor du die Scans häufiger oder für weitere Repositorys ausführst.

      Speichere die Berichte als CI-Artefakte. Lege Zugriffsrechte und Aufbewahrungsfristen fest, die dem enthaltenen Quellcode und den Belegen angemessen sind.

      Optional kannst du die Ergebnisse im SARIF-Format exportieren, um sie in der Sicherheitsansicht deiner Plattform anzuzeigen. SARIF ist ein strukturiertes Format für Sicherheitsbefunde. Prüfe in der Anleitung deiner Plattform, welche Versionen sie unterstützt und welche Berechtigungen und Lizenzen du benötigst.

    4. Festlegen, ob Befunde einen Merge blockieren sollen

      Prüfe zunächst die Befunde, ohne Merges zu blockieren. Sobald dein Team mit den Ergebnissen vertraut ist, kannst du für Pull Requests eine erfolgreiche Sicherheitsprüfung voraussetzen. Du kannst einen Merge zum Beispiel blockieren, wenn der Scan eine Schwachstelle mit hohem oder kritischem Schweregrad findet.

      Prüfe immer, ob der Scan erfolgreich abgeschlossen wurde und welchen Code er erfasst hat. Wenn ein Scan fehlgeschlagen ist oder Code übersprungen hat, geh der Ursache nach, auch wenn er keine Befunde gemeldet hat.

      Details zur Konfiguration findest du in der Anleitung Schwellenwerte für Schweregrade konfigurieren und Scanergebnisse interpretieren.

    5. Befunde nachverfolgen

      Weise die Befunde nach dem üblichen Verfahren deines Teams zur Untersuchung oder Behebung zu. Gib für jeden Befund den gescannten Commit, den betroffenen Code und die zugehörigen Belege an, damit jemand anderes aus dem Entwicklungsteam den Befund untersuchen kann.

      Prüfe, ob die Korrekturen wirksam sind, bevor du Befunde schließt. Prüfe bisher nicht vollständig erfasste Bereiche in einem weiteren Scan.

    Verwandte Anwendungsfälle