providers

Documentation

Index

• Variables
• type EnvProvider
  • func NewEnvProvider() EnvProvider
  • func (ep EnvProvider) GetValue(fieldPath []string) (string, error)
• type JSONProvider
  • func NewJSONProvider(filePath string) (*JSONProvider, error)
  • func NewJSONProviderFromFs(fs fs.FS, filePath string) (*JSONProvider, error)
  • func (jp JSONProvider) GetValue(fieldPath []string) (string, error)
• type VaultAppRoleAuthOptions
• type VaultClient
  • func NewVaultClient() *VaultClient
  • func (vc *VaultClient) AppRoleLogin(ctx context.Context, roleId string, secretId string) error
  • func (vc *VaultClient) GetValues(ctx context.Context, path string, mountPath string) (map[string]interface{}, error)
  • func (vc *VaultClient) Initialize(url string, requestTimeout time.Duration) error
  • func (vc *VaultClient) KubernetesLogin(ctx context.Context, jwt string, role string) error
• type VaultClienter
• type VaultKubernetesAuthOptions
• type VaultOptions
• type VaultProvider
  • func NewVaultProvider(options VaultOptions) (*VaultProvider, error)
  • func (vp *VaultProvider) GetValue(fieldPath []string) (string, error)

Variables

var (
	ErrInvalidVaultAuthConfig = errors.New("exactly one auth method options must be specified")
	ErrVaultConnection        = errors.New("error connecting to the Vault server")
	ErrVaultAuth              = errors.New("error authenticating with Vault")
	ErrVaultSecretFetch       = errors.New("error fetching secret from Vault")
	ErrVaultSecretValueType   = errors.New("error getting secret value as string")
)

Types

type EnvProvider

type EnvProvider struct{}

func NewEnvProvider

func NewEnvProvider() EnvProvider

func (EnvProvider) GetValue

func (ep EnvProvider) GetValue(fieldPath []string) (string, error)

type JSONProvider

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

func NewJSONProvider

func NewJSONProvider(filePath string) (*JSONProvider, error)

func NewJSONProviderFromFs

func NewJSONProviderFromFs(fs fs.FS, filePath string) (*JSONProvider, error)

func (JSONProvider) GetValue

func (jp JSONProvider) GetValue(fieldPath []string) (string, error)

type VaultAppRoleAuthOptions

type VaultAppRoleAuthOptions struct {
	RoleId   string
	SecretId string
}

type VaultClient

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

func NewVaultClient

func NewVaultClient() *VaultClient

func (*VaultClient) AppRoleLogin

func (vc *VaultClient) AppRoleLogin(ctx context.Context, roleId string, secretId string) error

func (*VaultClient) GetValues

func (vc *VaultClient) GetValues(ctx context.Context, path string, mountPath string) (map[string]interface{}, error)

func (*VaultClient) Initialize

func (vc *VaultClient) Initialize(url string, requestTimeout time.Duration) error

func (*VaultClient) KubernetesLogin

func (vc *VaultClient) KubernetesLogin(ctx context.Context, jwt string, role string) error

type VaultClienter

type VaultClienter interface {
	Initialize(url string, requestTimeout time.Duration) error
	AppRoleLogin(ctx context.Context, roleId string, secretId string) error
	KubernetesLogin(ctx context.Context, jwt string, role string) error
	GetValues(ctx context.Context, path string, mountPath string) (map[string]interface{}, error)
}

VaultClienter Serves as an abstraction layer to the actual vault client We're using this, so we can unit test the vault provider without worrying about the Vault client

type VaultKubernetesAuthOptions

type VaultKubernetesAuthOptions struct {
	Jwt  string
	Role string
}

type VaultOptions

type VaultOptions struct {
	// The Vault Server url
	Url string

	// The request timeout for the vault client in seconds (default 1m)
	RequestTimeout int

	// Options for app role authentication
	AppRoleAuth *VaultAppRoleAuthOptions

	// Options for kubernetes authentication
	KubernetesAuth *VaultKubernetesAuthOptions

	// The KV mount path
	MountPath string

	// The path of the secret
	Path string
}

type VaultProvider

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

func NewVaultProvider

func NewVaultProvider(options VaultOptions) (*VaultProvider, error)

func (*VaultProvider) GetValue

func (vp *VaultProvider) GetValue(fieldPath []string) (string, error)