Botan  2.7.0
Crypto and TLS for C++11
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Botan::TripleDES Class Referencefinal

#include <des.h>

Inheritance diagram for Botan::TripleDES:
Botan::Block_Cipher_Fixed_Params< 8, 16, 24, 8 > Botan::BlockCipher Botan::SymmetricAlgorithm

Public Types

enum  
 

Public Member Functions

size_t block_size () const override
 
void clear () override
 
BlockCipherclone () const override
 
void decrypt (const uint8_t in[], uint8_t out[]) const
 
void decrypt (uint8_t block[]) const
 
template<typename Alloc >
void decrypt (std::vector< uint8_t, Alloc > &block) const
 
template<typename Alloc , typename Alloc2 >
void decrypt (const std::vector< uint8_t, Alloc > &in, std::vector< uint8_t, Alloc2 > &out) 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 override
 
void encrypt (const uint8_t in[], uint8_t out[]) const
 
void encrypt (uint8_t block[]) const
 
template<typename Alloc >
void encrypt (std::vector< uint8_t, Alloc > &block) const
 
template<typename Alloc , typename Alloc2 >
void encrypt (const std::vector< uint8_t, Alloc > &in, std::vector< uint8_t, Alloc2 > &out) 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 override
 
Key_Length_Specification key_spec () const override
 
size_t maximum_keylength () const
 
size_t minimum_keylength () const
 
std::string name () const override
 
size_t parallel_bytes () const
 
virtual size_t parallelism () const
 
virtual std::string provider () const
 
void set_key (const SymmetricKey &key)
 
template<typename Alloc >
void set_key (const std::vector< uint8_t, Alloc > &key)
 
void set_key (const uint8_t key[], size_t length)
 
bool valid_keylength (size_t length) const
 

Static Public Member Functions

static std::unique_ptr< BlockCiphercreate (const std::string &algo_spec, const std::string &provider="")
 
static std::unique_ptr< BlockCiphercreate_or_throw (const std::string &algo_spec, const std::string &provider="")
 
static std::vector< std::string > providers (const std::string &algo_spec)
 

Protected Member Functions

void verify_key_set (bool cond) const
 

Detailed Description

Triple DES

Definition at line 36 of file des.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

Member Function Documentation

◆ block_size()

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

Implements Botan::BlockCipher.

Definition at line 208 of file block_cipher.h.

208 { return BS; }

◆ clear()

void Botan::TripleDES::clear ( )
overridevirtual

Reset the state.

Implements Botan::SymmetricAlgorithm.

Definition at line 376 of file des.cpp.

References Botan::zap().

377  {
378  zap(m_round_key);
379  }
void zap(std::vector< T, Alloc > &vec)
Definition: secmem.h:193

◆ clone()

BlockCipher* Botan::TripleDES::clone ( ) const
inlineoverridevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 44 of file des.h.

44 { return new TripleDES; }

◆ create()

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

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

Parameters
algo_specalgorithm name
providerprovider implementation to choose
Returns
a null pointer if the algo/provider combination cannot be found

Definition at line 104 of file block_cipher.cpp.

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::HashFunction::create(), Botan::StreamCipher::create(), hash, Botan::make_openssl_block_cipher(), and Botan::BlockCipher::provider().

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

