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

#include <serpent.h>

Inheritance diagram for Botan::Serpent:
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 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 final 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 final override
 
Key_Length_Specification key_spec () const final override
 
size_t maximum_keylength () const
 
size_t minimum_keylength () const
 
std::string name () const override
 
size_t parallel_bytes () const
 
size_t parallelism () const override
 
std::string provider () const override
 
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

Serpent is the most conservative of the AES finalists https://www.cl.cam.ac.uk/~rja14/serpent.html

Definition at line 19 of file serpent.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, BlockCipher >::block_size ( ) const
inlinefinaloverridevirtualinherited

Implements Botan::BlockCipher.

Definition at line 225 of file block_cipher.h.

225 { return BS; }

◆ clear()

void Botan::Serpent::clear ( )
overridevirtual

Reset the state.

Implements Botan::SymmetricAlgorithm.

Definition at line 273 of file serpent.cpp.

References Botan::zap().

274  {
275  zap(m_round_key);
276  }
void zap(std::vector< T, Alloc > &vec)
Definition: secmem.h:170

◆ clone()

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

Implements Botan::BlockCipher.

Definition at line 28 of file serpent.h.

28 { return new Serpent; }

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

References Botan::BlockCipher::block_size(), BOTAN_UNUSED, Botan::HashFunction::create(), Botan::StreamCipher::create(), hash, Botan::make_commoncrypto_block_cipher(), and Botan::make_openssl_block_cipher().

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

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

References Botan::BlockCipher::create().

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

350  {
351  if(auto bc = BlockCipher::create(algo, provider))
352  {
353  return bc;
354  }
355  throw Lookup_Error("Block cipher", algo, provider);
356  }
static std::unique_ptr< BlockCipher > create(const std::string &algo_spec, const std::string &provider="")
virtual std::string provider() const
Definition: block_cipher.h:73

◆ 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 92 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().

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

