vault

Documentation

Index

• func CheckAuthentication(ctx context.Context, client *api.Client) ([]string, error)
• func FromKey(key string) (value.Transformer, error)
• func Transformer(mountPath, keyName string, dataEncryption DataEncryption) (value.Transformer, error)
• func TransformerKey(mountPath, keyName string, dataEncryption DataEncryption) string
• type DataEncryption
• type ServiceFactory
  • func DefaultClient() (ServiceFactory, error)
  • func FromVaultClient(vaultClient *api.Client) (ServiceFactory, error)

Functions

func CheckAuthentication

func CheckAuthentication(ctx context.Context, client *api.Client) ([]string, error)

CheckAuthentication verifies that the connection to vault is setup correctly by retrieving information about the configured token.

func FromKey

func FromKey(key string) (value.Transformer, error)

Vault returns an envelope encryption using a remote transit backend for key encryption. vault:<path>:<data encryption>

func Transformer

func Transformer(mountPath, keyName string, dataEncryption DataEncryption) (value.Transformer, error)

Transformer returns an envelope encryption using a remote transit backend for key encryption.

func TransformerKey

func TransformerKey(mountPath, keyName string, dataEncryption DataEncryption) string

Types

type DataEncryption

type DataEncryption string

var (
	AESGCM           DataEncryption = "aesgcm"
	Chacha20Poly1305 DataEncryption = "chacha20poly1305"
	Secretbox        DataEncryption = "secretbox"
)

type ServiceFactory

type ServiceFactory interface {
	KV(mountPath string) (kv.Service, error)
	Transit(mounthPath, keyName string) (transit.Service, error)
	Cubbyhole(mountPath string) (cubbyhole.Service, error)
}

ServiceFactory defines Vault client cervice contract.

func DefaultClient

func DefaultClient() (ServiceFactory, error)

DefaultClient initialize a Vault client and wrap it in a Service factory.

func FromVaultClient

func FromVaultClient(vaultClient *api.Client) (ServiceFactory, error)

FromVaultClient wraps an existing Vault client as a Service factory.