secrets

Documentation

Index

• Constants
• Variables
• func New() gopass.Secret
• type AKV
  • func NewAKV() *AKV
  • func NewAKVWithData(pw string, kvps map[string][]string, body string, converted bool) *AKV
  • func ParseAKV(in []byte) *AKV
  • func (a *AKV) Add(key string, value any) error
  • func (a *AKV) Body() string
  • func (a *AKV) Bytes() []byte
  • func (a *AKV) Del(key string) bool
  • func (a *AKV) FromMime() bool
  • func (a *AKV) Get(key string) (string, bool)
  • func (a *AKV) Keys() []string
  • func (a *AKV) Password() string
  • func (a *AKV) SafeStr() string
  • func (a *AKV) Set(key string, value any) error
  • func (a *AKV) SetPassword(p string)
  • func (a *AKV) Values(key string) ([]string, bool)
  • func (a *AKV) Write(buf []byte) (int, error)
• type PermanentError
  • func (p *PermanentError) Error() string
• type YAML
  • func ParseYAML(in []byte) (*YAML, error)
  • func (y *YAML) Add(key string, value any) error
  • func (y *YAML) Body() string
  • func (y *YAML) Bytes() []byte
  • func (y *YAML) Del(key string) bool
  • func (y *YAML) Get(key string) (string, bool)
  • func (y *YAML) Keys() []string
  • func (y *YAML) Password() string
  • func (y *YAML) SafeStr() string
  • func (y *YAML) Set(key string, value any) error
  • func (y *YAML) SetPassword(v string)
  • func (y *YAML) Values(key string) ([]string, bool)
  • func (y *YAML) Write(buf []byte) (int, error)

Constants

const (
	// Ident is the header of the deprecated Gopass MIME secret.
	Ident = "GOPASS-SECRET-1.0"
)

Variables

var ErrNoYAML = fmt.Errorf("no YAML marker")

ErrNoYAML is returned when no YAML section is found.

var ErrNotSupported = fmt.Errorf("not supported")

ErrNotSupported is returned when a method is not supported.

Functions

func New

func New() gopass.Secret

New creates a new secret.

Types

type AKV

type AKV struct {
	// contains filtered or unexported fields
}

AKV is the new Key-Value implementation that will replace KV.

func NewAKV

func NewAKV() *AKV

NewAKV creates a new AKV instances.

func NewAKVWithData

func NewAKVWithData(pw string, kvps map[string][]string, body string, converted bool) *AKV

NewAKVWithData returns a new KV secret populated with data.

func ParseAKV

func ParseAKV(in []byte) *AKV

ParseAKV tries to parse an AKV secret.

func (*AKV) Add

func (a *AKV) Add(key string, value any) error

Add appends data to a given key.

func (*AKV) Body

func (a *AKV) Body() string

Body returns the body.

func (*AKV) Bytes

func (a *AKV) Bytes() []byte

Bytes returns the raw string as bytes.

func (*AKV) Del

func (a *AKV) Del(key string) bool

Del removes a given key and all of its values.

func (*AKV) FromMime

func (a *AKV) FromMime() bool

FromMime returns whether this secret was converted from a Mime secret of not.

func (*AKV) Get

func (a *AKV) Get(key string) (string, bool)

Get returns the value of the requested key, if found.

func (*AKV) Keys

func (a *AKV) Keys() []string

Keys returns all the parsed keys.

func (*AKV) Password

func (a *AKV) Password() string

Password returns the password.

func (*AKV) SafeStr

func (a *AKV) SafeStr() string

SafeStr always returnes "(elided)".

func (*AKV) Set

func (a *AKV) Set(key string, value any) error

Set writes a single key.

func (*AKV) SetPassword

func (a *AKV) SetPassword(p string)

SetPassword updates the password.

func (*AKV) Values

func (a *AKV) Values(key string) ([]string, bool)

Values returns all values for that key.

func (*AKV) Write

func (a *AKV) Write(buf []byte) (int, error)

Write appends the buffer to the secret's body.

type PermanentError

type PermanentError struct {
	Err error
}

PermanentError signal that parsing should not attempt other formats.

func (*PermanentError) Error

func (p *PermanentError) Error() string

type YAML

type YAML struct {
	// contains filtered or unexported fields
}

YAML is a gopass secret that contains a parsed YAML data structure. This is a legacy data type that is discouraged for new users as YAML is neither trivial nor intuitive for users manually editing secrets (e.g. unquoted phone numbers being parsed as octal and such).

Format ------ Line | Description

  0 | Password
1-n | Body
n+1 | Separator ("---")
n+2 | YAML content.

func ParseYAML

func ParseYAML(in []byte) (*YAML, error)

ParseYAML will try to parse a YAML secret.

func (*YAML) Add

func (y *YAML) Add(key string, value any) error

Add doesn't work since as per YAML specification keys must be unique.

func (*YAML) Body

func (y *YAML) Body() string

Body returns the body.

func (*YAML) Bytes

func (y *YAML) Bytes() []byte

Bytes serialized this secret.

func (*YAML) Del

func (y *YAML) Del(key string) bool

Del removes a single key.

func (*YAML) Get

func (y *YAML) Get(key string) (string, bool)

Get returns the first value of a single key.

func (*YAML) Keys

func (y *YAML) Keys() []string

Keys returns all keys.

func (*YAML) Password

func (y *YAML) Password() string

Password returns the password.

func (*YAML) SafeStr

func (y *YAML) SafeStr() string

SafeStr always returnes "(elided)".

func (*YAML) Set

func (y *YAML) Set(key string, value any) error

Set sets a key to a given value.

func (*YAML) SetPassword

func (y *YAML) SetPassword(v string)

SetPassword updates the password.

func (*YAML) Values

func (y *YAML) Values(key string) ([]string, bool)

Values returns Get since as per YAML specification keys must be unique.

func (*YAML) Write

func (y *YAML) Write(buf []byte) (int, error)

Write appends the buffer to the secret's body.