blob: f8db1a550362d5e68bbf987a7ebaabe453fdec45 [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{
Manuel Pégourié-Gonnardbf82ff02015-06-19 09:40:51 +0200328 int ret, count = 0, i, done;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329 mbedtls_entropy_context *ctx = (mbedtls_entropy_context *) data;
330 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakker6083fd22011-12-03 21:45:14 +0000331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200332 if( len > MBEDTLS_ENTROPY_BLOCK_SIZE )
333 return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
Paul Bakker6083fd22011-12-03 21:45:14 +0000334
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100335#if defined(MBEDTLS_ENTROPY_NV_SEED)
336 /* Update the NV entropy seed before generating any entropy for outside
337 * use.
338 */
Paul Bakkerfc9c7c82016-06-01 15:25:50 +0100339 if( ctx->initial_entropy_run == 0 )
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100340 {
Paul Bakkerfc9c7c82016-06-01 15:25:50 +0100341 ctx->initial_entropy_run = 1;
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100342 if( ( ret = mbedtls_entropy_update_nv_seed( ctx ) ) != 0 )
343 return( ret );
344 }
345#endif
346
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200347#if defined(MBEDTLS_THREADING_C)
348 if( ( ret = mbedtls_mutex_lock( &ctx->mutex ) ) != 0 )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200349 return( ret );
350#endif
351
Paul Bakker6083fd22011-12-03 21:45:14 +0000352 /*
353 * Always gather extra entropy before a call
354 */
355 do
356 {
357 if( count++ > ENTROPY_MAX_LOOP )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200358 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200359 ret = MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200360 goto exit;
361 }
Paul Bakker6083fd22011-12-03 21:45:14 +0000362
Paul Bakker47703a02014-02-06 15:01:20 +0100363 if( ( ret = entropy_gather_internal( ctx ) ) != 0 )
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200364 goto exit;
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000365
Manuel Pégourié-Gonnardbf82ff02015-06-19 09:40:51 +0200366 done = 1;
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000367 for( i = 0; i < ctx->source_count; i++ )
Manuel Pégourié-Gonnardbf82ff02015-06-19 09:40:51 +0200368 if( ctx->source[i].size < ctx->source[i].threshold )
369 done = 0;
Paul Bakker6083fd22011-12-03 21:45:14 +0000370 }
Manuel Pégourié-Gonnardbf82ff02015-06-19 09:40:51 +0200371 while( ! done );
Paul Bakker6083fd22011-12-03 21:45:14 +0000372
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373 memset( buf, 0, MBEDTLS_ENTROPY_BLOCK_SIZE );
Paul Bakker6083fd22011-12-03 21:45:14 +0000374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375#if defined(MBEDTLS_ENTROPY_SHA512_ACCUMULATOR)
Andres Amaya Garciab2b063f2017-07-20 16:45:24 +0100376 /*
377 * Note that at this stage it is assumed that the accumulator was started
378 * in a previous call to entropy_update(). If this is not guaranteed, the
379 * code below will fail.
380 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100381 if( ( ret = mbedtls_sha512_finish_ret( &ctx->accumulator, buf ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100382 goto exit;
Paul Bakker9e36f042013-06-30 14:34:05 +0200383
Paul Bakker6083fd22011-12-03 21:45:14 +0000384 /*
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000385 * Reset accumulator and counters and recycle existing entropy
Paul Bakker6083fd22011-12-03 21:45:14 +0000386 */
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100387 mbedtls_sha512_free( &ctx->accumulator );
388 mbedtls_sha512_init( &ctx->accumulator );
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100389 if( ( ret = mbedtls_sha512_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100390 goto exit;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100391 if( ( ret = mbedtls_sha512_update_ret( &ctx->accumulator, buf,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100392 MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
393 goto exit;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200394
395 /*
Paul Bakkerb13d3ff2014-03-26 12:51:25 +0100396 * Perform second SHA-512 on entropy
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200397 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100398 if( ( ret = mbedtls_sha512_ret( buf, MBEDTLS_ENTROPY_BLOCK_SIZE,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100399 buf, 0 ) ) != 0 )
400 goto exit;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401#else /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100402 if( ( ret = mbedtls_sha256_finish_ret( &ctx->accumulator, buf ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100403 goto exit;
Paul Bakkerfb08fd22013-08-27 15:06:26 +0200404
405 /*
406 * Reset accumulator and counters and recycle existing entropy
407 */
Andres Amaya Garciaa7559cb2017-06-29 16:12:31 +0100408 mbedtls_sha256_free( &ctx->accumulator );
409 mbedtls_sha256_init( &ctx->accumulator );
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100410 if( ( ret = mbedtls_sha256_starts_ret( &ctx->accumulator, 0 ) ) != 0 )
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100411 goto exit;
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100412 if( ( ret = mbedtls_sha256_update_ret( &ctx->accumulator, buf,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100413 MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
414 goto exit;
Paul Bakkerb13d3ff2014-03-26 12:51:25 +0100415
416 /*
417 * Perform second SHA-256 on entropy
418 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100419 if( ( ret = mbedtls_sha256_ret( buf, MBEDTLS_ENTROPY_BLOCK_SIZE,
Andres Amaya Garcia207cea52017-06-29 13:28:13 +0100420 buf, 0 ) ) != 0 )
421 goto exit;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422#endif /* MBEDTLS_ENTROPY_SHA512_ACCUMULATOR */
Paul Bakkerbd4a9d02011-12-10 17:02:19 +0000423
424 for( i = 0; i < ctx->source_count; i++ )
425 ctx->source[i].size = 0;
Paul Bakker6083fd22011-12-03 21:45:14 +0000426
427 memcpy( output, buf, len );
428
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200429 ret = 0;
430
431exit:
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500432 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200434#if defined(MBEDTLS_THREADING_C)
435 if( mbedtls_mutex_unlock( &ctx->mutex ) != 0 )
436 return( MBEDTLS_ERR_THREADING_MUTEX_ERROR );
Paul Bakkerf4e7dc52013-09-28 15:23:57 +0200437#endif
438
439 return( ret );
Paul Bakker6083fd22011-12-03 21:45:14 +0000440}
441
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100442#if defined(MBEDTLS_ENTROPY_NV_SEED)
443int mbedtls_entropy_update_nv_seed( mbedtls_entropy_context *ctx )
444{
445 int ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
Andres Amaya Garciaaf0b31d2017-07-05 14:23:54 +0100446 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100447
448 /* Read new seed and write it to NV */
449 if( ( ret = mbedtls_entropy_func( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
450 return( ret );
451
452 if( mbedtls_nv_seed_write( buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) < 0 )
453 return( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR );
454
455 /* Manually update the remaining stream with a separator value to diverge */
456 memset( buf, 0, MBEDTLS_ENTROPY_BLOCK_SIZE );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100457 ret = mbedtls_entropy_update_manual( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE );
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100458
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100459 return( ret );
Paul Bakkerd5c9f6d2016-06-01 11:30:54 +0100460}
461#endif /* MBEDTLS_ENTROPY_NV_SEED */
462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200463#if defined(MBEDTLS_FS_IO)
464int mbedtls_entropy_write_seed_file( mbedtls_entropy_context *ctx, const char *path )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100465{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200466 int ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100467 FILE *f;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200468 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
Paul Bakker66ff70d2014-03-26 11:54:05 +0100469
470 if( ( f = fopen( path, "wb" ) ) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200471 return( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100472
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200473 if( ( ret = mbedtls_entropy_func( ctx, buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) ) != 0 )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100474 goto exit;
475
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200476 if( fwrite( buf, 1, MBEDTLS_ENTROPY_BLOCK_SIZE, f ) != MBEDTLS_ENTROPY_BLOCK_SIZE )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100477 {
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
Paul Bakker66ff70d2014-03-26 11:54:05 +0100487 fclose( f );
488 return( ret );
489}
490
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200491int mbedtls_entropy_update_seed_file( mbedtls_entropy_context *ctx, const char *path )
Paul Bakker66ff70d2014-03-26 11:54:05 +0100492{
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100493 int ret = 0;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100494 FILE *f;
495 size_t n;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200496 unsigned char buf[ MBEDTLS_ENTROPY_MAX_SEED_SIZE ];
Paul Bakker66ff70d2014-03-26 11:54:05 +0100497
498 if( ( f = fopen( path, "rb" ) ) == NULL )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200499 return( MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100500
501 fseek( f, 0, SEEK_END );
502 n = (size_t) ftell( f );
503 fseek( f, 0, SEEK_SET );
504
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200505 if( n > MBEDTLS_ENTROPY_MAX_SEED_SIZE )
506 n = MBEDTLS_ENTROPY_MAX_SEED_SIZE;
Paul Bakker66ff70d2014-03-26 11:54:05 +0100507
508 if( fread( buf, 1, n, f ) != n )
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100509 ret = MBEDTLS_ERR_ENTROPY_FILE_IO_ERROR;
510 else
511 ret = mbedtls_entropy_update_manual( ctx, buf, n );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100512
513 fclose( f );
514
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -0500515 mbedtls_platform_zeroize( buf, sizeof( buf ) );
Andres Amaya Garcia1adcd952017-06-26 09:58:59 +0100516
517 if( ret != 0 )
518 return( ret );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100519
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200520 return( mbedtls_entropy_write_seed_file( ctx, path ) );
Paul Bakker66ff70d2014-03-26 11:54:05 +0100521}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200522#endif /* MBEDTLS_FS_IO */
Paul Bakker66ff70d2014-03-26 11:54:05 +0100523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200524#if defined(MBEDTLS_SELF_TEST)
Simon Butcher669c6352016-09-15 18:57:34 +0100525#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200526/*
527 * Dummy source function
528 */
529static int entropy_dummy_source( void *data, unsigned char *output,
530 size_t len, size_t *olen )
531{
532 ((void) data);
533
534 memset( output, 0x2a, len );
535 *olen = len;
536
537 return( 0 );
538}
Simon Butcher669c6352016-09-15 18:57:34 +0100539#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200540
Andres AGe7723ec2016-08-25 10:18:50 +0100541#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
Andres AGb34e42e2016-08-22 11:08:50 +0100542
Andres AGe7723ec2016-08-25 10:18:50 +0100543static int mbedtls_entropy_source_self_test_gather( unsigned char *buf, size_t buf_len )
544{
545 int ret = 0;
546 size_t entropy_len = 0;
547 size_t olen = 0;
548 size_t attempts = buf_len;
549
550 while( attempts > 0 && entropy_len < buf_len )
551 {
552 if( ( ret = mbedtls_hardware_poll( NULL, buf + entropy_len,
553 buf_len - entropy_len, &olen ) ) != 0 )
554 return( ret );
555
556 entropy_len += olen;
557 attempts--;
558 }
559
560 if( entropy_len < buf_len )
561 {
562 ret = 1;
563 }
564
565 return( ret );
566}
567
568
569static int mbedtls_entropy_source_self_test_check_bits( const unsigned char *buf,
570 size_t buf_len )
571{
572 unsigned char set= 0xFF;
573 unsigned char unset = 0x00;
574 size_t i;
575
576 for( i = 0; i < buf_len; i++ )
577 {
578 set &= buf[i];
579 unset |= buf[i];
580 }
581
582 return( set == 0xFF || unset == 0x00 );
583}
Andres AGb34e42e2016-08-22 11:08:50 +0100584
585/*
Andres AGe7723ec2016-08-25 10:18:50 +0100586 * A test to ensure hat the entropy sources are functioning correctly
587 * and there is no obvious failure. The test performs the following checks:
Andres AGb34e42e2016-08-22 11:08:50 +0100588 * - The entropy source is not providing only 0s (all bits unset) or 1s (all
589 * bits set).
590 * - The entropy source is not providing values in a pattern. Because the
Andres AGe7723ec2016-08-25 10:18:50 +0100591 * hardware could be providing data in an arbitrary length, this check polls
592 * the hardware entropy source twice and compares the result to ensure they
593 * are not equal.
Andres AGb34e42e2016-08-22 11:08:50 +0100594 * - The error code returned by the entropy source is not an error.
595 */
Andres AGe7723ec2016-08-25 10:18:50 +0100596int mbedtls_entropy_source_self_test( int verbose )
Andres AGb34e42e2016-08-22 11:08:50 +0100597{
598 int ret = 0;
Andres AGe7723ec2016-08-25 10:18:50 +0100599 unsigned char buf0[2 * sizeof( unsigned long long int )];
600 unsigned char buf1[2 * sizeof( unsigned long long int )];
Andres AGb34e42e2016-08-22 11:08:50 +0100601
602 if( verbose != 0 )
603 mbedtls_printf( " ENTROPY_BIAS test: " );
604
Andres AGe7723ec2016-08-25 10:18:50 +0100605 memset( buf0, 0x00, sizeof( buf0 ) );
606 memset( buf1, 0x00, sizeof( buf1 ) );
Andres AGb34e42e2016-08-22 11:08:50 +0100607
Andres AGe7723ec2016-08-25 10:18:50 +0100608 if( ( ret = mbedtls_entropy_source_self_test_gather( buf0, sizeof( buf0 ) ) ) != 0 )
Andres AGb34e42e2016-08-22 11:08:50 +0100609 goto cleanup;
Andres AGe7723ec2016-08-25 10:18:50 +0100610 if( ( ret = mbedtls_entropy_source_self_test_gather( buf1, sizeof( buf1 ) ) ) != 0 )
611 goto cleanup;
612
613 /* Make sure that the returned values are not all 0 or 1 */
614 if( ( ret = mbedtls_entropy_source_self_test_check_bits( buf0, sizeof( buf0 ) ) ) != 0 )
615 goto cleanup;
616 if( ( ret = mbedtls_entropy_source_self_test_check_bits( buf1, sizeof( buf1 ) ) ) != 0 )
617 goto cleanup;
Andres AGb34e42e2016-08-22 11:08:50 +0100618
619 /* Make sure that the entropy source is not returning values in a
620 * pattern */
Andres AGe7723ec2016-08-25 10:18:50 +0100621 ret = memcmp( buf0, buf1, sizeof( buf0 ) ) == 0;
Andres AGb34e42e2016-08-22 11:08:50 +0100622
623cleanup:
Andres AGb34e42e2016-08-22 11:08:50 +0100624 if( verbose != 0 )
625 {
626 if( ret != 0 )
627 mbedtls_printf( "failed\n" );
628 else
629 mbedtls_printf( "passed\n" );
630
631 mbedtls_printf( "\n" );
632 }
633
634 return( ret != 0 );
635}
Andres AGe7723ec2016-08-25 10:18:50 +0100636
637#endif /* MBEDTLS_ENTROPY_HARDWARE_ALT */
Andres AGb34e42e2016-08-22 11:08:50 +0100638
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200639/*
640 * The actual entropy quality is hard to test, but we can at least
641 * test that the functions don't cause errors and write the correct
642 * amount of data to buffers.
643 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200644int mbedtls_entropy_self_test( int verbose )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200645{
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100646 int ret = 1;
Simon Butcher669c6352016-09-15 18:57:34 +0100647#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648 mbedtls_entropy_context ctx;
649 unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE] = { 0 };
650 unsigned char acc[MBEDTLS_ENTROPY_BLOCK_SIZE] = { 0 };
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200651 size_t i, j;
Simon Butcher669c6352016-09-15 18:57:34 +0100652#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200653
654 if( verbose != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655 mbedtls_printf( " ENTROPY test: " );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200656
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100657#if !defined(MBEDTLS_TEST_NULL_ENTROPY)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200658 mbedtls_entropy_init( &ctx );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200659
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200660 /* First do a gather to make sure we have default sources */
Manuel Pégourié-Gonnarde94bfe62015-05-14 13:57:50 +0200661 if( ( ret = mbedtls_entropy_gather( &ctx ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200662 goto cleanup;
663
Manuel Pégourié-Gonnard7580ba42015-06-19 10:26:32 +0200664 ret = mbedtls_entropy_add_source( &ctx, entropy_dummy_source, NULL, 16,
665 MBEDTLS_ENTROPY_SOURCE_WEAK );
Manuel Pégourié-Gonnarde94bfe62015-05-14 13:57:50 +0200666 if( ret != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200667 goto cleanup;
668
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200669 if( ( ret = mbedtls_entropy_update_manual( &ctx, buf, sizeof buf ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200670 goto cleanup;
671
672 /*
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200673 * To test that mbedtls_entropy_func writes correct number of bytes:
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200674 * - use the whole buffer and rely on ASan to detect overruns
675 * - collect entropy 8 times and OR the result in an accumulator:
676 * any byte should then be 0 with probably 2^(-64), so requiring
677 * each of the 32 or 64 bytes to be non-zero has a false failure rate
678 * of at most 2^(-58) which is acceptable.
679 */
680 for( i = 0; i < 8; i++ )
681 {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682 if( ( ret = mbedtls_entropy_func( &ctx, buf, sizeof( buf ) ) ) != 0 )
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200683 goto cleanup;
684
685 for( j = 0; j < sizeof( buf ); j++ )
686 acc[j] |= buf[j];
687 }
688
689 for( j = 0; j < sizeof( buf ); j++ )
690 {
691 if( acc[j] == 0 )
692 {
693 ret = 1;
694 goto cleanup;
695 }
696 }
697
Andres AGe7723ec2016-08-25 10:18:50 +0100698#if defined(MBEDTLS_ENTROPY_HARDWARE_ALT)
699 if( ( ret = mbedtls_entropy_source_self_test( 0 ) ) != 0 )
700 goto cleanup;
701#endif
702
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200703cleanup:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200704 mbedtls_entropy_free( &ctx );
Andres Amaya Garciaa928e672016-09-13 13:30:02 +0100705#endif /* !MBEDTLS_TEST_NULL_ENTROPY */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200706
707 if( verbose != 0 )
708 {
709 if( ret != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 mbedtls_printf( "failed\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200711 else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200712 mbedtls_printf( "passed\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200713
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714 mbedtls_printf( "\n" );
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200715 }
716
717 return( ret != 0 );
718}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200719#endif /* MBEDTLS_SELF_TEST */
Manuel Pégourié-Gonnard4dd73922014-05-30 10:34:15 +0200720
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200721#endif /* MBEDTLS_ENTROPY_C */