match

package
v0.86.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 13, 2024 License: Apache-2.0 Imports: 11 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var AllMatcherTypes = []MatcherType{
	ApkMatcher,
	RubyGemMatcher,
	DpkgMatcher,
	RpmMatcher,
	JavaMatcher,
	PythonMatcher,
	DotnetMatcher,
	JavascriptMatcher,
	MsrcMatcher,
	PortageMatcher,
	GoModuleMatcher,
	OpenVexMatcher,
	RustMatcher,
}
View Source 
var ErrCannotMerge = fmt.Errorf("unable to merge vulnerability matches")

Functions

func ApplyExplicitIgnoreRules added in v0.28.0 

func ApplyExplicitIgnoreRules(provider ExclusionProvider, matches Matches) (Matches, []IgnoredMatch)

ApplyExplicitIgnoreRules Filters out matches meeting the criteria defined above and those within the grype database

func ApplyIgnoreRules added in v0.21.1 

func ApplyIgnoreRules(matches Matches, rules []IgnoreRule) (Matches, []IgnoredMatch)

ApplyIgnoreRules iterates through the provided matches and, for each match, determines if the match should be ignored, by evaluating if any of the provided IgnoreRules apply to the match. If any rules apply to the match, all applicable rules are attached to the Match to form an IgnoredMatch. ApplyIgnoreRules returns two collections: the matches that are not being ignored, and the matches that are being ignored.

func ConvertToIndirectMatches added in v0.33.0 

func ConvertToIndirectMatches(matches []Match, p pkg.Package)

Types

type ByElements added in v0.13.0 

type ByElements []Match

func (ByElements) Len added in v0.13.0 

func (m ByElements) Len() int

Len is the number of elements in the collection.

func (ByElements) Less added in v0.13.0 

func (m ByElements) Less(i, j int) bool

Less reports whether the element with index i should sort before the element with index j.

func (ByElements) Swap added in v0.13.0 

func (m ByElements) Swap(i, j int)

Swap swaps the elements with indexes i and j.

type Detail added in v0.33.0 

type Detail struct {
	Type       Type        // The kind of match made (an exact match, fuzzy match, indirect vs direct, etc).
	SearchedBy interface{} // The specific attributes that were used to search (other than package name and version) --this indicates "how" the match was made.
	Found      interface{} // The specific attributes on the vulnerability object that were matched with --this indicates "what" was matched on / within.
	Matcher    MatcherType // The matcher object that discovered the match.
	Confidence float64     // The certainty of the match as a ratio (currently unused, reserved for future use).
}

func (Detail) ID added in v0.33.0 

func (m Detail) ID() string

func (Detail) String added in v0.33.0 

func (m Detail) String() string

String is the string representation of select match fields.

type Details added in v0.13.0 

type Details []Detail

func (Details) Len added in v0.85.0 

func (m Details) Len() int

func (Details) Less added in v0.85.0 

func (m Details) Less(i, j int) bool

func (Details) Matchers added in v0.33.0 

func (m Details) Matchers() (tys []MatcherType)

func (Details) Swap added in v0.85.0 

func (m Details) Swap(i, j int)

func (Details) Types added in v0.33.0 

func (m Details) Types() (tys []Type)

type ExclusionProvider added in v0.41.0 

type ExclusionProvider interface {
	GetRules(vulnerabilityID string) ([]IgnoreRule, error)
}

type Fingerprint added in v0.13.0 

type Fingerprint struct {
	// contains filtered or unexported fields
}

func (Fingerprint) ID added in v0.33.0 

func (m Fingerprint) ID() string

func (Fingerprint) String added in v0.33.0 

func (m Fingerprint) String() string

type IgnoreRule added in v0.21.1 

type IgnoreRule struct {
	Vulnerability    string            `yaml:"vulnerability" json:"vulnerability" mapstructure:"vulnerability"`
	Reason           string            `yaml:"reason" json:"reason" mapstructure:"reason"`
	Namespace        string            `yaml:"namespace" json:"namespace" mapstructure:"namespace"`
	FixState         string            `yaml:"fix-state" json:"fix-state" mapstructure:"fix-state"`
	Package          IgnoreRulePackage `yaml:"package" json:"package" mapstructure:"package"`
	VexStatus        string            `yaml:"vex-status" json:"vex-status" mapstructure:"vex-status"`
	VexJustification string            `yaml:"vex-justification" json:"vex-justification" mapstructure:"vex-justification"`
	MatchType        Type              `yaml:"match-type" json:"match-type" mapstructure:"match-type"`
}

An IgnoreRule specifies criteria for a vulnerability match to meet in order to be ignored. Not all criteria (fields) need to be specified, but all specified criteria must be met by the vulnerability match in order for the rule to apply.

func (IgnoreRule) HasConditions added in v0.68.0 

func (ir IgnoreRule) HasConditions() bool

HasConditions returns true if the ignore rule has conditions that can cause a match to be ignored

type IgnoreRulePackage added in v0.21.1 

type IgnoreRulePackage struct {
	Name         string `yaml:"name" json:"name" mapstructure:"name"`
	Version      string `yaml:"version" json:"version" mapstructure:"version"`
	Language     string `yaml:"language" json:"language" mapstructure:"language"`
	Type         string `yaml:"type" json:"type" mapstructure:"type"`
	Location     string `yaml:"location" json:"location" mapstructure:"location"`
	UpstreamName string `yaml:"upstream-name" json:"upstream-name" mapstructure:"upstream-name"`
}

IgnoreRulePackage describes the Package-specific fields that comprise the IgnoreRule.

type IgnoredMatch added in v0.21.1 

type IgnoredMatch struct {
	Match

	// AppliedIgnoreRules are the rules that were applied to the match that caused Grype to ignore it.
	AppliedIgnoreRules []IgnoreRule
}

An IgnoredMatch is a vulnerability Match that has been ignored because one or more IgnoreRules applied to the match.

type Match 

type Match struct {
	Vulnerability vulnerability.Vulnerability // The vulnerability details of the match.
	Package       pkg.Package                 // The package used to search for a match.
	Details       Details                     // all the ways this particular match was made.
}

Match represents a finding in the vulnerability matching process, pairing a single package and a single vulnerability object.

func (Match) Fingerprint added in v0.13.0 

func (m Match) Fingerprint() Fingerprint

func (*Match) Merge added in v0.33.0 

func (m *Match) Merge(other Match) error

func (Match) String 

func (m Match) String() string

String is the string representation of select match fields.

type MatcherType 

type MatcherType string
const (
	UnknownMatcherType MatcherType = "UnknownMatcherType"
	StockMatcher       MatcherType = "stock-matcher"
	ApkMatcher         MatcherType = "apk-matcher"
	RubyGemMatcher     MatcherType = "ruby-gem-matcher"
	DpkgMatcher        MatcherType = "dpkg-matcher"
	RpmMatcher         MatcherType = "rpm-matcher"
	JavaMatcher        MatcherType = "java-matcher"
	PythonMatcher      MatcherType = "python-matcher"
	DotnetMatcher      MatcherType = "dotnet-matcher"
	JavascriptMatcher  MatcherType = "javascript-matcher"
	MsrcMatcher        MatcherType = "msrc-matcher"
	PortageMatcher     MatcherType = "portage-matcher"
	GoModuleMatcher    MatcherType = "go-module-matcher"
	OpenVexMatcher     MatcherType = "openvex-matcher"
	RustMatcher        MatcherType = "rust-matcher"
)

type Matches 

type Matches struct {
	// contains filtered or unexported fields
}

func NewMatches 

func NewMatches(matches ...Match) Matches

func (*Matches) Add 

func (r *Matches) Add(matches ...Match)

func (*Matches) AllByPkgID added in v0.36.0 

func (r *Matches) AllByPkgID() map[pkg.ID][]Match

AllByPkgID returns a map of all matches organized by package ID

func (*Matches) Count 

func (r *Matches) Count() int

Count returns the total number of matches in a result

func (*Matches) Diff added in v0.68.0 

func (r *Matches) Diff(other Matches) *Matches

func (*Matches) Enumerate 

func (r *Matches) Enumerate() <-chan Match

func (*Matches) GetByPkgID 

func (r *Matches) GetByPkgID(id pkg.ID) (matches []Match)

GetByPkgID returns a slice of potential matches from an ID

func (*Matches) Merge 

func (r *Matches) Merge(other Matches)

func (*Matches) Sorted added in v0.12.1 

func (r *Matches) Sorted() []Match

type Type 

type Type string
const (
	ExactDirectMatch   Type = "exact-direct-match"
	ExactIndirectMatch Type = "exact-indirect-match"
	CPEMatch           Type = "cpe-match"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.