Botan  1.10.9
Public Types | Public Member Functions | List of all members
Botan::Square Class Reference

#include <square.h>

Inheritance diagram for Botan::Square:
Botan::Block_Cipher_Fixed_Params< 16, 16 > Botan::BlockCipher Botan::SymmetricAlgorithm Botan::Algorithm

Public Types

enum  
 

Public Member Functions

size_t block_size () const
 
void clear ()
 
BlockCipherclone () const
 
void decrypt (const byte in[], byte out[]) const
 
void decrypt (byte block[]) const
 
void decrypt_n (const byte in[], byte out[], size_t blocks) const
 
void encrypt (const byte in[], byte out[]) const
 
void encrypt (byte block[]) 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
 
void set_key (const SymmetricKey &key)
 
void set_key (const byte key[], size_t length)
 
 Square ()
 
bool valid_keylength (size_t length) const
 

Detailed Description

Square

Definition at line 18 of file square.h.

Member Enumeration Documentation

anonymous enum
inherited

Constructor & Destructor Documentation

Botan::Square::Square ( )
inline

Definition at line 28 of file square.h.

28 : EK(28), DK(28), ME(32), MD(32) {}

Member Function Documentation

size_t Botan::Block_Cipher_Fixed_Params< BS, KMIN, 0 , 1 >::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; }
void Botan::Square::clear ( )
virtual

Zeroize internal state

Implements Botan::Algorithm.

Definition at line 210 of file square.cpp.

References Botan::zeroise().

211  {
212  zeroise(EK);
213  zeroise(DK);
214  zeroise(ME);
215  zeroise(MD);
216  }
void zeroise(MemoryRegion< T > &vec)
Definition: secmem.h:415
BlockCipher* Botan::Square::clone ( ) const
inlinevirtual

Get a new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 26 of file square.h.

26 { return new Square; }
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.

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

