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

Sicherheitsbefunde exportieren und nachverfolgen

Exportiere Scanergebnisse oder erstelle Issues und Entwürfe für Sicherheitsmeldungen.

Exportiere die Befunde eines abgeschlossenen Scans, um sie in einem anderen Tool zu verwenden. Wenn du die Behebung nachverfolgen oder die Offenlegung koordinieren möchtest, bitte Codex, ein Issue oder einen privaten Entwurf für ein GitHub Security Advisory vorzubereiten.

Ein portables Artefakt exportieren

Öffne in der Desktop-App unter Sicherheit > Scans einen abgeschlossenen Scan. Wähle unter Artefakte den Eintrag Befunde (JSON), um die strukturierten Befunde zu öffnen. Wähle SARIF-Bericht, wenn der Scan einen solchen Bericht erzeugt hat. Welche Artefakte verfügbar sind, hängt von den Versionen der App und des Plugins ab.

Wenn Codex anbietet, die Scanbefunde zu exportieren, gib JSON, CSV oder SARIF als Format an. Für den Export im Terminal verwende den CLI-Exportbefehl mit dem gespeicherten Scanverzeichnis.

Format Verwendungszweck
JSON Die versiegelten, strukturierten Befunde für Tools und Skripte erhalten.
CSV Befunde in einer Tabellenkalkulation prüfen.
SARIF Befunde an Tools übermitteln, die das Austauschformat SARIF unterstützen.

Wenn du den aktuellen Triage-Status, Gründe für das Schließen von Befunden oder Notizen in den Export aufnehmen möchtest, exportiere nach deinen Änderungen eine CSV-Datei aus dem Plugin. Öffne exports/findings.csv im Scanverzeichnis. Die CLI exportiert den gespeicherten Scan ohne die lokalen Triage-Änderungen.

Öffne in einem abgeschlossenen Scan die Angaben zur Scanabdeckung, die Befunde, das Scanmanifest, den Markdown-Bericht oder das SARIF-Artefakt.

Wähle Markdown-Bericht, um report.md in deinem konfigurierten Editor zu öffnen.

Prüfe im generierten Markdown-Bericht den Scanumfang, das Bedrohungsmodell, die validierten Befunde und die Links zu ausführlichen Berichten.

Bewahre beim Archivieren des Berichts das gesamte Scanverzeichnis auf. Für die Nachverfolgung brauchst du die Originaldateien scan-manifest.json und findings.json. Wenn du die Befunde bearbeiten musst, erstelle zuerst eine eigene Kopie von findings.json.

Ausgewählte Befunde nachverfolgen

Verwende $codex-security:track-findings mit einem oder mehreren validierten Befunden aus demselben abgeschlossenen Scan. Wähle für jeden Durchlauf genau ein Ziel.

Ziel Erforderliche Angaben
Linear-Issue Team und optional ein Projekt
GitHub-Issue Name des Kontos oder der Organisation, dem bzw. der das Repository gehört, und Name des Repositorys
Jira-Vorgang Site, Projekt und Vorgangstyp in der Atlassian-App
Privater Entwurf für ein GitHub Security Advisory Ein Befund und das zugehörige öffentliche Quell-Repository auf GitHub.com
Verwende $codex-security:track-findings, um für das Team [team] ein Linear-Issue zum Befund [finding ID] aus [completed scan directory] zu entwerfen.

Wenn du mehrere Befunde auf einmal nachverfolgen möchtest, liste ihre IDs in deiner Anfrage auf. Für die Nachverfolgung in Jira verbinde die Atlassian-App mit Codex. Vergewissere dich, wer Vorgänge im Projekt lesen kann. Um einen Vorgang zu erstellen, brauchst du die Berechtigung, das Projekt zu durchsuchen und Vorgänge anzulegen. Für die Wiederverwendung eines vorhandenen Vorgangs brauchst du Lesezugriff, für eine Aktualisierung sowohl Lese- als auch Bearbeitungsrechte.

Für einen Advisory-Entwurf melde dich über die GitHub CLI (gh) bei GitHub.com an. Verwende ein Konto mit Administratorrechten für das öffentliche Quell-Repository. Das Repository darf kein Fork sein. Wähle genau einen Befund aus einem Scan, dessen Ziel eine Git-Revision (git_revision) ist. Scans von Commit-Diffs kommen dafür nicht infrage. Halte den Paketnamen, das Ökosystem und die betroffenen Versionen bereit.

Issue oder Security Advisory prüfen

  1. Prüfe den ursprünglichen Scan, die ausgewählten Befunde und das Konto, mit dem du angemeldet bist. Vergewissere dich, dass das Ziel stimmt und du weißt, wer dort Lesezugriff hat. Wähle für sensible Befunde ein privates Ziel. Für ein internes oder öffentliches GitHub-Issue brauchst du eine ausdrückliche Genehmigung zur Offenlegung.
  2. Prüfe, ob Codex vorschlägt, ein Issue zu erstellen, wiederzuverwenden oder zu aktualisieren. Bei einem Security Advisory kann Codex einen privaten Entwurf erstellen. Es kann auch einen passenden Entwurf oder ein passendes, bereits veröffentlichtes Advisory wiederverwenden.
  3. Lies den Titel und den Text und prüfe die angegebenen Stellen im Quellcode. Ein Advisory-Entwurf kann später öffentlich werden. Entferne Zugangsdaten, vertrauliche Belege und unnötige Details zur Ausnutzung der Schwachstelle.
  4. Genehmige die Vorschau im Chat mit Codex, bevor Codex den Eintrag erstellt oder aktualisiert. Wenn sich die Vorschau ändert, prüfe und genehmige sie erneut.

Speichere die Issue-ID oder den Link aus dem Tracking-System, auch wenn Codex das Issue nicht erneut öffnen kann. Bei einem neuen Advisory prüft Codex, ob der Entwurf mit der von dir genehmigten Vorschau übereinstimmt.

Wenn Codex nicht feststellen kann, ob es einen Eintrag erstellt oder aktualisiert hat, bricht es die Verarbeitung der übrigen Befunde ab. Suche vor einem erneuten Versuch im Tracking-System nach dem Issue oder Advisory und frage Codex, bei welchen Befunden es die Nachverfolgung noch nicht versucht hat.

Sobald die zuständige Person den Eintrag zur Behebung angenommen hat, fahre mit Einen Befund beheben und die Behebung überprüfen fort.