License	BSD-style
Maintainer	Vincent Hanquez <vincent@snarc.org>
Stability	Stable
Portability	Excellent
Safe Haskell	None
Language	Haskell98

Crypto.Cipher.Types

Contents

Cipher classes
AEAD functions
Key type and constructor
Initial Vector type and constructor
Authentification Tag

Description

symmetric cipher basic types

Synopsis

Cipher classes

class Cipher cipher where

Symmetric cipher class.

Methods

cipherInit :: Key cipher -> cipher

Initialize a cipher context from a key

cipherName :: cipher -> String

Cipher name

cipherKeySize :: cipher -> KeySizeSpecifier

return the size of the key required for this cipher. Some cipher accept any size for key

class Cipher cipher => BlockCipher cipher where

Symmetric block cipher class

Minimal complete definition

blockSize, ecbEncrypt, ecbDecrypt

Methods

blockSize :: cipher -> Int

Return the size of block required for this block cipher

ecbEncrypt :: cipher -> ByteString -> ByteString

Encrypt blocks

the input string need to be multiple of the block size

ecbDecrypt :: cipher -> ByteString -> ByteString

Decrypt blocks

the input string need to be multiple of the block size

cbcEncrypt :: cipher -> IV cipher -> ByteString -> ByteString

encrypt using the CBC mode.

input need to be a multiple of the blocksize

cbcDecrypt :: cipher -> IV cipher -> ByteString -> ByteString

decrypt using the CBC mode.

input need to be a multiple of the blocksize

cfbEncrypt :: cipher -> IV cipher -> ByteString -> ByteString

encrypt using the CFB mode.

input need to be a multiple of the blocksize

cfbDecrypt :: cipher -> IV cipher -> ByteString -> ByteString

decrypt using the CFB mode.

input need to be a multiple of the blocksize

ctrCombine :: cipher -> IV cipher -> ByteString -> ByteString

combine using the CTR mode.

CTR mode produce a stream of randomized data that is combined (by XOR operation) with the input stream.

encryption and decryption are the same operation.

input can be of any size

xtsEncrypt

Arguments

:: (cipher, cipher)
-> IV cipher	Usually represent the Data Unit (e.g. disk sector)
-> DataUnitOffset	Offset in the data unit in number of blocks
-> ByteString	Plaintext
-> ByteString	Ciphertext

encrypt using the XTS mode.

input need to be a multiple of the blocksize, and the cipher need to process 128 bits block only

xtsDecrypt

Arguments

:: (cipher, cipher)
-> IV cipher	Usually represent the Data Unit (e.g. disk sector)
-> DataUnitOffset	Offset in the data unit in number of blocks
-> ByteString	Ciphertext
-> ByteString	Plaintext

decrypt using the XTS mode.

input need to be a multiple of the blocksize, and the cipher need to process 128 bits block only

aeadInit :: Byteable iv => AEADMode -> cipher -> iv -> Maybe (AEAD cipher)

Initialize a new AEAD State

When Nothing is returns, it means the mode is not handled.

class Cipher cipher => StreamCipher cipher where

Symmetric stream cipher class

Methods

streamCombine :: cipher -> ByteString -> (ByteString, cipher)

Combine using the stream cipher

type DataUnitOffset = Word32

Offset inside an XTS data unit, measured in block size.

data KeySizeSpecifier

Different specifier for key size in bytes

Constructors

KeySizeRange Int Int	in the range [min,max]
KeySizeEnum [Int]	one of the specified values
KeySizeFixed Int	a specific size

Instances

Eq KeySizeSpecifier
Show KeySizeSpecifier

data KeyError

Possible Error that can be reported when initializating a key

Constructors

KeyErrorTooSmall
KeyErrorTooBig
KeyErrorInvalid String

Instances

Eq KeyError
Show KeyError

data AEAD cipher

Authenticated Encryption with Associated Data algorithms

Constructors

AEAD cipher (AEADState cipher)

data AEADState cipher

Wrapper for any AEADState

Constructors

forall st . AEADModeImpl cipher st => AEADState st

data AEADMode

AEAD Mode

Constructors

AEAD_OCB
AEAD_CCM
AEAD_EAX
AEAD_CWC
AEAD_GCM

Instances

Eq AEADMode
Show AEADMode

class BlockCipher cipher => AEADModeImpl cipher state where

Class of AEAD Mode implementation

Methods

aeadStateAppendHeader :: cipher -> state -> ByteString -> state

aeadStateEncrypt :: cipher -> state -> ByteString -> (ByteString, state)

aeadStateDecrypt :: cipher -> state -> ByteString -> (ByteString, state)

aeadStateFinalize :: cipher -> state -> Int -> AuthTag

cfb8Encrypt :: BlockCipher a => a -> IV a -> ByteString -> ByteString

Encrypt using CFB mode in 8 bit output

Effectively turn a Block cipher in CFB mode into a Stream cipher

cfb8Decrypt :: BlockCipher a => a -> IV a -> ByteString -> ByteString

Decrypt using CFB mode in 8 bit output

Effectively turn a Block cipher in CFB mode into a Stream cipher

AEAD functions

aeadAppendHeader :: BlockCipher a => AEAD a -> ByteString -> AEAD a

Append associated data into the AEAD state

aeadEncrypt :: BlockCipher a => AEAD a -> ByteString -> (ByteString, AEAD a)

Encrypt input and append into the AEAD state

aeadDecrypt :: BlockCipher a => AEAD a -> ByteString -> (ByteString, AEAD a)

Decrypt input and append into the AEAD state

aeadFinalize :: BlockCipher a => AEAD a -> Int -> AuthTag

Finalize the AEAD state and create an authentification tag

aeadSimpleEncrypt

Arguments

:: BlockCipher a
=> AEAD a	A new AEAD Context
-> ByteString	Optional Authentified Header
-> ByteString	Optional Plaintext
-> Int	Tag length
-> (AuthTag, ByteString)	Authentification tag and ciphertext

Simple AEAD encryption

aeadSimpleDecrypt

Arguments

:: BlockCipher a
=> AEAD a	A new AEAD Context
-> ByteString	Optional Authentified Header
-> ByteString	Optional Plaintext
-> AuthTag	Tag length
-> Maybe ByteString	Plaintext