Botan::Tweakable_Block_Cipher Class Reference

#include <block_cipher.h>

Inheritance diagram for Botan::Tweakable_Block_Cipher:

Public Member Functions
virtual size_t	block_size () const =0
virtual void	clear ()=0
BlockCipher *	clone () const
template<typename Alloc , typename Alloc2 >
void	decrypt (const std::vector< uint8_t, Alloc > &in, std::vector< uint8_t, Alloc2 > &out) const
void	decrypt (const uint8_t in[], uint8_t out[]) const
template<typename Alloc >
void	decrypt (std::vector< uint8_t, Alloc > &block) const
void	decrypt (uint8_t block[]) const
virtual void	decrypt_n (const uint8_t in[], uint8_t out[], size_t blocks) const =0
virtual void	decrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const
template<typename Alloc , typename Alloc2 >
void	encrypt (const std::vector< uint8_t, Alloc > &in, std::vector< uint8_t, Alloc2 > &out) const
void	encrypt (const uint8_t in[], uint8_t out[]) const
template<typename Alloc >
void	encrypt (std::vector< uint8_t, Alloc > &block) const
void	encrypt (uint8_t block[]) const
virtual void	encrypt_n (const uint8_t in[], uint8_t out[], size_t blocks) const =0
virtual void	encrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const
virtual Key_Length_Specification	key_spec () const =0
size_t	maximum_keylength () const
size_t	minimum_keylength () const
virtual std::string	name () const =0
virtual std::unique_ptr< BlockCipher >	new_object () const =0
size_t	parallel_bytes () const
virtual size_t	parallelism () const
virtual std::string	provider () const
template<typename Alloc >
void	set_key (const std::vector< uint8_t, Alloc > &key)
void	set_key (const SymmetricKey &key)
void	set_key (const uint8_t key[], size_t length)
virtual void	set_tweak (const uint8_t tweak[], size_t len)=0
bool	valid_keylength (size_t length) const

Static Public Member Functions
static std::unique_ptr< BlockCipher >	create (const std::string &algo_spec, const std::string &provider="")
static std::unique_ptr< BlockCipher >	create_or_throw (const std::string &algo_spec, const std::string &provider="")
static std::vector< std::string >	providers (const std::string &algo_spec)

Protected Member Functions
void	verify_key_set (bool cond) const

Detailed Description

Tweakable block ciphers allow setting a tweak which is a non-keyed value which affects the encryption/decryption operation.

Definition at line 210 of file block_cipher.h.

Member Function Documentation

block_size()

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

pure virtualinherited

Returns

block size of this algorithm

Implemented in Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD, BaseClass >, Botan::Block_Cipher_Fixed_Params< 16, 16 >, Botan::Block_Cipher_Fixed_Params< 16, 24 >, Botan::Block_Cipher_Fixed_Params< 16, 32 >, Botan::Block_Cipher_Fixed_Params< 8, 1, 56 >, Botan::Block_Cipher_Fixed_Params< 8, 11, 16 >, Botan::Block_Cipher_Fixed_Params< 8, 8 >, Botan::Block_Cipher_Fixed_Params< 8, 32 >, Botan::Block_Cipher_Fixed_Params< 8, 16 >, Botan::Block_Cipher_Fixed_Params< 32, 16, 64, 4 >, Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >, Botan::Block_Cipher_Fixed_Params< 64, 64, 0, 1, Tweakable_Block_Cipher >, Botan::Block_Cipher_Fixed_Params< 8, 16, 24, 8 >, Botan::Cascade_Cipher, and Botan::Lion.

Referenced by Botan::BlockCipher::create(), Botan::nist_key_unwrap(), Botan::nist_key_unwrap_padded(), Botan::nist_key_wrap(), and Botan::nist_key_wrap_padded().

clear()

virtual void Botan::SymmetricAlgorithm::clear ( )

pure virtualinherited

Reset the state.

Implemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::DES, Botan::TripleDES, Botan::GOST_28147_89, Botan::IDEA, Botan::Lion, Botan::Noekeon, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SM4, Botan::Threefish_512, Botan::Twofish, Botan::BLAKE2b, Botan::BLAKE2bMAC, Botan::CMAC, Botan::GMAC, Botan::HMAC, Botan::Poly1305, Botan::SipHash, Botan::ANSI_X919_MAC, Botan::FPE_FE1, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::EAX_Mode, Botan::GCM_Mode, Botan::OCB_Mode, Botan::SIV_Mode, Botan::CBC_Mode, Botan::XTS_Mode, Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, Botan::SHAKE_128_Cipher, Botan::GHASH, Botan::CFB_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.

