xref: /optee_os/lib/libmbedtls/mbedtls/library/hmac_drbg.c (revision 11fa71b9ddb429088f325cfda430183003ccd1db)
1c6672fdcSEdison Ai // SPDX-License-Identifier: Apache-2.0
2817466cbSJens Wiklander /*
3817466cbSJens Wiklander  *  HMAC_DRBG implementation (NIST SP 800-90)
4817466cbSJens Wiklander  *
5817466cbSJens Wiklander  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
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  *  This file is part of mbed TLS (https://tls.mbed.org)
20817466cbSJens Wiklander  */
21817466cbSJens Wiklander 
22817466cbSJens Wiklander /*
23817466cbSJens Wiklander  *  The NIST SP 800-90A DRBGs are described in the following publication.
24817466cbSJens Wiklander  *  http://csrc.nist.gov/publications/nistpubs/800-90A/SP800-90A.pdf
25817466cbSJens Wiklander  *  References below are based on rev. 1 (January 2012).
26817466cbSJens Wiklander  */
27817466cbSJens Wiklander 
28817466cbSJens Wiklander #if !defined(MBEDTLS_CONFIG_FILE)
29817466cbSJens Wiklander #include "mbedtls/config.h"
30817466cbSJens Wiklander #else
31817466cbSJens Wiklander #include MBEDTLS_CONFIG_FILE
32817466cbSJens Wiklander #endif
33817466cbSJens Wiklander 
34817466cbSJens Wiklander #if defined(MBEDTLS_HMAC_DRBG_C)
35817466cbSJens Wiklander 
36817466cbSJens Wiklander #include "mbedtls/hmac_drbg.h"
373d3b0591SJens Wiklander #include "mbedtls/platform_util.h"
38*11fa71b9SJerome Forissier #include "mbedtls/error.h"
39817466cbSJens Wiklander 
40817466cbSJens Wiklander #include <string.h>
41817466cbSJens Wiklander 
42817466cbSJens Wiklander #if defined(MBEDTLS_FS_IO)
43817466cbSJens Wiklander #include <stdio.h>
44817466cbSJens Wiklander #endif
45817466cbSJens Wiklander 
46817466cbSJens Wiklander #if defined(MBEDTLS_SELF_TEST)
47817466cbSJens Wiklander #if defined(MBEDTLS_PLATFORM_C)
48817466cbSJens Wiklander #include "mbedtls/platform.h"
49817466cbSJens Wiklander #else
50817466cbSJens Wiklander #include <stdio.h>
51817466cbSJens Wiklander #define mbedtls_printf printf
52817466cbSJens Wiklander #endif /* MBEDTLS_SELF_TEST */
53817466cbSJens Wiklander #endif /* MBEDTLS_PLATFORM_C */
54817466cbSJens Wiklander 
55817466cbSJens Wiklander /*
56817466cbSJens Wiklander  * HMAC_DRBG context initialization
57817466cbSJens Wiklander  */
58817466cbSJens Wiklander void mbedtls_hmac_drbg_init( mbedtls_hmac_drbg_context *ctx )
59817466cbSJens Wiklander {
60817466cbSJens Wiklander     memset( ctx, 0, sizeof( mbedtls_hmac_drbg_context ) );
61817466cbSJens Wiklander 
62817466cbSJens Wiklander #if defined(MBEDTLS_THREADING_C)
63817466cbSJens Wiklander     mbedtls_mutex_init( &ctx->mutex );
64817466cbSJens Wiklander #endif
65817466cbSJens Wiklander }
66817466cbSJens Wiklander 
67817466cbSJens Wiklander /*
68817466cbSJens Wiklander  * HMAC_DRBG update, using optional additional data (10.1.2.2)
69817466cbSJens Wiklander  */
703d3b0591SJens Wiklander int mbedtls_hmac_drbg_update_ret( mbedtls_hmac_drbg_context *ctx,
713d3b0591SJens Wiklander                                   const unsigned char *additional,
723d3b0591SJens Wiklander                                   size_t add_len )
73817466cbSJens Wiklander {
74817466cbSJens Wiklander     size_t md_len = mbedtls_md_get_size( ctx->md_ctx.md_info );
75817466cbSJens Wiklander     unsigned char rounds = ( additional != NULL && add_len != 0 ) ? 2 : 1;
76817466cbSJens Wiklander     unsigned char sep[1];
77817466cbSJens Wiklander     unsigned char K[MBEDTLS_MD_MAX_SIZE];
78*11fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_MD_BAD_INPUT_DATA;
79817466cbSJens Wiklander 
80817466cbSJens Wiklander     for( sep[0] = 0; sep[0] < rounds; sep[0]++ )
81817466cbSJens Wiklander     {
82817466cbSJens Wiklander         /* Step 1 or 4 */
833d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_reset( &ctx->md_ctx ) ) != 0 )
843d3b0591SJens Wiklander             goto exit;
853d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_update( &ctx->md_ctx,
863d3b0591SJens Wiklander                                             ctx->V, md_len ) ) != 0 )
873d3b0591SJens Wiklander             goto exit;
883d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_update( &ctx->md_ctx,
893d3b0591SJens Wiklander                                             sep, 1 ) ) != 0 )
903d3b0591SJens Wiklander             goto exit;
91817466cbSJens Wiklander         if( rounds == 2 )
923d3b0591SJens Wiklander         {
933d3b0591SJens Wiklander             if( ( ret = mbedtls_md_hmac_update( &ctx->md_ctx,
943d3b0591SJens Wiklander                                                 additional, add_len ) ) != 0 )
953d3b0591SJens Wiklander             goto exit;
963d3b0591SJens Wiklander         }
973d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_finish( &ctx->md_ctx, K ) ) != 0 )
983d3b0591SJens Wiklander             goto exit;
99817466cbSJens Wiklander 
100817466cbSJens Wiklander         /* Step 2 or 5 */
1013d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_starts( &ctx->md_ctx, K, md_len ) ) != 0 )
1023d3b0591SJens Wiklander             goto exit;
1033d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_update( &ctx->md_ctx,
1043d3b0591SJens Wiklander                                             ctx->V, md_len ) ) != 0 )
1053d3b0591SJens Wiklander             goto exit;
1063d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_finish( &ctx->md_ctx, ctx->V ) ) != 0 )
1073d3b0591SJens Wiklander             goto exit;
108817466cbSJens Wiklander     }
1093d3b0591SJens Wiklander 
1103d3b0591SJens Wiklander exit:
1113d3b0591SJens Wiklander     mbedtls_platform_zeroize( K, sizeof( K ) );
1123d3b0591SJens Wiklander     return( ret );
113817466cbSJens Wiklander }
114817466cbSJens Wiklander 
1153d3b0591SJens Wiklander #if !defined(MBEDTLS_DEPRECATED_REMOVED)
1163d3b0591SJens Wiklander void mbedtls_hmac_drbg_update( mbedtls_hmac_drbg_context *ctx,
1173d3b0591SJens Wiklander                                const unsigned char *additional,
1183d3b0591SJens Wiklander                                size_t add_len )
1193d3b0591SJens Wiklander {
1203d3b0591SJens Wiklander     (void) mbedtls_hmac_drbg_update_ret( ctx, additional, add_len );
1213d3b0591SJens Wiklander }
1223d3b0591SJens Wiklander #endif /* MBEDTLS_DEPRECATED_REMOVED */
1233d3b0591SJens Wiklander 
124817466cbSJens Wiklander /*
125817466cbSJens Wiklander  * Simplified HMAC_DRBG initialisation (for use with deterministic ECDSA)
126817466cbSJens Wiklander  */
127817466cbSJens Wiklander int mbedtls_hmac_drbg_seed_buf( mbedtls_hmac_drbg_context *ctx,
128817466cbSJens Wiklander                         const mbedtls_md_info_t * md_info,
129817466cbSJens Wiklander                         const unsigned char *data, size_t data_len )
130817466cbSJens Wiklander {
131*11fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
132817466cbSJens Wiklander 
133817466cbSJens Wiklander     if( ( ret = mbedtls_md_setup( &ctx->md_ctx, md_info, 1 ) ) != 0 )
134817466cbSJens Wiklander         return( ret );
135817466cbSJens Wiklander 
136817466cbSJens Wiklander     /*
137817466cbSJens Wiklander      * Set initial working state.
138817466cbSJens Wiklander      * Use the V memory location, which is currently all 0, to initialize the
139817466cbSJens Wiklander      * MD context with an all-zero key. Then set V to its initial value.
140817466cbSJens Wiklander      */
1413d3b0591SJens Wiklander     if( ( ret = mbedtls_md_hmac_starts( &ctx->md_ctx, ctx->V,
1423d3b0591SJens Wiklander                                         mbedtls_md_get_size( md_info ) ) ) != 0 )
1433d3b0591SJens Wiklander         return( ret );
144817466cbSJens Wiklander     memset( ctx->V, 0x01, mbedtls_md_get_size( md_info ) );
145817466cbSJens Wiklander 
1463d3b0591SJens Wiklander     if( ( ret = mbedtls_hmac_drbg_update_ret( ctx, data, data_len ) ) != 0 )
1473d3b0591SJens Wiklander         return( ret );
148817466cbSJens Wiklander 
149817466cbSJens Wiklander     return( 0 );
150817466cbSJens Wiklander }
151817466cbSJens Wiklander 
152817466cbSJens Wiklander /*
1535b25c76aSJerome Forissier  * Internal function used both for seeding and reseeding the DRBG.
1545b25c76aSJerome Forissier  * Comments starting with arabic numbers refer to section 10.1.2.4
1555b25c76aSJerome Forissier  * of SP800-90A, while roman numbers refer to section 9.2.
156817466cbSJens Wiklander  */
1575b25c76aSJerome Forissier static int hmac_drbg_reseed_core( mbedtls_hmac_drbg_context *ctx,
1585b25c76aSJerome Forissier                                   const unsigned char *additional, size_t len,
1595b25c76aSJerome Forissier                                   int use_nonce )
160817466cbSJens Wiklander {
161817466cbSJens Wiklander     unsigned char seed[MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT];
1625b25c76aSJerome Forissier     size_t seedlen = 0;
163*11fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
164817466cbSJens Wiklander 
1655b25c76aSJerome Forissier     {
1665b25c76aSJerome Forissier         size_t total_entropy_len;
1675b25c76aSJerome Forissier 
1685b25c76aSJerome Forissier         if( use_nonce == 0 )
1695b25c76aSJerome Forissier             total_entropy_len = ctx->entropy_len;
1705b25c76aSJerome Forissier         else
1715b25c76aSJerome Forissier             total_entropy_len = ctx->entropy_len * 3 / 2;
1725b25c76aSJerome Forissier 
173817466cbSJens Wiklander         /* III. Check input length */
174817466cbSJens Wiklander         if( len > MBEDTLS_HMAC_DRBG_MAX_INPUT ||
1755b25c76aSJerome Forissier             total_entropy_len + len > MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT )
176817466cbSJens Wiklander         {
177817466cbSJens Wiklander             return( MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG );
178817466cbSJens Wiklander         }
1795b25c76aSJerome Forissier     }
180817466cbSJens Wiklander 
181817466cbSJens Wiklander     memset( seed, 0, MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT );
182817466cbSJens Wiklander 
183817466cbSJens Wiklander     /* IV. Gather entropy_len bytes of entropy for the seed */
1843d3b0591SJens Wiklander     if( ( ret = ctx->f_entropy( ctx->p_entropy,
1853d3b0591SJens Wiklander                                 seed, ctx->entropy_len ) ) != 0 )
1865b25c76aSJerome Forissier     {
187817466cbSJens Wiklander         return( MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED );
1885b25c76aSJerome Forissier     }
1895b25c76aSJerome Forissier     seedlen += ctx->entropy_len;
190817466cbSJens Wiklander 
1915b25c76aSJerome Forissier     /* For initial seeding, allow adding of nonce generated
1925b25c76aSJerome Forissier      * from the entropy source. See Sect 8.6.7 in SP800-90A. */
1935b25c76aSJerome Forissier     if( use_nonce )
1945b25c76aSJerome Forissier     {
1955b25c76aSJerome Forissier         /* Note: We don't merge the two calls to f_entropy() in order
1965b25c76aSJerome Forissier          *       to avoid requesting too much entropy from f_entropy()
1975b25c76aSJerome Forissier          *       at once. Specifically, if the underlying digest is not
1985b25c76aSJerome Forissier          *       SHA-1, 3 / 2 * entropy_len is at least 36 Bytes, which
1995b25c76aSJerome Forissier          *       is larger than the maximum of 32 Bytes that our own
2005b25c76aSJerome Forissier          *       entropy source implementation can emit in a single
2015b25c76aSJerome Forissier          *       call in configurations disabling SHA-512. */
2025b25c76aSJerome Forissier         if( ( ret = ctx->f_entropy( ctx->p_entropy,
2035b25c76aSJerome Forissier                                     seed + seedlen,
2045b25c76aSJerome Forissier                                     ctx->entropy_len / 2 ) ) != 0 )
2055b25c76aSJerome Forissier         {
2065b25c76aSJerome Forissier             return( MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED );
2075b25c76aSJerome Forissier         }
2085b25c76aSJerome Forissier 
2095b25c76aSJerome Forissier         seedlen += ctx->entropy_len / 2;
2105b25c76aSJerome Forissier     }
2115b25c76aSJerome Forissier 
212817466cbSJens Wiklander 
213817466cbSJens Wiklander     /* 1. Concatenate entropy and additional data if any */
214817466cbSJens Wiklander     if( additional != NULL && len != 0 )
215817466cbSJens Wiklander     {
216817466cbSJens Wiklander         memcpy( seed + seedlen, additional, len );
217817466cbSJens Wiklander         seedlen += len;
218817466cbSJens Wiklander     }
219817466cbSJens Wiklander 
220817466cbSJens Wiklander     /* 2. Update state */
2213d3b0591SJens Wiklander     if( ( ret = mbedtls_hmac_drbg_update_ret( ctx, seed, seedlen ) ) != 0 )
2223d3b0591SJens Wiklander         goto exit;
223817466cbSJens Wiklander 
224817466cbSJens Wiklander     /* 3. Reset reseed_counter */
225817466cbSJens Wiklander     ctx->reseed_counter = 1;
226817466cbSJens Wiklander 
2273d3b0591SJens Wiklander exit:
228817466cbSJens Wiklander     /* 4. Done */
2293d3b0591SJens Wiklander     mbedtls_platform_zeroize( seed, seedlen );
2303d3b0591SJens Wiklander     return( ret );
231817466cbSJens Wiklander }
232817466cbSJens Wiklander 
233817466cbSJens Wiklander /*
2345b25c76aSJerome Forissier  * HMAC_DRBG reseeding: 10.1.2.4 + 9.2
2355b25c76aSJerome Forissier  */
2365b25c76aSJerome Forissier int mbedtls_hmac_drbg_reseed( mbedtls_hmac_drbg_context *ctx,
2375b25c76aSJerome Forissier                       const unsigned char *additional, size_t len )
2385b25c76aSJerome Forissier {
2395b25c76aSJerome Forissier     return( hmac_drbg_reseed_core( ctx, additional, len, 0 ) );
2405b25c76aSJerome Forissier }
2415b25c76aSJerome Forissier 
2425b25c76aSJerome Forissier /*
243817466cbSJens Wiklander  * HMAC_DRBG initialisation (10.1.2.3 + 9.1)
2445b25c76aSJerome Forissier  *
2455b25c76aSJerome Forissier  * The nonce is not passed as a separate parameter but extracted
2465b25c76aSJerome Forissier  * from the entropy source as suggested in 8.6.7.
247817466cbSJens Wiklander  */
248817466cbSJens Wiklander int mbedtls_hmac_drbg_seed( mbedtls_hmac_drbg_context *ctx,
249817466cbSJens Wiklander                     const mbedtls_md_info_t * md_info,
250817466cbSJens Wiklander                     int (*f_entropy)(void *, unsigned char *, size_t),
251817466cbSJens Wiklander                     void *p_entropy,
252817466cbSJens Wiklander                     const unsigned char *custom,
253817466cbSJens Wiklander                     size_t len )
254817466cbSJens Wiklander {
255*11fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2565b25c76aSJerome Forissier     size_t md_size;
257817466cbSJens Wiklander 
258817466cbSJens Wiklander     if( ( ret = mbedtls_md_setup( &ctx->md_ctx, md_info, 1 ) ) != 0 )
259817466cbSJens Wiklander         return( ret );
260817466cbSJens Wiklander 
261817466cbSJens Wiklander     md_size = mbedtls_md_get_size( md_info );
262817466cbSJens Wiklander 
263817466cbSJens Wiklander     /*
264817466cbSJens Wiklander      * Set initial working state.
265817466cbSJens Wiklander      * Use the V memory location, which is currently all 0, to initialize the
266817466cbSJens Wiklander      * MD context with an all-zero key. Then set V to its initial value.
267817466cbSJens Wiklander      */
2683d3b0591SJens Wiklander     if( ( ret = mbedtls_md_hmac_starts( &ctx->md_ctx, ctx->V, md_size ) ) != 0 )
2693d3b0591SJens Wiklander         return( ret );
270817466cbSJens Wiklander     memset( ctx->V, 0x01, md_size );
271817466cbSJens Wiklander 
272817466cbSJens Wiklander     ctx->f_entropy = f_entropy;
273817466cbSJens Wiklander     ctx->p_entropy = p_entropy;
274817466cbSJens Wiklander 
275817466cbSJens Wiklander     ctx->reseed_interval = MBEDTLS_HMAC_DRBG_RESEED_INTERVAL;
276817466cbSJens Wiklander 
2775b25c76aSJerome Forissier     if( ctx->entropy_len == 0 )
2785b25c76aSJerome Forissier     {
279817466cbSJens Wiklander         /*
280817466cbSJens Wiklander          * See SP800-57 5.6.1 (p. 65-66) for the security strength provided by
281817466cbSJens Wiklander          * each hash function, then according to SP800-90A rev1 10.1 table 2,
282817466cbSJens Wiklander          * min_entropy_len (in bits) is security_strength.
283817466cbSJens Wiklander          *
284817466cbSJens Wiklander          * (This also matches the sizes used in the NIST test vectors.)
285817466cbSJens Wiklander          */
2865b25c76aSJerome Forissier         ctx->entropy_len = md_size <= 20 ? 16 : /* 160-bits hash -> 128 bits */
287817466cbSJens Wiklander                            md_size <= 28 ? 24 : /* 224-bits hash -> 192 bits */
288817466cbSJens Wiklander                            32;  /* better (256+) -> 256 bits */
2895b25c76aSJerome Forissier     }
290817466cbSJens Wiklander 
2915b25c76aSJerome Forissier     if( ( ret = hmac_drbg_reseed_core( ctx, custom, len,
2925b25c76aSJerome Forissier                                        1 /* add nonce */ ) ) != 0 )
2935b25c76aSJerome Forissier     {
294817466cbSJens Wiklander         return( ret );
2955b25c76aSJerome Forissier     }
296817466cbSJens Wiklander 
297817466cbSJens Wiklander     return( 0 );
298817466cbSJens Wiklander }
299817466cbSJens Wiklander 
300817466cbSJens Wiklander /*
301817466cbSJens Wiklander  * Set prediction resistance
302817466cbSJens Wiklander  */
303817466cbSJens Wiklander void mbedtls_hmac_drbg_set_prediction_resistance( mbedtls_hmac_drbg_context *ctx,
304817466cbSJens Wiklander                                           int resistance )
305817466cbSJens Wiklander {
306817466cbSJens Wiklander     ctx->prediction_resistance = resistance;
307817466cbSJens Wiklander }
308817466cbSJens Wiklander 
309817466cbSJens Wiklander /*
3105b25c76aSJerome Forissier  * Set entropy length grabbed for seeding
311817466cbSJens Wiklander  */
312817466cbSJens Wiklander void mbedtls_hmac_drbg_set_entropy_len( mbedtls_hmac_drbg_context *ctx, size_t len )
313817466cbSJens Wiklander {
314817466cbSJens Wiklander     ctx->entropy_len = len;
315817466cbSJens Wiklander }
316817466cbSJens Wiklander 
317817466cbSJens Wiklander /*
318817466cbSJens Wiklander  * Set reseed interval
319817466cbSJens Wiklander  */
320817466cbSJens Wiklander void mbedtls_hmac_drbg_set_reseed_interval( mbedtls_hmac_drbg_context *ctx, int interval )
321817466cbSJens Wiklander {
322817466cbSJens Wiklander     ctx->reseed_interval = interval;
323817466cbSJens Wiklander }
324817466cbSJens Wiklander 
325817466cbSJens Wiklander /*
326817466cbSJens Wiklander  * HMAC_DRBG random function with optional additional data:
327817466cbSJens Wiklander  * 10.1.2.5 (arabic) + 9.3 (Roman)
328817466cbSJens Wiklander  */
329817466cbSJens Wiklander int mbedtls_hmac_drbg_random_with_add( void *p_rng,
330817466cbSJens Wiklander                                unsigned char *output, size_t out_len,
331817466cbSJens Wiklander                                const unsigned char *additional, size_t add_len )
332817466cbSJens Wiklander {
333*11fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
334817466cbSJens Wiklander     mbedtls_hmac_drbg_context *ctx = (mbedtls_hmac_drbg_context *) p_rng;
335817466cbSJens Wiklander     size_t md_len = mbedtls_md_get_size( ctx->md_ctx.md_info );
336817466cbSJens Wiklander     size_t left = out_len;
337817466cbSJens Wiklander     unsigned char *out = output;
338817466cbSJens Wiklander 
339817466cbSJens Wiklander     /* II. Check request length */
340817466cbSJens Wiklander     if( out_len > MBEDTLS_HMAC_DRBG_MAX_REQUEST )
341817466cbSJens Wiklander         return( MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG );
342817466cbSJens Wiklander 
343817466cbSJens Wiklander     /* III. Check input length */
344817466cbSJens Wiklander     if( add_len > MBEDTLS_HMAC_DRBG_MAX_INPUT )
345817466cbSJens Wiklander         return( MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG );
346817466cbSJens Wiklander 
347817466cbSJens Wiklander     /* 1. (aka VII and IX) Check reseed counter and PR */
348817466cbSJens Wiklander     if( ctx->f_entropy != NULL && /* For no-reseeding instances */
349817466cbSJens Wiklander         ( ctx->prediction_resistance == MBEDTLS_HMAC_DRBG_PR_ON ||
350817466cbSJens Wiklander           ctx->reseed_counter > ctx->reseed_interval ) )
351817466cbSJens Wiklander     {
352817466cbSJens Wiklander         if( ( ret = mbedtls_hmac_drbg_reseed( ctx, additional, add_len ) ) != 0 )
353817466cbSJens Wiklander             return( ret );
354817466cbSJens Wiklander 
355817466cbSJens Wiklander         add_len = 0; /* VII.4 */
356817466cbSJens Wiklander     }
357817466cbSJens Wiklander 
358817466cbSJens Wiklander     /* 2. Use additional data if any */
359817466cbSJens Wiklander     if( additional != NULL && add_len != 0 )
3603d3b0591SJens Wiklander     {
3613d3b0591SJens Wiklander         if( ( ret = mbedtls_hmac_drbg_update_ret( ctx,
3623d3b0591SJens Wiklander                                                   additional, add_len ) ) != 0 )
3633d3b0591SJens Wiklander             goto exit;
3643d3b0591SJens Wiklander     }
365817466cbSJens Wiklander 
366817466cbSJens Wiklander     /* 3, 4, 5. Generate bytes */
367817466cbSJens Wiklander     while( left != 0 )
368817466cbSJens Wiklander     {
369817466cbSJens Wiklander         size_t use_len = left > md_len ? md_len : left;
370817466cbSJens Wiklander 
3713d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_reset( &ctx->md_ctx ) ) != 0 )
3723d3b0591SJens Wiklander             goto exit;
3733d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_update( &ctx->md_ctx,
3743d3b0591SJens Wiklander                                             ctx->V, md_len ) ) != 0 )
3753d3b0591SJens Wiklander             goto exit;
3763d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_finish( &ctx->md_ctx, ctx->V ) ) != 0 )
3773d3b0591SJens Wiklander             goto exit;
378817466cbSJens Wiklander 
379817466cbSJens Wiklander         memcpy( out, ctx->V, use_len );
380817466cbSJens Wiklander         out += use_len;
381817466cbSJens Wiklander         left -= use_len;
382817466cbSJens Wiklander     }
383817466cbSJens Wiklander 
384817466cbSJens Wiklander     /* 6. Update */
3853d3b0591SJens Wiklander     if( ( ret = mbedtls_hmac_drbg_update_ret( ctx,
3863d3b0591SJens Wiklander                                               additional, add_len ) ) != 0 )
3873d3b0591SJens Wiklander         goto exit;
388817466cbSJens Wiklander 
389817466cbSJens Wiklander     /* 7. Update reseed counter */
390817466cbSJens Wiklander     ctx->reseed_counter++;
391817466cbSJens Wiklander 
3923d3b0591SJens Wiklander exit:
393817466cbSJens Wiklander     /* 8. Done */
3943d3b0591SJens Wiklander     return( ret );
395817466cbSJens Wiklander }
396817466cbSJens Wiklander 
397817466cbSJens Wiklander /*
398817466cbSJens Wiklander  * HMAC_DRBG random function
399817466cbSJens Wiklander  */
400817466cbSJens Wiklander int mbedtls_hmac_drbg_random( void *p_rng, unsigned char *output, size_t out_len )
401817466cbSJens Wiklander {
402*11fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
403817466cbSJens Wiklander     mbedtls_hmac_drbg_context *ctx = (mbedtls_hmac_drbg_context *) p_rng;
404817466cbSJens Wiklander 
405817466cbSJens Wiklander #if defined(MBEDTLS_THREADING_C)
406817466cbSJens Wiklander     if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
407817466cbSJens Wiklander         return( ret );
408817466cbSJens Wiklander #endif
409817466cbSJens Wiklander 
410817466cbSJens Wiklander     ret = mbedtls_hmac_drbg_random_with_add( ctx, output, out_len, NULL, 0 );
411817466cbSJens Wiklander 
412817466cbSJens Wiklander #if defined(MBEDTLS_THREADING_C)
413817466cbSJens Wiklander     if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
414817466cbSJens Wiklander         return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
415817466cbSJens Wiklander #endif
416817466cbSJens Wiklander 
417817466cbSJens Wiklander     return( ret );
418817466cbSJens Wiklander }
419817466cbSJens Wiklander 
420817466cbSJens Wiklander /*
421817466cbSJens Wiklander  * Free an HMAC_DRBG context
422817466cbSJens Wiklander  */
423817466cbSJens Wiklander void mbedtls_hmac_drbg_free( mbedtls_hmac_drbg_context *ctx )
424817466cbSJens Wiklander {
425817466cbSJens Wiklander     if( ctx == NULL )
426817466cbSJens Wiklander         return;
427817466cbSJens Wiklander 
428817466cbSJens Wiklander #if defined(MBEDTLS_THREADING_C)
429817466cbSJens Wiklander     mbedtls_mutex_free( &ctx->mutex );
430817466cbSJens Wiklander #endif
431817466cbSJens Wiklander     mbedtls_md_free( &ctx->md_ctx );
4323d3b0591SJens Wiklander     mbedtls_platform_zeroize( ctx, sizeof( mbedtls_hmac_drbg_context ) );
433817466cbSJens Wiklander }
434817466cbSJens Wiklander 
435817466cbSJens Wiklander #if defined(MBEDTLS_FS_IO)
436817466cbSJens Wiklander int mbedtls_hmac_drbg_write_seed_file( mbedtls_hmac_drbg_context *ctx, const char *path )
437817466cbSJens Wiklander {
438*11fa71b9SJerome Forissier     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
439817466cbSJens Wiklander     FILE *f;
440817466cbSJens Wiklander     unsigned char buf[ MBEDTLS_HMAC_DRBG_MAX_INPUT ];
441817466cbSJens Wiklander 
442817466cbSJens Wiklander     if( ( f = fopen( path, "wb" ) ) == NULL )
443817466cbSJens Wiklander         return( MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR );
444817466cbSJens Wiklander 
445817466cbSJens Wiklander     if( ( ret = mbedtls_hmac_drbg_random( ctx, buf, sizeof( buf ) ) ) != 0 )
446817466cbSJens Wiklander         goto exit;
447817466cbSJens Wiklander 
448817466cbSJens Wiklander     if( fwrite( buf, 1, sizeof( buf ), f ) != sizeof( buf ) )
449817466cbSJens Wiklander     {
450817466cbSJens Wiklander         ret = MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR;
451817466cbSJens Wiklander         goto exit;
452817466cbSJens Wiklander     }
453817466cbSJens Wiklander 
454817466cbSJens Wiklander     ret = 0;
455817466cbSJens Wiklander 
456817466cbSJens Wiklander exit:
457817466cbSJens Wiklander     fclose( f );
4583d3b0591SJens Wiklander     mbedtls_platform_zeroize( buf, sizeof( buf ) );
4593d3b0591SJens Wiklander 
460817466cbSJens Wiklander     return( ret );
461817466cbSJens Wiklander }
462817466cbSJens Wiklander 
463817466cbSJens Wiklander int mbedtls_hmac_drbg_update_seed_file( mbedtls_hmac_drbg_context *ctx, const char *path )
464817466cbSJens Wiklander {
4653d3b0591SJens Wiklander     int ret = 0;
4663d3b0591SJens Wiklander     FILE *f = NULL;
467817466cbSJens Wiklander     size_t n;
468817466cbSJens Wiklander     unsigned char buf[ MBEDTLS_HMAC_DRBG_MAX_INPUT ];
4693d3b0591SJens Wiklander     unsigned char c;
470817466cbSJens Wiklander 
471817466cbSJens Wiklander     if( ( f = fopen( path, "rb" ) ) == NULL )
472817466cbSJens Wiklander         return( MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR );
473817466cbSJens Wiklander 
4743d3b0591SJens Wiklander     n = fread( buf, 1, sizeof( buf ), f );
4753d3b0591SJens Wiklander     if( fread( &c, 1, 1, f ) != 0 )
476817466cbSJens Wiklander     {
4773d3b0591SJens Wiklander         ret = MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG;
4783d3b0591SJens Wiklander         goto exit;
479817466cbSJens Wiklander     }
4803d3b0591SJens Wiklander     if( n == 0 || ferror( f ) )
481817466cbSJens Wiklander     {
4823d3b0591SJens Wiklander         ret = MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR;
4833d3b0591SJens Wiklander         goto exit;
484817466cbSJens Wiklander     }
485817466cbSJens Wiklander     fclose( f );
4863d3b0591SJens Wiklander     f = NULL;
487817466cbSJens Wiklander 
4883d3b0591SJens Wiklander     ret = mbedtls_hmac_drbg_update_ret( ctx, buf, n );
489817466cbSJens Wiklander 
4903d3b0591SJens Wiklander exit:
4913d3b0591SJens Wiklander     mbedtls_platform_zeroize( buf, sizeof( buf ) );
4923d3b0591SJens Wiklander     if( f != NULL )
4933d3b0591SJens Wiklander         fclose( f );
4943d3b0591SJens Wiklander     if( ret != 0 )
4953d3b0591SJens Wiklander         return( ret );
496817466cbSJens Wiklander     return( mbedtls_hmac_drbg_write_seed_file( ctx, path ) );
497817466cbSJens Wiklander }
498817466cbSJens Wiklander #endif /* MBEDTLS_FS_IO */
499817466cbSJens Wiklander 
500817466cbSJens Wiklander 
501817466cbSJens Wiklander #if defined(MBEDTLS_SELF_TEST)
502817466cbSJens Wiklander 
503817466cbSJens Wiklander #if !defined(MBEDTLS_SHA1_C)
504817466cbSJens Wiklander /* Dummy checkup routine */
505817466cbSJens Wiklander int mbedtls_hmac_drbg_self_test( int verbose )
506817466cbSJens Wiklander {
507817466cbSJens Wiklander     (void) verbose;
508817466cbSJens Wiklander     return( 0 );
509817466cbSJens Wiklander }
510817466cbSJens Wiklander #else
511817466cbSJens Wiklander 
512817466cbSJens Wiklander #define OUTPUT_LEN  80
513817466cbSJens Wiklander 
514817466cbSJens Wiklander /* From a NIST PR=true test vector */
515817466cbSJens Wiklander static const unsigned char entropy_pr[] = {
516817466cbSJens Wiklander     0xa0, 0xc9, 0xab, 0x58, 0xf1, 0xe2, 0xe5, 0xa4, 0xde, 0x3e, 0xbd, 0x4f,
517817466cbSJens Wiklander     0xf7, 0x3e, 0x9c, 0x5b, 0x64, 0xef, 0xd8, 0xca, 0x02, 0x8c, 0xf8, 0x11,
518817466cbSJens Wiklander     0x48, 0xa5, 0x84, 0xfe, 0x69, 0xab, 0x5a, 0xee, 0x42, 0xaa, 0x4d, 0x42,
519817466cbSJens Wiklander     0x17, 0x60, 0x99, 0xd4, 0x5e, 0x13, 0x97, 0xdc, 0x40, 0x4d, 0x86, 0xa3,
520817466cbSJens Wiklander     0x7b, 0xf5, 0x59, 0x54, 0x75, 0x69, 0x51, 0xe4 };
521817466cbSJens Wiklander static const unsigned char result_pr[OUTPUT_LEN] = {
522817466cbSJens Wiklander     0x9a, 0x00, 0xa2, 0xd0, 0x0e, 0xd5, 0x9b, 0xfe, 0x31, 0xec, 0xb1, 0x39,
523817466cbSJens Wiklander     0x9b, 0x60, 0x81, 0x48, 0xd1, 0x96, 0x9d, 0x25, 0x0d, 0x3c, 0x1e, 0x94,
524817466cbSJens Wiklander     0x10, 0x10, 0x98, 0x12, 0x93, 0x25, 0xca, 0xb8, 0xfc, 0xcc, 0x2d, 0x54,
525817466cbSJens Wiklander     0x73, 0x19, 0x70, 0xc0, 0x10, 0x7a, 0xa4, 0x89, 0x25, 0x19, 0x95, 0x5e,
526817466cbSJens Wiklander     0x4b, 0xc6, 0x00, 0x1d, 0x7f, 0x4e, 0x6a, 0x2b, 0xf8, 0xa3, 0x01, 0xab,
527817466cbSJens Wiklander     0x46, 0x05, 0x5c, 0x09, 0xa6, 0x71, 0x88, 0xf1, 0xa7, 0x40, 0xee, 0xf3,
528817466cbSJens Wiklander     0xe1, 0x5c, 0x02, 0x9b, 0x44, 0xaf, 0x03, 0x44 };
529817466cbSJens Wiklander 
530817466cbSJens Wiklander /* From a NIST PR=false test vector */
531817466cbSJens Wiklander static const unsigned char entropy_nopr[] = {
532817466cbSJens Wiklander     0x79, 0x34, 0x9b, 0xbf, 0x7c, 0xdd, 0xa5, 0x79, 0x95, 0x57, 0x86, 0x66,
533817466cbSJens Wiklander     0x21, 0xc9, 0x13, 0x83, 0x11, 0x46, 0x73, 0x3a, 0xbf, 0x8c, 0x35, 0xc8,
534817466cbSJens Wiklander     0xc7, 0x21, 0x5b, 0x5b, 0x96, 0xc4, 0x8e, 0x9b, 0x33, 0x8c, 0x74, 0xe3,
535817466cbSJens Wiklander     0xe9, 0x9d, 0xfe, 0xdf };
536817466cbSJens Wiklander static const unsigned char result_nopr[OUTPUT_LEN] = {
537817466cbSJens Wiklander     0xc6, 0xa1, 0x6a, 0xb8, 0xd4, 0x20, 0x70, 0x6f, 0x0f, 0x34, 0xab, 0x7f,
538817466cbSJens Wiklander     0xec, 0x5a, 0xdc, 0xa9, 0xd8, 0xca, 0x3a, 0x13, 0x3e, 0x15, 0x9c, 0xa6,
539817466cbSJens Wiklander     0xac, 0x43, 0xc6, 0xf8, 0xa2, 0xbe, 0x22, 0x83, 0x4a, 0x4c, 0x0a, 0x0a,
540817466cbSJens Wiklander     0xff, 0xb1, 0x0d, 0x71, 0x94, 0xf1, 0xc1, 0xa5, 0xcf, 0x73, 0x22, 0xec,
541817466cbSJens Wiklander     0x1a, 0xe0, 0x96, 0x4e, 0xd4, 0xbf, 0x12, 0x27, 0x46, 0xe0, 0x87, 0xfd,
542817466cbSJens Wiklander     0xb5, 0xb3, 0xe9, 0x1b, 0x34, 0x93, 0xd5, 0xbb, 0x98, 0xfa, 0xed, 0x49,
543817466cbSJens Wiklander     0xe8, 0x5f, 0x13, 0x0f, 0xc8, 0xa4, 0x59, 0xb7 };
544817466cbSJens Wiklander 
545817466cbSJens Wiklander /* "Entropy" from buffer */
546817466cbSJens Wiklander static size_t test_offset;
547817466cbSJens Wiklander static int hmac_drbg_self_test_entropy( void *data,
548817466cbSJens Wiklander                                         unsigned char *buf, size_t len )
549817466cbSJens Wiklander {
550817466cbSJens Wiklander     const unsigned char *p = data;
551817466cbSJens Wiklander     memcpy( buf, p + test_offset, len );
552817466cbSJens Wiklander     test_offset += len;
553817466cbSJens Wiklander     return( 0 );
554817466cbSJens Wiklander }
555817466cbSJens Wiklander 
556817466cbSJens Wiklander #define CHK( c )    if( (c) != 0 )                          \
557817466cbSJens Wiklander                     {                                       \
558817466cbSJens Wiklander                         if( verbose != 0 )                  \
559817466cbSJens Wiklander                             mbedtls_printf( "failed\n" );  \
560817466cbSJens Wiklander                         return( 1 );                        \
561817466cbSJens Wiklander                     }
562817466cbSJens Wiklander 
563817466cbSJens Wiklander /*
564817466cbSJens Wiklander  * Checkup routine for HMAC_DRBG with SHA-1
565817466cbSJens Wiklander  */
566817466cbSJens Wiklander int mbedtls_hmac_drbg_self_test( int verbose )
567817466cbSJens Wiklander {
568817466cbSJens Wiklander     mbedtls_hmac_drbg_context ctx;
569817466cbSJens Wiklander     unsigned char buf[OUTPUT_LEN];
570817466cbSJens Wiklander     const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( MBEDTLS_MD_SHA1 );
571817466cbSJens Wiklander 
572817466cbSJens Wiklander     mbedtls_hmac_drbg_init( &ctx );
573817466cbSJens Wiklander 
574817466cbSJens Wiklander     /*
575817466cbSJens Wiklander      * PR = True
576817466cbSJens Wiklander      */
577817466cbSJens Wiklander     if( verbose != 0 )
578817466cbSJens Wiklander         mbedtls_printf( "  HMAC_DRBG (PR = True) : " );
579817466cbSJens Wiklander 
580817466cbSJens Wiklander     test_offset = 0;
581817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_seed( &ctx, md_info,
582817466cbSJens Wiklander                          hmac_drbg_self_test_entropy, (void *) entropy_pr,
583817466cbSJens Wiklander                          NULL, 0 ) );
584817466cbSJens Wiklander     mbedtls_hmac_drbg_set_prediction_resistance( &ctx, MBEDTLS_HMAC_DRBG_PR_ON );
585817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_random( &ctx, buf, OUTPUT_LEN ) );
586817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_random( &ctx, buf, OUTPUT_LEN ) );
587817466cbSJens Wiklander     CHK( memcmp( buf, result_pr, OUTPUT_LEN ) );
588817466cbSJens Wiklander     mbedtls_hmac_drbg_free( &ctx );
589817466cbSJens Wiklander 
590817466cbSJens Wiklander     mbedtls_hmac_drbg_free( &ctx );
591817466cbSJens Wiklander 
592817466cbSJens Wiklander     if( verbose != 0 )
593817466cbSJens Wiklander         mbedtls_printf( "passed\n" );
594817466cbSJens Wiklander 
595817466cbSJens Wiklander     /*
596817466cbSJens Wiklander      * PR = False
597817466cbSJens Wiklander      */
598817466cbSJens Wiklander     if( verbose != 0 )
599817466cbSJens Wiklander         mbedtls_printf( "  HMAC_DRBG (PR = False) : " );
600817466cbSJens Wiklander 
601817466cbSJens Wiklander     mbedtls_hmac_drbg_init( &ctx );
602817466cbSJens Wiklander 
603817466cbSJens Wiklander     test_offset = 0;
604817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_seed( &ctx, md_info,
605817466cbSJens Wiklander                          hmac_drbg_self_test_entropy, (void *) entropy_nopr,
606817466cbSJens Wiklander                          NULL, 0 ) );
607817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_reseed( &ctx, NULL, 0 ) );
608817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_random( &ctx, buf, OUTPUT_LEN ) );
609817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_random( &ctx, buf, OUTPUT_LEN ) );
610817466cbSJens Wiklander     CHK( memcmp( buf, result_nopr, OUTPUT_LEN ) );
611817466cbSJens Wiklander     mbedtls_hmac_drbg_free( &ctx );
612817466cbSJens Wiklander 
613817466cbSJens Wiklander     mbedtls_hmac_drbg_free( &ctx );
614817466cbSJens Wiklander 
615817466cbSJens Wiklander     if( verbose != 0 )
616817466cbSJens Wiklander         mbedtls_printf( "passed\n" );
617817466cbSJens Wiklander 
618817466cbSJens Wiklander     if( verbose != 0 )
619817466cbSJens Wiklander         mbedtls_printf( "\n" );
620817466cbSJens Wiklander 
621817466cbSJens Wiklander     return( 0 );
622817466cbSJens Wiklander }
623817466cbSJens Wiklander #endif /* MBEDTLS_SHA1_C */
624817466cbSJens Wiklander #endif /* MBEDTLS_SELF_TEST */
625817466cbSJens Wiklander 
626817466cbSJens Wiklander #endif /* MBEDTLS_HMAC_DRBG_C */
627