match

Documentation

Index

• Variables
• type ByElements
  • func (m ByElements) Len() int
  • func (m ByElements) Less(i, j int) bool
  • func (m ByElements) Swap(i, j int)
• type Details
• type Fingerprint
• type Match
  • func (m Match) Fingerprint() Fingerprint
  • func (m Match) String() string
  • func (m Match) Summary() string
• type MatcherType
  • func (f MatcherType) String() string
• type Matches
  • func NewMatches() Matches
  • func (r *Matches) Add(p pkg.Package, matches ...Match)
  • func (r *Matches) Count() int
  • func (r *Matches) Enumerate() <-chan Match
  • func (r *Matches) GetByPkgID(id pkg.ID) []Match
  • func (r *Matches) Merge(other Matches)
  • func (r *Matches) Sorted() []Match
• type Type
  • func ParseType(userStr string) Type
  • func (f Type) String() string

Variables

var AllMatcherTypes = []MatcherType{
	ApkMatcher,
	RubyGemMatcher,
	DpkgMatcher,
	RpmDBMatcher,
	JavaMatcher,
	PythonMatcher,
	JavascriptMatcher,
	MsrcMatcher,
}

Types

type ByElements

type ByElements []Match

func (ByElements) Len

func (m ByElements) Len() int

Len is the number of elements in the collection.

func (ByElements) Less

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

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

Swap swaps the elements with indexes i and j.

type Details

type Details struct {
	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).
}

type Fingerprint

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

type Match

type Match struct {
	Type          Type                        // The kind of match made (an exact match, fuzzy match, indirect vs direct, etc).
	Vulnerability vulnerability.Vulnerability // The vulnerability details of the match.
	Package       pkg.Package                 // The package used to search for a match.
	MatchDetails  []Details                   // all ways in which how 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

func (m Match) Fingerprint() Fingerprint

func (Match) String

func (m Match) String() string

String is the string representation of select match fields.

func (Match) Summary

func (m Match) Summary() string

type MatcherType

type MatcherType int

const (
	UnknownMatcherType MatcherType = iota
	ApkMatcher
	RubyGemMatcher
	DpkgMatcher
	RpmDBMatcher
	JavaMatcher
	PythonMatcher
	JavascriptMatcher
	MsrcMatcher
)

func (MatcherType) String

func (f MatcherType) String() string

type Matches

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

func NewMatches

func NewMatches() Matches

func (*Matches) Add

func (r *Matches) Add(p pkg.Package, matches ...Match)

func (*Matches) Count

func (r *Matches) Count() int

Count returns the total number of matches in a result

func (*Matches) Enumerate

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

func (*Matches) GetByPkgID

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

GetByPkgID returns a slice of potential matches from an ID

func (*Matches) Merge

func (r *Matches) Merge(other Matches)

func (*Matches) Sorted

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

type Type

type Type int

const (
	UnknownMatchType Type = iota
	ExactDirectMatch
	ExactIndirectMatch
	FuzzyMatch
)

func ParseType

func ParseType(userStr string) Type

func (Type) String

func (f Type) String() string