Referenced by botan_cipher_clear(), botan_mac_clear(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::clear().

clone()

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

inlineinherited

Definition at line 198 of file block_cipher.h.

         {
         return this->new_object().release();
         }

create()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create ( const std::string &  algo_spec, const std::string &  provider = ""  )

staticinherited

Create an instance based on a name If provider is empty then best available is chosen.

Parameters

algo_spec	algorithm name
provider	provider implementation to choose

Returns

a null pointer if the algo/provider combination cannot be found

Definition at line 87 of file block_cipher.cpp.

   {
#if defined(BOTAN_HAS_COMMONCRYPTO)
   if(provider.empty() || provider == "commoncrypto")
      {
      if(auto bc = make_commoncrypto_block_cipher(algo))
         return bc;
 
      if(!provider.empty())
         return nullptr;
      }
#endif
 
   // TODO: CryptoAPI
   // TODO: /dev/crypto
 
   // Only base providers from here on out
   if(provider.empty() == false && provider != "base")
      return nullptr;
 
#if defined(BOTAN_HAS_AES)
   if(algo == "AES-128")
      {
      return std::make_unique<AES_128>();
      }
 
   if(algo == "AES-192")
      {
      return std::make_unique<AES_192>();
      }
 
   if(algo == "AES-256")
      {
      return std::make_unique<AES_256>();
      }
#endif
 
#if defined(BOTAN_HAS_ARIA)
   if(algo == "ARIA-128")
      {
      return std::make_unique<ARIA_128>();
      }
 
   if(algo == "ARIA-192")
      {
      return std::make_unique<ARIA_192>();
      }
 
   if(algo == "ARIA-256")
      {
      return std::make_unique<ARIA_256>();
      }
#endif
 
#if defined(BOTAN_HAS_SERPENT)
   if(algo == "Serpent")
      {
      return std::make_unique<Serpent>();
      }
#endif
 
#if defined(BOTAN_HAS_SHACAL2)
   if(algo == "SHACAL2")
      {
      return std::make_unique<SHACAL2>();
      }
#endif
 
#if defined(BOTAN_HAS_TWOFISH)
   if(algo == "Twofish")
      {
      return std::make_unique<Twofish>();
      }
#endif
 
#if defined(BOTAN_HAS_THREEFISH_512)
   if(algo == "Threefish-512")
      {
      return std::make_unique<Threefish_512>();
      }
#endif
 
#if defined(BOTAN_HAS_BLOWFISH)
   if(algo == "Blowfish")
      {
      return std::make_unique<Blowfish>();
      }
#endif
 
#if defined(BOTAN_HAS_CAMELLIA)
   if(algo == "Camellia-128")
      {
      return std::make_unique<Camellia_128>();
      }
 
   if(algo == "Camellia-192")
      {
      return std::make_unique<Camellia_192>();
      }
 
   if(algo == "Camellia-256")
      {
      return std::make_unique<Camellia_256>();
      }
#endif
 
#if defined(BOTAN_HAS_DES)
   if(algo == "DES")
      {
      return std::make_unique<DES>();
      }
 
   if(algo == "TripleDES" || algo == "3DES" || algo == "DES-EDE")
      {
      return std::make_unique<TripleDES>();
      }
#endif
 
#if defined(BOTAN_HAS_NOEKEON)
   if(algo == "Noekeon")
      {
      return std::make_unique<Noekeon>();
      }
#endif
 
#if defined(BOTAN_HAS_CAST_128)
   if(algo == "CAST-128" || algo == "CAST5")
      {
      return std::make_unique<CAST_128>();
      }
#endif
 
#if defined(BOTAN_HAS_IDEA)
   if(algo == "IDEA")
      {
      return std::make_unique<IDEA>();
      }
#endif
 
#if defined(BOTAN_HAS_SEED)
   if(algo == "SEED")
      {
      return std::make_unique<SEED>();
      }
#endif
 
#if defined(BOTAN_HAS_SM4)
   if(algo == "SM4")
      {
      return std::make_unique<SM4>();
      }
#endif
 
   const SCAN_Name req(algo);
 
#if defined(BOTAN_HAS_GOST_28147_89)
   if(req.algo_name() == "GOST-28147-89")
      {
      return std::make_unique<GOST_28147_89>(req.arg(0, "R3411_94_TestParam"));
      }
#endif
 
#if defined(BOTAN_HAS_CASCADE)
   if(req.algo_name() == "Cascade" && req.arg_count() == 2)
      {
      std::unique_ptr<BlockCipher> c1 = BlockCipher::create(req.arg(0));
      std::unique_ptr<BlockCipher> c2 = BlockCipher::create(req.arg(1));
 
      if(c1 && c2)
         return std::make_unique<Cascade_Cipher>(std::move(c1), std::move(c2));
      }
#endif
 
#if defined(BOTAN_HAS_LION)
   if(req.algo_name() == "Lion" && req.arg_count_between(2, 3))
      {
      std::unique_ptr<HashFunction> hash = HashFunction::create(req.arg(0));
      std::unique_ptr<StreamCipher> stream = StreamCipher::create(req.arg(1));
 
      if(hash && stream)
         {
         const size_t block_size = req.arg_as_integer(2, 1024);
         return std::make_unique<Lion>(std::move(hash), std::move(stream), block_size);
         }
      }
#endif
 
   BOTAN_UNUSED(req);
   BOTAN_UNUSED(provider);
 
   return nullptr;
   }

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), Botan::SCAN_Name::arg_count_between(), Botan::BlockCipher::block_size(), BOTAN_UNUSED, Botan::BlockCipher::create(), Botan::HashFunction::create(), Botan::StreamCipher::create(), hash, Botan::make_commoncrypto_block_cipher(), and Botan::BlockCipher::provider().

