local

Documentation

Index

• Variables
• type Applier
• type ApplierApplyLayersArgs
• type ApplierApplyLayersExpectation
• type ApplierApplyLayersReturns
• type MockApplier
  • func (_m *MockApplier) ApplyApplyLayersExpectation(e ApplierApplyLayersExpectation)
  • func (_m *MockApplier) ApplyApplyLayersExpectations(expectations []ApplierApplyLayersExpectation)
  • func (_m *MockApplier) ApplyLayers(artifactID string, blobIDs []string) (types.ArtifactDetail, error)
• type MockOspkgDetector
  • func (_m *MockOspkgDetector) ApplyDetectExpectation(e OspkgDetectorDetectExpectation)
  • func (_m *MockOspkgDetector) ApplyDetectExpectations(expectations []OspkgDetectorDetectExpectation)
  • func (_m *MockOspkgDetector) Detect(imageName string, osFamily string, osName string, repo *types.Repository, ...) ([]pkgtypes.DetectedVulnerability, bool, error)
• type OspkgDetector
• type OspkgDetectorDetectArgs
• type OspkgDetectorDetectExpectation
• type OspkgDetectorDetectReturns
• type Scanner
  • func NewScanner(applier Applier, ospkgDetector OspkgDetector) Scanner
  • func (s Scanner) Scan(target string, artifactKey string, blobKeys []string, ...) (types.Results, *ftypes.OS, error)

Variables

var SuperSet = wire.NewSet(
	applier.NewApplier,
	wire.Bind(new(Applier), new(applier.Applier)),
	ospkgDetector.SuperSet,
	wire.Bind(new(OspkgDetector), new(ospkgDetector.Detector)),
	NewScanner,
)

SuperSet binds dependencies for Local scan

Types

type Applier

type Applier interface {
	ApplyLayers(artifactID string, blobIDs []string) (detail ftypes.ArtifactDetail, err error)
}

Applier defines operation to scan image layers

type ApplierApplyLayersArgs

type ApplierApplyLayersArgs struct {
	ArtifactID         string
	ArtifactIDAnything bool
	BlobIDs            []string
	BlobIDsAnything    bool
}

type ApplierApplyLayersExpectation

type ApplierApplyLayersExpectation struct {
	Args    ApplierApplyLayersArgs
	Returns ApplierApplyLayersReturns
}

type ApplierApplyLayersReturns

type ApplierApplyLayersReturns struct {
	Detail types.ArtifactDetail
	Err    error
}

type MockApplier

type MockApplier struct {
	mock.Mock
}

MockApplier is an autogenerated mock type for the Applier type

func (*MockApplier) ApplyApplyLayersExpectation

func (_m *MockApplier) ApplyApplyLayersExpectation(e ApplierApplyLayersExpectation)

func (*MockApplier) ApplyApplyLayersExpectations

func (_m *MockApplier) ApplyApplyLayersExpectations(expectations []ApplierApplyLayersExpectation)

func (*MockApplier) ApplyLayers

func (_m *MockApplier) ApplyLayers(artifactID string, blobIDs []string) (types.ArtifactDetail, error)

ApplyLayers provides a mock function with given fields: artifactID, blobIDs

type MockOspkgDetector

type MockOspkgDetector struct {
	mock.Mock
}

MockOspkgDetector is an autogenerated mock type for the OspkgDetector type

func (*MockOspkgDetector) ApplyDetectExpectation

func (_m *MockOspkgDetector) ApplyDetectExpectation(e OspkgDetectorDetectExpectation)

func (*MockOspkgDetector) ApplyDetectExpectations

func (_m *MockOspkgDetector) ApplyDetectExpectations(expectations []OspkgDetectorDetectExpectation)

func (*MockOspkgDetector) Detect

func (_m *MockOspkgDetector) Detect(imageName string, osFamily string, osName string, repo *types.Repository, created time.Time, pkgs []types.Package) ([]pkgtypes.DetectedVulnerability, bool, error)

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

type OspkgDetector

type OspkgDetector interface {
	Detect(imageName, osFamily, osName string, repo *ftypes.Repository, created time.Time, pkgs []ftypes.Package) (detectedVulns []types.DetectedVulnerability, eosl bool, err error)
}

OspkgDetector defines operation to detect OS vulnerabilities

type OspkgDetectorDetectArgs

type OspkgDetectorDetectArgs struct {
	ImageName         string
	ImageNameAnything bool
	OsFamily          string
	OsFamilyAnything  bool
	OsName            string
	OsNameAnything    bool
	Repo              *types.Repository
	RepoAnything      bool
	Created           time.Time
	CreatedAnything   bool
	Pkgs              []types.Package
	PkgsAnything      bool
}

type OspkgDetectorDetectExpectation

type OspkgDetectorDetectExpectation struct {
	Args    OspkgDetectorDetectArgs
	Returns OspkgDetectorDetectReturns
}

type OspkgDetectorDetectReturns

type OspkgDetectorDetectReturns struct {
	DetectedVulns []pkgtypes.DetectedVulnerability
	Eosl          bool
	Err           error
}

type Scanner

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

Scanner implements the OspkgDetector and LibraryDetector

func NewScanner

func NewScanner(applier Applier, ospkgDetector OspkgDetector) Scanner

NewScanner is the factory method for Scanner

func (Scanner) Scan

func (s Scanner) Scan(target string, artifactKey string, blobKeys []string, options types.ScanOptions) (types.Results, *ftypes.OS, error)

Scan scans the artifact and return results.