vault

Documentation

Overview

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

Index

• Constants
• func NewMockClient() loggingClient
• func NewSecretClientFactory() *secretClientFactory
• type AuthenticationInfo
• type Caller
• type Client
  • func (c Client) GetSecrets(subPath string, keys ...string) (map[string]string, error)
  • func (c Client) StoreSecrets(subPath string, secrets map[string]string) error
• type ErrCaRootCert
  • func (e ErrCaRootCert) Error() string
• type MockLogger
  • func (lc MockLogger) Debug(msg string, args ...interface{})
  • func (lc MockLogger) Info(msg string, args ...interface{})
  • func (lc MockLogger) Warn(msg string, args ...interface{})
• type SecretConfig
  • func (c SecretConfig) BuildSecretsPathURL(subPath string) (url string, err error)
  • func (c SecretConfig) BuildURL(path string) (spURL string, err error)
• type TokenLookupMetadata
• type TokenLookupResponse

Constants

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

Functions

func NewMockClient

func NewMockClient() loggingClient

NewMockClient creates a mock instance of loggingClient implementation

func NewSecretClientFactory

func NewSecretClientFactory() *secretClientFactory

NewSecretClientFactory creates a new factory for manufacturing secret clients the facotry is maintaining an internal map of Vault tokens and context cancel functions for gracefully terminating the background goroutine per token

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
	// contains filtered or unexported fields
}

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

func (Client) GetSecrets

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

GetSecrets retrieves the secrets at the provided subpath that matches the specified keys.

func (Client) StoreSecrets

func (c Client) StoreSecrets(subPath string, secrets map[string]string) error

StoreSecrets stores the secrets at the provided subpath for 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 MockLogger

type MockLogger struct {
}

func (MockLogger) Debug

func (lc MockLogger) Debug(msg string, args ...interface{})

Debug simulates logging an entry at the DEBUG severity level

func (MockLogger) Info

func (lc MockLogger) Info(msg string, args ...interface{})

Info simulates logging an entry at the INFO severity level

func (MockLogger) Warn

func (lc MockLogger) Warn(msg string, args ...interface{})

Warn simulates logging an entry at the WARN severity level

type SecretConfig

type SecretConfig struct {
	Host string
	Port int
	// Path is the base path to the secret's location in the secret store
	Path                    string
	Protocol                string
	Namespace               string
	RootCaCertPath          string
	ServerName              string
	Authentication          AuthenticationInfo
	AdditionalRetryAttempts int
	RetryWaitPeriod         string
	// contains filtered or unexported fields
}

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

func (SecretConfig) BuildSecretsPathURL

func (c SecretConfig) BuildSecretsPathURL(subPath string) (url string, err error)

BuildSecretsPathURL constructs a URL which can be used to identify a secret's path subPath is the location of the secrets in the secrets engine

func (SecretConfig) BuildURL

func (c SecretConfig) BuildURL(path string) (spURL string, err error)

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

type TokenLookupMetadata

type TokenLookupMetadata struct {
	ExpireTime string `json:"expire_time"`
	Period     int    `json:"period"` // in seconds
	Renewable  bool   `json:"renewable"`
	Ttl        int    `json:"ttl"` // in seconds
}

type TokenLookupResponse

type TokenLookupResponse struct {
	Data TokenLookupMetadata
}