root

Documentation

Index

• type Store
  • func New(ctx context.Context, cfg *config.Config) (*Store, error)
  • func (r *Store) AddMount(ctx context.Context, alias, path string, keys ...string) error
  • func (r *Store) AddRecipient(ctx context.Context, store, rec string) error
  • func (r *Store) Alias() string
  • func (r *Store) Copy(ctx context.Context, from, to string) error
  • func (r *Store) Delete(ctx context.Context, name string) error
  • func (r *Store) Exists(ctx context.Context, name string) bool
  • func (r *Store) Format(maxDepth int) (string, error)
  • func (r *Store) Fsck(ctx context.Context, prefix string) (map[string]uint64, error)
  • func (r *Store) GPGVersion(ctx context.Context) semver.Version
  • func (r *Store) Get(ctx context.Context, name string) (*secret.Secret, error)
  • func (r *Store) GetSubStore(name string) (*sub.Store, error)
  • func (r *Store) GetTemplate(ctx context.Context, name string) ([]byte, error)
  • func (r *Store) Git(ctx context.Context, name string, recurse, force bool, args ...string) error
  • func (r *Store) GitInit(ctx context.Context, name, sk, userName, userEmail string) error
  • func (r *Store) GitVersion(ctx context.Context) semver.Version
  • func (r *Store) HasTemplate(ctx context.Context, name string) bool
  • func (r *Store) ImportMissingPublicKeys(ctx context.Context) error
  • func (r *Store) Init(ctx context.Context, alias, path string, ids ...string) error
  • func (r *Store) Initialized() bool
  • func (r *Store) IsDir(ctx context.Context, name string) bool
  • func (r *Store) List(maxDepth int) ([]string, error)
  • func (r *Store) ListRecipients(ctx context.Context, store string) []string
  • func (r *Store) LookupTemplate(ctx context.Context, name string) ([]byte, bool)
  • func (r *Store) MountPoints() []string
  • func (r *Store) Mounts() map[string]string
  • func (r *Store) Move(ctx context.Context, from, to string) error
  • func (r *Store) Path() string
  • func (r *Store) Prune(ctx context.Context, tree string) error
  • func (r *Store) RecipientsTree(ctx context.Context, pretty bool) (tree.Tree, error)
  • func (r *Store) RemoveMount(alias string) error
  • func (r *Store) RemoveRecipient(ctx context.Context, store, rec string) error
  • func (r *Store) RemoveTemplate(ctx context.Context, name string) error
  • func (r *Store) SaveRecipients(ctx context.Context) error
  • func (r *Store) Set(ctx context.Context, name string, sec *secret.Secret) error
  • func (r *Store) SetTemplate(ctx context.Context, name string, content []byte) error
  • func (r *Store) String() string
  • func (r *Store) TemplateTree() (tree.Tree, error)
  • func (r *Store) Tree() (tree.Tree, error)

Types

type Store

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

Store is the public facing password store

func New

func New(ctx context.Context, cfg *config.Config) (*Store, error)

New creates a new store

func (*Store) AddMount

func (r *Store) AddMount(ctx context.Context, alias, path string, keys ...string) error

AddMount adds a new mount

func (*Store) AddRecipient

func (r *Store) AddRecipient(ctx context.Context, store, rec string) error

AddRecipient adds a single recipient to the given store

func (*Store) Alias

func (r *Store) Alias() string

Alias always returns an empty string

func (*Store) Copy

func (r *Store) Copy(ctx context.Context, from, to string) error

Copy will copy one entry to another location. Multi-store copies are supported. Each entry has to be decoded and encoded for the destination to make sure it's encrypted for the right set of recipients.

func (*Store) Delete

func (r *Store) Delete(ctx context.Context, name string) error

Delete will remove an single entry from the store

func (*Store) Exists

func (r *Store) Exists(ctx context.Context, name string) bool

Exists checks the existence of a single entry

func (*Store) Format

func (r *Store) Format(maxDepth int) (string, error)

Format will pretty print all entries in this store and all substores

func (*Store) Fsck

func (r *Store) Fsck(ctx context.Context, prefix string) (map[string]uint64, error)

Fsck checks the stores integrity

func (*Store) GPGVersion

func (r *Store) GPGVersion(ctx context.Context) semver.Version

GPGVersion returns GPG version information

