options

type AnnotationOptions ¶

type AnnotationOptions struct {
	Annotations []string
}

AnnotationOptions is the top level wrapper for the annotations.

func (o *AnnotationOptions) AddFlags(cmd *cobra.Command)

func (o *AnnotationOptions) AnnotationsMap() (sigs.AnnotationsMap, error)

type AttachSBOMOptions ¶

type AttachSBOMOptions struct {
	SBOM     string
	SBOMType string
	Registry RegistryOptions
}

AttachSBOMOptions is the top level wrapper for the attach sbom command.

func (o *AttachSBOMOptions) AddFlags(cmd *cobra.Command)

func (o *AttachSBOMOptions) MediaType() (types.MediaType, error)

type AttachSignatureOptions ¶

type AttachSignatureOptions struct {
	Signature string
	Payload   string
	Registry  RegistryOptions
}

AttachSignatureOptions is the top level wrapper for the attach signature command.

func (o *AttachSignatureOptions) AddFlags(cmd *cobra.Command)

type AttestOptions ¶

type AttestOptions struct {
	Key       string
	Cert      string
	NoUpload  bool
	Force     bool
	Recursive bool
	Replace   bool
	Timeout   time.Duration

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

AttestOptions is the top level wrapper for the attest command.

func (o *AttestOptions) AddFlags(cmd *cobra.Command)

type CopyOptions ¶

type CopyOptions struct {
	SignatureOnly bool
	Force         bool
	Registry      RegistryOptions
}

CopyOptions is the top level wrapper for the copy command.

func (o *CopyOptions) AddFlags(cmd *cobra.Command)

type FilesOptions ¶

type FilesOptions struct {
	Files []string
}

FilesOptions is the wrapper for the files.

func (o *FilesOptions) AddFlags(cmd *cobra.Command)

func (o *FilesOptions) Parse() ([]cremote.File, error)

func (o *FilesOptions) String() string

type FulcioOptions ¶

type FulcioOptions struct {
	URL                      string
	IdentityToken            string
	InsecureSkipFulcioVerify bool
}

FulcioOptions is the wrapper for Fulcio related options.

func (o *FulcioOptions) AddFlags(cmd *cobra.Command)

type GenerateKeyPairOptions ¶

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

GenerateKeyPairOptions is the top level wrapper for the generate-key-pair command.

func (o *GenerateKeyPairOptions) AddFlags(cmd *cobra.Command)

type GenerateOptions ¶

type GenerateOptions struct {
	AnnotationOptions
	Registry RegistryOptions
}

GenerateOptions is the top level wrapper for the generate command.

func (o *GenerateOptions) AddFlags(cmd *cobra.Command)

type InitializeOptions ¶

type InitializeOptions struct {
	Mirror string
	Root   string
}

InitializeOptions is the top level wrapper for the initialize command.

func (o *InitializeOptions) AddFlags(cmd *cobra.Command)

type Interface ¶

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

type KeyParseError ¶

type KeyParseError struct{}

KeyParseError is an error returned when an incorrect set of key flags are parsed by the CLI

func (e *KeyParseError) Error() string

type LoadOptions ¶

type LoadOptions struct {
	Directory string
}

LoadOptions is the top level wrapper for the load command.

func (o *LoadOptions) AddFlags(cmd *cobra.Command)

type OIDCOptions ¶

type OIDCOptions struct {
	Issuer       string
	ClientID     string
	ClientSecret string
}

OIDCOptions is the wrapper for OIDC related options.

func (o *OIDCOptions) AddFlags(cmd *cobra.Command)

type PIVToolAttestationOptions ¶

type PIVToolAttestationOptions struct {
	Output string
	Slot   string
}

PIVToolAttestationOptions is the wrapper for `piv-tool attestation` related options.

func (o *PIVToolAttestationOptions) AddFlags(cmd *cobra.Command)

type PIVToolGenerateKeyOptions ¶

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

PIVToolGenerateKeyOptions is the wrapper for `piv-tool generate-key` related options.

func (o *PIVToolGenerateKeyOptions) AddFlags(cmd *cobra.Command)

type PIVToolSetManagementKeyOptions ¶

type PIVToolSetManagementKeyOptions struct {
	OldKey    string
	NewKey    string
	RandomKey bool
}

PIVToolSetManagementKeyOptions is the wrapper for `piv-tool set-management-key` related options.

func (o *PIVToolSetManagementKeyOptions) AddFlags(cmd *cobra.Command)

type PIVToolSetPINOptions ¶

type PIVToolSetPINOptions struct {
	OldPIN string
	NewPIN string
}

PIVToolSetPINOptions is the wrapper for `piv-tool set-pin` related options.

func (o *PIVToolSetPINOptions) AddFlags(cmd *cobra.Command)

type PIVToolSetPUKOptions ¶

type PIVToolSetPUKOptions struct {
	OldPUK string
	NewPUK string
}

PIVToolSetPUKOptions is the wrapper for `piv-tool set-puk` related options.

func (o *PIVToolSetPUKOptions) AddFlags(cmd *cobra.Command)

type PIVToolUnblockOptions ¶

type PIVToolUnblockOptions struct {
	PUK    string
	NewPIN string
}

PIVToolUnblockOptions is the wrapper for `piv-tool unblock` related options.

func (o *PIVToolUnblockOptions) AddFlags(cmd *cobra.Command)

type PKCS11ToolListKeysUrisOptions ¶

type PKCS11ToolListKeysUrisOptions struct {
	ModulePath string
	SlotID     uint
	Pin        string
}

PKCS11ToolListKeysUrisOptions is the wrapper for `pkcs11-tool list-keys-uris` related options.

func (o *PKCS11ToolListKeysUrisOptions) AddFlags(cmd *cobra.Command)

type PKCS11ToolListTokensOptions ¶

type PKCS11ToolListTokensOptions struct {
	ModulePath string
}

PKCS11ToolListTokens is the wrapper for `pkcs11-tool list-tokens` related options.

func (o *PKCS11ToolListTokensOptions) AddFlags(cmd *cobra.Command)

type PolicyInitOptions ¶

type PolicyInitOptions struct {
	ImageRef    string
	Maintainers []string
	Issuer      string
	Threshold   int
	Expires     int
	OutFile     string
	Registry    RegistryOptions
}

PolicyInitOptions is the top level wrapper for the policy-init command.

func (o *PolicyInitOptions) AddFlags(cmd *cobra.Command)

type PolicySignOptions ¶

type PolicySignOptions struct {
	ImageRef string
	OutFile  string
	Registry RegistryOptions
	Fulcio   FulcioOptions
	Rekor    RekorOptions
	Timeout  time.Duration

	OIDC OIDCOptions
}

func (o *PolicySignOptions) AddFlags(cmd *cobra.Command)

type PredicateLocalOptions ¶

type PredicateLocalOptions struct {
	PredicateOptions
	Path string
}

PredicateLocalOptions is the wrapper for predicate related options.

func (o *PredicateLocalOptions) AddFlags(cmd *cobra.Command)

type PredicateOptions ¶

type PredicateOptions struct {
	Type string
}

PredicateOptions is the wrapper for predicate related options.

func (o *PredicateOptions) AddFlags(cmd *cobra.Command)

type PredicateRemoteOptions ¶

type PredicateRemoteOptions struct {
	PredicateOptions
}

PredicateRemoteOptions is the wrapper for remote predicate related options.

func (o *PredicateRemoteOptions) AddFlags(cmd *cobra.Command)

type PubKeyParseError ¶

type PubKeyParseError struct{}

PubKeyParseError is an error returned when an incorrect set of public key flags are parsed by the CLI

func (e *PubKeyParseError) Error() string

type PublicKeyOptions ¶

type PublicKeyOptions struct {
	Key         string
	SecurityKey SecurityKeyOptions
	OutFile     string
}

PublicKeyOptions is the top level wrapper for the public-key command.

func (o *PublicKeyOptions) AddFlags(cmd *cobra.Command)

type ReferenceOptions ¶

type ReferenceOptions struct {
	TagPrefix string
}

ReferenceOptions is a wrapper for image reference options.

func (o *ReferenceOptions) AddFlags(cmd *cobra.Command)

type RegistryOptions ¶

type RegistryOptions struct {
	AllowInsecure      bool
	KubernetesKeychain bool
	RefOpts            ReferenceOptions
}

RegistryOptions is the wrapper for the registry options.

func (o *RegistryOptions) AddFlags(cmd *cobra.Command)

func (o *RegistryOptions) ClientOpts(ctx context.Context) ([]ociremote.Option, error)

func (o *RegistryOptions) GetRegistryClientOpts(ctx context.Context) []remote.Option

type RekorOptions ¶

type RekorOptions struct {
	URL string
}

RekorOptions is the wrapper for Rekor related options.

func (o *RekorOptions) AddFlags(cmd *cobra.Command)

type RootOptions ¶

type RootOptions struct {
	OutputFile string
	Verbose    bool
}

RootOptions define flags and options for the root cosign cli.

func (o *RootOptions) AddFlags(cmd *cobra.Command)

type SaveOptions ¶

type SaveOptions struct {
	Directory string
}

SaveOptions is the top level wrapper for the load command.

func (o *SaveOptions) AddFlags(cmd *cobra.Command)

type SecurityKeyOptions ¶

type SecurityKeyOptions struct {
	Use  bool
	Slot string
}

SecurityKeyOptions is the wrapper for security key related options.

func (o *SecurityKeyOptions) AddFlags(cmd *cobra.Command)

type SignBlobOptions ¶

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
	Timeout           time.Duration
}

