cipher

README

Convenient encryption tools

Installation

Run go get resenje.org/cipher from command line.

Documentation

Index

• Variables
• type BytesCipher
• type Cipher
• type StringCipher
• type StringEncoder

Variables

var ErrInvalidData = errors.New("invalid data")

ErrInvalidData should be returned by DecryptString if the data validation fails.

Types

type BytesCipher

type BytesCipher interface {
	Encrypt([]byte) ([]byte, error)
	Decrypt([]byte) ([]byte, error)
}

BytesCipher defines methods that need to be defined to have a convenient way to encrypt and decrypt arbitrary data.

type Cipher

type Cipher interface {
	BytesCipher
	StringCipher
}

BytesCipher defines methods that need to be defined to have a convenient way to encrypt and decrypt arbitrary data and strings.

type StringCipher

type StringCipher interface {
	EncryptString(string) (string, error)
	DecryptString(string) (string, error)
}

StringCipher defines methods that need to be defined to have a convenient way to encrypt and decrypt arbitrary strings.

type StringEncoder

type StringEncoder interface {
	EncodeToString([]byte) string
	DecodeString(string) ([]byte, error)
}

StringEncoder is used to specify encoding for input or output data.

var DefaultEncoder StringEncoder = base32.NewEncoding("0123456789abcdefghjkmnpqrstvwxyz").WithPadding(base32.NoPadding)

DefaultEncoding is a Base32 encoding with "0123456789abcdefghjkmnpqrstvwxyz" charset and without padding. It is used to encode data returned by EncryptString.