Botan.Cipher

A block cipher by itself, is only able to securely encrypt a single data block. To be able to securely encrypt data of arbitrary length, a mode of operation applies the block cipher’s single block operation repeatedly to encrypt an entire message.

Thing

Usage

Idiomatic interface

Cipher data type

data Cipher

Constructors

CBC BlockCipher CBCPadding

CFB BlockCipher Int

XTS BlockCipher

ChaCha20Poly1305

GCM BlockCipher128 Int

OCB BlockCipher128 Int

EAX BlockCipher Int

SIV BlockCipher128

CCM BlockCipher128 Int Int

Instances

Show Cipher

Defined in Botan.Cipher

Methods

showsPrec :: Int -> Cipher -> ShowS

show :: Cipher -> String

showList :: [Cipher] -> ShowS

Eq Cipher

Defined in Botan.Cipher

Methods

(==) :: Cipher -> Cipher -> Bool

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

Ord Cipher

Defined in Botan.Cipher

Methods

compare :: Cipher -> Cipher -> Ordering

(<) :: Cipher -> Cipher -> Bool

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

(>) :: Cipher -> Cipher -> Bool

(>=) :: Cipher -> Cipher -> Bool

max :: Cipher -> Cipher -> Cipher

min :: Cipher -> Cipher -> Cipher

AEAD data type

newtype AEAD

Constructors

MkAEAD

Fields

• unAEAD :: Cipher

Instances

Show AEAD

Defined in Botan.Cipher

Methods

showsPrec :: Int -> AEAD -> ShowS

show :: AEAD -> String

showList :: [AEAD] -> ShowS

Eq AEAD

Defined in Botan.Cipher

Methods

(==) :: AEAD -> AEAD -> Bool

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

Ord AEAD

Defined in Botan.Cipher

Methods

compare :: AEAD -> AEAD -> Ordering

(<) :: AEAD -> AEAD -> Bool

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

(>) :: AEAD -> AEAD -> Bool

(>=) :: AEAD -> AEAD -> Bool

max :: AEAD -> AEAD -> AEAD

min :: AEAD -> AEAD -> AEAD

aead :: Cipher -> Maybe AEAD

unsafeAEAD :: Cipher -> AEAD

isAEAD :: Cipher -> Bool

Enumerations

ciphers :: [Cipher]

cbcPaddings :: [CBCPadding]

aeads :: [AEAD]

Associated types

type CipherKey = CipherKey

type CipherNonce = ByteString

data CBCPadding

Constructors

PKCS7

OneAndZeros

X9_23

ESP

CTS

NoPadding

Instances

Show CBCPadding

Defined in Botan.Cipher

Methods

showsPrec :: Int -> CBCPadding -> ShowS

show :: CBCPadding -> String

showList :: [CBCPadding] -> ShowS

Eq CBCPadding

Defined in Botan.Cipher

Methods

(==) :: CBCPadding -> CBCPadding -> Bool

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

Ord CBCPadding

Defined in Botan.Cipher

Methods

compare :: CBCPadding -> CBCPadding -> Ordering

(<) :: CBCPadding -> CBCPadding -> Bool

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

(>) :: CBCPadding -> CBCPadding -> Bool

(>=) :: CBCPadding -> CBCPadding -> Bool

max :: CBCPadding -> CBCPadding -> CBCPadding

min :: CBCPadding -> CBCPadding -> CBCPadding

type AEADAssociatedData = ByteString

Accessors

cipherName :: Cipher -> CipherName

cipherKeySpec :: Cipher -> CipherKeySpec

cipherDefaultNonceSize :: Cipher -> Int

cipherNonceSizeIsValid :: Int -> Cipher -> Bool

cipherTagSize :: Cipher -> Maybe Int

cipherUpdateGranularity :: Cipher -> Int

cipherIdealUpdateGranularity :: Cipher -> Int

cipherOutputLength :: Cipher -> CipherDirection -> Int -> Int

Idiomatic algorithm

cipherEncrypt :: Cipher -> CipherKey -> CipherNonce -> ByteString -> Ciphertext

cipherDecrypt :: Cipher -> CipherKey -> CipherNonce -> Ciphertext -> Maybe ByteString

cipherEncryptLazy :: Cipher -> CipherKey -> CipherNonce -> ByteString -> LazyCiphertext

cipherDecryptLazy :: Cipher -> CipherKey -> CipherNonce -> LazyCiphertext -> Maybe ByteString

aeadEncrypt :: AEAD -> CipherKey -> CipherNonce -> AEADAssociatedData -> ByteString -> Ciphertext

aeadDecrypt :: AEAD -> CipherKey -> CipherNonce -> AEADAssociatedData -> Ciphertext -> Maybe ByteString

Mutable interface

