library

Documentation

Index

• func Detect(libType string, pkgs []ftypes.Package) ([]types.DetectedVulnerability, error)
• type Advisory
  • func NewAdvisory(ecosystem string, comparer comparer.Comparer) *Advisory
  • func (s *Advisory) DetectVulnerabilities(pkgName, pkgVer string) ([]types.DetectedVulnerability, error)
• type Driver
  • func Aggregate(ecosystem string, advisories ...advisory) Driver
  • func NewDriver(libType string) (Driver, error)
  • func (d *Driver) Detect(pkgName string, pkgVer string) ([]types.DetectedVulnerability, error)
  • func (d *Driver) Type() string
• type MockOperation
  • func (_m *MockOperation) ApplyDetectExpectation(e OperationDetectExpectation)
  • func (_m *MockOperation) ApplyDetectExpectations(expectations []OperationDetectExpectation)
  • func (_m *MockOperation) Detect(imageName string, filePath string, created time.Time, pkgs []types.Package) ([]pkgtypes.DetectedVulnerability, error)
• type OperationDetectArgs
• type OperationDetectExpectation
• type OperationDetectReturns

Functions

func Detect

func Detect(libType string, pkgs []ftypes.Package) ([]types.DetectedVulnerability, error)

Detect scans and returns vulnerabilities of library

Types

type Advisory

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

Advisory represents security advisories for each programming language

func NewAdvisory

func NewAdvisory(ecosystem string, comparer comparer.Comparer) *Advisory

NewAdvisory is the factory method of Advisory

func (*Advisory) DetectVulnerabilities

func (s *Advisory) DetectVulnerabilities(pkgName, pkgVer string) ([]types.DetectedVulnerability, error)

DetectVulnerabilities scans buckets with the prefix according to the ecosystem in "Advisory". If "ecosystem" is pip, it looks for buckets with "pip::" and gets security advisories from those buckets. It allows us to add a new data source with the ecosystem prefix (e.g. pip::new-data-source) and detect vulnerabilities without specifying a specific bucket name.

type Driver

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

Driver implements the advisory

func Aggregate

func Aggregate(ecosystem string, advisories ...advisory) Driver

Aggregate aggregates drivers

func NewDriver

func NewDriver(libType string) (Driver, error)

NewDriver returns a driver according to the library type

func (*Driver) Detect

func (d *Driver) Detect(pkgName string, pkgVer string) ([]types.DetectedVulnerability, error)

Detect scans and returns vulnerabilities

func (*Driver) Type

func (d *Driver) Type() string

Type returns the driver ecosystem

type MockOperation

type MockOperation struct {
	mock.Mock
}

MockOperation is an autogenerated mock type for the Operation type

func (*MockOperation) ApplyDetectExpectation

func (_m *MockOperation) ApplyDetectExpectation(e OperationDetectExpectation)

func (*MockOperation) ApplyDetectExpectations

func (_m *MockOperation) ApplyDetectExpectations(expectations []OperationDetectExpectation)

func (*MockOperation) Detect

func (_m *MockOperation) Detect(imageName string, filePath string, created time.Time, pkgs []types.Package) ([]pkgtypes.DetectedVulnerability, error)

Detect provides a mock function with given fields: imageName, filePath, created, pkgs

type OperationDetectArgs

type OperationDetectArgs struct {
	ImageName         string
	ImageNameAnything bool
	FilePath          string
	FilePathAnything  bool
	Created           time.Time
	CreatedAnything   bool
	Pkgs              []types.Package
	PkgsAnything      bool
}

type OperationDetectExpectation

type OperationDetectExpectation struct {
	Args    OperationDetectArgs
	Returns OperationDetectReturns
}

type OperationDetectReturns

type OperationDetectReturns struct {
	Vulns []pkgtypes.DetectedVulnerability
	Err   error
}