c070c7b059d019502b070c005c48134acd9af22a
[openssl.git] / providers / implementations / kdfs / scrypt.c
1 /*
2  * Copyright 2017-2021 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <stdlib.h>
11 #include <stdarg.h>
12 #include <string.h>
13 #include <openssl/evp.h>
14 #include <openssl/kdf.h>
15 #include <openssl/err.h>
16 #include <openssl/core_names.h>
17 #include <openssl/proverr.h>
18 #include "crypto/evp.h"
19 #include "internal/numbers.h"
20 #include "prov/implementations.h"
21 #include "prov/provider_ctx.h"
22 #include "prov/providercommon.h"
23 #include "prov/implementations.h"
24 #include "prov/provider_util.h"
25
26 #ifndef OPENSSL_NO_SCRYPT
27
28 static OSSL_FUNC_kdf_newctx_fn kdf_scrypt_new;
29 static OSSL_FUNC_kdf_dupctx_fn kdf_scrypt_dup;
30 static OSSL_FUNC_kdf_freectx_fn kdf_scrypt_free;
31 static OSSL_FUNC_kdf_reset_fn kdf_scrypt_reset;
32 static OSSL_FUNC_kdf_derive_fn kdf_scrypt_derive;
33 static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_scrypt_settable_ctx_params;
34 static OSSL_FUNC_kdf_set_ctx_params_fn kdf_scrypt_set_ctx_params;
35 static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_scrypt_gettable_ctx_params;
36 static OSSL_FUNC_kdf_get_ctx_params_fn kdf_scrypt_get_ctx_params;
37
38 static int scrypt_alg(const char *pass, size_t passlen,
39                       const unsigned char *salt, size_t saltlen,
40                       uint64_t N, uint64_t r, uint64_t p, uint64_t maxmem,
41                       unsigned char *key, size_t keylen, EVP_MD *sha256,
42                       OSSL_LIB_CTX *libctx, const char *propq);
43
44 typedef struct {
45     OSSL_LIB_CTX *libctx;
46     char *propq;
47     unsigned char *pass;
48     size_t pass_len;
49     unsigned char *salt;
50     size_t salt_len;
51     uint64_t N;
52     uint64_t r, p;
53     uint64_t maxmem_bytes;
54     EVP_MD *sha256;
55 } KDF_SCRYPT;
56
57 static void kdf_scrypt_init(KDF_SCRYPT *ctx);
58
59 static void *kdf_scrypt_new_inner(OSSL_LIB_CTX *libctx)
60 {
61     KDF_SCRYPT *ctx;
62
63     if (!ossl_prov_is_running())
64         return NULL;
65
66     ctx = OPENSSL_zalloc(sizeof(*ctx));
67     if (ctx == NULL) {
68         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
69         return NULL;
70     }
71     ctx->libctx = libctx;
72     kdf_scrypt_init(ctx);
73     return ctx;
74 }
75
76 static void *kdf_scrypt_new(void *provctx)
77 {
78     return kdf_scrypt_new_inner(PROV_LIBCTX_OF(provctx));
79 }
80
81 static void kdf_scrypt_free(void *vctx)
82 {
83     KDF_SCRYPT *ctx = (KDF_SCRYPT *)vctx;
84
85     if (ctx != NULL) {
86         OPENSSL_free(ctx->propq);
87         EVP_MD_free(ctx->sha256);
88         kdf_scrypt_reset(ctx);
89         OPENSSL_free(ctx);
90     }
91 }
92
93 static void kdf_scrypt_reset(void *vctx)
94 {
95     KDF_SCRYPT *ctx = (KDF_SCRYPT *)vctx;
96
97     OPENSSL_free(ctx->salt);
98     OPENSSL_clear_free(ctx->pass, ctx->pass_len);
99     kdf_scrypt_init(ctx);
100 }
101
102 static void *kdf_scrypt_dup(void *vctx)
103 {
104     const KDF_SCRYPT *src = (const KDF_SCRYPT *)vctx;
105     KDF_SCRYPT *dest;
106
107     dest = kdf_scrypt_new_inner(src->libctx);
108     if (dest != NULL) {
109         if (src->sha256 != NULL && !EVP_MD_up_ref(src->sha256))
110             goto err;
111         if (src->propq != NULL) {
112             dest->propq = OPENSSL_strdup(src->propq);
113             if (dest->propq == NULL)
114                 goto err;
115         }
116         if (!ossl_prov_memdup(src->salt, src->salt_len,
117                               &dest->salt, &dest->salt_len)
118                 || !ossl_prov_memdup(src->pass, src->pass_len,
119                                      &dest->pass , &dest->pass_len))
120             goto err;
121         dest->N = src->N;
122         dest->r = src->r;
123         dest->p = src->p;
124         dest->maxmem_bytes = src->maxmem_bytes;
125         dest->sha256 = src->sha256;
126     }
127     return dest;
128
129  err:
130     kdf_scrypt_free(dest);
131     return NULL;
132 }
133
134 static void kdf_scrypt_init(KDF_SCRYPT *ctx)
135 {
136     /* Default values are the most conservative recommendation given in the
137      * original paper of C. Percival. Derivation uses roughly 1 GiB of memory
138      * for this parameter choice (approx. 128 * r * N * p bytes).
139      */
140     ctx->N = 1 << 20;
141     ctx->r = 8;
142     ctx->p = 1;
143     ctx->maxmem_bytes = 1025 * 1024 * 1024;
144 }
145
146 static int scrypt_set_membuf(unsigned char **buffer, size_t *buflen,
147                              const OSSL_PARAM *p)
148 {
149     OPENSSL_clear_free(*buffer, *buflen);
150     *buffer = NULL;
151     *buflen = 0;
152
153     if (p->data_size == 0) {
154         if ((*buffer = OPENSSL_malloc(1)) == NULL) {
155             ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
156             return 0;
157         }
158     } else if (p->data != NULL) {
159         if (!OSSL_PARAM_get_octet_string(p, (void **)buffer, 0, buflen))
160             return 0;
161     }
162     return 1;
163 }
164
165 static int set_digest(KDF_SCRYPT *ctx)
166 {
167     EVP_MD_free(ctx->sha256);
168     ctx->sha256 = EVP_MD_fetch(ctx->libctx, "sha256", ctx->propq);
169     if (ctx->sha256 == NULL) {
170         OPENSSL_free(ctx);
171         ERR_raise(ERR_LIB_PROV, PROV_R_UNABLE_TO_LOAD_SHA256);
172         return 0;
173     }
174     return 1;
175 }
176
177 static int set_property_query(KDF_SCRYPT *ctx, const char *propq)
178 {
179     OPENSSL_free(ctx->propq);
180     ctx->propq = NULL;
181     if (propq != NULL) {
182         ctx->propq = OPENSSL_strdup(propq);
183         if (ctx->propq == NULL) {
184             ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
185             return 0;
186         }
187     }
188     return 1;
189 }
190
191 static int kdf_scrypt_derive(void *vctx, unsigned char *key, size_t keylen,
192                              const OSSL_PARAM params[])
193 {
194     KDF_SCRYPT *ctx = (KDF_SCRYPT *)vctx;
195
196     if (!ossl_prov_is_running() || !kdf_scrypt_set_ctx_params(ctx, params))
197         return 0;
198
199     if (ctx->pass == NULL) {
200         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_PASS);
201         return 0;
202     }
203
204     if (ctx->salt == NULL) {
205         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SALT);
206         return 0;
207     }
208
209     if (ctx->sha256 == NULL && !set_digest(ctx))
210         return 0;
211
212     return scrypt_alg((char *)ctx->pass, ctx->pass_len, ctx->salt,
213                       ctx->salt_len, ctx->N, ctx->r, ctx->p,
214                       ctx->maxmem_bytes, key, keylen, ctx->sha256,
215                       ctx->libctx, ctx->propq);
216 }
217
218 static int is_power_of_two(uint64_t value)
219 {
220     return (value != 0) && ((value & (value - 1)) == 0);
221 }
222
223 static int kdf_scrypt_set_ctx_params(void *vctx, const OSSL_PARAM params[])
224 {
225     const OSSL_PARAM *p;
226     KDF_SCRYPT *ctx = vctx;
227     uint64_t u64_value;
228
229     if (params == NULL)
230         return 1;
231
232     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PASSWORD)) != NULL)
233         if (!scrypt_set_membuf(&ctx->pass, &ctx->pass_len, p))
234             return 0;
235
236     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL)
237         if (!scrypt_set_membuf(&ctx->salt, &ctx->salt_len, p))
238             return 0;
239
240     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SCRYPT_N))
241         != NULL) {
242         if (!OSSL_PARAM_get_uint64(p, &u64_value)
243             || u64_value <= 1
244             || !is_power_of_two(u64_value))
245             return 0;
246         ctx->N = u64_value;
247     }
248
249     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SCRYPT_R))
250         != NULL) {
251         if (!OSSL_PARAM_get_uint64(p, &u64_value) || u64_value < 1)
252             return 0;
253         ctx->r = u64_value;
254     }
255
256     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SCRYPT_P))
257         != NULL) {
258         if (!OSSL_PARAM_get_uint64(p, &u64_value) || u64_value < 1)
259             return 0;
260         ctx->p = u64_value;
261     }
262
263     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SCRYPT_MAXMEM))
264         != NULL) {
265         if (!OSSL_PARAM_get_uint64(p, &u64_value) || u64_value < 1)
266             return 0;
267         ctx->maxmem_bytes = u64_value;
268     }
269
270     p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PROPERTIES);
271     if (p != NULL) {
272         if (p->data_type != OSSL_PARAM_UTF8_STRING
273             || !set_property_query(ctx, p->data)
274             || !set_digest(ctx))
275             return 0;
276     }
277     return 1;
278 }
279
280 static const OSSL_PARAM *kdf_scrypt_settable_ctx_params(ossl_unused void *ctx,
281                                                         ossl_unused void *p_ctx)
282 {
283     static const OSSL_PARAM known_settable_ctx_params[] = {
284         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_PASSWORD, NULL, 0),
285         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0),
286         OSSL_PARAM_uint64(OSSL_KDF_PARAM_SCRYPT_N, NULL),
287         OSSL_PARAM_uint32(OSSL_KDF_PARAM_SCRYPT_R, NULL),
288         OSSL_PARAM_uint32(OSSL_KDF_PARAM_SCRYPT_P, NULL),
289         OSSL_PARAM_uint64(OSSL_KDF_PARAM_SCRYPT_MAXMEM, NULL),
290         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
291         OSSL_PARAM_END
292     };
293     return known_settable_ctx_params;
294 }
295
296 static int kdf_scrypt_get_ctx_params(void *vctx, OSSL_PARAM params[])
297 {
298     OSSL_PARAM *p;
299
300     if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
301         return OSSL_PARAM_set_size_t(p, SIZE_MAX);
302     return -2;
303 }
304
305 static const OSSL_PARAM *kdf_scrypt_gettable_ctx_params(ossl_unused void *ctx,
306                                                         ossl_unused void *p_ctx)
307 {
308     static const OSSL_PARAM known_gettable_ctx_params[] = {
309         OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
310         OSSL_PARAM_END
311     };
312     return known_gettable_ctx_params;
313 }
314
315 const OSSL_DISPATCH ossl_kdf_scrypt_functions[] = {
316     { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_scrypt_new },
317     { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))kdf_scrypt_dup },
318     { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_scrypt_free },
319     { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_scrypt_reset },
320     { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_scrypt_derive },
321     { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
322       (void(*)(void))kdf_scrypt_settable_ctx_params },
323     { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_scrypt_set_ctx_params },
324     { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
325       (void(*)(void))kdf_scrypt_gettable_ctx_params },
326     { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_scrypt_get_ctx_params },
327     { 0, NULL }
328 };
329
330 #define R(a,b) (((a) << (b)) | ((a) >> (32 - (b))))
331 static void salsa208_word_specification(uint32_t inout[16])
332 {
333     int i;
334     uint32_t x[16];
335
336     memcpy(x, inout, sizeof(x));
337     for (i = 8; i > 0; i -= 2) {
338         x[4] ^= R(x[0] + x[12], 7);
339         x[8] ^= R(x[4] + x[0], 9);
340         x[12] ^= R(x[8] + x[4], 13);
341         x[0] ^= R(x[12] + x[8], 18);
342         x[9] ^= R(x[5] + x[1], 7);
343         x[13] ^= R(x[9] + x[5], 9);
344         x[1] ^= R(x[13] + x[9], 13);
345         x[5] ^= R(x[1] + x[13], 18);
346         x[14] ^= R(x[10] + x[6], 7);
347         x[2] ^= R(x[14] + x[10], 9);
348         x[6] ^= R(x[2] + x[14], 13);
349         x[10] ^= R(x[6] + x[2], 18);
350         x[3] ^= R(x[15] + x[11], 7);
351         x[7] ^= R(x[3] + x[15], 9);
352         x[11] ^= R(x[7] + x[3], 13);
353         x[15] ^= R(x[11] + x[7], 18);
354         x[1] ^= R(x[0] + x[3], 7);
355         x[2] ^= R(x[1] + x[0], 9);
356         x[3] ^= R(x[2] + x[1], 13);
357         x[0] ^= R(x[3] + x[2], 18);
358         x[6] ^= R(x[5] + x[4], 7);
359         x[7] ^= R(x[6] + x[5], 9);
360         x[4] ^= R(x[7] + x[6], 13);
361         x[5] ^= R(x[4] + x[7], 18);
362         x[11] ^= R(x[10] + x[9], 7);
363         x[8] ^= R(x[11] + x[10], 9);
364         x[9] ^= R(x[8] + x[11], 13);
365         x[10] ^= R(x[9] + x[8], 18);
366         x[12] ^= R(x[15] + x[14], 7);
367         x[13] ^= R(x[12] + x[15], 9);
368         x[14] ^= R(x[13] + x[12], 13);
369         x[15] ^= R(x[14] + x[13], 18);
370     }
371     for (i = 0; i < 16; ++i)
372         inout[i] += x[i];
373     OPENSSL_cleanse(x, sizeof(x));
374 }
375
376 static void scryptBlockMix(uint32_t *B_, uint32_t *B, uint64_t r)
377 {
378     uint64_t i, j;
379     uint32_t X[16], *pB;
380
381     memcpy(X, B + (r * 2 - 1) * 16, sizeof(X));
382     pB = B;
383     for (i = 0; i < r * 2; i++) {
384         for (j = 0; j < 16; j++)
385             X[j] ^= *pB++;
386         salsa208_word_specification(X);
387         memcpy(B_ + (i / 2 + (i & 1) * r) * 16, X, sizeof(X));
388     }
389     OPENSSL_cleanse(X, sizeof(X));
390 }
391
392 static void scryptROMix(unsigned char *B, uint64_t r, uint64_t N,
393                         uint32_t *X, uint32_t *T, uint32_t *V)
394 {
395     unsigned char *pB;
396     uint32_t *pV;
397     uint64_t i, k;
398
399     /* Convert from little endian input */
400     for (pV = V, i = 0, pB = B; i < 32 * r; i++, pV++) {
401         *pV = *pB++;
402         *pV |= *pB++ << 8;
403         *pV |= *pB++ << 16;
404         *pV |= (uint32_t)*pB++ << 24;
405     }
406
407     for (i = 1; i < N; i++, pV += 32 * r)
408         scryptBlockMix(pV, pV - 32 * r, r);
409
410     scryptBlockMix(X, V + (N - 1) * 32 * r, r);
411
412     for (i = 0; i < N; i++) {
413         uint32_t j;
414         j = X[16 * (2 * r - 1)] % N;
415         pV = V + 32 * r * j;
416         for (k = 0; k < 32 * r; k++)
417             T[k] = X[k] ^ *pV++;
418         scryptBlockMix(X, T, r);
419     }
420     /* Convert output to little endian */
421     for (i = 0, pB = B; i < 32 * r; i++) {
422         uint32_t xtmp = X[i];
423         *pB++ = xtmp & 0xff;
424         *pB++ = (xtmp >> 8) & 0xff;
425         *pB++ = (xtmp >> 16) & 0xff;
426         *pB++ = (xtmp >> 24) & 0xff;
427     }
428 }
429
430 #ifndef SIZE_MAX
431 # define SIZE_MAX    ((size_t)-1)
432 #endif
433
434 /*
435  * Maximum power of two that will fit in uint64_t: this should work on
436  * most (all?) platforms.
437  */
438
439 #define LOG2_UINT64_MAX         (sizeof(uint64_t) * 8 - 1)
440
441 /*
442  * Maximum value of p * r:
443  * p <= ((2^32-1) * hLen) / MFLen =>
444  * p <= ((2^32-1) * 32) / (128 * r) =>
445  * p * r <= (2^30-1)
446  */
447
448 #define SCRYPT_PR_MAX   ((1 << 30) - 1)
449
450 static int scrypt_alg(const char *pass, size_t passlen,
451                       const unsigned char *salt, size_t saltlen,
452                       uint64_t N, uint64_t r, uint64_t p, uint64_t maxmem,
453                       unsigned char *key, size_t keylen, EVP_MD *sha256,
454                       OSSL_LIB_CTX *libctx, const char *propq)
455 {
456     int rv = 0;
457     unsigned char *B;
458     uint32_t *X, *V, *T;
459     uint64_t i, Blen, Vlen;
460
461     /* Sanity check parameters */
462     /* initial check, r,p must be non zero, N >= 2 and a power of 2 */
463     if (r == 0 || p == 0 || N < 2 || (N & (N - 1)))
464         return 0;
465     /* Check p * r < SCRYPT_PR_MAX avoiding overflow */
466     if (p > SCRYPT_PR_MAX / r) {
467         ERR_raise(ERR_LIB_EVP, EVP_R_MEMORY_LIMIT_EXCEEDED);
468         return 0;
469     }
470
471     /*
472      * Need to check N: if 2^(128 * r / 8) overflows limit this is
473      * automatically satisfied since N <= UINT64_MAX.
474      */
475
476     if (16 * r <= LOG2_UINT64_MAX) {
477         if (N >= (((uint64_t)1) << (16 * r))) {
478             ERR_raise(ERR_LIB_EVP, EVP_R_MEMORY_LIMIT_EXCEEDED);
479             return 0;
480         }
481     }
482
483     /* Memory checks: check total allocated buffer size fits in uint64_t */
484
485     /*
486      * B size in section 5 step 1.S
487      * Note: we know p * 128 * r < UINT64_MAX because we already checked
488      * p * r < SCRYPT_PR_MAX
489      */
490     Blen = p * 128 * r;
491     /*
492      * Yet we pass it as integer to PKCS5_PBKDF2_HMAC... [This would
493      * have to be revised when/if PKCS5_PBKDF2_HMAC accepts size_t.]
494      */
495     if (Blen > INT_MAX) {
496         ERR_raise(ERR_LIB_EVP, EVP_R_MEMORY_LIMIT_EXCEEDED);
497         return 0;
498     }
499
500     /*
501      * Check 32 * r * (N + 2) * sizeof(uint32_t) fits in uint64_t
502      * This is combined size V, X and T (section 4)
503      */
504     i = UINT64_MAX / (32 * sizeof(uint32_t));
505     if (N + 2 > i / r) {
506         ERR_raise(ERR_LIB_EVP, EVP_R_MEMORY_LIMIT_EXCEEDED);
507         return 0;
508     }
509     Vlen = 32 * r * (N + 2) * sizeof(uint32_t);
510
511     /* check total allocated size fits in uint64_t */
512     if (Blen > UINT64_MAX - Vlen) {
513         ERR_raise(ERR_LIB_EVP, EVP_R_MEMORY_LIMIT_EXCEEDED);
514         return 0;
515     }
516
517     /* Check that the maximum memory doesn't exceed a size_t limits */
518     if (maxmem > SIZE_MAX)
519         maxmem = SIZE_MAX;
520
521     if (Blen + Vlen > maxmem) {
522         ERR_raise(ERR_LIB_EVP, EVP_R_MEMORY_LIMIT_EXCEEDED);
523         return 0;
524     }
525
526     /* If no key return to indicate parameters are OK */
527     if (key == NULL)
528         return 1;
529
530     B = OPENSSL_malloc((size_t)(Blen + Vlen));
531     if (B == NULL) {
532         ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
533         return 0;
534     }
535     X = (uint32_t *)(B + Blen);
536     T = X + 32 * r;
537     V = T + 32 * r;
538     if (ossl_pkcs5_pbkdf2_hmac_ex(pass, passlen, salt, saltlen, 1, sha256,
539                                   (int)Blen, B, libctx, propq) == 0)
540         goto err;
541
542     for (i = 0; i < p; i++)
543         scryptROMix(B + 128 * r * i, r, N, X, T, V);
544
545     if (ossl_pkcs5_pbkdf2_hmac_ex(pass, passlen, B, (int)Blen, 1, sha256,
546                                   keylen, key, libctx, propq) == 0)
547         goto err;
548     rv = 1;
549  err:
550     if (rv == 0)
551         ERR_raise(ERR_LIB_EVP, EVP_R_PBKDF2_ERROR);
552
553     OPENSSL_clear_free(B, (size_t)(Blen + Vlen));
554     return rv;
555 }
556
557 #endif