vault

Documentation

Index

• type Capability
  • func (c *Capability) String() string
• type Engines
• type Namespaces
• type Secrets
• type Vault
  • func NewClient(addr, token string) (*Vault, error)
  • func NewDefaultClient() (*Vault, error)
  • func (v *Vault) CreateNamespaceErrorIfNotForced(parentNS, nsName string, force bool) error
  • func (v *Vault) DeleteNamespace(parentns, ns string) error
  • func (v *Vault) DisableKV2Engine(rootPath string) error
  • func (v *Vault) EnableKV1Engine(rootPath string) error
  • func (v *Vault) EnableKV2Engine(rootPath string) error
  • func (v *Vault) EnableKV2EngineErrorIfNotForced(force bool, path string) error
  • func (v *Vault) GetCapabilities(path string) (*Capability, error)
  • func (v *Vault) GetEngineDescription(rootPath string) (string, error)
  • func (v *Vault) GetEngineTypeVersion(rootPath string) (string, string, error)
  • func (v *Vault) IsKVv1(rootPath string) (bool, error)
  • func (v *Vault) ListAllKVSecretEngines(ns string) (Engines, error)
  • func (v *Vault) ListAllNamespaces(ns string) (Namespaces, error)
  • func (v *Vault) ListKVSecretEngines(ns string) ([]string, error)
  • func (v *Vault) ListKeys(rootPath, subPath string) ([]string, error)
  • func (v *Vault) ListNamespaces(ns string) ([]string, error)
  • func (v *Vault) ListRecursive(rootPath, subPath string, skipErrors bool) (*Secrets, error)
  • func (v *Vault) ReadSecretMetadata(rootPath, subPath string) (interface{}, error)
  • func (v *Vault) ReadSecretVersion(rootPath, subPath string) (interface{}, error)
  • func (v *Vault) ReadSecrets(rootPath, subPath string) (map[string]interface{}, error)
  • func (v *Vault) WriteSecrets(rootPath, subPath string, secrets map[string]interface{}) error

Types

type Capability

type Capability struct {
	Create bool
	Read   bool
	Update bool
	Delete bool
	List   bool
	Root   bool
}

Capability represents a tokens caps for a specific path.

func (*Capability) String

func (c *Capability) String() string

type Engines

type Engines map[string][]string

Engines struct that hols all engines key is the namespace.

type Namespaces

type Namespaces map[string][]string

Namespaces represents vault hierarchical namespaces.

type Secrets

type Secrets map[string]interface{}

Secrets holds all recursive secrets of a certain path.

type Vault

type Vault struct {
	Client *api.Client
}

Vault represents a vault struct used for reading and writing secrets.

func NewClient

func NewClient(addr, token string) (*Vault, error)

NewClient returns a new vault client wrapper.

func NewDefaultClient

func NewDefaultClient() (*Vault, error)

NewDefaultClient returns a new vault client wrapper.

func (*Vault) CreateNamespaceErrorIfNotForced

func (v *Vault) CreateNamespaceErrorIfNotForced(parentNS, nsName string, force bool) error

CreateNamespaceErrorIfNotForced creates a namespace returns no error if force is true.

func (*Vault) DeleteNamespace

func (v *Vault) DeleteNamespace(parentns, ns string) error

DeleteNamespace deletes a namespace.

func (*Vault) DisableKV2Engine

func (v *Vault) DisableKV2Engine(rootPath string) error

DisableKV2Engine disables the kv2 engine at a specified path.

func (*Vault) EnableKV1Engine

func (v *Vault) EnableKV1Engine(rootPath string) error

EnableKV1Engine enables the kv1 engine at a specified path.

func (*Vault) EnableKV2Engine

func (v *Vault) EnableKV2Engine(rootPath string) error

EnableKV2Engine enables the kv2 engine at a specified path.

func (*Vault) EnableKV2EngineErrorIfNotForced

func (v *Vault) EnableKV2EngineErrorIfNotForced(force bool, path string) error

EnableKV2EngineErrorIfNotForced enables a KVv2 Engine and errors if already enabled, unless force is set to true.

func (*Vault) GetCapabilities

func (v *Vault) GetCapabilities(path string) (*Capability, error)

GetCapabilities returns the current authenticated tokens capabilities for a given path.

func (*Vault) GetEngineDescription

func (v *Vault) GetEngineDescription(rootPath string) (string, error)

GetEngineDescription returns the description of the engine.

func (*Vault) GetEngineTypeVersion

func (v *Vault) GetEngineTypeVersion(rootPath string) (string, string, error)

func (*Vault) IsKVv1

func (v *Vault) IsKVv1(rootPath string) (bool, error)

IsKVv1 returns true if the current path is a KVv1 Engine.

func (*Vault) ListAllKVSecretEngines

func (v *Vault) ListAllKVSecretEngines(ns string) (Engines, error)

ListAllKVSecretEngines returns a list of all visible KV secret engines.

func (*Vault) ListAllNamespaces

func (v *Vault) ListAllNamespaces(ns string) (Namespaces, error)

ListAllNamespaces lists all namespaces of a specified namespace recursively.

func (*Vault) ListKVSecretEngines

func (v *Vault) ListKVSecretEngines(ns string) ([]string, error)

ListKVSecretEngines returns a list of all visible KV secret engines.

func (*Vault) ListKeys

func (v *Vault) ListKeys(rootPath, subPath string) ([]string, error)

ListKeys returns all keys from vault kv secret path.

func (*Vault) ListNamespaces

func (v *Vault) ListNamespaces(ns string) ([]string, error)

ListNamespaces list the namespaces of the specified namespace.

func (*Vault) ListRecursive

func (v *Vault) ListRecursive(rootPath, subPath string, skipErrors bool) (*Secrets, error)

ListRecursive returns secrets to a path recursive. nolint: cyclop

func (*Vault) ReadSecretMetadata

func (v *Vault) ReadSecretMetadata(rootPath, subPath string) (interface{}, error)

ReadSecretMetadata read the metadata of the secret.

func (*Vault) ReadSecretVersion

func (v *Vault) ReadSecretVersion(rootPath, subPath string) (interface{}, error)

ReadSecretVersion read the version of the secret.

func (*Vault) ReadSecrets

func (v *Vault) ReadSecrets(rootPath, subPath string) (map[string]interface{}, error)

ReadSecrets returns a map with all secrets from a kv engine path.

func (*Vault) WriteSecrets

func (v *Vault) WriteSecrets(rootPath, subPath string, secrets map[string]interface{}) error

WriteSecrets writes kv secrets to a specified path.