client

Documentation

Index

• type Cache
  • func NewCache(vaultClient *api.Client) *Cache
  • func (cache *Cache) Clear()
  • func (cache *Cache) List(path string) (result *api.Secret, err error)
• type Client
  • func NewClient(conf *VaultConfig) (*Client, error)
  • func (client *Client) ClearCache()
  • func (client *Client) Delete(absolutePath string) (err error)
  • func (client *Client) GetType(absolutePath string) (kind PathKind)
  • func (client *Client) List(absolutePath string) (result []string, err error)
  • func (client *Client) Read(absolutePath string) (secret *Secret, err error)
  • func (client *Client) SubpathsForPath(path string, shallow bool) (filePaths []string, err error)
  • func (client *Client) Traverse(absolutePath string, shallow bool) (paths []string)
  • func (client *Client) Write(absolutePath string, secret *Secret) (err error)
• type PathKind
• type Secret
  • func NewSecret(vaultSecret *api.Secret) *Secret
  • func (secret *Secret) GetAPISecret() *api.Secret
  • func (secret *Secret) GetData() map[string]interface{}
  • func (secret *Secret) SetData(data map[string]interface{})
• type VaultConfig

Types

type Cache

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

Cache is a thread-safe cache for vault queries

func NewCache

func NewCache(vaultClient *api.Client) *Cache

NewCache create a new thread-safe cache object

func (*Cache) Clear

func (cache *Cache) Clear()

Clear removes all entries from the cache

func (*Cache) List

func (cache *Cache) List(path string) (result *api.Secret, err error)

List tries to get path from cache. If path is not available in cache, it uses the vault client to query and update cache.

type Client

type Client struct {
	Vault      *api.Client
	Name       string
	Pwd        string
	KVBackends map[string]int
	// contains filtered or unexported fields
}

Client wrapper for Vault API client

func NewClient

func NewClient(conf *VaultConfig) (*Client, error)

NewClient creates a new Client Vault wrapper

func (*Client) ClearCache

func (client *Client) ClearCache()

ClearCache clears the list cache

func (*Client) Delete

func (client *Client) Delete(absolutePath string) (err error)

Delete deletes secret at given absolutePath, using given client

func (*Client) GetType

func (client *Client) GetType(absolutePath string) (kind PathKind)

GetType returns the file type the given absolutePath points to. Possible return values are BACKEND, NODE, LEAF or NONE

func (*Client) List

func (client *Client) List(absolutePath string) (result []string, err error)

List elements at the given absolutePath, using the given client

func (*Client) Read

func (client *Client) Read(absolutePath string) (secret *Secret, err error)

Read returns secret at given path, using given Client

func (*Client) SubpathsForPath

func (client *Client) SubpathsForPath(path string, shallow bool) (filePaths []string, err error)

SubpathsForPath will return an array of absolute paths at or below path

func (*Client) Traverse

func (client *Client) Traverse(absolutePath string, shallow bool) (paths []string)

Traverse traverses given absolutePath via DFS and returns sub-paths in array

func (*Client) Write

func (client *Client) Write(absolutePath string, secret *Secret) (err error)

Write writes secret to given path, using given Client

type PathKind

type PathKind int

PathKind describes the type of a path

const (
	BACKEND PathKind = iota
	NODE
	LEAF
	NONE
)

types of paths

type Secret

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

Secret holds vault secret and offers operations to simplify KV abstraction

func NewSecret

func NewSecret(vaultSecret *api.Secret) *Secret

NewSecret create a new Secret object

func (*Secret) GetAPISecret

func (secret *Secret) GetAPISecret() *api.Secret

GetAPISecret getter method for vault secret in Secret object

func (*Secret) GetData

func (secret *Secret) GetData() map[string]interface{}

GetData returns the secret data as a map and is KV agnostic

func (*Secret) SetData

func (secret *Secret) SetData(data map[string]interface{})

SetData set given data as vault secret data and is KV agnostic

type VaultConfig

type VaultConfig struct {
	Addr      string
	Token     string
	StartPath string
}

VaultConfig container to keep parameters for Client configuration