106  {
107 #if defined(BOTAN_HAS_OPENSSL)
108  if(provider.empty() || provider == "openssl")
109  {
110  if(auto bc = make_openssl_block_cipher(algo))
111  return bc;
112 
113  if(!provider.empty())
114  return nullptr;
115  }
116 #endif
117 
118  // TODO: CommonCrypto
119  // TODO: CryptoAPI
120  // TODO: /dev/crypto
121 
122  // Only base providers from here on out
123  if(provider.empty() == false && provider != "base")
124  return nullptr;
125 
126 #if defined(BOTAN_HAS_AES)
127  if(algo == "AES-128")
128  {
129  return std::unique_ptr<BlockCipher>(new AES_128);
130  }
131 
132  if(algo == "AES-192")
133  {
134  return std::unique_ptr<BlockCipher>(new AES_192);
135  }
136 
137  if(algo == "AES-256")
138  {
139  return std::unique_ptr<BlockCipher>(new AES_256);
140  }
141 #endif
142 
143 #if defined(BOTAN_HAS_ARIA)
144  if(algo == "ARIA-128")
145  {
146  return std::unique_ptr<BlockCipher>(new ARIA_128);
147  }
148 
149  if(algo == "ARIA-192")
150  {
151  return std::unique_ptr<BlockCipher>(new ARIA_192);
152  }
153 
154  if(algo == "ARIA-256")
155  {
156  return std::unique_ptr<BlockCipher>(new ARIA_256);
157  }
158 #endif
159 
160 #if defined(BOTAN_HAS_SERPENT)
161  if(algo == "Serpent")
162  {
163  return std::unique_ptr<BlockCipher>(new Serpent);
164  }
165 #endif
166 
167 #if defined(BOTAN_HAS_SHACAL2)
168  if(algo == "SHACAL2")
169  {
170  return std::unique_ptr<BlockCipher>(new SHACAL2);
171  }
172 #endif
173 
174 #if defined(BOTAN_HAS_TWOFISH)
175  if(algo == "Twofish")
176  {
177  return std::unique_ptr<BlockCipher>(new Twofish);
178  }
179 #endif
180 
181 #if defined(BOTAN_HAS_THREEFISH_512)
182  if(algo == "Threefish-512")
183  {
184  return std::unique_ptr<BlockCipher>(new Threefish_512);
185  }
186 #endif
187 
188 #if defined(BOTAN_HAS_BLOWFISH)
189  if(algo == "Blowfish")
190  {
191  return std::unique_ptr<BlockCipher>(new Blowfish);
192  }
193 #endif
194 
195 #if defined(BOTAN_HAS_CAMELLIA)
196  if(algo == "Camellia-128")
197  {
198  return std::unique_ptr<BlockCipher>(new Camellia_128);
199  }
200 
201  if(algo == "Camellia-192")
202  {
203  return std::unique_ptr<BlockCipher>(new Camellia_192);
204  }
205 
206  if(algo == "Camellia-256")
207  {
208  return std::unique_ptr<BlockCipher>(new Camellia_256);
209  }
210 #endif
211 
212 #if defined(BOTAN_HAS_DES)
213  if(algo == "DES")
214  {
215  return std::unique_ptr<BlockCipher>(new DES);
216  }
217 
218  if(algo == "DESX")
219  {
220  return std::unique_ptr<BlockCipher>(new DESX);
221  }
222 
223  if(algo == "TripleDES" || algo == "3DES" || algo == "DES-EDE")
224  {
225  return std::unique_ptr<BlockCipher>(new TripleDES);
226  }
227 #endif
228 
229 #if defined(BOTAN_HAS_NOEKEON)
230  if(algo == "Noekeon")
231  {
232  return std::unique_ptr<BlockCipher>(new Noekeon);
233  }
234 #endif
235 
236 #if defined(BOTAN_HAS_CAST_128)
237  if(algo == "CAST-128" || algo == "CAST5")
238  {
239  return std::unique_ptr<BlockCipher>(new CAST_128);
240  }
241 #endif
242 
243 #if defined(BOTAN_HAS_CAST_256)
244  if(algo == "CAST-256")
245  {
246  return std::unique_ptr<BlockCipher>(new CAST_256);
247  }
248 #endif
249 
250 #if defined(BOTAN_HAS_IDEA)
251  if(algo == "IDEA")
252  {
253  return std::unique_ptr<BlockCipher>(new IDEA);
254  }
255 #endif
256 
257 #if defined(BOTAN_HAS_KASUMI)
258  if(algo == "KASUMI")
259  {
260  return std::unique_ptr<BlockCipher>(new KASUMI);
261  }
262 #endif
263 
264 #if defined(BOTAN_HAS_MISTY1)
265  if(algo == "MISTY1")
266  {
267  return std::unique_ptr<BlockCipher>(new MISTY1);
268  }
269 #endif
270 
271 #if defined(BOTAN_HAS_SEED)
272  if(algo == "SEED")
273  {
274  return std::unique_ptr<BlockCipher>(new SEED);
275  }
276 #endif
277 
278 #if defined(BOTAN_HAS_SM4)
279  if(algo == "SM4")
280  {
281  return std::unique_ptr<BlockCipher>(new SM4);
282  }
283 #endif
284 
285 #if defined(BOTAN_HAS_XTEA)
286  if(algo == "XTEA")
287  {
288  return std::unique_ptr<BlockCipher>(new XTEA);
289  }
290 #endif
291 
292  const SCAN_Name req(algo);
293 
294 #if defined(BOTAN_HAS_GOST_28147_89)
295  if(req.algo_name() == "GOST-28147-89")
296  {
297  return std::unique_ptr<BlockCipher>(new GOST_28147_89(req.arg(0, "R3411_94_TestParam")));
298  }
299 #endif
300 
301 #if defined(BOTAN_HAS_CASCADE)
302  if(req.algo_name() == "Cascade" && req.arg_count() == 2)
303  {
304  std::unique_ptr<BlockCipher> c1(BlockCipher::create(req.arg(0)));
305  std::unique_ptr<BlockCipher> c2(BlockCipher::create(req.arg(1)));
306 
307  if(c1 && c2)
308  return std::unique_ptr<BlockCipher>(new Cascade_Cipher(c1.release(), c2.release()));
309  }
310 #endif
311 
312 #if defined(BOTAN_HAS_LION)
313  if(req.algo_name() == "Lion" && req.arg_count_between(2, 3))
314  {
315  std::unique_ptr<HashFunction> hash(HashFunction::create(req.arg(0)));
316  std::unique_ptr<StreamCipher> stream(StreamCipher::create(req.arg(1)));
317 
318  if(hash && stream)
319  {
320  const size_t block_size = req.arg_as_integer(2, 1024);
321  return std::unique_ptr<BlockCipher>(new Lion(hash.release(), stream.release(), block_size));
322  }
323  }
324 #endif
325 
326  BOTAN_UNUSED(req);
328 
329  return nullptr;
330  }
static std::unique_ptr< HashFunction > create(const std::string &algo_spec, const std::string &provider="")
Definition: hash.cpp:106
#define BOTAN_UNUSED(...)
Definition: assert.h:130
static std::unique_ptr< BlockCipher > create(const std::string &algo_spec, const std::string &provider="")
static std::unique_ptr< StreamCipher > create(const std::string &algo_spec, const std::string &provider="")
std::unique_ptr< BlockCipher > make_openssl_block_cipher(const std::string &name)
virtual std::string provider() const
Definition: block_cipher.h:72
virtual size_t block_size() const =0
MechanismType hash

