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(plugin): simplify workbench persistence (#1226)
mldangelo-oaic39bbaf9dc9c
diff --git a/plugins/codex-security/scripts/deep_scan_workbench.py b/plugins/codex-security/scripts/deep_scan_workbench.pyindex bfe93f061..3e06b0a65 100644--- a/plugins/codex-security/scripts/deep_scan_workbench.py+++ b/plugins/codex-security/scripts/deep_scan_workbench.py@@ -17,16 +17,10 @@ from typing import Any, Callablesys.path.insert(0, str(Path(__file__).resolve().parent))from deep_scan_config import resolve_deep_scan_config-from filesystem_identity import serialize_filesystem_identityfrom finalize_scan_contract import _read_scan_local_jsonfrom workbench.handoff import require_current_continuationfrom workbench.storage import create_private_directory-from workbench_target import (- directory_content_digest,- directory_snapshot_regular_file_count,- git_revision,- worktree_content_digest,-)+from workbench_target import directory_snapshot_regular_file_countfrom workbench_validation import optional_text, require_uuid, user_context_argumentDEEP_SCAN_WORKER_KINDS = ("setup", "discovery", "dedup")@@ -671,7 +665,7 @@ def begin_deep_scan_for_scan(if workflow_version is None:raise SystemExit("workflow-version is required.")connection.execute("BEGIN IMMEDIATE")- try:+ with connection:scan, _ = require_owned_scan(connection, scan_id, thread_id)require_current_continuation(scan,@@ -679,10 +673,6 @@ def begin_deep_scan_for_scan(error_message="Deep Scan orchestration is owned by another continuation.",)ensure_deep_scan_run(connection, scan, config, workflow_version, dependencies().now())- connection.commit()- except BaseException:- connection.rollback()- raisereturn deep_scan_result(connection, scan_id, start_disposition="created")@@ -697,19 +687,13 @@ def begin_deep_scan_for_target(if existing is not None:return begin_deep_scan_for_scan(connection, existing["id"], thread_id, args)target_metadata = target.stat()- revision = git_revision(target)- target_snapshot_digest = (- directory_content_digest(target)- if revision == "unversioned"- else worktree_content_digest(target)- )- target_device = serialize_filesystem_identity(target_metadata.st_dev)- target_inode = serialize_filesystem_identity(target_metadata.st_ino)+ target_identity = dependencies().scan_target_identity(target, None, metadata=target_metadata)+ revision, target_snapshot_digest, target_device, target_inode = target_identityscope_file_count = directory_snapshot_regular_file_count(target if scope == "." else target / scope)connection.execute("BEGIN IMMEDIATE")- try:+ with connection:existing = existing_deep_scan_for_target(connection, thread_id, target_path, scope)if existing is not None:existing_run = connection.execute(@@ -759,11 +743,7 @@ def begin_deep_scan_for_target(workflow_version = optional_text(args.workflow_version, maximum=256)if workflow_version is None:raise SystemExit("workflow-version is required.")- root = (- Path(args.scan_root).expanduser().resolve()- if args.scan_root- else dependencies().state_dir() / "scans"- )+ root = dependencies().resolve_scan_root(args.scan_root)target_root = (root / dependencies().safe_segment(target.name)).resolve()if target_root == target or target in target_root.parents:raise SystemExit("The scan artifact directory must be outside the selected target.")@@ -800,55 +780,28 @@ def begin_deep_scan_for_target(timestamp,),)- connection.execute(- """- INSERT INTO scans (- id, workspace_id, target_id, target_path, target_revision, target_snapshot_digest,- target_device, target_inode, scope, mode, user_context,- deep_scan_owner_thread_id, scan_dir, model, reasoning_effort, status, phase,- handoff_status, started_at, created_at, updated_at- ) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, 'deep', ?, ?, ?, ?, ?,- 'running', 'preflight', 'delivered', ?, ?, ?)- """,- (- scan_id,- workspace_id,- target_id,- target_path,- revision,- target_snapshot_digest,- target_device,- target_inode,- scope,- user_context,- thread_id,- str(scan_dir),- model,- reasoning_effort,- timestamp,- timestamp,- timestamp,- ),- )- connection.execute(- """- INSERT INTO scan_progress (- scan_id, scope_file_count, review_items_total, review_items_completed,- reportable_findings_count, updated_at- ) VALUES (?, ?, 0, 0, 0, ?)- """,- (scan_id, scope_file_count, timestamp),- )- connection.execute(- "UPDATE workspaces SET active_scan_id = ?, updated_at = ? WHERE id = ?",- (scan_id, timestamp, workspace_id),+ workspace = connection.execute(+ "SELECT * FROM workspaces WHERE id = ?", (workspace_id,)+ ).fetchone()+ dependencies().insert_running_scan(+ connection,+ scan_id=scan_id,+ workspace=workspace,+ target=target,+ scope=scope,+ diff_target=None,+ target_identity=target_identity,+ target_root=target_root,+ target_summary=None,+ scope_file_count=scope_file_count,+ timestamp=timestamp,+ handoff_status="delivered",+ model=model,+ reasoning_effort=reasoning_effort,+ scan_dir=scan_dir,)scan = dependencies().require_scan(connection, scan_id)ensure_deep_scan_run(connection, scan, config, workflow_version, timestamp)- connection.commit()- except BaseException:- connection.rollback()- raisereturn deep_scan_result(connection, scan_id, start_disposition="created")@@ -931,7 +884,7 @@ def claim_deep_scan_coordinator_locked(connection: sqlite3.Connection, args: argparse.Namespace, scan_id: str) -> dict[str, Any]:connection.execute("BEGIN IMMEDIATE")- try:+ with connection:scan, _ = require_owned_scan(connection, scan_id, args.thread_id)require_current_continuation(scan,@@ -963,10 +916,6 @@ def claim_deep_scan_coordinator_locked(""",(int(args.coordinator_generation != run["coordinator_generation"]), timestamp, scan_id),)- connection.commit()- except BaseException:- connection.rollback()- raisereturn {**deep_scan_result(connection, scan_id),"coordinatorDisposition": disposition,@@ -1128,7 +1077,7 @@ def upsert_deep_scan_worker(scan_id = require_uuid(args.scan_id, "scan-id")worker_id = require_uuid(args.worker_id, "worker-id")connection.execute("BEGIN IMMEDIATE")- try:+ with connection:run = require_deep_scan_run(connection, scan_id)require_current_coordinator(run, args)scan = dependencies().require_scan(connection, scan_id)@@ -1349,10 +1298,6 @@ def upsert_deep_scan_worker(worker_id,),)- connection.commit()- except BaseException:- connection.rollback()- raisereturn deep_scan_result(connection, scan_id)@@ -1365,7 +1310,7 @@ def claim_deep_scan_dedup(if len(set(input_ids)) != len(input_ids):raise SystemExit("Dedup input worker IDs must be unique.")connection.execute("BEGIN IMMEDIATE")- try:+ with connection:run, scan = require_running_deep_scan(connection, scan_id)require_current_coordinator(run, args)prompt_path = deep_scan_path(scan, args.prompt_path, "Dedup prompt path", kind="file")@@ -1494,10 +1439,6 @@ def claim_deep_scan_dedup(""",(timestamp, scan_id),)- connection.commit()- except BaseException:- connection.rollback()- raisereturn deep_scan_result(connection, scan_id)@@ -2011,7 +1952,7 @@ def record_deep_scan_publication_failure(raise SystemExit("message is required.")with dependencies().scan_completion_lock(scan_id):connection.execute("BEGIN IMMEDIATE")- try:+ with connection:run = require_deep_scan_run(connection, scan_id)require_current_coordinator(run, args)scan = dependencies().require_scan(connection, scan_id)@@ -2035,10 +1976,6 @@ def record_deep_scan_publication_failure(""",(message, timestamp, scan_id),)- connection.commit()- except BaseException:- connection.rollback()- raisereturn deep_scan_result(connection, scan_id)diff --git a/plugins/codex-security/scripts/workbench_cli.py b/plugins/codex-security/scripts/workbench_cli.pyindex ab38dd9de..ae1db666d 100644--- a/plugins/codex-security/scripts/workbench_cli.py+++ b/plugins/codex-security/scripts/workbench_cli.py@@ -9,7 +9,6 @@ from pathlib import Path# Some plugin hosts launch Python with safe-path isolation enabled.sys.path.insert(0, str(Path(__file__).resolve().parent))import deep_scan_workbench as deep_scan-import workbench_remediation as remediationfrom deep_scan_workbench import non_negative_intfrom workbench_constants import (DIFF_TARGET_KINDS,@@ -342,7 +341,10 @@ def parse_args(description: str) -> argparse.Namespace:release_finding_remediation_claim.add_argument("--request-id", required=True)release_finding_remediation_claim.add_argument("--action-token", required=True)- remediation.register_cancel_finding_remediation_request(subparsers)+ cancel_remediation = subparsers.add_parser("cancel-finding-remediation-request")+ cancel_remediation.add_argument("--occurrence-id", required=True)+ cancel_remediation.add_argument("--request-id", required=True)+ cancel_remediation.add_argument("--action-token", required=True)set_finding_remediation = subparsers.add_parser("set-finding-remediation")set_finding_remediation.add_argument("--occurrence-id", required=True)diff --git a/plugins/codex-security/scripts/workbench_constants.py b/plugins/codex-security/scripts/workbench_constants.pyindex fc0a19c3c..9eefb96d8 100644--- a/plugins/codex-security/scripts/workbench_constants.py+++ b/plugins/codex-security/scripts/workbench_constants.py@@ -16,18 +16,7 @@ PHASE_PROGRESS_UNITS = (FINDING_SEVERITIES = ("critical", "high", "medium", "low", "informational")FINDING_STATUSES = ("open", "closed")FINDING_CLOSE_REASONS = ("already_fixed", "wont_fix", "false_positive")-REMEDIATION_STATES = (- "idle",- "requested",- "generated",- "applied",- "verifying",- "verified",- "failed",- "superseded",-)REMEDIATION_UPDATE_STATES = ("generated", "applied", "verifying", "verified", "failed")-REMEDIATION_PENDING_ACTIONS = ("generate", "apply", "verify")EXPORT_FORMATS = ("csv", "json", "sarif")ARTIFACTS = {"coverage": "coverage.json",diff --git a/plugins/codex-security/scripts/workbench_db.py b/plugins/codex-security/scripts/workbench_db.pyindex 0ea3217b6..8159f7764 100644--- a/plugins/codex-security/scripts/workbench_db.py+++ b/plugins/codex-security/scripts/workbench_db.py@@ -1096,7 +1096,7 @@ def pin_legacy_manifest_digest(connection: sqlite3.Connection, scan_id: str, manifest_digest: str) -> None:connection.execute("BEGIN IMMEDIATE")- try:+ with connection:scan = require_scan(connection, scan_id)current = scan["seal_manifest_digest"]if current is not None and current != manifest_digest:@@ -1106,10 +1106,6 @@ def pin_legacy_manifest_digest("UPDATE scans SET seal_manifest_digest = ? WHERE id = ?",(manifest_digest, scan["id"]),)- connection.commit()- except BaseException:- connection.rollback()- raisedef complete_scan(@@ -1543,17 +1539,13 @@ def complete_scan_locked(manifest_digest = published_manifest_digest(scan_dir, manifest)if prepare_only:connection.execute("BEGIN IMMEDIATE")- try:+ with connection:updated = connection.execute("UPDATE scans SET completion_warnings_json = ? WHERE id = ? AND status = 'running'",(json.dumps(warnings), scan["id"]),)if updated.rowcount != 1:raise SystemExit("Only a running scan can be prepared for completion.")- connection.commit()- except BaseException:- connection.rollback()- raisecontext = scan_context(connection, scan["id"])context["targetWarnings"] = target_warningsreturn context@@ -1686,7 +1678,7 @@ def register_cli_scan(connection: sqlite3.Connection, args: argparse.Namespace)workspace_id = str(uuid.uuid4())connection.execute("BEGIN IMMEDIATE")- try:+ with connection:archive_scan(connection, args, scan_dir, timestamp, require_canonical_scan_directory)target_id = ensure_security_target(connection, str(repository))if parent_scan_id is not None:@@ -1741,10 +1733,6 @@ def register_cli_scan(connection: sqlite3.Connection, args: argparse.Namespace))if workflow_id is not None:register_workflow_scan(connection, workflow_id, scan_id, str(scan_dir), timestamp)- connection.commit()- except BaseException:- connection.rollback()- raisescan = require_scan(connection, scan_id)return {"contract": scan_contract(scan),@@ -1877,7 +1865,7 @@ def set_finding_triage(connection: sqlite3.Connection, args: argparse.Namespace)note = optional_text(args.note, maximum=2400)require_close_note(close_reason, note)connection.execute("BEGIN IMMEDIATE")- try:+ with connection:timestamp = now()occurrence = require_occurrence(connection, args.occurrence_id)if args.status == "closed":@@ -1949,10 +1937,6 @@ def set_finding_triage(connection: sqlite3.Connection, args: argparse.Namespace)""",(occurrence["id"], args.status, close_reason, note, timestamp),)- connection.commit()- except BaseException:- connection.rollback()- raisereturn scan_context(connection, occurrence["scan_id"])@@ -2276,7 +2260,7 @@ def set_finding_remediation(action_token = require_uuid(args.action_token, "action-token")summary = optional_text(args.summary, maximum=2400)verification_summary = optional_text(args.verification_summary, maximum=2400)- try:+ with connection:occurrence = require_occurrence(connection, args.occurrence_id)require_finding_open(connection, occurrence["id"])scan = require_scan(connection, occurrence["scan_id"])@@ -2391,10 +2375,6 @@ def set_finding_remediation(raise SystemExit("This remediation request changed. Refresh it before recording an update.")- connection.commit()- except BaseException:- connection.rollback()- raisereturn scan_context(connection, occurrence["scan_id"])@@ -2899,7 +2879,7 @@ def backfill_legacy_finding_details(connection: sqlite3.Connection, scan: sqlitereturnconnection.execute("BEGIN IMMEDIATE")- try:+ with connection:current = require_scan(connection, scan["id"])recorded_digest = current["seal_manifest_digest"]if recorded_digest is not None and recorded_digest != manifest_digest:@@ -2917,10 +2897,6 @@ def backfill_legacy_finding_details(connection: sqlite3.Connection, scan: sqlite"UPDATE scans SET seal_manifest_digest = ? WHERE id = ?",(manifest_digest, scan["id"]),)- connection.commit()- except BaseException:- connection.rollback()- raisedef legacy_finding_matches(row: sqlite3.Row, finding: Any) -> bool:diff --git a/plugins/codex-security/scripts/workbench_progress.py b/plugins/codex-security/scripts/workbench_progress.pyindex 7793abf4d..1d2066fe9 100644--- a/plugins/codex-security/scripts/workbench_progress.py+++ b/plugins/codex-security/scripts/workbench_progress.py@@ -82,7 +82,7 @@ def update_context(scan_id = require_uuid(args.scan_id, "scan-id")context = user_context_argument(args)connection.execute("BEGIN IMMEDIATE")- try:+ with connection:scan = require_scan(connection, scan_id)if scan["status"] != "running" or scan["canceled_at"] is not None:raise SystemExit("Only a running scan can update context.")@@ -117,10 +117,6 @@ def update_context("UPDATE workspaces SET updated_at = ? WHERE id = ?",(timestamp, workspace["id"]),)- connection.commit()- except BaseException:- connection.rollback()- raisereturn scan_context(connection, scan_id)@@ -166,7 +162,7 @@ def update_progress()serialized_preflight_issues = preflight_issues_json(preflight_issues)connection.execute("BEGIN IMMEDIATE")- try:+ with connection:timestamp = now()scan = require_scan(connection, scan_id)if scan["status"] != "running":@@ -230,8 +226,12 @@ def update_progress(and args.phase_progress_unit != progress["phase_progress_unit"]):raise SystemExit("Phase progress unit cannot change within a phase.")- updates: list[str] = []- values: list[Any] = []+ updates: list[str] = [+ "phase_items_total = ?",+ "phase_items_completed = ?",+ "phase_progress_unit = ?",+ ]+ values: list[Any] = [phase_total, phase_completed, phase_unit]if next_phase == "preflight" and scan["mode"] != "deep":updates.extend(["preflight_checks_total = ?", "preflight_checks_completed = ?"])values.extend([phase_total, phase_completed])@@ -285,29 +285,10 @@ def update_progress()if updated.rowcount != 1:raise SystemExit("Only a running scan can update progress.")- if updates:- connection.execute(- f"UPDATE scan_progress SET {', '.join(updates)}, updated_at = ? WHERE scan_id = ?",- (*values, timestamp, scan["id"]),- )- else:- connection.execute(- "UPDATE scan_progress SET updated_at = ? WHERE scan_id = ?",- (timestamp, scan["id"]),- )connection.execute(- """- UPDATE scan_progress- SET phase_items_total = ?, phase_items_completed = ?,- phase_progress_unit = ?, updated_at = ?- WHERE scan_id = ?- """,- (phase_total, phase_completed, phase_unit, timestamp, scan["id"]),+ f"UPDATE scan_progress SET {', '.join(updates)}, updated_at = ? WHERE scan_id = ?",+ (*values, timestamp, scan["id"]),)- connection.commit()- except BaseException:- connection.rollback()- raisereturn scan_context(connection, scan["id"])diff --git a/plugins/codex-security/scripts/workbench_publication.py b/plugins/codex-security/scripts/workbench_publication.pyindex 802bee035..537f021c2 100644--- a/plugins/codex-security/scripts/workbench_publication.py+++ b/plugins/codex-security/scripts/workbench_publication.py@@ -191,17 +191,13 @@ def prepare_linear_publication() -> dict[str, Any]:payload, destination, findings = linear_publication_input(db, args, recording=False)connection.execute("BEGIN IMMEDIATE")- try:+ with connection:scan = verify_linear_publication_scan(db, connection, payload, findings)result = {"scanId": scan["id"],"destination": destination,"findingCount": len(findings),}- connection.commit()- except BaseException:- connection.rollback()- raisereturn result@@ -246,7 +242,7 @@ def record_linear_publications(external_ids.add(issue_identifier)connection.execute("BEGIN IMMEDIATE")- try:+ with connection:scan = verify_linear_publication_scan(db, connection, payload, findings)timestamp = db.now()for publication in publications:@@ -331,10 +327,6 @@ def record_linear_publications(})result = {"scanId": scan["id"], "destination": destination, "created": created}- connection.commit()- except BaseException:- connection.rollback()- raisereturn resultdiff --git a/plugins/codex-security/scripts/workbench_remediation.py b/plugins/codex-security/scripts/workbench_remediation.pyindex 2f5870d5c..4115cc759 100644--- a/plugins/codex-security/scripts/workbench_remediation.py+++ b/plugins/codex-security/scripts/workbench_remediation.py@@ -90,35 +90,25 @@ def require_pending_action(current: sqlite3.Row, requested: str) -> None:)-def register_cancel_finding_remediation_request(subparsers: Any) -> None:- parser = subparsers.add_parser("cancel-finding-remediation-request")- parser.add_argument("--occurrence-id", required=True)- parser.add_argument("--request-id", required=True)- parser.add_argument("--action-token", required=True)--def cancel_finding_remediation_request(connection: sqlite3.Connection, args: argparse.Namespace) -> str:request_id = require_uuid(args.request_id, "request-id")action_token = require_uuid(args.action_token, "action-token")connection.execute("BEGIN IMMEDIATE")- try:+ with connection:occurrence = require_occurrence(connection, args.occurrence_id)current = connection.execute("SELECT * FROM finding_remediation_attempts WHERE request_id = ?",(request_id,),).fetchone()if current is None:- connection.commit()return str(occurrence["scan_id"])if current["occurrence_id"] != occurrence["id"]:raise SystemExit("This remediation request belongs to a different finding.")if current["pending_action"] is None:- connection.commit()return str(occurrence["scan_id"])if current["state"] == "failed" and current["pending_action_claim_token"] is None:- connection.commit()return str(occurrence["scan_id"])if current["pending_action_claim_token"] != action_token:raise SystemExit("This remediation host request is owned by a different action token.")@@ -152,10 +142,6 @@ def cancel_finding_remediation_request(""",(timestamp, request_id, action_token),)- connection.commit()- except BaseException:- connection.rollback()- raisereturn str(occurrence["scan_id"])diff --git a/plugins/codex-security/scripts/workbench_scan_start.py b/plugins/codex-security/scripts/workbench_scan_start.pyindex b31f2543e..cac00420f 100644--- a/plugins/codex-security/scripts/workbench_scan_start.py+++ b/plugins/codex-security/scripts/workbench_scan_start.py@@ -197,10 +197,7 @@ def insert_running_scan(workspace["default_mode"],user_context,workspace["thread_id"] if workspace["default_mode"] == "deep" else None,- diff_target["kind"] if diff_target else None,- diff_target["baseRevision"] if diff_target else None,- diff_target["headRevision"] if diff_target else None,- diff_target.get("contentDigest") if diff_target else None,+ *scan_diff_identity(diff_target or None),target_summary,str(scan_dir),optional_text(model, maximum=200),diff --git a/plugins/codex-security/scripts/workbench_scan_usage.py b/plugins/codex-security/scripts/workbench_scan_usage.pyindex d3e437e81..26d971236 100644--- a/plugins/codex-security/scripts/workbench_scan_usage.py+++ b/plugins/codex-security/scripts/workbench_scan_usage.py@@ -70,15 +70,11 @@ def reconcile_completed_scan_cost(allow_nan=False,)connection.execute("BEGIN IMMEDIATE")- try:+ with connection:connection.execute("UPDATE scans SET cost_json = ? WHERE id = ? AND status = 'complete'",(cost_json, scan["id"]),)- connection.commit()- except BaseException:- connection.rollback()- raisedef collect_scan_usage(diff --git a/plugins/codex-security/scripts/workbench_validation.py b/plugins/codex-security/scripts/workbench_validation.pyindex 4459ed626..398f51faa 100644--- a/plugins/codex-security/scripts/workbench_validation.py+++ b/plugins/codex-security/scripts/workbench_validation.py@@ -45,9 +45,7 @@ def path_within_scope(path: str, scope: str) -> bool:requested = PurePosixPath(scope)if candidate.is_absolute() or ".." in candidate.parts:return False- if requested == PurePosixPath("."):- return True- return candidate == requested or requested in candidate.parents+ return candidate.is_relative_to(requested)def require_close_note(close_reason: str | None, note: str | None) -> None: