artifact

Documentation

Index

• Variables
• func ConfigRun(ctx *cli.Context) error
• func Exit(c Option, failedResults bool)
• func FilesystemRun(ctx *cli.Context) error
• func ImageRun(ctx *cli.Context) error
• func RepositoryRun(ctx *cli.Context) error
• func RootfsRun(ctx *cli.Context) error
• func Run(cliCtx *cli.Context, artifactType ArtifactType) error
• func SbomRun(ctx *cli.Context) error
• func WithCacheClient(c cache.Cache) runnerOption
• type ArtifactType
• type InitializeScanner
• type Option
  • func InitOption(ctx *cli.Context) (Option, error)
  • func NewOption(c *cli.Context) (Option, error)
  • func (c *Option) Init() error
• type Runner
  • func NewRunner(cliOption Option, opts ...runnerOption) (Runner, error)
• type ScannerConfig

Variables

var (
	SkipScan = errors.New("skip subsequent processes")
)

Functions

func ConfigRun

func ConfigRun(ctx *cli.Context) error

ConfigRun runs scan on config files

func Exit

func Exit(c Option, failedResults bool)

func FilesystemRun

func FilesystemRun(ctx *cli.Context) error

FilesystemRun runs scan on filesystem for language-specific dependencies and config files

func ImageRun

func ImageRun(ctx *cli.Context) error

ImageRun runs scan on container image

func RepositoryRun

func RepositoryRun(ctx *cli.Context) error

RepositoryRun runs scan on repository

func RootfsRun

func RootfsRun(ctx *cli.Context) error

RootfsRun runs scan on rootfs.

func Run

func Run(cliCtx *cli.Context, artifactType ArtifactType) error

Run performs artifact scanning

func SbomRun

func SbomRun(ctx *cli.Context) error

SbomRun runs generates sbom for image and package artifacts

func WithCacheClient

func WithCacheClient(c cache.Cache) runnerOption

WithCacheClient takes a custom cache implementation

Types

type ArtifactType

type ArtifactType string

type InitializeScanner

type InitializeScanner func(context.Context, ScannerConfig) (scanner.Scanner, func(), error)

InitializeScanner defines the initialize function signature of scanner

type Option

type Option struct {
	option.GlobalOption
	option.ArtifactOption
	option.DBOption
	option.ImageOption
	option.ReportOption
	option.CacheOption
	option.ConfigOption
	option.RemoteOption
	option.SbomOption
	option.SecretOption
	option.KubernetesOption
	option.OtherOption

	// We don't want to allow disabled analyzers to be passed by users,
	// but it differs depending on scanning modes.
	DisabledAnalyzers []analyzer.Type
}

Option holds the artifact options

func InitOption

func InitOption(ctx *cli.Context) (Option, error)

func NewOption

func NewOption(c *cli.Context) (Option, error)

NewOption is the factory method to return options

func (*Option) Init

func (c *Option) Init() error

Init initializes the artifact options

type Runner

type Runner interface {
	// ScanImage scans an image
	ScanImage(ctx context.Context, opt Option) (types.Report, error)
	// ScanFilesystem scans a filesystem
	ScanFilesystem(ctx context.Context, opt Option) (types.Report, error)
	// ScanRootfs scans rootfs
	ScanRootfs(ctx context.Context, opt Option) (types.Report, error)
	// ScanRepository scans repository
	ScanRepository(ctx context.Context, opt Option) (types.Report, error)
	// Filter filter a report
	Filter(ctx context.Context, opt Option, report types.Report) (types.Report, error)
	// Report a writes a report
	Report(opt Option, report types.Report) error
	// Close closes runner
	Close(ctx context.Context) error
}

func NewRunner

func NewRunner(cliOption Option, opts ...runnerOption) (Runner, error)

NewRunner initializes Runner that provides scanning functionalities. It is possible to return SkipScan and it must be handled by caller.

type ScannerConfig

type ScannerConfig struct {
	// e.g. image name and file path
	Target string

	// Cache
	ArtifactCache      cache.ArtifactCache
	LocalArtifactCache cache.LocalArtifactCache

	// Client/Server options
	RemoteOption client.ScannerOption

	// Artifact options
	ArtifactOption artifact.Option
}