@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
@@ -0,0 +1,464 @@
1
+ """Collect a selected existing scan using the user's installed Checkmarx tools."""
2
+
3
+ import argparse
4
+ import json
5
+ import os
6
+ import re
7
+ import shutil
8
+ import signal
9
+ import stat
10
+ import subprocess
11
+ import sys
12
+ import tempfile
13
+ import zipfile
14
+ from contextlib import suppress
15
+ from email.parser import BytesHeaderParser
16
+ from pathlib import Path
17
+ from xml.parsers import expat
18
+
19
+
20
+ def is_link(info: os.stat_result) -> bool:
21
+ return stat.S_ISLNK(info.st_mode) or (
22
+ os.name == "nt" and info.st_reparse_tag == stat.IO_REPARSE_TAG_MOUNT_POINT
23
+ )
24
+
25
+
26
+ def source_root(target: Path | None) -> Path | None:
27
+ if target is not None and (not target.is_absolute() or not target.is_dir()):
28
+ raise ValueError("Select an existing absolute source directory.")
29
+ source = (target or Path.cwd()).resolve()
30
+ # A nested checkout or submodule is still part of the enclosing source tree.
31
+ for parent in (*reversed(source.parents), source):
32
+ marker = parent / ".git"
33
+ try:
34
+ info = marker.lstat()
35
+ if stat.S_ISDIR(info.st_mode) and not is_link(info):
36
+ info = (marker / "HEAD").lstat()
37
+ except (FileNotFoundError, NotADirectoryError):
38
+ continue
39
+ if stat.S_ISREG(info.st_mode) or is_link(info):
40
+ return parent
41
+ return source if target is not None else None
42
+
43
+
44
+ def in_source(path: Path, source: Path | None) -> bool:
45
+ if source is None:
46
+ return False
47
+ if path.is_relative_to(source):
48
+ return True
49
+ identity = source.stat()
50
+ current = Path()
51
+ parts = list(reversed(path.absolute().parts))
52
+ active_links = set()
53
+ while parts:
54
+ part = parts.pop()
55
+ if isinstance(part, Path):
56
+ # The link target's components have all been checked.
57
+ active_links.remove(part)
58
+ continue
59
+ current = current.parent if part == ".." else current / part
60
+ if current == source:
61
+ return True
62
+ try:
63
+ info = current.lstat()
64
+ except (FileNotFoundError, NotADirectoryError):
65
+ continue
66
+ if os.path.samestat(info, identity):
67
+ return True
68
+ if is_link(info):
69
+ if current in active_links:
70
+ raise OSError(f"Symbolic link loop at {current}")
71
+ active_links.add(current)
72
+ parts.append(current)
73
+ parts.extend(reversed(current.readlink().parts))
74
+ current = current.parent
75
+ return False
76
+
77
+
78
+ def installed_file(value: str, source: Path | None) -> Path:
79
+ path = Path(value)
80
+ if path.is_absolute() and in_source(path, source):
81
+ raise ValueError("use an installed file outside the source checkout")
82
+ if not path.is_absolute() or not path.is_file():
83
+ raise ValueError("expected an absolute path to an existing file")
84
+ # Invoke the selected name for native multicall binaries.
85
+ return path.parent.resolve() / path.name
86
+
87
+
88
+ def installed_launcher(value: str, source: Path | None) -> Path:
89
+ path = installed_file(value, source)
90
+ if sys.platform == "win32" and (
91
+ path.suffix.lower() not in {".exe", ".com"}
92
+ or path.resolve().suffix.lower() in {".bat", ".cmd"}
93
+ ):
94
+ raise ValueError("use a native Windows executable (.exe or .com)")
95
+ with path.open("rb") as image:
96
+ magic = image.read(4)
97
+ if sys.platform == "win32":
98
+ # The DOS header points to the PE signature.
99
+ image.seek(0x3C)
100
+ pe_offset = int.from_bytes(image.read(4), "little")
101
+ image.seek(pe_offset)
102
+ native = magic.startswith(b"MZ") and image.read(4) == b"PE\0\0"
103
+ elif sys.platform == "darwin":
104
+ # 32/64-bit thin and universal Mach-O, in either byte order.
105
+ native = any(
106
+ int.from_bytes(magic, order) in {0xFEEDFACE, 0xFEEDFACF, 0xCAFEBABE, 0xCAFEBABF}
107
+ for order in ("big", "little")
108
+ )
109
+ else:
110
+ native = magic == b"\x7fELF"
111
+ if not native:
112
+ raise ValueError("use the installed native executable for cx or java")
113
+ return path
114
+
115
+
116
+ def check_cxflow_version(jar: Path) -> None:
117
+ # Earlier CxFlow versions accept --scanId but silently retrieve the latest scan.
118
+ advice = "Use a released CxFlow 1.6.37 or later, or supply a scoped CxSAST XML export."
119
+ try:
120
+ with zipfile.ZipFile(jar) as archive:
121
+ manifest = BytesHeaderParser().parsebytes(archive.read("META-INF/MANIFEST.MF"))
122
+ metadata = archive.read("META-INF/build-info.properties").decode("utf-8")
123
+ except (KeyError, UnicodeDecodeError, zipfile.BadZipFile) as error:
124
+ raise ValueError(
125
+ f"Could not read the CxFlow release metadata: {error}. {advice}"
126
+ ) from error
127
+ properties = dict(line.split("=", 1) for line in metadata.splitlines() if "=" in line)
128
+ if (
129
+ manifest.get("Start-Class") != "com.checkmarx.flow.CxFlowApplication"
130
+ or properties.get("build.group") != "com.checkmarx"
131
+ ):
132
+ raise ValueError(f"The selected JAR does not identify itself as CxFlow. {advice}")
133
+ version = properties.get("build.version", "")
134
+ if not re.fullmatch(r"[0-9]+\.[0-9]+\.[0-9]+", version) or tuple(
135
+ map(int, version.split("."))
136
+ ) < (1, 6, 37):
137
+ raise ValueError(f"Unsupported CxFlow version {version or '(unknown)'}. {advice}")
138
+
139
+
140
+ def private_environment(work: str, inherit: tuple[str, ...]) -> dict[str, str]:
141
+ env = {name: os.environ[name] for name in inherit if name in os.environ}
142
+ return env | dict.fromkeys(("TEMP", "TMP", "TMPDIR"), work)
143
+
144
+
145
+ def cxsast_environment(work: str, use_env_credentials: bool = False) -> dict[str, str]:
146
+ # CxFlow uses the chosen profile for its server and Spring configuration.
147
+ credentials = ("CHECKMARX_USERNAME", "CHECKMARX_PASSWORD", "CHECKMARX_CLIENT_SECRET")
148
+ env = private_environment(work, credentials if use_env_credentials else ())
149
+ if os.name == "nt":
150
+ env["SystemRoot"] = os.environ["SystemRoot"]
151
+ else:
152
+ # The Java launcher decodes native arguments before applying file.encoding.
153
+ env["LC_CTYPE"] = "UTF-8" if sys.platform == "darwin" else "C.UTF-8"
154
+ return env
155
+
156
+
157
+ def one_environment(source: Path | None, work: str) -> dict[str, str]:
158
+ # An inherited endpoint or proxy must never receive credentials from a saved profile.
159
+ account = ("HOME", "USER", "LOGNAME", "USERPROFILE", "APPDATA", "LOCALAPPDATA", "SystemRoot")
160
+ env = private_environment(work, (*account, "LANG", "LC_ALL", "LC_CTYPE"))
161
+ configured = os.environ.get("CX_CONFIG_FILE_PATH")
162
+ oauth = ("CX_CLIENT_ID", "CX_CLIENT_SECRET", "CX_BASE_URI", "CX_TENANT")
163
+ api_key = os.environ.get("CX_APIKEY")
164
+ if not configured and (api_key or all(os.environ.get(k) for k in oauth)):
165
+ # A separate config path also separates the vendor's path-keyed credential store.
166
+ profile = Path(work, "env-auth.yaml")
167
+ profile.write_text("{}\n", encoding="utf-8")
168
+ env["CX_CONFIG_FILE_PATH"] = str(profile)
169
+ env["CX_KEYRING_MODE"] = "disabled"
170
+ credentials = ("CX_APIKEY",) if api_key else (*oauth, "CX_BASE_AUTH_URI")
171
+ env.update((name, os.environ[name]) for name in credentials if os.environ.get(name))
172
+ return env
173
+
174
+ profile = Path(configured) if configured else Path.home() / ".checkmarx" / "checkmarxcli.yaml"
175
+ if not profile.is_absolute() or in_source(profile, source):
176
+ raise ValueError(
177
+ "Set CX_CONFIG_FILE_PATH to a trusted absolute path outside the source checkout. "
178
+ "The collector runs Checkmarx One from a private directory."
179
+ )
180
+ env["CX_CONFIG_FILE_PATH"] = configured or str(profile)
181
+ if "CX_KEYRING_MODE" in os.environ:
182
+ env["CX_KEYRING_MODE"] = os.environ["CX_KEYRING_MODE"]
183
+ return env
184
+
185
+
186
+ def verify_one(report: Path, scan_id: str) -> None:
187
+ with report.open(encoding="utf-8-sig") as stream:
188
+ data = json.load(stream)
189
+ reported = data.get("scanID") if isinstance(data, dict) else None
190
+ if (
191
+ not isinstance(reported, str)
192
+ or not reported.isascii()
193
+ or reported.lower() != scan_id.lower()
194
+ ):
195
+ raise ValueError("The Checkmarx One report does not match the requested scan ID.")
196
+
197
+
198
+ def team_path(value: str) -> str:
199
+ path = value.replace("\\", "/").strip("/")
200
+ return "".join(char.lower() if char.isascii() else char for char in path)
201
+
202
+
203
+ def verify_cxsast(report: Path, scan_id: str, project: str, team: str) -> None:
204
+ parser = expat.ParserCreate()
205
+
206
+ def check_root(name, attributes):
207
+ if name != "CxXMLResults" or not attributes.get("ProjectId"):
208
+ raise ValueError("Expected a CxSAST XML scan report.")
209
+ if attributes.get("ScanId") != scan_id or attributes.get("ProjectName") != project:
210
+ raise ValueError("The CxSAST report does not match the requested scan and project.")
211
+ actual_team = attributes.get("TeamFullPathOnReportDate")
212
+ if not actual_team or team_path(actual_team) != team_path(team):
213
+ raise ValueError("The CxSAST report does not match the requested team.")
214
+ parser.StartElementHandler = None
215
+
216
+ parser.StartElementHandler = check_root
217
+ with report.open("rb") as stream:
218
+ parser.ParseFile(stream)
219
+
220
+
221
+ def capture_directory(temp: Path) -> Path:
222
+ if os.name != "nt":
223
+ return Path(tempfile.mkdtemp(prefix="checkmarx-report-", dir=temp)).resolve()
224
+
225
+ import ctypes.wintypes
226
+ import secrets
227
+
228
+ class SecurityAttributes(ctypes.Structure):
229
+ _fields_ = [
230
+ ("length", ctypes.wintypes.DWORD),
231
+ ("descriptor", ctypes.wintypes.LPVOID),
232
+ ("inherit", ctypes.wintypes.BOOL),
233
+ ]
234
+
235
+ # Older Windows Python releases ignore mkdir's 0700 mode. Apply CPython's
236
+ # protected, inheritable SYSTEM/Administrators/owner DACL at creation.
237
+ kernel = ctypes.WinDLL("kernel32", use_last_error=True)
238
+ temp = temp.resolve()
239
+ volume = ctypes.create_unicode_buffer(32768)
240
+ flags = ctypes.wintypes.DWORD()
241
+ if not kernel.GetVolumePathNameW(str(temp), volume, len(volume)):
242
+ raise ctypes.WinError(ctypes.get_last_error())
243
+ if not kernel.GetVolumeInformationW(volume, None, 0, None, None, ctypes.byref(flags), None, 0):
244
+ raise ctypes.WinError(ctypes.get_last_error())
245
+ if not flags.value & 0x8: # FILE_PERSISTENT_ACLS
246
+ raise ValueError("Select a temporary directory on a Windows volume that supports ACLs.")
247
+
248
+ security = ctypes.WinDLL("advapi32", use_last_error=True)
249
+ descriptor = ctypes.wintypes.LPVOID()
250
+ dacl = "D:P(A;OICI;FA;;;SY)(A;OICI;FA;;;BA)(A;OICI;FA;;;OW)"
251
+ if not security.ConvertStringSecurityDescriptorToSecurityDescriptorW(
252
+ dacl, 1, ctypes.byref(descriptor), None
253
+ ):
254
+ raise ctypes.WinError(ctypes.get_last_error())
255
+ try:
256
+ path = temp / f"checkmarx-report-{secrets.token_hex(16)}"
257
+ attributes = SecurityAttributes(ctypes.sizeof(SecurityAttributes), descriptor, False)
258
+ if not kernel.CreateDirectoryW(str(path), ctypes.byref(attributes)):
259
+ raise ctypes.WinError(ctypes.get_last_error())
260
+ return path
261
+ finally:
262
+ kernel.LocalFree(descriptor)
263
+
264
+
265
+ def create_capture(source: Path | None) -> Path:
266
+ # gettempdir() probes candidates by writing a file. Check each candidate before
267
+ # trying to create the actual capture directory in Python's platform order.
268
+ cached = tempfile.tempdir
269
+ candidates = [cached] if cached is not None else tempfile._candidate_tempdir_list()
270
+ last_error = None
271
+ for candidate in candidates:
272
+ temp = Path(os.fsdecode(candidate)).absolute()
273
+ if in_source(temp, source):
274
+ raise ValueError(
275
+ "Select a temporary directory outside the source checkout (TMPDIR or TEMP)."
276
+ )
277
+ try:
278
+ return capture_directory(temp)
279
+ except OSError as error:
280
+ if cached is not None:
281
+ raise
282
+ last_error = error
283
+ raise FileNotFoundError(
284
+ f"No usable temporary directory outside the source checkout: {last_error}"
285
+ )
286
+
287
+
288
+ def export_report(args: argparse.Namespace, source: Path | None, work: str, run_vendor) -> Path:
289
+ def fetch(report, env, *command):
290
+ # Only the validated report path goes to stdout; vendor diagnostics go to stderr.
291
+ status = run_vendor(command, cwd=work, env=env, stdin=subprocess.DEVNULL, stdout=sys.stderr)
292
+ if status:
293
+ raise ValueError(f"The Checkmarx tool exited with status {status}.")
294
+ if report.is_symlink() or not report.is_file():
295
+ raise ValueError("The Checkmarx tool did not produce the requested report.")
296
+
297
+ if args.product == "one":
298
+ env = one_environment(source, work)
299
+ report = Path(work, "cx_result.json")
300
+ fetch(
301
+ report,
302
+ env,
303
+ str(args.cx),
304
+ "results",
305
+ "show",
306
+ # Older clients reject this flag instead of authenticating with another profile.
307
+ "--config-file-path",
308
+ env["CX_CONFIG_FILE_PATH"],
309
+ "--scan-id",
310
+ args.scan_id,
311
+ "--report-format",
312
+ "json",
313
+ "--output-path",
314
+ work,
315
+ "--output-name",
316
+ report.stem,
317
+ )
318
+ verify_one(report, args.scan_id)
319
+ return report
320
+
321
+ team = args.team.rstrip("/\\")
322
+ report = Path(work, "checkmarx-results.xml")
323
+ fetch(
324
+ report,
325
+ cxsast_environment(work, args.use_env_credentials),
326
+ str(args.java),
327
+ f"-Djava.io.tmpdir={work}",
328
+ f"-DLOG_PATH={work}",
329
+ "-Dfile.encoding=UTF-8",
330
+ "-jar",
331
+ str(args.jar),
332
+ f"--spring.config.location={args.config.as_uri()}",
333
+ "--logging.config=classpath:logback-spring.xml",
334
+ f"--logging.file.path={work}",
335
+ f"--logging.file.name={Path(work, 'cx-flow.log')}",
336
+ f"--logging.logback.rollingpolicy.file-name-pattern={Path(work, 'cx-flow.%d{yyyy-MM-dd}.%i.gz')}",
337
+ "--project",
338
+ f"--scanId={args.scan_id}",
339
+ f"--cx-team={team}",
340
+ f"--cx-project={args.project}",
341
+ f"--app={args.project}",
342
+ "--bug-tracker=CxXml",
343
+ "--cx-flow.bug-tracker-impl=CxXml",
344
+ "--cx-flow.enabled-vulnerability-scanners=sast",
345
+ "--cx-flow.preserve-project-name=true",
346
+ "--cx-flow.mail.notification=false",
347
+ "--cx-flow.filter-script=",
348
+ "--disable-break-build",
349
+ "--checkmarx.cx-branch=false",
350
+ "--checkmarx.preserve-xml=true",
351
+ f"--cx-xml.data-folder={work}",
352
+ f"--cx-xml.file-name-format={report.name}",
353
+ )
354
+ verify_cxsast(report, str(args.scan_id), args.project, args.team)
355
+ return report
356
+
357
+
358
+ def collect(args: argparse.Namespace, source: Path | None, run_vendor) -> None:
359
+ output = create_capture(source)
360
+ try:
361
+ with tempfile.TemporaryDirectory(dir=output) as work:
362
+ report = export_report(args, source, work, run_vendor)
363
+ report.chmod(0o600)
364
+ saved = report.replace(output / report.name)
365
+ sys.stdout.buffer.write(f"{saved}\n".encode("utf-8"))
366
+ sys.stdout.buffer.flush()
367
+ except BaseException:
368
+ shutil.rmtree(output)
369
+ raise
370
+
371
+
372
+ def main() -> int:
373
+ parser = argparse.ArgumentParser(description=__doc__)
374
+ parser.add_argument("--source-root", type=Path, help="absolute source directory to protect")
375
+ products = parser.add_subparsers(dest="product", required=True)
376
+ one = products.add_parser("one", help="export an existing Checkmarx One scan")
377
+ one.add_argument("scan_id")
378
+ one.add_argument("--cx", required=True)
379
+ cxsast = products.add_parser("cxsast", help="retrieve an existing CxSAST scan with CxFlow")
380
+ cxsast.add_argument("scan_id", type=int)
381
+ cxsast.add_argument("--java", required=True)
382
+ cxsast.add_argument("--jar", required=True)
383
+ cxsast.add_argument("--config", required=True)
384
+ cxsast.add_argument("--team", required=True)
385
+ cxsast.add_argument("--project", required=True)
386
+ cxsast.add_argument(
387
+ "--use-env-credentials",
388
+ action="store_true",
389
+ help="use the Checkmarx credentials selected for this profile's server",
390
+ )
391
+ args = parser.parse_args()
392
+ if args.product == "one":
393
+ if not re.fullmatch(
394
+ r"[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}", args.scan_id, re.I | re.ASCII
395
+ ):
396
+ parser.error("Select a Checkmarx One scan UUID in hyphenated form.")
397
+ else:
398
+ if args.scan_id <= 0:
399
+ parser.error("Select an existing positive CxSAST scan ID.")
400
+ if not re.search(r"[^\s/\\]", args.team) or not args.project.strip():
401
+ parser.error("Select a nonblank CxSAST team path and project.")
402
+
403
+ pending_signal = None
404
+ defer_termination = False
405
+
406
+ def terminate(signum, _frame):
407
+ nonlocal pending_signal
408
+ if pending_signal is None:
409
+ pending_signal = signum
410
+ if not defer_termination:
411
+ raise SystemExit(128 + signum)
412
+
413
+ def run_vendor(command, **kwargs):
414
+ nonlocal defer_termination
415
+ child = None
416
+ # Popen can have spawned the child before it returns the handle needed for cleanup.
417
+ defer_termination = True
418
+ try:
419
+ child = subprocess.Popen(command, start_new_session=os.name == "posix", **kwargs)
420
+ defer_termination = False
421
+ if pending_signal is not None:
422
+ raise SystemExit(128 + pending_signal)
423
+ return child.wait()
424
+ except BaseException:
425
+ defer_termination = True
426
+ if child is not None:
427
+ if os.name == "posix":
428
+ # Kill any surviving credential helper if the process group still exists.
429
+ with suppress(ProcessLookupError):
430
+ os.killpg(child.pid, signal.SIGKILL)
431
+ else:
432
+ child.kill()
433
+ child.wait()
434
+ raise
435
+ finally:
436
+ defer_termination = False
437
+
438
+ signals = [signal.SIGTERM]
439
+ if signal.getsignal(signal.SIGINT) != signal.SIG_IGN:
440
+ signals.append(signal.SIGINT)
441
+ if os.name == "posix" and signal.getsignal(signal.SIGHUP) != signal.SIG_IGN:
442
+ signals.append(signal.SIGHUP)
443
+ previous = {number: signal.signal(number, terminate) for number in signals}
444
+ try:
445
+ source = source_root(args.source_root)
446
+ if args.product == "one":
447
+ args.cx = installed_launcher(args.cx, source)
448
+ else:
449
+ args.java = installed_launcher(args.java, source)
450
+ args.jar = installed_file(args.jar, source)
451
+ args.config = installed_file(args.config, source)
452
+ check_cxflow_version(args.jar)
453
+ collect(args, source, run_vendor)
454
+ except (ValueError, OSError, expat.ExpatError) as error:
455
+ print(error, file=sys.stderr)
456
+ return 1
457
+ finally:
458
+ for number, handler in previous.items():
459
+ signal.signal(number, handler)
460
+ return 0
461
+
462
+
463
+ if __name__ == "__main__":
464
+ raise SystemExit(main())
@@ -16,7 +16,20 @@ def require(condition, message):
16
16
 
