Botan 3.5.0
Crypto and TLS for C&
Botan::Cascade_Cipher Class Referencefinal

#include <cascade.h>

Inheritance diagram for Botan::Cascade_Cipher:
Botan::BlockCipher Botan::SymmetricAlgorithm

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
 
BlockCipherclone () 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< BlockCiphernew_object () const override
 
Cascade_Cipheroperator= (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< BlockCiphercreate (std::string_view algo_spec, std::string_view provider="")
 
static std::unique_ptr< BlockCiphercreate_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
cipher1the first cipher
cipher2the second cipher

Definition at line 56 of file cascade.cpp.

56 :
57 m_cipher1(std::move(cipher1)),
58 m_cipher2(std::move(cipher2)),
59 m_block_size(std::lcm(m_cipher1->block_size(), m_cipher2->block_size())) {
60 BOTAN_ASSERT(m_block_size % m_cipher1->block_size() == 0 && m_block_size % m_cipher2->block_size() == 0,
61 "Combined block size is a multiple of each ciphers block");
62}
#define BOTAN_ASSERT(expr, assertion_made)
Definition assert.h:50

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

virtual bool has_keying_material() const =0
void assert_key_material_set() const
Definition sym_algo.h:139

References Botan::SymmetricAlgorithm::assert_key_material_set().

Referenced by Botan::SymmetricAlgorithm::assert_key_material_set(), 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::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::Kuznyechik::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::TripleDES::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::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::Kuznyechik::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::TripleDES::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 141 of file sym_algo.h.

141 {
142 if(!predicate) {
143 throw_key_not_set_error();
144 }
145 }

◆ block_size()

size_t Botan::Cascade_Cipher::block_size ( ) const
inlineoverridevirtual
Returns
block size of this algorithm

Implements Botan::BlockCipher.

Definition at line 23 of file cascade.h.

23{ 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 39 of file cascade.cpp.

39 {
40 m_cipher1->clear();
41 m_cipher2->clear();
42}

◆ clone()

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

Definition at line 171 of file block_cipher.h.

171{ return this->new_object().release(); }
virtual std::unique_ptr< BlockCipher > new_object() const =0

◆ 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_specalgorithm name
providerprovider implementation to choose
Returns
a null pointer if the algo/provider combination cannot be found

Definition at line 91 of file block_cipher.cpp.

91 {
92#if defined(BOTAN_HAS_COMMONCRYPTO)
93 if(provider.empty() || provider == "commoncrypto") {
94 if(auto bc = make_commoncrypto_block_cipher(algo))
95 return bc;
96
97 if(!provider.empty())
98 return nullptr;
99 }
100#endif
101
102 // TODO: CryptoAPI
103 // TODO: /dev/crypto
104
105 // Only base providers from here on out
106 if(provider.empty() == false && provider != "base") {
107 return nullptr;
108 }
109
110#if defined(BOTAN_HAS_AES)
111 if(algo == "AES-128") {
112 return std::make_unique<AES_128>();
113 }
114
115 if(algo == "AES-192") {
116 return std::make_unique<AES_192>();
117 }
118
119 if(algo == "AES-256") {
120 return std::make_unique<AES_256>();
121 }
122#endif
123
124#if defined(BOTAN_HAS_ARIA)
125 if(algo == "ARIA-128") {
126 return std::make_unique<ARIA_128>();
127 }
128
129 if(algo == "ARIA-192") {
130 return std::make_unique<ARIA_192>();
131 }
132
133 if(algo == "ARIA-256") {
134 return std::make_unique<ARIA_256>();
135 }
136#endif
137
138#if defined(BOTAN_HAS_SERPENT)
139 if(algo == "Serpent") {
140 return std::make_unique<Serpent>();
141 }
142#endif
143
144#if defined(BOTAN_HAS_SHACAL2)
145 if(algo == "SHACAL2") {
146 return std::make_unique<SHACAL2>();
147 }
148#endif
149
150#if defined(BOTAN_HAS_TWOFISH)
151 if(algo == "Twofish") {
152 return std::make_unique<Twofish>();
153 }
154#endif
155
156#if defined(BOTAN_HAS_THREEFISH_512)
157 if(algo == "Threefish-512") {
158 return std::make_unique<Threefish_512>();
159 }
160#endif
161
162#if defined(BOTAN_HAS_BLOWFISH)
163 if(algo == "Blowfish") {
164 return std::make_unique<Blowfish>();
165 }
166#endif
167
168#if defined(BOTAN_HAS_CAMELLIA)
169 if(algo == "Camellia-128") {
170 return std::make_unique<Camellia_128>();
171 }
172
173 if(algo == "Camellia-192") {
174 return std::make_unique<Camellia_192>();
175 }
176
177 if(algo == "Camellia-256") {
178 return std::make_unique<Camellia_256>();
179 }
180#endif
181
182#if defined(BOTAN_HAS_DES)
183 if(algo == "DES") {
184 return std::make_unique<DES>();
185 }
186
187 if(algo == "TripleDES" || algo == "3DES" || algo == "DES-EDE") {
188 return std::make_unique<TripleDES>();
189 }
190#endif
191
192#if defined(BOTAN_HAS_NOEKEON)
193 if(algo == "Noekeon") {
194 return std::make_unique<Noekeon>();
195 }
196#endif
197
198#if defined(BOTAN_HAS_CAST_128)
199 if(algo == "CAST-128" || algo == "CAST5") {
200 return std::make_unique<CAST_128>();
201 }
202#endif
203
204#if defined(BOTAN_HAS_IDEA)
205 if(algo == "IDEA") {
206 return std::make_unique<IDEA>();
207 }
208#endif
209
210#if defined(BOTAN_HAS_KUZNYECHIK)
211 if(algo == "Kuznyechik") {
212 return std::make_unique<Kuznyechik>();
213 }
214#endif
215
216#if defined(BOTAN_HAS_SEED)
217 if(algo == "SEED") {
218 return std::make_unique<SEED>();
219 }
220#endif
221
222#if defined(BOTAN_HAS_SM4)
223 if(algo == "SM4") {
224 return std::make_unique<SM4>();
225 }
226#endif
227
228 const SCAN_Name req(algo);
229
230#if defined(BOTAN_HAS_GOST_28147_89)
231 if(req.algo_name() == "GOST-28147-89") {
232 return std::make_unique<GOST_28147_89>(req.arg(0, "R3411_94_TestParam"));
233 }
234#endif
235
236#if defined(BOTAN_HAS_CASCADE)
237 if(req.algo_name() == "Cascade" && req.arg_count() == 2) {
238 auto c1 = BlockCipher::create(req.arg(0));
239 auto c2 = BlockCipher::create(req.arg(1));
240
241 if(c1 && c2) {
242 return std::make_unique<Cascade_Cipher>(std::move(c1), std::move(c2));
243 }
244 }
245#endif
246
247#if defined(BOTAN_HAS_LION)
248 if(req.algo_name() == "Lion" && req.arg_count_between(2, 3)) {
249 auto hash = HashFunction::create(req.arg(0));
250 auto stream = StreamCipher::create(req.arg(1));
251
252 if(hash && stream) {
253 const size_t block_size = req.arg_as_integer(2, 1024);
254 return std::make_unique<Lion>(std::move(hash), std::move(stream), block_size);
255 }
256 }
257#endif
258
259 BOTAN_UNUSED(req);
261
262 return nullptr;
263}
#define BOTAN_UNUSED
Definition assert.h:118
static std::unique_ptr< BlockCipher > create(std::string_view algo_spec, std::string_view provider="")
virtual size_t block_size() const =0
virtual std::string provider() const
static std::unique_ptr< HashFunction > create(std::string_view algo_spec, std::string_view provider="")
Definition hash.cpp:107
static std::unique_ptr< StreamCipher > create(std::string_view algo_spec, std::string_view provider="")
std::unique_ptr< BlockCipher > make_commoncrypto_block_cipher(std::string_view name)

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::BlockCipher::create(), Botan::Cipher_Mode::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 266 of file block_cipher.cpp.

266 {
267 if(auto bc = BlockCipher::create(algo, provider)) {
268 return bc;
269 }
270 throw Lookup_Error("Block cipher", algo, provider);
271}

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
inThe ciphertext block to be decypted as a byte array. Must be of length block_size().
outThe byte array designated to hold the decrypted block. Must be of length block_size().

Definition at line 84 of file block_cipher.h.

84{ decrypt_n(in, out, 1); }
virtual void decrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0

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
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)

Definition at line 132 of file block_cipher.h.

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

◆ decrypt() [3/4]

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

Decrypt one or more blocks

Parameters
blockthe input/output buffer (multiple of block_size())

Definition at line 114 of file block_cipher.h.

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

◆ decrypt() [4/4]

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

Decrypt a block.

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

Definition at line 100 of file block_cipher.h.

100{ 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
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)
blocksthe number of blocks to process

Implements Botan::BlockCipher.

Definition at line 24 of file cascade.cpp.

24 {
25 size_t c1_blocks = blocks * (block_size() / m_cipher1->block_size());
26 size_t c2_blocks = blocks * (block_size() / m_cipher2->block_size());
27
28 m_cipher2->decrypt_n(in, out, c2_blocks);
29 m_cipher1->decrypt_n(out, out, c1_blocks);
30}
size_t block_size() const override
Definition cascade.h:23

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

Definition at line 159 of file block_cipher.h.

159 {
160 const size_t BS = block_size();
161 xor_buf(data, mask, blocks * BS);
162 decrypt_n(data, data, blocks);
163 xor_buf(data, mask, blocks * BS);
164 }
constexpr void xor_buf(ranges::contiguous_output_range< uint8_t > auto &&out, ranges::contiguous_range< uint8_t > auto &&in)
Definition mem_ops.h:341

References Botan::xor_buf().

◆ encrypt() [1/4]

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

Encrypt a block.

Parameters
inThe plaintext block to be encrypted as a byte array. Must be of length block_size().
outThe byte array designated to hold the encrypted block. Must be of length block_size().

Definition at line 75 of file block_cipher.h.

75{ encrypt_n(in, out, 1); }
virtual void encrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0

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
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)

