commands

Documentation

Index

• Variables
• func Execute(version, commit, date, builtBy string)
• func GenerateProvenance(scanCfg *config.ScanConfiguration) error
• func InitBuildTools(mavenOpts string) build.Tools
• type AttestCmd
• type AttestOptions
  • func (o AttestOptions) Run(args []string, runner utils.CmdRunner) (string, error)
• type ClientInformation
• type Principal
• type ProvenanceConfig
• type RootFlags
  • func (r RootFlags) WorkDir() string

Variables

var (
	PathFlags *RootFlags
	Auth      *Principal
	Client    *ClientInformation
)

Functions

func Execute

func Execute(version, commit, date, builtBy string)

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func GenerateProvenance

func GenerateProvenance(scanCfg *config.ScanConfiguration) error

func InitBuildTools

func InitBuildTools(mavenOpts string) build.Tools

Types

type AttestCmd

type AttestCmd interface {
	Run(args []string, runner utils.CmdRunner) error
}

type AttestOptions

type AttestOptions struct {
	Key           string `mapstructure:"key"`
	IdentityToken string `mapstructure:"identity-token"`
	NoUpload      bool   `mapstructure:"no-upload"`
	RekorURL      string `mapstructure:"rekor-url"`
	PredicateFile string `mapstructure:"predicate"`
	PredicateType string `mapstructure:"type"`
}

func (AttestOptions) Run

func (o AttestOptions) Run(args []string, runner utils.CmdRunner) (string, error)

type ClientInformation

type ClientInformation struct {
	Version string
	Commit  string
	Date    string
	BuiltBy string
}

type Principal

type Principal struct {
	GithubToken string
}

type ProvenanceConfig

type ProvenanceConfig struct {
	WithDependencies bool
	BuildStartedOn   string
}

var (
	Config *ProvenanceConfig
)

type RootFlags

type RootFlags struct {
	Repo    string
	RepoDir string
	SubDir  string
	Remote  bool
}

func (RootFlags) WorkDir

func (r RootFlags) WorkDir() string