Documentation
¶
Overview ¶
Package report renders scanner findings as a human-readable Markdown report, ready to paste into a pentest writeup. It is a pure transform over stored issues — no I/O — so it is equally callable from the control API and the AI.
Index ¶
- func Findings(issues []store.Issue) string
- func Project(findings []store.Finding, issues []store.Issue) string
- func ProjectGroupedByTag(findings []store.Finding, issues []store.Issue, tagOrder, omitTags []string) string
- func ProjectHTML(findings []store.Finding, issues []store.Issue) string
- func ProjectHTMLGroupedByTag(findings []store.Finding, issues []store.Issue, tagOrder, omitTags []string) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Findings ¶
Findings renders issues as Markdown, grouped by severity (High→Info) with a summary line. Output is deterministic for a given set of issues.
func Project ¶
Project renders a full engagement report: an executive summary table, then the curated Findings (each with its status and attached PoC request/response flows) grouped by severity Critical→Info, then an "Excluded — False Positives" section for findings marked false_positive, and finally an appendix of the auto-generated passive-scan Issues. Findings marked false_positive are kept out of the main body. Deterministic for a given input. This is the human-and-AI-shared writeup the operator exports.
func ProjectGroupedByTag ¶ added in v1.5.4
func ProjectGroupedByTag(findings []store.Finding, issues []store.Issue, tagOrder, omitTags []string) string
ProjectGroupedByTag is like Project but sections active findings under ## Tag: <name> headings. tagOrder prefers section order (e.g. cms, website, app, api); remaining tags follow alphabetically; untagged findings go last under ## Untagged. omitTags drops those tags from sections and excludes findings that only carry omitted tags (typical for out-of-scope).
func ProjectHTML ¶
ProjectHTML renders the same engagement report as Project, as a self-contained HTML document suitable for download or print-to-PDF.
Types ¶
This section is empty.
Source Files