action

package
v1.5.0-alpha.1 Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2017 License: MIT Imports: 56 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// ExitOK means no error (status code 0)
	ExitOK = iota
	// ExitUnknown is used if we can't determine the exact exit cause
	ExitUnknown
	// ExitUsage is used if there was some kind of invocation error
	ExitUsage
	// ExitAborted is used if the user willingly aborted an action
	ExitAborted
	// ExitUnsupported is used if an operation is not supported by gopass
	ExitUnsupported
	// ExitAlreadyInitialized is used if someone is trying to initialize
	// an already initialized store
	ExitAlreadyInitialized
	// ExitNotInitialized is used if someone is trying to use an unitialized
	// store
	ExitNotInitialized
	// ExitGit is used if any git errors are encountered
	ExitGit
	// ExitMount is used if a substore mount operation fails
	ExitMount
	// ExitNoName is used when no name was provided for a named entry
	ExitNoName
	// ExitNotFound is used if a requested secret is not found
	ExitNotFound
	// ExitDecrypt is used when reading/decrypting a secret failed
	ExitDecrypt
	// ExitEncrypt is used when writing/encrypting of a secret fails
	ExitEncrypt
	// ExitList is used when listing the store content fails
	ExitList
	// ExitAudit is used when audit report possible issues
	ExitAudit
	// ExitFsck is used when the integrity check fails
	ExitFsck
	// ExitConfig is used when config errors occur
	ExitConfig
	// ExitRecipients is used when a recipient operation fails
	ExitRecipients
	// ExitIO is used for misc. I/O errors
	ExitIO
)
View Source 
const (
	// BinarySuffix is the suffix that is appended to binaries in the store
	BinarySuffix = ".b64"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Action 

type Action struct {
	Name  string
	Store *root.Store
	// contains filtered or unexported fields
}

Action knows everything to run gopass CLI actions

func New 

func New(ctx context.Context, cfg *config.Config, sv semver.Version) *Action

New returns a new Action wrapper

func (*Action) AskForConfirmation added in v1.4.0 

func (s *Action) AskForConfirmation(ctx context.Context, text string) bool

AskForConfirmation asks a yes/no question until the user replies yes or no

func (*Action) AskForKeyImport added in v1.4.0 

func (s *Action) AskForKeyImport(ctx context.Context, key string) bool

AskForKeyImport asks for permissions to import the named key

func (*Action) Audit added in v1.3.0 

func (s *Action) Audit(ctx context.Context, c *cli.Context) error

Audit validates passwords against common flaws

func (*Action) BinaryCat added in v1.2.0 

func (s *Action) BinaryCat(ctx context.Context, c *cli.Context) error

BinaryCat prints to or reads from STDIN/STDOUT

func (*Action) BinaryCopy added in v1.2.0 

func (s *Action) BinaryCopy(ctx context.Context, c *cli.Context) error

BinaryCopy copies either from the filesystem to the store or from the store to the filesystem

func (*Action) BinaryMove added in v1.2.0 

func (s *Action) BinaryMove(ctx context.Context, c *cli.Context) error

BinaryMove works like BinaryCopy but will remove (shred/wipe) the source after a successful copy. Mostly useful for securely moving secrets into the store if they are no longer needed / wanted on disk afterwards

func (*Action) BinarySum added in v1.2.0 

func (s *Action) BinarySum(ctx context.Context, c *cli.Context) error

BinarySum decodes binary content and computes the SHA256 checksum

func (*Action) Clone 

func (s *Action) Clone(ctx context.Context, c *cli.Context) error

Clone will fetch and mount a new password store from a git repo

func (*Action) Complete 

func (s *Action) Complete(*cli.Context)

Complete prints a list of all password names to os.Stdout

func (*Action) CompletionBash 

func (s *Action) CompletionBash(c *cli.Context) error

CompletionBash returns a bash script used for auto completion

func (*Action) CompletionZSH 

func (s *Action) CompletionZSH(c *cli.Context) error

CompletionZSH returns a script that uses bash's auto completion

func (*Action) Config 

func (s *Action) Config(ctx context.Context, c *cli.Context) error

Config handles changes to the gopass configuration

func (*Action) ConfigComplete added in v1.4.0 

func (s *Action) ConfigComplete(c *cli.Context)

ConfigComplete will print the list of valid config keys

func (*Action) ConfirmRecipients added in v1.4.0 

func (s *Action) ConfirmRecipients(ctx context.Context, name string, recipients []string) ([]string, error)

ConfirmRecipients asks the user to confirm a given set of recipients

func (*Action) Copy 

func (s *Action) Copy(ctx context.Context, c *cli.Context) error

Copy the contents of a file to another one

func (*Action) Create added in v1.5.0 

func (s *Action) Create(ctx context.Context, c *cli.Context) error

Create displays the password creation wizard

func (*Action) Delete 

func (s *Action) Delete(ctx context.Context, c *cli.Context) error

Delete a secret file with its content

func (*Action) Edit 

func (s *Action) Edit(ctx context.Context, c *cli.Context) error

Edit the content of a password file

func (*Action) Find 

func (s *Action) Find(ctx context.Context, c *cli.Context) error

Find a string in the secret file's name

func (*Action) Fsck 

func (s *Action) Fsck(ctx context.Context, c *cli.Context) error

Fsck checks the store integrity

func (*Action) Generate 

func (s *Action) Generate(ctx context.Context, c *cli.Context) error

Generate & save a password

func (*Action) Git 

func (s *Action) Git(ctx context.Context, c *cli.Context) error

Git runs git commands inside the store or mounts

func (*Action) GitInit 

func (s *Action) GitInit(ctx context.Context, c *cli.Context) error

GitInit initializes a git repo including basic configuration

func (*Action) Grep 

func (s *Action) Grep(ctx context.Context, c *cli.Context) error

Grep searches a string inside the content of all files

func (*Action) HIBP added in v1.3.0 

func (s *Action) HIBP(ctx context.Context, c *cli.Context) error

HIBP compares all entries from the store against the provided SHA1 sum dumps

func (*Action) Init 

func (s *Action) Init(ctx context.Context, c *cli.Context) error

Init a new password store with a first gpg id

func (*Action) InitOnboarding added in v1.5.0 

func (s *Action) InitOnboarding(ctx context.Context, c *cli.Context) error

InitOnboarding will invoke the onboarding / setup wizard

func (*Action) Initialized 

func (s *Action) Initialized(ctx context.Context, c *cli.Context) error

Initialized returns an error if the store is not properly prepared.

func (*Action) Insert 

func (s *Action) Insert(ctx context.Context, c *cli.Context) error

Insert a string as content to a secret file

func (*Action) JSONAPI added in v1.4.0 

func (s *Action) JSONAPI(ctx context.Context, c *cli.Context) error

JSONAPI reads a json message on stdin and responds on stdout

func (*Action) List 

func (s *Action) List(ctx context.Context, c *cli.Context) error

List all secrets as a tree

func (*Action) MountAdd 

func (s *Action) MountAdd(ctx context.Context, c *cli.Context) error

MountAdd adds a new mount

func (*Action) MountRemove 

func (s *Action) MountRemove(ctx context.Context, c *cli.Context) error

MountRemove removes an existing mount

func (*Action) MountsComplete 

func (s *Action) MountsComplete(*cli.Context)

MountsComplete will print a list of existings mount points for bash completion

func (*Action) MountsPrint 

func (s *Action) MountsPrint(ctx context.Context, c *cli.Context) error

MountsPrint prints all existing mounts

func (*Action) Move 

func (s *Action) Move(ctx context.Context, c *cli.Context) error

Move the content from one secret to another

func (*Action) RecipientsAdd 

func (s *Action) RecipientsAdd(ctx context.Context, c *cli.Context) error

RecipientsAdd adds new recipients

func (*Action) RecipientsComplete 

func (s *Action) RecipientsComplete(ctx context.Context, c *cli.Context)

RecipientsComplete will print a list of recipients for bash completion

func (*Action) RecipientsPrint 

func (s *Action) RecipientsPrint(ctx context.Context, c *cli.Context) error

RecipientsPrint prints all recipients per store

func (*Action) RecipientsRemove 

func (s *Action) RecipientsRemove(ctx context.Context, c *cli.Context) error

RecipientsRemove removes recipients

func (*Action) SetupNativeMessaging added in v1.4.0 

func (s *Action) SetupNativeMessaging(ctx context.Context, c *cli.Context) error

SetupNativeMessaging sets up manifest for gopass as native messaging host

func (*Action) Show 

func (s *Action) Show(ctx context.Context, c *cli.Context) error

Show the content of a secret file

func (*Action) String 

func (s *Action) String() string

String implement fmt.Stringer

func (*Action) Sync added in v1.4.0 

func (s *Action) Sync(ctx context.Context, c *cli.Context) error

Sync all stores with their remotes

func (*Action) TOTP added in v1.3.0 

func (s *Action) TOTP(ctx context.Context, c *cli.Context) error

TOTP implements time-based OTP token handling

func (*Action) TemplateEdit added in v1.1.0 

func (s *Action) TemplateEdit(ctx context.Context, c *cli.Context) error

TemplateEdit will load and existing or new template into an editor

func (*Action) TemplatePrint added in v1.1.0 

func (s *Action) TemplatePrint(ctx context.Context, c *cli.Context) error

TemplatePrint will lookup and print a single template

func (*Action) TemplateRemove added in v1.1.0 

func (s *Action) TemplateRemove(ctx context.Context, c *cli.Context) error

TemplateRemove will remove a single template

func (*Action) TemplatesComplete added in v1.1.0 

func (s *Action) TemplatesComplete(*cli.Context)

TemplatesComplete prints a list of all templates for bash completion

func (*Action) TemplatesPrint added in v1.1.0 

func (s *Action) TemplatesPrint(ctx context.Context, c *cli.Context) error

TemplatesPrint will pretty-print a tree of templates

func (*Action) Unclip 

func (s *Action) Unclip(ctx context.Context, c *cli.Context) error

Unclip tries to erase the content of the clipboard

func (*Action) Version 

func (s *Action) Version(ctx context.Context, c *cli.Context) error

Version prints the gopass version

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.