#include <twofish.h>

Inheritance diagram for Botan::Twofish:

Public Types
enum
typedef SCAN_Name	Spec
Public Member Functions
size_t	block_size () const
void	clear ()
BlockCipher *	clone () const
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
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
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)
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

typedef SCAN_Name Botan::BlockCipher::Spec [inherited]

Definition at line 22 of file block_cipher.h.

Member Enumeration Documentation

anonymous enum [inherited]

Definition at line 153 of file block_cipher.h.

{ BLOCK_SIZE = BS };

Member Function Documentation

size_t Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >::block_size ( ) const [inline, virtual, inherited]

Returns:: block size of this algorithm

Implements Botan::BlockCipher.

Definition at line 154 of file block_cipher.h.

{ return BS; }

void Botan::Twofish::clear ( ) [virtual]

Implements Botan::SymmetricAlgorithm.

Definition at line 240 of file twofish.cpp.

References Botan::zap().

   {
   zap(SB);
   zap(RK);
   }

BlockCipher* Botan::Twofish::clone ( ) const [inline, virtual]

Returns:: new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 26 of file twofish.h.

{ return new Twofish; }

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

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

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

         { decrypt_n(in, out, 1); }

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

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

{ decrypt_n(block, block, 1); }

template<typename Alloc >

void Botan::BlockCipher::decrypt ( std::vector< byte, Alloc > & block ) const [inline, inherited]

Decrypt one or more blocks

Parameters:

block the input/output buffer (multiple of block_size())

Definition at line 93 of file block_cipher.h.

         {
         return decrypt_n(&block[0], &block[0], block.size() / block_size());
         }

template<typename Alloc , typename Alloc2 >

void Botan::BlockCipher::decrypt	(	const std::vector< byte, Alloc > &	in,
		std::vector< byte, Alloc2 > &	out
	)		const `[inline, inherited]`

Decrypt one or more blocks

Parameters:

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)

Definition at line 116 of file block_cipher.h.

         {
         return decrypt_n(&in[0], &out[0], in.size() / block_size());
         }

void Botan::Twofish::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 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().

   {
   for(size_t i = 0; i != blocks; ++i)
      {
      u32bit A = load_le<u32bit>(in, 0) ^ RK[4];
      u32bit B = load_le<u32bit>(in, 1) ^ RK[5];
      u32bit C = load_le<u32bit>(in, 2) ^ RK[6];
      u32bit D = load_le<u32bit>(in, 3) ^ RK[7];

      for(size_t j = 0; j != 16; j += 2)
         {
         u32bit X, Y;

         X = SB[    get_byte(3, A)] ^ SB[256+get_byte(2, A)] ^
             SB[512+get_byte(1, A)] ^ SB[768+get_byte(0, A)];
         Y = SB[    get_byte(0, B)] ^ SB[256+get_byte(3, B)] ^
             SB[512+get_byte(2, B)] ^ SB[768+get_byte(1, B)];
         X += Y;
         Y += X + RK[39 - 2*j];
         X += RK[38 - 2*j];

         C = rotate_left(C, 1) ^ X;
         D = rotate_right(D ^ Y, 1);

         X = SB[    get_byte(3, C)] ^ SB[256+get_byte(2, C)] ^
             SB[512+get_byte(1, C)] ^ SB[768+get_byte(0, C)];
         Y = SB[    get_byte(0, D)] ^ SB[256+get_byte(3, D)] ^
             SB[512+get_byte(2, D)] ^ SB[768+get_byte(1, D)];
         X += Y;
         Y += X + RK[37 - 2*j];
         X += RK[36 - 2*j];

         A = rotate_left(A, 1) ^ X;
         B = rotate_right(B ^ Y, 1);
         }

      C ^= RK[0];
      D ^= RK[1];
      A ^= RK[2];
      B ^= RK[3];

      store_le(out, C, D, A, B);

      in += BLOCK_SIZE;
      out += BLOCK_SIZE;
      }
   }

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

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

Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::DESX::encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::XTS_Encryption::finish(), Botan::CTS_Encryption::finish(), Botan::CBC_Encryption::update(), Botan::CFB_Encryption::update(), and Botan::CFB_Decryption::update().

         { encrypt_n(in, out, 1); }

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

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

{ encrypt_n(block, block, 1); }

template<typename Alloc >

void Botan::BlockCipher::encrypt ( std::vector< byte, Alloc > & block ) const [inline, inherited]

Encrypt one or more blocks

Parameters:

block the input/output buffer (multiple of block_size())

Definition at line 83 of file block_cipher.h.

         {
         return encrypt_n(&block[0], &block[0], block.size() / block_size());
         }

template<typename Alloc , typename Alloc2 >

void Botan::BlockCipher::encrypt	(	const std::vector< byte, Alloc > &	in,
		std::vector< byte, Alloc2 > &	out
	)		const `[inline, inherited]`

Encrypt one or more blocks

Parameters:

in	the input buffer (multiple of block_size())
out	the output buffer (same size as in)

Definition at line 104 of file block_cipher.h.

         {
         return encrypt_n(&in[0], &out[0], in.size() / block_size());
         }

void Botan::Twofish::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 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().

   {
   for(size_t i = 0; i != blocks; ++i)
      {
      u32bit A = load_le<u32bit>(in, 0) ^ RK[0];
      u32bit B = load_le<u32bit>(in, 1) ^ RK[1];
      u32bit C = load_le<u32bit>(in, 2) ^ RK[2];
      u32bit D = load_le<u32bit>(in, 3) ^ RK[3];

      for(size_t j = 0; j != 16; j += 2)
         {
         u32bit X, Y;

         X = SB[    get_byte(3, A)] ^ SB[256+get_byte(2, A)] ^
             SB[512+get_byte(1, A)] ^ SB[768+get_byte(0, A)];
         Y = SB[    get_byte(0, B)] ^ SB[256+get_byte(3, B)] ^
             SB[512+get_byte(2, B)] ^ SB[768+get_byte(1, B)];
         X += Y;
         Y += X + RK[2*j + 9];
         X += RK[2*j + 8];

         C = rotate_right(C ^ X, 1);
         D = rotate_left(D, 1) ^ Y;

         X = SB[    get_byte(3, C)] ^ SB[256+get_byte(2, C)] ^
             SB[512+get_byte(1, C)] ^ SB[768+get_byte(0, C)];
         Y = SB[    get_byte(0, D)] ^ SB[256+get_byte(3, D)] ^
             SB[512+get_byte(2, D)] ^ SB[768+get_byte(1, D)];
         X += Y;
         Y += X + RK[2*j + 11];
         X += RK[2*j + 10];

         A = rotate_right(A ^ X, 1);
         B = rotate_left(B, 1) ^ Y;
         }

      C ^= RK[4];
      D ^= RK[5];
      A ^= RK[6];
      B ^= RK[7];

      store_le(out, C, D, A, B);

      in += BLOCK_SIZE;
      out += BLOCK_SIZE;
      }
   }

Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, KMOD >::key_spec ( ) const [inline, virtual, inherited]

Returns:: object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 156 of file block_cipher.h.

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

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const [inline, inherited]

Returns:: minimum allowed key length

Definition at line 36 of file sym_algo.h.

References Botan::Key_Length_Specification::maximum_keylength().

         {
         return key_spec().maximum_keylength();
         }

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const [inline, inherited]

Returns:: maxmium allowed key length

Definition at line 44 of file sym_algo.h.

         {
         return key_spec().minimum_keylength();
         }

std::string Botan::Twofish::name ( ) const [inline, virtual]

Implements Botan::SymmetricAlgorithm.

Definition at line 25 of file twofish.h.

{ return "Twofish"; }

size_t Botan::BlockCipher::parallel_bytes ( ) const [inline, inherited]

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::ECB_Mode::update_granularity(), and Botan::CBC_Mode::update_granularity().

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

virtual size_t Botan::BlockCipher::parallelism ( ) const [inline, virtual, inherited]

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.

{ return 1; }

void Botan::SymmetricAlgorithm::set_key ( const SymmetricKey & key ) [inline, inherited]

Set the symmetric key of this object.

Parameters:

key	the 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().

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

template<typename Alloc >

void Botan::SymmetricAlgorithm::set_key ( const std::vector< byte, Alloc > & key ) [inline, inherited]

Definition at line 69 of file sym_algo.h.

         {
         set_key(&key[0], key.size());
         }

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

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

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

bool Botan::SymmetricAlgorithm::valid_keylength ( size_t length ) const [inline, inherited]

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

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

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

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

src/lib/block/twofish/twofish.h
src/lib/block/twofish/two_tab.cpp
src/lib/block/twofish/twofish.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation