ospkg

Documentation

Index

• Variables
• func RegisterDriver(name string, driver Driver)
• type DetectExpectation
• type DetectInput
• type DetectOutput
• type Detector
  • func (d Detector) Detect(_, osFamily, osName string, repo *ftypes.Repository, _ time.Time, ...) ([]types.DetectedVulnerability, bool, error)
• type Driver
• type MockDetector
  • func NewMockDetector(detectExpectations []DetectExpectation) *MockDetector
  • func (_m *MockDetector) Detect(a string, b string, c string, d time.Time, e []ftypes.Package) ([]types.DetectedVulnerability, bool, error)
• type Operation

Variables

var (
	// ErrUnsupportedOS defines error for unsupported OS
	ErrUnsupportedOS = xerrors.New("unsupported os")

	// SuperSet binds dependencies for OS scan
	SuperSet = wire.NewSet(
		wire.Struct(new(Detector)),
		wire.Bind(new(Operation), new(Detector)),
	)
)

Functions

func RegisterDriver

func RegisterDriver(name string, driver Driver)

RegisterDriver is defined for extensibility and not supposed to be used in Trivy.

Types

type DetectExpectation

type DetectExpectation struct {
	Args       DetectInput
	ReturnArgs DetectOutput
}

type DetectInput

type DetectInput struct {
	ImageName string
	OSFamily  string
	OSName    string
	Created   time.Time
	Pkgs      []ftypes.Package
}

type DetectOutput

type DetectOutput struct {
	Vulns []types.DetectedVulnerability
	Eosl  bool
	Err   error
}

type Detector

type Detector struct{}

Detector implements Operation

func (Detector) Detect

func (d Detector) Detect(_, osFamily, osName string, repo *ftypes.Repository, _ time.Time, pkgs []ftypes.Package) ([]types.DetectedVulnerability, bool, error)

Detect detects the vulnerabilities

type Driver

type Driver interface {
	Detect(string, *ftypes.Repository, []ftypes.Package) ([]types.DetectedVulnerability, error)
	IsSupportedVersion(string, string) bool
}

Driver defines operations for OS package scan

type MockDetector

type MockDetector struct {
	mock.Mock
}

func NewMockDetector

func NewMockDetector(detectExpectations []DetectExpectation) *MockDetector

func (*MockDetector) Detect

func (_m *MockDetector) Detect(a string, b string, c string, d time.Time, e []ftypes.Package) ([]types.DetectedVulnerability, bool, error)

type Operation

type Operation interface {
	Detect(string, string, string, time.Time, []ftypes.Package) ([]types.DetectedVulnerability, bool, error)
}

Operation defines operation of OSpkg scan