@openai/codex-security 0.8.3 → 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.
Files changed (534) hide show
  1. package/README.md +192 -151
  2. package/_bundled_plugin/.mcp.json +5 -1
  3. package/_bundled_plugin/examples/completed-scan/findings.json +16 -4
  4. package/_bundled_plugin/examples/completed-scan/report.md +11 -8
  5. package/_bundled_plugin/examples/completed-scan/scan-manifest.json +4 -2
  6. package/_bundled_plugin/mcp/fzstd-LICENSE.txt +21 -0
  7. package/_bundled_plugin/mcp/helpers.mjs +2 -11
  8. package/_bundled_plugin/mcp/helpers.mjs.br +0 -0
  9. package/_bundled_plugin/mcp/native/THIRD_PARTY_NOTICES.txt +3 -210
  10. package/_bundled_plugin/mcp/native/darwin-arm64/unix.node +0 -0
  11. package/_bundled_plugin/mcp/native/darwin-x64/unix.node +0 -0
  12. package/_bundled_plugin/mcp/native/linux-arm64-gnu/unix.node +0 -0
  13. package/_bundled_plugin/mcp/native/linux-arm64-musl/unix.node +0 -0
  14. package/_bundled_plugin/mcp/native/linux-x64-gnu/unix.node +0 -0
  15. package/_bundled_plugin/mcp/native/linux-x64-musl/unix.node +0 -0
  16. package/_bundled_plugin/mcp/native/win32-arm64/windows.node +0 -0
  17. package/_bundled_plugin/mcp/native/win32-x64/windows.node +0 -0
  18. package/_bundled_plugin/mcp/package.json +1 -0
  19. package/_bundled_plugin/mcp/permission-profile-preflight.mjs +5 -2
  20. package/_bundled_plugin/mcp/server.mjs +2 -11
  21. package/_bundled_plugin/mcp/server.mjs.br +0 -0
  22. package/_bundled_plugin/mcp/session-decompression.mjs +712 -0
  23. package/_bundled_plugin/references/default-severity-rubric.md +9 -4
  24. package/_bundled_plugin/references/final-report.md +5 -3
  25. package/_bundled_plugin/references/finding-detail-fields.md +18 -18
  26. package/_bundled_plugin/references/sarif-adapter.md +8 -2
  27. package/_bundled_plugin/references/scan-artifacts.md +21 -12
  28. package/_bundled_plugin/references/scan-contract.md +27 -33
  29. package/_bundled_plugin/schemas/tools/scan-draft.schema.json +2 -2
  30. package/_bundled_plugin/scripts/check_deep_scan_target.py +97 -0
  31. package/_bundled_plugin/scripts/codex_profile.mjs +7 -1
  32. package/_bundled_plugin/scripts/deep_scan_config.py +20 -1
  33. package/_bundled_plugin/scripts/deep_scan_workbench.py +165 -342
  34. package/_bundled_plugin/scripts/filesystem_identity.py +1 -0
  35. package/_bundled_plugin/scripts/finalize_scan_contract.py +153 -227
  36. package/_bundled_plugin/scripts/finding_preview.py +20 -0
  37. package/_bundled_plugin/scripts/launch_codex_security_mcp +1 -0
  38. package/_bundled_plugin/scripts/legacy_findings.py +148 -0
  39. package/_bundled_plugin/scripts/posix_scan_local_files.py +11 -0
  40. package/_bundled_plugin/scripts/read_codex_session.mjs +21 -0
  41. package/_bundled_plugin/scripts/report_projection.py +81 -43
  42. package/_bundled_plugin/scripts/review_state.py +8 -2
  43. package/_bundled_plugin/scripts/servicenow_avit.py +20 -0
  44. package/_bundled_plugin/scripts/snapshot_sqlite.py +1 -0
  45. package/_bundled_plugin/scripts/threat_model_projection.py +22 -26
  46. package/_bundled_plugin/scripts/validate_scan_contract.py +7 -1
  47. package/_bundled_plugin/scripts/windows_scan_local_files.py +388 -17
  48. package/_bundled_plugin/scripts/workbench/__init__.py +1 -1
  49. package/_bundled_plugin/scripts/workbench/handoff.py +47 -0
  50. package/_bundled_plugin/scripts/workbench/retained_coverage.py +30 -51
  51. package/_bundled_plugin/scripts/workbench/retained_records.py +18 -30
  52. package/_bundled_plugin/scripts/workbench/runtime_toml.py +4 -1
  53. package/_bundled_plugin/scripts/workbench/saved_coverage.py +9 -17
  54. package/_bundled_plugin/scripts/workbench/saved_outputs.py +9 -0
  55. package/_bundled_plugin/scripts/workbench/saved_sources.py +47 -40
  56. package/_bundled_plugin/scripts/workbench/storage.py +71 -7
  57. package/_bundled_plugin/scripts/workbench_cli.py +30 -12
  58. package/_bundled_plugin/scripts/workbench_constants.py +10 -0
  59. package/_bundled_plugin/scripts/workbench_coverage_receipts.py +3 -3
  60. package/_bundled_plugin/scripts/workbench_db.py +369 -137
  61. package/_bundled_plugin/scripts/workbench_feedback.py +8 -7
  62. package/_bundled_plugin/scripts/workbench_finding_index.py +1 -0
  63. package/_bundled_plugin/scripts/workbench_finding_workflows.py +4 -0
  64. package/_bundled_plugin/scripts/workbench_native_indexes.py +12 -12
  65. package/_bundled_plugin/scripts/workbench_progress.py +10 -1
  66. package/_bundled_plugin/scripts/workbench_publication.py +14 -10
  67. package/_bundled_plugin/scripts/workbench_remediation.py +13 -0
  68. package/_bundled_plugin/scripts/workbench_saved_results.py +132 -77
  69. package/_bundled_plugin/scripts/workbench_scan_history.py +117 -55
  70. package/_bundled_plugin/scripts/workbench_scan_start.py +83 -24
  71. package/_bundled_plugin/scripts/workbench_scan_usage.py +644 -68
  72. package/_bundled_plugin/scripts/workbench_schema.py +44 -55
  73. package/_bundled_plugin/scripts/workbench_setup.py +13 -1
  74. package/_bundled_plugin/scripts/workbench_source_excerpt.py +13 -0
  75. package/_bundled_plugin/scripts/workbench_source_scopes.py +18 -0
  76. package/_bundled_plugin/scripts/workbench_target.py +127 -56
  77. package/_bundled_plugin/scripts/workbench_target_state.py +3 -0
  78. package/_bundled_plugin/scripts/workbench_validation.py +43 -3
  79. package/_bundled_plugin/shared/workbench-history-repairs.json +19 -23
  80. package/_bundled_plugin/shared/workbench-migrations.json +34 -0
  81. package/_bundled_plugin/skills/cloud-findings/SKILL.md +5 -5
  82. package/_bundled_plugin/skills/deep-security-scan/SKILL.md +7 -50
  83. package/_bundled_plugin/skills/fix-finding/SKILL.md +1 -1
  84. package/_bundled_plugin/skills/publish-findings/SKILL.md +32 -25
  85. package/_bundled_plugin/skills/publish-findings/references/checkmarx-import.md +37 -0
  86. package/_bundled_plugin/skills/publish-findings/references/wiz-import.md +3 -3
  87. package/_bundled_plugin/skills/publish-findings/scripts/collect_checkmarx.py +464 -0
  88. package/_bundled_plugin/skills/threat-model-visualize/scripts/build_explorer.py +22 -1
  89. package/_bundled_plugin/skills/triage-finding/references/ticket-intake.md +6 -2
  90. package/dist/api.d.ts +39 -4
  91. package/dist/api.d.ts.map +1 -1
  92. package/dist/api.js +774 -292
  93. package/dist/api.js.map +1 -1
  94. package/dist/auth.d.ts.map +1 -1
  95. package/dist/auth.js +4 -6
  96. package/dist/auth.js.map +1 -1
  97. package/dist/bedrock-oss-pricing.d.ts +6 -0
  98. package/dist/bedrock-oss-pricing.d.ts.map +1 -0
  99. package/dist/bedrock-oss-pricing.js +58 -0
  100. package/dist/bedrock-oss-pricing.js.map +1 -0
  101. package/dist/bedrock-pricing.d.ts +15 -0
  102. package/dist/bedrock-pricing.d.ts.map +1 -0
  103. package/dist/bedrock-pricing.js +117 -0
  104. package/dist/bedrock-pricing.js.map +1 -0
  105. package/dist/blackduck-findings.d.ts.map +1 -1
  106. package/dist/blackduck-findings.js +35 -20
  107. package/dist/blackduck-findings.js.map +1 -1
  108. package/dist/bulk-scan-discovery.d.ts.map +1 -1
  109. package/dist/bulk-scan-discovery.js +4 -4
  110. package/dist/bulk-scan-discovery.js.map +1 -1
  111. package/dist/checkmarx-evidence.d.ts +19 -0
  112. package/dist/checkmarx-evidence.d.ts.map +1 -0
  113. package/dist/checkmarx-evidence.js +36 -0
  114. package/dist/checkmarx-evidence.js.map +1 -0
  115. package/dist/checkmarx-findings.d.ts +4 -0
  116. package/dist/checkmarx-findings.d.ts.map +1 -0
  117. package/dist/checkmarx-findings.js +27 -0
  118. package/dist/checkmarx-findings.js.map +1 -0
  119. package/dist/checkmarx-one.d.ts +4 -0
  120. package/dist/checkmarx-one.d.ts.map +1 -0
  121. package/dist/checkmarx-one.js +53 -0
  122. package/dist/checkmarx-one.js.map +1 -0
  123. package/dist/checkmarx-repository.d.ts +12 -0
  124. package/dist/checkmarx-repository.d.ts.map +1 -0
  125. package/dist/checkmarx-repository.js +181 -0
  126. package/dist/checkmarx-repository.js.map +1 -0
  127. package/dist/checkmarx-xml.d.ts +12 -0
  128. package/dist/checkmarx-xml.d.ts.map +1 -0
  129. package/dist/checkmarx-xml.js +196 -0
  130. package/dist/checkmarx-xml.js.map +1 -0
  131. package/dist/classify-severity-records.d.ts +1 -9
  132. package/dist/classify-severity-records.d.ts.map +1 -1
  133. package/dist/classify-severity-records.js +3 -13
  134. package/dist/classify-severity-records.js.map +1 -1
  135. package/dist/classify-severity.d.ts.map +1 -1
  136. package/dist/classify-severity.js +2 -4
  137. package/dist/classify-severity.js.map +1 -1
  138. package/dist/cli.d.ts +11 -5
  139. package/dist/cli.d.ts.map +1 -1
  140. package/dist/cli.js +1734 -1238
  141. package/dist/cli.js.map +1 -1
  142. package/dist/cloud-publish.js +2 -2
  143. package/dist/cloud-publish.js.map +1 -1
  144. package/dist/component-scan.d.ts +16 -3
  145. package/dist/component-scan.d.ts.map +1 -1
  146. package/dist/component-scan.js +27 -2
  147. package/dist/component-scan.js.map +1 -1
  148. package/dist/config.d.ts.map +1 -1
  149. package/dist/config.js +100 -66
  150. package/dist/config.js.map +1 -1
  151. package/dist/continuum-findings.d.ts.map +1 -1
  152. package/dist/continuum-findings.js +80 -12
  153. package/dist/continuum-findings.js.map +1 -1
  154. package/dist/contract-values.d.ts +2 -0
  155. package/dist/contract-values.d.ts.map +1 -1
  156. package/dist/contract-values.js +12 -9
  157. package/dist/contract-values.js.map +1 -1
  158. package/dist/cost-model.d.ts +13 -1
  159. package/dist/cost-model.d.ts.map +1 -1
  160. package/dist/cost-model.js +66 -112
  161. package/dist/cost-model.js.map +1 -1
  162. package/dist/cost.d.ts +42 -3
  163. package/dist/cost.d.ts.map +1 -1
  164. package/dist/cost.js +483 -104
  165. package/dist/cost.js.map +1 -1
  166. package/dist/custom-publish.d.ts +4 -0
  167. package/dist/custom-publish.d.ts.map +1 -1
  168. package/dist/custom-publish.js +40 -3
  169. package/dist/custom-publish.js.map +1 -1
  170. package/dist/deduplication/local.d.ts +2 -2
  171. package/dist/deduplication/local.d.ts.map +1 -1
  172. package/dist/deduplication/local.js +2 -2
  173. package/dist/deduplication/local.js.map +1 -1
  174. package/dist/deduplication/refusal.d.ts.map +1 -1
  175. package/dist/deduplication/refusal.js +25 -5
  176. package/dist/deduplication/refusal.js.map +1 -1
  177. package/dist/deduplication/scan.d.ts +3 -0
  178. package/dist/deduplication/scan.d.ts.map +1 -1
  179. package/dist/deduplication/scan.js +1 -1
  180. package/dist/deduplication/scan.js.map +1 -1
  181. package/dist/deep-config.d.ts +0 -1
  182. package/dist/deep-config.d.ts.map +1 -1
  183. package/dist/deep-config.js +22 -33
  184. package/dist/deep-config.js.map +1 -1
  185. package/dist/deep-scan-defaults.d.ts +2 -0
  186. package/dist/deep-scan-defaults.d.ts.map +1 -1
  187. package/dist/deep-scan-defaults.js +28 -1
  188. package/dist/deep-scan-defaults.js.map +1 -1
  189. package/dist/deep-scan.d.ts +2 -0
  190. package/dist/deep-scan.d.ts.map +1 -1
  191. package/dist/deep-scan.js +28 -4
  192. package/dist/deep-scan.js.map +1 -1
  193. package/dist/default-severity-rubric.d.ts +1 -1
  194. package/dist/default-severity-rubric.d.ts.map +1 -1
  195. package/dist/default-severity-rubric.js +1 -1
  196. package/dist/default-severity-rubric.js.map +1 -1
  197. package/dist/endor-findings.d.ts +3 -1
  198. package/dist/endor-findings.d.ts.map +1 -1
  199. package/dist/endor-findings.js +103 -45
  200. package/dist/endor-findings.js.map +1 -1
  201. package/dist/errors.d.ts +1 -1
  202. package/dist/errors.d.ts.map +1 -1
  203. package/dist/errors.js +8 -1
  204. package/dist/errors.js.map +1 -1
  205. package/dist/external-findings-import.d.ts +5 -3
  206. package/dist/external-findings-import.d.ts.map +1 -1
  207. package/dist/external-findings-import.js +7 -6
  208. package/dist/external-findings-import.js.map +1 -1
  209. package/dist/external-findings-local.d.ts +7 -5
  210. package/dist/external-findings-local.d.ts.map +1 -1
  211. package/dist/external-findings-local.js +337 -89
  212. package/dist/external-findings-local.js.map +1 -1
  213. package/dist/external-findings-publish.d.ts +8 -6
  214. package/dist/external-findings-publish.d.ts.map +1 -1
  215. package/dist/external-findings-publish.js +1318 -258
  216. package/dist/external-findings-publish.js.map +1 -1
  217. package/dist/external-findings-read.d.ts +20 -2
  218. package/dist/external-findings-read.d.ts.map +1 -1
  219. package/dist/external-findings-read.js +148 -66
  220. package/dist/external-findings-read.js.map +1 -1
  221. package/dist/external-findings.d.ts +15 -3
  222. package/dist/external-findings.d.ts.map +1 -1
  223. package/dist/external-findings.js +42 -1
  224. package/dist/external-findings.js.map +1 -1
  225. package/dist/external-import-contract.d.ts +5 -1
  226. package/dist/external-import-contract.d.ts.map +1 -1
  227. package/dist/external-import-contract.js +23 -9
  228. package/dist/external-import-contract.js.map +1 -1
  229. package/dist/external-import-models.d.ts +1 -1
  230. package/dist/external-import-models.d.ts.map +1 -1
  231. package/dist/external-import-models.js.map +1 -1
  232. package/dist/feedback.d.ts.map +1 -1
  233. package/dist/feedback.js +5 -4
  234. package/dist/feedback.js.map +1 -1
  235. package/dist/finding-prompt.d.ts +5 -0
  236. package/dist/finding-prompt.d.ts.map +1 -0
  237. package/dist/finding-prompt.js +32 -0
  238. package/dist/finding-prompt.js.map +1 -0
  239. package/dist/findings-client.d.ts +1 -0
  240. package/dist/findings-client.d.ts.map +1 -1
  241. package/dist/findings-client.js +27 -3
  242. package/dist/findings-client.js.map +1 -1
  243. package/dist/github-advisories.d.ts.map +1 -1
  244. package/dist/github-advisories.js +0 -2
  245. package/dist/github-advisories.js.map +1 -1
  246. package/dist/github-dependabot-findings.d.ts.map +1 -1
  247. package/dist/github-dependabot-findings.js +15 -4
  248. package/dist/github-dependabot-findings.js.map +1 -1
  249. package/dist/github-findings.d.ts +4 -1
  250. package/dist/github-findings.d.ts.map +1 -1
  251. package/dist/github-findings.js +55 -30
  252. package/dist/github-findings.js.map +1 -1
  253. package/dist/hosted-git-remotes.d.ts +5 -0
  254. package/dist/hosted-git-remotes.d.ts.map +1 -0
  255. package/dist/hosted-git-remotes.js +285 -0
  256. package/dist/hosted-git-remotes.js.map +1 -0
  257. package/dist/hosted-git-repository.d.ts +28 -0
  258. package/dist/hosted-git-repository.d.ts.map +1 -0
  259. package/dist/hosted-git-repository.js +222 -0
  260. package/dist/hosted-git-repository.js.map +1 -0
  261. package/dist/hosted-scan-protocol.js +2 -2
  262. package/dist/hosted-scan-protocol.js.map +1 -1
  263. package/dist/hosted-scan.d.ts.map +1 -1
  264. package/dist/hosted-scan.js +16 -11
  265. package/dist/hosted-scan.js.map +1 -1
  266. package/dist/hosted-scanner-http.d.ts +21 -0
  267. package/dist/hosted-scanner-http.d.ts.map +1 -0
  268. package/dist/hosted-scanner-http.js +204 -0
  269. package/dist/hosted-scanner-http.js.map +1 -0
  270. package/dist/hosted-scanner-v1.d.ts +6 -0
  271. package/dist/hosted-scanner-v1.d.ts.map +1 -0
  272. package/dist/hosted-scanner-v1.js +60 -0
  273. package/dist/hosted-scanner-v1.js.map +1 -0
  274. package/dist/import-scan.d.ts.map +1 -1
  275. package/dist/import-scan.js +3 -0
  276. package/dist/import-scan.js.map +1 -1
  277. package/dist/index.d.ts +18 -7
  278. package/dist/index.d.ts.map +1 -1
  279. package/dist/index.js +10 -2
  280. package/dist/index.js.map +1 -1
  281. package/dist/inspector-findings.d.ts.map +1 -1
  282. package/dist/inspector-findings.js +47 -65
  283. package/dist/inspector-findings.js.map +1 -1
  284. package/dist/knowledge-base.d.ts.map +1 -1
  285. package/dist/knowledge-base.js +68 -5
  286. package/dist/knowledge-base.js.map +1 -1
  287. package/dist/local-git-metadata.d.ts +1 -1
  288. package/dist/local-git-metadata.d.ts.map +1 -1
  289. package/dist/local-git-metadata.js +1 -2
  290. package/dist/local-git-metadata.js.map +1 -1
  291. package/dist/multiscan.d.ts +6 -4
  292. package/dist/multiscan.d.ts.map +1 -1
  293. package/dist/multiscan.js +138 -65
  294. package/dist/multiscan.js.map +1 -1
  295. package/dist/native-json-findings.d.ts +2 -1
  296. package/dist/native-json-findings.d.ts.map +1 -1
  297. package/dist/native-json-findings.js +12 -2
  298. package/dist/native-json-findings.js.map +1 -1
  299. package/dist/opengrep-findings.d.ts +1 -0
  300. package/dist/opengrep-findings.d.ts.map +1 -1
  301. package/dist/opengrep-findings.js +17 -13
  302. package/dist/opengrep-findings.js.map +1 -1
  303. package/dist/operation-telemetry.d.ts +104 -0
  304. package/dist/operation-telemetry.d.ts.map +1 -0
  305. package/dist/operation-telemetry.js +293 -0
  306. package/dist/operation-telemetry.js.map +1 -0
  307. package/dist/plugin-python-probe.d.ts +4 -0
  308. package/dist/plugin-python-probe.d.ts.map +1 -0
  309. package/dist/plugin-python-probe.js +10 -0
  310. package/dist/plugin-python-probe.js.map +1 -0
  311. package/dist/private-finding-import.d.ts +97 -2
  312. package/dist/private-finding-import.d.ts.map +1 -1
  313. package/dist/private-finding-import.js +58 -34
  314. package/dist/private-finding-import.js.map +1 -1
  315. package/dist/provider-profile.d.ts +1 -1
  316. package/dist/provider-profile.d.ts.map +1 -1
  317. package/dist/provider-profile.js +8 -1
  318. package/dist/provider-profile.js.map +1 -1
  319. package/dist/publication-telemetry.d.ts +45 -0
  320. package/dist/publication-telemetry.d.ts.map +1 -0
  321. package/dist/publication-telemetry.js +50 -0
  322. package/dist/publication-telemetry.js.map +1 -0
  323. package/dist/publish.d.ts +4 -0
  324. package/dist/publish.d.ts.map +1 -1
  325. package/dist/publish.js +42 -2
  326. package/dist/publish.js.map +1 -1
  327. package/dist/reader-selection.d.ts +2 -0
  328. package/dist/reader-selection.d.ts.map +1 -1
  329. package/dist/reader-selection.js +8 -0
  330. package/dist/reader-selection.js.map +1 -1
  331. package/dist/remediation.d.ts +1 -4
  332. package/dist/remediation.d.ts.map +1 -1
  333. package/dist/remediation.js +3 -7
  334. package/dist/remediation.js.map +1 -1
  335. package/dist/request-metadata.d.ts +3 -0
  336. package/dist/request-metadata.d.ts.map +1 -1
  337. package/dist/request-metadata.js +9 -0
  338. package/dist/request-metadata.js.map +1 -1
  339. package/dist/result.d.ts +4 -0
  340. package/dist/result.d.ts.map +1 -1
  341. package/dist/result.js +1 -1
  342. package/dist/result.js.map +1 -1
  343. package/dist/retry-windows-rename.d.ts +8 -0
  344. package/dist/retry-windows-rename.d.ts.map +1 -0
  345. package/dist/retry-windows-rename.js +24 -0
  346. package/dist/retry-windows-rename.js.map +1 -0
  347. package/dist/runtime.d.ts +20 -0
  348. package/dist/runtime.d.ts.map +1 -1
  349. package/dist/runtime.js +313 -110
  350. package/dist/runtime.js.map +1 -1
  351. package/dist/saved-scan-bootstrap.d.ts +1 -0
  352. package/dist/saved-scan-bootstrap.d.ts.map +1 -1
  353. package/dist/saved-scan-bootstrap.js +18 -15
  354. package/dist/saved-scan-bootstrap.js.map +1 -1
  355. package/dist/scan-activity.d.ts.map +1 -1
  356. package/dist/scan-activity.js +141 -56
  357. package/dist/scan-activity.js.map +1 -1
  358. package/dist/scan-comparison.d.ts +10 -5
  359. package/dist/scan-comparison.d.ts.map +1 -1
  360. package/dist/scan-comparison.js +60 -15
  361. package/dist/scan-comparison.js.map +1 -1
  362. package/dist/scan-dashboard.d.ts +6 -6
  363. package/dist/scan-dashboard.d.ts.map +1 -1
  364. package/dist/scan-dashboard.js +75 -42
  365. package/dist/scan-dashboard.js.map +1 -1
  366. package/dist/scan-executor.d.ts +10 -1
  367. package/dist/scan-executor.d.ts.map +1 -1
  368. package/dist/scan-executor.js +22 -2
  369. package/dist/scan-executor.js.map +1 -1
  370. package/dist/scan-history-renderer.d.ts.map +1 -1
  371. package/dist/scan-history-renderer.js +9 -19
  372. package/dist/scan-history-renderer.js.map +1 -1
  373. package/dist/scan-logs.d.ts +12 -0
  374. package/dist/scan-logs.d.ts.map +1 -1
  375. package/dist/scan-logs.js +106 -77
  376. package/dist/scan-logs.js.map +1 -1
  377. package/dist/scan-measurement.d.ts +26 -0
  378. package/dist/scan-measurement.d.ts.map +1 -0
  379. package/dist/scan-measurement.js +77 -0
  380. package/dist/scan-measurement.js.map +1 -0
  381. package/dist/scan-progress.d.ts +1 -0
  382. package/dist/scan-progress.d.ts.map +1 -1
  383. package/dist/scan-progress.js +3 -0
  384. package/dist/scan-progress.js.map +1 -1
  385. package/dist/scan-sessions.d.ts.map +1 -1
  386. package/dist/scan-sessions.js +4 -1
  387. package/dist/scan-sessions.js.map +1 -1
  388. package/dist/scan-settings.d.ts +1 -1
  389. package/dist/scan-settings.d.ts.map +1 -1
  390. package/dist/scan-settings.js +1 -24
  391. package/dist/scan-settings.js.map +1 -1
  392. package/dist/scanner-import.d.ts +20 -2
  393. package/dist/scanner-import.d.ts.map +1 -1
  394. package/dist/scanner-import.js +200 -8
  395. package/dist/scanner-import.js.map +1 -1
  396. package/dist/scanner-repository-url.d.ts +4 -1
  397. package/dist/scanner-repository-url.d.ts.map +1 -1
  398. package/dist/scanner-repository-url.js +10 -6
  399. package/dist/scanner-repository-url.js.map +1 -1
  400. package/dist/security-policy.d.ts +1 -1
  401. package/dist/security-policy.d.ts.map +1 -1
  402. package/dist/security-policy.js.map +1 -1
  403. package/dist/semgrep-findings.d.ts +6 -3
  404. package/dist/semgrep-findings.d.ts.map +1 -1
  405. package/dist/semgrep-findings.js +107 -43
  406. package/dist/semgrep-findings.js.map +1 -1
  407. package/dist/semgrep-guardian-findings.d.ts +38 -0
  408. package/dist/semgrep-guardian-findings.d.ts.map +1 -0
  409. package/dist/semgrep-guardian-findings.js +165 -0
  410. package/dist/semgrep-guardian-findings.js.map +1 -0
  411. package/dist/semgrep-platform-collector.d.ts +26 -0
  412. package/dist/semgrep-platform-collector.d.ts.map +1 -0
  413. package/dist/semgrep-platform-collector.js +108 -0
  414. package/dist/semgrep-platform-collector.js.map +1 -0
  415. package/dist/semgrep-platform-findings.d.ts +207 -6
  416. package/dist/semgrep-platform-findings.d.ts.map +1 -1
  417. package/dist/semgrep-platform-findings.js +983 -103
  418. package/dist/semgrep-platform-findings.js.map +1 -1
  419. package/dist/semgrep-platform-v1.d.ts +6 -0
  420. package/dist/semgrep-platform-v1.d.ts.map +1 -0
  421. package/dist/semgrep-platform-v1.js +83 -0
  422. package/dist/semgrep-platform-v1.js.map +1 -0
  423. package/dist/server/api.d.ts +1 -1
  424. package/dist/server/api.d.ts.map +1 -1
  425. package/dist/server/api.js.map +1 -1
  426. package/dist/server/embedding-tokenizer.cdx.json +33 -0
  427. package/dist/server/embedding-tokenizer.d.ts +2 -0
  428. package/dist/server/embedding-tokenizer.d.ts.map +1 -0
  429. package/dist/server/embedding-tokenizer.js +322 -0
  430. package/dist/server/embedding-tokenizer.js.map +6 -0
  431. package/dist/server/embeddings.d.ts +16 -2
  432. package/dist/server/embeddings.d.ts.map +1 -1
  433. package/dist/server/embeddings.js +35 -5
  434. package/dist/server/embeddings.js.map +1 -1
  435. package/dist/session-lines.d.ts +5 -0
  436. package/dist/session-lines.d.ts.map +1 -0
  437. package/dist/session-lines.js +60 -0
  438. package/dist/session-lines.js.map +1 -0
  439. package/dist/severity-review.d.ts +3 -1
  440. package/dist/severity-review.d.ts.map +1 -1
  441. package/dist/severity-review.js +3 -2
  442. package/dist/severity-review.js.map +1 -1
  443. package/dist/skill-authentication.d.ts +1 -0
  444. package/dist/skill-authentication.d.ts.map +1 -1
  445. package/dist/skill-authentication.js +1 -0
  446. package/dist/skill-authentication.js.map +1 -1
  447. package/dist/snyk-findings.d.ts +7 -2
  448. package/dist/snyk-findings.d.ts.map +1 -1
  449. package/dist/snyk-findings.js +93 -70
  450. package/dist/snyk-findings.js.map +1 -1
  451. package/dist/snyk-rest-findings.d.ts +76 -0
  452. package/dist/snyk-rest-findings.d.ts.map +1 -0
  453. package/dist/snyk-rest-findings.js +1051 -0
  454. package/dist/snyk-rest-findings.js.map +1 -0
  455. package/dist/snyk-rest-v1.d.ts +28 -0
  456. package/dist/snyk-rest-v1.d.ts.map +1 -0
  457. package/dist/snyk-rest-v1.js +132 -0
  458. package/dist/snyk-rest-v1.js.map +1 -0
  459. package/dist/snyk-token-origin.d.ts +4 -0
  460. package/dist/snyk-token-origin.d.ts.map +1 -0
  461. package/dist/snyk-token-origin.js +82 -0
  462. package/dist/snyk-token-origin.js.map +1 -0
  463. package/dist/sonar-collector.d.ts.map +1 -1
  464. package/dist/sonar-collector.js +0 -3
  465. package/dist/sonar-collector.js.map +1 -1
  466. package/dist/sonar-import.d.ts.map +1 -1
  467. package/dist/sonar-import.js +2 -4
  468. package/dist/sonar-import.js.map +1 -1
  469. package/dist/target-drift.d.ts +9 -0
  470. package/dist/target-drift.d.ts.map +1 -0
  471. package/dist/target-drift.js +27 -0
  472. package/dist/target-drift.js.map +1 -0
  473. package/dist/targets.d.ts +2 -0
  474. package/dist/targets.d.ts.map +1 -1
  475. package/dist/targets.js +56 -20
  476. package/dist/targets.js.map +1 -1
  477. package/dist/tenable-findings.d.ts +9 -0
  478. package/dist/tenable-findings.d.ts.map +1 -0
  479. package/dist/tenable-findings.js +122 -0
  480. package/dist/tenable-findings.js.map +1 -0
  481. package/dist/terminal-stream.d.ts +13 -0
  482. package/dist/terminal-stream.d.ts.map +1 -0
  483. package/dist/terminal-stream.js +35 -0
  484. package/dist/terminal-stream.js.map +1 -0
  485. package/dist/trivy-findings.d.ts +19 -0
  486. package/dist/trivy-findings.d.ts.map +1 -0
  487. package/dist/trivy-findings.js +435 -0
  488. package/dist/trivy-findings.js.map +1 -0
  489. package/dist/trivy-import.d.ts +19 -0
  490. package/dist/trivy-import.d.ts.map +1 -0
  491. package/dist/trivy-import.js +151 -0
  492. package/dist/trivy-import.js.map +1 -0
  493. package/dist/validation-records.js +1 -1
  494. package/dist/validation-records.js.map +1 -1
  495. package/dist/veracode-findings.d.ts +2 -0
  496. package/dist/veracode-findings.d.ts.map +1 -1
  497. package/dist/veracode-findings.js +49 -11
  498. package/dist/veracode-findings.js.map +1 -1
  499. package/dist/vertex-pricing.d.ts +8 -0
  500. package/dist/vertex-pricing.d.ts.map +1 -0
  501. package/dist/vertex-pricing.js +20 -0
  502. package/dist/vertex-pricing.js.map +1 -0
  503. package/dist/windows-path.d.ts +1 -0
  504. package/dist/windows-path.d.ts.map +1 -1
  505. package/dist/windows-path.js +26 -1
  506. package/dist/windows-path.js.map +1 -1
  507. package/dist/wiz-findings.d.ts +4 -0
  508. package/dist/wiz-findings.d.ts.map +1 -1
  509. package/dist/wiz-findings.js +57 -3
  510. package/dist/wiz-findings.js.map +1 -1
  511. package/docs/classify-severity-records.md +27 -12
  512. package/docs/cli.md +497 -550
  513. package/docs/dedupe-records.md +44 -24
  514. package/docs/findings-service.md +66 -39
  515. package/docs/hosted-remediation.md +14 -7
  516. package/docs/hosted-scans.md +50 -42
  517. package/docs/telemetry.md +236 -0
  518. package/docs/validate-records.md +78 -44
  519. package/package.json +18 -15
  520. package/schemas/external-findings.schema.json +3 -1
  521. package/_bundled_plugin/mcp/helpers.mjs.br.part-000 +0 -0
  522. package/_bundled_plugin/mcp/helpers.mjs.br.part-001 +0 -0
  523. package/_bundled_plugin/mcp/server.mjs.br.part-000 +0 -0
  524. package/_bundled_plugin/mcp/server.mjs.br.part-001 +0 -0
  525. package/_bundled_plugin/mcp/server.mjs.br.part-002 +0 -0
  526. package/_bundled_plugin/schemas/tools/deep-reducer.schema.json +0 -96
  527. package/dist/external-imports-feature.d.ts +0 -6
  528. package/dist/external-imports-feature.d.ts.map +0 -1
  529. package/dist/external-imports-feature.js +0 -51
  530. package/dist/external-imports-feature.js.map +0 -1
  531. package/dist/finding-normalization.d.ts +0 -5
  532. package/dist/finding-normalization.d.ts.map +0 -1
  533. package/dist/finding-normalization.js +0 -155
  534. package/dist/finding-normalization.js.map +0 -1
package/README.md CHANGED
@@ -4,8 +4,8 @@ Run Codex Security from TypeScript or the command line to find, validate, and fi
4
4
  security vulnerabilities in your code. The package includes the Codex runtime,
5
5
  security plugin, and TypeScript declarations. It uses ES modules.
6
6
 
7
- - Scan repositories, selected paths, or Git changes. Deep scans run parallel
8
- discovery workers on repositories and selected paths.
7
+ - Scan repositories, selected paths, or Git changes. Deep scans repeat Standard
8
+ scans of the selected scope and merge their findings after each batch.
9
9
  - Validate findings, generate patches, and verify existing fixes.
10
10
  - Draft security policies and retain threat models.
11
11
  - Review saved findings, identify duplicates, classify severity, and suggest owners.
@@ -29,11 +29,9 @@ Supported runtimes:
29
29
  - Python 3.10+ for scans, policy generation, exports, scan history, and saved
30
30
  findings. Python 3.10 also needs `tomli`.
31
31
 
32
- Reading compressed Codex session logs (`.jsonl.zst`) requires Node.js 22.15.0+
33
- within 22.x, or Node.js 24.x or 26.x. On Node.js 22.13–22.14, compressed sessions
34
- are unavailable when reading saved activity or attaching scan logs to feedback, and
35
- scans whose original session is compressed cannot resume. Plain `.jsonl` logs
36
- work on all supported runtimes.
32
+ Compressed Codex session logs (`.jsonl.zst`) are readable on all supported Node.js
33
+ versions. The bundled streaming decoder reads concatenated frames and reports
34
+ truncated streams as collection errors.
37
35
 
