@openai/codex-security 0.1.31 → 0.3.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.
Files changed (514) hide show
  1. package/README.md +442 -2434
  2. package/_bundled_plugin/.app.json +5 -1
  3. package/_bundled_plugin/.codex-plugin/plugin.json +9 -5
  4. package/_bundled_plugin/.mcp.json +3 -0
  5. package/_bundled_plugin/examples/completed-scan/coverage.json +0 -1
  6. package/_bundled_plugin/examples/completed-scan/report.md +28 -26
  7. package/_bundled_plugin/examples/completed-scan/scan-manifest.json +1 -1
  8. package/_bundled_plugin/mcp/helpers.mjs +1 -0
  9. package/_bundled_plugin/mcp/helpers.mjs.br.part-000 +0 -0
  10. package/_bundled_plugin/mcp/native/THIRD_PARTY_NOTICES.txt +7 -214
  11. package/_bundled_plugin/mcp/native/darwin-arm64/unix.node +0 -0
  12. package/_bundled_plugin/mcp/native/darwin-x64/unix.node +0 -0
  13. package/_bundled_plugin/mcp/native/linux-arm64-gnu/unix.node +0 -0
  14. package/_bundled_plugin/mcp/native/linux-arm64-musl/unix.node +0 -0
  15. package/_bundled_plugin/mcp/native/linux-x64-gnu/unix.node +0 -0
  16. package/_bundled_plugin/mcp/native/linux-x64-musl/unix.node +0 -0
  17. package/_bundled_plugin/mcp/native/win32-arm64/windows.node +0 -0
  18. package/_bundled_plugin/mcp/native/win32-x64/windows.node +0 -0
  19. package/_bundled_plugin/mcp/permission-profile-preflight.mjs +563 -0
  20. package/_bundled_plugin/mcp/server.mjs +1 -0
  21. package/_bundled_plugin/mcp/server.mjs.br.part-000 +0 -0
  22. package/_bundled_plugin/mcp/server.mjs.br.part-001 +0 -0
  23. package/_bundled_plugin/preflight/capability-profiles.toml +0 -13
  24. package/_bundled_plugin/references/artifact-storage.md +5 -5
  25. package/_bundled_plugin/references/config-preflight.md +1 -5
  26. package/_bundled_plugin/references/core-scan.md +34 -10
  27. package/_bundled_plugin/references/final-report.md +13 -13
  28. package/_bundled_plugin/references/finding-detail-fields.md +90 -80
  29. package/_bundled_plugin/references/sarif-adapter.md +1 -1
  30. package/_bundled_plugin/references/scan-artifacts.md +3 -4
  31. package/_bundled_plugin/references/scan-contract.md +11 -6
  32. package/_bundled_plugin/references/scan-prologue.md +12 -0
  33. package/_bundled_plugin/references/security-guidance.md +2 -2
  34. package/_bundled_plugin/references/standalone-validation.md +11 -0
  35. package/_bundled_plugin/references/threat-model.md +2 -2
  36. package/_bundled_plugin/schemas/coverage.schema.json +23 -47
  37. package/_bundled_plugin/schemas/definitions/artifact-common.schema.json +2 -24
  38. package/_bundled_plugin/schemas/definitions/discovery-candidate.schema.json +49 -25
  39. package/_bundled_plugin/schemas/findings.schema.json +71 -192
  40. package/_bundled_plugin/schemas/scan-manifest.schema.json +83 -95
  41. package/_bundled_plugin/schemas/tools/candidate-attack-paths.schema.json +91 -83
  42. package/_bundled_plugin/schemas/tools/candidate-validations.schema.json +35 -64
  43. package/_bundled_plugin/schemas/tools/deep-reducer.schema.json +5 -2
  44. package/_bundled_plugin/schemas/tools/discovery-candidates.schema.json +6 -55
  45. package/_bundled_plugin/schemas/tools/review-items.schema.json +2 -38
  46. package/_bundled_plugin/schemas/tools/scan-draft.schema.json +245 -356
  47. package/_bundled_plugin/scripts/codex_profile.mjs +239 -0
  48. package/_bundled_plugin/scripts/codex_session.mjs +53 -0
  49. package/_bundled_plugin/scripts/config_preflight.py +29 -69
  50. package/_bundled_plugin/scripts/deep_scan_config.py +9 -11
  51. package/_bundled_plugin/scripts/deep_scan_workbench.py +208 -363
  52. package/_bundled_plugin/scripts/filesystem_identity.py +1 -5
  53. package/_bundled_plugin/scripts/finalize_scan_contract.py +733 -375
  54. package/_bundled_plugin/scripts/finding_preview.py +81 -91
  55. package/_bundled_plugin/scripts/generate_in_scope_files.py +48 -102
  56. package/_bundled_plugin/scripts/generate_rank_input.py +117 -888
  57. package/_bundled_plugin/scripts/launch_codex_security_mcp +35 -6
  58. package/_bundled_plugin/scripts/launch_codex_security_mcp.cmd +5 -5
  59. package/_bundled_plugin/scripts/rank_preview.py +43 -902
  60. package/_bundled_plugin/scripts/report_projection.py +143 -219
  61. package/_bundled_plugin/scripts/snapshot_sqlite.py +6 -1
  62. package/_bundled_plugin/scripts/threat_model_projection.py +161 -0
  63. package/_bundled_plugin/scripts/validate_scan_contract.py +4 -34
  64. package/_bundled_plugin/scripts/validate_tracking_source.py +3 -13
  65. package/_bundled_plugin/scripts/windows_scan_local_files.py +59 -9
  66. package/_bundled_plugin/scripts/workbench/handoff.py +25 -50
  67. package/_bundled_plugin/scripts/workbench/runtime_toml.py +22 -0
  68. package/_bundled_plugin/scripts/workbench/storage.py +21 -6
  69. package/_bundled_plugin/scripts/workbench_cli.py +99 -190
  70. package/_bundled_plugin/scripts/workbench_constants.py +6 -14
  71. package/_bundled_plugin/scripts/workbench_db.py +524 -672
  72. package/_bundled_plugin/scripts/workbench_feedback.py +6 -3
  73. package/_bundled_plugin/scripts/workbench_finding_index.py +20 -7
  74. package/_bundled_plugin/scripts/workbench_finding_workflows.py +18 -4
  75. package/_bundled_plugin/scripts/workbench_local_dedupe.py +136 -0
  76. package/_bundled_plugin/scripts/workbench_native_indexes.py +28 -18
  77. package/_bundled_plugin/scripts/workbench_progress.py +26 -92
  78. package/_bundled_plugin/scripts/workbench_publication.py +77 -116
  79. package/_bundled_plugin/scripts/workbench_remediation.py +14 -20
  80. package/_bundled_plugin/scripts/workbench_saved_results.py +1402 -263
  81. package/_bundled_plugin/scripts/workbench_scan_history.py +57 -57
  82. package/_bundled_plugin/scripts/workbench_scan_start.py +109 -52
  83. package/_bundled_plugin/scripts/workbench_scan_usage.py +30 -49
  84. package/_bundled_plugin/scripts/workbench_schema.py +71 -1370
  85. package/_bundled_plugin/scripts/workbench_source_excerpt.py +16 -7
  86. package/_bundled_plugin/scripts/workbench_target.py +526 -150
  87. package/_bundled_plugin/scripts/workbench_target_state.py +1 -5
  88. package/_bundled_plugin/scripts/workbench_validation.py +19 -44
  89. package/_bundled_plugin/shared/workbench-history-repairs.json +218 -0
  90. package/_bundled_plugin/shared/workbench-migrations.json +397 -0
  91. package/_bundled_plugin/skills/assess-patch-risk/SKILL.md +15 -4
  92. package/_bundled_plugin/skills/attack-path-analysis/SKILL.md +1 -0
  93. package/_bundled_plugin/skills/cloud-findings/SKILL.md +54 -0
  94. package/_bundled_plugin/skills/cloud-findings/agents/openai.yaml +4 -0
  95. package/_bundled_plugin/skills/deep-security-scan/SKILL.md +6 -6
  96. package/_bundled_plugin/skills/deep-security-scan/agents/openai.yaml +1 -1
  97. package/_bundled_plugin/skills/finding-discovery/SKILL.md +3 -3
  98. package/_bundled_plugin/skills/propose-security-hardening/references/proposal-format.md +50 -20
  99. package/_bundled_plugin/skills/security-diff-scan/SKILL.md +8 -14
  100. package/_bundled_plugin/skills/security-diff-scan/agents/openai.yaml +1 -1
  101. package/_bundled_plugin/skills/security-scan/SKILL.md +22 -7
  102. package/_bundled_plugin/skills/security-scan/agents/openai.yaml +1 -1
  103. package/_bundled_plugin/skills/security-scan/references/desktop-scan.md +2 -2
  104. package/_bundled_plugin/skills/security-scan/references/scan-artifacts-and-ledger.md +13 -1
  105. package/_bundled_plugin/skills/threat-model/SKILL.md +2 -2
  106. package/_bundled_plugin/skills/track-findings/SKILL.md +46 -178
  107. package/_bundled_plugin/skills/track-findings/agents/openai.yaml +1 -1
  108. package/_bundled_plugin/skills/track-findings/references/github-security-advisories.md +16 -24
  109. package/_bundled_plugin/skills/track-findings/references/jira.md +15 -61
  110. package/_bundled_plugin/skills/triage-finding/SKILL.md +50 -289
  111. package/_bundled_plugin/skills/triage-finding/agents/openai.yaml +2 -2
  112. package/_bundled_plugin/skills/triage-finding/references/ticket-intake.md +23 -43
  113. package/_bundled_plugin/skills/triage-finding/references/triage-result-contract.md +7 -1
  114. package/bin/codex-security.mjs +9 -2
  115. package/dist/api.d.ts +63 -15
  116. package/dist/api.d.ts.map +1 -1
  117. package/dist/api.js +970 -553
  118. package/dist/api.js.map +1 -1
  119. package/dist/artifact-export.d.ts +70 -0
  120. package/dist/artifact-export.d.ts.map +1 -0
  121. package/dist/artifact-export.js +292 -0
  122. package/dist/artifact-export.js.map +1 -0
  123. package/dist/auth.d.ts +2 -6
  124. package/dist/auth.d.ts.map +1 -1
  125. package/dist/auth.js +27 -12
  126. package/dist/auth.js.map +1 -1
  127. package/dist/bulk-scan-discovery.d.ts +1 -0
  128. package/dist/bulk-scan-discovery.d.ts.map +1 -1
  129. package/dist/bulk-scan-discovery.js +9 -9
  130. package/dist/bulk-scan-discovery.js.map +1 -1
  131. package/dist/classify-scan-severity.d.ts.map +1 -1
  132. package/dist/classify-scan-severity.js +2 -5
  133. package/dist/classify-scan-severity.js.map +1 -1
  134. package/dist/classify-severity.d.ts +28 -17
  135. package/dist/classify-severity.d.ts.map +1 -1
  136. package/dist/classify-severity.js +16 -35
  137. package/dist/classify-severity.js.map +1 -1
  138. package/dist/cli-help.d.ts +3 -0
  139. package/dist/cli-help.d.ts.map +1 -0
  140. package/dist/cli-help.js +285 -0
  141. package/dist/cli-help.js.map +1 -0
  142. package/dist/cli-signals.d.ts +8 -0
  143. package/dist/cli-signals.d.ts.map +1 -0
  144. package/dist/cli-signals.js +28 -0
  145. package/dist/cli-signals.js.map +1 -0
  146. package/dist/cli.d.ts +22 -24
  147. package/dist/cli.d.ts.map +1 -1
  148. package/dist/cli.js +1660 -1556
  149. package/dist/cli.js.map +1 -1
  150. package/dist/cloud-publish.d.ts.map +1 -1
  151. package/dist/cloud-publish.js +11 -17
  152. package/dist/cloud-publish.js.map +1 -1
  153. package/dist/codeowners.d.ts +19 -0
  154. package/dist/codeowners.d.ts.map +1 -0
  155. package/dist/codeowners.js +138 -0
  156. package/dist/codeowners.js.map +1 -0
  157. package/dist/codex-prompt.d.ts.map +1 -1
  158. package/dist/codex-prompt.js +1 -2
  159. package/dist/codex-prompt.js.map +1 -1
  160. package/dist/codex-sdk-environment.d.ts +3 -0
  161. package/dist/codex-sdk-environment.d.ts.map +1 -0
  162. package/dist/codex-sdk-environment.js +68 -0
  163. package/dist/codex-sdk-environment.js.map +1 -0
  164. package/dist/component-plan.d.ts +2 -5
  165. package/dist/component-plan.d.ts.map +1 -1
  166. package/dist/component-plan.js +38 -34
  167. package/dist/component-plan.js.map +1 -1
  168. package/dist/component-scan.d.ts +7 -5
  169. package/dist/component-scan.d.ts.map +1 -1
  170. package/dist/component-scan.js +54 -44
  171. package/dist/component-scan.js.map +1 -1
  172. package/dist/config.d.ts.map +1 -1
  173. package/dist/config.js +93 -104
  174. package/dist/config.js.map +1 -1
  175. package/dist/contract.d.ts +15 -2
  176. package/dist/contract.d.ts.map +1 -1
  177. package/dist/contract.js +124 -348
  178. package/dist/contract.js.map +1 -1
  179. package/dist/cost-model.d.ts +13 -6
  180. package/dist/cost-model.d.ts.map +1 -1
  181. package/dist/cost-model.js +75 -34
  182. package/dist/cost-model.js.map +1 -1
  183. package/dist/cost.d.ts +10 -2
  184. package/dist/cost.d.ts.map +1 -1
  185. package/dist/cost.js +116 -134
  186. package/dist/cost.js.map +1 -1
  187. package/dist/custom-validation-prompt.d.ts.map +1 -1
  188. package/dist/custom-validation-prompt.js +7 -6
  189. package/dist/custom-validation-prompt.js.map +1 -1
  190. package/dist/custom-validation.d.ts +1 -2
  191. package/dist/custom-validation.d.ts.map +1 -1
  192. package/dist/custom-validation.js +23 -16
  193. package/dist/custom-validation.js.map +1 -1
  194. package/dist/deduplication/checkpointed-review.d.ts +4 -2
  195. package/dist/deduplication/checkpointed-review.d.ts.map +1 -1
  196. package/dist/deduplication/checkpointed-review.js +33 -20
  197. package/dist/deduplication/checkpointed-review.js.map +1 -1
  198. package/dist/deduplication/codex-review.d.ts +9 -1
  199. package/dist/deduplication/codex-review.d.ts.map +1 -1
  200. package/dist/deduplication/codex-review.js +129 -20
  201. package/dist/deduplication/codex-review.js.map +1 -1
  202. package/dist/deduplication/deduplication-prompts.d.ts +5 -2
  203. package/dist/deduplication/deduplication-prompts.d.ts.map +1 -1
  204. package/dist/deduplication/deduplication-prompts.js +18 -4
  205. package/dist/deduplication/deduplication-prompts.js.map +1 -1
  206. package/dist/deduplication/deduplication-reviewer.d.ts +26 -4
  207. package/dist/deduplication/deduplication-reviewer.d.ts.map +1 -1
  208. package/dist/deduplication/deduplication-reviewer.js +59 -47
  209. package/dist/deduplication/deduplication-reviewer.js.map +1 -1
  210. package/dist/deduplication/deduplication.d.ts.map +1 -1
  211. package/dist/deduplication/deduplication.js +59 -113
  212. package/dist/deduplication/deduplication.js.map +1 -1
  213. package/dist/deduplication/diagnostics.d.ts +17 -0
  214. package/dist/deduplication/diagnostics.d.ts.map +1 -0
  215. package/dist/deduplication/diagnostics.js +5 -0
  216. package/dist/deduplication/diagnostics.js.map +1 -0
  217. package/dist/deduplication/finding-schema.d.ts.map +1 -1
  218. package/dist/deduplication/finding-schema.js +7 -1
  219. package/dist/deduplication/finding-schema.js.map +1 -1
  220. package/dist/deduplication/local.d.ts +31 -0
  221. package/dist/deduplication/local.d.ts.map +1 -0
  222. package/dist/deduplication/local.js +166 -0
  223. package/dist/deduplication/local.js.map +1 -0
  224. package/dist/deduplication/records-protocol.d.ts.map +1 -1
  225. package/dist/deduplication/records-protocol.js +12 -28
  226. package/dist/deduplication/records-protocol.js.map +1 -1
  227. package/dist/deduplication/records.d.ts +188 -12
  228. package/dist/deduplication/records.d.ts.map +1 -1
  229. package/dist/deduplication/records.js +34 -24
  230. package/dist/deduplication/records.js.map +1 -1
  231. package/dist/deduplication/review.d.ts +7 -0
  232. package/dist/deduplication/review.d.ts.map +1 -1
  233. package/dist/deduplication/review.js.map +1 -1
  234. package/dist/deduplication/scan.d.ts +9 -3
  235. package/dist/deduplication/scan.d.ts.map +1 -1
  236. package/dist/deduplication/scan.js +159 -44
  237. package/dist/deduplication/scan.js.map +1 -1
  238. package/dist/deep-config.d.ts +2 -1
  239. package/dist/deep-config.d.ts.map +1 -1
  240. package/dist/deep-config.js +7 -23
  241. package/dist/deep-config.js.map +1 -1
  242. package/dist/deep-progress.d.ts +2 -1
  243. package/dist/deep-progress.d.ts.map +1 -1
  244. package/dist/deep-progress.js +32 -47
  245. package/dist/deep-progress.js.map +1 -1
  246. package/dist/deep-scan.d.ts +20 -0
  247. package/dist/deep-scan.d.ts.map +1 -0
  248. package/dist/deep-scan.js +113 -0
  249. package/dist/deep-scan.js.map +1 -0
  250. package/dist/errors.d.ts +5 -2
  251. package/dist/errors.d.ts.map +1 -1
  252. package/dist/errors.js +7 -7
  253. package/dist/errors.js.map +1 -1
  254. package/dist/feedback.d.ts.map +1 -1
  255. package/dist/feedback.js +53 -21
  256. package/dist/feedback.js.map +1 -1
  257. package/dist/finding-catalogue.d.ts.map +1 -1
  258. package/dist/finding-catalogue.js +26 -30
  259. package/dist/finding-catalogue.js.map +1 -1
  260. package/dist/finding-normalization.d.ts +5 -0
  261. package/dist/finding-normalization.d.ts.map +1 -0
  262. package/dist/finding-normalization.js +120 -0
  263. package/dist/finding-normalization.js.map +1 -0
  264. package/dist/finding-retrieval.d.ts +9 -0
  265. package/dist/finding-retrieval.d.ts.map +1 -1
  266. package/dist/finding-retrieval.js.map +1 -1
  267. package/dist/finding-workflow.d.ts +13 -8
  268. package/dist/finding-workflow.d.ts.map +1 -1
  269. package/dist/finding-workflow.js +18 -13
  270. package/dist/finding-workflow.js.map +1 -1
  271. package/dist/findings-client.d.ts +2 -1
  272. package/dist/findings-client.d.ts.map +1 -1
  273. package/dist/findings-client.js +36 -9
  274. package/dist/findings-client.js.map +1 -1
  275. package/dist/findings-errors.d.ts +16 -0
  276. package/dist/findings-errors.d.ts.map +1 -0
  277. package/dist/findings-errors.js +24 -0
  278. package/dist/findings-errors.js.map +1 -0
  279. package/dist/findings-import.d.ts +1 -1
  280. package/dist/findings-import.d.ts.map +1 -1
  281. package/dist/findings-import.js +16 -44
  282. package/dist/findings-import.js.map +1 -1
  283. package/dist/github.d.ts.map +1 -1
  284. package/dist/github.js +9 -4
  285. package/dist/github.js.map +1 -1
  286. package/dist/import-scan.d.ts.map +1 -1
  287. package/dist/import-scan.js +49 -39
  288. package/dist/import-scan.js.map +1 -1
  289. package/dist/index.d.ts +11 -5
  290. package/dist/index.d.ts.map +1 -1
  291. package/dist/index.js +2 -1
  292. package/dist/index.js.map +1 -1
  293. package/dist/knowledge-base.d.ts +7 -1
  294. package/dist/knowledge-base.d.ts.map +1 -1
  295. package/dist/knowledge-base.js +115 -47
  296. package/dist/knowledge-base.js.map +1 -1
  297. package/dist/linear.d.ts.map +1 -1
  298. package/dist/linear.js +4 -10
  299. package/dist/linear.js.map +1 -1
  300. package/dist/mock-scan.d.ts.map +1 -1
  301. package/dist/mock-scan.js +0 -1
  302. package/dist/mock-scan.js.map +1 -1
  303. package/dist/models.d.ts +24 -2
  304. package/dist/models.d.ts.map +1 -1
  305. package/dist/models.js.map +1 -1
  306. package/dist/multiscan.d.ts +9 -3
  307. package/dist/multiscan.d.ts.map +1 -1
  308. package/dist/multiscan.js +225 -153
  309. package/dist/multiscan.js.map +1 -1
  310. package/dist/owner-evidence.d.ts +10 -2
  311. package/dist/owner-evidence.d.ts.map +1 -1
  312. package/dist/owner-evidence.js +69 -14
  313. package/dist/owner-evidence.js.map +1 -1
  314. package/dist/patch-tui.d.ts.map +1 -1
  315. package/dist/patch-tui.js +5 -6
  316. package/dist/patch-tui.js.map +1 -1
  317. package/dist/project-config-schema.d.ts +10 -0
  318. package/dist/project-config-schema.d.ts.map +1 -1
  319. package/dist/project-config-schema.js +1 -0
  320. package/dist/project-config-schema.js.map +1 -1
  321. package/dist/project-config.d.ts +1 -0
  322. package/dist/project-config.d.ts.map +1 -1
  323. package/dist/project-config.js +5 -3
  324. package/dist/project-config.js.map +1 -1
  325. package/dist/prompt-files.d.ts +0 -1
  326. package/dist/prompt-files.d.ts.map +1 -1
  327. package/dist/prompt-files.js +2 -4
  328. package/dist/prompt-files.js.map +1 -1
  329. package/dist/provider-profile.d.ts +21 -0
  330. package/dist/provider-profile.d.ts.map +1 -0
  331. package/dist/provider-profile.js +133 -0
  332. package/dist/provider-profile.js.map +1 -0
  333. package/dist/publication-events.d.ts +6 -8
  334. package/dist/publication-events.d.ts.map +1 -1
  335. package/dist/publication-events.js +40 -79
  336. package/dist/publication-events.js.map +1 -1
  337. package/dist/publication-store.d.ts.map +1 -1
  338. package/dist/publication-store.js +48 -76
  339. package/dist/publication-store.js.map +1 -1
  340. package/dist/publication.d.ts +1 -2
  341. package/dist/publication.d.ts.map +1 -1
  342. package/dist/publication.js +7 -16
  343. package/dist/publication.js.map +1 -1
  344. package/dist/publish.d.ts +1 -5
  345. package/dist/publish.d.ts.map +1 -1
  346. package/dist/publish.js +138 -199
  347. package/dist/publish.js.map +1 -1
  348. package/dist/record.d.ts +2 -0
  349. package/dist/record.d.ts.map +1 -0
  350. package/dist/record.js +4 -0
  351. package/dist/record.js.map +1 -0
  352. package/dist/request-metadata.d.ts +9 -0
  353. package/dist/request-metadata.d.ts.map +1 -0
  354. package/dist/request-metadata.js +13 -0
  355. package/dist/request-metadata.js.map +1 -0
  356. package/dist/result.d.ts +4 -1
  357. package/dist/result.d.ts.map +1 -1
  358. package/dist/result.js +7 -0
  359. package/dist/result.js.map +1 -1
  360. package/dist/runtime.d.ts +25 -17
  361. package/dist/runtime.d.ts.map +1 -1
  362. package/dist/runtime.js +619 -255
  363. package/dist/runtime.js.map +1 -1
  364. package/dist/saved-scan-bootstrap.d.ts +14 -0
  365. package/dist/saved-scan-bootstrap.d.ts.map +1 -0
  366. package/dist/saved-scan-bootstrap.js +261 -0
  367. package/dist/saved-scan-bootstrap.js.map +1 -0
  368. package/dist/saved-scan.d.ts +1 -1
  369. package/dist/saved-scan.d.ts.map +1 -1
  370. package/dist/saved-scan.js +16 -32
  371. package/dist/saved-scan.js.map +1 -1
  372. package/dist/scan-activity.d.ts.map +1 -1
  373. package/dist/scan-activity.js +19 -30
  374. package/dist/scan-activity.js.map +1 -1
  375. package/dist/scan-comparison.d.ts +31 -18
  376. package/dist/scan-comparison.d.ts.map +1 -1
  377. package/dist/scan-comparison.js +307 -347
  378. package/dist/scan-comparison.js.map +1 -1
  379. package/dist/scan-dashboard.d.ts +3 -1
  380. package/dist/scan-dashboard.d.ts.map +1 -1
  381. package/dist/scan-dashboard.js +351 -92
  382. package/dist/scan-dashboard.js.map +1 -1
  383. package/dist/scan-history-renderer.d.ts.map +1 -1
  384. package/dist/scan-history-renderer.js +55 -15
  385. package/dist/scan-history-renderer.js.map +1 -1
  386. package/dist/scan-inputs.d.ts +6 -0
  387. package/dist/scan-inputs.d.ts.map +1 -0
  388. package/dist/scan-inputs.js +71 -0
  389. package/dist/scan-inputs.js.map +1 -0
  390. package/dist/scan-logs.d.ts +2 -3
  391. package/dist/scan-logs.d.ts.map +1 -1
  392. package/dist/scan-logs.js +14 -12
  393. package/dist/scan-logs.js.map +1 -1
  394. package/dist/scan-sessions.d.ts +4 -0
  395. package/dist/scan-sessions.d.ts.map +1 -1
  396. package/dist/scan-sessions.js +18 -3
  397. package/dist/scan-sessions.js.map +1 -1
  398. package/dist/scan-settings.d.ts +5 -0
  399. package/dist/scan-settings.d.ts.map +1 -1
  400. package/dist/scan-settings.js +4 -0
  401. package/dist/scan-settings.js.map +1 -1
  402. package/dist/scan-skill-paths.d.ts +8 -0
  403. package/dist/scan-skill-paths.d.ts.map +1 -0
  404. package/dist/scan-skill-paths.js +47 -0
  405. package/dist/scan-skill-paths.js.map +1 -0
  406. package/dist/security-policy-cli.d.ts.map +1 -1
  407. package/dist/security-policy-cli.js +15 -33
  408. package/dist/security-policy-cli.js.map +1 -1
  409. package/dist/security-policy.d.ts +17 -9
  410. package/dist/security-policy.d.ts.map +1 -1
  411. package/dist/security-policy.js +131 -98
  412. package/dist/security-policy.js.map +1 -1
  413. package/dist/server/api.d.ts +0 -1
  414. package/dist/server/api.d.ts.map +1 -1
  415. package/dist/server/api.js +0 -1
  416. package/dist/server/api.js.map +1 -1
  417. package/dist/server/embeddings.d.ts +3 -1
  418. package/dist/server/embeddings.d.ts.map +1 -1
  419. package/dist/server/embeddings.js +11 -3
  420. package/dist/server/embeddings.js.map +1 -1
  421. package/dist/server/errors.d.ts +5 -2
  422. package/dist/server/errors.d.ts.map +1 -1
  423. package/dist/server/errors.js +7 -0
  424. package/dist/server/errors.js.map +1 -1
  425. package/dist/server/sqlite-store.d.ts +0 -2
  426. package/dist/server/sqlite-store.d.ts.map +1 -1
  427. package/dist/server/sqlite-store.js +55 -55
  428. package/dist/server/sqlite-store.js.map +1 -1
  429. package/dist/server/storage.d.ts +0 -2
  430. package/dist/server/storage.d.ts.map +1 -1
  431. package/dist/server/storage.js.map +1 -1
  432. package/dist/severity-store.js +20 -32
  433. package/dist/severity-store.js.map +1 -1
  434. package/dist/standalone-validation-prompt.d.ts +2 -0
  435. package/dist/standalone-validation-prompt.d.ts.map +1 -0
  436. package/dist/standalone-validation-prompt.js +10 -0
  437. package/dist/standalone-validation-prompt.js.map +1 -0
  438. package/dist/suggest-owners.d.ts +6 -5
  439. package/dist/suggest-owners.d.ts.map +1 -1
  440. package/dist/suggest-owners.js +15 -10
  441. package/dist/suggest-owners.js.map +1 -1
  442. package/dist/targets.d.ts +12 -0
  443. package/dist/targets.d.ts.map +1 -1
  444. package/dist/targets.js +124 -62
  445. package/dist/targets.js.map +1 -1
  446. package/dist/trusted-executable.d.ts +6 -1
  447. package/dist/trusted-executable.d.ts.map +1 -1
  448. package/dist/trusted-executable.js +28 -9
  449. package/dist/trusted-executable.js.map +1 -1
  450. package/dist/value.d.ts +2 -0
  451. package/dist/value.d.ts.map +1 -0
  452. package/dist/value.js +27 -0
  453. package/dist/value.js.map +1 -0
  454. package/dist/version.d.ts.map +1 -1
  455. package/dist/version.js +3 -6
  456. package/dist/version.js.map +1 -1
  457. package/dist/windows-path.d.ts.map +1 -1
  458. package/dist/windows-path.js +1 -2
  459. package/dist/windows-path.js.map +1 -1
  460. package/dist/workbench-arguments.d.ts +3 -0
  461. package/dist/workbench-arguments.d.ts.map +1 -0
  462. package/dist/workbench-arguments.js +15 -0
  463. package/dist/workbench-arguments.js.map +1 -0
  464. package/dist/worker-progress.d.ts +2 -0
  465. package/dist/worker-progress.d.ts.map +1 -1
  466. package/dist/worker-progress.js +40 -46
  467. package/dist/worker-progress.js.map +1 -1
  468. package/docs/cli.md +1778 -0
  469. package/docs/dedupe-records.md +24 -0
  470. package/docs/findings-service.md +402 -0
  471. package/package.json +23 -23
  472. package/schemas/project-config.schema.json +5 -0
  473. package/_bundled_plugin/schemas/tools/worker-threat-model.schema.json +0 -18
  474. package/_bundled_plugin/scripts/normalize_candidates.py +0 -338
  475. package/_bundled_plugin/scripts/workbench_dashboard.py +0 -159
  476. package/_bundled_plugin/scripts/workbench_findings.py +0 -221
  477. package/_bundled_plugin/scripts/workbench_severity.py +0 -119
  478. package/_bundled_plugin/skills/assess-patch-risk/scripts/validate_patch_risk_assessment.py +0 -163
  479. package/dist/server/dashboard/THIRD_PARTY_NOTICES.txt +0 -276
  480. package/dist/server/dashboard/app.css +0 -2
  481. package/dist/server/dashboard/app.js +0 -66
  482. package/dist/server/dashboard/index.html +0 -18
  483. package/dist/server/dashboard-types.d.ts +0 -48
  484. package/dist/server/dashboard-types.d.ts.map +0 -1
  485. package/dist/server/dashboard-types.js +0 -2
  486. package/dist/server/dashboard-types.js.map +0 -1
  487. package/dist/server/dashboard.d.ts +0 -6
  488. package/dist/server/dashboard.d.ts.map +0 -1
  489. package/dist/server/dashboard.js +0 -59
  490. package/dist/server/dashboard.js.map +0 -1
  491. package/dist/server/findings-service.d.ts +0 -20
  492. package/dist/server/findings-service.d.ts.map +0 -1
  493. package/dist/server/findings-service.js +0 -31
  494. package/dist/server/findings-service.js.map +0 -1
  495. package/dist/server/index.d.ts +0 -2
  496. package/dist/server/index.d.ts.map +0 -1
  497. package/dist/server/index.js +0 -6
  498. package/dist/server/index.js.map +0 -1
  499. package/dist/server/routes.d.ts +0 -6
  500. package/dist/server/routes.d.ts.map +0 -1
  501. package/dist/server/routes.js +0 -86
  502. package/dist/server/routes.js.map +0 -1
  503. package/dist/server/serve.d.ts +0 -2
  504. package/dist/server/serve.d.ts.map +0 -1
  505. package/dist/server/serve.js +0 -28
  506. package/dist/server/serve.js.map +0 -1
  507. package/dist/server/server.d.ts +0 -10
  508. package/dist/server/server.d.ts.map +0 -1
  509. package/dist/server/server.js +0 -17
  510. package/dist/server/server.js.map +0 -1
  511. package/dist/server/validation.d.ts +0 -17
  512. package/dist/server/validation.d.ts.map +0 -1
  513. package/dist/server/validation.js +0 -53
  514. package/dist/server/validation.js.map +0 -1
@@ -9,7 +9,6 @@ from pathlib import Path
9
9
  # Some plugin hosts launch Python with safe-path isolation enabled.
10
10
  sys.path.insert(0, str(Path(__file__).resolve().parent))
11
11
  import deep_scan_workbench as deep_scan
12
- import workbench_remediation as remediation
13
12
  from workbench_constants import (
14
13
  DIFF_TARGET_KINDS,
15
14
  EXPORT_FORMATS,
@@ -21,6 +20,7 @@ from workbench_constants import (
21
20
  PHASE_PROGRESS_UNITS,
22
21
  PHASES,
23
22
  REMEDIATION_UPDATE_STATES,
23
+ positive_int,
24
24
  )
25
25
 
26
26
 
@@ -34,11 +34,16 @@ def parse_args(description: str) -> argparse.Namespace:
34
34
  parser = argparse.ArgumentParser(description=description)
35
35
  subparsers = parser.add_subparsers(dest="command", required=True)
36
36
 
37
+ def add_command(name: str, *required: str) -> argparse.ArgumentParser:
38
+ command_parser = subparsers.add_parser(name)
39
+ for flag in required:
40
+ command_parser.add_argument(flag, required=True)
41
+ return command_parser
42
+
37
43
  resolve_scan_root = subparsers.add_parser("resolve-scan-root")
38
44
  resolve_scan_root.add_argument("--scan-root")
39
45
 
40
- create_workspace = subparsers.add_parser("create-workspace")
41
- create_workspace.add_argument("--workspace-id", required=True)
46
+ create_workspace = add_command("create-workspace", "--workspace-id")
42
47
  create_workspace.add_argument("--thread-id")
43
48
  create_workspace.add_argument("--target-path")
44
49
  create_workspace.add_argument("--target-title")
@@ -46,69 +51,44 @@ def parse_args(description: str) -> argparse.Namespace:
46
51
  add_user_context(create_workspace)
47
52
  create_workspace.add_argument("--scope")
48
53
  create_workspace.add_argument("--mode", choices=MODES, default="standard")
49
- create_workspace.add_argument("--diff-target-kind", choices=DIFF_TARGET_KINDS)
50
- create_workspace.add_argument("--diff-base-revision")
51
- create_workspace.add_argument("--diff-head-revision")
52
- create_workspace.add_argument("--diff-content-digest")
53
54
 
54
- get_workspace = subparsers.add_parser("get-workspace")
55
- get_workspace.add_argument("--workspace-id", required=True)
55
+ get_workspace = add_command("get-workspace", "--workspace-id")
56
56
  get_workspace.add_argument("--thread-id")
57
57
 
58
- inspect_target = subparsers.add_parser("inspect-target")
59
- inspect_target.add_argument("--target-path", required=True)
58
+ add_command("inspect-target", "--target-path")
60
59
 
61
- inspect_setup = subparsers.add_parser("inspect-setup")
62
- inspect_setup.add_argument("--target-path", required=True)
63
- inspect_setup.add_argument("--scope", required=True)
60
+ inspect_setup = add_command("inspect-setup", "--target-path", "--scope")
64
61
  inspect_setup.add_argument("--mode", choices=MODES, required=True)
65
- inspect_setup.add_argument("--diff-target-kind", choices=DIFF_TARGET_KINDS)
66
- inspect_setup.add_argument("--diff-base-revision")
67
- inspect_setup.add_argument("--diff-head-revision")
68
- inspect_setup.add_argument("--diff-content-digest")
69
-
70
- save_workspace = subparsers.add_parser("save-workspace")
71
- save_workspace.add_argument("--workspace-id", required=True)
72
- save_workspace.add_argument("--target-path", required=True)
73
- save_workspace.add_argument("--scope", required=True)
62
+
63
+ save_workspace = add_command("save-workspace", "--workspace-id", "--target-path", "--scope")
74
64
  save_workspace.add_argument("--mode", choices=MODES, required=True)
75
65
  save_workspace.add_argument("--target-summary")
76
66
  add_user_context(save_workspace)
77
- save_workspace.add_argument("--diff-target-kind", choices=DIFF_TARGET_KINDS)
78
- save_workspace.add_argument("--diff-base-revision")
79
- save_workspace.add_argument("--diff-head-revision")
80
- save_workspace.add_argument("--diff-content-digest")
81
-
82
- start_scan = subparsers.add_parser("start-scan")
83
- start_scan.add_argument("--workspace-id", required=True)
84
- start_scan.add_argument("--scan-root")
85
- start_scan.add_argument("--model")
86
- start_scan.add_argument("--reasoning-effort")
87
-
88
- start_prompt_only_scan = subparsers.add_parser("start-prompt-only-scan")
89
- start_prompt_only_scan.add_argument("--thread-id", required=True)
90
- start_prompt_only_scan.add_argument("--target-path", required=True)
91
- start_prompt_only_scan.add_argument("--scope", required=True)
67
+
68
+ start_scan = add_command("start-scan", "--workspace-id")
69
+
70
+ start_prompt_only_scan = add_command(
71
+ "start-prompt-only-scan", "--thread-id", "--target-path", "--scope"
72
+ )
92
73
  start_prompt_only_scan.add_argument("--mode", choices=("diff", "standard"), required=True)
93
74
  start_prompt_only_scan.add_argument("--target-summary")
94
75
  add_user_context(start_prompt_only_scan)
95
- start_prompt_only_scan.add_argument("--diff-target-kind", choices=DIFF_TARGET_KINDS)
96
- start_prompt_only_scan.add_argument("--diff-base-revision")
97
- start_prompt_only_scan.add_argument("--diff-head-revision")
98
- start_prompt_only_scan.add_argument("--diff-content-digest")
99
- start_prompt_only_scan.add_argument("--scan-root")
100
- start_prompt_only_scan.add_argument("--model")
101
- start_prompt_only_scan.add_argument("--reasoning-effort")
102
-
103
- start_headless_standard_scan = subparsers.add_parser("start-headless-standard-scan")
104
- start_headless_standard_scan.add_argument("--thread-id", required=True)
105
- start_headless_standard_scan.add_argument("--target-path", required=True)
106
- start_headless_standard_scan.add_argument("--scope", required=True)
76
+ # Place shared options after each command's preceding arguments to preserve help order.
77
+ for diff_parser in (create_workspace, inspect_setup, save_workspace, start_prompt_only_scan):
78
+ diff_parser.add_argument("--diff-target-kind", choices=DIFF_TARGET_KINDS)
79
+ diff_parser.add_argument("--diff-base-revision")
80
+ diff_parser.add_argument("--diff-head-revision")
81
+ diff_parser.add_argument("--diff-content-digest")
82
+
83
+ start_headless_standard_scan = add_command(
84
+ "start-headless-standard-scan", "--thread-id", "--target-path", "--scope"
85
+ )
107
86
  start_headless_standard_scan.add_argument("--target-summary")
108
87
  add_user_context(start_headless_standard_scan)
109
- start_headless_standard_scan.add_argument("--scan-root")
110
- start_headless_standard_scan.add_argument("--model")
111
- start_headless_standard_scan.add_argument("--reasoning-effort")
88
+ for scan_parser in (start_scan, start_prompt_only_scan, start_headless_standard_scan):
89
+ scan_parser.add_argument("--scan-root")
90
+ scan_parser.add_argument("--model")
91
+ scan_parser.add_argument("--reasoning-effort")
112
92
  start_headless_standard_scan.set_defaults(
113
93
  mode="standard",
114
94
  diff_target_kind=None,
@@ -119,15 +99,14 @@ def parse_args(description: str) -> argparse.Namespace:
119
99
 
120
100
  deep_scan.register_subcommands(subparsers, positive_int)
121
101
 
122
- get_scan = subparsers.add_parser("get-scan")
123
- get_scan.add_argument("--scan-id", required=True)
102
+ get_scan = add_command("get-scan", "--scan-id")
124
103
  get_scan.add_argument("--occurrence-id")
125
104
 
126
- get_scan_feedback = subparsers.add_parser("get-scan-feedback")
127
- get_scan_feedback.add_argument("--scan-id", required=True)
105
+ add_command("rename-scan", "--scan-id", "--name")
128
106
 
129
- update_scan_context = subparsers.add_parser("update-scan-context")
130
- update_scan_context.add_argument("--scan-id", required=True)
107
+ add_command("get-scan-feedback", "--scan-id")
108
+
109
+ update_scan_context = add_command("update-scan-context", "--scan-id")
131
110
  add_user_context(update_scan_context, required=True)
132
111
  update_scan_context_owner = update_scan_context.add_mutually_exclusive_group(required=True)
133
112
  update_scan_context_owner.add_argument("--workspace-id")
@@ -141,42 +120,36 @@ def parse_args(description: str) -> argparse.Namespace:
141
120
  list_scans.add_argument("--mode", choices=MODES)
142
121
  list_scans.add_argument("--repository")
143
122
  list_scans.add_argument("--scan-root")
144
- list_scans.add_argument("--offset", type=non_negative_int, default=0)
123
+ list_scans.add_argument("--offset", type=deep_scan.non_negative_int, default=0)
145
124
  list_scans.add_argument("--limit", type=positive_int)
146
125
 
147
- list_unmatched_scan_pairs = subparsers.add_parser("list-unmatched-scan-pairs")
148
- list_unmatched_scan_pairs.add_argument("--repository", required=True)
126
+ list_unmatched_scan_pairs = add_command("list-unmatched-scan-pairs", "--repository")
149
127
  list_unmatched_scan_pairs.add_argument("--force", action="store_true")
150
128
 
151
- register_cli_scan = subparsers.add_parser("register-cli-scan")
152
- register_cli_scan.add_argument("--scan-dir", required=True)
153
- register_cli_scan.add_argument("--repository", required=True)
129
+ register_cli_scan = add_command("register-cli-scan", "--scan-dir", "--repository")
154
130
  recipe = register_cli_scan.add_mutually_exclusive_group(required=True)
155
131
  recipe.add_argument("--recipe-json")
156
132
  recipe.add_argument("--recipe-json-stdin", action="store_true")
157
133
  recipe.add_argument("--registration-json-stdin", action="store_true")
158
134
  register_cli_scan.add_argument("--parent-scan-id")
159
- register_cli_scan.add_argument("--archive-existing", action="store_true")
135
+ register_cli_scan.add_argument(
136
+ "--archive-existing",
137
+ action="store_true",
138
+ help="Archive output in the registration transaction. Supports cancellable archival preparation.",
139
+ )
160
140
  register_cli_scan.add_argument("--archived-scan-dir")
161
141
 
162
- set_scan_thread = subparsers.add_parser("set-scan-thread")
163
- set_scan_thread.add_argument("--scan-id", required=True)
164
- set_scan_thread.add_argument("--thread-id", required=True)
142
+ add_command("set-scan-thread", "--scan-id", "--thread-id")
165
143
 
166
- set_scan_cost_limit = subparsers.add_parser("set-scan-cost-limit")
167
- set_scan_cost_limit.add_argument("--scan-id", required=True)
144
+ set_scan_cost_limit = add_command("set-scan-cost-limit", "--scan-id")
168
145
  set_scan_cost_limit.add_argument("--max-cost-usd", required=True, type=float)
169
146
 
170
- get_scan_recipe = subparsers.add_parser("get-scan-recipe")
171
- get_scan_recipe.add_argument("--scan-id", required=True)
147
+ add_command("get-scan-recipe", "--scan-id")
172
148
 
173
- get_cli_scan_resume = subparsers.add_parser("get-cli-scan-resume")
174
- get_cli_scan_resume.add_argument("--scan-id", required=True)
149
+ get_cli_scan_resume = add_command("get-cli-scan-resume", "--scan-id")
175
150
  get_cli_scan_resume.add_argument("--allow-unavailable", action="store_true")
176
151
 
177
- compare_scans = subparsers.add_parser("compare-scans")
178
- compare_scans.add_argument("--before-scan-id", required=True)
179
- compare_scans.add_argument("--after-scan-id", required=True)
152
+ compare_scans = add_command("compare-scans", "--before-scan-id", "--after-scan-id")
180
153
  compare_scans.add_argument("--include-matching-inputs", action="store_true")
181
154
  compare_scans.add_argument("--require-matches", action="store_true")
182
155
 
@@ -195,68 +168,60 @@ def parse_args(description: str) -> argparse.Namespace:
195
168
  list_global_findings.add_argument("--severity", choices=FINDING_SEVERITIES)
196
169
  list_global_findings.add_argument("--status", choices=FINDING_STATUSES)
197
170
  list_global_findings.add_argument("--target-id")
198
- list_global_findings.add_argument("--offset", type=non_negative_int, default=0)
171
+ list_global_findings.add_argument("--offset", type=deep_scan.non_negative_int, default=0)
199
172
  list_global_findings.add_argument("--limit", type=positive_int, default=FINDINGS_PAGE_MAX)
200
173
  list_repositories = subparsers.add_parser("list-repositories")
201
174
  list_repositories.add_argument("--query")
202
175
  list_repositories.add_argument("--target-id")
203
176
  list_repositories.add_argument("--status", choices=("scanned", "not_scanned", "open_findings"))
204
- list_repositories.add_argument("--offset", type=non_negative_int, default=0)
177
+ list_repositories.add_argument("--offset", type=deep_scan.non_negative_int, default=0)
205
178
  list_repositories.add_argument("--limit", type=positive_int)
206
179
 
207
- list_findings = subparsers.add_parser("list-findings")
208
- list_findings.add_argument("--scan-id", required=True)
180
+ list_findings = add_command("list-findings", "--scan-id")
209
181
  list_findings.add_argument("--query")
210
182
  list_findings.add_argument("--severity", choices=FINDING_SEVERITIES)
211
183
  list_findings.add_argument("--status", choices=FINDING_STATUSES)
212
- list_findings.add_argument("--offset", type=non_negative_int, default=0)
184
+ list_findings.add_argument("--offset", type=deep_scan.non_negative_int, default=0)
213
185
  list_findings.add_argument("--limit", type=positive_int, default=FINDINGS_PAGE_MAX)
214
186
 
215
- update_progress = subparsers.add_parser("update-progress")
216
- update_progress.add_argument("--scan-id", required=True)
187
+ update_progress = add_command("update-progress", "--scan-id")
217
188
  update_progress.add_argument("--phase", choices=PHASES)
218
- update_progress.add_argument("--phase-items-total", type=non_negative_int)
219
- update_progress.add_argument("--phase-items-completed", type=non_negative_int)
189
+ update_progress.add_argument("--phase-items-total", type=deep_scan.non_negative_int)
190
+ update_progress.add_argument("--phase-items-completed", type=deep_scan.non_negative_int)
220
191
  update_progress.add_argument("--phase-progress-unit", choices=PHASE_PROGRESS_UNITS)
221
192
  preflight_issues = update_progress.add_mutually_exclusive_group()
222
193
  preflight_issues.add_argument("--preflight-issues-json")
223
194
  preflight_issues.add_argument("--preflight-issues-json-stdin", action="store_true")
224
- update_progress.add_argument("--review-items-total", type=non_negative_int)
225
- update_progress.add_argument("--review-items-completed", type=non_negative_int)
226
- update_progress.add_argument("--reportable-findings-count", type=non_negative_int)
195
+ update_progress.add_argument("--review-items-total", type=deep_scan.non_negative_int)
196
+ update_progress.add_argument("--review-items-completed", type=deep_scan.non_negative_int)
197
+ update_progress.add_argument("--reportable-findings-count", type=deep_scan.non_negative_int)
227
198
  update_progress.add_argument("--deep-review-pass", type=positive_int)
228
199
  update_progress.add_argument("--claim-token")
229
200
  update_progress.add_argument("--coordinator-generation", type=positive_int)
230
201
  update_progress.add_argument("--model")
231
202
  update_progress.add_argument("--reasoning-effort")
232
203
 
233
- prepare_scan_completion = subparsers.add_parser("prepare-scan-completion")
234
- prepare_scan_completion.add_argument("--scan-id", required=True)
204
+ prepare_scan_completion = add_command("prepare-scan-completion", "--scan-id")
235
205
  prepare_scan_completion.add_argument("--claim-token")
236
206
 
237
- complete_scan = subparsers.add_parser("complete-scan")
238
- complete_scan.add_argument("--scan-id", required=True)
207
+ complete_scan = add_command("complete-scan", "--scan-id")
239
208
  complete_scan.add_argument("--claim-token")
240
209
  complete_scan.add_argument("--cost-json")
241
210
  complete_scan.add_argument("--thread-id")
242
211
 
243
- complete_budget_exhausted_scan = subparsers.add_parser("complete-budget-exhausted-scan")
244
- complete_budget_exhausted_scan.add_argument("--scan-id", required=True)
245
- complete_budget_exhausted_scan.add_argument("--cost-json", required=True)
212
+ complete_budget_exhausted_scan = add_command(
213
+ "complete-budget-exhausted-scan", "--scan-id", "--cost-json"
214
+ )
246
215
  complete_budget_exhausted_scan.add_argument("--message")
247
216
 
248
- cancel_scan = subparsers.add_parser("cancel-scan")
249
- cancel_scan.add_argument("--scan-id", required=True)
217
+ cancel_scan = add_command("cancel-scan", "--scan-id")
250
218
  cancel_scan.add_argument("--thread-id")
251
219
 
252
- fail_scan = subparsers.add_parser("fail-scan")
253
- fail_scan.add_argument("--scan-id", required=True)
254
- fail_scan.add_argument("--message", required=True)
220
+ fail_scan = add_command("fail-scan", "--scan-id", "--message")
255
221
  fail_scan.add_argument("--claim-token")
256
222
  fail_scan.add_argument("--cost-json")
257
223
 
258
- preserve_scan = subparsers.add_parser("preserve-scan-results")
259
- preserve_scan.add_argument("--scan-id", required=True)
224
+ preserve_scan = add_command("preserve-scan-results", "--scan-id")
260
225
  preserve_scan.add_argument("--thread-id")
261
226
  preserve_scan.add_argument("--claim-token")
262
227
  preserve_scan.add_argument("--coordinator-generation", type=positive_int)
@@ -267,56 +232,37 @@ def parse_args(description: str) -> argparse.Namespace:
267
232
  )
268
233
  recover_scan.add_argument("--scan-id", required=True, help="ID of the stopped scan to recover.")
269
234
 
270
- write_scan_draft = subparsers.add_parser("write-scan-draft")
271
- write_scan_draft.add_argument("--scan-id", required=True)
272
- write_scan_draft.add_argument("--draft-path", required=True)
235
+ write_scan_draft = add_command("write-scan-draft", "--scan-id", "--draft-path")
273
236
  write_scan_draft.add_argument("--checkpoint-path")
274
237
  write_scan_draft.add_argument("--expected-draft-digest")
275
238
  write_scan_draft.add_argument("--claim-token")
276
239
 
277
- save_scan_artifact = subparsers.add_parser("save-scan-artifact")
278
- save_scan_artifact.add_argument("--scan-id", required=True)
279
- save_scan_artifact.add_argument("--artifact-path", required=True)
240
+ save_scan_artifact = add_command("save-scan-artifact", "--scan-id", "--artifact-path")
280
241
  save_scan_artifact.add_argument("--claim-token")
281
242
 
282
243
  for command in ("save-artifact", "read-artifact"):
283
- artifact = subparsers.add_parser(command)
284
- artifact.add_argument("--artifact-root", required=True)
285
- artifact.add_argument("--artifact-path", required=True)
244
+ add_command(command, "--artifact-root", "--artifact-path")
286
245
 
287
- mark_handoff_delivered = subparsers.add_parser("mark-handoff-delivered")
288
- mark_handoff_delivered.add_argument("--scan-id", required=True)
289
- mark_handoff_delivered.add_argument("--claim-token", required=True)
246
+ mark_handoff_delivered = add_command("mark-handoff-delivered", "--scan-id", "--claim-token")
290
247
  mark_handoff_delivered.add_argument("--thread-id")
291
248
 
292
- claim_handoff_delivery = subparsers.add_parser("claim-handoff-delivery")
293
- claim_handoff_delivery.add_argument("--scan-id", required=True)
294
- claim_handoff_delivery.add_argument("--claim-token", required=True)
249
+ claim_handoff_delivery = add_command("claim-handoff-delivery", "--scan-id", "--claim-token")
295
250
  claim_handoff_delivery.add_argument("--take-over-stale", action="store_true")
296
251
 
297
- release_handoff_delivery = subparsers.add_parser("release-handoff-delivery")
298
- release_handoff_delivery.add_argument("--scan-id", required=True)
299
- release_handoff_delivery.add_argument("--claim-token", required=True)
252
+ add_command("release-handoff-delivery", "--scan-id", "--claim-token")
300
253
 
301
- attach_scan_continuation_thread = subparsers.add_parser("attach-scan-continuation-thread")
302
- attach_scan_continuation_thread.add_argument("--scan-id", required=True)
303
- attach_scan_continuation_thread.add_argument("--claim-token", required=True)
304
- attach_scan_continuation_thread.add_argument("--thread-id", required=True)
254
+ add_command("attach-scan-continuation-thread", "--scan-id", "--claim-token", "--thread-id")
305
255
 
306
- set_finding_triage = subparsers.add_parser("set-finding-triage")
307
- set_finding_triage.add_argument("--occurrence-id", required=True)
256
+ set_finding_triage = add_command("set-finding-triage", "--occurrence-id")
308
257
  set_finding_triage.add_argument("--status", choices=FINDING_STATUSES, required=True)
309
258
  set_finding_triage.add_argument("--close-reason", choices=FINDING_CLOSE_REASONS)
310
259
  set_finding_triage.add_argument("--note")
311
260
 
312
- request_finding_remediation = subparsers.add_parser("request-finding-remediation")
313
- request_finding_remediation.add_argument("--occurrence-id", required=True)
314
- request_finding_remediation.add_argument("--request-id", required=True)
315
- request_finding_remediation.add_argument("--action-token", required=True)
261
+ add_command("request-finding-remediation", "--occurrence-id", "--request-id", "--action-token")
316
262
 
317
- request_finding_remediation_action = subparsers.add_parser("request-finding-remediation-action")
318
- request_finding_remediation_action.add_argument("--occurrence-id", required=True)
319
- request_finding_remediation_action.add_argument("--request-id", required=True)
263
+ request_finding_remediation_action = add_command(
264
+ "request-finding-remediation-action", "--occurrence-id", "--request-id"
265
+ )
320
266
  request_finding_remediation_action.add_argument(
321
267
  "--expected-version", type=positive_int, required=True
322
268
  )
@@ -325,27 +271,17 @@ def parse_args(description: str) -> argparse.Namespace:
325
271
  )
326
272
  request_finding_remediation_action.add_argument("--action-token", required=True)
327
273
 
328
- claim_finding_remediation_resend = subparsers.add_parser("claim-finding-remediation-resend")
329
- claim_finding_remediation_resend.add_argument("--occurrence-id", required=True)
330
- claim_finding_remediation_resend.add_argument("--request-id", required=True)
331
- claim_finding_remediation_resend.add_argument("--action-token", required=True)
332
-
333
- mark_finding_remediation_delivered = subparsers.add_parser("mark-finding-remediation-delivered")
334
- mark_finding_remediation_delivered.add_argument("--occurrence-id", required=True)
335
- mark_finding_remediation_delivered.add_argument("--request-id", required=True)
336
- mark_finding_remediation_delivered.add_argument("--action-token", required=True)
337
-
338
- release_finding_remediation_claim = subparsers.add_parser("release-finding-remediation-claim")
339
- release_finding_remediation_claim.add_argument("--occurrence-id", required=True)
340
- release_finding_remediation_claim.add_argument("--request-id", required=True)
341
- release_finding_remediation_claim.add_argument("--action-token", required=True)
342
-
343
- remediation.register_cancel_finding_remediation_request(subparsers)
274
+ for command in (
275
+ "claim-finding-remediation-resend",
276
+ "mark-finding-remediation-delivered",
277
+ "release-finding-remediation-claim",
278
+ "cancel-finding-remediation-request",
279
+ ):
280
+ add_command(command, "--occurrence-id", "--request-id", "--action-token")
344
281
 
345
- set_finding_remediation = subparsers.add_parser("set-finding-remediation")
346
- set_finding_remediation.add_argument("--occurrence-id", required=True)
347
- set_finding_remediation.add_argument("--request-id", required=True)
348
- set_finding_remediation.add_argument("--action-token", required=True)
282
+ set_finding_remediation = add_command(
283
+ "set-finding-remediation", "--occurrence-id", "--request-id", "--action-token"
284
+ )
349
285
  set_finding_remediation.add_argument("--expected-version", type=positive_int, required=True)
350
286
  set_finding_remediation.add_argument(
351
287
  "--state", choices=REMEDIATION_UPDATE_STATES, required=True
@@ -356,36 +292,23 @@ def parse_args(description: str) -> argparse.Namespace:
356
292
  set_finding_remediation.add_argument("--base-revision")
357
293
  set_finding_remediation.add_argument("--verification-summary")
358
294
 
359
- export_findings = subparsers.add_parser("export-findings")
360
- export_findings.add_argument("--scan-id", required=True)
361
- export_findings.add_argument("--format", choices=EXPORT_FORMATS, required=True)
295
+ export_findings = add_command("export-findings", "--scan-id")
296
+ export_findings.add_argument(
297
+ "--artifact", choices=("findings", "threat-model"), default="findings"
298
+ )
299
+ export_findings.add_argument("--format", choices=(*EXPORT_FORMATS, "md"))
300
+ export_findings.add_argument("--validate-only", action="store_true")
362
301
 
363
302
  for command in (
364
303
  "inspect-linear-publication",
365
304
  "prepare-linear-publication",
366
305
  "record-linear-publications",
367
306
  ):
368
- publication = subparsers.add_parser(command)
369
- publication.add_argument("--input-file", required=True)
307
+ add_command(command, "--input-file")
370
308
 
371
309
  subparsers.add_parser("database-info")
372
- subparsers.add_parser("dashboard")
373
310
  subparsers.add_parser("finding-workflow")
374
- subparsers.add_parser("severity-classification")
375
- severity = subparsers.add_parser("read-severity-classification")
376
- severity.add_argument("--scan-id", required=True)
377
- subparsers.add_parser("store-findings")
378
- subparsers.add_parser("store-dedupe-groups")
379
- dedupe_groups = subparsers.add_parser("list-dedupe-groups")
380
- dedupe_groups.add_argument("--finding-id", required=True)
381
- potential_duplicates = subparsers.add_parser("find-potential-duplicates")
382
- potential_duplicates.add_argument("--finding-id", required=True)
383
- scope = potential_duplicates.add_mutually_exclusive_group(required=True)
384
- scope.add_argument("--repository-id")
385
- scope.add_argument("--all-repositories", action="store_true")
386
- stored_findings = subparsers.add_parser("list-stored-findings")
387
- stored_findings.add_argument("--limit", type=positive_int, required=True)
388
- stored_findings.add_argument("--offset", type=non_negative_int, required=True)
311
+ subparsers.add_parser("local-dedupe")
389
312
  arguments = sys.argv[1:]
390
313
  if "--user-context-stdin" in arguments:
391
314
  if arguments.count("--user-context-stdin") != 1 or "--user-context" in arguments:
@@ -395,19 +318,5 @@ def parse_args(description: str) -> argparse.Namespace:
395
318
  return parser.parse_args(arguments)
396
319
 
397
320
 
398
- def non_negative_int(value: str) -> int:
399
- parsed = int(value)
400
- if parsed < 0:
401
- raise argparse.ArgumentTypeError("expected a non-negative integer")
402
- return parsed
403
-
404
-
405
- def positive_int(value: str) -> int:
406
- parsed = int(value)
407
- if parsed < 1:
408
- raise argparse.ArgumentTypeError("expected a positive integer")
409
- return parsed
410
-
411
-
412
321
  if __name__ == "__main__":
413
322
  parse_args(__doc__)
@@ -16,18 +16,7 @@ PHASE_PROGRESS_UNITS = (
16
16
  FINDING_SEVERITIES = ("critical", "high", "medium", "low", "informational")
17
17
  FINDING_STATUSES = ("open", "closed")
18
18
  FINDING_CLOSE_REASONS = ("already_fixed", "wont_fix", "false_positive")
19
- REMEDIATION_STATES = (
20
- "idle",
21
- "requested",
22
- "generated",
23
- "applied",
24
- "verifying",
25
- "verified",
26
- "failed",
27
- "superseded",
28
- )
29
19
  REMEDIATION_UPDATE_STATES = ("generated", "applied", "verifying", "verified", "failed")
30
- REMEDIATION_PENDING_ACTIONS = ("generate", "apply", "verify")
31
20
  EXPORT_FORMATS = ("csv", "json", "sarif")
32
21
  ARTIFACTS = {
33
22
  "coverage": "coverage.json",
@@ -70,9 +59,12 @@ GIT_REPOSITORY_ENVIRONMENT = (
70
59
  EMPTY_GIT_TREE = "4b825dc642cb6eb9a060e54bf8d69288fbee4904"
71
60
 
72
61
 
73
- def main() -> None:
74
- argparse.ArgumentParser(description=__doc__).parse_args()
62
+ def positive_int(value: str) -> int:
63
+ parsed = int(value)
64
+ if parsed < 1:
65
+ raise argparse.ArgumentTypeError("expected a positive integer")
66
+ return parsed
75
67
 
76
68
 
77
69
  if __name__ == "__main__":
78
- main()
70
+ argparse.ArgumentParser(description=__doc__).parse_args()