@openai/codex-security 0.8.2 → 0.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +201 -178
- package/_bundled_plugin/.app.json +4 -0
- package/_bundled_plugin/.mcp.json +6 -1
- package/_bundled_plugin/examples/completed-scan/findings.json +16 -4
- package/_bundled_plugin/examples/completed-scan/report.md +11 -8
- package/_bundled_plugin/examples/completed-scan/scan-manifest.json +4 -2
- package/_bundled_plugin/mcp/fzstd-LICENSE.txt +21 -0
- package/_bundled_plugin/mcp/helpers.mjs +2 -11
- package/_bundled_plugin/mcp/helpers.mjs.br +0 -0
- package/_bundled_plugin/mcp/native/THIRD_PARTY_NOTICES.txt +3 -210
- package/_bundled_plugin/mcp/native/darwin-arm64/unix.node +0 -0
- package/_bundled_plugin/mcp/native/darwin-x64/unix.node +0 -0
- package/_bundled_plugin/mcp/native/linux-arm64-gnu/unix.node +0 -0
- package/_bundled_plugin/mcp/native/linux-arm64-musl/unix.node +0 -0
- package/_bundled_plugin/mcp/native/linux-x64-gnu/unix.node +0 -0
- package/_bundled_plugin/mcp/native/linux-x64-musl/unix.node +0 -0
- package/_bundled_plugin/mcp/native/win32-arm64/windows.node +0 -0
- package/_bundled_plugin/mcp/native/win32-x64/windows.node +0 -0
- package/_bundled_plugin/mcp/package.json +1 -0
- package/_bundled_plugin/mcp/permission-profile-preflight.mjs +51 -14
- package/_bundled_plugin/mcp/server.mjs +2 -11
- package/_bundled_plugin/mcp/server.mjs.br +0 -0
- package/_bundled_plugin/mcp/session-decompression.mjs +712 -0
- package/_bundled_plugin/references/artifact-storage.md +1 -1
- package/_bundled_plugin/references/core-scan.md +14 -5
- package/_bundled_plugin/references/default-severity-rubric.md +33 -0
- package/_bundled_plugin/references/final-report.md +5 -3
- package/_bundled_plugin/references/finding-detail-fields.md +19 -18
- package/_bundled_plugin/references/sarif-adapter.md +8 -2
- package/_bundled_plugin/references/scan-artifacts.md +21 -12
- package/_bundled_plugin/references/scan-contract.md +27 -33
- package/_bundled_plugin/references/threat-model.md +1 -0
- package/_bundled_plugin/schemas/tools/scan-draft.schema.json +2 -2
- package/_bundled_plugin/scripts/check_deep_scan_target.py +97 -0
- package/_bundled_plugin/scripts/codex_profile.mjs +7 -1
- package/_bundled_plugin/scripts/deep_scan_config.py +20 -1
- package/_bundled_plugin/scripts/deep_scan_workbench.py +188 -454
- package/_bundled_plugin/scripts/filesystem_identity.py +1 -0
- package/_bundled_plugin/scripts/finalize_scan_contract.py +317 -377
- package/_bundled_plugin/scripts/finding_preview.py +25 -29
- package/_bundled_plugin/scripts/launch_codex_security_mcp +1 -0
- package/_bundled_plugin/scripts/legacy_findings.py +148 -0
- package/_bundled_plugin/scripts/posix_scan_local_files.py +198 -0
- package/_bundled_plugin/scripts/read_codex_session.mjs +21 -0
- package/_bundled_plugin/scripts/report_projection.py +167 -178
- package/_bundled_plugin/scripts/review_state.py +8 -2
- package/_bundled_plugin/scripts/servicenow_avit.py +20 -0
- package/_bundled_plugin/scripts/snapshot_sqlite.py +1 -0
- package/_bundled_plugin/scripts/threat_model_projection.py +22 -26
- package/_bundled_plugin/scripts/validate_scan_contract.py +9 -7
- package/_bundled_plugin/scripts/windows_scan_local_files.py +600 -72
- package/_bundled_plugin/scripts/workbench/__init__.py +1 -1
- package/_bundled_plugin/scripts/workbench/handoff.py +47 -0
- package/_bundled_plugin/scripts/workbench/retained_coverage.py +38 -75
- package/_bundled_plugin/scripts/workbench/retained_records.py +18 -30
- package/_bundled_plugin/scripts/workbench/runtime_toml.py +4 -1
- package/_bundled_plugin/scripts/workbench/saved_coverage.py +152 -248
- package/_bundled_plugin/scripts/workbench/saved_outputs.py +9 -0
- package/_bundled_plugin/scripts/workbench/saved_sources.py +47 -40
- package/_bundled_plugin/scripts/workbench/storage.py +71 -7
- package/_bundled_plugin/scripts/workbench_cli.py +121 -14
- package/_bundled_plugin/scripts/workbench_constants.py +19 -0
- package/_bundled_plugin/scripts/workbench_coverage_receipts.py +3 -3
- package/_bundled_plugin/scripts/workbench_db.py +550 -492
- package/_bundled_plugin/scripts/workbench_feedback.py +8 -7
- package/_bundled_plugin/scripts/workbench_finding_index.py +1 -0
- package/_bundled_plugin/scripts/workbench_finding_workflows.py +90 -4
- package/_bundled_plugin/scripts/workbench_native_indexes.py +29 -33
- package/_bundled_plugin/scripts/workbench_progress.py +10 -1
- package/_bundled_plugin/scripts/workbench_publication.py +14 -10
- package/_bundled_plugin/scripts/workbench_remediation.py +508 -11
- package/_bundled_plugin/scripts/workbench_saved_results.py +132 -77
- package/_bundled_plugin/scripts/workbench_scan_history.py +139 -80
- package/_bundled_plugin/scripts/workbench_scan_start.py +84 -25
- package/_bundled_plugin/scripts/workbench_scan_usage.py +666 -117
- package/_bundled_plugin/scripts/workbench_schema.py +44 -55
- package/_bundled_plugin/scripts/workbench_setup.py +251 -0
- package/_bundled_plugin/scripts/workbench_source_excerpt.py +13 -0
- package/_bundled_plugin/scripts/workbench_source_scopes.py +33 -23
- package/_bundled_plugin/scripts/workbench_target.py +330 -66
- package/_bundled_plugin/scripts/workbench_target_state.py +3 -0
- package/_bundled_plugin/scripts/workbench_validation.py +44 -12
- package/_bundled_plugin/shared/workbench-history-repairs.json +19 -16
- package/_bundled_plugin/shared/workbench-migrations.json +53 -0
- package/_bundled_plugin/skills/attack-path-analysis/SKILL.md +1 -1
- package/_bundled_plugin/skills/attack-path-analysis/references/severity-policy.md +4 -68
- package/_bundled_plugin/skills/check-skills/SKILL.md +43 -0
- package/_bundled_plugin/skills/check-skills/agents/openai.yaml +4 -0
- package/_bundled_plugin/skills/cloud-findings/SKILL.md +6 -4
- package/_bundled_plugin/skills/deep-security-scan/SKILL.md +7 -50
- package/_bundled_plugin/skills/fix-finding/SKILL.md +19 -2
- package/_bundled_plugin/skills/publish-findings/SKILL.md +81 -45
- package/_bundled_plugin/skills/publish-findings/references/checkmarx-import.md +37 -0
- package/_bundled_plugin/skills/publish-findings/references/wiz-import.md +5 -24
- package/_bundled_plugin/skills/publish-findings/scripts/collect_checkmarx.py +464 -0
- package/_bundled_plugin/skills/threat-model-visualize/scripts/build_explorer.py +36 -9
- package/_bundled_plugin/skills/track-findings/SKILL.md +5 -3
- package/_bundled_plugin/skills/triage-finding/references/github-rest-intake.md +22 -68
- package/_bundled_plugin/skills/triage-finding/references/ticket-intake.md +12 -6
- package/dist/api.d.ts +45 -5
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js +1144 -411
- package/dist/api.js.map +1 -1
- package/dist/auth.d.ts.map +1 -1
- package/dist/auth.js +10 -7
- package/dist/auth.js.map +1 -1
- package/dist/bedrock-oss-pricing.d.ts +6 -0
- package/dist/bedrock-oss-pricing.d.ts.map +1 -0
- package/dist/bedrock-oss-pricing.js +58 -0
- package/dist/bedrock-oss-pricing.js.map +1 -0
- package/dist/bedrock-pricing.d.ts +15 -0
- package/dist/bedrock-pricing.d.ts.map +1 -0
- package/dist/bedrock-pricing.js +117 -0
- package/dist/bedrock-pricing.js.map +1 -0
- package/dist/blackduck-findings.d.ts +8 -0
- package/dist/blackduck-findings.d.ts.map +1 -0
- package/dist/blackduck-findings.js +320 -0
- package/dist/blackduck-findings.js.map +1 -0
- package/dist/bulk-scan-discovery.d.ts.map +1 -1
- package/dist/bulk-scan-discovery.js +51 -36
- package/dist/bulk-scan-discovery.js.map +1 -1
- package/dist/checkmarx-evidence.d.ts +19 -0
- package/dist/checkmarx-evidence.d.ts.map +1 -0
- package/dist/checkmarx-evidence.js +36 -0
- package/dist/checkmarx-evidence.js.map +1 -0
- package/dist/checkmarx-findings.d.ts +4 -0
- package/dist/checkmarx-findings.d.ts.map +1 -0
- package/dist/checkmarx-findings.js +27 -0
- package/dist/checkmarx-findings.js.map +1 -0
- package/dist/checkmarx-one.d.ts +4 -0
- package/dist/checkmarx-one.d.ts.map +1 -0
- package/dist/checkmarx-one.js +53 -0
- package/dist/checkmarx-one.js.map +1 -0
- package/dist/checkmarx-repository.d.ts +12 -0
- package/dist/checkmarx-repository.d.ts.map +1 -0
- package/dist/checkmarx-repository.js +181 -0
- package/dist/checkmarx-repository.js.map +1 -0
- package/dist/checkmarx-xml.d.ts +12 -0
- package/dist/checkmarx-xml.d.ts.map +1 -0
- package/dist/checkmarx-xml.js +196 -0
- package/dist/checkmarx-xml.js.map +1 -0
- package/dist/classify-severity-records.d.ts +6 -9
- package/dist/classify-severity-records.d.ts.map +1 -1
- package/dist/classify-severity-records.js +9 -21
- package/dist/classify-severity-records.js.map +1 -1
- package/dist/classify-severity.d.ts +4 -1
- package/dist/classify-severity.d.ts.map +1 -1
- package/dist/classify-severity.js +30 -13
- package/dist/classify-severity.js.map +1 -1
- package/dist/cli.d.ts +14 -5
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +2112 -1266
- package/dist/cli.js.map +1 -1
- package/dist/cloud-publish.js +2 -2
- package/dist/cloud-publish.js.map +1 -1
- package/dist/codex-prompt.d.ts +2 -0
- package/dist/codex-prompt.d.ts.map +1 -1
- package/dist/codex-prompt.js +6 -0
- package/dist/codex-prompt.js.map +1 -1
- package/dist/component-scan.d.ts +16 -3
- package/dist/component-scan.d.ts.map +1 -1
- package/dist/component-scan.js +32 -6
- package/dist/component-scan.js.map +1 -1
- package/dist/config.d.ts +2 -1
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +221 -65
- package/dist/config.js.map +1 -1
- package/dist/continuum-findings.d.ts +7 -0
- package/dist/continuum-findings.d.ts.map +1 -0
- package/dist/continuum-findings.js +225 -0
- package/dist/continuum-findings.js.map +1 -0
- package/dist/contract-values.d.ts +30 -0
- package/dist/contract-values.d.ts.map +1 -0
- package/dist/contract-values.js +78 -0
- package/dist/contract-values.js.map +1 -0
- package/dist/contract.d.ts +2 -20
- package/dist/contract.d.ts.map +1 -1
- package/dist/contract.js +58 -669
- package/dist/contract.js.map +1 -1
- package/dist/cost-model.d.ts +13 -1
- package/dist/cost-model.d.ts.map +1 -1
- package/dist/cost-model.js +66 -115
- package/dist/cost-model.js.map +1 -1
- package/dist/cost.d.ts +61 -4
- package/dist/cost.d.ts.map +1 -1
- package/dist/cost.js +2560 -100
- package/dist/cost.js.map +1 -1
- package/dist/custom-publish.d.ts +4 -0
- package/dist/custom-publish.d.ts.map +1 -1
- package/dist/custom-publish.js +40 -3
- package/dist/custom-publish.js.map +1 -1
- package/dist/custom-validation-prompt.d.ts +1 -1
- package/dist/custom-validation-prompt.d.ts.map +1 -1
- package/dist/custom-validation-prompt.js +5 -0
- package/dist/custom-validation-prompt.js.map +1 -1
- package/dist/custom-validation.d.ts +2 -0
- package/dist/custom-validation.d.ts.map +1 -1
- package/dist/custom-validation.js +4 -0
- package/dist/custom-validation.js.map +1 -1
- package/dist/deduplication/deduplication-prompts.d.ts +4 -4
- package/dist/deduplication/deduplication-prompts.d.ts.map +1 -1
- package/dist/deduplication/deduplication-prompts.js +2 -2
- package/dist/deduplication/deduplication-prompts.js.map +1 -1
- package/dist/deduplication/deduplication-reviewer.d.ts +14 -11
- package/dist/deduplication/deduplication-reviewer.d.ts.map +1 -1
- package/dist/deduplication/deduplication-reviewer.js +11 -4
- package/dist/deduplication/deduplication-reviewer.js.map +1 -1
- package/dist/deduplication/deduplication.js.map +1 -1
- package/dist/deduplication/finding-schema.d.ts +19 -1
- package/dist/deduplication/finding-schema.d.ts.map +1 -1
- package/dist/deduplication/finding-schema.js +25 -0
- package/dist/deduplication/finding-schema.js.map +1 -1
- package/dist/deduplication/local.d.ts +2 -2
- package/dist/deduplication/local.d.ts.map +1 -1
- package/dist/deduplication/local.js +5 -10
- package/dist/deduplication/local.js.map +1 -1
- package/dist/deduplication/records.d.ts +8 -2
- package/dist/deduplication/records.d.ts.map +1 -1
- package/dist/deduplication/records.js +36 -8
- package/dist/deduplication/records.js.map +1 -1
- package/dist/deduplication/refusal.d.ts.map +1 -1
- package/dist/deduplication/refusal.js +25 -5
- package/dist/deduplication/refusal.js.map +1 -1
- package/dist/deduplication/scan.d.ts +3 -0
- package/dist/deduplication/scan.d.ts.map +1 -1
- package/dist/deduplication/scan.js +1 -1
- package/dist/deduplication/scan.js.map +1 -1
- package/dist/deep-config.d.ts +0 -1
- package/dist/deep-config.d.ts.map +1 -1
- package/dist/deep-config.js +22 -33
- package/dist/deep-config.js.map +1 -1
- package/dist/deep-scan-defaults.d.ts +2 -0
- package/dist/deep-scan-defaults.d.ts.map +1 -1
- package/dist/deep-scan-defaults.js +28 -1
- package/dist/deep-scan-defaults.js.map +1 -1
- package/dist/deep-scan.d.ts +13 -0
- package/dist/deep-scan.d.ts.map +1 -1
- package/dist/deep-scan.js +262 -7
- package/dist/deep-scan.js.map +1 -1
- package/dist/default-severity-rubric.d.ts +1 -2
- package/dist/default-severity-rubric.d.ts.map +1 -1
- package/dist/default-severity-rubric.js +2 -66
- package/dist/default-severity-rubric.js.map +1 -1
- package/dist/endor-findings.d.ts +3 -1
- package/dist/endor-findings.d.ts.map +1 -1
- package/dist/endor-findings.js +108 -80
- package/dist/endor-findings.js.map +1 -1
- package/dist/errors.d.ts +1 -1
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +9 -2
- package/dist/errors.js.map +1 -1
- package/dist/external-findings-import.d.ts +5 -3
- package/dist/external-findings-import.d.ts.map +1 -1
- package/dist/external-findings-import.js +11 -16
- package/dist/external-findings-import.js.map +1 -1
- package/dist/external-findings-local.d.ts +15 -4
- package/dist/external-findings-local.d.ts.map +1 -1
- package/dist/external-findings-local.js +619 -225
- package/dist/external-findings-local.js.map +1 -1
- package/dist/external-findings-publish.d.ts +20 -6
- package/dist/external-findings-publish.d.ts.map +1 -1
- package/dist/external-findings-publish.js +2356 -308
- package/dist/external-findings-publish.js.map +1 -1
- package/dist/external-findings-read.d.ts +28 -2
- package/dist/external-findings-read.d.ts.map +1 -1
- package/dist/external-findings-read.js +174 -81
- package/dist/external-findings-read.js.map +1 -1
- package/dist/external-findings.d.ts +17 -3
- package/dist/external-findings.d.ts.map +1 -1
- package/dist/external-findings.js +153 -1
- package/dist/external-findings.js.map +1 -1
- package/dist/external-import-contract.d.ts +33 -1
- package/dist/external-import-contract.d.ts.map +1 -1
- package/dist/external-import-contract.js +335 -51
- package/dist/external-import-contract.js.map +1 -1
- package/dist/external-import-models.d.ts +1 -1
- package/dist/external-import-models.d.ts.map +1 -1
- package/dist/external-import-models.js.map +1 -1
- package/dist/feedback.d.ts.map +1 -1
- package/dist/feedback.js +5 -4
- package/dist/feedback.js.map +1 -1
- package/dist/finding-prompt.d.ts +5 -0
- package/dist/finding-prompt.d.ts.map +1 -0
- package/dist/finding-prompt.js +32 -0
- package/dist/finding-prompt.js.map +1 -0
- package/dist/finding-retrieval.d.ts +3 -3
- package/dist/finding-retrieval.d.ts.map +1 -1
- package/dist/finding-retrieval.js.map +1 -1
- package/dist/finding-workflow.d.ts +6 -1
- package/dist/finding-workflow.d.ts.map +1 -1
- package/dist/finding-workflow.js +2 -2
- package/dist/finding-workflow.js.map +1 -1
- package/dist/findings-client.d.ts +1 -0
- package/dist/findings-client.d.ts.map +1 -1
- package/dist/findings-client.js +27 -3
- package/dist/findings-client.js.map +1 -1
- package/dist/git-remote.d.ts +4 -0
- package/dist/git-remote.d.ts.map +1 -1
- package/dist/git-remote.js +20 -0
- package/dist/git-remote.js.map +1 -1
- package/dist/github-advisories.d.ts +3 -12
- package/dist/github-advisories.d.ts.map +1 -1
- package/dist/github-advisories.js +9 -31
- package/dist/github-advisories.js.map +1 -1
- package/dist/github-dependabot-findings.d.ts.map +1 -1
- package/dist/github-dependabot-findings.js +22 -20
- package/dist/github-dependabot-findings.js.map +1 -1
- package/dist/github-findings.d.ts +4 -1
- package/dist/github-findings.d.ts.map +1 -1
- package/dist/github-findings.js +392 -79
- package/dist/github-findings.js.map +1 -1
- package/dist/github.d.ts +17 -7
- package/dist/github.d.ts.map +1 -1
- package/dist/github.js +43 -30
- package/dist/github.js.map +1 -1
- package/dist/host-protocol.d.ts +2 -2
- package/dist/host-protocol.d.ts.map +1 -1
- package/dist/host-protocol.js.map +1 -1
- package/dist/host-records-protocol.d.ts +10 -11
- package/dist/host-records-protocol.d.ts.map +1 -1
- package/dist/host-records-protocol.js +69 -9
- package/dist/host-records-protocol.js.map +1 -1
- package/dist/hosted-git-remotes.d.ts +5 -0
- package/dist/hosted-git-remotes.d.ts.map +1 -0
- package/dist/hosted-git-remotes.js +285 -0
- package/dist/hosted-git-remotes.js.map +1 -0
- package/dist/hosted-git-repository.d.ts +28 -0
- package/dist/hosted-git-repository.d.ts.map +1 -0
- package/dist/hosted-git-repository.js +222 -0
- package/dist/hosted-git-repository.js.map +1 -0
- package/dist/hosted-scan-protocol.js +2 -2
- package/dist/hosted-scan-protocol.js.map +1 -1
- package/dist/hosted-scan.d.ts +15 -0
- package/dist/hosted-scan.d.ts.map +1 -1
- package/dist/hosted-scan.js +71 -44
- package/dist/hosted-scan.js.map +1 -1
- package/dist/hosted-scanner-http.d.ts +21 -0
- package/dist/hosted-scanner-http.d.ts.map +1 -0
- package/dist/hosted-scanner-http.js +204 -0
- package/dist/hosted-scanner-http.js.map +1 -0
- package/dist/hosted-scanner-v1.d.ts +6 -0
- package/dist/hosted-scanner-v1.d.ts.map +1 -0
- package/dist/hosted-scanner-v1.js +60 -0
- package/dist/hosted-scanner-v1.js.map +1 -0
- package/dist/import-scan.d.ts.map +1 -1
- package/dist/import-scan.js +3 -0
- package/dist/import-scan.js.map +1 -1
- package/dist/index.d.ts +24 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +15 -1
- package/dist/index.js.map +1 -1
- package/dist/inspector-findings.d.ts.map +1 -1
- package/dist/inspector-findings.js +58 -81
- package/dist/inspector-findings.js.map +1 -1
- package/dist/knowledge-base.d.ts.map +1 -1
- package/dist/knowledge-base.js +86 -10
- package/dist/knowledge-base.js.map +1 -1
- package/dist/local-git-metadata.d.ts +5 -0
- package/dist/local-git-metadata.d.ts.map +1 -0
- package/dist/local-git-metadata.js +130 -0
- package/dist/local-git-metadata.js.map +1 -0
- package/dist/multiscan.d.ts +6 -4
- package/dist/multiscan.d.ts.map +1 -1
- package/dist/multiscan.js +160 -77
- package/dist/multiscan.js.map +1 -1
- package/dist/native-json-findings.d.ts +2 -1
- package/dist/native-json-findings.d.ts.map +1 -1
- package/dist/native-json-findings.js +12 -2
- package/dist/native-json-findings.js.map +1 -1
- package/dist/opengrep-findings.d.ts +1 -0
- package/dist/opengrep-findings.d.ts.map +1 -1
- package/dist/opengrep-findings.js +49 -31
- package/dist/opengrep-findings.js.map +1 -1
- package/dist/operation-telemetry.d.ts +104 -0
- package/dist/operation-telemetry.d.ts.map +1 -0
- package/dist/operation-telemetry.js +293 -0
- package/dist/operation-telemetry.js.map +1 -0
- package/dist/patch-tui.d.ts.map +1 -1
- package/dist/patch-tui.js +90 -35
- package/dist/patch-tui.js.map +1 -1
- package/dist/plugin-python-probe.d.ts +4 -0
- package/dist/plugin-python-probe.d.ts.map +1 -0
- package/dist/plugin-python-probe.js +10 -0
- package/dist/plugin-python-probe.js.map +1 -0
- package/dist/private-finding-import.d.ts +341 -0
- package/dist/private-finding-import.d.ts.map +1 -0
- package/dist/private-finding-import.js +411 -0
- package/dist/private-finding-import.js.map +1 -0
- package/dist/project-config.d.ts.map +1 -1
- package/dist/project-config.js +2 -2
- package/dist/project-config.js.map +1 -1
- package/dist/provider-profile.d.ts +11 -3
- package/dist/provider-profile.d.ts.map +1 -1
- package/dist/provider-profile.js +80 -11
- package/dist/provider-profile.js.map +1 -1
- package/dist/publication-telemetry.d.ts +45 -0
- package/dist/publication-telemetry.d.ts.map +1 -0
- package/dist/publication-telemetry.js +50 -0
- package/dist/publication-telemetry.js.map +1 -0
- package/dist/publication.js +7 -1
- package/dist/publication.js.map +1 -1
- package/dist/publish.d.ts +4 -0
- package/dist/publish.d.ts.map +1 -1
- package/dist/publish.js +42 -2
- package/dist/publish.js.map +1 -1
- package/dist/reader-selection.d.ts +15 -0
- package/dist/reader-selection.d.ts.map +1 -0
- package/dist/reader-selection.js +89 -0
- package/dist/reader-selection.js.map +1 -0
- package/dist/record.d.ts +6 -1
- package/dist/record.d.ts.map +1 -1
- package/dist/record.js +53 -2
- package/dist/record.js.map +1 -1
- package/dist/remediation.d.ts +3 -1
- package/dist/remediation.d.ts.map +1 -1
- package/dist/remediation.js +28 -2
- package/dist/remediation.js.map +1 -1
- package/dist/request-metadata.d.ts +3 -0
- package/dist/request-metadata.d.ts.map +1 -1
- package/dist/request-metadata.js +9 -0
- package/dist/request-metadata.js.map +1 -1
- package/dist/result.d.ts +6 -0
- package/dist/result.d.ts.map +1 -1
- package/dist/result.js +3 -1
- package/dist/result.js.map +1 -1
- package/dist/retry-windows-rename.d.ts +8 -0
- package/dist/retry-windows-rename.d.ts.map +1 -0
- package/dist/retry-windows-rename.js +24 -0
- package/dist/retry-windows-rename.js.map +1 -0
- package/dist/runtime.d.ts +22 -1
- package/dist/runtime.d.ts.map +1 -1
- package/dist/runtime.js +408 -162
- package/dist/runtime.js.map +1 -1
- package/dist/saved-scan-bootstrap.d.ts +1 -0
- package/dist/saved-scan-bootstrap.d.ts.map +1 -1
- package/dist/saved-scan-bootstrap.js +18 -15
- package/dist/saved-scan-bootstrap.js.map +1 -1
- package/dist/scan-activity.d.ts.map +1 -1
- package/dist/scan-activity.js +172 -64
- package/dist/scan-activity.js.map +1 -1
- package/dist/scan-comparison.d.ts +10 -5
- package/dist/scan-comparison.d.ts.map +1 -1
- package/dist/scan-comparison.js +68 -25
- package/dist/scan-comparison.js.map +1 -1
- package/dist/scan-dashboard.d.ts +7 -6
- package/dist/scan-dashboard.d.ts.map +1 -1
- package/dist/scan-dashboard.js +91 -79
- package/dist/scan-dashboard.js.map +1 -1
- package/dist/scan-executor.d.ts +12 -1
- package/dist/scan-executor.d.ts.map +1 -1
- package/dist/scan-executor.js +22 -2
- package/dist/scan-executor.js.map +1 -1
- package/dist/scan-history-renderer.d.ts.map +1 -1
- package/dist/scan-history-renderer.js +31 -28
- package/dist/scan-history-renderer.js.map +1 -1
- package/dist/scan-logs.d.ts +12 -0
- package/dist/scan-logs.d.ts.map +1 -1
- package/dist/scan-logs.js +106 -77
- package/dist/scan-logs.js.map +1 -1
- package/dist/scan-measurement.d.ts +26 -0
- package/dist/scan-measurement.d.ts.map +1 -0
- package/dist/scan-measurement.js +77 -0
- package/dist/scan-measurement.js.map +1 -0
- package/dist/scan-progress.d.ts +1 -0
- package/dist/scan-progress.d.ts.map +1 -1
- package/dist/scan-progress.js +3 -0
- package/dist/scan-progress.js.map +1 -1
- package/dist/scan-sessions.d.ts.map +1 -1
- package/dist/scan-sessions.js +4 -1
- package/dist/scan-sessions.js.map +1 -1
- package/dist/scan-settings.d.ts +1 -1
- package/dist/scan-settings.d.ts.map +1 -1
- package/dist/scan-settings.js +1 -24
- package/dist/scan-settings.js.map +1 -1
- package/dist/scanner-import.d.ts +64 -6
- package/dist/scanner-import.d.ts.map +1 -1
- package/dist/scanner-import.js +406 -48
- package/dist/scanner-import.js.map +1 -1
- package/dist/scanner-repository-url.d.ts +17 -0
- package/dist/scanner-repository-url.d.ts.map +1 -0
- package/dist/scanner-repository-url.js +71 -0
- package/dist/scanner-repository-url.js.map +1 -0
- package/dist/security-policy.d.ts +1 -1
- package/dist/security-policy.d.ts.map +1 -1
- package/dist/security-policy.js.map +1 -1
- package/dist/semgrep-findings.d.ts +6 -3
- package/dist/semgrep-findings.d.ts.map +1 -1
- package/dist/semgrep-findings.js +124 -88
- package/dist/semgrep-findings.js.map +1 -1
- package/dist/semgrep-guardian-findings.d.ts +38 -0
- package/dist/semgrep-guardian-findings.d.ts.map +1 -0
- package/dist/semgrep-guardian-findings.js +165 -0
- package/dist/semgrep-guardian-findings.js.map +1 -0
- package/dist/semgrep-platform-collector.d.ts +26 -0
- package/dist/semgrep-platform-collector.d.ts.map +1 -0
- package/dist/semgrep-platform-collector.js +108 -0
- package/dist/semgrep-platform-collector.js.map +1 -0
- package/dist/semgrep-platform-findings.d.ts +213 -0
- package/dist/semgrep-platform-findings.d.ts.map +1 -0
- package/dist/semgrep-platform-findings.js +1078 -0
- package/dist/semgrep-platform-findings.js.map +1 -0
- package/dist/semgrep-platform-v1.d.ts +6 -0
- package/dist/semgrep-platform-v1.d.ts.map +1 -0
- package/dist/semgrep-platform-v1.js +83 -0
- package/dist/semgrep-platform-v1.js.map +1 -0
- package/dist/server/api.d.ts +1 -1
- package/dist/server/api.d.ts.map +1 -1
- package/dist/server/api.js.map +1 -1
- package/dist/server/embedding-tokenizer.cdx.json +33 -0
- package/dist/server/embedding-tokenizer.d.ts +2 -0
- package/dist/server/embedding-tokenizer.d.ts.map +1 -0
- package/dist/server/embedding-tokenizer.js +322 -0
- package/dist/server/embedding-tokenizer.js.map +6 -0
- package/dist/server/embeddings.d.ts +16 -2
- package/dist/server/embeddings.d.ts.map +1 -1
- package/dist/server/embeddings.js +35 -5
- package/dist/server/embeddings.js.map +1 -1
- package/dist/session-lines.d.ts +5 -0
- package/dist/session-lines.d.ts.map +1 -0
- package/dist/session-lines.js +60 -0
- package/dist/session-lines.js.map +1 -0
- package/dist/severity-review.d.ts +3 -1
- package/dist/severity-review.d.ts.map +1 -1
- package/dist/severity-review.js +3 -2
- package/dist/severity-review.js.map +1 -1
- package/dist/severity-rubric.d.ts +20 -0
- package/dist/severity-rubric.d.ts.map +1 -0
- package/dist/severity-rubric.js +73 -0
- package/dist/severity-rubric.js.map +1 -0
- package/dist/severity-store.js +15 -5
- package/dist/severity-store.js.map +1 -1
- package/dist/skill-authentication.d.ts +1 -0
- package/dist/skill-authentication.d.ts.map +1 -1
- package/dist/skill-authentication.js +1 -0
- package/dist/skill-authentication.js.map +1 -1
- package/dist/snyk-findings.d.ts +7 -2
- package/dist/snyk-findings.d.ts.map +1 -1
- package/dist/snyk-findings.js +108 -84
- package/dist/snyk-findings.js.map +1 -1
- package/dist/snyk-rest-findings.d.ts +76 -0
- package/dist/snyk-rest-findings.d.ts.map +1 -0
- package/dist/snyk-rest-findings.js +1051 -0
- package/dist/snyk-rest-findings.js.map +1 -0
- package/dist/snyk-rest-v1.d.ts +28 -0
- package/dist/snyk-rest-v1.d.ts.map +1 -0
- package/dist/snyk-rest-v1.js +132 -0
- package/dist/snyk-rest-v1.js.map +1 -0
- package/dist/snyk-token-origin.d.ts +4 -0
- package/dist/snyk-token-origin.d.ts.map +1 -0
- package/dist/snyk-token-origin.js +82 -0
- package/dist/snyk-token-origin.js.map +1 -0
- package/dist/sonar-collector.d.ts +16 -0
- package/dist/sonar-collector.d.ts.map +1 -0
- package/dist/sonar-collector.js +380 -0
- package/dist/sonar-collector.js.map +1 -0
- package/dist/sonar-findings.d.ts +49 -0
- package/dist/sonar-findings.d.ts.map +1 -0
- package/dist/sonar-findings.js +288 -0
- package/dist/sonar-findings.js.map +1 -0
- package/dist/sonar-import.d.ts +111 -0
- package/dist/sonar-import.d.ts.map +1 -0
- package/dist/sonar-import.js +277 -0
- package/dist/sonar-import.js.map +1 -0
- package/dist/suggest-owners.d.ts.map +1 -1
- package/dist/suggest-owners.js +2 -1
- package/dist/suggest-owners.js.map +1 -1
- package/dist/target-drift.d.ts +9 -0
- package/dist/target-drift.d.ts.map +1 -0
- package/dist/target-drift.js +27 -0
- package/dist/target-drift.js.map +1 -0
- package/dist/targets.d.ts +5 -0
- package/dist/targets.d.ts.map +1 -1
- package/dist/targets.js +73 -31
- package/dist/targets.js.map +1 -1
- package/dist/tenable-findings.d.ts +9 -0
- package/dist/tenable-findings.d.ts.map +1 -0
- package/dist/tenable-findings.js +122 -0
- package/dist/tenable-findings.js.map +1 -0
- package/dist/terminal-columns.d.ts +4 -0
- package/dist/terminal-columns.d.ts.map +1 -0
- package/dist/terminal-columns.js +19 -0
- package/dist/terminal-columns.js.map +1 -0
- package/dist/terminal-stream.d.ts +13 -0
- package/dist/terminal-stream.d.ts.map +1 -0
- package/dist/terminal-stream.js +35 -0
- package/dist/terminal-stream.js.map +1 -0
- package/dist/trivy-findings.d.ts +19 -0
- package/dist/trivy-findings.d.ts.map +1 -0
- package/dist/trivy-findings.js +435 -0
- package/dist/trivy-findings.js.map +1 -0
- package/dist/trivy-import.d.ts +19 -0
- package/dist/trivy-import.d.ts.map +1 -0
- package/dist/trivy-import.js +151 -0
- package/dist/trivy-import.js.map +1 -0
- package/dist/validation-records.d.ts +0 -3
- package/dist/validation-records.d.ts.map +1 -1
- package/dist/validation-records.js +1 -17
- package/dist/validation-records.js.map +1 -1
- package/dist/veracode-findings.d.ts +9 -0
- package/dist/veracode-findings.d.ts.map +1 -0
- package/dist/veracode-findings.js +409 -0
- package/dist/veracode-findings.js.map +1 -0
- package/dist/vertex-pricing.d.ts +8 -0
- package/dist/vertex-pricing.d.ts.map +1 -0
- package/dist/vertex-pricing.js +20 -0
- package/dist/vertex-pricing.js.map +1 -0
- package/dist/windows-path.d.ts +1 -0
- package/dist/windows-path.d.ts.map +1 -1
- package/dist/windows-path.js +27 -1
- package/dist/windows-path.js.map +1 -1
- package/dist/wiz-csv.d.ts +2 -2
- package/dist/wiz-csv.d.ts.map +1 -1
- package/dist/wiz-csv.js +1 -3
- package/dist/wiz-csv.js.map +1 -1
- package/dist/wiz-findings.d.ts +14 -2
- package/dist/wiz-findings.d.ts.map +1 -1
- package/dist/wiz-findings.js +143 -50
- package/dist/wiz-findings.js.map +1 -1
- package/docs/classify-severity-records.md +28 -13
- package/docs/cli.md +623 -843
- package/docs/dedupe-records.md +54 -24
- package/docs/findings-service.md +87 -47
- package/docs/hosted-remediation.md +14 -7
- package/docs/hosted-scans.md +64 -41
- package/docs/telemetry.md +236 -0
- package/docs/validate-records.md +78 -44
- package/package.json +19 -17
- package/schemas/external-findings.schema.json +14 -1
- package/schemas/hosted-scan-v2.fixture.json +16 -1
- package/_bundled_plugin/mcp/helpers.mjs.br.part-000 +0 -0
- package/_bundled_plugin/mcp/helpers.mjs.br.part-001 +0 -0
- package/_bundled_plugin/mcp/server.mjs.br.part-000 +0 -0
- package/_bundled_plugin/mcp/server.mjs.br.part-001 +0 -0
- package/_bundled_plugin/mcp/server.mjs.br.part-002 +0 -0
- package/_bundled_plugin/schemas/tools/deep-reducer.schema.json +0 -96
- package/_bundled_plugin/scripts/validate_tracking_source.py +0 -82
- package/_bundled_plugin/scripts/workbench_local_dedupe.py +0 -136
- package/dist/deduplication/records-protocol.d.ts +0 -4
- package/dist/deduplication/records-protocol.d.ts.map +0 -1
- package/dist/deduplication/records-protocol.js +0 -49
- package/dist/deduplication/records-protocol.js.map +0 -1
- package/dist/external-imports-feature.d.ts +0 -6
- package/dist/external-imports-feature.d.ts.map +0 -1
- package/dist/external-imports-feature.js +0 -51
- package/dist/external-imports-feature.js.map +0 -1
- package/dist/finding-normalization.d.ts +0 -5
- package/dist/finding-normalization.d.ts.map +0 -1
- package/dist/finding-normalization.js +0 -120
- package/dist/finding-normalization.js.map +0 -1
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
# Telemetry and measurement
|
|
2
|
+
|
|
3
|
+
Codex Security keeps model-request attribution, native analytics, local usage
|
|
4
|
+
accounting, and host-owned telemetry export separate. It does not configure a new
|
|
5
|
+
remote collector.
|
|
6
|
+
|
|
7
|
+
## Controls and collection
|
|
8
|
+
|
|
9
|
+
Native `analytics` and `otel` settings keep their Codex semantics. Scan profiles,
|
|
10
|
+
project settings, and explicit overrides keep their native precedence. Per-scan
|
|
11
|
+
settings are not merged into shared credential configuration. Discovery, reducer,
|
|
12
|
+
and resumed workers inherit their scan's settings. Worker runtime snapshots live
|
|
13
|
+
under the credential home denied to model tools. OTel exporter configuration can
|
|
14
|
+
contain authentication headers, so it is excluded from model-readable preflight
|
|
15
|
+
files and saved scan recipes while remaining available to native execution.
|
|
16
|
+
|
|
17
|
+
For authentication/bootstrap commands and stored-account CLI app-server startup,
|
|
18
|
+
automatic inheritance covers analytics consent and request metadata. OTel
|
|
19
|
+
exporters come from the selected native home or existing explicit runtime
|
|
20
|
+
configuration; ambient/profile exporter settings are not copied when
|
|
21
|
+
authentication selects another home. The pinned runtime cannot load a separate
|
|
22
|
+
private profile for these helpers without changing authentication/state identity.
|
|
23
|
+
The wrapper does not copy inherited exporter headers into arguments or
|
|
24
|
+
temporarily rewrite shared settings.
|
|
25
|
+
|
|
26
|
+
Request metadata includes command, surface, package/plugin versions, configured
|
|
27
|
+
provider family, and scan mode when available. Wrapper operations and workers add
|
|
28
|
+
opaque operation, attempt, and parent-attempt IDs. IDs are join keys, not metric
|
|
29
|
+
labels. Hosted scan execution receives the same attribution in
|
|
30
|
+
`request.runtime.requestMetadata`; the executor owns forwarding it to its runtime.
|
|
31
|
+
Native analytics opt-out does not remove request attribution or configure an OTel
|
|
32
|
+
exporter. Hosted schema and checkout preparation precede the SDK invocation;
|
|
33
|
+
rejections at that boundary remain the host's responsibility to record.
|
|
34
|
+
The [hosted remediation executor](./hosted-remediation.md) owns request
|
|
35
|
+
attribution, durable attempt tracking, and usage reporting for
|
|
36
|
+
`runHostedRemediation`.
|
|
37
|
+
|
|
38
|
+
Local operational receipts are saved under `telemetry/` in the existing Codex
|
|
39
|
+
Security state directory. These are local history, not an analytics upload.
|
|
40
|
+
Removing that directory removes these receipts and their resume bindings.
|
|
41
|
+
Receipts are never written inside the protected repository; a journal failure
|
|
42
|
+
remains observable and does not override the main operation.
|
|
43
|
+
Retention and remote deletion in a host's collector remain the host's
|
|
44
|
+
responsibility. Existing scan output, diagnostics, and explicit feedback retain
|
|
45
|
+
their existing behavior.
|
|
46
|
+
|
|
47
|
+
## Operation receipts
|
|
48
|
+
|
|
49
|
+
SDK `run`, `patch`, `validate`, and `generatePolicy` capture an `attempt_started`
|
|
50
|
+
receipt at invocation and one `attempt_finished` receipt on settlement. Local
|
|
51
|
+
initialization can delay start delivery; its occurrence time remains the original
|
|
52
|
+
invocation time. Inference preparation waits for that initialization.
|
|
53
|
+
CLI scans use the SDK path. Standalone CLI patch, validation, verification, and
|
|
54
|
+
patch-risk assessment also record native invocation starts and outcomes. Mock
|
|
55
|
+
scans and preflight-only calls are excluded. Policy generation emits its start to
|
|
56
|
+
observers immediately and buffers disk persistence until policy path validation
|
|
57
|
+
establishes all protected Git stores. Policy attempts rejected before that point
|
|
58
|
+
are observable only through `onTelemetry`; they do not create local state.
|
|
59
|
+
Finding workflows likewise defer persistence until explicit and saved artifact
|
|
60
|
+
paths have been protected. Their journal cannot write into either artifact tree,
|
|
61
|
+
including when the selected artifact directory occupies the journal path.
|
|
62
|
+
Each receipt has a schema version, stable event ID, random operation/attempt IDs,
|
|
63
|
+
occurrence and local observation times, command, surface, package version, and
|
|
64
|
+
resume status. Terminal receipts add duration, outcome, a bounded failure category,
|
|
65
|
+
and available numerical usage and result counts. Plugin version and configured
|
|
66
|
+
provider family are added once the runtime is known.
|
|
67
|
+
|
|
68
|
+
The terminal receipt embeds the last SDK measurement with its own `observedAt`
|
|
69
|
+
and available `coverageScope`. Saved workbench accounting may reconcile later
|
|
70
|
+
native evidence; terminal snapshots are not backfilled.
|
|
71
|
+
|
|
72
|
+
The outcome is `completed`, `failed`, `canceled`, or `unresolved`. A hosted
|
|
73
|
+
submission with unknown acceptance is unresolved. A start without a terminal
|
|
74
|
+
receipt, including process loss, also remains unresolved when summarized.
|
|
75
|
+
Completion describes operation execution; finding counts do not measure accuracy.
|
|
76
|
+
A terminal `reusedResult: true` identifies a cached workflow return. The summary
|
|
77
|
+
counts these as `reusedAttempts`; exclude them from new-work, finding-yield, and
|
|
78
|
+
usage-coverage denominators. Older receipts without the field have unrecorded
|
|
79
|
+
reuse status. Completed scans report the finding count and whether the scan
|
|
80
|
+
manifest records completion. Older receipts can also contain model-reported
|
|
81
|
+
reviewed surface and deferred counts.
|
|
82
|
+
|
|
83
|
+
Resuming a saved scan keeps its operation ID but creates a new attempt ID.
|
|
84
|
+
`usageScopeId` identifies cumulative accounting across those attempts. Do not sum
|
|
85
|
+
resumed cumulative receipts. The supplied summary takes the maximum observed cost
|
|
86
|
+
per usage scope; separate retry scans have separate scopes.
|
|
87
|
+
|
|
88
|
+
Pass the Codex Security state directory as the first argument to this script.
|
|
89
|
+
Use `CODEX_SECURITY_STATE_DIR` if you set it, or the default
|
|
90
|
+
`$CODEX_HOME/state/plugins/codex-security`. The reader looks for `telemetry/`
|
|
91
|
+
inside that directory.
|
|
92
|
+
|
|
93
|
+
```ts
|
|
94
|
+
import {
|
|
95
|
+
readOperationTelemetry,
|
|
96
|
+
summarizeOperationTelemetry,
|
|
97
|
+
} from "@openai/codex-security";
|
|
98
|
+
|
|
99
|
+
const stateDirectory = process.argv[2];
|
|
100
|
+
if (!stateDirectory)
|
|
101
|
+
throw new Error("Pass the Codex Security state directory.");
|
|
102
|
+
const { events, parseFailures } = await readOperationTelemetry(stateDirectory);
|
|
103
|
+
const summary = summarizeOperationTelemetry(events);
|
|
104
|
+
console.log({ ...summary, parseFailures });
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
The reader reports corrupt/truncated records separately from usable receipts. The
|
|
108
|
+
summary deduplicates event IDs, counts attempts and logical operations separately,
|
|
109
|
+
retains unresolved attempts, and reports usage coverage and priced-attempt counts
|
|
110
|
+
beside observed cost. Duration samples can be pooled into histograms or
|
|
111
|
+
percentiles; do not average percentiles from separate groups.
|
|
112
|
+
|
|
113
|
+
`onTelemetry` is an optional SDK observer for these same receipts. An observer
|
|
114
|
+
cannot delay or fail a scan. It is not an acknowledgement from a remote collector.
|
|
115
|
+
A host needing delivery across restarts should replay the local journal, dedupe
|
|
116
|
+
by event ID, and checkpoint only after its collector acknowledges acceptance.
|
|
117
|
+
Ingestion should add its own timestamp while preserving `occurredAt`.
|
|
118
|
+
Journal write failures reach the warning observer; receipt collection counters
|
|
119
|
+
describe local persistence only. They do not claim remote acceptance.
|
|
120
|
+
|
|
121
|
+
Track collector pending, accepted, retried, dropped/expired, duplicate, and late
|
|
122
|
+
records at the integration that owns delivery. Reconcile emitted event IDs against
|
|
123
|
+
accepted IDs there. Local tests exercise failed writes, replay, duplicate
|
|
124
|
+
terminals, corrupt tails, and unclosed attempts; they do not establish a
|
|
125
|
+
production collector's loss rate.
|
|
126
|
+
|
|
127
|
+
## Usage and completeness
|
|
128
|
+
|
|
129
|
+
Use `onMeasurement` on your SDK client to see usage during a scan of your checkout:
|
|
130
|
+
|
|
131
|
+
```ts
|
|
132
|
+
await security.run(repository, {
|
|
133
|
+
onMeasurement(measurement) {
|
|
134
|
+
// usage and cost may be null; partial values are observed subtotals.
|
|
135
|
+
console.log(measurement.usage, measurement.cost, measurement.coverage);
|
|
136
|
+
},
|
|
137
|
+
});
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
The observation contains `usage`, `cost`, `coverage`, `observedAt`, measured
|
|
141
|
+
`threadCount`, and `missingThreadCount`. Coverage is `complete`, `partial`, or
|
|
142
|
+
`unavailable`. An incompletely measured thread can contribute to both thread
|
|
143
|
+
counts. Complete coverage means all discovered threads are accounted for;
|
|
144
|
+
descendants absent from native metadata and worker receipts cannot be detected.
|
|
145
|
+
A newly discovered worker can change complete usage to partial. The
|
|
146
|
+
dashboard updates the qualifier and clears unavailable values. Existing
|
|
147
|
+
`onUsage` and `onCost` observers retain their complete-only behavior; budget
|
|
148
|
+
enforcement still uses known spending subtotals.
|
|
149
|
+
|
|
150
|
+
Coverage applies to the tracked scan threads, including optional owner evidence
|
|
151
|
+
recorded during the scan. Automatic owner reports validate that evidence without
|
|
152
|
+
additional model calls. Standalone owner suggestions, finding comparisons, and
|
|
153
|
+
severity-review helpers do not contribute usage to these scan/component subtotals.
|
|
154
|
+
|
|
155
|
+
When available, `coverageScope` identifies every discovered thread and worker
|
|
156
|
+
attempt, including missing measurements. Saved reconciliation clears a known gap
|
|
157
|
+
only when newer complete evidence covers that entire scope. A newer observation
|
|
158
|
+
that does not encompass the retained scope leaves the maximum reported subtotal
|
|
159
|
+
partial, even when both observations individually report complete. The
|
|
160
|
+
`usage_scope_incomplete` warning identifies these unreconciled scope totals;
|
|
161
|
+
later encompassing complete evidence clears that uncertainty. Reconciliation
|
|
162
|
+
retains the union of known identities and the largest reported missing-thread
|
|
163
|
+
count. Overlapping aggregates cannot establish an exact combined missing-thread
|
|
164
|
+
count. Legacy observations without a scope cannot prove that their gaps were
|
|
165
|
+
resolved.
|
|
166
|
+
These identities belong in local records, not metric labels.
|
|
167
|
+
|
|
168
|
+
Saved success, failure, and cancellation records retain numerical usage even
|
|
169
|
+
without a model price. Repeated terminal updates reconcile late observations
|
|
170
|
+
without changing the saved outcome or summing overlapping receipts. Component
|
|
171
|
+
and bulk receipts also keep failed/canceled usage. Legacy receipt status values
|
|
172
|
+
are preserved; their additive `outcome` distinguishes cancellation.
|
|
173
|
+
Bulk recovery of an already sealed scan copies the saved `usage` object with its
|
|
174
|
+
original source, observation time, coverage, and scope into the receipt without
|
|
175
|
+
creating a new inference attempt or live measurement.
|
|
176
|
+
|
|
177
|
+
Both live and saved collectors read plain and compressed rollouts. Deep workers
|
|
178
|
+
persist a receipt per attempt before validating their output, including failed
|
|
179
|
+
and canceled attempts. These receipts live under
|
|
180
|
+
`codex-home/worker-usage/<scanId>/` in the host's Codex Security state directory,
|
|
181
|
+
with the scan and worker permission profiles protecting the host-managed store.
|
|
182
|
+
Collectors bind receipts to the selected scan and attempt; model-authored scan
|
|
183
|
+
artifacts cannot introduce usage totals or authorize reading another session.
|
|
184
|
+
Worker receipts remain local runtime state, subject to the host's retention and
|
|
185
|
+
deletion policy. The pinned native CLI reports cumulative thread usage at
|
|
186
|
+
turn completion. Receipts mark this as `usageScope: "thread_cumulative"`:
|
|
187
|
+
resumed attempts on the same thread are reconciled by maximum, then compared
|
|
188
|
+
with the native thread total by maximum, preserving whole cumulative snapshots.
|
|
189
|
+
Separate threads are summed. Missing native evidence
|
|
190
|
+
keeps worker fallback usage partial, including when the native state database is
|
|
191
|
+
unavailable.
|
|
192
|
+
|
|
193
|
+
Missing cache-write usage is represented with
|
|
194
|
+
`cache_write_input_tokens_reported: false` in SDK token usage and
|
|
195
|
+
`cacheWriteInputTokensReported: false` in saved usage. Its numeric zero is a
|
|
196
|
+
placeholder, not an observed zero. Worker receipts also treat SDK-defaulted zeroes
|
|
197
|
+
without field-presence evidence as unknown. Known total usage remains usable. Cost is an
|
|
198
|
+
estimate with its existing price provenance and uncertainty, not a billing total.
|
|
199
|
+
Late saved usage can exceed an earlier supplied price estimate; the warning
|
|
200
|
+
`cost_estimate_covers_earlier_usage` identifies that cost subtotal.
|
|
201
|
+
|
|
202
|
+
Embedding batch usage is observed separately through `onEmbeddingUsage`. Provider
|
|
203
|
+
input tokens can be unknown; local token estimates do not replace a missing
|
|
204
|
+
provider receipt. Publication telemetry uses existing publication results and
|
|
205
|
+
receipts, with destination family, duration, outcome, and counts. An upsert
|
|
206
|
+
acknowledgement does not establish whether a finding was newly created or reused;
|
|
207
|
+
those counts remain unknown when the integration cannot distinguish them.
|
|
208
|
+
|
|
209
|
+
## Reporting and data selection
|
|
210
|
+
|
|
211
|
+
Routine operation telemetry contains no source, prompts, model output, finding
|
|
212
|
+
text, paths, repository URLs, account IDs, raw exceptions, or full configuration.
|
|
213
|
+
This field selection does not redact or change existing diagnostic text.
|
|
214
|
+
|
|
215
|
+
Use bounded dimensions such as command, surface, scan mode, worker role, outcome,
|
|
216
|
+
and provider family. Keep correlation IDs out of metric labels. Report the
|
|
217
|
+
population, sample count, missingness, and relevant version/workload cohorts with
|
|
218
|
+
every comparison:
|
|
219
|
+
|
|
220
|
+
- Reliability: terminal outcomes per eligible attempt, unresolved rate, and
|
|
221
|
+
eventual operation success separately.
|
|
222
|
+
- Performance: attempt duration distributions, separating cancellation and
|
|
223
|
+
incomplete work.
|
|
224
|
+
- Cost: all observed usage scopes, including failed attempts, divided by useful
|
|
225
|
+
completed outcomes; show partial-usage and unknown-price rates alongside.
|
|
226
|
+
- Caching: cache-read/write shares only where the required breakdown is observed.
|
|
227
|
+
- Worker efficiency: attempts, retries, duration, usage coverage, and accepted
|
|
228
|
+
output by role.
|
|
229
|
+
- Quality: reviewed true-positive share among adjudicated findings, with review
|
|
230
|
+
coverage. Unreviewed findings are unknown. Publication and patch outcomes are
|
|
231
|
+
separate signals.
|
|
232
|
+
|
|
233
|
+
The latest closed false positives used as scan context are a selected sample,
|
|
234
|
+
not a false-positive-rate denominator. Recall requires held-out labeled
|
|
235
|
+
evaluations or independent representative review; production finding counts
|
|
236
|
+
cannot establish it.
|
package/docs/validate-records.md
CHANGED
|
@@ -1,16 +1,15 @@
|
|
|
1
1
|
# Host-provided standalone validation (protocol v1)
|
|
2
2
|
|
|
3
|
-
Run `codex-security validate --records` with that flag alone
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
3
|
+
Run `codex-security validate --records` with that flag alone to assess findings
|
|
4
|
+
against source evidence. Your host provides the authorized checkout, runs the
|
|
5
|
+
model and decides whether to update stored findings. For the CLI-managed model
|
|
6
|
+
and sandbox, use [standalone validation](cli.md#validate-and-patch-findings).
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
one JSON object per line, one `run` request, and `review.run` requests answered
|
|
10
|
-
by the host. Keep stdin open until the final response. Cancellation, disconnects,
|
|
11
|
-
and host errors terminate the invocation without retrying the review.
|
|
8
|
+
## Send the findings
|
|
12
9
|
|
|
13
|
-
|
|
10
|
+
Use the [records transport](dedupe-records.md#input-and-identities). Send one
|
|
11
|
+
JSON-RPC `run` request with the following `params`. Give each finding a unique,
|
|
12
|
+
nonempty host ID and enough source evidence to assess it.
|
|
14
13
|
|
|
15
14
|
```json
|
|
16
15
|
{
|
|
@@ -18,52 +17,87 @@ The `run` request's `params` has this shape:
|
|
|
18
17
|
"findings": [
|
|
19
18
|
{
|
|
20
19
|
"id": "finding-1",
|
|
21
|
-
"finding": {
|
|
20
|
+
"finding": {
|
|
21
|
+
"title": "Missing tenant filter",
|
|
22
|
+
"location": "src/invoices.ts:24",
|
|
23
|
+
"evidence": "The lookup accepts an invoice ID from the route."
|
|
24
|
+
}
|
|
22
25
|
}
|
|
23
26
|
],
|
|
24
|
-
"context": "Optional deployment facts or reviewer feedback.",
|
|
25
|
-
"knowledgeBasePath": "/validation/context",
|
|
26
27
|
"outputSchema": {
|
|
27
28
|
"type": "object",
|
|
28
|
-
"properties": {
|
|
29
|
-
|
|
29
|
+
"properties": {
|
|
30
|
+
"assessments": {
|
|
31
|
+
"type": "array",
|
|
32
|
+
"items": {
|
|
33
|
+
"type": "object",
|
|
34
|
+
"properties": {
|
|
35
|
+
"id": { "type": "string" },
|
|
36
|
+
"rationale": { "type": "string" }
|
|
37
|
+
},
|
|
38
|
+
"required": ["id", "rationale"],
|
|
39
|
+
"additionalProperties": false
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
"required": ["assessments"],
|
|
30
44
|
"additionalProperties": false
|
|
31
45
|
}
|
|
32
46
|
}
|
|
33
47
|
```
|
|
34
48
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
not instructions or automatic dismissal rules.
|
|
49
|
+
The `finding` value preserves the caller's format. Optional `context` supplies
|
|
50
|
+
deployment facts or reviewer feedback. Optional `knowledgeBasePath` points to a
|
|
51
|
+
directory already present in the host's review environment. Treat its contents
|
|
52
|
+
and reviewer feedback as evidence to check against source. Optional `model`
|
|
53
|
+
and `effort` override the SDK defaults.
|
|
41
54
|
|
|
42
|
-
|
|
43
|
-
not define a standard disposition or product status model. The host must verify
|
|
44
|
-
finding ID coverage and any application-specific conditions before changing
|
|
45
|
-
published findings. Optional `model` and `effort` override the SDK's default
|
|
46
|
-
model configuration. Local configuration files and CLI model flags are not read.
|
|
55
|
+
## Run the review
|
|
47
56
|
|
|
48
|
-
The CLI
|
|
49
|
-
`trustedInstructions`, `prompt`, and `schema`. The host
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
execution failure exits with code 2. SIGINT and SIGTERM
|
|
55
|
-
retain exit codes 130 and 143.
|
|
57
|
+
The CLI sends one `review.run` with `requestId`, `model`, `effort`,
|
|
58
|
+
`trustedInstructions`, `prompt`, and `schema`. The host authorizes source
|
|
59
|
+
access, provides model credentials, and enforces a source-only review with
|
|
60
|
+
builds, tests, target execution and network investigation disabled. Return the
|
|
61
|
+
structured answer using the review request's JSON-RPC ID. Keep stdin open
|
|
62
|
+
until the final response.
|
|
56
63
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
target execution, or network investigation. This mode does not configure a local
|
|
62
|
-
Codex sandbox; regular `validate` retains its existing read-only sandbox. A
|
|
63
|
-
protocol success only proves that the answer matched the schema; it does not
|
|
64
|
-
establish assessment quality.
|
|
64
|
+
The CLI checks the answer against the required `outputSchema` and returns
|
|
65
|
+
`{ "status": "completed", "result": <assessment> }` in the final JSON-RPC
|
|
66
|
+
`result`. A schema match checks the structure of the answer. The host decides
|
|
67
|
+
which dispositions, evidence and other conditions justify a record update.
|
|
65
68
|
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
the
|
|
69
|
+
## Check the returned IDs
|
|
70
|
+
|
|
71
|
+
Before updating any records, check that the assessment names each input ID
|
|
72
|
+
exactly once. In this JavaScript example, pass the original `params.findings`
|
|
73
|
+
and the `assessments` array from the schema-checked answer.
|
|
74
|
+
|
|
75
|
+
```js
|
|
76
|
+
function checkFindingIds(findings, assessments) {
|
|
77
|
+
const remaining = new Set(findings.map((finding) => finding.id));
|
|
78
|
+
for (const { id } of assessments) {
|
|
79
|
+
if (!remaining.delete(id)) {
|
|
80
|
+
throw new Error(`Duplicate or unexpected finding ID: ${id}`);
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
if (remaining.size > 0) {
|
|
84
|
+
throw new Error(`Missing finding IDs: ${[...remaining].join(", ")}`);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
For the example above, the final message's
|
|
90
|
+
`result.result.assessments` might contain
|
|
91
|
+
`[{"id":"finding-1","rationale":"The lookup at src/invoices.ts:24 also filters on the authenticated tenant."}]`.
|
|
92
|
+
A missing, repeated or unfamiliar ID must stop the update.
|
|
93
|
+
|
|
94
|
+
Completion exits with code 0. Invalid input, invalid output or execution
|
|
95
|
+
failure exits with code 2. SIGINT and SIGTERM use 130 and 143. Cancellation,
|
|
96
|
+
disconnects and host errors terminate the invocation without retrying the review.
|
|
97
|
+
The host owns remote cancellation, usage and cleanup.
|
|
98
|
+
|
|
99
|
+
The SDK exports `validateRecords(input, { reviewRunner, signal })` from
|
|
100
|
+
`@openai/codex-security`. Its runner's `run(request, { signal })` method
|
|
101
|
+
returns the structured answer, and the SDK returns that answer after the schema
|
|
102
|
+
check. `ValidateRecordsInput`, `ValidateRecordsOptions` and
|
|
69
103
|
`ValidationReviewRequest` are exported types.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openai/codex-security",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.9.1",
|
|
4
4
|
"description": "TypeScript SDK and CLI for Codex Security",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "OpenAI",
|
|
@@ -48,7 +48,8 @@
|
|
|
48
48
|
"docs/classify-severity-records.md",
|
|
49
49
|
"docs/hosted-scans.md",
|
|
50
50
|
"docs/validate-records.md",
|
|
51
|
-
"docs/hosted-remediation.md"
|
|
51
|
+
"docs/hosted-remediation.md",
|
|
52
|
+
"docs/telemetry.md"
|
|
52
53
|
],
|
|
53
54
|
"publishConfig": {
|
|
54
55
|
"access": "public",
|
|
@@ -57,18 +58,20 @@
|
|
|
57
58
|
]
|
|
58
59
|
},
|
|
59
60
|
"dependencies": {
|
|
60
|
-
"@inquirer/
|
|
61
|
-
"@
|
|
61
|
+
"@inquirer/checkbox": "5.2.8",
|
|
62
|
+
"@inquirer/confirm": "6.3.5",
|
|
63
|
+
"@inquirer/input": "5.1.9",
|
|
64
|
+
"@inquirer/search": "4.3.6",
|
|
65
|
+
"@linear/sdk": "100.0.0",
|
|
62
66
|
"@octokit/core": "7.0.8",
|
|
63
|
-
"@openai/codex": "0.
|
|
64
|
-
"@openai/codex-sdk": "0.
|
|
67
|
+
"@openai/codex": "0.167.0",
|
|
68
|
+
"@openai/codex-sdk": "0.167.0",
|
|
65
69
|
"ajv": "8.20.0",
|
|
66
70
|
"fflate": "0.8.3",
|
|
67
71
|
"incur": "0.7.1",
|
|
68
72
|
"ink": "8.0.0",
|
|
69
|
-
"js-tiktoken": "1.0.21",
|
|
70
73
|
"papaparse": "5.7.0",
|
|
71
|
-
"pdfjs-dist": "6.
|
|
74
|
+
"pdfjs-dist": "6.5.438",
|
|
72
75
|
"react": "19.3.1",
|
|
73
76
|
"saxes": "6.0.0",
|
|
74
77
|
"semver": "7.8.5",
|
|
@@ -80,9 +83,8 @@
|
|
|
80
83
|
"zod": "4.6.7"
|
|
81
84
|
},
|
|
82
85
|
"devDependencies": {
|
|
83
|
-
"@
|
|
84
|
-
"@types/
|
|
85
|
-
"@types/node": "26.6.5",
|
|
86
|
+
"@types/bun": "1.4.4",
|
|
87
|
+
"@types/node": "26.6.6",
|
|
86
88
|
"@types/papaparse": "5.5.2",
|
|
87
89
|
"@types/react": "19.3.0",
|
|
88
90
|
"@types/semver": "7.8.0",
|
|
@@ -90,24 +92,24 @@
|
|
|
90
92
|
"esbuild": "0.28.2",
|
|
91
93
|
"fast-check": "4.10.2",
|
|
92
94
|
"ink-testing-library": "4.0.0",
|
|
95
|
+
"js-tiktoken": "1.0.21",
|
|
93
96
|
"json-schema-to-typescript": "16.0.0",
|
|
94
97
|
"json5": "2.2.3",
|
|
95
|
-
"minimatch": "10.2.6",
|
|
96
98
|
"prettier": "3.9.10",
|
|
97
99
|
"typescript": "7.0.2"
|
|
98
100
|
},
|
|
99
|
-
"gitHead": "
|
|
101
|
+
"gitHead": "fe1089ab514599931ff0ce77a82dc8c4a99201ea",
|
|
100
102
|
"scripts": {
|
|
101
103
|
"audit:prod": "pnpm audit --prod --audit-level high",
|
|
102
104
|
"clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
|
|
103
|
-
"build": "node --run clean && node scripts/generate-
|
|
105
|
+
"build": "node --run clean && node scripts/generate-plugin-defaults.mjs && tsc -p tsconfig.build.json && node scripts/build-embedding-tokenizer.mjs",
|
|
104
106
|
"build:ci": "tsc -p tsconfig.ci.json",
|
|
105
107
|
"build:evals": "node --run build && tsc -p ../../evals/tsconfig.json",
|
|
106
108
|
"build:examples": "tsc -p tsconfig.examples.json",
|
|
107
109
|
"build:plugin": "node scripts/build-plugin.mjs",
|
|
108
110
|
"check:plugin-source": "node scripts/check-plugin-source.mjs",
|
|
109
111
|
"check:package": "node scripts/check-package.mjs",
|
|
110
|
-
"format": "prettier --check --ignore-path .gitignore --ignore-path .prettierignore \"**/*.{cjs,mjs,js,ts,mts,tsx,json}\" \"../../.github/scripts/*.mts\" \"../../examples/custom-validation/*.mts\" \"../../plugins/codex-security/native/*.mts\" \"../../evals/{
|
|
112
|
+
"format": "prettier --check --ignore-path .gitignore --ignore-path .prettierignore \"**/*.{cjs,mjs,js,ts,mts,tsx,json}\" \"../../.github/scripts/*.mts\" \"../../examples/custom-validation/*.mts\" \"../../plugins/codex-security/native/*.mts\" \"../../evals/{secret-discovery,standard-time-budget,workflow-routing}/*.mts\" \"../../evals/triage-finding/{assertions,scripts,sastbench/assertions,sastbench/scripts}/*.mts\" \"../../evals/triage-finding/types.ts\" \"../../evals/tsconfig.json\" && node scripts/check-markdown.mjs",
|
|
111
113
|
"generate:models": "node scripts/generate-models.cjs",
|
|
112
114
|
"generate:models:check": "node scripts/generate-models.cjs --check",
|
|
113
115
|
"generate:external-import-models": "node scripts/generate-external-import-models.cjs",
|
|
@@ -116,8 +118,8 @@
|
|
|
116
118
|
"test": "node --run build:plugin && bun test --timeout 30000 ./tests-ts",
|
|
117
119
|
"test:ci": "node -e \"require('node:fs').mkdirSync('reports',{recursive:true})\" && pnpm run test --coverage --coverage-reporter=text --coverage-reporter=lcov --reporter=junit --reporter-outfile=reports/junit.xml",
|
|
118
120
|
"test:mcp": "node --run build:plugin && pnpm --dir ../../plugins/codex-security/mcp-app run test:mcp",
|
|
119
|
-
"test:mutation": "
|
|
121
|
+
"test:mutation": "pnpm --dir ../mutation install --frozen-lockfile && pnpm --dir ../mutation run test:sdk",
|
|
120
122
|
"test:package": "node scripts/smoke-package.mjs",
|
|
121
|
-
"types": "node scripts/generate-
|
|
123
|
+
"types": "node scripts/generate-plugin-defaults.mjs --check && pnpm run generate:models:check && pnpm run generate:external-import-models:check && pnpm --dir ../../plugins/codex-security/mcp-app run typecheck && tsc --noEmit"
|
|
122
124
|
}
|
|
123
125
|
}
|
|
@@ -378,7 +378,20 @@
|
|
|
378
378
|
"additionalProperties": false,
|
|
379
379
|
"properties": {
|
|
380
380
|
"provider": {
|
|
381
|
-
"enum": [
|
|
381
|
+
"enum": [
|
|
382
|
+
"wiz",
|
|
383
|
+
"endor",
|
|
384
|
+
"snyk",
|
|
385
|
+
"github",
|
|
386
|
+
"semgrep",
|
|
387
|
+
"inspector",
|
|
388
|
+
"blackduck",
|
|
389
|
+
"veracode",
|
|
390
|
+
"sonar",
|
|
391
|
+
"continuum",
|
|
392
|
+
"checkmarx",
|
|
393
|
+
"trivy"
|
|
394
|
+
],
|
|
382
395
|
"title": "Provider",
|
|
383
396
|
"type": "string"
|
|
384
397
|
},
|
|
@@ -14,6 +14,11 @@
|
|
|
14
14
|
"stateDirectory": "/scan/state",
|
|
15
15
|
"model": "fixture-model",
|
|
16
16
|
"reasoningEffort": "medium",
|
|
17
|
+
"severityRubric": {
|
|
18
|
+
"markdown": "# Security team rubric\n\nGrade the impact on the affected tenant.\n",
|
|
19
|
+
"revision": 3,
|
|
20
|
+
"sha256": "0735ad8680e64cc58dae0f2ac171cfbe98816494176fe95ca28b122476b61cfa"
|
|
21
|
+
},
|
|
17
22
|
"identity": {
|
|
18
23
|
"runId": "run-1",
|
|
19
24
|
"attemptId": "attempt-1",
|
|
@@ -39,9 +44,14 @@
|
|
|
39
44
|
},
|
|
40
45
|
"model": "fixture-model",
|
|
41
46
|
"reasoningEffort": "medium",
|
|
47
|
+
"severityRubric": {
|
|
48
|
+
"markdown": "# Security team rubric\n\nGrade the impact on the affected tenant.\n",
|
|
49
|
+
"revision": 3,
|
|
50
|
+
"sha256": "0735ad8680e64cc58dae0f2ac171cfbe98816494176fe95ca28b122476b61cfa"
|
|
51
|
+
},
|
|
42
52
|
"requestId": "request-1",
|
|
43
53
|
"scanId": "scan-1",
|
|
44
|
-
"prompt": "Scan the selected paths
|
|
54
|
+
"prompt": "Scan the selected paths using the supplied severity rubric.\n{\"severityRubric\":{\"markdown\":\"# Security team rubric\\n\\nGrade the impact on the affected tenant.\\n\",\"revision\":3,\"sha256\":\"0735ad8680e64cc58dae0f2ac171cfbe98816494176fe95ca28b122476b61cfa\"}}",
|
|
45
55
|
"runtime": {
|
|
46
56
|
"pluginRoot": "/opt/runtime/cli/_bundled_plugin",
|
|
47
57
|
"pluginVersion": "0.1.95",
|
|
@@ -99,6 +109,11 @@
|
|
|
99
109
|
"attemptId": "attempt-1",
|
|
100
110
|
"buildId": "fixture-build"
|
|
101
111
|
},
|
|
112
|
+
"severityRubric": {
|
|
113
|
+
"markdown": "# Security team rubric\n\nGrade the impact on the affected tenant.\n",
|
|
114
|
+
"revision": 3,
|
|
115
|
+
"sha256": "0735ad8680e64cc58dae0f2ac171cfbe98816494176fe95ca28b122476b61cfa"
|
|
116
|
+
},
|
|
102
117
|
"outputDirectory": "/scan/output",
|
|
103
118
|
"status": "completed",
|
|
104
119
|
"scanId": "scan-1",
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|