ezcrypt

README

ezcrypt

Golang Easy Cryptography

Installation

go get github.com/anantadwi13/ezcrypt

Documentation

Index

• Constants
• func SetBase64Encoder(encoder *base64.Encoding) error
• func SetRandomReader(reader io.Reader) error
• type AES
  • func AesCBC(key AESKey) (AES, error)
  • func AesCBCWithPKCS5Padding(key AESKey) (AES, error)
  • func AesCFB(key AESKey) (AES, error)
  • func AesGCM(key AESKey, additionalData []byte) (AES, error)
• type AESKey
  • func AesGenerateRandomKey(keySize AESKeySize) AESKey
  • func AesLoadEncodedKey(encodedKey []byte) (AESKey, error)
  • func (a AESKey) Encode() ([]byte, error)
• type AESKeySize
• type AsymmetricEncryption
• type Key
• type KeyPair
• type RSA
  • func RsaOAEPWithSHA256(keyPair RSAKeyPair) (RSA, error)
  • func RsaOAEPWithSHA512(keyPair RSAKeyPair) (RSA, error)
• type RSAKeyPair
  • func RsaGenerateKeyPair(bits RSAKeySize) (RSAKeyPair, error)
  • func RsaLoadEncodedKeyPair(privateKey []byte) (RSAKeyPair, error)
  • func RsaLoadEncodedPublicKey(publicKey []byte) (RSAKeyPair, error)
• type RSAKeySize
• type SymmetricEncryption

Constants

const (
	AESKey128 = AESKeySize(16)
	AESKey192 = AESKeySize(24)
	AESKey256 = AESKeySize(32)
)

const (
	RSAKey2048 = RSAKeySize(2048)
	RSAKey4096 = RSAKeySize(4096)
)

Functions

func SetBase64Encoder

func SetBase64Encoder(encoder *base64.Encoding) error

func SetRandomReader

func SetRandomReader(reader io.Reader) error

Types

type AES

type AES interface {
	SymmetricEncryption
}

func AesCBC

func AesCBC(key AESKey) (AES, error)

func AesCBCWithPKCS5Padding

func AesCBCWithPKCS5Padding(key AESKey) (AES, error)

func AesCFB

func AesCFB(key AESKey) (AES, error)

func AesGCM

func AesGCM(key AESKey, additionalData []byte) (AES, error)

AesGCM return AES with Galois Counter Mode instance. It is using 12 bytes nonce and 16 bytes tag. additionalData is an optional parameter (used for authentication purpose). It can be nil or any size slice.

AesGCM.Encrypt will return bytes of base64encode(Nonce+CipherText+Tag). AesGCM.Decrypt requires bytes of base64encode(Nonce+CipherText+Tag) parameter.

type AESKey

type AESKey Key

func AesGenerateRandomKey

func AesGenerateRandomKey(keySize AESKeySize) AESKey

func AesLoadEncodedKey

func AesLoadEncodedKey(encodedKey []byte) (AESKey, error)

AesLoadEncodedKey loads encoded base64 key into AESKey

func (AESKey) Encode

func (a AESKey) Encode() ([]byte, error)

type AESKeySize

type AESKeySize int

type AsymmetricEncryption

type AsymmetricEncryption interface {
	EncryptWithPublicKey(message []byte) ([]byte, error)
	DecryptWithPrivateKey(cipher []byte) ([]byte, error)
	KeyPair() KeyPair
}

type Key

type Key []byte

type KeyPair

type KeyPair interface {
	Public() interface{}
	Private() interface{}
	EncodedPublic() ([]byte, error)
	EncodedPrivate() ([]byte, error)
}

type RSA

type RSA interface {
	AsymmetricEncryption
}

func RsaOAEPWithSHA256

func RsaOAEPWithSHA256(keyPair RSAKeyPair) (RSA, error)

func RsaOAEPWithSHA512

func RsaOAEPWithSHA512(keyPair RSAKeyPair) (RSA, error)

type RSAKeyPair

type RSAKeyPair interface {
	KeyPair
	PublicRsa() *rsa.PublicKey
	PrivateRsa() *rsa.PrivateKey
}

func RsaGenerateKeyPair

func RsaGenerateKeyPair(bits RSAKeySize) (RSAKeyPair, error)

func RsaLoadEncodedKeyPair

func RsaLoadEncodedKeyPair(privateKey []byte) (RSAKeyPair, error)

RsaLoadEncodedKeyPair loads base64 encoded privateKey into RSAKeyPair. It will create RSAKeyPair instance with private and public keys loaded.

func RsaLoadEncodedPublicKey

func RsaLoadEncodedPublicKey(publicKey []byte) (RSAKeyPair, error)

RsaLoadEncodedPublicKey loads base64 encoded publicKey only into RSAKeyPair. It will create RSAKeyPair instance without a private key.

**NOTE** This RSAKeyPair is used for encryption only.

type RSAKeySize

type RSAKeySize int

type SymmetricEncryption

type SymmetricEncryption interface {
	Encrypt(message []byte) ([]byte, error)
	Decrypt(cipher []byte) ([]byte, error)
	Key() Key
}