#include <block_cipher.h>

Inheritance diagram for Botan::BlockCipher:

Public Member Functions
virtual size_t	block_size () const =0
virtual void	clear ()=0
virtual BlockCipher *	clone () const =0
void	decrypt (byte block[]) const
void	decrypt (const byte in[], byte out[]) const
virtual void	decrypt_n (const byte in[], byte out[], size_t blocks) const =0
void	encrypt (byte block[]) const
void	encrypt (const byte in[], byte out[]) const
virtual void	encrypt_n (const byte in[], byte out[], size_t blocks) const =0
virtual Key_Length_Specification	key_spec () const =0
size_t	maximum_keylength () const
size_t	minimum_keylength () const
virtual std::string	name () const =0
size_t	parallel_bytes () const
virtual size_t	parallelism () const
void	set_key (const byte key[], size_t length)
void	set_key (const SymmetricKey &key)
bool	valid_keylength (size_t length) const

Detailed Description

This class represents a block cipher object.

Definition at line 18 of file block_cipher.h.

Member Function Documentation

◆ block_size()

virtual size_t Botan::BlockCipher::block_size ( ) const

pure virtual

Returns: block size of this algorithm

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::Cascade_Cipher::Cascade_Cipher(), Botan::CFB_Decryption::CFB_Decryption(), Botan::CFB_Decryption::CFB_Decryption(), Botan::CFB_Encryption::CFB_Encryption(), Botan::CFB_Encryption::CFB_Encryption(), Botan::get_cipher_mode(), and parallel_bytes().

◆ clear()

virtual void Botan::Algorithm::clear ( )

pure virtualinherited

Zeroize internal state

Implemented in Botan::Adler32, Botan::AES_128, Botan::AES_128_NI, Botan::AES_128_SSSE3, Botan::AES_192, Botan::AES_192_NI, Botan::AES_192_SSSE3, Botan::AES_256, Botan::AES_256_NI, Botan::AES_256_SSSE3, Botan::ANSI_X919_MAC, Botan::ARC4, Botan::Blowfish, Botan::BMW_512, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CAST_256, Botan::CBC_MAC, Botan::CMAC, Botan::Comb4P, Botan::CRC24, Botan::CRC32, Botan::CTR_BE, Botan::DES, Botan::DESX, Botan::GOST_28147_89, Botan::GOST_34_11, Botan::HAS_160, Botan::HMAC, Botan::IDEA, Botan::KASUMI, Botan::KDF, Botan::Keccak_1600, Botan::Lion, Botan::LubyRackoff, Botan::MARS, Botan::MD2, Botan::MD4, Botan::MD5, Botan::MDx_HashFunction, Botan::MISTY1, Botan::Noekeon, Botan::OFB, Botan::Parallel, Botan::PBKDF, Botan::RC2, Botan::RIPEMD_128, Botan::RIPEMD_160, Botan::SAFER_SK, Botan::Salsa20, Botan::SEED, Botan::Serpent, Botan::SHA_160, Botan::SHA_224, Botan::SHA_256, Botan::SHA_384, Botan::SHA_512, Botan::Skein_512, Botan::Skipjack, Botan::Square, Botan::SSL3_MAC, Botan::TEA, Botan::Tiger, Botan::TripleDES, Botan::Turing, Botan::Twofish, Botan::Whirlpool, Botan::WiderWake_41_BE, and Botan::XTEA.

◆ clone()

virtual BlockCipher * Botan::BlockCipher::clone ( ) const

pure virtual

Get a new object representing the same algorithm as *this

Implemented in Botan::AES_128, Botan::AES_128_NI, Botan::AES_128_SSSE3, Botan::AES_192, Botan::AES_192_NI, Botan::AES_192_SSSE3, Botan::AES_256, Botan::AES_256_NI, Botan::AES_256_SSSE3, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CAST_256, Botan::DES, Botan::DESX, Botan::GOST_28147_89, Botan::IDEA, Botan::IDEA_SSE2, Botan::KASUMI, Botan::Lion, Botan::LubyRackoff, Botan::MARS, Botan::MISTY1, Botan::Noekeon, Botan::Noekeon_SIMD, Botan::RC2, Botan::SAFER_SK, Botan::SEED, Botan::Serpent, Botan::Serpent_SIMD, Botan::Serpent_X86_32, Botan::Skipjack, Botan::Square, Botan::TEA, Botan::TripleDES, Botan::Twofish, Botan::XTEA, and Botan::XTEA_SIMD.

Referenced by Botan::EAX_Base::EAX_Base(), Botan::Core_Engine::find_block_cipher(), Botan::get_cipher_mode(), Botan::get_pbe(), Botan::get_pbe(), Botan::Algorithm_Factory::make_block_cipher(), Botan::XTS_Decryption::XTS_Decryption(), and Botan::XTS_Decryption::XTS_Decryption().

◆ decrypt() [1/2]

void Botan::BlockCipher::decrypt ( byte block[] ) const

inline

Decrypt a block.

Parameters

block the ciphertext block to be decrypted Must be of length block_size(). Will hold the result when the function has finished.

Definition at line 74 of file block_cipher.h.

74{ decrypt_n(block, block, 1); }

Botan::BlockCipher::decrypt_n

virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0

References decrypt_n().

◆ decrypt() [2/2]

void Botan::BlockCipher::decrypt	(	const byte	in[],
		byte	out[] ) const

inline

Decrypt a block.

Parameters

in	The ciphertext block to be decypted as a byte array. Must be of length block_size().
out	The byte array designated to hold the decrypted block. Must be of length block_size().

Definition at line 57 of file block_cipher.h.

58 { decrypt_n(in, out, 1); }

References decrypt_n().

◆ decrypt_n()

virtual void Botan::BlockCipher::decrypt_n	(	const byte	in[],
		byte	out[],
		size_t	blocks ) const

pure virtual

Decrypt one or more blocks

Parameters

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)
blocks	the number of blocks to process

Implemented in Botan::AES_128, Botan::AES_128_NI, Botan::AES_128_SSSE3, Botan::AES_192, Botan::AES_192_NI, Botan::AES_192_SSSE3, Botan::AES_256, Botan::AES_256_NI, Botan::AES_256_SSSE3, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CAST_256, Botan::DES, Botan::DESX, Botan::GOST_28147_89, Botan::IDEA, Botan::IDEA_SSE2, Botan::KASUMI, Botan::Lion, Botan::LubyRackoff, Botan::MARS, Botan::MISTY1, Botan::Noekeon, Botan::Noekeon_SIMD, Botan::RC2, Botan::SAFER_SK, Botan::SEED, Botan::Serpent, Botan::Serpent_SIMD, Botan::Serpent_X86_32, Botan::Skipjack, Botan::Square, Botan::TEA, Botan::TripleDES, Botan::Twofish, Botan::XTEA, and Botan::XTEA_SIMD.

Referenced by decrypt(), and decrypt().

◆ encrypt() [1/2]

void Botan::BlockCipher::encrypt ( byte block[] ) const

inline

Encrypt a block.

Parameters

block the plaintext block to be encrypted Must be of length block_size(). Will hold the result when the function has finished.

Definition at line 66 of file block_cipher.h.

66{ encrypt_n(block, block, 1); }

Botan::BlockCipher::encrypt_n

virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0

References encrypt_n().

◆ encrypt() [2/2]

void Botan::BlockCipher::encrypt	(	const byte	in[],
		byte	out[] ) const

inline

Encrypt a block.

Parameters

in	The plaintext block to be encrypted as a byte array. Must be of length block_size().
out	The byte array designated to hold the encrypted block. Must be of length block_size().

Definition at line 47 of file block_cipher.h.

48 { encrypt_n(in, out, 1); }

References encrypt_n().

