openvex

Documentation

Index

• type Match
• type Processor
  • func New() *Processor
  • func (ovm *Processor) AugmentMatches(docRaw interface{}, ignoreRules []match.IgnoreRule, pkgContext *pkg.Context, ...) (*match.Matches, []match.IgnoredMatch, error)
  • func (ovm *Processor) FilterMatches(docRaw interface{}, ignoreRules []match.IgnoreRule, pkgContext *pkg.Context, ...) (*match.Matches, []match.IgnoredMatch, error)
  • func (ovm *Processor) ReadVexDocuments(docs []string) (interface{}, error)
• type SearchedBy

Types

type Match

type Match struct {
	Statement openvex.Statement
}

Match captures the criteria that caused a vulnerability to match

type Processor

type Processor struct{}

func New

func New() *Processor

func (*Processor) AugmentMatches

func (ovm *Processor) AugmentMatches(
	docRaw interface{}, ignoreRules []match.IgnoreRule, pkgContext *pkg.Context, remainingMatches *match.Matches, ignoredMatches []match.IgnoredMatch,
) (*match.Matches, []match.IgnoredMatch, error)

AugmentMatches adds results to the match.Matches array when matching data about an affected VEX product is found on loaded VEX documents. Matches are moved from the ignore list or synthesized when no previous data is found.

func (*Processor) FilterMatches

func (ovm *Processor) FilterMatches(
	docRaw interface{}, ignoreRules []match.IgnoreRule, pkgContext *pkg.Context, matches *match.Matches, ignoredMatches []match.IgnoredMatch,
) (*match.Matches, []match.IgnoredMatch, error)

FilterMatches takes a set of scanning results and moves any results marked in the VEX data as fixed or not_affected to the ignored list.

func (*Processor) ReadVexDocuments

func (ovm *Processor) ReadVexDocuments(docs []string) (interface{}, error)

ReadVexDocuments reads and merges VEX documents

type SearchedBy

type SearchedBy struct {
	Vulnerability string
	Product       string
	Subcomponents []string
}

SearchedBy captures the prameters used to search through the VEX data