Skip to content

README.md

Latest commit

 

History

History
45 lines (34 loc) · 2.07 KB

README.md

File metadata and controls

45 lines (34 loc) · 2.07 KB
Raw

Examples

Examples and templates for using Codex Security:

  • GitHub Actions with Amazon Bedrock: a copyable workflow for PR-diff and full-repository scans with AWS OIDC authentication, SARIF uploads, and downloadable reports.

  • Findings CSV template: a header-only template for codex-security publish scan --to cloud --csv PATH. Copy it, add one finding per row, and validate the file before publishing:

    npx @openai/codex-security publish scan --to cloud \
  --csv /path/to/findings.csv --dry-run --json

    See Publish findings to Cloud for the required columns and input rules.

  • Custom validation demo: run a scan with a custom validation script against a deliberately vulnerable API using synthetic data. Follow the demo's setup instructions, and do not deploy the example app.

  • Invoice Desk sample: a Node.js invoice app with ten seeded finding scenarios, synthetic data, and no dependencies or external services. Its CI workflow runs behavior tests on PRs to main and queues OpenAI scans with environment approval. Sample guides and expected findings stay outside the scan input. Results include finding metrics and downloadable reports.

  • Azure Pipelines with Amazon Bedrock: centrally run manual full or committed-diff scans against Azure Repos, with OIDC credentials, report artifacts, and optional native SARIF publishing.

npm package

This top-level examples/ directory is available in the repository only; it is not included in the @openai/codex-security npm package. The package is built from sdk/typescript, whose files list includes only the CLI launcher, compiled SDK, bundled plugin, license, and package README. The package check rejects files outside its expected contents.

The bundled plugin's own example artifacts are separate and remain part of the package.