Skip to content

Latest commit

 

History

History
136 lines (104 loc) · 10.1 KB

README.md

File metadata and controls

136 lines (104 loc) · 10.1 KB

Import external scanner findings

Preview a scanner report with the CLI, then save the findings in the local workbench or send a supported report to Codex Security Cloud.

In Codex, ask to import a saved report or fetch selected findings with an available CLI, API, or MCP connection. You can publish selected findings from the local workbench in a later session using their stored IDs and versions. Walk through acquisition, local import, and publication in Codex

Choose your input

Starting point Command
Saved vendor report codex-security publish findings FILE --provider PROVIDER --source-key KEY --repository . --to local --dry-run previews the evidence. Remove --dry-run to save it.
Codex Security findings export codex-security scan import FILE saves findings from a .csv or .json file as a completed scan. Use --input-format for other filenames and --json for JSON output.
Live provider codex-security import --help lists the Continuum, GitHub, Semgrep, Snyk and Sonar collectors. The Sonar collector can also replay its saved capture.

Choose your scanner

The --provider value selects the reader for a saved report. To see which readers your installed CLI supports, run codex-security publish findings --help. The guides cover local and Cloud imports unless a row limits its scope.

Guide --provider Supported input
Amazon Inspector inspector Inspector2 ListFindings JSON for one Code Security repository
ArmorCode armorcode Findings API JSON for one repository (local verified, Cloud unverified)
AWS Continuum continuum Code issues with linked evidence, or saved findings and patches
Black Duck SCA blackduck BOM-6 vulnerable components for one project version
Checkmarx SAST checkmarx Checkmarx One CLI JSON or self-managed CxSAST XML for one scan
CrowdStrike crowdstrike FCS CLI 4.x IaC scan JSON (local only)
Endor Labs endor Native Finding JSON, or self-contained endorctl SARIF with finding UUIDs
GitHub code scanning github Alerts selected for one repository and Git ref
GitHub Dependabot github Dependency alerts exported from one repository
GitHub Security Advisories github Selected repository or global advisories
OpenGrep opengrep Native scan JSON, optionally gzip-compressed
Semgrep semgrep CLI/CI JSON, SARIF, selected Guardian findings, or Platform Web API reports
Snyk snyk CLI JSON, plugin exports, SARIF, or monitored Code and Open Source issues
SonarQube Cloud sonar Issues selected with the signed-in Sonar CLI, or saved issue-search pages
Tenable One tenable Selected Code Repository inventory findings (local only)
Trivy trivy Native schema-v2 repository or filesystem JSON, optionally gzip-compressed
Veracode Static Analysis veracode Findings API pages for one application's policy flaws
Wiz wiz Native JSON, normalized JSONL, or detailed repository package vulnerability CSV

Preview a report

Install the CLI and open the repository the findings apply to. Keep reports and preview output in a private directory outside that checkout. To choose where mktemp -d creates the directory, set TMPDIR to an existing directory outside the checkout and pass it in the template, as in mktemp -d "${TMPDIR:-/tmp}/report.XXXXXX". This works on both macOS and Linux. In CI, redirect stdout and stderr to private files.

In the terminal, follow your scanner's guide. Run examples that use --repository . from the checkout root. For a saved report, publish findings with --to local --dry-run works offline without a Cloud login or model call. Add --format json to see every finding and exclusion. For repeat local file imports, reuse the preview's exact repository and source.source_key to update matching findings.

In Codex, enable the Codex Security plugin and start a new chat. Ask it to preview the report with your configured model.

Preview ../reports/endor-findings.json for this checkout. Show me which Endor findings the CLI would import and which it would skip. Stop there.

If you selected specific findings, compare the preview with your selection. Check for missing, duplicate or unexpected occurrences. For OpenGrep, check report.errors as well as exclusions, even when the findings list is empty.

Save or publish and verify

These steps cover publish findings FILE. For import sonar, use the capture from the preview for your destination.

Save locally. Remove --dry-run and confirm. In automation, use --yes after reviewing the preview.

Send to Cloud. Tenable One and CrowdStrike reports support local import only. For a Cloud-supported report, keep the file, provider, source key, and scanner options from your local preview. Change the destination to --to cloud, and pass the connected repository URL or Cloud ID to --repository. Preview again with --dry-run --format json. Cloud setup

Check the account, endpoint, repository, selected findings, and exclusions. The preview shows where your workspace will store the evidence. A privateImport entry identifies your private inbox and the suggested repository for assessment. Entries in requests identify the repository environments that will receive the findings. Once you have reviewed the destination, remove --dry-run and confirm.

Verify the import

For a local import, list the saved findings using the checkout path from the preview.

codex-security findings imported /path/to/project --format json

For a Cloud import, check the receipt for the destination shown in the preview.

What the Cloud preview shows How to verify the import
Private inbox (privateImport) Check that privateJob.status is completed and its counts account for the selected findings, with zero errors or unprocessed rows. Review exclusions.
Repository publisher (environments in requests) Check each receipt, the verified and unacknowledged counts, failures, and exclusions.

To inspect published findings in Codex, connect the Cloud app and ask for imported findings in the destination repository. If the scanner has no filter in the findings view, use the source and finding IDs from your receipt to identify the record. For a private import, ask for your private import history.

If the repository publisher requires a reported severity, the preview excludes findings whose severity the scanner left unknown. You can keep those findings in a local import or a private inbox when available.

If publish findings stops and returns savedSubmission, resume from that checkpoint.

Troubleshoot Semgrep and Snyk collection

If import semgrep or import snyk stops with HTTP 429, check the vendor's Retry-After value. Wait for that interval, rerun collection, and preview the complete export before importing it.

Work with imported findings

New local findings start as not_assessed. To check whether one affects your code, give its evidence and the matching checkout to the triage workflow. For a dependency alert, check the installed version and trace the dependency.

With the SDK, look up a local record by its id with listLocalExternalFindings({ repository, id }). Pass record.evidence and the matching checkout to security.validate(). Your configured model provider returns a separate assessment.

See Imported finding identity and evidence for what each reader stores and how repeat imports work.