◆ create_or_throw()

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

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

Definition at line 334 of file block_cipher.cpp.

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

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

336  {
337  if(auto bc = BlockCipher::create(algo, provider))
338  {
339  return bc;
340  }
341  throw Lookup_Error("Block cipher", algo, provider);
342  }
static std::unique_ptr< BlockCipher > create(const std::string &algo_spec, const std::string &provider="")
virtual std::string provider() const
Definition: block_cipher.h:72

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

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

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

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

◆ decrypt() [3/4]

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

Decrypt one or more blocks

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

Definition at line 125 of file block_cipher.h.

126  {
127  return decrypt_n(block.data(), block.data(), block.size() / block_size());
128  }
virtual void decrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0
virtual size_t block_size() const =0

◆ decrypt() [4/4]

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

Decrypt one or more blocks

Parameters
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)

Definition at line 148 of file block_cipher.h.

150  {
151  return decrypt_n(in.data(), out.data(), in.size() / block_size());
152  }
virtual void decrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0
virtual size_t block_size() const =0

◆ decrypt_n()

void Botan::TripleDES::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 324 of file des.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 16, 24, 8 >::BLOCK_SIZE, and Botan::SymmetricAlgorithm::verify_key_set().

325  {
326  verify_key_set(m_round_key.empty() == false);
327 
328  while(blocks >= 2)
329  {
330  uint32_t L0, R0;
331  uint32_t L1, R1;
332 
333  des_IP(L0, R0, in);
334  des_IP(L1, R1, in + BLOCK_SIZE);
335 
336  des_decrypt_x2(L0, R0, L1, R1, &m_round_key[64]);
337  des_encrypt_x2(R0, L0, R1, L1, &m_round_key[32]);
338  des_decrypt_x2(L0, R0, L1, R1, &m_round_key[0]);
339 
340  des_FP(L0, R0, out);
341  des_FP(L1, R1, out + BLOCK_SIZE);
342 
343  in += 2*BLOCK_SIZE;
344  out += 2*BLOCK_SIZE;
345  blocks -= 2;
346  }
347 
348  for(size_t i = 0; i != blocks; ++i)
349  {
350  uint32_t L, R;
351  des_IP(L, R, in + BLOCK_SIZE*i);
352 
353  des_decrypt(L, R, &m_round_key[64]);
354  des_encrypt(R, L, &m_round_key[32]);
355  des_decrypt(L, R, &m_round_key[0]);
356 
357  des_FP(L, R, out + BLOCK_SIZE*i);
358  }
359  }
void verify_key_set(bool cond) const
Definition: sym_algo.h:89

◆ decrypt_n_xex()

void Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >::decrypt_n_xex ( uint8_t  data[],
const uint8_t  mask[],
size_t  blocks 
) const
inlineoverridevirtualinherited

Reimplemented from Botan::BlockCipher.

Definition at line 220 of file block_cipher.h.

223  {
224  xor_buf(data, mask, blocks * BS);
225  decrypt_n(data, data, blocks);
226  xor_buf(data, mask, blocks * BS);
227  }
virtual void decrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0
void xor_buf(uint8_t out[], const uint8_t in[], size_t length)
Definition: mem_ops.h:174

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

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::DESX::encrypt_n(), Botan::XTS_Encryption::finish(), Botan::CTS_Encryption::finish(), Botan::nist_key_wrap_padded(), Botan::CBC_Encryption::process(), and Botan::CFB_Mode::shift_register().

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

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

◆ encrypt() [3/4]

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

Encrypt one or more blocks

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

Definition at line 115 of file block_cipher.h.

116  {
117  return encrypt_n(block.data(), block.data(), block.size() / block_size());
118  }
virtual void encrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0
virtual size_t block_size() const =0

◆ encrypt() [4/4]

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

Encrypt one or more blocks

Parameters
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)

Definition at line 136 of file block_cipher.h.

138  {
139  return encrypt_n(in.data(), out.data(), in.size() / block_size());
140  }
virtual void encrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0
virtual size_t block_size() const =0

◆ encrypt_n()

void Botan::TripleDES::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 284 of file des.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 16, 24, 8 >::BLOCK_SIZE, and Botan::SymmetricAlgorithm::verify_key_set().

285  {
286  verify_key_set(m_round_key.empty() == false);
287 
288  while(blocks >= 2)
289  {
290  uint32_t L0, R0;
291  uint32_t L1, R1;
292 
293  des_IP(L0, R0, in);
294  des_IP(L1, R1, in + BLOCK_SIZE);
295 
296  des_encrypt_x2(L0, R0, L1, R1, &m_round_key[0]);
297  des_decrypt_x2(R0, L0, R1, L1, &m_round_key[32]);
298  des_encrypt_x2(L0, R0, L1, R1, &m_round_key[64]);
299 
300  des_FP(L0, R0, out);
301  des_FP(L1, R1, out + BLOCK_SIZE);
302 
303  in += 2*BLOCK_SIZE;
304  out += 2*BLOCK_SIZE;
305  blocks -= 2;
306  }
307 
308  for(size_t i = 0; i != blocks; ++i)
309  {
310  uint32_t L, R;
311  des_IP(L, R, in + BLOCK_SIZE*i);
312 
313  des_encrypt(L, R, &m_round_key[0]);
314  des_decrypt(R, L, &m_round_key[32]);
315  des_encrypt(L, R, &m_round_key[64]);
316 
317  des_FP(L, R, out + BLOCK_SIZE*i);
318  }
319  }
void verify_key_set(bool cond) const
Definition: sym_algo.h:89

◆ encrypt_n_xex()

void Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >::encrypt_n_xex ( uint8_t  data[],
const uint8_t  mask[],
size_t  blocks 
) const
inlineoverridevirtualinherited

Reimplemented from Botan::BlockCipher.

Definition at line 211 of file block_cipher.h.

214  {
215  xor_buf(data, mask, blocks * BS);
216  encrypt_n(data, data, blocks);
217  xor_buf(data, mask, blocks * BS);
218  }
void xor_buf(uint8_t out[], const uint8_t in[], size_t length)
Definition: mem_ops.h:174
virtual void encrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0

◆ key_spec()

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

Implements Botan::SymmetricAlgorithm.

Definition at line 229 of file block_cipher.h.

230  {
231  return Key_Length_Specification(KMIN, KMAX, KMOD);
232  }

◆ maximum_keylength()

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

Definition at line 38 of file sym_algo.h.

39  {
40  return key_spec().maximum_keylength();
41  }
size_t maximum_keylength() const
Definition: key_spec.h:69
virtual Key_Length_Specification key_spec() const =0

◆ minimum_keylength()

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

Definition at line 46 of file sym_algo.h.

47  {
48  return key_spec().minimum_keylength();
49  }
virtual Key_Length_Specification key_spec() const =0
size_t minimum_keylength() const
Definition: key_spec.h:61

◆ name()

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

Implements Botan::SymmetricAlgorithm.

Definition at line 43 of file des.h.

43 { return "TripleDES"; }

◆ parallel_bytes()

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

Definition at line 63 of file block_cipher.h.

Referenced by Botan::XTS_Mode::update_granularity(), and Botan::CBC_Mode::update_granularity().

64  {
65  return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
66  }
virtual size_t parallelism() const
Definition: block_cipher.h:58
virtual size_t block_size() const =0

◆ parallelism()

virtual size_t Botan::BlockCipher::parallelism ( ) const
inlinevirtualinherited
Returns
native parallelism of this cipher in blocks

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

Definition at line 58 of file block_cipher.h.

58 { 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_256, Botan::AES_192, Botan::Threefish_512, Botan::AES_128, Botan::IDEA, Botan::Serpent, Botan::Noekeon, and Botan::SHACAL2.

Definition at line 72 of file block_cipher.h.

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

72 { return "base"; }

◆ providers()

std::vector< std::string > Botan::BlockCipher::providers ( const std::string &  algo_spec)
staticinherited
Returns
list of available providers for this algorithm, empty if not available
Parameters
algo_specalgorithm name

Definition at line 344 of file block_cipher.cpp.

345  {
346  return probe_providers_of<BlockCipher>(algo, { "base", "openssl" });
347  }

◆ set_key() [1/3]

void Botan::SymmetricAlgorithm::set_key ( const SymmetricKey key)
inlineinherited

Set the symmetric key of this object.

Parameters
keythe SymmetricKey to be set.

Definition at line 65 of file sym_algo.h.

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

Referenced by Botan::aont_package(), Botan::aont_unpackage(), botan_block_cipher_set_key(), botan_mac_set_key(), Botan::FPE::fe1_decrypt(), Botan::FPE::fe1_encrypt(), and Botan::pbkdf2().

66  {
67  set_key(key.begin(), key.length());
68  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:65

◆ set_key() [2/3]

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

Definition at line 71 of file sym_algo.h.

72  {
73  set_key(key.data(), key.size());
74  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:65

◆ set_key() [3/3]

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

Set the symmetric key of this object.

Parameters
keythe to be set as a byte array.
lengthin bytes of key param

Definition at line 17 of file sym_algo.cpp.

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

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

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

Referenced by Botan::aont_package(), Botan::aont_unpackage(), and Botan::SymmetricAlgorithm::set_key().

57  {
58  return key_spec().valid_keylength(length);
59  }
bool valid_keylength(size_t length) const
Definition: key_spec.h:51
virtual Key_Length_Specification key_spec() const =0

◆ verify_key_set()

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

Definition at line 89 of file sym_algo.h.

Referenced by Botan::Salsa20::cipher(), Botan::CTR_BE::cipher(), Botan::RC4::cipher(), Botan::SHAKE_128_Cipher::cipher(), Botan::ChaCha::cipher(), Botan::KASUMI::decrypt_n(), Botan::CAST_256::decrypt_n(), Botan::Threefish_512::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::MISTY1::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::DES::decrypt_n(), Botan::XTEA::decrypt_n(), Botan::Camellia_128::decrypt_n(), Botan::SEED::decrypt_n(), Botan::SM4::decrypt_n(), Botan::DESX::decrypt_n(), Botan::AES_128::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::Serpent::decrypt_n(), Botan::Lion::decrypt_n(), Botan::ARIA_128::decrypt_n(), Botan::Camellia_192::decrypt_n(), decrypt_n(), Botan::ARIA_192::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::AES_192::decrypt_n(), Botan::ARIA_256::decrypt_n(), Botan::AES_256::decrypt_n(), Botan::IDEA::encrypt_n(), Botan::KASUMI::encrypt_n(), Botan::SEED::encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::AES_128::encrypt_n(), Botan::Threefish_512::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::Blowfish::encrypt_n(), Botan::MISTY1::encrypt_n(), Botan::XTEA::encrypt_n(), Botan::DES::encrypt_n(), Botan::CAST_256::encrypt_n(), Botan::DESX::encrypt_n(), Botan::SM4::encrypt_n(), Botan::Serpent::encrypt_n(), Botan::Lion::encrypt_n(), Botan::ARIA_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), encrypt_n(), Botan::ARIA_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::AES_192::encrypt_n(), Botan::ARIA_256::encrypt_n(), Botan::AES_256::encrypt_n(), Botan::Salsa20::seek(), Botan::CTR_BE::seek(), Botan::ChaCha::seek(), and Botan::GHASH::update_associated_data().

90  {
91  if(cond == false)
92  throw_key_not_set_error();
93  }

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