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"`
}
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"`
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) ToCatalogerConfig ¶ added in v0.89.0
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 MultiOutput ¶ added in v0.89.0
type MultiOutput struct {
Outputs []string `yaml:"output" json:"output" mapstructure:"output"` // -o, the format to use for output
OutputFile `yaml:",inline" json:"" mapstructure:",squash"`
OutputTemplatePath string `yaml:"output-template-path" json:"output-template-path" mapstructure:"output-template-path"` // -t template file to use for output
}
MultiOutput has the standard output options syft accepts: multiple -o, --file, --template
func DefaultOutput ¶ added in v0.89.0
func DefaultOutput() MultiOutput
func (*MultiOutput) AddFlags ¶ added in v0.89.0
func (o *MultiOutput) AddFlags(flags clio.FlagSet)
func (*MultiOutput) SBOMWriter ¶ added in v0.89.0
func (o *MultiOutput) SBOMWriter() (sbom.Writer, error)
type OutputFile
deprecated
added in
v0.89.0
type OutputFile struct {
File string `yaml:"file" json:"file" mapstructure:"file"` // --file, the file to write report output to
}
Deprecated: OutputFile is only the --file argument
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
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 SingleOutput ¶ added in v0.89.0
type SingleOutput struct {
AllowableOptions []string `yaml:"-" json:"-" mapstructure:"-"`
Output string `yaml:"output" json:"output" mapstructure:"output"`
OutputTemplatePath string `yaml:"output-template-path" json:"output-template-path" mapstructure:"output-template-path"` // -t template file to use for output
}
SingleOutput allows only 1 output to be specified, with a user able to set what options are allowed by setting AllowableOptions
func (*SingleOutput) AddFlags ¶ added in v0.89.0
func (o *SingleOutput) AddFlags(flags clio.FlagSet)
func (*SingleOutput) SBOMWriter ¶ added in v0.89.0
func (o *SingleOutput) SBOMWriter(file string) (sbom.Writer, error)
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
Source Files
Click to show internal directories.
Click to hide internal directories.