confz

Documentation

Index

• Constants
• func ConsulGet(key string) ([]byte, error)
• func Decode(obj any, secretFetcher SecretFetcher, encDecoder SecretFetcher) (any, error)
• func Decrypt(v any) (any, error)
• func DecryptInplace(v any) error
• func FileExists(file string) (bool, error)
• func Md5Hex(data []byte) string
• func NewAppRoleVaultClient(addr string, roleId string, secretId string) (*vault.Client, error)
• func NewEnvAppRoleVaultClient() (*vault.Client, error)
• type EncDecoder
  • func NewDefaultEncDecoder() *EncDecoder
  • func NewEncDecoder(key string) *EncDecoder
  • func (d *EncDecoder) Fetch(ctx context.Context, key string) (string, error)
• type LazyVaultSecretFetcher
  • func NewLazyVaultSecretFetcher() *LazyVaultSecretFetcher
  • func (f *LazyVaultSecretFetcher) Fetch(ctx context.Context, secretKey string) (string, error)
• type SecretFetcher
• type VaultConf
• type VaultSecretFetcher
  • func NewVaultSecretFetcher(client *vault.Client) *VaultSecretFetcher
  • func (f *VaultSecretFetcher) Close() error
  • func (f *VaultSecretFetcher) Fetch(ctx context.Context, secretKey string) (string, error)

Constants

const (
	EnvConsulAddr  = "CONSUL_ADDR"
	EnvConsulToken = "CONSUL_TOKEN"
)

const (
	EnvVaultAddr     = "VAULT_ADDR"
	EnvVaultRoleId   = "VAULT_ROLE_ID"
	EnvVaultSecretId = "VAULT_SECRET_ID"
	EnvVaultTmpDir   = "VAULT_TMP_DIR"
)

const (
	EnvConfigKey = "CONFIG_KEY"
)

Functions

func ConsulGet

func ConsulGet(key string) ([]byte, error)

func Decode

func Decode(obj any, secretFetcher SecretFetcher, encDecoder SecretFetcher) (any, error)

Decode decrypts the encrypted string fields start with `ENC~` in fields tree of obj and returns the decrypted obj.

func Decrypt

func Decrypt(v any) (any, error)

func DecryptInplace

func DecryptInplace(v any) error

func FileExists

func FileExists(file string) (bool, error)

func Md5Hex

func Md5Hex(data []byte) string

Md5Hex returns the md5 hex string of data.

func NewAppRoleVaultClient

func NewAppRoleVaultClient(
	addr string,
	roleId string,
	secretId string,
) (*vault.Client, error)

func NewEnvAppRoleVaultClient

func NewEnvAppRoleVaultClient() (*vault.Client, error)

Types

type EncDecoder

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

func NewDefaultEncDecoder

func NewDefaultEncDecoder() *EncDecoder

func NewEncDecoder

func NewEncDecoder(key string) *EncDecoder

func (*EncDecoder) Fetch

func (d *EncDecoder) Fetch(ctx context.Context, key string) (string, error)

type LazyVaultSecretFetcher

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

func NewLazyVaultSecretFetcher

func NewLazyVaultSecretFetcher() *LazyVaultSecretFetcher

func (*LazyVaultSecretFetcher) Fetch

func (f *LazyVaultSecretFetcher) Fetch(ctx context.Context, secretKey string) (string, error)

type SecretFetcher

type SecretFetcher interface {
	Fetch(ctx context.Context, key string) (string, error)
}

type VaultConf

type VaultConf struct {
	Addr  string `json:"addr,env=VAULT_ADDR"`
	Token string `json:"token,env=VAULT_TOKEN"`
}

type VaultSecretFetcher

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

func NewVaultSecretFetcher

func NewVaultSecretFetcher(client *vault.Client) *VaultSecretFetcher

func (*VaultSecretFetcher) Close

func (f *VaultSecretFetcher) Close() error

func (*VaultSecretFetcher) Fetch

func (f *VaultSecretFetcher) Fetch(ctx context.Context, secretKey string) (string, error)

Fetch returns the value of the key in the given path. path format: {mount}/{path}/{key} cache key: {mount}/{path}