Botan 3.9.0
Crypto and TLS for C&
scrypt.cpp
Go to the documentation of this file.
1/**
2* (C) 2018 Jack Lloyd
3* (C) 2018 Ribose Inc
4*
5* Botan is released under the Simplified BSD License (see license.txt)
6*/
7
8#include <botan/scrypt.h>
9
10#include <botan/exceptn.h>
11#include <botan/pbkdf2.h>
12#include <botan/internal/bit_ops.h>
13#include <botan/internal/fmt.h>
14#include <botan/internal/loadstor.h>
15#include <botan/internal/mem_utils.h>
16#include <botan/internal/salsa20.h>
17#include <botan/internal/time_utils.h>
18
19namespace Botan {
20
21namespace {
22
23size_t scrypt_memory_usage(size_t N, size_t r, size_t p) {
24 return 128 * r * (N + p);
25}
26
27} // namespace
28
29std::string Scrypt_Family::name() const {
30 return "Scrypt";
31}
32
33std::unique_ptr<PasswordHash> Scrypt_Family::default_params() const {
34 return std::make_unique<Scrypt>(32768, 8, 1);
35}
36
37std::unique_ptr<PasswordHash> Scrypt_Family::tune(size_t output_length,
38 std::chrono::milliseconds msec,
39 size_t max_memory_usage_mb,
40 std::chrono::milliseconds tune_time) const {
41 BOTAN_UNUSED(output_length);
42
43 /*
44 * Some rough relations between scrypt parameters and runtime.
45 * Denote here by stime(N,r,p) the msec it takes to run scrypt.
46 *
47 * Emperically for smaller sizes:
48 * stime(N,8*r,p) / stime(N,r,p) is ~ 6-7
49 * stime(N,r,8*p) / stime(N,r,8*p) is ~ 7
50 * stime(2*N,r,p) / stime(N,r,p) is ~ 2
51 *
52 * Compute stime(8192,1,1) as baseline and extrapolate
53 */
54
55 // This is zero if max_memory_usage_mb == 0 (unbounded)
56 const size_t max_memory_usage = max_memory_usage_mb * 1024 * 1024;
57
58 // Starting parameters
59 size_t N = 8 * 1024;
60 size_t r = 1;
61 size_t p = 1;
62
63 auto pwdhash = this->from_params(N, r, p);
64
65 const uint64_t measured_time = measure_cost(tune_time, [&]() {
66 uint8_t output[32] = {0};
67 pwdhash->derive_key(output, sizeof(output), "test", 4, nullptr, 0);
68 });
69
70 const uint64_t target_nsec = msec.count() * static_cast<uint64_t>(1000000);
71
72 uint64_t est_nsec = measured_time;
73
74 // In below code we invoke scrypt_memory_usage with p == 0 as p contributes
75 // (very slightly) to memory consumption, but N is the driving factor.
76 // Including p leads to using an N half as large as what the user would expect.
77
78 // First increase r by 8x if possible
79 if(max_memory_usage == 0 || scrypt_memory_usage(N, r * 8, 0) <= max_memory_usage) {
80 if(target_nsec / est_nsec >= 5) {
81 r *= 8;
82 est_nsec *= 5;
83 }
84 }
85
86 // Now double N as many times as we can
87 while(max_memory_usage == 0 || scrypt_memory_usage(N * 2, r, 0) <= max_memory_usage) {
88 if(target_nsec / est_nsec >= 2) {
89 N *= 2;
90 est_nsec *= 2;
91 } else {
92 break;
93 }
94 }
95
96 // If we have extra runtime budget, increment p
97 if(target_nsec / est_nsec >= 2) {
98 p *= std::min<size_t>(1024, static_cast<size_t>(target_nsec / est_nsec));
99 }
100
101 return std::make_unique<Scrypt>(N, r, p);
102}
103
104std::unique_ptr<PasswordHash> Scrypt_Family::from_params(size_t N, size_t r, size_t p) const {
105 return std::make_unique<Scrypt>(N, r, p);
106}
107
108std::unique_ptr<PasswordHash> Scrypt_Family::from_iterations(size_t iter) const {
109 const size_t r = 8;
110 const size_t p = 1;
111
112 size_t N = 8192;
113
114 if(iter > 50000) {
115 N = 16384;
116 }
117 if(iter > 100000) {
118 N = 32768;
119 }
120 if(iter > 150000) {
121 N = 65536;
122 }
123
124 return std::make_unique<Scrypt>(N, r, p);
125}
126
127Scrypt::Scrypt(size_t N, size_t r, size_t p) : m_N(N), m_r(r), m_p(p) {
128 if(!is_power_of_2(N)) {
129 throw Invalid_Argument("Scrypt N parameter must be a power of 2");
130 }
131
132 if(p == 0 || p > 1024) {
133 throw Invalid_Argument("Invalid or unsupported scrypt p");
134 }
135 if(r == 0 || r > 256) {
136 throw Invalid_Argument("Invalid or unsupported scrypt r");
137 }
138 if(N < 1 || N > 4194304) {
139 throw Invalid_Argument("Invalid or unsupported scrypt N");
140 }
141}
142
143std::string Scrypt::to_string() const {
144 return fmt("Scrypt({},{},{})", m_N, m_r, m_p);
145}
146
148 const size_t N = memory_param();
149 const size_t p = parallelism();
150 const size_t r = iterations();
151
152 return scrypt_memory_usage(N, r, p);
153}
154
155namespace {
156
157void scryptBlockMix(size_t r, uint8_t* B, uint8_t* Y) {
158 uint32_t B32[16];
160 copy_mem(X.data(), &B[(2 * r - 1) * 64], 64);
161
162 for(size_t i = 0; i != 2 * r; i++) {
163 xor_buf(X.data(), &B[64 * i], 64);
164 load_le<uint32_t>(B32, X.data(), 16);
165 Salsa20::salsa_core(X.data(), B32, 8);
166 copy_mem(&Y[64 * i], X.data(), 64);
167 }
168
169 for(size_t i = 0; i < r; ++i) {
170 copy_mem(&B[i * 64], &Y[(i * 2) * 64], 64);
171 }
172
173 for(size_t i = 0; i < r; ++i) {
174 copy_mem(&B[(i + r) * 64], &Y[(i * 2 + 1) * 64], 64);
175 }
176}
177
178void scryptROMmix(size_t r, size_t N, uint8_t* B, secure_vector<uint8_t>& V) {
179 const size_t S = 128 * r;
180
181 for(size_t i = 0; i != N; ++i) {
182 copy_mem(&V[S * i], B, S);
183 scryptBlockMix(r, B, &V[N * S]);
184 }
185
186 for(size_t i = 0; i != N; ++i) {
187 // compiler doesn't know here that N is power of 2
188 const size_t j = load_le<uint32_t>(&B[(2 * r - 1) * 64], 0) & (N - 1);
189 xor_buf(B, &V[j * S], S);
190 scryptBlockMix(r, B, &V[N * S]);
191 }
192}
193
194} // namespace
195
196void Scrypt::derive_key(uint8_t output[],
197 size_t output_len,
198 const char* password,
199 size_t password_len,
200 const uint8_t salt[],
201 size_t salt_len) const {
202 const size_t N = memory_param();
203 const size_t p = parallelism();
204 const size_t r = iterations();
205
206 const size_t S = 128 * r;
207 secure_vector<uint8_t> B(p * S);
208 // temp space
209 secure_vector<uint8_t> V((N + 1) * S);
210
211 auto hmac_sha256 = MessageAuthenticationCode::create_or_throw("HMAC(SHA-256)");
212
213 try {
214 hmac_sha256->set_key(as_span_of_bytes(password, password_len));
215 } catch(Invalid_Key_Length&) {
216 throw Invalid_Argument("Scrypt cannot accept passphrases of the provided length");
217 }
218
219 pbkdf2(*hmac_sha256, B.data(), B.size(), salt, salt_len, 1);
220
221 // these can be parallel
222 for(size_t i = 0; i != p; ++i) {
223 scryptROMmix(r, N, &B[128 * r * i], V);
224 }
225
226 pbkdf2(*hmac_sha256, output, output_len, B.data(), B.size(), 1);
227}
228
229} // namespace Botan
#define BOTAN_UNUSED
Definition assert.h:144
static std::unique_ptr< MessageAuthenticationCode > create_or_throw(std::string_view algo_spec, std::string_view provider="")
Definition mac.cpp:148
static void salsa_core(uint8_t output[64], const uint32_t input[16], size_t rounds)
Definition salsa20.cpp:75
std::unique_ptr< PasswordHash > from_params(size_t N, size_t r, size_t p) const override
Definition scrypt.cpp:104
std::unique_ptr< PasswordHash > tune(size_t output_length, std::chrono::milliseconds msec, size_t max_memory, std::chrono::milliseconds tune_msec) const override
Definition scrypt.cpp:37
std::unique_ptr< PasswordHash > from_iterations(size_t iter) const override
Definition scrypt.cpp:108
std::string name() const override
Definition scrypt.cpp:29
std::unique_ptr< PasswordHash > default_params() const override
Definition scrypt.cpp:33
std::string to_string() const override
Definition scrypt.cpp:143
size_t memory_param() const override
Definition scrypt.h:41
size_t iterations() const override
Definition scrypt.h:37
size_t parallelism() const override
Definition scrypt.h:39
size_t total_memory_usage() const override
Definition scrypt.cpp:147
Scrypt(size_t N, size_t r, size_t p)
Definition scrypt.cpp:127
void derive_key(uint8_t out[], size_t out_len, const char *password, size_t password_len, const uint8_t salt[], size_t salt_len) const override
Definition scrypt.cpp:196
BOTAN_FORCE_INLINE constexpr bool is_power_of_2(T arg)
Definition bit_ops.h:45
std::span< const uint8_t > as_span_of_bytes(const char *s, size_t len)
Definition mem_utils.h:28
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition mem_ops.h:145
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53
constexpr auto load_le(ParamTs &&... params)
Definition loadstor.h:495
constexpr void xor_buf(ranges::contiguous_output_range< uint8_t > auto &&out, ranges::contiguous_range< uint8_t > auto &&in)
Definition mem_ops.h:342
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:69
uint64_t measure_cost(std::chrono::milliseconds trial_msec, F func)
Definition time_utils.h:21
size_t pbkdf2(MessageAuthenticationCode &prf, uint8_t out[], size_t out_len, std::string_view password, const uint8_t salt[], size_t salt_len, size_t iterations, std::chrono::milliseconds msec)
Definition pbkdf2.cpp:72