58  { 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 74 of file block_cipher.h.

74 { decrypt_n(block, block, 1); }
virtual void decrypt_n(const byte in[], byte out[], size_t blocks) const =0
void Botan::Square::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.

Definition at line 81 of file square.cpp.

References Botan::Block_Cipher_Fixed_Params< 16, 16 >::BLOCK_SIZE, and Botan::get_byte().

82  {
83  for(size_t i = 0; i != blocks; ++i)
84  {
85  u32bit B0, B1, B2, B3;
86 
87  B0 = TD0[in[ 0] ^ MD[ 0]] ^ TD1[in[ 4] ^ MD[ 4]] ^
88  TD2[in[ 8] ^ MD[ 8]] ^ TD3[in[12] ^ MD[12]] ^ DK[0];
89  B1 = TD0[in[ 1] ^ MD[ 1]] ^ TD1[in[ 5] ^ MD[ 5]] ^
90  TD2[in[ 9] ^ MD[ 9]] ^ TD3[in[13] ^ MD[13]] ^ DK[1];
91  B2 = TD0[in[ 2] ^ MD[ 2]] ^ TD1[in[ 6] ^ MD[ 6]] ^
92  TD2[in[10] ^ MD[10]] ^ TD3[in[14] ^ MD[14]] ^ DK[2];
93  B3 = TD0[in[ 3] ^ MD[ 3]] ^ TD1[in[ 7] ^ MD[ 7]] ^
94  TD2[in[11] ^ MD[11]] ^ TD3[in[15] ^ MD[15]] ^ DK[3];
95 
96  for(size_t j = 1; j != 7; j += 2)
97  {
98  u32bit T0, T1, T2, T3;
99  T0 = TD0[get_byte(0, B0)] ^ TD1[get_byte(0, B1)] ^
100  TD2[get_byte(0, B2)] ^ TD3[get_byte(0, B3)] ^ DK[4*j+0];
101  T1 = TD0[get_byte(1, B0)] ^ TD1[get_byte(1, B1)] ^
102  TD2[get_byte(1, B2)] ^ TD3[get_byte(1, B3)] ^ DK[4*j+1];
103  T2 = TD0[get_byte(2, B0)] ^ TD1[get_byte(2, B1)] ^
104  TD2[get_byte(2, B2)] ^ TD3[get_byte(2, B3)] ^ DK[4*j+2];
105  T3 = TD0[get_byte(3, B0)] ^ TD1[get_byte(3, B1)] ^
106  TD2[get_byte(3, B2)] ^ TD3[get_byte(3, B3)] ^ DK[4*j+3];
107 
108  B0 = TD0[get_byte(0, T0)] ^ TD1[get_byte(0, T1)] ^
109  TD2[get_byte(0, T2)] ^ TD3[get_byte(0, T3)] ^ DK[4*j+4];
110  B1 = TD0[get_byte(1, T0)] ^ TD1[get_byte(1, T1)] ^
111  TD2[get_byte(1, T2)] ^ TD3[get_byte(1, T3)] ^ DK[4*j+5];
112  B2 = TD0[get_byte(2, T0)] ^ TD1[get_byte(2, T1)] ^
113  TD2[get_byte(2, T2)] ^ TD3[get_byte(2, T3)] ^ DK[4*j+6];
114  B3 = TD0[get_byte(3, T0)] ^ TD1[get_byte(3, T1)] ^
115  TD2[get_byte(3, T2)] ^ TD3[get_byte(3, T3)] ^ DK[4*j+7];
116  }
117 
118  out[ 0] = SD[get_byte(0, B0)] ^ MD[16];
119  out[ 1] = SD[get_byte(0, B1)] ^ MD[17];
120  out[ 2] = SD[get_byte(0, B2)] ^ MD[18];
121  out[ 3] = SD[get_byte(0, B3)] ^ MD[19];
122  out[ 4] = SD[get_byte(1, B0)] ^ MD[20];
123  out[ 5] = SD[get_byte(1, B1)] ^ MD[21];
124  out[ 6] = SD[get_byte(1, B2)] ^ MD[22];
125  out[ 7] = SD[get_byte(1, B3)] ^ MD[23];
126  out[ 8] = SD[get_byte(2, B0)] ^ MD[24];
127  out[ 9] = SD[get_byte(2, B1)] ^ MD[25];
128  out[10] = SD[get_byte(2, B2)] ^ MD[26];
129  out[11] = SD[get_byte(2, B3)] ^ MD[27];
130  out[12] = SD[get_byte(3, B0)] ^ MD[28];
131  out[13] = SD[get_byte(3, B1)] ^ MD[29];
132  out[14] = SD[get_byte(3, B2)] ^ MD[30];
133  out[15] = SD[get_byte(3, B3)] ^ MD[31];
134 
135  in += BLOCK_SIZE;
136  out += BLOCK_SIZE;
137  }
138  }
byte get_byte(size_t byte_num, T input)
Definition: get_byte.h:21
unsigned int u32bit
Definition: types.h:32
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.

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::OFB::cipher(), Botan::DESX::encrypt_n(), Botan::CFB_Encryption::set_iv(), Botan::OFB::set_iv(), Botan::XTS_Encryption::set_iv(), Botan::CFB_Decryption::set_iv(), and Botan::XTS_Decryption::set_iv().

48  { 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 66 of file block_cipher.h.

66 { encrypt_n(block, block, 1); }
virtual void encrypt_n(const byte in[], byte out[], size_t blocks) const =0
void Botan::Square::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.

Definition at line 19 of file square.cpp.

References Botan::Block_Cipher_Fixed_Params< 16, 16 >::BLOCK_SIZE, and Botan::get_byte().

20  {
21  for(size_t i = 0; i != blocks; ++i)
22  {
23  u32bit B0, B1, B2, B3;
24 
25  B0 = TE0[in[ 0] ^ ME[ 0]] ^ TE1[in[ 4] ^ ME[ 4]] ^
26  TE2[in[ 8] ^ ME[ 8]] ^ TE3[in[12] ^ ME[12]] ^ EK[0];
27  B1 = TE0[in[ 1] ^ ME[ 1]] ^ TE1[in[ 5] ^ ME[ 5]] ^
28  TE2[in[ 9] ^ ME[ 9]] ^ TE3[in[13] ^ ME[13]] ^ EK[1];
29  B2 = TE0[in[ 2] ^ ME[ 2]] ^ TE1[in[ 6] ^ ME[ 6]] ^
30  TE2[in[10] ^ ME[10]] ^ TE3[in[14] ^ ME[14]] ^ EK[2];
31  B3 = TE0[in[ 3] ^ ME[ 3]] ^ TE1[in[ 7] ^ ME[ 7]] ^
32  TE2[in[11] ^ ME[11]] ^ TE3[in[15] ^ ME[15]] ^ EK[3];
33 
34  for(size_t j = 1; j != 7; j += 2)
35  {
36  u32bit T0, T1, T2, T3;
37  T0 = TE0[get_byte(0, B0)] ^ TE1[get_byte(0, B1)] ^
38  TE2[get_byte(0, B2)] ^ TE3[get_byte(0, B3)] ^ EK[4*j+0];
39  T1 = TE0[get_byte(1, B0)] ^ TE1[get_byte(1, B1)] ^
40  TE2[get_byte(1, B2)] ^ TE3[get_byte(1, B3)] ^ EK[4*j+1];
41  T2 = TE0[get_byte(2, B0)] ^ TE1[get_byte(2, B1)] ^
42  TE2[get_byte(2, B2)] ^ TE3[get_byte(2, B3)] ^ EK[4*j+2];
43  T3 = TE0[get_byte(3, B0)] ^ TE1[get_byte(3, B1)] ^
44  TE2[get_byte(3, B2)] ^ TE3[get_byte(3, B3)] ^ EK[4*j+3];
45 
46  B0 = TE0[get_byte(0, T0)] ^ TE1[get_byte(0, T1)] ^
47  TE2[get_byte(0, T2)] ^ TE3[get_byte(0, T3)] ^ EK[4*j+4];
48  B1 = TE0[get_byte(1, T0)] ^ TE1[get_byte(1, T1)] ^
49  TE2[get_byte(1, T2)] ^ TE3[get_byte(1, T3)] ^ EK[4*j+5];
50  B2 = TE0[get_byte(2, T0)] ^ TE1[get_byte(2, T1)] ^
51  TE2[get_byte(2, T2)] ^ TE3[get_byte(2, T3)] ^ EK[4*j+6];
52  B3 = TE0[get_byte(3, T0)] ^ TE1[get_byte(3, T1)] ^
53  TE2[get_byte(3, T2)] ^ TE3[get_byte(3, T3)] ^ EK[4*j+7];
54  }
55 
56  out[ 0] = SE[get_byte(0, B0)] ^ ME[16];
57  out[ 1] = SE[get_byte(0, B1)] ^ ME[17];
58  out[ 2] = SE[get_byte(0, B2)] ^ ME[18];
59  out[ 3] = SE[get_byte(0, B3)] ^ ME[19];
60  out[ 4] = SE[get_byte(1, B0)] ^ ME[20];
61  out[ 5] = SE[get_byte(1, B1)] ^ ME[21];
62  out[ 6] = SE[get_byte(1, B2)] ^ ME[22];
63  out[ 7] = SE[get_byte(1, B3)] ^ ME[23];
64  out[ 8] = SE[get_byte(2, B0)] ^ ME[24];
65  out[ 9] = SE[get_byte(2, B1)] ^ ME[25];
66  out[10] = SE[get_byte(2, B2)] ^ ME[26];
67  out[11] = SE[get_byte(2, B3)] ^ ME[27];
68  out[12] = SE[get_byte(3, B0)] ^ ME[28];
69  out[13] = SE[get_byte(3, B1)] ^ ME[29];
70  out[14] = SE[get_byte(3, B2)] ^ ME[30];
71  out[15] = SE[get_byte(3, B3)] ^ ME[31];
72 
73  in += BLOCK_SIZE;
74  out += BLOCK_SIZE;
75  }
76  }
byte get_byte(size_t byte_num, T input)
Definition: get_byte.h:21
unsigned int u32bit
Definition: types.h:32
Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, 0 , 1 >::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  }
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  }
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 41 of file sym_algo.h.

42  {
43  return key_spec().minimum_keylength();
44  }
size_t minimum_keylength() const
Definition: key_spec.h:61
virtual Key_Length_Specification key_spec() const =0
std::string Botan::Square::name ( ) const
inlinevirtual
Returns
name of this algorithm

Implements Botan::Algorithm.

Definition at line 25 of file square.h.

25 { return "Square"; }
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.

References block_size.

36  {
37  return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
38  }
virtual size_t parallelism() const
Definition: block_cipher.h:30
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 30 of file block_cipher.h.

30 { return 1; }
void Botan::SymmetricAlgorithm::set_key ( const SymmetricKey key)
inlineinherited
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  }
bool valid_keylength(size_t length) const
Definition: sym_algo.h:51
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 51 of file sym_algo.h.

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::HMAC_RNG::HMAC_RNG(), Botan::Lion::Lion(), Botan::Randpool::Randpool(), and Botan::EAX_Base::valid_keylength().

52  {
53  return key_spec().valid_keylength(length);
54  }
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: