output

Documentation

Index

• Constants
• func Form(count int, singular, plural string) string
• func GroupFixedVersions(flattened []models.VulnerabilityFlattened) map[string][]string
• func MaxSeverity(group models.GroupInfo, pkg models.PackageVulns) string
• func PrintCycloneDXResults(vulnResult *models.VulnerabilityResults, ...) error
• func PrintGHAnnotationReport(vulnResult *models.VulnerabilityResults, outputWriter io.Writer) error
• func PrintJSONResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer) error
• func PrintMarkdownTableResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer)
• func PrintSARIFReport(vulnResult *models.VulnerabilityResults, outputWriter io.Writer) error
• func PrintTableResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer, ...)
• func PrintVerticalResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer)
• type FixedPkgTableData
• type HelpTemplateData
• type VulnDescription

Constants

const OSVBaseVulnerabilityURL = "https://osv.dev/"

OSVBaseVulnerabilityURL is the base URL for detailed vulnerability views. Copied in from osv package to avoid referencing the osv package unnecessarily

const SARIFTemplate = `` /* 1269-byte string literal not displayed */

Two double-quotes ("") is replaced with a single backtick (`), since we can't embed backticks in raw strings

Functions

func Form

func Form(count int, singular, plural string) string

Form returns the singular or plural form that should be used based on the given count

func GroupFixedVersions

func GroupFixedVersions(flattened []models.VulnerabilityFlattened) map[string][]string

GroupFixedVersions builds the fixed versions for each ID Group, with keys formatted like so: `Source:ID`

func MaxSeverity

func MaxSeverity(group models.GroupInfo, pkg models.PackageVulns) string

func PrintCycloneDXResults

func PrintCycloneDXResults(vulnResult *models.VulnerabilityResults, cycloneDXVersion models.CycloneDXVersion, outputWriter io.Writer) error

PrintCycloneDXResults writes results to the provided writer in CycloneDX format

func PrintGHAnnotationReport

func PrintGHAnnotationReport(vulnResult *models.VulnerabilityResults, outputWriter io.Writer) error

PrintGHAnnotationReport prints Github specific annotations to outputWriter

func PrintJSONResults

func PrintJSONResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer) error

PrintJSONResults writes results to the provided writer in JSON format

func PrintMarkdownTableResults

func PrintMarkdownTableResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer)

PrintTableResults prints the osv scan results into a human friendly table.

func PrintSARIFReport

func PrintSARIFReport(vulnResult *models.VulnerabilityResults, outputWriter io.Writer) error

PrintSARIFReport prints SARIF output to outputWriter

func PrintTableResults

func PrintTableResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer, terminalWidth int)

PrintTableResults prints the osv scan results into a human friendly table.

func PrintVerticalResults

func PrintVerticalResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer)

Types

type FixedPkgTableData

type FixedPkgTableData struct {
	VulnID       string
	PackageName  string
	FixedVersion string
}

type HelpTemplateData

type HelpTemplateData struct {
	ID                    string
	AffectedPackagesTable string
	AffectedPackagePaths  []string
	AliasedVulns          []VulnDescription
	HasFixedVersion       bool
	FixedVersionTable     string
}

type VulnDescription

type VulnDescription struct {
	ID      string
	Details string
}