explain

Documentation

Index

• type Findings
  • func Doc(doc *models.Document, requestedIDs []string) (Findings, error)
• type ViewModel
• type VulnerabilityExplainer
  • func NewVulnerabilityExplainer(w io.Writer, doc *models.Document) VulnerabilityExplainer

Types

type Findings

type Findings map[string]ViewModel

func Doc

func Doc(doc *models.Document, requestedIDs []string) (Findings, error)

type ViewModel

type ViewModel struct {
	PrimaryVulnerability   models.VulnerabilityMetadata
	RelatedVulnerabilities []models.VulnerabilityMetadata
	MatchedPackages        []*explainedPackage // I think this needs a map of artifacts to explained evidence
	URLs                   []string
}

type VulnerabilityExplainer

type VulnerabilityExplainer interface {
	ExplainByID(IDs []string) error
	ExplainBySeverity(severity string) error
	ExplainAll() error
}

func NewVulnerabilityExplainer

func NewVulnerabilityExplainer(w io.Writer, doc *models.Document) VulnerabilityExplainer