secrets

Documentation

Index

• func New() gopass.Secret
• type KV
  • func NewKV() *KV
  • func ParseKV(in []byte) (*KV, error)
  • func ParseLegacyMIME(buf []byte) (*KV, error)
  • func (k *KV) Body() string
  • func (k *KV) Bytes() []byte
  • func (k *KV) Del(key string) bool
  • func (k *KV) FromMime() bool
  • func (k *KV) Get(key string) (string, bool)
  • func (k *KV) Keys() []string
  • func (k *KV) Password() string
  • func (k *KV) Set(key string, value interface{}) error
  • func (k *KV) SetPassword(p string)
  • func (k *KV) Write(buf []byte) (int, error)
• type Plain
  • func ParsePlain(in []byte) *Plain
  • func (p *Plain) Body() string
  • func (p *Plain) Bytes() []byte
  • func (p *Plain) Del(_ string) bool
  • func (p *Plain) Get(key string) (string, bool)
  • func (p *Plain) Getbuf() string
  • func (p *Plain) Keys() []string
  • func (p *Plain) Password() string
  • func (p *Plain) Set(_ string, _ interface{}) error
  • func (p *Plain) SetPassword(value string)
  • func (p *Plain) Write(buf []byte) (int, error)
  • func (p *Plain) WriteString(in string)
• type YAML
  • func ParseYAML(in []byte) (*YAML, 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) Set(key string, value interface{}) error
  • func (y *YAML) SetPassword(v string)
  • func (y *YAML) Write(buf []byte) (int, error)

Functions

func New

func New() gopass.Secret

New creates a new secret

Types

type KV

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

KV is a simple key value secret

func NewKV

func NewKV() *KV

NewKV creates a new KV secret

func ParseKV

func ParseKV(in []byte) (*KV, error)

ParseKV tries to parse a KV secret

func ParseLegacyMIME

func ParseLegacyMIME(buf []byte) (*KV, error)

ParseLegacyMIME is a fallback parser for the transient MIME format TODO Unexport this TODO Add tests

func (*KV) Body

func (k *KV) Body() string

Body returns the body

func (*KV) Bytes

func (k *KV) Bytes() []byte

Bytes serializes

func (*KV) Del

func (k *KV) Del(key string) bool

Del removes a key

func (*KV) FromMime

func (k *KV) FromMime() bool

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

func (*KV) Get

func (k *KV) Get(key string) (string, bool)

Get returns a single key

func (*KV) Keys

func (k *KV) Keys() []string

Keys returns all keys

func (*KV) Password

func (k *KV) Password() string

Password returns the password

func (*KV) Set

func (k *KV) Set(key string, value interface{}) error

Set writes a single key

func (*KV) SetPassword

func (k *KV) SetPassword(p string)

SetPassword updates the password

func (*KV) Write

func (k *KV) Write(buf []byte) (int, error)

Write appends the buffer to the secret's body

type Plain

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

Plain is the fallback secret that only contains plain text

func ParsePlain

func ParsePlain(in []byte) *Plain

ParsePlain never fails and always returns a Plain secret

func (*Plain) Body

func (p *Plain) Body() string

Body contains everything but the first line

func (*Plain) Bytes

func (p *Plain) Bytes() []byte

Bytes returns the complete secret

func (*Plain) Del

func (p *Plain) Del(_ string) bool

Del does nothing

func (*Plain) Get

func (p *Plain) Get(key string) (string, bool)

Get returns the first line (for password) or the empty string

func (*Plain) Getbuf

func (p *Plain) Getbuf() string

Getbuf returns everything execpt the first line

func (*Plain) Keys

func (p *Plain) Keys() []string

Keys always returns nil

func (*Plain) Password

func (p *Plain) Password() string

Password returns the first line

func (*Plain) Set

func (p *Plain) Set(_ string, _ interface{}) error

Set does nothing

func (*Plain) SetPassword

func (p *Plain) SetPassword(value string)

SetPassword updates the first line

func (*Plain) Write

func (p *Plain) Write(buf []byte) (int, error)

Write appends to the internal buffer

func (*Plain) WriteString

func (p *Plain) WriteString(in string)

WriteString append a string to the internal buffer

type YAML

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

YAML is a YAML secret

func ParseYAML

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

ParseYAML will try to parse a YAML secret.

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

func (y *YAML) Set(key string, value interface{}) error

Set sets a key to a given value

func (*YAML) SetPassword

func (y *YAML) SetPassword(v string)

SetPassword updates the password

func (*YAML) Write

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

Write appends the buffer to the secret's body