sigstore

Documentation

Index

• func NewSigner(opts ...Option) (*signer.Signer, error)
• type GenerateKeyPairResult
  • func GenerateKeyPair(passphrase []byte) (*GenerateKeyPairResult, error)
• type Option
  • func WithPrivateKeyFile(file string, passphrase []byte) Option

Functions

func NewSigner

func NewSigner(opts ...Option) (*signer.Signer, error)

Types

type GenerateKeyPairResult

type GenerateKeyPairResult struct {
	PublicKey  []byte
	PrivateKey []byte
}

GenerateKeyPairResult is a struct to ensure the private and public parts can not be confused by the caller.

func GenerateKeyPair

func GenerateKeyPair(passphrase []byte) (*GenerateKeyPairResult, error)

GenerateKeyPair generates a public/private key pair usable for signing images using the sigstore format, and returns key representations suitable for storing in long-term files (with the private key encrypted using the provided passphrase). The specific key kind (e.g. algorithm, size), as well as the file format, are unspecified by this API, and can change with best practices over time.

type Option

type Option = internal.Option

func WithPrivateKeyFile

func WithPrivateKeyFile(file string, passphrase []byte) Option