Tagged mutable context

data MutableCipher

Constructors

MkMutableCipher

Fields

• mutableCipherType :: Cipher
• mutableCipherDirection :: CipherDirection
• mutableCipherCtx :: Cipher

Destructor

destroyCipher :: MonadIO m => MutableCipher -> m ()

Associated types

data CipherDirection

Constructors

CipherEncrypt

CipherDecrypt

Instances

Show CipherDirection

Defined in Botan.Cipher

Methods

showsPrec :: Int -> CipherDirection -> ShowS

show :: CipherDirection -> String

showList :: [CipherDirection] -> ShowS

Eq CipherDirection

Defined in Botan.Cipher

Methods

(==) :: CipherDirection -> CipherDirection -> Bool

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

Ord CipherDirection

Defined in Botan.Cipher

Methods

compare :: CipherDirection -> CipherDirection -> Ordering

(<) :: CipherDirection -> CipherDirection -> Bool

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

(>) :: CipherDirection -> CipherDirection -> Bool

(>=) :: CipherDirection -> CipherDirection -> Bool

max :: CipherDirection -> CipherDirection -> CipherDirection

min :: CipherDirection -> CipherDirection -> CipherDirection

data CipherUpdate

Constructors

CipherUpdate

CipherFinal

Instances

Show CipherUpdate

Defined in Botan.Cipher

Methods

showsPrec :: Int -> CipherUpdate -> ShowS

show :: CipherUpdate -> String

showList :: [CipherUpdate] -> ShowS

Eq CipherUpdate

Defined in Botan.Cipher

Methods

(==) :: CipherUpdate -> CipherUpdate -> Bool

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

Ord CipherUpdate

Defined in Botan.Cipher

Methods

compare :: CipherUpdate -> CipherUpdate -> Ordering

(<) :: CipherUpdate -> CipherUpdate -> Bool

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

(>) :: CipherUpdate -> CipherUpdate -> Bool

(>=) :: CipherUpdate -> CipherUpdate -> Bool

max :: CipherUpdate -> CipherUpdate -> CipherUpdate

min :: CipherUpdate -> CipherUpdate -> CipherUpdate

Initializers

newCipher :: MonadIO m => Cipher -> CipherDirection -> m MutableCipher

Accessors

getCipherName :: MonadIO m => MutableCipher -> m ByteString

getCipherKeySpec :: MonadIO m => MutableCipher -> m CipherKeySpec

getCipherDefaultNonceSize :: MonadIO m => MutableCipher -> m Int

getCipherNonceSizeIsValid :: MonadIO m => MutableCipher -> Int -> m Bool

getCipherTagSize :: MonadIO m => MutableCipher -> m Int

getCipherUpdateGranularity :: MonadIO m => MutableCipher -> m Int

getCipherIdealUpdateGranularity :: MonadIO m => MutableCipher -> m Int

getCipherEstimateOutputLength :: MonadIO m => MutableCipher -> Int -> m Int

getCipherOutputLength :: MonadIO m => MutableCipher -> Int -> m Int

Warning: Needs to be confirmed accurate, use getCipherEstimateOutputLength

setCipherKey :: MonadIO m => MutableCipher -> CipherKey -> m ()

setAEADAssociatedData :: MonadIO m => MutableCipher -> ByteString -> m ()

Accessory functions

clearCipher :: MonadIO m => MutableCipher -> m ()

resetCipher :: MonadIO m => MutableCipher -> m ()

Mutable algorithm

startCipher :: MonadIO m => MutableCipher -> CipherNonce -> m ()

updateCipher :: MonadIO m => MutableCipher -> ByteString -> m (Int, ByteString)

finalizeCipher :: MonadIO m => MutableCipher -> ByteString -> m ByteString

finalizeResetCipher :: MonadIO m => MutableCipher -> ByteString -> m ByteString

finalizeClearCipher :: MonadIO m => MutableCipher -> ByteString -> m ByteString

Algorithm references

cbc :: BlockCipher -> Cipher

cbcWith :: BlockCipher -> CBCPadding -> Cipher

cfb :: BlockCipher -> Cipher

cfbWith :: BlockCipher -> Int -> Cipher

xts :: BlockCipher -> Cipher

chaCha20Poly1305 :: Cipher

gcm :: BlockCipher128 -> Cipher

gcmWith :: BlockCipher128 -> Int -> Cipher

ocb :: BlockCipher128 -> Cipher

ocbWith :: BlockCipher128 -> Int -> Cipher

eax :: BlockCipher -> Cipher

eaxWith :: BlockCipher -> Int -> Cipher

siv :: BlockCipher128 -> Cipher

ccm :: BlockCipher128 -> Cipher

ccmWith :: BlockCipher128 -> Int -> Int -> Cipher