sym

Sym

A small and lightweight symmetric encryption/decryption package.

Useful for encrypting and decrypting strings, bytes, and files.

Only external dependency is stretchr/testify for the unit tests.

Install

go get -u github.com/fuskovic/sym

Examples

Encrypt/Decrypt Strings

// The key needs to be either 16, 24, or 32 characters in length
key := os.Getenv("SYMMETRIC_KEY")

ciphertext, err := sym.EncryptString(key, "hello world")
if err != nil {
    // handle error
}

plaintext, err := sym.DecryptString(key, ciphertext)
if err != nil {
    // handle error
}

Encrypt/Decrypt Bytes

// The key needs to be either 16, 24, or 32 characters in length
key := os.Getenv("SYMMETRIC_KEY")

ciphertext, err := sym.EncryptBytes(key, []byte("hello world"))
if err != nil {
    // handle error
}

plaintext, err := sym.DecryptBytes(key, ciphertext)
if err != nil {
    // handle error
}

Encrypt/Decrypt Files

var (
    // The key needs to be either 16, 24, or 32 characters in length
    key                 = os.Getenv("SYMMETRIC_KEY")
    plaintextFilePath   = "/path/to/existing/file.txt"
    // New files get created and existing files get overwritten.
    encryptedFilePath   = "/path/to/new/or/existing/file.txt"
)

if err := sym.EncryptFile(key, plaintextFilePath, encryptedFilePath); err != nil {
    // handle error
}

in := encryptedFilePath
out := "/path/to/new/or/existing/file.txt"

if err := sym.DecryptFile(key, in, out); err != nil {
    // handle error
}