38
36
  ### Install the CLI
39
37
 
@@ -44,14 +42,9 @@ npm install --global @openai/codex-security
44
42
  cs --version
45
43
  ```
46
44
 
47
- `cs` is a short alias for `codex-security`; both commands run the same CLI.
48
- The installation creates both commands in npm's global executable directory,
49
- which must be on your `PATH`. If `cs` already resolves to another tool, use
50
- `codex-security` instead. If npm stops with an `EEXIST` error for `cs`, use
51
- `npx @openai/codex-security` without a global installation.
52
-
53
- Continue with the [CLI walkthrough](#cli). To run without a global installation,
54
- replace `cs` in the CLI examples with `npx @openai/codex-security`.
45
+ Continue with the [CLI walkthrough](#cli). You can use the full command
46
+ `codex-security` if `cs` names another tool on your PATH. If installation
47
+ fails with `EEXIST`, use `npx @openai/codex-security` in place of `cs`.
55
48
 
56
49
  ### Install the TypeScript SDK
57
50
 
@@ -61,24 +54,6 @@ Install the package locally in your TypeScript project:
61
54
  npm install @openai/codex-security
62
55
  ```
63
56
 
64
- ### Package and plugin versions
65
-
66
- For bug reports, run `npx @openai/codex-security info --json` in the project
67
- where the SDK is installed, or `codex-security info --json` for a global install.
68
- Include the npm version (`cliVersion` and `sdkVersion`), bundled plugin manifest
69
- version (`bundledPluginVersion`), and Codex runtime and SDK pins (`codexVersion`
70
- and `codexSdkVersion`). If you used a marketplace plugin, a plugin supplied by
71
- path, or a custom Codex executable, include its version separately.
72
-
73
- For example, `npm view @openai/codex-security@0.1.5 gitHead dist.integrity`
74
- shows the registry's source commit and tarball digest. Compare `gitHead` with
75
- the commit for tag `npm-v0.1.5`. `npm pack @openai/codex-security@0.1.5` downloads
76
- the archive, including `package/_bundled_plugin/.codex-plugin/plugin.json`.
77
-
78
- The [release workflow](https://github.com/openai/codex-security/blob/main/.github/workflows/node-github-release.yml)
79
- verifies the signed attestation that binds the tarball to the tagged commit.
80
- For `0.1.0` and `0.1.1`, npm omits `gitHead`. Use the commit from the verified attestation.
81
-
82
57
  ## Authentication
83
58
 
84
59
  Sign in with ChatGPT:
@@ -133,39 +108,6 @@ Bedrock scans use AWS credentials and model access. They do not require
133
108
  [Bedrock guide](https://github.com/openai/codex-security/blob/main/docs/bedrock.md)
134
109
  for setup, model selection, and verification.
135
110
 
136
- ## Read existing Cloud findings
137
-
138
- The Security plugin includes `$cloud-findings` for accounts where Codex Security
139
- Cloud is available. Install the plugin through your configured Codex marketplace,
140
- sign in to Codex with ChatGPT, and complete the Cloud connection interactively in
141
- the intended account and workspace. Installation alone does not authenticate the
142
- connection. Local scans do not require Cloud, and an API key used for scanning
143
- does not replace the Cloud connection.
144
-
145
- In Codex desktop or the interactive Codex CLI, ask:
146
-
147
- > Use $cloud-findings to list findings for example/security-demo in my selected
148
- > workspace. Inspect the highest-severity finding and its report, and show its
149
- > recorded assignee, patch links, verification results, and latest scan status.
150
- > Do not change anything.
151
-
152
- After completing connection setup, the same host connection can be used by
153
- `codex exec`:
154
-
155
- ```bash
156
- codex exec --ephemeral --json -s read-only 'Use $codex-security:cloud-findings to read findings and the latest scan status for example/security-demo in my selected workspace. Inspect one finding and its report. If the workspace or repository is ambiguous, explain the required selection and stop. Do not change anything.'
157
- ```
158
-
159
- Noninteractive execution needs an existing authenticated connection; it cannot
160
- complete first-time sign-in. If authentication expires, the app is unavailable,
161
- or workspace policy denies access, complete the reported setup action before
162
- retrying. Those failures do not mean the repository has no findings.
163
-
164
- Assignment, issue validation, patch checks, periodic fix checks, and finding
165
- lifecycle status are separate records. Some finding sources do not provide all
166
- of them. The read workflow reports missing data and incomplete evidence pages,
167
- and does not describe failed or unfinished scans as clean.
168
-
169
111
  ## Run a scan from TypeScript
170
112
 
171
113
  Scan a repository you own or have permission to assess:
@@ -200,19 +142,21 @@ permissions; newly created directories are private to you by default.
200
142
  | --------------------------------- | ---------------------------------------------------------------- |
201
143
  | `findings.findings` | Findings from this scan. |
202
144
  | `reportPath` | Path to the Markdown report. |
203
- | `review` | Additional excluded paths. This is not file coverage. |
145
+ | `review.excludedPaths` | Additional paths the scan excluded. |
204
146
  | `repositoryFindings` | This scan's findings plus earlier open findings, when available. |
205
147
  | `sarifPath` | SARIF export path, or `null`. |
206
148
  | `threatModel` / `threatModelPath` | Saved threat model and document path; either can be `null`. |
207
149
  | `cost` | Estimated model usage cost, or `null` when unavailable. |
208
150
 
209
- Review the requested paths and exclusions alongside the execution outcome.
210
- `reviewState.deferred` records unfinished requested work, while
211
- `reviewState.openQuestions` records optional follow-up separately.
151
+ Read `result.manifest.scan.status` and `result.manifest.scan.scope` alongside
152
+ `result.review.excludedPaths` to see the outcome, the requested scope and any
153
+ additional exclusions. A completed scan can report zero findings within that scope.
212
154
 
213
- Review the scan status and scope alongside findings. A report with no findings does not establish
214
- that the repository is secure. Reports and logs can contain source code,
215
- vulnerability details, and credentials; review them before sharing.
155
+ If the run retained a draft or checkpoint, its `reviewState.deferred` lists
156
+ unfinished work and `reviewState.openQuestions` lists follow-up questions.
157
+ See [saved scan files](docs/cli.md#understand-scan-scope-and-follow-up-work)
158
+ for the current and legacy layouts. Reports and logs can include source code,
159
+ vulnerability details and credentials. Review them before sharing.
216
160
 
217
161
  Saved-history excerpts use scanned Git objects without fetching missing data.
218
162
  Working-tree diff scans omit excerpts, as do historical scans whose source or
@@ -302,12 +246,12 @@ For a custom `pluginPath`, check [custom plugin compatibility](#custom-plugins).
302
246
 
303
247
  To enable Daybreak on Codex 0.163.0 or later, set `codexOverrides.daybreak: true`.
304
248
  The toggle defaults off; an explicit `false` keeps it off. The setting reaches
305
- Deep Scan discovery and reducer workers, including resumed workers. Scans use
249
+ Deep Scan discovery workers, including resumed workers. Scans use
306
250
  isolated configuration, so a desktop toggle or personal Codex configuration does
307
251
  not configure an SDK scan. See [Daybreak opt-in](docs/cli.md#daybreak-opt-in) for
308
252
  CLI, project-file, and direct plugin configuration.
309
253
 
310
- Deep Scan discovery, reducer, and resumed workers inherit per-scan provider,
254
+ Deep Scan workers, including resumed workers, inherit per-scan provider,
311
255
  authentication, environment, and executable settings with read-only permissions.
312
256
 
313
257
  Scans use an isolated Codex configuration. See
@@ -392,20 +336,51 @@ const result = await security.run("/path/to/repository", {
392
336
  });
393
337
  ```
394
338
 
395
- `workers` controls concurrent discovery workers; `subagents` controls delegation
396
- within each worker. Time and run limits apply to discovery. After discovery
397
- stops, the scan combines and returns completed findings. See
339
+ `workers` controls concurrent Standard scans and `subagents` controls delegation
340
+ within each scan. Time and run limits apply to discovery. The coordinator merges
341
+ completed findings before the next batch starts. See
398
342
  [deep scan settings](docs/cli.md#configure-deep-scans) for defaults and saved settings.
399
343
  Deep discovery retains its enforced deadline, with a default and maximum of
400
344
  5760 minutes. `maxTimeHours` remains a deprecated Deep-only alias in hours.
401
345
 
402
346
  ### Progress and cost
403
347
 
404
- Use `onProgress` for scan progress and `onCost` for cost updates.
405
- Use `onUsageObservation` for the last reported token measurement time
348
+ Use `onLifecycle` to observe the saved state of a top-level scan in your own
349
+ application:
350
+
351
+ ```ts
352
+ await security.run(repository, {
353
+ onLifecycle(scan) {
354
+ console.log(scan.scanId, scan.status, scan.hasReportableFindings);
355
+ },
356
+ });
357
+ ```
358
+
359
+ For `runComponentScans()`, subscribe to `onScanEvent` and select events with
360
+ `type === "lifecycle"` to correlate each snapshot with its `componentId`. Deep
361
+ component scans also emit `deep-progress` events with independent review counts.
362
+
363
+ Group observations by `scanId`. A completed scan with
364
+ `hasReportableFindings: false` finished with zero reportable findings.
365
+ The field is `null` until that outcome is known. Saved scan history retains
366
+ the lifecycle snapshot after the originating process exits. The snapshot
367
+ includes the launch surface, package and plugin versions when available,
368
+ and whether the scan used a mock. Offline imports appear in history with
369
+ lifecycle mode `import`. Exclude imports and mock scans when counting executed
370
+ scans. For older records, saved recipes identify known imports, mock scans,
371
+ and the plugin version used at launch. Missing fields stay unknown.
372
+
373
+ If `run()` rejects before you receive a registration, record the error separately
374
+ from saved scan outcomes. The caller may have missed the registration receipt.
375
+
376
+ Use `onProgress` for scan progress and `onMeasurement` for observed token/cost
377
+ subtotals, coverage, and collection time. `onCost` and `onUsage` report complete
378
+ totals. `onUsageObservation` reports the native token measurement time
406
379
  (`tokensUpdatedAt`) and account-wide allowance readings (`accountRateLimits`).
407
- Each reading includes its own `observedAt` timestamp and the percentage used in
408
- each reported window. A limit-only update can arrive before any token measurement.
380
+ Each reading has its own `observedAt` timestamp and percentages used in each
381
+ reported window. An allowance can arrive before any token measurement. See
382
+ [telemetry and measurement](docs/telemetry.md) for operation receipts, collection
383
+ controls, replay, and reporting definitions.
409
384
 
410
385
  Follow scans with `onWorkerEvent` and `onReconnect`. `onWorkerEvent` reports
411
386
  persisted worker sessions discovered by the SDK's existing session tracker,
@@ -442,18 +417,24 @@ For retired progress hooks, see [older progress integrations](#older-progress-in
442
417
  contain source code or credentials. Deep scans additionally expose durable
443
418
  independent-review counts through `onDeepProgress`: `completed`, `active`, and
444
419
  `maximum`. The maximum is a configured cap, not a percentage denominator. The
445
- optional `consolidating` flag reports when results are being combined or the
446
- coordinator has finished.
420
+ optional `consolidating` flag is true while the running scan combines results or
421
+ waits for finalization after its coordinator finishes. It is false once the scan
422
+ completes, fails, or is canceled.
447
423
  `ScanOptions` lists all callbacks.
448
424
 
449
425
  Costs estimate API-equivalent model usage, not your bill or ChatGPT subscription
450
426
  allowance. Use `cost.estimatedUsdRange` for reporting. `maxCostUsd` uses the
451
427
  short-context estimate; in-flight requests can exceed it. Post-scan prompts run
452
- outside that limit. Matching earlier findings can also make model calls.
428
+ outside that limit. With a cost limit, completing the scan requires verifiable
429
+ usage for the scan and its workers. Matching earlier findings can also make model calls.
453
430
  See [progress and cost](docs/cli.md#progress-and-cost) for accounting and budget callbacks.
454
431
 
455
432
  ### Validate an existing finding
456
433
 
434
+ `validate()` sends the finding to your configured model provider. The model's
435
+ review tools can read the checkout, with network access and web search disabled.
436
+ Validation uses source evidence and skips builds, tests and application execution.
437
+
457
438
  ```ts
458
439
  import { writeFile } from "node:fs/promises";
459
440
 
@@ -468,15 +449,10 @@ console.log(result.disposition, result.report);
468
449
  await writeFile("/path/to/reports/assessment.md", result.report, "utf8");
469
450
  ```
470
451
 
471
- Pass finding text or a JSON-serializable object, not a file path. Standalone
472
- validation uses source evidence in a read-only, offline session. It does not build
473
- the target, execute application code, run tests or PoCs, or add a scan to history.
474
- The validator returns the assessment without writing report files. The example
475
- saves `result.report` in an existing directory. `outputDir` selects the session
476
- directory, not a report destination. Callers that previously read reports from it
477
- must save `result.report` instead.
478
- Callers needing runtime proof must arrange a separate reproduction step. Standard,
479
- Deep, and diff scan validation keep their existing workflows.
452
+ Pass literal finding text or a JSON-serializable object. The assessment is
453
+ returned to the caller and has no scan history entry. The example saves
454
+ `result.report` in an existing directory. Use `outputDir` to select the
455
+ session directory. If you need runtime evidence, arrange a separate check.
480
456
 
481
457
  The disposition is `reportable`, `suppressed`, `not_applicable`, or `deferred`.
482
458
  `reportable` can rely on static analysis; `deferred` means there is insufficient
@@ -496,6 +472,8 @@ See [host-provided standalone validation](docs/validate-records.md).
496
472
  workspace that the caller has intentionally made writable:
497
473
 
498
474
  ```ts
475
+ import { CodexSecurity } from "@openai/codex-security";
476
+
499
477
  const security = new CodexSecurity();
500
478
  try {
501
479
  const result = await security.patch({
@@ -505,7 +483,6 @@ try {
505
483
  summary: "User input reaches a raw SQL query.",
506
484
  locations: [{ path: "src/query.ts", startLine: 42 }],
507
485
  },
508
- signal,
509
486
  onActivity(activity) {
510
487
  console.log(activity.description);
511
488
  },
@@ -563,23 +540,16 @@ After [installing the CLI](#install-the-cli), sign in if needed:
563
540
  cs login
564
541
  ```
565
542
 
566
- From your repository, optionally [draft a `SECURITY.md`](#generate-a-security-policy)
567
- that explains what counts as a security issue in your project:
568
-
569
- ```bash
570
- cs policy .
571
- ```
572
-
573
- The draft is saved outside your repository. Review the diff and notes, edit the
574
- draft, then copy only `SECURITY.md` to the **Policy target** shown. Skip this step
575
- to keep your current policy or scan without one.
576
-
577
- Then scan the repository:
543
+ From the repository you want to review, run:
578
544
 
579
545
  ```bash
580
546
  cs scan .
581
547
  ```
582
548
 
549
+ Open the report at the path printed on completion. To inspect the latest
550
+ completed scan for this checkout, run `cs scans show`. To provide a project
551
+ policy for future scans, [draft and review a `SECURITY.md`](#generate-a-security-policy).
552
+
583
553
  To narrow the scan scope or check the configuration before scanning:
584
554
 
585
555
  ```bash
@@ -653,55 +623,70 @@ on CODEOWNERS, source, and Git history. Declared owners take priority over Git
653
623
  contributors. Suggestions do not assign tickets. See
654
624
  [owner suggestions](docs/cli.md#suggest-finding-owners) for input and output examples.
655
625
 
626
+ ### Read existing Cloud findings
627
+
628
+ The Security plugin includes `$cloud-findings` for accounts where Codex Security
629
+ Cloud is available. Install the plugin through your configured Codex marketplace,
630
+ sign in to Codex with ChatGPT, and complete the Cloud connection interactively in
631
+ the intended account and workspace. Installation alone does not authenticate the
632
+ connection. Local scans do not require Cloud, and an API key used for scanning
633
+ does not replace the Cloud connection.
634
+
635
+ In Codex desktop or the interactive Codex CLI, ask:
636
+
637
+ > Use $cloud-findings to list findings for example/security-demo in my selected
638
+ > workspace. Inspect the highest-severity finding and its report, and show its
639
+ > recorded assignee, patch links, verification results, and latest scan status.
640
+ > Do not change anything.
641
+
642
+ After completing connection setup, the same host connection can be used by
643
+ `codex exec`:
644
+
645
+ ```bash
646
+ codex exec --ephemeral --json -s read-only 'Use $codex-security:cloud-findings to read findings and the latest scan status for example/security-demo in my selected workspace. Inspect one finding and its report. If the workspace or repository is ambiguous, explain the required selection and stop. Do not change anything.'
647
+ ```
648
+
649
+ Noninteractive execution needs an existing authenticated connection; it cannot
650
+ complete first-time sign-in. If authentication expires, the app is unavailable,
651
+ or workspace policy denies access, complete the reported setup action before
652
+ retrying. Those failures do not mean the repository has no findings.
653
+
654
+ Assignment, issue validation, patch checks, periodic fix checks, and finding
655
+ lifecycle status are separate records. Some finding sources do not provide all
656
+ of them. The read workflow reports missing data and incomplete evidence pages,
657
+ and does not describe failed or unfinished scans as clean.
658
+
656
659
  ### Publish findings to Cloud
657
660
 
658
- `publish scan --to cloud` uploads selected findings to Codex Security Cloud.
659
- It requires ChatGPT credentials; inference API keys and AWS credentials do not
660
- grant Cloud access. See [Cloud publication](docs/cli.md#publish-completed-scans)
661
- for setup and review steps, or [Linear publication](docs/cli.md#publish-completed-scans-to-linear)
662
- for issue creation.
661
+ Use `publish scan --to cloud` for completed Codex Security scans or a Codex
662
+ Security findings CSV. Preview either input offline with `--dry-run`. Uploads
663
+ require a file-backed ChatGPT login. [Cloud publication](docs/cli.md#publish-completed-scans)
664
+
665
+ For a report exported by a scanner, see [Import external findings](#import-external-findings).
666
+ For issue tracking, see [Linear publication](docs/cli.md#publish-completed-scans-to-linear).
663
667
 
664
668
  ### Import external findings
665
669
 
666
- External vendor imports are opt-in. Set `CODEX_SECURITY_ENABLE_EXTERNAL_IMPORTS=1`
667
- to enable `publish findings`, `findings imported`, `import sonar`, `import github-advisories`, and
668
- the SDK's external publication, local import/readback, Sonar issue collection, and advisory acquisition
669
- APIs. They are disabled otherwise; CLI commands are hidden from help and schemas.
670
- SDK callers can supply the flag through the existing per-call
671
- `dependencies.environment`, or in `options.environment` for `collectSonarIssues(options)`.
672
- For an SDK import of selected Sonar issues, pass their keys in `options.issueKeys`.
673
- Omit `issueKeys` to collect the project's open security issues. An empty list is rejected.
674
- If you know the source repository, pass its Git URL in `options.sourceRepositoryUrl`
675
- to check the Sonar binding before fetching issues.
676
- Pure normalizers and file readers remain available.
677
- For AWS Continuum code findings, use `readContinuumFindings(path, sourceRepositoryUrl)`
678
- with a saved list or detail response, or `normalizeContinuumFindings(input, sourceRepositoryUrl)`
679
- with parsed JSON. Verify the repository for the selected findings before passing its Git URL.
680
- [Continuum import guide](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/continuum.md)
670
+ For a saved scanner report, call `prepareLocalExternalImport` for a checkout
671
+ or `prepareExternalPublication` for a connected Cloud repository. Review the
672
+ returned `preview`, then call `import()` to save locally or `publish()` to
673
+ upload. The [scanner import guides](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/README.md)
674
+ list the supported report formats and destinations for each provider.
681
675
 
682
- Use `normalizeSelectedSemgrepPlatformFindings` for selected SAST findings from saved
683
- Semgrep Web API responses. See the [Semgrep SDK example](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/semgrep.md#import-selected-semgrep-platform-sast-findings-with-the-sdk).
684
- This does not affect scan publishing or the existing GitHub alert collector.
685
-
686
- The SDK also exposes `prepareExternalPublication(file, options)` for supported
687
- vendor exports and `prepareNormalizedExternalPublication(findings, options)` for
688
- normalized external evidence from any provider in the Cloud import contract.
689
- The normalized API accepts `NormalizedExternalPublicationOptions`; file readers
690
- use `ExternalPublicationOptions` for their supported formats. Both resolve the Cloud repository and return a
691
- `preview` plus a separate `publish()` operation. Inspect the preview before
692
- calling `publish()`. Imported evidence remains not assessed by Codex, and saved
693
- requests and receipts support retries after interruption.
694
-
695
- For CLI examples and supported input formats, see the
696
- [scanner import guides](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/README.md).
697
-
698
- The SDK's `prepareLocalExternalImport(file, options)` returns a `preview` and a
699
- separate `import()` operation. `prepareNormalizedLocalImport(findings,
700
- options)` accepts already normalized evidence, and
701
- `listLocalExternalFindings({ repository })` reads the stored records. Imports
702
- remain unassessed source evidence, separate from native scan findings. Repeated
703
- imports update the same repository/provider/source-key/source-ID record; omitted
704
- records remain stored, and unknown evidence fields are not inferred.
676
+ For normalized evidence, use `prepareNormalizedLocalImport(findings, options)`
677
+ or `prepareNormalizedExternalPublication(findings, options)` and review the
678
+ preview in the same way. Cloud file imports use `ExternalPublicationOptions`,
679
+ and normalized Cloud imports use `NormalizedExternalPublicationOptions`. Keep
680
+ Cloud receipts and saved requests when retrying an interrupted submission.
681
+
682
+ Use `listLocalExternalFindings({ repository })` to read saved scanner evidence.
683
+ It starts unassessed. Reimporting the same repository, provider, source key
684
+ and finding ID updates that record. Records omitted from the export remain stored.
685
+
686
+ A local SDK import with only excluded records returns the exclusions and zero
687
+ writes. The CLI exits 2 in that case. When Cloud preparation throws
688
+ `NoPublishableFindingsError`, inspect its `selection` for the read count,
689
+ exclusions and scanner diagnostics. A clean empty report needs no upload.
705
690
 
706
691
  File imports forward repository references from the reader automatically. With
707
692
  `prepareNormalizedLocalImport()`, supply additional known references in the
@@ -713,6 +698,50 @@ reports carry this platform in their repository inventory. If you export only th
713
698
  normalized finding rows to JSONL, supply that metadata separately; the original
714
699
  finding evidence does not include the surrounding inventory.
715
700
 
701
+ #### Collect and normalize scanner evidence
702
+
703
+ To collect selected Sonar issues, pass their keys to `collectSonarIssues` in `options.issueKeys`.
704
+ Omit `issueKeys` to collect the project's open security issues. An empty list is rejected.
705
+ If you know the source repository, pass its Git URL in `options.sourceRepositoryUrl`
706
+ to check the Sonar binding before fetching issues.
707
+
708
+ For AWS Continuum code findings, use `readContinuumFindings(path, sourceRepositoryUrl)`
709
+ with a saved list or detail response, or `normalizeContinuumFindings(input, sourceRepositoryUrl)`
710
+ with parsed JSON. Verify the repository for the selected findings before passing its Git URL.
711
+ [Continuum import guide](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/continuum.md)
712
+
713
+ For a saved Checkmarx One CLI JSON or CxSAST XML report, use
714
+ `readCheckmarxFindings(path, sourceRepositoryUrl, "local")` to inspect its evidence.
715
+ To prepare a local import, pass `provider: "checkmarx"` and the verified
716
+ `sourceRepositoryUrl` to `prepareLocalExternalImport`. Keep each batch of normalized
717
+ Checkmarx findings scoped to one scan and its repository.
718
+ [Checkmarx SAST import guide](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/checkmarx.md)
719
+
720
+ Use `collectSelectedSemgrepGuardianFindings` with a connected Guardian MCP client to
721
+ [capture selected Code or Supply Chain findings](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/semgrep.md#import-selected-guardian-findings) using the user's Guardian sign-in.
722
+ Use `normalizeSelectedSemgrepPlatformFindings` for selected SAST findings from saved
723
+ Semgrep Web API responses. See the [Semgrep SDK example](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/semgrep.md#import-selected-semgrep-platform-sast-findings-with-the-sdk).
724
+ Use `selectSemgrepPlatformFindings` to [save a selection for the local CLI](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/semgrep.md#existing-platform-findings).
725
+ Use `collectSemgrepPlatformFindings` to [collect one project at an explicit ref](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/semgrep.md#collect-a-platform-project-and-branch) for a single product (default `sast`).
726
+
727
+ Use `collectSnykIssues` to [collect existing Open Source or Code issues](https://github.com/openai/codex-security/blob/main/docs/scanner-imports/snyk.md#existing-issues-from-snyk) for local import or Cloud publication.
728
+ For a private repository with a verified SCM, pass its URL and `platform: "gitlab"` or `"github"` in `sourceRepositories` to match standard SSH clone URLs.
729
+
730
+ To inspect dependency vulnerabilities in a saved Trivy schema-v2 repository or filesystem
731
+ report, call `readTrivyFindings` with the JSON or gzip path. Use `normalizeTrivyFindings`
732
+ for an already parsed report. Supply the scanned directory relative to the checkout
733
+ (`.` for the whole checkout) unless the report's remote target and Git metadata establish it.
734
+
735
+ ```ts
736
+ import { readTrivyFindings } from "@openai/codex-security";
737
+
738
+ const { findings, excluded, report } = await readTrivyFindings(
739
+ "trivy.json.gz",
740
+ "local",
741
+ ".",
742
+ );
743
+ ```
744
+
716
745
  ## Findings storage and deduplication
717
746
 
718
747
  Saved-scan deduplication uses local SQLite directly:
@@ -744,7 +773,7 @@ Local tools running under the same account are trusted.
744
773
  The scan profile allows reads across the local filesystem and writes to workspace
745
774
  roots. Execution approvals are reviewed automatically and may grant extra
746
775
  permissions for an operation. Set `codexOverrides.approval_policy: "never"`
747
- (or CLI `--codex 'approval_policy="never"'`) to deny permission requests.
776
+ (or CLI `--codex "approval_policy='never'"`) to deny permission requests.
748
777
  If you select a Codex profile, its explicit `approval_policy` takes precedence
749
778
  over the root setting.
750
779
  Host and network restrictions still apply.
@@ -755,6 +784,18 @@ paths. Keep state and scan artifacts private and outside the repository.
755
784
 
756
785
  ## Compatibility
757
786
 
787
+ ### Package and plugin versions
788
+
789
+ When reporting a problem, run `codex-security info --json` with the installation
790
+ that produced it. For a local SDK installation, run
791
+ `npx @openai/codex-security info --json` in that project. Include `cliVersion`,
792
+ `sdkVersion`, `bundledPluginVersion`, `codexVersion` and `codexSdkVersion`. If
793
+ you supplied a separate plugin or Codex executable, include its version too.
794
+
795
+ For package provenance, compare the registry's `gitHead` and `dist.integrity`
796
+ with the release tag and tarball. If a package omits `gitHead`, use the commit
797
+ in its [verified release attestation](https://github.com/openai/codex-security/blob/main/.github/workflows/node-github-release.yml).
798
+
758
799
  ### Custom plugins
759
800
 
760
801
  New and resumed Deep Scans require a plugin with `directDeepScanEngine: 1`,
@@ -8,6 +8,8 @@
8
8
  "CODEX_HOME",
9
9
  "CODEX_SQLITE_HOME",
10
10
  "CODEX_API_KEY",
11
+ "CODEX_OSS_BASE_URL",
12
+ "CODEX_OSS_PORT",
11
13
  "CODEX_SAFETY_IDENTIFIER",
12
14
  "CODEX_BROWSER_USE_NODE_PATH",
13
15
  "CODEX_CLI_PATH",
@@ -18,6 +20,9 @@
18
20
  "OPENROUTER_API_KEY",
19
21
  "FIREWORKS_API_KEY",
20
22
  "CHEAPER_INFERENCE_API_KEY",
23
+ "GOOGLE_CLOUD_PROJECT",
24
+ "GOOGLE_CLOUD_LOCATION",
25
+ "GOOGLE_APPLICATION_CREDENTIALS",
21
26
  "AWS_BEARER_TOKEN_BEDROCK",
22
27
  "AWS_ACCESS_KEY_ID",
23
28
  "AWS_SECRET_ACCESS_KEY",
@@ -38,7 +43,6 @@
38
43
  "PYTHONUTF8",
39
44
  "CODEX_SECURITY_PYTHON_COMMAND",
40
45
  "CODEX_SECURITY_GIT",
41
- "CODEX_SECURITY_ENABLE_EXTERNAL_IMPORTS",
42
46
  "CODEX_SECURITY_KNOWLEDGE_BASE",
43
47
  "CODEX_SECURITY_CONFIG_PATH",
44
48
  "CODEX_SECURITY_DEEP_SCAN_CONFIG_PATH",
@@ -2,10 +2,17 @@
2
2
  "documentType": "codex-security.findings",
3
3
  "findings": [
4
4
  {
5
- "attackPath": null,
5
+ "attackPath": {
6
+ "dataflow": {
7
+ "summary": "The archive supplies an entry name. The extractor uses that name to select the file it writes."
8
+ },
9
+ "reachability": {
10
+ "summary": "The caller must be able to supply an archive for extraction. The service account must have write access to the destination."
11
+ }
12
+ },
6
13
  "confidence": {
7
14
  "level": "high",
8
- "rationale": "Direct source trace reaches the filesystem write without a containment check."
15
+ "rationale": "The destination passed to the file writer is visible in the reviewed code."
9
16
  },
10
17
  "extensions": {},
11
18
  "findingId": "csf_852f90d6e1177502ff113d4a",
@@ -37,11 +44,13 @@
37
44
  ],
38
45
  "ruleId": "path-traversal.archive-extraction",
39
46
  "severity": {
47
+ "changeConditions": "A filesystem policy that confines writes to a disposable import directory would limit the impact.",
40
48
  "level": "high",
49
+ "rationale": "The caller can alter files outside the import area with the permissions of the extraction service.",
41
50
  "score": 8.1,
42
51
  "scoringSystem": "CVSS:3.1"
43
52
  },
44
- "summary": "An attacker-controlled path reaches a filesystem write without containment validation.",
53
+ "summary": "Archive extraction can overwrite files outside the directory chosen for the import.",
45
54
  "taxonomy": {
46
55
  "category": "path-traversal",
47
56
  "cwe": [
@@ -49,7 +58,10 @@
49
58
  ]
50
59
  },
51
60
  "title": "Unsafe archive extraction can escape the output directory",
52
- "validation": null
61
+ "validation": {
62
+ "method": "Static source review",
63
+ "summary": "The extractor combines the output directory with the entry name and passes the resulting path to the writer. It never checks that the destination stays inside the output directory."
64
+ }
53
65
  }
54
66
  ],
55
67
  "scanId": "scan_example_001",
@@ -11,6 +11,7 @@ The scan was configured for the include paths and exclusions listed below.
11
11
  - Snapshot digest: codex-security-snapshot/v1:sha256:ed88f96a4c1a06603a41b3f261f59c3de2555c367ef6ad3bb8b9e483495d34eb
12
12
  - Included paths: .
13
13
  - Excluded paths: none
14
+ - Scan context: Illustrative scan of a synthetic archive importer.
14
15
 
15
16
  ### Scan Summary
16
17
 
@@ -20,7 +21,7 @@ The scan was configured for the include paths and exclusions listed below.
20
21
  | Reportable findings | 1 |
21
22
  | Severity mix | high: 1 |
22
23
  | Confidence mix | high: 1 |
23
- | Validation mode | not recorded |
24
+ | Validation mode | Static source review |
24
25
 
25
26
  Canonical artifacts: `scan-manifest.json` and `findings.json`. This report is a deterministic projection of those files.
26
27
 
@@ -50,32 +51,34 @@ No explicit canonical threat-model summary was recorded.
50
51
  | --- | --- |
51
52
  | Severity | high |
52
53
  | Confidence | high |
53
- | Confidence rationale | Direct source trace reaches the filesystem write without a containment check. |
54
+ | Confidence rationale | The destination passed to the file writer is visible in the reviewed code. |
54
55
  | Category | path-traversal |
55
56
  | CWE | CWE-22 |
56
57
  | Affected lines | src/extract.py:41-44 |
57
58
 
58
59
  #### Summary
59
60
 
60
- An attacker-controlled path reaches a filesystem write without containment validation.
61
+ Archive extraction can overwrite files outside the directory chosen for the import.
61
62
 
62
63
  #### Validation
63
64
 
64
- Direct source trace reaches the filesystem write without a containment check. Validation details were not recorded separately.
65
+ The extractor combines the output directory with the entry name and passes the resulting path to the writer. It never checks that the destination stays inside the output directory.
66
+
67
+ Validation method: Static source review
65
68
 
66
69
  #### Dataflow
67
70
 
68
- The canonical finding records the affected path at src/extract.py:41-44, but no expanded source-to-sink narrative was recorded.
71
+ The archive supplies an entry name. The extractor uses that name to select the file it writes.
69
72
 
70
73
  #### Reachability
71
74
 
72
- Reachability was not recorded beyond the canonical finding summary and affected locations.
75
+ The caller must be able to supply an archive for extraction. The service account must have write access to the destination.
73
76
 
74
77
  #### Severity
75
78
 
76
- **High** — The scan assigned high severity; no separate canonical severity rationale was recorded.
79
+ **High** — The caller can alter files outside the import area with the permissions of the extraction service.
77
80
 
78
- Additional runtime or deployment evidence could raise or lower this severity.
81
+ A filesystem policy that confines writes to a disposable import directory would limit the impact.
79
82
 
80
83
  #### Remediation
81
84