goencrypt

README

goencrypt

Goencrypt is a library written in pure Go providing a set of encryption algorithms, which including symmetric ciphers(DES, 3DES, AES), asymmetric ciphers (RSA), etc.

Quick Start

Download and install

go get github.com/marspere/goencrypt@v1.0.7

# assume the following codes in example.go file
$ cat example.go

package main

import (
	"fmt"

	"github.com/marspere/goencrypt"
)

func main() {
	value, err := goencrypt.MD5("hello world")
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(value)
	// output: 5eb63bbbe01eeed093cb22bb8f5acdc3
}

# run example.go
$ go run example.go

API Examples

You can find a number of examples at goencrypt repository.

MD5 Message-Digest Algorithm

It is a widely used cryptographic hash function that produces a hash value to ensure complete and consistent information transfer.

func main() {	
    // The return value is 32-bit lowercase.
    value, err := goencrypt.MD5("hello world")
    fmt.Println(value.Value)
    
    // UpperCase32 return 32-bit uppercase value.
    fmt.Println(value.UpperCase32)
    
    // LowerCase16 return 16-bit lowercase value.
    fmt.Println(value.LowerCase16)
    
    // UpperCase16 return 16-bit uppercase value.
    fmt.Println(value.UpperCase16)
}

RSA Algorithm

RSA encryption algorithm is an asymmetric encryption algorithm. RSA is also a packet encryption algorithm, except that the packet size can be changed according to the size of the key.

RSA encryption limits the length of plaintext, and specifies the maximum length of plaintext to be encrypted = len(key) - 11.

func main() {
	cipher := goencrypt.NewRSACipher(goencrypt.PrintBase64, defaultPublicFile, defaultPrivateFile)
	cipherText, err := cipher.RSAEncrypt([]byte("hello world"))
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(cipherText)
}

AES Algorithm

AES, Advanced Encryption Standard, also known as Rijndael encryption in cryptography, is a block encryption standard adopted by the US federal government.

AES block length is fixed at 128 bits, the key length can be 128, 192 or 256 bits. It including AES-ECB,AES-CBC,AES-CTR,AES-OFB,AES-CFB.

func main() {
	cipher, err := goencrypt.NewAESCipher([]byte("0123456789asdfgh"), []byte("0123456789asdfgh"), goencrypt.CBCMode, goencrypt.Pkcs7, goencrypt.PrintBase64)
	if err != nil {
    	fmt.Println(err)
    	return
    }
	cipherText, err := cipher.AESEncrypt([]byte("hello world"))
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(cipherText)
}

DES Algorithm

func main() {
	cipher := goencrypt.NewDESCipher([]byte("12345678"), []byte(""), goencrypt.ECBMode, goencrypt.Pkcs5, goencrypt.PrintBase64)
	cipherText, err := cipher.DESEncrypt([]byte("hello world"))
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(cipherText)
}

Triple DES Algorithm

func main() {
	cipher := goencrypt.NewDESCipher([]byte("12345678abcdefghijklmnop"), []byte("abcdefgh"), goencrypt.CBCMode, goencrypt.Pkcs5, goencrypt.PrintBase64)
	cipherText, err := cipher.TripleDESEncrypt([]byte("hello world"))
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(cipherText)
}

Secure Hash Algorithm

func main() {
	result, err := goencrypt.SHA(goencrypt.SHA1, []byte("hello world"), goencrypt.PrintHex)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(result)
}

Contributing

If you’d like to propose a change please ensure the following:

• All existing tests are passing.
• There are tests in the test suite that cover the changes you’re making.
• You have added documentation strings (in English) to (at least) the public functions you’ve added or modified.

Documentation

Index

• Constants
• func SHA(length int, content interface{}, decodeType int) (result string, err error)
• type Cipher
  • func (c *Cipher) Decode(cipherText string) ([]byte, error)
  • func (c *Cipher) Decrypt(block cipher.Block, cipherData []byte) (err error)
  • func (c *Cipher) Encode() string
  • func (c *Cipher) Encrypt(block cipher.Block, plainData []byte) (err error)
  • func (c *Cipher) Fill(plainText []byte, blockSize int) []byte
  • func (c *Cipher) NewECBDecrypter(block cipher.Block, cipherData []byte)
  • func (c *Cipher) NewECBEncrypter(block cipher.Block, plainData []byte)
  • func (c *Cipher) UnFill(plainText []byte) (data []byte, err error)
• type CipherAES
  • func NewAESCipher(key, iv []byte, groupMode int, fillMode FillMode, decodeType int) (*CipherAES, error)
  • func (c *CipherAES) AESDecrypt(cipherText string) (plainText string, err error)
  • func (c *CipherAES) AESEncrypt(plainText []byte) (cipherText string, err error)
• type CipherDES
  • func NewDESCipher(key, iv []byte, groupMode int, fillMode FillMode, decodeType int) *CipherDES
  • func (c *CipherDES) DESDecrypt(cipherText string) (plainText string, err error)
  • func (c *CipherDES) DESEncrypt(plainText []byte) (cipherText string, err error)
  • func (c *CipherDES) TripleDESDecrypt(cipherText string) (plainText string, err error)
  • func (c *CipherDES) TripleDESEncrypt(plainText []byte) (cipherText string, err error)
• type CipherRSA
  • func NewRSACipher(decodeType int, keyFile ...string) *CipherRSA
  • func (cr *CipherRSA) RSADecrypt(cipherText string) (plainText string, err error)
  • func (cr *CipherRSA) RSAEncrypt(plainText []byte) (cipherText string, err error)
• type CipherText
• type Crypto
• type FillMode
• type MessageDigest
  • func MD5(src interface{}) (md MessageDigest, err error)
  • func (md MessageDigest) LowerCase16() string
  • func (md MessageDigest) UpperCase16() string
  • func (md MessageDigest) UpperCase32() string

Examples

• SHA

Constants

const (
	CBCMode = iota
	CFBMode
	CTRMode
	ECBMode
	OFBMode
)

const (
	PrintHex = iota
	PrintBase64
)

const (
	SHA1 = iota
	SHA256
	SHA512
)

const BlockSize = 16

Functions

func SHA

func SHA(length int, content interface{}, decodeType int) (result string, err error)

SHA implements several hash functions, including sha1, sha256, and sha512. Meanwhile, SHA supports file hash. When content type is string, it indicates the address of the file. decodeType represents the print format, and the result is not encrypted by default.

Example

result, err := SHA(SHA1, []byte("hello world"), PrintHex)
if err != nil {
	fmt.Println(err)
	return
}
fmt.Println(result)

Types

type Cipher

type Cipher struct {
	GroupMode  int
	FillMode   FillMode
	DecodeType int
	Key        []byte
	Iv         []byte
	Output     CipherText
}

func (*Cipher) Decode

func (c *Cipher) Decode(cipherText string) ([]byte, error)

func (*Cipher) Decrypt

func (c *Cipher) Decrypt(block cipher.Block, cipherData []byte) (err error)

func (*Cipher) Encode

func (c *Cipher) Encode() string

Encode default print format is base64

func (*Cipher) Encrypt

func (c *Cipher) Encrypt(block cipher.Block, plainData []byte) (err error)

func (*Cipher) Fill

func (c *Cipher) Fill(plainText []byte, blockSize int) []byte

func (*Cipher) NewECBDecrypter

func (c *Cipher) NewECBDecrypter(block cipher.Block, cipherData []byte)

func (*Cipher) NewECBEncrypter

func (c *Cipher) NewECBEncrypter(block cipher.Block, plainData []byte)

func (*Cipher) UnFill

func (c *Cipher) UnFill(plainText []byte) (data []byte, err error)

type CipherAES

type CipherAES struct {
	Cipher
}

func NewAESCipher

func NewAESCipher(key, iv []byte, groupMode int, fillMode FillMode, decodeType int) (*CipherAES, error)

func (*CipherAES) AESDecrypt

func (c *CipherAES) AESDecrypt(cipherText string) (plainText string, err error)

func (*CipherAES) AESEncrypt

func (c *CipherAES) AESEncrypt(plainText []byte) (cipherText string, err error)

type CipherDES

type CipherDES struct {
	Cipher
}

func NewDESCipher

func NewDESCipher(key, iv []byte, groupMode int, fillMode FillMode, decodeType int) *CipherDES

func (*CipherDES) DESDecrypt

func (c *CipherDES) DESDecrypt(cipherText string) (plainText string, err error)

func (*CipherDES) DESEncrypt

func (c *CipherDES) DESEncrypt(plainText []byte) (cipherText string, err error)

func (*CipherDES) TripleDESDecrypt

func (c *CipherDES) TripleDESDecrypt(cipherText string) (plainText string, err error)

func (*CipherDES) TripleDESEncrypt

func (c *CipherDES) TripleDESEncrypt(plainText []byte) (cipherText string, err error)

type CipherRSA

type CipherRSA struct {
	PubKey string
	PriKey string
	Cipher
}

func NewRSACipher

func NewRSACipher(decodeType int, keyFile ...string) *CipherRSA

New returns a CipherRSA pointer, the keyFile parameters is address of public key or private key. If the length of keyFile is 1, which means RSA encryption. If the length of keyFile greater than 1, which means RSA decryption. Meanwhile, the second element of keyFile represents private key.

func (*CipherRSA) RSADecrypt

func (cr *CipherRSA) RSADecrypt(cipherText string) (plainText string, err error)

Decrypt parses the given message with RSA private key in PKCS#1, ASN.1 DER form.

func (*CipherRSA) RSAEncrypt

func (cr *CipherRSA) RSAEncrypt(plainText []byte) (cipherText string, err error)

Encrypt encrypts the given message with RSA and the padding scheme from PKCS#1 v1.5.

type CipherText

type CipherText []byte

type Crypto

type Crypto interface {
	Encrypt(plainText []byte) (string, error)
	Decrypt(cipherText string) (string, error)
}

type FillMode

type FillMode int

const (
	PkcsZero FillMode = iota
	Pkcs7
)

type MessageDigest

type MessageDigest string

func MD5

func MD5(src interface{}) (md MessageDigest, err error)

MD5 information summary, the src has two types: []byte or string The default return value is 32-bit lowercase.

func (MessageDigest) LowerCase16

func (md MessageDigest) LowerCase16() string

func (MessageDigest) UpperCase16

func (md MessageDigest) UpperCase16() string

func (MessageDigest) UpperCase32

func (md MessageDigest) UpperCase32() string