09dfdf25157d21b01b96c073a3d6d57511313638
[openssl.git] / crypto / evp / scrypt.c
1 /* scrypt.c */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
4  * 2015.
5  */
6 /* ====================================================================
7  * Copyright (c) 2015 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
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
19  *    distribution.
20  *
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/)"
25  *
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.
30  *
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.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
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  * ====================================================================
53  *
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).
57  *
58  */
59
60 #include <stddef.h>
61 #include <stdio.h>
62 #include <string.h>
63 #include <openssl/evp.h>
64 #include <openssl/err.h>
65 #include <internal/numbers.h>
66
67 #define R(a,b) (((a) << (b)) | ((a) >> (32 - (b))))
68 static void salsa208_word_specification(uint32_t inout[16])
69 {
70     int i;
71     uint32_t x[16];
72     memcpy(x, inout, sizeof(x));
73     for (i = 8; i > 0; i -= 2) {
74         x[4] ^= R(x[0] + x[12], 7);
75         x[8] ^= R(x[4] + x[0], 9);
76         x[12] ^= R(x[8] + x[4], 13);
77         x[0] ^= R(x[12] + x[8], 18);
78         x[9] ^= R(x[5] + x[1], 7);
79         x[13] ^= R(x[9] + x[5], 9);
80         x[1] ^= R(x[13] + x[9], 13);
81         x[5] ^= R(x[1] + x[13], 18);
82         x[14] ^= R(x[10] + x[6], 7);
83         x[2] ^= R(x[14] + x[10], 9);
84         x[6] ^= R(x[2] + x[14], 13);
85         x[10] ^= R(x[6] + x[2], 18);
86         x[3] ^= R(x[15] + x[11], 7);
87         x[7] ^= R(x[3] + x[15], 9);
88         x[11] ^= R(x[7] + x[3], 13);
89         x[15] ^= R(x[11] + x[7], 18);
90         x[1] ^= R(x[0] + x[3], 7);
91         x[2] ^= R(x[1] + x[0], 9);
92         x[3] ^= R(x[2] + x[1], 13);
93         x[0] ^= R(x[3] + x[2], 18);
94         x[6] ^= R(x[5] + x[4], 7);
95         x[7] ^= R(x[6] + x[5], 9);
96         x[4] ^= R(x[7] + x[6], 13);
97         x[5] ^= R(x[4] + x[7], 18);
98         x[11] ^= R(x[10] + x[9], 7);
99         x[8] ^= R(x[11] + x[10], 9);
100         x[9] ^= R(x[8] + x[11], 13);
101         x[10] ^= R(x[9] + x[8], 18);
102         x[12] ^= R(x[15] + x[14], 7);
103         x[13] ^= R(x[12] + x[15], 9);
104         x[14] ^= R(x[13] + x[12], 13);
105         x[15] ^= R(x[14] + x[13], 18);
106     }
107     for (i = 0; i < 16; ++i)
108         inout[i] += x[i];
109     OPENSSL_cleanse(x, sizeof(x));
110 }
111
112 static void scryptBlockMix(uint32_t *B_, uint32_t *B, uint64_t r)
113 {
114     uint64_t i, j;
115     uint32_t X[16], *pB;
116
117     memcpy(X, B + (r * 2 - 1) * 16, sizeof(X));
118     pB = B;
119     for (i = 0; i < r * 2; i++) {
120         for (j = 0; j < 16; j++)
121             X[j] ^= *pB++;
122         salsa208_word_specification(X);
123         memcpy(B_ + (i / 2 + (i & 1) * r) * 16, X, sizeof(X));
124     }
125     OPENSSL_cleanse(X, sizeof(X));
126 }
127
128 static void scryptROMix(unsigned char *B, uint64_t r, uint64_t N,
129                         uint32_t *X, uint32_t *T, uint32_t *V)
130 {
131     unsigned char *pB;
132     uint32_t *pV;
133     uint64_t i, k;
134
135     /* Convert from little endian input */
136     for (pV = V, i = 0, pB = B; i < 32 * r; i++, pV++) {
137         *pV = *pB++;
138         *pV |= *pB++ << 8;
139         *pV |= *pB++ << 16;
140         *pV |= *pB++ << 24;
141     }
142
143     for (i = 1; i < N; i++, pV += 32 * r)
144         scryptBlockMix(pV, pV - 32 * r, r);
145
146     scryptBlockMix(X, V + (N - 1) * 32 * r, r);
147
148     for (i = 0; i < N; i++) {
149         uint32_t j;
150         j = X[16 * (2 * r - 1)] % N;
151         pV = V + 32 * r * j;
152         for (k = 0; k < 32 * r; k++)
153             T[k] = X[k] ^ *pV++;
154         scryptBlockMix(X, T, r);
155     }
156     /* Convert output to little endian */
157     for (i = 0, pB = B; i < 32 * r; i++) {
158         uint32_t xtmp = X[i];
159         *pB++ = xtmp & 0xff;
160         *pB++ = (xtmp >> 8) & 0xff;
161         *pB++ = (xtmp >> 16) & 0xff;
162         *pB++ = (xtmp >> 24) & 0xff;
163     }
164 }
165
166 #ifndef SIZE_MAX
167 # define SIZE_MAX    ((size_t)-1)
168 #endif
169
170 /*
171  * Maximum power of two that will fit in uint64_t: this should work on
172  * most (all?) platforms.
173  */
174
175 #define LOG2_UINT64_MAX         (sizeof(uint64_t) * 8 - 1)
176
177 /*
178  * Maximum value of p * r:
179  * p <= ((2^32-1) * hLen) / MFLen =>
180  * p <= ((2^32-1) * 32) / (128 * r) =>
181  * p * r <= (2^30-1)
182  *
183  */
184
185 #define SCRYPT_PR_MAX   ((1 << 30) - 1)
186
187 /*
188  * Maximum permitted memory allow this to be overridden with Configuration
189  * option: e.g. -DSCRYPT_MAX_MEM=0 for maximum possible.
190  */
191
192 #ifdef SCRYPT_MAX_MEM
193 # if SCRYPT_MAX_MEM == 0
194 #  undef SCRYPT_MAX_MEM
195 /*
196  * Although we could theoretically allocate SIZE_MAX memory that would leave
197  * no memory available for anything else so set limit as half that.
198  */
199 #  define SCRYPT_MAX_MEM (SIZE_MAX/2)
200 # endif
201 #else
202 /* Default memory limit: 32 MB */
203 # define SCRYPT_MAX_MEM  (1024 * 1024 * 32)
204 #endif
205
206 int EVP_PBE_scrypt(const char *pass, size_t passlen,
207                    const unsigned char *salt, size_t saltlen,
208                    uint64_t N, uint64_t r, uint64_t p, uint64_t maxmem,
209                    unsigned char *key, size_t keylen)
210 {
211     int rv = 0;
212     unsigned char *B;
213     uint32_t *X, *V, *T;
214     uint64_t i, Blen, Vlen;
215
216     /* Sanity check parameters */
217     /* initial check, r,p must be non zero, N >= 2 and a power of 2 */
218     if (r == 0 || p == 0 || N < 2 || (N & (N - 1)))
219         return 0;
220     /* Check p * r < SCRYPT_PR_MAX avoiding overflow */
221     if (p > SCRYPT_PR_MAX / r)
222         return 0;
223
224     /*
225      * Need to check N: if 2^(128 * r / 8) overflows limit this is
226      * automatically satisfied since N <= UINT64_MAX.
227      */
228
229     if (16 * r <= LOG2_UINT64_MAX) {
230         if (N >= (1UL << (16 * r)))
231             return 0;
232     }
233
234     /* Memory checks: check total allocated buffer size fits in uint64_t */
235
236     /*
237      * B size in section 5 step 1.S
238      * Note: we know p * 128 * r < UINT64_MAX because we already checked
239      * p * r < SCRYPT_PR_MAX
240      */
241     Blen = p * 128 * r;
242
243     /*
244      * Check 32 * r * (N + 2) * sizeof(uint32_t) fits in uint64_t.
245      * This is combined size V, X and T (section 4)
246      */
247     i = UINT64_MAX / (32 * sizeof(uint32_t));
248     if (N + 2 > i / r)
249         return 0;
250     Vlen = 32 * r * (N + 2) * sizeof(uint32_t);
251
252     /* check total allocated size fits in uint64_t */
253     if (Blen > UINT64_MAX - Vlen)
254         return 0;
255
256     if (maxmem == 0)
257         maxmem = SCRYPT_MAX_MEM;
258
259     if (Blen + Vlen > maxmem) {
260         EVPerr(EVP_F_EVP_PBE_SCRYPT, EVP_R_MEMORY_LIMIT_EXCEEDED);
261         return 0;
262     }
263
264     /* If no key return to indicate parameters are OK */
265     if (key == NULL)
266         return 1;
267
268     B = OPENSSL_malloc(Blen + Vlen);
269     if (B == 0)
270         return 0;
271     X = (uint32_t *)(B + Blen);
272     T = X + 32 * r;
273     V = T + 32 * r;
274     if (PKCS5_PBKDF2_HMAC(pass, passlen, salt, saltlen, 1, EVP_sha256(),
275                           Blen, B) == 0)
276         goto err;
277
278     for (i = 0; i < p; i++)
279         scryptROMix(B + 128 * r * i, r, N, X, T, V);
280
281     if (PKCS5_PBKDF2_HMAC(pass, passlen, B, Blen, 1, EVP_sha256(),
282                           keylen, key) == 0)
283         goto err;
284     rv = 1;
285 #ifdef SCRYPT_DEBUG
286     fprintf(stderr, "scrypt parameters:\n");
287     fprintf(stderr, "N=%lu, p=%lu, r=%lu\n", N, p, r);
288     fprintf(stderr, "Salt:\n");
289     BIO_dump_fp(stderr, (char *)salt, saltlen);
290     fprintf(stderr, "Password:\n");
291     BIO_dump_fp(stderr, (char *)pass, passlen);
292     fprintf(stderr, "Key:\n");
293     BIO_dump_fp(stderr, (char *)key, keylen);
294 #endif
295  err:
296     OPENSSL_clear_free(B, Blen + Vlen);
297     return rv;
298 }