option

Documentation

Index

• Constants
• type ArtifactOption
  • func NewArtifactOption(c *cli.Context) ArtifactOption
  • func (c *ArtifactOption) Init(ctx *cli.Context, logger *zap.SugaredLogger) (err error)
• type CacheOption
  • func NewCacheOption(c *cli.Context) CacheOption
  • func (c *CacheOption) CacheBackendMasked() string
  • func (c *CacheOption) Init() error
• type ConfigOption
  • func NewConfigOption(c *cli.Context) ConfigOption
• type DBOption
  • func NewDBOption(c *cli.Context) DBOption
  • func (c *DBOption) Init() (err error)
• type GlobalOption
  • func NewGlobalOption(c *cli.Context) (GlobalOption, error)
• type ImageOption
  • func NewImageOption(c *cli.Context) ImageOption
• type KubernetesOption
  • func NewKubernetesOption(c *cli.Context) KubernetesOption
• type OtherOption
  • func NewOtherOption(c *cli.Context) OtherOption
• type RedisOption
• type RemoteOption
  • func NewRemoteOption(c *cli.Context) RemoteOption
  • func (c *RemoteOption) Init(logger *zap.SugaredLogger)
• type ReportOption
  • func NewReportOption(c *cli.Context) ReportOption
  • func (c *ReportOption) Init(output io.Writer, logger *zap.SugaredLogger) error
• type SbomOption
  • func NewSbomOption(c *cli.Context) SbomOption
  • func (c *SbomOption) Init(ctx *cli.Context, logger *zap.SugaredLogger) error
• type SecretOption
  • func NewSecretOption(c *cli.Context) SecretOption

Constants

const DefaultTokenHeader = "Trivy-Token"

Types

type ArtifactOption

type ArtifactOption struct {
	Input      string
	Timeout    time.Duration
	ClearCache bool

	SkipDirs    []string
	SkipFiles   []string
	OfflineScan bool

	// this field is populated in Init()
	Target string
}

ArtifactOption holds the options for an artifact scanning

func NewArtifactOption

func NewArtifactOption(c *cli.Context) ArtifactOption

NewArtifactOption is the factory method to return artifact option

func (*ArtifactOption) Init

func (c *ArtifactOption) Init(ctx *cli.Context, logger *zap.SugaredLogger) (err error)

Init initialize the CLI context for artifact scanning

type CacheOption

type CacheOption struct {
	CacheBackend string
	CacheTTL     time.Duration
	RedisOption
}

CacheOption holds the options for cache

func NewCacheOption

func NewCacheOption(c *cli.Context) CacheOption

NewCacheOption returns an instance of CacheOption

func (*CacheOption) CacheBackendMasked

func (c *CacheOption) CacheBackendMasked() string

CacheBackendMasked returns the redis connection string masking credentials

func (*CacheOption) Init

func (c *CacheOption) Init() error

Init initialize the CacheOption

type ConfigOption

type ConfigOption struct {
	FilePatterns       []string
	IncludeNonFailures bool
	SkipPolicyUpdate   bool
	Trace              bool

	// Rego
	PolicyPaths      []string
	DataPaths        []string
	PolicyNamespaces []string
}

ConfigOption holds the options for config scanning

func NewConfigOption

func NewConfigOption(c *cli.Context) ConfigOption

NewConfigOption is the factory method to return config scanning options

type DBOption

type DBOption struct {
	Reset          bool
	DownloadDBOnly bool
	SkipDBUpdate   bool
	Light          bool
	NoProgress     bool
	DBRepository   string
}

DBOption holds the options for trivy DB

func NewDBOption

func NewDBOption(c *cli.Context) DBOption

NewDBOption is the factory method to return the DBOption

func (*DBOption) Init

func (c *DBOption) Init() (err error)

Init initialize the DBOption

type GlobalOption

type GlobalOption struct {
	Context *cli.Context
	Logger  *zap.SugaredLogger

	AppVersion string
	Quiet      bool
	Debug      bool
	CacheDir   string
}

GlobalOption holds the global options for trivy

func NewGlobalOption

func NewGlobalOption(c *cli.Context) (GlobalOption, error)

NewGlobalOption is the factory method to return GlobalOption

type ImageOption

type ImageOption struct {
	ScanRemovedPkgs bool
}

ImageOption holds the options for scanning images

func NewImageOption

func NewImageOption(c *cli.Context) ImageOption

NewImageOption is the factory method to return ImageOption

type KubernetesOption

type KubernetesOption struct {
	ClusterContext string
	Namespace      string
	ReportFormat   string
}

KubernetesOption holds the options for Kubernetes scanning

func NewKubernetesOption

func NewKubernetesOption(c *cli.Context) KubernetesOption

NewKubernetesOption is the factory method to return Kubernetes options

type OtherOption

type OtherOption struct {
	Insecure bool
}

func NewOtherOption

func NewOtherOption(c *cli.Context) OtherOption

NewOtherOption is the factory method to return other option

type RedisOption

type RedisOption struct {
	RedisCACert string
	RedisCert   string
	RedisKey    string
}

RedisOption holds the options for redis cache

type RemoteOption

type RemoteOption struct {
	RemoteAddr string

	// this field is populated in Init()
	CustomHeaders http.Header
	// contains filtered or unexported fields
}

RemoteOption holds options for client/server

func NewRemoteOption

func NewRemoteOption(c *cli.Context) RemoteOption

func (*RemoteOption) Init

func (c *RemoteOption) Init(logger *zap.SugaredLogger)

Init initialize the options for client/server mode

type ReportOption

type ReportOption struct {
	Format         string
	Template       string
	DependencyTree bool

	IgnoreFile    string
	IgnoreUnfixed bool
	ExitCode      int
	IgnorePolicy  string

	// these variables are populated by Init()
	VulnType       []string
	SecurityChecks []string
	Output         io.Writer
	Severities     []dbTypes.Severity
	ListAllPkgs    bool
	// contains filtered or unexported fields
}

ReportOption holds the options for reporting scan results

func NewReportOption

func NewReportOption(c *cli.Context) ReportOption

NewReportOption is the factory method to return ReportOption

func (*ReportOption) Init

func (c *ReportOption) Init(output io.Writer, logger *zap.SugaredLogger) error

Init initializes the ReportOption

type SbomOption

type SbomOption struct {
	ArtifactType string
	SbomFormat   string
}

SbomOption holds the options for SBOM generation

func NewSbomOption

func NewSbomOption(c *cli.Context) SbomOption

NewSbomOption is the factory method to return SBOM options

func (*SbomOption) Init

func (c *SbomOption) Init(ctx *cli.Context, logger *zap.SugaredLogger) error

Init initialize the CLI context for SBOM generation

type SecretOption

type SecretOption struct {
	SecretConfigPath string
}

SecretOption holds the options for secret scanning

func NewSecretOption

func NewSecretOption(c *cli.Context) SecretOption

NewSecretOption is the factory method to return secret options