xref: /optee_os/lib/libmbedtls/mbedtls/library/hmac_drbg.c (revision 5b25c76ac40f830867e3d60800120ffd7874e8dc)
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"
38817466cbSJens Wiklander 
39817466cbSJens Wiklander #include <string.h>
40817466cbSJens Wiklander 
41817466cbSJens Wiklander #if defined(MBEDTLS_FS_IO)
42817466cbSJens Wiklander #include <stdio.h>
43817466cbSJens Wiklander #endif
44817466cbSJens Wiklander 
45817466cbSJens Wiklander #if defined(MBEDTLS_SELF_TEST)
46817466cbSJens Wiklander #if defined(MBEDTLS_PLATFORM_C)
47817466cbSJens Wiklander #include "mbedtls/platform.h"
48817466cbSJens Wiklander #else
49817466cbSJens Wiklander #include <stdio.h>
50817466cbSJens Wiklander #define mbedtls_printf printf
51817466cbSJens Wiklander #endif /* MBEDTLS_SELF_TEST */
52817466cbSJens Wiklander #endif /* MBEDTLS_PLATFORM_C */
53817466cbSJens Wiklander 
54817466cbSJens Wiklander /*
55817466cbSJens Wiklander  * HMAC_DRBG context initialization
56817466cbSJens Wiklander  */
57817466cbSJens Wiklander void mbedtls_hmac_drbg_init( mbedtls_hmac_drbg_context *ctx )
58817466cbSJens Wiklander {
59817466cbSJens Wiklander     memset( ctx, 0, sizeof( mbedtls_hmac_drbg_context ) );
60817466cbSJens Wiklander 
61817466cbSJens Wiklander #if defined(MBEDTLS_THREADING_C)
62817466cbSJens Wiklander     mbedtls_mutex_init( &ctx->mutex );
63817466cbSJens Wiklander #endif
64817466cbSJens Wiklander }
65817466cbSJens Wiklander 
66817466cbSJens Wiklander /*
67817466cbSJens Wiklander  * HMAC_DRBG update, using optional additional data (10.1.2.2)
68817466cbSJens Wiklander  */
693d3b0591SJens Wiklander int mbedtls_hmac_drbg_update_ret( mbedtls_hmac_drbg_context *ctx,
703d3b0591SJens Wiklander                                   const unsigned char *additional,
713d3b0591SJens Wiklander                                   size_t add_len )
72817466cbSJens Wiklander {
73817466cbSJens Wiklander     size_t md_len = mbedtls_md_get_size( ctx->md_ctx.md_info );
74817466cbSJens Wiklander     unsigned char rounds = ( additional != NULL && add_len != 0 ) ? 2 : 1;
75817466cbSJens Wiklander     unsigned char sep[1];
76817466cbSJens Wiklander     unsigned char K[MBEDTLS_MD_MAX_SIZE];
773d3b0591SJens Wiklander     int ret;
78817466cbSJens Wiklander 
79817466cbSJens Wiklander     for( sep[0] = 0; sep[0] < rounds; sep[0]++ )
80817466cbSJens Wiklander     {
81817466cbSJens Wiklander         /* Step 1 or 4 */
823d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_reset( &ctx->md_ctx ) ) != 0 )
833d3b0591SJens Wiklander             goto exit;
843d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_update( &ctx->md_ctx,
853d3b0591SJens Wiklander                                             ctx->V, md_len ) ) != 0 )
863d3b0591SJens Wiklander             goto exit;
873d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_update( &ctx->md_ctx,
883d3b0591SJens Wiklander                                             sep, 1 ) ) != 0 )
893d3b0591SJens Wiklander             goto exit;
90817466cbSJens Wiklander         if( rounds == 2 )
913d3b0591SJens Wiklander         {
923d3b0591SJens Wiklander             if( ( ret = mbedtls_md_hmac_update( &ctx->md_ctx,
933d3b0591SJens Wiklander                                                 additional, add_len ) ) != 0 )
943d3b0591SJens Wiklander             goto exit;
953d3b0591SJens Wiklander         }
963d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_finish( &ctx->md_ctx, K ) ) != 0 )
973d3b0591SJens Wiklander             goto exit;
98817466cbSJens Wiklander 
99817466cbSJens Wiklander         /* Step 2 or 5 */
1003d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_starts( &ctx->md_ctx, K, md_len ) ) != 0 )
1013d3b0591SJens Wiklander             goto exit;
1023d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_update( &ctx->md_ctx,
1033d3b0591SJens Wiklander                                             ctx->V, md_len ) ) != 0 )
1043d3b0591SJens Wiklander             goto exit;
1053d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_finish( &ctx->md_ctx, ctx->V ) ) != 0 )
1063d3b0591SJens Wiklander             goto exit;
107817466cbSJens Wiklander     }
1083d3b0591SJens Wiklander 
1093d3b0591SJens Wiklander exit:
1103d3b0591SJens Wiklander     mbedtls_platform_zeroize( K, sizeof( K ) );
1113d3b0591SJens Wiklander     return( ret );
112817466cbSJens Wiklander }
113817466cbSJens Wiklander 
1143d3b0591SJens Wiklander #if !defined(MBEDTLS_DEPRECATED_REMOVED)
1153d3b0591SJens Wiklander void mbedtls_hmac_drbg_update( mbedtls_hmac_drbg_context *ctx,
1163d3b0591SJens Wiklander                                const unsigned char *additional,
1173d3b0591SJens Wiklander                                size_t add_len )
1183d3b0591SJens Wiklander {
1193d3b0591SJens Wiklander     (void) mbedtls_hmac_drbg_update_ret( ctx, additional, add_len );
1203d3b0591SJens Wiklander }
1213d3b0591SJens Wiklander #endif /* MBEDTLS_DEPRECATED_REMOVED */
1223d3b0591SJens Wiklander 
123817466cbSJens Wiklander /*
124817466cbSJens Wiklander  * Simplified HMAC_DRBG initialisation (for use with deterministic ECDSA)
125817466cbSJens Wiklander  */
126817466cbSJens Wiklander int mbedtls_hmac_drbg_seed_buf( mbedtls_hmac_drbg_context *ctx,
127817466cbSJens Wiklander                         const mbedtls_md_info_t * md_info,
128817466cbSJens Wiklander                         const unsigned char *data, size_t data_len )
129817466cbSJens Wiklander {
130817466cbSJens Wiklander     int ret;
131817466cbSJens Wiklander 
132817466cbSJens Wiklander     if( ( ret = mbedtls_md_setup( &ctx->md_ctx, md_info, 1 ) ) != 0 )
133817466cbSJens Wiklander         return( ret );
134817466cbSJens Wiklander 
135817466cbSJens Wiklander     /*
136817466cbSJens Wiklander      * Set initial working state.
137817466cbSJens Wiklander      * Use the V memory location, which is currently all 0, to initialize the
138817466cbSJens Wiklander      * MD context with an all-zero key. Then set V to its initial value.
139817466cbSJens Wiklander      */
1403d3b0591SJens Wiklander     if( ( ret = mbedtls_md_hmac_starts( &ctx->md_ctx, ctx->V,
1413d3b0591SJens Wiklander                                         mbedtls_md_get_size( md_info ) ) ) != 0 )
1423d3b0591SJens Wiklander         return( ret );
143817466cbSJens Wiklander     memset( ctx->V, 0x01, mbedtls_md_get_size( md_info ) );
144817466cbSJens Wiklander 
1453d3b0591SJens Wiklander     if( ( ret = mbedtls_hmac_drbg_update_ret( ctx, data, data_len ) ) != 0 )
1463d3b0591SJens Wiklander         return( ret );
147817466cbSJens Wiklander 
148817466cbSJens Wiklander     return( 0 );
149817466cbSJens Wiklander }
150817466cbSJens Wiklander 
151817466cbSJens Wiklander /*
152*5b25c76aSJerome Forissier  * Internal function used both for seeding and reseeding the DRBG.
153*5b25c76aSJerome Forissier  * Comments starting with arabic numbers refer to section 10.1.2.4
154*5b25c76aSJerome Forissier  * of SP800-90A, while roman numbers refer to section 9.2.
155817466cbSJens Wiklander  */
156*5b25c76aSJerome Forissier static int hmac_drbg_reseed_core( mbedtls_hmac_drbg_context *ctx,
157*5b25c76aSJerome Forissier                                   const unsigned char *additional, size_t len,
158*5b25c76aSJerome Forissier                                   int use_nonce )
159817466cbSJens Wiklander {
160817466cbSJens Wiklander     unsigned char seed[MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT];
161*5b25c76aSJerome Forissier     size_t seedlen = 0;
1623d3b0591SJens Wiklander     int ret;
163817466cbSJens Wiklander 
164*5b25c76aSJerome Forissier     {
165*5b25c76aSJerome Forissier         size_t total_entropy_len;
166*5b25c76aSJerome Forissier 
167*5b25c76aSJerome Forissier         if( use_nonce == 0 )
168*5b25c76aSJerome Forissier             total_entropy_len = ctx->entropy_len;
169*5b25c76aSJerome Forissier         else
170*5b25c76aSJerome Forissier             total_entropy_len = ctx->entropy_len * 3 / 2;
171*5b25c76aSJerome Forissier 
172817466cbSJens Wiklander         /* III. Check input length */
173817466cbSJens Wiklander         if( len > MBEDTLS_HMAC_DRBG_MAX_INPUT ||
174*5b25c76aSJerome Forissier             total_entropy_len + len > MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT )
175817466cbSJens Wiklander         {
176817466cbSJens Wiklander             return( MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG );
177817466cbSJens Wiklander         }
178*5b25c76aSJerome Forissier     }
179817466cbSJens Wiklander 
180817466cbSJens Wiklander     memset( seed, 0, MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT );
181817466cbSJens Wiklander 
182817466cbSJens Wiklander     /* IV. Gather entropy_len bytes of entropy for the seed */
1833d3b0591SJens Wiklander     if( ( ret = ctx->f_entropy( ctx->p_entropy,
1843d3b0591SJens Wiklander                                 seed, ctx->entropy_len ) ) != 0 )
185*5b25c76aSJerome Forissier     {
186817466cbSJens Wiklander         return( MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED );
187*5b25c76aSJerome Forissier     }
188*5b25c76aSJerome Forissier     seedlen += ctx->entropy_len;
189817466cbSJens Wiklander 
190*5b25c76aSJerome Forissier     /* For initial seeding, allow adding of nonce generated
191*5b25c76aSJerome Forissier      * from the entropy source. See Sect 8.6.7 in SP800-90A. */
192*5b25c76aSJerome Forissier     if( use_nonce )
193*5b25c76aSJerome Forissier     {
194*5b25c76aSJerome Forissier         /* Note: We don't merge the two calls to f_entropy() in order
195*5b25c76aSJerome Forissier          *       to avoid requesting too much entropy from f_entropy()
196*5b25c76aSJerome Forissier          *       at once. Specifically, if the underlying digest is not
197*5b25c76aSJerome Forissier          *       SHA-1, 3 / 2 * entropy_len is at least 36 Bytes, which
198*5b25c76aSJerome Forissier          *       is larger than the maximum of 32 Bytes that our own
199*5b25c76aSJerome Forissier          *       entropy source implementation can emit in a single
200*5b25c76aSJerome Forissier          *       call in configurations disabling SHA-512. */
201*5b25c76aSJerome Forissier         if( ( ret = ctx->f_entropy( ctx->p_entropy,
202*5b25c76aSJerome Forissier                                     seed + seedlen,
203*5b25c76aSJerome Forissier                                     ctx->entropy_len / 2 ) ) != 0 )
204*5b25c76aSJerome Forissier         {
205*5b25c76aSJerome Forissier             return( MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED );
206*5b25c76aSJerome Forissier         }
207*5b25c76aSJerome Forissier 
208*5b25c76aSJerome Forissier         seedlen += ctx->entropy_len / 2;
209*5b25c76aSJerome Forissier     }
210*5b25c76aSJerome Forissier 
211817466cbSJens Wiklander 
212817466cbSJens Wiklander     /* 1. Concatenate entropy and additional data if any */
213817466cbSJens Wiklander     if( additional != NULL && len != 0 )
214817466cbSJens Wiklander     {
215817466cbSJens Wiklander         memcpy( seed + seedlen, additional, len );
216817466cbSJens Wiklander         seedlen += len;
217817466cbSJens Wiklander     }
218817466cbSJens Wiklander 
219817466cbSJens Wiklander     /* 2. Update state */
2203d3b0591SJens Wiklander     if( ( ret = mbedtls_hmac_drbg_update_ret( ctx, seed, seedlen ) ) != 0 )
2213d3b0591SJens Wiklander         goto exit;
222817466cbSJens Wiklander 
223817466cbSJens Wiklander     /* 3. Reset reseed_counter */
224817466cbSJens Wiklander     ctx->reseed_counter = 1;
225817466cbSJens Wiklander 
2263d3b0591SJens Wiklander exit:
227817466cbSJens Wiklander     /* 4. Done */
2283d3b0591SJens Wiklander     mbedtls_platform_zeroize( seed, seedlen );
2293d3b0591SJens Wiklander     return( ret );
230817466cbSJens Wiklander }
231817466cbSJens Wiklander 
232817466cbSJens Wiklander /*
233*5b25c76aSJerome Forissier  * HMAC_DRBG reseeding: 10.1.2.4 + 9.2
234*5b25c76aSJerome Forissier  */
235*5b25c76aSJerome Forissier int mbedtls_hmac_drbg_reseed( mbedtls_hmac_drbg_context *ctx,
236*5b25c76aSJerome Forissier                       const unsigned char *additional, size_t len )
237*5b25c76aSJerome Forissier {
238*5b25c76aSJerome Forissier     return( hmac_drbg_reseed_core( ctx, additional, len, 0 ) );
239*5b25c76aSJerome Forissier }
240*5b25c76aSJerome Forissier 
241*5b25c76aSJerome Forissier /*
242817466cbSJens Wiklander  * HMAC_DRBG initialisation (10.1.2.3 + 9.1)
243*5b25c76aSJerome Forissier  *
244*5b25c76aSJerome Forissier  * The nonce is not passed as a separate parameter but extracted
245*5b25c76aSJerome Forissier  * from the entropy source as suggested in 8.6.7.
246817466cbSJens Wiklander  */
247817466cbSJens Wiklander int mbedtls_hmac_drbg_seed( mbedtls_hmac_drbg_context *ctx,
248817466cbSJens Wiklander                     const mbedtls_md_info_t * md_info,
249817466cbSJens Wiklander                     int (*f_entropy)(void *, unsigned char *, size_t),
250817466cbSJens Wiklander                     void *p_entropy,
251817466cbSJens Wiklander                     const unsigned char *custom,
252817466cbSJens Wiklander                     size_t len )
253817466cbSJens Wiklander {
254817466cbSJens Wiklander     int ret;
255*5b25c76aSJerome Forissier     size_t md_size;
256817466cbSJens Wiklander 
257817466cbSJens Wiklander     if( ( ret = mbedtls_md_setup( &ctx->md_ctx, md_info, 1 ) ) != 0 )
258817466cbSJens Wiklander         return( ret );
259817466cbSJens Wiklander 
260817466cbSJens Wiklander     md_size = mbedtls_md_get_size( md_info );
261817466cbSJens Wiklander 
262817466cbSJens Wiklander     /*
263817466cbSJens Wiklander      * Set initial working state.
264817466cbSJens Wiklander      * Use the V memory location, which is currently all 0, to initialize the
265817466cbSJens Wiklander      * MD context with an all-zero key. Then set V to its initial value.
266817466cbSJens Wiklander      */
2673d3b0591SJens Wiklander     if( ( ret = mbedtls_md_hmac_starts( &ctx->md_ctx, ctx->V, md_size ) ) != 0 )
2683d3b0591SJens Wiklander         return( ret );
269817466cbSJens Wiklander     memset( ctx->V, 0x01, md_size );
270817466cbSJens Wiklander 
271817466cbSJens Wiklander     ctx->f_entropy = f_entropy;
272817466cbSJens Wiklander     ctx->p_entropy = p_entropy;
273817466cbSJens Wiklander 
274817466cbSJens Wiklander     ctx->reseed_interval = MBEDTLS_HMAC_DRBG_RESEED_INTERVAL;
275817466cbSJens Wiklander 
276*5b25c76aSJerome Forissier     if( ctx->entropy_len == 0 )
277*5b25c76aSJerome Forissier     {
278817466cbSJens Wiklander         /*
279817466cbSJens Wiklander          * See SP800-57 5.6.1 (p. 65-66) for the security strength provided by
280817466cbSJens Wiklander          * each hash function, then according to SP800-90A rev1 10.1 table 2,
281817466cbSJens Wiklander          * min_entropy_len (in bits) is security_strength.
282817466cbSJens Wiklander          *
283817466cbSJens Wiklander          * (This also matches the sizes used in the NIST test vectors.)
284817466cbSJens Wiklander          */
285*5b25c76aSJerome Forissier         ctx->entropy_len = md_size <= 20 ? 16 : /* 160-bits hash -> 128 bits */
286817466cbSJens Wiklander                            md_size <= 28 ? 24 : /* 224-bits hash -> 192 bits */
287817466cbSJens Wiklander                            32;  /* better (256+) -> 256 bits */
288*5b25c76aSJerome Forissier     }
289817466cbSJens Wiklander 
290*5b25c76aSJerome Forissier     if( ( ret = hmac_drbg_reseed_core( ctx, custom, len,
291*5b25c76aSJerome Forissier                                        1 /* add nonce */ ) ) != 0 )
292*5b25c76aSJerome Forissier     {
293817466cbSJens Wiklander         return( ret );
294*5b25c76aSJerome Forissier     }
295817466cbSJens Wiklander 
296817466cbSJens Wiklander     return( 0 );
297817466cbSJens Wiklander }
298817466cbSJens Wiklander 
299817466cbSJens Wiklander /*
300817466cbSJens Wiklander  * Set prediction resistance
301817466cbSJens Wiklander  */
302817466cbSJens Wiklander void mbedtls_hmac_drbg_set_prediction_resistance( mbedtls_hmac_drbg_context *ctx,
303817466cbSJens Wiklander                                           int resistance )
304817466cbSJens Wiklander {
305817466cbSJens Wiklander     ctx->prediction_resistance = resistance;
306817466cbSJens Wiklander }
307817466cbSJens Wiklander 
308817466cbSJens Wiklander /*
309*5b25c76aSJerome Forissier  * Set entropy length grabbed for seeding
310817466cbSJens Wiklander  */
311817466cbSJens Wiklander void mbedtls_hmac_drbg_set_entropy_len( mbedtls_hmac_drbg_context *ctx, size_t len )
312817466cbSJens Wiklander {
313817466cbSJens Wiklander     ctx->entropy_len = len;
314817466cbSJens Wiklander }
315817466cbSJens Wiklander 
316817466cbSJens Wiklander /*
317817466cbSJens Wiklander  * Set reseed interval
318817466cbSJens Wiklander  */
319817466cbSJens Wiklander void mbedtls_hmac_drbg_set_reseed_interval( mbedtls_hmac_drbg_context *ctx, int interval )
320817466cbSJens Wiklander {
321817466cbSJens Wiklander     ctx->reseed_interval = interval;
322817466cbSJens Wiklander }
323817466cbSJens Wiklander 
324817466cbSJens Wiklander /*
325817466cbSJens Wiklander  * HMAC_DRBG random function with optional additional data:
326817466cbSJens Wiklander  * 10.1.2.5 (arabic) + 9.3 (Roman)
327817466cbSJens Wiklander  */
328817466cbSJens Wiklander int mbedtls_hmac_drbg_random_with_add( void *p_rng,
329817466cbSJens Wiklander                                unsigned char *output, size_t out_len,
330817466cbSJens Wiklander                                const unsigned char *additional, size_t add_len )
331817466cbSJens Wiklander {
332817466cbSJens Wiklander     int ret;
333817466cbSJens Wiklander     mbedtls_hmac_drbg_context *ctx = (mbedtls_hmac_drbg_context *) p_rng;
334817466cbSJens Wiklander     size_t md_len = mbedtls_md_get_size( ctx->md_ctx.md_info );
335817466cbSJens Wiklander     size_t left = out_len;
336817466cbSJens Wiklander     unsigned char *out = output;
337817466cbSJens Wiklander 
338817466cbSJens Wiklander     /* II. Check request length */
339817466cbSJens Wiklander     if( out_len > MBEDTLS_HMAC_DRBG_MAX_REQUEST )
340817466cbSJens Wiklander         return( MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG );
341817466cbSJens Wiklander 
342817466cbSJens Wiklander     /* III. Check input length */
343817466cbSJens Wiklander     if( add_len > MBEDTLS_HMAC_DRBG_MAX_INPUT )
344817466cbSJens Wiklander         return( MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG );
345817466cbSJens Wiklander 
346817466cbSJens Wiklander     /* 1. (aka VII and IX) Check reseed counter and PR */
347817466cbSJens Wiklander     if( ctx->f_entropy != NULL && /* For no-reseeding instances */
348817466cbSJens Wiklander         ( ctx->prediction_resistance == MBEDTLS_HMAC_DRBG_PR_ON ||
349817466cbSJens Wiklander           ctx->reseed_counter > ctx->reseed_interval ) )
350817466cbSJens Wiklander     {
351817466cbSJens Wiklander         if( ( ret = mbedtls_hmac_drbg_reseed( ctx, additional, add_len ) ) != 0 )
352817466cbSJens Wiklander             return( ret );
353817466cbSJens Wiklander 
354817466cbSJens Wiklander         add_len = 0; /* VII.4 */
355817466cbSJens Wiklander     }
356817466cbSJens Wiklander 
357817466cbSJens Wiklander     /* 2. Use additional data if any */
358817466cbSJens Wiklander     if( additional != NULL && add_len != 0 )
3593d3b0591SJens Wiklander     {
3603d3b0591SJens Wiklander         if( ( ret = mbedtls_hmac_drbg_update_ret( ctx,
3613d3b0591SJens Wiklander                                                   additional, add_len ) ) != 0 )
3623d3b0591SJens Wiklander             goto exit;
3633d3b0591SJens Wiklander     }
364817466cbSJens Wiklander 
365817466cbSJens Wiklander     /* 3, 4, 5. Generate bytes */
366817466cbSJens Wiklander     while( left != 0 )
367817466cbSJens Wiklander     {
368817466cbSJens Wiklander         size_t use_len = left > md_len ? md_len : left;
369817466cbSJens Wiklander 
3703d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_reset( &ctx->md_ctx ) ) != 0 )
3713d3b0591SJens Wiklander             goto exit;
3723d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_update( &ctx->md_ctx,
3733d3b0591SJens Wiklander                                             ctx->V, md_len ) ) != 0 )
3743d3b0591SJens Wiklander             goto exit;
3753d3b0591SJens Wiklander         if( ( ret = mbedtls_md_hmac_finish( &ctx->md_ctx, ctx->V ) ) != 0 )
3763d3b0591SJens Wiklander             goto exit;
377817466cbSJens Wiklander 
378817466cbSJens Wiklander         memcpy( out, ctx->V, use_len );
379817466cbSJens Wiklander         out += use_len;
380817466cbSJens Wiklander         left -= use_len;
381817466cbSJens Wiklander     }
382817466cbSJens Wiklander 
383817466cbSJens Wiklander     /* 6. Update */
3843d3b0591SJens Wiklander     if( ( ret = mbedtls_hmac_drbg_update_ret( ctx,
3853d3b0591SJens Wiklander                                               additional, add_len ) ) != 0 )
3863d3b0591SJens Wiklander         goto exit;
387817466cbSJens Wiklander 
388817466cbSJens Wiklander     /* 7. Update reseed counter */
389817466cbSJens Wiklander     ctx->reseed_counter++;
390817466cbSJens Wiklander 
3913d3b0591SJens Wiklander exit:
392817466cbSJens Wiklander     /* 8. Done */
3933d3b0591SJens Wiklander     return( ret );
394817466cbSJens Wiklander }
395817466cbSJens Wiklander 
396817466cbSJens Wiklander /*
397817466cbSJens Wiklander  * HMAC_DRBG random function
398817466cbSJens Wiklander  */
399817466cbSJens Wiklander int mbedtls_hmac_drbg_random( void *p_rng, unsigned char *output, size_t out_len )
400817466cbSJens Wiklander {
401817466cbSJens Wiklander     int ret;
402817466cbSJens Wiklander     mbedtls_hmac_drbg_context *ctx = (mbedtls_hmac_drbg_context *) p_rng;
403817466cbSJens Wiklander 
404817466cbSJens Wiklander #if defined(MBEDTLS_THREADING_C)
405817466cbSJens Wiklander     if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
406817466cbSJens Wiklander         return( ret );
407817466cbSJens Wiklander #endif
408817466cbSJens Wiklander 
409817466cbSJens Wiklander     ret = mbedtls_hmac_drbg_random_with_add( ctx, output, out_len, NULL, 0 );
410817466cbSJens Wiklander 
411817466cbSJens Wiklander #if defined(MBEDTLS_THREADING_C)
412817466cbSJens Wiklander     if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
413817466cbSJens Wiklander         return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
414817466cbSJens Wiklander #endif
415817466cbSJens Wiklander 
416817466cbSJens Wiklander     return( ret );
417817466cbSJens Wiklander }
418817466cbSJens Wiklander 
419817466cbSJens Wiklander /*
420817466cbSJens Wiklander  * Free an HMAC_DRBG context
421817466cbSJens Wiklander  */
422817466cbSJens Wiklander void mbedtls_hmac_drbg_free( mbedtls_hmac_drbg_context *ctx )
423817466cbSJens Wiklander {
424817466cbSJens Wiklander     if( ctx == NULL )
425817466cbSJens Wiklander         return;
426817466cbSJens Wiklander 
427817466cbSJens Wiklander #if defined(MBEDTLS_THREADING_C)
428817466cbSJens Wiklander     mbedtls_mutex_free( &ctx->mutex );
429817466cbSJens Wiklander #endif
430817466cbSJens Wiklander     mbedtls_md_free( &ctx->md_ctx );
4313d3b0591SJens Wiklander     mbedtls_platform_zeroize( ctx, sizeof( mbedtls_hmac_drbg_context ) );
432817466cbSJens Wiklander }
433817466cbSJens Wiklander 
434817466cbSJens Wiklander #if defined(MBEDTLS_FS_IO)
435817466cbSJens Wiklander int mbedtls_hmac_drbg_write_seed_file( mbedtls_hmac_drbg_context *ctx, const char *path )
436817466cbSJens Wiklander {
437817466cbSJens Wiklander     int ret;
438817466cbSJens Wiklander     FILE *f;
439817466cbSJens Wiklander     unsigned char buf[ MBEDTLS_HMAC_DRBG_MAX_INPUT ];
440817466cbSJens Wiklander 
441817466cbSJens Wiklander     if( ( f = fopen( path, "wb" ) ) == NULL )
442817466cbSJens Wiklander         return( MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR );
443817466cbSJens Wiklander 
444817466cbSJens Wiklander     if( ( ret = mbedtls_hmac_drbg_random( ctx, buf, sizeof( buf ) ) ) != 0 )
445817466cbSJens Wiklander         goto exit;
446817466cbSJens Wiklander 
447817466cbSJens Wiklander     if( fwrite( buf, 1, sizeof( buf ), f ) != sizeof( buf ) )
448817466cbSJens Wiklander     {
449817466cbSJens Wiklander         ret = MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR;
450817466cbSJens Wiklander         goto exit;
451817466cbSJens Wiklander     }
452817466cbSJens Wiklander 
453817466cbSJens Wiklander     ret = 0;
454817466cbSJens Wiklander 
455817466cbSJens Wiklander exit:
456817466cbSJens Wiklander     fclose( f );
4573d3b0591SJens Wiklander     mbedtls_platform_zeroize( buf, sizeof( buf ) );
4583d3b0591SJens Wiklander 
459817466cbSJens Wiklander     return( ret );
460817466cbSJens Wiklander }
461817466cbSJens Wiklander 
462817466cbSJens Wiklander int mbedtls_hmac_drbg_update_seed_file( mbedtls_hmac_drbg_context *ctx, const char *path )
463817466cbSJens Wiklander {
4643d3b0591SJens Wiklander     int ret = 0;
4653d3b0591SJens Wiklander     FILE *f = NULL;
466817466cbSJens Wiklander     size_t n;
467817466cbSJens Wiklander     unsigned char buf[ MBEDTLS_HMAC_DRBG_MAX_INPUT ];
4683d3b0591SJens Wiklander     unsigned char c;
469817466cbSJens Wiklander 
470817466cbSJens Wiklander     if( ( f = fopen( path, "rb" ) ) == NULL )
471817466cbSJens Wiklander         return( MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR );
472817466cbSJens Wiklander 
4733d3b0591SJens Wiklander     n = fread( buf, 1, sizeof( buf ), f );
4743d3b0591SJens Wiklander     if( fread( &c, 1, 1, f ) != 0 )
475817466cbSJens Wiklander     {
4763d3b0591SJens Wiklander         ret = MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG;
4773d3b0591SJens Wiklander         goto exit;
478817466cbSJens Wiklander     }
4793d3b0591SJens Wiklander     if( n == 0 || ferror( f ) )
480817466cbSJens Wiklander     {
4813d3b0591SJens Wiklander         ret = MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR;
4823d3b0591SJens Wiklander         goto exit;
483817466cbSJens Wiklander     }
484817466cbSJens Wiklander     fclose( f );
4853d3b0591SJens Wiklander     f = NULL;
486817466cbSJens Wiklander 
4873d3b0591SJens Wiklander     ret = mbedtls_hmac_drbg_update_ret( ctx, buf, n );
488817466cbSJens Wiklander 
4893d3b0591SJens Wiklander exit:
4903d3b0591SJens Wiklander     mbedtls_platform_zeroize( buf, sizeof( buf ) );
4913d3b0591SJens Wiklander     if( f != NULL )
4923d3b0591SJens Wiklander         fclose( f );
4933d3b0591SJens Wiklander     if( ret != 0 )
4943d3b0591SJens Wiklander         return( ret );
495817466cbSJens Wiklander     return( mbedtls_hmac_drbg_write_seed_file( ctx, path ) );
496817466cbSJens Wiklander }
497817466cbSJens Wiklander #endif /* MBEDTLS_FS_IO */
498817466cbSJens Wiklander 
499817466cbSJens Wiklander 
500817466cbSJens Wiklander #if defined(MBEDTLS_SELF_TEST)
501817466cbSJens Wiklander 
502817466cbSJens Wiklander #if !defined(MBEDTLS_SHA1_C)
503817466cbSJens Wiklander /* Dummy checkup routine */
504817466cbSJens Wiklander int mbedtls_hmac_drbg_self_test( int verbose )
505817466cbSJens Wiklander {
506817466cbSJens Wiklander     (void) verbose;
507817466cbSJens Wiklander     return( 0 );
508817466cbSJens Wiklander }
509817466cbSJens Wiklander #else
510817466cbSJens Wiklander 
511817466cbSJens Wiklander #define OUTPUT_LEN  80
512817466cbSJens Wiklander 
513817466cbSJens Wiklander /* From a NIST PR=true test vector */
514817466cbSJens Wiklander static const unsigned char entropy_pr[] = {
515817466cbSJens Wiklander     0xa0, 0xc9, 0xab, 0x58, 0xf1, 0xe2, 0xe5, 0xa4, 0xde, 0x3e, 0xbd, 0x4f,
516817466cbSJens Wiklander     0xf7, 0x3e, 0x9c, 0x5b, 0x64, 0xef, 0xd8, 0xca, 0x02, 0x8c, 0xf8, 0x11,
517817466cbSJens Wiklander     0x48, 0xa5, 0x84, 0xfe, 0x69, 0xab, 0x5a, 0xee, 0x42, 0xaa, 0x4d, 0x42,
518817466cbSJens Wiklander     0x17, 0x60, 0x99, 0xd4, 0x5e, 0x13, 0x97, 0xdc, 0x40, 0x4d, 0x86, 0xa3,
519817466cbSJens Wiklander     0x7b, 0xf5, 0x59, 0x54, 0x75, 0x69, 0x51, 0xe4 };
520817466cbSJens Wiklander static const unsigned char result_pr[OUTPUT_LEN] = {
521817466cbSJens Wiklander     0x9a, 0x00, 0xa2, 0xd0, 0x0e, 0xd5, 0x9b, 0xfe, 0x31, 0xec, 0xb1, 0x39,
522817466cbSJens Wiklander     0x9b, 0x60, 0x81, 0x48, 0xd1, 0x96, 0x9d, 0x25, 0x0d, 0x3c, 0x1e, 0x94,
523817466cbSJens Wiklander     0x10, 0x10, 0x98, 0x12, 0x93, 0x25, 0xca, 0xb8, 0xfc, 0xcc, 0x2d, 0x54,
524817466cbSJens Wiklander     0x73, 0x19, 0x70, 0xc0, 0x10, 0x7a, 0xa4, 0x89, 0x25, 0x19, 0x95, 0x5e,
525817466cbSJens Wiklander     0x4b, 0xc6, 0x00, 0x1d, 0x7f, 0x4e, 0x6a, 0x2b, 0xf8, 0xa3, 0x01, 0xab,
526817466cbSJens Wiklander     0x46, 0x05, 0x5c, 0x09, 0xa6, 0x71, 0x88, 0xf1, 0xa7, 0x40, 0xee, 0xf3,
527817466cbSJens Wiklander     0xe1, 0x5c, 0x02, 0x9b, 0x44, 0xaf, 0x03, 0x44 };
528817466cbSJens Wiklander 
529817466cbSJens Wiklander /* From a NIST PR=false test vector */
530817466cbSJens Wiklander static const unsigned char entropy_nopr[] = {
531817466cbSJens Wiklander     0x79, 0x34, 0x9b, 0xbf, 0x7c, 0xdd, 0xa5, 0x79, 0x95, 0x57, 0x86, 0x66,
532817466cbSJens Wiklander     0x21, 0xc9, 0x13, 0x83, 0x11, 0x46, 0x73, 0x3a, 0xbf, 0x8c, 0x35, 0xc8,
533817466cbSJens Wiklander     0xc7, 0x21, 0x5b, 0x5b, 0x96, 0xc4, 0x8e, 0x9b, 0x33, 0x8c, 0x74, 0xe3,
534817466cbSJens Wiklander     0xe9, 0x9d, 0xfe, 0xdf };
535817466cbSJens Wiklander static const unsigned char result_nopr[OUTPUT_LEN] = {
536817466cbSJens Wiklander     0xc6, 0xa1, 0x6a, 0xb8, 0xd4, 0x20, 0x70, 0x6f, 0x0f, 0x34, 0xab, 0x7f,
537817466cbSJens Wiklander     0xec, 0x5a, 0xdc, 0xa9, 0xd8, 0xca, 0x3a, 0x13, 0x3e, 0x15, 0x9c, 0xa6,
538817466cbSJens Wiklander     0xac, 0x43, 0xc6, 0xf8, 0xa2, 0xbe, 0x22, 0x83, 0x4a, 0x4c, 0x0a, 0x0a,
539817466cbSJens Wiklander     0xff, 0xb1, 0x0d, 0x71, 0x94, 0xf1, 0xc1, 0xa5, 0xcf, 0x73, 0x22, 0xec,
540817466cbSJens Wiklander     0x1a, 0xe0, 0x96, 0x4e, 0xd4, 0xbf, 0x12, 0x27, 0x46, 0xe0, 0x87, 0xfd,
541817466cbSJens Wiklander     0xb5, 0xb3, 0xe9, 0x1b, 0x34, 0x93, 0xd5, 0xbb, 0x98, 0xfa, 0xed, 0x49,
542817466cbSJens Wiklander     0xe8, 0x5f, 0x13, 0x0f, 0xc8, 0xa4, 0x59, 0xb7 };
543817466cbSJens Wiklander 
544817466cbSJens Wiklander /* "Entropy" from buffer */
545817466cbSJens Wiklander static size_t test_offset;
546817466cbSJens Wiklander static int hmac_drbg_self_test_entropy( void *data,
547817466cbSJens Wiklander                                         unsigned char *buf, size_t len )
548817466cbSJens Wiklander {
549817466cbSJens Wiklander     const unsigned char *p = data;
550817466cbSJens Wiklander     memcpy( buf, p + test_offset, len );
551817466cbSJens Wiklander     test_offset += len;
552817466cbSJens Wiklander     return( 0 );
553817466cbSJens Wiklander }
554817466cbSJens Wiklander 
555817466cbSJens Wiklander #define CHK( c )    if( (c) != 0 )                          \
556817466cbSJens Wiklander                     {                                       \
557817466cbSJens Wiklander                         if( verbose != 0 )                  \
558817466cbSJens Wiklander                             mbedtls_printf( "failed\n" );  \
559817466cbSJens Wiklander                         return( 1 );                        \
560817466cbSJens Wiklander                     }
561817466cbSJens Wiklander 
562817466cbSJens Wiklander /*
563817466cbSJens Wiklander  * Checkup routine for HMAC_DRBG with SHA-1
564817466cbSJens Wiklander  */
565817466cbSJens Wiklander int mbedtls_hmac_drbg_self_test( int verbose )
566817466cbSJens Wiklander {
567817466cbSJens Wiklander     mbedtls_hmac_drbg_context ctx;
568817466cbSJens Wiklander     unsigned char buf[OUTPUT_LEN];
569817466cbSJens Wiklander     const mbedtls_md_info_t *md_info = mbedtls_md_info_from_type( MBEDTLS_MD_SHA1 );
570817466cbSJens Wiklander 
571817466cbSJens Wiklander     mbedtls_hmac_drbg_init( &ctx );
572817466cbSJens Wiklander 
573817466cbSJens Wiklander     /*
574817466cbSJens Wiklander      * PR = True
575817466cbSJens Wiklander      */
576817466cbSJens Wiklander     if( verbose != 0 )
577817466cbSJens Wiklander         mbedtls_printf( "  HMAC_DRBG (PR = True) : " );
578817466cbSJens Wiklander 
579817466cbSJens Wiklander     test_offset = 0;
580817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_seed( &ctx, md_info,
581817466cbSJens Wiklander                          hmac_drbg_self_test_entropy, (void *) entropy_pr,
582817466cbSJens Wiklander                          NULL, 0 ) );
583817466cbSJens Wiklander     mbedtls_hmac_drbg_set_prediction_resistance( &ctx, MBEDTLS_HMAC_DRBG_PR_ON );
584817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_random( &ctx, buf, OUTPUT_LEN ) );
585817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_random( &ctx, buf, OUTPUT_LEN ) );
586817466cbSJens Wiklander     CHK( memcmp( buf, result_pr, OUTPUT_LEN ) );
587817466cbSJens Wiklander     mbedtls_hmac_drbg_free( &ctx );
588817466cbSJens Wiklander 
589817466cbSJens Wiklander     mbedtls_hmac_drbg_free( &ctx );
590817466cbSJens Wiklander 
591817466cbSJens Wiklander     if( verbose != 0 )
592817466cbSJens Wiklander         mbedtls_printf( "passed\n" );
593817466cbSJens Wiklander 
594817466cbSJens Wiklander     /*
595817466cbSJens Wiklander      * PR = False
596817466cbSJens Wiklander      */
597817466cbSJens Wiklander     if( verbose != 0 )
598817466cbSJens Wiklander         mbedtls_printf( "  HMAC_DRBG (PR = False) : " );
599817466cbSJens Wiklander 
600817466cbSJens Wiklander     mbedtls_hmac_drbg_init( &ctx );
601817466cbSJens Wiklander 
602817466cbSJens Wiklander     test_offset = 0;
603817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_seed( &ctx, md_info,
604817466cbSJens Wiklander                          hmac_drbg_self_test_entropy, (void *) entropy_nopr,
605817466cbSJens Wiklander                          NULL, 0 ) );
606817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_reseed( &ctx, NULL, 0 ) );
607817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_random( &ctx, buf, OUTPUT_LEN ) );
608817466cbSJens Wiklander     CHK( mbedtls_hmac_drbg_random( &ctx, buf, OUTPUT_LEN ) );
609817466cbSJens Wiklander     CHK( memcmp( buf, result_nopr, OUTPUT_LEN ) );
610817466cbSJens Wiklander     mbedtls_hmac_drbg_free( &ctx );
611817466cbSJens Wiklander 
612817466cbSJens Wiklander     mbedtls_hmac_drbg_free( &ctx );
613817466cbSJens Wiklander 
614817466cbSJens Wiklander     if( verbose != 0 )
615817466cbSJens Wiklander         mbedtls_printf( "passed\n" );
616817466cbSJens Wiklander 
617817466cbSJens Wiklander     if( verbose != 0 )
618817466cbSJens Wiklander         mbedtls_printf( "\n" );
619817466cbSJens Wiklander 
620817466cbSJens Wiklander     return( 0 );
621817466cbSJens Wiklander }
622817466cbSJens Wiklander #endif /* MBEDTLS_SHA1_C */
623817466cbSJens Wiklander #endif /* MBEDTLS_SELF_TEST */
624817466cbSJens Wiklander 
625817466cbSJens Wiklander #endif /* MBEDTLS_HMAC_DRBG_C */
626