For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Write vulnerability reports

Turn findings, disclosure notes, source, and proof-of-concept material into vulnerability reports with supporting evidence.

Use $codex-security:vulnerability-writeup to create a self-contained report for each distinct vulnerability. You can start from Codex Security scan results or use supplied findings, disclosure notes, PoCs, and source code directly. A Codex Security scan isn’t required.

Prepare the evidence

Provide the workflow with:

  • The findings, disclosure notes, or assessment documents to review.
  • The target source tree and affected revision or release.
  • Existing PoCs, logs, traces, screenshots, or diagnostic output.
  • Fix commits or diffs when available.

Codex checks each claim against the affected source code before writing the report. If the source or affected revision isn’t available, decide whether to proceed with a report that identifies the unverified claims.

Run the workflow

Send a prompt like:

Use $codex-security:vulnerability-writeup to create one self-contained report for each distinct vulnerability in [input paths]. Verify the claims against [source path and revision], preserve or improve the supplied PoCs, and write the reports to [output directory]. Use a local test environment for reproductions.

Codex inventories the supplied material, groups reports that describe the same root cause and vulnerable path, and creates one report directory per distinct vulnerability. Each directory contains a Markdown report and a poc/ directory when supporting PoC files are available.

Review each report

Before distributing a report, confirm that it:

  • Traces the bug from the attacker-controlled entry point to the broken security invariant and impact.
  • Distinguishes verified behavior from hypotheses and unresolved constraints.
  • Includes source excerpts with paths, functions, and the affected revision.
  • Includes PoC source, build or run instructions, representative output, and safety limitations when a PoC is practical.
  • Uses portable paths and doesn’t depend on internal storage or local absolute paths.

Use reports from a scan

Detailed vulnerability reports are optional for standard, deep, and change scans. When you request them, Codex writes each report to findings/<slug>/<slug>.md, stores supporting files under findings/<slug>/poc/, and links the report from report.md.

Keep the complete scan directory together when sharing or archiving a scan. To look for improvements that address patterns across the reports, continue with Propose security hardening.