vault

Documentation

Index

• Variables
• type Node
• type Secret
  • func NewSecret() *Secret
  • func (s *Secret) Format(oldKey, newKey, fmtType string) error
  • func (s *Secret) Get(key string) string
  • func (s *Secret) Has(key string) bool
  • func (s *Secret) JSON() string
  • func (s Secret) MarshalJSON() ([]byte, error)
  • func (s *Secret) Password(key string, length int)
  • func (s *Secret) RSAKey(bits int) error
  • func (s *Secret) SSHKey(bits int) error
  • func (s *Secret) Set(key, value string)
  • func (s *Secret) UnmarshalJSON(b []byte) error
  • func (s *Secret) YAML() string
• type Vault
  • func NewVault(url, token string) (*Vault, error)
  • func (v *Vault) Copy(oldpath, newpath string) error
  • func (v *Vault) Delete(path string) error
  • func (v *Vault) List(path string) (paths []string, err error)
  • func (v *Vault) Move(oldpath, newpath string) error
  • func (v *Vault) Read(path string) (secret *Secret, err error)
  • func (v *Vault) Tree(path string, ansify bool) (tree.Node, error)
  • func (v *Vault) Write(path string, s *Secret) error

Variables

var NotFound error

Types

type Node

type Node struct {
	Path     string
	Children []Node
}

type Secret

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

A Secret contains a set of key/value pairs that store anything you want, including passwords, RSAKey keys, usernames, etc.

func NewSecret

func NewSecret() *Secret

func (*Secret) Format

func (s *Secret) Format(oldKey, newKey, fmtType string) error

func (*Secret) Get

func (s *Secret) Get(key string) string

Get retrieves the value of the given key, or "" if no such key exists.

func (*Secret) Has

func (s *Secret) Has(key string) bool

Has returns true if the Secret has defined the given key.

func (*Secret) JSON

func (s *Secret) JSON() string

JSON converts a Secret to its JSON representation and returns it as a string. Returns an empty string if there were any errors.

func (Secret) MarshalJSON

func (s Secret) MarshalJSON() ([]byte, error)

func (*Secret) Password

func (s *Secret) Password(key string, length int)

Password creates and stores a new randomized password.

func (*Secret) RSAKey

func (s *Secret) RSAKey(bits int) error

RSAKey generates a new public/private keypair, and stores it in the secret, under the 'public' and 'private' keys.

func (*Secret) SSHKey

func (s *Secret) SSHKey(bits int) error

SSHKey generates a new public/private keypair, and stores it in the secret, under the 'public' and 'private' keys.

func (*Secret) Set

func (s *Secret) Set(key, value string)

Set stores a value in the Secret, under the given key.

func (*Secret) UnmarshalJSON

func (s *Secret) UnmarshalJSON(b []byte) error

func (*Secret) YAML

func (s *Secret) YAML() string

YAML converts a Secret to its YAML representation and returns it as a string. Returns an empty string if there were any errors.

type Vault

type Vault struct {
	URL    string
	Token  string
	Client *http.Client
}

A Vault represents a means for interacting with a remote Vault instance (unsealed and pre-authenticated) to read and write secrets.

func NewVault

func NewVault(url, token string) (*Vault, error)

NewVault creates a new Vault object. If an empty token is specified, the current user's token is read from ~/.vault-token.

func (*Vault) Copy

func (v *Vault) Copy(oldpath, newpath string) error

Copy copies secrets from one path to another.

func (*Vault) Delete

func (v *Vault) Delete(path string) error

Delete removes the secret stored at the specified path.

func (*Vault) List

func (v *Vault) List(path string) (paths []string, err error)

List returns the set of (relative) paths that are directly underneath the given path. Intermediate path nodes are suffixed with a single "/", whereas leaf nodes (the secrets themselves) are not.

func (*Vault) Move

func (v *Vault) Move(oldpath, newpath string) error

Move moves secrets from one path to another.

func (*Vault) Read

func (v *Vault) Read(path string) (secret *Secret, err error)

Read checks the Vault for a Secret at the specified path, and returns it. If there is nothing at that path, a nil *Secret will be returned, with no error.

func (*Vault) Tree

func (v *Vault) Tree(path string, ansify bool) (tree.Node, error)

Tree returns a tree that represents the hierarhcy of paths contained below the given path, inside of the Vault.

func (*Vault) Write

func (v *Vault) Write(path string, s *Secret) error

Write takes a Secret and writes it to the Vault at the specified path.