blob: f30f5e6649aa8d5a59f963f75f955f78b53e3a13 [file] [log] [blame]
Azim Khanec024482017-05-09 17:20:21 +01001#line 2 "suites/helpers.function"
SimonB0269dad2016-02-17 23:34:30 +00002/*----------------------------------------------------------------------------*/
3/* Headers */
4
Simon Butcheredb7fd92016-05-17 13:35:51 +01005#include <stdlib.h>
6
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02007#if defined(MBEDTLS_PLATFORM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +00008#include "mbedtls/platform.h"
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +02009#else
Rich Evans00ab4702015-02-06 13:43:58 +000010#include <stdio.h>
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020011#define mbedtls_fprintf fprintf
Simon Butcher25731362016-09-30 13:11:29 +010012#define mbedtls_snprintf snprintf
13#define mbedtls_calloc calloc
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#define mbedtls_free free
15#define mbedtls_exit exit
Simon Butcherb2d5dd12016-04-27 13:35:37 +010016#define mbedtls_time time
17#define mbedtls_time_t time_t
Janos Follath55abc212016-04-18 18:18:48 +010018#define MBEDTLS_EXIT_SUCCESS EXIT_SUCCESS
19#define MBEDTLS_EXIT_FAILURE EXIT_FAILURE
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +020020#endif
21
SimonB0269dad2016-02-17 23:34:30 +000022#if defined(MBEDTLS_MEMORY_BUFFER_ALLOC_C)
23#include "mbedtls/memory_buffer_alloc.h"
24#endif
25
Simon Butchera6463452018-12-06 17:41:56 +000026#if defined(MBEDTLS_CHECK_PARAMS)
Manuel Pégourié-Gonnarda2b0e272018-12-10 15:23:58 +010027#include "mbedtls/platform_util.h"
Simon Butchera6463452018-12-06 17:41:56 +000028#include <setjmp.h>
Manuel Pégourié-Gonnarda2b0e272018-12-10 15:23:58 +010029#endif
Simon Butcher747f5fe2018-12-07 16:53:57 +000030
Paul Bakkerb3dcbc12011-03-13 16:57:25 +000031#ifdef _MSC_VER
32#include <basetsd.h>
Azim Khan0fa35042018-06-22 11:34:33 +010033typedef UINT8 uint8_t;
34typedef INT32 int32_t;
Paul Bakkerb3dcbc12011-03-13 16:57:25 +000035typedef UINT32 uint32_t;
Nicholas Wilson733676b2015-11-14 13:09:01 +000036#define strncasecmp _strnicmp
37#define strcasecmp _stricmp
Paul Bakkerb3dcbc12011-03-13 16:57:25 +000038#else
Manuel Pégourié-Gonnard93866642015-06-22 19:21:23 +020039#include <stdint.h>
Paul Bakkerb3dcbc12011-03-13 16:57:25 +000040#endif
41
Paul Bakker19343182013-08-16 13:31:10 +020042#include <string.h>
43
Janos Follath8ca53b52016-10-05 10:57:49 +010044#if defined(__unix__) || (defined(__APPLE__) && defined(__MACH__))
45#include <unistd.h>
Nicholas Wilson2682edf2017-12-05 12:08:15 +000046#include <strings.h>
Janos Follath8ca53b52016-10-05 10:57:49 +010047#endif
SimonB0269dad2016-02-17 23:34:30 +000048
Azim Khand30ca132017-06-09 04:32:58 +010049/* Type for Hex parameters */
Azim Khan5fcca462018-06-29 11:05:32 +010050typedef struct data_tag
Azim Khand30ca132017-06-09 04:32:58 +010051{
52 uint8_t * x;
53 uint32_t len;
Azim Khan5fcca462018-06-29 11:05:32 +010054} data_t;
Azim Khand30ca132017-06-09 04:32:58 +010055
SimonB0269dad2016-02-17 23:34:30 +000056/*----------------------------------------------------------------------------*/
Azim Khan62a5d7d2018-06-29 10:02:54 +010057/* Status and error constants */
SimonB0269dad2016-02-17 23:34:30 +000058
Azim Khan62a5d7d2018-06-29 10:02:54 +010059#define DEPENDENCY_SUPPORTED 0 /* Dependency supported by build */
60#define KEY_VALUE_MAPPING_FOUND 0 /* Integer expression found */
61#define DISPATCH_TEST_SUCCESS 0 /* Test dispatch successful */
SimonB8ca7bc42016-04-17 23:24:50 +010062
Azim Khan62a5d7d2018-06-29 10:02:54 +010063#define KEY_VALUE_MAPPING_NOT_FOUND -1 /* Integer expression not found */
64#define DEPENDENCY_NOT_SUPPORTED -2 /* Dependency not supported */
65#define DISPATCH_TEST_FN_NOT_FOUND -3 /* Test function not found */
66#define DISPATCH_INVALID_TEST_DATA -4 /* Invalid test parameter type.
67 Only int, string, binary data
68 and integer expressions are
69 allowed */
70#define DISPATCH_UNSUPPORTED_SUITE -5 /* Test suite not supported by the
71 build */
SimonB0269dad2016-02-17 23:34:30 +000072
Simon Butcher6542f6c2018-12-09 22:09:59 +000073typedef enum
74{
75 PARAMFAIL_TESTSTATE_IDLE = 0, /* No parameter failure call test */
76 PARAMFAIL_TESTSTATE_PENDING, /* Test call to the parameter failure
77 * is pending */
78 PARAMFAIL_TESTSTATE_CALLED /* The test call to the parameter
79 * failure function has been made */
80} paramfail_test_state_t;
81
SimonB0269dad2016-02-17 23:34:30 +000082
83/*----------------------------------------------------------------------------*/
84/* Macros */
85
Simon Butchera6463452018-12-06 17:41:56 +000086/**
87 * \brief This macro tests the expression passed to it as a test step or
88 * individual test in a test case.
89 *
90 * It allows a library function to return a value and return an error
91 * code that can be tested.
92 *
93 * When MBEDTLS_CHECK_PARAMS is enabled, calls to the parameter failure
Manuel Pégourié-Gonnarda2b0e272018-12-10 15:23:58 +010094 * callback, MBEDTLS_PARAM_FAILED(), will be assumed to be a test
95 * failure.
Simon Butchera6463452018-12-06 17:41:56 +000096 *
97 * This macro is not suitable for negative parameter validation tests,
98 * as it assumes the test step will not create an error.
99 *
100 * \param TEST The test expression to be tested.
101 */
Simon Butcher6542f6c2018-12-09 22:09:59 +0000102#define TEST_ASSERT( TEST ) \
103 do { \
104 if( ! (TEST) ) \
105 { \
106 test_fail( #TEST, __LINE__, __FILE__ ); \
107 goto exit; \
108 } \
SimonB0269dad2016-02-17 23:34:30 +0000109 } while( 0 )
110
Ronald Cron8e8898d2020-07-30 14:18:02 +0200111/** Compare two buffers and fail the test case if they differ.
112 *
113 * This macro expands to an instruction, not an expression.
114 * It may jump to the \c exit label.
115 *
116 * \param p1 Pointer to the start of the first buffer.
117 * \param size1 Size of the first buffer in bytes.
118 * This expression may be evaluated multiple times.
119 * \param p2 Pointer to the start of the second buffer.
120 * \param size2 Size of the second buffer in bytes.
121 * This expression may be evaluated multiple times.
122 */
123#define ASSERT_COMPARE( p1, size1, p2, size2 ) \
124 do \
125 { \
126 TEST_ASSERT( ( size1 ) == ( size2 ) ); \
127 if( ( size1 ) != 0 ) \
128 TEST_ASSERT( memcmp( ( p1 ), ( p2 ), ( size1 ) ) == 0 ); \
129 } \
130 while( 0 )
131
Hanno Beckerd3369f62019-07-05 13:31:30 +0100132/**
133 * \brief This macro tests the expression passed to it and skips the
134 * running test if it doesn't evaluate to 'true'.
135 *
136 * \param TEST The test expression to be tested.
137 */
138#define TEST_ASSUME( TEST ) \
139 do { \
140 if( ! (TEST) ) \
141 { \
142 test_skip( #TEST, __LINE__, __FILE__ ); \
143 goto exit; \
144 } \
145 } while( 0 )
146
Manuel Pégourié-Gonnarda2b0e272018-12-10 15:23:58 +0100147#if defined(MBEDTLS_CHECK_PARAMS) && !defined(MBEDTLS_PARAM_FAILED_ALT)
Simon Butchera6463452018-12-06 17:41:56 +0000148/**
149 * \brief This macro tests the statement passed to it as a test step or
150 * individual test in a test case. The macro assumes the test will fail
151 * and will generate an error.
152 *
153 * It allows a library function to return a value and tests the return
154 * code on return to confirm the given error code was returned.
155 *
156 * When MBEDTLS_CHECK_PARAMS is enabled, calls to the parameter failure
Manuel Pégourié-Gonnarda2b0e272018-12-10 15:23:58 +0100157 * callback, MBEDTLS_PARAM_FAILED(), are assumed to indicate the
Simon Butchera6463452018-12-06 17:41:56 +0000158 * expected failure, and the test will pass.
159 *
160 * This macro is intended for negative parameter validation tests,
161 * where the failing function may return an error value or call
Manuel Pégourié-Gonnarda2b0e272018-12-10 15:23:58 +0100162 * MBEDTLS_PARAM_FAILED() to indicate the error.
Simon Butchera6463452018-12-06 17:41:56 +0000163 *
164 * \param PARAM_ERROR_VALUE The expected error code.
165 *
166 * \param TEST The test expression to be tested.
167 */
Simon Butcher6542f6c2018-12-09 22:09:59 +0000168#define TEST_INVALID_PARAM_RET( PARAM_ERR_VALUE, TEST ) \
169 do { \
170 test_info.paramfail_test_state = PARAMFAIL_TESTSTATE_PENDING; \
Manuel Pégourié-Gonnardacfdc622018-12-11 10:36:21 +0100171 if( (TEST) != (PARAM_ERR_VALUE) || \
Simon Butcher6542f6c2018-12-09 22:09:59 +0000172 test_info.paramfail_test_state != PARAMFAIL_TESTSTATE_CALLED ) \
173 { \
174 test_fail( #TEST, __LINE__, __FILE__ ); \
175 goto exit; \
176 } \
177 } while( 0 )
Simon Butchera6463452018-12-06 17:41:56 +0000178
179/**
180 * \brief This macro tests the statement passed to it as a test step or
181 * individual test in a test case. The macro assumes the test will fail
182 * and will generate an error.
183 *
184 * It assumes the library function under test cannot return a value and
185 * assumes errors can only be indicated byt calls to
Manuel Pégourié-Gonnarda2b0e272018-12-10 15:23:58 +0100186 * MBEDTLS_PARAM_FAILED().
Simon Butchera6463452018-12-06 17:41:56 +0000187 *
188 * When MBEDTLS_CHECK_PARAMS is enabled, calls to the parameter failure
Manuel Pégourié-Gonnarda2b0e272018-12-10 15:23:58 +0100189 * callback, MBEDTLS_PARAM_FAILED(), are assumed to indicate the
Simon Butchera6463452018-12-06 17:41:56 +0000190 * expected failure. If MBEDTLS_CHECK_PARAMS is not enabled, no test
191 * can be made.
192 *
193 * This macro is intended for negative parameter validation tests,
194 * where the failing function can only return an error by calling
Manuel Pégourié-Gonnarda2b0e272018-12-10 15:23:58 +0100195 * MBEDTLS_PARAM_FAILED() to indicate the error.
Simon Butchera6463452018-12-06 17:41:56 +0000196 *
197 * \param TEST The test expression to be tested.
198 */
Simon Butcher6542f6c2018-12-09 22:09:59 +0000199#define TEST_INVALID_PARAM( TEST ) \
200 do { \
201 memcpy(jmp_tmp, param_fail_jmp, sizeof(jmp_buf)); \
Manuel Pégourié-Gonnardaae10fa2018-12-12 10:24:19 +0100202 if( setjmp( param_fail_jmp ) == 0 ) \
Simon Butcher6542f6c2018-12-09 22:09:59 +0000203 { \
204 TEST; \
205 test_fail( #TEST, __LINE__, __FILE__ ); \
206 goto exit; \
207 } \
208 memcpy(param_fail_jmp, jmp_tmp, sizeof(jmp_buf)); \
Simon Butchera6463452018-12-06 17:41:56 +0000209 } while( 0 )
Manuel Pégourié-Gonnard54e7f312018-12-12 11:56:09 +0100210#endif /* MBEDTLS_CHECK_PARAMS && !MBEDTLS_PARAM_FAILED_ALT */
Simon Butchera6463452018-12-06 17:41:56 +0000211
Manuel Pégourié-Gonnard44c5d582018-12-10 16:56:14 +0100212/**
213 * \brief This macro tests the statement passed to it as a test step or
214 * individual test in a test case. The macro assumes the test will not fail.
215 *
216 * It assumes the library function under test cannot return a value and
217 * assumes errors can only be indicated by calls to
218 * MBEDTLS_PARAM_FAILED().
219 *
220 * When MBEDTLS_CHECK_PARAMS is enabled, calls to the parameter failure
221 * callback, MBEDTLS_PARAM_FAILED(), are assumed to indicate the
222 * expected failure. If MBEDTLS_CHECK_PARAMS is not enabled, no test
223 * can be made.
224 *
Manuel Pégourié-Gonnardcd2b29c2018-12-12 10:23:57 +0100225 * This macro is intended to test that functions returning void
Manuel Pégourié-Gonnard44c5d582018-12-10 16:56:14 +0100226 * accept all of the parameter values they're supposed to accept - eg
227 * that they don't call MBEDTLS_PARAM_FAILED() when a parameter
Manuel Pégourié-Gonnardcd2b29c2018-12-12 10:23:57 +0100228 * that's allowed to be NULL happens to be NULL.
Manuel Pégourié-Gonnard44c5d582018-12-10 16:56:14 +0100229 *
230 * Note: for functions that return something other that void,
231 * checking that they accept all the parameters they're supposed to
232 * accept is best done by using TEST_ASSERT() and checking the return
233 * value as well.
234 *
Manuel Pégourié-Gonnard54e7f312018-12-12 11:56:09 +0100235 * Note: this macro is available even when #MBEDTLS_CHECK_PARAMS is
236 * disabled, as it makes sense to check that the functions accept all
237 * legal values even if this option is disabled - only in that case,
Manuel Pégourié-Gonnarde7306d32018-12-13 09:45:49 +0100238 * the test is more about whether the function segfaults than about
Manuel Pégourié-Gonnard54e7f312018-12-12 11:56:09 +0100239 * whether it invokes MBEDTLS_PARAM_FAILED().
240 *
Manuel Pégourié-Gonnard44c5d582018-12-10 16:56:14 +0100241 * \param TEST The test expression to be tested.
242 */
243#define TEST_VALID_PARAM( TEST ) \
244 TEST_ASSERT( ( TEST, 1 ) );
Simon Butchera6463452018-12-06 17:41:56 +0000245
Gilles Peskine137d31b2019-06-07 14:52:07 +0200246#define TEST_HELPER_ASSERT(a) if( !( a ) ) \
Rich Evans4c091142015-02-02 12:04:10 +0000247{ \
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200248 mbedtls_fprintf( stderr, "Assertion Failed at %s:%d - %s\n", \
Rich Evans4c091142015-02-02 12:04:10 +0000249 __FILE__, __LINE__, #a ); \
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200250 mbedtls_exit( 1 ); \
Rich Evans4c091142015-02-02 12:04:10 +0000251}
252
Ronald Cron07c83f22020-04-06 09:50:58 +0200253#if defined(__GNUC__)
254/* Test if arg and &(arg)[0] have the same type. This is true if arg is
255 * an array but not if it's a pointer. */
256#define IS_ARRAY_NOT_POINTER( arg ) \
257 ( ! __builtin_types_compatible_p( __typeof__( arg ), \
258 __typeof__( &( arg )[0] ) ) )
259#else
260/* On platforms where we don't know how to implement this check,
261 * omit it. Oh well, a non-portable check is better than nothing. */
262#define IS_ARRAY_NOT_POINTER( arg ) 1
263#endif
264
265/* A compile-time constant with the value 0. If `const_expr` is not a
266 * compile-time constant with a nonzero value, cause a compile-time error. */
267#define STATIC_ASSERT_EXPR( const_expr ) \
268 ( 0 && sizeof( struct { int STATIC_ASSERT : 1 - 2 * ! ( const_expr ); } ) )
269/* Return the scalar value `value` (possibly promoted). This is a compile-time
270 * constant if `value` is. `condition` must be a compile-time constant.
271 * If `condition` is false, arrange to cause a compile-time error. */
272#define STATIC_ASSERT_THEN_RETURN( condition, value ) \
273 ( STATIC_ASSERT_EXPR( condition ) ? 0 : ( value ) )
274
275#define ARRAY_LENGTH_UNSAFE( array ) \
276 ( sizeof( array ) / sizeof( *( array ) ) )
277/** Return the number of elements of a static or stack array.
278 *
279 * \param array A value of array (not pointer) type.
280 *
281 * \return The number of elements of the array.
282 */
283#define ARRAY_LENGTH( array ) \
284 ( STATIC_ASSERT_THEN_RETURN( IS_ARRAY_NOT_POINTER( array ), \
285 ARRAY_LENGTH_UNSAFE( array ) ) )
286
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000287/*
288 * 32-bit integer manipulation macros (big endian)
289 */
Paul Bakker5c2364c2012-10-01 14:41:15 +0000290#ifndef GET_UINT32_BE
291#define GET_UINT32_BE(n,b,i) \
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000292{ \
Paul Bakker5c2364c2012-10-01 14:41:15 +0000293 (n) = ( (uint32_t) (b)[(i) ] << 24 ) \
294 | ( (uint32_t) (b)[(i) + 1] << 16 ) \
295 | ( (uint32_t) (b)[(i) + 2] << 8 ) \
296 | ( (uint32_t) (b)[(i) + 3] ); \
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000297}
298#endif
299
Paul Bakker5c2364c2012-10-01 14:41:15 +0000300#ifndef PUT_UINT32_BE
301#define PUT_UINT32_BE(n,b,i) \
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000302{ \
303 (b)[(i) ] = (unsigned char) ( (n) >> 24 ); \
304 (b)[(i) + 1] = (unsigned char) ( (n) >> 16 ); \
305 (b)[(i) + 2] = (unsigned char) ( (n) >> 8 ); \
306 (b)[(i) + 3] = (unsigned char) ( (n) ); \
307}
308#endif
309
SimonB0269dad2016-02-17 23:34:30 +0000310
311/*----------------------------------------------------------------------------*/
SimonB8ca7bc42016-04-17 23:24:50 +0100312/* Global variables */
313
Hanno Beckerd3369f62019-07-05 13:31:30 +0100314typedef enum
315{
316 TEST_RESULT_SUCCESS = 0,
317 TEST_RESULT_FAILED,
318 TEST_RESULT_SKIPPED
319} test_result_t;
320
Andres Amaya Garcia3f50f512017-10-01 16:42:29 +0100321static struct
322{
Simon Butcher6542f6c2018-12-09 22:09:59 +0000323 paramfail_test_state_t paramfail_test_state;
Hanno Beckerd3369f62019-07-05 13:31:30 +0100324 test_result_t result;
Andres Amaya Garcia3f50f512017-10-01 16:42:29 +0100325 const char *test;
326 const char *filename;
327 int line_no;
328}
329test_info;
SimonB8ca7bc42016-04-17 23:24:50 +0100330
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400331#if defined(MBEDTLS_PLATFORM_C)
Andrzej Kurek1152fa82018-04-13 05:15:17 -0400332mbedtls_platform_context platform_ctx;
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400333#endif
SimonB8ca7bc42016-04-17 23:24:50 +0100334
Simon Butchera6463452018-12-06 17:41:56 +0000335#if defined(MBEDTLS_CHECK_PARAMS)
336jmp_buf param_fail_jmp;
Simon Butcher6542f6c2018-12-09 22:09:59 +0000337jmp_buf jmp_tmp;
Simon Butchera6463452018-12-06 17:41:56 +0000338#endif
339
SimonB8ca7bc42016-04-17 23:24:50 +0100340/*----------------------------------------------------------------------------*/
Hanno Becker47deec42017-07-24 12:27:09 +0100341/* Helper flags for complex dependencies */
342
343/* Indicates whether we expect mbedtls_entropy_init
344 * to initialize some strong entropy source. */
345#if defined(MBEDTLS_TEST_NULL_ENTROPY) || \
346 ( !defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES) && \
347 ( !defined(MBEDTLS_NO_PLATFORM_ENTROPY) || \
348 defined(MBEDTLS_HAVEGE_C) || \
349 defined(MBEDTLS_ENTROPY_HARDWARE_ALT) || \
350 defined(ENTROPY_NV_SEED) ) )
Hanno Beckerd4a872e2017-09-07 08:09:33 +0100351#define ENTROPY_HAVE_STRONG
Hanno Becker47deec42017-07-24 12:27:09 +0100352#endif
353
354
355/*----------------------------------------------------------------------------*/
SimonB0269dad2016-02-17 23:34:30 +0000356/* Helper Functions */
Simon Butcher6542f6c2018-12-09 22:09:59 +0000357
Simon Butcherecff2192018-10-03 16:17:41 +0100358void test_fail( const char *test, int line_no, const char* filename )
Simon Butcher6542f6c2018-12-09 22:09:59 +0000359{
Hanno Beckerd3369f62019-07-05 13:31:30 +0100360 test_info.result = TEST_RESULT_FAILED;
361 test_info.test = test;
362 test_info.line_no = line_no;
363 test_info.filename = filename;
364}
365
366void test_skip( const char *test, int line_no, const char* filename )
367{
368 test_info.result = TEST_RESULT_SKIPPED;
Simon Butcher6542f6c2018-12-09 22:09:59 +0000369 test_info.test = test;
370 test_info.line_no = line_no;
371 test_info.filename = filename;
372}
373
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400374static int platform_setup()
375{
Andrzej Kurekf13ca952018-04-18 04:14:31 -0400376 int ret = 0;
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400377#if defined(MBEDTLS_PLATFORM_C)
Andrzej Kurekf13ca952018-04-18 04:14:31 -0400378 ret = mbedtls_platform_setup( &platform_ctx );
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400379#endif /* MBEDTLS_PLATFORM_C */
Andrzej Kurekf13ca952018-04-18 04:14:31 -0400380 return( ret );
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400381}
382
383static void platform_teardown()
384{
385#if defined(MBEDTLS_PLATFORM_C)
386 mbedtls_platform_teardown( &platform_ctx );
387#endif /* MBEDTLS_PLATFORM_C */
388}
SimonB0269dad2016-02-17 23:34:30 +0000389
Simon Butchera6463452018-12-06 17:41:56 +0000390#if defined(MBEDTLS_CHECK_PARAMS)
Manuel Pégourié-Gonnard3ef6a6d2018-12-10 14:31:45 +0100391void mbedtls_param_failed( const char *failure_condition,
392 const char *file,
393 int line )
Simon Butchera6463452018-12-06 17:41:56 +0000394{
Simon Butcher6542f6c2018-12-09 22:09:59 +0000395 /* If we are testing the callback function... */
Manuel Pégourié-Gonnardaae10fa2018-12-12 10:24:19 +0100396 if( test_info.paramfail_test_state == PARAMFAIL_TESTSTATE_PENDING )
Simon Butcher6542f6c2018-12-09 22:09:59 +0000397 {
398 test_info.paramfail_test_state = PARAMFAIL_TESTSTATE_CALLED;
399 }
400 else
401 {
402 /* ...else we treat this as an error */
Simon Butchera6463452018-12-06 17:41:56 +0000403
Simon Butcher6542f6c2018-12-09 22:09:59 +0000404 /* Record the location of the failure, but not as a failure yet, in case
405 * it was part of the test */
406 test_fail( failure_condition, line, file );
Hanno Beckerd3369f62019-07-05 13:31:30 +0100407 test_info.result = TEST_RESULT_SUCCESS;
Simon Butcher6542f6c2018-12-09 22:09:59 +0000408
409 longjmp( param_fail_jmp, 1 );
410 }
Simon Butchera6463452018-12-06 17:41:56 +0000411}
412#endif
413
Janos Follath8ca53b52016-10-05 10:57:49 +0100414#if defined(__unix__) || (defined(__APPLE__) && defined(__MACH__))
415static int redirect_output( FILE** out_stream, const char* path )
416{
417 int stdout_fd = dup( fileno( *out_stream ) );
418
419 if( stdout_fd == -1 )
420 {
421 return -1;
422 }
423
424 fflush( *out_stream );
425 fclose( *out_stream );
426 *out_stream = fopen( path, "w" );
427
428 if( *out_stream == NULL )
429 {
Andres Amaya Garcia687d6732018-11-26 21:23:28 +0000430 close( stdout_fd );
Janos Follath8ca53b52016-10-05 10:57:49 +0100431 return -1;
432 }
433
434 return stdout_fd;
435}
436
437static int restore_output( FILE** out_stream, int old_fd )
438{
439 fflush( *out_stream );
440 fclose( *out_stream );
441
442 *out_stream = fdopen( old_fd, "w" );
443 if( *out_stream == NULL )
444 {
445 return -1;
446 }
447
448 return 0;
449}
Simon Butchere0192962016-10-12 23:07:30 +0100450
Janos Follathe709f7c2016-10-13 11:26:29 +0100451static void close_output( FILE* out_stream )
Simon Butchere0192962016-10-12 23:07:30 +0100452{
Janos Follathe709f7c2016-10-13 11:26:29 +0100453 fclose( out_stream );
Simon Butchere0192962016-10-12 23:07:30 +0100454}
Janos Follath8ca53b52016-10-05 10:57:49 +0100455#endif /* __unix__ || __APPLE__ __MACH__ */
456
Ronald Crona0c9ff32020-06-08 17:05:57 +0200457int mbedtls_test_unhexify( unsigned char *obuf, const char *ibuf )
Paul Bakker367dae42009-06-28 21:50:27 +0000458{
459 unsigned char c, c2;
Rich Evans4c091142015-02-02 12:04:10 +0000460 int len = strlen( ibuf ) / 2;
Gilles Peskine137d31b2019-06-07 14:52:07 +0200461 TEST_HELPER_ASSERT( strlen( ibuf ) % 2 == 0 ); /* must be even number of bytes */
Paul Bakker367dae42009-06-28 21:50:27 +0000462
Rich Evans4c091142015-02-02 12:04:10 +0000463 while( *ibuf != 0 )
Paul Bakker367dae42009-06-28 21:50:27 +0000464 {
465 c = *ibuf++;
466 if( c >= '0' && c <= '9' )
467 c -= '0';
468 else if( c >= 'a' && c <= 'f' )
469 c -= 'a' - 10;
470 else if( c >= 'A' && c <= 'F' )
471 c -= 'A' - 10;
472 else
Gilles Peskine137d31b2019-06-07 14:52:07 +0200473 TEST_HELPER_ASSERT( 0 );
Paul Bakker367dae42009-06-28 21:50:27 +0000474
475 c2 = *ibuf++;
476 if( c2 >= '0' && c2 <= '9' )
477 c2 -= '0';
478 else if( c2 >= 'a' && c2 <= 'f' )
479 c2 -= 'a' - 10;
480 else if( c2 >= 'A' && c2 <= 'F' )
481 c2 -= 'A' - 10;
482 else
Gilles Peskine137d31b2019-06-07 14:52:07 +0200483 TEST_HELPER_ASSERT( 0 );
Paul Bakker367dae42009-06-28 21:50:27 +0000484
485 *obuf++ = ( c << 4 ) | c2;
486 }
487
488 return len;
489}
490
Ronald Crona0c9ff32020-06-08 17:05:57 +0200491void mbedtls_test_hexify( unsigned char *obuf, const unsigned char *ibuf, int len )
Paul Bakker367dae42009-06-28 21:50:27 +0000492{
493 unsigned char l, h;
494
Rich Evans42914452015-02-02 12:09:25 +0000495 while( len != 0 )
Paul Bakker367dae42009-06-28 21:50:27 +0000496 {
Rich Evans42914452015-02-02 12:09:25 +0000497 h = *ibuf / 16;
498 l = *ibuf % 16;
Paul Bakker367dae42009-06-28 21:50:27 +0000499
500 if( h < 10 )
501 *obuf++ = '0' + h;
502 else
503 *obuf++ = 'a' + h - 10;
504
505 if( l < 10 )
506 *obuf++ = '0' + l;
507 else
508 *obuf++ = 'a' + l - 10;
509
510 ++ibuf;
511 len--;
512 }
513}
Paul Bakker9dcc3222011-03-08 14:16:06 +0000514
515/**
Manuel Pégourié-Gonnard0dc5e0d2014-06-13 21:09:26 +0200516 * Allocate and zeroize a buffer.
517 *
518 * If the size if zero, a pointer to a zeroized 1-byte buffer is returned.
519 *
520 * For convenience, dies if allocation fails.
521 */
522static unsigned char *zero_alloc( size_t len )
523{
524 void *p;
Rich Evans42914452015-02-02 12:09:25 +0000525 size_t actual_len = ( len != 0 ) ? len : 1;
Manuel Pégourié-Gonnard0dc5e0d2014-06-13 21:09:26 +0200526
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200527 p = mbedtls_calloc( 1, actual_len );
Gilles Peskine137d31b2019-06-07 14:52:07 +0200528 TEST_HELPER_ASSERT( p != NULL );
Manuel Pégourié-Gonnard0dc5e0d2014-06-13 21:09:26 +0200529
530 memset( p, 0x00, actual_len );
531
532 return( p );
533}
534
535/**
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +0200536 * Allocate and fill a buffer from hex data.
537 *
538 * The buffer is sized exactly as needed. This allows to detect buffer
539 * overruns (including overreads) when running the test suite under valgrind.
540 *
Manuel Pégourié-Gonnard0dc5e0d2014-06-13 21:09:26 +0200541 * If the size if zero, a pointer to a zeroized 1-byte buffer is returned.
542 *
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +0200543 * For convenience, dies if allocation fails.
544 */
Simon Butcherecff2192018-10-03 16:17:41 +0100545unsigned char *unhexify_alloc( const char *ibuf, size_t *olen )
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +0200546{
547 unsigned char *obuf;
548
Rich Evans42914452015-02-02 12:09:25 +0000549 *olen = strlen( ibuf ) / 2;
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +0200550
Manuel Pégourié-Gonnard0dc5e0d2014-06-13 21:09:26 +0200551 if( *olen == 0 )
552 return( zero_alloc( *olen ) );
553
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200554 obuf = mbedtls_calloc( 1, *olen );
Gilles Peskine137d31b2019-06-07 14:52:07 +0200555 TEST_HELPER_ASSERT( obuf != NULL );
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +0200556
Ronald Crona0c9ff32020-06-08 17:05:57 +0200557 (void) mbedtls_test_unhexify( obuf, ibuf );
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +0200558
559 return( obuf );
560}
561
562/**
Paul Bakker9dcc3222011-03-08 14:16:06 +0000563 * This function just returns data from rand().
Paul Bakker997bbd12011-03-13 15:45:42 +0000564 * Although predictable and often similar on multiple
565 * runs, this does not result in identical random on
566 * each run. So do not use this if the results of a
567 * test depend on the random data that is generated.
Paul Bakker9dcc3222011-03-08 14:16:06 +0000568 *
569 * rng_state shall be NULL.
570 */
Paul Bakkera3d195c2011-11-27 21:07:34 +0000571static int rnd_std_rand( void *rng_state, unsigned char *output, size_t len )
Paul Bakker9dcc3222011-03-08 14:16:06 +0000572{
Paul Bakkerf96f7b62014-04-30 16:02:38 +0200573#if !defined(__OpenBSD__)
Paul Bakkera3d195c2011-11-27 21:07:34 +0000574 size_t i;
575
Paul Bakker9dcc3222011-03-08 14:16:06 +0000576 if( rng_state != NULL )
577 rng_state = NULL;
578
Paul Bakkera3d195c2011-11-27 21:07:34 +0000579 for( i = 0; i < len; ++i )
580 output[i] = rand();
Paul Bakkerf96f7b62014-04-30 16:02:38 +0200581#else
582 if( rng_state != NULL )
583 rng_state = NULL;
584
585 arc4random_buf( output, len );
586#endif /* !OpenBSD */
Paul Bakkera3d195c2011-11-27 21:07:34 +0000587
588 return( 0 );
Paul Bakker9dcc3222011-03-08 14:16:06 +0000589}
590
591/**
592 * This function only returns zeros
593 *
594 * rng_state shall be NULL.
595 */
Simon Butcherecff2192018-10-03 16:17:41 +0100596int rnd_zero_rand( void *rng_state, unsigned char *output, size_t len )
Paul Bakker9dcc3222011-03-08 14:16:06 +0000597{
598 if( rng_state != NULL )
599 rng_state = NULL;
600
Paul Bakkera3d195c2011-11-27 21:07:34 +0000601 memset( output, 0, len );
602
Paul Bakker9dcc3222011-03-08 14:16:06 +0000603 return( 0 );
604}
605
606typedef struct
607{
608 unsigned char *buf;
Paul Bakkera3d195c2011-11-27 21:07:34 +0000609 size_t length;
Paul Bakker997bbd12011-03-13 15:45:42 +0000610} rnd_buf_info;
Paul Bakker9dcc3222011-03-08 14:16:06 +0000611
612/**
613 * This function returns random based on a buffer it receives.
614 *
Paul Bakker997bbd12011-03-13 15:45:42 +0000615 * rng_state shall be a pointer to a rnd_buf_info structure.
Manuel Pégourié-Gonnarde670f902015-10-30 09:23:19 +0100616 *
Paul Bakker997bbd12011-03-13 15:45:42 +0000617 * The number of bytes released from the buffer on each call to
618 * the random function is specified by per_call. (Can be between
619 * 1 and 4)
Paul Bakker9dcc3222011-03-08 14:16:06 +0000620 *
621 * After the buffer is empty it will return rand();
622 */
Simon Butcherecff2192018-10-03 16:17:41 +0100623int rnd_buffer_rand( void *rng_state, unsigned char *output, size_t len )
Paul Bakker9dcc3222011-03-08 14:16:06 +0000624{
Paul Bakker997bbd12011-03-13 15:45:42 +0000625 rnd_buf_info *info = (rnd_buf_info *) rng_state;
Paul Bakkera3d195c2011-11-27 21:07:34 +0000626 size_t use_len;
Paul Bakker9dcc3222011-03-08 14:16:06 +0000627
628 if( rng_state == NULL )
Paul Bakkera3d195c2011-11-27 21:07:34 +0000629 return( rnd_std_rand( NULL, output, len ) );
Paul Bakker9dcc3222011-03-08 14:16:06 +0000630
Paul Bakkera3d195c2011-11-27 21:07:34 +0000631 use_len = len;
632 if( len > info->length )
633 use_len = info->length;
Paul Bakker997bbd12011-03-13 15:45:42 +0000634
Paul Bakkera3d195c2011-11-27 21:07:34 +0000635 if( use_len )
Paul Bakker9dcc3222011-03-08 14:16:06 +0000636 {
Paul Bakkera3d195c2011-11-27 21:07:34 +0000637 memcpy( output, info->buf, use_len );
638 info->buf += use_len;
639 info->length -= use_len;
Paul Bakker9dcc3222011-03-08 14:16:06 +0000640 }
641
Paul Bakkera3d195c2011-11-27 21:07:34 +0000642 if( len - use_len > 0 )
643 return( rnd_std_rand( NULL, output + use_len, len - use_len ) );
644
645 return( 0 );
Paul Bakker9dcc3222011-03-08 14:16:06 +0000646}
Paul Bakker997bbd12011-03-13 15:45:42 +0000647
648/**
649 * Info structure for the pseudo random function
650 *
651 * Key should be set at the start to a test-unique value.
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000652 * Do not forget endianness!
Paul Bakker997bbd12011-03-13 15:45:42 +0000653 * State( v0, v1 ) should be set to zero.
654 */
655typedef struct
656{
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000657 uint32_t key[16];
Paul Bakker997bbd12011-03-13 15:45:42 +0000658 uint32_t v0, v1;
659} rnd_pseudo_info;
660
661/**
662 * This function returns random based on a pseudo random function.
663 * This means the results should be identical on all systems.
664 * Pseudo random is based on the XTEA encryption algorithm to
665 * generate pseudorandom.
666 *
667 * rng_state shall be a pointer to a rnd_pseudo_info structure.
668 */
Simon Butcherecff2192018-10-03 16:17:41 +0100669int rnd_pseudo_rand( void *rng_state, unsigned char *output, size_t len )
Paul Bakker997bbd12011-03-13 15:45:42 +0000670{
671 rnd_pseudo_info *info = (rnd_pseudo_info *) rng_state;
Paul Bakkera3d195c2011-11-27 21:07:34 +0000672 uint32_t i, *k, sum, delta=0x9E3779B9;
Manuel Pégourié-Gonnard217a29c2014-01-03 11:59:09 +0100673 unsigned char result[4], *out = output;
Paul Bakker997bbd12011-03-13 15:45:42 +0000674
675 if( rng_state == NULL )
Paul Bakkera3d195c2011-11-27 21:07:34 +0000676 return( rnd_std_rand( NULL, output, len ) );
Paul Bakker997bbd12011-03-13 15:45:42 +0000677
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000678 k = info->key;
Paul Bakkera3d195c2011-11-27 21:07:34 +0000679
680 while( len > 0 )
Paul Bakker997bbd12011-03-13 15:45:42 +0000681 {
Paul Bakker40dd5302012-05-15 15:02:38 +0000682 size_t use_len = ( len > 4 ) ? 4 : len;
Paul Bakkera3d195c2011-11-27 21:07:34 +0000683 sum = 0;
684
Paul Bakkera3d195c2011-11-27 21:07:34 +0000685 for( i = 0; i < 32; i++ )
686 {
Rich Evans42914452015-02-02 12:09:25 +0000687 info->v0 += ( ( ( info->v1 << 4 ) ^ ( info->v1 >> 5 ) )
688 + info->v1 ) ^ ( sum + k[sum & 3] );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000689 sum += delta;
Rich Evans42914452015-02-02 12:09:25 +0000690 info->v1 += ( ( ( info->v0 << 4 ) ^ ( info->v0 >> 5 ) )
691 + info->v0 ) ^ ( sum + k[( sum>>11 ) & 3] );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000692 }
693
Paul Bakker5c2364c2012-10-01 14:41:15 +0000694 PUT_UINT32_BE( info->v0, result, 0 );
Manuel Pégourié-Gonnard217a29c2014-01-03 11:59:09 +0100695 memcpy( out, result, use_len );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000696 len -= use_len;
Manuel Pégourié-Gonnard217a29c2014-01-03 11:59:09 +0100697 out += 4;
Paul Bakker997bbd12011-03-13 15:45:42 +0000698 }
699
Paul Bakkera3d195c2011-11-27 21:07:34 +0000700 return( 0 );
Paul Bakker997bbd12011-03-13 15:45:42 +0000701}
SimonB0269dad2016-02-17 23:34:30 +0000702
Ronald Crond2397942020-06-10 11:03:08 +0200703int mbedtls_test_hexcmp( uint8_t * a, uint8_t * b, uint32_t a_len, uint32_t b_len )
Azim Khan3499a9e2017-05-30 00:06:49 +0100704{
705 int ret = 0;
706 uint32_t i = 0;
707
Manuel Pégourié-Gonnardaae10fa2018-12-12 10:24:19 +0100708 if( a_len != b_len )
Mohammad Azim Khand2d01122018-07-18 17:48:37 +0100709 return( -1 );
Azim Khan3499a9e2017-05-30 00:06:49 +0100710
711 for( i = 0; i < a_len; i++ )
712 {
Manuel Pégourié-Gonnardaae10fa2018-12-12 10:24:19 +0100713 if( a[i] != b[i] )
Azim Khan3499a9e2017-05-30 00:06:49 +0100714 {
715 ret = -1;
716 break;
717 }
718 }
719 return ret;
720}