blob: 565525396a6c642408605e2b6348e567ae9bf4ad [file] [log] [blame]
Paul Bakker6083fd22011-12-03 21:45:14 +00001/*
2 * Entropy accumulator implementation
3 *
Paul Bakker9988d6b2016-06-01 11:29:42 +01004 * Copyright (C) 2006-2016, ARM Limited, All Rights Reserved
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 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000019 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker6083fd22011-12-03 21:45:14 +000020 */
21
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#if !defined(MBEDTLS_CONFIG_FILE)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000023#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020024#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020025#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020026#endif
Paul Bakker6083fd22011-12-03 21:45:14 +000027
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020028#if defined(MBEDTLS_ENTROPY_C)
Paul Bakker6083fd22011-12-03 21:45:14 +000029
Simon Butcherab5df402016-06-11 02:31:21 +010030#if defined(MBEDTLS_TEST_NULL_ENTROPY)
Simon Butcher1ceab6e2016-06-21 10:14:00 +010031#warning "**** WARNING! MBEDTLS_TEST_NULL_ENTROPY defined! "
32#warning "**** THIS BUILD HAS NO DEFINED ENTROPY SOURCES "
33#warning "**** THIS BUILD IS *NOT* SUITABLE FOR PRODUCTION USE "
Simon Butcherab5df402016-06-11 02:31:21 +010034#endif
35
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/entropy.h"
37#include "mbedtls/entropy_poll.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050038#include "mbedtls/platform_util.h"
Paul Bakker6083fd22011-12-03 21:45:14 +000039
Rich Evans00ab4702015-02-06 13:43:58 +000040#include <string.h>
41
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020042#if defined(MBEDTLS_FS_IO)
Paul Bakker66ff70d2014-03-26 11:54:05 +010043#include <stdio.h>
44#endif
45
Paul Bakker217efbc2016-07-14 14:30:03 +010046#if defined(MBEDTLS_ENTROPY_NV_SEED)
47#include "mbedtls/platform.h"
48#endif
49
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#if defined(MBEDTLS_SELF_TEST)
51#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000052#include "mbedtls/platform.h"
Rich Evans00ab4702015-02-06 13:43:58 +000053#else
54#include <stdio.h>
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020055#define mbedtls_printf printf
56#endif /* MBEDTLS_PLATFORM_C */
57#endif /* MBEDTLS_SELF_TEST */
Rich Evans00ab4702015-02-06 13:43:58 +000058
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020059#if defined(MBEDTLS_HAVEGE_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000060#include "mbedtls/havege.h"
Paul Bakker28c7e7f2011-12-15 19:49:30 +000061#endif
62
Paul Bakker6083fd22011-12-03 21:45:14 +000063#define ENTROPY_MAX_LOOP 256 /**< Maximum amount to loop before error */
64
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065void mbedtls_entropy_init( mbedtls_entropy_context *ctx )
Paul Bakker6083fd22011-12-03 21:45:14 +000066{
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +010067 ctx->source_count = 0;
68 memset( ctx->source, 0, sizeof( ctx->source ) );
Paul Bakker6083fd22011-12-03 21:45:14 +000069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070#if defined(MBEDTLS_THREADING_C)
71 mbedtls_mutex_init( &ctx->mutex );
Paul Bakkerf4e7dc52013-09-28 15:23:57 +020072#endif
73
Andres Amaya Garcia95869c42017-06-29 16:31:44 +010074 ctx->accumulator_started = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020075#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +010076 mbedtls_sha512_init( &ctx->accumulator );
Paul Bakkerfb08fd22013-08-27 15:06:26 +020077#else
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +010078 mbedtls_sha256_init( &ctx->accumulator );
Paul Bakkerfb08fd22013-08-27 15:06:26 +020079#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020080#if defined(MBEDTLS_HAVEGE_C)
81 mbedtls_havege_init( &ctx->havege_data );
Paul Bakker43655f42011-12-15 20:11:16 +000082#endif
Paul Bakker6083fd22011-12-03 21:45:14 +000083
Hanno Beckerd4a872e2017-09-07 08:09:33 +010084 /* Reminder: Update ENTROPY_HAVE_STRONG in the test files
Hanno Becker47deec42017-07-24 12:27:09 +010085 * when adding more strong entropy sources here. */
Hanno Beckerc6deafc2017-07-23 14:06:42 +010086
Simon Butcherab5df402016-06-11 02:31:21 +010087#if defined(MBEDTLS_TEST_NULL_ENTROPY)
Simon Butcher4157b602016-06-12 00:31:33 +010088 mbedtls_entropy_add_source( ctx, mbedtls_null_entropy_poll, NULL,
Janos Follath53de7842016-06-08 15:29:18 +010089 1, MBEDTLS_ENTROPY_SOURCE_STRONG );
90#endif
91
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020092#if !defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
93#if !defined(MBEDTLS_NO_PLATFORM_ENTROPY)
94 mbedtls_entropy_add_source( ctx, mbedtls_platform_entropy_poll, NULL,
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +020095 MBEDTLS_ENTROPY_MIN_PLATFORM,
96 MBEDTLS_ENTROPY_SOURCE_STRONG );
Paul Bakker6083fd22011-12-03 21:45:14 +000097#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020098#if defined(MBEDTLS_TIMING_C)
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +020099 mbedtls_entropy_add_source( ctx, mbedtls_hardclock_poll, NULL,
100 MBEDTLS_ENTROPY_MIN_HARDCLOCK,
101 MBEDTLS_ENTROPY_SOURCE_WEAK );
Paul Bakker6083fd22011-12-03 21:45:14 +0000102#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103#if defined(MBEDTLS_HAVEGE_C)
104 mbedtls_entropy_add_source( ctx, mbedtls_havege_poll, &ctx->havege_data,
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200105 MBEDTLS_ENTROPY_MIN_HAVEGE,
106 MBEDTLS_ENTROPY_SOURCE_STRONG );
Paul Bakker28c7e7f2011-12-15 19:49:30 +0000107#endif
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200108#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
Manuel Pégourié-Gonnardfc2ccfe2015-07-10 11:15:50 +0100109 mbedtls_entropy_add_source( ctx, mbedtls_hardware_poll, NULL,
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200110 MBEDTLS_ENTROPY_MIN_HARDWARE,
111 MBEDTLS_ENTROPY_SOURCE_STRONG );
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200112#endif
Paul Bakker9988d6b2016-06-01 11:29:42 +0100113#if defined(MBEDTLS_ENTROPY_NV_SEED)
114 mbedtls_entropy_add_source( ctx, mbedtls_nv_seed_poll, NULL,
115 MBEDTLS_ENTROPY_BLOCK_SIZE,
116 MBEDTLS_ENTROPY_SOURCE_STRONG );
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100117 ctx->initial_entropy_run = 0;
Paul Bakker9988d6b2016-06-01 11:29:42 +0100118#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200119#endif /* MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES */
Paul Bakker6083fd22011-12-03 21:45:14 +0000120}
121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200122void mbedtls_entropy_free( mbedtls_entropy_context *ctx )
Paul Bakker1ffefac2013-09-28 15:23:03 +0200123{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200124#if defined(MBEDTLS_HAVEGE_C)
125 mbedtls_havege_free( &ctx->havege_data );
Paul Bakkera317a982014-06-18 16:44:11 +0200126#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200127#if defined(MBEDTLS_THREADING_C)
128 mbedtls_mutex_free( &ctx->mutex );
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200129#endif
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100130#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
131 mbedtls_sha512_free( &ctx->accumulator );
132#else
133 mbedtls_sha256_free( &ctx->accumulator );
134#endif
135#if defined(MBEDTLS_ENTROPY_NV_SEED)
136 ctx->initial_entropy_run = 0;
137#endif
138 ctx->source_count = 0;
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500139 mbedtls_platform_zeroize( ctx->source, sizeof( ctx->source ) );
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100140 ctx->accumulator_started = 0;
Paul Bakker1ffefac2013-09-28 15:23:03 +0200141}
142
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200143int mbedtls_entropy_add_source( mbedtls_entropy_context *ctx,
144 mbedtls_entropy_f_source_ptr f_source, void *p_source,
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200145 size_t threshold, int strong )
Paul Bakker6083fd22011-12-03 21:45:14 +0000146{
Hanno Becker61937d42017-04-26 15:01:23 +0100147 int idx, ret = 0;
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000148
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200149#if defined(MBEDTLS_THREADING_C)
150 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakker47703a02014-02-06 15:01:20 +0100151 return( ret );
152#endif
153
Hanno Becker61937d42017-04-26 15:01:23 +0100154 idx = ctx->source_count;
155 if( idx >= MBEDTLS_ENTROPY_MAX_SOURCES )
Paul Bakker47703a02014-02-06 15:01:20 +0100156 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200157 ret = MBEDTLS_ERR_ENTROPY_MAX_SOURCES;
Paul Bakker47703a02014-02-06 15:01:20 +0100158 goto exit;
159 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000160
Hanno Becker61937d42017-04-26 15:01:23 +0100161 ctx->source[idx].f_source = f_source;
162 ctx->source[idx].p_source = p_source;
163 ctx->source[idx].threshold = threshold;
164 ctx->source[idx].strong = strong;
Paul Bakker6083fd22011-12-03 21:45:14 +0000165
166 ctx->source_count++;
167
Paul Bakker47703a02014-02-06 15:01:20 +0100168exit:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169#if defined(MBEDTLS_THREADING_C)
170 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
171 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakker47703a02014-02-06 15:01:20 +0100172#endif
173
174 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000175}
176
177/*
178 * Entropy accumulator update
179 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180static int entropy_update( mbedtls_entropy_context *ctx, unsigned char source_id,
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200181 const unsigned char *data, size_t len )
Paul Bakker6083fd22011-12-03 21:45:14 +0000182{
183 unsigned char header[2];
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184 unsigned char tmp[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakker6083fd22011-12-03 21:45:14 +0000185 size_t use_len = len;
186 const unsigned char *p = data;
Jaeden Amero66954e12018-01-25 16:05:54 +0000187 int ret = 0;
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189 if( use_len > MBEDTLS_ENTROPY_BLOCK_SIZE )
Paul Bakker6083fd22011-12-03 21:45:14 +0000190 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200191#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100192 if( ( ret = mbedtls_sha512_ret( data, len, tmp, 0 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000193 goto cleanup;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200194#else
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100195 if( ( ret = mbedtls_sha256_ret( data, len, tmp, 0 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000196 goto cleanup;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200197#endif
Paul Bakker6083fd22011-12-03 21:45:14 +0000198 p = tmp;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199 use_len = MBEDTLS_ENTROPY_BLOCK_SIZE;
Paul Bakker6083fd22011-12-03 21:45:14 +0000200 }
201
202 header[0] = source_id;
203 header[1] = use_len & 0xFF;
204
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100205 /*
206 * Start the accumulator if this has not already happened. Note that
207 * it is sufficient to start the accumulator here only because all calls to
208 * gather entropy eventually execute this code.
209 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200210#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100211 if( ctx->accumulator_started == 0 &&
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100212 ( ret = mbedtls_sha512_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000213 goto cleanup;
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100214 else
215 ctx->accumulator_started = 1;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100216 if( ( ret = mbedtls_sha512_update_ret( &ctx->accumulator, header, 2 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000217 goto cleanup;
218 ret = mbedtls_sha512_update_ret( &ctx->accumulator, p, use_len );
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200219#else
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100220 if( ctx->accumulator_started == 0 &&
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100221 ( ret = mbedtls_sha256_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000222 goto cleanup;
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100223 else
224 ctx->accumulator_started = 1;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100225 if( ( ret = mbedtls_sha256_update_ret( &ctx->accumulator, header, 2 ) ) != 0 )
Jaeden Amero66954e12018-01-25 16:05:54 +0000226 goto cleanup;
227 ret = mbedtls_sha256_update_ret( &ctx->accumulator, p, use_len );
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200228#endif
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200229
Jaeden Amero66954e12018-01-25 16:05:54 +0000230cleanup:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500231 mbedtls_platform_zeroize( tmp, sizeof( tmp ) );
Andres Amaya Garcia65121932017-07-05 15:45:47 +0100232
Jaeden Amero66954e12018-01-25 16:05:54 +0000233 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000234}
235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200236int mbedtls_entropy_update_manual( mbedtls_entropy_context *ctx,
Paul Bakker6083fd22011-12-03 21:45:14 +0000237 const unsigned char *data, size_t len )
238{
Paul Bakker47703a02014-02-06 15:01:20 +0100239 int ret;
240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#if defined(MBEDTLS_THREADING_C)
242 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakker47703a02014-02-06 15:01:20 +0100243 return( ret );
244#endif
245
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246 ret = entropy_update( ctx, MBEDTLS_ENTROPY_SOURCE_MANUAL, data, len );
Paul Bakker47703a02014-02-06 15:01:20 +0100247
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200248#if defined(MBEDTLS_THREADING_C)
249 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
250 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakker47703a02014-02-06 15:01:20 +0100251#endif
252
Paul Bakkerd8bb8262014-06-17 14:06:49 +0200253 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000254}
255
256/*
257 * Run through the different sources to add entropy to our accumulator
258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259static int entropy_gather_internal( mbedtls_entropy_context *ctx )
Paul Bakker6083fd22011-12-03 21:45:14 +0000260{
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200261 int ret, i, have_one_strong = 0;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262 unsigned char buf[MBEDTLS_ENTROPY_MAX_GATHER];
Paul Bakker6083fd22011-12-03 21:45:14 +0000263 size_t olen;
Paul Bakker47703a02014-02-06 15:01:20 +0100264
Paul Bakker43655f42011-12-15 20:11:16 +0000265 if( ctx->source_count == 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200266 return( MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED );
Paul Bakker43655f42011-12-15 20:11:16 +0000267
Paul Bakker6083fd22011-12-03 21:45:14 +0000268 /*
269 * Run through our entropy sources
270 */
271 for( i = 0; i < ctx->source_count; i++ )
272 {
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200273 if( ctx->source[i].strong == MBEDTLS_ENTROPY_SOURCE_STRONG )
274 have_one_strong = 1;
275
Paul Bakker6083fd22011-12-03 21:45:14 +0000276 olen = 0;
Paul Bakker66d5d072014-06-17 16:39:18 +0200277 if( ( ret = ctx->source[i].f_source( ctx->source[i].p_source,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200278 buf, MBEDTLS_ENTROPY_MAX_GATHER, &olen ) ) != 0 )
Paul Bakker6083fd22011-12-03 21:45:14 +0000279 {
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100280 goto cleanup;
Paul Bakker6083fd22011-12-03 21:45:14 +0000281 }
282
283 /*
284 * Add if we actually gathered something
285 */
286 if( olen > 0 )
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000287 {
Andres Amaya Garcia95869c42017-06-29 16:31:44 +0100288 if( ( ret = entropy_update( ctx, (unsigned char) i,
289 buf, olen ) ) != 0 )
290 return( ret );
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000291 ctx->source[i].size += olen;
292 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000293 }
294
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200295 if( have_one_strong == 0 )
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100296 ret = MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE;
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200297
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100298cleanup:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500299 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100300
301 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000302}
303
Paul Bakker47703a02014-02-06 15:01:20 +0100304/*
305 * Thread-safe wrapper for entropy_gather_internal()
306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200307int mbedtls_entropy_gather( mbedtls_entropy_context *ctx )
Paul Bakker47703a02014-02-06 15:01:20 +0100308{
Paul Bakkerddd427a2014-04-09 14:47:58 +0200309 int ret;
Paul Bakker47703a02014-02-06 15:01:20 +0100310
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200311#if defined(MBEDTLS_THREADING_C)
312 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakkerddd427a2014-04-09 14:47:58 +0200313 return( ret );
Paul Bakker47703a02014-02-06 15:01:20 +0100314#endif
315
Paul Bakkerddd427a2014-04-09 14:47:58 +0200316 ret = entropy_gather_internal( ctx );
Paul Bakker47703a02014-02-06 15:01:20 +0100317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318#if defined(MBEDTLS_THREADING_C)
319 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
320 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakker47703a02014-02-06 15:01:20 +0100321#endif
322
Paul Bakkerddd427a2014-04-09 14:47:58 +0200323 return( ret );
Paul Bakker47703a02014-02-06 15:01:20 +0100324}
325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200326int mbedtls_entropy_func( void *data, unsigned char *output, size_t len )
Paul Bakker6083fd22011-12-03 21:45:14 +0000327{
Gilles Peskine85485c72019-10-08 15:04:16 +0200328 int ret, count = 0, i, thresholds_reached;
329 size_t strong_size;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330 mbedtls_entropy_context *ctx = (mbedtls_entropy_context *) data;
331 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakker6083fd22011-12-03 21:45:14 +0000332
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200333 if( len > MBEDTLS_ENTROPY_BLOCK_SIZE )
334 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
Paul Bakker6083fd22011-12-03 21:45:14 +0000335
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100336#if defined(MBEDTLS_ENTROPY_NV_SEED)
337 /* Update the NV entropy seed before generating any entropy for outside
338 * use.
339 */
Paul Bakkerfc9c7c82016-06-01 15:25:50 +0100340 if( ctx->initial_entropy_run == 0 )
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100341 {
Paul Bakkerfc9c7c82016-06-01 15:25:50 +0100342 ctx->initial_entropy_run = 1;
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100343 if( ( ret = mbedtls_entropy_update_nv_seed( ctx ) ) != 0 )
344 return( ret );
345 }
346#endif
347
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200348#if defined(MBEDTLS_THREADING_C)
349 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200350 return( ret );
351#endif
352
Paul Bakker6083fd22011-12-03 21:45:14 +0000353 /*
354 * Always gather extra entropy before a call
355 */
356 do
357 {
358 if( count++ > ENTROPY_MAX_LOOP )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200359 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360 ret = MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200361 goto exit;
362 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000363
Paul Bakker47703a02014-02-06 15:01:20 +0100364 if( ( ret = entropy_gather_internal( ctx ) ) != 0 )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200365 goto exit;
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000366
Gilles Peskine85485c72019-10-08 15:04:16 +0200367 thresholds_reached = 1;
368 strong_size = 0;
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000369 for( i = 0; i < ctx->source_count; i++ )
Gilles Peskine85485c72019-10-08 15:04:16 +0200370 {
Manuel Pégourié-Gonnardbf82ff02015-06-19 09:40:51 +0200371 if( ctx->source[i].size < ctx->source[i].threshold )
Gilles Peskine85485c72019-10-08 15:04:16 +0200372 thresholds_reached = 0;
373 if( ctx->source[i].strong == MBEDTLS_ENTROPY_SOURCE_STRONG )
374 strong_size += ctx->source[i].size;
375 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000376 }
Gilles Peskine85485c72019-10-08 15:04:16 +0200377 while( ! thresholds_reached || strong_size < MBEDTLS_ENTROPY_BLOCK_SIZE );
Paul Bakker6083fd22011-12-03 21:45:14 +0000378
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200379 memset( buf, 0, MBEDTLS_ENTROPY_BLOCK_SIZE );
Paul Bakker6083fd22011-12-03 21:45:14 +0000380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200381#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Andres Amaya Garciab2b063f2017-07-20 16:45:24 +0100382 /*
383 * Note that at this stage it is assumed that the accumulator was started
384 * in a previous call to entropy_update(). If this is not guaranteed, the
385 * code below will fail.
386 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100387 if( ( ret = mbedtls_sha512_finish_ret( &ctx->accumulator, buf ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100388 goto exit;
Paul Bakker9e36f042013-06-30 14:34:05 +0200389
Paul Bakker6083fd22011-12-03 21:45:14 +0000390 /*
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000391 * Reset accumulator and counters and recycle existing entropy
Paul Bakker6083fd22011-12-03 21:45:14 +0000392 */
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100393 mbedtls_sha512_free( &ctx->accumulator );
394 mbedtls_sha512_init( &ctx->accumulator );
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100395 if( ( ret = mbedtls_sha512_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100396 goto exit;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100397 if( ( ret = mbedtls_sha512_update_ret( &ctx->accumulator, buf,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100398 MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
399 goto exit;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200400
401 /*
Paul Bakkerb13d3ff2014-03-26 12:51:25 +0100402 * Perform second SHA-512 on entropy
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200403 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100404 if( ( ret = mbedtls_sha512_ret( buf, MBEDTLS_ENTROPY_BLOCK_SIZE,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100405 buf, 0 ) ) != 0 )
406 goto exit;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200407#else /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100408 if( ( ret = mbedtls_sha256_finish_ret( &ctx->accumulator, buf ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100409 goto exit;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200410
411 /*
412 * Reset accumulator and counters and recycle existing entropy
413 */
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100414 mbedtls_sha256_free( &ctx->accumulator );
415 mbedtls_sha256_init( &ctx->accumulator );
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100416 if( ( ret = mbedtls_sha256_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100417 goto exit;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100418 if( ( ret = mbedtls_sha256_update_ret( &ctx->accumulator, buf,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100419 MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
420 goto exit;
Paul Bakkerb13d3ff2014-03-26 12:51:25 +0100421
422 /*
423 * Perform second SHA-256 on entropy
424 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100425 if( ( ret = mbedtls_sha256_ret( buf, MBEDTLS_ENTROPY_BLOCK_SIZE,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100426 buf, 0 ) ) != 0 )
427 goto exit;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200428#endif /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000429
430 for( i = 0; i < ctx->source_count; i++ )
431 ctx->source[i].size = 0;
Paul Bakker6083fd22011-12-03 21:45:14 +0000432
433 memcpy( output, buf, len );
434
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200435 ret = 0;
436
437exit:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500438 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100439
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200440#if defined(MBEDTLS_THREADING_C)
441 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
442 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200443#endif
444
445 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000446}
447
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100448#if defined(MBEDTLS_ENTROPY_NV_SEED)
449int mbedtls_entropy_update_nv_seed( mbedtls_entropy_context *ctx )
450{
451 int ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
Andres Amaya Garciaaf0b31d2017-07-05 14:23:54 +0100452 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100453
454 /* Read new seed and write it to NV */
455 if( ( ret = mbedtls_entropy_func( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
456 return( ret );
457
458 if( mbedtls_nv_seed_write( buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) < 0 )
459 return( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR );
460
461 /* Manually update the remaining stream with a separator value to diverge */
462 memset( buf, 0, MBEDTLS_ENTROPY_BLOCK_SIZE );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100463 ret = mbedtls_entropy_update_manual( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE );
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100464
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100465 return( ret );
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100466}
467#endif /* MBEDTLS_ENTROPY_NV_SEED */
468
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200469#if defined(MBEDTLS_FS_IO)
470int mbedtls_entropy_write_seed_file( mbedtls_entropy_context *ctx, const char *path )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100471{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200472 int ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100473 FILE *f;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200474 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakker66ff70d2014-03-26 11:54:05 +0100475
476 if( ( f = fopen( path, "wb" ) ) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200477 return( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200479 if( ( ret = mbedtls_entropy_func( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100480 goto exit;
481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482 if( fwrite( buf, 1, MBEDTLS_ENTROPY_BLOCK_SIZE, f ) != MBEDTLS_ENTROPY_BLOCK_SIZE )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100483 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484 ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100485 goto exit;
486 }
487
488 ret = 0;
489
490exit:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500491 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100492
Paul Bakker66ff70d2014-03-26 11:54:05 +0100493 fclose( f );
494 return( ret );
495}
496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200497int mbedtls_entropy_update_seed_file( mbedtls_entropy_context *ctx, const char *path )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100498{
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100499 int ret = 0;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100500 FILE *f;
501 size_t n;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200502 unsigned char buf[ MBEDTLS_ENTROPY_MAX_SEED_SIZE ];
Paul Bakker66ff70d2014-03-26 11:54:05 +0100503
504 if( ( f = fopen( path, "rb" ) ) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200505 return( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100506
507 fseek( f, 0, SEEK_END );
508 n = (size_t) ftell( f );
509 fseek( f, 0, SEEK_SET );
510
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200511 if( n > MBEDTLS_ENTROPY_MAX_SEED_SIZE )
512 n = MBEDTLS_ENTROPY_MAX_SEED_SIZE;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100513
514 if( fread( buf, 1, n, f ) != n )
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100515 ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
516 else
517 ret = mbedtls_entropy_update_manual( ctx, buf, n );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100518
519 fclose( f );
520
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500521 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100522
523 if( ret != 0 )
524 return( ret );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100525
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526 return( mbedtls_entropy_write_seed_file( ctx, path ) );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100527}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200528#endif /* MBEDTLS_FS_IO */
Paul Bakker66ff70d2014-03-26 11:54:05 +0100529
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200530#if defined(MBEDTLS_SELF_TEST)
Simon Butcher669c6352016-09-15 18:57:34 +0100531#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200532/*
533 * Dummy source function
534 */
535static int entropy_dummy_source( void *data, unsigned char *output,
536 size_t len, size_t *olen )
537{
538 ((void) data);
539
540 memset( output, 0x2a, len );
541 *olen = len;
542
543 return( 0 );
544}
Simon Butcher669c6352016-09-15 18:57:34 +0100545#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200546
Andres AGe7723ec2016-08-25 10:18:50 +0100547#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
Andres AGb34e42e2016-08-22 11:08:50 +0100548
Andres AGe7723ec2016-08-25 10:18:50 +0100549static int mbedtls_entropy_source_self_test_gather( unsigned char *buf, size_t buf_len )
550{
551 int ret = 0;
552 size_t entropy_len = 0;
553 size_t olen = 0;
554 size_t attempts = buf_len;
555
556 while( attempts > 0 && entropy_len < buf_len )
557 {
558 if( ( ret = mbedtls_hardware_poll( NULL, buf + entropy_len,
559 buf_len - entropy_len, &olen ) ) != 0 )
560 return( ret );
561
562 entropy_len += olen;
563 attempts--;
564 }
565
566 if( entropy_len < buf_len )
567 {
568 ret = 1;
569 }
570
571 return( ret );
572}
573
574
575static int mbedtls_entropy_source_self_test_check_bits( const unsigned char *buf,
576 size_t buf_len )
577{
578 unsigned char set= 0xFF;
579 unsigned char unset = 0x00;
580 size_t i;
581
582 for( i = 0; i < buf_len; i++ )
583 {
584 set &= buf[i];
585 unset |= buf[i];
586 }
587
588 return( set == 0xFF || unset == 0x00 );
589}
Andres AGb34e42e2016-08-22 11:08:50 +0100590
591/*
Andres AGe7723ec2016-08-25 10:18:50 +0100592 * A test to ensure hat the entropy sources are functioning correctly
593 * and there is no obvious failure. The test performs the following checks:
Andres AGb34e42e2016-08-22 11:08:50 +0100594 * - The entropy source is not providing only 0s (all bits unset) or 1s (all
595 * bits set).
596 * - The entropy source is not providing values in a pattern. Because the
Andres AGe7723ec2016-08-25 10:18:50 +0100597 * hardware could be providing data in an arbitrary length, this check polls
598 * the hardware entropy source twice and compares the result to ensure they
599 * are not equal.
Andres AGb34e42e2016-08-22 11:08:50 +0100600 * - The error code returned by the entropy source is not an error.
601 */
Andres AGe7723ec2016-08-25 10:18:50 +0100602int mbedtls_entropy_source_self_test( int verbose )
Andres AGb34e42e2016-08-22 11:08:50 +0100603{
604 int ret = 0;
Andres AGe7723ec2016-08-25 10:18:50 +0100605 unsigned char buf0[2 * sizeof( unsigned long long int )];
606 unsigned char buf1[2 * sizeof( unsigned long long int )];
Andres AGb34e42e2016-08-22 11:08:50 +0100607
608 if( verbose != 0 )
609 mbedtls_printf( " ENTROPY_BIAS test: " );
610
Andres AGe7723ec2016-08-25 10:18:50 +0100611 memset( buf0, 0x00, sizeof( buf0 ) );
612 memset( buf1, 0x00, sizeof( buf1 ) );
Andres AGb34e42e2016-08-22 11:08:50 +0100613
Andres AGe7723ec2016-08-25 10:18:50 +0100614 if( ( ret = mbedtls_entropy_source_self_test_gather( buf0, sizeof( buf0 ) ) ) != 0 )
Andres AGb34e42e2016-08-22 11:08:50 +0100615 goto cleanup;
Andres AGe7723ec2016-08-25 10:18:50 +0100616 if( ( ret = mbedtls_entropy_source_self_test_gather( buf1, sizeof( buf1 ) ) ) != 0 )
617 goto cleanup;
618
619 /* Make sure that the returned values are not all 0 or 1 */
620 if( ( ret = mbedtls_entropy_source_self_test_check_bits( buf0, sizeof( buf0 ) ) ) != 0 )
621 goto cleanup;
622 if( ( ret = mbedtls_entropy_source_self_test_check_bits( buf1, sizeof( buf1 ) ) ) != 0 )
623 goto cleanup;
Andres AGb34e42e2016-08-22 11:08:50 +0100624
625 /* Make sure that the entropy source is not returning values in a
626 * pattern */
Andres AGe7723ec2016-08-25 10:18:50 +0100627 ret = memcmp( buf0, buf1, sizeof( buf0 ) ) == 0;
Andres AGb34e42e2016-08-22 11:08:50 +0100628
629cleanup:
Andres AGb34e42e2016-08-22 11:08:50 +0100630 if( verbose != 0 )
631 {
632 if( ret != 0 )
633 mbedtls_printf( "failed\n" );
634 else
635 mbedtls_printf( "passed\n" );
636
637 mbedtls_printf( "\n" );
638 }
639
640 return( ret != 0 );
641}
Andres AGe7723ec2016-08-25 10:18:50 +0100642
643#endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
Andres AGb34e42e2016-08-22 11:08:50 +0100644
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200645/*
646 * The actual entropy quality is hard to test, but we can at least
647 * test that the functions don't cause errors and write the correct
648 * amount of data to buffers.
649 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650int mbedtls_entropy_self_test( int verbose )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200651{
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100652 int ret = 1;
Simon Butcher669c6352016-09-15 18:57:34 +0100653#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654 mbedtls_entropy_context ctx;
655 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE] = { 0 };
656 unsigned char acc[MBEDTLS_ENTROPY_BLOCK_SIZE] = { 0 };
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200657 size_t i, j;
Simon Butcher669c6352016-09-15 18:57:34 +0100658#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200659
660 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661 mbedtls_printf( " ENTROPY test: " );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200662
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100663#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200664 mbedtls_entropy_init( &ctx );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200665
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200666 /* First do a gather to make sure we have default sources */
Manuel Pégourié-Gonnarde94bfe62015-05-14 13:57:50 +0200667 if( ( ret = mbedtls_entropy_gather( &ctx ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200668 goto cleanup;
669
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200670 ret = mbedtls_entropy_add_source( &ctx, entropy_dummy_source, NULL, 16,
671 MBEDTLS_ENTROPY_SOURCE_WEAK );
Manuel Pégourié-Gonnarde94bfe62015-05-14 13:57:50 +0200672 if( ret != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200673 goto cleanup;
674
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675 if( ( ret = mbedtls_entropy_update_manual( &ctx, buf, sizeof buf ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200676 goto cleanup;
677
678 /*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 * To test that mbedtls_entropy_func writes correct number of bytes:
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200680 * - use the whole buffer and rely on ASan to detect overruns
681 * - collect entropy 8 times and OR the result in an accumulator:
682 * any byte should then be 0 with probably 2^(-64), so requiring
683 * each of the 32 or 64 bytes to be non-zero has a false failure rate
684 * of at most 2^(-58) which is acceptable.
685 */
686 for( i = 0; i < 8; i++ )
687 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 if( ( ret = mbedtls_entropy_func( &ctx, buf, sizeof( buf ) ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200689 goto cleanup;
690
691 for( j = 0; j < sizeof( buf ); j++ )
692 acc[j] |= buf[j];
693 }
694
695 for( j = 0; j < sizeof( buf ); j++ )
696 {
697 if( acc[j] == 0 )
698 {
699 ret = 1;
700 goto cleanup;
701 }
702 }
703
Andres AGe7723ec2016-08-25 10:18:50 +0100704#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
705 if( ( ret = mbedtls_entropy_source_self_test( 0 ) ) != 0 )
706 goto cleanup;
707#endif
708
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200709cleanup:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 mbedtls_entropy_free( &ctx );
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100711#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200712
713 if( verbose != 0 )
714 {
715 if( ret != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200716 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200717 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200718 mbedtls_printf( "passed\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200719
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200720 mbedtls_printf( "\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200721 }
722
723 return( ret != 0 );
724}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725#endif /* MBEDTLS_SELF_TEST */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200726
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200727#endif /* MBEDTLS_ENTROPY_C */