Simplified encryption and decryption functions using the standard crypto/aes package
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
LICENSE.txt
README.md
aes256.go
aes256_test.go
example_test.go

README.md

aes256

import "github.com/mkmueller/aes256"

Overview

The aes256 package provides simplified encryption and decryption functions using the standard crypto/aes package. It implements a 256 bit key length and the GCM cipher. The key may be a string of at least one character with an optional hash iteration value. The encrypted output may be a byte slice or a base-64 encoded string.

Index

Examples

Package files

aes256.go

func Decrypt

func Decrypt(key string, ciphertext []byte) ([]byte, error)

Decrypt accepts a key string and a ciphertext byte array. It returns a decrypted byte array.

func DecryptB64

func DecryptB64(key string, ciphertext string) ([]byte, error)

DecryptB64 accepts a key string and a base-64 encoded ciphertext string. It returns a decrypted byte array.

func Encrypt

func Encrypt(key string, plaintext []byte) ([]byte, error)

Encrypt accepts a key string and a plaintext byte array. It returns an encrypted byte array.

func EncryptB64

func EncryptB64(key string, plaintext []byte) (string, error)

Encrypt accepts a key string and a plaintext byte array. It returns an encrypted base-64 encoded string.

type Cipher

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

func New

func New(key string, rehash ...int) (*Cipher, error)

New accepts a key string and an optional rehash value. The supplied key will be rehashed the number of times indicated by the optional rehash value. A new Cipher instance will be returned.

func (*Cipher) Decrypt

func (ci *Cipher) Decrypt(ciphertext []byte) ([]byte, error)

Decrypt accepts a ciphertext byte array and returns a plaintext byte array.

func (*Cipher) DecryptB64

func (ci *Cipher) DecryptB64(b64str string) ([]byte, error)

DecryptB64 accepts a base-64 encoded ciphertext string and returns a decrypted byte array.

func (*Cipher) Encrypt

func (ci *Cipher) Encrypt(plaintext []byte) ([]byte, error)

Encrypt accepts a plaintext byte array and returns an encrypted byte array.

func (*Cipher) EncryptB64

func (ci *Cipher) EncryptB64(plaintext []byte) (string, error)

EncryptB64 accepts a plaintext byte array and returns an encrypted base-64 encoded ciphertext string.


Generated by godoc2md