Botan 3.6.1
Crypto and TLS for C&
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Botan::Blowfish Class Referencefinal

#include <blowfish.h>

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

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
 
virtual 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
 
virtual 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 SymmetricKey &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)
 

Protected Member Functions

void assert_key_material_set () const
 
void assert_key_material_set (bool predicate) const
 

Detailed Description

Blowfish

Definition at line 18 of file blowfish.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

Definition at line 197 of file block_cipher.h.

197{ BLOCK_SIZE = BS };
Botan::Block_Cipher_Fixed_Params< 8, 1, 56 >::BLOCK_SIZE
@ BLOCK_SIZE
Definition block_cipher.h:197

Member Function Documentation

◆ assert_key_material_set() [1/2]

void Botan::SymmetricAlgorithm::assert_key_material_set ( ) const
inlineprotectedinherited

Definition at line 139 of file sym_algo.h.

139{ assert_key_material_set(has_keying_material()); }
Botan::SymmetricAlgorithm::has_keying_material
virtual bool has_keying_material() const =0
Botan::SymmetricAlgorithm::assert_key_material_set
void assert_key_material_set() const
Definition sym_algo.h:139

References Botan::SymmetricAlgorithm::assert_key_material_set().

Referenced by Botan::SymmetricAlgorithm::assert_key_material_set(), Botan::Salsa20::cipher_bytes(), Botan::AES_128::decrypt_n(), Botan::AES_192::decrypt_n(), Botan::AES_256::decrypt_n(), Botan::ARIA_128::decrypt_n(), Botan::ARIA_192::decrypt_n(), Botan::ARIA_256::decrypt_n(), decrypt_n(), Botan::Camellia_128::decrypt_n(), Botan::Camellia_192::decrypt_n(), Botan::Camellia_256::decrypt_n(), Botan::CAST_128::decrypt_n(), Botan::DES::decrypt_n(), Botan::GOST_28147_89::decrypt_n(), Botan::IDEA::decrypt_n(), Botan::Kuznyechik::decrypt_n(), Botan::Lion::decrypt_n(), Botan::Noekeon::decrypt_n(), Botan::SEED::decrypt_n(), Botan::Serpent::decrypt_n(), Botan::SHACAL2::decrypt_n(), Botan::SM4::decrypt_n(), Botan::Threefish_512::decrypt_n(), Botan::TripleDES::decrypt_n(), Botan::Twofish::decrypt_n(), Botan::AES_128::encrypt_n(), Botan::AES_192::encrypt_n(), Botan::AES_256::encrypt_n(), Botan::ARIA_128::encrypt_n(), Botan::ARIA_192::encrypt_n(), Botan::ARIA_256::encrypt_n(), encrypt_n(), Botan::Camellia_128::encrypt_n(), Botan::Camellia_192::encrypt_n(), Botan::Camellia_256::encrypt_n(), Botan::CAST_128::encrypt_n(), Botan::DES::encrypt_n(), Botan::GOST_28147_89::encrypt_n(), Botan::IDEA::encrypt_n(), Botan::Kuznyechik::encrypt_n(), Botan::Lion::encrypt_n(), Botan::Noekeon::encrypt_n(), Botan::SEED::encrypt_n(), Botan::Serpent::encrypt_n(), Botan::SHACAL2::encrypt_n(), Botan::SM4::encrypt_n(), Botan::Threefish_512::encrypt_n(), Botan::TripleDES::encrypt_n(), Botan::Twofish::encrypt_n(), Botan::GHASH::final(), Botan::GHASH::ghash_update(), Botan::ChaCha::seek(), Botan::CTR_BE::seek(), Botan::Salsa20::seek(), Botan::OCB_Mode::set_associated_data_n(), Botan::Salsa20::set_iv_bytes(), Botan::GHASH::update(), and Botan::GHASH::update_associated_data().

◆ assert_key_material_set() [2/2]

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

Definition at line 141 of file sym_algo.h.

141 {
142 if(!predicate) {
143 throw_key_not_set_error();
144 }
145 }

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

199{ 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.

391 {
392 zap(m_P);
393 zap(m_S);
394}
Botan::zap
void zap(std::vector< T, Alloc > &vec)
Definition secmem.h:117

References Botan::zap().

◆ clone()

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

Definition at line 171 of file block_cipher.h.

171{ return this->new_object().release(); }
Botan::BlockCipher::new_object
virtual std::unique_ptr< BlockCipher > new_object() const =0

◆ 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_specalgorithm name
providerprovider implementation to choose
Returns
a null pointer if the algo/provider combination cannot be found

Definition at line 91 of file block_cipher.cpp.

91 {
92#if defined(BOTAN_HAS_COMMONCRYPTO)
93 if(provider.empty() || provider == "commoncrypto") {
94 if(auto bc = make_commoncrypto_block_cipher(algo))
95 return bc;
96
97 if(!provider.empty())
98 return nullptr;
99 }
100#endif
101
102 // TODO: CryptoAPI
103 // TODO: /dev/crypto
104
105 // Only base providers from here on out
106 if(provider.empty() == false && provider != "base") {
107 return nullptr;
108 }
109
110#if defined(BOTAN_HAS_AES)
111 if(algo == "AES-128") {
112 return std::make_unique<AES_128>();
113 }
114
115 if(algo == "AES-192") {
116 return std::make_unique<AES_192>();
117 }
118
119 if(algo == "AES-256") {
120 return std::make_unique<AES_256>();
121 }
122#endif
123
124#if defined(BOTAN_HAS_ARIA)
125 if(algo == "ARIA-128") {
126 return std::make_unique<ARIA_128>();
127 }
128
129 if(algo == "ARIA-192") {
130 return std::make_unique<ARIA_192>();
131 }
132
133 if(algo == "ARIA-256") {
134 return std::make_unique<ARIA_256>();
135 }
136#endif
137
138#if defined(BOTAN_HAS_SERPENT)
139 if(algo == "Serpent") {
140 return std::make_unique<Serpent>();
141 }
142#endif
143
144#if defined(BOTAN_HAS_SHACAL2)
145 if(algo == "SHACAL2") {
146 return std::make_unique<SHACAL2>();
147 }
148#endif
149
150#if defined(BOTAN_HAS_TWOFISH)
151 if(algo == "Twofish") {
152 return std::make_unique<Twofish>();
153 }
154#endif
155
156#if defined(BOTAN_HAS_THREEFISH_512)
157 if(algo == "Threefish-512") {
158 return std::make_unique<Threefish_512>();
159 }
160#endif
161
162#if defined(BOTAN_HAS_BLOWFISH)
163 if(algo == "Blowfish") {
164 return std::make_unique<Blowfish>();
165 }
166#endif
167
168#if defined(BOTAN_HAS_CAMELLIA)
169 if(algo == "Camellia-128") {
170 return std::make_unique<Camellia_128>();
171 }
172
173 if(algo == "Camellia-192") {
174 return std::make_unique<Camellia_192>();
175 }
176
177 if(algo == "Camellia-256") {
178 return std::make_unique<Camellia_256>();
179 }
180#endif
181
182#if defined(BOTAN_HAS_DES)
183 if(algo == "DES") {
184 return std::make_unique<DES>();
185 }
186
187 if(algo == "TripleDES" || algo == "3DES" || algo == "DES-EDE") {
188 return std::make_unique<TripleDES>();
189 }
190#endif
191
192#if defined(BOTAN_HAS_NOEKEON)
193 if(algo == "Noekeon") {
194 return std::make_unique<Noekeon>();
195 }
196#endif
197
198#if defined(BOTAN_HAS_CAST_128)
199 if(algo == "CAST-128" || algo == "CAST5") {
200 return std::make_unique<CAST_128>();
201 }
202#endif
203
204#if defined(BOTAN_HAS_IDEA)
205 if(algo == "IDEA") {
206 return std::make_unique<IDEA>();
207 }
208#endif
209
210#if defined(BOTAN_HAS_KUZNYECHIK)
211 if(algo == "Kuznyechik") {
212 return std::make_unique<Kuznyechik>();
213 }
214#endif
215
216#if defined(BOTAN_HAS_SEED)
217 if(algo == "SEED") {
218 return std::make_unique<SEED>();
219 }
220#endif
221
222#if defined(BOTAN_HAS_SM4)
223 if(algo == "SM4") {
224 return std::make_unique<SM4>();
225 }
226#endif
227
228 const SCAN_Name req(algo);
229
230#if defined(BOTAN_HAS_GOST_28147_89)
231 if(req.algo_name() == "GOST-28147-89") {
232 return std::make_unique<GOST_28147_89>(req.arg(0, "R3411_94_TestParam"));
233 }
234#endif
235
236#if defined(BOTAN_HAS_CASCADE)
237 if(req.algo_name() == "Cascade" && req.arg_count() == 2) {
238 auto c1 = BlockCipher::create(req.arg(0));
239 auto c2 = BlockCipher::create(req.arg(1));
240
241 if(c1 && c2) {
242 return std::make_unique<Cascade_Cipher>(std::move(c1), std::move(c2));
243 }
244 }
245#endif
246
247#if defined(BOTAN_HAS_LION)
248 if(req.algo_name() == "Lion" && req.arg_count_between(2, 3)) {
249 auto hash = HashFunction::create(req.arg(0));
250 auto stream = StreamCipher::create(req.arg(1));
251
252 if(hash && stream) {
253 const size_t block_size = req.arg_as_integer(2, 1024);
254 return std::make_unique<Lion>(std::move(hash), std::move(stream), block_size);
255 }
256 }
257#endif
258
259 BOTAN_UNUSED(req);
260 BOTAN_UNUSED(provider);
261
262 return nullptr;
263}
BOTAN_UNUSED
#define BOTAN_UNUSED
Definition assert.h:118
Botan::BlockCipher::create
static std::unique_ptr< BlockCipher > create(std::string_view algo_spec, std::string_view provider="")
Definition block_cipher.cpp:91
Botan::BlockCipher::block_size
virtual size_t block_size() const =0
Botan::BlockCipher::provider
virtual std::string provider() const
Definition block_cipher.h:66
Botan::HashFunction::create
static std::unique_ptr< HashFunction > create(std::string_view algo_spec, std::string_view provider="")
Definition hash.cpp:107
Botan::StreamCipher::create
static std::unique_ptr< StreamCipher > create(std::string_view algo_spec, std::string_view provider="")
Definition stream_cipher.cpp:40
Botan::make_commoncrypto_block_cipher
std::unique_ptr< BlockCipher > make_commoncrypto_block_cipher(std::string_view name)
Definition commoncrypto_block.cpp:133

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), Botan::SCAN_Name::arg_count_between(), Botan::BlockCipher::block_size(), BOTAN_UNUSED, Botan::BlockCipher::create(), Botan::HashFunction::create(), Botan::StreamCipher::create(), Botan::make_commoncrypto_block_cipher(), and Botan::BlockCipher::provider().

Referenced by botan_block_cipher_init(), Botan::AEAD_Mode::create(), Botan::BlockCipher::create(), Botan::Cipher_Mode::create(), Botan::MessageAuthenticationCode::create(), Botan::StreamCipher::create(), and Botan::BlockCipher::create_or_throw().

◆ 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 266 of file block_cipher.cpp.

266 {
267 if(auto bc = BlockCipher::create(algo, provider)) {
268 return bc;
269 }
270 throw Lookup_Error("Block cipher", algo, provider);
271}

References Botan::BlockCipher::create(), and Botan::BlockCipher::provider().

Referenced by botan_nist_kw_dec(), botan_nist_kw_enc(), Botan::TLS::Connection_Cipher_State::Connection_Cipher_State(), Botan::Encrypted_PSK_Database::Encrypted_PSK_Database(), Botan::rfc3394_keyunwrap(), and Botan::rfc3394_keywrap().

◆ decrypt() [1/4]

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

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

84{ decrypt_n(in, out, 1); }
Botan::BlockCipher::decrypt_n
virtual void decrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0

Referenced by Botan::nist_key_unwrap(), and Botan::nist_key_unwrap_padded().

◆ 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
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)

Definition at line 132 of file block_cipher.h.

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

◆ decrypt() [3/4]

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

Decrypt one or more blocks

Parameters
blockthe input/output buffer (multiple of block_size())

Definition at line 114 of file block_cipher.h.

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

◆ decrypt() [4/4]

void Botan::BlockCipher::decrypt ( uint8_t block[]) const
inlineinherited

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

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

225 {
226 assert_key_material_set();
227
228 while(blocks >= 4) {
229 uint32_t L0, R0, L1, R1, L2, R2, L3, R3;
230 load_be(in, L0, R0, L1, R1, L2, R2, L3, R3);
231
232 for(size_t r = 17; r != 1; r -= 2) {
233 L0 ^= m_P[r];
234 L1 ^= m_P[r];
235 L2 ^= m_P[r];
236 L3 ^= m_P[r];
237 R0 ^= BFF(L0, m_S);
238 R1 ^= BFF(L1, m_S);
239 R2 ^= BFF(L2, m_S);
240 R3 ^= BFF(L3, m_S);
241
242 R0 ^= m_P[r - 1];
243 R1 ^= m_P[r - 1];
244 R2 ^= m_P[r - 1];
245 R3 ^= m_P[r - 1];
246
247 L0 ^= BFF(R0, m_S);
248 L1 ^= BFF(R1, m_S);
249 L2 ^= BFF(R2, m_S);
250 L3 ^= BFF(R3, m_S);
251 }
252
253 L0 ^= m_P[1];
254 R0 ^= m_P[0];
255 L1 ^= m_P[1];
256 R1 ^= m_P[0];
257 L2 ^= m_P[1];
258 R2 ^= m_P[0];
259 L3 ^= m_P[1];
260 R3 ^= m_P[0];
261
262 store_be(out, R0, L0, R1, L1, R2, L2, R3, L3);
263
264 in += 4 * BLOCK_SIZE;
265 out += 4 * BLOCK_SIZE;
266 blocks -= 4;
267 }
268
269 while(blocks) {
270 uint32_t L, R;
271 load_be(in, L, R);
272
273 for(size_t r = 17; r != 1; r -= 2) {
274 L ^= m_P[r];
275 R ^= BFF(L, m_S);
276
277 R ^= m_P[r - 1];
278 L ^= BFF(R, m_S);
279 }
280
281 L ^= m_P[1];
282 R ^= m_P[0];
283
284 store_be(out, R, L);
285
286 in += BLOCK_SIZE;
287 out += BLOCK_SIZE;
288 blocks--;
289 }
290}
Botan::store_be
constexpr auto store_be(ParamTs &&... params)
Definition loadstor.h:773
Botan::load_be
constexpr auto load_be(ParamTs &&... params)
Definition loadstor.h:530

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

◆ decrypt_n_xex()

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

Definition at line 159 of file block_cipher.h.

159 {
160 const size_t BS = block_size();
161 xor_buf(data, mask, blocks * BS);
162 decrypt_n(data, data, blocks);
163 xor_buf(data, mask, blocks * BS);
164 }
Botan::xor_buf
constexpr void xor_buf(ranges::contiguous_output_range< uint8_t > auto &&out, ranges::contiguous_range< uint8_t > auto &&in)
Definition mem_ops.h:341

References Botan::xor_buf().

◆ encrypt() [1/4]

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

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

75{ encrypt_n(in, out, 1); }
Botan::BlockCipher::encrypt_n
virtual void encrypt_n(const uint8_t in[], uint8_t out[], size_t blocks) const =0

Referenced by Botan::nist_key_wrap(), Botan::nist_key_wrap_padded(), and Botan::CFB_Mode::shift_register().

◆ 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
inthe input buffer (multiple of block_size())
outthe output buffer (same size as in)

Definition at line 123 of file block_cipher.h.

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

◆ encrypt() [3/4]

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

Encrypt one or more blocks

Parameters
blockthe input/output buffer (multiple of block_size())

Definition at line 106 of file block_cipher.h.

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

◆ encrypt() [4/4]

void Botan::BlockCipher::encrypt ( uint8_t block[]) const
inlineinherited

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

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

156 {
157 assert_key_material_set();
158
159 while(blocks >= 4) {
160 uint32_t L0, R0, L1, R1, L2, R2, L3, R3;
161 load_be(in, L0, R0, L1, R1, L2, R2, L3, R3);
162
163 for(size_t r = 0; r != 16; r += 2) {
164 L0 ^= m_P[r];
165 L1 ^= m_P[r];
166 L2 ^= m_P[r];
167 L3 ^= m_P[r];
168 R0 ^= BFF(L0, m_S);
169 R1 ^= BFF(L1, m_S);
170 R2 ^= BFF(L2, m_S);
171 R3 ^= BFF(L3, m_S);
172
173 R0 ^= m_P[r + 1];
174 R1 ^= m_P[r + 1];
175 R2 ^= m_P[r + 1];
176 R3 ^= m_P[r + 1];
177 L0 ^= BFF(R0, m_S);
178 L1 ^= BFF(R1, m_S);
179 L2 ^= BFF(R2, m_S);
180 L3 ^= BFF(R3, m_S);
181 }
182
183 L0 ^= m_P[16];
184 R0 ^= m_P[17];
185 L1 ^= m_P[16];
186 R1 ^= m_P[17];
187 L2 ^= m_P[16];
188 R2 ^= m_P[17];
189 L3 ^= m_P[16];
190 R3 ^= m_P[17];
191
192 store_be(out, R0, L0, R1, L1, R2, L2, R3, L3);
193
194 in += 4 * BLOCK_SIZE;
195 out += 4 * BLOCK_SIZE;
196 blocks -= 4;
197 }
198
199 while(blocks) {
200 uint32_t L, R;
201 load_be(in, L, R);
202
203 for(size_t r = 0; r != 16; r += 2) {
204 L ^= m_P[r];
205 R ^= BFF(L, m_S);
206
207 R ^= m_P[r + 1];
208 L ^= BFF(R, m_S);
209 }
210
211 L ^= m_P[16];
212 R ^= m_P[17];
213
214 store_be(out, R, L);
215
216 in += BLOCK_SIZE;
217 out += BLOCK_SIZE;
218 blocks--;
219 }
220}

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

◆ encrypt_n_xex()

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

Definition at line 152 of file block_cipher.h.

152 {
153 const size_t BS = block_size();
154 xor_buf(data, mask, blocks * BS);
155 encrypt_n(data, data, blocks);
156 xor_buf(data, mask, blocks * BS);
157 }

References Botan::xor_buf().

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

292 {
293 return !m_P.empty();
294}

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

201{ 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 95 of file sym_algo.h.

95{ return key_spec().maximum_keylength(); }
Botan::Key_Length_Specification::maximum_keylength
size_t maximum_keylength() const
Definition sym_algo.h:54
Botan::SymmetricAlgorithm::key_spec
virtual Key_Length_Specification key_spec() const =0

◆ minimum_keylength()

size_t Botan::SymmetricAlgorithm::minimum_keylength ( ) const
inlineinherited
Returns
minimum allowed key length

Definition at line 100 of file sym_algo.h.

100{ return key_spec().minimum_keylength(); }
Botan::Key_Length_Specification::minimum_keylength
size_t minimum_keylength() const
Definition sym_algo.h:49

◆ name()

std::string Botan::Blowfish::name ( ) const
inlineoverridevirtual
Returns
the algorithm name

Implements Botan::SymmetricAlgorithm.

Definition at line 35 of file blowfish.h.

35{ 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 37 of file blowfish.h.

37{ 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 60 of file block_cipher.h.

60{ return parallelism() * block_size() * BOTAN_BLOCK_CIPHER_PAR_MULT; }
Botan::BlockCipher::parallelism
virtual size_t parallelism() const
Definition block_cipher.h:55
BOTAN_BLOCK_CIPHER_PAR_MULT
#define BOTAN_BLOCK_CIPHER_PAR_MULT
Definition build.h:512

References BOTAN_BLOCK_CIPHER_PAR_MULT.

Referenced by Botan::CBC_Mode::ideal_granularity().

◆ parallelism()

virtual size_t Botan::BlockCipher::parallelism ( ) const
inlinevirtualinherited
Returns
native parallelism of this cipher in blocks

Reimplemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::IDEA, Botan::Noekeon, Botan::Serpent, Botan::SHACAL2, and Botan::SM4.

Definition at line 55 of file block_cipher.h.

55{ 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.

Reimplemented in Botan::AES_128, Botan::AES_192, Botan::AES_256, Botan::IDEA, Botan::Noekeon, Botan::Serpent, Botan::SHACAL2, and Botan::SM4.

Definition at line 66 of file block_cipher.h.

66{ return "base"; }

Referenced by Botan::BlockCipher::create(), and Botan::BlockCipher::create_or_throw().

◆ 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_specalgorithm name

Definition at line 273 of file block_cipher.cpp.

273 {
274 return probe_providers_of<BlockCipher>(algo, {"base", "commoncrypto"});
275}
Botan::probe_providers_of
std::vector< std::string > probe_providers_of(std::string_view algo_spec, const std::vector< std::string > &possible={"base"})
Definition scan_name.h:105

References Botan::probe_providers_of().

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

327 {
328 BOTAN_ARG_CHECK(salt_length > 0 && salt_length % 4 == 0, "Invalid salt length for Blowfish salted key schedule");
329
330 if(length > 72) {
331 // Truncate longer passwords to the 72 char bcrypt limit
332 length = 72;
333 }
334
335 m_P.resize(18);
336 copy_mem(m_P.data(), P_INIT, 18);
337
338 m_S.resize(1024);
339 copy_mem(m_S.data(), S_INIT, 1024);
340 key_expansion(key, length, salt, salt_length);
341
342 if(workfactor > 0) {
343 const size_t rounds = static_cast<size_t>(1) << workfactor;
344
345 for(size_t r = 0; r != rounds; ++r) {
346 if(salt_first) {
347 key_expansion(salt, salt_length, nullptr, 0);
348 key_expansion(key, length, nullptr, 0);
349 } else {
350 key_expansion(key, length, nullptr, 0);
351 key_expansion(salt, salt_length, nullptr, 0);
352 }
353 }
354 }
355}
BOTAN_ARG_CHECK
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:29
Botan::copy_mem
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition mem_ops.h:146

References BOTAN_ARG_CHECK, and Botan::copy_mem().

◆ set_key() [1/3]

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

Set the symmetric key of this object.

Parameters
keythe SymmetricKey to be set.

Definition at line 113 of file sym_algo.h.

113{ set_key(std::span{key.begin(), key.length()}); }
Botan::SymmetricAlgorithm::set_key
void set_key(const SymmetricKey &key)
Definition sym_algo.h:113

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

Referenced by Botan::create_aes_row_generator(), Botan::Sodium::crypto_stream_salsa20(), Botan::Sodium::crypto_stream_salsa20_xor_ic(), Botan::Sodium::crypto_stream_xsalsa20(), Botan::Sodium::crypto_stream_xsalsa20_xor_ic(), Botan::FPE::fe1_decrypt(), Botan::FPE::fe1_encrypt(), Botan::Sphincs_Hash_Functions_Sha2::PRF_msg(), Botan::Sodium::randombytes_buf_deterministic(), and Botan::SymmetricAlgorithm::set_key().

◆ 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
keythe to be set as a byte array.
lengthin bytes of key param

Definition at line 126 of file sym_algo.h.

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

References Botan::SymmetricAlgorithm::set_key().

Referenced by Botan::SymmetricAlgorithm::set_key().

◆ set_key() [3/3]

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

Set the symmetric key of this object.

Parameters
keythe contiguous byte range to be set.

Definition at line 17 of file sym_algo.cpp.

17 {
18 if(!valid_keylength(key.size())) {
19 throw Invalid_Key_Length(name(), key.size());
20 }
21 key_schedule(key);
22}
Botan::SymmetricAlgorithm::valid_keylength
bool valid_keylength(size_t length) const
Definition sym_algo.h:107
Botan::SymmetricAlgorithm::name
virtual std::string name() const =0

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

◆ valid_keylength()

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

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

107{ return key_spec().valid_keylength(length); }
Botan::Key_Length_Specification::valid_keylength
bool valid_keylength(size_t length) const
Definition sym_algo.h:42

Referenced by Botan::SymmetricAlgorithm::set_key().

The documentation for this class was generated from the following files:
Generated by doxygen 1.12.0