keyring

Documentation

Index

• Variables
• type CACertsKey
  • func NewCACertsKey(certs []*x509.Certificate) *CACertsKey
• type EphemeralKey
  • func LoadEphemeralKey(r io.Reader) (*EphemeralKey, error)
  • func (e *EphemeralKey) Validate() error
• type Keyring
  • func New(keys ...any) Keyring
  • func Unmarshal(data []byte) (Keyring, error)
• type PKPKey
  • func NewPKPKey(pinnedKeys []*pkp.PublicKeyPin) *PKPKey
• type SharedKeys
  • func NewSharedKeys(secret []byte) *SharedKeys
• type UsageType
• type UseKeyFn

Variables

var (
	ErrInvalidKeyType = errors.New("invalid key type")
)

Types

type CACertsKey

type CACertsKey struct {
	// DER-encoded certificates
	CACerts [][]byte `json:"caCerts"`
}

func NewCACertsKey

func NewCACertsKey(certs []*x509.Certificate) *CACertsKey

type EphemeralKey

type EphemeralKey struct {
	Usage  UsageType         `json:"usage" validate:"oneof=encryption signing"`
	Secret []byte            `json:"secret" validate:"len=32"`
	Labels map[string]string `json:"labels" validate:"dive,keys,printascii,endkeys,printascii"`
}

func LoadEphemeralKey

func LoadEphemeralKey(r io.Reader) (*EphemeralKey, error)

func (*EphemeralKey) Validate

func (e *EphemeralKey) Validate() error

type Keyring

type Keyring interface {
	Try(...UseKeyFn) bool
	ForEach(func(key any))
	Marshal() ([]byte, error)
	Merge(Keyring) Keyring
}

func New

func New(keys ...any) Keyring

func Unmarshal

func Unmarshal(data []byte) (Keyring, error)

type PKPKey

type PKPKey struct {
	PinnedKeys []*pkp.PublicKeyPin `json:"pinnedKeys"`
}

func NewPKPKey

func NewPKPKey(pinnedKeys []*pkp.PublicKeyPin) *PKPKey

type SharedKeys

type SharedKeys struct {
	ClientKey ed25519.PrivateKey `json:"clientKey"`
	ServerKey ed25519.PrivateKey `json:"serverKey"`
}

func NewSharedKeys

func NewSharedKeys(secret []byte) *SharedKeys

type UsageType

type UsageType string

const (
	Encryption UsageType = "encryption"
	Signing    UsageType = "signing"
)

type UseKeyFn

type UseKeyFn any // func(*KeyringType)