Documentation ¶
Index ¶
- Constants
- Variables
- func GetCryptoBackend(ctx context.Context, cb backend.CryptoBackend, cfgdir string, ...) (backend.Crypto, error)
- func GetFsckFunc(ctx context.Context) store.FsckCallback
- func GetImportFunc(ctx context.Context) store.ImportCallback
- func GetReason(ctx context.Context) string
- func GetRecipientFunc(ctx context.Context) store.RecipientCallback
- func HasAutoSync(ctx context.Context) bool
- func HasCheckRecipients(ctx context.Context) bool
- func HasFsckCheck(ctx context.Context) bool
- func HasFsckForce(ctx context.Context) bool
- func HasFsckFunc(ctx context.Context) bool
- func HasImportFunc(ctx context.Context) bool
- func HasReason(ctx context.Context) bool
- func HasRecipientFunc(ctx context.Context) bool
- func IsAutoSync(ctx context.Context) bool
- func IsCheckRecipients(ctx context.Context) bool
- func IsFsckCheck(ctx context.Context) bool
- func IsFsckForce(ctx context.Context) bool
- func WithAutoSync(ctx context.Context, sync bool) context.Context
- func WithCheckRecipients(ctx context.Context, cr bool) context.Context
- func WithFsckCheck(ctx context.Context, check bool) context.Context
- func WithFsckForce(ctx context.Context, force bool) context.Context
- func WithFsckFunc(ctx context.Context, imf store.FsckCallback) context.Context
- func WithImportFunc(ctx context.Context, imf store.ImportCallback) context.Context
- func WithReason(ctx context.Context, msg string) context.Context
- func WithRecipientFunc(ctx context.Context, imf store.RecipientCallback) context.Context
- type Store
- func (s *Store) AddRecipient(ctx context.Context, id string) error
- func (s *Store) Alias() string
- func (s *Store) Copy(ctx context.Context, from, to string) error
- func (s *Store) Crypto() backend.Crypto
- func (s *Store) Delete(ctx context.Context, name string) error
- func (s *Store) Equals(other store.Store) bool
- func (s *Store) Exists(ctx context.Context, name string) bool
- func (s *Store) ExportMissingPublicKeys(ctx context.Context, rs []string) (bool, error)
- func (s *Store) Fsck(ctx context.Context, path string) error
- func (s *Store) Get(ctx context.Context, name string) (store.Secret, error)
- func (s *Store) GetRecipients(ctx context.Context, name string) ([]string, error)
- func (s *Store) GetRevision(ctx context.Context, name, revision string) (store.Secret, error)
- func (s *Store) GetTemplate(ctx context.Context, name string) ([]byte, error)
- func (s *Store) GitInit(ctx context.Context, un, ue string) error
- func (s *Store) HasTemplate(ctx context.Context, name string) bool
- func (s *Store) ImportMissingPublicKeys(ctx context.Context) error
- func (s *Store) Init(ctx context.Context, path string, ids ...string) error
- func (s *Store) Initialized(ctx context.Context) bool
- func (s *Store) IsDir(ctx context.Context, name string) bool
- func (s *Store) List(ctx context.Context, prefix string) ([]string, error)
- func (s *Store) ListRevisions(ctx context.Context, name string) ([]backend.Revision, error)
- func (s *Store) ListTemplates(ctx context.Context, prefix string) []string
- func (s *Store) LookupTemplate(ctx context.Context, name string) ([]byte, bool)
- func (s *Store) Move(ctx context.Context, from, to string) error
- func (s *Store) OurKeyID(ctx context.Context) string
- func (s *Store) Path() string
- func (s *Store) Prune(ctx context.Context, tree string) error
- func (s *Store) RCS() backend.RCS
- func (s *Store) Recipients(ctx context.Context) []string
- func (s *Store) RemoveRecipient(ctx context.Context, id string) error
- func (s *Store) RemoveTemplate(ctx context.Context, name string) error
- func (s *Store) SaveRecipients(ctx context.Context) error
- func (s *Store) Set(ctx context.Context, name string, sec store.Secret) error
- func (s *Store) SetRecipients(ctx context.Context, rs []string) error
- func (s *Store) SetTemplate(ctx context.Context, name string, content []byte) error
- func (s *Store) Storage() backend.Storage
- func (s *Store) String() string
- func (s *Store) TemplateTree(ctx context.Context) (tree.Tree, error)
- func (s *Store) URL() string
- func (s *Store) Valid() bool
Constants ¶
const (
// TemplateFile is the name of a pass template
TemplateFile = ".pass-template"
)
Variables ¶
var ( // ErrRecipientChecksumChanged is returned is the recipient checksum has changed ErrRecipientChecksumChanged = fmt.Errorf("checksum changed. Run 'gopass recipients update' to get rid of this warning") )
Functions ¶
func GetCryptoBackend ¶
func GetCryptoBackend(ctx context.Context, cb backend.CryptoBackend, cfgdir string, agent *client.Client) (backend.Crypto, error)
GetCryptoBackend initialized the correct crypto backend
func GetFsckFunc ¶
func GetFsckFunc(ctx context.Context) store.FsckCallback
GetFsckFunc will return the fsck confirmation callback or a default one returning true. Note: will never return nil
func GetImportFunc ¶
func GetImportFunc(ctx context.Context) store.ImportCallback
GetImportFunc will return the import callback or a default one returning true Note: will never return nil
func GetRecipientFunc ¶
func GetRecipientFunc(ctx context.Context) store.RecipientCallback
GetRecipientFunc will return the recipient callback or a default one returning the unaltered list of recipients. Note: will never return nil
func HasAutoSync ¶
HasAutoSync has been set if a value for auto sync has been set in this context
func HasCheckRecipients ¶
HasCheckRecipients returns true if check recipients has been set in this context
func HasFsckCheck ¶
HasFsckCheck returns true if a value for fsck check has been set in this context
func HasFsckForce ¶
HasFsckForce returns true if a value for fsck force has been set in this context
func HasFsckFunc ¶
HasFsckFunc returns true if a fsck func has been set in this context
func HasImportFunc ¶
HasImportFunc returns true if a value for import func has been set in this context
func HasRecipientFunc ¶
HasRecipientFunc returns true if a recipient func has been set in this context
func IsAutoSync ¶
IsAutoSync returns the value of autosync
func IsCheckRecipients ¶
IsCheckRecipients will return the value of the check recipients flag or the default value (false)
func IsFsckCheck ¶
IsFsckCheck returns the value of fsck check
func IsFsckForce ¶
IsFsckForce returns the value of fsck force
func WithAutoSync ¶
WithAutoSync returns a context with the flag for autosync set
func WithCheckRecipients ¶
WithCheckRecipients will return a context with the flag for check recipients set
func WithFsckCheck ¶
WithFsckCheck returns a context with the flag for fscks check set
func WithFsckForce ¶
WithFsckForce returns a context with the flag for fsck force set
func WithFsckFunc ¶
WithFsckFunc will return a context with the fsck confirmation callback set
func WithImportFunc ¶
WithImportFunc will return a context with the import callback set
func WithReason ¶
WithReason returns a context with a commit/change reason set
func WithRecipientFunc ¶
WithRecipientFunc will return a context with the recipient callback set
Types ¶
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
Store is password store
func New ¶
func New(ctx context.Context, sc recipientHashStorer, alias string, u *backend.URL, cfgdir string, agent *client.Client) (*Store, error)
New creates a new store, copying settings from the given root store
func (*Store) AddRecipient ¶
AddRecipient adds a new recipient to the list
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) ExportMissingPublicKeys ¶
ExportMissingPublicKeys will export any possibly missing public keys to the stores .public-keys directory
func (*Store) GetRecipients ¶
GetRecipients will load all Recipients from the .gpg-id file for the given secret path
func (*Store) GetRevision ¶
GetRevision will retrieve a single revision from the backend
func (*Store) GetTemplate ¶
GetTemplate will return the content of the named template
func (*Store) HasTemplate ¶
HasTemplate returns true if the template exists
func (*Store) ImportMissingPublicKeys ¶
ImportMissingPublicKeys will try to import any missing public keys from the .gpg-keys folder in the password store
func (*Store) Initialized ¶
Initialized returns true if the store is properly initialized
func (*Store) ListRevisions ¶
ListRevisions will list all revisions for a secret
func (*Store) ListTemplates ¶
ListTemplates will list all templates in this store
func (*Store) LookupTemplate ¶
LookupTemplate will lookup and return a template
func (*Store) Move ¶
Move will move one entry from one location to another. 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) OurKeyID ¶
OurKeyID returns the key fingprint this user can use to access the store (if any)
func (*Store) Recipients ¶
Recipients returns the list of recipients of this store
func (*Store) RemoveRecipient ¶
RemoveRecipient will remove the given recipient from the store but if this key is not available on this machine we just try to remove it literally
func (*Store) RemoveTemplate ¶
RemoveTemplate will delete the named template if it exists
func (*Store) SaveRecipients ¶
SaveRecipients persists the current recipients on disk
func (*Store) SetRecipients ¶ added in v1.8.0
SetRecipients will update the stored recipients and the associated checksum
func (*Store) SetTemplate ¶
SetTemplate will (over)write the content to the template file
func (*Store) TemplateTree ¶
TemplateTree returns a tree of all templates