Botan::Square Class Reference

#include <square.h>

Inheritance diagram for Botan::Square:

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 (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 (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	maximum_keylength () const
size_t	minimum_keylength () const
size_t	minimum_keylength () const
std::string	name () const
size_t	parallel_bytes () const
size_t	parallel_bytes () const
virtual size_t	parallelism () const
virtual size_t	parallelism () const
void	set_key (const byte key[], size_t length)
void	set_key (const SymmetricKey &key)
void	set_key (const byte key[], size_t length)
void	set_key (const SymmetricKey &key)
	Square ()
bool	valid_keylength (size_t length) const
bool	valid_keylength (size_t length) const

Detailed Description

Square

Definition at line 18 of file square.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Definition at line 107 of file block_cipher.h.

{ BLOCK_SIZE = BS };

Constructor & Destructor Documentation

Square()

Botan::Square::Square ( )

inline

Definition at line 28 of file square.h.

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

Referenced by clone().

Member Function Documentation

block_size()

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.

{ return BS; }

clear()

void Botan::Square::clear ( )

virtual

Zeroize internal state

Implements Botan::Algorithm.

Definition at line 210 of file square.cpp.

   {
   zeroise(EK);
   zeroise(DK);
   zeroise(ME);
   zeroise(MD);
   }

References Botan::zeroise().

clone()

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.

{ return new Square; }

References Square().

decrypt() [1/4]

void Botan::BlockCipher::decrypt ( byte block[] ) const

inlineinherited

Decrypt a block.

Parameters

block

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

{ decrypt_n(block, block, 1); }

decrypt() [2/4]

void Botan::BlockCipher::decrypt ( const byte in[], byte out[] ) const

inlineinherited

Decrypt a block.

Parameters

in	The ciphertext block to be decypted as a byte array. Must be of length block_size().
out	The byte array designated to hold the decrypted block. Must be of length block_size().

Definition at line 57 of file block_cipher.h.

         { decrypt_n(in, out, 1); }

decrypt() [3/4]

void Botan::BlockCipher::decrypt ( byte block[] ) const

inlineinherited

Decrypt a block.

Parameters

block

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

{ decrypt_n(block, block, 1); }

References decrypt_n().

decrypt() [4/4]

void Botan::BlockCipher::decrypt ( const byte in[], byte out[] ) const

inlineinherited

Decrypt a block.

Parameters

in	The ciphertext block to be decypted as a byte array. Must be of length block_size().
out	The byte array designated to hold the decrypted block. Must be of length block_size().

Definition at line 57 of file block_cipher.h.

         { decrypt_n(in, out, 1); }

References decrypt_n().

decrypt_n()

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

virtual

Decrypt one or more blocks

Parameters

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)
blocks	the number of blocks to process

Implements Botan::BlockCipher.

Definition at line 81 of file square.cpp.

   {
   for(size_t i = 0; i != blocks; ++i)
      {
      u32bit B0, B1, B2, B3;
 
      B0 = TD0[in[ 0] ^ MD[ 0]] ^ TD1[in[ 4] ^ MD[ 4]] ^
           TD2[in[ 8] ^ MD[ 8]] ^ TD3[in[12] ^ MD[12]] ^ DK[0];
      B1 = TD0[in[ 1] ^ MD[ 1]] ^ TD1[in[ 5] ^ MD[ 5]] ^
           TD2[in[ 9] ^ MD[ 9]] ^ TD3[in[13] ^ MD[13]] ^ DK[1];
      B2 = TD0[in[ 2] ^ MD[ 2]] ^ TD1[in[ 6] ^ MD[ 6]] ^
           TD2[in[10] ^ MD[10]] ^ TD3[in[14] ^ MD[14]] ^ DK[2];
      B3 = TD0[in[ 3] ^ MD[ 3]] ^ TD1[in[ 7] ^ MD[ 7]] ^
           TD2[in[11] ^ MD[11]] ^ TD3[in[15] ^ MD[15]] ^ DK[3];
 
      for(size_t j = 1; j != 7; j += 2)
         {
         u32bit T0, T1, T2, T3;
         T0 = TD0[get_byte(0, B0)] ^ TD1[get_byte(0, B1)] ^
              TD2[get_byte(0, B2)] ^ TD3[get_byte(0, B3)] ^ DK[4*j+0];
         T1 = TD0[get_byte(1, B0)] ^ TD1[get_byte(1, B1)] ^
              TD2[get_byte(1, B2)] ^ TD3[get_byte(1, B3)] ^ DK[4*j+1];
         T2 = TD0[get_byte(2, B0)] ^ TD1[get_byte(2, B1)] ^
              TD2[get_byte(2, B2)] ^ TD3[get_byte(2, B3)] ^ DK[4*j+2];
         T3 = TD0[get_byte(3, B0)] ^ TD1[get_byte(3, B1)] ^
              TD2[get_byte(3, B2)] ^ TD3[get_byte(3, B3)] ^ DK[4*j+3];
 
         B0 = TD0[get_byte(0, T0)] ^ TD1[get_byte(0, T1)] ^
              TD2[get_byte(0, T2)] ^ TD3[get_byte(0, T3)] ^ DK[4*j+4];
         B1 = TD0[get_byte(1, T0)] ^ TD1[get_byte(1, T1)] ^
              TD2[get_byte(1, T2)] ^ TD3[get_byte(1, T3)] ^ DK[4*j+5];
         B2 = TD0[get_byte(2, T0)] ^ TD1[get_byte(2, T1)] ^
              TD2[get_byte(2, T2)] ^ TD3[get_byte(2, T3)] ^ DK[4*j+6];
         B3 = TD0[get_byte(3, T0)] ^ TD1[get_byte(3, T1)] ^
              TD2[get_byte(3, T2)] ^ TD3[get_byte(3, T3)] ^ DK[4*j+7];
         }
 
      out[ 0] = SD[get_byte(0, B0)] ^ MD[16];
      out[ 1] = SD[get_byte(0, B1)] ^ MD[17];
      out[ 2] = SD[get_byte(0, B2)] ^ MD[18];
      out[ 3] = SD[get_byte(0, B3)] ^ MD[19];
      out[ 4] = SD[get_byte(1, B0)] ^ MD[20];
      out[ 5] = SD[get_byte(1, B1)] ^ MD[21];
      out[ 6] = SD[get_byte(1, B2)] ^ MD[22];
      out[ 7] = SD[get_byte(1, B3)] ^ MD[23];
      out[ 8] = SD[get_byte(2, B0)] ^ MD[24];
      out[ 9] = SD[get_byte(2, B1)] ^ MD[25];
      out[10] = SD[get_byte(2, B2)] ^ MD[26];
      out[11] = SD[get_byte(2, B3)] ^ MD[27];
      out[12] = SD[get_byte(3, B0)] ^ MD[28];
      out[13] = SD[get_byte(3, B1)] ^ MD[29];
      out[14] = SD[get_byte(3, B2)] ^ MD[30];
      out[15] = SD[get_byte(3, B3)] ^ MD[31];
 
      in += BLOCK_SIZE;
      out += BLOCK_SIZE;
      }
   }

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

encrypt() [1/4]

void Botan::BlockCipher::encrypt ( byte block[] ) const

inlineinherited

Encrypt a block.

Parameters

block

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

{ encrypt_n(block, block, 1); }

encrypt() [2/4]

void Botan::BlockCipher::encrypt ( const byte in[], byte out[] ) const

inlineinherited

Encrypt a block.

Parameters

in	The plaintext block to be encrypted as a byte array. Must be of length block_size().
out	The byte array designated to hold the encrypted block. Must be of length block_size().

Definition at line 47 of file block_cipher.h.

         { encrypt_n(in, out, 1); }

encrypt() [3/4]

void Botan::BlockCipher::encrypt ( byte block[] ) const

inlineinherited

Encrypt a block.

Parameters

block

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

{ encrypt_n(block, block, 1); }

References encrypt_n().

encrypt() [4/4]

void Botan::BlockCipher::encrypt ( const byte in[], byte out[] ) const

inlineinherited

Encrypt a block.

Parameters

in	The plaintext block to be encrypted as a byte array. Must be of length block_size().
out	The byte array designated to hold the encrypted block. Must be of length block_size().

Definition at line 47 of file block_cipher.h.

         { encrypt_n(in, out, 1); }

References encrypt_n().

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

encrypt_n()

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

virtual

Encrypt one or more blocks

Parameters

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)
blocks	the number of blocks to process

Implements Botan::BlockCipher.

Definition at line 19 of file square.cpp.

   {
   for(size_t i = 0; i != blocks; ++i)
      {
      u32bit B0, B1, B2, B3;
 
      B0 = TE0[in[ 0] ^ ME[ 0]] ^ TE1[in[ 4] ^ ME[ 4]] ^
           TE2[in[ 8] ^ ME[ 8]] ^ TE3[in[12] ^ ME[12]] ^ EK[0];
      B1 = TE0[in[ 1] ^ ME[ 1]] ^ TE1[in[ 5] ^ ME[ 5]] ^
           TE2[in[ 9] ^ ME[ 9]] ^ TE3[in[13] ^ ME[13]] ^ EK[1];
      B2 = TE0[in[ 2] ^ ME[ 2]] ^ TE1[in[ 6] ^ ME[ 6]] ^
           TE2[in[10] ^ ME[10]] ^ TE3[in[14] ^ ME[14]] ^ EK[2];
      B3 = TE0[in[ 3] ^ ME[ 3]] ^ TE1[in[ 7] ^ ME[ 7]] ^
           TE2[in[11] ^ ME[11]] ^ TE3[in[15] ^ ME[15]] ^ EK[3];
 
      for(size_t j = 1; j != 7; j += 2)
         {
         u32bit T0, T1, T2, T3;
         T0 = TE0[get_byte(0, B0)] ^ TE1[get_byte(0, B1)] ^
              TE2[get_byte(0, B2)] ^ TE3[get_byte(0, B3)] ^ EK[4*j+0];
         T1 = TE0[get_byte(1, B0)] ^ TE1[get_byte(1, B1)] ^
              TE2[get_byte(1, B2)] ^ TE3[get_byte(1, B3)] ^ EK[4*j+1];
         T2 = TE0[get_byte(2, B0)] ^ TE1[get_byte(2, B1)] ^
              TE2[get_byte(2, B2)] ^ TE3[get_byte(2, B3)] ^ EK[4*j+2];
         T3 = TE0[get_byte(3, B0)] ^ TE1[get_byte(3, B1)] ^
              TE2[get_byte(3, B2)] ^ TE3[get_byte(3, B3)] ^ EK[4*j+3];
 
         B0 = TE0[get_byte(0, T0)] ^ TE1[get_byte(0, T1)] ^
              TE2[get_byte(0, T2)] ^ TE3[get_byte(0, T3)] ^ EK[4*j+4];
         B1 = TE0[get_byte(1, T0)] ^ TE1[get_byte(1, T1)] ^
              TE2[get_byte(1, T2)] ^ TE3[get_byte(1, T3)] ^ EK[4*j+5];
         B2 = TE0[get_byte(2, T0)] ^ TE1[get_byte(2, T1)] ^
              TE2[get_byte(2, T2)] ^ TE3[get_byte(2, T3)] ^ EK[4*j+6];
         B3 = TE0[get_byte(3, T0)] ^ TE1[get_byte(3, T1)] ^
              TE2[get_byte(3, T2)] ^ TE3[get_byte(3, T3)] ^ EK[4*j+7];
         }
 
      out[ 0] = SE[get_byte(0, B0)] ^ ME[16];
      out[ 1] = SE[get_byte(0, B1)] ^ ME[17];
      out[ 2] = SE[get_byte(0, B2)] ^ ME[18];
      out[ 3] = SE[get_byte(0, B3)] ^ ME[19];
      out[ 4] = SE[get_byte(1, B0)] ^ ME[20];
      out[ 5] = SE[get_byte(1, B1)] ^ ME[21];
      out[ 6] = SE[get_byte(1, B2)] ^ ME[22];
      out[ 7] = SE[get_byte(1, B3)] ^ ME[23];
      out[ 8] = SE[get_byte(2, B0)] ^ ME[24];
      out[ 9] = SE[get_byte(2, B1)] ^ ME[25];
      out[10] = SE[get_byte(2, B2)] ^ ME[26];
      out[11] = SE[get_byte(2, B3)] ^ ME[27];
      out[12] = SE[get_byte(3, B0)] ^ ME[28];
      out[13] = SE[get_byte(3, B1)] ^ ME[29];
      out[14] = SE[get_byte(3, B2)] ^ ME[30];
      out[15] = SE[get_byte(3, B3)] ^ ME[31];
 
      in += BLOCK_SIZE;
      out += BLOCK_SIZE;
      }
   }

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

key_spec()

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.

         {
         return Key_Length_Specification(KMIN, KMAX, KMOD);
         }

maximum_keylength() [1/2]

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const

inlineinherited

Returns

minimum allowed key length

Definition at line 33 of file sym_algo.h.

         {
         return key_spec().maximum_keylength();
         }

maximum_keylength() [2/2]

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const

inlineinherited

Returns

minimum allowed key length

Definition at line 33 of file sym_algo.h.

         {
         return key_spec().maximum_keylength();
         }

References key_spec().

minimum_keylength() [1/2]

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const

inlineinherited

Returns

maxmium allowed key length

Definition at line 41 of file sym_algo.h.

         {
         return key_spec().minimum_keylength();
         }

minimum_keylength() [2/2]

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const

inlineinherited

Returns

maxmium allowed key length

Definition at line 41 of file sym_algo.h.

         {
         return key_spec().minimum_keylength();
         }

References key_spec().

name()

std::string Botan::Square::name ( ) const

inlinevirtual

Returns

name of this algorithm

Implements Botan::Algorithm.

Definition at line 25 of file square.h.

{ return "Square"; }

parallel_bytes() [1/2]

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.

         {
         return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
         }

parallel_bytes() [2/2]

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.

         {
         return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT;
         }

References block_size(), and parallelism().

