pgp

Documentation

Overview

Package pgp provides interface to signature generation and validation

Index

• type GoSigner
  • func (g *GoSigner) ClearSign(source string, destination string) error
  • func (g *GoSigner) DetachedSign(source string, destination string) error
  • func (g *GoSigner) Init() error
  • func (g *GoSigner) SetBatch(batch bool)
  • func (g *GoSigner) SetKey(keyRef string)
  • func (g *GoSigner) SetKeyRing(keyring, secretKeyring string)
  • func (g *GoSigner) SetPassphrase(passphrase, passphraseFile string)
• type GoVerifier
  • func (g *GoVerifier) AddKeyring(keyring string)
  • func (g *GoVerifier) ExtractClearsigned(clearsigned io.Reader) (text *os.File, err error)
  • func (g *GoVerifier) InitKeyring() error
  • func (g *GoVerifier) IsClearSigned(clearsigned io.Reader) (bool, error)
  • func (g *GoVerifier) VerifyClearsigned(clearsigned io.Reader, showKeyTip bool) (*KeyInfo, error)
  • func (g *GoVerifier) VerifyDetachedSignature(signature, cleartext io.Reader, showKeyTip bool) error
• type GpgSigner
  • func NewGpgSigner() *GpgSigner
  • func (g *GpgSigner) ClearSign(source string, destination string) error
  • func (g *GpgSigner) DetachedSign(source string, destination string) error
  • func (g *GpgSigner) Init() error
  • func (g *GpgSigner) SetBatch(batch bool)
  • func (g *GpgSigner) SetKey(keyRef string)
  • func (g *GpgSigner) SetKeyRing(keyring, secretKeyring string)
  • func (g *GpgSigner) SetPassphrase(passphrase, passphraseFile string)
• type GpgVerifier
  • func NewGpgVerifier() *GpgVerifier
  • func (g *GpgVerifier) AddKeyring(keyring string)
  • func (g *GpgVerifier) ExtractClearsigned(clearsigned io.Reader) (text *os.File, err error)
  • func (g *GpgVerifier) InitKeyring() error
  • func (g *GpgVerifier) IsClearSigned(clearsigned io.Reader) (bool, error)
  • func (g *GpgVerifier) VerifyClearsigned(clearsigned io.Reader, showKeyTip bool) (*KeyInfo, error)
  • func (g *GpgVerifier) VerifyDetachedSignature(signature, cleartext io.Reader, showKeyTip bool) error
• type Key
  • func KeyFromUint64(key uint64) Key
  • func (key1 Key) Matches(key2 Key) bool
• type KeyInfo
• type Signer
• type Verifier

Types

type GoSigner

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

GoSigner is implementation of Signer interface using Go internal OpenPGP library

func (*GoSigner) ClearSign

func (g *GoSigner) ClearSign(source string, destination string) error

ClearSign clear-signs the file

func (*GoSigner) DetachedSign

func (g *GoSigner) DetachedSign(source string, destination string) error

DetachedSign signs file with detached signature in ASCII format

func (*GoSigner) Init

func (g *GoSigner) Init() error

Init verifies availability of gpg & presence of keys

func (*GoSigner) SetBatch

func (g *GoSigner) SetBatch(batch bool)

SetBatch controls whether we allowed to interact with user

func (*GoSigner) SetKey

func (g *GoSigner) SetKey(keyRef string)

SetKey sets key ID to use when signing files

func (*GoSigner) SetKeyRing

func (g *GoSigner) SetKeyRing(keyring, secretKeyring string)

SetKeyRing allows to set custom keyring and secretkeyring

func (*GoSigner) SetPassphrase

func (g *GoSigner) SetPassphrase(passphrase, passphraseFile string)

SetPassphrase sets passhprase params

type GoVerifier

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

GoVerifier is implementation of Verifier interface using Go internal OpenPGP library

func (*GoVerifier) AddKeyring

func (g *GoVerifier) AddKeyring(keyring string)

AddKeyring adds custom keyrings to the list

func (*GoVerifier) ExtractClearsigned

func (g *GoVerifier) ExtractClearsigned(clearsigned io.Reader) (text *os.File, err error)

ExtractClearsigned extracts cleartext from clearsigned file WITHOUT signature verification

func (*GoVerifier) InitKeyring

func (g *GoVerifier) InitKeyring() error

InitKeyring verifies that gpg is installed and some keys are trusted

func (*GoVerifier) IsClearSigned

func (g *GoVerifier) IsClearSigned(clearsigned io.Reader) (bool, error)

