@openai/codex-security 0.8.2 → 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 (649) hide show
  1. package/README.md +201 -178
  2. package/_bundled_plugin/.app.json +4 -0
  3. package/_bundled_plugin/.mcp.json +6 -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 +51 -14
  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/core-scan.md +14 -5
  26. package/_bundled_plugin/references/default-severity-rubric.md +33 -0
  27. package/_bundled_plugin/references/final-report.md +5 -3
  28. package/_bundled_plugin/references/finding-detail-fields.md +19 -18
  29. package/_bundled_plugin/references/sarif-adapter.md +8 -2
  30. package/_bundled_plugin/references/scan-artifacts.md +21 -12
  31. package/_bundled_plugin/references/scan-contract.md +27 -33
  32. package/_bundled_plugin/references/threat-model.md +1 -0
  33. package/_bundled_plugin/schemas/tools/scan-draft.schema.json +2 -2
  34. package/_bundled_plugin/scripts/check_deep_scan_target.py +97 -0
  35. package/_bundled_plugin/scripts/codex_profile.mjs +7 -1
  36. package/_bundled_plugin/scripts/deep_scan_config.py +20 -1
  37. package/_bundled_plugin/scripts/deep_scan_workbench.py +188 -454
  38. package/_bundled_plugin/scripts/filesystem_identity.py +1 -0
  39. package/_bundled_plugin/scripts/finalize_scan_contract.py +317 -377
  40. package/_bundled_plugin/scripts/finding_preview.py +25 -29
  41. package/_bundled_plugin/scripts/launch_codex_security_mcp +1 -0
  42. package/_bundled_plugin/scripts/legacy_findings.py +148 -0
  43. package/_bundled_plugin/scripts/posix_scan_local_files.py +198 -0
  44. package/_bundled_plugin/scripts/read_codex_session.mjs +21 -0
  45. package/_bundled_plugin/scripts/report_projection.py +167 -178
  46. package/_bundled_plugin/scripts/review_state.py +8 -2
  47. package/_bundled_plugin/scripts/servicenow_avit.py +20 -0
  48. package/_bundled_plugin/scripts/snapshot_sqlite.py +1 -0
  49. package/_bundled_plugin/scripts/threat_model_projection.py +22 -26
  50. package/_bundled_plugin/scripts/validate_scan_contract.py +9 -7
  51. package/_bundled_plugin/scripts/windows_scan_local_files.py +600 -72
  52. package/_bundled_plugin/scripts/workbench/__init__.py +1 -1
  53. package/_bundled_plugin/scripts/workbench/handoff.py +47 -0
  54. package/_bundled_plugin/scripts/workbench/retained_coverage.py +38 -75
  55. package/_bundled_plugin/scripts/workbench/retained_records.py +18 -30
  56. package/_bundled_plugin/scripts/workbench/runtime_toml.py +4 -1
  57. package/_bundled_plugin/scripts/workbench/saved_coverage.py +152 -248
  58. package/_bundled_plugin/scripts/workbench/saved_outputs.py +9 -0
  59. package/_bundled_plugin/scripts/workbench/saved_sources.py +47 -40
  60. package/_bundled_plugin/scripts/workbench/storage.py +71 -7
  61. package/_bundled_plugin/scripts/workbench_cli.py +121 -14
  62. package/_bundled_plugin/scripts/workbench_constants.py +19 -0
  63. package/_bundled_plugin/scripts/workbench_coverage_receipts.py +3 -3
  64. package/_bundled_plugin/scripts/workbench_db.py +550 -492
  65. package/_bundled_plugin/scripts/workbench_feedback.py +8 -7
  66. package/_bundled_plugin/scripts/workbench_finding_index.py +1 -0
  67. package/_bundled_plugin/scripts/workbench_finding_workflows.py +90 -4
  68. package/_bundled_plugin/scripts/workbench_native_indexes.py +29 -33
  69. package/_bundled_plugin/scripts/workbench_progress.py +10 -1
  70. package/_bundled_plugin/scripts/workbench_publication.py +14 -10
  71. package/_bundled_plugin/scripts/workbench_remediation.py +508 -11
  72. package/_bundled_plugin/scripts/workbench_saved_results.py +132 -77
  73. package/_bundled_plugin/scripts/workbench_scan_history.py +139 -80
  74. package/_bundled_plugin/scripts/workbench_scan_start.py +84 -25
  75. package/_bundled_plugin/scripts/workbench_scan_usage.py +666 -117
  76. package/_bundled_plugin/scripts/workbench_schema.py +44 -55
  77. package/_bundled_plugin/scripts/workbench_setup.py +251 -0
  78. package/_bundled_plugin/scripts/workbench_source_excerpt.py +13 -0
  79. package/_bundled_plugin/scripts/workbench_source_scopes.py +33 -23
  80. package/_bundled_plugin/scripts/workbench_target.py +330 -66
  81. package/_bundled_plugin/scripts/workbench_target_state.py +3 -0
  82. package/_bundled_plugin/scripts/workbench_validation.py +44 -12
  83. package/_bundled_plugin/shared/workbench-history-repairs.json +19 -16
  84. package/_bundled_plugin/shared/workbench-migrations.json +53 -0
  85. package/_bundled_plugin/skills/attack-path-analysis/SKILL.md +1 -1
  86. package/_bundled_plugin/skills/attack-path-analysis/references/severity-policy.md +4 -68
  87. package/_bundled_plugin/skills/check-skills/SKILL.md +43 -0
  88. package/_bundled_plugin/skills/check-skills/agents/openai.yaml +4 -0
  89. package/_bundled_plugin/skills/cloud-findings/SKILL.md +6 -4
  90. package/_bundled_plugin/skills/deep-security-scan/SKILL.md +7 -50
  91. package/_bundled_plugin/skills/fix-finding/SKILL.md +19 -2
  92. package/_bundled_plugin/skills/publish-findings/SKILL.md +81 -45
  93. package/_bundled_plugin/skills/publish-findings/references/checkmarx-import.md +37 -0
  94. package/_bundled_plugin/skills/publish-findings/references/wiz-import.md +5 -24
  95. package/_bundled_plugin/skills/publish-findings/scripts/collect_checkmarx.py +464 -0
  96. package/_bundled_plugin/skills/threat-model-visualize/scripts/build_explorer.py +36 -9
  97. package/_bundled_plugin/skills/track-findings/SKILL.md +5 -3
  98. package/_bundled_plugin/skills/triage-finding/references/github-rest-intake.md +22 -68
  99. package/_bundled_plugin/skills/triage-finding/references/ticket-intake.md +12 -6
  100. package/dist/api.d.ts +45 -5
  101. package/dist/api.d.ts.map +1 -1
  102. package/dist/api.js +1144 -411
  103. package/dist/api.js.map +1 -1
  104. package/dist/auth.d.ts.map +1 -1
  105. package/dist/auth.js +10 -7
  106. package/dist/auth.js.map +1 -1
  107. package/dist/bedrock-oss-pricing.d.ts +6 -0
  108. package/dist/bedrock-oss-pricing.d.ts.map +1 -0
  109. package/dist/bedrock-oss-pricing.js +58 -0
  110. package/dist/bedrock-oss-pricing.js.map +1 -0
  111. package/dist/bedrock-pricing.d.ts +15 -0
  112. package/dist/bedrock-pricing.d.ts.map +1 -0
  113. package/dist/bedrock-pricing.js +117 -0
  114. package/dist/bedrock-pricing.js.map +1 -0
  115. package/dist/blackduck-findings.d.ts +8 -0
  116. package/dist/blackduck-findings.d.ts.map +1 -0
  117. package/dist/blackduck-findings.js +320 -0
  118. package/dist/blackduck-findings.js.map +1 -0
  119. package/dist/bulk-scan-discovery.d.ts.map +1 -1
  120. package/dist/bulk-scan-discovery.js +51 -36
  121. package/dist/bulk-scan-discovery.js.map +1 -1
  122. package/dist/checkmarx-evidence.d.ts +19 -0
  123. package/dist/checkmarx-evidence.d.ts.map +1 -0
  124. package/dist/checkmarx-evidence.js +36 -0
  125. package/dist/checkmarx-evidence.js.map +1 -0
  126. package/dist/checkmarx-findings.d.ts +4 -0
  127. package/dist/checkmarx-findings.d.ts.map +1 -0
  128. package/dist/checkmarx-findings.js +27 -0
  129. package/dist/checkmarx-findings.js.map +1 -0
  130. package/dist/checkmarx-one.d.ts +4 -0
  131. package/dist/checkmarx-one.d.ts.map +1 -0
  132. package/dist/checkmarx-one.js +53 -0
  133. package/dist/checkmarx-one.js.map +1 -0
  134. package/dist/checkmarx-repository.d.ts +12 -0
  135. package/dist/checkmarx-repository.d.ts.map +1 -0
  136. package/dist/checkmarx-repository.js +181 -0
  137. package/dist/checkmarx-repository.js.map +1 -0
  138. package/dist/checkmarx-xml.d.ts +12 -0
  139. package/dist/checkmarx-xml.d.ts.map +1 -0
  140. package/dist/checkmarx-xml.js +196 -0
  141. package/dist/checkmarx-xml.js.map +1 -0
  142. package/dist/classify-severity-records.d.ts +6 -9
  143. package/dist/classify-severity-records.d.ts.map +1 -1
  144. package/dist/classify-severity-records.js +9 -21
  145. package/dist/classify-severity-records.js.map +1 -1
  146. package/dist/classify-severity.d.ts +4 -1
  147. package/dist/classify-severity.d.ts.map +1 -1
  148. package/dist/classify-severity.js +30 -13
  149. package/dist/classify-severity.js.map +1 -1
  150. package/dist/cli.d.ts +14 -5
  151. package/dist/cli.d.ts.map +1 -1
  152. package/dist/cli.js +2112 -1266
  153. package/dist/cli.js.map +1 -1
  154. package/dist/cloud-publish.js +2 -2
  155. package/dist/cloud-publish.js.map +1 -1
  156. package/dist/codex-prompt.d.ts +2 -0
  157. package/dist/codex-prompt.d.ts.map +1 -1
  158. package/dist/codex-prompt.js +6 -0
  159. package/dist/codex-prompt.js.map +1 -1
  160. package/dist/component-scan.d.ts +16 -3
  161. package/dist/component-scan.d.ts.map +1 -1
  162. package/dist/component-scan.js +32 -6
  163. package/dist/component-scan.js.map +1 -1
  164. package/dist/config.d.ts +2 -1
  165. package/dist/config.d.ts.map +1 -1
  166. package/dist/config.js +221 -65
  167. package/dist/config.js.map +1 -1
  168. package/dist/continuum-findings.d.ts +7 -0
  169. package/dist/continuum-findings.d.ts.map +1 -0
  170. package/dist/continuum-findings.js +225 -0
  171. package/dist/continuum-findings.js.map +1 -0
  172. package/dist/contract-values.d.ts +30 -0
  173. package/dist/contract-values.d.ts.map +1 -0
  174. package/dist/contract-values.js +78 -0
  175. package/dist/contract-values.js.map +1 -0
  176. package/dist/contract.d.ts +2 -20
  177. package/dist/contract.d.ts.map +1 -1
  178. package/dist/contract.js +58 -669
  179. package/dist/contract.js.map +1 -1
  180. package/dist/cost-model.d.ts +13 -1
  181. package/dist/cost-model.d.ts.map +1 -1
  182. package/dist/cost-model.js +66 -115
  183. package/dist/cost-model.js.map +1 -1
  184. package/dist/cost.d.ts +61 -4
  185. package/dist/cost.d.ts.map +1 -1
  186. package/dist/cost.js +2560 -100
  187. package/dist/cost.js.map +1 -1
  188. package/dist/custom-publish.d.ts +4 -0
  189. package/dist/custom-publish.d.ts.map +1 -1
  190. package/dist/custom-publish.js +40 -3
  191. package/dist/custom-publish.js.map +1 -1
  192. package/dist/custom-validation-prompt.d.ts +1 -1
  193. package/dist/custom-validation-prompt.d.ts.map +1 -1
  194. package/dist/custom-validation-prompt.js +5 -0
  195. package/dist/custom-validation-prompt.js.map +1 -1
  196. package/dist/custom-validation.d.ts +2 -0
  197. package/dist/custom-validation.d.ts.map +1 -1
  198. package/dist/custom-validation.js +4 -0
  199. package/dist/custom-validation.js.map +1 -1
  200. package/dist/deduplication/deduplication-prompts.d.ts +4 -4
  201. package/dist/deduplication/deduplication-prompts.d.ts.map +1 -1
  202. package/dist/deduplication/deduplication-prompts.js +2 -2
  203. package/dist/deduplication/deduplication-prompts.js.map +1 -1
  204. package/dist/deduplication/deduplication-reviewer.d.ts +14 -11
  205. package/dist/deduplication/deduplication-reviewer.d.ts.map +1 -1
  206. package/dist/deduplication/deduplication-reviewer.js +11 -4
  207. package/dist/deduplication/deduplication-reviewer.js.map +1 -1
  208. package/dist/deduplication/deduplication.js.map +1 -1
  209. package/dist/deduplication/finding-schema.d.ts +19 -1
  210. package/dist/deduplication/finding-schema.d.ts.map +1 -1
  211. package/dist/deduplication/finding-schema.js +25 -0
  212. package/dist/deduplication/finding-schema.js.map +1 -1
  213. package/dist/deduplication/local.d.ts +2 -2
  214. package/dist/deduplication/local.d.ts.map +1 -1
  215. package/dist/deduplication/local.js +5 -10
  216. package/dist/deduplication/local.js.map +1 -1
  217. package/dist/deduplication/records.d.ts +8 -2
  218. package/dist/deduplication/records.d.ts.map +1 -1
  219. package/dist/deduplication/records.js +36 -8
  220. package/dist/deduplication/records.js.map +1 -1
  221. package/dist/deduplication/refusal.d.ts.map +1 -1
  222. package/dist/deduplication/refusal.js +25 -5
  223. package/dist/deduplication/refusal.js.map +1 -1
  224. package/dist/deduplication/scan.d.ts +3 -0
  225. package/dist/deduplication/scan.d.ts.map +1 -1
  226. package/dist/deduplication/scan.js +1 -1
  227. package/dist/deduplication/scan.js.map +1 -1
  228. package/dist/deep-config.d.ts +0 -1
  229. package/dist/deep-config.d.ts.map +1 -1
  230. package/dist/deep-config.js +22 -33
  231. package/dist/deep-config.js.map +1 -1
  232. package/dist/deep-scan-defaults.d.ts +2 -0
  233. package/dist/deep-scan-defaults.d.ts.map +1 -1
  234. package/dist/deep-scan-defaults.js +28 -1
  235. package/dist/deep-scan-defaults.js.map +1 -1
  236. package/dist/deep-scan.d.ts +13 -0
  237. package/dist/deep-scan.d.ts.map +1 -1
  238. package/dist/deep-scan.js +262 -7
  239. package/dist/deep-scan.js.map +1 -1
  240. package/dist/default-severity-rubric.d.ts +1 -2
  241. package/dist/default-severity-rubric.d.ts.map +1 -1
  242. package/dist/default-severity-rubric.js +2 -66
  243. package/dist/default-severity-rubric.js.map +1 -1
  244. package/dist/endor-findings.d.ts +3 -1
  245. package/dist/endor-findings.d.ts.map +1 -1
  246. package/dist/endor-findings.js +108 -80
  247. package/dist/endor-findings.js.map +1 -1
  248. package/dist/errors.d.ts +1 -1
  249. package/dist/errors.d.ts.map +1 -1
  250. package/dist/errors.js +9 -2
  251. package/dist/errors.js.map +1 -1
  252. package/dist/external-findings-import.d.ts +5 -3
  253. package/dist/external-findings-import.d.ts.map +1 -1
  254. package/dist/external-findings-import.js +11 -16
  255. package/dist/external-findings-import.js.map +1 -1
  256. package/dist/external-findings-local.d.ts +15 -4
  257. package/dist/external-findings-local.d.ts.map +1 -1
  258. package/dist/external-findings-local.js +619 -225
  259. package/dist/external-findings-local.js.map +1 -1
  260. package/dist/external-findings-publish.d.ts +20 -6
  261. package/dist/external-findings-publish.d.ts.map +1 -1
  262. package/dist/external-findings-publish.js +2356 -308
  263. package/dist/external-findings-publish.js.map +1 -1
  264. package/dist/external-findings-read.d.ts +28 -2
  265. package/dist/external-findings-read.d.ts.map +1 -1
  266. package/dist/external-findings-read.js +174 -81
  267. package/dist/external-findings-read.js.map +1 -1
  268. package/dist/external-findings.d.ts +17 -3
  269. package/dist/external-findings.d.ts.map +1 -1
  270. package/dist/external-findings.js +153 -1
  271. package/dist/external-findings.js.map +1 -1
  272. package/dist/external-import-contract.d.ts +33 -1
  273. package/dist/external-import-contract.d.ts.map +1 -1
  274. package/dist/external-import-contract.js +335 -51
  275. package/dist/external-import-contract.js.map +1 -1
  276. package/dist/external-import-models.d.ts +1 -1
  277. package/dist/external-import-models.d.ts.map +1 -1
  278. package/dist/external-import-models.js.map +1 -1
  279. package/dist/feedback.d.ts.map +1 -1
  280. package/dist/feedback.js +5 -4
  281. package/dist/feedback.js.map +1 -1
  282. package/dist/finding-prompt.d.ts +5 -0
  283. package/dist/finding-prompt.d.ts.map +1 -0
  284. package/dist/finding-prompt.js +32 -0
  285. package/dist/finding-prompt.js.map +1 -0
  286. package/dist/finding-retrieval.d.ts +3 -3
  287. package/dist/finding-retrieval.d.ts.map +1 -1
  288. package/dist/finding-retrieval.js.map +1 -1
  289. package/dist/finding-workflow.d.ts +6 -1
  290. package/dist/finding-workflow.d.ts.map +1 -1
  291. package/dist/finding-workflow.js +2 -2
  292. package/dist/finding-workflow.js.map +1 -1
  293. package/dist/findings-client.d.ts +1 -0
  294. package/dist/findings-client.d.ts.map +1 -1
  295. package/dist/findings-client.js +27 -3
  296. package/dist/findings-client.js.map +1 -1
  297. package/dist/git-remote.d.ts +4 -0
  298. package/dist/git-remote.d.ts.map +1 -1
  299. package/dist/git-remote.js +20 -0
  300. package/dist/git-remote.js.map +1 -1
  301. package/dist/github-advisories.d.ts +3 -12
  302. package/dist/github-advisories.d.ts.map +1 -1
  303. package/dist/github-advisories.js +9 -31
  304. package/dist/github-advisories.js.map +1 -1
  305. package/dist/github-dependabot-findings.d.ts.map +1 -1
  306. package/dist/github-dependabot-findings.js +22 -20
  307. package/dist/github-dependabot-findings.js.map +1 -1
  308. package/dist/github-findings.d.ts +4 -1
  309. package/dist/github-findings.d.ts.map +1 -1
  310. package/dist/github-findings.js +392 -79
  311. package/dist/github-findings.js.map +1 -1
  312. package/dist/github.d.ts +17 -7
  313. package/dist/github.d.ts.map +1 -1
  314. package/dist/github.js +43 -30
  315. package/dist/github.js.map +1 -1
  316. package/dist/host-protocol.d.ts +2 -2
  317. package/dist/host-protocol.d.ts.map +1 -1
  318. package/dist/host-protocol.js.map +1 -1
  319. package/dist/host-records-protocol.d.ts +10 -11
  320. package/dist/host-records-protocol.d.ts.map +1 -1
  321. package/dist/host-records-protocol.js +69 -9
  322. package/dist/host-records-protocol.js.map +1 -1
  323. package/dist/hosted-git-remotes.d.ts +5 -0
  324. package/dist/hosted-git-remotes.d.ts.map +1 -0
  325. package/dist/hosted-git-remotes.js +285 -0
  326. package/dist/hosted-git-remotes.js.map +1 -0
  327. package/dist/hosted-git-repository.d.ts +28 -0
  328. package/dist/hosted-git-repository.d.ts.map +1 -0
  329. package/dist/hosted-git-repository.js +222 -0
  330. package/dist/hosted-git-repository.js.map +1 -0
  331. package/dist/hosted-scan-protocol.js +2 -2
  332. package/dist/hosted-scan-protocol.js.map +1 -1
  333. package/dist/hosted-scan.d.ts +15 -0
  334. package/dist/hosted-scan.d.ts.map +1 -1
  335. package/dist/hosted-scan.js +71 -44
  336. package/dist/hosted-scan.js.map +1 -1
  337. package/dist/hosted-scanner-http.d.ts +21 -0
  338. package/dist/hosted-scanner-http.d.ts.map +1 -0
  339. package/dist/hosted-scanner-http.js +204 -0
  340. package/dist/hosted-scanner-http.js.map +1 -0
  341. package/dist/hosted-scanner-v1.d.ts +6 -0
  342. package/dist/hosted-scanner-v1.d.ts.map +1 -0
  343. package/dist/hosted-scanner-v1.js +60 -0
  344. package/dist/hosted-scanner-v1.js.map +1 -0
  345. package/dist/import-scan.d.ts.map +1 -1
  346. package/dist/import-scan.js +3 -0
  347. package/dist/import-scan.js.map +1 -1
  348. package/dist/index.d.ts +24 -6
  349. package/dist/index.d.ts.map +1 -1
  350. package/dist/index.js +15 -1
  351. package/dist/index.js.map +1 -1
  352. package/dist/inspector-findings.d.ts.map +1 -1
  353. package/dist/inspector-findings.js +58 -81
  354. package/dist/inspector-findings.js.map +1 -1
  355. package/dist/knowledge-base.d.ts.map +1 -1
  356. package/dist/knowledge-base.js +86 -10
  357. package/dist/knowledge-base.js.map +1 -1
  358. package/dist/local-git-metadata.d.ts +5 -0
  359. package/dist/local-git-metadata.d.ts.map +1 -0
  360. package/dist/local-git-metadata.js +130 -0
  361. package/dist/local-git-metadata.js.map +1 -0
  362. package/dist/multiscan.d.ts +6 -4
  363. package/dist/multiscan.d.ts.map +1 -1
  364. package/dist/multiscan.js +160 -77
  365. package/dist/multiscan.js.map +1 -1
  366. package/dist/native-json-findings.d.ts +2 -1
  367. package/dist/native-json-findings.d.ts.map +1 -1
  368. package/dist/native-json-findings.js +12 -2
  369. package/dist/native-json-findings.js.map +1 -1
  370. package/dist/opengrep-findings.d.ts +1 -0
  371. package/dist/opengrep-findings.d.ts.map +1 -1
  372. package/dist/opengrep-findings.js +49 -31
  373. package/dist/opengrep-findings.js.map +1 -1
  374. package/dist/operation-telemetry.d.ts +104 -0
  375. package/dist/operation-telemetry.d.ts.map +1 -0
  376. package/dist/operation-telemetry.js +293 -0
  377. package/dist/operation-telemetry.js.map +1 -0
  378. package/dist/patch-tui.d.ts.map +1 -1
  379. package/dist/patch-tui.js +90 -35
  380. package/dist/patch-tui.js.map +1 -1
  381. package/dist/plugin-python-probe.d.ts +4 -0
  382. package/dist/plugin-python-probe.d.ts.map +1 -0
  383. package/dist/plugin-python-probe.js +10 -0
  384. package/dist/plugin-python-probe.js.map +1 -0
  385. package/dist/private-finding-import.d.ts +341 -0
  386. package/dist/private-finding-import.d.ts.map +1 -0
  387. package/dist/private-finding-import.js +411 -0
  388. package/dist/private-finding-import.js.map +1 -0
  389. package/dist/project-config.d.ts.map +1 -1
  390. package/dist/project-config.js +2 -2
  391. package/dist/project-config.js.map +1 -1
  392. package/dist/provider-profile.d.ts +11 -3
  393. package/dist/provider-profile.d.ts.map +1 -1
  394. package/dist/provider-profile.js +80 -11
  395. package/dist/provider-profile.js.map +1 -1
  396. package/dist/publication-telemetry.d.ts +45 -0
  397. package/dist/publication-telemetry.d.ts.map +1 -0
  398. package/dist/publication-telemetry.js +50 -0
  399. package/dist/publication-telemetry.js.map +1 -0
  400. package/dist/publication.js +7 -1
  401. package/dist/publication.js.map +1 -1
  402. package/dist/publish.d.ts +4 -0
  403. package/dist/publish.d.ts.map +1 -1
  404. package/dist/publish.js +42 -2
  405. package/dist/publish.js.map +1 -1
  406. package/dist/reader-selection.d.ts +15 -0
  407. package/dist/reader-selection.d.ts.map +1 -0
  408. package/dist/reader-selection.js +89 -0
  409. package/dist/reader-selection.js.map +1 -0
  410. package/dist/record.d.ts +6 -1
  411. package/dist/record.d.ts.map +1 -1
  412. package/dist/record.js +53 -2
  413. package/dist/record.js.map +1 -1
  414. package/dist/remediation.d.ts +3 -1
  415. package/dist/remediation.d.ts.map +1 -1
  416. package/dist/remediation.js +28 -2
  417. package/dist/remediation.js.map +1 -1
  418. package/dist/request-metadata.d.ts +3 -0
  419. package/dist/request-metadata.d.ts.map +1 -1
  420. package/dist/request-metadata.js +9 -0
  421. package/dist/request-metadata.js.map +1 -1
  422. package/dist/result.d.ts +6 -0
  423. package/dist/result.d.ts.map +1 -1
  424. package/dist/result.js +3 -1
  425. package/dist/result.js.map +1 -1
  426. package/dist/retry-windows-rename.d.ts +8 -0
  427. package/dist/retry-windows-rename.d.ts.map +1 -0
  428. package/dist/retry-windows-rename.js +24 -0
  429. package/dist/retry-windows-rename.js.map +1 -0
  430. package/dist/runtime.d.ts +22 -1
  431. package/dist/runtime.d.ts.map +1 -1
  432. package/dist/runtime.js +408 -162
  433. package/dist/runtime.js.map +1 -1
  434. package/dist/saved-scan-bootstrap.d.ts +1 -0
  435. package/dist/saved-scan-bootstrap.d.ts.map +1 -1
  436. package/dist/saved-scan-bootstrap.js +18 -15
  437. package/dist/saved-scan-bootstrap.js.map +1 -1
  438. package/dist/scan-activity.d.ts.map +1 -1
  439. package/dist/scan-activity.js +172 -64
  440. package/dist/scan-activity.js.map +1 -1
  441. package/dist/scan-comparison.d.ts +10 -5
  442. package/dist/scan-comparison.d.ts.map +1 -1
  443. package/dist/scan-comparison.js +68 -25
  444. package/dist/scan-comparison.js.map +1 -1
  445. package/dist/scan-dashboard.d.ts +7 -6
  446. package/dist/scan-dashboard.d.ts.map +1 -1
  447. package/dist/scan-dashboard.js +91 -79
  448. package/dist/scan-dashboard.js.map +1 -1
  449. package/dist/scan-executor.d.ts +12 -1
  450. package/dist/scan-executor.d.ts.map +1 -1
  451. package/dist/scan-executor.js +22 -2
  452. package/dist/scan-executor.js.map +1 -1
  453. package/dist/scan-history-renderer.d.ts.map +1 -1
  454. package/dist/scan-history-renderer.js +31 -28
  455. package/dist/scan-history-renderer.js.map +1 -1
  456. package/dist/scan-logs.d.ts +12 -0
  457. package/dist/scan-logs.d.ts.map +1 -1
  458. package/dist/scan-logs.js +106 -77
  459. package/dist/scan-logs.js.map +1 -1
  460. package/dist/scan-measurement.d.ts +26 -0
  461. package/dist/scan-measurement.d.ts.map +1 -0
  462. package/dist/scan-measurement.js +77 -0
  463. package/dist/scan-measurement.js.map +1 -0
  464. package/dist/scan-progress.d.ts +1 -0
  465. package/dist/scan-progress.d.ts.map +1 -1
  466. package/dist/scan-progress.js +3 -0
  467. package/dist/scan-progress.js.map +1 -1
  468. package/dist/scan-sessions.d.ts.map +1 -1
  469. package/dist/scan-sessions.js +4 -1
  470. package/dist/scan-sessions.js.map +1 -1
  471. package/dist/scan-settings.d.ts +1 -1
  472. package/dist/scan-settings.d.ts.map +1 -1
  473. package/dist/scan-settings.js +1 -24
  474. package/dist/scan-settings.js.map +1 -1
  475. package/dist/scanner-import.d.ts +64 -6
  476. package/dist/scanner-import.d.ts.map +1 -1
  477. package/dist/scanner-import.js +406 -48
  478. package/dist/scanner-import.js.map +1 -1
  479. package/dist/scanner-repository-url.d.ts +17 -0
  480. package/dist/scanner-repository-url.d.ts.map +1 -0
  481. package/dist/scanner-repository-url.js +71 -0
  482. package/dist/scanner-repository-url.js.map +1 -0
  483. package/dist/security-policy.d.ts +1 -1
  484. package/dist/security-policy.d.ts.map +1 -1
  485. package/dist/security-policy.js.map +1 -1
  486. package/dist/semgrep-findings.d.ts +6 -3
  487. package/dist/semgrep-findings.d.ts.map +1 -1
  488. package/dist/semgrep-findings.js +124 -88
  489. package/dist/semgrep-findings.js.map +1 -1
  490. package/dist/semgrep-guardian-findings.d.ts +38 -0
  491. package/dist/semgrep-guardian-findings.d.ts.map +1 -0
  492. package/dist/semgrep-guardian-findings.js +165 -0
  493. package/dist/semgrep-guardian-findings.js.map +1 -0
  494. package/dist/semgrep-platform-collector.d.ts +26 -0
  495. package/dist/semgrep-platform-collector.d.ts.map +1 -0
  496. package/dist/semgrep-platform-collector.js +108 -0
  497. package/dist/semgrep-platform-collector.js.map +1 -0
  498. package/dist/semgrep-platform-findings.d.ts +213 -0
  499. package/dist/semgrep-platform-findings.d.ts.map +1 -0
  500. package/dist/semgrep-platform-findings.js +1078 -0
  501. package/dist/semgrep-platform-findings.js.map +1 -0
  502. package/dist/semgrep-platform-v1.d.ts +6 -0
  503. package/dist/semgrep-platform-v1.d.ts.map +1 -0
  504. package/dist/semgrep-platform-v1.js +83 -0
  505. package/dist/semgrep-platform-v1.js.map +1 -0
  506. package/dist/server/api.d.ts +1 -1
  507. package/dist/server/api.d.ts.map +1 -1
  508. package/dist/server/api.js.map +1 -1
  509. package/dist/server/embedding-tokenizer.cdx.json +33 -0
  510. package/dist/server/embedding-tokenizer.d.ts +2 -0
  511. package/dist/server/embedding-tokenizer.d.ts.map +1 -0
  512. package/dist/server/embedding-tokenizer.js +322 -0
  513. package/dist/server/embedding-tokenizer.js.map +6 -0
  514. package/dist/server/embeddings.d.ts +16 -2
  515. package/dist/server/embeddings.d.ts.map +1 -1
  516. package/dist/server/embeddings.js +35 -5
  517. package/dist/server/embeddings.js.map +1 -1
  518. package/dist/session-lines.d.ts +5 -0
  519. package/dist/session-lines.d.ts.map +1 -0
  520. package/dist/session-lines.js +60 -0
  521. package/dist/session-lines.js.map +1 -0
  522. package/dist/severity-review.d.ts +3 -1
  523. package/dist/severity-review.d.ts.map +1 -1
  524. package/dist/severity-review.js +3 -2
  525. package/dist/severity-review.js.map +1 -1
  526. package/dist/severity-rubric.d.ts +20 -0
  527. package/dist/severity-rubric.d.ts.map +1 -0
  528. package/dist/severity-rubric.js +73 -0
  529. package/dist/severity-rubric.js.map +1 -0
  530. package/dist/severity-store.js +15 -5
  531. package/dist/severity-store.js.map +1 -1
  532. package/dist/skill-authentication.d.ts +1 -0
  533. package/dist/skill-authentication.d.ts.map +1 -1
  534. package/dist/skill-authentication.js +1 -0
  535. package/dist/skill-authentication.js.map +1 -1
  536. package/dist/snyk-findings.d.ts +7 -2
  537. package/dist/snyk-findings.d.ts.map +1 -1
  538. package/dist/snyk-findings.js +108 -84
  539. package/dist/snyk-findings.js.map +1 -1
  540. package/dist/snyk-rest-findings.d.ts +76 -0
  541. package/dist/snyk-rest-findings.d.ts.map +1 -0
  542. package/dist/snyk-rest-findings.js +1051 -0
  543. package/dist/snyk-rest-findings.js.map +1 -0
  544. package/dist/snyk-rest-v1.d.ts +28 -0
  545. package/dist/snyk-rest-v1.d.ts.map +1 -0
  546. package/dist/snyk-rest-v1.js +132 -0
  547. package/dist/snyk-rest-v1.js.map +1 -0
  548. package/dist/snyk-token-origin.d.ts +4 -0
  549. package/dist/snyk-token-origin.d.ts.map +1 -0
  550. package/dist/snyk-token-origin.js +82 -0
  551. package/dist/snyk-token-origin.js.map +1 -0
  552. package/dist/sonar-collector.d.ts +16 -0
  553. package/dist/sonar-collector.d.ts.map +1 -0
  554. package/dist/sonar-collector.js +380 -0
  555. package/dist/sonar-collector.js.map +1 -0
  556. package/dist/sonar-findings.d.ts +49 -0
  557. package/dist/sonar-findings.d.ts.map +1 -0
  558. package/dist/sonar-findings.js +288 -0
  559. package/dist/sonar-findings.js.map +1 -0
  560. package/dist/sonar-import.d.ts +111 -0
  561. package/dist/sonar-import.d.ts.map +1 -0
  562. package/dist/sonar-import.js +277 -0
  563. package/dist/sonar-import.js.map +1 -0
  564. package/dist/suggest-owners.d.ts.map +1 -1
  565. package/dist/suggest-owners.js +2 -1
  566. package/dist/suggest-owners.js.map +1 -1
  567. package/dist/target-drift.d.ts +9 -0
  568. package/dist/target-drift.d.ts.map +1 -0
  569. package/dist/target-drift.js +27 -0
  570. package/dist/target-drift.js.map +1 -0
  571. package/dist/targets.d.ts +5 -0
  572. package/dist/targets.d.ts.map +1 -1
  573. package/dist/targets.js +73 -31
  574. package/dist/targets.js.map +1 -1
  575. package/dist/tenable-findings.d.ts +9 -0
  576. package/dist/tenable-findings.d.ts.map +1 -0
  577. package/dist/tenable-findings.js +122 -0
  578. package/dist/tenable-findings.js.map +1 -0
  579. package/dist/terminal-columns.d.ts +4 -0
  580. package/dist/terminal-columns.d.ts.map +1 -0
  581. package/dist/terminal-columns.js +19 -0
  582. package/dist/terminal-columns.js.map +1 -0
  583. package/dist/terminal-stream.d.ts +13 -0
  584. package/dist/terminal-stream.d.ts.map +1 -0
  585. package/dist/terminal-stream.js +35 -0
  586. package/dist/terminal-stream.js.map +1 -0
  587. package/dist/trivy-findings.d.ts +19 -0
  588. package/dist/trivy-findings.d.ts.map +1 -0
  589. package/dist/trivy-findings.js +435 -0
  590. package/dist/trivy-findings.js.map +1 -0
  591. package/dist/trivy-import.d.ts +19 -0
  592. package/dist/trivy-import.d.ts.map +1 -0
  593. package/dist/trivy-import.js +151 -0
  594. package/dist/trivy-import.js.map +1 -0
  595. package/dist/validation-records.d.ts +0 -3
  596. package/dist/validation-records.d.ts.map +1 -1
  597. package/dist/validation-records.js +1 -17
  598. package/dist/validation-records.js.map +1 -1
  599. package/dist/veracode-findings.d.ts +9 -0
  600. package/dist/veracode-findings.d.ts.map +1 -0
  601. package/dist/veracode-findings.js +409 -0
  602. package/dist/veracode-findings.js.map +1 -0
  603. package/dist/vertex-pricing.d.ts +8 -0
  604. package/dist/vertex-pricing.d.ts.map +1 -0
  605. package/dist/vertex-pricing.js +20 -0
  606. package/dist/vertex-pricing.js.map +1 -0
  607. package/dist/windows-path.d.ts +1 -0
  608. package/dist/windows-path.d.ts.map +1 -1
  609. package/dist/windows-path.js +27 -1
  610. package/dist/windows-path.js.map +1 -1
  611. package/dist/wiz-csv.d.ts +2 -2
  612. package/dist/wiz-csv.d.ts.map +1 -1
  613. package/dist/wiz-csv.js +1 -3
  614. package/dist/wiz-csv.js.map +1 -1
  615. package/dist/wiz-findings.d.ts +14 -2
  616. package/dist/wiz-findings.d.ts.map +1 -1
  617. package/dist/wiz-findings.js +143 -50
  618. package/dist/wiz-findings.js.map +1 -1
  619. package/docs/classify-severity-records.md +28 -13
  620. package/docs/cli.md +623 -843
  621. package/docs/dedupe-records.md +54 -24
  622. package/docs/findings-service.md +87 -47
  623. package/docs/hosted-remediation.md +14 -7
  624. package/docs/hosted-scans.md +64 -41
  625. package/docs/telemetry.md +236 -0
  626. package/docs/validate-records.md +78 -44
  627. package/package.json +19 -17
  628. package/schemas/external-findings.schema.json +14 -1
  629. package/schemas/hosted-scan-v2.fixture.json +16 -1
  630. package/_bundled_plugin/mcp/helpers.mjs.br.part-000 +0 -0
  631. package/_bundled_plugin/mcp/helpers.mjs.br.part-001 +0 -0
  632. package/_bundled_plugin/mcp/server.mjs.br.part-000 +0 -0
  633. package/_bundled_plugin/mcp/server.mjs.br.part-001 +0 -0
  634. package/_bundled_plugin/mcp/server.mjs.br.part-002 +0 -0
  635. package/_bundled_plugin/schemas/tools/deep-reducer.schema.json +0 -96
  636. package/_bundled_plugin/scripts/validate_tracking_source.py +0 -82
  637. package/_bundled_plugin/scripts/workbench_local_dedupe.py +0 -136
  638. package/dist/deduplication/records-protocol.d.ts +0 -4
  639. package/dist/deduplication/records-protocol.d.ts.map +0 -1
  640. package/dist/deduplication/records-protocol.js +0 -49
  641. package/dist/deduplication/records-protocol.js.map +0 -1
  642. package/dist/external-imports-feature.d.ts +0 -6
  643. package/dist/external-imports-feature.d.ts.map +0 -1
  644. package/dist/external-imports-feature.js +0 -51
  645. package/dist/external-imports-feature.js.map +0 -1
  646. package/dist/finding-normalization.d.ts +0 -5
  647. package/dist/finding-normalization.d.ts.map +0 -1
  648. package/dist/finding-normalization.js +0 -120
  649. package/dist/finding-normalization.js.map +0 -1
