Botan::Blowfish Class Reference

#include <blowfish.h>

Inheritance diagram for Botan::Blowfish:

Public Types
enum

Public Member Functions
size_t	block_size () const final
void	clear () override
BlockCipher *	clone () const
void	decrypt (const uint8_t in[], uint8_t out[]) const
void	decrypt (std::span< const uint8_t > in, std::span< uint8_t > out) const
void	decrypt (std::span< uint8_t > block) const
void	decrypt (uint8_t block[]) const
void	decrypt_n (const uint8_t in[], uint8_t out[], size_t blocks) const override
void	decrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const
void	encrypt (const uint8_t in[], uint8_t out[]) const
void	encrypt (std::span< const uint8_t > in, std::span< uint8_t > out) const
void	encrypt (std::span< uint8_t > block) const
void	encrypt (uint8_t block[]) const
void	encrypt_n (const uint8_t in[], uint8_t out[], size_t blocks) const override
void	encrypt_n_xex (uint8_t data[], const uint8_t mask[], size_t blocks) const
bool	has_keying_material () const override
Key_Length_Specification	key_spec () const final
size_t	maximum_keylength () const
size_t	minimum_keylength () const
std::string	name () const override
std::unique_ptr< BlockCipher >	new_object () const override
size_t	parallel_bytes () const
virtual size_t	parallelism () const
virtual std::string	provider () const
void	salted_set_key (const uint8_t key[], size_t key_length, const uint8_t salt[], size_t salt_length, size_t workfactor, bool salt_first=false)
void	set_key (const OctetString &key)
void	set_key (const uint8_t key[], size_t length)
void	set_key (std::span< const uint8_t > key)
bool	valid_keylength (size_t length) const

Static Public Member Functions
static std::unique_ptr< BlockCipher >	create (std::string_view algo_spec, std::string_view provider="")
static std::unique_ptr< BlockCipher >	create_or_throw (std::string_view algo_spec, std::string_view provider="")
static std::vector< std::string >	providers (std::string_view algo_spec)

Static Public Attributes
static constexpr size_t	ParallelismMult

Protected Member Functions
void	assert_key_material_set () const
void	assert_key_material_set (bool predicate) const

Detailed Description

Blowfish

Definition at line 19 of file blowfish.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Definition at line 214 of file block_cipher.h.

{ BLOCK_SIZE = BS };

Member Function Documentation

assert_key_material_set() [1/2]

void Botan::SymmetricAlgorithm::assert_key_material_set ( ) const

inlineprotectedinherited

Definition at line 141 of file sym_algo.h.

{ assert_key_material_set(has_keying_material()); }

Referenced by Botan::Blowfish::decrypt_n(), and Botan::Blowfish::encrypt_n().

assert_key_material_set() [2/2]

void Botan::SymmetricAlgorithm::assert_key_material_set ( bool predicate ) const

inlineprotectedinherited

Definition at line 143 of file sym_algo.h.

                                                         {
         if(!predicate) {
            throw_key_not_set_error();
         }
      }

block_size()

size_t Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, 1, BlockCipher >::block_size ( ) const

inlinefinalvirtualinherited

Returns

block size of this algorithm

Implements Botan::BlockCipher.

Definition at line 216 of file block_cipher.h.

{ return BS; }

clear()

void Botan::Blowfish::clear ( )

overridevirtual

Reset the internal state. This includes not just the key, but any partial message that may have been in process.

Implements Botan::SymmetricAlgorithm.

Definition at line 391 of file blowfish.cpp.

                     {
   zap(m_P);
   zap(m_S);
}

References Botan::zap().

clone()

BlockCipher * Botan::BlockCipher::clone ( ) const

inlineinherited

Definition at line 188 of file block_cipher.h.

{ return this->new_object().release(); }

create()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create ( std::string_view algo_spec, std::string_view provider = "" )

staticinherited

Create an instance based on a name If provider is empty then best available is chosen.

Parameters

algo_spec	algorithm name
provider	provider implementation to choose

Returns

a null pointer if the algo/provider combination cannot be found