Referenced by Botan::aont_package(), and Botan::aont_unpackage().

◆ encrypt_n()

virtual void Botan::BlockCipher::encrypt_n	(	const byte	in[],
		byte	out[],
		size_t	blocks ) const

pure virtual

Encrypt one or more blocks

Parameters

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)
blocks	the number of blocks to process

Implemented in Botan::AES_128, Botan::AES_128_NI, Botan::AES_128_SSSE3, Botan::AES_192, Botan::AES_192_NI, Botan::AES_192_SSSE3, Botan::AES_256, Botan::AES_256_NI, Botan::AES_256_SSSE3, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CAST_256, Botan::DES, Botan::DESX, Botan::GOST_28147_89, Botan::IDEA, Botan::IDEA_SSE2, Botan::KASUMI, Botan::Lion, Botan::LubyRackoff, Botan::MARS, Botan::MISTY1, Botan::Noekeon, Botan::Noekeon_SIMD, Botan::RC2, Botan::SAFER_SK, Botan::SEED, Botan::Serpent, Botan::Serpent_SIMD, Botan::Serpent_X86_32, Botan::Skipjack, Botan::Square, Botan::TEA, Botan::TripleDES, Botan::Twofish, Botan::XTEA, and Botan::XTEA_SIMD.

Referenced by encrypt(), and encrypt().

◆ key_spec()

virtual Key_Length_Specification Botan::SymmetricAlgorithm::key_spec ( ) const

pure virtualinherited

Returns: object describing limits on key size

Referenced by maximum_keylength(), minimum_keylength(), and valid_keylength().

◆ maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const

inlineinherited

Returns: minimum allowed key length

Definition at line 33 of file sym_algo.h.

         {
         return key_spec().maximum_keylength();
         }

References key_spec().

◆ minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const

inlineinherited

Returns: maxmium allowed key length

Definition at line 41 of file sym_algo.h.

         {
         return key_spec().minimum_keylength();
         }

References key_spec().

◆ name()

virtual std::string Botan::Algorithm::name ( ) const

pure virtualinherited

Returns: name of this algorithm

Implemented in Botan::Adler32, Botan::AES_128, Botan::AES_128_NI, Botan::AES_128_SSSE3, Botan::AES_192, Botan::AES_192_NI, Botan::AES_192_SSSE3, Botan::AES_256, Botan::AES_256_NI, Botan::AES_256_SSSE3, Botan::ANSI_X919_MAC, Botan::ARC4, Botan::Blowfish, Botan::BMW_512, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CAST_256, Botan::CBC_MAC, Botan::CMAC, Botan::Comb4P, Botan::CRC24, Botan::CRC32, Botan::CTR_BE, Botan::DES, Botan::DESX, Botan::GOST_28147_89, Botan::GOST_34_11, Botan::HAS_160, Botan::HMAC, Botan::IDEA, Botan::KASUMI, Botan::KDF1, Botan::KDF2, Botan::Keccak_1600, Botan::Lion, Botan::LubyRackoff, Botan::MARS, Botan::MD2, Botan::MD4, Botan::MD5, Botan::MessageAuthenticationCode, Botan::MISTY1, Botan::Noekeon, Botan::OFB, Botan::OpenPGP_S2K, Botan::Parallel, Botan::PKCS5_PBKDF1, Botan::PKCS5_PBKDF2, Botan::RC2, Botan::RIPEMD_128, Botan::RIPEMD_160, Botan::SAFER_SK, Botan::Salsa20, Botan::SEED, Botan::Serpent, Botan::SHA_160, Botan::SHA_224, Botan::SHA_256, Botan::SHA_384, Botan::SHA_512, Botan::Skein_512, Botan::Skipjack, Botan::Square, Botan::SSL3_MAC, Botan::SSL3_PRF, Botan::TEA, Botan::Tiger, Botan::TLS_12_PRF, Botan::TLS_PRF, Botan::TripleDES, Botan::Turing, Botan::Twofish, Botan::Whirlpool, Botan::WiderWake_41_BE, Botan::X942_PRF, and Botan::XTEA.

