Botan 1.10.17
Public Types | Public Member Functions | Protected Member Functions | List of all members
Botan::Serpent Class Reference

#include <serpent.h>

Inheritance diagram for Botan::Serpent:
Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 > Botan::BlockCipher Botan::SymmetricAlgorithm Botan::Algorithm Botan::Serpent_SIMD Botan::Serpent_X86_32

Public Types

enum  

Public Member Functions

size_t block_size () const
void clear ()
BlockCipher * clone () const
void decrypt (byte block[]) const
void decrypt (const byte in[], byte out[]) const
void decrypt_n (const byte in[], byte out[], size_t blocks) const
void encrypt (byte block[]) const
void encrypt (const byte in[], byte out[]) const
void encrypt_n (const byte in[], byte out[], size_t blocks) const
Key_Length_Specification key_spec () const
size_t maximum_keylength () const
size_t minimum_keylength () const
std::string name () const
size_t parallel_bytes () const
virtual size_t parallelism () const
 Serpent ()
void set_key (const byte key[], size_t length)
void set_key (const SymmetricKey &key)
bool valid_keylength (size_t length) const

Protected Member Functions

const SecureVector< u32bit > & get_round_keys () const
void set_round_keys (const u32bit ks[132])

Detailed Description

Serpent, an AES finalist

Definition at line 18 of file serpent.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

Definition at line 107 of file block_cipher.h.

107{ BLOCK_SIZE = BS };
Botan::Block_Cipher_Fixed_Params
Definition block_cipher.h:105

Constructor & Destructor Documentation

◆ Serpent()

Botan::Serpent::Serpent ( )
inline

Definition at line 28 of file serpent.h.

28: round_key(132) {}

Referenced by clone().

Member Function Documentation

◆ block_size()

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

Implements Botan::BlockCipher.

Definition at line 108 of file block_cipher.h.

108{ return BS; }

◆ clear()

void Botan::Serpent::clear ( )
inlinevirtual

Zeroize internal state

Implements Botan::Algorithm.

Definition at line 24 of file serpent.h.

24{ zeroise(round_key); }
Botan::zeroise
void zeroise(MemoryRegion< T > &vec)
Definition secmem.h:428

References Botan::zeroise().

◆ clone()

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

Get a new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Reimplemented in Botan::Serpent_SIMD, and Botan::Serpent_X86_32.

Definition at line 26 of file serpent.h.

26{ return new Serpent; }

References Serpent().

◆ decrypt() [1/2]

