@openai/codex-security 0.8.3 → 0.10.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 (658) hide show
  1. package/README.md +36 -746
  2. package/_bundled_plugin/.codex-plugin/plugin.json +2 -0
  3. package/_bundled_plugin/.mcp.json +7 -1
  4. package/_bundled_plugin/examples/completed-scan/findings.json +16 -4
  5. package/_bundled_plugin/examples/completed-scan/report.md +11 -8
  6. package/_bundled_plugin/examples/completed-scan/scan-manifest.json +4 -2
  7. package/_bundled_plugin/mcp/fzstd-LICENSE.txt +21 -0
  8. package/_bundled_plugin/mcp/helpers.mjs +2 -11
  9. package/_bundled_plugin/mcp/helpers.mjs.br +0 -0
  10. package/_bundled_plugin/mcp/native/THIRD_PARTY_NOTICES.txt +3 -210
  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/package.json +1 -0
  20. package/_bundled_plugin/mcp/permission-profile-preflight.mjs +5 -2
  21. package/_bundled_plugin/mcp/server.mjs +2 -11
  22. package/_bundled_plugin/mcp/server.mjs.br +0 -0
  23. package/_bundled_plugin/mcp/session-decompression.mjs +712 -0
  24. package/_bundled_plugin/references/artifact-storage.md +1 -1
  25. package/_bundled_plugin/references/baseline-auditor.md +18 -0
  26. package/_bundled_plugin/references/core-scan.md +5 -42
  27. package/_bundled_plugin/references/default-severity-rubric.md +9 -4
  28. package/_bundled_plugin/references/final-report.md +5 -3
  29. package/_bundled_plugin/references/finding-detail-fields.md +18 -18
  30. package/_bundled_plugin/references/focused-investigator.md +13 -0
  31. package/_bundled_plugin/references/sarif-adapter.md +8 -2
  32. package/_bundled_plugin/references/scan-artifacts.md +21 -12
  33. package/_bundled_plugin/references/scan-contract.md +27 -33
  34. package/_bundled_plugin/references/scan-prologue.md +2 -2
  35. package/_bundled_plugin/references/scan-runtime.md +4 -2
  36. package/_bundled_plugin/references/security-guidance.md +14 -1
  37. package/_bundled_plugin/references/validate-scan-findings.md +3 -0
  38. package/_bundled_plugin/schemas/tools/scan-draft.schema.json +2 -2
  39. package/_bundled_plugin/scripts/check_deep_scan_target.py +97 -0
  40. package/_bundled_plugin/scripts/codex_profile.mjs +7 -1
  41. package/_bundled_plugin/scripts/deep_scan_config.py +20 -1
  42. package/_bundled_plugin/scripts/deep_scan_workbench.py +192 -352
  43. package/_bundled_plugin/scripts/dispatch_inventory_tool +7 -0
  44. package/_bundled_plugin/scripts/filesystem_identity.py +1 -0
  45. package/_bundled_plugin/scripts/finalize_scan_contract.py +182 -230
  46. package/_bundled_plugin/scripts/finding_preview.py +20 -0
  47. package/_bundled_plugin/scripts/launch_codex_security_mcp +55 -16
  48. package/_bundled_plugin/scripts/legacy_findings.py +148 -0
  49. package/_bundled_plugin/scripts/posix_scan_local_files.py +37 -1
  50. package/_bundled_plugin/scripts/read_codex_session.mjs +21 -0
  51. package/_bundled_plugin/scripts/report_projection.py +81 -43
  52. package/_bundled_plugin/scripts/review_state.py +8 -2
  53. package/_bundled_plugin/scripts/servicenow_avit.py +20 -0
  54. package/_bundled_plugin/scripts/snapshot_sqlite.py +9 -2
  55. package/_bundled_plugin/scripts/threat_model_projection.py +22 -26
  56. package/_bundled_plugin/scripts/validate_scan_contract.py +7 -1
  57. package/_bundled_plugin/scripts/windows_scan_local_files.py +582 -20
  58. package/_bundled_plugin/scripts/workbench/__init__.py +1 -1
  59. package/_bundled_plugin/scripts/workbench/handoff.py +100 -23
  60. package/_bundled_plugin/scripts/workbench/retained_coverage.py +30 -51
  61. package/_bundled_plugin/scripts/workbench/retained_records.py +18 -30
  62. package/_bundled_plugin/scripts/workbench/runtime_toml.py +4 -1
  63. package/_bundled_plugin/scripts/workbench/saved_coverage.py +9 -17
  64. package/_bundled_plugin/scripts/workbench/saved_outputs.py +9 -0
  65. package/_bundled_plugin/scripts/workbench/saved_sources.py +47 -40
  66. package/_bundled_plugin/scripts/workbench/storage.py +91 -7
  67. package/_bundled_plugin/scripts/workbench_cli.py +54 -14
  68. package/_bundled_plugin/scripts/workbench_constants.py +12 -0
  69. package/_bundled_plugin/scripts/workbench_coverage_receipts.py +3 -3
  70. package/_bundled_plugin/scripts/workbench_db.py +562 -303
  71. package/_bundled_plugin/scripts/workbench_feedback.py +57 -11
  72. package/_bundled_plugin/scripts/workbench_finding_index.py +1 -0
  73. package/_bundled_plugin/scripts/workbench_finding_workflows.py +4 -0
  74. package/_bundled_plugin/scripts/workbench_native_indexes.py +238 -41
  75. package/_bundled_plugin/scripts/workbench_progress.py +169 -4
  76. package/_bundled_plugin/scripts/workbench_publication.py +16 -13
  77. package/_bundled_plugin/scripts/workbench_remediation.py +155 -2
  78. package/_bundled_plugin/scripts/workbench_saved_results.py +176 -81
  79. package/_bundled_plugin/scripts/workbench_scan_history.py +398 -174
  80. package/_bundled_plugin/scripts/workbench_scan_start.py +224 -31
  81. package/_bundled_plugin/scripts/workbench_scan_usage.py +675 -73
  82. package/_bundled_plugin/scripts/workbench_schema.py +258 -63
  83. package/_bundled_plugin/scripts/workbench_setup.py +14 -2
  84. package/_bundled_plugin/scripts/workbench_source_excerpt.py +13 -0
  85. package/_bundled_plugin/scripts/workbench_source_scopes.py +18 -0
  86. package/_bundled_plugin/scripts/workbench_target.py +594 -136
  87. package/_bundled_plugin/scripts/workbench_target_state.py +1110 -21
  88. package/_bundled_plugin/scripts/workbench_validation.py +43 -3
  89. package/_bundled_plugin/shared/workbench-history-repairs.json +77 -35
  90. package/_bundled_plugin/shared/workbench-migrations.json +100 -0
  91. package/_bundled_plugin/skills/cloud-findings/SKILL.md +5 -5
  92. package/_bundled_plugin/skills/deep-security-scan/SKILL.md +7 -50
  93. package/_bundled_plugin/skills/fix-finding/SKILL.md +2 -1
  94. package/_bundled_plugin/skills/publish-findings/SKILL.md +24 -153
  95. package/_bundled_plugin/skills/publish-findings/agents/openai.yaml +2 -2
  96. package/_bundled_plugin/skills/publish-findings/references/checkmarx-import.md +37 -0
  97. package/_bundled_plugin/skills/publish-findings/references/wiz-import.md +3 -3
  98. package/_bundled_plugin/skills/publish-findings/scripts/collect_checkmarx.py +409 -0
  99. package/_bundled_plugin/skills/publish-findings/scripts/collect_continuum.py +224 -0
  100. package/_bundled_plugin/skills/publish-findings/scripts/collector_paths.py +63 -0
  101. package/_bundled_plugin/skills/security-scan/SKILL.md +9 -46
  102. package/_bundled_plugin/skills/security-scan/agents/openai.yaml +2 -2
  103. package/_bundled_plugin/skills/security-scan/references/desktop-scan.md +3 -21
  104. package/_bundled_plugin/skills/security-scan/references/managed-scan.md +11 -0
  105. package/_bundled_plugin/skills/security-scan/references/scan-results.md +15 -0
  106. package/_bundled_plugin/skills/security-scan/references/scoped-paths.md +23 -0
  107. package/_bundled_plugin/skills/security-scan/references/sdk-files.md +24 -0
  108. package/_bundled_plugin/skills/threat-model-visualize/scripts/build_explorer.py +22 -1
  109. package/_bundled_plugin/skills/triage-finding/references/ticket-intake.md +6 -2
  110. package/bin/codex-security.mjs +2 -2
  111. package/dist/api.d.ts +45 -5
  112. package/dist/api.d.ts.map +1 -1
  113. package/dist/api.js +1192 -427
  114. package/dist/api.js.map +1 -1
  115. package/dist/armorcode-findings.d.ts +9 -0
  116. package/dist/armorcode-findings.d.ts.map +1 -0
  117. package/dist/armorcode-findings.js +145 -0
  118. package/dist/armorcode-findings.js.map +1 -0
  119. package/dist/artifact-export.d.ts +2 -0
  120. package/dist/artifact-export.d.ts.map +1 -1
  121. package/dist/artifact-export.js +29 -13
  122. package/dist/artifact-export.js.map +1 -1
  123. package/dist/auth.d.ts +6 -2
  124. package/dist/auth.d.ts.map +1 -1
  125. package/dist/auth.js +37 -18
  126. package/dist/auth.js.map +1 -1
  127. package/dist/batch-cost.d.ts +18 -0
  128. package/dist/batch-cost.d.ts.map +1 -0
  129. package/dist/batch-cost.js +41 -0
  130. package/dist/batch-cost.js.map +1 -0
  131. package/dist/bedrock-oss-pricing.d.ts +6 -0
  132. package/dist/bedrock-oss-pricing.d.ts.map +1 -0
  133. package/dist/bedrock-oss-pricing.js +58 -0
  134. package/dist/bedrock-oss-pricing.js.map +1 -0
  135. package/dist/bedrock-pricing.d.ts +15 -0
  136. package/dist/bedrock-pricing.d.ts.map +1 -0
  137. package/dist/bedrock-pricing.js +117 -0
  138. package/dist/bedrock-pricing.js.map +1 -0
  139. package/dist/blackduck-findings.d.ts +1 -1
  140. package/dist/blackduck-findings.d.ts.map +1 -1
  141. package/dist/blackduck-findings.js +24 -22
  142. package/dist/blackduck-findings.js.map +1 -1
  143. package/dist/bulk-scan-discovery.d.ts.map +1 -1
  144. package/dist/bulk-scan-discovery.js +4 -4
  145. package/dist/bulk-scan-discovery.js.map +1 -1
  146. package/dist/bundled-plugin.d.ts +4 -0
  147. package/dist/bundled-plugin.d.ts.map +1 -0
  148. package/dist/bundled-plugin.js +23 -0
  149. package/dist/bundled-plugin.js.map +1 -0
  150. package/dist/checkmarx-evidence.d.ts +19 -0
  151. package/dist/checkmarx-evidence.d.ts.map +1 -0
  152. package/dist/checkmarx-evidence.js +36 -0
  153. package/dist/checkmarx-evidence.js.map +1 -0
  154. package/dist/checkmarx-findings.d.ts +4 -0
  155. package/dist/checkmarx-findings.d.ts.map +1 -0
  156. package/dist/checkmarx-findings.js +27 -0
  157. package/dist/checkmarx-findings.js.map +1 -0
  158. package/dist/checkmarx-one.d.ts +4 -0
  159. package/dist/checkmarx-one.d.ts.map +1 -0
  160. package/dist/checkmarx-one.js +53 -0
  161. package/dist/checkmarx-one.js.map +1 -0
  162. package/dist/checkmarx-repository.d.ts +12 -0
  163. package/dist/checkmarx-repository.d.ts.map +1 -0
  164. package/dist/checkmarx-repository.js +181 -0
  165. package/dist/checkmarx-repository.js.map +1 -0
  166. package/dist/checkmarx-xml.d.ts +12 -0
  167. package/dist/checkmarx-xml.d.ts.map +1 -0
  168. package/dist/checkmarx-xml.js +196 -0
  169. package/dist/checkmarx-xml.js.map +1 -0
  170. package/dist/classify-scan-severity.d.ts +1 -1
  171. package/dist/classify-scan-severity.d.ts.map +1 -1
  172. package/dist/classify-scan-severity.js +11 -3
  173. package/dist/classify-scan-severity.js.map +1 -1
  174. package/dist/classify-severity-records.d.ts +1 -9
  175. package/dist/classify-severity-records.d.ts.map +1 -1
  176. package/dist/classify-severity-records.js +3 -13
  177. package/dist/classify-severity-records.js.map +1 -1
  178. package/dist/classify-severity.d.ts.map +1 -1
  179. package/dist/classify-severity.js +11 -10
  180. package/dist/classify-severity.js.map +1 -1
  181. package/dist/cli-argument.d.ts +4 -0
  182. package/dist/cli-argument.d.ts.map +1 -0
  183. package/dist/cli-argument.js +17 -0
  184. package/dist/cli-argument.js.map +1 -0
  185. package/dist/cli-help.d.ts +1 -1
  186. package/dist/cli-help.d.ts.map +1 -1
  187. package/dist/cli-help.js +71 -29
  188. package/dist/cli-help.js.map +1 -1
  189. package/dist/cli-hook.d.ts +3 -0
  190. package/dist/cli-hook.d.ts.map +1 -0
  191. package/dist/cli-hook.js +87 -0
  192. package/dist/cli-hook.js.map +1 -0
  193. package/dist/cli-integrations.d.ts +13 -0
  194. package/dist/cli-integrations.d.ts.map +1 -0
  195. package/dist/cli-integrations.js +333 -0
  196. package/dist/cli-integrations.js.map +1 -0
  197. package/dist/cli-mcp.d.ts +15 -0
  198. package/dist/cli-mcp.d.ts.map +1 -0
  199. package/dist/cli-mcp.js +178 -0
  200. package/dist/cli-mcp.js.map +1 -0
  201. package/dist/cli-token-view.d.ts +10 -0
  202. package/dist/cli-token-view.d.ts.map +1 -0
  203. package/dist/cli-token-view.js +41 -0
  204. package/dist/cli-token-view.js.map +1 -0
  205. package/dist/cli.d.ts +16 -8
  206. package/dist/cli.d.ts.map +1 -1
  207. package/dist/cli.js +3382 -2017
  208. package/dist/cli.js.map +1 -1
  209. package/dist/cloud-publish.d.ts.map +1 -1
  210. package/dist/cloud-publish.js +35 -33
  211. package/dist/cloud-publish.js.map +1 -1
  212. package/dist/codex-sdk-environment.d.ts +6 -0
  213. package/dist/codex-sdk-environment.d.ts.map +1 -1
  214. package/dist/codex-sdk-environment.js +19 -0
  215. package/dist/codex-sdk-environment.js.map +1 -1
  216. package/dist/command-words.d.ts +3 -0
  217. package/dist/command-words.d.ts.map +1 -0
  218. package/dist/command-words.js +46 -0
  219. package/dist/command-words.js.map +1 -0
  220. package/dist/component-scan.d.ts +19 -4
  221. package/dist/component-scan.d.ts.map +1 -1
  222. package/dist/component-scan.js +67 -9
  223. package/dist/component-scan.js.map +1 -1
  224. package/dist/config.d.ts +1 -1
  225. package/dist/config.d.ts.map +1 -1
  226. package/dist/config.js +130 -67
  227. package/dist/config.js.map +1 -1
  228. package/dist/continuum-findings.d.ts +1 -1
  229. package/dist/continuum-findings.d.ts.map +1 -1
  230. package/dist/continuum-findings.js +149 -19
  231. package/dist/continuum-findings.js.map +1 -1
  232. package/dist/contract-values.d.ts +2 -0
  233. package/dist/contract-values.d.ts.map +1 -1
  234. package/dist/contract-values.js +12 -9
  235. package/dist/contract-values.js.map +1 -1
  236. package/dist/cost-model.d.ts +13 -1
  237. package/dist/cost-model.d.ts.map +1 -1
  238. package/dist/cost-model.js +66 -112
  239. package/dist/cost-model.js.map +1 -1
  240. package/dist/cost.d.ts +42 -3
  241. package/dist/cost.d.ts.map +1 -1
  242. package/dist/cost.js +484 -149
  243. package/dist/cost.js.map +1 -1
  244. package/dist/custom-publish.d.ts +4 -0
  245. package/dist/custom-publish.d.ts.map +1 -1
  246. package/dist/custom-publish.js +40 -3
  247. package/dist/custom-publish.js.map +1 -1
  248. package/dist/custom-validation-prompt.d.ts +1 -1
  249. package/dist/custom-validation-prompt.d.ts.map +1 -1
  250. package/dist/custom-validation-prompt.js +29 -19
  251. package/dist/custom-validation-prompt.js.map +1 -1
  252. package/dist/deduplication/local.d.ts +4 -2
  253. package/dist/deduplication/local.d.ts.map +1 -1
  254. package/dist/deduplication/local.js +9 -2
  255. package/dist/deduplication/local.js.map +1 -1
  256. package/dist/deduplication/refusal.d.ts.map +1 -1
  257. package/dist/deduplication/refusal.js +26 -5
  258. package/dist/deduplication/refusal.js.map +1 -1
  259. package/dist/deduplication/scan.d.ts +5 -0
  260. package/dist/deduplication/scan.d.ts.map +1 -1
  261. package/dist/deduplication/scan.js +24 -7
  262. package/dist/deduplication/scan.js.map +1 -1
  263. package/dist/deep-config.d.ts +0 -1
  264. package/dist/deep-config.d.ts.map +1 -1
  265. package/dist/deep-config.js +22 -33
  266. package/dist/deep-config.js.map +1 -1
  267. package/dist/deep-scan-defaults.d.ts +2 -0
  268. package/dist/deep-scan-defaults.d.ts.map +1 -1
  269. package/dist/deep-scan-defaults.js +28 -1
  270. package/dist/deep-scan-defaults.js.map +1 -1
  271. package/dist/deep-scan.d.ts +2 -0
  272. package/dist/deep-scan.d.ts.map +1 -1
  273. package/dist/deep-scan.js +44 -19
  274. package/dist/deep-scan.js.map +1 -1
  275. package/dist/default-severity-rubric.d.ts +1 -1
  276. package/dist/default-severity-rubric.d.ts.map +1 -1
  277. package/dist/default-severity-rubric.js +1 -1
  278. package/dist/default-severity-rubric.js.map +1 -1
  279. package/dist/endor-findings.d.ts +3 -1
  280. package/dist/endor-findings.d.ts.map +1 -1
  281. package/dist/endor-findings.js +86 -45
  282. package/dist/endor-findings.js.map +1 -1
  283. package/dist/errors.d.ts +4 -2
  284. package/dist/errors.d.ts.map +1 -1
  285. package/dist/errors.js +15 -4
  286. package/dist/errors.js.map +1 -1
  287. package/dist/executable-path.d.ts +3 -0
  288. package/dist/executable-path.d.ts.map +1 -1
  289. package/dist/executable-path.js +26 -0
  290. package/dist/executable-path.js.map +1 -1
  291. package/dist/external-findings-import.d.ts +5 -3
  292. package/dist/external-findings-import.d.ts.map +1 -1
  293. package/dist/external-findings-import.js +19 -7
  294. package/dist/external-findings-import.js.map +1 -1
  295. package/dist/external-findings-local.d.ts +69 -5
  296. package/dist/external-findings-local.d.ts.map +1 -1
  297. package/dist/external-findings-local.js +537 -108
  298. package/dist/external-findings-local.js.map +1 -1
  299. package/dist/external-findings-publish.d.ts +13 -6
  300. package/dist/external-findings-publish.d.ts.map +1 -1
  301. package/dist/external-findings-publish.js +895 -1142
  302. package/dist/external-findings-publish.js.map +1 -1
  303. package/dist/external-findings-read.d.ts +21 -2
  304. package/dist/external-findings-read.d.ts.map +1 -1
  305. package/dist/external-findings-read.js +130 -68
  306. package/dist/external-findings-read.js.map +1 -1
  307. package/dist/external-findings.d.ts +15 -3
  308. package/dist/external-findings.d.ts.map +1 -1
  309. package/dist/external-findings.js +54 -2
  310. package/dist/external-findings.js.map +1 -1
  311. package/dist/external-import-contract.d.ts +8 -12
  312. package/dist/external-import-contract.d.ts.map +1 -1
  313. package/dist/external-import-contract.js +51 -184
  314. package/dist/external-import-contract.js.map +1 -1
  315. package/dist/external-import-models.d.ts +1 -1
  316. package/dist/external-import-models.d.ts.map +1 -1
  317. package/dist/external-import-models.js.map +1 -1
  318. package/dist/feedback.d.ts.map +1 -1
  319. package/dist/feedback.js +5 -4
  320. package/dist/feedback.js.map +1 -1
  321. package/dist/finding-prompt.d.ts +5 -0
  322. package/dist/finding-prompt.d.ts.map +1 -0
  323. package/dist/finding-prompt.js +32 -0
  324. package/dist/finding-prompt.js.map +1 -0
  325. package/dist/findings-client.d.ts +1 -0
  326. package/dist/findings-client.d.ts.map +1 -1
  327. package/dist/findings-client.js +27 -3
  328. package/dist/findings-client.js.map +1 -1
  329. package/dist/github-advisories.d.ts.map +1 -1
  330. package/dist/github-advisories.js +0 -2
  331. package/dist/github-advisories.js.map +1 -1
  332. package/dist/github-dependabot-findings.d.ts.map +1 -1
  333. package/dist/github-dependabot-findings.js +18 -8
  334. package/dist/github-dependabot-findings.js.map +1 -1
  335. package/dist/github-findings.d.ts +4 -1
  336. package/dist/github-findings.d.ts.map +1 -1
  337. package/dist/github-findings.js +73 -316
  338. package/dist/github-findings.js.map +1 -1
  339. package/dist/hosted-git-remotes.d.ts +5 -0
  340. package/dist/hosted-git-remotes.d.ts.map +1 -0
  341. package/dist/hosted-git-remotes.js +285 -0
  342. package/dist/hosted-git-remotes.js.map +1 -0
  343. package/dist/hosted-git-repository.d.ts +28 -0
  344. package/dist/hosted-git-repository.d.ts.map +1 -0
  345. package/dist/hosted-git-repository.js +222 -0
  346. package/dist/hosted-git-repository.js.map +1 -0
  347. package/dist/hosted-remediation.d.ts +1 -0
  348. package/dist/hosted-remediation.d.ts.map +1 -1
  349. package/dist/hosted-remediation.js +23 -3
  350. package/dist/hosted-remediation.js.map +1 -1
  351. package/dist/hosted-scan-protocol.js +2 -2
  352. package/dist/hosted-scan-protocol.js.map +1 -1
  353. package/dist/hosted-scan.d.ts.map +1 -1
  354. package/dist/hosted-scan.js +16 -11
  355. package/dist/hosted-scan.js.map +1 -1
  356. package/dist/hosted-scanner-http.d.ts +21 -0
  357. package/dist/hosted-scanner-http.d.ts.map +1 -0
  358. package/dist/hosted-scanner-http.js +204 -0
  359. package/dist/hosted-scanner-http.js.map +1 -0
  360. package/dist/import-scan.d.ts.map +1 -1
  361. package/dist/import-scan.js +3 -0
  362. package/dist/import-scan.js.map +1 -1
  363. package/dist/index.d.ts +21 -9
  364. package/dist/index.d.ts.map +1 -1
  365. package/dist/index.js +12 -3
  366. package/dist/index.js.map +1 -1
  367. package/dist/inspector-findings.d.ts.map +1 -1
  368. package/dist/inspector-findings.js +52 -86
  369. package/dist/inspector-findings.js.map +1 -1
  370. package/dist/knowledge-base.d.ts +1 -1
  371. package/dist/knowledge-base.d.ts.map +1 -1
  372. package/dist/knowledge-base.js +102 -32
  373. package/dist/knowledge-base.js.map +1 -1
  374. package/dist/linear.d.ts +11 -0
  375. package/dist/linear.d.ts.map +1 -1
  376. package/dist/linear.js.map +1 -1
  377. package/dist/local-git-metadata.d.ts +5 -2
  378. package/dist/local-git-metadata.d.ts.map +1 -1
  379. package/dist/local-git-metadata.js +8 -5
  380. package/dist/local-git-metadata.js.map +1 -1
  381. package/dist/multiscan.d.ts +10 -4
  382. package/dist/multiscan.d.ts.map +1 -1
  383. package/dist/multiscan.js +217 -102
  384. package/dist/multiscan.js.map +1 -1
  385. package/dist/native-json-findings.d.ts +2 -1
  386. package/dist/native-json-findings.d.ts.map +1 -1
  387. package/dist/native-json-findings.js +12 -2
  388. package/dist/native-json-findings.js.map +1 -1
  389. package/dist/opengrep-findings.d.ts +5 -2
  390. package/dist/opengrep-findings.d.ts.map +1 -1
  391. package/dist/opengrep-findings.js +54 -33
  392. package/dist/opengrep-findings.js.map +1 -1
  393. package/dist/operation-telemetry.d.ts +104 -0
  394. package/dist/operation-telemetry.d.ts.map +1 -0
  395. package/dist/operation-telemetry.js +293 -0
  396. package/dist/operation-telemetry.js.map +1 -0
  397. package/dist/plugin-python-probe.d.ts +4 -0
  398. package/dist/plugin-python-probe.d.ts.map +1 -0
  399. package/dist/plugin-python-probe.js +10 -0
  400. package/dist/plugin-python-probe.js.map +1 -0
  401. package/dist/private-finding-import.d.ts +99 -9
  402. package/dist/private-finding-import.d.ts.map +1 -1
  403. package/dist/private-finding-import.js +116 -152
  404. package/dist/private-finding-import.js.map +1 -1
  405. package/dist/project-config.d.ts.map +1 -1
  406. package/dist/project-config.js +53 -13
  407. package/dist/project-config.js.map +1 -1
  408. package/dist/prompt-files.d.ts +7 -2
  409. package/dist/prompt-files.d.ts.map +1 -1
  410. package/dist/prompt-files.js +42 -20
  411. package/dist/prompt-files.js.map +1 -1
  412. package/dist/provider-profile.d.ts +1 -1
  413. package/dist/provider-profile.d.ts.map +1 -1
  414. package/dist/provider-profile.js +12 -10
  415. package/dist/provider-profile.js.map +1 -1
  416. package/dist/publication-telemetry.d.ts +45 -0
  417. package/dist/publication-telemetry.d.ts.map +1 -0
  418. package/dist/publication-telemetry.js +50 -0
  419. package/dist/publication-telemetry.js.map +1 -0
  420. package/dist/publication.d.ts +1 -1
  421. package/dist/publication.d.ts.map +1 -1
  422. package/dist/publication.js.map +1 -1
  423. package/dist/publish.d.ts +4 -0
  424. package/dist/publish.d.ts.map +1 -1
  425. package/dist/publish.js +42 -2
  426. package/dist/publish.js.map +1 -1
  427. package/dist/record.d.ts +1 -5
  428. package/dist/record.d.ts.map +1 -1
  429. package/dist/record.js +3 -51
  430. package/dist/record.js.map +1 -1
  431. package/dist/remediation.d.ts +1 -4
  432. package/dist/remediation.d.ts.map +1 -1
  433. package/dist/remediation.js +6 -8
  434. package/dist/remediation.js.map +1 -1
  435. package/dist/request-metadata.d.ts +3 -0
  436. package/dist/request-metadata.d.ts.map +1 -1
  437. package/dist/request-metadata.js +9 -0
  438. package/dist/request-metadata.js.map +1 -1
  439. package/dist/result.d.ts +4 -0
  440. package/dist/result.d.ts.map +1 -1
  441. package/dist/result.js +1 -1
  442. package/dist/result.js.map +1 -1
  443. package/dist/retry-windows-rename.d.ts +8 -0
  444. package/dist/retry-windows-rename.d.ts.map +1 -0
  445. package/dist/retry-windows-rename.js +24 -0
  446. package/dist/retry-windows-rename.js.map +1 -0
  447. package/dist/runtime.d.ts +54 -6
  448. package/dist/runtime.d.ts.map +1 -1
  449. package/dist/runtime.js +1084 -256
  450. package/dist/runtime.js.map +1 -1
  451. package/dist/saved-scan-bootstrap.d.ts +7 -1
  452. package/dist/saved-scan-bootstrap.d.ts.map +1 -1
  453. package/dist/saved-scan-bootstrap.js +269 -114
  454. package/dist/saved-scan-bootstrap.js.map +1 -1
  455. package/dist/scan-activity.d.ts.map +1 -1
  456. package/dist/scan-activity.js +141 -56
  457. package/dist/scan-activity.js.map +1 -1
  458. package/dist/scan-archive-path.d.ts +2 -0
  459. package/dist/scan-archive-path.d.ts.map +1 -0
  460. package/dist/scan-archive-path.js +5 -0
  461. package/dist/scan-archive-path.js.map +1 -0
  462. package/dist/scan-comparison.d.ts +10 -5
  463. package/dist/scan-comparison.d.ts.map +1 -1
  464. package/dist/scan-comparison.js +66 -17
  465. package/dist/scan-comparison.js.map +1 -1
  466. package/dist/scan-dashboard.d.ts +7 -6
  467. package/dist/scan-dashboard.d.ts.map +1 -1
  468. package/dist/scan-dashboard.js +92 -43
  469. package/dist/scan-dashboard.js.map +1 -1
  470. package/dist/scan-executor.d.ts +10 -1
  471. package/dist/scan-executor.d.ts.map +1 -1
  472. package/dist/scan-executor.js +24 -2
  473. package/dist/scan-executor.js.map +1 -1
  474. package/dist/scan-history-renderer.d.ts +1 -0
  475. package/dist/scan-history-renderer.d.ts.map +1 -1
  476. package/dist/scan-history-renderer.js +34 -28
  477. package/dist/scan-history-renderer.js.map +1 -1
  478. package/dist/scan-logs.d.ts +12 -0
  479. package/dist/scan-logs.d.ts.map +1 -1
  480. package/dist/scan-logs.js +131 -78
  481. package/dist/scan-logs.js.map +1 -1
  482. package/dist/scan-measurement.d.ts +26 -0
  483. package/dist/scan-measurement.d.ts.map +1 -0
  484. package/dist/scan-measurement.js +77 -0
  485. package/dist/scan-measurement.js.map +1 -0
  486. package/dist/scan-progress.d.ts +1 -0
  487. package/dist/scan-progress.d.ts.map +1 -1
  488. package/dist/scan-progress.js +3 -0
  489. package/dist/scan-progress.js.map +1 -1
  490. package/dist/scan-sessions.d.ts.map +1 -1
  491. package/dist/scan-sessions.js +4 -1
  492. package/dist/scan-sessions.js.map +1 -1
  493. package/dist/scan-settings.d.ts +1 -1
  494. package/dist/scan-settings.d.ts.map +1 -1
  495. package/dist/scan-settings.js +1 -24
  496. package/dist/scan-settings.js.map +1 -1
  497. package/dist/scanner-import.d.ts +25 -13
  498. package/dist/scanner-import.d.ts.map +1 -1
  499. package/dist/scanner-import.js +216 -97
  500. package/dist/scanner-import.js.map +1 -1
  501. package/dist/scanner-repository-url.d.ts +4 -1
  502. package/dist/scanner-repository-url.d.ts.map +1 -1
  503. package/dist/scanner-repository-url.js +10 -6
  504. package/dist/scanner-repository-url.js.map +1 -1
  505. package/dist/security-policy.d.ts +1 -1
  506. package/dist/security-policy.d.ts.map +1 -1
  507. package/dist/security-policy.js +26 -6
  508. package/dist/security-policy.js.map +1 -1
  509. package/dist/semgrep-findings.d.ts +6 -3
  510. package/dist/semgrep-findings.d.ts.map +1 -1
  511. package/dist/semgrep-findings.js +72 -42
  512. package/dist/semgrep-findings.js.map +1 -1
  513. package/dist/semgrep-guardian-findings.d.ts +38 -0
  514. package/dist/semgrep-guardian-findings.d.ts.map +1 -0
  515. package/dist/semgrep-guardian-findings.js +165 -0
  516. package/dist/semgrep-guardian-findings.js.map +1 -0
  517. package/dist/semgrep-platform-collector.d.ts +26 -0
  518. package/dist/semgrep-platform-collector.d.ts.map +1 -0
  519. package/dist/semgrep-platform-collector.js +108 -0
  520. package/dist/semgrep-platform-collector.js.map +1 -0
  521. package/dist/semgrep-platform-findings.d.ts +157 -6
  522. package/dist/semgrep-platform-findings.d.ts.map +1 -1
  523. package/dist/semgrep-platform-findings.js +766 -103
  524. package/dist/semgrep-platform-findings.js.map +1 -1
  525. package/dist/server/api.d.ts +1 -1
  526. package/dist/server/api.d.ts.map +1 -1
  527. package/dist/server/api.js.map +1 -1
  528. package/dist/server/embedding-tokenizer.cdx.json +33 -0
  529. package/dist/server/embedding-tokenizer.d.ts +2 -0
  530. package/dist/server/embedding-tokenizer.d.ts.map +1 -0
  531. package/dist/server/embedding-tokenizer.js +322 -0
  532. package/dist/server/embedding-tokenizer.js.map +6 -0
  533. package/dist/server/embeddings.d.ts +16 -2
  534. package/dist/server/embeddings.d.ts.map +1 -1
  535. package/dist/server/embeddings.js +35 -5
  536. package/dist/server/embeddings.js.map +1 -1
  537. package/dist/session-lines.d.ts +5 -0
  538. package/dist/session-lines.d.ts.map +1 -0
  539. package/dist/session-lines.js +60 -0
  540. package/dist/session-lines.js.map +1 -0
  541. package/dist/severity-review.d.ts +3 -1
  542. package/dist/severity-review.d.ts.map +1 -1
  543. package/dist/severity-review.js +3 -2
  544. package/dist/severity-review.js.map +1 -1
  545. package/dist/skill-authentication.d.ts +1 -0
  546. package/dist/skill-authentication.d.ts.map +1 -1
  547. package/dist/skill-authentication.js +1 -0
  548. package/dist/skill-authentication.js.map +1 -1
  549. package/dist/snyk-findings.d.ts +9 -2
  550. package/dist/snyk-findings.d.ts.map +1 -1
  551. package/dist/snyk-findings.js +90 -70
  552. package/dist/snyk-findings.js.map +1 -1
  553. package/dist/snyk-rest-findings.d.ts +59 -0
  554. package/dist/snyk-rest-findings.d.ts.map +1 -0
  555. package/dist/snyk-rest-findings.js +879 -0
  556. package/dist/snyk-rest-findings.js.map +1 -0
  557. package/dist/snyk-token-origin.d.ts +4 -0
  558. package/dist/snyk-token-origin.d.ts.map +1 -0
  559. package/dist/snyk-token-origin.js +82 -0
  560. package/dist/snyk-token-origin.js.map +1 -0
  561. package/dist/sonar-collector.d.ts.map +1 -1
  562. package/dist/sonar-collector.js +0 -3
  563. package/dist/sonar-collector.js.map +1 -1
  564. package/dist/sonar-findings.d.ts +1 -1
  565. package/dist/sonar-findings.d.ts.map +1 -1
  566. package/dist/sonar-findings.js +2 -4
  567. package/dist/sonar-findings.js.map +1 -1
  568. package/dist/sonar-import.d.ts +3 -0
  569. package/dist/sonar-import.d.ts.map +1 -1
  570. package/dist/sonar-import.js +30 -34
  571. package/dist/sonar-import.js.map +1 -1
  572. package/dist/stored-finding-projection.d.ts +6 -0
  573. package/dist/stored-finding-projection.d.ts.map +1 -0
  574. package/dist/stored-finding-projection.js +104 -0
  575. package/dist/stored-finding-projection.js.map +1 -0
  576. package/dist/stored-findings-publication.d.ts +23 -0
  577. package/dist/stored-findings-publication.d.ts.map +1 -0
  578. package/dist/stored-findings-publication.js +169 -0
  579. package/dist/stored-findings-publication.js.map +1 -0
  580. package/dist/target-drift.d.ts +9 -0
  581. package/dist/target-drift.d.ts.map +1 -0
  582. package/dist/target-drift.js +27 -0
  583. package/dist/target-drift.js.map +1 -0
  584. package/dist/targets.d.ts +8 -1
  585. package/dist/targets.d.ts.map +1 -1
  586. package/dist/targets.js +131 -42
  587. package/dist/targets.js.map +1 -1
  588. package/dist/tenable-findings.d.ts +6 -0
  589. package/dist/tenable-findings.d.ts.map +1 -0
  590. package/dist/tenable-findings.js +122 -0
  591. package/dist/tenable-findings.js.map +1 -0
  592. package/dist/terminal-stream.d.ts +13 -0
  593. package/dist/terminal-stream.d.ts.map +1 -0
  594. package/dist/terminal-stream.js +35 -0
  595. package/dist/terminal-stream.js.map +1 -0
  596. package/dist/trivy-findings.d.ts +19 -0
  597. package/dist/trivy-findings.d.ts.map +1 -0
  598. package/dist/trivy-findings.js +424 -0
  599. package/dist/trivy-findings.js.map +1 -0
  600. package/dist/trivy-import.d.ts +19 -0
  601. package/dist/trivy-import.d.ts.map +1 -0
  602. package/dist/trivy-import.js +151 -0
  603. package/dist/trivy-import.js.map +1 -0
  604. package/dist/trusted-executable.d.ts +6 -0
  605. package/dist/trusted-executable.d.ts.map +1 -1
  606. package/dist/trusted-executable.js +140 -37
  607. package/dist/trusted-executable.js.map +1 -1
  608. package/dist/validation-records.js +1 -1
  609. package/dist/validation-records.js.map +1 -1
  610. package/dist/veracode-findings.d.ts +1 -1
  611. package/dist/veracode-findings.d.ts.map +1 -1
  612. package/dist/veracode-findings.js +19 -6
  613. package/dist/veracode-findings.js.map +1 -1
  614. package/dist/version.d.ts +3 -1
  615. package/dist/version.d.ts.map +1 -1
  616. package/dist/version.js +184 -32
  617. package/dist/version.js.map +1 -1
  618. package/dist/vertex-pricing.d.ts +8 -0
  619. package/dist/vertex-pricing.d.ts.map +1 -0
  620. package/dist/vertex-pricing.js +20 -0
  621. package/dist/vertex-pricing.js.map +1 -0
  622. package/dist/windows-path.d.ts +1 -0
  623. package/dist/windows-path.d.ts.map +1 -1
  624. package/dist/windows-path.js +26 -1
  625. package/dist/windows-path.js.map +1 -1
  626. package/dist/wiz-findings.d.ts +6 -2
  627. package/dist/wiz-findings.d.ts.map +1 -1
  628. package/dist/wiz-findings.js +65 -89
  629. package/dist/wiz-findings.js.map +1 -1
  630. package/docs/classify-severity-records.md +27 -12
  631. package/docs/cli.md +853 -639
  632. package/docs/dedupe-records.md +44 -24
  633. package/docs/findings-service.md +84 -44
  634. package/docs/hosted-remediation.md +27 -11
  635. package/docs/hosted-scans.md +50 -42
  636. package/docs/sdk.md +903 -0
  637. package/docs/telemetry.md +236 -0
  638. package/docs/validate-records.md +78 -44
  639. package/package.json +23 -16
  640. package/schemas/external-findings.schema.json +4 -1
  641. package/_bundled_plugin/mcp/helpers.mjs.br.part-000 +0 -0
  642. package/_bundled_plugin/mcp/helpers.mjs.br.part-001 +0 -0
  643. package/_bundled_plugin/mcp/server.mjs.br.part-000 +0 -0
  644. package/_bundled_plugin/mcp/server.mjs.br.part-001 +0 -0
  645. package/_bundled_plugin/mcp/server.mjs.br.part-002 +0 -0
  646. package/_bundled_plugin/schemas/tools/deep-reducer.schema.json +0 -96
  647. package/dist/external-imports-feature.d.ts +0 -6
  648. package/dist/external-imports-feature.d.ts.map +0 -1
  649. package/dist/external-imports-feature.js +0 -51
  650. package/dist/external-imports-feature.js.map +0 -1
  651. package/dist/finding-normalization.d.ts +0 -5
  652. package/dist/finding-normalization.d.ts.map +0 -1
  653. package/dist/finding-normalization.js +0 -155
  654. package/dist/finding-normalization.js.map +0 -1
  655. package/dist/reader-selection.d.ts +0 -13
  656. package/dist/reader-selection.d.ts.map +0 -1
  657. package/dist/reader-selection.js +0 -81
  658. package/dist/reader-selection.js.map +0 -1
