cpt

Documentation

Index

• Constants
• Variables
• func CutPadKey(key string, size int) string
• func Pkcs7Pad(data []byte, size int) []byte
• func Pkcs7Unpad(data []byte) []byte
• func Salt(chars, salt, src string) string
• func Unsalt(chars, salt, src string) string
• type Cryptor
• type Decryptor
  • func NewAes128CBCDecryptor(secret string) Decryptor
  • func NewAes128CFBDecryptor(secret string) Decryptor
  • func NewAes192CBCDecryptor(secret string) Decryptor
  • func NewAes192CFBDecryptor(secret string) Decryptor
  • func NewAes256CBCDecryptor(secret string) Decryptor
  • func NewAes256CFBDecryptor(secret string) Decryptor
  • func NewAesCBCDecryptor(secret string, bits int) Decryptor
  • func NewAesCFBDecryptor(secret string, bits int) Decryptor
• type Encryptor
  • func NewAes128CBCEncryptor(secret string) Encryptor
  • func NewAes128CFBEncryptor(secret string) Encryptor
  • func NewAes192CBCEncryptor(secret string) Encryptor
  • func NewAes192CFBEncryptor(secret string) Encryptor
  • func NewAes256CBCEncryptor(secret string) Encryptor
  • func NewAes256CFBEncryptor(secret string) Encryptor
  • func NewAesCBCEncryptor(secret string, bits int) Encryptor
  • func NewAesCFBEncryptor(secret string, bits int) Encryptor
• type Padder
  • func (p Padder) Pad(data []byte) []byte
  • func (p Padder) Unpad(data []byte) ([]byte, error)
• type Padding
  • func NewPkcs5Padding() Padding
  • func NewPkcs7Padding(blockSize int) Padding
• type Token
  • func NewToken() *Token
  • func ParseToken(token string) (t *Token, err error)
  • func (t *Token) Refresh()
  • func (t *Token) Salt() string
  • func (t *Token) Secret() string
  • func (t *Token) String() string
  • func (t *Token) Timestamp() time.Time
  • func (t *Token) Token() string
• type Tokener
  • func NewTokener(saltLength, secretLength int) *Tokener
  • func (tr *Tokener) NewToken(secret ...string) *Token
  • func (tr *Tokener) ParseToken(token string) (*Token, error)

Constants

const (
	SecretChars = str.Base64URL
)

Variables

var (
	ErrTokenLength    = errors.New("invalid token length")
	ErrTokenTimestamp = errors.New("invalid token timestamp")
)

Functions

func CutPadKey

func CutPadKey(key string, size int) string

CutPadKey cut key if key's length is greater than 'size', or pad key with space if key's length is smaller than 'size'.

func Pkcs7Pad

func Pkcs7Pad(data []byte, size int) []byte

Pkcs7Pad returns the byte array passed as a parameter padded with bytes such that the new byte array will be an exact multiple of the expected block size. For example, if the expected block size is 8 bytes (e.g. PKCS #5) and that the initial byte array is:

[]byte{0x0A, 0x0B, 0x0C, 0x0D}

the returned array will be:

[]byte{0x0A, 0x0B, 0x0C, 0x0D, 0x04, 0x04, 0x04, 0x04}

The value of each octet of the padding is the size of the padding. If the array passed as a parameter is already an exact multiple of the block size, the original array will be padded with a full block.

func Pkcs7Unpad

func Pkcs7Unpad(data []byte) []byte

Pkcs7Unpad removes the padding of a given byte array, according to the same rules as described in the Pad function. For example if the byte array passed as a parameter is:

[]byte{0x0A, 0x0B, 0x0C, 0x0D, 0x04, 0x04, 0x04, 0x04}

the returned array will be:

[]byte{0x0A, 0x0B, 0x0C, 0x0D}

func Salt

func Salt(chars, salt, src string) string

func Unsalt

func Unsalt(chars, salt, src string) string

Types

type Cryptor

type Cryptor interface {
	Encryptor
	Decryptor
}

type Decryptor

type Decryptor interface {
	DecryptString(string) (string, error)
	DecryptBytes([]byte) ([]byte, error)
}

func NewAes128CBCDecryptor

func NewAes128CBCDecryptor(secret string) Decryptor

func NewAes128CFBDecryptor

func NewAes128CFBDecryptor(secret string) Decryptor

func NewAes192CBCDecryptor

func NewAes192CBCDecryptor(secret string) Decryptor

func NewAes192CFBDecryptor

func NewAes192CFBDecryptor(secret string) Decryptor

func NewAes256CBCDecryptor

func NewAes256CBCDecryptor(secret string) Decryptor

func NewAes256CFBDecryptor

func NewAes256CFBDecryptor(secret string) Decryptor

func NewAesCBCDecryptor

func NewAesCBCDecryptor(secret string, bits int) Decryptor

func NewAesCFBDecryptor

func NewAesCFBDecryptor(secret string, bits int) Decryptor

type Encryptor

type Encryptor interface {
	EncryptString(string) (string, error)
	EncryptBytes([]byte) ([]byte, error)
}

func NewAes128CBCEncryptor

func NewAes128CBCEncryptor(secret string) Encryptor

func NewAes128CFBEncryptor

func NewAes128CFBEncryptor(secret string) Encryptor

func NewAes192CBCEncryptor

func NewAes192CBCEncryptor(secret string) Encryptor

func NewAes192CFBEncryptor

func NewAes192CFBEncryptor(secret string) Encryptor

func NewAes256CBCEncryptor

func NewAes256CBCEncryptor(secret string) Encryptor

func NewAes256CFBEncryptor

func NewAes256CFBEncryptor(secret string) Encryptor

func NewAesCBCEncryptor

func NewAesCBCEncryptor(secret string, bits int) Encryptor

func NewAesCFBEncryptor

func NewAesCFBEncryptor(secret string, bits int) Encryptor

type Padder

type Padder int

Padder struct embeds attributes necessary for the padding calculation (e.g. block size). It implements the Padding interface.

func (Padder) Pad

func (p Padder) Pad(data []byte) []byte

func (Padder) Unpad

func (p Padder) Unpad(data []byte) ([]byte, error)

type Padding

type Padding interface {
	Pad(p []byte) []byte
	Unpad(p []byte) ([]byte, error)
}

Padding interface defines functions Pad and Unpad implemented for PKCS #5 and PKCS #7 types of padding.

func NewPkcs5Padding

func NewPkcs5Padding() Padding

NewPkcs5Padding returns a PKCS5 padding type structure. The blocksize defaults to 8 bytes (64-bit). See https://tools.ietf.org/html/rfc2898 PKCS #5: Password-Based Cryptography. Specification Version 2.0

func NewPkcs7Padding

func NewPkcs7Padding(blockSize int) Padding

NewPkcs7Padding returns a PKCS7 padding type structure. The blocksize is passed as a parameter. See https://tools.ietf.org/html/rfc2315 PKCS #7: Cryptographic Message Syntax Version 1.5. For example the block size for AES is 16 bytes (128 bits).

type Token

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

func NewToken

func NewToken() *Token

func ParseToken

func ParseToken(token string) (t *Token, err error)

func (*Token) Refresh

func (t *Token) Refresh()

func (*Token) Salt

func (t *Token) Salt() string

func (*Token) Secret

func (t *Token) Secret() string

func (*Token) String

func (t *Token) String() string

func (*Token) Timestamp

func (t *Token) Timestamp() time.Time

func (*Token) Token

func (t *Token) Token() string

type Tokener

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

func NewTokener

func NewTokener(saltLength, secretLength int) *Tokener

func (*Tokener) NewToken

func (tr *Tokener) NewToken(secret ...string) *Token

func (*Tokener) ParseToken

func (tr *Tokener) ParseToken(token string) (*Token, error)