README
¶
gocrypt
gocrypt is encryption/decryption library for golang.
Library gocrypt provides a library to do encryption instruct with go field. The library gocrypt provide instruct tag encryption or inline encryption and decryption
Overview
The package supported:
DES3 — Triple Data Encryption Standard
The AES cipher is the current U.S. government standard for all software and is recognized worldwide.
AES — Advanced Encryption Standard
The DES ciphers are primarily supported for PBE standard that provides the option of generating an encryption key based on a passphrase.
RC4 — stream chipper
The RC4 is supplied for situations that call for fast encryption, but not strong encryption. RC4 is ideal for situations that require a minimum of encryption.
The Idea
Sample JSON Payload
Before the encryption:
{
"a": "Sample plain text",
"b": {
c: "Sample plain text 2"
}
}
After the encryption:
{
"profile": "akldfjiaidjfods==",
"id": {
c: "Ijdsifsjiek18239=="
}
}
Struct Tag Field Implementation
type A struct {
A string `json:"a" gocrypt:"aes"`
B B `json:"b"`
}
type B struct {
C string `json:"c" gocrypt:"aes"`
}
Full Sample
package main
import (
"encoding/json"
"fmt"
"log"
"time"
"github.com/firdasafridi/gocrypt"
)
// Data contains identity and profile user
type Data struct {
Profile *Profile `json:"profile"`
Identity *Identity `json:"identity"`
}
// Profile contains name and phone number user
type Profile struct {
Name string `json:"name"`
PhoneNumber string `json:"phone_number" gocrypt:"aes"`
}
// Identity contains id, license number, and expired date
type Identity struct {
ID string `json:"id" gocrypt:"aes"`
LicenseNumber string `json:"license_number" gocrypt:"aes"`
ExpiredDate time.Time `json:"expired_date"`
}
const (
// it's random string must be hexa a-f & 0-9
aeskey = "fa89277fb1e1c344709190deeac4465c2b28396423c8534a90c86322d0ec9dcf"
)
func main() {
// define AES option
aesOpt, err := gocrypt.NewAESOpt(aeskey)
if err != nil {
log.Println("ERR", err)
return
}
data := &Data{
Profile: &Profile{
Name: "Batman",
PhoneNumber: "+62123123123",
},
Identity: &Identity{
ID: "12345678",
LicenseNumber: "JSKI-123-456",
},
}
cryptRunner := gocrypt.New(&gocrypt.Option{
AESOpt: aesOpt,
})
err = cryptRunner.Encrypt(data)
if err != nil {
log.Println("ERR", err)
return
}
strEncrypt, _ := json.Marshal(data)
fmt.Println("Encrypted:", string(strEncrypt))
err = cryptRunner.Decrypt(data)
if err != nil {
log.Println("ERR", err)
return
}
strDecrypted, _ := json.Marshal(data)
fmt.Println("Decrypted:", string(strDecrypted))
}
Others
gocrypt also supported inline encryption/decryption.
func main() {
// sample plain text
sampleText := "Halo this is encrypted text!!!"
// define DES option
desOpt, err := gocrypt.NewDESOpt(key)
if err != nil {
log.Println("ERR", err)
return
}
// Encrypt text using DES algorithm
cipherText, err := desOpt.Encrypt([]byte(sampleText))
if err != nil {
log.Println("ERR", err)
return
}
fmt.Println("Encrypted data:", cipherText)
// Decrypt text using DES algorithm
plainText, err := desOpt.Decrypt([]byte(cipherText))
if err != nil {
log.Println("ERR", err)
return
}
fmt.Println("Decrypted data:", plainText)
}
Limitation
gocrypt only supports the string type. Need more research & development to support the library for more type data.
Documentation
¶
Overview ¶
Package gocrypt provide a library for do encryption in struct with go field.
Package gocrypt provide in struct tag encryption or inline encryption and decryption ¶
The package supported:
DES3 — Triple Data Encryption Standard ¶
AES — Advanced Encryption Standard ¶
RC4 — stream chipper ¶
The AES cipher is the current U.S. government standard for all software, and is recognized worldwide.
The DES ciphers are primarily supported for PBE standard that provides the option of generating an encryption key based on a passphrase.
The RC4 is supplied for situations that call for fast encryption, but not strong encryption. RC4 is ideal for situations that require a minimum of encryption.
Index ¶
Constants ¶
const (
// GOCRYPT is variable tag field for gocrypt
GOCRYPT = "gocrypt"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AESOpt ¶
type AESOpt struct {
// contains filtered or unexported fields
}
AESOpt contains all aes session option
func NewAESOpt ¶
NewAESOpt is function to create new configuration of aes algorithm option the secret must be hexa a-f & 0-9
type DESOpt ¶
type DESOpt struct {
// contains filtered or unexported fields
}
DESOpt contains all DES session option
func NewDESOpt ¶
NewDESOpt is function to create new configuration of des algorithm option the secret must be 24 character
type GocryptInterface ¶
GocryptInterface is facing the format gocrypt option library
type GocryptOption ¶
type GocryptOption interface {
Encrypt(plainText []byte) (string, error)
Decrypt(chipherText []byte) (string, error)
}
GocryptOption is facing the format encryption and decryption format
type Option ¶
type Option struct {
AESOpt GocryptOption
DESOpt GocryptOption
RC4Opt GocryptOption
Custom map[string]GocryptOption
Prefix string
Postfix string
}
Option contains an option from initial algorithm encryptioin & decryption.
func New ¶
New create and initialize new option for struct field encryption.
It needs option from aes, rc4, or des for initialitaion
type RC4Opt ¶
type RC4Opt struct {
// contains filtered or unexported fields
}
RC4Opt is tructure of aes option
func NewRC4Opt ¶
NewRC4Opt is function to create new configuration of aes algorithm option the secret must be hexa a-f & 0-9
Source Files
Directories