109 { 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 126 of file block_cipher.h.

127  {
128  return decrypt_n(block.data(), block.data(), block.size() / block_size());
129  }
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 149 of file block_cipher.h.

151  {
152  return decrypt_n(in.data(), out.data(), in.size() / block_size());
153  }
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::Serpent::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 134 of file serpent.cpp.

References Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::BLOCK_SIZE, BOTAN_PARALLEL_SIMD_FOR, Botan::CPUID::has_simd_32(), i_transform, key_xor, Botan::load_le(), Botan::load_le< uint32_t >(), SBoxD1, SBoxD2, SBoxD3, SBoxD4, SBoxD5, SBoxD6, SBoxD7, SBoxD8, SBoxE1, SBoxE2, SBoxE3, SBoxE4, SBoxE5, SBoxE6, SBoxE7, SBoxE8, Botan::store_le(), and Botan::SymmetricAlgorithm::verify_key_set().

135  {
136  verify_key_set(m_round_key.empty() == false);
137 
138 #if defined(BOTAN_HAS_SERPENT_AVX2)
139  if(CPUID::has_avx2())
140  {
141  while(blocks >= 8)
142  {
143  avx2_decrypt_8(in, out);
144  in += 8 * BLOCK_SIZE;
145  out += 8 * BLOCK_SIZE;
146  blocks -= 8;
147  }
148  }
149 #endif
150 
151 #if defined(BOTAN_HAS_SERPENT_SIMD)
152  if(CPUID::has_simd_32())
153  {
154  while(blocks >= 4)
155  {
156  simd_decrypt_4(in, out);
157  in += 4 * BLOCK_SIZE;
158  out += 4 * BLOCK_SIZE;
159  blocks -= 4;
160  }
161  }
162 #endif
163 
164  BOTAN_PARALLEL_SIMD_FOR(size_t i = 0; i < blocks; ++i)
165  {
166  uint32_t B0, B1, B2, B3;
167  load_le(in + 16*i, B0, B1, B2, B3);
168 
169  key_xor(32,B0,B1,B2,B3); SBoxD8(B0,B1,B2,B3); key_xor(31,B0,B1,B2,B3);
170  i_transform(B0,B1,B2,B3); SBoxD7(B0,B1,B2,B3); key_xor(30,B0,B1,B2,B3);
171  i_transform(B0,B1,B2,B3); SBoxD6(B0,B1,B2,B3); key_xor(29,B0,B1,B2,B3);
172  i_transform(B0,B1,B2,B3); SBoxD5(B0,B1,B2,B3); key_xor(28,B0,B1,B2,B3);
173  i_transform(B0,B1,B2,B3); SBoxD4(B0,B1,B2,B3); key_xor(27,B0,B1,B2,B3);
174  i_transform(B0,B1,B2,B3); SBoxD3(B0,B1,B2,B3); key_xor(26,B0,B1,B2,B3);
175  i_transform(B0,B1,B2,B3); SBoxD2(B0,B1,B2,B3); key_xor(25,B0,B1,B2,B3);
176  i_transform(B0,B1,B2,B3); SBoxD1(B0,B1,B2,B3); key_xor(24,B0,B1,B2,B3);
177  i_transform(B0,B1,B2,B3); SBoxD8(B0,B1,B2,B3); key_xor(23,B0,B1,B2,B3);
178  i_transform(B0,B1,B2,B3); SBoxD7(B0,B1,B2,B3); key_xor(22,B0,B1,B2,B3);
179  i_transform(B0,B1,B2,B3); SBoxD6(B0,B1,B2,B3); key_xor(21,B0,B1,B2,B3);
180  i_transform(B0,B1,B2,B3); SBoxD5(B0,B1,B2,B3); key_xor(20,B0,B1,B2,B3);
181  i_transform(B0,B1,B2,B3); SBoxD4(B0,B1,B2,B3); key_xor(19,B0,B1,B2,B3);
182  i_transform(B0,B1,B2,B3); SBoxD3(B0,B1,B2,B3); key_xor(18,B0,B1,B2,B3);
183  i_transform(B0,B1,B2,B3); SBoxD2(B0,B1,B2,B3); key_xor(17,B0,B1,B2,B3);
184  i_transform(B0,B1,B2,B3); SBoxD1(B0,B1,B2,B3); key_xor(16,B0,B1,B2,B3);
185  i_transform(B0,B1,B2,B3); SBoxD8(B0,B1,B2,B3); key_xor(15,B0,B1,B2,B3);
186  i_transform(B0,B1,B2,B3); SBoxD7(B0,B1,B2,B3); key_xor(14,B0,B1,B2,B3);
187  i_transform(B0,B1,B2,B3); SBoxD6(B0,B1,B2,B3); key_xor(13,B0,B1,B2,B3);
188  i_transform(B0,B1,B2,B3); SBoxD5(B0,B1,B2,B3); key_xor(12,B0,B1,B2,B3);
189  i_transform(B0,B1,B2,B3); SBoxD4(B0,B1,B2,B3); key_xor(11,B0,B1,B2,B3);
190  i_transform(B0,B1,B2,B3); SBoxD3(B0,B1,B2,B3); key_xor(10,B0,B1,B2,B3);
191  i_transform(B0,B1,B2,B3); SBoxD2(B0,B1,B2,B3); key_xor( 9,B0,B1,B2,B3);
192  i_transform(B0,B1,B2,B3); SBoxD1(B0,B1,B2,B3); key_xor( 8,B0,B1,B2,B3);
193  i_transform(B0,B1,B2,B3); SBoxD8(B0,B1,B2,B3); key_xor( 7,B0,B1,B2,B3);
194  i_transform(B0,B1,B2,B3); SBoxD7(B0,B1,B2,B3); key_xor( 6,B0,B1,B2,B3);
195  i_transform(B0,B1,B2,B3); SBoxD6(B0,B1,B2,B3); key_xor( 5,B0,B1,B2,B3);
196  i_transform(B0,B1,B2,B3); SBoxD5(B0,B1,B2,B3); key_xor( 4,B0,B1,B2,B3);
197  i_transform(B0,B1,B2,B3); SBoxD4(B0,B1,B2,B3); key_xor( 3,B0,B1,B2,B3);
198  i_transform(B0,B1,B2,B3); SBoxD3(B0,B1,B2,B3); key_xor( 2,B0,B1,B2,B3);
199  i_transform(B0,B1,B2,B3); SBoxD2(B0,B1,B2,B3); key_xor( 1,B0,B1,B2,B3);
200  i_transform(B0,B1,B2,B3); SBoxD1(B0,B1,B2,B3); key_xor( 0,B0,B1,B2,B3);
201 
202  store_le(out + 16*i, B0, B1, B2, B3);
203  }
204  }
#define SBoxD4(B0, B1, B2, B3)
Definition: serpent_sbox.h:297
void verify_key_set(bool cond) const
Definition: sym_algo.h:89
#define SBoxD2(B0, B1, B2, B3)
Definition: serpent_sbox.h:244
#define SBoxD6(B0, B1, B2, B3)
Definition: serpent_sbox.h:349
static bool has_simd_32()
Definition: cpuid.cpp:23
#define i_transform(B0, B1, B2, B3)
T load_le(const uint8_t in[], size_t off)
Definition: loadstor.h:121
#define SBoxD1(B0, B1, B2, B3)
Definition: serpent_sbox.h:219
#define SBoxD3(B0, B1, B2, B3)
Definition: serpent_sbox.h:272
#define SBoxD8(B0, B1, B2, B3)
Definition: serpent_sbox.h:401
#define key_xor(round, B0, B1, B2, B3)
Definition: serpent.cpp:50
#define SBoxD7(B0, B1, B2, B3)
Definition: serpent_sbox.h:377
#define SBoxD5(B0, B1, B2, B3)
Definition: serpent_sbox.h:323
#define BOTAN_PARALLEL_SIMD_FOR
Definition: compiler.h:178
void store_le(uint16_t in, uint8_t out[2])
Definition: loadstor.h:452

◆ decrypt_n_xex()

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

Reimplemented from Botan::BlockCipher.

Definition at line 237 of file block_cipher.h.

240  {
241  xor_buf(data, mask, blocks * BS);
242  this->decrypt_n(data, data, blocks);
243  xor_buf(data, mask, blocks * BS);
244  }
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:202

◆ 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.

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

83  { 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 101 of file block_cipher.h.

101 { 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 116 of file block_cipher.h.

117  {
118  return encrypt_n(block.data(), block.data(), block.size() / block_size());
119  }
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 137 of file block_cipher.h.

139  {
140  return encrypt_n(in.data(), out.data(), in.size() / block_size());
141  }
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::Serpent::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 59 of file serpent.cpp.

References Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::BLOCK_SIZE, BOTAN_PARALLEL_SIMD_FOR, Botan::CPUID::has_simd_32(), key_xor, Botan::load_le(), SBoxE1, SBoxE2, SBoxE3, SBoxE4, SBoxE5, SBoxE6, SBoxE7, SBoxE8, Botan::store_le(), transform, and Botan::SymmetricAlgorithm::verify_key_set().

60  {
61  verify_key_set(m_round_key.empty() == false);
62 
63 #if defined(BOTAN_HAS_SERPENT_AVX2)
64  if(CPUID::has_avx2())
65  {
66  while(blocks >= 8)
67  {
68  avx2_encrypt_8(in, out);
69  in += 8 * BLOCK_SIZE;
70  out += 8 * BLOCK_SIZE;
71  blocks -= 8;
72  }
73  }
74 #endif
75 
76 #if defined(BOTAN_HAS_SERPENT_SIMD)
77  if(CPUID::has_simd_32())
78  {
79  while(blocks >= 4)
80  {
81  simd_encrypt_4(in, out);
82  in += 4 * BLOCK_SIZE;
83  out += 4 * BLOCK_SIZE;
84  blocks -= 4;
85  }
86  }
87 #endif
88 
89  BOTAN_PARALLEL_SIMD_FOR(size_t i = 0; i < blocks; ++i)
90  {
91  uint32_t B0, B1, B2, B3;
92  load_le(in + 16*i, B0, B1, B2, B3);
93 
94  key_xor( 0,B0,B1,B2,B3); SBoxE1(B0,B1,B2,B3); transform(B0,B1,B2,B3);
95  key_xor( 1,B0,B1,B2,B3); SBoxE2(B0,B1,B2,B3); transform(B0,B1,B2,B3);
96  key_xor( 2,B0,B1,B2,B3); SBoxE3(B0,B1,B2,B3); transform(B0,B1,B2,B3);
97  key_xor( 3,B0,B1,B2,B3); SBoxE4(B0,B1,B2,B3); transform(B0,B1,B2,B3);
98  key_xor( 4,B0,B1,B2,B3); SBoxE5(B0,B1,B2,B3); transform(B0,B1,B2,B3);
99  key_xor( 5,B0,B1,B2,B3); SBoxE6(B0,B1,B2,B3); transform(B0,B1,B2,B3);
100  key_xor( 6,B0,B1,B2,B3); SBoxE7(B0,B1,B2,B3); transform(B0,B1,B2,B3);
101  key_xor( 7,B0,B1,B2,B3); SBoxE8(B0,B1,B2,B3); transform(B0,B1,B2,B3);
102  key_xor( 8,B0,B1,B2,B3); SBoxE1(B0,B1,B2,B3); transform(B0,B1,B2,B3);
103  key_xor( 9,B0,B1,B2,B3); SBoxE2(B0,B1,B2,B3); transform(B0,B1,B2,B3);
104  key_xor(10,B0,B1,B2,B3); SBoxE3(B0,B1,B2,B3); transform(B0,B1,B2,B3);
105  key_xor(11,B0,B1,B2,B3); SBoxE4(B0,B1,B2,B3); transform(B0,B1,B2,B3);
106  key_xor(12,B0,B1,B2,B3); SBoxE5(B0,B1,B2,B3); transform(B0,B1,B2,B3);
107  key_xor(13,B0,B1,B2,B3); SBoxE6(B0,B1,B2,B3); transform(B0,B1,B2,B3);
108  key_xor(14,B0,B1,B2,B3); SBoxE7(B0,B1,B2,B3); transform(B0,B1,B2,B3);
109  key_xor(15,B0,B1,B2,B3); SBoxE8(B0,B1,B2,B3); transform(B0,B1,B2,B3);
110  key_xor(16,B0,B1,B2,B3); SBoxE1(B0,B1,B2,B3); transform(B0,B1,B2,B3);
111  key_xor(17,B0,B1,B2,B3); SBoxE2(B0,B1,B2,B3); transform(B0,B1,B2,B3);
112  key_xor(18,B0,B1,B2,B3); SBoxE3(B0,B1,B2,B3); transform(B0,B1,B2,B3);
113  key_xor(19,B0,B1,B2,B3); SBoxE4(B0,B1,B2,B3); transform(B0,B1,B2,B3);
114  key_xor(20,B0,B1,B2,B3); SBoxE5(B0,B1,B2,B3); transform(B0,B1,B2,B3);
115  key_xor(21,B0,B1,B2,B3); SBoxE6(B0,B1,B2,B3); transform(B0,B1,B2,B3);
116  key_xor(22,B0,B1,B2,B3); SBoxE7(B0,B1,B2,B3); transform(B0,B1,B2,B3);
117  key_xor(23,B0,B1,B2,B3); SBoxE8(B0,B1,B2,B3); transform(B0,B1,B2,B3);
118  key_xor(24,B0,B1,B2,B3); SBoxE1(B0,B1,B2,B3); transform(B0,B1,B2,B3);
119  key_xor(25,B0,B1,B2,B3); SBoxE2(B0,B1,B2,B3); transform(B0,B1,B2,B3);
120  key_xor(26,B0,B1,B2,B3); SBoxE3(B0,B1,B2,B3); transform(B0,B1,B2,B3);
121  key_xor(27,B0,B1,B2,B3); SBoxE4(B0,B1,B2,B3); transform(B0,B1,B2,B3);
122  key_xor(28,B0,B1,B2,B3); SBoxE5(B0,B1,B2,B3); transform(B0,B1,B2,B3);
123  key_xor(29,B0,B1,B2,B3); SBoxE6(B0,B1,B2,B3); transform(B0,B1,B2,B3);
124  key_xor(30,B0,B1,B2,B3); SBoxE7(B0,B1,B2,B3); transform(B0,B1,B2,B3);
125  key_xor(31,B0,B1,B2,B3); SBoxE8(B0,B1,B2,B3); key_xor(32,B0,B1,B2,B3);
126 
127  store_le(out + 16*i, B0, B1, B2, B3);
128  }
129  }
#define SBoxE5(B0, B1, B2, B3)
Definition: serpent_sbox.h:114
void verify_key_set(bool cond) const
Definition: sym_algo.h:89
#define transform(B0, B1, B2, B3)
#define SBoxE1(B0, B1, B2, B3)
Definition: serpent_sbox.h:14
static bool has_simd_32()
Definition: cpuid.cpp:23
#define SBoxE2(B0, B1, B2, B3)
Definition: serpent_sbox.h:39
#define SBoxE6(B0, B1, B2, B3)
Definition: serpent_sbox.h:141
#define SBoxE7(B0, B1, B2, B3)
Definition: serpent_sbox.h:168
#define SBoxE3(B0, B1, B2, B3)
Definition: serpent_sbox.h:65
T load_le(const uint8_t in[], size_t off)
Definition: loadstor.h:121
#define SBoxE4(B0, B1, B2, B3)
Definition: serpent_sbox.h:88
#define SBoxE8(B0, B1, B2, B3)
Definition: serpent_sbox.h:191
#define key_xor(round, B0, B1, B2, B3)
Definition: serpent.cpp:50
#define BOTAN_PARALLEL_SIMD_FOR
Definition: compiler.h:178
void store_le(uint16_t in, uint8_t out[2])
Definition: loadstor.h:452

◆ encrypt_n_xex()

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

Reimplemented from Botan::BlockCipher.

Definition at line 228 of file block_cipher.h.

231  {
232  xor_buf(data, mask, blocks * BS);
233  this->encrypt_n(data, data, blocks);
234  xor_buf(data, mask, blocks * BS);
235  }
void xor_buf(uint8_t out[], const uint8_t in[], size_t length)
Definition: mem_ops.h:202
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, BlockCipher >::key_spec ( ) const
inlinefinaloverridevirtualinherited

Implements Botan::SymmetricAlgorithm.

Definition at line 246 of file block_cipher.h.

247  {
248  return Key_Length_Specification(KMIN, KMAX, KMOD);
249  }

◆ 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.

Referenced by botan_block_cipher_get_keyspec(), and botan_mac_get_keyspec().

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::Serpent::name ( ) const
inlineoverridevirtual
Returns
the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 27 of file serpent.h.

27 { return "Serpent"; }

◆ parallel_bytes()

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

Definition at line 64 of file block_cipher.h.

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

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

◆ parallelism()

size_t Botan::Serpent::parallelism ( ) const
inlineoverridevirtual
Returns
native parallelism of this cipher in blocks

Reimplemented from Botan::BlockCipher.

Definition at line 30 of file serpent.h.

30 { return 4; }

◆ provider()

std::string Botan::Serpent::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 278 of file serpent.cpp.

References Botan::CPUID::has_simd_32().

279  {
280 #if defined(BOTAN_HAS_SERPENT_AVX2)
281  if(CPUID::has_avx2())
282  {
283  return "avx2";
284  }
285 #endif
286 
287 #if defined(BOTAN_HAS_SERPENT_SIMD)
288  if(CPUID::has_simd_32())
289  {
290  return "simd";
291  }
292 #endif
293 
294  return "base";
295  }
static bool has_simd_32()
Definition: cpuid.cpp:23

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

Referenced by Botan::TLS::Ciphersuite::by_id().

359  {
360  return probe_providers_of<BlockCipher>(algo, { "base", "openssl", "commoncrypto" });
361  }

◆ set_key() [1/3]

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

◆ 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.

References name.

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::Poly1305::clear(), Botan::DESX::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::KASUMI::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::Blowfish::decrypt_n(), Botan::XTEA::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::MISTY1::decrypt_n(), Botan::SEED::decrypt_n(), Botan::CAST_256::decrypt_n(), Botan::SM4::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::DES::decrypt_n(), Botan::Threefish_512::decrypt_n(), decrypt_n(), Botan::Lion::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::SM4::encrypt_n(), Botan::MISTY1::encrypt_n(), Botan::KASUMI::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::XTEA::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::CAST_256::encrypt_n(), Botan::DES::encrypt_n(), Botan::DESX::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::Blowfish::encrypt_n(), Botan::SEED::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::Threefish_512::encrypt_n(), encrypt_n(), Botan::Lion::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::OCB_Encryption::finish(), Botan::OCB_Decryption::finish(), Botan::GHASH::ghash_update(), Botan::CFB_Encryption::process(), Botan::CFB_Decryption::process(), Botan::Salsa20::seek(), Botan::CTR_BE::seek(), Botan::ChaCha::seek(), Botan::OCB_Mode::set_associated_data(), Botan::Salsa20::set_iv(), Botan::ChaCha::set_iv(), Botan::GHASH::update(), Botan::GHASH::update_associated_data(), Botan::CFB_Mode::valid_nonce_length(), and Botan::ChaCha::write_keystream().

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

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