options

package
v0.96.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 8, 2023 License: Apache-2.0 Imports: 35 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Attest added in v0.89.0

type Attest struct {
	// IMPORTANT: do not show the attestation key/password in any YAML/JSON output (sensitive information)
	Key      secret `yaml:"key" json:"key" mapstructure:"key"`
	Password secret `yaml:"password" json:"password" mapstructure:"password"`
}

func (Attest) AddFlags added in v0.89.0

func (o Attest) AddFlags(flags clio.FlagSet)

type Catalog added in v0.89.0

type Catalog struct {
	Catalogers                      []string           `yaml:"catalogers" json:"catalogers" mapstructure:"catalogers"`
	Package                         pkg                `yaml:"package" json:"package" mapstructure:"package"`
	Golang                          golang             `yaml:"golang" json:"golang" mapstructure:"golang"`
	Java                            java               `yaml:"java" json:"java" mapstructure:"java"`
	LinuxKernel                     linuxKernel        `yaml:"linux-kernel" json:"linux-kernel" mapstructure:"linux-kernel"`
	Python                          python             `yaml:"python" json:"python" mapstructure:"python"`
	FileMetadata                    fileMetadata       `yaml:"file-metadata" json:"file-metadata" mapstructure:"file-metadata"`
	FileClassification              fileClassification `yaml:"file-classification" json:"file-classification" mapstructure:"file-classification"`
	FileContents                    fileContents       `yaml:"file-contents" json:"file-contents" mapstructure:"file-contents"`
	Secrets                         secrets            `yaml:"secrets" json:"secrets" mapstructure:"secrets"`
	Registry                        registry           `yaml:"registry" json:"registry" mapstructure:"registry"`
	Exclusions                      []string           `yaml:"exclude" json:"exclude" mapstructure:"exclude"`
	Platform                        string             `yaml:"platform" json:"platform" mapstructure:"platform"`
	Name                            string             `yaml:"name" json:"name" mapstructure:"name"`
	Source                          sourceCfg          `yaml:"source" json:"source" mapstructure:"source"`
	Parallelism                     int                `yaml:"parallelism" json:"parallelism" mapstructure:"parallelism"`                                           // the number of catalog workers to run in parallel
	DefaultImagePullSource          string             `yaml:"default-image-pull-source" json:"default-image-pull-source" mapstructure:"default-image-pull-source"` // specify default image pull source
	BasePath                        string             `yaml:"base-path" json:"base-path" mapstructure:"base-path"`                                                 // specify base path for all file paths
	ExcludeBinaryOverlapByOwnership bool               ``                                                                                                           // exclude synthetic binary packages owned by os package files
	/* 136-byte string literal not displayed */
}

func DefaultCatalog added in v0.89.0

func DefaultCatalog() Catalog

func (*Catalog) AddFlags added in v0.89.0

func (cfg *Catalog) AddFlags(flags clio.FlagSet)

func (*Catalog) PostLoad added in v0.89.0

func (cfg *Catalog) PostLoad() error

func (Catalog) ToCatalogerConfig added in v0.89.0

func (cfg Catalog) ToCatalogerConfig() cataloger.Config

type Config added in v0.89.0

type Config struct {
	ConfigFile string `yaml:"config" json:"config" mapstructure:"config"`
}

Config holds a reference to the specific config file that was used to load application configuration

type Format added in v0.95.0

type Format struct {
	Template FormatTemplate `yaml:"template" json:"template" mapstructure:"template"`
	JSON     FormatJSON     `yaml:"json" json:"json" mapstructure:"json"`
}

Format contains all user configuration for output formatting.

func DefaultFormat added in v0.95.0

func DefaultFormat() Format

func (*Format) Encoders added in v0.95.0

func (o *Format) Encoders() ([]sbom.FormatEncoder, error)

type FormatJSON added in v0.95.0

type FormatJSON struct {
	Legacy bool `yaml:"legacy" json:"legacy" mapstructure:"legacy"`
}

func DefaultFormatJSON added in v0.95.0

func DefaultFormatJSON() FormatJSON

type FormatTemplate added in v0.95.0

type FormatTemplate struct {
	Enabled bool   `yaml:"-" json:"-" mapstructure:"-"`
	Path    string `yaml:"path" json:"path" mapstructure:"path"` // -t template file to use for output
}

func DefaultFormatTemplate added in v0.95.0

func DefaultFormatTemplate() FormatTemplate

func (*FormatTemplate) AddFlags added in v0.95.0

func (o *FormatTemplate) AddFlags(flags clio.FlagSet)

type Output added in v0.95.0

type Output struct {
	AllowableOptions     []string `yaml:"-" json:"-" mapstructure:"-"`
	AllowMultipleOutputs bool     `yaml:"-" json:"-" mapstructure:"-"`
	Outputs              []string `yaml:"output" json:"output" mapstructure:"output"` // -o, the format to use for output
	OutputFile           `yaml:",inline" json:"" mapstructure:",squash"`
	Format               `yaml:"format" json:"format" mapstructure:"format"`
}

Output has the standard output options syft accepts: multiple -o, --file, --template

func DefaultOutput added in v0.89.0

func DefaultOutput() Output

func (*Output) AddFlags added in v0.95.0

func (o *Output) AddFlags(flags clio.FlagSet)

func (Output) OutputNameSet added in v0.95.0

func (o Output) OutputNameSet() *strset.Set

func (Output) SBOMWriter added in v0.95.0

func (o Output) SBOMWriter() (sbom.Writer, error)

type OutputFile deprecated added in v0.89.0

type OutputFile struct {
	Enabled bool   `yaml:"-" json:"-" mapstructure:"-"`
	File    string `yaml:"file" json:"file" mapstructure:"file"`
}

Deprecated: OutputFile supports the --file to write the SBOM output to

func (*OutputFile) AddFlags added in v0.89.0

func (o *OutputFile) AddFlags(flags clio.FlagSet)

func (*OutputFile) PostLoad added in v0.89.0

func (o *OutputFile) PostLoad() error

func (*OutputFile) SBOMWriter added in v0.89.0

func (o *OutputFile) SBOMWriter(f sbom.FormatEncoder) (sbom.Writer, error)

type RegistryCredentials added in v0.89.0

type RegistryCredentials struct {
	Authority string `yaml:"authority" json:"authority" mapstructure:"authority"`
	// IMPORTANT: do not show any credential information, use secret type to automatically redact the values
	Username secret `yaml:"username" json:"username" mapstructure:"username"`
	Password secret `yaml:"password" json:"password" mapstructure:"password"`
	Token    secret `yaml:"token" json:"token" mapstructure:"token"`

	TLSCert string `yaml:"tls-cert,omitempty" json:"tls-cert,omitempty" mapstructure:"tls-cert"`
	TLSKey  string `yaml:"tls-key,omitempty" json:"tls-key,omitempty" mapstructure:"tls-key"`
}

type UpdateCheck added in v0.89.0

type UpdateCheck struct {
	CheckForAppUpdate bool `yaml:"check-for-app-update" json:"check-for-app-update" mapstructure:"check-for-app-update"` // whether to check for an application update on start up or not
}

func DefaultUpdateCheck added in v0.89.0

func DefaultUpdateCheck() UpdateCheck

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL