artifact

Documentation

Index

• func ConfigRun(ctx *cli.Context) error
• 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(ctx context.Context, opt Option, initializeScanner InitializeScanner, ...) error
• func SbomRun(ctx *cli.Context) error
• type ArtifactType
• type InitCache
• type InitializeScanner
• type Option
  • func NewOption(c *cli.Context) (Option, error)
  • func (c *Option) Init() error

Functions

func ConfigRun

func ConfigRun(ctx *cli.Context) error

ConfigRun runs scan on config files

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(ctx context.Context, opt Option, initializeScanner InitializeScanner, initCache InitCache) error

Run performs artifact scanning

func SbomRun

func SbomRun(ctx *cli.Context) error

SbomRun runs generates sbom for image and package artifacts

Types

type ArtifactType

type ArtifactType string

type InitCache

type InitCache func(c Option) (cache.Cache, error)

InitCache defines cache initializer

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

	// 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 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