18978562474

Committed 31 Oct 2025 04:18PM UTC coverage: 90.672% (+0.003%) from 90.669%

Build # 18978562474

Build Type

Pull #5124

github

Committed by

web-flow

Commit Message

Merge 30546bc9a into 72715a0cf

Pull Request Pull Request #5124: Cooperative Cancellation in PasswordHash

Run Details

100535 of 110878 relevant lines covered (90.67%)

12292430.55 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.52

/src/lib/pbkdf/bcrypt_pbkdf/bcrypt_pbkdf.cpp

/*
* (C) 2018,2019 Jack Lloyd
*
* Botan is released under the Simplified BSD License (see license.txt)
*/

#include <botan/bcrypt_pbkdf.h>

#include <botan/hash.h>
#include <botan/internal/blowfish.h>
#include <botan/internal/fmt.h>
#include <botan/internal/loadstor.h>
#include <botan/internal/mem_utils.h>
#include <botan/internal/time_utils.h>

namespace Botan {

Bcrypt_PBKDF::Bcrypt_PBKDF(size_t iterations) : m_iterations(iterations) {
   BOTAN_ARG_CHECK(m_iterations > 0, "Invalid Bcrypt-PBKDF iterations");
}

std::string Bcrypt_PBKDF::to_string() const {
   return fmt("Bcrypt-PBKDF({})", m_iterations);
}

std::string Bcrypt_PBKDF_Family::name() const {
   return "Bcrypt-PBKDF";
}

std::unique_ptr<PasswordHash> Bcrypt_PBKDF_Family::tune(size_t output_length,
                                                        std::chrono::milliseconds msec,
                                                        size_t /*max_memory*/,
                                                        std::chrono::milliseconds tune_time) const {
   const size_t blocks = (output_length + 32 - 1) / 32;

   if(blocks == 0) {
      return default_params();
   }

   const size_t starting_iter = 2;

   auto pwhash = this->from_iterations(starting_iter);

   auto tune_fn = [&]() {
      uint8_t output[32] = {0};
      pwhash->derive_key(output, sizeof(output), "test", 4, nullptr, 0);
   };

   const uint64_t measured_time = measure_cost(tune_time, tune_fn) / blocks;

   const uint64_t target_nsec = msec.count() * static_cast<uint64_t>(1000000);

   const uint64_t desired_increase = target_nsec / measured_time;

   if(desired_increase == 0) {
      return this->from_iterations(starting_iter);
   }

   return this->from_iterations(static_cast<size_t>(desired_increase * starting_iter));
}

std::unique_ptr<PasswordHash> Bcrypt_PBKDF_Family::default_params() const {
   return this->from_iterations(32);  // About 100 ms on fast machine
}

std::unique_ptr<PasswordHash> Bcrypt_PBKDF_Family::from_iterations(size_t iterations) const {
   return std::make_unique<Bcrypt_PBKDF>(iterations);
}

std::unique_ptr<PasswordHash> Bcrypt_PBKDF_Family::from_params(size_t iterations, size_t /*t*/, size_t /*p*/) const {
   return this->from_iterations(iterations);
}

namespace {

void bcrypt_round(Blowfish& blowfish,
                  const secure_vector<uint8_t>& pass_hash,
                  const secure_vector<uint8_t>& salt_hash,
                  secure_vector<uint8_t>& out,
                  secure_vector<uint8_t>& tmp) {
   const size_t BCRYPT_PBKDF_OUTPUT = 32;

   // "OxychromaticBlowfishSwatDynamite"
   alignas(64) static const uint8_t BCRYPT_PBKDF_MAGIC[BCRYPT_PBKDF_OUTPUT] = {
      0x4F, 0x78, 0x79, 0x63, 0x68, 0x72, 0x6F, 0x6D, 0x61, 0x74, 0x69, 0x63, 0x42, 0x6C, 0x6F, 0x77,
      0x66, 0x69, 0x73, 0x68, 0x53, 0x77, 0x61, 0x74, 0x44, 0x79, 0x6E, 0x61, 0x6D, 0x69, 0x74, 0x65};

   const size_t BCRYPT_PBKDF_WORKFACTOR = 6;
   const size_t BCRYPT_PBKDF_ROUNDS = 64;

   blowfish.salted_set_key(
      pass_hash.data(), pass_hash.size(), salt_hash.data(), salt_hash.size(), BCRYPT_PBKDF_WORKFACTOR, true);

   copy_mem(tmp.data(), BCRYPT_PBKDF_MAGIC, BCRYPT_PBKDF_OUTPUT);
   for(size_t i = 0; i != BCRYPT_PBKDF_ROUNDS; ++i) {
      blowfish.encrypt(tmp);
   }

   /*
   Bcrypt PBKDF loads the Blowfish output as big endian for no reason
   in particular. We can't just swap everything once at the end
   because the (big-endian) values are fed into SHA-512 to generate
   the salt for the next round
   */
   for(size_t i = 0; i != 32 / 4; ++i) {
      const uint32_t w = load_le<uint32_t>(tmp.data(), i);
      store_be(w, &tmp[sizeof(uint32_t) * i]);
   }

   xor_buf(out.data(), tmp.data(), BCRYPT_PBKDF_OUTPUT);
}

}  // namespace

void Bcrypt_PBKDF::derive_key(uint8_t output[],
                              size_t output_len,
                              const char* password,
                              size_t password_len,
                              const uint8_t salt[],
                              size_t salt_len,
                              const std::optional<std::stop_token>& stop_token) const {
   // No output desired, so we are all done already...
   if(output_len == 0) {
      return;
   }

   BOTAN_ARG_CHECK(output_len <= 10 * 1024 * 1024, "Too much output for Bcrypt PBKDF");

   const size_t BCRYPT_BLOCK_SIZE = 32;
   const size_t blocks = (output_len + BCRYPT_BLOCK_SIZE - 1) / BCRYPT_BLOCK_SIZE;

   auto sha512 = HashFunction::create_or_throw("SHA-512");
   const auto pass_hash = sha512->process(as_span_of_bytes(password, password_len));

   secure_vector<uint8_t> salt_hash(sha512->output_length());

   Blowfish blowfish;
   secure_vector<uint8_t> out(BCRYPT_BLOCK_SIZE);
   secure_vector<uint8_t> tmp(BCRYPT_BLOCK_SIZE);

   for(size_t block = 0; block != blocks; ++block) {
      clear_mem(out.data(), out.size());

      sha512->update(salt, salt_len);
      sha512->update_be(static_cast<uint32_t>(block + 1));
      sha512->final(salt_hash.data());

      bcrypt_round(blowfish, pass_hash, salt_hash, out, tmp);

      for(size_t r = 1; r < m_iterations; ++r) {
         if((r & 63) == 0 && stop_token.has_value() && stop_token->stop_requested()) {
            throw Botan::Operation_Canceled("scrypt");
         }
         // Next salt is H(prev_output)
         sha512->update(tmp);
         sha512->final(salt_hash.data());

         bcrypt_round(blowfish, pass_hash, salt_hash, out, tmp);
      }

      for(size_t i = 0; i != BCRYPT_BLOCK_SIZE; ++i) {
         const size_t dest = i * blocks + block;
         if(dest < output_len) {
            output[dest] = out[i];
         }
      }
   }
}

}  // namespace Botan

1	/*
2	* (C) 2018,2019 Jack Lloyd
3	*
4	* Botan is released under the Simplified BSD License (see license.txt)
5	*/
6
7	#include <botan/bcrypt_pbkdf.h>
8
9	#include <botan/hash.h>
10	#include <botan/internal/blowfish.h>
11	#include <botan/internal/fmt.h>
12	#include <botan/internal/loadstor.h>
13	#include <botan/internal/mem_utils.h>
14	#include <botan/internal/time_utils.h>
15
16	namespace Botan {
17
18	Bcrypt_PBKDF::Bcrypt_PBKDF(size_t iterations) : m_iterations(iterations) {	42✔
19	BOTAN_ARG_CHECK(m_iterations > 0, "Invalid Bcrypt-PBKDF iterations");	42✔
20	}	42✔
21
22	std::string Bcrypt_PBKDF::to_string() const {	×
23	return fmt("Bcrypt-PBKDF({})", m_iterations);	×
24	}
25
26	std::string Bcrypt_PBKDF_Family::name() const {	2✔
27	return "Bcrypt-PBKDF";	2✔
28	}
29
30	std::unique_ptr<PasswordHash> Bcrypt_PBKDF_Family::tune(size_t output_length,	2✔
31	std::chrono::milliseconds msec,
32	size_t /max_memory/,
33	std::chrono::milliseconds tune_time) const {
34	const size_t blocks = (output_length + 32 - 1) / 32;	2✔
35
36	if(blocks == 0) {	2✔
37	return default_params();	×
38	}
39
40	const size_t starting_iter = 2;	2✔
41
42	auto pwhash = this->from_iterations(starting_iter);	2✔
43
44	auto tune_fn = [&]() {	11✔
45	uint8_t output[32] = {0};	9✔
46	pwhash->derive_key(output, sizeof(output), "test", 4, nullptr, 0);	9✔
47	};	9✔
48
49	const uint64_t measured_time = measure_cost(tune_time, tune_fn) / blocks;	2✔
50
51	const uint64_t target_nsec = msec.count() * static_cast<uint64_t>(1000000);	2✔
52
53	const uint64_t desired_increase = target_nsec / measured_time;	2✔
54
55	if(desired_increase == 0) {	2✔
56	return this->from_iterations(starting_iter);	1✔
57	}
58
59	return this->from_iterations(static_cast<size_t>(desired_increase * starting_iter));	1✔
60	}	2✔
61
62	std::unique_ptr<PasswordHash> Bcrypt_PBKDF_Family::default_params() const {	1✔
63	return this->from_iterations(32); // About 100 ms on fast machine	1✔
64	}
65
66	std::unique_ptr<PasswordHash> Bcrypt_PBKDF_Family::from_iterations(size_t iterations) const {	42✔
67	return std::make_unique<Bcrypt_PBKDF>(iterations);	42✔
68	}
69
70	std::unique_ptr<PasswordHash> Bcrypt_PBKDF_Family::from_params(size_t iterations, size_t /t/, size_t /p/) const {	1✔
71	return this->from_iterations(iterations);	1✔
72	}
73
74	namespace {
75
76	void bcrypt_round(Blowfish& blowfish,	587✔
77	const secure_vector<uint8_t>& pass_hash,
78	const secure_vector<uint8_t>& salt_hash,
79	secure_vector<uint8_t>& out,
80	secure_vector<uint8_t>& tmp) {
81	const size_t BCRYPT_PBKDF_OUTPUT = 32;	587✔
82
83	// "OxychromaticBlowfishSwatDynamite"
84	alignas(64) static const uint8_t BCRYPT_PBKDF_MAGIC[BCRYPT_PBKDF_OUTPUT] = {	587✔
85	0x4F, 0x78, 0x79, 0x63, 0x68, 0x72, 0x6F, 0x6D, 0x61, 0x74, 0x69, 0x63, 0x42, 0x6C, 0x6F, 0x77,
86	0x66, 0x69, 0x73, 0x68, 0x53, 0x77, 0x61, 0x74, 0x44, 0x79, 0x6E, 0x61, 0x6D, 0x69, 0x74, 0x65};
87
88	const size_t BCRYPT_PBKDF_WORKFACTOR = 6;	587✔
89	const size_t BCRYPT_PBKDF_ROUNDS = 64;	587✔
90
91	blowfish.salted_set_key(	587✔
92	pass_hash.data(), pass_hash.size(), salt_hash.data(), salt_hash.size(), BCRYPT_PBKDF_WORKFACTOR, true);
93
94	copy_mem(tmp.data(), BCRYPT_PBKDF_MAGIC, BCRYPT_PBKDF_OUTPUT);	587✔
95	for(size_t i = 0; i != BCRYPT_PBKDF_ROUNDS; ++i) {	38,155✔
96	blowfish.encrypt(tmp);	75,136✔
97	}
98
99	/*
100	Bcrypt PBKDF loads the Blowfish output as big endian for no reason
101	in particular. We can't just swap everything once at the end
102	because the (big-endian) values are fed into SHA-512 to generate
103	the salt for the next round
104	*/
105	for(size_t i = 0; i != 32 / 4; ++i) {	5,283✔
106	const uint32_t w = load_le<uint32_t>(tmp.data(), i);	4,696✔
107	store_be(w, &tmp[sizeof(uint32_t) * i]);	4,696✔
108	}
109
110	xor_buf(out.data(), tmp.data(), BCRYPT_PBKDF_OUTPUT);	587✔
111	}	587✔
112
113	} // namespace
114
115	void Bcrypt_PBKDF::derive_key(uint8_t output[],	49✔
116	size_t output_len,
117	const char* password,
118	size_t password_len,
119	const uint8_t salt[],
120	size_t salt_len,
121	const std::optional<std::stop_token>& stop_token) const {
122	// No output desired, so we are all done already...
123	if(output_len == 0) {	49✔
124	return;	×
125	}
126
127	BOTAN_ARG_CHECK(output_len <= 10 * 1024 * 1024, "Too much output for Bcrypt PBKDF");	49✔
128
129	const size_t BCRYPT_BLOCK_SIZE = 32;	49✔
130	const size_t blocks = (output_len + BCRYPT_BLOCK_SIZE - 1) / BCRYPT_BLOCK_SIZE;	49✔
131
132	auto sha512 = HashFunction::create_or_throw("SHA-512");	49✔
133	const auto pass_hash = sha512->process(as_span_of_bytes(password, password_len));	49✔
134
135	secure_vector<uint8_t> salt_hash(sha512->output_length());	50✔
136
137	Blowfish blowfish;	49✔
138	secure_vector<uint8_t> out(BCRYPT_BLOCK_SIZE);	49✔
139	secure_vector<uint8_t> tmp(BCRYPT_BLOCK_SIZE);	50✔
140
141	for(size_t block = 0; block != blocks; ++block) {	114✔
142	clear_mem(out.data(), out.size());	66✔
143
144	sha512->update(salt, salt_len);	66✔
145	sha512->update_be(static_cast<uint32_t>(block + 1));	66✔
146	sha512->final(salt_hash.data());	66✔
147
148	bcrypt_round(blowfish, pass_hash, salt_hash, out, tmp);	66✔
149
150	for(size_t r = 1; r < m_iterations; ++r) {	587✔
151	if((r & 63) == 0 && stop_token.has_value() && stop_token->stop_requested()) {	522✔
152	throw Botan::Operation_Canceled("scrypt");	1✔
153	}
154	// Next salt is H(prev_output)
155	sha512->update(tmp);	521✔
156	sha512->final(salt_hash.data());	521✔
157
158	bcrypt_round(blowfish, pass_hash, salt_hash, out, tmp);	521✔
159	}
160
161	for(size_t i = 0; i != BCRYPT_BLOCK_SIZE; ++i) {	2,145✔
162	const size_t dest = i * blocks + block;	2,080✔
163	if(dest < output_len) {	2,080✔
164	output[dest] = out[i];	1,802✔
165	}
166	}
167	}
168	}	244✔
169
170	} // namespace Botan

randombit / botan / 18978562474

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous