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

Crypto.Cipher.AES

Contents

block cipher data types
IV
Authenticated encryption block cipher types
creation
misc
encryption
decryption

Description

Synopsis

block cipher data types

data AES

AES Context (pre-processed key)

Instances

BlockCipher AES
Cipher AES
AEADModeImpl AES AESGCM

data AES128

AES with 128 bit key

Instances

BlockCipher AES128
Cipher AES128
AEADModeImpl AES128 AESGCM

data AES192

AES with 192 bit key

Instances

BlockCipher AES192
Cipher AES192
AEADModeImpl AES192 AESGCM

data AES256

AES with 256 bit key

Instances

BlockCipher AES256
Cipher AES256
AEADModeImpl AES256 AESGCM

IV

data AESIV

AES IV is always 16 bytes

Instances

Eq AESIV
Show AESIV
Byteable AESIV

aesIV_ :: ByteString -> AESIV

convert a bytestring to an AESIV

Authenticated encryption block cipher types

data AESGCM

AESGCM State

Instances

AEADModeImpl AES256 AESGCM
AEADModeImpl AES192 AESGCM
AEADModeImpl AES128 AESGCM
AEADModeImpl AES AESGCM

creation

initAES :: Byteable b => b -> AES

Initialize a new context with a key

Key need to be of length 16, 24 or 32 bytes. any other values will cause undefined behavior

initKey :: Byteable b => b -> AES

Deprecated: use initAES

misc

genCTR

Arguments

:: Byteable iv
=> AES	Cipher Key.
-> iv	usually a 128 bit integer.
-> Int	length of bytes required.
-> ByteString

generate a counter mode pad. this is generally xor-ed to an input to make the standard counter mode block operations.

if the length requested is not a multiple of the block cipher size, more data will be returned, so that the returned bytestring is a multiple of the block cipher size.

genCounter :: AES -> AESIV -> Int -> (ByteString, AESIV)

generate a counter mode pad. this is generally xor-ed to an input to make the standard counter mode block operations.

if the length requested is not a multiple of the block cipher size, more data will be returned, so that the returned bytestring is a multiple of the block cipher size.

Similiar to genCTR but also return the next IV for continuation

encryption

encryptECB :: AES -> ByteString -> ByteString

encrypt using Electronic Code Book (ECB)

encryptCBC

Arguments

:: Byteable iv
=> AES	AES Context
-> iv	Initial vector of AES block size
-> ByteString	plaintext
-> ByteString	ciphertext

encrypt using Cipher Block Chaining (CBC)

encryptCTR

Arguments

:: Byteable iv
=> AES	AES Context
-> iv	initial vector of AES block size (usually representing a 128 bit integer)
-> ByteString	plaintext input
-> ByteString	ciphertext output

encrypt using Counter mode (CTR)

in CTR mode encryption and decryption is the same operation.

encryptXTS

Arguments

:: Byteable iv
=> (AES, AES)	AES cipher and tweak context
-> iv	a 128 bits IV, typically a sector or a block offset in XTS
-> Word32	number of rounds to skip, also seen a 16 byte offset in the sector or block.
-> ByteString	input to encrypt
-> ByteString	output encrypted

encrypt using XTS

the first key is the normal block encryption key the second key is used for the initial block tweak

encryptGCM

Arguments

:: Byteable iv
=> AES	AES Context
-> iv	IV initial vector of any size
-> ByteString	data to authenticate (AAD)
-> ByteString	data to encrypt
-> (ByteString, AuthTag)	ciphertext and tag

encrypt using Galois counter mode (GCM) return the encrypted bytestring and the tag associated

note: encrypted data is identical to CTR mode in GCM, however a tag is also computed.

encryptOCB

Arguments

:: Byteable iv
=> AES	AES Context
-> iv	IV initial vector of any size
-> ByteString	data to authenticate (AAD)
-> ByteString	data to encrypt
-> (ByteString, AuthTag)	ciphertext and tag

encrypt using OCB v3 return the encrypted bytestring and the tag associated

decryption

decryptECB :: AES -> ByteString -> ByteString

decrypt using Electronic Code Book (ECB)

decryptCBC :: Byteable iv => AES -> iv -> ByteString -> ByteString

decrypt using Cipher block chaining (CBC)

decryptCTR

Arguments

:: Byteable iv
=> AES	AES Context
-> iv	initial vector, usually representing a 128 bit integer
-> ByteString	ciphertext input
-> ByteString	plaintext output

decrypt using Counter mode (CTR).

in CTR mode encryption and decryption is the same operation.

decryptXTS

Arguments

:: Byteable iv
=> (AES, AES)	AES cipher and tweak context
-> iv	a 128 bits IV, typically a sector or a block offset in XTS
-> Word32	number of rounds to skip, also seen a 16 byte offset in the sector or block.
-> ByteString	input to decrypt
-> ByteString	output decrypted

decrypt using XTS

decryptGCM

Arguments

:: Byteable iv
=> AES	Key
-> iv	IV initial vector of any size
-> ByteString	data to authenticate (AAD)
-> ByteString	data to decrypt
-> (ByteString, AuthTag)	plaintext and tag

decrypt using Galois Counter Mode (GCM)

decryptOCB

Arguments

:: Byteable iv
=> AES	Key
-> iv	IV initial vector of any size
-> ByteString	data to authenticate (AAD)
-> ByteString	data to decrypt
-> (ByteString, AuthTag)	plaintext and tag

decrypt using Offset Codebook Mode (OCB)