options

Documentation

Index

• Constants
• func FormatAliases(ids ...sbom.FormatID) (aliases []string)
• func IsVerbose(app *config.Application) (result bool)
• func MakeWriter(outputs []string, defaultFile, templateFilePath string) (sbom.Writer, error)
• type AttestOptions
  • func (o *AttestOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error
• type FulcioOptions
  • func (o *FulcioOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error
• type Interface
• type OIDCOptions
  • func (o *OIDCOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error
• type PackagesOptions
  • func (o *PackagesOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error
• type RekorOptions
  • func (o *RekorOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error
• type RootOptions
  • func (o *RootOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error
• type VersionOptions
  • func (o *VersionOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error

Constants

const DefaultOIDCIssuerURL = "https://oauth2.sigstore.dev/auth"

const DefaultRekorURL = "https://rekor.sigstore.dev"

Functions

func FormatAliases

func FormatAliases(ids ...sbom.FormatID) (aliases []string)

func IsVerbose

func IsVerbose(app *config.Application) (result bool)

func MakeWriter

func MakeWriter(outputs []string, defaultFile, templateFilePath string) (sbom.Writer, error)

makeWriter creates a sbom.Writer for output or returns an error. this will either return a valid writer or an error but neither both and if there is no error, sbom.Writer.Close() should be called

Types

type AttestOptions

type AttestOptions struct {
	Key       string
	Cert      string
	CertChain string
	NoUpload  bool
	Force     bool
	Recursive bool

	Rekor  RekorOptions
	Fulcio FulcioOptions
	OIDC   OIDCOptions
}

func (*AttestOptions) AddFlags

func (o *AttestOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error

type FulcioOptions

type FulcioOptions struct {
	URL                      string
	IdentityToken            string
	InsecureSkipFulcioVerify bool
}

FulcioOptions is the wrapper for Fulcio related options.

func (*FulcioOptions) AddFlags

func (o *FulcioOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error

AddFlags implements Interface

type Interface

type Interface interface {
	// AddFlags adds this options' flags to the cobra command.
	AddFlags(cmd *cobra.Command, v *viper.Viper) error
}

type OIDCOptions

type OIDCOptions struct {
	Issuer      string
	ClientID    string
	RedirectURL string
}

OIDCOptions is the wrapper for OIDC related options.

func (*OIDCOptions) AddFlags

func (o *OIDCOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error

AddFlags implements Interface

type PackagesOptions

type PackagesOptions struct {
	Scope                  string
	Output                 []string
	OutputTemplatePath     string
	File                   string
	Platform               string
	Host                   string
	Username               string
	Password               string
	Dockerfile             string
	Exclude                []string
	OverwriteExistingImage bool
	ImportTimeout          uint
	Catalogers             []string
}

func (*PackagesOptions) AddFlags

func (o *PackagesOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error

type RekorOptions

type RekorOptions struct {
	URL string
}

RekorOptions is the wrapper for Rekor related options.

func (*RekorOptions) AddFlags

func (o *RekorOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error

AddFlags implements Interface

type RootOptions

type RootOptions struct {
	Config  string
	Quiet   bool
	Verbose int
}

func (*RootOptions) AddFlags

func (o *RootOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error

type VersionOptions

type VersionOptions struct {
	Output string
}

func (*VersionOptions) AddFlags

func (o *VersionOptions) AddFlags(cmd *cobra.Command, v *viper.Viper) error