sub

package
v1.5.0-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 16, 2017 License: MIT Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// GPGID is the name of the file containing the recipient ids
	GPGID = ".gpg-id"
)
View Source 
const (
	// TemplateFile is the name of a pass template
	TemplateFile = ".pass-template"
)

Variables

This section is empty.

Functions

func GetFsckFunc added in v1.4.0 

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 added in v1.4.0 

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 added in v1.4.0 

func GetReason(ctx context.Context) string

GetReason returns the value of reason

func GetRecipientFunc added in v1.4.0 

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 added in v1.4.0 

func HasAutoSync(ctx context.Context) bool

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

func HasCheckRecipients added in v1.4.0 

func HasCheckRecipients(ctx context.Context) bool

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

func HasFsckCheck added in v1.4.0 

func HasFsckCheck(ctx context.Context) bool

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

func HasFsckForce added in v1.4.0 

func HasFsckForce(ctx context.Context) bool

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

func HasFsckFunc added in v1.4.0 

func HasFsckFunc(ctx context.Context) bool

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

func HasImportFunc added in v1.4.0 

func HasImportFunc(ctx context.Context) bool

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

func HasReason added in v1.4.0 

func HasReason(ctx context.Context) bool

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

func HasRecipientFunc added in v1.4.0 

func HasRecipientFunc(ctx context.Context) bool

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

func IsAutoSync added in v1.4.0 

func IsAutoSync(ctx context.Context) bool

IsAutoSync returns the value of autosync

func IsCheckRecipients added in v1.4.0 

func IsCheckRecipients(ctx context.Context) bool

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

func IsFsckCheck added in v1.4.0 

func IsFsckCheck(ctx context.Context) bool

IsFsckCheck returns the value of fsck check

func IsFsckForce added in v1.4.0 

func IsFsckForce(ctx context.Context) bool

IsFsckForce returns the value of fsck force

func WithAutoSync added in v1.4.0 

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

WithAutoSync returns a context with the flag for autosync set

func WithCheckRecipients added in v1.4.0 

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

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

func WithFsckCheck added in v1.4.0 

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

WithFsckCheck returns a context with the flag for fscks check set

func WithFsckForce added in v1.4.0 

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

WithFsckForce returns a context with the flag for fsck force set

func WithFsckFunc added in v1.4.0 

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

WithFsckFunc will return a context with the fsck confirmation callback set

func WithImportFunc added in v1.4.0 

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

WithImportFunc will return a context with the import callback set

func WithReason added in v1.4.0 

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

WithReason returns a context with a commit/change reason set

func WithRecipientFunc added in v1.4.0 

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

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(alias string, path string) *Store

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

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

func (*Store) Exists 

func (s *Store) Exists(name string) bool

Exists checks the existence of a single entry

func (*Store) ExportMissingPublicKeys added in v1.4.0 

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

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

func (*Store) Fsck 

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

Fsck checks this stores integrity

func (*Store) GPGVersion added in v1.3.0 

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

GPGVersion returns parsed GPG version information

func (*Store) Get 

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

Get returns the plaintext of a single key

func (*Store) GetRecipients added in v1.4.0 

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

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

func (*Store) GetTemplate 

func (s *Store) GetTemplate(name string) ([]byte, error)

GetTemplate will return the content of the named template

func (*Store) Git 

func (s *Store) Git(ctx context.Context, args ...string) error

Git runs arbitrary git commands on this store

func (*Store) GitInit 

func (s *Store) GitInit(ctx context.Context, alias, signKey, userName, userEmail string) error

GitInit initializes this store's git repo and recursively calls GitInit on all substores.

func (*Store) GitPull added in v1.4.0 

func (s *Store) GitPull(ctx context.Context, remote, branch string) error

GitPull pulls from the git remote

func (*Store) GitPush added in v1.4.0 

func (s *Store) GitPush(ctx context.Context, remote, branch string) error

GitPush pushes to the git remote

func (*Store) GitVersion added in v1.3.0 

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

GitVersion returns the git version as major, minor and patch level

func (*Store) HasTemplate 

func (s *Store) HasTemplate(name string) bool

HasTemplate returns true if the template exists

func (*Store) ImportMissingPublicKeys added in v1.3.0 

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() bool

Initialized returns true if the store is properly initialized

func (*Store) IsDir 

func (s *Store) IsDir(name string) bool

IsDir returns true if the entry is folder inside the store

func (*Store) List 

func (s *Store) List(prefix string) ([]string, error)

List will list all entries in this store

func (*Store) ListTemplates 

func (s *Store) ListTemplates(prefix string) []string

ListTemplates will list all templates in this store

func (*Store) LookupTemplate 

func (s *Store) LookupTemplate(name 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. 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 (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) 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 storefunc (s *Store) RemoveRecipient()id string) error {

func (*Store) RemoveTemplate 

func (s *Store) RemoveTemplate(name string) error

RemoveTemplate will delete the named template if it exists

func (*Store) SaveRecipients added in v1.3.0 

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 *secret.Secret) error

Set encodes and writes the cipertext of one entry to disk. This method can be passed a callback to confirm the recipients immediately before encryption.

func (*Store) SetTemplate 

func (s *Store) SetTemplate(name string, content []byte) error

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

func (*Store) String 

func (s *Store) String() string

String implement fmt.Stringer

func (*Store) TemplateTree 

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

TemplateTree returns a tree of all templates

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.