Documentation ¶
Index ¶
- type AlreadyMountedError
- type NotInitializedError
- type Store
- 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) Crypto(ctx context.Context, name string) backend.Crypto
- func (r *Store) Delete(ctx context.Context, name string) error
- func (r *Store) Exists(ctx context.Context, name string) bool
- func (r *Store) Format(ctx context.Context, maxDepth int) (string, error)
- func (s *Store) Fsck(ctx context.Context, path string) error
- func (r *Store) Get(ctx context.Context, name string) (store.Secret, error)
- func (r *Store) GetContext(ctx context.Context, name string) (store.Secret, context.Context, error)
- func (r *Store) GetRevision(ctx context.Context, name, revision string) (store.Secret, error)
- func (r *Store) GetSubStore(name string) (store.Store, error)
- func (r *Store) GetTemplate(ctx context.Context, name string) ([]byte, error)
- func (r *Store) GitAddRemote(ctx context.Context, name, remote, url string) error
- func (r *Store) GitInit(ctx context.Context, name, userName, userEmail string) error
- func (r *Store) GitInitConfig(ctx context.Context, name, userName, userEmail string) error
- func (r *Store) GitPull(ctx context.Context, name, origin, remote string) error
- func (r *Store) GitPush(ctx context.Context, name, origin, remote string) error
- func (r *Store) GitRemoveRemote(ctx context.Context, name, remote 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(ctx context.Context) (bool, error)
- func (r *Store) IsDir(ctx context.Context, name string) bool
- func (r *Store) List(ctx context.Context, maxDepth int) ([]string, error)
- func (r *Store) ListRecipients(ctx context.Context, store string) []string
- func (r *Store) ListRevisions(ctx context.Context, name string) ([]backend.Revision, error)
- func (r *Store) LookupTemplate(ctx context.Context, name string) ([]byte, bool)
- func (r *Store) MountPoint(name string) string
- 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) RCS(ctx context.Context, name string) backend.RCS
- func (r *Store) RecipientsTree(ctx context.Context, pretty bool) (tree.Tree, error)
- func (r *Store) RemoveMount(ctx context.Context, 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 store.Secret) error
- func (r *Store) SetContext(ctx context.Context, name string, sec store.Secret) (context.Context, error)
- func (r *Store) SetTemplate(ctx context.Context, name string, content []byte) error
- func (r *Store) Storage(ctx context.Context, name string) backend.Storage
- func (r *Store) String() string
- func (r *Store) TemplateTree(ctx context.Context) (tree.Tree, error)
- func (r *Store) Tree(ctx context.Context) (tree.Tree, error)
- func (r *Store) URL() string
- func (r *Store) WithConfig(ctx context.Context, name string) context.Context
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlreadyMountedError ¶ added in v1.8.3
type AlreadyMountedError string
AlreadyMountedError is an error that is returned when a store is already mounted on a given mount point
func (AlreadyMountedError) Error ¶ added in v1.8.3
func (a AlreadyMountedError) Error() string
type NotInitializedError ¶ added in v1.8.3
type NotInitializedError struct {
// contains filtered or unexported fields
}
NotInitializedError is an error that is returned when a not initialized store should be mounted
func (NotInitializedError) Alias ¶ added in v1.8.3
func (n NotInitializedError) Alias() string
Alias returns the store alias this error was generated for
func (NotInitializedError) Error ¶ added in v1.8.3
func (n NotInitializedError) Error() string
func (NotInitializedError) Path ¶ added in v1.8.3
func (n NotInitializedError) Path() string
Path returns the store path this error was generated for
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
Store is the public facing password store
func (*Store) AddRecipient ¶
AddRecipient adds a single recipient to the given store
func (*Store) Copy ¶
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) GetContext ¶
GetContext returns the plaintext and the context of a single key
func (*Store) GetRevision ¶
GetRevision will try to retrieve the given revision from the sync backend
func (*Store) GetSubStore ¶
GetSubStore returns an exact match for a mount point or an error if this mount point does not exist
func (*Store) GetTemplate ¶
GetTemplate will return the content of the named template
func (*Store) GitAddRemote ¶
GitAddRemote adds a git remote
func (*Store) GitInitConfig ¶
GitInitConfig initializes the git repos local config
func (*Store) GitRemoveRemote ¶
GitRemoveRemote removes a git remote
func (*Store) GitVersion ¶
GitVersion returns git version information
func (*Store) HasTemplate ¶
HasTemplate returns true if the template exists
func (*Store) ImportMissingPublicKeys ¶
ImportMissingPublicKeys import missing public keys in any substore
func (*Store) Initialized ¶
Initialized checks on disk if .gpg-id was generated and thus returns true.
func (*Store) ListRecipients ¶
ListRecipients lists all recipients for the given store
func (*Store) ListRevisions ¶
ListRevisions will list all revisions for the named entity
func (*Store) LookupTemplate ¶
LookupTemplate will lookup and return a template
func (*Store) MountPoint ¶
MountPoint returns the most-specific mount point for the given key
func (*Store) MountPoints ¶
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) Move ¶
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) RecipientsTree ¶
RecipientsTree returns a tree view of all stores' recipients
func (*Store) RemoveMount ¶
RemoveMount removes and existing mount
func (*Store) RemoveRecipient ¶
RemoveRecipient removes a single recipient from the given store
func (*Store) RemoveTemplate ¶
RemoveTemplate will delete the named template if it exists
func (*Store) SaveRecipients ¶
SaveRecipients persists the recipients to disk. Only useful if persist keys is enabled
func (*Store) SetContext ¶
func (r *Store) SetContext(ctx context.Context, name string, sec store.Secret) (context.Context, error)
SetContext encodes and write the ciphertext of one entry to disk and propagate the context
func (*Store) SetTemplate ¶
SetTemplate will (over)write the content to the template file
func (*Store) TemplateTree ¶
TemplateTree returns a tree of all templates