SignBlobOptions is the top level wrapper for the sign-blob command. The new output-certificate flag is only in use when COSIGN_EXPERIMENTAL is enabled

func (o *SignBlobOptions) AddFlags(cmd *cobra.Command)

type SignOptions ¶

type SignOptions struct {
	Key               string
	Cert              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.
	OutputCertificate string
	PayloadPath       string
	Force             bool
	Recursive         bool
	Attachment        string

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

SignOptions is the top level wrapper for the sign command.

func (o *SignOptions) AddFlags(cmd *cobra.Command)

type SignatureDigestOptions ¶

type SignatureDigestOptions struct {
	AlgorithmName string
}

SignatureDigestOptions holds options for specifying which digest algorithm should be used when processing a signature.

func (o *SignatureDigestOptions) AddFlags(cmd *cobra.Command)

func (o *SignatureDigestOptions) HashAlgorithm() (crypto.Hash, error)

type TriangulateOptions ¶

type TriangulateOptions struct {
	Type     string
	Registry RegistryOptions
}

TriangulateOptions is the top level wrapper for the triangulate command.

func (o *TriangulateOptions) AddFlags(cmd *cobra.Command)

type UploadBlobOptions ¶

type UploadBlobOptions struct {
	ContentType string
	Files       FilesOptions
	Registry    RegistryOptions
}

UploadBlobOptions is the top level wrapper for the `upload blob` command.

func (o *UploadBlobOptions) AddFlags(cmd *cobra.Command)

type UploadWASMOptions ¶

type UploadWASMOptions struct {
	File     string
	Registry RegistryOptions
}

UploadWASMOptions is the top level wrapper for the `upload wasm` command.

func (o *UploadWASMOptions) AddFlags(cmd *cobra.Command)

type VerifyAttestationOptions ¶

type VerifyAttestationOptions struct {
	Key         string
	CheckClaims bool
	Output      string

	SecurityKey SecurityKeyOptions
	Rekor       RekorOptions
	Fulcio      FulcioOptions // TODO: the original command did not use id token, mistake?
	Registry    RegistryOptions
	Predicate   PredicateRemoteOptions
	Policies    []string
	LocalImage  bool
}

VerifyAttestationOptions is the top level wrapper for the `verify attestation` command.

func (o *VerifyAttestationOptions) AddFlags(cmd *cobra.Command)

type VerifyBlobOptions ¶

type VerifyBlobOptions struct {
	Key       string
	Cert      string
	Signature string

	SecurityKey SecurityKeyOptions
	Rekor       RekorOptions
	Registry    RegistryOptions
}

VerifyBlobOptions is the top level wrapper for the `verify blob` command.

func (o *VerifyBlobOptions) AddFlags(cmd *cobra.Command)

type VerifyDockerfileOptions ¶

type VerifyDockerfileOptions struct {
	VerifyOptions
	BaseImageOnly bool
}

VerifyBlobOptions is the top level wrapper for the `verify blob` command.

func (o *VerifyDockerfileOptions) AddFlags(cmd *cobra.Command)

type VerifyOptions ¶

type VerifyOptions struct {
	Key          string
	Cert         string
	CertEmail    string // TODO: merge into fulcio option as read mode?
	CheckClaims  bool
	Attachment   string
	Output       string
	SignatureRef string
	LocalImage   bool

	SecurityKey SecurityKeyOptions
	Rekor       RekorOptions
	// TODO: this seems like it should have the Fulcio options.
	Registry        RegistryOptions
	SignatureDigest SignatureDigestOptions
	AnnotationOptions
}

VerifyOptions is the top level wrapper for the `verify` command.

func (o *VerifyOptions) AddFlags(cmd *cobra.Command)