Modulecrypton-2.1.7Haskell2010

Crypto.Cipher.Types

Symmetric cipher basic types

Contents

Cipher classes
AEAD functions
Initial Vector type and constructor
Authentification Tag

Synopsis

class Cipher
class BlockCipher
class BlockCipher128
class StreamCipher
type DataUnitOffset
data KeySizeSpecifier
data AEADMode
data CCM_M
data CCM_L
value aeadAppendHeader
value aeadDecrypt
value aeadEncrypt
value aeadFinalize
value aeadSimpleDecrypt
value aeadSimpleEncrypt
value minimumTagLength
value tryAeadSimpleDecrypt
data AEAD
data AEADModeImpl
data IV
value makeIV
value nullIV
value ivAdd
newtype AuthTag

Packagecrypton-2.1.7
Exports24
LanguageHaskell2010
LicenceBSD-3-Clause AND MIT AND ISC
SourceTypes.hs

Cipher classes

classclass Cipher cipher where

Source#

Symmetric cipher class.

Methods

cipherInit :: ByteArray key => key -> CryptoFailable 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

Instances19Cipher, …

Cipher AES128Defined in crypton-2.1.7 · Crypto.Cipher.AES
Cipher AES192Defined in crypton-2.1.7 · Crypto.Cipher.AES
Cipher AES256Defined in crypton-2.1.7 · Crypto.Cipher.AES
Cipher AESDefined in crypton-2.1.7 · Crypto.Cipher.AES.Primitive
Cipher BlowfishDefined in crypton-2.1.7 · Crypto.Cipher.Blowfish
Cipher Blowfish128Defined in crypton-2.1.7 · Crypto.Cipher.Blowfish
Cipher Blowfish256Defined in crypton-2.1.7 · Crypto.Cipher.Blowfish
Cipher Blowfish448Defined in crypton-2.1.7 · Crypto.Cipher.Blowfish
Cipher Blowfish64Defined in crypton-2.1.7 · Crypto.Cipher.Blowfish
Cipher CAST5Defined in crypton-2.1.7 · Crypto.Cipher.CAST5
Cipher Camellia128Defined in crypton-2.1.7 · Crypto.Cipher.Camellia
Cipher DESDefined in crypton-2.1.7 · Crypto.Cipher.DES
Cipher DES_EDE2Defined in crypton-2.1.7 · Crypto.Cipher.TripleDES
Cipher DES_EDE3Defined in crypton-2.1.7 · Crypto.Cipher.TripleDES
Cipher DES_EEE2Defined in crypton-2.1.7 · Crypto.Cipher.TripleDES
Cipher DES_EEE3Defined in crypton-2.1.7 · Crypto.Cipher.TripleDES
Cipher Twofish128Defined in crypton-2.1.7 · Crypto.Cipher.Twofish
Cipher Twofish192Defined in crypton-2.1.7 · Crypto.Cipher.Twofish
Cipher Twofish256Defined in crypton-2.1.7 · Crypto.Cipher.Twofish

classclass Cipher cipher => BlockCipher cipher where

Source#

Symmetric block cipher class

Methods

blockSize :: cipher -> Int
Return the size of block required for this block cipher
ecbEncrypt :: ByteArray ba => cipher -> ba -> ba
Encrypt blocks
the input string need to be multiple of the block size
ecbDecrypt :: ByteArray ba => cipher -> ba -> ba
Decrypt blocks
the input string need to be multiple of the block size
cbcEncrypt :: ByteArray ba => cipher -> IV cipher -> ba -> ba
encrypt using the CBC mode.
input need to be a multiple of the blocksize
cbcDecrypt :: ByteArray ba => cipher -> IV cipher -> ba -> ba
decrypt using the CBC mode.
input need to be a multiple of the blocksize
cfbEncrypt :: ByteArray ba => cipher -> IV cipher -> ba -> ba
encrypt using the CFB mode.
input need to be a multiple of the blocksize
cfbDecrypt :: ByteArray ba => cipher -> IV cipher -> ba -> ba
decrypt using the CFB mode.
input need to be a multiple of the blocksize
ctrCombine :: ByteArray ba => cipher -> IV cipher -> ba -> ba
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
aeadInit :: ByteArrayAccess iv => AEADMode -> cipher -> iv -> CryptoFailable (AEAD cipher)
Initialize a new AEAD State
When Nothing is returns, it means the mode is not handled.

Instances19BlockCipher, …

BlockCipher AES128Defined in crypton-2.1.7 · Crypto.Cipher.AES
BlockCipher AES192Defined in crypton-2.1.7 · Crypto.Cipher.AES
BlockCipher AES256Defined in crypton-2.1.7 · Crypto.Cipher.AES
BlockCipher AESDefined in crypton-2.1.7 · Crypto.Cipher.AES.Primitive
BlockCipher BlowfishDefined in crypton-2.1.7 · Crypto.Cipher.Blowfish
BlockCipher Blowfish128Defined in crypton-2.1.7 · Crypto.Cipher.Blowfish
BlockCipher Blowfish256Defined in crypton-2.1.7 · Crypto.Cipher.Blowfish
BlockCipher Blowfish448Defined in crypton-2.1.7 · Crypto.Cipher.Blowfish
BlockCipher Blowfish64Defined in crypton-2.1.7 · Crypto.Cipher.Blowfish
BlockCipher CAST5Defined in crypton-2.1.7 · Crypto.Cipher.CAST5
BlockCipher Camellia128Defined in crypton-2.1.7 · Crypto.Cipher.Camellia
BlockCipher DESDefined in crypton-2.1.7 · Crypto.Cipher.DES
BlockCipher DES_EDE2Defined in crypton-2.1.7 · Crypto.Cipher.TripleDES
BlockCipher DES_EDE3Defined in crypton-2.1.7 · Crypto.Cipher.TripleDES
BlockCipher DES_EEE2Defined in crypton-2.1.7 · Crypto.Cipher.TripleDES
BlockCipher DES_EEE3Defined in crypton-2.1.7 · Crypto.Cipher.TripleDES
BlockCipher Twofish128Defined in crypton-2.1.7 · Crypto.Cipher.Twofish
BlockCipher Twofish192Defined in crypton-2.1.7 · Crypto.Cipher.Twofish
BlockCipher Twofish256Defined in crypton-2.1.7 · Crypto.Cipher.Twofish

classclass BlockCipher cipher => BlockCipher128 cipher where

Source#

class of block cipher with a 128 bits block size

Methods

xtsEncrypt :: ByteArray ba => (cipher, cipher) -> IV cipher -> DataUnitOffset -> ba -> ba
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 :: ByteArray ba => (cipher, cipher) -> IV cipher -> DataUnitOffset -> ba -> ba
decrypt using the XTS mode.
input need to be a multiple of the blocksize, and the cipher need to process 128 bits block only

Instances4BlockCipher128

BlockCipher128 AES128Defined in crypton-2.1.7 · Crypto.Cipher.AES
BlockCipher128 AES192Defined in crypton-2.1.7 · Crypto.Cipher.AES
BlockCipher128 AES256Defined in crypton-2.1.7 · Crypto.Cipher.AES
BlockCipher128 AESDefined in crypton-2.1.7 · Crypto.Cipher.AES.Primitive

classclass Cipher cipher => StreamCipher cipher where

Source#

Symmetric stream cipher class

Methods

streamCombine :: ByteArray ba => cipher -> ba -> (ba, cipher)
Combine using the stream cipher

typetype DataUnitOffset = Word32

Source#

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

datadata KeySizeSpecifier

Source#

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

Instances2Eq, Show

Eq KeySizeSpecifierDefined in crypton-2.1.7 · Crypto.Cipher.Types.Base
Show KeySizeSpecifierDefined in crypton-2.1.7 · Crypto.Cipher.Types.Base

AEAD functions

datadata AEADMode

Source#

AEAD Mode

Instances2Eq, Show

Eq AEADModeDefined in crypton-2.1.7 · Crypto.Cipher.Types.Base
Show AEADModeDefined in crypton-2.1.7 · Crypto.Cipher.Types.Base

datadata CCM_M

CCM_M4 CCM_M6 CCM_M8 CCM_M10 CCM_M12 CCM_M14 CCM_M16

Instances2Eq, Show

Eq CCM_MDefined in crypton-2.1.7 · Crypto.Cipher.Types.Base
Show CCM_MDefined in crypton-2.1.7 · Crypto.Cipher.Types.Base

datadata CCM_L

