report

Documentation

Overview

Package report serializes collected scan results to sarif and markdown. it's deliberately decoupled from the scan package: callers map their own results into report.Result, so report never imports a scanner type.

Index

• func Markdown(results []Result) []byte
• func SARIF(results []Result) ([]byte, error)
• type Result

Functions

func Markdown

func Markdown(results []Result) []byte

Markdown renders results as a readable report grouped by target, then by module, with each module's finding pretty-printed as a json code block.

func SARIF

func SARIF(results []Result) ([]byte, error)

SARIF serializes results to a minimal valid sarif 2.1.0 log. Each module result becomes one sarif result tagged with its module id (the rule) and the target uri, with the raw module data inlined into the message for context.

Types

type Result

type Result struct {
	Target   string
	Module   string
	Severity string
	Data     json.RawMessage
}

Result is one module's output for one target. Data is whatever the scanner returned, carried as raw json so report stays free of scan types. Severity is the normalized rank ("critical".."info", or "" when the source carries none), passed in as a plain string so report keeps its independence from the finding package; the sarif writer maps it onto a sarif level.