Botan::Cascade_Cipher Class Reference

#include <cascade.h>

Inheritance diagram for Botan::Cascade_Cipher:

Public Member Functions
size_t	block_size () const override
	Cascade_Cipher (const Cascade_Cipher &)=delete
	Cascade_Cipher (std::unique_ptr< BlockCipher > cipher1, std::unique_ptr< BlockCipher > cipher2)
void	clear () override
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
void	decrypt_n (const uint8_t in[], uint8_t out[], size_t blocks) const override
virtual 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
void	encrypt_n (const uint8_t in[], uint8_t out[], size_t blocks) const override
virtual void	encrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const
bool	has_keying_material () const override
Key_Length_Specification	key_spec () const override
size_t	maximum_keylength () const
size_t	minimum_keylength () const
std::string	name () const override
std::unique_ptr< BlockCipher >	new_object () const override
Cascade_Cipher &	operator= (const Cascade_Cipher &)=delete
size_t	parallel_bytes () const
virtual size_t	parallelism () const
virtual std::string	provider () const
void	set_key (const SymmetricKey &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

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)

Protected Member Functions
void	assert_key_material_set () const
void	assert_key_material_set (bool predicate) const

Detailed Description

Block Cipher Cascade

Definition at line 18 of file cascade.h.

Constructor & Destructor Documentation

Cascade_Cipher() [1/2]

Botan::Cascade_Cipher::Cascade_Cipher	(	std::unique_ptr< BlockCipher >	cipher1,
		std::unique_ptr< BlockCipher >	cipher2
	)

Create a cascade of two block ciphers

Parameters

cipher1	the first cipher
cipher2	the second cipher

Definition at line 90 of file cascade.cpp.

                                                                   :
   m_cipher1(std::move(cipher1)),
   m_cipher2(std::move(cipher2)),
   m_block_size(block_size_for_cascade(m_cipher1->block_size(), m_cipher2->block_size()))
   {
   BOTAN_ASSERT(m_block_size % m_cipher1->block_size() == 0 &&
                m_block_size % m_cipher2->block_size() == 0,
                "Combined block size is a multiple of each ciphers block");
   }

References BOTAN_ASSERT.

Cascade_Cipher() [2/2]

Botan::Cascade_Cipher::Cascade_Cipher ( const Cascade_Cipher &  )

delete

Member Function Documentation

assert_key_material_set() [1/2]

void Botan::SymmetricAlgorithm::assert_key_material_set ( ) const

inlineprotectedinherited

Definition at line 182 of file sym_algo.h.

         {
         assert_key_material_set(has_keying_material());
         }

Referenced by Botan::Salsa20::cipher_bytes(), 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::GHASH::final(), Botan::GHASH::ghash_update(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), 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 187 of file sym_algo.h.

         {
         if(!predicate)
            throw_key_not_set_error();
         }

block_size()

size_t Botan::Cascade_Cipher::block_size ( ) const

inlineoverridevirtual

Returns

block size of this algorithm

Implements Botan::BlockCipher.

Definition at line 24 of file cascade.h.

{ return m_block_size; }

Referenced by decrypt_n(), and encrypt_n().

clear()

void Botan::Cascade_Cipher::clear ( )

overridevirtual

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

Implements Botan::SymmetricAlgorithm.

Definition at line 41 of file cascade.cpp.

   {
   m_cipher1->clear();
   m_cipher2->clear();
   }

clone()

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

inlineinherited

Definition at line 193 of file block_cipher.h.

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

create()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create ( std::string_view  algo_spec, std::string_view  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)
      {
      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(), Botan::BlockCipher::block_size(), BOTAN_UNUSED, Botan::BlockCipher::create(), Botan::HashFunction::create(), Botan::StreamCipher::create(), 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 ( std::string_view  algo_spec, std::string_view  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_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

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

         { decrypt_n(in, out, 1); }

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

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

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

decrypt() [3/4]

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

inlineinherited

Decrypt one or more blocks

Parameters

block

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

Definition at line 125 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 110 of file block_cipher.h.

{ decrypt_n(block, block, 1); }

decrypt_n()

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

overridevirtual

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

Implements Botan::BlockCipher.

Definition at line 23 of file cascade.cpp.

   {
   size_t c1_blocks = blocks * (block_size() / m_cipher1->block_size());
   size_t c2_blocks = blocks * (block_size() / m_cipher2->block_size());
 
   m_cipher2->decrypt_n(in, out, c2_blocks);
   m_cipher1->decrypt_n(out, out, c1_blocks);
   }

References block_size().

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 178 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().

encrypt() [1/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 83 of file block_cipher.h.

         { encrypt_n(in, out, 1); }

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

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

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

encrypt() [3/4]

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

{ encrypt_n(block, block, 1); }

encrypt_n()

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

overridevirtual

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

Implements Botan::BlockCipher.

Definition at line 13 of file cascade.cpp.

   {
   size_t c1_blocks = blocks * (block_size() / m_cipher1->block_size());
   size_t c2_blocks = blocks * (block_size() / m_cipher2->block_size());
 
   m_cipher1->encrypt_n(in, out, c1_blocks);
   m_cipher2->encrypt_n(out, out, c2_blocks);
   }

References block_size().

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 168 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().

has_keying_material()

bool Botan::Cascade_Cipher::has_keying_material ( ) const

overridevirtual

Returns

true if a key has been set on this object

Implements Botan::SymmetricAlgorithm.

Definition at line 52 of file cascade.cpp.

   {
   return m_cipher1->has_keying_material() &&
      m_cipher2->has_keying_material();
   }

key_spec()

Key_Length_Specification Botan::Cascade_Cipher::key_spec ( ) const

inlineoverridevirtual

Returns

object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 26 of file cascade.h.

         {
         return Key_Length_Specification(m_cipher1->maximum_keylength() +
                                         m_cipher2->maximum_keylength());
         }

maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const

inlineinherited

Returns

maximum allowed key length

Definition at line 123 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 131 of file sym_algo.h.

         {
         return key_spec().minimum_keylength();
         }

name()

std::string Botan::Cascade_Cipher::name ( ) const

overridevirtual

Returns

the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 47 of file cascade.cpp.

   {
   return fmt("Cascade({},{})", m_cipher1->name(), m_cipher2->name());
   }

References Botan::fmt().

new_object()

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

overridevirtual

Returns

new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 58 of file cascade.cpp.

   {
   return std::make_unique<Cascade_Cipher>(m_cipher1->new_object(),
                                           m_cipher2->new_object());
   }

operator=()

Cascade_Cipher & Botan::Cascade_Cipher::operator= ( const Cascade_Cipher &  )

delete

parallel_bytes()

size_t Botan::BlockCipher::parallel_bytes ( ) const

inlineinherited

Returns

prefererred parallelism of this cipher in bytes

Definition at line 65 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::ideal_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, and Botan::SM4.

Definition at line 60 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, and Botan::SM4.

Definition at line 74 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 ( std::string_view  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]

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

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

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

Referenced by 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() [2/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_key() [3/3]

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

inlineinherited

Set the symmetric key of this object.

Parameters

key	the contiguous byte range to be set.

Definition at line 159 of file sym_algo.h.

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

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

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

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

---

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

• src/lib/block/cascade/cascade.h
• src/lib/block/cascade/cascade.cpp