3 * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
63 #include <openssl/evp.h>
64 #include <openssl/err.h>
65 #include <internal/numbers.h>
67 #ifndef OPENSSL_NO_SCRYPT
69 #define R(a,b) (((a) << (b)) | ((a) >> (32 - (b))))
70 static void salsa208_word_specification(uint32_t inout[16])
74 memcpy(x, inout, sizeof(x));
75 for (i = 8; i > 0; i -= 2) {
76 x[4] ^= R(x[0] + x[12], 7);
77 x[8] ^= R(x[4] + x[0], 9);
78 x[12] ^= R(x[8] + x[4], 13);
79 x[0] ^= R(x[12] + x[8], 18);
80 x[9] ^= R(x[5] + x[1], 7);
81 x[13] ^= R(x[9] + x[5], 9);
82 x[1] ^= R(x[13] + x[9], 13);
83 x[5] ^= R(x[1] + x[13], 18);
84 x[14] ^= R(x[10] + x[6], 7);
85 x[2] ^= R(x[14] + x[10], 9);
86 x[6] ^= R(x[2] + x[14], 13);
87 x[10] ^= R(x[6] + x[2], 18);
88 x[3] ^= R(x[15] + x[11], 7);
89 x[7] ^= R(x[3] + x[15], 9);
90 x[11] ^= R(x[7] + x[3], 13);
91 x[15] ^= R(x[11] + x[7], 18);
92 x[1] ^= R(x[0] + x[3], 7);
93 x[2] ^= R(x[1] + x[0], 9);
94 x[3] ^= R(x[2] + x[1], 13);
95 x[0] ^= R(x[3] + x[2], 18);
96 x[6] ^= R(x[5] + x[4], 7);
97 x[7] ^= R(x[6] + x[5], 9);
98 x[4] ^= R(x[7] + x[6], 13);
99 x[5] ^= R(x[4] + x[7], 18);
100 x[11] ^= R(x[10] + x[9], 7);
101 x[8] ^= R(x[11] + x[10], 9);
102 x[9] ^= R(x[8] + x[11], 13);
103 x[10] ^= R(x[9] + x[8], 18);
104 x[12] ^= R(x[15] + x[14], 7);
105 x[13] ^= R(x[12] + x[15], 9);
106 x[14] ^= R(x[13] + x[12], 13);
107 x[15] ^= R(x[14] + x[13], 18);
109 for (i = 0; i < 16; ++i)
111 OPENSSL_cleanse(x, sizeof(x));
114 static void scryptBlockMix(uint32_t *B_, uint32_t *B, uint64_t r)
119 memcpy(X, B + (r * 2 - 1) * 16, sizeof(X));
121 for (i = 0; i < r * 2; i++) {
122 for (j = 0; j < 16; j++)
124 salsa208_word_specification(X);
125 memcpy(B_ + (i / 2 + (i & 1) * r) * 16, X, sizeof(X));
127 OPENSSL_cleanse(X, sizeof(X));
130 static void scryptROMix(unsigned char *B, uint64_t r, uint64_t N,
131 uint32_t *X, uint32_t *T, uint32_t *V)
137 /* Convert from little endian input */
138 for (pV = V, i = 0, pB = B; i < 32 * r; i++, pV++) {
142 *pV |= (uint32_t)*pB++ << 24;
145 for (i = 1; i < N; i++, pV += 32 * r)
146 scryptBlockMix(pV, pV - 32 * r, r);
148 scryptBlockMix(X, V + (N - 1) * 32 * r, r);
150 for (i = 0; i < N; i++) {
152 j = X[16 * (2 * r - 1)] % N;
154 for (k = 0; k < 32 * r; k++)
156 scryptBlockMix(X, T, r);
158 /* Convert output to little endian */
159 for (i = 0, pB = B; i < 32 * r; i++) {
160 uint32_t xtmp = X[i];
162 *pB++ = (xtmp >> 8) & 0xff;
163 *pB++ = (xtmp >> 16) & 0xff;
164 *pB++ = (xtmp >> 24) & 0xff;
169 # define SIZE_MAX ((size_t)-1)
173 * Maximum power of two that will fit in uint64_t: this should work on
174 * most (all?) platforms.
177 #define LOG2_UINT64_MAX (sizeof(uint64_t) * 8 - 1)
180 * Maximum value of p * r:
181 * p <= ((2^32-1) * hLen) / MFLen =>
182 * p <= ((2^32-1) * 32) / (128 * r) =>
187 #define SCRYPT_PR_MAX ((1 << 30) - 1)
190 * Maximum permitted memory allow this to be overridden with Configuration
191 * option: e.g. -DSCRYPT_MAX_MEM=0 for maximum possible.
194 #ifdef SCRYPT_MAX_MEM
195 # if SCRYPT_MAX_MEM == 0
196 # undef SCRYPT_MAX_MEM
198 * Although we could theoretically allocate SIZE_MAX memory that would leave
199 * no memory available for anything else so set limit as half that.
201 # define SCRYPT_MAX_MEM (SIZE_MAX/2)
204 /* Default memory limit: 32 MB */
205 # define SCRYPT_MAX_MEM (1024 * 1024 * 32)
208 int EVP_PBE_scrypt(const char *pass, size_t passlen,
209 const unsigned char *salt, size_t saltlen,
210 uint64_t N, uint64_t r, uint64_t p, uint64_t maxmem,
211 unsigned char *key, size_t keylen)
216 uint64_t i, Blen, Vlen;
218 /* Sanity check parameters */
219 /* initial check, r,p must be non zero, N >= 2 and a power of 2 */
220 if (r == 0 || p == 0 || N < 2 || (N & (N - 1)))
222 /* Check p * r < SCRYPT_PR_MAX avoiding overflow */
223 if (p > SCRYPT_PR_MAX / r)
227 * Need to check N: if 2^(128 * r / 8) overflows limit this is
228 * automatically satisfied since N <= UINT64_MAX.
231 if (16 * r <= LOG2_UINT64_MAX) {
232 if (N >= (1UL << (16 * r)))
236 /* Memory checks: check total allocated buffer size fits in uint64_t */
239 * B size in section 5 step 1.S
240 * Note: we know p * 128 * r < UINT64_MAX because we already checked
241 * p * r < SCRYPT_PR_MAX
246 * Check 32 * r * (N + 2) * sizeof(uint32_t) fits in uint64_t.
247 * This is combined size V, X and T (section 4)
249 i = UINT64_MAX / (32 * sizeof(uint32_t));
252 Vlen = 32 * r * (N + 2) * sizeof(uint32_t);
254 /* check total allocated size fits in uint64_t */
255 if (Blen > UINT64_MAX - Vlen)
259 maxmem = SCRYPT_MAX_MEM;
261 if (Blen + Vlen > maxmem) {
262 EVPerr(EVP_F_EVP_PBE_SCRYPT, EVP_R_MEMORY_LIMIT_EXCEEDED);
266 /* If no key return to indicate parameters are OK */
270 B = OPENSSL_malloc(Blen + Vlen);
273 X = (uint32_t *)(B + Blen);
276 if (PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, 1, EVP_sha256(),
280 for (i = 0; i < p; i++)
281 scryptROMix(B + 128 * r * i, r, N, X, T, V);
283 if (PKCS5_PBKDF2_HMAC(pass, passlen, B, Blen, 1, EVP_sha256(),
288 fprintf(stderr, "scrypt parameters:\n");
289 fprintf(stderr, "N=%lu, p=%lu, r=%lu\n", N, p, r);
290 fprintf(stderr, "Salt:\n");
291 BIO_dump_fp(stderr, (char *)salt, saltlen);
292 fprintf(stderr, "Password:\n");
293 BIO_dump_fp(stderr, (char *)pass, passlen);
294 fprintf(stderr, "Key:\n");
295 BIO_dump_fp(stderr, (char *)key, keylen);
298 OPENSSL_clear_free(B, Blen + Vlen);