Botan  1.11.15
Public Types | Public Member Functions
Botan::Blowfish Class Reference

#include <blowfish.h>

Inheritance diagram for Botan::Blowfish:
Botan::Block_Cipher_Fixed_Params< 8, 1, 56 > Botan::BlockCipher Botan::SymmetricAlgorithm

List of all members.

Public Types

enum  
typedef SCAN_Name Spec

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
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 eks_key_schedule (const byte key[], size_t key_length, const byte salt[16], size_t workfactor)
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

Blowfish

Definition at line 18 of file blowfish.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, 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::Blowfish::clear ( ) [virtual]

Implements Botan::SymmetricAlgorithm.

Definition at line 191 of file blowfish.cpp.

References Botan::zap().

   {
   zap(P);
   zap(S);
   }
BlockCipher* Botan::Blowfish::clone ( ) const [inline, virtual]
Returns:
new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 32 of file blowfish.h.

{ return new Blowfish; }
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::Blowfish::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 53 of file blowfish.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 1, 56 >::BLOCK_SIZE, Botan::get_byte(), Botan::load_be< u32bit >(), and Botan::store_be().

   {
   const u32bit* S1 = &S[0];
   const u32bit* S2 = &S[256];
   const u32bit* S3 = &S[512];
   const u32bit* S4 = &S[768];

   for(size_t i = 0; i != blocks; ++i)
      {
      u32bit L = load_be<u32bit>(in, 0);
      u32bit R = load_be<u32bit>(in, 1);

      for(size_t j = 17; j != 1; j -= 2)
         {
         L ^= P[j];
         R ^= ((S1[get_byte(0, L)]  + S2[get_byte(1, L)]) ^
                S3[get_byte(2, L)]) + S4[get_byte(3, L)];

         R ^= P[j-1];
         L ^= ((S1[get_byte(0, R)]  + S2[get_byte(1, R)]) ^
                S3[get_byte(2, R)]) + S4[get_byte(3, R)];
         }

      L ^= P[1]; R ^= P[0];

      store_be(out, R, L);

      in += BLOCK_SIZE;
      out += BLOCK_SIZE;
      }
   }
void Botan::Blowfish::eks_key_schedule ( const byte  key[],
size_t  key_length,
const byte  salt[16],
size_t  workfactor 
)

Modified EKSBlowfish key schedule, used for bcrypt password hashing

Definition at line 117 of file blowfish.cpp.

References Botan::ASN1::to_string().

   {
   // Truncate longer passwords to the 56 byte limit Blowfish enforces
   length = std::min<size_t>(length, 55);

   if(workfactor == 0)
      throw std::invalid_argument("Bcrypt work factor must be at least 1");

   /*
   * On a 2.8 GHz Core-i7, workfactor == 18 takes about 25 seconds to
   * hash a password. This seems like a reasonable upper bound for the
   * time being.
   */
   if(workfactor > 18)
      throw std::invalid_argument("Requested Bcrypt work factor " +
                                  std::to_string(workfactor) + " too large");

   P.resize(18);
   std::copy(P_INIT, P_INIT + 18, P.begin());

   S.resize(1024);
   std::copy(S_INIT, S_INIT + 1024, S.begin());

   key_expansion(key, length, salt);

   const byte null_salt[16] = { 0 };
   const size_t rounds = static_cast<size_t>(1) << workfactor;

   for(size_t r = 0; r != rounds; ++r)
      {
      key_expansion(key, length, null_salt);
      key_expansion(salt, 16, null_salt);
      }
   }
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::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:
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::Blowfish::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 18 of file blowfish.cpp.

References Botan::Block_Cipher_Fixed_Params< 8, 1, 56 >::BLOCK_SIZE, Botan::get_byte(), Botan::load_be< u32bit >(), and Botan::store_be().

   {
   const u32bit* S1 = &S[0];
   const u32bit* S2 = &S[256];
   const u32bit* S3 = &S[512];
   const u32bit* S4 = &S[768];

   for(size_t i = 0; i != blocks; ++i)
      {
      u32bit L = load_be<u32bit>(in, 0);
      u32bit R = load_be<u32bit>(in, 1);

      for(size_t j = 0; j != 16; j += 2)
         {
         L ^= P[j];
         R ^= ((S1[get_byte(0, L)]  + S2[get_byte(1, L)]) ^
                S3[get_byte(2, L)]) + S4[get_byte(3, L)];

         R ^= P[j+1];
         L ^= ((S1[get_byte(0, R)]  + S2[get_byte(1, R)]) ^
                S3[get_byte(2, R)]) + S4[get_byte(3, R)];
         }

      L ^= P[16]; R ^= P[17];

      store_be(out, R, L);

      in += BLOCK_SIZE;
      out += BLOCK_SIZE;
      }
   }
Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, 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::Blowfish::name ( ) const [inline, virtual]

Implements Botan::SymmetricAlgorithm.

Definition at line 31 of file blowfish.h.

{ return "Blowfish"; }
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:
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);
         }
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);
         }

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