18999119208

Committed 01 Nov 2025 12:19PM UTC coverage: 92.005% (+1.3%) from 90.676%

Build # 18999119208

Build Type

push

github

Committed by

randombit

Commit Message

Update release notes

Coverage Stats

101931 of 110789 relevant lines covered (92.0%)

12156405.33 hits per line

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

76.19

/src/lib/pbkdf/argon2/argon2pwhash.cpp

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

#include <botan/argon2.h>

#include <botan/assert.h>
#include <botan/exceptn.h>
#include <botan/internal/fmt.h>
#include <botan/internal/time_utils.h>
#include <algorithm>
#include <limits>

namespace Botan {

Argon2::Argon2(uint8_t family, size_t M, size_t t, size_t p) : m_family(family), m_M(M), m_t(t), m_p(p) {
   BOTAN_ARG_CHECK(m_p >= 1 && m_p <= 128, "Invalid Argon2 threads parameter");
   BOTAN_ARG_CHECK(m_M >= 8 * m_p && m_M <= 8192 * 1024, "Invalid Argon2 M parameter");
   BOTAN_ARG_CHECK(m_t >= 1 && m_t <= std::numeric_limits<uint32_t>::max(), "Invalid Argon2 t parameter");
}

void Argon2::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 {
   argon2(output, output_len, password, password_len, salt, salt_len, nullptr, 0, nullptr, 0);
}

void Argon2::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 uint8_t ad[],
                        size_t ad_len,
                        const uint8_t key[],
                        size_t key_len) const {
   argon2(output, output_len, password, password_len, salt, salt_len, key, key_len, ad, ad_len);
}

namespace {

std::string argon2_family_name(uint8_t f) {
   switch(f) {
      case 0:
         return "Argon2d";
      case 1:
         return "Argon2i";
      case 2:
         return "Argon2id";
      default:
         throw Invalid_Argument("Unknown Argon2 parameter");
   }
}

}  // namespace

std::string Argon2::to_string() const {
   return fmt("{}({},{},{})", argon2_family_name(m_family), m_M, m_t, m_p);
}

Argon2_Family::Argon2_Family(uint8_t family) : m_family(family) {
   if(m_family != 0 && m_family != 1 && m_family != 2) {
      throw Invalid_Argument("Unknown Argon2 family identifier");
   }
}

std::string Argon2_Family::name() const {
   return argon2_family_name(m_family);
}

std::unique_ptr<PasswordHash> Argon2_Family::tune(size_t /*output_length*/,
                                                  std::chrono::milliseconds msec,
                                                  size_t max_memory,
                                                  std::chrono::milliseconds tune_time) const {
   const size_t max_kib = (max_memory == 0) ? 256 * 1024 : max_memory * 1024;

   // Tune with a large memory otherwise we measure cache vs RAM speeds and underestimate
   // costs for larger params. Default is 36 MiB, or use 128 for long times.
   const size_t tune_M = (msec >= std::chrono::milliseconds(200) ? 128 : 36) * 1024;
   const size_t p = 1;
   size_t t = 1;

   size_t M = 4 * 1024;

   auto pwhash = this->from_params(tune_M, t, p);

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

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

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

   /*
   * Argon2 scaling rules:
   * k*M, k*t, k*p all increase cost by about k
   *
   * First preference is to increase M up to max allowed value.
   * Any remaining time budget is spent on increasing t.
   */

   uint64_t est_nsec = measured_time;

   if(est_nsec < target_nsec && M < max_kib) {
      const uint64_t desired_cost_increase = (target_nsec + est_nsec - 1) / est_nsec;
      const uint64_t mem_headroom = max_kib / M;

      const uint64_t M_mult = std::min(desired_cost_increase, mem_headroom);
      M *= static_cast<size_t>(M_mult);
      est_nsec *= M_mult;
   }

   if(est_nsec < target_nsec / 2) {
      const uint64_t desired_cost_increase = (target_nsec + est_nsec - 1) / est_nsec;
      t *= static_cast<size_t>(desired_cost_increase);
   }

   return this->from_params(M, t, p);
}

std::unique_ptr<PasswordHash> Argon2_Family::default_params() const {
   return this->from_params(128 * 1024, 1, 1);
}

std::unique_ptr<PasswordHash> Argon2_Family::from_iterations(size_t iter) const {
   /*
   These choices are arbitrary, but should not change in future
   releases since they will break applications expecting deterministic
   mapping from iteration count to params
   */
   const size_t M = iter;
   const size_t t = 1;
   const size_t p = 1;
   return this->from_params(M, t, p);
}

std::unique_ptr<PasswordHash> Argon2_Family::from_params(size_t M, size_t t, size_t p) const {
   return std::make_unique<Argon2>(m_family, M, t, p);
}

}  // namespace Botan

1	/**
2	* (C) 2019 Jack Lloyd
3	*
4	* Botan is released under the Simplified BSD License (see license.txt)
5	*/
6
7	#include <botan/argon2.h>
8
9	#include <botan/assert.h>
10	#include <botan/exceptn.h>
11	#include <botan/internal/fmt.h>
12	#include <botan/internal/time_utils.h>
13	#include <algorithm>
14	#include <limits>
15
16	namespace Botan {
17
18	Argon2::Argon2(uint8_t family, size_t M, size_t t, size_t p) : m_family(family), m_M(M), m_t(t), m_p(p) {	1,118✔
19	BOTAN_ARG_CHECK(m_p >= 1 && m_p <= 128, "Invalid Argon2 threads parameter");	1,118✔
20	BOTAN_ARG_CHECK(m_M >= 8 * m_p && m_M <= 8192 * 1024, "Invalid Argon2 M parameter");	1,118✔
21	BOTAN_ARG_CHECK(m_t >= 1 && m_t <= std::numeric_limits<uint32_t>::max(), "Invalid Argon2 t parameter");	1,118✔
22	}	1,118✔
23
24	void Argon2::derive_key(uint8_t output[],	47✔
25	size_t output_len,
26	const char* password,
27	size_t password_len,
28	const uint8_t salt[],
29	size_t salt_len) const {
30	argon2(output, output_len, password, password_len, salt, salt_len, nullptr, 0, nullptr, 0);	47✔
31	}	47✔
32
33	void Argon2::derive_key(uint8_t output[],	1,071✔
34	size_t output_len,
35	const char* password,
36	size_t password_len,
37	const uint8_t salt[],
38	size_t salt_len,
39	const uint8_t ad[],
40	size_t ad_len,
41	const uint8_t key[],
42	size_t key_len) const {
43	argon2(output, output_len, password, password_len, salt, salt_len, key, key_len, ad, ad_len);	1,071✔
44	}	1,071✔
45
46	namespace {
47
48	std::string argon2_family_name(uint8_t f) {	22✔
49	switch(f) {	22✔
50	case 0:	2✔
51	return "Argon2d";	2✔
52	case 1:	2✔
53	return "Argon2i";	2✔
54	case 2:	18✔
55	return "Argon2id";	18✔
56	default:	×
57	throw Invalid_Argument("Unknown Argon2 parameter");	×
58	}
59	}
60
61	} // namespace
62
63	std::string Argon2::to_string() const {	16✔
64	return fmt("{}({},{},{})", argon2_family_name(m_family), m_M, m_t, m_p);	16✔
65	}
66
67	Argon2_Family::Argon2_Family(uint8_t family) : m_family(family) {	1,092✔
68	if(m_family != 0 && m_family != 1 && m_family != 2) {	1,092✔
69	throw Invalid_Argument("Unknown Argon2 family identifier");	×
70	}
71	}	1,092✔
72
73	std::string Argon2_Family::name() const {	6✔
74	return argon2_family_name(m_family);	6✔
75	}
76
77	std::unique_ptr<PasswordHash> Argon2_Family::tune(size_t /output_length/,	6✔
78	std::chrono::milliseconds msec,
79	size_t max_memory,
80	std::chrono::milliseconds tune_time) const {
81	const size_t max_kib = (max_memory == 0) ? 256 * 1024 : max_memory * 1024;	6✔
82
83	// Tune with a large memory otherwise we measure cache vs RAM speeds and underestimate
84	// costs for larger params. Default is 36 MiB, or use 128 for long times.
85	const size_t tune_M = (msec >= std::chrono::milliseconds(200) ? 128 : 36) * 1024;	6✔
86	const size_t p = 1;	6✔
87	size_t t = 1;	6✔
88
89	size_t M = 4 * 1024;	6✔
90
91	auto pwhash = this->from_params(tune_M, t, p);	6✔
92
93	auto tune_fn = [&]() {	12✔
94	uint8_t output[64] = {0};	6✔
95	pwhash->derive_key(output, sizeof(output), "test", 4, nullptr, 0);	6✔
96	};	12✔
97
98	const uint64_t measured_time = measure_cost(tune_time, tune_fn) / (tune_M / M);	6✔
99
100	const uint64_t target_nsec = msec.count() * static_cast<uint64_t>(1000000);	6✔
101
102	/*
103	* Argon2 scaling rules:
104	* kM, kt, k*p all increase cost by about k
105	*
106	* First preference is to increase M up to max allowed value.
107	* Any remaining time budget is spent on increasing t.
108	*/
109
110	uint64_t est_nsec = measured_time;	6✔
111
112	if(est_nsec < target_nsec && M < max_kib) {	6✔
113	const uint64_t desired_cost_increase = (target_nsec + est_nsec - 1) / est_nsec;	×
114	const uint64_t mem_headroom = max_kib / M;	×
115
116	const uint64_t M_mult = std::min(desired_cost_increase, mem_headroom);	×
117	M *= static_cast<size_t>(M_mult);	×
118	est_nsec *= M_mult;	×
119	}
120
121	if(est_nsec < target_nsec / 2) {	6✔
122	const uint64_t desired_cost_increase = (target_nsec + est_nsec - 1) / est_nsec;	×
123	t *= static_cast<size_t>(desired_cost_increase);	×
124	}
125
126	return this->from_params(M, t, p);	6✔
127	}	6✔
128
129	std::unique_ptr<PasswordHash> Argon2_Family::default_params() const {	4✔
130	return this->from_params(128 * 1024, 1, 1);	4✔
131	}
132
133	std::unique_ptr<PasswordHash> Argon2_Family::from_iterations(size_t iter) const {	×
134	/*
135	These choices are arbitrary, but should not change in future
136	releases since they will break applications expecting deterministic
137	mapping from iteration count to params
138	*/
139	const size_t M = iter;	×
140	const size_t t = 1;	×
141	const size_t p = 1;	×
142	return this->from_params(M, t, p);	×
143	}
144
145	std::unique_ptr<PasswordHash> Argon2_Family::from_params(size_t M, size_t t, size_t p) const {	1,118✔
146	return std::make_unique<Argon2>(m_family, M, t, p);	1,118✔
147	}
148
149	} // namespace Botan

randombit / botan / 18999119208

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