scanner

Documentation

Index

• Variables
• type Driver
• type DriverScanArgs
• type DriverScanExpectation
• type DriverScanReturns
• type MockDriver
  • func (_m *MockDriver) ApplyScanExpectation(e DriverScanExpectation)
  • func (_m *MockDriver) ApplyScanExpectations(expectations []DriverScanExpectation)
  • func (_m *MockDriver) Scan(ctx context.Context, target string, artifactKey string, blobKeys []string, ...) (types.Results, *fanaltypes.OS, error)
• type Scanner
  • func NewScanner(driver Driver, ar artifact.Artifact) Scanner
  • func (s Scanner) ScanArtifact(ctx context.Context, options types.ScanOptions) (types.Report, error)

Variables

var RemoteArchiveSet = wire.NewSet(
	aimage.NewArtifact,
	image.NewArchiveImage,
	RemoteSuperSet,
)

RemoteArchiveSet binds remote archive dependencies

var RemoteDockerSet = wire.NewSet(
	aimage.NewArtifact,
	wire.Value([]image.Option(nil)),
	image.NewContainerImage,
	RemoteSuperSet,
)

RemoteDockerSet binds remote docker dependencies

var RemoteFilesystemSet = wire.NewSet(
	flocal.NewArtifact,
	RemoteSuperSet,
)

RemoteFilesystemSet binds filesystem dependencies for client/server mode

var RemoteSBOMSet = wire.NewSet(
	sbom.NewArtifact,
	RemoteSuperSet,
)

RemoteSBOMSet binds sbom dependencies for client/server mode

var RemoteSuperSet = wire.NewSet(
	client.NewScanner,
	wire.Value([]client.Option(nil)),
	wire.Bind(new(Driver), new(client.Scanner)),
	NewScanner,
)

RemoteSuperSet is used in the client mode

var StandaloneArchiveSet = wire.NewSet(
	image.NewArchiveImage,
	aimage.NewArtifact,
	StandaloneSuperSet,
)

StandaloneArchiveSet binds archive scan dependencies

var StandaloneDockerSet = wire.NewSet(
	wire.Value([]image.Option(nil)),
	image.NewContainerImage,
	aimage.NewArtifact,
	StandaloneSuperSet,
)

StandaloneDockerSet binds docker dependencies

var StandaloneFilesystemSet = wire.NewSet(
	flocal.NewArtifact,
	StandaloneSuperSet,
)

StandaloneFilesystemSet binds filesystem dependencies

var StandaloneRepositorySet = wire.NewSet(
	remote.NewArtifact,
	StandaloneSuperSet,
)

StandaloneRepositorySet binds repository dependencies

var StandaloneSBOMSet = wire.NewSet(
	sbom.NewArtifact,
	StandaloneSuperSet,
)

StandaloneSBOMSet binds sbom dependencies

var StandaloneSuperSet = wire.NewSet(
	local.SuperSet,
	wire.Bind(new(Driver), new(local.Scanner)),
	NewScanner,
)

StandaloneSuperSet is used in the standalone mode

Types

type Driver

type Driver interface {
	Scan(ctx context.Context, target, artifactKey string, blobKeys []string, options types.ScanOptions) (
		results types.Results, osFound *ftypes.OS, err error)
}

Driver defines operations of scanner

type DriverScanArgs

type DriverScanArgs struct {
	Ctx              context.Context
	CtxAnything      bool
	Target           string
	TargetAnything   bool
	ImageID          string
	ImageIDAnything  bool
	LayerIDs         []string
	LayerIDsAnything bool
	Options          types.ScanOptions
	OptionsAnything  bool
}

type DriverScanExpectation

type DriverScanExpectation struct {
	Args    DriverScanArgs
	Returns DriverScanReturns
}

type DriverScanReturns

type DriverScanReturns struct {
	Results types.Results
	OsFound *fanaltypes.OS
	Err     error
}

type MockDriver

type MockDriver struct {
	mock.Mock
}

MockDriver is an autogenerated mock type for the Driver type

func (*MockDriver) ApplyScanExpectation

func (_m *MockDriver) ApplyScanExpectation(e DriverScanExpectation)

func (*MockDriver) ApplyScanExpectations

func (_m *MockDriver) ApplyScanExpectations(expectations []DriverScanExpectation)

func (*MockDriver) Scan

func (_m *MockDriver) Scan(ctx context.Context, target string, artifactKey string, blobKeys []string, options types.ScanOptions) (types.Results, *fanaltypes.OS, error)

Scan provides a mock function with given fields: ctx, target, imageID, layerIDs, options

type Scanner

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

Scanner implements the Artifact and Driver operations

func NewScanner

func NewScanner(driver Driver, ar artifact.Artifact) Scanner

NewScanner is the factory method of Scanner

func (Scanner) ScanArtifact

func (s Scanner) ScanArtifact(ctx context.Context, options types.ScanOptions) (types.Report, error)

ScanArtifact scans the artifacts and returns results