keystore

Documentation

Overview

Package keystore implements the auth.KeyStore interface. This implements an in-memory keystore for JWT support.

Index

• type KeyStore
  • func New() *KeyStore
  • func NewFS(fsys fs.FS) (*KeyStore, error)
  • func NewMap(store map[string]*rsa.PrivateKey) *KeyStore
  • func (ks *KeyStore) Add(privateKey *rsa.PrivateKey, kid string)
  • func (ks *KeyStore) PrivateKey(kid string) (*rsa.PrivateKey, error)
  • func (ks *KeyStore) PublicKey(kid string) (*rsa.PublicKey, error)
  • func (ks *KeyStore) Remove(kid string)

Types

type KeyStore

type KeyStore struct {
	// contains filtered or unexported fields
}

KeyStore represents an in memory store implementation of the KeyStorer interface for use with the auth package.

func New

func New() *KeyStore

New constructs an empty KeyStore ready for use.

func NewFS

func NewFS(fsys fs.FS) (*KeyStore, error)

NewFS constructs a KeyStore based on a set of PEM files rooted inside of a directory. The name of each PEM file will be used as the key id. Example: keystore.NewFS(os.DirFS("/zarf/keys/")) Example: /zarf/keys/54bb2165-71e1-41a6-af3e-7da4a0e1e2c1.pem

func NewMap

func NewMap(store map[string]*rsa.PrivateKey) *KeyStore

NewMap constructs a KeyStore with an initial set of keys. [PS] this method is used for unit testing

func (*KeyStore) Add

func (ks *KeyStore) Add(privateKey *rsa.PrivateKey, kid string)

[PS] helper function for key rotation Add adds a private key and combination kid to the store.

func (*KeyStore) PrivateKey

func (ks *KeyStore) PrivateKey(kid string) (*rsa.PrivateKey, error)

PrivateKey searches the key store for a given kid and returns the private key. [PS] Implementation of interface defined in business/sys/auth

func (*KeyStore) PublicKey

func (ks *KeyStore) PublicKey(kid string) (*rsa.PublicKey, error)

PublicKey searches the key store for a given kid and returns the public key. [PS] Implementation of interface defined in business/sys/auth

func (*KeyStore) Remove

func (ks *KeyStore) Remove(kid string)

[PS] helper function for key rotation Remove removes a private key and combination kid to the store.