blob: 019071ba404bcae10b23590f287aab41e091b812 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/*
2 * Self-test demonstration program
3 *
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02004 * Copyright (C) 2006-2015, 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 Bakkerb96f1542010-07-18 20:36:00 +000018 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000019 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker5121ce52009-01-03 21:22:43 +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 Bakker5121ce52009-01-03 21:22:43 +000027
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000028#include "mbedtls/entropy.h"
Simon Butcherb6a73c92016-06-18 22:45:37 +010029#include "mbedtls/entropy_poll.h"
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000030#include "mbedtls/hmac_drbg.h"
31#include "mbedtls/ctr_drbg.h"
32#include "mbedtls/dhm.h"
33#include "mbedtls/gcm.h"
34#include "mbedtls/ccm.h"
Robert Cragiedc5c7b92015-12-11 15:49:45 +000035#include "mbedtls/cmac.h"
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/md2.h"
37#include "mbedtls/md4.h"
38#include "mbedtls/md5.h"
39#include "mbedtls/ripemd160.h"
40#include "mbedtls/sha1.h"
41#include "mbedtls/sha256.h"
42#include "mbedtls/sha512.h"
43#include "mbedtls/arc4.h"
44#include "mbedtls/des.h"
45#include "mbedtls/aes.h"
46#include "mbedtls/camellia.h"
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +000047#include "mbedtls/aria.h"
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000048#include "mbedtls/base64.h"
49#include "mbedtls/bignum.h"
50#include "mbedtls/rsa.h"
51#include "mbedtls/x509.h"
52#include "mbedtls/xtea.h"
53#include "mbedtls/pkcs5.h"
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000054#include "mbedtls/ecp.h"
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +020055#include "mbedtls/ecjpake.h"
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000056#include "mbedtls/timing.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000057
Rich Evans18b78c72015-02-11 14:06:19 +000058#include <string.h>
59
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020060#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000061#include "mbedtls/platform.h"
Rich Evans18b78c72015-02-11 14:06:19 +000062#else
63#include <stdio.h>
Janos Follath2e3aca22016-03-18 16:25:52 +000064#include <stdlib.h>
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065#define mbedtls_printf printf
Manuel Pégourié-Gonnard7b6dcbe2015-06-22 10:48:01 +020066#define mbedtls_snprintf snprintf
Janos Follath2e3aca22016-03-18 16:25:52 +000067#define mbedtls_exit exit
68#define MBEDTLS_EXIT_SUCCESS EXIT_SUCCESS
69#define MBEDTLS_EXIT_FAILURE EXIT_FAILURE
Rich Evans18b78c72015-02-11 14:06:19 +000070#endif
71
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020072#if defined(MBEDTLS_MEMORY_BUFFER_ALLOC_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000073#include "mbedtls/memory_buffer_alloc.h"
Paul Bakker6e339b52013-07-03 13:37:05 +020074#endif
75
Manuel Pégourié-Gonnard7b6dcbe2015-06-22 10:48:01 +020076static int test_snprintf( size_t n, const char ref_buf[10], int ref_ret )
77{
78 int ret;
79 char buf[10] = "xxxxxxxxx";
Manuel Pégourié-Gonnard4b00f082015-06-26 11:24:32 +020080 const char ref[10] = "xxxxxxxxx";
Manuel Pégourié-Gonnard7b6dcbe2015-06-22 10:48:01 +020081
82 ret = mbedtls_snprintf( buf, n, "%s", "123" );
83 if( ret < 0 || (size_t) ret >= n )
84 ret = -1;
85
Manuel Pégourié-Gonnard4b00f082015-06-26 11:24:32 +020086 if( strncmp( ref_buf, buf, sizeof( buf ) ) != 0 ||
87 ref_ret != ret ||
88 memcmp( buf + n, ref + n, sizeof( buf ) - n ) != 0 )
Manuel Pégourié-Gonnard7b6dcbe2015-06-22 10:48:01 +020089 {
90 return( 1 );
91 }
92
93 return( 0 );
94}
95
96static int run_test_snprintf( void )
97{
98 return( test_snprintf( 0, "xxxxxxxxx", -1 ) != 0 ||
Manuel Pégourié-Gonnard4b00f082015-06-26 11:24:32 +020099 test_snprintf( 1, "", -1 ) != 0 ||
100 test_snprintf( 2, "1", -1 ) != 0 ||
101 test_snprintf( 3, "12", -1 ) != 0 ||
102 test_snprintf( 4, "123", 3 ) != 0 ||
103 test_snprintf( 5, "123", 3 ) != 0 );
Manuel Pégourié-Gonnard7b6dcbe2015-06-22 10:48:01 +0200104}
105
Simon Butcherb6a73c92016-06-18 22:45:37 +0100106/*
107 * Check if a seed file is present, and if not create one for the entropy
108 * self-test. If this fails, we attempt the test anyway, so no error is passed
109 * back.
110 */
Gilles Peskine319ac802017-12-15 14:57:18 +0100111#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_ENTROPY_C)
112#if defined(MBEDTLS_ENTROPY_NV_SEED) && !defined(MBEDTLS_NO_PLATFORM_ENTROPY)
Simon Butcherb6a73c92016-06-18 22:45:37 +0100113static void create_entropy_seed_file( void )
114{
115 int result;
116 size_t output_len = 0;
117 unsigned char seed_value[MBEDTLS_ENTROPY_BLOCK_SIZE];
118
119 /* Attempt to read the entropy seed file. If this fails - attempt to write
120 * to the file to ensure one is present. */
121 result = mbedtls_platform_std_nv_seed_read( seed_value,
122 MBEDTLS_ENTROPY_BLOCK_SIZE );
123 if( 0 == result )
124 return;
125
126 result = mbedtls_platform_entropy_poll( NULL,
127 seed_value,
128 MBEDTLS_ENTROPY_BLOCK_SIZE,
129 &output_len );
130 if( 0 != result )
131 return;
132
133 if( MBEDTLS_ENTROPY_BLOCK_SIZE != output_len )
134 return;
135
136 mbedtls_platform_std_nv_seed_write( seed_value, MBEDTLS_ENTROPY_BLOCK_SIZE );
137}
138#endif
139
Gilles Peskine319ac802017-12-15 14:57:18 +0100140int mbedtls_entropy_self_test_wrapper( int verbose )
141{
142#if defined(MBEDTLS_ENTROPY_NV_SEED) && !defined(MBEDTLS_NO_PLATFORM_ENTROPY)
143 create_entropy_seed_file( );
144#endif
145 return( mbedtls_entropy_self_test( verbose ) );
146}
147#endif
148
149#if defined(MBEDTLS_SELF_TEST)
150#if defined(MBEDTLS_MEMORY_BUFFER_ALLOC_C)
151int mbedtls_memory_buffer_alloc_free_and_self_test( int verbose )
152{
153 if( verbose != 0 )
154 {
155#if defined(MBEDTLS_MEMORY_DEBUG)
156 mbedtls_memory_buffer_alloc_status( );
157#endif
158 }
159 mbedtls_memory_buffer_alloc_free( );
160 return( mbedtls_memory_buffer_alloc_self_test( verbose ) );
161}
162#endif
163
164typedef struct
165{
166 const char *name;
167 int ( *function )( int );
168} selftest_t;
169
170const selftest_t selftests[] =
171{
172#if defined(MBEDTLS_MD2_C)
173 {"md2", mbedtls_md2_self_test},
174#endif
175#if defined(MBEDTLS_MD4_C)
176 {"md4", mbedtls_md4_self_test},
177#endif
178#if defined(MBEDTLS_MD5_C)
179 {"md5", mbedtls_md5_self_test},
180#endif
181#if defined(MBEDTLS_RIPEMD160_C)
182 {"ripemd160", mbedtls_ripemd160_self_test},
183#endif
184#if defined(MBEDTLS_SHA1_C)
185 {"sha1", mbedtls_sha1_self_test},
186#endif
187#if defined(MBEDTLS_SHA256_C)
188 {"sha256", mbedtls_sha256_self_test},
189#endif
190#if defined(MBEDTLS_SHA512_C)
191 {"sha512", mbedtls_sha512_self_test},
192#endif
193#if defined(MBEDTLS_ARC4_C)
194 {"arc4", mbedtls_arc4_self_test},
195#endif
196#if defined(MBEDTLS_DES_C)
197 {"des", mbedtls_des_self_test},
198#endif
199#if defined(MBEDTLS_AES_C)
200 {"aes", mbedtls_aes_self_test},
201#endif
202#if defined(MBEDTLS_GCM_C) && defined(MBEDTLS_AES_C)
203 {"gcm", mbedtls_gcm_self_test},
204#endif
205#if defined(MBEDTLS_CCM_C) && defined(MBEDTLS_AES_C)
206 {"ccm", mbedtls_ccm_self_test},
207#endif
208#if defined(MBEDTLS_CMAC_C)
209 {"cmac", mbedtls_cmac_self_test},
210#endif
211#if defined(MBEDTLS_BASE64_C)
212 {"base64", mbedtls_base64_self_test},
213#endif
214#if defined(MBEDTLS_BIGNUM_C)
215 {"mpi", mbedtls_mpi_self_test},
216#endif
217#if defined(MBEDTLS_RSA_C)
218 {"rsa", mbedtls_rsa_self_test},
219#endif
220#if defined(MBEDTLS_X509_USE_C)
221 {"x509", mbedtls_x509_self_test},
222#endif
223#if defined(MBEDTLS_XTEA_C)
224 {"xtea", mbedtls_xtea_self_test},
225#endif
226#if defined(MBEDTLS_CAMELLIA_C)
227 {"camellia", mbedtls_camellia_self_test},
228#endif
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +0000229#if defined(MBEDTLS_ARIA_C)
230 {"aria", mbedtls_aria_self_test},
231#endif
Gilles Peskine319ac802017-12-15 14:57:18 +0100232#if defined(MBEDTLS_CTR_DRBG_C)
233 {"ctr_drbg", mbedtls_ctr_drbg_self_test},
234#endif
235#if defined(MBEDTLS_HMAC_DRBG_C)
236 {"hmac_drbg", mbedtls_hmac_drbg_self_test},
237#endif
238#if defined(MBEDTLS_ECP_C)
239 {"ecp", mbedtls_ecp_self_test},
240#endif
241#if defined(MBEDTLS_ECJPAKE_C)
242 {"ecjpake", mbedtls_ecjpake_self_test},
243#endif
244#if defined(MBEDTLS_DHM_C)
245 {"dhm", mbedtls_dhm_self_test},
246#endif
247#if defined(MBEDTLS_ENTROPY_C)
248 {"entropy", mbedtls_entropy_self_test_wrapper},
249#endif
250#if defined(MBEDTLS_PKCS5_C)
251 {"pkcs5", mbedtls_pkcs5_self_test},
252#endif
253/* Slower test after the faster ones */
254#if defined(MBEDTLS_TIMING_C)
255 {"timing", mbedtls_timing_self_test},
256#endif
257/* Heap test comes last */
258#if defined(MBEDTLS_MEMORY_BUFFER_ALLOC_C)
259 {"memory_buffer_alloc", mbedtls_memory_buffer_alloc_free_and_self_test},
260#endif
261 {NULL, NULL}
262};
Gilles Peskinec82fbb42017-12-15 15:01:27 +0100263#endif /* MBEDTLS_SELF_TEST */
Gilles Peskine319ac802017-12-15 14:57:18 +0100264
Paul Bakker5121ce52009-01-03 21:22:43 +0000265int main( int argc, char *argv[] )
266{
Gilles Peskinec82fbb42017-12-15 15:01:27 +0100267#if defined(MBEDTLS_SELF_TEST)
Gilles Peskine319ac802017-12-15 14:57:18 +0100268 const selftest_t *test;
Gilles Peskinec82fbb42017-12-15 15:01:27 +0100269#endif /* MBEDTLS_SELF_TEST */
Gilles Peskineff79d272017-12-20 18:09:27 +0100270 char **argp;
271 int v = 1; /* v=1 for verbose mode */
272 int exclude_mode = 0;
273 int suites_tested = 0, suites_failed = 0;
Paul Bakker70940ca2016-07-14 14:30:45 +0100274#if defined(MBEDTLS_MEMORY_BUFFER_ALLOC_C) && defined(MBEDTLS_SELF_TEST)
Paul Bakker6e339b52013-07-03 13:37:05 +0200275 unsigned char buf[1000000];
276#endif
Manuel Pégourié-Gonnardd14acbc2015-05-29 11:26:37 +0200277 void *pointer;
278
279 /*
280 * The C standard doesn't guarantee that all-bits-0 is the representation
281 * of a NULL pointer. We do however use that in our code for initializing
282 * structures, which should work on every modern platform. Let's be sure.
283 */
284 memset( &pointer, 0, sizeof( void * ) );
285 if( pointer != NULL )
286 {
287 mbedtls_printf( "all-bits-zero is not a NULL pointer\n" );
Janos Follath2e3aca22016-03-18 16:25:52 +0000288 mbedtls_exit( MBEDTLS_EXIT_FAILURE );
Manuel Pégourié-Gonnardd14acbc2015-05-29 11:26:37 +0200289 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000290
Manuel Pégourié-Gonnard7b6dcbe2015-06-22 10:48:01 +0200291 /*
292 * Make sure we have a snprintf that correctly zero-terminates
293 */
294 if( run_test_snprintf() != 0 )
295 {
296 mbedtls_printf( "the snprintf implementation is broken\n" );
Janos Follath2e3aca22016-03-18 16:25:52 +0000297 mbedtls_exit( MBEDTLS_EXIT_FAILURE );
Manuel Pégourié-Gonnard7b6dcbe2015-06-22 10:48:01 +0200298 }
299
Gilles Peskineff79d272017-12-20 18:09:27 +0100300 for( argp = argv + ( argc >= 1 ? 1 : argc ); *argp != NULL; ++argp )
SimonB5a8afb82016-03-11 00:40:54 +0000301 {
Gilles Peskineff79d272017-12-20 18:09:27 +0100302 if( strcmp( *argp, "--quiet" ) == 0 ||
303 strcmp( *argp, "-q" ) == 0 )
304 {
305 v = 0;
306 }
307 else if( strcmp( *argp, "--exclude" ) == 0 ||
308 strcmp( *argp, "-x" ) == 0 )
309 {
310 exclude_mode = 1;
311 }
312 else
313 break;
SimonB5a8afb82016-03-11 00:40:54 +0000314 }
Gilles Peskineff79d272017-12-20 18:09:27 +0100315
316 if( v != 0 )
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200317 mbedtls_printf( "\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +0000318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319#if defined(MBEDTLS_SELF_TEST)
Paul Bakker135b98e2011-05-25 11:13:47 +0000320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200321#if defined(MBEDTLS_MEMORY_BUFFER_ALLOC_C)
322 mbedtls_memory_buffer_alloc_init( buf, sizeof(buf) );
Paul Bakker6e339b52013-07-03 13:37:05 +0200323#endif
324
Gilles Peskineff79d272017-12-20 18:09:27 +0100325 if( *argp != NULL && exclude_mode == 0 )
SimonB5a8afb82016-03-11 00:40:54 +0000326 {
Gilles Peskinec82fbb42017-12-15 15:01:27 +0100327 /* Run the specified tests */
328 for( ; *argp != NULL; argp++ )
Gilles Peskine319ac802017-12-15 14:57:18 +0100329 {
Gilles Peskinec82fbb42017-12-15 15:01:27 +0100330 for( test = selftests; test->name != NULL; test++ )
331 {
332 if( !strcmp( *argp, test->name ) )
333 {
334 if( test->function( v ) != 0 )
335 {
336 suites_failed++;
337 }
338 suites_tested++;
339 break;
340 }
341 }
342 if( test->name == NULL )
343 {
344 mbedtls_printf( " Test suite %s not available -> failed\n\n", *argp );
345 suites_failed++;
346 }
Gilles Peskine319ac802017-12-15 14:57:18 +0100347 }
Gilles Peskinec82fbb42017-12-15 15:01:27 +0100348 }
349 else
350 {
Gilles Peskineff79d272017-12-20 18:09:27 +0100351 /* Run all the tests except excluded ones */
Gilles Peskinec82fbb42017-12-15 15:01:27 +0100352 for( test = selftests; test->name != NULL; test++ )
353 {
Gilles Peskineff79d272017-12-20 18:09:27 +0100354 if( exclude_mode )
355 {
356 char **excluded;
357 for( excluded = argp; *excluded != NULL; ++excluded )
358 {
359 if( !strcmp( *excluded, test->name ) )
360 break;
361 }
362 if( *excluded )
363 {
364 if( v )
365 mbedtls_printf( " Skip: %s\n", test->name );
366 continue;
367 }
368 }
Gilles Peskinec82fbb42017-12-15 15:01:27 +0100369 if( test->function( v ) != 0 )
370 {
371 suites_failed++;
372 }
373 suites_tested++;
374 }
SimonB5a8afb82016-03-11 00:40:54 +0000375 }
Manuel Pégourié-Gonnard5ba1d522014-11-27 11:33:55 +0100376
Paul Bakker70940ca2016-07-14 14:30:45 +0100377#else
Gilles Peskineff79d272017-12-20 18:09:27 +0100378 (void) exclude_mode;
Paul Bakker70940ca2016-07-14 14:30:45 +0100379 mbedtls_printf( " MBEDTLS_SELF_TEST not defined.\n" );
380#endif
381
Manuel Pégourié-Gonnard5ba1d522014-11-27 11:33:55 +0100382 if( v != 0 )
383 {
Simon Butcherf1547632016-03-14 23:09:39 +0000384 mbedtls_printf( " Executed %d test suites\n\n", suites_tested );
SimonB5a8afb82016-03-11 00:40:54 +0000385
386 if( suites_failed > 0)
387 {
388 mbedtls_printf( " [ %d tests FAIL ]\n\n", suites_failed );
389 }
390 else
391 {
392 mbedtls_printf( " [ All tests PASS ]\n\n" );
393 }
Paul Bakkercce9d772011-11-18 14:26:47 +0000394#if defined(_WIN32)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200395 mbedtls_printf( " Press Enter to exit this program.\n" );
Paul Bakker5121ce52009-01-03 21:22:43 +0000396 fflush( stdout ); getchar();
397#endif
398 }
Paul Bakker5121ce52009-01-03 21:22:43 +0000399
SimonB5a8afb82016-03-11 00:40:54 +0000400 if( suites_failed > 0)
Janos Follath2e3aca22016-03-18 16:25:52 +0000401 mbedtls_exit( MBEDTLS_EXIT_FAILURE );
SimonB5a8afb82016-03-11 00:40:54 +0000402
Janos Follath98e28a72016-05-31 14:03:54 +0100403 /* return() is here to prevent compiler warnings */
Janos Follath0c539442016-04-18 09:59:16 +0100404 return( MBEDTLS_EXIT_SUCCESS );
Paul Bakker5121ce52009-01-03 21:22:43 +0000405}
SimonB5a8afb82016-03-11 00:40:54 +0000406