Referenced by Botan::Algorithm_Factory::add_block_cipher(), Botan::Algorithm_Factory::add_hash_function(), Botan::Algorithm_Factory::add_pbkdf(), Botan::Algorithm_Factory::add_stream_cipher(), Botan::choose_sig_format(), Botan::PBE_PKCS5v15::PBE_PKCS5v15(), Botan::PBE_PKCS5v20::PBE_PKCS5v20(), Botan::StreamCipher::set_iv(), and Botan::SymmetricAlgorithm::set_key().

◆ parallel_bytes()

size_t Botan::BlockCipher::parallel_bytes ( ) const

inline

Returns: prefererred parallelism of this cipher in bytes

Definition at line 35 of file block_cipher.h.

         {
         return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
         }

References block_size(), and parallelism().

◆ parallelism()

virtual size_t Botan::BlockCipher::parallelism ( ) const

inlinevirtual

Returns: native parallelism of this cipher in blocks

Reimplemented in Botan::AES_128_NI, Botan::AES_192_NI, Botan::AES_256_NI, Botan::IDEA_SSE2, Botan::Noekeon_SIMD, Botan::Serpent_SIMD, and Botan::XTEA_SIMD.

Definition at line 30 of file block_cipher.h.

30{ return 1; }

Referenced by parallel_bytes().

◆ set_key() [1/2]

void Botan::SymmetricAlgorithm::set_key	(	const byte	key[],
		size_t	length )

inlineinherited

Set the symmetric key of this object.

Parameters

key	the to be set as a byte array.
length	in bytes of key param

Definition at line 68 of file sym_algo.h.

         {
         if(!valid_keylength(length))
            throw Invalid_Key_Length(name(), length);
         key_schedule(key, length);
         }

References Botan::Algorithm::name(), and valid_keylength().

◆ set_key() [2/2]

void Botan::SymmetricAlgorithm::set_key ( const SymmetricKey & key )

inlineinherited

Set the symmetric key of this object.

Parameters

key	the SymmetricKey to be set.

Definition at line 60 of file sym_algo.h.

61 { set_key(key.begin(), key.length()); }

Botan::SymmetricAlgorithm::set_key

void set_key(const SymmetricKey &key)

Definition sym_algo.h:60

References Botan::OctetString::begin(), Botan::OctetString::length(), and set_key().

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::MAC_Filter::MAC_Filter(), Botan::MAC_Filter::MAC_Filter(), Botan::EAX_Base::set_key(), set_key(), Botan::Record_Reader::set_keys(), Botan::Record_Writer::set_keys(), Botan::StreamCipher_Filter::StreamCipher_Filter(), and Botan::StreamCipher_Filter::StreamCipher_Filter().

◆ valid_keylength()

bool Botan::SymmetricAlgorithm::valid_keylength ( size_t length ) const

inlineinherited

Check whether a given key length is valid for this algorithm.

Parameters

length the key length to be checked.

Returns: true if the key length is valid.

Definition at line 51 of file sym_algo.h.

         {
         return key_spec().valid_keylength(length);
         }

References key_spec().

Referenced by Botan::aont_package(), Botan::aont_unpackage(), set_key(), and Botan::EAX_Base::valid_keylength().

The documentation for this class was generated from the following file:

src/block/block_cipher.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ block_size()

◆ clear()

◆ clone()

◆ decrypt() [1/2]

◆ decrypt() [2/2]

◆ decrypt_n()

◆ encrypt() [1/2]

◆ encrypt() [2/2]

◆ encrypt_n()

◆ key_spec()

◆ maximum_keylength()

◆ minimum_keylength()

◆ name()

◆ parallel_bytes()

◆ parallelism()

◆ set_key() [1/2]

◆ set_key() [2/2]

◆ valid_keylength()