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 PrintHTMLResults(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 HTMLEcosystemResult
- type HTMLPackageResult
- type HTMLResult
- type HTMLSourceResult
- type HTMLVulnCount
- type HTMLVulnResult
- type HTMLVulnResultDetail
- type HTMLVulnResultSummary
- 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 = `` /* 1287-byte string literal not displayed */
Two double-quotes ("") is replaced with a single backtick (`), since we can't embed backticks in raw strings
const TemplateDir = "html/*"
HTML templates directory
const UnfixedDescription = "No fix available"
const VersionUnsupported = "N/A"
Variables ¶
This section is empty.
Functions ¶
func Form ¶ added in v1.4.0
Form returns the singular or plural form that should be used based on the given count
func GroupFixedVersions ¶ added in v1.4.0
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 ¶ added in v1.4.0
func MaxSeverity(group models.GroupInfo, pkg models.PackageVulns) string
func PrintCycloneDXResults ¶ added in v1.8.2
func PrintCycloneDXResults(vulnResult *models.VulnerabilityResults, cycloneDXVersion models.CycloneDXVersion, outputWriter io.Writer) error
PrintCycloneDXResults writes results to the provided writer in CycloneDX format
func PrintGHAnnotationReport ¶ added in v1.4.0
func PrintGHAnnotationReport(vulnResult *models.VulnerabilityResults, outputWriter io.Writer) error
PrintGHAnnotationReport prints Github specific annotations to outputWriter
func PrintHTMLResults ¶ added in v1.9.1
func PrintHTMLResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer) error
func PrintJSONResults ¶
func PrintJSONResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer) error
PrintJSONResults writes results to the provided writer in JSON format
func PrintMarkdownTableResults ¶ added in v1.2.0
func PrintMarkdownTableResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer)
PrintTableResults prints the osv scan results into a human friendly table.
func PrintSARIFReport ¶ added in v1.4.0
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 ¶ added in v1.8.3
func PrintVerticalResults(vulnResult *models.VulnerabilityResults, outputWriter io.Writer)
Types ¶
type FixedPkgTableData ¶ added in v1.4.1
type HTMLEcosystemResult ¶ added in v1.9.1
type HTMLEcosystemResult struct {
Ecosystem string
Sources []HTMLSourceResult
}
HTMLEcosystemResult represents the vulnerability scanning results for an ecosystem.
type HTMLPackageResult ¶ added in v1.9.1
type HTMLPackageResult struct {
Name string
Ecosystem string
Source string
CalledVulns []HTMLVulnResult
UncalledVulns []HTMLVulnResult
InstalledVersion string
FixedVersion string
HTMLVulnCount HTMLVulnCount
}
HTMLPackageResult represents the vulnerability scanning results for a package.
type HTMLResult ¶ added in v1.9.1
type HTMLResult struct {
HTMLVulnCount HTMLVulnCount
EcosystemResults []HTMLEcosystemResult
}
HTMLResult represents the vulnerability scanning results for HTML report.
func BuildHTMLResults ¶ added in v1.9.1
func BuildHTMLResults(vulnResult *models.VulnerabilityResults) HTMLResult
BuildHTMLResults builds HTML results from vulnerability results.
type HTMLSourceResult ¶ added in v1.9.1
type HTMLSourceResult struct {
Source string
Ecosystem string
PackageResults []HTMLPackageResult
CalledPackageCount int
UncalledPackageCount int
HTMLVulnCount HTMLVulnCount
}
HTMLSourceResult represents the vulnerability scanning results for a source file.
type HTMLVulnCount ¶ added in v1.9.1
type HTMLVulnCount struct {
Critical int
High int
Medium int
Low int
Unknown int
Called int
Uncalled int
Fixed int
UnFixed int
}
HTMLVulnCount represents the counts of vulnerabilities by severity and fixed/unfixed status
type HTMLVulnResult ¶ added in v1.9.1
type HTMLVulnResult struct {
Summary HTMLVulnResultSummary
Detail HTMLVulnResultDetail
}
HTMLVulnResult represents a single vulnerability.
type HTMLVulnResultDetail ¶ added in v1.9.1
type HTMLVulnResultDetail struct {
GroupIDs []string
Aliases []string
LayerCommand string
LayerCommandTooltip string
LayerID string
InBaseImage string
Description string
}
HTMLVulnResultDetail represents detailed information about a vulnerability.
type HTMLVulnResultSummary ¶ added in v1.9.1
type HTMLVulnResultSummary struct {
ID string
PackageName string
InstalledVersion string
FixedVersion string
SeverityRating string
SeverityScore string
}
HTMLVulnResultSummary represents summary information about a vulnerability.