func (*Store) Get

func (r *Store) Get(ctx context.Context, name string) (*secret.Secret, error)

Get returns the plaintext of a single key

func (*Store) GetSubStore

func (r *Store) GetSubStore(name string) (*sub.Store, error)

GetSubStore returns an exact match for a mount point or an error if this mount point does not exist

func (*Store) GetTemplate

func (r *Store) GetTemplate(ctx context.Context, name string) ([]byte, error)

GetTemplate will return the content of the named template

func (*Store) Git

func (r *Store) Git(ctx context.Context, name string, recurse, force bool, args ...string) error

Git runs arbitrary git commands on this store and all substores

func (*Store) GitInit

func (r *Store) GitInit(ctx context.Context, name, sk, userName, userEmail string) error

GitInit initializes the git repo

func (*Store) GitVersion

func (r *Store) GitVersion(ctx context.Context) semver.Version

GitVersion returns git version information

func (*Store) HasTemplate

func (r *Store) HasTemplate(ctx context.Context, name string) bool

HasTemplate returns true if the template exists

func (*Store) ImportMissingPublicKeys

func (r *Store) ImportMissingPublicKeys(ctx context.Context) error

ImportMissingPublicKeys import missing public keys in any substore

func (*Store) Init

func (r *Store) Init(ctx context.Context, alias, path string, ids ...string) error

Init tries to initialize a new password store location matching the object

func (*Store) Initialized

func (r *Store) Initialized() bool

Initialized checks on disk if .gpg-id was generated and thus returns true.

func (*Store) IsDir

func (r *Store) IsDir(ctx context.Context, name string) bool

IsDir checks if a given key is actually a folder

func (*Store) List

func (r *Store) List(maxDepth int) ([]string, error)

List will return a flattened list of all tree entries

func (*Store) ListRecipients

func (r *Store) ListRecipients(ctx context.Context, store string) []string

ListRecipients lists all recipients for the given store

func (*Store) LookupTemplate

func (r *Store) LookupTemplate(ctx context.Context, name string) ([]byte, bool)

LookupTemplate will lookup and return a template

func (*Store) MountPoints

func (r *Store) MountPoints() []string

MountPoints returns a sorted list of mount points. It encodes the logic that the longer a mount point the more specific it is. This allows to "shadow" a shorter mount point by a longer one.

func (*Store) Mounts

func (r *Store) Mounts() map[string]string

Mounts returns a map of mounts with their paths

func (*Store) Move

func (r *Store) Move(ctx context.Context, from, to string) error

Move will move one entry from one location to another. Cross-store moves are supported. Moving an entry will decode it from the old location, encode it for the destination store with the right set of recipients and remove it from the old location afterwards.

func (*Store) Path

func (r *Store) Path() string

Path returns the store path

func (*Store) Prune

func (r *Store) Prune(ctx context.Context, tree string) error

Prune will remove a subtree from the Store

func (*Store) RecipientsTree

func (r *Store) RecipientsTree(ctx context.Context, pretty bool) (tree.Tree, error)

RecipientsTree returns a tree view of all stores' recipients

func (*Store) RemoveMount

func (r *Store) RemoveMount(alias string) error

RemoveMount removes and existing mount

func (*Store) RemoveRecipient

func (r *Store) RemoveRecipient(ctx context.Context, store, rec string) error

RemoveRecipient removes a single recipient from the given store

func (*Store) RemoveTemplate

func (r *Store) RemoveTemplate(ctx context.Context, name string) error

RemoveTemplate will delete the named template if it exists

func (*Store) SaveRecipients

func (r *Store) SaveRecipients(ctx context.Context) error

SaveRecipients persists the recipients to disk. Only useful if persist keys is enabled

func (*Store) Set

func (r *Store) Set(ctx context.Context, name string, sec *secret.Secret) error

Set encodes and write the ciphertext of one entry to disk

func (*Store) SetTemplate

func (r *Store) SetTemplate(ctx context.Context, name string, content []byte) error

SetTemplate will (over)write the content to the template file

func (*Store) String

func (r *Store) String() string

func (*Store) TemplateTree

func (r *Store) TemplateTree() (tree.Tree, error)

TemplateTree returns a tree of all templates

func (*Store) Tree

func (r *Store) Tree() (tree.Tree, error)

Tree returns the tree representation of the entries