blob: c7ae97aa453faf4732a882f516d85d4cdf0bf741 [file] [log] [blame]
Paul Bakker6083fd22011-12-03 21:45:14 +00001/*
2 * Entropy accumulator implementation
3 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Paul Bakker6083fd22011-12-03 21:45:14 +000018 */
19
Gilles Peskinedb09ef62020-06-03 01:43:33 +020020#include "common.h"
Paul Bakker6083fd22011-12-03 21:45:14 +000021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#if defined(MBEDTLS_ENTROPY_C)
Paul Bakker6083fd22011-12-03 21:45:14 +000023
Simon Butcherab5df402016-06-11 02:31:21 +010024#if defined(MBEDTLS_TEST_NULL_ENTROPY)
Simon Butcher1ceab6e2016-06-21 10:14:00 +010025#warning "**** WARNING! MBEDTLS_TEST_NULL_ENTROPY defined! "
26#warning "**** THIS BUILD HAS NO DEFINED ENTROPY SOURCES "
27#warning "**** THIS BUILD IS *NOT* SUITABLE FOR PRODUCTION USE "
Simon Butcherab5df402016-06-11 02:31:21 +010028#endif
29
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000030#include "mbedtls/entropy.h"
Chris Jonesea0a8652021-03-09 19:11:19 +000031#include "entropy_poll.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050032#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000033#include "mbedtls/error.h"
Paul Bakker6083fd22011-12-03 21:45:14 +000034
Rich Evans00ab4702015-02-06 13:43:58 +000035#include <string.h>
36
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020037#if defined(MBEDTLS_FS_IO)
Paul Bakker66ff70d2014-03-26 11:54:05 +010038#include <stdio.h>
39#endif
40
Paul Bakker217efbc2016-07-14 14:30:03 +010041#if defined(MBEDTLS_ENTROPY_NV_SEED)
42#include "mbedtls/platform.h"
43#endif
44
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020045#if defined(MBEDTLS_SELF_TEST)
46#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000047#include "mbedtls/platform.h"
Rich Evans00ab4702015-02-06 13:43:58 +000048#else
49#include <stdio.h>
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define mbedtls_printf printf
51#endif /* MBEDTLS_PLATFORM_C */
52#endif /* MBEDTLS_SELF_TEST */
Rich Evans00ab4702015-02-06 13:43:58 +000053
Paul Bakker28c7e7f2011-12-15 19:49:30 +000054
Paul Bakker6083fd22011-12-03 21:45:14 +000055#define ENTROPY_MAX_LOOP 256 /**< Maximum amount to loop before error */
56
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020057void mbedtls_entropy_init( mbedtls_entropy_context *ctx )
Paul Bakker6083fd22011-12-03 21:45:14 +000058{
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +010059 ctx->source_count = 0;
60 memset( ctx->source, 0, sizeof( ctx->source ) );
Paul Bakker6083fd22011-12-03 21:45:14 +000061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020062#if defined(MBEDTLS_THREADING_C)
63 mbedtls_mutex_init( &ctx->mutex );
Paul Bakkerf4e7dc52013-09-28 15:23:57 +020064#endif
65
Andres Amaya Garcia95869c42017-06-29 16:31:44 +010066 ctx->accumulator_started = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020067#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +010068 mbedtls_sha512_init( &ctx->accumulator );
Paul Bakkerfb08fd22013-08-27 15:06:26 +020069#else
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +010070 mbedtls_sha256_init( &ctx->accumulator );
Paul Bakkerfb08fd22013-08-27 15:06:26 +020071#endif
Paul Bakker6083fd22011-12-03 21:45:14 +000072
Hanno Beckerd4a872e2017-09-07 08:09:33 +010073 /* Reminder: Update ENTROPY_HAVE_STRONG in the test files
Hanno Becker47deec42017-07-24 12:27:09 +010074 * when adding more strong entropy sources here. */
Hanno Beckerc6deafc2017-07-23 14:06:42 +010075
Simon Butcherab5df402016-06-11 02:31:21 +010076#if defined(MBEDTLS_TEST_NULL_ENTROPY)
Simon Butcher4157b602016-06-12 00:31:33 +010077 mbedtls_entropy_add_source( ctx, mbedtls_null_entropy_poll, NULL,
Janos Follath53de7842016-06-08 15:29:18 +010078 1, MBEDTLS_ENTROPY_SOURCE_STRONG );
79#endif
80
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081#if !defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
82#if !defined(MBEDTLS_NO_PLATFORM_ENTROPY)
83 mbedtls_entropy_add_source( ctx, mbedtls_platform_entropy_poll, NULL,
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +020084 MBEDTLS_ENTROPY_MIN_PLATFORM,
85 MBEDTLS_ENTROPY_SOURCE_STRONG );
Paul Bakker6083fd22011-12-03 21:45:14 +000086#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020087#if defined(MBEDTLS_TIMING_C)
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +020088 mbedtls_entropy_add_source( ctx, mbedtls_hardclock_poll, NULL,
89 MBEDTLS_ENTROPY_MIN_HARDCLOCK,
90 MBEDTLS_ENTROPY_SOURCE_WEAK );
Paul Bakker6083fd22011-12-03 21:45:14 +000091#endif
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +020092#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
Manuel Pégourié-Gonnardfc2ccfe2015-07-10 11:15:50 +010093 mbedtls_entropy_add_source( ctx, mbedtls_hardware_poll, NULL,
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +020094 MBEDTLS_ENTROPY_MIN_HARDWARE,
95 MBEDTLS_ENTROPY_SOURCE_STRONG );
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +020096#endif
Paul Bakker9988d6b2016-06-01 11:29:42 +010097#if defined(MBEDTLS_ENTROPY_NV_SEED)
98 mbedtls_entropy_add_source( ctx, mbedtls_nv_seed_poll, NULL,
99 MBEDTLS_ENTROPY_BLOCK_SIZE,
100 MBEDTLS_ENTROPY_SOURCE_STRONG );
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100101 ctx->initial_entropy_run = 0;
Paul Bakker9988d6b2016-06-01 11:29:42 +0100102#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103#endif /* MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES */
Paul Bakker6083fd22011-12-03 21:45:14 +0000104}
105
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200106void mbedtls_entropy_free( mbedtls_entropy_context *ctx )
Paul Bakker1ffefac2013-09-28 15:23:03 +0200107{
Gilles Peskineb1583212021-02-22 21:26:54 +0100108 /* If the context was already free, don't call free() again.
109 * This is important for mutexes which don't allow double-free. */
110 if( ctx->accumulator_started == -1 )
111 return;
112
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200113#if defined(MBEDTLS_THREADING_C)
114 mbedtls_mutex_free( &ctx->mutex );
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200115#endif
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100116#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
117 mbedtls_sha512_free( &ctx->accumulator );
118#else
119 mbedtls_sha256_free( &ctx->accumulator );
120#endif
121#if defined(MBEDTLS_ENTROPY_NV_SEED)
122 ctx->initial_entropy_run = 0;
123#endif
124 ctx->source_count = 0;
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500125 mbedtls_platform_zeroize( ctx->source, sizeof( ctx->source ) );
Gilles Peskineb1583212021-02-22 21:26:54 +0100126 ctx->accumulator_started = -1;
Paul Bakker1ffefac2013-09-28 15:23:03 +0200127}
128
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129int mbedtls_entropy_add_source( mbedtls_entropy_context *ctx,
130 mbedtls_entropy_f_source_ptr f_source, void *p_source,
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200131 size_t threshold, int strong )
Paul Bakker6083fd22011-12-03 21:45:14 +0000132{
Hanno Becker61937d42017-04-26 15:01:23 +0100133 int idx, ret = 0;
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200135#if defined(MBEDTLS_THREADING_C)
136 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakker47703a02014-02-06 15:01:20 +0100137 return( ret );
138#endif
139
Hanno Becker61937d42017-04-26 15:01:23 +0100140 idx = ctx->source_count;
141 if( idx >= MBEDTLS_ENTROPY_MAX_SOURCES )
Paul Bakker47703a02014-02-06 15:01:20 +0100142 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200143 ret = MBEDTLS_ERR_ENTROPY_MAX_SOURCES;
Paul Bakker47703a02014-02-06 15:01:20 +0100144 goto exit;
145 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000146
Hanno Becker61937d42017-04-26 15:01:23 +0100147 ctx->source[idx].f_source = f_source;
148 ctx->source[idx].p_source = p_source;
149 ctx->source[idx].threshold = threshold;
150 ctx->source[idx].strong = strong;
Paul Bakker6083fd22011-12-03 21:45:14 +0000151
152 ctx->source_count++;
153
Paul Bakker47703a02014-02-06 15:01:20 +0100154exit:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200155#if defined(MBEDTLS_THREADING_C)
156 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
157 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakker47703a02014-02-06 15:01:20 +0100158#endif
159
160 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000161}
162
163/*
164 * Entropy accumulator update
165 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200166static int entropy_update( mbedtls_entropy_context *ctx, unsigned char source_id,
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200167 const unsigned char *data, size_t len )
Paul Bakker6083fd22011-12-03 21:45:14 +0000168{
169 unsigned char header[2];
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170 unsigned char tmp[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakker6083fd22011-12-03 21:45:14 +0000171 size_t use_len = len;
172 const unsigned char *p = data;
Jaeden Amero66954e12018-01-25 16:05:54 +0000173 int ret = 0;
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200174
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175 if( use_len > MBEDTLS_ENTROPY_BLOCK_SIZE )
Paul Bakker6083fd22011-12-03 21:45:14 +0000176 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100178 if( ( ret = mbedtls_sha512_ret( data, len, tmp, 0 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000179 goto cleanup;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200180#else
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100181 if( ( ret = mbedtls_sha256_ret( data, len, tmp, 0 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000182 goto cleanup;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200183#endif
Paul Bakker6083fd22011-12-03 21:45:14 +0000184 p = tmp;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200185 use_len = MBEDTLS_ENTROPY_BLOCK_SIZE;
Paul Bakker6083fd22011-12-03 21:45:14 +0000186 }
187
188 header[0] = source_id;
189 header[1] = use_len & 0xFF;
190
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100191 /*
192 * Start the accumulator if this has not already happened. Note that
193 * it is sufficient to start the accumulator here only because all calls to
194 * gather entropy eventually execute this code.
195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200196#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100197 if( ctx->accumulator_started == 0 &&
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100198 ( ret = mbedtls_sha512_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000199 goto cleanup;
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100200 else
201 ctx->accumulator_started = 1;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100202 if( ( ret = mbedtls_sha512_update_ret( &ctx->accumulator, header, 2 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000203 goto cleanup;
204 ret = mbedtls_sha512_update_ret( &ctx->accumulator, p, use_len );
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200205#else
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100206 if( ctx->accumulator_started == 0 &&
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100207 ( ret = mbedtls_sha256_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000208 goto cleanup;
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100209 else
210 ctx->accumulator_started = 1;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100211 if( ( ret = mbedtls_sha256_update_ret( &ctx->accumulator, header, 2 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000212 goto cleanup;
213 ret = mbedtls_sha256_update_ret( &ctx->accumulator, p, use_len );
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200214#endif
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200215
Jaeden Amero66954e12018-01-25 16:05:54 +0000216cleanup:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500217 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Andres Amaya Garcia65121932017-07-05 15:45:47 +0100218
Jaeden Amero66954e12018-01-25 16:05:54 +0000219 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000220}
221
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222int mbedtls_entropy_update_manual( mbedtls_entropy_context *ctx,
Paul Bakker6083fd22011-12-03 21:45:14 +0000223 const unsigned char *data, size_t len )
224{
Janos Follath24eed8d2019-11-22 13:21:35 +0000225 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker47703a02014-02-06 15:01:20 +0100226
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200227#if defined(MBEDTLS_THREADING_C)
228 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakker47703a02014-02-06 15:01:20 +0100229 return( ret );
230#endif
231
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200232 ret = entropy_update( ctx, MBEDTLS_ENTROPY_SOURCE_MANUAL, data, len );
Paul Bakker47703a02014-02-06 15:01:20 +0100233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234#if defined(MBEDTLS_THREADING_C)
235 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
236 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakker47703a02014-02-06 15:01:20 +0100237#endif
238
Paul Bakkerd8bb8262014-06-17 14:06:49 +0200239 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000240}
241
242/*
243 * Run through the different sources to add entropy to our accumulator
244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200245static int entropy_gather_internal( mbedtls_entropy_context *ctx )
Paul Bakker6083fd22011-12-03 21:45:14 +0000246{
Gilles Peskine006c1b52019-09-30 17:29:54 +0200247 int ret = MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
248 int i;
249 int have_one_strong = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200250 unsigned char buf[MBEDTLS_ENTROPY_MAX_GATHER];
Paul Bakker6083fd22011-12-03 21:45:14 +0000251 size_t olen;
Paul Bakker47703a02014-02-06 15:01:20 +0100252
Paul Bakker43655f42011-12-15 20:11:16 +0000253 if( ctx->source_count == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254 return( MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED );
Paul Bakker43655f42011-12-15 20:11:16 +0000255
Paul Bakker6083fd22011-12-03 21:45:14 +0000256 /*
257 * Run through our entropy sources
258 */
259 for( i = 0; i < ctx->source_count; i++ )
260 {
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200261 if( ctx->source[i].strong == MBEDTLS_ENTROPY_SOURCE_STRONG )
262 have_one_strong = 1;
263
Paul Bakker6083fd22011-12-03 21:45:14 +0000264 olen = 0;
Paul Bakker66d5d072014-06-17 16:39:18 +0200265 if( ( ret = ctx->source[i].f_source( ctx->source[i].p_source,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200266 buf, MBEDTLS_ENTROPY_MAX_GATHER, &olen ) ) != 0 )
Paul Bakker6083fd22011-12-03 21:45:14 +0000267 {
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100268 goto cleanup;
Paul Bakker6083fd22011-12-03 21:45:14 +0000269 }
270
271 /*
272 * Add if we actually gathered something
273 */
274 if( olen > 0 )
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000275 {
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100276 if( ( ret = entropy_update( ctx, (unsigned char) i,
277 buf, olen ) ) != 0 )
278 return( ret );
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000279 ctx->source[i].size += olen;
280 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000281 }
282
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200283 if( have_one_strong == 0 )
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100284 ret = MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE;
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200285
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100286cleanup:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500287 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100288
289 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000290}
291
Paul Bakker47703a02014-02-06 15:01:20 +0100292/*
293 * Thread-safe wrapper for entropy_gather_internal()
294 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200295int mbedtls_entropy_gather( mbedtls_entropy_context *ctx )
Paul Bakker47703a02014-02-06 15:01:20 +0100296{
Janos Follath24eed8d2019-11-22 13:21:35 +0000297 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker47703a02014-02-06 15:01:20 +0100298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299#if defined(MBEDTLS_THREADING_C)
300 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakkerddd427a2014-04-09 14:47:58 +0200301 return( ret );
Paul Bakker47703a02014-02-06 15:01:20 +0100302#endif
303
Paul Bakkerddd427a2014-04-09 14:47:58 +0200304 ret = entropy_gather_internal( ctx );
Paul Bakker47703a02014-02-06 15:01:20 +0100305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200306#if defined(MBEDTLS_THREADING_C)
307 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
308 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakker47703a02014-02-06 15:01:20 +0100309#endif
310
Paul Bakkerddd427a2014-04-09 14:47:58 +0200311 return( ret );
Paul Bakker47703a02014-02-06 15:01:20 +0100312}
313
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200314int mbedtls_entropy_func( void *data, unsigned char *output, size_t len )
Paul Bakker6083fd22011-12-03 21:45:14 +0000315{
Gilles Peskine85485c72019-10-08 15:04:16 +0200316 int ret, count = 0, i, thresholds_reached;
317 size_t strong_size;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318 mbedtls_entropy_context *ctx = (mbedtls_entropy_context *) data;
319 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakker6083fd22011-12-03 21:45:14 +0000320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200321 if( len > MBEDTLS_ENTROPY_BLOCK_SIZE )
322 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
Paul Bakker6083fd22011-12-03 21:45:14 +0000323
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100324#if defined(MBEDTLS_ENTROPY_NV_SEED)
325 /* Update the NV entropy seed before generating any entropy for outside
326 * use.
327 */
Paul Bakkerfc9c7c82016-06-01 15:25:50 +0100328 if( ctx->initial_entropy_run == 0 )
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100329 {
Paul Bakkerfc9c7c82016-06-01 15:25:50 +0100330 ctx->initial_entropy_run = 1;
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100331 if( ( ret = mbedtls_entropy_update_nv_seed( ctx ) ) != 0 )
332 return( ret );
333 }
334#endif
335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200336#if defined(MBEDTLS_THREADING_C)
337 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200338 return( ret );
339#endif
340
Paul Bakker6083fd22011-12-03 21:45:14 +0000341 /*
342 * Always gather extra entropy before a call
343 */
344 do
345 {
346 if( count++ > ENTROPY_MAX_LOOP )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200347 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200348 ret = MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200349 goto exit;
350 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000351
Paul Bakker47703a02014-02-06 15:01:20 +0100352 if( ( ret = entropy_gather_internal( ctx ) ) != 0 )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200353 goto exit;
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000354
Gilles Peskine85485c72019-10-08 15:04:16 +0200355 thresholds_reached = 1;
356 strong_size = 0;
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000357 for( i = 0; i < ctx->source_count; i++ )
Gilles Peskine85485c72019-10-08 15:04:16 +0200358 {
Manuel Pégourié-Gonnardbf82ff02015-06-19 09:40:51 +0200359 if( ctx->source[i].size < ctx->source[i].threshold )
Gilles Peskine85485c72019-10-08 15:04:16 +0200360 thresholds_reached = 0;
361 if( ctx->source[i].strong == MBEDTLS_ENTROPY_SOURCE_STRONG )
362 strong_size += ctx->source[i].size;
363 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000364 }
Gilles Peskine85485c72019-10-08 15:04:16 +0200365 while( ! thresholds_reached || strong_size < MBEDTLS_ENTROPY_BLOCK_SIZE );
Paul Bakker6083fd22011-12-03 21:45:14 +0000366
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200367 memset( buf, 0, MBEDTLS_ENTROPY_BLOCK_SIZE );
Paul Bakker6083fd22011-12-03 21:45:14 +0000368
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200369#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Andres Amaya Garciab2b063f2017-07-20 16:45:24 +0100370 /*
371 * Note that at this stage it is assumed that the accumulator was started
372 * in a previous call to entropy_update(). If this is not guaranteed, the
373 * code below will fail.
374 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100375 if( ( ret = mbedtls_sha512_finish_ret( &ctx->accumulator, buf ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100376 goto exit;
Paul Bakker9e36f042013-06-30 14:34:05 +0200377
Paul Bakker6083fd22011-12-03 21:45:14 +0000378 /*
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000379 * Reset accumulator and counters and recycle existing entropy
Paul Bakker6083fd22011-12-03 21:45:14 +0000380 */
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100381 mbedtls_sha512_free( &ctx->accumulator );
382 mbedtls_sha512_init( &ctx->accumulator );
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100383 if( ( ret = mbedtls_sha512_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100384 goto exit;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100385 if( ( ret = mbedtls_sha512_update_ret( &ctx->accumulator, buf,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100386 MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
387 goto exit;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200388
389 /*
Paul Bakkerb13d3ff2014-03-26 12:51:25 +0100390 * Perform second SHA-512 on entropy
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200391 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100392 if( ( ret = mbedtls_sha512_ret( buf, MBEDTLS_ENTROPY_BLOCK_SIZE,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100393 buf, 0 ) ) != 0 )
394 goto exit;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200395#else /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100396 if( ( ret = mbedtls_sha256_finish_ret( &ctx->accumulator, buf ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100397 goto exit;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200398
399 /*
400 * Reset accumulator and counters and recycle existing entropy
401 */
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100402 mbedtls_sha256_free( &ctx->accumulator );
403 mbedtls_sha256_init( &ctx->accumulator );
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100404 if( ( ret = mbedtls_sha256_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100405 goto exit;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100406 if( ( ret = mbedtls_sha256_update_ret( &ctx->accumulator, buf,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100407 MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
408 goto exit;
Paul Bakkerb13d3ff2014-03-26 12:51:25 +0100409
410 /*
411 * Perform second SHA-256 on entropy
412 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100413 if( ( ret = mbedtls_sha256_ret( buf, MBEDTLS_ENTROPY_BLOCK_SIZE,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100414 buf, 0 ) ) != 0 )
415 goto exit;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200416#endif /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000417
418 for( i = 0; i < ctx->source_count; i++ )
419 ctx->source[i].size = 0;
Paul Bakker6083fd22011-12-03 21:45:14 +0000420
421 memcpy( output, buf, len );
422
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200423 ret = 0;
424
425exit:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500426 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100427
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200428#if defined(MBEDTLS_THREADING_C)
429 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
430 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200431#endif
432
433 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000434}
435
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100436#if defined(MBEDTLS_ENTROPY_NV_SEED)
437int mbedtls_entropy_update_nv_seed( mbedtls_entropy_context *ctx )
438{
439 int ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
Andres Amaya Garciaaf0b31d2017-07-05 14:23:54 +0100440 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100441
442 /* Read new seed and write it to NV */
443 if( ( ret = mbedtls_entropy_func( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
444 return( ret );
445
446 if( mbedtls_nv_seed_write( buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) < 0 )
447 return( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR );
448
449 /* Manually update the remaining stream with a separator value to diverge */
450 memset( buf, 0, MBEDTLS_ENTROPY_BLOCK_SIZE );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100451 ret = mbedtls_entropy_update_manual( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE );
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100452
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100453 return( ret );
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100454}
455#endif /* MBEDTLS_ENTROPY_NV_SEED */
456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200457#if defined(MBEDTLS_FS_IO)
458int mbedtls_entropy_write_seed_file( mbedtls_entropy_context *ctx, const char *path )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100459{
Victor Krasnoshchoka0c2d192020-09-03 00:07:05 +0300460 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Victor Krasnoshchoke79812e2020-08-27 00:19:55 +0300461 FILE *f = NULL;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200462 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakker66ff70d2014-03-26 11:54:05 +0100463
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200464 if( ( ret = mbedtls_entropy_func( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100465 {
Victor Krasnoshchokb3129ba2020-08-29 22:54:37 +0300466 ret = MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100467 goto exit;
Victor Krasnoshchokb3129ba2020-08-29 22:54:37 +0300468 }
469
470 if( ( f = fopen( path, "wb" ) ) == NULL )
471 {
472 ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
473 goto exit;
474 }
Paul Bakker66ff70d2014-03-26 11:54:05 +0100475
476 if( fwrite( buf, 1, MBEDTLS_ENTROPY_BLOCK_SIZE, f ) != MBEDTLS_ENTROPY_BLOCK_SIZE )
477 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478 ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100479 goto exit;
480 }
481
482 ret = 0;
483
484exit:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500485 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100486
Victor Krasnoshchokb3129ba2020-08-29 22:54:37 +0300487 if( f != NULL )
Victor Krasnoshchoke79812e2020-08-27 00:19:55 +0300488 fclose( f );
489
Paul Bakker66ff70d2014-03-26 11:54:05 +0100490 return( ret );
491}
492
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200493int mbedtls_entropy_update_seed_file( mbedtls_entropy_context *ctx, const char *path )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100494{
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100495 int ret = 0;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100496 FILE *f;
497 size_t n;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200498 unsigned char buf[ MBEDTLS_ENTROPY_MAX_SEED_SIZE ];
Paul Bakker66ff70d2014-03-26 11:54:05 +0100499
500 if( ( f = fopen( path, "rb" ) ) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200501 return( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100502
503 fseek( f, 0, SEEK_END );
504 n = (size_t) ftell( f );
505 fseek( f, 0, SEEK_SET );
506
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200507 if( n > MBEDTLS_ENTROPY_MAX_SEED_SIZE )
508 n = MBEDTLS_ENTROPY_MAX_SEED_SIZE;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100509
510 if( fread( buf, 1, n, f ) != n )
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100511 ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
512 else
513 ret = mbedtls_entropy_update_manual( ctx, buf, n );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100514
515 fclose( f );
516
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500517 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100518
519 if( ret != 0 )
520 return( ret );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100521
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200522 return( mbedtls_entropy_write_seed_file( ctx, path ) );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100523}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200524#endif /* MBEDTLS_FS_IO */
Paul Bakker66ff70d2014-03-26 11:54:05 +0100525
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526#if defined(MBEDTLS_SELF_TEST)
Simon Butcher669c6352016-09-15 18:57:34 +0100527#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200528/*
529 * Dummy source function
530 */
531static int entropy_dummy_source( void *data, unsigned char *output,
532 size_t len, size_t *olen )
533{
534 ((void) data);
535
536 memset( output, 0x2a, len );
537 *olen = len;
538
539 return( 0 );
540}
Simon Butcher669c6352016-09-15 18:57:34 +0100541#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200542
Andres AGe7723ec2016-08-25 10:18:50 +0100543#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
Andres AGb34e42e2016-08-22 11:08:50 +0100544
Andres AGe7723ec2016-08-25 10:18:50 +0100545static int mbedtls_entropy_source_self_test_gather( unsigned char *buf, size_t buf_len )
546{
547 int ret = 0;
548 size_t entropy_len = 0;
549 size_t olen = 0;
550 size_t attempts = buf_len;
551
552 while( attempts > 0 && entropy_len < buf_len )
553 {
554 if( ( ret = mbedtls_hardware_poll( NULL, buf + entropy_len,
555 buf_len - entropy_len, &olen ) ) != 0 )
556 return( ret );
557
558 entropy_len += olen;
559 attempts--;
560 }
561
562 if( entropy_len < buf_len )
563 {
564 ret = 1;
565 }
566
567 return( ret );
568}
569
570
571static int mbedtls_entropy_source_self_test_check_bits( const unsigned char *buf,
572 size_t buf_len )
573{
574 unsigned char set= 0xFF;
575 unsigned char unset = 0x00;
576 size_t i;
577
578 for( i = 0; i < buf_len; i++ )
579 {
580 set &= buf[i];
581 unset |= buf[i];
582 }
583
584 return( set == 0xFF || unset == 0x00 );
585}
Andres AGb34e42e2016-08-22 11:08:50 +0100586
587/*
Andres AGe7723ec2016-08-25 10:18:50 +0100588 * A test to ensure hat the entropy sources are functioning correctly
589 * and there is no obvious failure. The test performs the following checks:
Andres AGb34e42e2016-08-22 11:08:50 +0100590 * - The entropy source is not providing only 0s (all bits unset) or 1s (all
591 * bits set).
592 * - The entropy source is not providing values in a pattern. Because the
Andres AGe7723ec2016-08-25 10:18:50 +0100593 * hardware could be providing data in an arbitrary length, this check polls
594 * the hardware entropy source twice and compares the result to ensure they
595 * are not equal.
Andres AGb34e42e2016-08-22 11:08:50 +0100596 * - The error code returned by the entropy source is not an error.
597 */
Andres AGe7723ec2016-08-25 10:18:50 +0100598int mbedtls_entropy_source_self_test( int verbose )
Andres AGb34e42e2016-08-22 11:08:50 +0100599{
600 int ret = 0;
Andres AGe7723ec2016-08-25 10:18:50 +0100601 unsigned char buf0[2 * sizeof( unsigned long long int )];
602 unsigned char buf1[2 * sizeof( unsigned long long int )];
Andres AGb34e42e2016-08-22 11:08:50 +0100603
604 if( verbose != 0 )
605 mbedtls_printf( " ENTROPY_BIAS test: " );
606
Andres AGe7723ec2016-08-25 10:18:50 +0100607 memset( buf0, 0x00, sizeof( buf0 ) );
608 memset( buf1, 0x00, sizeof( buf1 ) );
Andres AGb34e42e2016-08-22 11:08:50 +0100609
Andres AGe7723ec2016-08-25 10:18:50 +0100610 if( ( ret = mbedtls_entropy_source_self_test_gather( buf0, sizeof( buf0 ) ) ) != 0 )
Andres AGb34e42e2016-08-22 11:08:50 +0100611 goto cleanup;
Andres AGe7723ec2016-08-25 10:18:50 +0100612 if( ( ret = mbedtls_entropy_source_self_test_gather( buf1, sizeof( buf1 ) ) ) != 0 )
613 goto cleanup;
614
615 /* Make sure that the returned values are not all 0 or 1 */
616 if( ( ret = mbedtls_entropy_source_self_test_check_bits( buf0, sizeof( buf0 ) ) ) != 0 )
617 goto cleanup;
618 if( ( ret = mbedtls_entropy_source_self_test_check_bits( buf1, sizeof( buf1 ) ) ) != 0 )
619 goto cleanup;
Andres AGb34e42e2016-08-22 11:08:50 +0100620
621 /* Make sure that the entropy source is not returning values in a
622 * pattern */
Andres AGe7723ec2016-08-25 10:18:50 +0100623 ret = memcmp( buf0, buf1, sizeof( buf0 ) ) == 0;
Andres AGb34e42e2016-08-22 11:08:50 +0100624
625cleanup:
Andres AGb34e42e2016-08-22 11:08:50 +0100626 if( verbose != 0 )
627 {
628 if( ret != 0 )
629 mbedtls_printf( "failed\n" );
630 else
631 mbedtls_printf( "passed\n" );
632
633 mbedtls_printf( "\n" );
634 }
635
636 return( ret != 0 );
637}
Andres AGe7723ec2016-08-25 10:18:50 +0100638
639#endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
Andres AGb34e42e2016-08-22 11:08:50 +0100640
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200641/*
642 * The actual entropy quality is hard to test, but we can at least
643 * test that the functions don't cause errors and write the correct
644 * amount of data to buffers.
645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200646int mbedtls_entropy_self_test( int verbose )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200647{
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100648 int ret = 1;
Simon Butcher669c6352016-09-15 18:57:34 +0100649#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650 mbedtls_entropy_context ctx;
651 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE] = { 0 };
652 unsigned char acc[MBEDTLS_ENTROPY_BLOCK_SIZE] = { 0 };
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200653 size_t i, j;
Simon Butcher669c6352016-09-15 18:57:34 +0100654#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200655
656 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200657 mbedtls_printf( " ENTROPY test: " );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200658
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100659#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660 mbedtls_entropy_init( &ctx );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200661
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200662 /* First do a gather to make sure we have default sources */
Manuel Pégourié-Gonnarde94bfe62015-05-14 13:57:50 +0200663 if( ( ret = mbedtls_entropy_gather( &ctx ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200664 goto cleanup;
665
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200666 ret = mbedtls_entropy_add_source( &ctx, entropy_dummy_source, NULL, 16,
667 MBEDTLS_ENTROPY_SOURCE_WEAK );
Manuel Pégourié-Gonnarde94bfe62015-05-14 13:57:50 +0200668 if( ret != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200669 goto cleanup;
670
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200671 if( ( ret = mbedtls_entropy_update_manual( &ctx, buf, sizeof buf ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200672 goto cleanup;
673
674 /*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675 * To test that mbedtls_entropy_func writes correct number of bytes:
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200676 * - use the whole buffer and rely on ASan to detect overruns
677 * - collect entropy 8 times and OR the result in an accumulator:
678 * any byte should then be 0 with probably 2^(-64), so requiring
679 * each of the 32 or 64 bytes to be non-zero has a false failure rate
680 * of at most 2^(-58) which is acceptable.
681 */
682 for( i = 0; i < 8; i++ )
683 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684 if( ( ret = mbedtls_entropy_func( &ctx, buf, sizeof( buf ) ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200685 goto cleanup;
686
687 for( j = 0; j < sizeof( buf ); j++ )
688 acc[j] |= buf[j];
689 }
690
691 for( j = 0; j < sizeof( buf ); j++ )
692 {
693 if( acc[j] == 0 )
694 {
695 ret = 1;
696 goto cleanup;
697 }
698 }
699
Andres AGe7723ec2016-08-25 10:18:50 +0100700#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
701 if( ( ret = mbedtls_entropy_source_self_test( 0 ) ) != 0 )
702 goto cleanup;
703#endif
704
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200705cleanup:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200706 mbedtls_entropy_free( &ctx );
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100707#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200708
709 if( verbose != 0 )
710 {
711 if( ret != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200713 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714 mbedtls_printf( "passed\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200715
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200716 mbedtls_printf( "\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200717 }
718
719 return( ret != 0 );
720}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200721#endif /* MBEDTLS_SELF_TEST */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200722
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200723#endif /* MBEDTLS_ENTROPY_C */