@openai/codex-security 0.8.0 → 0.8.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 +8 -8
- package/_bundled_plugin/.codex-plugin/plugin.json +1 -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/scan-artifacts.md +1 -1
- package/_bundled_plugin/scripts/finalize_scan_contract.py +37 -1
- package/_bundled_plugin/scripts/servicenow_avit.py +107 -0
- package/_bundled_plugin/scripts/workbench_scan_start.py +4 -1
- package/_bundled_plugin/skills/publish-findings/SKILL.md +5 -3
- package/_bundled_plugin/skills/security-scan/SKILL.md +1 -1
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js +33 -12
- package/dist/api.js.map +1 -1
- package/dist/artifact-export.d.ts +12 -3
- package/dist/artifact-export.d.ts.map +1 -1
- package/dist/artifact-export.js +30 -10
- package/dist/artifact-export.js.map +1 -1
- package/dist/cli-help.d.ts.map +1 -1
- package/dist/cli-help.js +1 -0
- package/dist/cli-help.js.map +1 -1
- package/dist/cli.d.ts +1 -1
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +45 -42
- package/dist/cli.js.map +1 -1
- package/dist/contract.d.ts +1 -0
- package/dist/contract.d.ts.map +1 -1
- package/dist/contract.js +12 -8
- package/dist/contract.js.map +1 -1
- package/dist/custom-validation-prompt.d.ts.map +1 -1
- package/dist/custom-validation-prompt.js +12 -4
- package/dist/custom-validation-prompt.js.map +1 -1
- package/dist/external-findings-local.d.ts.map +1 -1
- package/dist/external-findings-local.js +19 -0
- package/dist/external-findings-local.js.map +1 -1
- package/dist/external-findings-publish.d.ts.map +1 -1
- package/dist/external-findings-publish.js +5 -4
- package/dist/external-findings-publish.js.map +1 -1
- package/dist/github-advisories.d.ts.map +1 -1
- package/dist/github-advisories.js +5 -5
- package/dist/github-advisories.js.map +1 -1
- package/dist/github-dependabot-findings.d.ts +6 -0
- package/dist/github-dependabot-findings.d.ts.map +1 -0
- package/dist/github-dependabot-findings.js +247 -0
- package/dist/github-dependabot-findings.js.map +1 -0
- package/dist/github-findings.d.ts.map +1 -1
- package/dist/github-findings.js +11 -4
- package/dist/github-findings.js.map +1 -1
- package/dist/github-identifiers.d.ts +4 -0
- package/dist/github-identifiers.d.ts.map +1 -0
- package/dist/github-identifiers.js +9 -0
- package/dist/github-identifiers.js.map +1 -0
- package/dist/github.d.ts.map +1 -1
- package/dist/github.js +4 -6
- package/dist/github.js.map +1 -1
- package/dist/hosted-scan.d.ts.map +1 -1
- package/dist/hosted-scan.js +13 -5
- package/dist/hosted-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/scanner-import.d.ts +0 -1
- package/dist/scanner-import.d.ts.map +1 -1
- package/dist/scanner-import.js +9 -9
- package/dist/scanner-import.js.map +1 -1
- package/docs/cli.md +39 -7
- package/docs/hosted-scans.md +14 -0
- package/package.json +4 -4
package/docs/cli.md
CHANGED
|
@@ -1306,7 +1306,8 @@ Wiz findings, [Snyk Open Source JSON and SARIF](#import-snyk-open-source-finding
|
|
|
1306
1306
|
[Endor Labs Finding JSON and SARIF](#import-endor-labs-findings),
|
|
1307
1307
|
[Semgrep Code JSON and SARIF](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/semgrep.md),
|
|
1308
1308
|
[OpenGrep native JSON](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/opengrep.md),
|
|
1309
|
-
|
|
1309
|
+
[GitHub Dependabot repository alerts](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/github-dependabot.md),
|
|
1310
|
+
and [saved GitHub code-scanning alerts and GHSA advisories](#import-github-findings-locally-or-to-cloud):
|
|
1310
1311
|
|
|
1311
1312
|
```bash
|
|
1312
1313
|
codex-security publish findings selected-wiz.json \
|
|
@@ -2281,6 +2282,33 @@ be unchanged since the scan. `--source-root` is supported only for SARIF.
|
|
|
2281
2282
|
If export fails, it exits with `2`. Fix the reported error and rerun the export;
|
|
2282
2283
|
the saved scan remains available, so you don't need to run another scan.
|
|
2283
2284
|
|
|
2285
|
+
### Export findings for ServiceNow
|
|
2286
|
+
|
|
2287
|
+
Use `servicenow-avit` to prepare a CSV for ServiceNow Application Vulnerability
|
|
2288
|
+
Response. In ServiceNow, open **All > Manual AVIT Ingestion > Upload File UI**
|
|
2289
|
+
and download the CSV template. Keep the headers and a single row per template
|
|
2290
|
+
file. Fill in the exact ServiceNow application name, requester, assignee, and
|
|
2291
|
+
assignment group. Supply the application team, purpose, sensitive data types,
|
|
2292
|
+
compliance programs, technology stack, and URLs to test. Leave the finding
|
|
2293
|
+
columns blank and reuse this file for future exports of the same application. See the
|
|
2294
|
+
[example template](https://github.com/openai/codex-security/blob/main/examples/servicenow-avit-template.csv).
|
|
2295
|
+
|
|
2296
|
+
```bash
|
|
2297
|
+
codex-security export --scan latest --export-format servicenow-avit \
|
|
2298
|
+
--avit-template invoice-desk.csv --output findings-avit.csv
|
|
2299
|
+
```
|
|
2300
|
+
|
|
2301
|
+
The command writes one row per saved finding. It fills the risk rating and uses
|
|
2302
|
+
the first CWE when available, otherwise the Codex finding ID. Technical details
|
|
2303
|
+
include that ID, the primary file and line, the summary, and remediation. For
|
|
2304
|
+
**Steps to reproduce**, review any recorded attack-path steps and complete blank
|
|
2305
|
+
cells before uploading. Both text fields have a 1,000-character limit. An ellipsis
|
|
2306
|
+
marks shortened text. Other template columns keep their original values.
|
|
2307
|
+
|
|
2308
|
+
The output defaults to `servicenow-avit.csv`. Upload the completed file in the
|
|
2309
|
+
same ServiceNow screen. Each upload creates a new penetration-test form for the
|
|
2310
|
+
application. See [ServiceNow's upload instructions](https://www.servicenow.com/docs/r/security-management/application-vulnerability-response/ingest-vulnerabilities-manually-avr.html).
|
|
2311
|
+
|
|
2284
2312
|
### Export a threat model
|
|
2285
2313
|
|
|
2286
2314
|
To save a scan's threat model as Markdown, run:
|
|
@@ -2323,6 +2351,8 @@ console.log(exported.path, exported.provenance);
|
|
|
2323
2351
|
```
|
|
2324
2352
|
|
|
2325
2353
|
Use `artifact: "findings"` with `format: "csv" | "json" | "sarif"` for findings.
|
|
2354
|
+
For ServiceNow, use `format: "servicenow-avit"` and set `avitTemplate` to the
|
|
2355
|
+
path of the application's populated CSV template.
|
|
2326
2356
|
`output: "-"` streams stdout and returns null path/provenance. `pythonPath`
|
|
2327
2357
|
selects an interpreter; `signal` cancels.
|
|
2328
2358
|
|
|
@@ -2405,10 +2435,12 @@ Acquire code-scanning findings with the existing `import github` collector and
|
|
|
2405
2435
|
save its complete JSON output. In Codex, the official
|
|
2406
2436
|
[GitHub Codex plugin](https://github.com/openai/plugins/tree/main/plugins/github)
|
|
2407
2437
|
can help select the repository, alert numbers and ref through GitHub's MCP
|
|
2408
|
-
server
|
|
2409
|
-
|
|
2410
|
-
|
|
2411
|
-
|
|
2438
|
+
server. Pass that selection to the collector. For Dependabot, use
|
|
2439
|
+
the [repository alert export guide](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/github-dependabot.md)
|
|
2440
|
+
to save the native REST records from one repository and preview them with
|
|
2441
|
+
`--provider github`. For GHSA disclosures, use the
|
|
2442
|
+
[advisory collector](#import-ghsa-advisories-separately).
|
|
2443
|
+
The following example previews local storage of a code-scanning export.
|
|
2412
2444
|
|
|
2413
2445
|
```bash
|
|
2414
2446
|
codex-security import github example/project --format json > /path/outside/repository/alerts.json
|
|
@@ -2429,8 +2461,8 @@ The importer fetches every page, retrieves alert details, and retains the select
|
|
|
2429
2461
|
ref's instance. It writes the saved input for publication; no website download or
|
|
2430
2462
|
hand-written JSON mapping is needed. Use `--github-alert NUMBER` repeatedly for
|
|
2431
2463
|
selected alerts or `--github-ref REF` for another ref. Defaults are open alerts on
|
|
2432
|
-
the default branch. MCP list calls are paginated separately
|
|
2433
|
-
|
|
2464
|
+
the default branch. MCP list calls are paginated separately. Code-scanning
|
|
2465
|
+
imports require the saved collector output, which includes the selected instance.
|
|
2434
2466
|
|
|
2435
2467
|
The importer uses GitHub CLI authentication (`gh auth login`) and `GH_HOST`;
|
|
2436
2468
|
the plugin's connection does not sign in `gh`. Reading alerts requires
|
package/docs/hosted-scans.md
CHANGED
|
@@ -208,6 +208,20 @@ needs before returning that outcome. Use shared mounts or a coordinated transfer
|
|
|
208
208
|
that preserves the supplied path bindings, not independent copies of mutable
|
|
209
209
|
workbench state.
|
|
210
210
|
|
|
211
|
+
For path scans with the Linux CLI and a current plugin, use the inventory
|
|
212
|
+
path the scope helper reports. A Linux executor can keep the inventory in
|
|
213
|
+
`stateDirectory` outside the checkout and captured output. The state binding
|
|
214
|
+
may include one protected symlink and must exclude `..` from the path and
|
|
215
|
+
link target. Its protected directory must support executor-owned mode-`0600`
|
|
216
|
+
files and keep a reader open across writer close.
|
|
217
|
+
|
|
218
|
+
Other layouts use `scoped-source-input.jsonl` in scan output. If a later
|
|
219
|
+
shell loses the inventory, run the recovery command in the prompt. It may
|
|
220
|
+
replace an earlier output file, so the executor needs permission to remove it.
|
|
221
|
+
State transfers include private inventories named
|
|
222
|
+
`<scope-input-filename>.scoped-<24 lowercase hex digits>.jsonl`. Hosts can
|
|
223
|
+
remove the request's private inventories after execution finishes.
|
|
224
|
+
|
|
211
225
|
Run the plugin stdio server from
|
|
212
226
|
`pluginRoot/scripts/launch_codex_security_mcp --stdio` with the supplied
|
|
213
227
|
environment. The executor needs the target files, plugin skills and registered
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openai/codex-security",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.1",
|
|
4
4
|
"description": "TypeScript SDK and CLI for Codex Security",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "OpenAI",
|
|
@@ -60,8 +60,8 @@
|
|
|
60
60
|
"@inquirer/prompts": "8.7.4",
|
|
61
61
|
"@linear/sdk": "98.0.0",
|
|
62
62
|
"@octokit/core": "7.0.8",
|
|
63
|
-
"@openai/codex": "0.
|
|
64
|
-
"@openai/codex-sdk": "0.
|
|
63
|
+
"@openai/codex": "0.165.0",
|
|
64
|
+
"@openai/codex-sdk": "0.165.0",
|
|
65
65
|
"ajv": "8.20.0",
|
|
66
66
|
"fflate": "0.8.3",
|
|
67
67
|
"incur": "0.7.1",
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
"prettier": "3.9.10",
|
|
97
97
|
"typescript": "7.0.2"
|
|
98
98
|
},
|
|
99
|
-
"gitHead": "
|
|
99
|
+
"gitHead": "1f2f96d562b98216257e7f7cdacd40c446b97f70",
|
|
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})\"",
|