1 /* 2 * Copyright 2014-2022 The OpenSSL Project Authors. All Rights Reserved. 3 * 4 * Licensed under the Apache License 2.0 (the "License"). You may not use 5 * this file except in compliance with the License. You can obtain a copy 6 * in the file LICENSE in the source distribution or at 7 * https://www.openssl.org/source/license.html 8 */ 9 10 #ifndef OSSL_TESTUTIL_H 11 # define OSSL_TESTUTIL_H 12 13 # include <stdarg.h> 14 15 # include <openssl/provider.h> 16 # include <openssl/err.h> 17 # include <openssl/e_os2.h> 18 # include <openssl/bn.h> 19 # include <openssl/x509.h> 20 # include "opt.h" 21 22 /*- 23 * Simple unit tests should implement setup_tests(). 24 * This function should return zero if the registration process fails. 25 * To register tests, call ADD_TEST or ADD_ALL_TESTS: 26 * 27 * int setup_tests(void) 28 * { 29 * ADD_TEST(test_foo); 30 * ADD_ALL_TESTS(test_bar, num_test_bar); 31 * return 1; 32 * } 33 * 34 * Tests that require clean up after execution should implement: 35 * 36 * void cleanup_tests(void); 37 * 38 * The cleanup_tests function will be called even if setup_tests() 39 * returns failure. 40 * 41 * In some cases, early initialization before the framework is set up 42 * may be needed. In such a case, this should be implemented: 43 * 44 * int global_init(void); 45 * 46 * This function should return zero if there is an unrecoverable error and 47 * non-zero if the initialization was successful. 48 */ 49 50 /* Adds a simple test case. */ 51 # define ADD_TEST(test_function) add_test(#test_function, test_function) 52 53 /* 54 * Simple parameterized tests. Calls test_function(idx) for each 0 <= idx < num. 55 */ 56 # define ADD_ALL_TESTS(test_function, num) \ 57 add_all_tests(#test_function, test_function, num, 1) 58 /* 59 * A variant of the same without TAP output. 60 */ 61 # define ADD_ALL_TESTS_NOSUBTEST(test_function, num) \ 62 add_all_tests(#test_function, test_function, num, 0) 63 64 /*- 65 * Test cases that share common setup should use the helper 66 * SETUP_TEST_FIXTURE and EXECUTE_TEST macros for test case functions. 67 * 68 * SETUP_TEST_FIXTURE will call set_up() to create a new TEST_FIXTURE_TYPE 69 * object called "fixture". It will also allocate the "result" variable used 70 * by EXECUTE_TEST. set_up() should take a const char* specifying the test 71 * case name and return a TEST_FIXTURE_TYPE by reference. 72 * If case set_up() fails then 0 is returned. 73 * 74 * EXECUTE_TEST will pass fixture to execute_func() by reference, call 75 * tear_down(), and return the result of execute_func(). execute_func() should 76 * take a TEST_FIXTURE_TYPE by reference and return 1 on success and 0 on 77 * failure. The tear_down function is responsible for deallocation of the 78 * result variable, if required. 79 * 80 * Unit tests can define their own SETUP_TEST_FIXTURE and EXECUTE_TEST 81 * variations like so: 82 * 83 * #define SETUP_FOOBAR_TEST_FIXTURE()\ 84 * SETUP_TEST_FIXTURE(FOOBAR_TEST_FIXTURE, set_up_foobar) 85 * 86 * #define EXECUTE_FOOBAR_TEST()\ 87 * EXECUTE_TEST(execute_foobar, tear_down_foobar) 88 * 89 * Then test case functions can take the form: 90 * 91 * static int test_foobar_feature() 92 * { 93 * SETUP_FOOBAR_TEST_FIXTURE(); 94 * [...set individual members of fixture...] 95 * EXECUTE_FOOBAR_TEST(); 96 * } 97 */ 98 # define SETUP_TEST_FIXTURE(TEST_FIXTURE_TYPE, set_up)\ 99 TEST_FIXTURE_TYPE *fixture = set_up(TEST_CASE_NAME); \ 100 int result = 0; \ 101 \ 102 if (fixture == NULL) \ 103 return 0 104 105 106 # define EXECUTE_TEST(execute_func, tear_down)\ 107 if (fixture != NULL) {\ 108 result = execute_func(fixture);\ 109 tear_down(fixture);\ 110 } 111 112 /* 113 * TEST_CASE_NAME is defined as the name of the test case function where 114 * possible; otherwise we get by with the file name and line number. 115 */ 116 # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L 117 # if defined(_MSC_VER) 118 # define TEST_CASE_NAME __FUNCTION__ 119 # else 120 # define testutil_stringify_helper(s) #s 121 # define testutil_stringify(s) testutil_stringify_helper(s) 122 # define TEST_CASE_NAME __FILE__ ":" testutil_stringify(__LINE__) 123 # endif /* _MSC_VER */ 124 # else 125 # define TEST_CASE_NAME __func__ 126 # endif /* __STDC_VERSION__ */ 127 128 129 /* The default test enum which should be common to all tests */ 130 # define OPT_TEST_ENUM \ 131 OPT_TEST_HELP = 500, \ 132 OPT_TEST_LIST, \ 133 OPT_TEST_SINGLE, \ 134 OPT_TEST_ITERATION, \ 135 OPT_TEST_INDENT, \ 136 OPT_TEST_SEED 137 138 /* The Default test OPTIONS common to all tests (without a usage string) */ 139 # define OPT_TEST_OPTIONS \ 140 { OPT_HELP_STR, 1, '-', "Valid options are:\n" }, \ 141 { "help", OPT_TEST_HELP, '-', "Display this summary" }, \ 142 { "list", OPT_TEST_LIST, '-', "Display the list of tests available" }, \ 143 { "test", OPT_TEST_SINGLE, 's', "Run a single test by id or name" }, \ 144 { "iter", OPT_TEST_ITERATION, 'n', "Run a single iteration of a test" }, \ 145 { "indent", OPT_TEST_INDENT,'p', "Number of tabs added to output" }, \ 146 { "seed", OPT_TEST_SEED, 'n', "Seed value to randomize tests with" } 147 148 /* The Default test OPTIONS common to all tests starting with an additional usage string */ 149 # define OPT_TEST_OPTIONS_WITH_EXTRA_USAGE(usage) \ 150 { OPT_HELP_STR, 1, '-', "Usage: %s [options] " usage }, \ 151 OPT_TEST_OPTIONS 152 153 /* The Default test OPTIONS common to all tests with an default usage string */ 154 # define OPT_TEST_OPTIONS_DEFAULT_USAGE \ 155 { OPT_HELP_STR, 1, '-', "Usage: %s [options]\n" }, \ 156 OPT_TEST_OPTIONS 157 158 /* 159 * Optional Cases that need to be ignored by the test app when using opt_next(), 160 * (that are handled internally). 161 */ 162 # define OPT_TEST_CASES \ 163 OPT_TEST_HELP: \ 164 case OPT_TEST_LIST: \ 165 case OPT_TEST_SINGLE: \ 166 case OPT_TEST_ITERATION: \ 167 case OPT_TEST_INDENT: \ 168 case OPT_TEST_SEED 169 170 /* 171 * Tests that use test_get_argument() that dont have any additional options 172 * (i.e- dont use opt_next()) can use this to set the usage string. 173 * It embeds test_get_options() which gives default command line options for 174 * the test system. 175 * 176 * Tests that need to use opt_next() need to specify 177 * (1) test_get_options() containing an options[] which should include either 178 * OPT_TEST_OPTIONS_DEFAULT_USAGE or 179 * OPT_TEST_OPTIONS_WITH_EXTRA_USAGE(...). 180 * (2) An enum outside the test_get_options() which contains OPT_TEST_ENUM, as 181 * well as the additional options that need to be handled. 182 * (3) case OPT_TEST_CASES: break; inside the opt_next() handling code. 183 */ 184 # define OPT_TEST_DECLARE_USAGE(usage_str) \ 185 const OPTIONS *test_get_options(void) \ 186 { \ 187 enum { OPT_TEST_ENUM }; \ 188 static const OPTIONS options[] = { \ 189 OPT_TEST_OPTIONS_WITH_EXTRA_USAGE(usage_str), \ 190 { NULL } \ 191 }; \ 192 return options; \ 193 } 194 195 /* 196 * Used to read non optional command line values that follow after the options. 197 * Returns NULL if there is no argument. 198 */ 199 char *test_get_argument(size_t n); 200 /* Return the number of additional non optional command line arguments */ 201 size_t test_get_argument_count(void); 202 203 /* 204 * Skip over common test options. Should be called before calling 205 * test_get_argument() 206 */ 207 int test_skip_common_options(void); 208 209 /* 210 * Get a library context for the tests, populated with the specified provider 211 * and configuration. If default_null_prov is not NULL, a "null" provider is 212 * loaded into the default library context to prevent it being used. 213 * If libctx is NULL, the specified provider is loaded into the default library 214 * context. 215 */ 216 int test_get_libctx(OSSL_LIB_CTX **libctx, OSSL_PROVIDER **default_null_prov, 217 const char *config_file, 218 OSSL_PROVIDER **provider, const char *module_name); 219 int test_arg_libctx(OSSL_LIB_CTX **libctx, OSSL_PROVIDER **default_null_prov, 220 OSSL_PROVIDER **provider, int argn, const char *usage); 221 222 /* 223 * Internal helpers. Test programs shouldn't use these directly, but should 224 * rather link to one of the helper main() methods. 225 */ 226 227 void add_test(const char *test_case_name, int (*test_fn) (void)); 228 void add_all_tests(const char *test_case_name, int (*test_fn)(int idx), int num, 229 int subtest); 230 231 /* 232 * Declarations for user defined functions. 233 * The first two return a boolean indicating that the test should not proceed. 234 */ 235 int global_init(void); 236 int setup_tests(void); 237 void cleanup_tests(void); 238 239 /* 240 * Helper functions to detect specific versions of the FIPS provider being in use. 241 * Because of FIPS rules, code changes after a module has been validated are 242 * difficult and because we provide a hard guarantee of ABI and behavioural 243 * stability going forwards, it is a requirement to have tests be conditional 244 * on specific FIPS provider versions. Without this, bug fixes cannot be tested 245 * in later releases. 246 * 247 * The reason for not including e.g. a less than test is to help avoid any 248 * temptation to use FIPS provider version numbers that don't exist. Until the 249 * `new' provider is validated, its version isn't set in stone. Thus a change 250 * in test behaviour must depend on already validated module versions only. 251 * 252 * In all cases, the function returns true if: 253 * 1. the FIPS provider version matches the criteria specified or 254 * 2. the FIPS provider isn't being used. 255 */ 256 int fips_provider_version_eq(OSSL_LIB_CTX *libctx, int major, int minor, int patch); 257 int fips_provider_version_ne(OSSL_LIB_CTX *libctx, int major, int minor, int patch); 258 int fips_provider_version_le(OSSL_LIB_CTX *libctx, int major, int minor, int patch); 259 int fips_provider_version_lt(OSSL_LIB_CTX *libctx, int major, int minor, int patch); 260 int fips_provider_version_gt(OSSL_LIB_CTX *libctx, int major, int minor, int patch); 261 int fips_provider_version_ge(OSSL_LIB_CTX *libctx, int major, int minor, int patch); 262 263 /* 264 * This function matches fips provider version with (potentially multiple) 265 * <operator>maj.min.patch version strings in versions. 266 * The operator can be one of = ! <= or > comparison symbols. 267 * If the fips provider matches all the version comparisons (or if there is no 268 * fips provider available) the function returns 1. 269 * If the fips provider does not match the version comparisons, it returns 0. 270 * On error the function returns -1. 271 */ 272 int fips_provider_version_match(OSSL_LIB_CTX *libctx, const char *versions); 273 274 /* 275 * Used to supply test specific command line options, 276 * If non optional parameters are used, then the first entry in the OPTIONS[] 277 * should contain: 278 * { OPT_HELP_STR, 1, '-', "<list of non-optional commandline params>\n"}, 279 * The last entry should always be { NULL }. 280 * 281 * Run the test locally using './test/test_name -help' to check the usage. 282 */ 283 const OPTIONS *test_get_options(void); 284 285 /* 286 * Test assumption verification helpers. 287 */ 288 289 # define PRINTF_FORMAT(a, b) 290 # if defined(__GNUC__) && defined(__STDC_VERSION__) \ 291 && !defined(__MINGW32__) && !defined(__MINGW64__) \ 292 && !defined(__APPLE__) 293 /* 294 * Because we support the 'z' modifier, which made its appearance in C99, 295 * we can't use __attribute__ with pre C99 dialects. 296 */ 297 # if __STDC_VERSION__ >= 199901L 298 # undef PRINTF_FORMAT 299 # define PRINTF_FORMAT(a, b) __attribute__ ((format(printf, a, b))) 300 # endif 301 # endif 302 303 # define DECLARE_COMPARISON(type, name, opname) \ 304 int test_ ## name ## _ ## opname(const char *, int, \ 305 const char *, const char *, \ 306 const type, const type); 307 308 # define DECLARE_COMPARISONS(type, name) \ 309 DECLARE_COMPARISON(type, name, eq) \ 310 DECLARE_COMPARISON(type, name, ne) \ 311 DECLARE_COMPARISON(type, name, lt) \ 312 DECLARE_COMPARISON(type, name, le) \ 313 DECLARE_COMPARISON(type, name, gt) \ 314 DECLARE_COMPARISON(type, name, ge) 315 316 DECLARE_COMPARISONS(int, int) 317 DECLARE_COMPARISONS(unsigned int, uint) 318 DECLARE_COMPARISONS(char, char) 319 DECLARE_COMPARISONS(unsigned char, uchar) 320 DECLARE_COMPARISONS(long, long) 321 DECLARE_COMPARISONS(unsigned long, ulong) 322 DECLARE_COMPARISONS(double, double) 323 DECLARE_COMPARISONS(time_t, time_t) 324 325 /* 326 * Because this comparison uses a printf format specifier that's not 327 * universally known (yet), we provide an option to not have it declared. 328 */ 329 # ifndef TESTUTIL_NO_size_t_COMPARISON 330 DECLARE_COMPARISONS(size_t, size_t) 331 # endif 332 333 /* 334 * Pointer comparisons against other pointers and null. 335 * These functions return 1 if the test is true. 336 * Otherwise, they return 0 and pretty-print diagnostics. 337 * These should not be called directly, use the TEST_xxx macros below instead. 338 */ 339 DECLARE_COMPARISON(void *, ptr, eq) 340 DECLARE_COMPARISON(void *, ptr, ne) 341 int test_ptr(const char *file, int line, const char *s, const void *p); 342 int test_ptr_null(const char *file, int line, const char *s, const void *p); 343 344 /* 345 * Equality tests for strings where NULL is a legitimate value. 346 * These calls return 1 if the two passed strings compare true. 347 * Otherwise, they return 0 and pretty-print diagnostics. 348 * These should not be called directly, use the TEST_xxx macros below instead. 349 */ 350 DECLARE_COMPARISON(char *, str, eq) 351 DECLARE_COMPARISON(char *, str, ne) 352 353 /* 354 * Same as above, but for strncmp. 355 */ 356 int test_strn_eq(const char *file, int line, const char *, const char *, 357 const char *a, size_t an, const char *b, size_t bn); 358 int test_strn_ne(const char *file, int line, const char *, const char *, 359 const char *a, size_t an, const char *b, size_t bn); 360 361 /* 362 * Equality test for memory blocks where NULL is a legitimate value. 363 * These calls return 1 if the two memory blocks compare true. 364 * Otherwise, they return 0 and pretty-print diagnostics. 365 * These should not be called directly, use the TEST_xxx macros below instead. 366 */ 367 int test_mem_eq(const char *, int, const char *, const char *, 368 const void *, size_t, const void *, size_t); 369 int test_mem_ne(const char *, int, const char *, const char *, 370 const void *, size_t, const void *, size_t); 371 372 /* 373 * Check a boolean result for being true or false. 374 * They return 1 if the condition is true (i.e. the value is non-zero). 375 * Otherwise, they return 0 and pretty-prints diagnostics using |s|. 376 * These should not be called directly, use the TEST_xxx macros below instead. 377 */ 378 int test_true(const char *file, int line, const char *s, int b); 379 int test_false(const char *file, int line, const char *s, int b); 380 381 /* 382 * Comparisons between BIGNUMs. 383 * BIGNUMS can be compared against other BIGNUMs or zero. 384 * Some additional equality tests against 1 & specific values are provided. 385 * Tests for parity are included as well. 386 */ 387 DECLARE_COMPARISONS(BIGNUM *, BN) 388 int test_BN_eq_zero(const char *file, int line, const char *s, const BIGNUM *a); 389 int test_BN_ne_zero(const char *file, int line, const char *s, const BIGNUM *a); 390 int test_BN_lt_zero(const char *file, int line, const char *s, const BIGNUM *a); 391 int test_BN_le_zero(const char *file, int line, const char *s, const BIGNUM *a); 392 int test_BN_gt_zero(const char *file, int line, const char *s, const BIGNUM *a); 393 int test_BN_ge_zero(const char *file, int line, const char *s, const BIGNUM *a); 394 int test_BN_eq_one(const char *file, int line, const char *s, const BIGNUM *a); 395 int test_BN_odd(const char *file, int line, const char *s, const BIGNUM *a); 396 int test_BN_even(const char *file, int line, const char *s, const BIGNUM *a); 397 int test_BN_eq_word(const char *file, int line, const char *bns, const char *ws, 398 const BIGNUM *a, BN_ULONG w); 399 int test_BN_abs_eq_word(const char *file, int line, const char *bns, 400 const char *ws, const BIGNUM *a, BN_ULONG w); 401 402 /* 403 * Pretty print a failure message. 404 * These should not be called directly, use the TEST_xxx macros below instead. 405 */ 406 void test_error(const char *file, int line, const char *desc, ...) 407 PRINTF_FORMAT(3, 4); 408 void test_error_c90(const char *desc, ...) PRINTF_FORMAT(1, 2); 409 void test_info(const char *file, int line, const char *desc, ...) 410 PRINTF_FORMAT(3, 4); 411 void test_info_c90(const char *desc, ...) PRINTF_FORMAT(1, 2); 412 void test_note(const char *desc, ...) PRINTF_FORMAT(1, 2); 413 int test_skip(const char *file, int line, const char *desc, ...) 414 PRINTF_FORMAT(3, 4); 415 int test_skip_c90(const char *desc, ...) PRINTF_FORMAT(1, 2); 416 void test_openssl_errors(void); 417 void test_perror(const char *s); 418 419 /* 420 * The following macros provide wrapper calls to the test functions with 421 * a default description that indicates the file and line number of the error. 422 * 423 * The following macros guarantee to evaluate each argument exactly once. 424 * This allows constructs such as: if (!TEST_ptr(ptr = OPENSSL_malloc(..))) 425 * to produce better contextual output than: 426 * ptr = OPENSSL_malloc(..); 427 * if (!TEST_ptr(ptr)) 428 */ 429 # define TEST_int_eq(a, b) test_int_eq(__FILE__, __LINE__, #a, #b, a, b) 430 # define TEST_int_ne(a, b) test_int_ne(__FILE__, __LINE__, #a, #b, a, b) 431 # define TEST_int_lt(a, b) test_int_lt(__FILE__, __LINE__, #a, #b, a, b) 432 # define TEST_int_le(a, b) test_int_le(__FILE__, __LINE__, #a, #b, a, b) 433 # define TEST_int_gt(a, b) test_int_gt(__FILE__, __LINE__, #a, #b, a, b) 434 # define TEST_int_ge(a, b) test_int_ge(__FILE__, __LINE__, #a, #b, a, b) 435 436 # define TEST_uint_eq(a, b) test_uint_eq(__FILE__, __LINE__, #a, #b, a, b) 437 # define TEST_uint_ne(a, b) test_uint_ne(__FILE__, __LINE__, #a, #b, a, b) 438 # define TEST_uint_lt(a, b) test_uint_lt(__FILE__, __LINE__, #a, #b, a, b) 439 # define TEST_uint_le(a, b) test_uint_le(__FILE__, __LINE__, #a, #b, a, b) 440 # define TEST_uint_gt(a, b) test_uint_gt(__FILE__, __LINE__, #a, #b, a, b) 441 # define TEST_uint_ge(a, b) test_uint_ge(__FILE__, __LINE__, #a, #b, a, b) 442 443 # define TEST_char_eq(a, b) test_char_eq(__FILE__, __LINE__, #a, #b, a, b) 444 # define TEST_char_ne(a, b) test_char_ne(__FILE__, __LINE__, #a, #b, a, b) 445 # define TEST_char_lt(a, b) test_char_lt(__FILE__, __LINE__, #a, #b, a, b) 446 # define TEST_char_le(a, b) test_char_le(__FILE__, __LINE__, #a, #b, a, b) 447 # define TEST_char_gt(a, b) test_char_gt(__FILE__, __LINE__, #a, #b, a, b) 448 # define TEST_char_ge(a, b) test_char_ge(__FILE__, __LINE__, #a, #b, a, b) 449 450 # define TEST_uchar_eq(a, b) test_uchar_eq(__FILE__, __LINE__, #a, #b, a, b) 451 # define TEST_uchar_ne(a, b) test_uchar_ne(__FILE__, __LINE__, #a, #b, a, b) 452 # define TEST_uchar_lt(a, b) test_uchar_lt(__FILE__, __LINE__, #a, #b, a, b) 453 # define TEST_uchar_le(a, b) test_uchar_le(__FILE__, __LINE__, #a, #b, a, b) 454 # define TEST_uchar_gt(a, b) test_uchar_gt(__FILE__, __LINE__, #a, #b, a, b) 455 # define TEST_uchar_ge(a, b) test_uchar_ge(__FILE__, __LINE__, #a, #b, a, b) 456 457 # define TEST_long_eq(a, b) test_long_eq(__FILE__, __LINE__, #a, #b, a, b) 458 # define TEST_long_ne(a, b) test_long_ne(__FILE__, __LINE__, #a, #b, a, b) 459 # define TEST_long_lt(a, b) test_long_lt(__FILE__, __LINE__, #a, #b, a, b) 460 # define TEST_long_le(a, b) test_long_le(__FILE__, __LINE__, #a, #b, a, b) 461 # define TEST_long_gt(a, b) test_long_gt(__FILE__, __LINE__, #a, #b, a, b) 462 # define TEST_long_ge(a, b) test_long_ge(__FILE__, __LINE__, #a, #b, a, b) 463 464 # define TEST_ulong_eq(a, b) test_ulong_eq(__FILE__, __LINE__, #a, #b, a, b) 465 # define TEST_ulong_ne(a, b) test_ulong_ne(__FILE__, __LINE__, #a, #b, a, b) 466 # define TEST_ulong_lt(a, b) test_ulong_lt(__FILE__, __LINE__, #a, #b, a, b) 467 # define TEST_ulong_le(a, b) test_ulong_le(__FILE__, __LINE__, #a, #b, a, b) 468 # define TEST_ulong_gt(a, b) test_ulong_gt(__FILE__, __LINE__, #a, #b, a, b) 469 # define TEST_ulong_ge(a, b) test_ulong_ge(__FILE__, __LINE__, #a, #b, a, b) 470 471 # define TEST_size_t_eq(a, b) test_size_t_eq(__FILE__, __LINE__, #a, #b, a, b) 472 # define TEST_size_t_ne(a, b) test_size_t_ne(__FILE__, __LINE__, #a, #b, a, b) 473 # define TEST_size_t_lt(a, b) test_size_t_lt(__FILE__, __LINE__, #a, #b, a, b) 474 # define TEST_size_t_le(a, b) test_size_t_le(__FILE__, __LINE__, #a, #b, a, b) 475 # define TEST_size_t_gt(a, b) test_size_t_gt(__FILE__, __LINE__, #a, #b, a, b) 476 # define TEST_size_t_ge(a, b) test_size_t_ge(__FILE__, __LINE__, #a, #b, a, b) 477 478 # define TEST_double_eq(a, b) test_double_eq(__FILE__, __LINE__, #a, #b, a, b) 479 # define TEST_double_ne(a, b) test_double_ne(__FILE__, __LINE__, #a, #b, a, b) 480 # define TEST_double_lt(a, b) test_double_lt(__FILE__, __LINE__, #a, #b, a, b) 481 # define TEST_double_le(a, b) test_double_le(__FILE__, __LINE__, #a, #b, a, b) 482 # define TEST_double_gt(a, b) test_double_gt(__FILE__, __LINE__, #a, #b, a, b) 483 # define TEST_double_ge(a, b) test_double_ge(__FILE__, __LINE__, #a, #b, a, b) 484 485 # define TEST_time_t_eq(a, b) test_time_t_eq(__FILE__, __LINE__, #a, #b, a, b) 486 # define TEST_time_t_ne(a, b) test_time_t_ne(__FILE__, __LINE__, #a, #b, a, b) 487 # define TEST_time_t_lt(a, b) test_time_t_lt(__FILE__, __LINE__, #a, #b, a, b) 488 # define TEST_time_t_le(a, b) test_time_t_le(__FILE__, __LINE__, #a, #b, a, b) 489 # define TEST_time_t_gt(a, b) test_time_t_gt(__FILE__, __LINE__, #a, #b, a, b) 490 # define TEST_time_t_ge(a, b) test_time_t_ge(__FILE__, __LINE__, #a, #b, a, b) 491 492 # define TEST_ptr_eq(a, b) test_ptr_eq(__FILE__, __LINE__, #a, #b, a, b) 493 # define TEST_ptr_ne(a, b) test_ptr_ne(__FILE__, __LINE__, #a, #b, a, b) 494 # define TEST_ptr(a) test_ptr(__FILE__, __LINE__, #a, a) 495 # define TEST_ptr_null(a) test_ptr_null(__FILE__, __LINE__, #a, a) 496 497 # define TEST_str_eq(a, b) test_str_eq(__FILE__, __LINE__, #a, #b, a, b) 498 # define TEST_str_ne(a, b) test_str_ne(__FILE__, __LINE__, #a, #b, a, b) 499 # define TEST_strn_eq(a, b, n) test_strn_eq(__FILE__, __LINE__, #a, #b, a, n, b, n) 500 # define TEST_strn_ne(a, b, n) test_strn_ne(__FILE__, __LINE__, #a, #b, a, n, b, n) 501 # define TEST_strn2_eq(a, m, b, n) test_strn_eq(__FILE__, __LINE__, #a, #b, a, m, b, n) 502 # define TEST_strn2_ne(a, m, b, n) test_strn_ne(__FILE__, __LINE__, #a, #b, a, m, b, n) 503 504 # define TEST_mem_eq(a, m, b, n) test_mem_eq(__FILE__, __LINE__, #a, #b, a, m, b, n) 505 # define TEST_mem_ne(a, m, b, n) test_mem_ne(__FILE__, __LINE__, #a, #b, a, m, b, n) 506 507 # define TEST_true(a) test_true(__FILE__, __LINE__, #a, (a) != 0) 508 # define TEST_false(a) test_false(__FILE__, __LINE__, #a, (a) != 0) 509 510 # define TEST_BN_eq(a, b) test_BN_eq(__FILE__, __LINE__, #a, #b, a, b) 511 # define TEST_BN_ne(a, b) test_BN_ne(__FILE__, __LINE__, #a, #b, a, b) 512 # define TEST_BN_lt(a, b) test_BN_lt(__FILE__, __LINE__, #a, #b, a, b) 513 # define TEST_BN_gt(a, b) test_BN_gt(__FILE__, __LINE__, #a, #b, a, b) 514 # define TEST_BN_le(a, b) test_BN_le(__FILE__, __LINE__, #a, #b, a, b) 515 # define TEST_BN_ge(a, b) test_BN_ge(__FILE__, __LINE__, #a, #b, a, b) 516 # define TEST_BN_eq_zero(a) test_BN_eq_zero(__FILE__, __LINE__, #a, a) 517 # define TEST_BN_ne_zero(a) test_BN_ne_zero(__FILE__, __LINE__, #a, a) 518 # define TEST_BN_lt_zero(a) test_BN_lt_zero(__FILE__, __LINE__, #a, a) 519 # define TEST_BN_gt_zero(a) test_BN_gt_zero(__FILE__, __LINE__, #a, a) 520 # define TEST_BN_le_zero(a) test_BN_le_zero(__FILE__, __LINE__, #a, a) 521 # define TEST_BN_ge_zero(a) test_BN_ge_zero(__FILE__, __LINE__, #a, a) 522 # define TEST_BN_eq_one(a) test_BN_eq_one(__FILE__, __LINE__, #a, a) 523 # define TEST_BN_eq_word(a, w) test_BN_eq_word(__FILE__, __LINE__, #a, #w, a, w) 524 # define TEST_BN_abs_eq_word(a, w) test_BN_abs_eq_word(__FILE__, __LINE__, #a, #w, a, w) 525 # define TEST_BN_odd(a) test_BN_odd(__FILE__, __LINE__, #a, a) 526 # define TEST_BN_even(a) test_BN_even(__FILE__, __LINE__, #a, a) 527 528 /* 529 * TEST_error(desc, ...) prints an informative error message in the standard 530 * format. |desc| is a printf format string. 531 */ 532 # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L 533 # define TEST_error test_error_c90 534 # define TEST_info test_info_c90 535 # define TEST_skip test_skip_c90 536 # else 537 # define TEST_error(...) test_error(__FILE__, __LINE__, __VA_ARGS__) 538 # define TEST_info(...) test_info(__FILE__, __LINE__, __VA_ARGS__) 539 # define TEST_skip(...) test_skip(__FILE__, __LINE__, __VA_ARGS__) 540 # endif 541 # define TEST_note test_note 542 # define TEST_openssl_errors test_openssl_errors 543 # define TEST_perror test_perror 544 545 extern BIO *bio_out; 546 extern BIO *bio_err; 547 548 /* 549 * Formatted output for strings, memory and bignums. 550 */ 551 void test_output_string(const char *name, const char *m, size_t l); 552 void test_output_bignum(const char *name, const BIGNUM *bn); 553 void test_output_memory(const char *name, const unsigned char *m, size_t l); 554 555 556 /* 557 * Utilities to parse a test file. 558 */ 559 # define TESTMAXPAIRS 150 560 561 typedef struct pair_st { 562 char *key; 563 char *value; 564 } PAIR; 565 566 typedef struct stanza_st { 567 const char *test_file; /* Input file name */ 568 BIO *fp; /* Input file */ 569 int curr; /* Current line in file */ 570 int start; /* Line where test starts */ 571 int errors; /* Error count */ 572 int numtests; /* Number of tests */ 573 int numskip; /* Number of skipped tests */ 574 int numpairs; 575 PAIR pairs[TESTMAXPAIRS]; 576 BIO *key; /* temp memory BIO for reading in keys */ 577 char buff[4096]; /* Input buffer for a single key/value */ 578 } STANZA; 579 580 /* 581 * Prepare to start reading the file |testfile| as input. 582 */ 583 int test_start_file(STANZA *s, const char *testfile); 584 int test_end_file(STANZA *s); 585 586 /* 587 * Read a stanza from the test file. A stanza consists of a block 588 * of lines of the form 589 * key = value 590 * The block is terminated by EOF or a blank line. 591 * Return 1 if found, 0 on EOF or error. 592 */ 593 int test_readstanza(STANZA *s); 594 595 /* 596 * Clear a stanza, release all allocated memory. 597 */ 598 void test_clearstanza(STANZA *s); 599 600 /* 601 * Glue an array of strings together and return it as an allocated string. 602 * Optionally return the whole length of this string in |out_len| 603 */ 604 char *glue_strings(const char *list[], size_t *out_len); 605 606 /* 607 * Pseudo random number generator of low quality but having repeatability 608 * across platforms. The two calls are replacements for random(3) and 609 * srandom(3). 610 */ 611 uint32_t test_random(void); 612 void test_random_seed(uint32_t sd); 613 614 /* Fake non-secure random number generator */ 615 typedef int fake_random_generate_cb(unsigned char *out, size_t outlen, 616 const char *name, EVP_RAND_CTX *ctx); 617 618 OSSL_PROVIDER *fake_rand_start(OSSL_LIB_CTX *libctx); 619 void fake_rand_finish(OSSL_PROVIDER *p); 620 void fake_rand_set_callback(EVP_RAND_CTX *ctx, 621 int (*cb)(unsigned char *out, size_t outlen, 622 const char *name, EVP_RAND_CTX *ctx)); 623 void fake_rand_set_public_private_callbacks(OSSL_LIB_CTX *libctx, 624 fake_random_generate_cb *cb); 625 626 /* Create a file path from a directory and a filename */ 627 char *test_mk_file_path(const char *dir, const char *file); 628 629 EVP_PKEY *load_pkey_pem(const char *file, OSSL_LIB_CTX *libctx); 630 X509 *load_cert_pem(const char *file, OSSL_LIB_CTX *libctx); 631 X509 *load_cert_der(const unsigned char *bytes, int len); 632 STACK_OF(X509) *load_certs_pem(const char *file); 633 X509_REQ *load_csr_der(const char *file, OSSL_LIB_CTX *libctx); 634 635 #endif /* OSSL_TESTUTIL_H */ 636