gopass

Documentation

Overview

Package gopass contains the public gopass API.

WARNING: This package is incomplete and unstable. DO NOT USE!

Feel free to report feedback on API design and missing features but please note that bug reports will be silently ignored and the API WILL CHANGE WITHOUT NOTICE until this note is gone.

Index

• type Byter
• type Secret
• type Store

Types

type Byter

type Byter interface {
	Bytes() []byte
}

Byter is a minimal secrets write interface

type Secret

type Secret interface {
	Byter

	Keys() []string
	// Get returns a single header value, use Get("Password") to get the
	// password value.
	Get(key string) string
	// Set sets a single header value, use Set("Password") to set the password
	// value.
	Set(key, value string)
	// Del removes a single header value
	Del(key string)

	// GetBody returns everything except the header. Use Bytes to get everything
	GetBody() string

	// MIME converts the secret to a MIME secret
	MIME() *secret.MIME
}

Secret is a secret type.

type Store

type Store interface {
	fmt.Stringer

	// List all secrets
	List(context.Context) ([]string, error)
	// Get an decrypted secret. Revision defaults to "latest".
	Get(ctx context.Context, name, revision string) (Secret, error)
	// Set (add) a new revision of an secret
	Set(ctx context.Context, name string, sec Byter) error
	// Revisions is TODO
	Revisions(ctx context.Context, name string) ([]string, error)
	// Remove a single secret
	Remove(ctx context.Context, name string) error
	// RemoveAll secrets with a common prefix
	RemoveAll(ctx context.Context, prefix string) error
	// Rename a path (secret of prefix) without decrypting
	Rename(ctx context.Context, src, dest string) error
	// Sync with a remote (if configured)
	// NOTE: We will always auto-sync when mutating the store. Use this to
	// manually pull in changes.
	Sync(ctx context.Context) error
	// Clean up any resources. MUST be called before the process exists.
	Close(ctx context.Context) error
}

Store is a secret store.