Referenced by botan_block_cipher_init(), Botan::AEAD_Mode::create(), Botan::Cipher_Mode::create(), Botan::BlockCipher::create(), Botan::MessageAuthenticationCode::create(), Botan::StreamCipher::create(), and Botan::BlockCipher::create_or_throw().

create_or_throw()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create_or_throw ( const std::string &  algo_spec, const std::string &  provider = ""  )

staticinherited

Create an instance based on a name, or throw if the algo/provider combination cannot be found. If provider is empty then best available is chosen.

Definition at line 283 of file block_cipher.cpp.

   {
   if(auto bc = BlockCipher::create(algo, provider))
      {
      return bc;
      }
   throw Lookup_Error("Block cipher", algo, provider);
   }

References Botan::BlockCipher::create(), and Botan::BlockCipher::provider().

Referenced by Botan::TLS::Connection_Cipher_State::Connection_Cipher_State(), Botan::Encrypted_PSK_Database::Encrypted_PSK_Database(), Botan::rfc3394_keyunwrap(), and Botan::rfc3394_keywrap().

decrypt() [1/4]

template<typename Alloc , typename Alloc2 >

void Botan::BlockCipher::decrypt ( const std::vector< uint8_t, Alloc > &  in, std::vector< uint8_t, Alloc2 > &  out  ) const

inlineinherited

Decrypt one or more blocks

Parameters

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)

Definition at line 149 of file block_cipher.h.

         {
         return decrypt_n(in.data(), out.data(), in.size() / block_size());
         }

decrypt() [2/4]

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

inlineinherited

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 92 of file block_cipher.h.

         { decrypt_n(in, out, 1); }

Referenced by Botan::CTS_Decryption::finish(), Botan::XTS_Decryption::finish(), and Botan::nist_key_unwrap_padded().

decrypt() [3/4]

template<typename Alloc >

void Botan::BlockCipher::decrypt ( std::vector< uint8_t, Alloc > &  block ) const

inlineinherited

Decrypt one or more blocks

Parameters

block

the input/output buffer (multiple of block_size())

Definition at line 126 of file block_cipher.h.

         {
         return decrypt_n(block.data(), block.data(), block.size() / block_size());
         }

decrypt() [4/4]

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

inlineinherited

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 109 of file block_cipher.h.

{ decrypt_n(block, block, 1); }

decrypt_n()

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

pure virtualinherited

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_192, Botan::AES_256, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::DES, Botan::TripleDES, Botan::GOST_28147_89, Botan::IDEA, Botan::Lion, Botan::Noekeon, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SM4, Botan::Threefish_512, and Botan::Twofish.

Referenced by Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD, BaseClass >::decrypt_n_xex(), and Botan::CBC_Decryption::process().

decrypt_n_xex()

