Botan 3.11.1
Crypto and TLS for C&
Botan::Twofish Class Referencefinal

#include <twofish.h>

Inheritance diagram for Botan::Twofish:
Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 > Botan::BlockCipher Botan::SymmetricAlgorithm

Public Types

enum  

Public Member Functions

size_t block_size () const final
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
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
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 final
size_t maximum_keylength () const
size_t minimum_keylength () const
std::string name () const override
std::unique_ptr< BlockCiphernew_object () const override
size_t parallel_bytes () const
size_t parallelism () const override
std::string provider () const override
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

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)

Static Public Attributes

static constexpr size_t ParallelismMult

Protected Member Functions

void assert_key_material_set () const
void assert_key_material_set (bool predicate) const

Detailed Description

Twofish, an AES finalist

Definition at line 19 of file twofish.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

Definition at line 212 of file block_cipher.h.

212{ BLOCK_SIZE = BS }; /* NOLINT(*-enum-size,*-use-enum-class) */

Member Function Documentation

◆ assert_key_material_set() [1/2]

◆ assert_key_material_set() [2/2]

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

Definition at line 147 of file sym_algo.h.

147 {
148 if(!predicate) {
150 }
151 }

◆ block_size()

size_t Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD, BlockCipher >::block_size ( ) const
inlinefinalvirtualinherited
Returns
block size of this algorithm

Implements Botan::BlockCipher.

Definition at line 214 of file block_cipher.h.

214{ return BS; }

◆ clear()

void Botan::Twofish::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 493 of file twofish.cpp.

493 {
494 zap(m_SB);
495 zap(m_RK);
496 zap(m_QS);
497}
void zap(std::vector< T, Alloc > &vec)
Definition secmem.h:133

References Botan::zap().

◆ clone()

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

Definition at line 188 of file block_cipher.h.

188{ 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 31 of file block_cipher.cpp.

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

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

271 {
272 if(auto bc = BlockCipher::create(algo, provider)) {
273 return bc;
274 }
275 throw Lookup_Error("Block cipher", algo, provider);
276}

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

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

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

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

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

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

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

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

◆ decrypt_n()

void Botan::Twofish::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 260 of file twofish.cpp.

260 {
262
263#if defined(BOTAN_HAS_TWOFISH_AVX512)
264 if(!m_QS.empty()) {
265 while(blocks >= 16) {
266 avx512_decrypt_16(in, out);
267 in += 16 * BLOCK_SIZE;
268 out += 16 * BLOCK_SIZE;
269 blocks -= 16;
270 }
271 }
272#endif
273
274 while(blocks >= 2) {
275 uint32_t A0 = 0;
276 uint32_t B0 = 0;
277 uint32_t C0 = 0;
278 uint32_t D0 = 0;
279 uint32_t A1 = 0;
280 uint32_t B1 = 0;
281 uint32_t C1 = 0;
282 uint32_t D1 = 0;
283 load_le(in, A0, B0, C0, D0, A1, B1, C1, D1);
284
285 A0 ^= m_RK[4];
286 A1 ^= m_RK[4];
287 B0 ^= m_RK[5];
288 B1 ^= m_RK[5];
289 C0 ^= m_RK[6];
290 C1 ^= m_RK[6];
291 D0 ^= m_RK[7];
292 D1 ^= m_RK[7];
293
294 for(size_t k = 40; k != 8; k -= 4) {
295 TF_D(A0, B0, C0, D0, m_RK[k - 2], m_RK[k - 1], m_SB);
296 TF_D(A1, B1, C1, D1, m_RK[k - 2], m_RK[k - 1], m_SB);
297
298 TF_D(C0, D0, A0, B0, m_RK[k - 4], m_RK[k - 3], m_SB);
299 TF_D(C1, D1, A1, B1, m_RK[k - 4], m_RK[k - 3], m_SB);
300 }
301
302 C0 ^= m_RK[0];
303 C1 ^= m_RK[0];
304 D0 ^= m_RK[1];
305 D1 ^= m_RK[1];
306 A0 ^= m_RK[2];
307 A1 ^= m_RK[2];
308 B0 ^= m_RK[3];
309 B1 ^= m_RK[3];
310
311 store_le(out, C0, D0, A0, B0, C1, D1, A1, B1);
312
313 blocks -= 2;
314 out += 2 * BLOCK_SIZE;
315 in += 2 * BLOCK_SIZE;
316 }
317
318 if(blocks > 0) {
319 uint32_t A = 0;
320 uint32_t B = 0;
321 uint32_t C = 0;
322 uint32_t D = 0;
323 load_le(in, A, B, C, D);
324
325 A ^= m_RK[4];
326 B ^= m_RK[5];
327 C ^= m_RK[6];
328 D ^= m_RK[7];
329
330 for(size_t k = 40; k != 8; k -= 4) {
331 TF_D(A, B, C, D, m_RK[k - 2], m_RK[k - 1], m_SB);
332 TF_D(C, D, A, B, m_RK[k - 4], m_RK[k - 3], m_SB);
333 }
334
335 C ^= m_RK[0];
336 D ^= m_RK[1];
337 A ^= m_RK[2];
338 B ^= m_RK[3];
339
340 store_le(out, C, D, A, B);
341 }
342}
constexpr auto store_le(ParamTs &&... params)
Definition loadstor.h:736
constexpr auto load_le(ParamTs &&... params)
Definition loadstor.h:495

References Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::assert_key_material_set(), Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::BLOCK_SIZE, Botan::load_le(), and Botan::store_le().

◆ decrypt_n_xex()

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

Definition at line 172 of file block_cipher.h.

172 {
173 const size_t BS = block_size();
174 for(size_t i = 0; i != blocks * BS; ++i) {
175 data[i] ^= mask[i];
176 }
178 for(size_t i = 0; i != blocks * BS; ++i) {
179 data[i] ^= mask[i];
180 }
181 }

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

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

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

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

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

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

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

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

◆ encrypt_n()

void Botan::Twofish::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 173 of file twofish.cpp.

173 {
175
176#if defined(BOTAN_HAS_TWOFISH_AVX512)
177 if(!m_QS.empty()) {
178 while(blocks >= 16) {
179 avx512_encrypt_16(in, out);
180 in += 16 * BLOCK_SIZE;
181 out += 16 * BLOCK_SIZE;
182 blocks -= 16;
183 }
184 }
185#endif
186
187 while(blocks >= 2) {
188 uint32_t A0 = 0;
189 uint32_t B0 = 0;
190 uint32_t C0 = 0;
191 uint32_t D0 = 0;
192 uint32_t A1 = 0;
193 uint32_t B1 = 0;
194 uint32_t C1 = 0;
195 uint32_t D1 = 0;
196 load_le(in, A0, B0, C0, D0, A1, B1, C1, D1);
197
198 A0 ^= m_RK[0];
199 A1 ^= m_RK[0];
200 B0 ^= m_RK[1];
201 B1 ^= m_RK[1];
202 C0 ^= m_RK[2];
203 C1 ^= m_RK[2];
204 D0 ^= m_RK[3];
205 D1 ^= m_RK[3];
206
207 for(size_t k = 8; k != 40; k += 4) {
208 TF_E(A0, B0, C0, D0, m_RK[k + 0], m_RK[k + 1], m_SB);
209 TF_E(A1, B1, C1, D1, m_RK[k + 0], m_RK[k + 1], m_SB);
210
211 TF_E(C0, D0, A0, B0, m_RK[k + 2], m_RK[k + 3], m_SB);
212 TF_E(C1, D1, A1, B1, m_RK[k + 2], m_RK[k + 3], m_SB);
213 }
214
215 C0 ^= m_RK[4];
216 C1 ^= m_RK[4];
217 D0 ^= m_RK[5];
218 D1 ^= m_RK[5];
219 A0 ^= m_RK[6];
220 A1 ^= m_RK[6];
221 B0 ^= m_RK[7];
222 B1 ^= m_RK[7];
223
224 store_le(out, C0, D0, A0, B0, C1, D1, A1, B1);
225
226 blocks -= 2;
227 out += 2 * BLOCK_SIZE;
228 in += 2 * BLOCK_SIZE;
229 }
230
231 if(blocks > 0) {
232 uint32_t A = 0;
233 uint32_t B = 0;
234 uint32_t C = 0;
235 uint32_t D = 0;
236 load_le(in, A, B, C, D);
237
238 A ^= m_RK[0];
239 B ^= m_RK[1];
240 C ^= m_RK[2];
241 D ^= m_RK[3];
242
243 for(size_t k = 8; k != 40; k += 4) {
244 TF_E(A, B, C, D, m_RK[k], m_RK[k + 1], m_SB);
245 TF_E(C, D, A, B, m_RK[k + 2], m_RK[k + 3], m_SB);
246 }
247
248 C ^= m_RK[4];
249 D ^= m_RK[5];
250 A ^= m_RK[6];
251 B ^= m_RK[7];
252
253 store_le(out, C, D, A, B);
254 }
255}

References Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::assert_key_material_set(), Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::BLOCK_SIZE, Botan::load_le(), and Botan::store_le().

◆ encrypt_n_xex()

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

Definition at line 160 of file block_cipher.h.

160 {
161 const size_t BS = block_size();
162 for(size_t i = 0; i != blocks * BS; ++i) {
163 data[i] ^= mask[i];
164 }
166 for(size_t i = 0; i != blocks * BS; ++i) {
167 data[i] ^= mask[i];
168 }
169 }

◆ has_keying_material()

bool Botan::Twofish::has_keying_material ( ) const
overridevirtual
Returns
true if a key has been set on this object

Implements Botan::SymmetricAlgorithm.

Definition at line 344 of file twofish.cpp.

344 {
345 return !m_SB.empty();
346}

◆ key_spec()

Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD, BlockCipher >::key_spec ( ) const
inlinefinalvirtualinherited
Returns
object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 216 of file block_cipher.h.

◆ maximum_keylength()

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

Definition at line 101 of file sym_algo.h.

101{ return key_spec().maximum_keylength(); }
Key_Length_Specification key_spec() const final
size_t maximum_keylength() const
Definition sym_algo.h:55

◆ minimum_keylength()

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

Definition at line 106 of file sym_algo.h.

106{ return key_spec().minimum_keylength(); }
size_t minimum_keylength() const
Definition sym_algo.h:50

◆ name()

std::string Botan::Twofish::name ( ) const
inlineoverridevirtual
Returns
the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 27 of file twofish.h.

27{ return "Twofish"; }

◆ new_object()

std::unique_ptr< BlockCipher > Botan::Twofish::new_object ( ) const
inlineoverridevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 29 of file twofish.h.

29{ return std::make_unique<Twofish>(); }

◆ parallel_bytes()

size_t Botan::BlockCipher::parallel_bytes ( ) const
inlineinherited
Returns
preferred parallelism of this cipher in bytes

Definition at line 67 of file block_cipher.h.

◆ parallelism()

size_t Botan::Twofish::parallelism ( ) const
overridevirtual
Returns
native parallelism of this cipher in blocks

Reimplemented from Botan::BlockCipher.

Definition at line 357 of file twofish.cpp.

357 {
358#if defined(BOTAN_HAS_TWOFISH_AVX512)
360 return 16;
361 }
362#endif
363 return 1;
364}
static bool has(CPUID::Feature feat)
Definition cpuid.h:94

References Botan::CPUFeature::AVX512, Botan::CPUFeature::GFNI, and Botan::CPUID::has().

◆ provider()

std::string Botan::Twofish::provider ( ) const
overridevirtual
Returns
provider information about this implementation. Default is "base", might also return "sse2", "avx2", "openssl", or some other arbitrary string.

Reimplemented from Botan::BlockCipher.

Definition at line 348 of file twofish.cpp.

348 {
349#if defined(BOTAN_HAS_TWOFISH_AVX512)
351 return "avx512";
352 }
353#endif
354 return "base";
355}

References Botan::CPUFeature::AVX512, Botan::CPUFeature::GFNI, and Botan::CPUID::has().

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

278 {
279 return probe_providers_of<BlockCipher>(algo, {"base", "commoncrypto"});
280}
std::vector< std::string > probe_providers_of(std::string_view algo_spec, const std::vector< std::string > &possible={"base"})
Definition scan_name.h:105

◆ set_key() [1/3]

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

Set the symmetric key of this object.

Parameters
keythe SymmetricKey to be set.

Definition at line 119 of file sym_algo.cpp.

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

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

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

22 {
23 if(!valid_keylength(key.size())) {
24 throw Invalid_Key_Length(name(), key.size());
25 }
27}

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

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

Member Data Documentation

◆ ParallelismMult

size_t Botan::BlockCipher::ParallelismMult
staticconstexprinherited

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.


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