blob: db61f16d84f608a7d4fc877d448399b05ff1bb1b [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"
31#include "mbedtls/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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020054#if defined(MBEDTLS_HAVEGE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000055#include "mbedtls/havege.h"
Paul Bakker28c7e7f2011-12-15 19:49:30 +000056#endif
57
Paul Bakker6083fd22011-12-03 21:45:14 +000058#define ENTROPY_MAX_LOOP 256 /**< Maximum amount to loop before error */
59
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020060void mbedtls_entropy_init( mbedtls_entropy_context *ctx )
Paul Bakker6083fd22011-12-03 21:45:14 +000061{
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +010062 ctx->source_count = 0;
63 memset( ctx->source, 0, sizeof( ctx->source ) );
Paul Bakker6083fd22011-12-03 21:45:14 +000064
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065#if defined(MBEDTLS_THREADING_C)
66 mbedtls_mutex_init( &ctx->mutex );
Paul Bakkerf4e7dc52013-09-28 15:23:57 +020067#endif
68
Andres Amaya Garcia95869c42017-06-29 16:31:44 +010069 ctx->accumulator_started = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +010071 mbedtls_sha512_init( &ctx->accumulator );
Paul Bakkerfb08fd22013-08-27 15:06:26 +020072#else
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +010073 mbedtls_sha256_init( &ctx->accumulator );
Paul Bakkerfb08fd22013-08-27 15:06:26 +020074#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020075#if defined(MBEDTLS_HAVEGE_C)
76 mbedtls_havege_init( &ctx->havege_data );
Paul Bakker43655f42011-12-15 20:11:16 +000077#endif
Paul Bakker6083fd22011-12-03 21:45:14 +000078
Hanno Beckerd4a872e2017-09-07 08:09:33 +010079 /* Reminder: Update ENTROPY_HAVE_STRONG in the test files
Hanno Becker47deec42017-07-24 12:27:09 +010080 * when adding more strong entropy sources here. */
Hanno Beckerc6deafc2017-07-23 14:06:42 +010081
Simon Butcherab5df402016-06-11 02:31:21 +010082#if defined(MBEDTLS_TEST_NULL_ENTROPY)
Simon Butcher4157b602016-06-12 00:31:33 +010083 mbedtls_entropy_add_source( ctx, mbedtls_null_entropy_poll, NULL,
Janos Follath53de7842016-06-08 15:29:18 +010084 1, MBEDTLS_ENTROPY_SOURCE_STRONG );
85#endif
86
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020087#if !defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
88#if !defined(MBEDTLS_NO_PLATFORM_ENTROPY)
89 mbedtls_entropy_add_source( ctx, mbedtls_platform_entropy_poll, NULL,
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +020090 MBEDTLS_ENTROPY_MIN_PLATFORM,
91 MBEDTLS_ENTROPY_SOURCE_STRONG );
Paul Bakker6083fd22011-12-03 21:45:14 +000092#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020093#if defined(MBEDTLS_TIMING_C)
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +020094 mbedtls_entropy_add_source( ctx, mbedtls_hardclock_poll, NULL,
95 MBEDTLS_ENTROPY_MIN_HARDCLOCK,
96 MBEDTLS_ENTROPY_SOURCE_WEAK );
Paul Bakker6083fd22011-12-03 21:45:14 +000097#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020098#if defined(MBEDTLS_HAVEGE_C)
99 mbedtls_entropy_add_source( ctx, mbedtls_havege_poll, &ctx->havege_data,
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200100 MBEDTLS_ENTROPY_MIN_HAVEGE,
101 MBEDTLS_ENTROPY_SOURCE_STRONG );
Paul Bakker28c7e7f2011-12-15 19:49:30 +0000102#endif
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200103#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
Manuel Pégourié-Gonnardfc2ccfe2015-07-10 11:15:50 +0100104 mbedtls_entropy_add_source( ctx, mbedtls_hardware_poll, NULL,
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200105 MBEDTLS_ENTROPY_MIN_HARDWARE,
106 MBEDTLS_ENTROPY_SOURCE_STRONG );
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200107#endif
Paul Bakker9988d6b2016-06-01 11:29:42 +0100108#if defined(MBEDTLS_ENTROPY_NV_SEED)
109 mbedtls_entropy_add_source( ctx, mbedtls_nv_seed_poll, NULL,
110 MBEDTLS_ENTROPY_BLOCK_SIZE,
111 MBEDTLS_ENTROPY_SOURCE_STRONG );
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100112 ctx->initial_entropy_run = 0;
Paul Bakker9988d6b2016-06-01 11:29:42 +0100113#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200114#endif /* MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES */
Paul Bakker6083fd22011-12-03 21:45:14 +0000115}
116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200117void mbedtls_entropy_free( mbedtls_entropy_context *ctx )
Paul Bakker1ffefac2013-09-28 15:23:03 +0200118{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200119#if defined(MBEDTLS_HAVEGE_C)
120 mbedtls_havege_free( &ctx->havege_data );
Paul Bakkera317a982014-06-18 16:44:11 +0200121#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200122#if defined(MBEDTLS_THREADING_C)
123 mbedtls_mutex_free( &ctx->mutex );
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200124#endif
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100125#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
126 mbedtls_sha512_free( &ctx->accumulator );
127#else
128 mbedtls_sha256_free( &ctx->accumulator );
129#endif
130#if defined(MBEDTLS_ENTROPY_NV_SEED)
131 ctx->initial_entropy_run = 0;
132#endif
133 ctx->source_count = 0;
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500134 mbedtls_platform_zeroize( ctx->source, sizeof( ctx->source ) );
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100135 ctx->accumulator_started = 0;
Paul Bakker1ffefac2013-09-28 15:23:03 +0200136}
137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200138int mbedtls_entropy_add_source( mbedtls_entropy_context *ctx,
139 mbedtls_entropy_f_source_ptr f_source, void *p_source,
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200140 size_t threshold, int strong )
Paul Bakker6083fd22011-12-03 21:45:14 +0000141{
Hanno Becker61937d42017-04-26 15:01:23 +0100142 int idx, ret = 0;
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200144#if defined(MBEDTLS_THREADING_C)
145 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakker47703a02014-02-06 15:01:20 +0100146 return( ret );
147#endif
148
Hanno Becker61937d42017-04-26 15:01:23 +0100149 idx = ctx->source_count;
150 if( idx >= MBEDTLS_ENTROPY_MAX_SOURCES )
Paul Bakker47703a02014-02-06 15:01:20 +0100151 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200152 ret = MBEDTLS_ERR_ENTROPY_MAX_SOURCES;
Paul Bakker47703a02014-02-06 15:01:20 +0100153 goto exit;
154 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000155
Hanno Becker61937d42017-04-26 15:01:23 +0100156 ctx->source[idx].f_source = f_source;
157 ctx->source[idx].p_source = p_source;
158 ctx->source[idx].threshold = threshold;
159 ctx->source[idx].strong = strong;
Paul Bakker6083fd22011-12-03 21:45:14 +0000160
161 ctx->source_count++;
162
Paul Bakker47703a02014-02-06 15:01:20 +0100163exit:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200164#if defined(MBEDTLS_THREADING_C)
165 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
166 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakker47703a02014-02-06 15:01:20 +0100167#endif
168
169 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000170}
171
172/*
173 * Entropy accumulator update
174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175static int entropy_update( mbedtls_entropy_context *ctx, unsigned char source_id,
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200176 const unsigned char *data, size_t len )
Paul Bakker6083fd22011-12-03 21:45:14 +0000177{
178 unsigned char header[2];
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200179 unsigned char tmp[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakker6083fd22011-12-03 21:45:14 +0000180 size_t use_len = len;
181 const unsigned char *p = data;
Jaeden Amero66954e12018-01-25 16:05:54 +0000182 int ret = 0;
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184 if( use_len > MBEDTLS_ENTROPY_BLOCK_SIZE )
Paul Bakker6083fd22011-12-03 21:45:14 +0000185 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100187 if( ( ret = mbedtls_sha512_ret( data, len, tmp, 0 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000188 goto cleanup;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200189#else
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100190 if( ( ret = mbedtls_sha256_ret( data, len, tmp, 0 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000191 goto cleanup;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200192#endif
Paul Bakker6083fd22011-12-03 21:45:14 +0000193 p = tmp;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194 use_len = MBEDTLS_ENTROPY_BLOCK_SIZE;
Paul Bakker6083fd22011-12-03 21:45:14 +0000195 }
196
197 header[0] = source_id;
198 header[1] = use_len & 0xFF;
199
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100200 /*
201 * Start the accumulator if this has not already happened. Note that
202 * it is sufficient to start the accumulator here only because all calls to
203 * gather entropy eventually execute this code.
204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200205#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100206 if( ctx->accumulator_started == 0 &&
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100207 ( ret = mbedtls_sha512_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_sha512_update_ret( &ctx->accumulator, header, 2 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000212 goto cleanup;
213 ret = mbedtls_sha512_update_ret( &ctx->accumulator, p, use_len );
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200214#else
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100215 if( ctx->accumulator_started == 0 &&
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100216 ( ret = mbedtls_sha256_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000217 goto cleanup;
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100218 else
219 ctx->accumulator_started = 1;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100220 if( ( ret = mbedtls_sha256_update_ret( &ctx->accumulator, header, 2 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000221 goto cleanup;
222 ret = mbedtls_sha256_update_ret( &ctx->accumulator, p, use_len );
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200223#endif
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200224
Jaeden Amero66954e12018-01-25 16:05:54 +0000225cleanup:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500226 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Andres Amaya Garcia65121932017-07-05 15:45:47 +0100227
Jaeden Amero66954e12018-01-25 16:05:54 +0000228 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000229}
230
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231int mbedtls_entropy_update_manual( mbedtls_entropy_context *ctx,
Paul Bakker6083fd22011-12-03 21:45:14 +0000232 const unsigned char *data, size_t len )
233{
Janos Follath24eed8d2019-11-22 13:21:35 +0000234 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker47703a02014-02-06 15:01:20 +0100235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236#if defined(MBEDTLS_THREADING_C)
237 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakker47703a02014-02-06 15:01:20 +0100238 return( ret );
239#endif
240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241 ret = entropy_update( ctx, MBEDTLS_ENTROPY_SOURCE_MANUAL, data, len );
Paul Bakker47703a02014-02-06 15:01:20 +0100242
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243#if defined(MBEDTLS_THREADING_C)
244 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
245 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakker47703a02014-02-06 15:01:20 +0100246#endif
247
Paul Bakkerd8bb8262014-06-17 14:06:49 +0200248 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000249}
250
251/*
252 * Run through the different sources to add entropy to our accumulator
253 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254static int entropy_gather_internal( mbedtls_entropy_context *ctx )
Paul Bakker6083fd22011-12-03 21:45:14 +0000255{
Gilles Peskine006c1b52019-09-30 17:29:54 +0200256 int ret = MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
257 int i;
258 int have_one_strong = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259 unsigned char buf[MBEDTLS_ENTROPY_MAX_GATHER];
Paul Bakker6083fd22011-12-03 21:45:14 +0000260 size_t olen;
Paul Bakker47703a02014-02-06 15:01:20 +0100261
Paul Bakker43655f42011-12-15 20:11:16 +0000262 if( ctx->source_count == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200263 return( MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED );
Paul Bakker43655f42011-12-15 20:11:16 +0000264
Paul Bakker6083fd22011-12-03 21:45:14 +0000265 /*
266 * Run through our entropy sources
267 */
268 for( i = 0; i < ctx->source_count; i++ )
269 {
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200270 if( ctx->source[i].strong == MBEDTLS_ENTROPY_SOURCE_STRONG )
271 have_one_strong = 1;
272
Paul Bakker6083fd22011-12-03 21:45:14 +0000273 olen = 0;
Paul Bakker66d5d072014-06-17 16:39:18 +0200274 if( ( ret = ctx->source[i].f_source( ctx->source[i].p_source,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275 buf, MBEDTLS_ENTROPY_MAX_GATHER, &olen ) ) != 0 )
Paul Bakker6083fd22011-12-03 21:45:14 +0000276 {
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100277 goto cleanup;
Paul Bakker6083fd22011-12-03 21:45:14 +0000278 }
279
280 /*
281 * Add if we actually gathered something
282 */
283 if( olen > 0 )
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000284 {
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100285 if( ( ret = entropy_update( ctx, (unsigned char) i,
286 buf, olen ) ) != 0 )
287 return( ret );
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000288 ctx->source[i].size += olen;
289 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000290 }
291
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200292 if( have_one_strong == 0 )
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100293 ret = MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE;
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200294
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100295cleanup:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500296 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100297
298 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000299}
300
Paul Bakker47703a02014-02-06 15:01:20 +0100301/*
302 * Thread-safe wrapper for entropy_gather_internal()
303 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304int mbedtls_entropy_gather( mbedtls_entropy_context *ctx )
Paul Bakker47703a02014-02-06 15:01:20 +0100305{
Janos Follath24eed8d2019-11-22 13:21:35 +0000306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Paul Bakker47703a02014-02-06 15:01:20 +0100307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308#if defined(MBEDTLS_THREADING_C)
309 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakkerddd427a2014-04-09 14:47:58 +0200310 return( ret );
Paul Bakker47703a02014-02-06 15:01:20 +0100311#endif
312
Paul Bakkerddd427a2014-04-09 14:47:58 +0200313 ret = entropy_gather_internal( ctx );
Paul Bakker47703a02014-02-06 15:01:20 +0100314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315#if defined(MBEDTLS_THREADING_C)
316 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
317 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakker47703a02014-02-06 15:01:20 +0100318#endif
319
Paul Bakkerddd427a2014-04-09 14:47:58 +0200320 return( ret );
Paul Bakker47703a02014-02-06 15:01:20 +0100321}
322
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200323int mbedtls_entropy_func( void *data, unsigned char *output, size_t len )
Paul Bakker6083fd22011-12-03 21:45:14 +0000324{
Gilles Peskine85485c72019-10-08 15:04:16 +0200325 int ret, count = 0, i, thresholds_reached;
326 size_t strong_size;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200327 mbedtls_entropy_context *ctx = (mbedtls_entropy_context *) data;
328 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakker6083fd22011-12-03 21:45:14 +0000329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330 if( len > MBEDTLS_ENTROPY_BLOCK_SIZE )
331 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
Paul Bakker6083fd22011-12-03 21:45:14 +0000332
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100333#if defined(MBEDTLS_ENTROPY_NV_SEED)
334 /* Update the NV entropy seed before generating any entropy for outside
335 * use.
336 */
Paul Bakkerfc9c7c82016-06-01 15:25:50 +0100337 if( ctx->initial_entropy_run == 0 )
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100338 {
Paul Bakkerfc9c7c82016-06-01 15:25:50 +0100339 ctx->initial_entropy_run = 1;
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100340 if( ( ret = mbedtls_entropy_update_nv_seed( ctx ) ) != 0 )
341 return( ret );
342 }
343#endif
344
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200345#if defined(MBEDTLS_THREADING_C)
346 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200347 return( ret );
348#endif
349
Paul Bakker6083fd22011-12-03 21:45:14 +0000350 /*
351 * Always gather extra entropy before a call
352 */
353 do
354 {
355 if( count++ > ENTROPY_MAX_LOOP )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200356 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357 ret = MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200358 goto exit;
359 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000360
Paul Bakker47703a02014-02-06 15:01:20 +0100361 if( ( ret = entropy_gather_internal( ctx ) ) != 0 )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200362 goto exit;
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000363
Gilles Peskine85485c72019-10-08 15:04:16 +0200364 thresholds_reached = 1;
365 strong_size = 0;
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000366 for( i = 0; i < ctx->source_count; i++ )
Gilles Peskine85485c72019-10-08 15:04:16 +0200367 {
Manuel Pégourié-Gonnardbf82ff02015-06-19 09:40:51 +0200368 if( ctx->source[i].size < ctx->source[i].threshold )
Gilles Peskine85485c72019-10-08 15:04:16 +0200369 thresholds_reached = 0;
370 if( ctx->source[i].strong == MBEDTLS_ENTROPY_SOURCE_STRONG )
371 strong_size += ctx->source[i].size;
372 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000373 }
Gilles Peskine85485c72019-10-08 15:04:16 +0200374 while( ! thresholds_reached || strong_size < MBEDTLS_ENTROPY_BLOCK_SIZE );
Paul Bakker6083fd22011-12-03 21:45:14 +0000375
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376 memset( buf, 0, MBEDTLS_ENTROPY_BLOCK_SIZE );
Paul Bakker6083fd22011-12-03 21:45:14 +0000377
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Andres Amaya Garciab2b063f2017-07-20 16:45:24 +0100379 /*
380 * Note that at this stage it is assumed that the accumulator was started
381 * in a previous call to entropy_update(). If this is not guaranteed, the
382 * code below will fail.
383 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100384 if( ( ret = mbedtls_sha512_finish_ret( &ctx->accumulator, buf ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100385 goto exit;
Paul Bakker9e36f042013-06-30 14:34:05 +0200386
Paul Bakker6083fd22011-12-03 21:45:14 +0000387 /*
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000388 * Reset accumulator and counters and recycle existing entropy
Paul Bakker6083fd22011-12-03 21:45:14 +0000389 */
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100390 mbedtls_sha512_free( &ctx->accumulator );
391 mbedtls_sha512_init( &ctx->accumulator );
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100392 if( ( ret = mbedtls_sha512_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100393 goto exit;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100394 if( ( ret = mbedtls_sha512_update_ret( &ctx->accumulator, buf,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100395 MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
396 goto exit;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200397
398 /*
Paul Bakkerb13d3ff2014-03-26 12:51:25 +0100399 * Perform second SHA-512 on entropy
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200400 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100401 if( ( ret = mbedtls_sha512_ret( buf, MBEDTLS_ENTROPY_BLOCK_SIZE,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100402 buf, 0 ) ) != 0 )
403 goto exit;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200404#else /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100405 if( ( ret = mbedtls_sha256_finish_ret( &ctx->accumulator, buf ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100406 goto exit;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200407
408 /*
409 * Reset accumulator and counters and recycle existing entropy
410 */
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100411 mbedtls_sha256_free( &ctx->accumulator );
412 mbedtls_sha256_init( &ctx->accumulator );
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100413 if( ( ret = mbedtls_sha256_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100414 goto exit;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100415 if( ( ret = mbedtls_sha256_update_ret( &ctx->accumulator, buf,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100416 MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
417 goto exit;
Paul Bakkerb13d3ff2014-03-26 12:51:25 +0100418
419 /*
420 * Perform second SHA-256 on entropy
421 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100422 if( ( ret = mbedtls_sha256_ret( buf, MBEDTLS_ENTROPY_BLOCK_SIZE,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100423 buf, 0 ) ) != 0 )
424 goto exit;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200425#endif /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000426
427 for( i = 0; i < ctx->source_count; i++ )
428 ctx->source[i].size = 0;
Paul Bakker6083fd22011-12-03 21:45:14 +0000429
430 memcpy( output, buf, len );
431
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200432 ret = 0;
433
434exit:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500435 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200437#if defined(MBEDTLS_THREADING_C)
438 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
439 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200440#endif
441
442 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000443}
444
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100445#if defined(MBEDTLS_ENTROPY_NV_SEED)
446int mbedtls_entropy_update_nv_seed( mbedtls_entropy_context *ctx )
447{
448 int ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
Andres Amaya Garciaaf0b31d2017-07-05 14:23:54 +0100449 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100450
451 /* Read new seed and write it to NV */
452 if( ( ret = mbedtls_entropy_func( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
453 return( ret );
454
455 if( mbedtls_nv_seed_write( buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) < 0 )
456 return( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR );
457
458 /* Manually update the remaining stream with a separator value to diverge */
459 memset( buf, 0, MBEDTLS_ENTROPY_BLOCK_SIZE );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100460 ret = mbedtls_entropy_update_manual( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE );
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100461
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100462 return( ret );
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100463}
464#endif /* MBEDTLS_ENTROPY_NV_SEED */
465
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200466#if defined(MBEDTLS_FS_IO)
467int mbedtls_entropy_write_seed_file( mbedtls_entropy_context *ctx, const char *path )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100468{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200469 int ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100470 FILE *f;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200471 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakker66ff70d2014-03-26 11:54:05 +0100472
473 if( ( f = fopen( path, "wb" ) ) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200474 return( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100475
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200476 if( ( ret = mbedtls_entropy_func( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100477 goto exit;
478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200479 if( fwrite( buf, 1, MBEDTLS_ENTROPY_BLOCK_SIZE, f ) != MBEDTLS_ENTROPY_BLOCK_SIZE )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100480 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200481 ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100482 goto exit;
483 }
484
485 ret = 0;
486
487exit:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500488 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100489
Paul Bakker66ff70d2014-03-26 11:54:05 +0100490 fclose( f );
491 return( ret );
492}
493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200494int mbedtls_entropy_update_seed_file( mbedtls_entropy_context *ctx, const char *path )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100495{
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100496 int ret = 0;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100497 FILE *f;
498 size_t n;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200499 unsigned char buf[ MBEDTLS_ENTROPY_MAX_SEED_SIZE ];
Paul Bakker66ff70d2014-03-26 11:54:05 +0100500
501 if( ( f = fopen( path, "rb" ) ) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200502 return( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100503
504 fseek( f, 0, SEEK_END );
505 n = (size_t) ftell( f );
506 fseek( f, 0, SEEK_SET );
507
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200508 if( n > MBEDTLS_ENTROPY_MAX_SEED_SIZE )
509 n = MBEDTLS_ENTROPY_MAX_SEED_SIZE;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100510
511 if( fread( buf, 1, n, f ) != n )
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100512 ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
513 else
514 ret = mbedtls_entropy_update_manual( ctx, buf, n );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100515
516 fclose( f );
517
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500518 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100519
520 if( ret != 0 )
521 return( ret );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200523 return( mbedtls_entropy_write_seed_file( ctx, path ) );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100524}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525#endif /* MBEDTLS_FS_IO */
Paul Bakker66ff70d2014-03-26 11:54:05 +0100526
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527#if defined(MBEDTLS_SELF_TEST)
Simon Butcher669c6352016-09-15 18:57:34 +0100528#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200529/*
530 * Dummy source function
531 */
532static int entropy_dummy_source( void *data, unsigned char *output,
533 size_t len, size_t *olen )
534{
535 ((void) data);
536
537 memset( output, 0x2a, len );
538 *olen = len;
539
540 return( 0 );
541}
Simon Butcher669c6352016-09-15 18:57:34 +0100542#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200543
Andres AGe7723ec2016-08-25 10:18:50 +0100544#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
Andres AGb34e42e2016-08-22 11:08:50 +0100545
Andres AGe7723ec2016-08-25 10:18:50 +0100546static int mbedtls_entropy_source_self_test_gather( unsigned char *buf, size_t buf_len )
547{
548 int ret = 0;
549 size_t entropy_len = 0;
550 size_t olen = 0;
551 size_t attempts = buf_len;
552
553 while( attempts > 0 && entropy_len < buf_len )
554 {
555 if( ( ret = mbedtls_hardware_poll( NULL, buf + entropy_len,
556 buf_len - entropy_len, &olen ) ) != 0 )
557 return( ret );
558
559 entropy_len += olen;
560 attempts--;
561 }
562
563 if( entropy_len < buf_len )
564 {
565 ret = 1;
566 }
567
568 return( ret );
569}
570
571
572static int mbedtls_entropy_source_self_test_check_bits( const unsigned char *buf,
573 size_t buf_len )
574{
575 unsigned char set= 0xFF;
576 unsigned char unset = 0x00;
577 size_t i;
578
579 for( i = 0; i < buf_len; i++ )
580 {
581 set &= buf[i];
582 unset |= buf[i];
583 }
584
585 return( set == 0xFF || unset == 0x00 );
586}
Andres AGb34e42e2016-08-22 11:08:50 +0100587
588/*
Andres AGe7723ec2016-08-25 10:18:50 +0100589 * A test to ensure hat the entropy sources are functioning correctly
590 * and there is no obvious failure. The test performs the following checks:
Andres AGb34e42e2016-08-22 11:08:50 +0100591 * - The entropy source is not providing only 0s (all bits unset) or 1s (all
592 * bits set).
593 * - The entropy source is not providing values in a pattern. Because the
Andres AGe7723ec2016-08-25 10:18:50 +0100594 * hardware could be providing data in an arbitrary length, this check polls
595 * the hardware entropy source twice and compares the result to ensure they
596 * are not equal.
Andres AGb34e42e2016-08-22 11:08:50 +0100597 * - The error code returned by the entropy source is not an error.
598 */
Andres AGe7723ec2016-08-25 10:18:50 +0100599int mbedtls_entropy_source_self_test( int verbose )
Andres AGb34e42e2016-08-22 11:08:50 +0100600{
601 int ret = 0;
Andres AGe7723ec2016-08-25 10:18:50 +0100602 unsigned char buf0[2 * sizeof( unsigned long long int )];
603 unsigned char buf1[2 * sizeof( unsigned long long int )];
Andres AGb34e42e2016-08-22 11:08:50 +0100604
605 if( verbose != 0 )
606 mbedtls_printf( " ENTROPY_BIAS test: " );
607
Andres AGe7723ec2016-08-25 10:18:50 +0100608 memset( buf0, 0x00, sizeof( buf0 ) );
609 memset( buf1, 0x00, sizeof( buf1 ) );
Andres AGb34e42e2016-08-22 11:08:50 +0100610
Andres AGe7723ec2016-08-25 10:18:50 +0100611 if( ( ret = mbedtls_entropy_source_self_test_gather( buf0, sizeof( buf0 ) ) ) != 0 )
Andres AGb34e42e2016-08-22 11:08:50 +0100612 goto cleanup;
Andres AGe7723ec2016-08-25 10:18:50 +0100613 if( ( ret = mbedtls_entropy_source_self_test_gather( buf1, sizeof( buf1 ) ) ) != 0 )
614 goto cleanup;
615
616 /* Make sure that the returned values are not all 0 or 1 */
617 if( ( ret = mbedtls_entropy_source_self_test_check_bits( buf0, sizeof( buf0 ) ) ) != 0 )
618 goto cleanup;
619 if( ( ret = mbedtls_entropy_source_self_test_check_bits( buf1, sizeof( buf1 ) ) ) != 0 )
620 goto cleanup;
Andres AGb34e42e2016-08-22 11:08:50 +0100621
622 /* Make sure that the entropy source is not returning values in a
623 * pattern */
Andres AGe7723ec2016-08-25 10:18:50 +0100624 ret = memcmp( buf0, buf1, sizeof( buf0 ) ) == 0;
Andres AGb34e42e2016-08-22 11:08:50 +0100625
626cleanup:
Andres AGb34e42e2016-08-22 11:08:50 +0100627 if( verbose != 0 )
628 {
629 if( ret != 0 )
630 mbedtls_printf( "failed\n" );
631 else
632 mbedtls_printf( "passed\n" );
633
634 mbedtls_printf( "\n" );
635 }
636
637 return( ret != 0 );
638}
Andres AGe7723ec2016-08-25 10:18:50 +0100639
640#endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
Andres AGb34e42e2016-08-22 11:08:50 +0100641
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200642/*
643 * The actual entropy quality is hard to test, but we can at least
644 * test that the functions don't cause errors and write the correct
645 * amount of data to buffers.
646 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200647int mbedtls_entropy_self_test( int verbose )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200648{
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100649 int ret = 1;
Simon Butcher669c6352016-09-15 18:57:34 +0100650#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651 mbedtls_entropy_context ctx;
652 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE] = { 0 };
653 unsigned char acc[MBEDTLS_ENTROPY_BLOCK_SIZE] = { 0 };
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200654 size_t i, j;
Simon Butcher669c6352016-09-15 18:57:34 +0100655#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200656
657 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200658 mbedtls_printf( " ENTROPY test: " );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200659
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100660#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661 mbedtls_entropy_init( &ctx );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200662
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200663 /* First do a gather to make sure we have default sources */
Manuel Pégourié-Gonnarde94bfe62015-05-14 13:57:50 +0200664 if( ( ret = mbedtls_entropy_gather( &ctx ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200665 goto cleanup;
666
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200667 ret = mbedtls_entropy_add_source( &ctx, entropy_dummy_source, NULL, 16,
668 MBEDTLS_ENTROPY_SOURCE_WEAK );
Manuel Pégourié-Gonnarde94bfe62015-05-14 13:57:50 +0200669 if( ret != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200670 goto cleanup;
671
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672 if( ( ret = mbedtls_entropy_update_manual( &ctx, buf, sizeof buf ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200673 goto cleanup;
674
675 /*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200676 * To test that mbedtls_entropy_func writes correct number of bytes:
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200677 * - use the whole buffer and rely on ASan to detect overruns
678 * - collect entropy 8 times and OR the result in an accumulator:
679 * any byte should then be 0 with probably 2^(-64), so requiring
680 * each of the 32 or 64 bytes to be non-zero has a false failure rate
681 * of at most 2^(-58) which is acceptable.
682 */
683 for( i = 0; i < 8; i++ )
684 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200685 if( ( ret = mbedtls_entropy_func( &ctx, buf, sizeof( buf ) ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200686 goto cleanup;
687
688 for( j = 0; j < sizeof( buf ); j++ )
689 acc[j] |= buf[j];
690 }
691
692 for( j = 0; j < sizeof( buf ); j++ )
693 {
694 if( acc[j] == 0 )
695 {
696 ret = 1;
697 goto cleanup;
698 }
699 }
700
Andres AGe7723ec2016-08-25 10:18:50 +0100701#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
702 if( ( ret = mbedtls_entropy_source_self_test( 0 ) ) != 0 )
703 goto cleanup;
704#endif
705
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200706cleanup:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200707 mbedtls_entropy_free( &ctx );
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100708#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200709
710 if( verbose != 0 )
711 {
712 if( ret != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200713 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200714 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715 mbedtls_printf( "passed\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200716
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200717 mbedtls_printf( "\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200718 }
719
720 return( ret != 0 );
721}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722#endif /* MBEDTLS_SELF_TEST */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200723
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724#endif /* MBEDTLS_ENTROPY_C */