gpg

Documentation

Index

• type Config
• type GPG
  • func New(cfg Config) *GPG
  • func (g *GPG) Decrypt(path string) ([]byte, error)
  • func (g *GPG) Encrypt(path string, content []byte, recipients []string) error
  • func (g *GPG) ExportPublicKey(id, filename string) error
  • func (g *GPG) FindPrivateKeys(search ...string) (KeyList, error)
  • func (g *GPG) FindPublicKeys(search ...string) (KeyList, error)
  • func (g *GPG) GetRecipients(file string) ([]string, error)
  • func (g *GPG) ImportPublicKey(filename string) error
  • func (g *GPG) ListPrivateKeys() (KeyList, error)
  • func (g *GPG) ListPublicKeys() (KeyList, error)
• type Identity
  • func (i Identity) ID() string
  • func (i Identity) String() string
• type Key
  • func (k Key) ID() string
  • func (k Key) IsUseable() bool
  • func (k Key) OneLine() string
  • func (k Key) String() string
• type KeyList
  • func (kl KeyList) FindKey(id string) (Key, error)
  • func (kl KeyList) UseableKeys() KeyList

Types

type Config

type Config struct {
	Binary      string
	Args        []string
	Debug       bool
	AlwaysTrust bool
}

Config is the gpg wrapper config

type GPG

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

GPG is a gpg wrapper

func New

func New(cfg Config) *GPG

New creates a new GPG wrapper

func (*GPG) Decrypt

func (g *GPG) Decrypt(path string) ([]byte, error)

Decrypt will try to decrypt the given file

func (*GPG) Encrypt

func (g *GPG) Encrypt(path string, content []byte, recipients []string) error

Encrypt will encrypt the given content for the recipients. If alwaysTrust is true the trust-model will be set to always as to avoid (annoying) "unuseable public key" errors when encrypting.

func (*GPG) ExportPublicKey

func (g *GPG) ExportPublicKey(id, filename string) error

ExportPublicKey will export the named public key to the location given

func (*GPG) FindPrivateKeys

func (g *GPG) FindPrivateKeys(search ...string) (KeyList, error)

FindPrivateKeys searches for the given private keys

func (*GPG) FindPublicKeys

func (g *GPG) FindPublicKeys(search ...string) (KeyList, error)

FindPublicKeys searches for the given public keys

func (*GPG) GetRecipients

func (g *GPG) GetRecipients(file string) ([]string, error)

GetRecipients returns a list of recipient IDs for a given file

func (*GPG) ImportPublicKey

func (g *GPG) ImportPublicKey(filename string) error

ImportPublicKey will import a key from the given location

func (*GPG) ListPrivateKeys

func (g *GPG) ListPrivateKeys() (KeyList, error)

ListPrivateKeys returns a parsed list of GPG secret keys

func (*GPG) ListPublicKeys

func (g *GPG) ListPublicKeys() (KeyList, error)

ListPublicKeys returns a parsed list of GPG public keys

type Identity

type Identity struct {
	Name    string
	Comment string
	Email   string
}

Identity is a GPG identity, one key can have many IDs

func (Identity) ID

func (i Identity) ID() string

ID returns the GPG ID format

func (Identity) String

func (i Identity) String() string

String implement fmt.Stringer. This method resembels the output gpg uses for user-ids

type Key

type Key struct {
	KeyType        string
	KeyLength      int
	Validity       string
	CreationDate   time.Time
	ExpirationDate time.Time
	Ownertrust     string
	Fingerprint    string
	Identities     map[string]Identity
	SubKeys        map[string]struct{}
}

Key is a GPG key (public or secret)

func (Key) ID

func (k Key) ID() string

ID returns the short fingerprint

func (Key) IsUseable

func (k Key) IsUseable() bool

IsUseable returns true if GPG would assume this key is useable for encryption

func (Key) OneLine

func (k Key) OneLine() string

OneLine prints a terse representation of this key on one line (includes only the first identity!)

func (Key) String

func (k Key) String() string

String implement fmt.Stringer. This method produces output that is close to, but not exactly the same, as the output form GPG itself

type KeyList

type KeyList []Key

KeyList is a searchable slice of Keys

func (KeyList) FindKey

func (kl KeyList) FindKey(id string) (Key, error)

FindKey will try to find the requested key

func (KeyList) UseableKeys

func (kl KeyList) UseableKeys() KeyList

UseableKeys returns the list of useable (valid keys)