vault

Documentation

Index

• type Config
• type CustomError
• type CustomVaultError
  • func (verr CustomVaultError) Error() string
• type Logger
• type Vault
  • func New(config *Config) (*Vault, error)
  • func (v *Vault) AWScredentials(account string, role string) (*api.Secret, error)
  • func (v *Vault) GetAddress() (string, error)
  • func (v *Vault) GetCurrentTokenTTL() (time.Duration, error)
  • func (v *Vault) GetHealth() (*api.HealthResponse, error)
  • func (v *Vault) GetMounts(mountType string) ([]string, error)
  • func (v *Vault) GetSecret(path string) (*api.Secret, error)
  • func (v *Vault) GetSecretKey(path string, key string) (string, error)
  • func (v *Vault) GetSecretKeys(path string) (map[string]string, error)
  • func (v *Vault) GetToken() (string, error)
  • func (v *Vault) GetUser() string
  • func (v *Vault) GetUsername() (string, error)
  • func (v *Vault) IsNewLogin() bool
  • func (v *Vault) ListSecrets(path string) ([]string, error)
  • func (v *Vault) Login() error
  • func (v *Vault) RenewLease(leaseID string, duration time.Duration) (time.Duration, error)
  • func (v *Vault) Version() (string, error)

Types

type Config

type Config struct {
	AuthPath             string
	Noprompt             bool
	Address              string
	Username             string
	UsernameSkipPrompt   bool
	Timeout              time.Duration
	InitialTokenDuration time.Duration
	Log                  Logger
}

type CustomError

type CustomError interface {
	Error() string
	// contains filtered or unexported methods
}

customError is custom error interface with one method that will block other functions from using this Error. This is not interchangeable with the standard error.

type CustomVaultError

type CustomVaultError struct {
	MessageParts  []string
	OriginalError error
}

CustomVaultError is the custom error type for this package

func (CustomVaultError) Error

func (verr CustomVaultError) Error() string

Error returns the error string

type Logger

type Logger interface {
	Debug(...interface{})
	Warn(...interface{})
	Fatal(...interface{})
}

type Vault

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

func New

func New(config *Config) (*Vault, error)

func (*Vault) AWScredentials

func (v *Vault) AWScredentials(account string, role string) (*api.Secret, error)

func (*Vault) GetAddress

func (v *Vault) GetAddress() (string, error)

GetAddress returns the currently configured Vault address

func (*Vault) GetCurrentTokenTTL

func (v *Vault) GetCurrentTokenTTL() (time.Duration, error)

GetCurrentTokenTTL gets the TTL of the current token

func (*Vault) GetHealth

func (v *Vault) GetHealth() (*api.HealthResponse, error)

GetHealth returns the Vault api health response

func (*Vault) GetMounts

func (v *Vault) GetMounts(mountType string) ([]string, error)

GetMounts retrieves a list of mounts Will return a string array filtered with given type. Example 'aws'

func (*Vault) GetSecret

func (v *Vault) GetSecret(path string) (*api.Secret, error)

GetSecret takes a secret path and returns the secret(s) in a Vault object

func (*Vault) GetSecretKey

func (v *Vault) GetSecretKey(path string, key string) (string, error)

GetSecretKey takes a secret path and key and returns, if successful, the secret string present in that key.

func (*Vault) GetSecretKeys

func (v *Vault) GetSecretKeys(path string) (map[string]string, error)

GetSecretKeys takes a secret path and returns, if successful, a map of all the keys at that path.

func (*Vault) GetToken

func (v *Vault) GetToken() (string, error)

GetToken returns the raw token

func (*Vault) GetUser

func (v *Vault) GetUser() string

func (*Vault) GetUsername

func (v *Vault) GetUsername() (string, error)

GetMeta returns the username metadata for the current token

func (*Vault) IsNewLogin

func (v *Vault) IsNewLogin() bool

IsNewLogin will help high level funcs know if a login prompt was used

func (*Vault) ListSecrets

func (v *Vault) ListSecrets(path string) ([]string, error)

ListSecrets takes a secret path and returns, if successful, a list of all child paths under that path.

func (*Vault) Login

func (v *Vault) Login() error

Login will authenticate the user with Vault Will detect if user needs to re-login

func (*Vault) RenewLease

func (v *Vault) RenewLease(leaseID string, duration time.Duration) (time.Duration, error)

Renew lease takes a Vault lease ID and renews it for the provided duration Returns the actual renew time (may be different than requested)

func (*Vault) Version

func (v *Vault) Version() (string, error)

Version returns the version of the Vault server