@openai/codex-security 0.7.0 → 0.8.0
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 +10 -4
- package/_bundled_plugin/examples/completed-scan/findings.json +34 -34
- package/_bundled_plugin/examples/completed-scan/report.md +22 -31
- package/_bundled_plugin/examples/completed-scan/scan-manifest.json +27 -29
- package/_bundled_plugin/examples/{completed-scan → legacy-completed-scan}/coverage.json +1 -0
- package/_bundled_plugin/examples/legacy-completed-scan/findings.json +57 -0
- package/_bundled_plugin/examples/legacy-completed-scan/report.md +98 -0
- package/_bundled_plugin/examples/legacy-completed-scan/scan-manifest.json +43 -0
- 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/native/win32-arm64/windows.node +0 -0
- package/_bundled_plugin/mcp/native/win32-x64/windows.node +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/references/core-scan.md +2 -2
- package/_bundled_plugin/references/final-report.md +16 -6
- package/_bundled_plugin/references/scan-artifacts.md +5 -5
- package/_bundled_plugin/references/scan-contract.md +10 -12
- package/_bundled_plugin/references/threat-model.md +1 -1
- package/_bundled_plugin/schemas/scan-manifest.schema.json +36 -11
- package/_bundled_plugin/schemas/tools/scan-draft.schema.json +5 -5
- package/_bundled_plugin/scripts/deep_scan_workbench.py +1 -1
- package/_bundled_plugin/scripts/finalize_scan_contract.py +60 -19
- package/_bundled_plugin/scripts/report_projection.py +5 -2
- package/_bundled_plugin/scripts/review_state.py +68 -0
- package/_bundled_plugin/scripts/validate_scan_contract.py +1 -2
- package/_bundled_plugin/scripts/workbench/retained_coverage.py +49 -37
- package/_bundled_plugin/scripts/workbench/retained_records.py +7 -7
- package/_bundled_plugin/scripts/workbench/saved_coverage.py +15 -15
- package/_bundled_plugin/scripts/workbench/saved_sources.py +24 -6
- package/_bundled_plugin/scripts/workbench_constants.py +0 -1
- package/_bundled_plugin/scripts/workbench_coverage_receipts.py +4 -4
- package/_bundled_plugin/scripts/workbench_db.py +5 -150
- package/_bundled_plugin/scripts/workbench_saved_results.py +169 -4
- package/_bundled_plugin/scripts/workbench_scan_history.py +12 -7
- package/_bundled_plugin/skills/publish-findings/SKILL.md +5 -1
- package/_bundled_plugin/skills/security-diff-scan/SKILL.md +1 -1
- package/_bundled_plugin/skills/security-scan/SKILL.md +6 -6
- package/_bundled_plugin/skills/track-findings/SKILL.md +1 -1
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js +19 -17
- package/dist/api.js.map +1 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +28 -17
- package/dist/cli.js.map +1 -1
- package/dist/cloud-publish.d.ts.map +1 -1
- package/dist/cloud-publish.js +2 -23
- package/dist/cloud-publish.js.map +1 -1
- package/dist/contract.d.ts +3 -2
- package/dist/contract.d.ts.map +1 -1
- package/dist/contract.js +28 -14
- package/dist/contract.js.map +1 -1
- package/dist/custom-publish.js +2 -2
- package/dist/custom-publish.js.map +1 -1
- package/dist/custom-validation-prompt.js +5 -5
- package/dist/custom-validation-prompt.js.map +1 -1
- package/dist/custom-validation.d.ts.map +1 -1
- package/dist/custom-validation.js +17 -15
- package/dist/custom-validation.js.map +1 -1
- package/dist/deduplication/codex-review.d.ts.map +1 -1
- package/dist/deduplication/codex-review.js +2 -2
- package/dist/deduplication/codex-review.js.map +1 -1
- package/dist/deduplication/deduplication-prompts.d.ts +1 -0
- package/dist/deduplication/deduplication-prompts.d.ts.map +1 -1
- package/dist/deduplication/deduplication-prompts.js +3 -0
- package/dist/deduplication/deduplication-prompts.js.map +1 -1
- package/dist/deduplication/records-protocol.d.ts.map +1 -1
- package/dist/deduplication/records-protocol.js +21 -1
- package/dist/deduplication/records-protocol.js.map +1 -1
- package/dist/deduplication/scan.d.ts.map +1 -1
- package/dist/deduplication/scan.js +2 -2
- package/dist/deduplication/scan.js.map +1 -1
- package/dist/external-findings-local.d.ts +1 -0
- package/dist/external-findings-local.d.ts.map +1 -1
- package/dist/external-findings-local.js +6 -2
- package/dist/external-findings-local.js.map +1 -1
- package/dist/external-findings-publish.d.ts +1 -0
- package/dist/external-findings-publish.d.ts.map +1 -1
- package/dist/external-findings-publish.js +53 -25
- package/dist/external-findings-publish.js.map +1 -1
- package/dist/external-findings-read.d.ts +1 -0
- package/dist/external-findings-read.d.ts.map +1 -1
- package/dist/external-findings-read.js +10 -0
- package/dist/external-findings-read.js.map +1 -1
- package/dist/external-findings.d.ts +2 -0
- package/dist/external-findings.d.ts.map +1 -1
- package/dist/external-findings.js.map +1 -1
- package/dist/external-import-contract.d.ts +4 -0
- package/dist/external-import-contract.d.ts.map +1 -1
- package/dist/external-import-contract.js +34 -10
- package/dist/external-import-contract.js.map +1 -1
- package/dist/finding-workflow.d.ts +2 -0
- package/dist/finding-workflow.d.ts.map +1 -1
- package/dist/finding-workflow.js +3 -0
- package/dist/finding-workflow.js.map +1 -1
- package/dist/host-protocol.d.ts +1 -1
- package/dist/host-protocol.d.ts.map +1 -1
- package/dist/host-protocol.js +2 -2
- package/dist/host-protocol.js.map +1 -1
- package/dist/hosted-scan.d.ts.map +1 -1
- package/dist/hosted-scan.js +0 -1
- package/dist/hosted-scan.js.map +1 -1
- package/dist/import-scan.js +16 -16
- package/dist/import-scan.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/knowledge-base.js +3 -0
- package/dist/knowledge-base.js.map +1 -1
- package/dist/mock-scan.d.ts +1 -2
- package/dist/mock-scan.d.ts.map +1 -1
- package/dist/mock-scan.js +12 -17
- package/dist/mock-scan.js.map +1 -1
- package/dist/models.d.ts +9 -1
- package/dist/models.d.ts.map +1 -1
- package/dist/models.js.map +1 -1
- package/dist/multiscan.d.ts.map +1 -1
- package/dist/multiscan.js +1 -6
- package/dist/multiscan.js.map +1 -1
- package/dist/native-json-findings.d.ts +30 -0
- package/dist/native-json-findings.d.ts.map +1 -0
- package/dist/native-json-findings.js +114 -0
- package/dist/native-json-findings.js.map +1 -0
- package/dist/opengrep-findings.d.ts +10 -0
- package/dist/opengrep-findings.d.ts.map +1 -0
- package/dist/opengrep-findings.js +198 -0
- package/dist/opengrep-findings.js.map +1 -0
- package/dist/patch-tui.d.ts.map +1 -1
- package/dist/patch-tui.js +2 -0
- package/dist/patch-tui.js.map +1 -1
- package/dist/publication.js +1 -2
- package/dist/publication.js.map +1 -1
- package/dist/record.d.ts +1 -0
- package/dist/record.d.ts.map +1 -1
- package/dist/record.js +10 -0
- package/dist/record.js.map +1 -1
- package/dist/result.d.ts +5 -3
- package/dist/result.d.ts.map +1 -1
- package/dist/result.js +9 -6
- package/dist/result.js.map +1 -1
- package/dist/scan-history-renderer.js +1 -1
- package/dist/scan-history-renderer.js.map +1 -1
- package/dist/security-policy.d.ts.map +1 -1
- package/dist/security-policy.js +16 -2
- package/dist/security-policy.js.map +1 -1
- package/dist/semgrep-findings.d.ts.map +1 -1
- package/dist/semgrep-findings.js +15 -82
- package/dist/semgrep-findings.js.map +1 -1
- package/docs/cli.md +16 -3
- package/docs/dedupe-records.md +15 -1
- package/package.json +3 -3
package/docs/cli.md
CHANGED
|
@@ -506,7 +506,7 @@ or JSONL output produce:
|
|
|
506
506
|
With `--full-output`, the error appears under `error` in an `ok: false` envelope.
|
|
507
507
|
If the scan target changed, the error explains that the results no longer
|
|
508
508
|
represent the current checkout. Retained sealed results remain available under
|
|
509
|
-
`data`, including their manifest, findings,
|
|
509
|
+
`data`, including their manifest, findings, review summary, scan directory, and report
|
|
510
510
|
path. Unsealed or invalid artifacts are not included. This also applies to
|
|
511
511
|
`scans rerun` and `scans resume`.
|
|
512
512
|
For `scans rerun` and `scans resume`, `--filter-output` applies to retained `data`;
|
|
@@ -1268,6 +1268,8 @@ Supply the validation prompt again when rerunning.
|
|
|
1268
1268
|
|
|
1269
1269
|
## Import vendor findings locally
|
|
1270
1270
|
|
|
1271
|
+
Use the [scanner file import schema and capability guide](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/schema-guide.md) to compare provider identities, mapped evidence and destination behavior before selecting a report.
|
|
1272
|
+
|
|
1271
1273
|
External finding imports are disabled by default. Opt in for the current shell:
|
|
1272
1274
|
|
|
1273
1275
|
```bash
|
|
@@ -1303,6 +1305,7 @@ repository path instead of a Cloud repository ID or URL. Supported inputs includ
|
|
|
1303
1305
|
Wiz findings, [Snyk Open Source JSON and SARIF](#import-snyk-open-source-findings),
|
|
1304
1306
|
[Endor Labs Finding JSON and SARIF](#import-endor-labs-findings),
|
|
1305
1307
|
[Semgrep Code JSON and SARIF](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/semgrep.md),
|
|
1308
|
+
[OpenGrep native JSON](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/opengrep.md),
|
|
1306
1309
|
and [saved GitHub alerts and GHSA advisories](#import-github-findings-locally-or-to-cloud):
|
|
1307
1310
|
|
|
1308
1311
|
```bash
|
|
@@ -1335,8 +1338,18 @@ Repeated imports update the same record by repository, provider, source key, and
|
|
|
1335
1338
|
source finding ID. The result reports created, updated, and unchanged counts.
|
|
1336
1339
|
Keep the source key stable across exports. Records omitted from a later selection
|
|
1337
1340
|
remain stored; omission does not resolve or delete a finding. Excluded records
|
|
1338
|
-
are reported, and an import with exclusions exits with status 1.
|
|
1339
|
-
|
|
1341
|
+
are reported, and an import with exclusions exits with status 1. Both destinations
|
|
1342
|
+
read the same vendor formats; Cloud's field, size and nesting limits do not apply
|
|
1343
|
+
to local file imports.
|
|
1344
|
+
|
|
1345
|
+
For OpenGrep, use `--provider opengrep` and supply `--source-repository-url`.
|
|
1346
|
+
The reader supports native JSON and gzip for both destinations. It uses the
|
|
1347
|
+
existing `semgrep` source-provider contract while retaining `OpenGrep` as the
|
|
1348
|
+
scanner origin; keep a stable OpenGrep-specific source key. Review report
|
|
1349
|
+
diagnostics as well as findings: import completion does not establish scan
|
|
1350
|
+
coverage. The [OpenGrep guide](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/opengrep.md)
|
|
1351
|
+
covers evidence identity, empty reports, and assessing an imported finding with
|
|
1352
|
+
the existing SDK validator.
|
|
1340
1353
|
|
|
1341
1354
|
`scan import --json` and `scan import --csv` remain separate commands for importing
|
|
1342
1355
|
Codex Security's findings schema as a saved scan; they do not accept vendor
|
package/docs/dedupe-records.md
CHANGED
|
@@ -190,7 +190,7 @@ For failure or an inconclusive review, send an explicit error:
|
|
|
190
190
|
}
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
|
|
193
|
+
A host error ends the review without another submission. Invalid model
|
|
194
194
|
answers, missing decisions, and host errors make the whole batch unresolved;
|
|
195
195
|
previous successful reviews in that run do not become persistence decisions.
|
|
196
196
|
The existing algorithm treats a validated `DISTINCT` as a nonmatch, when
|
|
@@ -203,6 +203,20 @@ severity-based representative selection are reused. No local review checkpoints
|
|
|
203
203
|
are read or written in records mode. Local saved-scan execution retains its
|
|
204
204
|
existing tool-submission validation and workflow checkpoints.
|
|
205
205
|
|
|
206
|
+
### Continuing a review
|
|
207
|
+
|
|
208
|
+
A `review.run` request with `supportsContinuation: true` can receive the result
|
|
209
|
+
`{"status":"missing_submission"}`. Send this only after verifying that the
|
|
210
|
+
original turn completed without a pending decision or blocker. Keep that
|
|
211
|
+
review session open. The CLI then sends one `review.continue` request with a
|
|
212
|
+
fresh JSON-RPC ID and `params: {requestId, prompt}`. The request ID in the
|
|
213
|
+
parameters identifies the original review. Submit the prompt in the same
|
|
214
|
+
session and reply on the new JSON-RPC ID. The correction omits
|
|
215
|
+
`supportsContinuation`, so the host releases the session after that turn. A second missing submission ends
|
|
216
|
+
the review as unresolved. A pending tool call uses the original turn and
|
|
217
|
+
requires no correction. An uncertain outcome or explicit blocker follows the
|
|
218
|
+
existing error path. Hosts without continuation support can ignore the field.
|
|
219
|
+
|
|
206
220
|
## Final response and persistence
|
|
207
221
|
|
|
208
222
|
```json
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openai/codex-security",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.8.0",
|
|
4
4
|
"description": "TypeScript SDK and CLI for Codex Security",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "OpenAI",
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
]
|
|
58
58
|
},
|
|
59
59
|
"dependencies": {
|
|
60
|
-
"@inquirer/prompts": "8.7.
|
|
60
|
+
"@inquirer/prompts": "8.7.4",
|
|
61
61
|
"@linear/sdk": "98.0.0",
|
|
62
62
|
"@octokit/core": "7.0.8",
|
|
63
63
|
"@openai/codex": "0.164.0",
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
"prettier": "3.9.10",
|
|
97
97
|
"typescript": "7.0.2"
|
|
98
98
|
},
|
|
99
|
-
"gitHead": "
|
|
99
|
+
"gitHead": "71bd7ae0e9bc859fb8fe9bc4b590b8f8998b19aa",
|
|
100
100
|
"scripts": {
|
|
101
101
|
"audit:prod": "pnpm audit --prod --audit-level high",
|
|
102
102
|
"clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
|