parallelism() [1/2]

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.

{ return 1; }

parallelism() [2/2]

virtual size_t Botan::BlockCipher::parallelism ( ) const

inlinevirtualinherited

Returns

native parallelism of this cipher in blocks

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

Definition at line 30 of file block_cipher.h.

{ return 1; }

Referenced by parallel_bytes().

set_key() [1/4]

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

inlineinherited

Set the symmetric key of this object.

Parameters

key	the to be set as a byte array.
length	in bytes of key param

Definition at line 68 of file sym_algo.h.

         {
         if(!valid_keylength(length))
            throw Invalid_Key_Length(name(), length);
         key_schedule(key, length);
         }

set_key() [2/4]

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

inlineinherited

Set the symmetric key of this object.

Parameters

key	the SymmetricKey to be set.

Definition at line 60 of file sym_algo.h.

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

set_key() [3/4]

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

inlineinherited

Set the symmetric key of this object.

Parameters

key	the to be set as a byte array.
length	in bytes of key param

Definition at line 68 of file sym_algo.h.

         {
         if(!valid_keylength(length))
            throw Invalid_Key_Length(name(), length);
         key_schedule(key, length);
         }

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

set_key() [4/4]

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

inlineinherited

Set the symmetric key of this object.

Parameters

key	the SymmetricKey to be set.

Definition at line 60 of file sym_algo.h.

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

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

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::MAC_Filter::MAC_Filter(), Botan::MAC_Filter::MAC_Filter(), Botan::EAX_Base::set_key(), set_key(), Botan::Record_Reader::set_keys(), Botan::Record_Writer::set_keys(), Botan::StreamCipher_Filter::StreamCipher_Filter(), and Botan::StreamCipher_Filter::StreamCipher_Filter().

valid_keylength() [1/2]

bool Botan::SymmetricAlgorithm::valid_keylength ( size_t length ) const

inlineinherited

Check whether a given key length is valid for this algorithm.

Parameters

length

the key length to be checked.

Returns

true if the key length is valid.

Definition at line 51 of file sym_algo.h.

         {
         return key_spec().valid_keylength(length);
         }

valid_keylength() [2/2]

bool Botan::SymmetricAlgorithm::valid_keylength ( size_t length ) const

inlineinherited

Check whether a given key length is valid for this algorithm.

Parameters

length

the key length to be checked.

Returns

true if the key length is valid.

Definition at line 51 of file sym_algo.h.

         {
         return key_spec().valid_keylength(length);
         }

References key_spec().

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

---

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

• src/block/square/square.h
• src/block/square/sqr_tab.cpp
• src/block/square/square.cpp