#include <block_cipher.h>

Inheritance diagram for Botan::BlockCipher:

Public Member Functions
virtual size_t	block_size () const =0

virtual void	clear ()=0

BlockCipher *	clone () const

void	decrypt (const uint8_t in[], uint8_t out[]) const

void	decrypt (std::span< const uint8_t > in, std::span< uint8_t > out) const

void	decrypt (std::span< uint8_t > block) const

void	decrypt (uint8_t block[]) const

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

void	decrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const

void	encrypt (const uint8_t in[], uint8_t out[]) const

void	encrypt (std::span< const uint8_t > in, std::span< uint8_t > out) const

void	encrypt (std::span< uint8_t > block) const

void	encrypt (uint8_t block[]) const

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

void	encrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const

virtual bool	has_keying_material () 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

virtual std::unique_ptr< BlockCipher >	new_object () const =0

size_t	parallel_bytes () const

virtual size_t	parallelism () const

virtual std::string	provider () const

void	set_key (const OctetString &key)

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

void	set_key (std::span< const uint8_t > key)

bool	valid_keylength (size_t length) const

	~BlockCipher () override=default

Static Public Member Functions
static std::unique_ptr< BlockCipher >	create (std::string_view algo_spec, std::string_view provider="")

static std::unique_ptr< BlockCipher >	create_or_throw (std::string_view algo_spec, std::string_view provider="")

static std::vector< std::string >	providers (std::string_view algo_spec)

Static Public Attributes
static constexpr size_t	ParallelismMult = 4

Protected Member Functions
void	assert_key_material_set () const

void	assert_key_material_set (bool predicate) const

Detailed Description

This class represents a block cipher object.

Definition at line 22 of file block_cipher.h.

Constructor & Destructor Documentation

◆ ~BlockCipher()

Botan::BlockCipher::~BlockCipher ( )

overridedefault

Member Function Documentation

◆ assert_key_material_set() [1/2]

void Botan::SymmetricAlgorithm::assert_key_material_set ( ) const

inlineprotectedinherited

Definition at line 141 of file sym_algo.h.

141{ assert_key_material_set(has_keying_material()); }

Botan::SymmetricAlgorithm::has_keying_material

virtual bool has_keying_material() const =0

Botan::SymmetricAlgorithm::assert_key_material_set

void assert_key_material_set() const

Definition sym_algo.h:141

References assert_key_material_set(), and has_keying_material().

Referenced by assert_key_material_set(), Botan::Salsa20::cipher_bytes(), Botan::Lion::decrypt_n(), Botan::Lion::encrypt_n(), Botan::GHASH::final(), Botan::GHASH::nonce_hash(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::GHASH::set_associated_data(), Botan::OCB_Mode::set_associated_data_n(), Botan::Salsa20::set_iv_bytes(), Botan::GHASH::update(), and Botan::GHASH::update_associated_data().

◆ assert_key_material_set() [2/2]

void Botan::SymmetricAlgorithm::assert_key_material_set ( bool predicate ) const

inlineprotectedinherited

Definition at line 143 of file sym_algo.h.

                                                         {
         if(!predicate) {
            throw_key_not_set_error();
         }
      }

◆ block_size()

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

pure virtual

Returns: block size of this algorithm

Referenced by create(), decrypt(), decrypt(), decrypt_n_xex(), encrypt(), encrypt(), encrypt_n_xex(), Botan::nist_key_unwrap(), Botan::nist_key_unwrap_padded(), Botan::nist_key_wrap(), Botan::nist_key_wrap_padded(), parallel_bytes(), and Botan::CBC_Mode::update_granularity().

◆ clear()

virtual void Botan::SymmetricAlgorithm::clear ( )

pure virtualinherited

Reset the internal state. This includes not just the key, but any partial message that may have been in process.

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

Referenced by Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::clear().

◆ clone()

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

inline

Definition at line 188 of file block_cipher.h.

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

Botan::BlockCipher::new_object

virtual std::unique_ptr< BlockCipher > new_object() const =0

References new_object().

◆ create()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create	(	std::string_view	algo_spec,
		std::string_view	provider = "" )

static

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 92 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_KUZNYECHIK)
   if(algo == "Kuznyechik") {
      return std::make_unique<Kuznyechik>();
   }