Definition at line 31 of file block_cipher.cpp.

                                                                                           {
#if defined(BOTAN_HAS_COMMONCRYPTO)
   if(provider.empty() || provider == "commoncrypto") {
      if(auto bc = make_commoncrypto_block_cipher(algo))
         return bc;
 
      if(!provider.empty())
         return nullptr;
   }
#endif
 
   // TODO: CryptoAPI
   // TODO: /dev/crypto
 
   // Only base providers from here on out
   if(provider.empty() == false && provider != "base") {
      return nullptr;
   }
 
#if defined(BOTAN_HAS_AES)
   if(algo == "AES-128") {
      return std::make_unique<AES_128>();
   }
 
   if(algo == "AES-192") {
      return std::make_unique<AES_192>();
   }
 
   if(algo == "AES-256") {
      return std::make_unique<AES_256>();
   }
#endif
 
#if defined(BOTAN_HAS_ARIA)
   if(algo == "ARIA-128") {
      return std::make_unique<ARIA_128>();
   }
 
   if(algo == "ARIA-192") {
      return std::make_unique<ARIA_192>();
   }
 
   if(algo == "ARIA-256") {
      return std::make_unique<ARIA_256>();
   }
#endif
 
#if defined(BOTAN_HAS_SERPENT)
   if(algo == "Serpent") {
      return std::make_unique<Serpent>();
   }
#endif
 
#if defined(BOTAN_HAS_SHACAL2)
   if(algo == "SHACAL2") {
      return std::make_unique<SHACAL2>();
   }
#endif
 
#if defined(BOTAN_HAS_TWOFISH)
   if(algo == "Twofish") {
      return std::make_unique<Twofish>();
   }
#endif
 
#if defined(BOTAN_HAS_THREEFISH_512)
   if(algo == "Threefish-512") {
      return std::make_unique<Threefish_512>();
   }
#endif
 
#if defined(BOTAN_HAS_BLOWFISH)
   if(algo == "Blowfish") {
      return std::make_unique<Blowfish>();
   }
#endif
 
#if defined(BOTAN_HAS_CAMELLIA)
   if(algo == "Camellia-128") {
      return std::make_unique<Camellia_128>();
   }
 
   if(algo == "Camellia-192") {
      return std::make_unique<Camellia_192>();
   }
 
   if(algo == "Camellia-256") {
      return std::make_unique<Camellia_256>();
   }
#endif
 
#if defined(BOTAN_HAS_DES)
   if(algo == "DES") {
      return std::make_unique<DES>();
   }
 
   if(algo == "TripleDES" || algo == "3DES" || algo == "DES-EDE") {
      return std::make_unique<TripleDES>();
   }
#endif
 
#if defined(BOTAN_HAS_NOEKEON)
   if(algo == "Noekeon") {
      return std::make_unique<Noekeon>();
   }
#endif
 
#if defined(BOTAN_HAS_CAST_128)
   if(algo == "CAST-128" || algo == "CAST5") {
      return std::make_unique<CAST_128>();
   }
#endif
 
#if defined(BOTAN_HAS_IDEA)
   if(algo == "IDEA") {
      return std::make_unique<IDEA>();
   }
#endif
 
#if defined(BOTAN_HAS_KUZNYECHIK)
   if(algo == "Kuznyechik") {
      return std::make_unique<Kuznyechik>();
   }
#endif
 
#if defined(BOTAN_HAS_SEED)
   if(algo == "SEED") {
      return std::make_unique<SEED>();
   }
#endif
 
#if defined(BOTAN_HAS_SM4)
   if(algo == "SM4") {
      return std::make_unique<SM4>();
   }
#endif
 
   const SCAN_Name req(algo);
 
#if defined(BOTAN_HAS_GOST_28147_89)
   if(req.algo_name() == "GOST-28147-89") {
      return std::make_unique<GOST_28147_89>(req.arg(0, "R3411_94_TestParam"));
   }
#endif
 
#if defined(BOTAN_HAS_CASCADE)
   if(req.algo_name() == "Cascade" && req.arg_count() == 2) {
      auto c1 = BlockCipher::create(req.arg(0));
      auto c2 = BlockCipher::create(req.arg(1));
 
      if(c1 && c2) {
         return std::make_unique<Cascade_Cipher>(std::move(c1), std::move(c2));
      }
   }
#endif
 
#if defined(BOTAN_HAS_LION)
   if(req.algo_name() == "Lion" && req.arg_count_between(2, 3)) {
      auto hash = HashFunction::create(req.arg(0));
      auto stream = StreamCipher::create(req.arg(1));
 
      if(hash && stream) {
         const size_t block_size = req.arg_as_integer(2, 1024);
         return std::make_unique<Lion>(std::move(hash), std::move(stream), block_size);
      }
   }
#endif
 
   BOTAN_UNUSED(req);
   BOTAN_UNUSED(provider);
 
   return nullptr;
}

