blob: 00320bca37ec6f4947404d61c8cb0f2f4bde426a [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
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050026#if defined(MBEDTLS_CHECK_PARAMS)
27#include "mbedtls/platform_util.h"
28#include <setjmp.h>
29#endif
30
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
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050073typedef 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
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050086/**
87 * \brief This macro tests the expression passed to it as a test step or
88 * individual test in a test case.
Gilles Peskine8954d0c2018-09-27 13:51:25 +020089 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050090 * It allows a library function to return a value and return an error
91 * code that can be tested.
Gilles Peskine8954d0c2018-09-27 13:51:25 +020092 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050093 * When MBEDTLS_CHECK_PARAMS is enabled, calls to the parameter failure
94 * callback, MBEDTLS_PARAM_FAILED(), will be assumed to be a test
95 * failure.
Gilles Peskine8954d0c2018-09-27 13:51:25 +020096 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050097 * This macro is not suitable for negative parameter validation tests,
98 * as it assumes the test step will not create an error.
99 *
Jaeden Amero67ea2c52019-02-11 12:05:54 +0000100 * Failing the test means:
101 * - Mark this test case as failed.
102 * - Print a message identifying the failure.
103 * - Jump to the \c exit label.
104 *
105 * This macro expands to an instruction, not an expression.
106 * It may jump to the \c exit label.
107 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500108 * \param TEST The test expression to be tested.
Gilles Peskine8954d0c2018-09-27 13:51:25 +0200109 */
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500110#define TEST_ASSERT( TEST ) \
111 do { \
112 if( ! (TEST) ) \
113 { \
114 test_fail( #TEST, __LINE__, __FILE__ ); \
115 goto exit; \
116 } \
SimonB0269dad2016-02-17 23:34:30 +0000117 } while( 0 )
118
Gilles Peskine5f7aeee2018-12-17 23:26:52 +0100119/** Evaluate two expressions and fail the test case if they have different
120 * values.
121 *
122 * \param expr1 An expression to evaluate.
123 * \param expr2 The expected value of \p expr1. This can be any
124 * expression, but it is typically a constant.
125 */
126#define TEST_EQUAL( expr1, expr2 ) \
127 TEST_ASSERT( ( expr1 ) == ( expr2 ) )
128
Gilles Peskineb75125c2018-09-27 13:52:16 +0200129/** Allocate memory dynamically and fail the test case if this fails.
130 *
131 * You must set \p pointer to \c NULL before calling this macro and
132 * put `mbedtls_free( pointer )` in the test's cleanup code.
133 *
Gilles Peskine7f6e3a82018-11-30 18:51:45 +0100134 * If \p length is zero, the resulting \p pointer will be \c NULL.
Gilles Peskineb75125c2018-09-27 13:52:16 +0200135 * This is usually what we want in tests since API functions are
136 * supposed to accept null pointers when a buffer size is zero.
137 *
138 * This macro expands to an instruction, not an expression.
139 * It may jump to the \c exit label.
140 *
141 * \param pointer An lvalue where the address of the allocated buffer
142 * will be stored.
143 * This expression may be evaluated multiple times.
Gilles Peskine7f6e3a82018-11-30 18:51:45 +0100144 * \param length Number of elements to allocate.
Gilles Peskineb75125c2018-09-27 13:52:16 +0200145 * This expression may be evaluated multiple times.
146 *
147 */
Gilles Peskine7f6e3a82018-11-30 18:51:45 +0100148#define ASSERT_ALLOC( pointer, length ) \
149 do \
150 { \
151 TEST_ASSERT( ( pointer ) == NULL ); \
152 if( ( length ) != 0 ) \
153 { \
154 ( pointer ) = mbedtls_calloc( sizeof( *( pointer ) ), \
155 ( length ) ); \
156 TEST_ASSERT( ( pointer ) != NULL ); \
157 } \
158 } \
Gilles Peskineb75125c2018-09-27 13:52:16 +0200159 while( 0 )
160
Gilles Peskine2cd8ecc2019-03-04 17:13:43 +0100161/** Allocate memory dynamically. Exit the test if this fails, but do
162 * not mark the test as failed.
163 *
164 * This macro behaves like #ASSERT_ALLOC, except that if the allocation
165 * fails, it jumps to the \c exit label without calling test_fail().
166 */
167#define ASSERT_ALLOC_WEAK( pointer, length ) \
168 do \
169 { \
170 TEST_ASSERT( ( pointer ) == NULL ); \
171 if( ( length ) != 0 ) \
172 { \
173 ( pointer ) = mbedtls_calloc( sizeof( *( pointer ) ), \
174 ( length ) ); \
175 if( ( pointer ) == NULL ) \
176 goto exit; \
177 } \
178 } \
179 while( 0 )
180
Gilles Peskine3c225962018-09-27 13:56:31 +0200181/** Compare two buffers and fail the test case if they differ.
182 *
183 * This macro expands to an instruction, not an expression.
184 * It may jump to the \c exit label.
185 *
186 * \param p1 Pointer to the start of the first buffer.
187 * \param size1 Size of the first buffer in bytes.
188 * This expression may be evaluated multiple times.
189 * \param p2 Pointer to the start of the second buffer.
190 * \param size2 Size of the second buffer in bytes.
191 * This expression may be evaluated multiple times.
192 */
193#define ASSERT_COMPARE( p1, size1, p2, size2 ) \
194 do \
195 { \
196 TEST_ASSERT( ( size1 ) == ( size2 ) ); \
197 if( ( size1 ) != 0 ) \
198 TEST_ASSERT( memcmp( ( p1 ), ( p2 ), ( size1 ) ) == 0 ); \
199 } \
200 while( 0 )
201
Hanno Beckere69d0152019-07-05 13:31:30 +0100202/**
203 * \brief This macro tests the expression passed to it and skips the
204 * running test if it doesn't evaluate to 'true'.
205 *
206 * \param TEST The test expression to be tested.
207 */
208#define TEST_ASSUME( TEST ) \
209 do { \
210 if( ! (TEST) ) \
211 { \
212 test_skip( #TEST, __LINE__, __FILE__ ); \
213 goto exit; \
214 } \
215 } while( 0 )
216
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500217#if defined(MBEDTLS_CHECK_PARAMS) && !defined(MBEDTLS_PARAM_FAILED_ALT)
218/**
219 * \brief This macro tests the statement passed to it as a test step or
220 * individual test in a test case. The macro assumes the test will fail
221 * and will generate an error.
222 *
223 * It allows a library function to return a value and tests the return
224 * code on return to confirm the given error code was returned.
225 *
226 * When MBEDTLS_CHECK_PARAMS is enabled, calls to the parameter failure
227 * callback, MBEDTLS_PARAM_FAILED(), are assumed to indicate the
228 * expected failure, and the test will pass.
229 *
230 * This macro is intended for negative parameter validation tests,
231 * where the failing function may return an error value or call
232 * MBEDTLS_PARAM_FAILED() to indicate the error.
233 *
234 * \param PARAM_ERROR_VALUE The expected error code.
235 *
236 * \param TEST The test expression to be tested.
237 */
238#define TEST_INVALID_PARAM_RET( PARAM_ERR_VALUE, TEST ) \
239 do { \
240 test_info.paramfail_test_state = PARAMFAIL_TESTSTATE_PENDING; \
241 if( (TEST) != (PARAM_ERR_VALUE) || \
242 test_info.paramfail_test_state != PARAMFAIL_TESTSTATE_CALLED ) \
243 { \
244 test_fail( #TEST, __LINE__, __FILE__ ); \
245 goto exit; \
246 } \
247 } while( 0 )
248
249/**
250 * \brief This macro tests the statement passed to it as a test step or
251 * individual test in a test case. The macro assumes the test will fail
252 * and will generate an error.
253 *
254 * It assumes the library function under test cannot return a value and
255 * assumes errors can only be indicated byt calls to
256 * MBEDTLS_PARAM_FAILED().
257 *
258 * When MBEDTLS_CHECK_PARAMS is enabled, calls to the parameter failure
259 * callback, MBEDTLS_PARAM_FAILED(), are assumed to indicate the
260 * expected failure. If MBEDTLS_CHECK_PARAMS is not enabled, no test
261 * can be made.
262 *
263 * This macro is intended for negative parameter validation tests,
264 * where the failing function can only return an error by calling
265 * MBEDTLS_PARAM_FAILED() to indicate the error.
266 *
267 * \param TEST The test expression to be tested.
268 */
269#define TEST_INVALID_PARAM( TEST ) \
270 do { \
271 memcpy(jmp_tmp, param_fail_jmp, sizeof(jmp_buf)); \
272 if( setjmp( param_fail_jmp ) == 0 ) \
273 { \
274 TEST; \
275 test_fail( #TEST, __LINE__, __FILE__ ); \
276 goto exit; \
277 } \
278 memcpy(param_fail_jmp, jmp_tmp, sizeof(jmp_buf)); \
279 } while( 0 )
280#endif /* MBEDTLS_CHECK_PARAMS && !MBEDTLS_PARAM_FAILED_ALT */
281
282/**
283 * \brief This macro tests the statement passed to it as a test step or
284 * individual test in a test case. The macro assumes the test will not fail.
285 *
286 * It assumes the library function under test cannot return a value and
287 * assumes errors can only be indicated by calls to
288 * MBEDTLS_PARAM_FAILED().
289 *
290 * When MBEDTLS_CHECK_PARAMS is enabled, calls to the parameter failure
291 * callback, MBEDTLS_PARAM_FAILED(), are assumed to indicate the
292 * expected failure. If MBEDTLS_CHECK_PARAMS is not enabled, no test
293 * can be made.
294 *
295 * This macro is intended to test that functions returning void
296 * accept all of the parameter values they're supposed to accept - eg
297 * that they don't call MBEDTLS_PARAM_FAILED() when a parameter
298 * that's allowed to be NULL happens to be NULL.
299 *
300 * Note: for functions that return something other that void,
301 * checking that they accept all the parameters they're supposed to
302 * accept is best done by using TEST_ASSERT() and checking the return
303 * value as well.
304 *
305 * Note: this macro is available even when #MBEDTLS_CHECK_PARAMS is
306 * disabled, as it makes sense to check that the functions accept all
307 * legal values even if this option is disabled - only in that case,
308 * the test is more about whether the function segfaults than about
309 * whether it invokes MBEDTLS_PARAM_FAILED().
310 *
311 * \param TEST The test expression to be tested.
312 */
313#define TEST_VALID_PARAM( TEST ) \
314 TEST_ASSERT( ( TEST, 1 ) );
315
Gilles Peskine9e23bea2019-06-07 14:52:07 +0200316#define TEST_HELPER_ASSERT(a) if( !( a ) ) \
Rich Evans4c091142015-02-02 12:04:10 +0000317{ \
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318 mbedtls_fprintf( stderr, "Assertion Failed at %s:%d - %s\n", \
Rich Evans4c091142015-02-02 12:04:10 +0000319 __FILE__, __LINE__, #a ); \
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320 mbedtls_exit( 1 ); \
Rich Evans4c091142015-02-02 12:04:10 +0000321}
322
Gilles Peskinef055ad72018-12-17 23:18:00 +0100323#if defined(__GNUC__)
324/* Test if arg and &(arg)[0] have the same type. This is true if arg is
325 * an array but not if it's a pointer. */
326#define IS_ARRAY_NOT_POINTER( arg ) \
327 ( ! __builtin_types_compatible_p( __typeof__( arg ), \
328 __typeof__( &( arg )[0] ) ) )
329#else
330/* On platforms where we don't know how to implement this check,
331 * omit it. Oh well, a non-portable check is better than nothing. */
332#define IS_ARRAY_NOT_POINTER( arg ) 1
333#endif
334
335/* A compile-time constant with the value 0. If `const_expr` is not a
336 * compile-time constant with a nonzero value, cause a compile-time error. */
337#define STATIC_ASSERT_EXPR( const_expr ) \
338 ( 0 && sizeof( struct { int STATIC_ASSERT : 1 - 2 * ! ( const_expr ); } ) )
339/* Return the scalar value `value` (possibly promoted). This is a compile-time
340 * constant if `value` is. `condition` must be a compile-time constant.
341 * If `condition` is false, arrange to cause a compile-time error. */
342#define STATIC_ASSERT_THEN_RETURN( condition, value ) \
343 ( STATIC_ASSERT_EXPR( condition ) ? 0 : ( value ) )
344
345#define ARRAY_LENGTH_UNSAFE( array ) \
Gilles Peskine3d2f9492018-12-17 23:17:17 +0100346 ( sizeof( array ) / sizeof( *( array ) ) )
Gilles Peskinef055ad72018-12-17 23:18:00 +0100347/** Return the number of elements of a static or stack array.
348 *
349 * \param array A value of array (not pointer) type.
350 *
351 * \return The number of elements of the array.
352 */
353#define ARRAY_LENGTH( array ) \
354 ( STATIC_ASSERT_THEN_RETURN( IS_ARRAY_NOT_POINTER( array ), \
355 ARRAY_LENGTH_UNSAFE( array ) ) )
356
Gilles Peskinec08fc1d2018-12-18 08:47:00 +0100357/** Return the smaller of two values.
358 *
359 * \param x An integer-valued expression without side effects.
360 * \param y An integer-valued expression without side effects.
361 *
362 * \return The smaller of \p x and \p y.
363 */
364#define MIN( x, y ) ( ( x ) < ( y ) ? ( x ) : ( y ) )
365
366/** Return the larger of two values.
367 *
368 * \param x An integer-valued expression without side effects.
369 * \param y An integer-valued expression without side effects.
370 *
371 * \return The larger of \p x and \p y.
372 */
373#define MAX( x, y ) ( ( x ) > ( y ) ? ( x ) : ( y ) )
Gilles Peskinef055ad72018-12-17 23:18:00 +0100374
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000375/*
376 * 32-bit integer manipulation macros (big endian)
377 */
Paul Bakker5c2364c2012-10-01 14:41:15 +0000378#ifndef GET_UINT32_BE
379#define GET_UINT32_BE(n,b,i) \
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000380{ \
Paul Bakker5c2364c2012-10-01 14:41:15 +0000381 (n) = ( (uint32_t) (b)[(i) ] << 24 ) \
382 | ( (uint32_t) (b)[(i) + 1] << 16 ) \
383 | ( (uint32_t) (b)[(i) + 2] << 8 ) \
384 | ( (uint32_t) (b)[(i) + 3] ); \
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000385}
386#endif
387
Paul Bakker5c2364c2012-10-01 14:41:15 +0000388#ifndef PUT_UINT32_BE
389#define PUT_UINT32_BE(n,b,i) \
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000390{ \
391 (b)[(i) ] = (unsigned char) ( (n) >> 24 ); \
392 (b)[(i) + 1] = (unsigned char) ( (n) >> 16 ); \
393 (b)[(i) + 2] = (unsigned char) ( (n) >> 8 ); \
394 (b)[(i) + 3] = (unsigned char) ( (n) ); \
395}
396#endif
397
SimonB0269dad2016-02-17 23:34:30 +0000398
399/*----------------------------------------------------------------------------*/
SimonB8ca7bc42016-04-17 23:24:50 +0100400/* Global variables */
401
Hanno Beckere69d0152019-07-05 13:31:30 +0100402typedef enum
403{
404 TEST_RESULT_SUCCESS = 0,
405 TEST_RESULT_FAILED,
406 TEST_RESULT_SKIPPED
407} test_result_t;
408
Andres Amaya Garcia3f50f512017-10-01 16:42:29 +0100409static struct
410{
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500411 paramfail_test_state_t paramfail_test_state;
Hanno Beckere69d0152019-07-05 13:31:30 +0100412 test_result_t result;
Andres Amaya Garcia3f50f512017-10-01 16:42:29 +0100413 const char *test;
414 const char *filename;
415 int line_no;
Gilles Peskine56055912019-03-01 14:26:30 +0100416 unsigned long step;
Andres Amaya Garcia3f50f512017-10-01 16:42:29 +0100417}
418test_info;
SimonB8ca7bc42016-04-17 23:24:50 +0100419
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400420#if defined(MBEDTLS_PLATFORM_C)
Andrzej Kurek1152fa82018-04-13 05:15:17 -0400421mbedtls_platform_context platform_ctx;
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400422#endif
SimonB8ca7bc42016-04-17 23:24:50 +0100423
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500424#if defined(MBEDTLS_CHECK_PARAMS)
425jmp_buf param_fail_jmp;
426jmp_buf jmp_tmp;
427#endif
428
SimonB8ca7bc42016-04-17 23:24:50 +0100429/*----------------------------------------------------------------------------*/
Hanno Becker47deec42017-07-24 12:27:09 +0100430/* Helper flags for complex dependencies */
431
432/* Indicates whether we expect mbedtls_entropy_init
433 * to initialize some strong entropy source. */
434#if defined(MBEDTLS_TEST_NULL_ENTROPY) || \
435 ( !defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES) && \
436 ( !defined(MBEDTLS_NO_PLATFORM_ENTROPY) || \
437 defined(MBEDTLS_HAVEGE_C) || \
438 defined(MBEDTLS_ENTROPY_HARDWARE_ALT) || \
439 defined(ENTROPY_NV_SEED) ) )
Hanno Beckerd4a872e2017-09-07 08:09:33 +0100440#define ENTROPY_HAVE_STRONG
Hanno Becker47deec42017-07-24 12:27:09 +0100441#endif
442
443
444/*----------------------------------------------------------------------------*/
SimonB0269dad2016-02-17 23:34:30 +0000445/* Helper Functions */
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500446
Gilles Peskine56055912019-03-01 14:26:30 +0100447/** Set the test step number for failure reports.
448 *
449 * Call this function to display "step NNN" in addition to the line number
450 * and file name if a test fails. Typically the "step number" is the index
451 * of a for loop but it can be whatever you want.
452 *
453 * \param step The step number to report.
454 */
455void test_set_step( unsigned long step )
456{
457 test_info.step = step;
458}
459
Simon Butcherecff2192018-10-03 16:17:41 +0100460void test_fail( const char *test, int line_no, const char* filename )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500461{
Hanno Beckere69d0152019-07-05 13:31:30 +0100462 test_info.result = TEST_RESULT_FAILED;
463 test_info.test = test;
464 test_info.line_no = line_no;
465 test_info.filename = filename;
466}
467
468void test_skip( const char *test, int line_no, const char* filename )
469{
470 test_info.result = TEST_RESULT_SKIPPED;
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500471 test_info.test = test;
472 test_info.line_no = line_no;
473 test_info.filename = filename;
474}
475
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400476static int platform_setup()
477{
Andrzej Kurekf13ca952018-04-18 04:14:31 -0400478 int ret = 0;
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400479#if defined(MBEDTLS_PLATFORM_C)
Andrzej Kurekf13ca952018-04-18 04:14:31 -0400480 ret = mbedtls_platform_setup( &platform_ctx );
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400481#endif /* MBEDTLS_PLATFORM_C */
Andrzej Kurekf13ca952018-04-18 04:14:31 -0400482 return( ret );
Andrzej Kurek32a675f2018-04-13 06:16:04 -0400483}
484
485static void platform_teardown()
486{
487#if defined(MBEDTLS_PLATFORM_C)
488 mbedtls_platform_teardown( &platform_ctx );
489#endif /* MBEDTLS_PLATFORM_C */
490}
SimonB0269dad2016-02-17 23:34:30 +0000491
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500492#if defined(MBEDTLS_CHECK_PARAMS)
493void mbedtls_param_failed( const char *failure_condition,
494 const char *file,
495 int line )
496{
497 /* If we are testing the callback function... */
498 if( test_info.paramfail_test_state == PARAMFAIL_TESTSTATE_PENDING )
499 {
500 test_info.paramfail_test_state = PARAMFAIL_TESTSTATE_CALLED;
501 }
502 else
503 {
504 /* ...else we treat this as an error */
505
506 /* Record the location of the failure, but not as a failure yet, in case
507 * it was part of the test */
508 test_fail( failure_condition, line, file );
Hanno Beckere69d0152019-07-05 13:31:30 +0100509 test_info.result = TEST_RESULT_SUCCESS;
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500510
511 longjmp( param_fail_jmp, 1 );
512 }
513}
514#endif
515
Janos Follath8ca53b52016-10-05 10:57:49 +0100516#if defined(__unix__) || (defined(__APPLE__) && defined(__MACH__))
517static int redirect_output( FILE** out_stream, const char* path )
518{
519 int stdout_fd = dup( fileno( *out_stream ) );
520
521 if( stdout_fd == -1 )
522 {
523 return -1;
524 }
525
526 fflush( *out_stream );
527 fclose( *out_stream );
528 *out_stream = fopen( path, "w" );
529
530 if( *out_stream == NULL )
531 {
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500532 close( stdout_fd );
Janos Follath8ca53b52016-10-05 10:57:49 +0100533 return -1;
534 }
535
536 return stdout_fd;
537}
538
539static int restore_output( FILE** out_stream, int old_fd )
540{
541 fflush( *out_stream );
542 fclose( *out_stream );
543
544 *out_stream = fdopen( old_fd, "w" );
545 if( *out_stream == NULL )
546 {
547 return -1;
548 }
549
550 return 0;
551}
Simon Butchere0192962016-10-12 23:07:30 +0100552
Janos Follathe709f7c2016-10-13 11:26:29 +0100553static void close_output( FILE* out_stream )
Simon Butchere0192962016-10-12 23:07:30 +0100554{
Janos Follathe709f7c2016-10-13 11:26:29 +0100555 fclose( out_stream );
Simon Butchere0192962016-10-12 23:07:30 +0100556}
Janos Follath8ca53b52016-10-05 10:57:49 +0100557#endif /* __unix__ || __APPLE__ __MACH__ */
558
Simon Butcherecff2192018-10-03 16:17:41 +0100559int unhexify( unsigned char *obuf, const char *ibuf )
Paul Bakker367dae42009-06-28 21:50:27 +0000560{
561 unsigned char c, c2;
Rich Evans4c091142015-02-02 12:04:10 +0000562 int len = strlen( ibuf ) / 2;
Gilles Peskine9e23bea2019-06-07 14:52:07 +0200563 TEST_HELPER_ASSERT( strlen( ibuf ) % 2 == 0 ); /* must be even number of bytes */
Paul Bakker367dae42009-06-28 21:50:27 +0000564
Rich Evans4c091142015-02-02 12:04:10 +0000565 while( *ibuf != 0 )
Paul Bakker367dae42009-06-28 21:50:27 +0000566 {
567 c = *ibuf++;
568 if( c >= '0' && c <= '9' )
569 c -= '0';
570 else if( c >= 'a' && c <= 'f' )
571 c -= 'a' - 10;
572 else if( c >= 'A' && c <= 'F' )
573 c -= 'A' - 10;
574 else
Gilles Peskine9e23bea2019-06-07 14:52:07 +0200575 TEST_HELPER_ASSERT( 0 );
Paul Bakker367dae42009-06-28 21:50:27 +0000576
577 c2 = *ibuf++;
578 if( c2 >= '0' && c2 <= '9' )
579 c2 -= '0';
580 else if( c2 >= 'a' && c2 <= 'f' )
581 c2 -= 'a' - 10;
582 else if( c2 >= 'A' && c2 <= 'F' )
583 c2 -= 'A' - 10;
584 else
Gilles Peskine9e23bea2019-06-07 14:52:07 +0200585 TEST_HELPER_ASSERT( 0 );
Paul Bakker367dae42009-06-28 21:50:27 +0000586
587 *obuf++ = ( c << 4 ) | c2;
588 }
589
590 return len;
591}
592
Simon Butcherecff2192018-10-03 16:17:41 +0100593void hexify( unsigned char *obuf, const unsigned char *ibuf, int len )
Paul Bakker367dae42009-06-28 21:50:27 +0000594{
595 unsigned char l, h;
596
Rich Evans42914452015-02-02 12:09:25 +0000597 while( len != 0 )
Paul Bakker367dae42009-06-28 21:50:27 +0000598 {
Rich Evans42914452015-02-02 12:09:25 +0000599 h = *ibuf / 16;
600 l = *ibuf % 16;
Paul Bakker367dae42009-06-28 21:50:27 +0000601
602 if( h < 10 )
603 *obuf++ = '0' + h;
604 else
605 *obuf++ = 'a' + h - 10;
606
607 if( l < 10 )
608 *obuf++ = '0' + l;
609 else
610 *obuf++ = 'a' + l - 10;
611
612 ++ibuf;
613 len--;
614 }
615}
Paul Bakker9dcc3222011-03-08 14:16:06 +0000616
617/**
Manuel Pégourié-Gonnard0dc5e0d2014-06-13 21:09:26 +0200618 * Allocate and zeroize a buffer.
619 *
620 * If the size if zero, a pointer to a zeroized 1-byte buffer is returned.
621 *
622 * For convenience, dies if allocation fails.
623 */
624static unsigned char *zero_alloc( size_t len )
625{
626 void *p;
Rich Evans42914452015-02-02 12:09:25 +0000627 size_t actual_len = ( len != 0 ) ? len : 1;
Manuel Pégourié-Gonnard0dc5e0d2014-06-13 21:09:26 +0200628
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200629 p = mbedtls_calloc( 1, actual_len );
Gilles Peskine9e23bea2019-06-07 14:52:07 +0200630 TEST_HELPER_ASSERT( p != NULL );
Manuel Pégourié-Gonnard0dc5e0d2014-06-13 21:09:26 +0200631
632 memset( p, 0x00, actual_len );
633
634 return( p );
635}
636
637/**
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +0200638 * Allocate and fill a buffer from hex data.
639 *
640 * The buffer is sized exactly as needed. This allows to detect buffer
641 * overruns (including overreads) when running the test suite under valgrind.
642 *
Manuel Pégourié-Gonnard0dc5e0d2014-06-13 21:09:26 +0200643 * If the size if zero, a pointer to a zeroized 1-byte buffer is returned.
644 *
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +0200645 * For convenience, dies if allocation fails.
646 */
Simon Butcherecff2192018-10-03 16:17:41 +0100647unsigned char *unhexify_alloc( const char *ibuf, size_t *olen )
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +0200648{
649 unsigned char *obuf;
650
Rich Evans42914452015-02-02 12:09:25 +0000651 *olen = strlen( ibuf ) / 2;
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +0200652
Manuel Pégourié-Gonnard0dc5e0d2014-06-13 21:09:26 +0200653 if( *olen == 0 )
654 return( zero_alloc( *olen ) );
655
Manuel Pégourié-Gonnard7551cb92015-05-26 16:04:06 +0200656 obuf = mbedtls_calloc( 1, *olen );
Gilles Peskine9e23bea2019-06-07 14:52:07 +0200657 TEST_HELPER_ASSERT( obuf != NULL );
Manuel Pégourié-Gonnard3d49b9d2014-06-06 14:48:09 +0200658
659 (void) unhexify( obuf, ibuf );
660
661 return( obuf );
662}
663
664/**
Paul Bakker9dcc3222011-03-08 14:16:06 +0000665 * This function just returns data from rand().
Paul Bakker997bbd12011-03-13 15:45:42 +0000666 * Although predictable and often similar on multiple
667 * runs, this does not result in identical random on
668 * each run. So do not use this if the results of a
669 * test depend on the random data that is generated.
Paul Bakker9dcc3222011-03-08 14:16:06 +0000670 *
671 * rng_state shall be NULL.
672 */
Paul Bakkera3d195c2011-11-27 21:07:34 +0000673static int rnd_std_rand( void *rng_state, unsigned char *output, size_t len )
Paul Bakker9dcc3222011-03-08 14:16:06 +0000674{
Paul Bakkerf96f7b62014-04-30 16:02:38 +0200675#if !defined(__OpenBSD__)
Paul Bakkera3d195c2011-11-27 21:07:34 +0000676 size_t i;
677
Paul Bakker9dcc3222011-03-08 14:16:06 +0000678 if( rng_state != NULL )
679 rng_state = NULL;
680
Paul Bakkera3d195c2011-11-27 21:07:34 +0000681 for( i = 0; i < len; ++i )
682 output[i] = rand();
Paul Bakkerf96f7b62014-04-30 16:02:38 +0200683#else
684 if( rng_state != NULL )
685 rng_state = NULL;
686
687 arc4random_buf( output, len );
688#endif /* !OpenBSD */
Paul Bakkera3d195c2011-11-27 21:07:34 +0000689
690 return( 0 );
Paul Bakker9dcc3222011-03-08 14:16:06 +0000691}
692
693/**
694 * This function only returns zeros
695 *
696 * rng_state shall be NULL.
697 */
Simon Butcherecff2192018-10-03 16:17:41 +0100698int rnd_zero_rand( void *rng_state, unsigned char *output, size_t len )
Paul Bakker9dcc3222011-03-08 14:16:06 +0000699{
700 if( rng_state != NULL )
701 rng_state = NULL;
702
Paul Bakkera3d195c2011-11-27 21:07:34 +0000703 memset( output, 0, len );
704
Paul Bakker9dcc3222011-03-08 14:16:06 +0000705 return( 0 );
706}
707
708typedef struct
709{
710 unsigned char *buf;
Paul Bakkera3d195c2011-11-27 21:07:34 +0000711 size_t length;
Paul Bakker997bbd12011-03-13 15:45:42 +0000712} rnd_buf_info;
Paul Bakker9dcc3222011-03-08 14:16:06 +0000713
714/**
715 * This function returns random based on a buffer it receives.
716 *
Paul Bakker997bbd12011-03-13 15:45:42 +0000717 * rng_state shall be a pointer to a rnd_buf_info structure.
Manuel Pégourié-Gonnarde670f902015-10-30 09:23:19 +0100718 *
Paul Bakker997bbd12011-03-13 15:45:42 +0000719 * The number of bytes released from the buffer on each call to
720 * the random function is specified by per_call. (Can be between
721 * 1 and 4)
Paul Bakker9dcc3222011-03-08 14:16:06 +0000722 *
723 * After the buffer is empty it will return rand();
724 */
Simon Butcherecff2192018-10-03 16:17:41 +0100725int rnd_buffer_rand( void *rng_state, unsigned char *output, size_t len )
Paul Bakker9dcc3222011-03-08 14:16:06 +0000726{
Paul Bakker997bbd12011-03-13 15:45:42 +0000727 rnd_buf_info *info = (rnd_buf_info *) rng_state;
Paul Bakkera3d195c2011-11-27 21:07:34 +0000728 size_t use_len;
Paul Bakker9dcc3222011-03-08 14:16:06 +0000729
730 if( rng_state == NULL )
Paul Bakkera3d195c2011-11-27 21:07:34 +0000731 return( rnd_std_rand( NULL, output, len ) );
Paul Bakker9dcc3222011-03-08 14:16:06 +0000732
Paul Bakkera3d195c2011-11-27 21:07:34 +0000733 use_len = len;
734 if( len > info->length )
735 use_len = info->length;
Paul Bakker997bbd12011-03-13 15:45:42 +0000736
Paul Bakkera3d195c2011-11-27 21:07:34 +0000737 if( use_len )
Paul Bakker9dcc3222011-03-08 14:16:06 +0000738 {
Paul Bakkera3d195c2011-11-27 21:07:34 +0000739 memcpy( output, info->buf, use_len );
740 info->buf += use_len;
741 info->length -= use_len;
Paul Bakker9dcc3222011-03-08 14:16:06 +0000742 }
743
Paul Bakkera3d195c2011-11-27 21:07:34 +0000744 if( len - use_len > 0 )
745 return( rnd_std_rand( NULL, output + use_len, len - use_len ) );
746
747 return( 0 );
Paul Bakker9dcc3222011-03-08 14:16:06 +0000748}
Paul Bakker997bbd12011-03-13 15:45:42 +0000749
750/**
751 * Info structure for the pseudo random function
752 *
753 * Key should be set at the start to a test-unique value.
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000754 * Do not forget endianness!
Paul Bakker997bbd12011-03-13 15:45:42 +0000755 * State( v0, v1 ) should be set to zero.
756 */
757typedef struct
758{
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000759 uint32_t key[16];
Paul Bakker997bbd12011-03-13 15:45:42 +0000760 uint32_t v0, v1;
761} rnd_pseudo_info;
762
763/**
764 * This function returns random based on a pseudo random function.
765 * This means the results should be identical on all systems.
766 * Pseudo random is based on the XTEA encryption algorithm to
767 * generate pseudorandom.
768 *
769 * rng_state shall be a pointer to a rnd_pseudo_info structure.
770 */
Simon Butcherecff2192018-10-03 16:17:41 +0100771int rnd_pseudo_rand( void *rng_state, unsigned char *output, size_t len )
Paul Bakker997bbd12011-03-13 15:45:42 +0000772{
773 rnd_pseudo_info *info = (rnd_pseudo_info *) rng_state;
Paul Bakkera3d195c2011-11-27 21:07:34 +0000774 uint32_t i, *k, sum, delta=0x9E3779B9;
Manuel Pégourié-Gonnard217a29c2014-01-03 11:59:09 +0100775 unsigned char result[4], *out = output;
Paul Bakker997bbd12011-03-13 15:45:42 +0000776
777 if( rng_state == NULL )
Paul Bakkera3d195c2011-11-27 21:07:34 +0000778 return( rnd_std_rand( NULL, output, len ) );
Paul Bakker997bbd12011-03-13 15:45:42 +0000779
Paul Bakkerb3dcbc12011-03-13 16:57:25 +0000780 k = info->key;
Paul Bakkera3d195c2011-11-27 21:07:34 +0000781
782 while( len > 0 )
Paul Bakker997bbd12011-03-13 15:45:42 +0000783 {
Paul Bakker40dd5302012-05-15 15:02:38 +0000784 size_t use_len = ( len > 4 ) ? 4 : len;
Paul Bakkera3d195c2011-11-27 21:07:34 +0000785 sum = 0;
786
Paul Bakkera3d195c2011-11-27 21:07:34 +0000787 for( i = 0; i < 32; i++ )
788 {
Rich Evans42914452015-02-02 12:09:25 +0000789 info->v0 += ( ( ( info->v1 << 4 ) ^ ( info->v1 >> 5 ) )
790 + info->v1 ) ^ ( sum + k[sum & 3] );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000791 sum += delta;
Rich Evans42914452015-02-02 12:09:25 +0000792 info->v1 += ( ( ( info->v0 << 4 ) ^ ( info->v0 >> 5 ) )
793 + info->v0 ) ^ ( sum + k[( sum>>11 ) & 3] );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000794 }
795
Paul Bakker5c2364c2012-10-01 14:41:15 +0000796 PUT_UINT32_BE( info->v0, result, 0 );
Manuel Pégourié-Gonnard217a29c2014-01-03 11:59:09 +0100797 memcpy( out, result, use_len );
Paul Bakkera3d195c2011-11-27 21:07:34 +0000798 len -= use_len;
Manuel Pégourié-Gonnard217a29c2014-01-03 11:59:09 +0100799 out += 4;
Paul Bakker997bbd12011-03-13 15:45:42 +0000800 }
801
Paul Bakkera3d195c2011-11-27 21:07:34 +0000802 return( 0 );
Paul Bakker997bbd12011-03-13 15:45:42 +0000803}
SimonB0269dad2016-02-17 23:34:30 +0000804
Mohammad Azim Khand2d01122018-07-18 17:48:37 +0100805int hexcmp( uint8_t * a, uint8_t * b, uint32_t a_len, uint32_t b_len )
Azim Khan3499a9e2017-05-30 00:06:49 +0100806{
807 int ret = 0;
808 uint32_t i = 0;
809
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500810 if( a_len != b_len )
Mohammad Azim Khand2d01122018-07-18 17:48:37 +0100811 return( -1 );
Azim Khan3499a9e2017-05-30 00:06:49 +0100812
813 for( i = 0; i < a_len; i++ )
814 {
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500815 if( a[i] != b[i] )
Azim Khan3499a9e2017-05-30 00:06:49 +0100816 {
817 ret = -1;
818 break;
819 }
820 }
821 return ret;
822}