@@ -7,11 +7,20 @@ import argparse
7
7
  import json
8
8
  import re
9
9
  from collections import Counter
10
+ from collections.abc import Iterator
11
+ from itertools import chain
10
12
  from typing import Any
11
13
 
12
14
  SEVERITY_ORDER = {"critical": 0, "high": 1, "medium": 2, "low": 3, "informational": 4}
13
15
  CONFIDENCE_ORDER = {"high": 0, "medium": 1, "low": 2}
14
16
  REPORTABLE_SEVERITIES = {"critical", "high", "medium", "low"}
17
+ THREAT_MODEL_SECTIONS = (
18
+ ("Assets", "assets"),
19
+ ("Trust Boundaries", "trustBoundaries"),
20
+ ("Attacker Capabilities", "attackerCapabilities"),
21
+ ("Security Objectives", "securityObjectives"),
22
+ ("Assumptions", "assumptions"),
23
+ )
15
24
  DISPOSITION_LABELS = {
16
25
  "reported": "Reported",
17
26
  "no_issue_found": "No issue found",
@@ -29,6 +38,14 @@ class ReportProjectionError(ValueError):
29
38
  """Raised when a canonical scan cannot be projected into a valid report."""
30
39
 
31
40
 
41
+ def markdown_threat_model_content(model: dict[str, Any]) -> str | None:
42
+ """Return nonblank authored content for a Markdown model, otherwise None."""
43
+ content = model.get("content")
44
+ if model.get("format") == "markdown" and isinstance(content, str) and content.strip():
45
+ return content
46
+ return None
47
+
48
+
32
49
  def _escape_markdown(value: str) -> str:
33
50
  # Locate whole URLs before matching code spans: a URL can contain backticks.
34
51
  urls = [match.span() for match in re.finditer(WWW_LINK_RE, value)]
@@ -60,12 +77,15 @@ def _text(value: Any, fallback: str) -> str:
60
77
  return _escape_markdown(normalized)
61
78
 
62
79
 
63
- def _strings(value: Any) -> list[str]:
80
+ def _string_values(value: Any) -> Iterator[str]:
64
81
  if isinstance(value, str):
65
- value = [value]
66
- if not isinstance(value, list):
67
- return []
68
- return [text for item in value if (text := _text(item, ""))]
82
+ yield value
83
+ elif isinstance(value, list):
84
+ yield from (item for item in value if isinstance(item, str))
85
+
86
+
87
+ def _strings(value: Any) -> list[str]:
88
+ return [text for item in _string_values(value) if (text := _text(item, ""))]
69
89
 
70
90
 
71
91
  def _path_label(value: str, *, ensure_ascii: bool = False) -> str:
@@ -130,6 +150,7 @@ def _has_deep_child_metadata(finding: dict[str, Any]) -> bool:
130
150
 
131
151
 
132
152
  def uses_deep_presentation(coverage: dict[str, Any], findings: list[dict[str, Any]]) -> bool:
153
+ """Select deep-report formatting for repository scans in deep mode and scoped scans with deep-child metadata."""
133
154
  if coverage.get("mode") == "deep_repository":
134
155
  return True
135
156
  if coverage.get("mode") != "scoped_path":
@@ -139,7 +160,7 @@ def uses_deep_presentation(coverage: dict[str, Any], findings: list[dict[str, An
139
160
  return any(_has_deep_child_metadata(finding) for finding in findings)
140
161
 
141
162
 
142
- def _deep_title_parts(finding: dict[str, Any]) -> tuple[str, str | None]:
163
+ def _deep_title_parts(finding: dict[str, Any], report_id: str) -> tuple[str, str | None]:
143
164
  title = finding.get("title")
144
165
  if not isinstance(title, str):
145
166
  return "Untitled finding", None
@@ -149,7 +170,7 @@ def _deep_title_parts(finding: dict[str, Any]) -> tuple[str, str | None]:
149
170
  return normalized, None
150
171
  annotation = match.group(2)
151
172
  extensions = finding.get("extensions")
152
- recognized_ids = [_deep_report_id(finding)]
173
+ recognized_ids = [report_id]
153
174
  if isinstance(extensions, dict):
154
175
  ledger_row_id = extensions.get("ledgerRowId")
155
176
  if isinstance(ledger_row_id, str) and ledger_row_id.strip():
@@ -162,21 +183,6 @@ def _deep_title_parts(finding: dict[str, Any]) -> tuple[str, str | None]:
162
183
  return normalized, None
163
184
 
164
185
 
165
- def _deep_finding_groups(
166
- findings: list[dict[str, Any]], writeup_paths: list[str | None]
167
- ) -> list[list[tuple[int, dict[str, Any], str | None]]]:
168
- groups: dict[str, list[tuple[int, dict[str, Any], str | None]]] = {}
169
- for number, (finding, report_path) in enumerate(zip(findings, writeup_paths, strict=True), 1):
170
- groups.setdefault(_deep_candidate_id(finding), []).append((number, finding, report_path))
171
- return list(groups.values())
172
-
173
-
174
- def _deep_group_titles(group: list[tuple[int, dict[str, Any], str | None]]) -> str:
175
- return "<br>".join(
176
- dict.fromkeys(_cell(_deep_title_parts(finding)[0]) for _, finding, _ in group)
177
- )
178
-
179
-
180
186
  def _deep_group_levels(
181
187
  group: list[tuple[int, dict[str, Any], str | None]],
182
188
  field: str,
@@ -186,47 +192,34 @@ def _deep_group_levels(
186
192
  return "<br>".join(sorted(levels, key=lambda level: order.get(level, len(order))))
187
193
 
188
194
 
189
- def _deep_group_report_labels(
190
- group: list[tuple[int, dict[str, Any], str | None]],
191
- ) -> list[str]:
195
+ def _deep_group_row(group: list[tuple[int, dict[str, Any], str | None]]) -> str:
192
196
  report_ids = [_deep_report_id(finding) for _, finding, _ in group]
193
- report_id_counts = Counter(report_ids)
194
- labels = [
195
- (_deep_title_parts(finding)[1] if report_id_counts[report_id] > 1 else report_id)
196
- or report_id
197
- for report_id, (_, finding, _) in zip(report_ids, group, strict=True)
198
- ]
199
- label_counts = Counter(labels)
200
- return [
201
- (
202
- finding.get("identity", {}).get("instance")
203
- if label_counts[label] > 1 and isinstance(finding.get("identity"), dict)
204
- else label
205
- )
206
- or _deep_report_id(finding)
207
- for label, (_, finding, _) in zip(labels, group, strict=True)
208
- ]
209
-
197
+ report_counts = Counter(report_ids)
198
+ titles = []
199
+ labels = []
200
+ for report_id, (_, finding, _) in zip(report_ids, group, strict=True):
201
+ title, annotation = _deep_title_parts(finding, report_id)
202
+ titles.append(_cell(title))
203
+ labels.append(annotation if report_counts[report_id] > 1 and annotation else report_id)
210
204
 
211
- def _deep_group_report_links(group: list[tuple[int, dict[str, Any], str | None]]) -> str:
212
- labels = _deep_group_report_labels(group)
213
- return "<br>".join(
214
- f"[{_cell(label)}](#finding-{number})"
215
- for label, (number, _, _) in zip(labels, group, strict=True)
205
+ label_counts = Counter(labels)
206
+ report_links = []
207
+ writeup_links = []
208
+ for report_id, label, (number, finding, path) in zip(report_ids, labels, group, strict=True):
209
+ identity = finding.get("identity")
210
+ if label_counts[label] > 1 and isinstance(identity, dict):
211
+ label = identity.get("instance") or report_id
212
+ label = _cell(label)
213
+ report_links.append(f"[{label}](#finding-{number})")
214
+ writeup_links.append(f"[Open {label}]({path})" if path else f"{label}: inline below")
215
+ return (
216
+ f"| {'<br>'.join(dict.fromkeys(titles))} | {'<br>'.join(report_links)} "
217
+ f"| {_deep_group_levels(group, 'severity', SEVERITY_ORDER)} "
218
+ f"| {_deep_group_levels(group, 'confidence', CONFIDENCE_ORDER)} "
219
+ f"| {'<br>'.join(writeup_links)} |"
216
220
  )
217
221
 
218
222
 
219
- def _deep_group_writeup_links(group: list[tuple[int, dict[str, Any], str | None]]) -> str:
220
- labels = _deep_group_report_labels(group)
221
- links: list[str] = []
222
- for label, (_, _, report_path) in zip(labels, group, strict=True):
223
- report_id = _cell(label)
224
- links.append(
225
- f"[Open {report_id}]({report_path})" if report_path else f"{report_id}: inline below"
226
- )
227
- return "<br>".join(links)
228
-
229
-
230
223
  def _writeup_report_path(finding: dict[str, Any]) -> str | None:
231
224
  writeup = finding.get("writeup")
232
225
  if writeup is None:
@@ -255,55 +248,50 @@ def _bullet_section(heading: str, items: list[str]) -> list[str]:
255
248
  return ["", heading, *(f"- {item}" for item in items)] if items else []
256
249
 
257
250
 
258
- def _code_evidence_catalog(finding: dict[str, Any]) -> dict[str, dict[str, Any]]:
259
- catalog: dict[str, dict[str, Any]] = {}
260
- for key in ("codeEvidence", "code_evidence"):
261
- raw = finding.get(key, [])
262
- if not isinstance(raw, list):
263
- continue
264
- for item in raw:
265
- if (
266
- isinstance(item, dict)
267
- and isinstance(item.get("id"), str)
251
+ def code_evidence_rows(*catalogs: Any) -> Iterator[dict[str, Any]]:
252
+ """Yield evidence objects with nonblank code in their original order."""
253
+ for items in catalogs:
254
+ if isinstance(items, list):
255
+ yield from (
256
+ item
257
+ for item in items
258
+ if isinstance(item, dict)
268
259
  and isinstance(item.get("code"), str)
269
260
  and item["code"].strip()
270
- ):
271
- catalog.setdefault(item["id"], item)
261
+ )
262
+
263
+
264
+ def embedded_code_evidence(section: dict[str, Any]) -> Iterator[dict[str, Any]]:
265
+ """Collect code evidence from both supported field spellings."""
266
+ return code_evidence_rows(section.get("codeEvidence"), section.get("code_evidence"))
267
+
268
+
269
+ def _code_evidence_catalog(finding: dict[str, Any]) -> dict[str, dict[str, Any]]:
270
+ catalog = {}
271
+ for item in embedded_code_evidence(finding):
272
+ if isinstance(item.get("id"), str):
273
+ catalog.setdefault(item["id"], item)
272
274
  return catalog
273
275
 
274
276
 
275
277
  def _section_code_evidence(
276
- finding: dict[str, Any], *sections: dict[str, Any]
278
+ catalog: dict[str, dict[str, Any]], *sections: dict[str, Any]
277
279
  ) -> list[dict[str, Any]]:
278
- catalog = _code_evidence_catalog(finding)
279
- resolved: list[dict[str, Any]] = []
280
- for section in sections:
281
- for key in ("evidenceRefs", "evidence_refs"):
282
- refs = section.get(key, [])
283
- if isinstance(refs, str):
284
- refs = [refs]
285
- if isinstance(refs, list):
286
- resolved.extend(
287
- catalog[ref] for ref in refs if isinstance(ref, str) and ref in catalog
288
- )
289
- for key in ("codeEvidence", "code_evidence"):
290
- embedded = section.get(key, [])
291
- if isinstance(embedded, list):
292
- resolved.extend(
293
- item
294
- for item in embedded
295
- if isinstance(item, dict)
296
- and isinstance(item.get("code"), str)
297
- and item["code"].strip()
298
- )
299
280
  unique: dict[tuple[str, str], dict[str, Any]] = {}
300
- for item in resolved:
301
- key = (str(item.get("id", "")), item["code"])
302
- unique.setdefault(key, item)
281
+ for section in sections:
282
+ referenced = (
283
+ catalog[ref]
284
+ for key in ("evidenceRefs", "evidence_refs")
285
+ for ref in _string_values(section.get(key))
286
+ if ref in catalog
287
+ )
288
+ for item in chain(referenced, embedded_code_evidence(section)):
289
+ unique.setdefault((str(item.get("id", "")), item["code"]), item)
303
290
  return list(unique.values())
304
291
 
305
292
 
306
293
  def merged_root_cause(value: dict[str, Any]) -> tuple[str | None, Any]:
294
+ """Return the first recorded root-cause field name and its merged detail, or (None, None) if absent."""
307
295
  keys = [key for key in ("rootCause", "root_cause") if key in value]
308
296
  if not keys:
309
297
  return None, None
@@ -359,12 +347,7 @@ def merged_root_cause(value: dict[str, Any]) -> tuple[str | None, Any]:
359
347
  ]
360
348
  if evidence_values:
361
349
  merged["evidenceRefs"] = list(
362
- dict.fromkeys(
363
- item
364
- for evidence in evidence_values
365
- for item in (evidence if isinstance(evidence, list) else [evidence])
366
- if isinstance(item, str)
367
- )
350
+ dict.fromkeys(item for evidence in evidence_values for item in _string_values(evidence))
368
351
  )
369
352
 
370
353
  embedded_evidence = [
@@ -396,9 +379,9 @@ def merged_root_cause(value: dict[str, Any]) -> tuple[str | None, Any]:
396
379
 
397
380
 
398
381
  def _root_cause_code_evidence(
399
- finding: dict[str, Any], root_cause: dict[str, Any]
382
+ finding: dict[str, Any], root_cause: dict[str, Any], catalog: dict[str, dict[str, Any]]
400
383
  ) -> list[dict[str, Any]]:
401
- evidence = _section_code_evidence(finding, root_cause)
384
+ evidence = _section_code_evidence(catalog, root_cause)
402
385
  legacy_code = root_cause.get("code")
403
386
  if not isinstance(legacy_code, str) or not legacy_code.strip():
404
387
  return evidence
@@ -599,33 +582,17 @@ def _finding_section(number: int, finding: dict[str, Any]) -> list[str]:
599
582
  if isinstance((value := attack_path.get(key)), (str, dict))
600
583
  ]
601
584
  dataflow: dict[str, Any] = {}
602
- for key in ("summary", "source", "sink", "outcome"):
603
- value = next(
604
- (
605
- section[key]
606
- for section in dataflow_sections
607
- if key in section and isinstance(section[key], str) and section[key].strip()
608
- ),
609
- None,
610
- )
611
- if value is not None:
612
- dataflow[key] = value
613
- transformations = list(
614
- dict.fromkeys(
615
- transformation
616
- for section in dataflow_sections
617
- for transformation in (
618
- [section.get("transformations")]
619
- if isinstance(section.get("transformations"), str)
620
- else section.get("transformations")
621
- if isinstance(section.get("transformations"), list)
622
- else []
623
- )
624
- if isinstance(transformation, str) and transformation.strip()
625
- )
585
+ for section in dataflow_sections:
586
+ for key in ("summary", "source", "sink", "outcome"):
587
+ value = section.get(key)
588
+ if isinstance(value, str) and value.strip():
589
+ dataflow.setdefault(key, value)
590
+ transformations = dict.fromkeys(
591
+ value
592
+ for section in dataflow_sections
593
+ for value in _string_values(section.get("transformations"))
594
+ if value.strip()
626
595
  )
627
- if transformations:
628
- dataflow["transformations"] = transformations
629
596
  raw_reachability = attack_path.get("reachability")
630
597
  reachability = (
631
598
  {"summary": raw_reachability}
@@ -654,10 +621,11 @@ def _finding_section(number: int, finding: dict[str, Any]) -> list[str]:
654
621
  raw_root_cause if isinstance(raw_root_cause, str) else root_cause.get("summary"),
655
622
  "",
656
623
  )
657
- root_cause_code_evidence = _root_cause_code_evidence(finding, root_cause)
658
- validation_code_evidence = _section_code_evidence(finding, validation)
659
- dataflow_code_evidence = _section_code_evidence(finding, attack_path, *dataflow_sections)
660
- reachability_code_evidence = _section_code_evidence(finding, reachability)
624
+ catalog = _code_evidence_catalog(finding)
625
+ root_cause_code_evidence = _root_cause_code_evidence(finding, root_cause, catalog)
626
+ validation_code_evidence = _section_code_evidence(catalog, validation)
627
+ dataflow_code_evidence = _section_code_evidence(catalog, attack_path, *dataflow_sections)
628
+ reachability_code_evidence = _section_code_evidence(catalog, reachability)
661
629
  dataflow_summary = _text(dataflow.get("summary"), "") or (
662
630
  f"The canonical finding records the affected path at {_locations(finding)}, "
663
631
  "but no expanded source-to-sink narrative was recorded."
@@ -704,7 +672,9 @@ def _finding_section(number: int, finding: dict[str, Any]) -> list[str]:
704
672
  for label, key in (("Source", "source"), ("Sink", "sink"), ("Outcome", "outcome")):
705
673
  if dataflow.get(key):
706
674
  lines.extend(["", f"- **{label}:** {_text(dataflow[key], 'not recorded')}"])
707
- lines.extend(_bullet_section("Transformations:", _strings(dataflow.get("transformations"))))
675
+ lines.extend(
676
+ _bullet_section("Transformations:", [_text(value, "") for value in transformations])
677
+ )
708
678
  lines.extend(_code_evidence_lines(dataflow_code_evidence))
709
679
  lines.extend(["", "#### Reachability", "", reachability_summary])
710
680
  for label, key in (
@@ -718,10 +688,7 @@ def _finding_section(number: int, finding: dict[str, Any]) -> list[str]:
718
688
  lines.extend(["", f"- **{label}:** {_text(reachability[key], 'not recorded')}"])
719
689
  preconditions = list(
720
690
  dict.fromkeys(
721
- [
722
- *_strings(attack_path.get("preconditions")),
723
- *_strings(reachability.get("preconditions")),
724
- ]
691
+ _strings(attack_path.get("preconditions")) + _strings(reachability.get("preconditions"))
725
692
  )
726
693
  )
727
694
  lines.extend(_bullet_section("Preconditions:", preconditions))
@@ -786,6 +753,16 @@ def _linked_finding_section(number: int, finding: dict[str, Any], report_path: s
786
753
  def build_report_markdown(
787
754
  manifest: dict[str, Any], findings_document: dict[str, Any], coverage: dict[str, Any]
788
755
  ) -> str:
756
+ """Render findings and review coverage as a Markdown report ending in a newline.
757
+
758
+ Args:
759
+ manifest: Scan metadata, target, and scope.
760
+ findings_document: Canonical findings for the scan.
761
+ coverage: Review coverage for older manifests. Newer scans supply review state inline.
762
+
763
+ Raises:
764
+ ReportProjectionError: Reportable findings share a writeup path.
765
+ """
789
766
  scan = manifest["scan"]
790
767
  if "review" in scan and "coverageRef" not in scan:
791
768
  from review_state import review_state
@@ -802,19 +779,23 @@ def build_report_markdown(
802
779
  ),
803
780
  key=_finding_sort_key,
804
781
  )
805
- writeup_paths = [_writeup_report_path(finding) for finding in findings]
806
- duplicate_writeup_paths = sorted(
807
- path
808
- for path, count in Counter(path for path in writeup_paths if path is not None).items()
809
- if count > 1
810
- )
782
+ numbered_findings = [
783
+ (number, finding, _writeup_report_path(finding))
784
+ for number, finding in enumerate(findings, 1)
785
+ ]
786
+ writeup_counts = Counter(path for _, _, path in numbered_findings if path is not None)
787
+ duplicate_writeup_paths = sorted(path for path, count in writeup_counts.items() if count > 1)
811
788
  if duplicate_writeup_paths:
812
789
  raise ReportProjectionError(
813
790
  "reportable findings have duplicate writeup reportPath values: "
814
791
  + ", ".join(duplicate_writeup_paths)
815
792
  )
816
793
  deep_presentation = uses_deep_presentation(coverage, findings)
817
- deep_finding_groups = _deep_finding_groups(findings, writeup_paths) if deep_presentation else []
794
+ deep_finding_groups: dict[str, list[tuple[int, dict[str, Any], str | None]]] = {}
795
+ if deep_presentation:
796
+ for entry in numbered_findings:
797
+ _, finding, _ = entry
798
+ deep_finding_groups.setdefault(_deep_candidate_id(finding), []).append(entry)
818
799
  hardening_portfolio_path = _hardening_portfolio_path(scan)
819
800
  include_paths = [
820
801
  _path_text(path) for path in coverage.get("includePaths", scope.get("includePaths", []))
@@ -883,8 +864,8 @@ def build_report_markdown(
883
864
  "",
884
865
  ]
885
866
  )
886
- content = threat_model.get("content")
887
- if threat_model.get("format") == "markdown" and isinstance(content, str) and content.strip():
867
+ content = markdown_threat_model_content(threat_model)
868
+ if content is not None:
888
869
  lines.append(content)
889
870
  else:
890
871
  lines.append(
@@ -893,18 +874,38 @@ def build_report_markdown(
893
874
  "No explicit canonical threat-model summary was recorded.",
894
875
  )
895
876
  )
896
- for heading, key in (
897
- ("Assets", "assets"),
898
- ("Trust Boundaries", "trustBoundaries"),
899
- ("Attacker Capabilities", "attackerCapabilities"),
900
- ("Security Objectives", "securityObjectives"),
901
- ("Assumptions", "assumptions"),
902
- ):
877
+ for heading, key in THREAT_MODEL_SECTIONS:
903
878
  values = _strings(threat_model.get(key))
904
879
  if values:
905
880
  lines.extend(["", f"### {heading}", "", *(f"- {value}" for value in values)])
881
+ reviews = scan.get("reviewState", {}).get("reviews")
882
+ if isinstance(reviews, list) and any(
883
+ isinstance(review, dict) and isinstance(review.get("threatModel"), dict)
884
+ for review in reviews
885
+ ):
886
+ lines.extend(
887
+ [
888
+ "",
889
+ (
890
+ "Other reviews recorded different threat models. See the `threatModel` fields "
891
+ "in `scan.reviewState.reviews` in the [scan manifest](scan-manifest.json)."
892
+ ),
893
+ ]
894
+ )
906
895
  lines.extend(["", "## Findings", ""])
896
+ informational_count = sum(
897
+ finding["severity"]["level"] == "informational" for finding in findings_document["findings"]
898
+ )
899
+ informational_note = ""
900
+ if informational_count:
901
+ noun = "finding" if informational_count == 1 else "findings"
902
+ informational_note = (
903
+ f"This report omits details for {informational_count} informational {noun}. "
904
+ "See `findings.json` or export the findings as SARIF or CSV."
905
+ )
907
906
  if findings:
907
+ if informational_note:
908
+ lines.extend([informational_note, ""])
908
909
  if deep_presentation:
909
910
  lines.extend(
910
911
  [
@@ -912,13 +913,7 @@ def build_report_markdown(
912
913
  "| --- | --- | --- | --- | --- |",
913
914
  ]
914
915
  )
915
- for group in deep_finding_groups:
916
- lines.append(
917
- f"| {_deep_group_titles(group)} | {_deep_group_report_links(group)} "
918
- f"| {_deep_group_levels(group, 'severity', SEVERITY_ORDER)} "
919
- f"| {_deep_group_levels(group, 'confidence', CONFIDENCE_ORDER)} "
920
- f"| {_deep_group_writeup_links(group)} |"
921
- )
916
+ lines.extend(_deep_group_row(group) for group in deep_finding_groups.values())
922
917
  else:
923
918
  lines.extend(
924
919
  [
@@ -926,9 +921,7 @@ def build_report_markdown(
926
921
  "| --- | --- | --- | --- |",
927
922
  ]
928
923
  )
929
- for number, (finding, report_path) in enumerate(
930
- zip(findings, writeup_paths, strict=True), 1
931
- ):
924
+ for number, finding, report_path in numbered_findings:
932
925
  title = _cell(finding["title"])
933
926
  finding_link = f"[{title}](#finding-{number})"
934
927
  writeup_link = f"[Open report]({report_path})" if report_path else "inline below"
@@ -948,9 +941,7 @@ def build_report_markdown(
948
941
  "| low | Evidence is incomplete and the item is retained only for explicit follow-up. |",
949
942
  ]
950
943
  )
951
- for number, (finding, report_path) in enumerate(
952
- zip(findings, writeup_paths, strict=True), 1
953
- ):
944
+ for number, finding, report_path in numbered_findings:
954
945
  if report_path is not None:
955
946
  lines.extend(["", *_linked_finding_section(number, finding, report_path)])
956
947
  else:
@@ -961,18 +952,15 @@ def build_report_markdown(
961
952
  "canceled",
962
953
  "interrupted",
963
954
  }
964
- lines.extend(
965
- [
966
- "### No findings",
967
- "",
968
- (
969
- "No findings were retained before the scan stopped. "
970
- "The scan did not complete. No vulnerability conclusion can be drawn."
971
- if stopped
972
- else "No findings were reported."
973
- ),
974
- ]
955
+ heading = "### No reportable findings" if informational_note else "### No findings"
956
+ message = informational_note or (
957
+ "No findings were retained before the scan stopped."
958
+ if stopped
959
+ else "No findings were reported."
975
960
  )
961
+ if stopped:
962
+ message += " The scan did not complete. No vulnerability conclusion can be drawn."
963
+ lines.extend([heading, "", message])
976
964
  if hardening_portfolio_path is not None:
977
965
  lines.extend(
978
966
  [
@@ -1058,6 +1046,7 @@ def generate_report_markdown(
1058
1046
  findings: dict[str, Any],
1059
1047
  coverage: dict[str, Any],
1060
1048
  ) -> bytes:
1049
+ """Return the Markdown report for the scan as UTF-8 bytes ready to write."""
1061
1050
  return build_report_markdown(manifest, findings, coverage).encode("utf-8")
1062
1051
 
1063
1052
 
@@ -8,17 +8,23 @@ from typing import Any
8
8
 
9
9
 
10
10
  def uses_legacy_review(scan: dict[str, Any]) -> bool:
11
+ """Return whether the manifest points to separate coverage or predates inline review metadata."""
11
12
  return "coverageRef" in scan or ("reviewState" not in scan and "review" not in scan)
12
13
 
13
14
 
14
15
  def review_summary(state: dict[str, Any]) -> dict[str, Any]:
16
+ """Return the excluded path patterns in the compact form stored on the scan manifest."""
15
17
  return {
16
18
  "excludedPaths": [item["pattern"] for item in state.get("explicitExclusions", [])],
17
19
  }
18
20
 
19
21
 
20
22
  def review_state(scan: dict[str, Any]) -> dict[str, Any]:
21
- """Read new manifest metadata using the recovery code's existing representation."""
23
+ """Build the recovery coverage record from inline manifest metadata.
24
+
25
+ Copy the saved review state, deriving exclusions from the summary when needed,
26
+ and attach the inventory strategy and scope for this scan.
27
+ """
22
28
  summary = scan.get("review", {})
23
29
  state = copy.deepcopy(scan.get("reviewState", {}))
24
30
  mode = scan.get("mode", "repository")
@@ -48,7 +54,7 @@ def review_state(scan: dict[str, Any]) -> dict[str, Any]:
48
54
 
49
55
 
50
56
  def checkpoint_review_state(state: dict[str, Any]) -> dict[str, Any]:
51
- """Retain unfinished work and candidate outcomes, without a coverage report."""
57
+ """Copy the review data needed for recovery, omitting per-surface risk areas and report metadata."""
52
58
  return {
53
59
  "surfaces": [
54
60
  {key: copy.deepcopy(value) for key, value in item.items() if key != "riskArea"}
@@ -32,6 +32,16 @@ AVIT_FINDING_FIELDS = (
32
32
 
33
33
 
34
34
  def read_template(path: Path) -> tuple[list[str], dict[str, str]]:
35
+ """Read the application defaults for a ServiceNow AVIT export from a UTF-8 CSV.
36
+
37
+ Returns:
38
+ tuple: The original column headings and a mapping of stripped, case-folded
39
+ headings to values from the single application row.
40
+
41
+ Raises:
42
+ ValueError: The file is unreadable, required columns are missing or
43
+ duplicated, or application values are empty or too long.
44
+ """
35
45
  try:
36
46
  with path.open(encoding="utf-8-sig", newline="") as source:
37
47
  rows = (row for row in csv.reader(source, strict=True) if row)
@@ -62,6 +72,11 @@ def _narrative(text: str) -> str:
62
72
 
63
73
 
64
74
  def finding_fields(finding: dict[str, Any], location: dict[str, Any], steps: str) -> dict[str, str]:
75
+ """Return AVIT columns for a finding at the selected location with the recorded steps.
76
+
77
+ Use the first recognized CWE as the category, or the finding ID as the
78
+ vulnerability ID when no CWE qualifies. Both narrative fields fit in 1,000 characters.
79
+ """
65
80
  details = (
66
81
  f"{finding['findingId']} | {location['path']}:{location['startLine']}\n"
67
82
  f"{finding['title']}\n{finding['summary']}\n{finding['remediation']}"
@@ -85,6 +100,11 @@ def finding_fields(finding: dict[str, Any], location: dict[str, Any], steps: str
85
100
 
86
101
 
87
102
  def render(template: Path, rows: Iterable[dict[str, str]]) -> bytes:
103
+ """Return UTF-8 CSV bytes with the template's header and one row per finding.
104
+
105
+ The template supplies application fields and column order. For nonempty input,
106
+ write the count of findings missing reproduction steps to stderr.
107
+ """
88
108
  headers, row = read_template(template)
89
109
  output = io.StringIO(newline="")
90
110
  writer = csv.writer(output)
@@ -10,6 +10,7 @@ from urllib.parse import quote
10
10
 
11
11
 
12
12
  def main() -> None:
13
+ """Back up the read-only source database into a separate destination using SQLite’s backup API."""
13
14
  parser = argparse.ArgumentParser(description=__doc__)
14
15
  parser.add_argument("source", type=Path)
15
16
  parser.add_argument("destination", type=Path)