kdf: add FIPS error state handling
[openssl.git] / providers / implementations / kdfs / hkdf.c
1 /*
2  * Copyright 2016-2020 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 /*
11  * HMAC low level APIs are deprecated for public use, but still ok for internal
12  * use.
13  */
14 #include "internal/deprecated.h"
15
16 #include <stdlib.h>
17 #include <stdarg.h>
18 #include <string.h>
19 #include <openssl/hmac.h>
20 #include <openssl/evp.h>
21 #include <openssl/kdf.h>
22 #include <openssl/core_names.h>
23 #include "internal/cryptlib.h"
24 #include "internal/numbers.h"
25 #include "crypto/evp.h"
26 #include "prov/provider_ctx.h"
27 #include "prov/providercommon.h"
28 #include "prov/providercommonerr.h"
29 #include "prov/implementations.h"
30 #include "prov/provider_util.h"
31 #include "e_os.h"
32
33 #define HKDF_MAXBUF 1024
34
35 static OSSL_FUNC_kdf_newctx_fn kdf_hkdf_new;
36 static OSSL_FUNC_kdf_freectx_fn kdf_hkdf_free;
37 static OSSL_FUNC_kdf_reset_fn kdf_hkdf_reset;
38 static OSSL_FUNC_kdf_derive_fn kdf_hkdf_derive;
39 static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_hkdf_settable_ctx_params;
40 static OSSL_FUNC_kdf_set_ctx_params_fn kdf_hkdf_set_ctx_params;
41 static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_hkdf_gettable_ctx_params;
42 static OSSL_FUNC_kdf_get_ctx_params_fn kdf_hkdf_get_ctx_params;
43
44 static int HKDF(const EVP_MD *evp_md,
45                 const unsigned char *salt, size_t salt_len,
46                 const unsigned char *key, size_t key_len,
47                 const unsigned char *info, size_t info_len,
48                 unsigned char *okm, size_t okm_len);
49 static int HKDF_Extract(const EVP_MD *evp_md,
50                         const unsigned char *salt, size_t salt_len,
51                         const unsigned char *ikm, size_t ikm_len,
52                         unsigned char *prk, size_t prk_len);
53 static int HKDF_Expand(const EVP_MD *evp_md,
54                        const unsigned char *prk, size_t prk_len,
55                        const unsigned char *info, size_t info_len,
56                        unsigned char *okm, size_t okm_len);
57
58 typedef struct {
59     void *provctx;
60     int mode;
61     PROV_DIGEST digest;
62     unsigned char *salt;
63     size_t salt_len;
64     unsigned char *key;
65     size_t key_len;
66     unsigned char info[HKDF_MAXBUF];
67     size_t info_len;
68 } KDF_HKDF;
69
70 static void *kdf_hkdf_new(void *provctx)
71 {
72     KDF_HKDF *ctx;
73
74     if (!ossl_prov_is_running())
75         return NULL;
76
77     if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL)
78         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
79     else
80         ctx->provctx = provctx;
81     return ctx;
82 }
83
84 static void kdf_hkdf_free(void *vctx)
85 {
86     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
87
88     if (ctx != NULL) {
89         kdf_hkdf_reset(ctx);
90         OPENSSL_free(ctx);
91     }
92 }
93
94 static void kdf_hkdf_reset(void *vctx)
95 {
96     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
97     void *provctx = ctx->provctx;
98
99     ossl_prov_digest_reset(&ctx->digest);
100     OPENSSL_free(ctx->salt);
101     OPENSSL_clear_free(ctx->key, ctx->key_len);
102     OPENSSL_cleanse(ctx->info, ctx->info_len);
103     memset(ctx, 0, sizeof(*ctx));
104     ctx->provctx = provctx;
105 }
106
107 static size_t kdf_hkdf_size(KDF_HKDF *ctx)
108 {
109     int sz;
110     const EVP_MD *md = ossl_prov_digest_md(&ctx->digest);
111
112     if (ctx->mode != EVP_KDF_HKDF_MODE_EXTRACT_ONLY)
113         return SIZE_MAX;
114
115     if (md == NULL) {
116         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
117         return 0;
118     }
119     sz = EVP_MD_size(md);
120     if (sz < 0)
121         return 0;
122
123     return sz;
124 }
125
126 static int kdf_hkdf_derive(void *vctx, unsigned char *key, size_t keylen)
127 {
128     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
129     const EVP_MD *md;
130
131     if (!ossl_prov_is_running())
132         return 0;
133
134     md = ossl_prov_digest_md(&ctx->digest);
135     if (md == NULL) {
136         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
137         return 0;
138     }
139     if (ctx->key == NULL) {
140         ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_KEY);
141         return 0;
142     }
143
144     switch (ctx->mode) {
145     case EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND:
146         return HKDF(md, ctx->salt, ctx->salt_len, ctx->key,
147                     ctx->key_len, ctx->info, ctx->info_len, key,
148                     keylen);
149
150     case EVP_KDF_HKDF_MODE_EXTRACT_ONLY:
151         return HKDF_Extract(md, ctx->salt, ctx->salt_len, ctx->key,
152                             ctx->key_len, key, keylen);
153
154     case EVP_KDF_HKDF_MODE_EXPAND_ONLY:
155         return HKDF_Expand(md, ctx->key, ctx->key_len, ctx->info,
156                            ctx->info_len, key, keylen);
157
158     default:
159         return 0;
160     }
161 }
162
163 static int kdf_hkdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
164 {
165     const OSSL_PARAM *p;
166     KDF_HKDF *ctx = vctx;
167     OPENSSL_CTX *provctx = PROV_LIBRARY_CONTEXT_OF(ctx->provctx);
168     int n;
169
170     if (!ossl_prov_digest_load_from_params(&ctx->digest, params, provctx))
171         return 0;
172
173     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_MODE)) != NULL) {
174         if (p->data_type == OSSL_PARAM_UTF8_STRING) {
175             if (strcasecmp(p->data, "EXTRACT_AND_EXPAND") == 0) {
176                 ctx->mode = EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND;
177             } else if (strcasecmp(p->data, "EXTRACT_ONLY") == 0) {
178                 ctx->mode = EVP_KDF_HKDF_MODE_EXTRACT_ONLY;
179             } else if (strcasecmp(p->data, "EXPAND_ONLY") == 0) {
180                 ctx->mode = EVP_KDF_HKDF_MODE_EXPAND_ONLY;
181             } else {
182                 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
183                 return 0;
184             }
185         } else if (OSSL_PARAM_get_int(p, &n)) {
186             if (n != EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
187                 && n != EVP_KDF_HKDF_MODE_EXTRACT_ONLY
188                 && n != EVP_KDF_HKDF_MODE_EXPAND_ONLY) {
189                 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
190                 return 0;
191             }
192             ctx->mode = n;
193         } else {
194             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
195             return 0;
196         }
197     }
198
199     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY)) != NULL) {
200         OPENSSL_clear_free(ctx->key, ctx->key_len);
201         ctx->key = NULL;
202         if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->key, 0,
203                                          &ctx->key_len))
204             return 0;
205     }
206
207     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL) {
208         if (p->data_size != 0 && p->data != NULL) {
209             OPENSSL_free(ctx->salt);
210             ctx->salt = NULL;
211             if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->salt, 0,
212                                              &ctx->salt_len))
213                 return 0;
214         }
215     }
216     /* The info fields concatenate, so process them all */
217     if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_INFO)) != NULL) {
218         ctx->info_len = 0;
219         for (; p != NULL; p = OSSL_PARAM_locate_const(p + 1,
220                                                       OSSL_KDF_PARAM_INFO)) {
221             const void *q = ctx->info + ctx->info_len;
222             size_t sz = 0;
223
224             if (p->data_size != 0
225                 && p->data != NULL
226                 && !OSSL_PARAM_get_octet_string(p, (void **)&q,
227                                                 HKDF_MAXBUF - ctx->info_len,
228                                                 &sz))
229                 return 0;
230             ctx->info_len += sz;
231         }
232     }
233     return 1;
234 }
235
236 static const OSSL_PARAM *kdf_hkdf_settable_ctx_params(ossl_unused void *provctx)
237 {
238     static const OSSL_PARAM known_settable_ctx_params[] = {
239         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MODE, NULL, 0),
240         OSSL_PARAM_int(OSSL_KDF_PARAM_MODE, NULL),
241         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
242         OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
243         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0),
244         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),
245         OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO, NULL, 0),
246         OSSL_PARAM_END
247     };
248     return known_settable_ctx_params;
249 }
250
251 static int kdf_hkdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
252 {
253     KDF_HKDF *ctx = (KDF_HKDF *)vctx;
254     OSSL_PARAM *p;
255
256     if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
257         return OSSL_PARAM_set_size_t(p, kdf_hkdf_size(ctx));
258     return -2;
259 }
260
261 static const OSSL_PARAM *kdf_hkdf_gettable_ctx_params(ossl_unused void *provctx)
262 {
263     static const OSSL_PARAM known_gettable_ctx_params[] = {
264         OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
265         OSSL_PARAM_END
266     };
267     return known_gettable_ctx_params;
268 }
269
270 const OSSL_DISPATCH kdf_hkdf_functions[] = {
271     { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_hkdf_new },
272     { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_hkdf_free },
273     { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_hkdf_reset },
274     { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_hkdf_derive },
275     { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
276       (void(*)(void))kdf_hkdf_settable_ctx_params },
277     { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_hkdf_set_ctx_params },
278     { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
279       (void(*)(void))kdf_hkdf_gettable_ctx_params },
280     { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_hkdf_get_ctx_params },
281     { 0, NULL }
282 };
283
284 /*
285  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
286  * Section 2 (https://tools.ietf.org/html/rfc5869#section-2) and
287  * "Cryptographic Extraction and Key Derivation: The HKDF Scheme"
288  * Section 4.2 (https://eprint.iacr.org/2010/264.pdf).
289  *
290  * From the paper:
291  *   The scheme HKDF is specified as:
292  *     HKDF(XTS, SKM, CTXinfo, L) = K(1) | K(2) | ... | K(t)
293  *
294  *     where:
295  *       SKM is source key material
296  *       XTS is extractor salt (which may be null or constant)
297  *       CTXinfo is context information (may be null)
298  *       L is the number of key bits to be produced by KDF
299  *       k is the output length in bits of the hash function used with HMAC
300  *       t = ceil(L/k)
301  *       the value K(t) is truncated to its first d = L mod k bits.
302  *
303  * From RFC 5869:
304  *   2.2.  Step 1: Extract
305  *     HKDF-Extract(salt, IKM) -> PRK
306  *   2.3.  Step 2: Expand
307  *     HKDF-Expand(PRK, info, L) -> OKM
308  */
309 static int HKDF(const EVP_MD *evp_md,
310                 const unsigned char *salt, size_t salt_len,
311                 const unsigned char *ikm, size_t ikm_len,
312                 const unsigned char *info, size_t info_len,
313                 unsigned char *okm, size_t okm_len)
314 {
315     unsigned char prk[EVP_MAX_MD_SIZE];
316     int ret, sz;
317     size_t prk_len;
318
319     sz = EVP_MD_size(evp_md);
320     if (sz < 0)
321         return 0;
322     prk_len = (size_t)sz;
323
324     /* Step 1: HKDF-Extract(salt, IKM) -> PRK */
325     if (!HKDF_Extract(evp_md, salt, salt_len, ikm, ikm_len, prk, prk_len))
326         return 0;
327
328     /* Step 2: HKDF-Expand(PRK, info, L) -> OKM */
329     ret = HKDF_Expand(evp_md, prk, prk_len, info, info_len, okm, okm_len);
330     OPENSSL_cleanse(prk, sizeof(prk));
331
332     return ret;
333 }
334
335 /*
336  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
337  * Section 2.2 (https://tools.ietf.org/html/rfc5869#section-2.2).
338  *
339  * 2.2.  Step 1: Extract
340  *
341  *   HKDF-Extract(salt, IKM) -> PRK
342  *
343  *   Options:
344  *      Hash     a hash function; HashLen denotes the length of the
345  *               hash function output in octets
346  *
347  *   Inputs:
348  *      salt     optional salt value (a non-secret random value);
349  *               if not provided, it is set to a string of HashLen zeros.
350  *      IKM      input keying material
351  *
352  *   Output:
353  *      PRK      a pseudorandom key (of HashLen octets)
354  *
355  *   The output PRK is calculated as follows:
356  *
357  *   PRK = HMAC-Hash(salt, IKM)
358  */
359 static int HKDF_Extract(const EVP_MD *evp_md,
360                         const unsigned char *salt, size_t salt_len,
361                         const unsigned char *ikm, size_t ikm_len,
362                         unsigned char *prk, size_t prk_len)
363 {
364     int sz = EVP_MD_size(evp_md);
365
366     if (sz < 0)
367         return 0;
368     if (prk_len != (size_t)sz) {
369         ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_OUTPUT_BUFFER_SIZE);
370         return 0;
371     }
372     /* calc: PRK = HMAC-Hash(salt, IKM) */
373     return HMAC(evp_md, salt, salt_len, ikm, ikm_len, prk, NULL) != NULL;
374 }
375
376 /*
377  * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
378  * Section 2.3 (https://tools.ietf.org/html/rfc5869#section-2.3).
379  *
380  * 2.3.  Step 2: Expand
381  *
382  *   HKDF-Expand(PRK, info, L) -> OKM
383  *
384  *   Options:
385  *      Hash     a hash function; HashLen denotes the length of the
386  *               hash function output in octets
387  *
388  *   Inputs:
389  *      PRK      a pseudorandom key of at least HashLen octets
390  *               (usually, the output from the extract step)
391  *      info     optional context and application specific information
392  *               (can be a zero-length string)
393  *      L        length of output keying material in octets
394  *               (<= 255*HashLen)
395  *
396  *   Output:
397  *      OKM      output keying material (of L octets)
398  *
399  *   The output OKM is calculated as follows:
400  *
401  *   N = ceil(L/HashLen)
402  *   T = T(1) | T(2) | T(3) | ... | T(N)
403  *   OKM = first L octets of T
404  *
405  *   where:
406  *   T(0) = empty string (zero length)
407  *   T(1) = HMAC-Hash(PRK, T(0) | info | 0x01)
408  *   T(2) = HMAC-Hash(PRK, T(1) | info | 0x02)
409  *   T(3) = HMAC-Hash(PRK, T(2) | info | 0x03)
410  *   ...
411  *
412  *   (where the constant concatenated to the end of each T(n) is a
413  *   single octet.)
414  */
415 static int HKDF_Expand(const EVP_MD *evp_md,
416                        const unsigned char *prk, size_t prk_len,
417                        const unsigned char *info, size_t info_len,
418                        unsigned char *okm, size_t okm_len)
419 {
420     HMAC_CTX *hmac;
421     int ret = 0, sz;
422     unsigned int i;
423     unsigned char prev[EVP_MAX_MD_SIZE];
424     size_t done_len = 0, dig_len, n;
425
426     sz = EVP_MD_size(evp_md);
427     if (sz <= 0)
428         return 0;
429     dig_len = (size_t)sz;
430
431     /* calc: N = ceil(L/HashLen) */
432     n = okm_len / dig_len;
433     if (okm_len % dig_len)
434         n++;
435
436     if (n > 255 || okm == NULL)
437         return 0;
438
439     if ((hmac = HMAC_CTX_new()) == NULL)
440         return 0;
441
442     if (!HMAC_Init_ex(hmac, prk, prk_len, evp_md, NULL))
443         goto err;
444
445     for (i = 1; i <= n; i++) {
446         size_t copy_len;
447         const unsigned char ctr = i;
448
449         /* calc: T(i) = HMAC-Hash(PRK, T(i - 1) | info | i) */
450         if (i > 1) {
451             if (!HMAC_Init_ex(hmac, NULL, 0, NULL, NULL))
452                 goto err;
453
454             if (!HMAC_Update(hmac, prev, dig_len))
455                 goto err;
456         }
457
458         if (!HMAC_Update(hmac, info, info_len))
459             goto err;
460
461         if (!HMAC_Update(hmac, &ctr, 1))
462             goto err;
463
464         if (!HMAC_Final(hmac, prev, NULL))
465             goto err;
466
467         copy_len = (done_len + dig_len > okm_len) ?
468                        okm_len - done_len :
469                        dig_len;
470
471         memcpy(okm + done_len, prev, copy_len);
472
473         done_len += copy_len;
474     }
475     ret = 1;
476
477  err:
478     OPENSSL_cleanse(prev, sizeof(prev));
479     HMAC_CTX_free(hmac);
480     return ret;
481 }