Botan.BlockCipher

This is a ‘raw’ interface to ECB mode block ciphers. Most applications want the higher level cipher API which provides authenticated encryption. This API exists as an escape hatch for applications which need to implement custom primitives using a PRP.

Block ciphers

Usage

Idiomatic interface

Data type

data BlockCipher

Constructors

Blowfish

CAST128

DES

TripleDES

GOST_28147_89

IDEA

AES128

AES192

AES256

ARIA128

ARIA192

ARIA256

Camellia128

Camellia192

Camellia256

Noekeon

SEED

Serpent

SM4

Twofish

SHACAL2

Threefish512

Instances

Show BlockCipher

Defined in Botan.BlockCipher

Methods

showsPrec :: Int -> BlockCipher -> ShowS

show :: BlockCipher -> String

showList :: [BlockCipher] -> ShowS

Eq BlockCipher

Cascade BlockCipher BlockCipher | Lion HashSpec StreamCipher Int

Defined in Botan.BlockCipher

Methods

(==) :: BlockCipher -> BlockCipher -> Bool

(/=) :: BlockCipher -> BlockCipher -> Bool

Ord BlockCipher

Defined in Botan.BlockCipher

Methods

compare :: BlockCipher -> BlockCipher -> Ordering

(<) :: BlockCipher -> BlockCipher -> Bool

(<=) :: BlockCipher -> BlockCipher -> Bool

(>) :: BlockCipher -> BlockCipher -> Bool

(>=) :: BlockCipher -> BlockCipher -> Bool

max :: BlockCipher -> BlockCipher -> BlockCipher

min :: BlockCipher -> BlockCipher -> BlockCipher

newtype BlockCipher128

Constructors

MkBlockCipher128

Fields

• unBlockCipher128 :: BlockCipher

Instances

Show BlockCipher128

Defined in Botan.BlockCipher

Methods

showsPrec :: Int -> BlockCipher128 -> ShowS

show :: BlockCipher128 -> String

showList :: [BlockCipher128] -> ShowS

Eq BlockCipher128

Defined in Botan.BlockCipher

Methods

(==) :: BlockCipher128 -> BlockCipher128 -> Bool

(/=) :: BlockCipher128 -> BlockCipher128 -> Bool

Ord BlockCipher128

Defined in Botan.BlockCipher

Methods

compare :: BlockCipher128 -> BlockCipher128 -> Ordering

(<) :: BlockCipher128 -> BlockCipher128 -> Bool

(<=) :: BlockCipher128 -> BlockCipher128 -> Bool

(>) :: BlockCipher128 -> BlockCipher128 -> Bool

(>=) :: BlockCipher128 -> BlockCipher128 -> Bool

max :: BlockCipher128 -> BlockCipher128 -> BlockCipher128

min :: BlockCipher128 -> BlockCipher128 -> BlockCipher128

Enumerations

blockCiphers :: [BlockCipher]

blockCipher128s :: [BlockCipher128]

Associated types

type BlockCipherKeySpec = KeySpec

type BlockCipherKey = ByteString

newBlockCipherKey :: MonadRandomIO m => BlockCipher -> m BlockCipherKey

newBlockCipherKeyMaybe :: MonadRandomIO m => Int -> BlockCipher -> m (Maybe BlockCipherKey)

type BlockCipherText = ByteString

Convenience

type BlockCipher128Key = BlockCipherKey

blockCipher128Name :: BlockCipher128 -> BlockCipherName

blockCipher128KeySpec :: BlockCipher128 -> BlockCipherKeySpec

isBlockCipher128 :: BlockCipher -> Bool

Accessors

blockCipherName :: BlockCipher -> BlockCipherName

blockCipherBlockSize :: BlockCipher -> Int

blockCipherKeySpec :: BlockCipher -> BlockCipherKeySpec

Idiomatic algorithm

blockCipherEncrypt :: BlockCipher -> BlockCipherKey -> ByteString -> Maybe ByteString

blockCipherDecrypt :: BlockCipher -> BlockCipherKey -> ByteString -> Maybe ByteString

blockCipherEncryptLazy :: BlockCipher -> BlockCipherKey -> ByteString -> Maybe ByteString

blockCipherDecryptLazy :: BlockCipher -> BlockCipherKey -> ByteString -> Maybe ByteString

Mutable interface

Tagged mutable context

data MutableBlockCipher

Constructors

MkMutableBlockCipher

Fields

• mutableBlockCipherType :: BlockCipher
• mutableBlockCipherCtx :: BlockCipher

Destructor

destroyBlockCipher :: MonadIO m => MutableBlockCipher -> m ()

Initializers

newBlockCipher :: MonadIO m => BlockCipher -> m MutableBlockCipher

Accessors

getBlockCipherName

Arguments

:: MonadIO m

=> MutableBlockCipher

The cipher object

-> m BlockCipherName

The cipher name

getBlockCipherBlockSize

Arguments

:: MonadIO m

=> MutableBlockCipher

The cipher object

-> m Int

getBlockCipherKeySpec

Arguments

:: MonadIO m

=> MutableBlockCipher

The cipher object

-> m BlockCipherKeySpec

setBlockCipherKey :: MonadIO m => BlockCipherKey -> MutableBlockCipher -> m Bool

Accessory functions

clearBlockCipher :: MonadIO m => MutableBlockCipher -> m ()

Mutable algorithm

encryptBlockCipherBlocks :: MonadIO m => MutableBlockCipher -> ByteString -> m BlockCipherText

decryptBlockCipherBlocks :: MonadIO m => MutableBlockCipher -> BlockCipherText -> m ByteString

autoEncryptBlockCipherBlocks :: MonadIO m => MutableBlockCipher -> BlockCipherKey -> ByteString -> m (Maybe BlockCipherText)

autoDecryptBlockCipherBlocks :: MonadIO m => MutableBlockCipher -> BlockCipherKey -> BlockCipherText -> m (Maybe ByteString)

blowfish :: BlockCipher

cast128 :: BlockCipher

des :: BlockCipher

tripleDES :: BlockCipher

gost_28147_89 :: BlockCipher

idea :: BlockCipher

aes128 :: BlockCipher

aes192 :: BlockCipher

aes256 :: BlockCipher

aria128 :: BlockCipher

aria192 :: BlockCipher

aria256 :: BlockCipher

camellia128 :: BlockCipher

camellia192 :: BlockCipher

camellia256 :: BlockCipher

noekeon :: BlockCipher

seed :: BlockCipher

sm4 :: BlockCipher

serpent :: BlockCipher

twofish :: BlockCipher

shalcal2 :: BlockCipher

threefish512 :: BlockCipher