vault

Documentation

Index

• func RegisterDynamicSecretDependency(dep SecretsSubscriber, v SecretsManager, dc chan<- bool)
• type Auth
• type Config
• type Secret
• type SecretSubscriptionSpec
• type SecretsManager
  • func New() (SecretsManager, error)
  • func NewVerbose() (SecretsManager, error)
• type SecretsSubscriber
• type Token
• type UpdatedSecret
  • func (us UpdatedSecret) GetAllData() map[string]string
• type Vault
  • func (vault *Vault) Authenticate() error
  • func (vault *Vault) Configure(client libhttp.Client) error
  • func (vault *Vault) ConnectToServer() error
  • func (vault *Vault) GetSecret(path string) (Secret, error)
  • func (vault *Vault) SetDefaultGoogleCredentials(path, key string) error

Functions

func RegisterDynamicSecretDependency

func RegisterDynamicSecretDependency(dep SecretsSubscriber, v SecretsManager, dc chan<- bool)

RegisterDynamicSecretDependency by registering

Types

type Auth

type Auth struct {
	ClientToken   string                 `json:"client_token"`
	TokenType     string                 `json:"token_type"`
	Accessor      string                 `json:"accessor"`
	EntityID      string                 `json:"entity_id"`
	LeaseDuration int                    `json:"lease_duration"`
	Renewable     bool                   `json:"renewable"`
	Orphan        bool                   `json:"orphan"`
	Policies      []string               `json:"policies"`
	TokenPolicies []string               `json:"token_policies"`
	Metadata      map[string]interface{} `json:"metadata"`
}

Auth contains the token information for authenticating Vault requests

type Config

type Config struct {
	Addr          string
	GithubToken   string
	K8ServicePath string
	K8MountPath   string
	K8Role        string

	Client libhttp.Client
}

Config contains the configuration information needed to do the initial setup and renewal of a Vault service

type Secret

type Secret interface {
	GetRequestID() string
	GetLeaseID() string
	IsRenewable() bool
	GetLeaseDuration() int
	GetData() map[string]interface{}
	GetMetadata() map[string]interface{}
}

type SecretSubscriptionSpec

type SecretSubscriptionSpec struct {
	Paths        []string
	CallbackChan chan<- UpdatedSecret
}

SecretSubscriptionSpec a specification of the paths to the secrets that a subscriber is interested in

type SecretsManager

type SecretsManager interface {
	GetSecret(path string) (Secret, error)
	SetDefaultGoogleCredentials(path, key string) error
}

SecretsManager represents a service that is able to provide clients with a secret stored at a privded path.

func New

func New() (SecretsManager, error)

New initiaizes a new Vault prepares it for interacting with secrets. It reads configuration information from the environment, configures a HTTP client and gets an authentification token to get secrets.

func NewVerbose

func NewVerbose() (SecretsManager, error)

NewVerbose initiaizes a new Vault prepares it for interacting with secrets. Upon It reads configuration information from the environment, configures a HTTP client and gets an authentification token to get secrets.

type SecretsSubscriber

type SecretsSubscriber interface {
	GetSubscriptionSpec() SecretSubscriptionSpec

	ReceiveAtStartup(UpdatedSecret)

	// Here we assume that the subscriber starts its own
	// go routine for receiving updated secrets on the channel
	StartSecretsListener()
}

SecretsSubscriber implementors have are dependant on secrets (connections strings, service account credentials and similar), and want the dynamic aspects to be handled automatically.

type Token

type Token struct {
	RequestID     string `json:"request_id"`
	LeaseID       string `json:"lease_id"`
	LeaseDuration int    `json:"lease_duration"`
	Renewable     bool   `json:"renewable"`
	Auth          Auth   `json:"auth"`
}

Token is used for authenticating Vault requests

type UpdatedSecret

type UpdatedSecret struct {
	Path    string
	Secrets map[string]Secret
}

UpdatedSecret a new version of a secret

func (UpdatedSecret) GetAllData

func (us UpdatedSecret) GetAllData() map[string]string

GetAllData combines all data in all secrets to a single map

type Vault

type Vault struct {
	Config
	Token Token
}

Vault contains all information needed to get and interact with Vault secrets, after initial configuration.

func (*Vault) Authenticate

func (vault *Vault) Authenticate() error

Authenticate uses supplied login information to authenticate to Vault and get an authentification token

func (*Vault) Configure

func (vault *Vault) Configure(client libhttp.Client) error

Configure reads configuration information from provided file and returns a config struct containing this information.

func (*Vault) ConnectToServer

func (vault *Vault) ConnectToServer() error

ConnectToServer performs neccessary setup for connections to the external HID service

func (*Vault) GetSecret

func (vault *Vault) GetSecret(path string) (Secret, error)

GetSecret returns the secret from the provided path. In case of 403 response from server, the credentials will be renewed and the request retried once.

func (*Vault) SetDefaultGoogleCredentials

func (vault *Vault) SetDefaultGoogleCredentials(path, key string) error