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
refactor: reuse scan contract readers and projection helpers (#1480)
mldangelo-oai0d78ef904314
diff --git a/plugins/codex-security/scripts/finalize_scan_contract.py b/plugins/codex-security/scripts/finalize_scan_contract.pyindex 999c9ec56..cd02cd0dd 100644--- a/plugins/codex-security/scripts/finalize_scan_contract.py+++ b/plugins/codex-security/scripts/finalize_scan_contract.py@@ -8,7 +8,6 @@ import copyimport csvimport errnoimport hashlib-import importlib.utilimport ioimport jsonimport math@@ -23,6 +22,11 @@ from pathlib import Path, PurePosixPathfrom typing import Any, TextIOfrom urllib.parse import quote, urlsplit+# Keep sibling helpers importable when Python starts in isolated mode.+sys.path.insert(0, str(Path(__file__).resolve().parent))+import report_projection+import threat_model_projection+SCHEMA_VERSION = "1.0"PRODUCER_NAME = "codex-security-plugin"FINGERPRINT_ALGORITHM = "codex-security/v1"@@ -126,28 +130,12 @@ def _generate_report_projection(findings: dict[str, Any],coverage: dict[str, Any],) -> bytes:- script = Path(__file__).resolve().parent / "report_projection.py"- spec = importlib.util.spec_from_file_location("codex_security_report_projection", script)- if spec is None or spec.loader is None:- raise ContractError(f"could not load report projection helper: {script}")- module = importlib.util.module_from_spec(spec)- spec.loader.exec_module(module)try:- return module.generate_report_markdown(manifest, findings, coverage)+ return report_projection.generate_report_markdown(manifest, findings, coverage)except ValueError as exc:raise ContractError(f"report projection failed: {exc}") from exc-def _threat_model_renderer() -> Any:- script = Path(__file__).resolve().with_name("threat_model_projection.py")- spec = importlib.util.spec_from_file_location("codex_security_threat_model_projection", script)- if spec is None or spec.loader is None:- raise ContractError(f"could not load threat model projection helper: {script}")- module = importlib.util.module_from_spec(spec)- spec.loader.exec_module(module)- return module--def threat_model_provenance(manifest: dict[str, Any]) -> dict[str, Any]:if manifest.get("documentType") == "codex-security.policy-draft":scope = manifest.get("scope")@@ -178,7 +166,7 @@ def threat_model_provenance(manifest: dict[str, Any]) -> dict[str, Any]:def _render_threat_model(model: dict[str, Any], provenance: dict[str, Any]) -> bytes:try:- return _threat_model_renderer().render_threat_model(model, provenance)+ return threat_model_projection.render_threat_model(model, provenance)except (TypeError, ValueError) as exc:raise ContractError(f"threat model projection failed: {exc}") from exc@@ -500,22 +488,11 @@ def _descriptor_relative_writes_available() -> bool:)-_WINDOWS_SCAN_LOCAL_FILES: Any | None = None--def _windows_scan_local_files() -> Any:"""Load the Win32 backend and shared stream comparison lazily."""+ import windows_scan_local_files- global _WINDOWS_SCAN_LOCAL_FILES- if _WINDOWS_SCAN_LOCAL_FILES is None:- script = Path(__file__).resolve().with_name("windows_scan_local_files.py")- spec = importlib.util.spec_from_file_location("codex_security_windows_scan_files", script)- if spec is None or spec.loader is None:- raise ContractError(f"could not load Windows scan-local file helper: {script}")- module = importlib.util.module_from_spec(spec)- spec.loader.exec_module(module)- _WINDOWS_SCAN_LOCAL_FILES = module- return _WINDOWS_SCAN_LOCAL_FILES+ return windows_scan_local_filesdef _open_verified_scan_directory(@@ -2627,16 +2604,9 @@ def _validate_existing_seal(raise ContractError(f"{context}: sealed artifact changed or is missing")-def _read_sealed_scan(- scan_dir: Path, schema_dir: Path | None, required_for: str-) -> tuple[dict[str, Any], dict[str, Any], dict[str, Any], bytes]:- scan_dir = _require_scan_directory(scan_dir)- schema_dir = schema_dir or Path(__file__).resolve().parent.parent / "schemas"- manifest = _read_scan_local_json(scan_dir, "scan-manifest.json", "scan-manifest.json")- scan = _require_dict(manifest, "scan", "manifest")- _validate_contract_refs(scan)- if scan.get("sealedAt") is None or scan.get("artifacts") is None:- raise ContractError(f"manifest.scan: {required_for} requires a sealed scan")+def _read_sealed_artifacts(+ scan_dir: Path, scan: dict[str, Any]+) -> tuple[dict[str, Any], dict[str, Any], bytes]:findings, findings_bytes = _read_scan_local_json_bytes(scan_dir, scan["findingsRef"], scan["findingsRef"])@@ -2651,6 +2621,20 @@ def _read_sealed_scan(scan["coverageRef"]: coverage_bytes,},)+ return findings, coverage, findings_bytes+++def _read_sealed_scan(+ scan_dir: Path, schema_dir: Path | None, required_for: str+) -> tuple[dict[str, Any], dict[str, Any], dict[str, Any], bytes]:+ scan_dir = _require_scan_directory(scan_dir)+ schema_dir = schema_dir or Path(__file__).resolve().parent.parent / "schemas"+ manifest = _read_scan_local_json(scan_dir, "scan-manifest.json", "scan-manifest.json")+ scan = _require_dict(manifest, "scan", "manifest")+ _validate_contract_refs(scan)+ if scan.get("sealedAt") is None or scan.get("artifacts") is None:+ raise ContractError(f"manifest.scan: {required_for} requires a sealed scan")+ findings, coverage, findings_bytes = _read_sealed_artifacts(scan_dir, scan)_validate_manifest(manifest)findings_for_validation = _legacy_sealed_findings_for_validation(findings)_validate_findings(manifest, findings_for_validation)@@ -2751,18 +2735,7 @@ def finding_csv_columns(deep_scan: bool) -> tuple[str, ...]:def build_csv_projection(findings: dict[str, Any], coverage: dict[str, Any]) -> bytes:output = io.StringIO(newline="")writer = csv.writer(output)- deep_scan = coverage.get("mode") == "deep_repository" or (- coverage.get("mode") == "scoped_path"- and any(- isinstance(finding.get("extensions"), dict)- and any(- isinstance(finding["extensions"].get(field), str)- and finding["extensions"][field].strip()- for field in ("candidateId", "reportId")- )- for finding in findings["findings"]- )- )+ deep_scan = report_projection.uses_deep_presentation(coverage, findings["findings"])writer.writerow(finding_csv_columns(deep_scan))for finding in findings["findings"]:location = _sarif_primary_location(finding)diff --git a/plugins/codex-security/scripts/report_projection.py b/plugins/codex-security/scripts/report_projection.pyindex df84891b5..f95d4c52d 100644--- a/plugins/codex-security/scripts/report_projection.py+++ b/plugins/codex-security/scripts/report_projection.py@@ -89,7 +89,7 @@ def _has_deep_child_metadata(finding: dict[str, Any]) -> bool:)-def _uses_deep_presentation(coverage: dict[str, Any], findings: list[dict[str, Any]]) -> bool:+def uses_deep_presentation(coverage: dict[str, Any], findings: list[dict[str, Any]]) -> bool:if coverage.get("mode") == "deep_repository":return Trueif coverage.get("mode") != "scoped_path":@@ -766,7 +766,7 @@ def build_report_markdown("reportable findings have duplicate writeup reportPath values: "+ ", ".join(duplicate_writeup_paths))- deep_presentation = _uses_deep_presentation(coverage, findings)+ deep_presentation = uses_deep_presentation(coverage, findings)deep_finding_groups = _deep_finding_groups(findings, writeup_paths) if deep_presentation else []hardening_portfolio_path = _hardening_portfolio_path(scan)include_paths = _strings(coverage.get("includePaths", scope.get("includePaths", [])))diff --git a/plugins/codex-security/scripts/threat_model_projection.py b/plugins/codex-security/scripts/threat_model_projection.pyindex bf70ab685..7b428aee2 100644--- a/plugins/codex-security/scripts/threat_model_projection.py+++ b/plugins/codex-security/scripts/threat_model_projection.py@@ -4,13 +4,16 @@from __future__ import annotationsimport argparse-import importlib.utilimport jsonimport sysfrom collections.abc import Callablefrom pathlib import Pathfrom typing import Any+# Keep sibling helpers importable when Python starts in isolated mode.+sys.path.insert(0, str(Path(__file__).resolve().parent))+import report_projection as report+_STRUCTURED_SECTIONS = (("Assets", "assets"),("Trust Boundaries", "trustBoundaries"),@@ -113,12 +116,6 @@ def render_threat_model(model: dict[str, Any], provenance: dict[str, Any] | Nonebody = threat_model_body(model)if _markdown_content(model) is None:body = "# Threat Model\n\n" + body- script = Path(__file__).resolve().with_name("report_projection.py")- spec = importlib.util.spec_from_file_location("codex_security_report_projection", script)- if spec is None or spec.loader is None:- raise ValueError(f"could not load report projection helper: {script}")- report = importlib.util.module_from_spec(spec)- spec.loader.exec_module(report)text = report._textprovenance = provenance or {}footer = ["---", "", "## Saved Model Context", ""]diff --git a/plugins/codex-security/scripts/validate_scan_contract.py b/plugins/codex-security/scripts/validate_scan_contract.pyindex 298b7eaf4..8b1bac664 100644--- a/plugins/codex-security/scripts/validate_scan_contract.py+++ b/plugins/codex-security/scripts/validate_scan_contract.py@@ -4,25 +4,14 @@from __future__ import annotationsimport argparse-import importlib.utilimport jsonimport sysfrom pathlib import Path-from types import ModuleTypefrom typing import Any--def _load_finalizer() -> ModuleType:- script = Path(__file__).resolve().with_name("finalize_scan_contract.py")- spec = importlib.util.spec_from_file_location("codex_security_scan_contract", script)- if spec is None or spec.loader is None:- raise RuntimeError(f"could not load scan contract validator: {script}")- module = importlib.util.module_from_spec(spec)- spec.loader.exec_module(module)- return module---FINALIZER = _load_finalizer()+# Keep sibling helpers importable when Python starts in isolated mode.+sys.path.insert(0, str(Path(__file__).resolve().parent))+import finalize_scan_contract as FINALIZERdef validate_contract(scan_dir: Path) -> dict[str, Any]:@@ -39,26 +28,7 @@ def validate_contract(scan_dir: Path) -> dict[str, Any]:FINALIZER.validate_against_schema(manifest, schema_dir / "scan-manifest.schema.json")scan = FINALIZER._require_dict(manifest, "scan", "manifest")- findings_ref = scan["findingsRef"]- coverage_ref = scan["coverageRef"]- findings, findings_bytes = FINALIZER._read_scan_local_json_bytes(- scan_dir,- findings_ref,- findings_ref,- )- coverage, coverage_bytes = FINALIZER._read_scan_local_json_bytes(- scan_dir,- coverage_ref,- coverage_ref,- )- FINALIZER._validate_existing_seal(- scan_dir,- scan,- artifact_contents={- findings_ref: findings_bytes,- coverage_ref: coverage_bytes,- },- )+ findings, coverage, _ = FINALIZER._read_sealed_artifacts(scan_dir, scan)findings_for_validation = FINALIZER._legacy_sealed_findings_for_validation(findings)FINALIZER._validate_findings(manifest, findings_for_validation)FINALIZER._validate_derived_finding_identities(manifest, findings)diff --git a/plugins/codex-security/scripts/validate_tracking_source.py b/plugins/codex-security/scripts/validate_tracking_source.pyindex 38a9edc23..34e18aee0 100644--- a/plugins/codex-security/scripts/validate_tracking_source.py+++ b/plugins/codex-security/scripts/validate_tracking_source.py@@ -4,24 +4,14 @@from __future__ import annotationsimport argparse-import importlib.utilimport sysfrom pathlib import Path-from types import ModuleTypefrom typing import Any+# Keep sibling helpers importable when Python starts in isolated mode.+sys.path.insert(0, str(Path(__file__).resolve().parent))+import validate_scan_contract as SCAN_CONTRACT-def _load_scan_contract_validator() -> ModuleType:- script = Path(__file__).resolve().with_name("validate_scan_contract.py")- spec = importlib.util.spec_from_file_location("codex_security_scan_validator", script)- if spec is None or spec.loader is None:- raise RuntimeError(f"could not load scan contract validator: {script}")- module = importlib.util.module_from_spec(spec)- spec.loader.exec_module(module)- return module---SCAN_CONTRACT = _load_scan_contract_validator()FINALIZER = SCAN_CONTRACT.FINALIZERvalidate_contract = SCAN_CONTRACT.validate_contractdiff --git a/plugins/codex-security/tests/test_cli_dry_runs.py b/plugins/codex-security/tests/test_cli_dry_runs.pyindex 0af345e7a..3ff83f635 100644--- a/plugins/codex-security/tests/test_cli_dry_runs.py+++ b/plugins/codex-security/tests/test_cli_dry_runs.py@@ -11,9 +11,9 @@ PLUGIN_ROOT = Path(__file__).resolve().parents[1]SCRIPT_DIR = PLUGIN_ROOT / "scripts"-def run_script(name: str, *args: str) -> subprocess.CompletedProcess[str]:+def run_script(name: str, *args: str, isolated: bool = False) -> subprocess.CompletedProcess[str]:return subprocess.run(- [sys.executable, str(SCRIPT_DIR / name), *args],+ [sys.executable, *(["-I"] if isolated else []), str(SCRIPT_DIR / name), *args],check=False,capture_output=True,text=True,@@ -27,14 +27,19 @@ def test_all_scripts_support_help() -> None:assert "usage:" in result.stdout.lower(), script.name[email protected]("name", ("workbench_publication.py", "workbench_severity.py"))-def test_workbench_helpers_support_help_with_safe_path(name: str) -> None:- result = subprocess.run(- [sys.executable, "-I", str(SCRIPT_DIR / name), "--help"],- check=False,- capture_output=True,- text=True,- )+ "name",+ (+ "workbench_publication.py",+ "workbench_severity.py",+ "finalize_scan_contract.py",+ "validate_scan_contract.py",+ "validate_tracking_source.py",+ "threat_model_projection.py",+ ),+)+def test_helpers_support_help_with_safe_path(name: str) -> None:+ result = run_script(name, "--help", isolated=True)assert result.returncode == 0, result.stderrassert "usage:" in result.stdout.lower()@@ -48,7 +53,8 @@ def test_recover_scan_results_help_describes_its_contract() -> None:assert "retained checkpoints" in result.stdout-def test_finalizer_cli_completes_checked_in_scan_bundle(tmp_path: Path) -> None:[email protected]("isolated", (False, True))+def test_finalizer_cli_completes_checked_in_scan_bundle(tmp_path: Path, isolated: bool) -> None:scan_dir = tmp_path / "completed-scan"shutil.copytree(PLUGIN_ROOT / "examples" / "completed-scan", scan_dir)@@ -58,6 +64,7 @@ def test_finalizer_cli_completes_checked_in_scan_bundle(tmp_path: Path) -> None:str(scan_dir),"--schema-dir",str(PLUGIN_ROOT / "schemas"),+ isolated=isolated,)assert result.returncode == 0, result.stderr