secure

Documentation

Index

• Variables
• func Belongs(pub KeyWithFilter, prv []byte, passphrase string) bool
• func DecryptAES(key, data []byte) ([]byte, error)
• func EncryptAES(key, data []byte) ([]byte, error)
• func IsAuthErr(err error) bool
• func PrivateKeyTypePrefix(key crypto.PrivateKey) string
• func SSHPrvKey(keyData []byte, passphrase string) (crypto.PrivateKey, error)
• func SSHPubKey(publicKey []byte) (crypto.PublicKey, error)
• func SharedSecret(prv crypto.PrivateKey, pub crypto.PublicKey) ([]byte, error)
• type Cipher
  • func (c *Cipher) DecodeAESKey(encryptedKeys [][]byte) ([]byte, error)
  • func (c *Cipher) Decoder(r io.Reader) (io.ReadCloser, error)
  • func (c *Cipher) Encoder(w io.Writer) (io.WriteCloser, error)
• type Key
  • func New(privateKey []byte, passphrase string, publicKeys ...KeyWithFilter) (*Key, error)
  • func (k *Key) AESKeys() ([]byte, [][]byte, error)
  • func (k *Key) Cipher() *Cipher
  • func (k *Key) IsRSA() bool
  • func (k *Key) SigDigest(digest []byte) ([]byte, error)
  • func (k *Key) Sign(data []byte) ([]byte, error)
  • func (k *Key) Signer() *Signer
  • func (k *Key) Verify(data []byte) ([]byte, bool)
  • func (k *Key) VerifyDigest(digest, sign []byte) bool
• type KeyWithFilter
  • func (key KeyWithFilter) GetKey(typePrefix string) ([]byte, error)
• type Signer
  • func (s *Signer) Decoder(r io.Reader) (io.ReadCloser, error)
  • func (s *Signer) Encoder(w io.Writer) (io.WriteCloser, error)

Variables

var ErrNotSupportedKey = errors.New("not an supported key")

var ErrPubKeyNotFound = errors.New("public key not found")

var ErrSignNotMatch = errors.New("sign not match")

Functions

func Belongs

func Belongs(pub KeyWithFilter, prv []byte, passphrase string) bool

Belongs checks if pub key belongs to prv key.

func DecryptAES

func DecryptAES(key, data []byte) ([]byte, error)

func EncryptAES

func EncryptAES(key, data []byte) ([]byte, error)

func IsAuthErr

func IsAuthErr(err error) bool

func PrivateKeyTypePrefix

func PrivateKeyTypePrefix(key crypto.PrivateKey) string

func SSHPrvKey

func SSHPrvKey(keyData []byte, passphrase string) (crypto.PrivateKey, error)

SSHPrvKey returns a private key from a ssh private key.

func SSHPubKey

func SSHPubKey(publicKey []byte) (crypto.PublicKey, error)

func SharedSecret

func SharedSecret(prv crypto.PrivateKey, pub crypto.PublicKey) ([]byte, error)

Types

type Cipher

type Cipher struct {
	Key *Key
}

func (*Cipher) DecodeAESKey

func (c *Cipher) DecodeAESKey(encryptedKeys [][]byte) ([]byte, error)

func (*Cipher) Decoder

func (c *Cipher) Decoder(r io.Reader) (io.ReadCloser, error)

func (*Cipher) Encoder

func (c *Cipher) Encoder(w io.Writer) (io.WriteCloser, error)

Encoder format is:

[encrypted key count][aes key 1][aes key 2]...[encrypted data].

Each key is for a public key.

type Key

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

func New

func New(privateKey []byte, passphrase string, publicKeys ...KeyWithFilter) (*Key, error)

func (*Key) AESKeys

func (k *Key) AESKeys() ([]byte, [][]byte, error)

AESKeys returns the AES key and encrypted keys for each public key. If there's only one public key, the AES key will be the ECDH key. If there're multiple public keys, a random base AES key will be generated, then each ECDH key will be used to encrypt the base AES key.

func (*Key) Cipher

func (k *Key) Cipher() *Cipher

func (*Key) IsRSA

func (k *Key) IsRSA() bool

func (*Key) SigDigest

func (k *Key) SigDigest(digest []byte) ([]byte, error)

func (*Key) Sign

func (k *Key) Sign(data []byte) ([]byte, error)

func (*Key) Signer

func (k *Key) Signer() *Signer

func (*Key) Verify

func (k *Key) Verify(data []byte) ([]byte, bool)

func (*Key) VerifyDigest

func (k *Key) VerifyDigest(digest, sign []byte) bool

type KeyWithFilter

type KeyWithFilter struct {
	Key    []byte
	Filter string
}

func (KeyWithFilter) GetKey

func (key KeyWithFilter) GetKey(typePrefix string) ([]byte, error)

type Signer

type Signer struct {
	Key *Key
}

func (*Signer) Decoder

func (s *Signer) Decoder(r io.Reader) (io.ReadCloser, error)

func (*Signer) Encoder

func (s *Signer) Encoder(w io.Writer) (io.WriteCloser, error)