cli

Documentation

Index

• Constants
• Variables
• func Attach() *cobra.Command
• func Attest() *cobra.Command
• func AttestBlob() *cobra.Command
• func Clean() *cobra.Command
• func CleanCmd(ctx context.Context, regOpts options.RegistryOptions, ...) error
• func Completion() *cobra.Command
• func Copy() *cobra.Command
• func Dockerfile() *cobra.Command
• func Download() *cobra.Command
• func Env() *cobra.Command
• func Generate() *cobra.Command
• func GenerateKeyPair() *cobra.Command
• func ImportKeyPair() *cobra.Command
• func Initialize() *cobra.Command
• func Load() *cobra.Command
• func LoadCmd(ctx context.Context, opts options.LoadOptions, imageRef string) error
• func Manifest() *cobra.Command
• func New() *cobra.Command
• func PIVTool() *cobra.Command
• func PKCS11Tool() *cobra.Command
• func Policy() *cobra.Command
• func PublicKey() *cobra.Command
• func Save() *cobra.Command
• func SaveCmd(ctx context.Context, opts options.SaveOptions, imageRef string) error
• func Sign() *cobra.Command
• func SignBlob() *cobra.Command
• func Tree() *cobra.Command
• func TreeCmd(ctx context.Context, regOpts options.RegistryOptions, imageRef string) error
• func Triangulate() *cobra.Command
• func Upload() *cobra.Command
• func Verify() *cobra.Command
• func VerifyAttestation() *cobra.Command
• func VerifyBlob() *cobra.Command
• func VerifyBlobAttestation() *cobra.Command
• type FulcioKeyVal
  • func GetFulcioKeyVal(key *Key) (*FulcioKeyVal, error)
• type Key
  • func FulcioVerificationKey(email, issuer string) *Key
  • func (k *Key) ContainsID(id string) bool
  • func (k *Key) ID() string
• type Role
  • func (r *Role) AddKeysWithThreshold(keys []*Key, threshold int) bool
• type Root
  • func NewRoot() *Root
  • func (r *Root) AddKey(key *Key) bool
  • func (r *Root) Marshal() (*Signed, error)
  • func (r *Root) ValidKey(key *Key, role string) (string, error)
• type Signature
• type Signed
  • func (s *Signed) AddOrUpdateSignature(key *Key, signature Signature) error
  • func (s *Signed) JSONMarshal(prefix, indent string) ([]byte, error)

Constants

const (
	KeyTypeFulcio   = "sigstore-oidc"
	KeySchemeFulcio = "https://fulcio.sigstore.dev"
)

Variables

var KeyAlgorithms = []string{"sha256", "sha512"}

Functions

func Attach

func Attach() *cobra.Command

func Attest

func Attest() *cobra.Command

func AttestBlob

func AttestBlob() *cobra.Command

func Clean

func Clean() *cobra.Command

func CleanCmd

func CleanCmd(ctx context.Context, regOpts options.RegistryOptions, cleanType, imageRef string, force bool) error

func Completion

func Completion() *cobra.Command

func Copy

func Copy() *cobra.Command

func Dockerfile

func Dockerfile() *cobra.Command

func Download

func Download() *cobra.Command

func Env

func Env() *cobra.Command

func Generate

func Generate() *cobra.Command

func GenerateKeyPair

func GenerateKeyPair() *cobra.Command

func ImportKeyPair

func ImportKeyPair() *cobra.Command

func Initialize

func Initialize() *cobra.Command

func Load

func Load() *cobra.Command

func LoadCmd

func LoadCmd(ctx context.Context, opts options.LoadOptions, imageRef string) error

func Manifest

func Manifest() *cobra.Command

func New

func New() *cobra.Command

func PIVTool

func PIVTool() *cobra.Command

func PKCS11Tool

func PKCS11Tool() *cobra.Command

func Policy

func Policy() *cobra.Command

func PublicKey

func PublicKey() *cobra.Command

func Save

func Save() *cobra.Command

func SaveCmd

func SaveCmd(ctx context.Context, opts options.SaveOptions, imageRef string) error

func Sign

func Sign() *cobra.Command

func SignBlob

func SignBlob() *cobra.Command

func Tree

func Tree() *cobra.Command

func TreeCmd

func TreeCmd(ctx context.Context, regOpts options.RegistryOptions, imageRef string) error

func Triangulate

func Triangulate() *cobra.Command

func Upload

func Upload() *cobra.Command

func Verify

func Verify() *cobra.Command

func VerifyAttestation

func VerifyAttestation() *cobra.Command

func VerifyBlob

func VerifyBlob() *cobra.Command

func VerifyBlobAttestation

func VerifyBlobAttestation() *cobra.Command

Types

type FulcioKeyVal

type FulcioKeyVal struct {
	Identity string `json:"identity"`
	Issuer   string `json:"issuer,omitempty"`
}

func GetFulcioKeyVal

func GetFulcioKeyVal(key *Key) (*FulcioKeyVal, error)

type Key

type Key struct {
	Type       string          `json:"keytype"`
	Scheme     string          `json:"scheme"`
	Algorithms []string        `json:"keyid_hash_algorithms,omitempty"`
	Value      json.RawMessage `json:"keyval"`
	// contains filtered or unexported fields
}

func FulcioVerificationKey

func FulcioVerificationKey(email, issuer string) *Key

func (*Key) ContainsID

func (k *Key) ContainsID(id string) bool

func (*Key) ID

func (k *Key) ID() string

type Role

type Role struct {
	KeyIDs    []string `json:"keyids"`
	Threshold int      `json:"threshold"`
}

func (*Role) AddKeysWithThreshold

func (r *Role) AddKeysWithThreshold(keys []*Key, threshold int) bool

type Root

type Root struct {
	Type        string           `json:"_type"`
	SpecVersion string           `json:"spec_version"`
	Version     int              `json:"version"`
	Expires     time.Time        `json:"expires"`
	Keys        map[string]*Key  `json:"keys"`
	Roles       map[string]*Role `json:"roles"`
	Namespace   string           `json:"namespace"`

	ConsistentSnapshot bool `json:"consistent_snapshot"`
}

func NewRoot

func NewRoot() *Root

func (*Root) AddKey

func (r *Root) AddKey(key *Key) bool

func (*Root) Marshal

func (r *Root) Marshal() (*Signed, error)

func (*Root) ValidKey

func (r *Root) ValidKey(key *Key, role string) (string, error)

type Signature

type Signature struct {
	KeyID     string `json:"keyid"`
	Signature string `json:"sig"`
	Cert      string `json:"cert,omitempty"`
}

type Signed

type Signed struct {
	Signed     json.RawMessage `json:"signed"`
	Signatures []Signature     `json:"signatures"`
}

func (*Signed) AddOrUpdateSignature

func (s *Signed) AddOrUpdateSignature(key *Key, signature Signature) error

func (*Signed) JSONMarshal

func (s *Signed) JSONMarshal(prefix, indent string) ([]byte, error)