#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) {
      auto c1 = BlockCipher::create(req.arg(0));
      auto 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)) {
      auto hash = HashFunction::create(req.arg(0));
      auto 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(), block_size(), BOTAN_UNUSED, create(), Botan::HashFunction::create(), Botan::StreamCipher::create(), Botan::make_commoncrypto_block_cipher(), and provider().

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

◆ create_or_throw()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create_or_throw	(	std::string_view	algo_spec,
		std::string_view	provider = "" )

static

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 267 of file block_cipher.cpp.

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

References create(), and provider().

Referenced by botan_nist_kw_dec(), botan_nist_kw_enc(), 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]

void Botan::BlockCipher::decrypt	(	const uint8_t	in[],
		uint8_t	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 91 of file block_cipher.h.

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

Botan::BlockCipher::decrypt_n

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

References decrypt_n().

Referenced by Botan::nist_key_unwrap(), and Botan::nist_key_unwrap_padded().

◆ decrypt() [2/4]

void Botan::BlockCipher::decrypt	(	std::span< const uint8_t >	in,
		std::span< uint8_t >	out ) const

inline

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

139 {

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

141 }

References block_size(), and decrypt_n().

◆ decrypt() [3/4]

void Botan::BlockCipher::decrypt ( std::span< uint8_t > block ) const

inline

Decrypt one or more blocks

Parameters

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

Definition at line 121 of file block_cipher.h.

121 {

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

123 }

References block_size(), and decrypt_n().

◆ decrypt() [4/4]

void Botan::BlockCipher::decrypt ( uint8_t 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 107 of file block_cipher.h.

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

References decrypt_n().

◆ decrypt_n()

virtual void Botan::BlockCipher::decrypt_n	(	const uint8_t	in[],
		uint8_t	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_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::GOST_28147_89, Botan::IDEA, Botan::Kuznyechik, Botan::Lion, Botan::Noekeon, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SM4, Botan::Threefish_512, Botan::TripleDES, and Botan::Twofish.

Referenced by decrypt(), decrypt(), decrypt(), decrypt(), and decrypt_n_xex().

◆ decrypt_n_xex()

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

inline

Definition at line 172 of file block_cipher.h.

                                                                                    {
         const size_t BS = block_size();
         for(size_t i = 0; i != blocks * BS; ++i) {
            data[i] ^= mask[i];
         }
         decrypt_n(data, data, blocks);
         for(size_t i = 0; i != blocks * BS; ++i) {
            data[i] ^= mask[i];
         }
      }

References block_size(), decrypt_n(), and decrypt_n_xex().

Referenced by decrypt_n_xex().

◆ encrypt() [1/4]

void Botan::BlockCipher::encrypt	(	const uint8_t	in[],
		uint8_t	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 82 of file block_cipher.h.

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

Botan::BlockCipher::encrypt_n

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

References encrypt_n().

Referenced by Botan::nist_key_wrap(), Botan::nist_key_wrap_padded(), and Botan::CFB_Mode::shift_register().

◆ encrypt() [2/4]

void Botan::BlockCipher::encrypt	(	std::span< const uint8_t >	in,
		std::span< uint8_t >	out ) const

inline

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

130 {

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

132 }

References block_size(), and encrypt_n().

◆ encrypt() [3/4]

void Botan::BlockCipher::encrypt ( std::span< uint8_t > block ) const

inline

Encrypt one or more blocks

Parameters

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

Definition at line 113 of file block_cipher.h.

113 {

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

115 }

References block_size(), and encrypt_n().

◆ encrypt() [4/4]

void Botan::BlockCipher::encrypt ( uint8_t 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 99 of file block_cipher.h.

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

References encrypt_n().

◆ encrypt_n()

virtual void Botan::BlockCipher::encrypt_n	(	const uint8_t	in[],
		uint8_t	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_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::GOST_28147_89, Botan::IDEA, Botan::Kuznyechik, Botan::Lion, Botan::Noekeon, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SM4, Botan::Threefish_512, Botan::TripleDES, and Botan::Twofish.

Referenced by encrypt(), encrypt(), encrypt(), encrypt(), and encrypt_n_xex().

◆ encrypt_n_xex()

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

inline

Definition at line 160 of file block_cipher.h.

                                                                                    {
         const size_t BS = block_size();
         for(size_t i = 0; i != blocks * BS; ++i) {
            data[i] ^= mask[i];
         }
         encrypt_n(data, data, blocks);
         for(size_t i = 0; i != blocks * BS; ++i) {
            data[i] ^= mask[i];
         }
      }

References block_size(), encrypt_n(), and encrypt_n_xex().

Referenced by encrypt_n_xex().

◆ has_keying_material()

virtual bool Botan::SymmetricAlgorithm::has_keying_material ( ) const

pure virtualinherited

Returns: true if a key has been set on this object

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

Referenced by assert_key_material_set(), and Botan::TLS::TLS_CBC_HMAC_AEAD_Mode::has_keying_material().

◆ key_spec()

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

pure virtualinherited

Returns: object describing limits on key size

Referenced by Botan::CBC_Mode::key_spec(), Botan::CFB_Mode::key_spec(), Botan::XTS_Mode::key_spec(), maximum_keylength(), minimum_keylength(), and valid_keylength().

◆ maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const

inlineinherited

Returns: maximum allowed key length

Definition at line 97 of file sym_algo.h.

97{ return key_spec().maximum_keylength(); }

Botan::Key_Length_Specification::maximum_keylength

size_t maximum_keylength() const

Definition sym_algo.h:56

Botan::SymmetricAlgorithm::key_spec

virtual Key_Length_Specification key_spec() const =0

References key_spec().

◆ minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const

inlineinherited

Returns: minimum allowed key length

Definition at line 102 of file sym_algo.h.

102{ return key_spec().minimum_keylength(); }

Botan::Key_Length_Specification::minimum_keylength

size_t minimum_keylength() const

Definition sym_algo.h:51

References key_spec().

◆ 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::ANSI_X919_MAC, Botan::ARIA_128, Botan::ARIA_192, Botan::ARIA_256, Botan::BLAKE2b, Botan::BLAKE2bMAC, Botan::Blowfish, Botan::Camellia_128, Botan::Camellia_192, Botan::Camellia_256, Botan::Cascade_Cipher, Botan::CAST_128, Botan::CBC_Mode, Botan::CCM_Mode, Botan::CFB_Mode, Botan::ChaCha20Poly1305_Mode, Botan::ChaCha, Botan::CMAC, Botan::CTR_BE, Botan::DES, Botan::EAX_Mode, Botan::FPE_FE1, Botan::GCM_Mode, Botan::GHASH, Botan::GMAC, Botan::GOST_28147_89, Botan::HMAC, Botan::IDEA, Botan::KMAC128, Botan::KMAC256, Botan::Kuznyechik, Botan::Lion, Botan::Noekeon, Botan::OCB_Mode, Botan::OFB, Botan::Poly1305, Botan::RC4, Botan::Salsa20, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SHAKE_128_Cipher, Botan::SHAKE_256_Cipher, Botan::SipHash, Botan::SIV_Mode, Botan::SM4, Botan::Threefish_512, Botan::TLS::TLS_CBC_HMAC_AEAD_Mode, Botan::TripleDES, Botan::Twofish, and Botan::XTS_Mode.

Referenced by Botan::XTS_Mode::name(), set_key(), and Botan::MessageAuthenticationCode::start_msg().

◆ new_object()

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

pure virtual

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::GOST_28147_89, Botan::IDEA, Botan::Kuznyechik, Botan::Lion, Botan::Noekeon, Botan::SEED, Botan::Serpent, Botan::SHACAL2, Botan::SM4, Botan::Threefish_512, Botan::TripleDES, and Botan::Twofish.

Referenced by clone().

◆ parallel_bytes()

size_t Botan::BlockCipher::parallel_bytes ( ) const

inline

Returns: prefererred parallelism of this cipher in bytes

Definition at line 67 of file block_cipher.h.

67{ return parallelism() * block_size() * BlockCipher::ParallelismMult; }

Botan::BlockCipher::ParallelismMult

static constexpr size_t ParallelismMult

Definition block_cipher.h:52

Botan::BlockCipher::parallelism

virtual size_t parallelism() const

Definition block_cipher.h:62

References block_size(), parallelism(), and ParallelismMult.

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

◆ parallelism()

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

inlinevirtual

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, and Botan::SM4.

Definition at line 62 of file block_cipher.h.

62{ return 1; }

Referenced by parallel_bytes().

◆ provider()

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

inlinevirtual

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, and Botan::SM4.

Definition at line 73 of file block_cipher.h.

73{ return "base"; }

Referenced by create(), and create_or_throw().

◆ providers()

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

static

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

Parameters

algo_spec algorithm name

Definition at line 274 of file block_cipher.cpp.

274 {

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

276}

Botan::probe_providers_of

std::vector< std::string > probe_providers_of(std::string_view algo_spec, const std::vector< std::string > &possible={"base"})

Definition scan_name.h:105

References Botan::probe_providers_of().

◆ set_key() [1/3]

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

inherited

Set the symmetric key of this object.

Parameters

key	the SymmetricKey to be set.

Definition at line 14 of file sym_algo.cpp.

14 {

15 set_key(std::span{key.begin(), key.length()});

16}

Botan::SymmetricAlgorithm::set_key

void set_key(const OctetString &key)

Definition sym_algo.cpp:14

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

Referenced by Botan::create_aes_row_generator(), 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(), Botan::Sphincs_Hash_Functions_Sha2::PRF_msg(), Botan::Sodium::randombytes_buf_deterministic(), and set_key().

◆ set_key() [2/3]

void Botan::SymmetricAlgorithm::set_key	(	const uint8_t	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 128 of file sym_algo.h.

128{ set_key(std::span{key, length}); }

References set_key().

Referenced by set_key().

◆ set_key() [3/3]

void Botan::SymmetricAlgorithm::set_key ( std::span< const uint8_t > key )

inherited

Set the symmetric key of this object.

Parameters

key	the contiguous byte range to be set.

Definition at line 22 of file sym_algo.cpp.

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

References name(), and valid_keylength().

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

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

Botan::Key_Length_Specification::valid_keylength

bool valid_keylength(size_t length) const

Definition sym_algo.h:44

References key_spec().

Referenced by set_key().

Member Data Documentation

◆ ParallelismMult

size_t Botan::BlockCipher::ParallelismMult = 4

staticconstexpr

Multiplier on a block cipher's native parallelism

Usually notable performance gains come from further loop blocking, at least for 2 or 4x

Definition at line 52 of file block_cipher.h.

Referenced by Botan::GCM_Mode::ideal_granularity(), and parallel_bytes().

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

src/lib/block/block_cipher.h
src/lib/block/block_cipher.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~BlockCipher()

Member Function Documentation

◆ assert_key_material_set() [1/2]

◆ assert_key_material_set() [2/2]

◆ block_size()

◆ clear()

◆ clone()

◆ create()

◆ create_or_throw()

◆ decrypt() [1/4]

◆ decrypt() [2/4]

◆ decrypt() [3/4]

◆ decrypt() [4/4]

◆ decrypt_n()

◆ decrypt_n_xex()

◆ encrypt() [1/4]

◆ encrypt() [2/4]

◆ encrypt() [3/4]

◆ encrypt() [4/4]

◆ encrypt_n()

◆ encrypt_n_xex()

◆ has_keying_material()

◆ key_spec()

◆ maximum_keylength()

◆ minimum_keylength()

◆ name()

◆ new_object()

◆ parallel_bytes()

◆ parallelism()

◆ provider()

◆ providers()

◆ set_key() [1/3]

◆ set_key() [2/3]

◆ set_key() [3/3]

◆ valid_keylength()

Member Data Documentation

◆ ParallelismMult