envkms

README

envkms

envkms is an implementation of Tink's registry.KMSClient, that uses a pre-allocated keyset from an environment variable to perform KMS operations. It is designed as a substititute for a real KMS in dev, or for homelab use.

⚠ You should probably not use this. Use a Hardware/Cloud Provider KMS instead. ⚠

Usage

The keyset should be stored in an environment variable called ENVKMS_KEYSET. A new keyset can be created with go run ./cmd/envkmsutil generate-keyset

See e2e_test.go for an example of its usage.

Documentation

Index

• type KMS
  • func New() *KMS
  • func (k *KMS) GetAEAD(keyURI string) (tink.AEAD, error)
  • func (k *KMS) Supported(keyURI string) bool

Types

type KMS

type KMS struct{}

func New

func New() *KMS

func (*KMS) GetAEAD

func (k *KMS) GetAEAD(keyURI string) (tink.AEAD, error)

GetAEAD gets an AEAD backend by keyURI.

func (*KMS) Supported

func (k *KMS) Supported(keyURI string) bool

Supported true if this client does support keyURI