Botan  1.10.10
Public Types | Public Member Functions | List of all members
Botan::Twofish Class Reference

#include <twofish.h>

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

Public Types

enum  
 
typedef SCAN_Name Spec
 

Public Member Functions

size_t block_size () const override
 
void clear () override
 
BlockCipherclone () const override
 
void decrypt (const byte in[], byte out[]) const
 
void decrypt (byte block[]) const
 
template<typename Alloc >
void decrypt (std::vector< byte, Alloc > &block) const
 
template<typename Alloc , typename Alloc2 >
void decrypt (const std::vector< byte, Alloc > &in, std::vector< byte, Alloc2 > &out) const
 
void decrypt_n (const byte in[], byte out[], size_t blocks) const override
 
void encrypt (const byte in[], byte out[]) const
 
void encrypt (byte block[]) const
 
template<typename Alloc >
void encrypt (std::vector< byte, Alloc > &block) const
 
template<typename Alloc , typename Alloc2 >
void encrypt (const std::vector< byte, Alloc > &in, std::vector< byte, Alloc2 > &out) const
 
void encrypt_n (const byte in[], byte out[], 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
 
void set_key (const SymmetricKey &key)
 
template<typename Alloc >
void set_key (const std::vector< byte, Alloc > &key)
 
void set_key (const byte key[], size_t length)
 
bool valid_keylength (size_t length) const
 

Detailed Description

Twofish, an AES finalist

Definition at line 18 of file twofish.h.

Member Typedef Documentation

Definition at line 22 of file block_cipher.h.

Member Enumeration Documentation

anonymous enum
inherited

Member Function Documentation

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

154 { return BS; }
void Botan::Twofish::clear ( )
overridevirtual

Implements Botan::SymmetricAlgorithm.

Definition at line 240 of file twofish.cpp.

References Botan::zap().

241  {
242  zap(SB);
243  zap(RK);
244  }
void zap(std::vector< T, Alloc > &vec)
Definition: secmem.h:193
BlockCipher* Botan::Twofish::clone ( ) const
inlineoverridevirtual
Returns
new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 26 of file twofish.h.

26 { return new Twofish; }
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 59 of file block_cipher.h.

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

60  { decrypt_n(in, out, 1); }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0
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 76 of file block_cipher.h.

76 { decrypt_n(block, block, 1); }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0
template<typename Alloc >
void Botan::BlockCipher::decrypt ( std::vector< byte, Alloc > &  block) const
inlineinherited

Decrypt one or more blocks

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

Definition at line 93 of file block_cipher.h.

94  {
95  return decrypt_n(block.data(), block.data(), block.size() / block_size());
96  }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0
template<typename Alloc , typename Alloc2 >
void Botan::BlockCipher::decrypt ( const std::vector< byte, Alloc > &  in,
std::vector< byte, 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 116 of file block_cipher.h.

118  {
119  return decrypt_n(in.data(), out.data(), in.size() / block_size());
120  }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0
void Botan::Twofish::decrypt_n ( const byte  in[],
byte  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 72 of file twofish.cpp.

References Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::BLOCK_SIZE, Botan::get_byte(), Botan::load_le< u32bit >(), Botan::rotate_left(), Botan::rotate_right(), and Botan::store_le().

73  {
74  for(size_t i = 0; i != blocks; ++i)
75  {
76  u32bit A = load_le<u32bit>(in, 0) ^ RK[4];
77  u32bit B = load_le<u32bit>(in, 1) ^ RK[5];
78  u32bit C = load_le<u32bit>(in, 2) ^ RK[6];
79  u32bit D = load_le<u32bit>(in, 3) ^ RK[7];
80 
81  for(size_t j = 0; j != 16; j += 2)
82  {
83  u32bit X, Y;
84 
85  X = SB[ get_byte(3, A)] ^ SB[256+get_byte(2, A)] ^
86  SB[512+get_byte(1, A)] ^ SB[768+get_byte(0, A)];
87  Y = SB[ get_byte(0, B)] ^ SB[256+get_byte(3, B)] ^
88  SB[512+get_byte(2, B)] ^ SB[768+get_byte(1, B)];
89  X += Y;
90  Y += X + RK[39 - 2*j];
91  X += RK[38 - 2*j];
92 
93  C = rotate_left(C, 1) ^ X;
94  D = rotate_right(D ^ Y, 1);
95 
96  X = SB[ get_byte(3, C)] ^ SB[256+get_byte(2, C)] ^
97  SB[512+get_byte(1, C)] ^ SB[768+get_byte(0, C)];
98  Y = SB[ get_byte(0, D)] ^ SB[256+get_byte(3, D)] ^
99  SB[512+get_byte(2, D)] ^ SB[768+get_byte(1, D)];
100  X += Y;
101  Y += X + RK[37 - 2*j];
102  X += RK[36 - 2*j];
103 
104  A = rotate_left(A, 1) ^ X;
105  B = rotate_right(B ^ Y, 1);
106  }
107 
108  C ^= RK[0];
109  D ^= RK[1];
110  A ^= RK[2];
111  B ^= RK[3];
112 
113  store_le(out, C, D, A, B);
114 
115  in += BLOCK_SIZE;
116  out += BLOCK_SIZE;
117  }
118  }
void store_le(u16bit in, byte out[2])
Definition: loadstor.h:428
T rotate_left(T input, size_t rot)
Definition: rotate.h:21
std::uint32_t u32bit
Definition: types.h:33
byte get_byte(size_t byte_num, T input)
Definition: get_byte.h:21
T rotate_right(T input, size_t rot)
Definition: rotate.h:34
u32bit load_le< u32bit >(const byte in[], size_t off)
Definition: loadstor.h:184
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 49 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::CFB_Encryption::update(), Botan::CBC_Encryption::update(), and Botan::CFB_Decryption::update().

50  { encrypt_n(in, out, 1); }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
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 68 of file block_cipher.h.

68 { encrypt_n(block, block, 1); }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
template<typename Alloc >
void Botan::BlockCipher::encrypt ( std::vector< byte, Alloc > &  block) const
inlineinherited

Encrypt one or more blocks

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

Definition at line 83 of file block_cipher.h.

84  {
85  return encrypt_n(block.data(), block.data(), block.size() / block_size());
86  }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0
template<typename Alloc , typename Alloc2 >
void Botan::BlockCipher::encrypt ( const std::vector< byte, Alloc > &  in,
std::vector< byte, 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 104 of file block_cipher.h.

106  {
107  return encrypt_n(in.data(), out.data(), in.size() / block_size());
108  }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
virtual size_t block_size() const =0
void Botan::Twofish::encrypt_n ( const byte  in[],
byte  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 21 of file twofish.cpp.

References Botan::Block_Cipher_Fixed_Params< 16, 16, 32, 8 >::BLOCK_SIZE, Botan::get_byte(), Botan::load_le< u32bit >(), Botan::rotate_left(), Botan::rotate_right(), and Botan::store_le().

22  {
23  for(size_t i = 0; i != blocks; ++i)
24  {
25  u32bit A = load_le<u32bit>(in, 0) ^ RK[0];
26  u32bit B = load_le<u32bit>(in, 1) ^ RK[1];
27  u32bit C = load_le<u32bit>(in, 2) ^ RK[2];
28  u32bit D = load_le<u32bit>(in, 3) ^ RK[3];
29 
30  for(size_t j = 0; j != 16; j += 2)
31  {
32  u32bit X, Y;
33 
34  X = SB[ get_byte(3, A)] ^ SB[256+get_byte(2, A)] ^
35  SB[512+get_byte(1, A)] ^ SB[768+get_byte(0, A)];
36  Y = SB[ get_byte(0, B)] ^ SB[256+get_byte(3, B)] ^
37  SB[512+get_byte(2, B)] ^ SB[768+get_byte(1, B)];
38  X += Y;
39  Y += X + RK[2*j + 9];
40  X += RK[2*j + 8];
41 
42  C = rotate_right(C ^ X, 1);
43  D = rotate_left(D, 1) ^ Y;
44 
45  X = SB[ get_byte(3, C)] ^ SB[256+get_byte(2, C)] ^
46  SB[512+get_byte(1, C)] ^ SB[768+get_byte(0, C)];
47  Y = SB[ get_byte(0, D)] ^ SB[256+get_byte(3, D)] ^
48  SB[512+get_byte(2, D)] ^ SB[768+get_byte(1, D)];
49  X += Y;
50  Y += X + RK[2*j + 11];
51  X += RK[2*j + 10];
52 
53  A = rotate_right(A ^ X, 1);
54  B = rotate_left(B, 1) ^ Y;
55  }
56 
57  C ^= RK[4];
58  D ^= RK[5];
59  A ^= RK[6];
60  B ^= RK[7];
61 
62  store_le(out, C, D, A, B);
63 
64  in += BLOCK_SIZE;
65  out += BLOCK_SIZE;
66  }
67  }
void store_le(u16bit in, byte out[2])
Definition: loadstor.h:428
T rotate_left(T input, size_t rot)
Definition: rotate.h:21
std::uint32_t u32bit
Definition: types.h:33
byte get_byte(size_t byte_num, T input)
Definition: get_byte.h:21
T rotate_right(T input, size_t rot)
Definition: rotate.h:34
u32bit load_le< u32bit >(const byte in[], size_t off)
Definition: loadstor.h:184
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 156 of file block_cipher.h.

157  {
158  return Key_Length_Specification(KMIN, KMAX, KMOD);
159  }
size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const
inlineinherited
Returns
minimum allowed key length

Definition at line 36 of file sym_algo.h.

37  {
38  return key_spec().maximum_keylength();
39  }
size_t maximum_keylength() const
Definition: key_spec.h:69
virtual Key_Length_Specification key_spec() const =0
size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const
inlineinherited
Returns
maxmium allowed key length

Definition at line 44 of file sym_algo.h.

45  {
46  return key_spec().minimum_keylength();
47  }
size_t minimum_keylength() const
Definition: key_spec.h:61
virtual Key_Length_Specification key_spec() const =0
std::string Botan::Twofish::name ( ) const
inlineoverridevirtual

Implements Botan::SymmetricAlgorithm.

Definition at line 25 of file twofish.h.

25 { return "Twofish"; }
size_t Botan::BlockCipher::parallel_bytes ( ) const
inlineinherited
Returns
prefererred parallelism of this cipher in bytes

Definition at line 37 of file block_cipher.h.

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

38  {
39  return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
40  }
virtual size_t parallelism() const
Definition: block_cipher.h:32
virtual size_t block_size() const =0
virtual size_t Botan::BlockCipher::parallelism ( ) const
inlinevirtualinherited
Returns
native parallelism of this cipher in blocks

Reimplemented in Botan::AES_256_NI, Botan::AES_192_NI, Botan::AES_128_NI, Botan::IDEA_SSE2, Botan::Noekeon_SIMD, Botan::Serpent_SIMD, and Botan::XTEA_SIMD.

Definition at line 32 of file block_cipher.h.

32 { return 1; }
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 63 of file sym_algo.h.

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

Referenced by Botan::aont_package(), Botan::aont_unpackage(), botan_mac_set_key(), Botan::TLS::Session::decrypt(), Botan::TLS::Session::encrypt(), and Botan::pbkdf2().

64  {
65  set_key(key.begin(), key.length());
66  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:63
template<typename Alloc >
void Botan::SymmetricAlgorithm::set_key ( const std::vector< byte, Alloc > &  key)
inlineinherited

Definition at line 69 of file sym_algo.h.

70  {
71  set_key(key.data(), key.size());
72  }
void set_key(const SymmetricKey &key)
Definition: sym_algo.h:63
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 79 of file sym_algo.h.

80  {
81  if(!valid_keylength(length))
82  throw Invalid_Key_Length(name(), length);
83  key_schedule(key, length);
84  }
bool valid_keylength(size_t length) const
Definition: sym_algo.h:54
virtual std::string name() const =0
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 54 of file sym_algo.h.

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

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

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