Modulecryptonite-0.30Haskell2010

Crypto.Cipher.Types

Symmetric cipher basic types

9 types
4 classes
9 values

Packagecryptonite-0.30
Exports22
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTypes.hs

Cipher classes

6 declarations

classclass Cipher cipher where

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 cryptonite-0.30 · Crypto.Cipher.AES
Cipher AES192Defined in cryptonite-0.30 · Crypto.Cipher.AES
Cipher AES256Defined in cryptonite-0.30 · Crypto.Cipher.AES
Cipher AESDefined in cryptonite-0.30 · Crypto.Cipher.AES.Primitive
Cipher BlowfishDefined in cryptonite-0.30 · Crypto.Cipher.Blowfish
Cipher Blowfish128Defined in cryptonite-0.30 · Crypto.Cipher.Blowfish
Cipher Blowfish256Defined in cryptonite-0.30 · Crypto.Cipher.Blowfish
Cipher Blowfish448Defined in cryptonite-0.30 · Crypto.Cipher.Blowfish
Cipher Blowfish64Defined in cryptonite-0.30 · Crypto.Cipher.Blowfish
Cipher CAST5Defined in cryptonite-0.30 · Crypto.Cipher.CAST5
Cipher Camellia128Defined in cryptonite-0.30 · Crypto.Cipher.Camellia
Cipher DESDefined in cryptonite-0.30 · Crypto.Cipher.DES
Cipher DES_EDE2Defined in cryptonite-0.30 · Crypto.Cipher.TripleDES
Cipher DES_EDE3Defined in cryptonite-0.30 · Crypto.Cipher.TripleDES
Cipher DES_EEE2Defined in cryptonite-0.30 · Crypto.Cipher.TripleDES
Cipher DES_EEE3Defined in cryptonite-0.30 · Crypto.Cipher.TripleDES
Cipher Twofish128Defined in cryptonite-0.30 · Crypto.Cipher.Twofish
Cipher Twofish192Defined in cryptonite-0.30 · Crypto.Cipher.Twofish
Cipher Twofish256Defined in cryptonite-0.30 · Crypto.Cipher.Twofish

classclass Cipher cipher => BlockCipher cipher where

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 cryptonite-0.30 · Crypto.Cipher.AES
BlockCipher AES192Defined in cryptonite-0.30 · Crypto.Cipher.AES
BlockCipher AES256Defined in cryptonite-0.30 · Crypto.Cipher.AES
BlockCipher AESDefined in cryptonite-0.30 · Crypto.Cipher.AES.Primitive
BlockCipher BlowfishDefined in cryptonite-0.30 · Crypto.Cipher.Blowfish
BlockCipher Blowfish128Defined in cryptonite-0.30 · Crypto.Cipher.Blowfish
BlockCipher Blowfish256Defined in cryptonite-0.30 · Crypto.Cipher.Blowfish
BlockCipher Blowfish448Defined in cryptonite-0.30 · Crypto.Cipher.Blowfish
BlockCipher Blowfish64Defined in cryptonite-0.30 · Crypto.Cipher.Blowfish
BlockCipher CAST5Defined in cryptonite-0.30 · Crypto.Cipher.CAST5
BlockCipher Camellia128Defined in cryptonite-0.30 · Crypto.Cipher.Camellia
BlockCipher DESDefined in cryptonite-0.30 · Crypto.Cipher.DES
BlockCipher DES_EDE2Defined in cryptonite-0.30 · Crypto.Cipher.TripleDES
BlockCipher DES_EDE3Defined in cryptonite-0.30 · Crypto.Cipher.TripleDES
BlockCipher DES_EEE2Defined in cryptonite-0.30 · Crypto.Cipher.TripleDES
BlockCipher DES_EEE3Defined in cryptonite-0.30 · Crypto.Cipher.TripleDES
BlockCipher Twofish128Defined in cryptonite-0.30 · Crypto.Cipher.Twofish
BlockCipher Twofish192Defined in cryptonite-0.30 · Crypto.Cipher.Twofish
BlockCipher Twofish256Defined in cryptonite-0.30 · Crypto.Cipher.Twofish

classclass BlockCipher cipher => BlockCipher128 cipher where

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 cryptonite-0.30 · Crypto.Cipher.AES
BlockCipher128 AES192Defined in cryptonite-0.30 · Crypto.Cipher.AES
BlockCipher128 AES256Defined in cryptonite-0.30 · Crypto.Cipher.AES
BlockCipher128 AESDefined in cryptonite-0.30 · Crypto.Cipher.AES.Primitive

classclass Cipher cipher => StreamCipher cipher where

Symmetric stream cipher class

Methods

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

typetype DataUnitOffset = Word32

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

datadata 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

Instances2Eq, Show

Eq KeySizeSpecifierDefined in cryptonite-0.30 · Crypto.Cipher.Types.Base
Show KeySizeSpecifierDefined in cryptonite-0.30 · Crypto.Cipher.Types.Base

AEAD functions

11 declarations

datadata AEADMode

AEAD Mode

Instances2Eq, Show

Eq AEADModeDefined in cryptonite-0.30 · Crypto.Cipher.Types.Base
Show AEADModeDefined in cryptonite-0.30 · 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 cryptonite-0.30 · Crypto.Cipher.Types.Base
Show CCM_MDefined in cryptonite-0.30 · Crypto.Cipher.Types.Base

datadata CCM_L

CCM_L2 CCM_L3 CCM_L4

Instances2Eq, Show

Eq CCM_LDefined in cryptonite-0.30 · Crypto.Cipher.Types.Base
Show CCM_LDefined in cryptonite-0.30 · Crypto.Cipher.Types.Base

datadata AEAD cipher

Authenticated Encryption with Associated Data algorithms

Constructors

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

datadata AEADModeImpl st

AEAD Implementation

Constructors

AEADModeImpl
- aeadImplAppendHeader :: forall ba. ByteArrayAccess ba => st -> ba -> st
- aeadImplEncrypt :: forall ba. ByteArray ba => st -> ba -> (ba, st)
- aeadImplDecrypt :: forall ba. ByteArray ba => st -> ba -> (ba, st)
- aeadImplFinalize :: st -> Int -> AuthTag

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

Append some header information to an AEAD context

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

Encrypt some data and update the AEAD context

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

Decrypt some data and update the AEAD context

valueaeadFinalize :: AEAD cipher -> Int -> AuthTag

Finalize the AEAD context and return the authentication tag

valueaeadSimpleEncrypt

:: (ByteArrayAccess aad, ByteArray ba)
=> AEAD a
A new AEAD Context
-> aad
Optional Authentication data header
-> ba
Optional Plaintext
-> Int
Tag length
-> (AuthTag, ba)
Authentication tag and ciphertext

Simple AEAD encryption

valueaeadSimpleDecrypt

:: (ByteArrayAccess aad, ByteArray ba)
=> AEAD a
A new AEAD Context
-> aad
Optional Authentication data header
-> ba
Ciphertext
-> AuthTag
The authentication tag
-> Maybe ba
Plaintext

Simple AEAD decryption

Initial Vector type and constructor

4 declarations

datadata IV c

an IV parametrized by the cipher

Instances2Eq, ByteArrayAccess

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

valuemakeIV :: (ByteArrayAccess b, BlockCipher c) => b -> Maybe (IV c)

Create an IV for a specified block cipher

valuenullIV :: BlockCipher c => IV c

Create an IV that is effectively representing the number 0

valueivAdd :: IV c -> Int -> IV c

Increment an IV by a number.

Assume the IV is in Big Endian format.

Authentification Tag

1 declaration

newtypenewtype AuthTag

Authentication Tag for AE cipher mode

Constructors

AuthTag
- unAuthTag :: Bytes

Instances4Eq, Show, NFData, ByteArrayAccess

Eq AuthTagDefined in cryptonite-0.30 · Crypto.Cipher.Types.Base
Show AuthTagDefined in cryptonite-0.30 · Crypto.Cipher.Types.Base
NFData AuthTagDefined in cryptonite-0.30 · Crypto.Cipher.Types.Base
ByteArrayAccess AuthTagDefined in cryptonite-0.30 · Crypto.Cipher.Types.Base