virtual void Botan::BlockCipher::decrypt_n_xex ( uint8_t  data[], const uint8_t  mask[], size_t  blocks  ) const

inlinevirtualinherited

Reimplemented in Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD, BaseClass >, Botan::Block_Cipher_Fixed_Params< 16, 16 >, Botan::Block_Cipher_Fixed_Params< 16, 24 >, Botan::Block_Cipher_Fixed_Params< 16, 32 >, Botan::Block_Cipher_Fixed_Params< 8, 1, 56 >, Botan::Block_Cipher_Fixed_Params< 8, 11, 16 >, Botan::Block_Cipher_Fixed_Params< 8, 8 >, Botan::Block_Cipher_Fixed_Params< 8, 32 >, Botan::Block_Cipher_Fixed_Params< 8, 16 >, Botan::Block_Cipher_Fixed_Params< 32, 16, 64, 4 >, Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >, Botan::Block_Cipher_Fixed_Params< 64, 64, 0, 1, Tweakable_Block_Cipher >, and Botan::Block_Cipher_Fixed_Params< 8, 16, 24, 8 >.

Definition at line 183 of file block_cipher.h.

         {
         const size_t BS = block_size();
         xor_buf(data, mask, blocks * BS);
         decrypt_n(data, data, blocks);
         xor_buf(data, mask, blocks * BS);
         }

References Botan::xor_buf().

Referenced by Botan::XTS_Decryption::process().

encrypt() [1/4]

template<typename Alloc , typename Alloc2 >

void Botan::BlockCipher::encrypt ( const std::vector< uint8_t, Alloc > &  in, std::vector< uint8_t, Alloc2 > &  out  ) const

inlineinherited

Encrypt one or more blocks

Parameters

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)

Definition at line 137 of file block_cipher.h.

         {
         return encrypt_n(in.data(), out.data(), in.size() / block_size());
         }

encrypt() [2/4]

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

inlineinherited

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 82 of file block_cipher.h.

         { encrypt_n(in, out, 1); }

Referenced by Botan::CCM_Encryption::finish(), Botan::CCM_Decryption::finish(), Botan::CTS_Encryption::finish(), Botan::XTS_Encryption::finish(), Botan::nist_key_wrap_padded(), Botan::CBC_Encryption::process(), and Botan::CFB_Mode::shift_register().

encrypt() [3/4]

template<typename Alloc >

void Botan::BlockCipher::encrypt ( std::vector< uint8_t, Alloc > &  block ) const

inlineinherited

Encrypt one or more blocks

Parameters

block

the input/output buffer (multiple of block_size())

Definition at line 116 of file block_cipher.h.

         {
         return encrypt_n(block.data(), block.data(), block.size() / block_size());
         }

encrypt() [4/4]

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

inlineinherited

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 101 of file block_cipher.h.

{ encrypt_n(block, block, 1); }

encrypt_n()

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

pure virtualinherited

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_192, Botan::AES_256, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::DES, Botan::TripleDES, Botan::GOST_28147_89, Botan::IDEA, Botan::Lion, Botan::Noekeon, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SM4, Botan::Threefish_512, and Botan::Twofish.

Referenced by Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD, BaseClass >::encrypt_n_xex().

encrypt_n_xex()

virtual void Botan::BlockCipher::encrypt_n_xex ( uint8_t  data[], const uint8_t  mask[], size_t  blocks  ) const

inlinevirtualinherited

Reimplemented in Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD, BaseClass >, Botan::Block_Cipher_Fixed_Params< 16, 16 >, Botan::Block_Cipher_Fixed_Params< 16, 24 >, Botan::Block_Cipher_Fixed_Params< 16, 32 >, Botan::Block_Cipher_Fixed_Params< 8, 1, 56 >, Botan::Block_Cipher_Fixed_Params< 8, 11, 16 >, Botan::Block_Cipher_Fixed_Params< 8, 8 >, Botan::Block_Cipher_Fixed_Params< 8, 32 >, Botan::Block_Cipher_Fixed_Params< 8, 16 >, Botan::Block_Cipher_Fixed_Params< 32, 16, 64, 4 >, Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >, Botan::Block_Cipher_Fixed_Params< 64, 64, 0, 1, Tweakable_Block_Cipher >, and Botan::Block_Cipher_Fixed_Params< 8, 16, 24, 8 >.