create_or_throw()

std::unique_ptr< BlockCipher > Botan::BlockCipher::create_or_throw ( std::string_view algo_spec, std::string_view provider = "" )

staticinherited

Create an instance based on a name, or throw if the algo/provider combination cannot be found. If provider is empty then best available is chosen.

Definition at line 38 of file block_cipher.cpp.

                                                                                                    {
   if(auto bc = BlockCipher::create(algo, provider)) {
      return bc;
   }
   throw Lookup_Error("Block cipher", algo, provider);
}

decrypt() [1/4]

void Botan::BlockCipher::decrypt ( const uint8_t in[], uint8_t 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 91 of file block_cipher.h.

{ decrypt_n(in, out, 1); }

decrypt() [2/4]

void Botan::BlockCipher::decrypt ( std::span< const uint8_t > in, std::span< uint8_t > out ) const

inlineinherited

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

                                                                          {
         return decrypt_n(in.data(), out.data(), in.size() / block_size());
      }

decrypt() [3/4]

void Botan::BlockCipher::decrypt ( std::span< uint8_t > block ) const

inlineinherited

Decrypt one or more blocks

Parameters

block

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

Definition at line 121 of file block_cipher.h.

                                                 {
         return decrypt_n(block.data(), block.data(), block.size() / block_size());
      }

decrypt() [4/4]

void Botan::BlockCipher::decrypt ( uint8_t 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 107 of file block_cipher.h.

{ decrypt_n(block, block, 1); }

decrypt_n()

void Botan::Blowfish::decrypt_n ( const uint8_t in[], uint8_t out[], size_t blocks ) const

overridevirtual

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 225 of file blowfish.cpp.

                                                                               {
   assert_key_material_set();
 
   while(blocks >= 4) {
      uint32_t L0, R0, L1, R1, L2, R2, L3, R3;
      load_be(in, L0, R0, L1, R1, L2, R2, L3, R3);
 
      for(size_t r = 17; r != 1; r -= 2) {
         L0 ^= m_P[r];
         L1 ^= m_P[r];
         L2 ^= m_P[r];
         L3 ^= m_P[r];
         R0 ^= BFF(L0, m_S);
         R1 ^= BFF(L1, m_S);
         R2 ^= BFF(L2, m_S);
         R3 ^= BFF(L3, m_S);
 
         R0 ^= m_P[r - 1];
         R1 ^= m_P[r - 1];
         R2 ^= m_P[r - 1];
         R3 ^= m_P[r - 1];
 
         L0 ^= BFF(R0, m_S);
         L1 ^= BFF(R1, m_S);
         L2 ^= BFF(R2, m_S);
         L3 ^= BFF(R3, m_S);
      }
 
      L0 ^= m_P[1];
      R0 ^= m_P[0];
      L1 ^= m_P[1];
      R1 ^= m_P[0];
      L2 ^= m_P[1];
      R2 ^= m_P[0];
      L3 ^= m_P[1];
      R3 ^= m_P[0];
 
      store_be(out, R0, L0, R1, L1, R2, L2, R3, L3);
 
      in += 4 * BLOCK_SIZE;
      out += 4 * BLOCK_SIZE;
      blocks -= 4;
   }
 
   while(blocks) {
      uint32_t L, R;
      load_be(in, L, R);
 
      for(size_t r = 17; r != 1; r -= 2) {
         L ^= m_P[r];
         R ^= BFF(L, m_S);
 
         R ^= m_P[r - 1];
         L ^= BFF(R, m_S);
      }
 
      L ^= m_P[1];
      R ^= m_P[0];
 
      store_be(out, R, L);
 
      in += BLOCK_SIZE;
      out += BLOCK_SIZE;
      blocks--;
   }
}

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

decrypt_n_xex()

void Botan::BlockCipher::decrypt_n_xex ( uint8_t data[], const uint8_t mask[], size_t blocks ) const

inlineinherited

Definition at line 172 of file block_cipher.h.

                                                                                    {
         const size_t BS = block_size();
         for(size_t i = 0; i != blocks * BS; ++i) {
            data[i] ^= mask[i];
         }
         decrypt_n(data, data, blocks);
         for(size_t i = 0; i != blocks * BS; ++i) {
            data[i] ^= mask[i];
         }
      }

encrypt() [1/4]

void Botan::BlockCipher::encrypt ( const uint8_t in[], uint8_t 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 82 of file block_cipher.h.

{ encrypt_n(in, out, 1); }

encrypt() [2/4]

void Botan::BlockCipher::encrypt ( std::span< const uint8_t > in, std::span< uint8_t > out ) const

inlineinherited

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

                                                                          {
         return encrypt_n(in.data(), out.data(), in.size() / block_size());
      }

encrypt() [3/4]

void Botan::BlockCipher::encrypt ( std::span< uint8_t > block ) const

inlineinherited

Encrypt one or more blocks

Parameters

block

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

Definition at line 113 of file block_cipher.h.

                                                 {
         return encrypt_n(block.data(), block.data(), block.size() / block_size());
      }

encrypt() [4/4]

void Botan::BlockCipher::encrypt ( uint8_t 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 99 of file block_cipher.h.

{ encrypt_n(block, block, 1); }

encrypt_n()

void Botan::Blowfish::encrypt_n ( const uint8_t in[], uint8_t out[], size_t blocks ) const

overridevirtual

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 156 of file blowfish.cpp.

                                                                               {
   assert_key_material_set();
 
   while(blocks >= 4) {
      uint32_t L0, R0, L1, R1, L2, R2, L3, R3;
      load_be(in, L0, R0, L1, R1, L2, R2, L3, R3);
 
      for(size_t r = 0; r != 16; r += 2) {
         L0 ^= m_P[r];
         L1 ^= m_P[r];
         L2 ^= m_P[r];
         L3 ^= m_P[r];
         R0 ^= BFF(L0, m_S);
         R1 ^= BFF(L1, m_S);
         R2 ^= BFF(L2, m_S);
         R3 ^= BFF(L3, m_S);
 
         R0 ^= m_P[r + 1];
         R1 ^= m_P[r + 1];
         R2 ^= m_P[r + 1];
         R3 ^= m_P[r + 1];
         L0 ^= BFF(R0, m_S);
         L1 ^= BFF(R1, m_S);
         L2 ^= BFF(R2, m_S);
         L3 ^= BFF(R3, m_S);
      }
 
      L0 ^= m_P[16];
      R0 ^= m_P[17];
      L1 ^= m_P[16];
      R1 ^= m_P[17];
      L2 ^= m_P[16];
      R2 ^= m_P[17];
      L3 ^= m_P[16];
      R3 ^= m_P[17];
 
      store_be(out, R0, L0, R1, L1, R2, L2, R3, L3);
 
      in += 4 * BLOCK_SIZE;
      out += 4 * BLOCK_SIZE;
      blocks -= 4;
   }
 
   while(blocks) {
      uint32_t L, R;
      load_be(in, L, R);
 
      for(size_t r = 0; r != 16; r += 2) {
         L ^= m_P[r];
         R ^= BFF(L, m_S);
 
         R ^= m_P[r + 1];
         L ^= BFF(R, m_S);
      }
 
      L ^= m_P[16];
      R ^= m_P[17];
 
      store_be(out, R, L);
 
      in += BLOCK_SIZE;
      out += BLOCK_SIZE;
      blocks--;
   }
}

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

encrypt_n_xex()

void Botan::BlockCipher::encrypt_n_xex ( uint8_t data[], const uint8_t mask[], size_t blocks ) const

inlineinherited

Definition at line 160 of file block_cipher.h.

                                                                                    {
         const size_t BS = block_size();
         for(size_t i = 0; i != blocks * BS; ++i) {
            data[i] ^= mask[i];
         }
         encrypt_n(data, data, blocks);
         for(size_t i = 0; i != blocks * BS; ++i) {
            data[i] ^= mask[i];
         }
      }

has_keying_material()

bool Botan::Blowfish::has_keying_material ( ) const

overridevirtual

Returns

true if a key has been set on this object

Implements Botan::SymmetricAlgorithm.

Definition at line 292 of file blowfish.cpp.

                                         {
   return !m_P.empty();
}

key_spec()

Key_Length_Specification Botan::Block_Cipher_Fixed_Params< BS, KMIN, KMAX, 1, BlockCipher >::key_spec ( ) const

inlinefinalvirtualinherited

Returns

object describing limits on key size

Implements Botan::SymmetricAlgorithm.

Definition at line 218 of file block_cipher.h.

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

maximum_keylength()

size_t Botan::SymmetricAlgorithm::maximum_keylength ( ) const

inlineinherited

Returns

maximum allowed key length

Definition at line 97 of file sym_algo.h.

{ return key_spec().maximum_keylength(); }

minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const

inlineinherited

Returns

minimum allowed key length

Definition at line 102 of file sym_algo.h.

{ return key_spec().minimum_keylength(); }

name()

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

inlineoverridevirtual

Returns

the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 36 of file blowfish.h.

{ return "Blowfish"; }

new_object()

std::unique_ptr< BlockCipher > Botan::Blowfish::new_object ( ) const

inlineoverridevirtual

Returns

new object representing the same algorithm as *this

Implements Botan::BlockCipher.

Definition at line 38 of file blowfish.h.

{ return std::make_unique<Blowfish>(); }

parallel_bytes()

size_t Botan::BlockCipher::parallel_bytes ( ) const

inlineinherited

Returns

prefererred parallelism of this cipher in bytes

Definition at line 67 of file block_cipher.h.

{ return parallelism() * block_size() * BlockCipher::ParallelismMult; }

parallelism()

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

inlinevirtualinherited

Returns

native parallelism of this cipher in blocks

Definition at line 62 of file block_cipher.h.

{ return 1; }

provider()

virtual std::string Botan::BlockCipher::provider ( ) const

inlinevirtualinherited

Returns

provider information about this implementation. Default is "base", might also return "sse2", "avx2", "openssl", or some other arbitrary string.

Definition at line 73 of file block_cipher.h.

{ return "base"; }

providers()

std::vector< std::string > Botan::BlockCipher::providers ( std::string_view algo_spec )

staticinherited

Returns

list of available providers for this algorithm, empty if not available

Parameters

algo_spec

algorithm name

Definition at line 44 of file block_cipher.cpp.

                                                               {
   return probe_providers_of<BlockCipher>(algo, {"base", "commoncrypto"});
}

salted_set_key()

void Botan::Blowfish::salted_set_key	(	const uint8_t	key[],
		size_t	key_length,
		const uint8_t	salt[],
		size_t	salt_length,
		size_t	workfactor,
		bool	salt_first = false )

Modified EKSBlowfish key schedule, used for bcrypt password hashing

Definition at line 326 of file blowfish.cpp.

                                                                                                                     {
   BOTAN_ARG_CHECK(salt_length > 0 && salt_length % 4 == 0, "Invalid salt length for Blowfish salted key schedule");
 
   if(length > 72) {
      // Truncate longer passwords to the 72 char bcrypt limit
      length = 72;
   }
 
   m_P.resize(18);
   copy_mem(m_P.data(), P_INIT, 18);
 
   m_S.resize(1024);
   copy_mem(m_S.data(), S_INIT, 1024);
   key_expansion(key, length, salt, salt_length);
 
   if(workfactor > 0) {
      const size_t rounds = static_cast<size_t>(1) << workfactor;
 
      for(size_t r = 0; r != rounds; ++r) {
         if(salt_first) {
            key_expansion(salt, salt_length, nullptr, 0);
            key_expansion(key, length, nullptr, 0);
         } else {
            key_expansion(key, length, nullptr, 0);
            key_expansion(salt, salt_length, nullptr, 0);
         }
      }
   }
}

References BOTAN_ARG_CHECK, and Botan::copy_mem().

set_key() [1/3]

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

inherited

Set the symmetric key of this object.

Parameters

key	the SymmetricKey to be set.

Definition at line 115 of file sym_algo.cpp.

                                                       {
   set_key(std::span{key.begin(), key.length()});
}

set_key() [2/3]

void Botan::SymmetricAlgorithm::set_key ( const uint8_t 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 128 of file sym_algo.h.

{ set_key(std::span{key, length}); }

set_key() [3/3]

void Botan::SymmetricAlgorithm::set_key ( std::span< const uint8_t > key )

inherited

Set the symmetric key of this object.

Parameters

key	the contiguous byte range to be set.

Definition at line 121 of file sym_algo.cpp.

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

valid_keylength()

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

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

Member Data Documentation

ParallelismMult

size_t Botan::BlockCipher::ParallelismMult

staticconstexprinherited

Multiplier on a block cipher's native parallelism

Usually notable performance gains come from further loop blocking, at least for 2 or 4x

Definition at line 52 of file block_cipher.h.

---

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

• src/lib/block/blowfish/blowfish.h
• src/lib/block/blowfish/blowfish.cpp