envkms

package module

v0.0.0-...-46d254a Latest Latest Go to latest Published: Feb 28, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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

Source Files ¶

View all Source files

kms.go

Directories ¶

Path	Synopsis
cmd
envkmsutil
internal
proto

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL