vaultunboxer

Documentation

Index

• Constants
• Variables
• type BoxedValue
  • func NewBoxedValue(rawBoxedValue string) (*BoxedValue, error)
  • func (value *BoxedValue) Select(data interface{}) (string, error)
  • func (value *BoxedValue) UseCache() bool
  • func (value *BoxedValue) VaultPathArgs() map[string][]string
• type CachedSecret
• type JWTAuth
  • func (jwtAuth *JWTAuth) Login(ctx context.Context, client *vault.Client) (*vault.Secret, error)
• type VaultUnboxer
  • func New(client *vault.Client) *VaultUnboxer
  • func NewFromEnvironment(ctx context.Context, env *environment.Environment) (*VaultUnboxer, error)
  • func (unboxer *VaultUnboxer) Unbox(ctx context.Context, value *BoxedValue) (string, error)

Constants

const (
	EnvCirrusVaultURL       = "CIRRUS_VAULT_URL"
	EnvCirrusVaultAuthPath  = "CIRRUS_VAULT_AUTH_PATH"
	EnvCirrusVaultNamespace = "CIRRUS_VAULT_NAMESPACE"
	EnvCirrusVaultRole      = "CIRRUS_VAULT_ROLE"
)

Variables

var (
	ErrNotABoxedValue    = errors.New("doesn't look like a Vault-boxed value")
	ErrInvalidBoxedValue = errors.New("Vault-boxed value has an invalid format")
)

Types

type BoxedValue

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

func NewBoxedValue

func NewBoxedValue(rawBoxedValue string) (*BoxedValue, error)

func (*BoxedValue) Select

func (value *BoxedValue) Select(data interface{}) (string, error)

func (*BoxedValue) UseCache

func (value *BoxedValue) UseCache() bool

func (*BoxedValue) VaultPathArgs

func (value *BoxedValue) VaultPathArgs() map[string][]string

type CachedSecret

type CachedSecret struct {
	Secret *vault.Secret
	Err    error
}

type JWTAuth

type JWTAuth struct {
	Token string
	Role  string
	Path  string
}

func (*JWTAuth) Login

func (jwtAuth *JWTAuth) Login(ctx context.Context, client *vault.Client) (*vault.Secret, error)

type VaultUnboxer

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

func New

func New(client *vault.Client) *VaultUnboxer

func NewFromEnvironment

func NewFromEnvironment(ctx context.Context, env *environment.Environment) (*VaultUnboxer, error)

func (*VaultUnboxer) Unbox

func (unboxer *VaultUnboxer) Unbox(ctx context.Context, value *BoxedValue) (string, error)