void Botan::BlockCipher::decrypt ( byte 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 74 of file block_cipher.h.

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

◆ decrypt() [2/2]

void Botan::BlockCipher::decrypt ( const byte in[],
byte 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 57 of file block_cipher.h.

58 { decrypt_n(in, out, 1); }

◆ decrypt_n()

void Botan::Serpent::decrypt_n ( const byte in[],
byte out[],
size_t blocks ) const
virtual

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.

Reimplemented in Botan::Serpent_SIMD, and Botan::Serpent_X86_32.

Definition at line 301 of file serpent.cpp.

302 {
303 for(size_t i = 0; i != blocks; ++i)
304 {
305 u32bit B0 = load_le<u32bit>(in, 0);
306 u32bit B1 = load_le<u32bit>(in, 1);
307 u32bit B2 = load_le<u32bit>(in, 2);
308 u32bit B3 = load_le<u32bit>(in, 3);
309
310 key_xor(32,B0,B1,B2,B3); SBoxD8(B0,B1,B2,B3); key_xor(31,B0,B1,B2,B3);
311 i_transform(B0,B1,B2,B3); SBoxD7(B0,B1,B2,B3); key_xor(30,B0,B1,B2,B3);
312 i_transform(B0,B1,B2,B3); SBoxD6(B0,B1,B2,B3); key_xor(29,B0,B1,B2,B3);
313 i_transform(B0,B1,B2,B3); SBoxD5(B0,B1,B2,B3); key_xor(28,B0,B1,B2,B3);
314 i_transform(B0,B1,B2,B3); SBoxD4(B0,B1,B2,B3); key_xor(27,B0,B1,B2,B3);
315 i_transform(B0,B1,B2,B3); SBoxD3(B0,B1,B2,B3); key_xor(26,B0,B1,B2,B3);
316 i_transform(B0,B1,B2,B3); SBoxD2(B0,B1,B2,B3); key_xor(25,B0,B1,B2,B3);
317 i_transform(B0,B1,B2,B3); SBoxD1(B0,B1,B2,B3); key_xor(24,B0,B1,B2,B3);
318 i_transform(B0,B1,B2,B3); SBoxD8(B0,B1,B2,B3); key_xor(23,B0,B1,B2,B3);
319 i_transform(B0,B1,B2,B3); SBoxD7(B0,B1,B2,B3); key_xor(22,B0,B1,B2,B3);
320 i_transform(B0,B1,B2,B3); SBoxD6(B0,B1,B2,B3); key_xor(21,B0,B1,B2,B3);
321 i_transform(B0,B1,B2,B3); SBoxD5(B0,B1,B2,B3); key_xor(20,B0,B1,B2,B3);
322 i_transform(B0,B1,B2,B3); SBoxD4(B0,B1,B2,B3); key_xor(19,B0,B1,B2,B3);
323 i_transform(B0,B1,B2,B3); SBoxD3(B0,B1,B2,B3); key_xor(18,B0,B1,B2,B3);
324 i_transform(B0,B1,B2,B3); SBoxD2(B0,B1,B2,B3); key_xor(17,B0,B1,B2,B3);
325 i_transform(B0,B1,B2,B3); SBoxD1(B0,B1,B2,B3); key_xor(16,B0,B1,B2,B3);
326 i_transform(B0,B1,B2,B3); SBoxD8(B0,B1,B2,B3); key_xor(15,B0,B1,B2,B3);
327 i_transform(B0,B1,B2,B3); SBoxD7(B0,B1,B2,B3); key_xor(14,B0,B1,B2,B3);
328 i_transform(B0,B1,B2,B3); SBoxD6(B0,B1,B2,B3); key_xor(13,B0,B1,B2,B3);
329 i_transform(B0,B1,B2,B3); SBoxD5(B0,B1,B2,B3); key_xor(12,B0,B1,B2,B3);
330 i_transform(B0,B1,B2,B3); SBoxD4(B0,B1,B2,B3); key_xor(11,B0,B1,B2,B3);
331 i_transform(B0,B1,B2,B3); SBoxD3(B0,B1,B2,B3); key_xor(10,B0,B1,B2,B3);
332 i_transform(B0,B1,B2,B3); SBoxD2(B0,B1,B2,B3); key_xor( 9,B0,B1,B2,B3);
333 i_transform(B0,B1,B2,B3); SBoxD1(B0,B1,B2,B3); key_xor( 8,B0,B1,B2,B3);
334 i_transform(B0,B1,B2,B3); SBoxD8(B0,B1,B2,B3); key_xor( 7,B0,B1,B2,B3);
335 i_transform(B0,B1,B2,B3); SBoxD7(B0,B1,B2,B3); key_xor( 6,B0,B1,B2,B3);
336 i_transform(B0,B1,B2,B3); SBoxD6(B0,B1,B2,B3); key_xor( 5,B0,B1,B2,B3);
337 i_transform(B0,B1,B2,B3); SBoxD5(B0,B1,B2,B3); key_xor( 4,B0,B1,B2,B3);
338 i_transform(B0,B1,B2,B3); SBoxD4(B0,B1,B2,B3); key_xor( 3,B0,B1,B2,B3);
339 i_transform(B0,B1,B2,B3); SBoxD3(B0,B1,B2,B3); key_xor( 2,B0,B1,B2,B3);
340 i_transform(B0,B1,B2,B3); SBoxD2(B0,B1,B2,B3); key_xor( 1,B0,B1,B2,B3);
341 i_transform(B0,B1,B2,B3); SBoxD1(B0,B1,B2,B3); key_xor( 0,B0,B1,B2,B3);
342
343 store_le(out, B0, B1, B2, B3);
344
345 in += BLOCK_SIZE;
346 out += BLOCK_SIZE;
347 }
348 }
Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::BLOCK_SIZE
@ BLOCK_SIZE
Definition block_cipher.h:107
Botan::load_le< u32bit >
u32bit load_le< u32bit >(const byte in[], size_t off)
Definition loadstor.h:183
Botan::u32bit
unsigned int u32bit
Definition types.h:32
Botan::store_le
void store_le(u16bit in, byte out[2])
Definition loadstor.h:427
SBoxD6
#define SBoxD6(B0, B1, B2, B3)
Definition serp_simd.cpp:351
SBoxD8
#define SBoxD8(B0, B1, B2, B3)
Definition serp_simd.cpp:403
SBoxD1
#define SBoxD1(B0, B1, B2, B3)
Definition serp_simd.cpp:221
i_transform
#define i_transform(B0, B1, B2, B3)
Definition serp_simd.cpp:455
SBoxD7
#define SBoxD7(B0, B1, B2, B3)
Definition serp_simd.cpp:379
SBoxD5
#define SBoxD5(B0, B1, B2, B3)
Definition serp_simd.cpp:325
SBoxD2
#define SBoxD2(B0, B1, B2, B3)
Definition serp_simd.cpp:246
SBoxD4
#define SBoxD4(B0, B1, B2, B3)
Definition serp_simd.cpp:299
SBoxD3
#define SBoxD3(B0, B1, B2, B3)
Definition serp_simd.cpp:274
key_xor
#define key_xor(round, B0, B1, B2, B3)
Definition serpent.cpp:240

References Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::BLOCK_SIZE, i_transform, key_xor, Botan::load_le(), SBoxD1, SBoxD2, SBoxD3, SBoxD4, SBoxD5, SBoxD6, SBoxD7, SBoxD8, and Botan::store_le().

Referenced by Botan::Serpent_SIMD::decrypt_n().

◆ encrypt() [1/2]

void Botan::BlockCipher::encrypt ( byte 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 66 of file block_cipher.h.

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

◆ encrypt() [2/2]

void Botan::BlockCipher::encrypt ( const byte in[],
byte 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 47 of file block_cipher.h.

48 { encrypt_n(in, out, 1); }

◆ encrypt_n()

void Botan::Serpent::encrypt_n ( const byte in[],
byte out[],
size_t blocks ) const
virtual

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.

Reimplemented in Botan::Serpent_SIMD, and Botan::Serpent_X86_32.

Definition at line 249 of file serpent.cpp.

250 {
251 for(size_t i = 0; i != blocks; ++i)
252 {
253 u32bit B0 = load_le<u32bit>(in, 0);
254 u32bit B1 = load_le<u32bit>(in, 1);
255 u32bit B2 = load_le<u32bit>(in, 2);
256 u32bit B3 = load_le<u32bit>(in, 3);
257
258 key_xor( 0,B0,B1,B2,B3); SBoxE1(B0,B1,B2,B3); transform(B0,B1,B2,B3);
259 key_xor( 1,B0,B1,B2,B3); SBoxE2(B0,B1,B2,B3); transform(B0,B1,B2,B3);
260 key_xor( 2,B0,B1,B2,B3); SBoxE3(B0,B1,B2,B3); transform(B0,B1,B2,B3);
261 key_xor( 3,B0,B1,B2,B3); SBoxE4(B0,B1,B2,B3); transform(B0,B1,B2,B3);
262 key_xor( 4,B0,B1,B2,B3); SBoxE5(B0,B1,B2,B3); transform(B0,B1,B2,B3);
263 key_xor( 5,B0,B1,B2,B3); SBoxE6(B0,B1,B2,B3); transform(B0,B1,B2,B3);
264 key_xor( 6,B0,B1,B2,B3); SBoxE7(B0,B1,B2,B3); transform(B0,B1,B2,B3);
265 key_xor( 7,B0,B1,B2,B3); SBoxE8(B0,B1,B2,B3); transform(B0,B1,B2,B3);
266 key_xor( 8,B0,B1,B2,B3); SBoxE1(B0,B1,B2,B3); transform(B0,B1,B2,B3);
267 key_xor( 9,B0,B1,B2,B3); SBoxE2(B0,B1,B2,B3); transform(B0,B1,B2,B3);
268 key_xor(10,B0,B1,B2,B3); SBoxE3(B0,B1,B2,B3); transform(B0,B1,B2,B3);
269 key_xor(11,B0,B1,B2,B3); SBoxE4(B0,B1,B2,B3); transform(B0,B1,B2,B3);
270 key_xor(12,B0,B1,B2,B3); SBoxE5(B0,B1,B2,B3); transform(B0,B1,B2,B3);
271 key_xor(13,B0,B1,B2,B3); SBoxE6(B0,B1,B2,B3); transform(B0,B1,B2,B3);
272 key_xor(14,B0,B1,B2,B3); SBoxE7(B0,B1,B2,B3); transform(B0,B1,B2,B3);
273 key_xor(15,B0,B1,B2,B3); SBoxE8(B0,B1,B2,B3); transform(B0,B1,B2,B3);
274 key_xor(16,B0,B1,B2,B3); SBoxE1(B0,B1,B2,B3); transform(B0,B1,B2,B3);
275 key_xor(17,B0,B1,B2,B3); SBoxE2(B0,B1,B2,B3); transform(B0,B1,B2,B3);
276 key_xor(18,B0,B1,B2,B3); SBoxE3(B0,B1,B2,B3); transform(B0,B1,B2,B3);
277 key_xor(19,B0,B1,B2,B3); SBoxE4(B0,B1,B2,B3); transform(B0,B1,B2,B3);
278 key_xor(20,B0,B1,B2,B3); SBoxE5(B0,B1,B2,B3); transform(B0,B1,B2,B3);
279 key_xor(21,B0,B1,B2,B3); SBoxE6(B0,B1,B2,B3); transform(B0,B1,B2,B3);
280 key_xor(22,B0,B1,B2,B3); SBoxE7(B0,B1,B2,B3); transform(B0,B1,B2,B3);
281 key_xor(23,B0,B1,B2,B3); SBoxE8(B0,B1,B2,B3); transform(B0,B1,B2,B3);
282 key_xor(24,B0,B1,B2,B3); SBoxE1(B0,B1,B2,B3); transform(B0,B1,B2,B3);
283 key_xor(25,B0,B1,B2,B3); SBoxE2(B0,B1,B2,B3); transform(B0,B1,B2,B3);
284 key_xor(26,B0,B1,B2,B3); SBoxE3(B0,B1,B2,B3); transform(B0,B1,B2,B3);
285 key_xor(27,B0,B1,B2,B3); SBoxE4(B0,B1,B2,B3); transform(B0,B1,B2,B3);
286 key_xor(28,B0,B1,B2,B3); SBoxE5(B0,B1,B2,B3); transform(B0,B1,B2,B3);
287 key_xor(29,B0,B1,B2,B3); SBoxE6(B0,B1,B2,B3); transform(B0,B1,B2,B3);
288 key_xor(30,B0,B1,B2,B3); SBoxE7(B0,B1,B2,B3); transform(B0,B1,B2,B3);
289 key_xor(31,B0,B1,B2,B3); SBoxE8(B0,B1,B2,B3); key_xor(32,B0,B1,B2,B3);
290
291 store_le(out, B0, B1, B2, B3);
292
293 in += BLOCK_SIZE;
294 out += BLOCK_SIZE;
295 }
296 }
SBoxE7
#define SBoxE7(B0, B1, B2, B3)
Definition serp_simd.cpp:170
SBoxE1
#define SBoxE1(B0, B1, B2, B3)
Definition serp_simd.cpp:16
SBoxE5
#define SBoxE5(B0, B1, B2, B3)
Definition serp_simd.cpp:116
SBoxE4
#define SBoxE4(B0, B1, B2, B3)
Definition serp_simd.cpp:90
SBoxE3
#define SBoxE3(B0, B1, B2, B3)
Definition serp_simd.cpp:67
SBoxE2
#define SBoxE2(B0, B1, B2, B3)
Definition serp_simd.cpp:41
transform
#define transform(B0, B1, B2, B3)
Definition serp_simd.cpp:441
SBoxE6
#define SBoxE6(B0, B1, B2, B3)
Definition serp_simd.cpp:143
SBoxE8
#define SBoxE8(B0, B1, B2, B3)
Definition serp_simd.cpp:193

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

Referenced by Botan::Serpent_SIMD::encrypt_n().

◆ get_round_keys()

const SecureVector< u32bit > & Botan::Serpent::get_round_keys ( ) const
inlineprotected

For use by subclasses using SIMD, asm, etc

Returns
const reference to the key schedule

Definition at line 34 of file serpent.h.

35 { return round_key; }

Referenced by Botan::Serpent_SIMD::decrypt_n(), Botan::Serpent_X86_32::decrypt_n(), Botan::Serpent_SIMD::encrypt_n(), and Botan::Serpent_X86_32::encrypt_n().

◆ key_spec()

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

Implements Botan::SymmetricAlgorithm.

Definition at line 110 of file block_cipher.h.

111 {
112 return Key_Length_Specification(KMIN, KMAX, KMOD);
113 }
Botan::Key_Length_Specification::Key_Length_Specification
Key_Length_Specification(size_t keylen)
Definition key_spec.h:25

◆ maximum_keylength()

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

Definition at line 33 of file sym_algo.h.

34 {
35 return key_spec().maximum_keylength();
36 }
Botan::SymmetricAlgorithm::maximum_keylength
size_t maximum_keylength() const
Definition sym_algo.h:33

◆ minimum_keylength()

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

Definition at line 41 of file sym_algo.h.

42 {
43 return key_spec().minimum_keylength();
44 }
Botan::SymmetricAlgorithm::minimum_keylength
size_t minimum_keylength() const
Definition sym_algo.h:41

◆ name()

std::string Botan::Serpent::name ( ) const
inlinevirtual
Returns
name of this algorithm

Implements Botan::Algorithm.

Definition at line 25 of file serpent.h.

25{ return "Serpent"; }

◆ parallel_bytes()

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

Definition at line 35 of file block_cipher.h.

36 {
37 return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
38 }

◆ parallelism()

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

Definition at line 30 of file block_cipher.h.

30{ return 1; }

◆ set_key() [1/2]

void Botan::SymmetricAlgorithm::set_key ( const byte 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 68 of file sym_algo.h.

69 {
70 if(!valid_keylength(length))
71 throw Invalid_Key_Length(name(), length);
72 key_schedule(key, length);
73 }
Botan::Invalid_Key_Length::Invalid_Key_Length
Invalid_Key_Length(const std::string &name, size_t length)
Definition exceptn.h:57

◆ set_key() [2/2]

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

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

◆ set_round_keys()

void Botan::Serpent::set_round_keys ( const u32bit ks[132])
inlineprotected

For use by subclasses that implement the key schedule

Parameters
ksis the new key schedule value to set

Definition at line 41 of file serpent.h.

42 {
43 copy_mem(&round_key[0], ks, 132);
44 }
Botan::copy_mem
void copy_mem(T *out, const T *in, size_t n)
Definition mem_ops.h:22

References Botan::copy_mem().

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

52 {
53 return key_spec().valid_keylength(length);
54 }
Botan::SymmetricAlgorithm::valid_keylength
bool valid_keylength(size_t length) const
Definition sym_algo.h:51
The documentation for this class was generated from the following files:
Generated by doxygen 1.18.0