Definition at line 123 of file block_cipher.h.

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

◆ encrypt() [3/4]

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

Encrypt one or more blocks

Parameters
blockthe input/output buffer (multiple of block_size())

Definition at line 106 of file block_cipher.h.

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

◆ encrypt() [4/4]

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

Encrypt a block.

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

Definition at line 92 of file block_cipher.h.

92{ 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
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)
blocksthe number of blocks to process

Implements Botan::BlockCipher.

Definition at line 16 of file cascade.cpp.

16 {
17 size_t c1_blocks = blocks * (block_size() / m_cipher1->block_size());
18 size_t c2_blocks = blocks * (block_size() / m_cipher2->block_size());
19
20 m_cipher1->encrypt_n(in, out, c1_blocks);
21 m_cipher2->encrypt_n(out, out, c2_blocks);
22}

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

Definition at line 152 of file block_cipher.h.

152 {
153 const size_t BS = block_size();
154 xor_buf(data, mask, blocks * BS);
155 encrypt_n(data, data, blocks);
156 xor_buf(data, mask, blocks * BS);
157 }

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 48 of file cascade.cpp.

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

◆ 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 25 of file cascade.h.

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

◆ maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const
inlineinherited
Returns
maximum allowed key length

Definition at line 95 of file sym_algo.h.

