options

type AnnotationOptions struct {
	Annotations []string
}

type AttachAttestationOptions struct {
	Attestations []string
	Registry     RegistryOptions
}

type AttachSBOMOptions struct {
	SBOM                 string
	SBOMType             string
	SBOMInputFormat      string
	Registry             RegistryOptions
	RegistryExperimental RegistryExperimentalOptions
}

type AttachSignatureOptions struct {
	Signature      string
	Payload        string
	Cert           string
	CertChain      string
	TimeStampedSig string
	RekorBundle    string
	Registry       RegistryOptions
}

type AttestBlobOptions struct {
	Key       string
	Cert      string
	CertChain string

	SkipConfirmation     bool
	TlogUpload           bool
	TSAServerURL         string
	RFC3161TimestampPath string

	Hash      string
	Predicate PredicateLocalOptions

	OutputSignature   string
	OutputAttestation string
	OutputCertificate string
	BundlePath        string

	Rekor       RekorOptions
	Fulcio      FulcioOptions
	OIDC        OIDCOptions
	SecurityKey SecurityKeyOptions
}

type AttestOptions struct {
	Key              string
	Cert             string
	CertChain        string
	NoUpload         bool
	Recursive        bool
	Replace          bool
	SkipConfirmation bool
	TlogUpload       bool
	TSAServerURL     string

	Rekor       RekorOptions
	Fulcio      FulcioOptions
	OIDC        OIDCOptions
	SecurityKey SecurityKeyOptions
	Predicate   PredicateLocalOptions
	Registry    RegistryOptions
}

type AttestationDownloadOptions struct {
	PredicateType string // Predicate type of attestation to retrieve
	Platform      string // Platform to download attestations
}

type CertVerifyOptions struct {
	Cert                         string
	CertIdentity                 string
	CertIdentityRegexp           string
	CertOidcIssuer               string
	CertOidcIssuerRegexp         string
	CertGithubWorkflowTrigger    string
	CertGithubWorkflowSha        string
	CertGithubWorkflowName       string
	CertGithubWorkflowRepository string
	CertGithubWorkflowRef        string
	CertChain                    string
	SCT                          string
	IgnoreSCT                    bool
}

type CleanOptions struct {
	Registry  RegistryOptions
	CleanType CleanType
	Force     bool
}

type CleanType string

type CommonVerifyOptions struct {
	Offline          bool // Force offline verification
	TSACertChainPath string
	IgnoreTlog       bool
	MaxWorkers       int
	// This is added to CommonVerifyOptions to provide a path to support
	// it for other verify options.
	ExperimentalOCI11 bool
}

type CopyOptions struct {
	CopyOnly      string
	SignatureOnly bool
	Force         bool
	Platform      string
	Registry      RegistryOptions
}

type EnvOptions struct {
	ShowDescriptions    bool
	ShowSensitiveValues bool
}

type FilesOptions struct {
	Files []string
}

type FulcioOptions struct {
	URL                      string
	IdentityToken            string
	InsecureSkipFulcioVerify bool
}

type GenerateKeyPairOptions struct {
	// KMS Key Management Service
	KMS             string
	OutputKeyPrefix string
}

type GenerateOptions struct {
	AnnotationOptions
	Registry RegistryOptions
}

type ImportKeyPairOptions struct {
	// Local key file generated by external program such as OpenSSL
	Key string

	// Filename used for outputted keys
	OutputKeyPrefix string
}

type InitializeOptions struct {
	Mirror string
	Root   string
}

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

type KeyOpts struct {
	Sk                   bool
	Slot                 string
	KeyRef               string
	FulcioURL            string
	RekorURL             string
	IDToken              string
	PassFunc             cosign.PassFunc
	OIDCIssuer           string
	OIDCClientID         string
	OIDCClientSecret     string
	OIDCRedirectURL      string
	OIDCDisableProviders bool   // Disable OIDC credential providers in keyless signer
	OIDCProvider         string // Specify which OIDC credential provider to use for keyless signer
	BundlePath           string
	SkipConfirmation     bool
	TSAClientCACert      string
	TSAClientCert        string
	TSAClientKey         string
	TSAServerName        string // expected SAN field in the TSA server's certificate - https://pkg.go.dev/crypto/tls#Config.ServerName
	TSAServerURL         string
	RFC3161TimestampPath string
	TSACertChainPath     string
	// IssueCertificate controls whether to issue a certificate when a key is
	// provided.
	IssueCertificateForExistingKey bool

	// FulcioAuthFlow is the auth flow to use when authenticating against
	// Fulcio. See https://pkg.go.dev/github.com/sigstore/cosign/v2/cmd/cosign/cli/fulcio#pkg-constants
	// for valid values.
	FulcioAuthFlow string

	// Modeled after InsecureSkipVerify in tls.Config, this disables
	// verifying the SCT.
	InsecureSkipFulcioVerify bool
}

type KeyParseError struct{}

type Keychain = authn.Keychain

type LoadOptions struct {
	Directory string
	Registry  RegistryOptions
}

type OIDCOptions struct {
	Issuer   string
	ClientID string

	RedirectURL             string
	Provider                string
	DisableAmbientProviders bool
	// contains filtered or unexported fields
}

type PIVToolAttestationOptions struct {
	Output string
	Slot   string
}

type PIVToolGenerateKeyOptions struct {
	ManagementKey string
	RandomKey     bool
	Slot          string
	PINPolicy     string
	TouchPolicy   string
}

type PIVToolSetManagementKeyOptions struct {
	OldKey    string
	NewKey    string
	RandomKey bool
}

type PIVToolSetPINOptions struct {
	OldPIN string
	NewPIN string
}

type PIVToolSetPUKOptions struct {
	OldPUK string
	NewPUK string
}

type PIVToolUnblockOptions struct {
	PUK    string
	NewPIN string
}

type PKCS11ToolListKeysUrisOptions struct {
	ModulePath string
	SlotID     uint
	Pin        string
}

type PKCS11ToolListTokensOptions struct {
	ModulePath string
}

type PredicateLocalOptions struct {
	PredicateOptions
	Path string
}

type PredicateOptions struct {
	Type string
}

type PredicateRemoteOptions struct {
	PredicateOptions
}

type PubKeyParseError struct{}

type PublicKeyOptions struct {
	Key         string
	SecurityKey SecurityKeyOptions
	OutFile     string
}

type ReferenceOptions struct {
	TagPrefix string
}

type RegistryExperimentalOptions struct {
	RegistryReferrersMode RegistryReferrersMode
}

type RegistryOptions struct {
	AllowInsecure      bool
	AllowHTTPRegistry  bool
	KubernetesKeychain bool
	RefOpts            ReferenceOptions
	Keychain           Keychain
	AuthConfig         authn.AuthConfig

	// RegistryClientOpts allows overriding the result of GetRegistryClientOpts.
	RegistryClientOpts []remote.Option
}

type RegistryReferrersMode string

type RekorOptions struct {
	URL string
}

type RootOptions struct {
	OutputFile string
	Verbose    bool
	Timeout    time.Duration
}

type SBOMDownloadOptions struct {
	Platform string // Platform to download sboms
}

type SaveOptions struct {
	Directory string
}

type SecurityKeyOptions struct {
	Use  bool
	Slot string
}

type SignBlobOptions struct {
	Key                  string
	Base64Output         bool
	Output               string // deprecated: TODO remove when the output flag is fully deprecated
	OutputSignature      string // TODO: this should be the root output file arg.
	OutputCertificate    string
	SecurityKey          SecurityKeyOptions
	Fulcio               FulcioOptions
	Rekor                RekorOptions
	OIDC                 OIDCOptions
	Registry             RegistryOptions
	BundlePath           string
	SkipConfirmation     bool
	TlogUpload           bool
	TSAClientCACert      string
	TSAClientCert        string
	TSAClientKey         string
	TSAServerName        string
	TSAServerURL         string
	RFC3161TimestampPath string
	IssueCertificate     bool
}

type SignOptions struct {
	Key                   string
	Cert                  string
	CertChain             string
	Upload                bool
	Output                string // deprecated: TODO remove when the output flag is fully deprecated
	OutputSignature       string // TODO: this should be the root output file arg.
	OutputPayload         string
	OutputCertificate     string
	PayloadPath           string
	Recursive             bool
	Attachment            string
	SkipConfirmation      bool
	TlogUpload            bool
	TSAClientCACert       string
	TSAClientCert         string
	TSAClientKey          string
	TSAServerName         string
	TSAServerURL          string
	IssueCertificate      bool
	SignContainerIdentity string

	Rekor       RekorOptions
	Fulcio      FulcioOptions
	OIDC        OIDCOptions
	SecurityKey SecurityKeyOptions
	AnnotationOptions
	Registry             RegistryOptions
	RegistryExperimental RegistryExperimentalOptions
}

type SignatureDigestOptions struct {
	AlgorithmName string
}

type TreeOptions struct {
	Registry  RegistryOptions
	CleanType string
}

type TriangulateOptions struct {
	Type     string
	Registry RegistryOptions
}

type UploadBlobOptions struct {
	ContentType string
	Files       FilesOptions
	Registry    RegistryOptions
	Annotations map[string]string
}

type UploadWASMOptions struct {
	File     string
	Registry RegistryOptions
}

type VerifyAttestationOptions struct {
	Key         string
	CheckClaims bool
	Output      string

	CommonVerifyOptions CommonVerifyOptions
	SecurityKey         SecurityKeyOptions
	Rekor               RekorOptions
	CertVerify          CertVerifyOptions
	Registry            RegistryOptions
	Predicate           PredicateRemoteOptions
	Policies            []string
	LocalImage          bool
}

type VerifyBlobAttestationOptions struct {
	Key           string
	SignaturePath string
	BundlePath    string

	PredicateOptions
	CheckClaims bool

	SecurityKey         SecurityKeyOptions
	CertVerify          CertVerifyOptions
	Rekor               RekorOptions
	CommonVerifyOptions CommonVerifyOptions

	RFC3161TimestampPath string
}

type VerifyBlobOptions struct {
	Key        string
	Signature  string
	BundlePath string

	SecurityKey         SecurityKeyOptions
	CertVerify          CertVerifyOptions
	Rekor               RekorOptions
	CommonVerifyOptions CommonVerifyOptions

	RFC3161TimestampPath string
}

type VerifyDockerfileOptions struct {
	VerifyOptions
	BaseImageOnly bool
}

type VerifyOptions struct {
	Key          string
	CheckClaims  bool
	Attachment   string
	Output       string
	SignatureRef string
	PayloadRef   string
	LocalImage   bool

	CommonVerifyOptions CommonVerifyOptions
	SecurityKey         SecurityKeyOptions
	CertVerify          CertVerifyOptions
	Rekor               RekorOptions
	Registry            RegistryOptions
	SignatureDigest     SignatureDigestOptions

	AnnotationOptions
}