Definition at line 173 of file block_cipher.h.

         {
         const size_t BS = block_size();
         xor_buf(data, mask, blocks * BS);
         encrypt_n(data, data, blocks);
         xor_buf(data, mask, blocks * BS);
         }

References Botan::xor_buf().

Referenced by Botan::XTS_Encryption::process().

key_spec()

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

pure virtualinherited

Returns

object describing limits on key size

Implemented in Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD, BaseClass >, Botan::Block_Cipher_Fixed_Params< 16, 16 >, Botan::Block_Cipher_Fixed_Params< 16, 24 >, Botan::Block_Cipher_Fixed_Params< 16, 32 >, Botan::Block_Cipher_Fixed_Params< 8, 1, 56 >, Botan::Block_Cipher_Fixed_Params< 8, 11, 16 >, Botan::Block_Cipher_Fixed_Params< 8, 8 >, Botan::Block_Cipher_Fixed_Params< 8, 32 >, Botan::Block_Cipher_Fixed_Params< 8, 16 >, Botan::Block_Cipher_Fixed_Params< 32, 16, 64, 4 >, Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >, Botan::Block_Cipher_Fixed_Params< 64, 64, 0, 1, Tweakable_Block_Cipher >, Botan::Block_Cipher_Fixed_Params< 8, 16, 24, 8 >, Botan::Cascade_Cipher, Botan::Lion, Botan::BLAKE2b, Botan::BLAKE2bMAC, Botan::CMAC, Botan::GMAC, Botan::HMAC, Botan::Poly1305, Botan::SipHash, Botan::ANSI_X919_MAC, Botan::FPE_FE1, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::EAX_Mode, Botan::GCM_Mode, Botan::OCB_Mode, Botan::SIV_Mode, Botan::CBC_Mode, Botan::XTS_Mode, Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, Botan::SHAKE_128_Cipher, Botan::GHASH, Botan::CFB_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.

Referenced by botan_cipher_get_keyspec(), botan_cipher_query_keylen(), Botan::CBC_Mode::key_spec(), Botan::XTS_Mode::key_spec(), and Botan::CFB_Mode::key_spec().

maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const

inlineinherited

Returns

maximum allowed key length

Definition at line 120 of file sym_algo.h.

         {
         return key_spec().maximum_keylength();
         }

minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const

inlineinherited

Returns

minimum allowed key length

Definition at line 128 of file sym_algo.h.

         {
         return key_spec().minimum_keylength();
         }

Referenced by botan_block_cipher_get_keyspec(), and botan_mac_get_keyspec().

name()

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

pure virtualinherited

Returns

the algorithm name

Implemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::DES, Botan::TripleDES, Botan::GOST_28147_89, Botan::IDEA, Botan::Lion, Botan::Noekeon, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SM4, Botan::Threefish_512, Botan::Twofish, Botan::BLAKE2b, Botan::BLAKE2bMAC, Botan::CMAC, Botan::GMAC, Botan::HMAC, Botan::Poly1305, Botan::SipHash, Botan::ANSI_X919_MAC, Botan::FPE_FE1, Botan::CCM_Mode, Botan::ChaCha20Poly1305_Mode, Botan::OCB_Mode, Botan::SIV_Mode, Botan::CBC_Mode, Botan::XTS_Mode, Botan::ChaCha, Botan::CTR_BE, Botan::OFB, Botan::RC4, Botan::Salsa20, Botan::SHAKE_128_Cipher, Botan::GHASH, Botan::EAX_Mode, Botan::GCM_Mode, Botan::CFB_Mode, and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode.

Referenced by Botan::CBC_Mode::name(), Botan::XTS_Mode::name(), Botan::CFB_Mode::name(), Botan::AEAD_Mode::set_associated_data_n(), Botan::SymmetricAlgorithm::set_key(), and Botan::MessageAuthenticationCode::start_msg().

new_object()

virtual std::unique_ptr< BlockCipher > Botan::BlockCipher::new_object ( ) const

pure virtualinherited

Returns

new object representing the same algorithm as *this

Implemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::DES, Botan::TripleDES, Botan::GOST_28147_89, Botan::IDEA, Botan::Lion, Botan::Noekeon, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SM4, Botan::Threefish_512, and Botan::Twofish.

parallel_bytes()

size_t Botan::BlockCipher::parallel_bytes ( ) const

inlineinherited

Returns

prefererred parallelism of this cipher in bytes

Definition at line 64 of file block_cipher.h.

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