IsClearSigned returns true if file contains signature

func (*GoVerifier) VerifyClearsigned

func (g *GoVerifier) VerifyClearsigned(clearsigned io.Reader, showKeyTip bool) (*KeyInfo, error)

VerifyClearsigned verifies clearsigned file using gpgv

func (*GoVerifier) VerifyDetachedSignature

func (g *GoVerifier) VerifyDetachedSignature(signature, cleartext io.Reader, showKeyTip bool) error

VerifyDetachedSignature verifies combination of signature and cleartext using gpgv

type GpgSigner

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

GpgSigner is implementation of Signer interface using gpg as external program

func NewGpgSigner

func NewGpgSigner() *GpgSigner

NewGpgSigner creates a new gpg signer

func (*GpgSigner) ClearSign

func (g *GpgSigner) ClearSign(source string, destination string) error

ClearSign clear-signs the file

func (*GpgSigner) DetachedSign

func (g *GpgSigner) DetachedSign(source string, destination string) error

DetachedSign signs file with detached signature in ASCII format

func (*GpgSigner) Init

func (g *GpgSigner) Init() error

Init verifies availability of gpg & presence of keys

func (*GpgSigner) SetBatch

func (g *GpgSigner) SetBatch(batch bool)

SetBatch control --no-tty flag to gpg

func (*GpgSigner) SetKey

func (g *GpgSigner) SetKey(keyRef string)

SetKey sets key ID to use when signing files

func (*GpgSigner) SetKeyRing

func (g *GpgSigner) SetKeyRing(keyring, secretKeyring string)

SetKeyRing allows to set custom keyring and secretkeyring

func (*GpgSigner) SetPassphrase

func (g *GpgSigner) SetPassphrase(passphrase, passphraseFile string)

SetPassphrase sets passhprase params

type GpgVerifier

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

GpgVerifier is implementation of Verifier interface using gpgv as external program

func NewGpgVerifier

func NewGpgVerifier() *GpgVerifier

NewGpgVerifier creates a new gpg signer

func (*GpgVerifier) AddKeyring

func (g *GpgVerifier) AddKeyring(keyring string)

AddKeyring adds custom keyring to GPG parameters

func (*GpgVerifier) ExtractClearsigned

func (g *GpgVerifier) ExtractClearsigned(clearsigned io.Reader) (text *os.File, err error)

ExtractClearsigned extracts cleartext from clearsigned file WITHOUT signature verification

func (*GpgVerifier) InitKeyring

func (g *GpgVerifier) InitKeyring() error

InitKeyring verifies that gpg is installed and some keys are trusted

func (*GpgVerifier) IsClearSigned

func (g *GpgVerifier) IsClearSigned(clearsigned io.Reader) (bool, error)

IsClearSigned returns true if file contains signature

func (*GpgVerifier) VerifyClearsigned

func (g *GpgVerifier) VerifyClearsigned(clearsigned io.Reader, showKeyTip bool) (*KeyInfo, error)

VerifyClearsigned verifies clearsigned file using gpgv

func (*GpgVerifier) VerifyDetachedSignature

func (g *GpgVerifier) VerifyDetachedSignature(signature, cleartext io.Reader, showKeyTip bool) error

VerifyDetachedSignature verifies combination of signature and cleartext using gpgv

type Key

type Key string

Key is key in PGP representation

func KeyFromUint64

func KeyFromUint64(key uint64) Key

KeyFromUint64 converts openpgp uint64 into hex human-readable

func (Key) Matches

func (key1 Key) Matches(key2 Key) bool

Matches checks two keys for equality

type KeyInfo

type KeyInfo struct {
	GoodKeys    []Key
	MissingKeys []Key
}

KeyInfo is response from signature verification

type Signer

type Signer interface {
	Init() error
	SetKey(keyRef string)
	SetKeyRing(keyring, secretKeyring string)
	SetPassphrase(passphrase, passphraseFile string)
	SetBatch(batch bool)
	DetachedSign(source string, destination string) error
	ClearSign(source string, destination string) error
}

Signer interface describes facility implementing signing of files

type Verifier

type Verifier interface {
	InitKeyring() error
	AddKeyring(keyring string)
	VerifyDetachedSignature(signature, cleartext io.Reader, showKeyTip bool) error
	IsClearSigned(clearsigned io.Reader) (bool, error)
	VerifyClearsigned(clearsigned io.Reader, showKeyTip bool) (*KeyInfo, error)
	ExtractClearsigned(clearsigned io.Reader) (text *os.File, err error)
}

Verifier interface describes signature verification factility