vault

Documentation

Index

• Constants
• Variables
• type KeyStore
• type Vault
  • func (v *Vault) Close() error
  • func (v *Vault) Create(keys KeyStore) (*model.Model, error)
  • func (v *Vault) Info() *api.VaultInfo
  • func (v *Vault) Open(keys KeyStore) (*model.Model, error)
  • func (v *Vault) OpenRaw(keys KeyStore) (*model.Model, error)
  • func (v *Vault) Status(keys KeyStore) (*api.VaultStatus, error)
  • func (v *Vault) With(keys KeyStore, fn func(*model.Model) error) error
• type Wallet
  • func (w *Wallet) Each(fn func(*Vault) error) error
  • func (w *Wallet) Index() *Vault
  • func (w *Wallet) Vault(name string) *Vault

Constants

const Index = "index"

Variables

var ErrAlreadyExists = errors.Conflict.With("already exists")

var ErrNotRegistered = errors.NotFound.With("not a registered vault")

Types

type KeyStore

type KeyStore interface {
	// GetKey retrieves the encryption key for the given vault.
	GetKey(*Vault) (*memguard.Enclave, error)
}

type Vault

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

func (*Vault) Close

func (v *Vault) Close() error

func (*Vault) Create

func (v *Vault) Create(keys KeyStore) (*model.Model, error)

Create creates the underlying database and returns an unencrypted model.

func (*Vault) Info

func (v *Vault) Info() *api.VaultInfo

func (*Vault) Open

func (v *Vault) Open(keys KeyStore) (*model.Model, error)

func (*Vault) OpenRaw

func (v *Vault) OpenRaw(keys KeyStore) (*model.Model, error)

func (*Vault) Status

func (v *Vault) Status(keys KeyStore) (*api.VaultStatus, error)

func (*Vault) With

func (v *Vault) With(keys KeyStore, fn func(*model.Model) error) error

type Wallet

type Wallet struct {
	UseMemDB  bool
	Directory string
	// contains filtered or unexported fields
}

func (*Wallet) Each

func (w *Wallet) Each(fn func(*Vault) error) error

func (*Wallet) Index

func (w *Wallet) Index() *Vault

func (*Wallet) Vault

func (w *Wallet) Vault(name string) *Vault