Back to

Package sub

Latest Go to latest
Published: Jul 26, 2019 | License: MIT | Module:


Package Files


const (
	// TemplateFile is the name of a pass template
	TemplateFile = ".pass-template"


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")

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 GetReason

func GetReason(ctx context.Context) string

GetReason returns the value of reason

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

func HasAutoSync(ctx context.Context) bool

HasAutoSync has been set if a value for auto sync has been set in this context

func HasCheckRecipients

func HasCheckRecipients(ctx context.Context) bool

HasCheckRecipients returns true if check recipients has been set in this context

func HasFsckCheck

func HasFsckCheck(ctx context.Context) bool

HasFsckCheck returns true if a value for fsck check has been set in this context

func HasFsckForce

func HasFsckForce(ctx context.Context) bool

HasFsckForce returns true if a value for fsck force has been set in this context

func HasFsckFunc

func HasFsckFunc(ctx context.Context) bool

HasFsckFunc returns true if a fsck func has been set in this context

func HasImportFunc

func HasImportFunc(ctx context.Context) bool

HasImportFunc returns true if a value for import func has been set in this context

func HasReason

func HasReason(ctx context.Context) bool

HasReason returns true if a value for reason has been set in this context

func HasRecipientFunc

func HasRecipientFunc(ctx context.Context) bool

HasRecipientFunc returns true if a recipient func has been set in this context

func IsAutoSync

func IsAutoSync(ctx context.Context) bool

IsAutoSync returns the value of autosync

func IsCheckRecipients

func IsCheckRecipients(ctx context.Context) bool

IsCheckRecipients will return the value of the check recipients flag or the default value (false)

func IsFsckCheck

func IsFsckCheck(ctx context.Context) bool

IsFsckCheck returns the value of fsck check

func IsFsckForce

func IsFsckForce(ctx context.Context) bool

IsFsckForce returns the value of fsck force

func WithAutoSync

func WithAutoSync(ctx context.Context, sync bool) context.Context

WithAutoSync returns a context with the flag for autosync set

func WithCheckRecipients

func WithCheckRecipients(ctx context.Context, cr bool) context.Context

WithCheckRecipients will return a context with the flag for check recipients set

func WithFsckCheck

func WithFsckCheck(ctx context.Context, check bool) context.Context

WithFsckCheck returns a context with the flag for fscks check set

func WithFsckForce

func WithFsckForce(ctx context.Context, force bool) context.Context

WithFsckForce returns a context with the flag for fsck force set

func WithFsckFunc

func WithFsckFunc(ctx context.Context, imf store.FsckCallback) context.Context

WithFsckFunc will return a context with the fsck confirmation callback set

func WithImportFunc

func WithImportFunc(ctx context.Context, imf store.ImportCallback) context.Context

WithImportFunc will return a context with the import callback set

func WithReason

func WithReason(ctx context.Context, msg string) context.Context

WithReason returns a context with a commit/change reason set

func WithRecipientFunc

func WithRecipientFunc(ctx context.Context, imf store.RecipientCallback) context.Context

WithRecipientFunc will return a context with the recipient callback set

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

func (s *Store) AddRecipient(ctx context.Context, id string) error

AddRecipient adds a new recipient to the list

func (*Store) Alias

func (s *Store) Alias() string

Alias returns the value of alias

func (*Store) Copy

func (s *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) Crypto

func (s *Store) Crypto() backend.Crypto

Crypto returns the crypto backend

func (*Store) Delete

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

Delete will remove an single entry from the store

func (*Store) Equals

func (s *Store) Equals(other store.Store) bool

Equals returns true if has the same on-disk path as the other

func (*Store) Exists

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

Exists checks the existence of a single entry

func (*Store) ExportMissingPublicKeys

func (s *Store) ExportMissingPublicKeys(ctx context.Context, rs []string) (bool, error)

ExportMissingPublicKeys will export any possibly missing public keys to the stores .public-keys directory

func (*Store) Fsck

func (s *Store) Fsck(ctx context.Context, path string) error

Fsck checks all entries matching the given prefix

func (*Store) Get

func (s *Store) Get(ctx context.Context, name string) (store.Secret, error)

Get returns the plaintext of a single key

func (*Store) GetRecipients

func (s *Store) GetRecipients(ctx context.Context, name string) ([]string, error)

GetRecipients will load all Recipients from the .gpg-id file for the given secret path

func (*Store) GetRevision

func (s *Store) GetRevision(ctx context.Context, name, revision string) (store.Secret, error)

GetRevision will retrieve a single revision from the backend

func (*Store) GetTemplate

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

GetTemplate will return the content of the named template

func (*Store) GitInit

func (s *Store) GitInit(ctx context.Context, un, ue string) error

GitInit initializes the the git repo in the store

func (*Store) HasTemplate

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

HasTemplate returns true if the template exists

func (*Store) ImportMissingPublicKeys

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

ImportMissingPublicKeys will try to import any missing public keys from the .gpg-keys folder in the password store

func (*Store) Init

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

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

func (*Store) Initialized

func (s *Store) Initialized(ctx context.Context) bool

Initialized returns true if the store is properly initialized

func (*Store) IsDir

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

IsDir returns true if the entry is folder inside the store

func (*Store) List

func (s *Store) List(ctx context.Context, prefix string) ([]string, error)

List will list all entries in this store

func (*Store) ListRevisions

func (s *Store) ListRevisions(ctx context.Context, name string) ([]backend.Revision, error)

ListRevisions will list all revisions for a secret

func (*Store) ListTemplates

func (s *Store) ListTemplates(ctx context.Context, prefix string) []string

ListTemplates will list all templates in this store

func (*Store) LookupTemplate

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

LookupTemplate will lookup and return a template

func (*Store) Move

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

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

func (s *Store) OurKeyID(ctx context.Context) string

OurKeyID returns the key fingprint this user can use to access the store (if any)

func (*Store) Path

func (s *Store) Path() string

Path returns the value of path

func (*Store) Prune

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

Prune will remove a subtree from the Store

func (*Store) RCS

func (s *Store) RCS() backend.RCS

RCS returns the sync backend

func (*Store) Recipients

func (s *Store) Recipients(ctx context.Context) []string

Recipients returns the list of recipients of this store

func (*Store) RemoveRecipient

func (s *Store) RemoveRecipient(ctx context.Context, id string) error

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

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

RemoveTemplate will delete the named template if it exists

func (*Store) SaveRecipients

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

SaveRecipients persists the current recipients on disk

func (*Store) Set

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

Set encodes and writes the cipertext of one entry to disk

func (*Store) SetRecipients

func (s *Store) SetRecipients(ctx context.Context, rs []string) error

SetRecipients will update the stored recipients and the associated checksum

func (*Store) SetTemplate

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

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

func (*Store) Storage

func (s *Store) Storage() backend.Storage

Storage returns the storage backend used by

func (*Store) String

func (s *Store) String() string

String implement fmt.Stringer

func (*Store) TemplateTree

func (s *Store) TemplateTree(ctx context.Context) (tree.Tree, error)

TemplateTree returns a tree of all templates

func (*Store) URL

func (s *Store) URL() string

URL returns the store URL

func (*Store) Valid

func (s *Store) Valid() bool

Valid returns true if this store is not nil

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier