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

Sicherheitsprüfungen über die CLI durchführen

Prüfe ausgewählte Codeänderungen und sieh dir die Belege für Sicherheitsbefunde direkt im Terminal an.

Schwierigkeitsgrad Intermediate
Zeithorizont 30m

Prüfe mit der Codex Security CLI Änderungen, die noch in keinem Commit enthalten sind, oder Änderungen auf einem Branch.

Besonders geeignet für

  • Entwickelnde, die lokale Änderungen oder Änderungen auf einem Branch im Terminal prüfen.
  • Teams für Anwendungssicherheit, die in einem Monorepo ausgewählte Dienste und Pakete sowie die Komponenten prüfen, die diese nutzen.
  • Fachleute aus der Softwareentwicklung, die bestehende Warnmeldungen aus dem GitHub-Code-Scanning anhand des Codes in ihrem Repository untersuchen.

Inhalt

    ← Alle Anwendungsfälle

    Sicherheitsprüfungen über die CLI durchführen

    Prüfe ausgewählte Codeänderungen und sieh dir die Belege für Sicherheitsbefunde direkt im Terminal an.

    Prüfe mit der Codex Security CLI Änderungen, die noch in keinem Commit enthalten sind, oder Änderungen auf einem Branch.

    Intermediate
    30m
    Zur Setup-Anleitung

    Prüfe mit der Codex Security CLI Änderungen, die noch in keinem Commit enthalten sind, oder Änderungen auf einem Branch.

    Intermediate
    30m

    Besonders geeignet für

    • Entwickelnde, die lokale Änderungen oder Änderungen auf einem Branch im Terminal prüfen.
    • Teams für Anwendungssicherheit, die in einem Monorepo ausgewählte Dienste und Pakete sowie die Komponenten prüfen, die diese nutzen.
    • Fachleute aus der Softwareentwicklung, die bestehende Warnmeldungen aus dem GitHub-Code-Scanning anhand des Codes in ihrem Repository untersuchen.

    Lokale Änderungen vor dem Commit prüfen

    Mit der CLI kannst du lokale Änderungen vor dem Commit prüfen und dafür vorab Kontext zum Repository und zu den Sicherheitsrichtlinien bereitstellen.

    Führe die Beispiele in derselben Shell in deinem Git-Checkout aus. Sie setzen voraus, dass deine Sicherheitsrichtlinie in SECURITY.md steht und die ergänzenden Dokumente unter docs/security/ liegen. Die folgenden Befehle legen ein temporäres Verzeichnis für die Scanergebnisse an.

    northstar_repo="$(git rev-parse --show-toplevel)"
    northstar_kb="$northstar_repo/docs/security"
    northstar_results="$(mktemp -d)"
    npx @openai/codex-security scan "$northstar_repo" \
      --working-tree \
      --base HEAD \
      --knowledge-base "$northstar_repo/SECURITY.md" \
      --knowledge-base "$northstar_kb" \
      --output-dir "$northstar_results/working-tree"

    Der Scan prüft alle Änderungen gegenüber HEAD, unabhängig davon, ob du sie bereits zum Git-Index hinzugefügt hast.

    Vergewissere dich vor dem Scan, dass dein Arbeitsverzeichnis die Änderung enthält, die du prüfen möchtest. Weitere Änderungen ohne Bezug zur Fragestellung erweitern den Prüfumfang und können es erschweren, die Befunde der ursprünglichen Fragestellung zuzuordnen.

    Pull Requests oder Commits eines Branches prüfen

    Du kannst auch einen Pull Request oder einen Branch auf Sicherheitsprobleme prüfen. Checke den zu prüfenden Branch aus und rufe den aktuellen Stand seines Zielbranches ab. In diesem Beispiel ist der Zielbranch origin/main.

    northstar_pr_base="$(git -C "$northstar_repo" merge-base origin/main HEAD)"
    
    npx @openai/codex-security scan "$northstar_repo" \
      --diff "$northstar_pr_base" \
      --head HEAD \
      --knowledge-base "$northstar_repo/SECURITY.md" \
      --knowledge-base "$northstar_kb" \
      --output-dir "$northstar_results/branch"

    Ein Diff-Scan prüft ausschließlich die vorgeschlagenen Änderungen. Nach Abschluss des Scans findest du im Ausgabeverzeichnis folgende Dateien:

    • report.md enthält einen lesbaren Prüfbericht.

    • scan-manifest.json bestätigt die genauen Angaben zu Basis-Commit, Head-Commit, Scanziel und Artefakten.

    • findings.json nennt für jeden Befund den Schweregrad, die Verlässlichkeit der Einschätzung, die Fundstellen und Maßnahmen zur Behebung.

    • coverage.json zeigt, welche Bereiche geprüft oder ausgeschlossen wurden, welche Prüfungen noch ausstehen und wie vollständig die Prüfung ist.

    Monorepos scannen

    In einem Monorepo kann sich eine Änderung an einer gemeinsam genutzten Bibliothek auf mehrere Dienste auswirken. Gib Codex genügend Kontext, um diese Wechselwirkungen zu prüfen. Die CI bestimmt, welche Komponenten und Prüfungen erforderlich sind.

    Kontext zum Repository

    Halte gemeinsame Vorgaben für die Entwicklung in AGENTS.md und Sicherheitsanforderungen in SECURITY.md fest. Ein typisches Repository könnte so aussehen:

    monorepo/
    ├── AGENTS.md
    ├── SECURITY.md
    ├── docs/security/
    │   ├── architecture.md
    │   └── threat-model.md
    ├── packages/auth/
    └── services/
        ├── billing/
        └── reporting/

    Nutze vorhandene Angaben zu Zuständigkeiten und Build-Metadaten, um für jede Komponente zu ermitteln, wovon sie abhängt, welche anderen Komponenten sie verwenden und welche Tests sie abdecken. Bei einer Änderung an packages/auth kann es beispielsweise nötig sein, beide Dienste zu prüfen, auch wenn sich deren Dateien nicht geändert haben. Deine Organisation pflegt die Zuordnung, die den Prüfumfang bestimmt. Das Hinzufügen von Codex richtet diese Zuordnung nicht automatisch ein.

    Einzelne Komponenten prüfen

    Bei großen Repositorys musst du nicht unbedingt für jeden Pull Request die gesamte Codebasis scannen. Enthält ein Monorepo separate Dienste oder Pakete, kannst du den Scan auf bestimmte Pfade beschränken. Gib –path mehrfach an, um eine gemeinsam genutzte Bibliothek und die Komponenten, die sie verwenden, zusammen zu prüfen.

    npx @openai/codex-security scan "$northstar_repo" \
      --path packages/auth \
      --path services/billing \
      --path services/reporting \
      --knowledge-base "$northstar_repo/SECURITY.md" \
      --knowledge-base "$northstar_kb" \
      --output-dir "$northstar_results/paths"

    Dieser Scan prüft nur die ausgewählten Pfade im Repository.

    Pull Requests und Diffs scannen

    Verwende für einen Pull Request die exakten Hashes seines Basis- und Head-Commits aus authentifizierten GitHub-Metadaten. Beide Revisionen und ihr Verlauf müssen im Checkout verfügbar sein. Das folgende Beispiel verwendet die Variablen von oben und speichert die Ergebnisse des Diff-Scans separat:

    BASE_SHA="<full PR base commit SHA>"
    HEAD_SHA="<full PR head commit SHA>"
    
    BASE_REVISION="$(
      git -C "$northstar_repo" merge-base "$BASE_SHA" "$HEAD_SHA"
    )" || exit
    
    npx @openai/codex-security scan "$northstar_repo" \
      --diff "$BASE_REVISION" \
      --head "$HEAD_SHA" \
      --knowledge-base "$northstar_kb" \
      --auth chatgpt \
      --output-dir "$northstar_results/pr"

    Ein Diff-Scan konzentriert sich auf die vorgeschlagenen Änderungen. Erfordert eine Änderung an einer gemeinsam genutzten Bibliothek eine umfassendere Prüfung der Komponenten, die sie verwenden, führe zusätzlich die Komponentenprüfung in einem sauberen Checkout des Head-Commits dieses Pull Requests aus. Halte die Ergebnisse getrennt. --diff und --path sind eigenständige Scanmodi und lassen sich nicht kombinieren.

    Warnmeldungen von GitHub prüfen

    Mit der CLI von Codex Security kannst du auch Warnmeldungen aus dem Code-Scanning für den Standardbranch prüfen.

    northstar_github_repository="example/northstar"
    northstar_github_alerts="$northstar_results/github-alerts.json"
    
    # Import all open alerts as complete JSON.
    npx @openai/codex-security import github "$northstar_github_repository" \
      --format json \
      > "$northstar_github_alerts"
    
    # Or import a selected subset.
    npx @openai/codex-security import github "$northstar_github_repository" \
      --github-alert 12 \
      --github-alert 18 \
      --format json \
      > "$northstar_github_alerts"
    
    # Run from the corresponding local repository; imported contents are data.
    cd "$northstar_repo"
    npx @openai/codex-security validate "$northstar_github_alerts"

    Verwandte Anwendungsfälle