vault

Documentation

Overview

Package vault defines structs that will be used frequently by clients which utilize HTTP transport.

Index

• Constants
• func NewSecretClient(config SecretConfig) (pkg.SecretClient, error)
• type AuthenticationInfo
• type Caller
• type Client
  • func (c Client) GetSecrets(path string, keys ...string) (map[string]string, error)
• type ErrCaRootCert
  • func (e ErrCaRootCert) Error() string
• type SecretConfig
  • func (c SecretConfig) BuildURL() (path string)

Constants

const (
	// NamespaceHeader specifies the header name to use when including Namespace information in a request.
	NamespaceHeader = "X-Vault-Namespace"
)

Functions

func NewSecretClient

func NewSecretClient(config SecretConfig) (pkg.SecretClient, error)

NewSecretClient constructs a SecretClient which communicates with Vault via HTTP(S)

Types

type AuthenticationInfo

type AuthenticationInfo struct {
	AuthType  string
	AuthToken string
}

AuthenticationInfo contains authentication information to be used when communicating with an HTTP based provider

type Caller

type Caller interface {
	Do(req *http.Request) (*http.Response, error)
}

Caller interface used to abstract the implementation details for issuing an HTTP request. This allows for easier testing by the way of mocks.

type Client

type Client struct {
	HttpConfig SecretConfig
	HttpCaller Caller
}

Client defines the behavior for interacting with the Vault REST secret key/value store via HTTP(S).

func (Client) GetSecrets

func (c Client) GetSecrets(path string, keys ...string) (map[string]string, error)

GetSecrets retrieves the secrets at the provided path that match the specified keys.

type ErrCaRootCert

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

ErrCaRootCert error when the provided CA Root certificate is invalid.

func (ErrCaRootCert) Error

func (e ErrCaRootCert) Error() string

type SecretConfig

type SecretConfig struct {
	Host                    string
	Port                    int
	Path                    string
	Protocol                string
	Namespace               string
	RootCaCertPath          string
	ServerName              string
	Authentication          AuthenticationInfo
	AdditionalRetryAttempts int
	RetryWaitPeriod         time.Duration
}

SecretConfig contains configuration settings used to communicate with an HTTP based secret provider

func (SecretConfig) BuildURL

func (c SecretConfig) BuildURL() (path string)

BuildURL constructs a URL which can be used to identify a HTTP based secret provider