CCM_L2 CCM_L3 CCM_L4

Instances2Eq, Show

Eq CCM_LDefined in crypton-2.1.7 · Crypto.Cipher.Types.Base
Show CCM_LDefined in crypton-2.1.7 · Crypto.Cipher.Types.Base

valueaeadAppendHeader :: ByteArrayAccess aad => AEAD cipher -> aad -> AEAD cipher

Source#

Adding associated/additional data to the AEAD context.

valueaeadDecrypt :: ByteArray ba => AEAD cipher -> ba -> (ba, AEAD cipher)

Source#

Decrypting ciphertext and update the AEAD context.

valueaeadEncrypt :: ByteArray ba => AEAD cipher -> ba -> (ba, AEAD cipher)

Source#

Encrypting plaintext and update the AEAD context.

valueaeadFinalize :: AEAD cipher -> Int -> AuthTag

Source#

Finalizing the AEAD context and returning the authentication tag.

valueaeadSimpleDecrypt

:: (ByteArrayAccess aad, ByteArray ba)
=> AEAD a
An AEAD Context
-> aad
Associated/additional data
-> ba
Ciphertext
-> AuthTag
The authentication tag
-> Maybe ba
Plaintext

Source#

Simple AEAD decryptio.

The number of bytes compared is the length of authTag. That is the caller's choice of tag length, so a caller reading a tag off the wire must check its length against the one it expects: passing an attacker-supplied tag straight in lets the attacker pick how much of it is verified. Tags shorter than minimumTagLength are rejected outright.

valueaeadSimpleEncrypt

:: (ByteArrayAccess aad, ByteArray ba)
=> AEAD a
An AEAD Context
-> aad
Associated/additional data
-> ba
Plaintext
-> Int
Tag length
-> (AuthTag, ba)
Authentication tag and ciphertext

Source#

Simple AEAD encryption.

valueminimumTagLength :: Int

Source#

The shortest authentication tag any mode here produces, four bytes (CCM_M4). Modes that truncate their tag -- GCM and OCB3 -- will compute one of whatever length they are asked for, down to nothing, so aeadSimpleDecrypt refuses a shorter tag than this rather than authenticate fewer bytes than any supported mode ever emits.

valuetryAeadSimpleDecrypt

:: (ByteArrayAccess aad, ByteArray ba)
=> AEAD a
An AEAD Context
-> aad
Associated/additional data
-> ba
Ciphertext
-> Int
The tag length to authenticate, which the tag must match
-> AuthTag
The authentication tag
-> Maybe ba
Plaintext

Source#

Simple AEAD decryption with the tag length given by the caller.

aeadSimpleDecrypt authenticates as many octets as the tag it is handed is long. That is the caller's choice only for as long as the tag is: one read off the wire is the peer's, and an attacker who truncates it picks how much of it gets verified, down to minimumTagLength.

Here the length is a separate argument and a tag that is not exactly that long is refused before anything is compared, so the peer cannot weaken the check. Prefer this wherever the tag is attacker reachable.

datadata AEAD cipher

Source#

Algorithm and context for AEAD(Authenticated Encryption with Associated/Additional Data)

Constructors

forall st. AEAD
- aeadModeImpl :: AEADModeImpl st
- aeadState :: !st

datadata AEADModeImpl st

Source#

AEAD Implementation

Constructors

AEADModeImpl
- aeadImplAppendHeader :: forall ba. ByteArrayAccess ba => st -> ba -> st
  Adding associated/additional data to the AEAD context.
- aeadImplEncrypt :: forall ba. ByteArray ba => st -> ba -> (ba, st)
  Encrypiting plaintext and update the AEAD context.
- aeadImplDecrypt :: forall ba. ByteArray ba => st -> ba -> (ba, st)
  Decrypting ciphertext and update the AEAD context.
- aeadImplFinalize :: st -> Int -> AuthTag
  Finalizing the AEAD context and returning the authentication tag.

Initial Vector type and constructor

datadata IV c

Source#

an IV parametrized by the cipher

Instances2Eq, ByteArrayAccess

Eq (IV c)Defined in crypton-2.1.7 · Crypto.Cipher.Types.Block
BlockCipher c => ByteArrayAccess (IV c)Defined in crypton-2.1.7 · Crypto.Cipher.Types.Block