OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security
TypeScript ai-securityapplication-securityclicode-scanningcodexcodex-securitycybersecuritydevsecopsnodejsnpmopenaisdksecuritytypescriptvulnerability-scanning
fix(exports): retain finalized Deep CSV candidate metadata (#1828)
Michael D'Angelo6922ace35305
diff --git a/plugins/codex-security/scripts/workbench_publication.py b/plugins/codex-security/scripts/workbench_publication.pyindex 7abccf36b..d649fa693 100644--- a/plugins/codex-security/scripts/workbench_publication.py+++ b/plugins/codex-security/scripts/workbench_publication.py@@ -332,7 +332,7 @@ def export_findings("workspace": db.workspace_state(connection, scan["workspace_id"]),}try:- manifest, _, _ = finalize_scan(+ manifest, findings_document, _ = finalize_scan(scan_dir,expected_coverage_mode=db.expected_coverage_mode(scan),)@@ -350,7 +350,8 @@ def export_findings(raise SystemExit(str(exc)) from excpath = db.artifact_path(scan_dir, "exports/results.sarif", required=True)else:- path = write_csv_export(db, connection, scan)+ path = write_csv_export(db, connection, scan, findings_document)+ del findings_documentif path is None:raise SystemExit(f"Could not export Codex Security findings as {args.format.upper()}.")return {@@ -364,6 +365,7 @@ def write_csv_export(db: Any,connection: sqlite3.Connection,scan: sqlite3.Row,+ findings_document: dict[str, Any],) -> Path:scan_dir = db.require_canonical_scan_directory(Path(scan["scan_dir"]))output = io.StringIO(newline="")@@ -371,7 +373,6 @@ def write_csv_export(deep_scan = scan["mode"] == "deep"candidate_ids_by_occurrence: dict[str, str] = {}if deep_scan:- findings_document = db.read_json_object(scan_dir / db.ARTIFACTS["findings"])findings = findings_document.get("findings")if not isinstance(findings, list):raise SystemExit("findings.json must contain a findings array.")diff --git a/plugins/codex-security/tests/test_workbench_db_exports.py b/plugins/codex-security/tests/test_workbench_db_exports.pyindex 7a5fb4afb..1dfa65f2e 100644--- a/plugins/codex-security/tests/test_workbench_db_exports.py+++ b/plugins/codex-security/tests/test_workbench_db_exports.py@@ -745,8 +745,14 @@ def test_completed_findings_export_inside_scan_directory(tmp_path: Path) -> None),ids=("candidate-id", "blank-candidate-id", "report-id", "ledger-row-id"),)[email protected]("replace_after_finalize", (False, True), ids=("saved", "replaced"))def test_deep_csv_export_adds_only_candidate_id_column(- tmp_path: Path, extensions: dict[str, str], expected_candidate_id: str+ tmp_path: Path,+ extensions: dict[str, str],+ expected_candidate_id: str,+ replace_after_finalize: bool,+ monkeypatch: pytest.MonkeyPatch,+ workbench_api,) -> None:state_dir = tmp_path / "state"codex_home = tmp_path / "codex-home"@@ -776,8 +782,38 @@ def test_deep_csv_export_adds_only_candidate_id_column(finding["extensions"] = extensionsfindings_path.write_text(json.dumps(findings_document))- scan_command(state_dir, "complete-scan", scan_id)- exported = scan_command(state_dir, "export-findings", scan_id, "--format", "csv")["export"]+ completed = scan_command(state_dir, "complete-scan", scan_id)["scan"]+ set_triage(+ state_dir,+ completed["findings"][0]["occurrenceId"],+ "closed",+ "--close-reason",+ "wont_fix",+ "--note",+ "Accepted after review.",+ )+ if replace_after_finalize:+ publication = workbench_api["publication"]+ finalize = publication.finalize_scan++ def replace_finalized_document(*args, **kwargs):+ result = finalize(*args, **kwargs)+ replacement = copy.deepcopy(result[1])+ replacement["findings"][0]["extensions"] = {"candidateId": "DSS-replaced"}+ replacement["findings"][0]["title"] = "Replaced title"+ findings_path.write_text(json.dumps(replacement))+ return result++ monkeypatch.setattr(publication, "finalize_scan", replace_finalized_document)+ with closing(sqlite3.connect(state_dir / "workbench.sqlite3")) as connection:+ connection.row_factory = sqlite3.Row+ exported = publication.export_findings(+ workbench_api["_WORKBENCH_PUBLICATION_CONTEXT"],+ connection,+ SimpleNamespace(scan_id=scan_id, format="csv"),+ )["export"]+ else:+ exported = scan_command(state_dir, "export-findings", scan_id, "--format", "csv")["export"]with Path(exported["path"]).open(newline="") as source:reader = csv.DictReader(source)rows = list(reader)@@ -801,6 +837,8 @@ def test_deep_csv_export_adds_only_candidate_id_column(assert len(rows) == 1assert rows[0]["candidate_id"] == expected_candidate_idassert rows[0]["title"] == original_title+ assert rows[0]["status"] == "closed"+ assert rows[0]["close_reason"] == "wont_fix"assert "report_id" not in rows[0]assert "detailed_writeup" not in rows[0]