References BOTAN_BLOCK_CIPHER_PAR_MULT.

Referenced by Botan::CBC_Mode::update_granularity().

parallelism()

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

inlinevirtualinherited

Returns

native parallelism of this cipher in blocks

Reimplemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::IDEA, Botan::Noekeon, Botan::Serpent, Botan::SHACAL2, Botan::SM4, and Botan::Threefish_512.

Definition at line 59 of file block_cipher.h.

{ return 1; }

provider()

virtual std::string Botan::BlockCipher::provider ( ) const

inlinevirtualinherited

Returns

provider information about this implementation. Default is "base", might also return "sse2", "avx2", "openssl", or some other arbitrary string.

Reimplemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::IDEA, Botan::Noekeon, Botan::Serpent, Botan::SHACAL2, Botan::SM4, and Botan::Threefish_512.

Definition at line 73 of file block_cipher.h.

{ return "base"; }

Referenced by Botan::BlockCipher::create(), and Botan::BlockCipher::create_or_throw().

providers()

std::vector< std::string > Botan::BlockCipher::providers ( const std::string &  algo_spec )

staticinherited

Returns

list of available providers for this algorithm, empty if not available

Parameters

algo_spec

algorithm name

Definition at line 293 of file block_cipher.cpp.

   {
   return probe_providers_of<BlockCipher>(algo, { "base", "commoncrypto" });
   }

set_key() [1/3]

template<typename Alloc >

void Botan::SymmetricAlgorithm::set_key ( const std::vector< uint8_t, Alloc > &  key )

inlineinherited

Definition at line 153 of file sym_algo.h.

         {
         set_key(key.data(), key.size());
         }

set_key() [2/3]

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 147 of file sym_algo.h.

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

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

Referenced by botan_cipher_set_key(), botan_mac_set_key(), Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::FPE::fe1_decrypt(), Botan::FPE::fe1_encrypt(), and Botan::Sodium::randombytes_buf_deterministic().

set_key() [3/3]

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

inherited

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 17 of file sym_algo.cpp.

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

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

set_tweak()

virtual void Botan::Tweakable_Block_Cipher::set_tweak ( const uint8_t  tweak[], size_t  len  )

pure virtual

Set the tweak value. This must be called after setting a key. The value persists until either set_tweak, set_key, or clear is called. Different algorithms support different tweak length(s). If called with an unsupported length, Invalid_Argument will be thrown.

Implemented in Botan::Threefish_512.

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 138 of file sym_algo.h.

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

Referenced by Botan::SymmetricAlgorithm::set_key().

verify_key_set()

void Botan::SymmetricAlgorithm::verify_key_set ( bool  cond ) const

inlineprotectedinherited

Definition at line 171 of file sym_algo.h.

         {
         if(cond == false)
            throw_key_not_set_error();
         }

Referenced by Botan::ChaCha::cipher(), Botan::CTR_BE::cipher(), Botan::RC4::cipher(), Botan::Salsa20::cipher(), Botan::SHAKE_128_Cipher::cipher(), Botan::AES_128::decrypt_n(), Botan::AES_192::decrypt_n(), Botan::AES_256::decrypt_n(), Botan::ARIA_128::decrypt_n(), Botan::ARIA_192::decrypt_n(), Botan::ARIA_256::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::Camellia_128::decrypt_n(), Botan::Camellia_192::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::DES::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::Lion::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::SEED::decrypt_n(), Botan::Serpent::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::SM4::decrypt_n(), Botan::Threefish_512::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::AES_128::encrypt_n(), Botan::AES_192::encrypt_n(), Botan::AES_256::encrypt_n(), Botan::ARIA_128::encrypt_n(), Botan::ARIA_192::encrypt_n(), Botan::ARIA_256::encrypt_n(), Botan::Blowfish::encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::DES::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::Lion::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::SEED::encrypt_n(), Botan::Serpent::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::SM4::encrypt_n(), Botan::Threefish_512::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::OCB_Encryption::finish(), Botan::OCB_Decryption::finish(), Botan::GHASH::ghash_update(), Botan::CFB_Encryption::process(), Botan::CFB_Decryption::process(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::OCB_Mode::set_associated_data(), Botan::ChaCha::set_iv(), Botan::Salsa20::set_iv(), Botan::GHASH::update(), Botan::GHASH::update_associated_data(), and Botan::ChaCha::write_keystream().

---

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

• src/lib/block/block_cipher.h