95{ return key_spec().maximum_keylength(); }
size_t maximum_keylength() const
Definition sym_algo.h:54
virtual Key_Length_Specification key_spec() const =0

◆ minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const
inlineinherited
Returns
minimum allowed key length

Definition at line 100 of file sym_algo.h.

100{ return key_spec().minimum_keylength(); }
size_t minimum_keylength() const
Definition sym_algo.h:49

◆ name()

std::string Botan::Cascade_Cipher::name ( ) const
overridevirtual
Returns
the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 44 of file cascade.cpp.

44 {
45 return fmt("Cascade({},{})", m_cipher1->name(), m_cipher2->name());
46}
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

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 52 of file cascade.cpp.

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

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

virtual size_t parallelism() const
#define BOTAN_BLOCK_CIPHER_PAR_MULT
Definition build.h:461

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

55{ 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 66 of file block_cipher.h.

66{ 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_specalgorithm name

Definition at line 273 of file block_cipher.cpp.

273 {
274 return probe_providers_of<BlockCipher>(algo, {"base", "commoncrypto"});
275}
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]

◆ 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
keythe to be set as a byte array.
lengthin bytes of key param

Definition at line 126 of file sym_algo.h.

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

References Botan::SymmetricAlgorithm::set_key().

Referenced by Botan::SymmetricAlgorithm::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
keythe contiguous byte range to be set.

Definition at line 17 of file sym_algo.cpp.

17 {
18 if(!valid_keylength(key.size())) {
19 throw Invalid_Key_Length(name(), key.size());
20 }
21 key_schedule(key);
22}
bool valid_keylength(size_t length) const
Definition sym_algo.h:107
virtual std::string name() const =0

References Botan::SymmetricAlgorithm::name(), and Botan::SymmetricAlgorithm::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
lengththe key length to be checked.
Returns
true if the key length is valid.

Definition at line 107 of file sym_algo.h.

107{ return key_spec().valid_keylength(length); }
bool valid_keylength(size_t length) const
Definition sym_algo.h:42

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


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