cipher

Documentation

Index

• Constants
• func HashPassword(rawPassword, uniqueValue []byte) []byte
• type AESGCMBlockCipher
  • func (*AESGCMBlockCipher) BlockSize() int
  • func (c *AESGCMBlockCipher) Clone() BlockCipher
  • func (c *AESGCMBlockCipher) Decrypt(ciphertext []byte) ([]byte, error)
  • func (c *AESGCMBlockCipher) Encrypt(plaintext []byte) ([]byte, error)
  • func (c *AESGCMBlockCipher) ImplicitNonce() []byte
  • func (c *AESGCMBlockCipher) IsStateless() bool
  • func (c *AESGCMBlockCipher) NonceSize() int
  • func (c *AESGCMBlockCipher) Overhead() int
  • func (c *AESGCMBlockCipher) SetImplicitNonceMode(enable bool)
• type BlockCipher
  • func BlockCipherFromPassword(password []byte, stateless bool) (BlockCipher, error)
  • func BlockCipherListFromPassword(password []byte, stateless bool) ([]BlockCipher, error)
  • func CloneBlockCiphers(blocks []BlockCipher) []BlockCipher
  • func SelectDecrypt(data []byte, blocks []BlockCipher) (BlockCipher, []byte, error)
  • func TryDecrypt(data, password []byte, stateless bool) (BlockCipher, []byte, error)

Constants

const (
	DefaultNonceSize = 12 // 12 bytes
	DefaultOverhead  = 16 // 16 bytes
	DefaultKeyLen    = 32 // 256 bits
)

Functions

func HashPassword

func HashPassword(rawPassword, uniqueValue []byte) []byte

HashPassword generates a hashed password from the raw password and a unique value that decorates the password.

Types

type AESGCMBlockCipher

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

AESGCMBlockCipher implements BlockCipher interface with AES-GCM algorithm.

func (*AESGCMBlockCipher) BlockSize

func (*AESGCMBlockCipher) BlockSize() int

BlockSize returns the block size of cipher.

func (*AESGCMBlockCipher) Clone

func (c *AESGCMBlockCipher) Clone() BlockCipher

func (*AESGCMBlockCipher) Decrypt

func (c *AESGCMBlockCipher) Decrypt(ciphertext []byte) ([]byte, error)

func (*AESGCMBlockCipher) Encrypt

func (c *AESGCMBlockCipher) Encrypt(plaintext []byte) ([]byte, error)

func (*AESGCMBlockCipher) ImplicitNonce

func (c *AESGCMBlockCipher) ImplicitNonce() []byte

ImplicitNonce returns the implicit nonce used by the block cipher.

func (*AESGCMBlockCipher) IsStateless

func (c *AESGCMBlockCipher) IsStateless() bool

func (*AESGCMBlockCipher) NonceSize

func (c *AESGCMBlockCipher) NonceSize() int

NonceSize returns the number of bytes used by nonce.

func (*AESGCMBlockCipher) Overhead

func (c *AESGCMBlockCipher) Overhead() int

func (*AESGCMBlockCipher) SetImplicitNonceMode

func (c *AESGCMBlockCipher) SetImplicitNonceMode(enable bool)

type BlockCipher

type BlockCipher interface {
	// Encrypt method adds the nonce in the dst, then encryptes the src.
	Encrypt(plaintext []byte) ([]byte, error)

	// Decrypt method removes the nonce in the src, then decryptes the src.
	Decrypt(ciphertext []byte) ([]byte, error)

	NonceSize() int

	Overhead() int

	// Clone method creates a deep copy of block cipher itself.
	// Panic if this operation fails.
	Clone() BlockCipher

	// SetImplicitNonceMode enables or disables implicit nonce mode.
	// Under implicit nonce mode, the nonce is set exactly once on the first
	// Encrypt() or Decrypt() call. After that, all Encrypt() or Decrypt()
	// calls will not look up nonce in the data. Each Encrypt() or Decrypt()
	// will cause the nonce value to be increased by 1.
	//
	// Implicit nonce mode is disabled by default.
	//
	// Disabling implicit nonce mode removes the implicit nonce (state)
	// from the block cipher.
	SetImplicitNonceMode(enable bool)

	// IsStateless returns true if the BlockCipher can do arbitrary Encrypt()
	// and Decrypt() in any sequence.
	IsStateless() bool
}

BlockCipher is an interface of block encryption and decryption.

func BlockCipherFromPassword

func BlockCipherFromPassword(password []byte, stateless bool) (BlockCipher, error)

BlockCipherFromPassword creates a BlockCipher object from the password with the default settings.

func BlockCipherListFromPassword

func BlockCipherListFromPassword(password []byte, stateless bool) ([]BlockCipher, error)

BlockCipherListFromPassword creates three BlockCipher objects using different salts from the password with the default settings.

func CloneBlockCiphers

func CloneBlockCiphers(blocks []BlockCipher) []BlockCipher

CloneBlockCiphers clones a slice of block ciphers.

func SelectDecrypt

func SelectDecrypt(data []byte, blocks []BlockCipher) (BlockCipher, []byte, error)

SelectDecrypt returns the appropriate cipher block that can decrypt the data, as well as the decrypted result.

func TryDecrypt

func TryDecrypt(data, password []byte, stateless bool) (BlockCipher, []byte, error)

TryDecrypt tries to decrypt the data with all possible keys generated from the password. If successful, returns the block cipher as well as the decrypted results.