xref: /optee_os/lib/libmbedtls/mbedtls/library/hmac_drbg.c (revision 32b3180828fa15a49ccc86ecb4be9d274c140c89)
1817466cbSJens Wiklander /*
2817466cbSJens Wiklander  *  HMAC_DRBG implementation (NIST SP 800-90)
3817466cbSJens Wiklander  *
47901324dSJerome Forissier  *  Copyright The Mbed TLS Contributors
57901324dSJerome Forissier  *  SPDX-License-Identifier: Apache-2.0
6817466cbSJens Wiklander  *
7817466cbSJens Wiklander  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
8817466cbSJens Wiklander  *  not use this file except in compliance with the License.
9817466cbSJens Wiklander  *  You may obtain a copy of the License at
10817466cbSJens Wiklander  *
11817466cbSJens Wiklander  *  http://www.apache.org/licenses/LICENSE-2.0
12817466cbSJens Wiklander  *
13817466cbSJens Wiklander  *  Unless required by applicable law or agreed to in writing, software
14817466cbSJens Wiklander  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15817466cbSJens Wiklander  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16817466cbSJens Wiklander  *  See the License for the specific language governing permissions and
17817466cbSJens Wiklander  *  limitations under the License.
18817466cbSJens Wiklander  */
19817466cbSJens Wiklander 
20817466cbSJens Wiklander /*
21817466cbSJens Wiklander  *  The NIST SP 800-90A DRBGs are described in the following publication.
22817466cbSJens Wiklander  *  http://csrc.nist.gov/publications/nistpubs/800-90A/SP800-90A.pdf
23817466cbSJens Wiklander  *  References below are based on rev. 1 (January 2012).
24817466cbSJens Wiklander  */
25817466cbSJens Wiklander 
267901324dSJerome Forissier #include "common.h"
27817466cbSJens Wiklander 
28817466cbSJens Wiklander #if defined(MBEDTLS_HMAC_DRBG_C)
29817466cbSJens Wiklander 
30817466cbSJens Wiklander #include "mbedtls/hmac_drbg.h"
313d3b0591SJens Wiklander #include "mbedtls/platform_util.h"
3211fa71b9SJerome Forissier #include "mbedtls/error.h"
33817466cbSJens Wiklander 
34817466cbSJens Wiklander #include <string.h>
35817466cbSJens Wiklander 
36817466cbSJens Wiklander #if defined(MBEDTLS_FS_IO)
37817466cbSJens Wiklander #include <stdio.h>
38817466cbSJens Wiklander #endif
39817466cbSJens Wiklander 
40817466cbSJens Wiklander #include "mbedtls/platform.h"
41817466cbSJens Wiklander 
42817466cbSJens Wiklander /*
43817466cbSJens Wiklander  * HMAC_DRBG context initialization
44817466cbSJens Wiklander  */
45817466cbSJens Wiklander void mbedtls_hmac_drbg_init(mbedtls_hmac_drbg_context *ctx)
46817466cbSJens Wiklander {
47817466cbSJens Wiklander     memset(ctx, 0, sizeof(mbedtls_hmac_drbg_context));
48817466cbSJens Wiklander 
497901324dSJerome Forissier     ctx->reseed_interval = MBEDTLS_HMAC_DRBG_RESEED_INTERVAL;
50817466cbSJens Wiklander }
51817466cbSJens Wiklander 
52817466cbSJens Wiklander /*
53817466cbSJens Wiklander  * HMAC_DRBG update, using optional additional data (10.1.2.2)
54817466cbSJens Wiklander  */
55*32b31808SJens Wiklander int mbedtls_hmac_drbg_update(mbedtls_hmac_drbg_context *ctx,
563d3b0591SJens Wiklander                              const unsigned char *additional,
573d3b0591SJens Wiklander                              size_t add_len)
58817466cbSJens Wiklander {
59817466cbSJens Wiklander     size_t md_len = mbedtls_md_get_size(ctx->md_ctx.md_info);
60817466cbSJens Wiklander     unsigned char rounds = (additional != NULL && add_len != 0) ? 2 : 1;
61817466cbSJens Wiklander     unsigned char sep[1];
62817466cbSJens Wiklander     unsigned char K[MBEDTLS_MD_MAX_SIZE];
6311fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_MD_BAD_INPUT_DATA;
64817466cbSJens Wiklander 
65*32b31808SJens Wiklander     for (sep[0] = 0; sep[0] < rounds; sep[0]++) {
66817466cbSJens Wiklander         /* Step 1 or 4 */
67*32b31808SJens Wiklander         if ((ret = mbedtls_md_hmac_reset(&ctx->md_ctx)) != 0) {
683d3b0591SJens Wiklander             goto exit;
693d3b0591SJens Wiklander         }
70*32b31808SJens Wiklander         if ((ret = mbedtls_md_hmac_update(&ctx->md_ctx,
71*32b31808SJens Wiklander                                           ctx->V, md_len)) != 0) {
723d3b0591SJens Wiklander             goto exit;
73*32b31808SJens Wiklander         }
74*32b31808SJens Wiklander         if ((ret = mbedtls_md_hmac_update(&ctx->md_ctx,
75*32b31808SJens Wiklander                                           sep, 1)) != 0) {
76*32b31808SJens Wiklander             goto exit;
77*32b31808SJens Wiklander         }
78*32b31808SJens Wiklander         if (rounds == 2) {
79*32b31808SJens Wiklander             if ((ret = mbedtls_md_hmac_update(&ctx->md_ctx,
80*32b31808SJens Wiklander                                               additional, add_len)) != 0) {
81*32b31808SJens Wiklander                 goto exit;
82*32b31808SJens Wiklander             }
83*32b31808SJens Wiklander         }
84*32b31808SJens Wiklander         if ((ret = mbedtls_md_hmac_finish(&ctx->md_ctx, K)) != 0) {
85*32b31808SJens Wiklander             goto exit;
86*32b31808SJens Wiklander         }
87817466cbSJens Wiklander 
88817466cbSJens Wiklander         /* Step 2 or 5 */
89*32b31808SJens Wiklander         if ((ret = mbedtls_md_hmac_starts(&ctx->md_ctx, K, md_len)) != 0) {
903d3b0591SJens Wiklander             goto exit;
91*32b31808SJens Wiklander         }
923d3b0591SJens Wiklander         if ((ret = mbedtls_md_hmac_update(&ctx->md_ctx,
93*32b31808SJens Wiklander                                           ctx->V, md_len)) != 0) {
943d3b0591SJens Wiklander             goto exit;
95*32b31808SJens Wiklander         }
96*32b31808SJens Wiklander         if ((ret = mbedtls_md_hmac_finish(&ctx->md_ctx, ctx->V)) != 0) {
973d3b0591SJens Wiklander             goto exit;
98817466cbSJens Wiklander         }
99*32b31808SJens Wiklander     }
1003d3b0591SJens Wiklander 
1013d3b0591SJens Wiklander exit:
1023d3b0591SJens Wiklander     mbedtls_platform_zeroize(K, sizeof(K));
103*32b31808SJens Wiklander     return ret;
104817466cbSJens Wiklander }
105817466cbSJens Wiklander 
106817466cbSJens Wiklander /*
107817466cbSJens Wiklander  * Simplified HMAC_DRBG initialisation (for use with deterministic ECDSA)
108817466cbSJens Wiklander  */
109817466cbSJens Wiklander int mbedtls_hmac_drbg_seed_buf(mbedtls_hmac_drbg_context *ctx,
110817466cbSJens Wiklander                                const mbedtls_md_info_t *md_info,
111817466cbSJens Wiklander                                const unsigned char *data, size_t data_len)
112817466cbSJens Wiklander {
11311fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
114817466cbSJens Wiklander 
115*32b31808SJens Wiklander     if ((ret = mbedtls_md_setup(&ctx->md_ctx, md_info, 1)) != 0) {
116*32b31808SJens Wiklander         return ret;
117*32b31808SJens Wiklander     }
118817466cbSJens Wiklander 
1197901324dSJerome Forissier #if defined(MBEDTLS_THREADING_C)
1207901324dSJerome Forissier     mbedtls_mutex_init(&ctx->mutex);
1217901324dSJerome Forissier #endif
1227901324dSJerome Forissier 
123817466cbSJens Wiklander     /*
124817466cbSJens Wiklander      * Set initial working state.
125817466cbSJens Wiklander      * Use the V memory location, which is currently all 0, to initialize the
126817466cbSJens Wiklander      * MD context with an all-zero key. Then set V to its initial value.
127817466cbSJens Wiklander      */
1283d3b0591SJens Wiklander     if ((ret = mbedtls_md_hmac_starts(&ctx->md_ctx, ctx->V,
129*32b31808SJens Wiklander                                       mbedtls_md_get_size(md_info))) != 0) {
130*32b31808SJens Wiklander         return ret;
131*32b31808SJens Wiklander     }
132817466cbSJens Wiklander     memset(ctx->V, 0x01, mbedtls_md_get_size(md_info));
133817466cbSJens Wiklander 
134*32b31808SJens Wiklander     if ((ret = mbedtls_hmac_drbg_update(ctx, data, data_len)) != 0) {
135*32b31808SJens Wiklander         return ret;
136*32b31808SJens Wiklander     }
137817466cbSJens Wiklander 
138*32b31808SJens Wiklander     return 0;
139817466cbSJens Wiklander }
140817466cbSJens Wiklander 
141817466cbSJens Wiklander /*
1425b25c76aSJerome Forissier  * Internal function used both for seeding and reseeding the DRBG.
1435b25c76aSJerome Forissier  * Comments starting with arabic numbers refer to section 10.1.2.4
1445b25c76aSJerome Forissier  * of SP800-90A, while roman numbers refer to section 9.2.
145817466cbSJens Wiklander  */
1465b25c76aSJerome Forissier static int hmac_drbg_reseed_core(mbedtls_hmac_drbg_context *ctx,
1475b25c76aSJerome Forissier                                  const unsigned char *additional, size_t len,
1485b25c76aSJerome Forissier                                  int use_nonce)
149817466cbSJens Wiklander {
150817466cbSJens Wiklander     unsigned char seed[MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT];
1515b25c76aSJerome Forissier     size_t seedlen = 0;
15211fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
153817466cbSJens Wiklander 
1545b25c76aSJerome Forissier     {
1555b25c76aSJerome Forissier         size_t total_entropy_len;
1565b25c76aSJerome Forissier 
157*32b31808SJens Wiklander         if (use_nonce == 0) {
1585b25c76aSJerome Forissier             total_entropy_len = ctx->entropy_len;
159*32b31808SJens Wiklander         } else {
1605b25c76aSJerome Forissier             total_entropy_len = ctx->entropy_len * 3 / 2;
161*32b31808SJens Wiklander         }
1625b25c76aSJerome Forissier 
163817466cbSJens Wiklander         /* III. Check input length */
164817466cbSJens Wiklander         if (len > MBEDTLS_HMAC_DRBG_MAX_INPUT ||
165*32b31808SJens Wiklander             total_entropy_len + len > MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT) {
166*32b31808SJens Wiklander             return MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG;
167817466cbSJens Wiklander         }
1685b25c76aSJerome Forissier     }
169817466cbSJens Wiklander 
170817466cbSJens Wiklander     memset(seed, 0, MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT);
171817466cbSJens Wiklander 
172817466cbSJens Wiklander     /* IV. Gather entropy_len bytes of entropy for the seed */
1733d3b0591SJens Wiklander     if ((ret = ctx->f_entropy(ctx->p_entropy,
174*32b31808SJens Wiklander                               seed, ctx->entropy_len)) != 0) {
175*32b31808SJens Wiklander         return MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED;
1765b25c76aSJerome Forissier     }
1775b25c76aSJerome Forissier     seedlen += ctx->entropy_len;
178817466cbSJens Wiklander 
1795b25c76aSJerome Forissier     /* For initial seeding, allow adding of nonce generated
1805b25c76aSJerome Forissier      * from the entropy source. See Sect 8.6.7 in SP800-90A. */
181*32b31808SJens Wiklander     if (use_nonce) {
1825b25c76aSJerome Forissier         /* Note: We don't merge the two calls to f_entropy() in order
1835b25c76aSJerome Forissier          *       to avoid requesting too much entropy from f_entropy()
1845b25c76aSJerome Forissier          *       at once. Specifically, if the underlying digest is not
1855b25c76aSJerome Forissier          *       SHA-1, 3 / 2 * entropy_len is at least 36 Bytes, which
1865b25c76aSJerome Forissier          *       is larger than the maximum of 32 Bytes that our own
1875b25c76aSJerome Forissier          *       entropy source implementation can emit in a single
1885b25c76aSJerome Forissier          *       call in configurations disabling SHA-512. */
1895b25c76aSJerome Forissier         if ((ret = ctx->f_entropy(ctx->p_entropy,
1905b25c76aSJerome Forissier                                   seed + seedlen,
191*32b31808SJens Wiklander                                   ctx->entropy_len / 2)) != 0) {
192*32b31808SJens Wiklander             return MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED;
1935b25c76aSJerome Forissier         }
1945b25c76aSJerome Forissier 
1955b25c76aSJerome Forissier         seedlen += ctx->entropy_len / 2;
1965b25c76aSJerome Forissier     }
1975b25c76aSJerome Forissier 
198817466cbSJens Wiklander 
199817466cbSJens Wiklander     /* 1. Concatenate entropy and additional data if any */
200*32b31808SJens Wiklander     if (additional != NULL && len != 0) {
201817466cbSJens Wiklander         memcpy(seed + seedlen, additional, len);
202817466cbSJens Wiklander         seedlen += len;
203817466cbSJens Wiklander     }
204817466cbSJens Wiklander 
205817466cbSJens Wiklander     /* 2. Update state */
206*32b31808SJens Wiklander     if ((ret = mbedtls_hmac_drbg_update(ctx, seed, seedlen)) != 0) {
2073d3b0591SJens Wiklander         goto exit;
208*32b31808SJens Wiklander     }
209817466cbSJens Wiklander 
210817466cbSJens Wiklander     /* 3. Reset reseed_counter */
211817466cbSJens Wiklander     ctx->reseed_counter = 1;
212817466cbSJens Wiklander 
2133d3b0591SJens Wiklander exit:
214817466cbSJens Wiklander     /* 4. Done */
2153d3b0591SJens Wiklander     mbedtls_platform_zeroize(seed, seedlen);
216*32b31808SJens Wiklander     return ret;
217817466cbSJens Wiklander }
218817466cbSJens Wiklander 
219817466cbSJens Wiklander /*
2205b25c76aSJerome Forissier  * HMAC_DRBG reseeding: 10.1.2.4 + 9.2
2215b25c76aSJerome Forissier  */
2225b25c76aSJerome Forissier int mbedtls_hmac_drbg_reseed(mbedtls_hmac_drbg_context *ctx,
2235b25c76aSJerome Forissier                              const unsigned char *additional, size_t len)
2245b25c76aSJerome Forissier {
225*32b31808SJens Wiklander     return hmac_drbg_reseed_core(ctx, additional, len, 0);
2265b25c76aSJerome Forissier }
2275b25c76aSJerome Forissier 
2285b25c76aSJerome Forissier /*
229817466cbSJens Wiklander  * HMAC_DRBG initialisation (10.1.2.3 + 9.1)
2305b25c76aSJerome Forissier  *
2315b25c76aSJerome Forissier  * The nonce is not passed as a separate parameter but extracted
2325b25c76aSJerome Forissier  * from the entropy source as suggested in 8.6.7.
233817466cbSJens Wiklander  */
234817466cbSJens Wiklander int mbedtls_hmac_drbg_seed(mbedtls_hmac_drbg_context *ctx,
235817466cbSJens Wiklander                            const mbedtls_md_info_t *md_info,
236817466cbSJens Wiklander                            int (*f_entropy)(void *, unsigned char *, size_t),
237817466cbSJens Wiklander                            void *p_entropy,
238817466cbSJens Wiklander                            const unsigned char *custom,
239817466cbSJens Wiklander                            size_t len)
240817466cbSJens Wiklander {
24111fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2425b25c76aSJerome Forissier     size_t md_size;
243817466cbSJens Wiklander 
244*32b31808SJens Wiklander     if ((ret = mbedtls_md_setup(&ctx->md_ctx, md_info, 1)) != 0) {
245*32b31808SJens Wiklander         return ret;
246*32b31808SJens Wiklander     }
247817466cbSJens Wiklander 
2487901324dSJerome Forissier     /* The mutex is initialized iff the md context is set up. */
2497901324dSJerome Forissier #if defined(MBEDTLS_THREADING_C)
2507901324dSJerome Forissier     mbedtls_mutex_init(&ctx->mutex);
2517901324dSJerome Forissier #endif
2527901324dSJerome Forissier 
253817466cbSJens Wiklander     md_size = mbedtls_md_get_size(md_info);
254817466cbSJens Wiklander 
255817466cbSJens Wiklander     /*
256817466cbSJens Wiklander      * Set initial working state.
257817466cbSJens Wiklander      * Use the V memory location, which is currently all 0, to initialize the
258817466cbSJens Wiklander      * MD context with an all-zero key. Then set V to its initial value.
259817466cbSJens Wiklander      */
260*32b31808SJens Wiklander     if ((ret = mbedtls_md_hmac_starts(&ctx->md_ctx, ctx->V, md_size)) != 0) {
261*32b31808SJens Wiklander         return ret;
262*32b31808SJens Wiklander     }
263817466cbSJens Wiklander     memset(ctx->V, 0x01, md_size);
264817466cbSJens Wiklander 
265817466cbSJens Wiklander     ctx->f_entropy = f_entropy;
266817466cbSJens Wiklander     ctx->p_entropy = p_entropy;
267817466cbSJens Wiklander 
268*32b31808SJens Wiklander     if (ctx->entropy_len == 0) {
269817466cbSJens Wiklander         /*
270817466cbSJens Wiklander          * See SP800-57 5.6.1 (p. 65-66) for the security strength provided by
271817466cbSJens Wiklander          * each hash function, then according to SP800-90A rev1 10.1 table 2,
272817466cbSJens Wiklander          * min_entropy_len (in bits) is security_strength.
273817466cbSJens Wiklander          *
274817466cbSJens Wiklander          * (This also matches the sizes used in the NIST test vectors.)
275817466cbSJens Wiklander          */
2765b25c76aSJerome Forissier         ctx->entropy_len = md_size <= 20 ? 16 : /* 160-bits hash -> 128 bits */
277817466cbSJens Wiklander                            md_size <= 28 ? 24 : /* 224-bits hash -> 192 bits */
278817466cbSJens Wiklander                            32;  /* better (256+) -> 256 bits */
2795b25c76aSJerome Forissier     }
280817466cbSJens Wiklander 
2815b25c76aSJerome Forissier     if ((ret = hmac_drbg_reseed_core(ctx, custom, len,
282*32b31808SJens Wiklander                                      1 /* add nonce */)) != 0) {
283*32b31808SJens Wiklander         return ret;
2845b25c76aSJerome Forissier     }
285817466cbSJens Wiklander 
286*32b31808SJens Wiklander     return 0;
287817466cbSJens Wiklander }
288817466cbSJens Wiklander 
289817466cbSJens Wiklander /*
290817466cbSJens Wiklander  * Set prediction resistance
291817466cbSJens Wiklander  */
292817466cbSJens Wiklander void mbedtls_hmac_drbg_set_prediction_resistance(mbedtls_hmac_drbg_context *ctx,
293817466cbSJens Wiklander                                                  int resistance)
294817466cbSJens Wiklander {
295817466cbSJens Wiklander     ctx->prediction_resistance = resistance;
296817466cbSJens Wiklander }
297817466cbSJens Wiklander 
298817466cbSJens Wiklander /*
2995b25c76aSJerome Forissier  * Set entropy length grabbed for seeding
300817466cbSJens Wiklander  */
301817466cbSJens Wiklander void mbedtls_hmac_drbg_set_entropy_len(mbedtls_hmac_drbg_context *ctx, size_t len)
302817466cbSJens Wiklander {
303817466cbSJens Wiklander     ctx->entropy_len = len;
304817466cbSJens Wiklander }
305817466cbSJens Wiklander 
306817466cbSJens Wiklander /*
307817466cbSJens Wiklander  * Set reseed interval
308817466cbSJens Wiklander  */
309817466cbSJens Wiklander void mbedtls_hmac_drbg_set_reseed_interval(mbedtls_hmac_drbg_context *ctx, int interval)
310817466cbSJens Wiklander {
311817466cbSJens Wiklander     ctx->reseed_interval = interval;
312817466cbSJens Wiklander }
313817466cbSJens Wiklander 
314817466cbSJens Wiklander /*
315817466cbSJens Wiklander  * HMAC_DRBG random function with optional additional data:
316817466cbSJens Wiklander  * 10.1.2.5 (arabic) + 9.3 (Roman)
317817466cbSJens Wiklander  */
318817466cbSJens Wiklander int mbedtls_hmac_drbg_random_with_add(void *p_rng,
319817466cbSJens Wiklander                                       unsigned char *output, size_t out_len,
320817466cbSJens Wiklander                                       const unsigned char *additional, size_t add_len)
321817466cbSJens Wiklander {
32211fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
323817466cbSJens Wiklander     mbedtls_hmac_drbg_context *ctx = (mbedtls_hmac_drbg_context *) p_rng;
324817466cbSJens Wiklander     size_t md_len = mbedtls_md_get_size(ctx->md_ctx.md_info);
325817466cbSJens Wiklander     size_t left = out_len;
326817466cbSJens Wiklander     unsigned char *out = output;
327817466cbSJens Wiklander 
328817466cbSJens Wiklander     /* II. Check request length */
329*32b31808SJens Wiklander     if (out_len > MBEDTLS_HMAC_DRBG_MAX_REQUEST) {
330*32b31808SJens Wiklander         return MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG;
331*32b31808SJens Wiklander     }
332817466cbSJens Wiklander 
333817466cbSJens Wiklander     /* III. Check input length */
334*32b31808SJens Wiklander     if (add_len > MBEDTLS_HMAC_DRBG_MAX_INPUT) {
335*32b31808SJens Wiklander         return MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG;
336*32b31808SJens Wiklander     }
337817466cbSJens Wiklander 
338817466cbSJens Wiklander     /* 1. (aka VII and IX) Check reseed counter and PR */
339817466cbSJens Wiklander     if (ctx->f_entropy != NULL && /* For no-reseeding instances */
340817466cbSJens Wiklander         (ctx->prediction_resistance == MBEDTLS_HMAC_DRBG_PR_ON ||
341*32b31808SJens Wiklander          ctx->reseed_counter > ctx->reseed_interval)) {
342*32b31808SJens Wiklander         if ((ret = mbedtls_hmac_drbg_reseed(ctx, additional, add_len)) != 0) {
343*32b31808SJens Wiklander             return ret;
344*32b31808SJens Wiklander         }
345817466cbSJens Wiklander 
346817466cbSJens Wiklander         add_len = 0; /* VII.4 */
347817466cbSJens Wiklander     }
348817466cbSJens Wiklander 
349817466cbSJens Wiklander     /* 2. Use additional data if any */
350*32b31808SJens Wiklander     if (additional != NULL && add_len != 0) {
351*32b31808SJens Wiklander         if ((ret = mbedtls_hmac_drbg_update(ctx,
352*32b31808SJens Wiklander                                             additional, add_len)) != 0) {
3533d3b0591SJens Wiklander             goto exit;
3543d3b0591SJens Wiklander         }
355*32b31808SJens Wiklander     }
356817466cbSJens Wiklander 
357817466cbSJens Wiklander     /* 3, 4, 5. Generate bytes */
358*32b31808SJens Wiklander     while (left != 0) {
359817466cbSJens Wiklander         size_t use_len = left > md_len ? md_len : left;
360817466cbSJens Wiklander 
361*32b31808SJens Wiklander         if ((ret = mbedtls_md_hmac_reset(&ctx->md_ctx)) != 0) {
3623d3b0591SJens Wiklander             goto exit;
363*32b31808SJens Wiklander         }
3643d3b0591SJens Wiklander         if ((ret = mbedtls_md_hmac_update(&ctx->md_ctx,
365*32b31808SJens Wiklander                                           ctx->V, md_len)) != 0) {
3663d3b0591SJens Wiklander             goto exit;
367*32b31808SJens Wiklander         }
368*32b31808SJens Wiklander         if ((ret = mbedtls_md_hmac_finish(&ctx->md_ctx, ctx->V)) != 0) {
3693d3b0591SJens Wiklander             goto exit;
370*32b31808SJens Wiklander         }
371817466cbSJens Wiklander 
372817466cbSJens Wiklander         memcpy(out, ctx->V, use_len);
373817466cbSJens Wiklander         out += use_len;
374817466cbSJens Wiklander         left -= use_len;
375817466cbSJens Wiklander     }
376817466cbSJens Wiklander 
377817466cbSJens Wiklander     /* 6. Update */
378*32b31808SJens Wiklander     if ((ret = mbedtls_hmac_drbg_update(ctx,
379*32b31808SJens Wiklander                                         additional, add_len)) != 0) {
3803d3b0591SJens Wiklander         goto exit;
381*32b31808SJens Wiklander     }
382817466cbSJens Wiklander 
383817466cbSJens Wiklander     /* 7. Update reseed counter */
384817466cbSJens Wiklander     ctx->reseed_counter++;
385817466cbSJens Wiklander 
3863d3b0591SJens Wiklander exit:
387817466cbSJens Wiklander     /* 8. Done */
388*32b31808SJens Wiklander     return ret;
389817466cbSJens Wiklander }
390817466cbSJens Wiklander 
391817466cbSJens Wiklander /*
392817466cbSJens Wiklander  * HMAC_DRBG random function
393817466cbSJens Wiklander  */
394817466cbSJens Wiklander int mbedtls_hmac_drbg_random(void *p_rng, unsigned char *output, size_t out_len)
395817466cbSJens Wiklander {
39611fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
397817466cbSJens Wiklander     mbedtls_hmac_drbg_context *ctx = (mbedtls_hmac_drbg_context *) p_rng;
398817466cbSJens Wiklander 
399817466cbSJens Wiklander #if defined(MBEDTLS_THREADING_C)
400*32b31808SJens Wiklander     if ((ret = mbedtls_mutex_lock(&ctx->mutex)) != 0) {
401*32b31808SJens Wiklander         return ret;
402*32b31808SJens Wiklander     }
403817466cbSJens Wiklander #endif
404817466cbSJens Wiklander 
405817466cbSJens Wiklander     ret = mbedtls_hmac_drbg_random_with_add(ctx, output, out_len, NULL, 0);
406817466cbSJens Wiklander 
407817466cbSJens Wiklander #if defined(MBEDTLS_THREADING_C)
408*32b31808SJens Wiklander     if (mbedtls_mutex_unlock(&ctx->mutex) != 0) {
409*32b31808SJens Wiklander         return MBEDTLS_ERR_THREADING_MUTEX_ERROR;
410*32b31808SJens Wiklander     }
411817466cbSJens Wiklander #endif
412817466cbSJens Wiklander 
413*32b31808SJens Wiklander     return ret;
414817466cbSJens Wiklander }
415817466cbSJens Wiklander 
416817466cbSJens Wiklander /*
4177901324dSJerome Forissier  *  This function resets HMAC_DRBG context to the state immediately
4187901324dSJerome Forissier  *  after initial call of mbedtls_hmac_drbg_init().
419817466cbSJens Wiklander  */
420817466cbSJens Wiklander void mbedtls_hmac_drbg_free(mbedtls_hmac_drbg_context *ctx)
421817466cbSJens Wiklander {
422*32b31808SJens Wiklander     if (ctx == NULL) {
423817466cbSJens Wiklander         return;
424*32b31808SJens Wiklander     }
425817466cbSJens Wiklander 
426817466cbSJens Wiklander #if defined(MBEDTLS_THREADING_C)
4277901324dSJerome Forissier     /* The mutex is initialized iff the md context is set up. */
428*32b31808SJens Wiklander     if (ctx->md_ctx.md_info != NULL) {
429817466cbSJens Wiklander         mbedtls_mutex_free(&ctx->mutex);
430*32b31808SJens Wiklander     }
431817466cbSJens Wiklander #endif
432817466cbSJens Wiklander     mbedtls_md_free(&ctx->md_ctx);
4333d3b0591SJens Wiklander     mbedtls_platform_zeroize(ctx, sizeof(mbedtls_hmac_drbg_context));
4347901324dSJerome Forissier     ctx->reseed_interval = MBEDTLS_HMAC_DRBG_RESEED_INTERVAL;
435817466cbSJens Wiklander }
436817466cbSJens Wiklander 
437817466cbSJens Wiklander #if defined(MBEDTLS_FS_IO)
438817466cbSJens Wiklander int mbedtls_hmac_drbg_write_seed_file(mbedtls_hmac_drbg_context *ctx, const char *path)
439817466cbSJens Wiklander {
44011fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
441817466cbSJens Wiklander     FILE *f;
442817466cbSJens Wiklander     unsigned char buf[MBEDTLS_HMAC_DRBG_MAX_INPUT];
443817466cbSJens Wiklander 
444*32b31808SJens Wiklander     if ((f = fopen(path, "wb")) == NULL) {
445*32b31808SJens Wiklander         return MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR;
446*32b31808SJens Wiklander     }
447817466cbSJens Wiklander 
448*32b31808SJens Wiklander     /* Ensure no stdio buffering of secrets, as such buffers cannot be wiped. */
449*32b31808SJens Wiklander     mbedtls_setbuf(f, NULL);
450*32b31808SJens Wiklander 
451*32b31808SJens Wiklander     if ((ret = mbedtls_hmac_drbg_random(ctx, buf, sizeof(buf))) != 0) {
452817466cbSJens Wiklander         goto exit;
453*32b31808SJens Wiklander     }
454817466cbSJens Wiklander 
455*32b31808SJens Wiklander     if (fwrite(buf, 1, sizeof(buf), f) != sizeof(buf)) {
456817466cbSJens Wiklander         ret = MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR;
457817466cbSJens Wiklander         goto exit;
458817466cbSJens Wiklander     }
459817466cbSJens Wiklander 
460817466cbSJens Wiklander     ret = 0;
461817466cbSJens Wiklander 
462817466cbSJens Wiklander exit:
463817466cbSJens Wiklander     fclose(f);
4643d3b0591SJens Wiklander     mbedtls_platform_zeroize(buf, sizeof(buf));
4653d3b0591SJens Wiklander 
466*32b31808SJens Wiklander     return ret;
467817466cbSJens Wiklander }
468817466cbSJens Wiklander 
469817466cbSJens Wiklander int mbedtls_hmac_drbg_update_seed_file(mbedtls_hmac_drbg_context *ctx, const char *path)
470817466cbSJens Wiklander {
4713d3b0591SJens Wiklander     int ret = 0;
4723d3b0591SJens Wiklander     FILE *f = NULL;
473817466cbSJens Wiklander     size_t n;
474817466cbSJens Wiklander     unsigned char buf[MBEDTLS_HMAC_DRBG_MAX_INPUT];
4753d3b0591SJens Wiklander     unsigned char c;
476817466cbSJens Wiklander 
477*32b31808SJens Wiklander     if ((f = fopen(path, "rb")) == NULL) {
478*32b31808SJens Wiklander         return MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR;
479*32b31808SJens Wiklander     }
480*32b31808SJens Wiklander 
481*32b31808SJens Wiklander     /* Ensure no stdio buffering of secrets, as such buffers cannot be wiped. */
482*32b31808SJens Wiklander     mbedtls_setbuf(f, NULL);
483817466cbSJens Wiklander 
4843d3b0591SJens Wiklander     n = fread(buf, 1, sizeof(buf), f);
485*32b31808SJens Wiklander     if (fread(&c, 1, 1, f) != 0) {
4863d3b0591SJens Wiklander         ret = MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG;
4873d3b0591SJens Wiklander         goto exit;
488817466cbSJens Wiklander     }
489*32b31808SJens Wiklander     if (n == 0 || ferror(f)) {
4903d3b0591SJens Wiklander         ret = MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR;
4913d3b0591SJens Wiklander         goto exit;
492817466cbSJens Wiklander     }
493817466cbSJens Wiklander     fclose(f);
4943d3b0591SJens Wiklander     f = NULL;
495817466cbSJens Wiklander 
496*32b31808SJens Wiklander     ret = mbedtls_hmac_drbg_update(ctx, buf, n);
497817466cbSJens Wiklander 
4983d3b0591SJens Wiklander exit:
4993d3b0591SJens Wiklander     mbedtls_platform_zeroize(buf, sizeof(buf));
500*32b31808SJens Wiklander     if (f != NULL) {
5013d3b0591SJens Wiklander         fclose(f);
502*32b31808SJens Wiklander     }
503*32b31808SJens Wiklander     if (ret != 0) {
504*32b31808SJens Wiklander         return ret;
505*32b31808SJens Wiklander     }
506*32b31808SJens Wiklander     return mbedtls_hmac_drbg_write_seed_file(ctx, path);
507817466cbSJens Wiklander }
508817466cbSJens Wiklander #endif /* MBEDTLS_FS_IO */
509817466cbSJens Wiklander 
510817466cbSJens Wiklander 
511817466cbSJens Wiklander #if defined(MBEDTLS_SELF_TEST)
512817466cbSJens Wiklander 
513817466cbSJens Wiklander #if !defined(MBEDTLS_SHA1_C)
514817466cbSJens Wiklander /* Dummy checkup routine */
515817466cbSJens Wiklander int mbedtls_hmac_drbg_self_test(int verbose)
516817466cbSJens Wiklander {
517817466cbSJens Wiklander     (void) verbose;
518*32b31808SJens Wiklander     return 0;
519817466cbSJens Wiklander }
520817466cbSJens Wiklander #else
521817466cbSJens Wiklander 
522817466cbSJens Wiklander #define OUTPUT_LEN  80
523817466cbSJens Wiklander 
524817466cbSJens Wiklander /* From a NIST PR=true test vector */
525817466cbSJens Wiklander static const unsigned char entropy_pr[] = {
526817466cbSJens Wiklander     0xa0, 0xc9, 0xab, 0x58, 0xf1, 0xe2, 0xe5, 0xa4, 0xde, 0x3e, 0xbd, 0x4f,
527817466cbSJens Wiklander     0xf7, 0x3e, 0x9c, 0x5b, 0x64, 0xef, 0xd8, 0xca, 0x02, 0x8c, 0xf8, 0x11,
528817466cbSJens Wiklander     0x48, 0xa5, 0x84, 0xfe, 0x69, 0xab, 0x5a, 0xee, 0x42, 0xaa, 0x4d, 0x42,
529817466cbSJens Wiklander     0x17, 0x60, 0x99, 0xd4, 0x5e, 0x13, 0x97, 0xdc, 0x40, 0x4d, 0x86, 0xa3,
530*32b31808SJens Wiklander     0x7b, 0xf5, 0x59, 0x54, 0x75, 0x69, 0x51, 0xe4
531*32b31808SJens Wiklander };
532817466cbSJens Wiklander static const unsigned char result_pr[OUTPUT_LEN] = {
533817466cbSJens Wiklander     0x9a, 0x00, 0xa2, 0xd0, 0x0e, 0xd5, 0x9b, 0xfe, 0x31, 0xec, 0xb1, 0x39,
534817466cbSJens Wiklander     0x9b, 0x60, 0x81, 0x48, 0xd1, 0x96, 0x9d, 0x25, 0x0d, 0x3c, 0x1e, 0x94,
535817466cbSJens Wiklander     0x10, 0x10, 0x98, 0x12, 0x93, 0x25, 0xca, 0xb8, 0xfc, 0xcc, 0x2d, 0x54,
536817466cbSJens Wiklander     0x73, 0x19, 0x70, 0xc0, 0x10, 0x7a, 0xa4, 0x89, 0x25, 0x19, 0x95, 0x5e,
537817466cbSJens Wiklander     0x4b, 0xc6, 0x00, 0x1d, 0x7f, 0x4e, 0x6a, 0x2b, 0xf8, 0xa3, 0x01, 0xab,
538817466cbSJens Wiklander     0x46, 0x05, 0x5c, 0x09, 0xa6, 0x71, 0x88, 0xf1, 0xa7, 0x40, 0xee, 0xf3,
539*32b31808SJens Wiklander     0xe1, 0x5c, 0x02, 0x9b, 0x44, 0xaf, 0x03, 0x44
540*32b31808SJens Wiklander };
541817466cbSJens Wiklander 
542817466cbSJens Wiklander /* From a NIST PR=false test vector */
543817466cbSJens Wiklander static const unsigned char entropy_nopr[] = {
544817466cbSJens Wiklander     0x79, 0x34, 0x9b, 0xbf, 0x7c, 0xdd, 0xa5, 0x79, 0x95, 0x57, 0x86, 0x66,
545817466cbSJens Wiklander     0x21, 0xc9, 0x13, 0x83, 0x11, 0x46, 0x73, 0x3a, 0xbf, 0x8c, 0x35, 0xc8,
546817466cbSJens Wiklander     0xc7, 0x21, 0x5b, 0x5b, 0x96, 0xc4, 0x8e, 0x9b, 0x33, 0x8c, 0x74, 0xe3,
547*32b31808SJens Wiklander     0xe9, 0x9d, 0xfe, 0xdf
548*32b31808SJens Wiklander };
549817466cbSJens Wiklander static const unsigned char result_nopr[OUTPUT_LEN] = {
550817466cbSJens Wiklander     0xc6, 0xa1, 0x6a, 0xb8, 0xd4, 0x20, 0x70, 0x6f, 0x0f, 0x34, 0xab, 0x7f,
551817466cbSJens Wiklander     0xec, 0x5a, 0xdc, 0xa9, 0xd8, 0xca, 0x3a, 0x13, 0x3e, 0x15, 0x9c, 0xa6,
552817466cbSJens Wiklander     0xac, 0x43, 0xc6, 0xf8, 0xa2, 0xbe, 0x22, 0x83, 0x4a, 0x4c, 0x0a, 0x0a,
553817466cbSJens Wiklander     0xff, 0xb1, 0x0d, 0x71, 0x94, 0xf1, 0xc1, 0xa5, 0xcf, 0x73, 0x22, 0xec,
554817466cbSJens Wiklander     0x1a, 0xe0, 0x96, 0x4e, 0xd4, 0xbf, 0x12, 0x27, 0x46, 0xe0, 0x87, 0xfd,
555817466cbSJens Wiklander     0xb5, 0xb3, 0xe9, 0x1b, 0x34, 0x93, 0xd5, 0xbb, 0x98, 0xfa, 0xed, 0x49,
556*32b31808SJens Wiklander     0xe8, 0x5f, 0x13, 0x0f, 0xc8, 0xa4, 0x59, 0xb7
557*32b31808SJens Wiklander };
558817466cbSJens Wiklander 
559817466cbSJens Wiklander /* "Entropy" from buffer */
560817466cbSJens Wiklander static size_t test_offset;
561817466cbSJens Wiklander static int hmac_drbg_self_test_entropy(void *data,
562817466cbSJens Wiklander                                        unsigned char *buf, size_t len)
563817466cbSJens Wiklander {
564817466cbSJens Wiklander     const unsigned char *p = data;
565817466cbSJens Wiklander     memcpy(buf, p + test_offset, len);
566817466cbSJens Wiklander     test_offset += len;
567*32b31808SJens Wiklander     return 0;
568817466cbSJens Wiklander }
569817466cbSJens Wiklander 
570817466cbSJens Wiklander #define CHK(c)    if ((c) != 0)                          \
571817466cbSJens Wiklander     {                                       \
572817466cbSJens Wiklander         if (verbose != 0)                  \
573817466cbSJens Wiklander         mbedtls_printf("failed\n");  \
574*32b31808SJens Wiklander         return 1;                        \
575817466cbSJens Wiklander     }
576817466cbSJens Wiklander 
577817466cbSJens Wiklander /*
578817466cbSJens Wiklander  * Checkup routine for HMAC_DRBG with SHA-1
579817466cbSJens Wiklander  */
580817466cbSJens Wiklander int mbedtls_hmac_drbg_self_test(int verbose)
581817466cbSJens Wiklander {
582817466cbSJens Wiklander     mbedtls_hmac_drbg_context ctx;
583817466cbSJens Wiklander     unsigned char buf[OUTPUT_LEN];
584817466cbSJens Wiklander     const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type(MBEDTLS_MD_SHA1);
585817466cbSJens Wiklander 
586817466cbSJens Wiklander     mbedtls_hmac_drbg_init(&ctx);
587817466cbSJens Wiklander 
588817466cbSJens Wiklander     /*
589817466cbSJens Wiklander      * PR = True
590817466cbSJens Wiklander      */
591*32b31808SJens Wiklander     if (verbose != 0) {
592817466cbSJens Wiklander         mbedtls_printf("  HMAC_DRBG (PR = True) : ");
593*32b31808SJens Wiklander     }
594817466cbSJens Wiklander 
595817466cbSJens Wiklander     test_offset = 0;
596817466cbSJens Wiklander     CHK(mbedtls_hmac_drbg_seed(&ctx, md_info,
597817466cbSJens Wiklander                                hmac_drbg_self_test_entropy, (void *) entropy_pr,
598817466cbSJens Wiklander                                NULL, 0));
599817466cbSJens Wiklander     mbedtls_hmac_drbg_set_prediction_resistance(&ctx, MBEDTLS_HMAC_DRBG_PR_ON);
600817466cbSJens Wiklander     CHK(mbedtls_hmac_drbg_random(&ctx, buf, OUTPUT_LEN));
601817466cbSJens Wiklander     CHK(mbedtls_hmac_drbg_random(&ctx, buf, OUTPUT_LEN));
602817466cbSJens Wiklander     CHK(memcmp(buf, result_pr, OUTPUT_LEN));
603817466cbSJens Wiklander     mbedtls_hmac_drbg_free(&ctx);
604817466cbSJens Wiklander 
605817466cbSJens Wiklander     mbedtls_hmac_drbg_free(&ctx);
606817466cbSJens Wiklander 
607*32b31808SJens Wiklander     if (verbose != 0) {
608817466cbSJens Wiklander         mbedtls_printf("passed\n");
609*32b31808SJens Wiklander     }
610817466cbSJens Wiklander 
611817466cbSJens Wiklander     /*
612817466cbSJens Wiklander      * PR = False
613817466cbSJens Wiklander      */
614*32b31808SJens Wiklander     if (verbose != 0) {
615817466cbSJens Wiklander         mbedtls_printf("  HMAC_DRBG (PR = False) : ");
616*32b31808SJens Wiklander     }
617817466cbSJens Wiklander 
618817466cbSJens Wiklander     mbedtls_hmac_drbg_init(&ctx);
619817466cbSJens Wiklander 
620817466cbSJens Wiklander     test_offset = 0;
621817466cbSJens Wiklander     CHK(mbedtls_hmac_drbg_seed(&ctx, md_info,
622817466cbSJens Wiklander                                hmac_drbg_self_test_entropy, (void *) entropy_nopr,
623817466cbSJens Wiklander                                NULL, 0));
624817466cbSJens Wiklander     CHK(mbedtls_hmac_drbg_reseed(&ctx, NULL, 0));
625817466cbSJens Wiklander     CHK(mbedtls_hmac_drbg_random(&ctx, buf, OUTPUT_LEN));
626817466cbSJens Wiklander     CHK(mbedtls_hmac_drbg_random(&ctx, buf, OUTPUT_LEN));
627817466cbSJens Wiklander     CHK(memcmp(buf, result_nopr, OUTPUT_LEN));
628817466cbSJens Wiklander     mbedtls_hmac_drbg_free(&ctx);
629817466cbSJens Wiklander 
630817466cbSJens Wiklander     mbedtls_hmac_drbg_free(&ctx);
631817466cbSJens Wiklander 
632*32b31808SJens Wiklander     if (verbose != 0) {
633817466cbSJens Wiklander         mbedtls_printf("passed\n");
634*32b31808SJens Wiklander     }
635817466cbSJens Wiklander 
636*32b31808SJens Wiklander     if (verbose != 0) {
637817466cbSJens Wiklander         mbedtls_printf("\n");
638*32b31808SJens Wiklander     }
639817466cbSJens Wiklander 
640*32b31808SJens Wiklander     return 0;
641817466cbSJens Wiklander }
642817466cbSJens Wiklander #endif /* MBEDTLS_SHA1_C */
643817466cbSJens Wiklander #endif /* MBEDTLS_SELF_TEST */
644817466cbSJens Wiklander 
645817466cbSJens Wiklander #endif /* MBEDTLS_HMAC_DRBG_C */
646