cli

Documentation

Index

• Variables
• func Download() *ffcli.Command
• func DownloadCmd(ctx context.Context, imageRef string) error
• func Generate() *ffcli.Command
• func GenerateCmd(_ context.Context, imageRef string, annotations map[string]interface{}, ...) error
• func GenerateKeyPair() *ffcli.Command
• func GenerateKeyPairCmd(ctx context.Context, kmsVal string) error
• func GetPass(confirm bool) ([]byte, error)
• func GetPublicKey(ctx context.Context, opts Pkopts, writer NamedWriter, pf cosign.PassFunc) error
• func MungeCmd(_ context.Context, imageRef string) error
• func PublicKey() *ffcli.Command
• func Sign() *ffcli.Command
• func SignBlob() *ffcli.Command
• func SignBlobCmd(ctx context.Context, ko KeyOpts, payloadPath string, b64 bool, ...) ([]byte, error)
• func SignCmd(ctx context.Context, so SignOpts, imageRef string, upload bool, ...) error
• func Triangulate() *ffcli.Command
• func Upload() *ffcli.Command
• func UploadCmd(ctx context.Context, sigRef, payloadRef, imageRef string) error
• func Verify() *ffcli.Command
• func VerifyBlob() *ffcli.Command
• func VerifyBlobCmd(ctx context.Context, ko KeyOpts, certRef, sigRef, blobRef string) error
• func Version() *ffcli.Command
• type Info
  • func VersionInfo() Info
  • func (i *Info) JSONString() (string, error)
  • func (i *Info) String() string
• type KeyOpts
• type KeyParseError
  • func (e *KeyParseError) Error() string
• type NamedWriter
• type Pkopts
• type SignOpts
• type SignatureArgType
• type VerifyCommand
  • func (c *VerifyCommand) Exec(ctx context.Context, args []string) error

Variables

var (
	// Read is for fuzzing
	Read = readPasswordFn
)

Functions

func Download

func Download() *ffcli.Command

func DownloadCmd

func DownloadCmd(ctx context.Context, imageRef string) error

func Generate

func Generate() *ffcli.Command

func GenerateCmd

func GenerateCmd(_ context.Context, imageRef string, annotations map[string]interface{}, w io.Writer) error

func GenerateKeyPair

func GenerateKeyPair() *ffcli.Command

func GenerateKeyPairCmd

func GenerateKeyPairCmd(ctx context.Context, kmsVal string) error

func GetPass

func GetPass(confirm bool) ([]byte, error)

func GetPublicKey

func GetPublicKey(ctx context.Context, opts Pkopts, writer NamedWriter, pf cosign.PassFunc) error

func MungeCmd

func MungeCmd(_ context.Context, imageRef string) error

func PublicKey

func PublicKey() *ffcli.Command

func Sign

func Sign() *ffcli.Command

func SignBlob

func SignBlob() *ffcli.Command

func SignBlobCmd

func SignBlobCmd(ctx context.Context, ko KeyOpts, payloadPath string, b64 bool, pf cosign.PassFunc) ([]byte, error)

func SignCmd

func SignCmd(ctx context.Context, so SignOpts,
	imageRef string, upload bool, payloadPath string, force bool) error

func Triangulate

func Triangulate() *ffcli.Command

func Upload

func Upload() *ffcli.Command

func UploadCmd

func UploadCmd(ctx context.Context, sigRef, payloadRef, imageRef string) error

func Verify

func Verify() *ffcli.Command

Verify builds and returns an ffcli command

func VerifyBlob

func VerifyBlob() *ffcli.Command

func VerifyBlobCmd

func VerifyBlobCmd(ctx context.Context, ko KeyOpts, certRef, sigRef, blobRef string) error

func Version

func Version() *ffcli.Command

Types

type Info

type Info struct {
	GitVersion   string
	GitCommit    string
	GitTreeState string
	BuildDate    string
	GoVersion    string
	Compiler     string
	Platform     string
}

func VersionInfo

func VersionInfo() Info

func (*Info) JSONString

func (i *Info) JSONString() (string, error)

JSONString returns the JSON representation of the version info

func (*Info) String

func (i *Info) String() string

String returns the string representation of the version info

type KeyOpts

type KeyOpts struct {
	Sk     bool
	KeyRef string
}

type KeyParseError

type KeyParseError struct{}

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

func (*KeyParseError) Error

func (e *KeyParseError) Error() string

type NamedWriter

type NamedWriter struct {
	Name string
	io.Writer
}

type Pkopts

type Pkopts struct {
	KeyRef string
	Sk     bool
}

type SignOpts

type SignOpts struct {
	Annotations map[string]interface{}
	KeyRef      string
	Sk          bool
	Pf          cosign.PassFunc
}

type SignatureArgType

type SignatureArgType uint8

const (
	StdinSignature SignatureArgType = iota
	RawSignature   SignatureArgType = iota
	FileSignature  SignatureArgType = iota
)

type VerifyCommand

type VerifyCommand struct {
	CheckClaims bool
	KeyRef      string
	Sk          bool
	Output      string
	Annotations *map[string]interface{}
}

VerifyCommand verifies a signature on a supplied container image

func (*VerifyCommand) Exec

func (c *VerifyCommand) Exec(ctx context.Context, args []string) error

Exec runs the verification command