Help us shape the future of Go! Take the 2026 Go Developer Survey

report

package
v0.15.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 27, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

Package report renders a deliverable Markdown report from the exploration graph: confirmed findings (with severity/evidence) (docs §15 P5).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FindingFilename

func FindingFilename(f *db.DBFinding) string

FindingFilename 为「一漏洞一文件」生成安全的 .md 文件名,形如 `critical_SQL注入_#123.md`。去掉路径分隔符与控制字符,避免 zip 内非法路径。

func FindingsCSV

func FindingsCSV(fs []*db.DBFinding) []byte

FindingsCSV 把一批 findings 渲染成 CSV(带 UTF-8 BOM,便于 Excel 正确识别中文)。 不含大段 report/evidence 全文,只放摘要类字段;需要全文用 Markdown/JSON 导出。

func FindingsMarkdown

func FindingsMarkdown(fs []*db.DBFinding, generatedAt time.Time) string

FindingsMarkdown 把一批 findings 整合成一份汇总报告(摘要 + 按严重等级分组, 每条含类别/状态/所属任务/证据/详细报告)。

func Markdown

func Markdown(in Input) string

Markdown renders the report.

func SingleFindingMarkdown

func SingleFindingMarkdown(f *db.DBFinding, generatedAt time.Time) string

SingleFindingMarkdown 渲染单条漏洞为一份独立 Markdown(用于「一漏洞一文件」打包)。

Types

type Input

type Input struct {
	Title       string
	Goal        string
	GeneratedAt time.Time
	AssetCounts map[string]int
	Findings    []*db.Node
}

Input bundles what the report needs.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL