Botan  1.11.15
Public Types | Public Member Functions | Protected Member Functions | Friends
Botan::Threefish_512 Class Reference

#include <threefish.h>

Inheritance diagram for Botan::Threefish_512:
Botan::Block_Cipher_Fixed_Params< 64, 64 > Botan::BlockCipher Botan::SymmetricAlgorithm Botan::Threefish_512_AVX2

List of all members.

Public Types

enum  
typedef SCAN_Name Spec

Public Member Functions

size_t block_size () const
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
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)
void set_tweak (const byte tweak[], size_t len)
bool valid_keylength (size_t length) const

Protected Member Functions

const secure_vector< u64bit > & get_K () const
const secure_vector< u64bit > & get_T () const

Friends

class Skein_512

Detailed Description

Threefish-512

Definition at line 18 of file threefish.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, 0 , 1 >::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::Threefish_512::clear ( ) [override, virtual]

Implements Botan::SymmetricAlgorithm.

Definition at line 249 of file threefish.cpp.

References Botan::zeroise().

   {
   zeroise(m_K);
   zeroise(m_T);
   }
BlockCipher* Botan::Threefish_512::clone ( ) const [inline, override, virtual]
Returns:
new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 28 of file threefish.h.

{ return new Threefish_512; }
void Botan::BlockCipher::decrypt ( const byte  in[],
byte  out[] 
) const [inline, inherited]

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

{ 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:
blockthe 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:
inthe input buffer (multiple of block_size())
outthe 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::Threefish_512::decrypt_n ( const byte  in[],
byte  out[],
size_t  blocks 
) const [override, 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 141 of file threefish.cpp.

References BOTAN_ASSERT, Botan::load_le< u64bit >(), Botan::store_le(), THREEFISH_DEC_8_ROUNDS, and THREEFISH_INJECT_KEY.

   {
   BOTAN_ASSERT(m_K.size() == 9, "Key was set");
   BOTAN_ASSERT(m_T.size() == 3, "Tweak was set");

#define THREEFISH_ROUND(X0,X1,X2,X3,X4,X5,X6,X7,ROT1,ROT2,ROT3,ROT4) \
   do {                                                              \
      X4 ^= X0;                                                      \
      X5 ^= X1;                                                      \
      X6 ^= X2;                                                      \
      X7 ^= X3;                                                      \
      X4 = rotate_right(X4, ROT1);                                   \
      X5 = rotate_right(X5, ROT2);                                   \
      X6 = rotate_right(X6, ROT3);                                   \
      X7 = rotate_right(X7, ROT4);                                   \
      X0 -= X4;                                                      \
      X1 -= X5;                                                      \
      X2 -= X6;                                                      \
      X3 -= X7;                                                      \
   } while(0)

#define THREEFISH_INJECT_KEY(r)              \
   do {                                      \
      X0 -= m_K[(r  ) % 9];                  \
      X1 -= m_K[(r+1) % 9];                  \
      X2 -= m_K[(r+2) % 9];                  \
      X3 -= m_K[(r+3) % 9];                  \
      X4 -= m_K[(r+4) % 9];                  \
      X5 -= m_K[(r+5) % 9] + m_T[(r  ) % 3]; \
      X6 -= m_K[(r+6) % 9] + m_T[(r+1) % 3]; \
      X7 -= m_K[(r+7) % 9] + (r);            \
   } while(0)

#define THREEFISH_DEC_8_ROUNDS(R1,R2)                         \
   do {                                                       \
      THREEFISH_ROUND(X6,X0,X2,X4, X1,X7,X5,X3,  8,35,56,22); \
      THREEFISH_ROUND(X4,X6,X0,X2, X1,X3,X5,X7, 25,29,39,43); \
      THREEFISH_ROUND(X2,X4,X6,X0, X1,X7,X5,X3, 13,50,10,17); \
      THREEFISH_ROUND(X0,X2,X4,X6, X1,X3,X5,X7, 39,30,34,24); \
      THREEFISH_INJECT_KEY(R1);                               \
                                                              \
      THREEFISH_ROUND(X6,X0,X2,X4, X1,X7,X5,X3, 44, 9,54,56); \
      THREEFISH_ROUND(X4,X6,X0,X2, X1,X3,X5,X7, 17,49,36,39); \
      THREEFISH_ROUND(X2,X4,X6,X0, X1,X7,X5,X3, 33,27,14,42); \
      THREEFISH_ROUND(X0,X2,X4,X6, X1,X3,X5,X7, 46,36,19,37); \
      THREEFISH_INJECT_KEY(R2);                               \
   } while(0)

   for(size_t i = 0; i != blocks; ++i)
      {
      u64bit X0 = load_le<u64bit>(in, 0);
      u64bit X1 = load_le<u64bit>(in, 1);
      u64bit X2 = load_le<u64bit>(in, 2);
      u64bit X3 = load_le<u64bit>(in, 3);
      u64bit X4 = load_le<u64bit>(in, 4);
      u64bit X5 = load_le<u64bit>(in, 5);
      u64bit X6 = load_le<u64bit>(in, 6);
      u64bit X7 = load_le<u64bit>(in, 7);

      THREEFISH_INJECT_KEY(18);

      THREEFISH_DEC_8_ROUNDS(17,16);
      THREEFISH_DEC_8_ROUNDS(15,14);
      THREEFISH_DEC_8_ROUNDS(13,12);
      THREEFISH_DEC_8_ROUNDS(11,10);
      THREEFISH_DEC_8_ROUNDS(9,8);
      THREEFISH_DEC_8_ROUNDS(7,6);
      THREEFISH_DEC_8_ROUNDS(5,4);
      THREEFISH_DEC_8_ROUNDS(3,2);
      THREEFISH_DEC_8_ROUNDS(1,0);

      store_le(out, X0, X1, X2, X3, X4, X5, X6, X7);

      in += 64;
      out += 64;
      }

#undef THREEFISH_DEC_8_ROUNDS
#undef THREEFISH_INJECT_KEY
#undef THREEFISH_ROUND
   }
void Botan::BlockCipher::encrypt ( const byte  in[],
byte  out[] 
) const [inline, inherited]

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::Camellia_128::encrypt_n(), Botan::DESX::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::XTS_Encryption::finish(), Botan::CTS_Encryption::finish(), Botan::CFB_Encryption::update(), Botan::CBC_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:
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.

{ 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:
blockthe 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:
inthe input buffer (multiple of block_size())
outthe 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::Threefish_512::encrypt_n ( const byte  in[],
byte  out[],
size_t  blocks 
) const [override, 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 102 of file threefish.cpp.

References BOTAN_ASSERT, Botan::load_le< u64bit >(), Botan::store_le(), THREEFISH_ENC_8_ROUNDS, and THREEFISH_INJECT_KEY.

   {
   BOTAN_ASSERT(m_K.size() == 9, "Key was set");
   BOTAN_ASSERT(m_T.size() == 3, "Tweak was set");

   for(size_t i = 0; i != blocks; ++i)
      {
      u64bit X0 = load_le<u64bit>(in, 0);
      u64bit X1 = load_le<u64bit>(in, 1);
      u64bit X2 = load_le<u64bit>(in, 2);
      u64bit X3 = load_le<u64bit>(in, 3);
      u64bit X4 = load_le<u64bit>(in, 4);
      u64bit X5 = load_le<u64bit>(in, 5);
      u64bit X6 = load_le<u64bit>(in, 6);
      u64bit X7 = load_le<u64bit>(in, 7);

      THREEFISH_INJECT_KEY(0);

      THREEFISH_ENC_8_ROUNDS(1,2);
      THREEFISH_ENC_8_ROUNDS(3,4);
      THREEFISH_ENC_8_ROUNDS(5,6);
      THREEFISH_ENC_8_ROUNDS(7,8);
      THREEFISH_ENC_8_ROUNDS(9,10);
      THREEFISH_ENC_8_ROUNDS(11,12);
      THREEFISH_ENC_8_ROUNDS(13,14);
      THREEFISH_ENC_8_ROUNDS(15,16);
      THREEFISH_ENC_8_ROUNDS(17,18);

      store_le(out, X0, X1, X2, X3, X4, X5, X6, X7);

      in += 64;
      out += 64;
      }
   }
const secure_vector<u64bit>& Botan::Threefish_512::get_K ( ) const [inline, protected]

Definition at line 31 of file threefish.h.

{ return m_K; }
const secure_vector<u64bit>& Botan::Threefish_512::get_T ( ) const [inline, protected]

Definition at line 30 of file threefish.h.

{ return m_T; }
Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, 0 , 1 >::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::Threefish_512::name ( ) const [inline, override, virtual]

Implements Botan::SymmetricAlgorithm.

Definition at line 27 of file threefish.h.

{ return "Threefish-512"; }
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::CBC_Mode::update_granularity(), and Botan::ECB_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:
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().

         {
         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:
keythe to be set as a byte array.
lengthin 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);
         }
void Botan::Threefish_512::set_tweak ( const byte  tweak[],
size_t  len 
)

Definition at line 223 of file threefish.cpp.

References Botan::load_le< u64bit >().

   {
   if(len != 16)
      throw std::runtime_error("Unsupported twofish tweak length");
   m_T.resize(3);
   m_T[0] = load_le<u64bit>(tweak, 0);
   m_T[1] = load_le<u64bit>(tweak, 1);
   m_T[2] = m_T[0] ^ m_T[1];
   }
bool Botan::SymmetricAlgorithm::valid_keylength ( size_t  length) const [inline, inherited]

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

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

Friends And Related Function Documentation

friend class Skein_512 [friend]

Definition at line 36 of file threefish.h.


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