17
17
 
18
18
  def validate(model, assessment_bytes: bytes):
19
+ """Check the explorer graph and its citations against the assessment before rendering.
20
+
21
+ Args:
22
+ model (dict): Parsed explorer JSON containing the graph, scenarios, and evidence.
23
+ assessment_bytes (bytes): Original UTF-8 bytes used to match quotations, line ranges,
24
+ and the optional assessment digest. Preserve the original line endings.
25
+
26
+ Raises:
27
+ ValueError: A graph relationship, layout value, or evidence check fails.
28
+ KeyError: A required field is missing when accessed by name.
29
+ """
30
+
19
31
  def indexed(key, default=None):
32
+ """Index a model collection by its unique, nonempty string IDs."""
20
33
  items = model.get(key, default)
21
34
  require(isinstance(items, list), f"{key} must be a list")
22
35
  ids = [item.get("id") for item in items]
@@ -148,6 +161,7 @@ def validate(model, assessment_bytes: bytes):
148
161
  source_roles(model.get("participants", []), "participants", participant=True)
149
162
 
150
163
  def chain(item, scenario_id, route_id):
164
+ """Return the edge IDs of a connected route after checking its assessment references."""
151
165
  ids = item.get("edges", [])
152
166
  require(
153
167
  isinstance(ids, list) and ids and all(i in edges for i in ids),
@@ -163,6 +177,7 @@ def validate(model, assessment_bytes: bytes):
163
177
  return ids
164
178
 
165
179
  def applicable_routes(control, routes, sources):
180
+ """Return the routes selected by both the control and any sources it targets."""
166
181
  return [
167
182
  route
168
183
  for route in routes
@@ -482,6 +497,7 @@ def validate(model, assessment_bytes: bytes):
482
497
 
483
498
 
484
499
  def embedded(value):
500
+ """Encode a value as JSON for an HTML script element, escaping HTML delimiters."""
485
501
  return (
486
502
  json.dumps(value, ensure_ascii=False, allow_nan=False)
487
503
  .replace("<", "\\u003c")
@@ -491,7 +507,10 @@ def embedded(value):
491
507
 
492
508
 
493
509
  def enters_node(start, end, node):
494
- """Intersect the segment's parameter interval with the open box on each axis."""
510
+ """Return whether the segment between two (x, y) points enters the open node rectangle.
511
+
512
+ Contact with an edge or corner alone is allowed when routing a connector.
513
+ """
495
514
  enter, leave = 0, 1
496
515
  for a, b, low, size in zip(start, end, (node["x"], node["y"]), (node["w"], node["h"])):
497
516
  high = low + size
@@ -505,6 +524,7 @@ def enters_node(start, end, node):
505
524
 
506
525
 
507
526
  def connector_warnings(model):
527
+ """Yield layout warnings for diagonal end bends and connectors that enter node interiors."""
508
528
  for edge in model["edges"]:
509
529
  segments = [(a, b) for a, b in pairwise(edge["points"]) if a != b]
510
530
  diagonal = [a[0] != b[0] and a[1] != b[1] for a, b in segments]
@@ -518,6 +538,7 @@ def connector_warnings(model):
518
538
 
519
539
 
520
540
  def main():
541
+ """Validate the assessment and model, write a self-contained HTML file, and print layout warnings."""
521
542
  parser = argparse.ArgumentParser(description=__doc__)
522
543
  parser.add_argument("model", type=Path)
523
544
  parser.add_argument("--assessment", required=True, type=Path)
@@ -6,7 +6,11 @@ Retrieve the requested content before normalization. Do not infer inaccessible t
6
6
 
7
7
  By default, use the native [Atlassian](app://asdk_app_6a83901dde988191b3f3cefdcc19acfa) app for Jira. Resolve identity and site with `atlassianUserInfo` and `getAccessibleAtlassianResources`; keep that connection and site for the selected set. Ask when the source is ambiguous.
8
8
 
9
- Use live schemas: `getJiraIssue` for exact issues and `searchJiraIssuesUsingJql` for collections. Exhaust returned pages. Discover deferred metadata through `discover` and `executeRead`; intake does not invoke write tools.
9
+ Use `getJiraIssue` for a single issue. For collections, use `searchJiraIssuesUsingJql` and follow `nextPageToken` until `isLast` is true.
10
+
11
+ When the request includes comments, use `listJiraIssueComments` and advance `startAt` until `isLast` is true. Preserve each comment’s visibility and whether it is an internal note.
12
+
13
+ Use only read operations for intake. Discover deferred metadata through `discover` and `executeRead`.
10
14
 
11
15
  Use natural-language search to discover a site, project, issue family, or first key from a vague request, then use JQL or exact fetches. Keep user-supplied JQL intact. Order queries you build by a stable field and preserve the JQL as provenance. Jira text search tokenizes punctuation: if an exact marker gives no results, search a stable token and filter summaries for the exact family when those fields are authorized.
12
16
 
@@ -16,7 +20,7 @@ For Linear, use the native app by default. If the user selects an authenticated
16
20
 
17
21
  ## Linear parents and sub-issues
18
22
 
19
- Fetch the supplied parent. When the request includes its sub-issues or a finding collection organized under it, list the relevant descendants with the parent filter, exhausting pagination.
23
+ Fetch the supplied parent. For requested sub-issues, use `list_issues` with `parentId` and follow every page of direct children. Repeat for each parent at deeper requested levels.
20
24
 
21
25
  Honor the requested collection scope across depths. If it is unclear whether descendants are included, show the available set and clarify once rather than asking at every level. Fetch each selected issue's full content before triage.
22
26
 
package/dist/api.d.ts CHANGED
@@ -3,7 +3,7 @@ import { z } from "zod";
3
3
  import { VerificationModeSchema } from "./remediation.js";
4
4
  import { CodexLoginHandle, type AccountStatus } from "./auth.js";
5
5
  import { type CodexSecurityConfig, type JsonObject, type ScanModelConfiguration } from "./config.js";
6
- import { type ScanCost, type ScanSessionEvent, type ScanUsageObservation, type ScanWorkerEvent } from "./cost.js";
6
+ import { type ScanCost, type ScanUsageMeasurement, type ScanSessionEvent, type ScanUsageObservation, type ScanWorkerEvent } from "./cost.js";
7
7
  import type { ScanTokenUsage } from "./cost-model.js";
8
8
  import { type DeepScanProgress } from "./scan-progress.js";
9
9
  import { type SeverityRubricSnapshot } from "./severity-rubric.js";
@@ -15,8 +15,36 @@ import { ScanResult } from "./result.js";
15
15
  import { type SecurityPolicyDraft, type SecurityPolicyOptions, type SecurityPolicyPreflight } from "./security-policy.js";
16
16
  import { type ScanActivity } from "./scan-activity.js";
17
17
  import { type ScanProgress, type ScanWorkerStatus } from "./worker-progress.js";
18
+ import { type OperationTelemetryEvent } from "./operation-telemetry.js";
18
19
  import { importAmbientAuth, type ProcessEnvironment } from "./runtime.js";
19
20
  import { type NormalizedTarget, type ScanMode } from "./targets.js";
21
+ declare const scanLifecycleSchema: z.ZodObject<{
22
+ scanId: z.ZodString;
23
+ mode: z.ZodEnum<{
24
+ deep: "deep";
25
+ diff: "diff";
26
+ import: "import";
27
+ standard: "standard";
28
+ }>;
29
+ startedAt: z.ZodString;
30
+ status: z.ZodEnum<{
31
+ canceled: "canceled";
32
+ completed: "completed";
33
+ failed: "failed";
34
+ running: "running";
35
+ }>;
36
+ finishedAt: z.ZodNullable<z.ZodString>;
37
+ hasReportableFindings: z.ZodNullable<z.ZodBoolean>;
38
+ surface: z.ZodNullable<z.ZodEnum<{
39
+ cli: "cli";
40
+ plugin: "plugin";
41
+ sdk: "sdk";
42
+ }>>;
43
+ packageVersion: z.ZodNullable<z.ZodString>;
44
+ pluginVersion: z.ZodNullable<z.ZodString>;
45
+ mock: z.ZodNullable<z.ZodBoolean>;
46
+ }, z.core.$strip>;
47
+ export type ScanLifecycle = Readonly<z.infer<typeof scanLifecycleSchema>>;
20
48
  export interface ScanOptions extends ScanSettings {
21
49
  /** Explicit policy for the initial scan and its workers. */
22
50
  severityRubric?: SeverityRubricSnapshot;
@@ -32,6 +60,10 @@ export interface ScanOptions extends ScanSettings {
32
60
  parentScanId?: string;
33
61
  expectedPluginVersion?: string;
34
62
  onCost?: (cost: Readonly<ScanCost>, maxCostUsd?: number) => void;
63
+ /** Observed subtotals and coverage changes, including loss of completeness. */
64
+ onMeasurement?: (measurement: Readonly<ScanUsageMeasurement>) => void;
65
+ /** Content-free local operation receipts. Hosts own remote export and acknowledgement. */
66
+ onTelemetry?: (event: Readonly<OperationTelemetryEvent>) => void;
35
67
  /** Observed tokens, including models without a price estimate. */
36
68
  onUsage?: (usage: Readonly<ScanTokenUsage>) => void;
37
69
  /** The last reportable token total's measurement time and latest account limits from this scan's sessions. */
@@ -39,6 +71,9 @@ export interface ScanOptions extends ScanSettings {
39
71
  onBudgetApproaching?: (budget: ScanBudget) => number | undefined | Promise<number | undefined>;
40
72
  onOutputArchived?: (archiveDir: string) => void;
41
73
  onOutputDirReady?: (scanDir: string) => void;
74
+ /** Best-effort snapshots at fresh registration and observed terminal state.
75
+ * Resume preserves the scan ID and only reports a terminal outcome. */
76
+ onLifecycle?: (scan: ScanLifecycle) => void;
42
77
  onAuthentication?: (authentication: ScanAuthentication) => void;
43
78
  onTrustedAccessStatus?: (status: ScanTrustedAccessStatus) => void;
44
79
  onScanStarted?: () => void;
@@ -61,7 +96,7 @@ export interface ScanOptions extends ScanSettings {
61
96
  onObserverError?: (observer: ScanObserverName, error: unknown) => void;
62
97
  signal?: AbortSignal;
63
98
  }
64
- export interface ValidationOptions extends Pick<ScanOptions, "auth" | "cyberAccessProgram" | "knowledgeBasePaths" | "outputDir" | "safetyIdentifier" | "signal"> {
99
+ export interface ValidationOptions extends Pick<ScanOptions, "auth" | "cyberAccessProgram" | "knowledgeBasePaths" | "outputDir" | "safetyIdentifier" | "signal" | "onTelemetry" | "onObserverError"> {
65
100
  repositoryPath: string;
66
101
  /** Finding text or a JSON-serializable object. Strings are never file paths. */
67
102
  finding: string | object;
@@ -79,7 +114,7 @@ export interface ValidationResult extends z.infer<typeof validationResponseSchem
79
114
  outputDir: string;
80
115
  threadId: string | null;
81
116
  }
82
- export interface PatchOptions extends Pick<ScanOptions, "auth" | "safetyIdentifier" | "signal" | "onAuthentication" | "onActivity" | "onSessionEvent" | "onCost" | "onReconnect" | "onWarning" | "onObserverError"> {
117
+ export interface PatchOptions extends Pick<ScanOptions, "auth" | "safetyIdentifier" | "signal" | "onAuthentication" | "onActivity" | "onSessionEvent" | "onCost" | "onMeasurement" | "onTelemetry" | "onReconnect" | "onWarning" | "onObserverError"> {
83
118
  repositoryPath: string;
84
119
  /** Finding text or a JSON-serializable object. Strings are never file paths. */
85
120
  finding: string | object;
@@ -146,7 +181,7 @@ export interface ScanBudget {
146
181
  cost: Readonly<ScanCost>;
147
182
  signal: AbortSignal;
148
183
  }
149
- type ScanObserverName = "onAuthentication" | "onCost" | "onUsage" | "onUsageObservation" | "onOutputArchived" | "onOutputDirReady" | "onScanRegistered" | "onScanStarted" | "onTrustedAccessStatus" | "onReconnect" | "onActivity" | "onSessionEvent" | "onProgress" | "onDeepProgress" | "onWorkerStatus" | "onWorkerEvent" | "onStage" | "onWarning";
184
+ type ScanObserverName = "onAuthentication" | "onCost" | "onUsage" | "onMeasurement" | "onTelemetry" | "onUsageObservation" | "onOutputArchived" | "onOutputDirReady" | "onScanRegistered" | "onLifecycle" | "onScanStarted" | "onTrustedAccessStatus" | "onReconnect" | "onActivity" | "onSessionEvent" | "onProgress" | "onDeepProgress" | "onWorkerStatus" | "onWorkerEvent" | "onStage" | "onWarning";
150
185
  export interface ScanPreflight extends DeepScanOptions, ScanModelConfiguration {
151
186
  maxTimeMinutes?: number;
152
187
  repository: string;