@@ -0,0 +1,409 @@
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 subprocess
10
+ import sys
11
+ import tempfile
12
+ import zipfile
13
+ from contextlib import suppress
14
+ from email.parser import BytesHeaderParser
15
+ from pathlib import Path
16
+ from xml.parsers import expat
17
+
18
+ # Isolated Python does not put the installed script directory on sys.path.
19
+ sys.path.insert(0, str(Path(__file__).resolve().parent))
20
+ from collector_paths import in_source, source_root # noqa: E402
21
+
22
+
23
+ def installed_file(value: str, source: Path | None) -> Path:
24
+ path = Path(value)
25
+ if path.is_absolute() and in_source(path, source):
26
+ raise ValueError("use an installed file outside the source checkout")
27
+ if not path.is_absolute() or not path.is_file():
28
+ raise ValueError("expected an absolute path to an existing file")
29
+ # Invoke the selected name for native multicall binaries.
30
+ return path.parent.resolve() / path.name
31
+
32
+
33
+ def installed_launcher(value: str, source: Path | None) -> Path:
34
+ path = installed_file(value, source)
35
+ if sys.platform == "win32" and (
36
+ path.suffix.lower() not in {".exe", ".com"}
37
+ or path.resolve().suffix.lower() in {".bat", ".cmd"}
38
+ ):
39
+ raise ValueError("use a native Windows executable (.exe or .com)")
40
+ with path.open("rb") as image:
41
+ magic = image.read(4)
42
+ if sys.platform == "win32":
43
+ # The DOS header points to the PE signature.
44
+ image.seek(0x3C)
45
+ pe_offset = int.from_bytes(image.read(4), "little")
46
+ image.seek(pe_offset)
47
+ native = magic.startswith(b"MZ") and image.read(4) == b"PE\0\0"
48
+ elif sys.platform == "darwin":
49
+ # 32/64-bit thin and universal Mach-O, in either byte order.
50
+ native = any(
51
+ int.from_bytes(magic, order) in {0xFEEDFACE, 0xFEEDFACF, 0xCAFEBABE, 0xCAFEBABF}
52
+ for order in ("big", "little")
53
+ )
54
+ else:
55
+ native = magic == b"\x7fELF"
56
+ if not native:
57
+ raise ValueError("use the installed native executable for cx or java")
58
+ return path
59
+
60
+
61
+ def check_cxflow_version(jar: Path) -> None:
62
+ # Earlier CxFlow versions accept --scanId but silently retrieve the latest scan.
63
+ advice = "Use a released CxFlow 1.6.37 or later, or supply a scoped CxSAST XML export."
64
+ try:
65
+ with zipfile.ZipFile(jar) as archive:
66
+ manifest = BytesHeaderParser().parsebytes(archive.read("META-INF/MANIFEST.MF"))
67
+ metadata = archive.read("META-INF/build-info.properties").decode("utf-8")
68
+ except (KeyError, UnicodeDecodeError, zipfile.BadZipFile) as error:
69
+ raise ValueError(
70
+ f"Could not read the CxFlow release metadata: {error}. {advice}"
71
+ ) from error
72
+ properties = dict(line.split("=", 1) for line in metadata.splitlines() if "=" in line)
73
+ if (
74
+ manifest.get("Start-Class") != "com.checkmarx.flow.CxFlowApplication"
75
+ or properties.get("build.group") != "com.checkmarx"
76
+ ):
77
+ raise ValueError(f"The selected JAR does not identify itself as CxFlow. {advice}")
78
+ version = properties.get("build.version", "")
79
+ if not re.fullmatch(r"[0-9]+\.[0-9]+\.[0-9]+", version) or tuple(
80
+ map(int, version.split("."))
81
+ ) < (1, 6, 37):
82
+ raise ValueError(f"Unsupported CxFlow version {version or '(unknown)'}. {advice}")
83
+
84
+
85
+ def private_environment(work: str, inherit: tuple[str, ...]) -> dict[str, str]:
86
+ env = {name: os.environ[name] for name in inherit if name in os.environ}
87
+ return env | dict.fromkeys(("TEMP", "TMP", "TMPDIR"), work)
88
+
89
+
90
+ def cxsast_environment(work: str, use_env_credentials: bool = False) -> dict[str, str]:
91
+ # CxFlow uses the chosen profile for its server and Spring configuration.
92
+ credentials = ("CHECKMARX_USERNAME", "CHECKMARX_PASSWORD", "CHECKMARX_CLIENT_SECRET")
93
+ env = private_environment(work, credentials if use_env_credentials else ())
94
+ if os.name == "nt":
95
+ env["SystemRoot"] = os.environ["SystemRoot"]
96
+ else:
97
+ # The Java launcher decodes native arguments before applying file.encoding.
98
+ env["LC_CTYPE"] = "UTF-8" if sys.platform == "darwin" else "C.UTF-8"
99
+ return env
100
+
101
+
102
+ def one_environment(source: Path | None, work: str) -> dict[str, str]:
103
+ # An inherited endpoint or proxy must never receive credentials from a saved profile.
104
+ account = ("HOME", "USER", "LOGNAME", "USERPROFILE", "APPDATA", "LOCALAPPDATA", "SystemRoot")
105
+ env = private_environment(work, (*account, "LANG", "LC_ALL", "LC_CTYPE"))
106
+ configured = os.environ.get("CX_CONFIG_FILE_PATH")
107
+ oauth = ("CX_CLIENT_ID", "CX_CLIENT_SECRET", "CX_BASE_URI", "CX_TENANT")
108
+ api_key = os.environ.get("CX_APIKEY")
109
+ if not configured and (api_key or all(os.environ.get(k) for k in oauth)):
110
+ # A separate config path also separates the vendor's path-keyed credential store.
111
+ profile = Path(work, "env-auth.yaml")
112
+ profile.write_text("{}\n", encoding="utf-8")
113
+ env["CX_CONFIG_FILE_PATH"] = str(profile)
114
+ env["CX_KEYRING_MODE"] = "disabled"
115
+ credentials = ("CX_APIKEY",) if api_key else (*oauth, "CX_BASE_AUTH_URI")
116
+ env.update((name, os.environ[name]) for name in credentials if os.environ.get(name))
117
+ return env
118
+
119
+ profile = Path(configured) if configured else Path.home() / ".checkmarx" / "checkmarxcli.yaml"
120
+ if not profile.is_absolute() or in_source(profile, source):
121
+ raise ValueError(
122
+ "Set CX_CONFIG_FILE_PATH to a trusted absolute path outside the source checkout. "
123
+ "The collector runs Checkmarx One from a private directory."
124
+ )
125
+ env["CX_CONFIG_FILE_PATH"] = configured or str(profile)
126
+ if "CX_KEYRING_MODE" in os.environ:
127
+ env["CX_KEYRING_MODE"] = os.environ["CX_KEYRING_MODE"]
128
+ return env
129
+
130
+
131
+ def verify_one(report: Path, scan_id: str) -> None:
132
+ with report.open(encoding="utf-8-sig") as stream:
133
+ data = json.load(stream)
134
+ reported = data.get("scanID") if isinstance(data, dict) else None
135
+ if (
136
+ not isinstance(reported, str)
137
+ or not reported.isascii()
138
+ or reported.lower() != scan_id.lower()
139
+ ):
140
+ raise ValueError("The Checkmarx One report does not match the requested scan ID.")
141
+
142
+
143
+ def team_path(value: str) -> str:
144
+ path = value.replace("\\", "/").strip("/")
145
+ return "".join(char.lower() if char.isascii() else char for char in path)
146
+
147
+
148
+ def verify_cxsast(report: Path, scan_id: str, project: str, team: str) -> None:
149
+ parser = expat.ParserCreate()
150
+
151
+ def check_root(name, attributes):
152
+ if name != "CxXMLResults" or not attributes.get("ProjectId"):
153
+ raise ValueError("Expected a CxSAST XML scan report.")
154
+ if attributes.get("ScanId") != scan_id or attributes.get("ProjectName") != project:
155
+ raise ValueError("The CxSAST report does not match the requested scan and project.")
156
+ actual_team = attributes.get("TeamFullPathOnReportDate")
157
+ if not actual_team or team_path(actual_team) != team_path(team):
158
+ raise ValueError("The CxSAST report does not match the requested team.")
159
+ parser.StartElementHandler = None
160
+
161
+ parser.StartElementHandler = check_root
162
+ with report.open("rb") as stream:
163
+ parser.ParseFile(stream)
164
+
165
+
166
+ def capture_directory(temp: Path) -> Path:
167
+ if os.name != "nt":
168
+ return Path(tempfile.mkdtemp(prefix="checkmarx-report-", dir=temp)).resolve()
169
+
170
+ import ctypes.wintypes
171
+ import secrets
172
+
173
+ class SecurityAttributes(ctypes.Structure):
174
+ _fields_ = [
175
+ ("length", ctypes.wintypes.DWORD),
176
+ ("descriptor", ctypes.wintypes.LPVOID),
177
+ ("inherit", ctypes.wintypes.BOOL),
178
+ ]
179
+
180
+ # Older Windows Python releases ignore mkdir's 0700 mode. Apply CPython's
181
+ # protected, inheritable SYSTEM/Administrators/owner DACL at creation.
182
+ kernel = ctypes.WinDLL("kernel32", use_last_error=True)
183
+ temp = temp.resolve()
184
+ volume = ctypes.create_unicode_buffer(32768)
185
+ flags = ctypes.wintypes.DWORD()
186
+ if not kernel.GetVolumePathNameW(str(temp), volume, len(volume)):
187
+ raise ctypes.WinError(ctypes.get_last_error())
188
+ if not kernel.GetVolumeInformationW(volume, None, 0, None, None, ctypes.byref(flags), None, 0):
189
+ raise ctypes.WinError(ctypes.get_last_error())
190
+ if not flags.value & 0x8: # FILE_PERSISTENT_ACLS
191
+ raise ValueError("Select a temporary directory on a Windows volume that supports ACLs.")
192
+
193
+ security = ctypes.WinDLL("advapi32", use_last_error=True)
194
+ descriptor = ctypes.wintypes.LPVOID()
195
+ dacl = "D:P(A;OICI;FA;;;SY)(A;OICI;FA;;;BA)(A;OICI;FA;;;OW)"
196
+ if not security.ConvertStringSecurityDescriptorToSecurityDescriptorW(
197
+ dacl, 1, ctypes.byref(descriptor), None
198
+ ):
199
+ raise ctypes.WinError(ctypes.get_last_error())
200
+ try:
201
+ path = temp / f"checkmarx-report-{secrets.token_hex(16)}"
202
+ attributes = SecurityAttributes(ctypes.sizeof(SecurityAttributes), descriptor, False)
203
+ if not kernel.CreateDirectoryW(str(path), ctypes.byref(attributes)):
204
+ raise ctypes.WinError(ctypes.get_last_error())
205
+ return path
206
+ finally:
207
+ kernel.LocalFree(descriptor)
208
+
209
+
210
+ def create_capture(source: Path | None) -> Path:
211
+ # gettempdir() probes candidates by writing a file. Check each candidate before
212
+ # trying to create the actual capture directory in Python's platform order.
213
+ cached = tempfile.tempdir
214
+ candidates = [cached] if cached is not None else tempfile._candidate_tempdir_list()
215
+ last_error = None
216
+ for candidate in candidates:
217
+ temp = Path(os.fsdecode(candidate)).absolute()
218
+ if in_source(temp, source):
219
+ raise ValueError(
220
+ "Select a temporary directory outside the source checkout (TMPDIR or TEMP)."
221
+ )
222
+ try:
223
+ return capture_directory(temp)
224
+ except OSError as error:
225
+ if cached is not None:
226
+ raise
227
+ last_error = error
228
+ raise FileNotFoundError(
229
+ f"No usable temporary directory outside the source checkout: {last_error}"
230
+ )
231
+
232
+
233
+ def export_report(args: argparse.Namespace, source: Path | None, work: str, run_vendor) -> Path:
234
+ def fetch(report, env, *command):
235
+ # Only the validated report path goes to stdout; vendor diagnostics go to stderr.
236
+ status = run_vendor(command, cwd=work, env=env, stdin=subprocess.DEVNULL, stdout=sys.stderr)
237
+ if status:
238
+ raise ValueError(f"The Checkmarx tool exited with status {status}.")
239
+ if report.is_symlink() or not report.is_file():
240
+ raise ValueError("The Checkmarx tool did not produce the requested report.")
241
+
242
+ if args.product == "one":
243
+ env = one_environment(source, work)
244
+ report = Path(work, "cx_result.json")
245
+ fetch(
246
+ report,
247
+ env,
248
+ str(args.cx),
249
+ "results",
250
+ "show",
251
+ # Older clients reject this flag instead of authenticating with another profile.
252
+ "--config-file-path",
253
+ env["CX_CONFIG_FILE_PATH"],
254
+ "--scan-id",
255
+ args.scan_id,
256
+ "--report-format",
257
+ "json",
258
+ "--output-path",
259
+ work,
260
+ "--output-name",
261
+ report.stem,
262
+ )
263
+ verify_one(report, args.scan_id)
264
+ return report
265
+
266
+ team = args.team.rstrip("/\\")
267
+ report = Path(work, "checkmarx-results.xml")
268
+ fetch(
269
+ report,
270
+ cxsast_environment(work, args.use_env_credentials),
271
+ str(args.java),
272
+ f"-Djava.io.tmpdir={work}",
273
+ f"-DLOG_PATH={work}",
274
+ "-Dfile.encoding=UTF-8",
275
+ "-jar",
276
+ str(args.jar),
277
+ f"--spring.config.location={args.config.as_uri()}",
278
+ "--logging.config=classpath:logback-spring.xml",
279
+ f"--logging.file.path={work}",
280
+ f"--logging.file.name={Path(work, 'cx-flow.log')}",
281
+ f"--logging.logback.rollingpolicy.file-name-pattern={Path(work, 'cx-flow.%d{yyyy-MM-dd}.%i.gz')}",
282
+ "--project",
283
+ f"--scanId={args.scan_id}",
284
+ f"--cx-team={team}",
285
+ f"--cx-project={args.project}",
286
+ f"--app={args.project}",
287
+ "--bug-tracker=CxXml",
288
+ "--cx-flow.bug-tracker-impl=CxXml",
289
+ "--cx-flow.enabled-vulnerability-scanners=sast",
290
+ "--cx-flow.preserve-project-name=true",
291
+ "--cx-flow.mail.notification=false",
292
+ "--cx-flow.filter-script=",
293
+ "--disable-break-build",
294
+ "--checkmarx.cx-branch=false",
295
+ "--checkmarx.preserve-xml=true",
296
+ f"--cx-xml.data-folder={work}",
297
+ f"--cx-xml.file-name-format={report.name}",
298
+ )
299
+ verify_cxsast(report, str(args.scan_id), args.project, args.team)
300
+ return report
301
+
302
+
303
+ def collect(args: argparse.Namespace, source: Path | None, run_vendor) -> None:
304
+ output = create_capture(source)
305
+ try:
306
+ with tempfile.TemporaryDirectory(dir=output) as work:
307
+ report = export_report(args, source, work, run_vendor)
308
+ report.chmod(0o600)
309
+ saved = report.replace(output / report.name)
310
+ sys.stdout.buffer.write(f"{saved}\n".encode("utf-8"))
311
+ sys.stdout.buffer.flush()
312
+ except BaseException:
313
+ shutil.rmtree(output)
314
+ raise
315
+
316
+
317
+ def main() -> int:
318
+ parser = argparse.ArgumentParser(description=__doc__)
319
+ parser.add_argument("--source-root", type=Path, help="absolute source directory to protect")
320
+ products = parser.add_subparsers(dest="product", required=True)
321
+ one = products.add_parser("one", help="export an existing Checkmarx One scan")
322
+ one.add_argument("scan_id")
323
+ one.add_argument("--cx", required=True)
324
+ cxsast = products.add_parser("cxsast", help="retrieve an existing CxSAST scan with CxFlow")
325
+ cxsast.add_argument("scan_id", type=int)
326
+ cxsast.add_argument("--java", required=True)
327
+ cxsast.add_argument("--jar", required=True)
328
+ cxsast.add_argument("--config", required=True)
329
+ cxsast.add_argument("--team", required=True)
330
+ cxsast.add_argument("--project", required=True)
331
+ cxsast.add_argument(
332
+ "--use-env-credentials",
333
+ action="store_true",
334
+ help="use the Checkmarx credentials selected for this profile's server",
335
+ )
336
+ args = parser.parse_args()
337
+ if args.product == "one":
338
+ if not re.fullmatch(
339
+ r"[0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}", args.scan_id, re.I | re.ASCII
340
+ ):
341
+ parser.error("Select a Checkmarx One scan UUID in hyphenated form.")
342
+ else:
343
+ if args.scan_id <= 0:
344
+ parser.error("Select an existing positive CxSAST scan ID.")
345
+ if not re.search(r"[^\s/\\]", args.team) or not args.project.strip():
346
+ parser.error("Select a nonblank CxSAST team path and project.")
347
+
348
+ pending_signal = None
349
+ defer_termination = False
350
+
351
+ def terminate(signum, _frame):
352
+ nonlocal pending_signal
353
+ if pending_signal is None:
354
+ pending_signal = signum
355
+ if not defer_termination:
356
+ raise SystemExit(128 + signum)
357
+
358
+ def run_vendor(command, **kwargs):
359
+ nonlocal defer_termination
360
+ child = None
361
+ # Popen can have spawned the child before it returns the handle needed for cleanup.
362
+ defer_termination = True
363
+ try:
364
+ child = subprocess.Popen(command, start_new_session=os.name == "posix", **kwargs)
365
+ defer_termination = False
366
+ if pending_signal is not None:
367
+ raise SystemExit(128 + pending_signal)
368
+ return child.wait()
369
+ except BaseException:
370
+ defer_termination = True
371
+ if child is not None:
372
+ if os.name == "posix":
373
+ # Kill any surviving credential helper if the process group still exists.
374
+ with suppress(ProcessLookupError):
375
+ os.killpg(child.pid, signal.SIGKILL)
376
+ else:
377
+ child.kill()
378
+ child.wait()
379
+ raise
380
+ finally:
381
+ defer_termination = False
382
+
383
+ signals = [signal.SIGTERM]
384
+ if signal.getsignal(signal.SIGINT) != signal.SIG_IGN:
385
+ signals.append(signal.SIGINT)
386
+ if os.name == "posix" and signal.getsignal(signal.SIGHUP) != signal.SIG_IGN:
387
+ signals.append(signal.SIGHUP)
388
+ previous = {number: signal.signal(number, terminate) for number in signals}
389
+ try:
390
+ source = source_root(args.source_root)
391
+ if args.product == "one":
392
+ args.cx = installed_launcher(args.cx, source)
393
+ else:
394
+ args.java = installed_launcher(args.java, source)
395
+ args.jar = installed_file(args.jar, source)
396
+ args.config = installed_file(args.config, source)
397
+ check_cxflow_version(args.jar)
398
+ collect(args, source, run_vendor)
399
+ except (ValueError, OSError, expat.ExpatError) as error:
400
+ print(error, file=sys.stderr)
401
+ return 1
402
+ finally:
403
+ for number, handler in previous.items():
404
+ signal.signal(number, handler)
405
+ return 0
406
+
407
+
408
+ if __name__ == "__main__":
409
+ raise SystemExit(main())
@@ -0,0 +1,224 @@
1
+ """Export one AWS Continuum finding and its selected repository's generated patches."""
2
+
3
+ import argparse
4
+ import json
5
+ import os
6
+ import subprocess
7
+ import sys
8
+ from pathlib import Path
9
+
10
+ # Isolated Python does not put the installed script directory on sys.path.
11
+ sys.path.insert(0, str(Path(__file__).resolve().parent))
12
+ from collector_paths import in_source, source_root # noqa: E402
13
+
14
+ # Credential helpers may use any interpreter. Forward AWS and host settings
15
+ # explicitly so a helper cannot inherit language-specific startup hooks.
16
+ ACCOUNT_DIRECTORIES = {"HOME", "USERPROFILE", "APPDATA", "LOCALAPPDATA", "XDG_CONFIG_HOME"}
17
+ HOST_SETTINGS = ACCOUNT_DIRECTORIES | {
18
+ "ALL_PROXY",
19
+ "CURL_CA_BUNDLE",
20
+ "HOMEDRIVE",
21
+ "HOMEPATH",
22
+ "HTTP_PROXY",
23
+ "HTTPS_PROXY",
24
+ "LANG",
25
+ "LANGUAGE",
26
+ "LOGNAME",
27
+ "NO_PROXY",
28
+ "REQUESTS_CA_BUNDLE",
29
+ "SSH_AUTH_SOCK",
30
+ "SSL_CERT_DIR",
31
+ "SSL_CERT_FILE",
32
+ "SYSTEMROOT",
33
+ "TEMP",
34
+ "TMP",
35
+ "TMPDIR",
36
+ "TZ",
37
+ "USER",
38
+ "USERNAME",
39
+ "WINDIR",
40
+ }
41
+
42
+
43
+ def checked_model_path(path: Path, source: Path | None, levels: int) -> None:
44
+ if in_source(path, source) or (source is not None and source.is_relative_to(path.resolve())):
45
+ raise ValueError(f"Use an AWS model path separate from the selected checkout: {path}")
46
+ if levels and path.is_dir():
47
+ # AWS reads global models and service/<version>/*.json[.gz]. Version
48
+ # names come from the filesystem; even a new version can override AWS.
49
+ for child in path.iterdir():
50
+ if child.name.lower().endswith((".json", ".json.gz")) or (
51
+ levels > 1 and child.is_dir()
52
+ ):
53
+ checked_model_path(child, source, levels - 1)
54
+
55
+
56
+ def pinned_setting(name: str, path: Path) -> str:
57
+ # Preserve paths expanded from parent-only variables; the CLI expands the
58
+ # forwarded value again and splits its model path on the platform separator.
59
+ value = str(path)
60
+ if os.path.expandvars(value) != value or (name == "AWS_DATA_PATH" and os.pathsep in value):
61
+ raise ValueError(f"Use a fully expanded file path for {name}.")
62
+ return value
63
+
64
+
65
+ def aws_environment(source: Path | None, cwd: Path, directories: list[str]) -> dict[str, str]:
66
+ env = {
67
+ name: value
68
+ for name, value in os.environ.items()
69
+ if name.startswith(("AWS_", "LC_")) or name.upper() in HOST_SETTINGS
70
+ }
71
+ env["PATH"] = os.pathsep.join(directories)
72
+ for name in ACCOUNT_DIRECTORIES:
73
+ if env.get(name) and in_source(cwd / env[name], source):
74
+ raise ValueError(f"Use an account {name} directory outside the selected checkout.")
75
+
76
+ # AWS can run credential_process from either profile file and shell commands
77
+ # from its per-account alias file. Check the paths AWS will actually read.
78
+ for name, default in (
79
+ ("AWS_CONFIG_FILE", "~/.aws/config"),
80
+ ("AWS_SHARED_CREDENTIALS_FILE", "~/.aws/credentials"),
81
+ ):
82
+ filename = os.path.expanduser(os.path.expandvars(env.get(name, default)))
83
+ path = cwd / filename
84
+ if in_source(path, source):
85
+ raise ValueError(f"Use an {name} file outside the selected checkout.")
86
+ if name in env:
87
+ env[name] = pinned_setting(name, path)
88
+ if in_source(cwd / os.path.expanduser("~/.aws/cli/alias"), source):
89
+ raise ValueError("Use an AWS CLI alias file outside the selected checkout.")
90
+ checked_model_path(cwd / os.path.expanduser("~/.aws/models"), source, 3)
91
+ if "AWS_DATA_PATH" in env:
92
+ paths = []
93
+ for entry in env["AWS_DATA_PATH"].split(os.pathsep):
94
+ directory = os.path.expanduser(os.path.expandvars(entry))
95
+ if directory:
96
+ path = cwd / directory
97
+ checked_model_path(path, source, 3)
98
+ paths.append(pinned_setting("AWS_DATA_PATH", path))
99
+ env["AWS_DATA_PATH"] = os.pathsep.join(paths)
100
+ return env
101
+
102
+
103
+ def installed_aws(target: Path) -> tuple[Path, dict[str, str], Path]:
104
+ source = source_root(target)
105
+ name = "aws.exe" if os.name == "nt" else "aws"
106
+ executable = None
107
+ directories = []
108
+ for entry in os.get_exec_path():
109
+ if os.name == "nt" and entry.startswith('"') and entry.endswith('"'):
110
+ entry = entry[1:-1]
111
+ directory = Path(entry)
112
+ if not directory.is_absolute():
113
+ continue
114
+ try:
115
+ # Also exclude a host directory whose aws links through the checkout.
116
+ if in_source(directory / name, source):
117
+ continue
118
+ directory = directory.resolve(strict=True)
119
+ if not directory.is_dir():
120
+ continue
121
+ candidate = directory / name
122
+ if executable is None and candidate.is_file() and os.access(candidate, os.X_OK):
123
+ resolved = candidate.resolve(strict=True)
124
+ if os.name == "nt" and resolved.suffix.lower() != ".exe":
125
+ continue
126
+ executable = resolved
127
+ directories.append(str(directory))
128
+ except OSError:
129
+ continue
130
+ if executable is None:
131
+ raise ValueError("Could not find an installed AWS CLI outside the selected checkout.")
132
+
133
+ # Credential helpers inherit the same lookup boundary, including on Windows
134
+ # where executable searches can also use the current directory.
135
+ cwd = executable.parent if in_source(Path.cwd(), source) else Path.cwd()
136
+ return executable, aws_environment(source, cwd, directories), cwd
137
+
138
+
139
+ def collect(
140
+ environment_id: str, finding_id: str, repository_name: str | None, target: Path
141
+ ) -> dict:
142
+ executable, child_env, cwd = installed_aws(target)
143
+
144
+ def aws(operation: str, *arguments: str) -> dict:
145
+ return json.loads(
146
+ subprocess.check_output(
147
+ [
148
+ str(executable),
149
+ "continuum",
150
+ operation,
151
+ *arguments,
152
+ "--output",
153
+ "json",
154
+ "--no-cli-pager",
155
+ ],
156
+ env=child_env,
157
+ cwd=cwd,
158
+ )
159
+ )
160
+
161
+ environment = ["--environment-id", environment_id]
162
+ finding = aws("get-code-finding", *environment, "--finding-id", finding_id)
163
+ issue_id = finding.get("createdIssueId") or finding.get("duplicateOfIssueId")
164
+ if not issue_id:
165
+ return finding
166
+
167
+ issue = [*environment, "--issue-id", issue_id]
168
+ # With JSON output the AWS CLI combines all pages into one items array.
169
+ artifacts = aws("list-code-issue-artifacts", *issue, "--artifact-type", "PATCH")
170
+ patches = []
171
+ for artifact_id in sorted(item["artifactId"] for item in artifacts["items"]):
172
+ artifact = aws("get-code-issue-artifact", *issue, "--artifact-id", artifact_id)
173
+ body = artifact["body"].get("patch")
174
+ if body is None:
175
+ raise ValueError(f"Continuum artifact {artifact_id} has no projected patch body.")
176
+ if repository_name is not None and body.get("repositoryName") != repository_name:
177
+ if not body.get("repositoryName"):
178
+ print(
179
+ f"Skipped Continuum patch {artifact_id}: AWS did not identify its repository.",
180
+ file=sys.stderr,
181
+ )
182
+ continue
183
+ patch = {key: body[key] for key in ("patch", "patchSha256", "sizeBytes")}
184
+ for key in ("format", "repositoryName"):
185
+ if key in body:
186
+ patch[key] = body[key]
187
+ patches.append({"artifactId": artifact_id, **patch})
188
+
189
+ return {"finding": finding, "patches": patches} if patches else finding
190
+
191
+
192
+ def main() -> int:
193
+ parser = argparse.ArgumentParser(description=__doc__)
194
+ parser.add_argument(
195
+ "--source-root",
196
+ type=Path,
197
+ required=True,
198
+ help="Absolute path to the selected local checkout to exclude from executable lookup.",
199
+ )
200
+ parser.add_argument("--environment-id", required=True)
201
+ parser.add_argument("--finding-id", required=True)
202
+ scope = parser.add_mutually_exclusive_group(required=True)
203
+ scope.add_argument(
204
+ "--single-repository",
205
+ action="store_true",
206
+ help="The selected environment has been verified to contain only this repository.",
207
+ )
208
+ scope.add_argument("--repository-name", help="Exact Continuum build repository name.")
209
+ args = parser.parse_args()
210
+ try:
211
+ report = collect(
212
+ args.environment_id, args.finding_id, args.repository_name, args.source_root
213
+ )
214
+ except subprocess.CalledProcessError as error:
215
+ # The AWS CLI already wrote the diagnostic to stderr.
216
+ return error.returncode
217
+ except (KeyError, OSError, ValueError) as error:
218
+ sys.exit(f"Could not export Continuum finding: {error}")
219
+ print(json.dumps(report))
220
+ return 0
221
+
222
+
223
+ if __name__ == "__main__":
224
+ sys.exit(main())