mirror of
https://github.com/BaaRai/ARTEX.git
synced 2026-11-13 11:40:53 +08:00
BaaRai
e233c02314
Comments, doc comments, UI labels, log and error messages, LLM prompt strings, markdown docs, test data and assertions. Identifiers, enum keys, routes, placeholders and code structure are unchanged. Notes: - docs/漏洞流量证据.md renamed to docs/vulnerability-traffic-evidence.md - tests that exercised CJK specific handling (GBK zip names, Chinese full text search) now use ASCII equivalents; go build passes and the test suite matches the pre translation baseline (remaining failures need a PostgreSQL DSN and fail identically on the original) - frontend mention syntax now uses English kinds (finding, asset, ...) matching the backend, chat mentions tests pass
100 lines
2.5 KiB
Go
100 lines
2.5 KiB
Go
// Package report renders a deliverable Markdown report from the exploration
|
|
// graph: confirmed findings (with severity/evidence) (docs §15 P5).
|
|
package report
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"sort"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/Autumn-27/artex/db"
|
|
)
|
|
|
|
// Input bundles what the report needs.
|
|
type Input struct {
|
|
Title string
|
|
Goal string
|
|
GeneratedAt time.Time
|
|
AssetCounts map[string]int
|
|
Findings []*db.Node
|
|
}
|
|
|
|
type findingView struct {
|
|
VulnClass string
|
|
Name string
|
|
Severity string
|
|
Summary string
|
|
PoC string
|
|
}
|
|
|
|
func parseFinding(n *db.Node) findingView {
|
|
var p struct {
|
|
VulnClass string `json:"vulnclass"`
|
|
Name string `json:"name"`
|
|
Severity string `json:"severity"`
|
|
Summary string `json:"summary"`
|
|
Evidence struct {
|
|
PoC string `json:"poc"`
|
|
} `json:"evidence"`
|
|
}
|
|
_ = json.Unmarshal(n.Payload, &p)
|
|
return findingView{p.VulnClass, p.Name, p.Severity, p.Summary, p.Evidence.PoC}
|
|
}
|
|
|
|
var sevRank = map[string]int{"critical": 0, "high": 1, "medium": 2, "low": 3, "": 4}
|
|
|
|
// Markdown renders the report.
|
|
func Markdown(in Input) string {
|
|
var b strings.Builder
|
|
fmt.Fprintf(&b, "# Penetration Test Report — %s\n\n", nz(in.Title, "Unnamed task"))
|
|
fmt.Fprintf(&b, "- **Task goal**: %s\n", nz(in.Goal, "(unspecified)"))
|
|
fmt.Fprintf(&b, "- **Generated at**: %s\n\n", in.GeneratedAt.Format("2006-01-02 15:04:05"))
|
|
|
|
// summary
|
|
fmt.Fprintf(&b, "## Summary\n\n")
|
|
fmt.Fprintf(&b, "- Confirmed findings: **%d**\n", len(in.Findings))
|
|
fmt.Fprintf(&b, "- Assets: ")
|
|
var types []string
|
|
for t := range in.AssetCounts {
|
|
types = append(types, t)
|
|
}
|
|
sort.Strings(types)
|
|
for i, t := range types {
|
|
if i > 0 {
|
|
b.WriteString(", ")
|
|
}
|
|
fmt.Fprintf(&b, "%s %d", t, in.AssetCounts[t])
|
|
}
|
|
b.WriteString("\n\n")
|
|
|
|
// findings
|
|
fmt.Fprintf(&b, "## Findings\n\n")
|
|
if len(in.Findings) == 0 {
|
|
b.WriteString("_No vulnerabilities confirmed this time._\n\n")
|
|
} else {
|
|
fs := make([]findingView, 0, len(in.Findings))
|
|
for _, n := range in.Findings {
|
|
fs = append(fs, parseFinding(n))
|
|
}
|
|
sort.SliceStable(fs, func(i, j int) bool { return sevRank[fs[i].Severity] < sevRank[fs[j].Severity] })
|
|
for i, f := range fs {
|
|
fmt.Fprintf(&b, "### %d. [%s] %s\n\n", i+1, strings.ToUpper(nz(f.Severity, "info")), nz(f.Name, nz(f.VulnClass, "Uncategorized")))
|
|
fmt.Fprintf(&b, "%s\n\n", nz(f.Summary, ""))
|
|
if f.PoC != "" {
|
|
fmt.Fprintf(&b, "**PoC / Evidence:**\n\n```\n%s\n```\n\n", f.PoC)
|
|
}
|
|
}
|
|
}
|
|
|
|
return b.String()
|
|
}
|
|
|
|
func nz(s, d string) string {
|
|
if strings.TrimSpace(s) == "" {
|
|
return d
|
|
}
|
|
return s
|
|
}
|