test/testutil.h

   1 /*
   2  * Copyright 2014-2021 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  * Used to supply test specific command line options,
 240  * If non optional parameters are used, then the first entry in the OPTIONS[]
 241  * should contain:
 242  * { OPT_HELP_STR, 1, '-', "<list of non-optional commandline params>\n"},
 243  * The last entry should always be { NULL }.
 244  *
 245  * Run the test locally using './test/test_name -help' to check the usage.
 246  */
 247 const OPTIONS *test_get_options(void);
 248
 249 /*
 250  *  Test assumption verification helpers.
 251  */
 252
 253 # define PRINTF_FORMAT(a, b)
 254 # if defined(__GNUC__) && defined(__STDC_VERSION__)
 255   /*
 256    * Because we support the 'z' modifier, which made its appearance in C99,
 257    * we can't use __attribute__ with pre C99 dialects.
 258    */
 259 #  if __STDC_VERSION__ >= 199901L
 260 #   undef PRINTF_FORMAT
 261 #   define PRINTF_FORMAT(a, b)   __attribute__ ((format(printf, a, b)))
 262 #  endif
 263 # endif
 264
 265 # define DECLARE_COMPARISON(type, name, opname)                         \
 266     int test_ ## name ## _ ## opname(const char *, int,                 \
 267                                      const char *, const char *,        \
 268                                      const type, const type);
 269
 270 # define DECLARE_COMPARISONS(type, name)                                \
 271     DECLARE_COMPARISON(type, name, eq)                                  \
 272     DECLARE_COMPARISON(type, name, ne)                                  \
 273     DECLARE_COMPARISON(type, name, lt)                                  \
 274     DECLARE_COMPARISON(type, name, le)                                  \
 275     DECLARE_COMPARISON(type, name, gt)                                  \
 276     DECLARE_COMPARISON(type, name, ge)
 277
 278 DECLARE_COMPARISONS(int, int)
 279 DECLARE_COMPARISONS(unsigned int, uint)
 280 DECLARE_COMPARISONS(char, char)
 281 DECLARE_COMPARISONS(unsigned char, uchar)
 282 DECLARE_COMPARISONS(long, long)
 283 DECLARE_COMPARISONS(unsigned long, ulong)
 284 DECLARE_COMPARISONS(double, double)
 285 DECLARE_COMPARISONS(time_t, time_t)
 286
 287 /*
 288  * Because this comparison uses a printf format specifier that's not
 289  * universally known (yet), we provide an option to not have it declared.
 290  */
 291 # ifndef TESTUTIL_NO_size_t_COMPARISON
 292 DECLARE_COMPARISONS(size_t, size_t)
 293 # endif
 294
 295 /*
 296  * Pointer comparisons against other pointers and null.
 297  * These functions return 1 if the test is true.
 298  * Otherwise, they return 0 and pretty-print diagnostics.
 299  * These should not be called directly, use the TEST_xxx macros below instead.
 300  */
 301 DECLARE_COMPARISON(void *, ptr, eq)
 302 DECLARE_COMPARISON(void *, ptr, ne)
 303 int test_ptr(const char *file, int line, const char *s, const void *p);
 304 int test_ptr_null(const char *file, int line, const char *s, const void *p);
 305
 306 /*
 307  * Equality tests for strings where NULL is a legitimate value.
 308  * These calls return 1 if the two passed strings compare true.
 309  * Otherwise, they return 0 and pretty-print diagnostics.
 310  * These should not be called directly, use the TEST_xxx macros below instead.
 311  */
 312 DECLARE_COMPARISON(char *, str, eq)
 313 DECLARE_COMPARISON(char *, str, ne)
 314
 315 /*
 316  * Same as above, but for strncmp.
 317  */
 318 int test_strn_eq(const char *file, int line, const char *, const char *,
 319                  const char *a, size_t an, const char *b, size_t bn);
 320 int test_strn_ne(const char *file, int line, const char *, const char *,
 321                  const char *a, size_t an, const char *b, size_t bn);
 322
 323 /*
 324  * Equality test for memory blocks where NULL is a legitimate value.
 325  * These calls return 1 if the two memory blocks compare true.
 326  * Otherwise, they return 0 and pretty-print diagnostics.
 327  * These should not be called directly, use the TEST_xxx macros below instead.
 328  */
 329 int test_mem_eq(const char *, int, const char *, const char *,
 330                 const void *, size_t, const void *, size_t);
 331 int test_mem_ne(const char *, int, const char *, const char *,
 332                 const void *, size_t, const void *, size_t);
 333
 334 /*
 335  * Check a boolean result for being true or false.
 336  * They return 1 if the condition is true (i.e. the value is non-zero).
 337  * Otherwise, they return 0 and pretty-prints diagnostics using |s|.
 338  * These should not be called directly, use the TEST_xxx macros below instead.
 339  */
 340 int test_true(const char *file, int line, const char *s, int b);
 341 int test_false(const char *file, int line, const char *s, int b);
 342
 343 /*
 344  * Comparisons between BIGNUMs.
 345  * BIGNUMS can be compared against other BIGNUMs or zero.
 346  * Some additional equality tests against 1 & specific values are provided.
 347  * Tests for parity are included as well.
 348  */
 349 DECLARE_COMPARISONS(BIGNUM *, BN)
 350 int test_BN_eq_zero(const char *file, int line, const char *s, const BIGNUM *a);
 351 int test_BN_ne_zero(const char *file, int line, const char *s, const BIGNUM *a);
 352 int test_BN_lt_zero(const char *file, int line, const char *s, const BIGNUM *a);
 353 int test_BN_le_zero(const char *file, int line, const char *s, const BIGNUM *a);
 354 int test_BN_gt_zero(const char *file, int line, const char *s, const BIGNUM *a);
 355 int test_BN_ge_zero(const char *file, int line, const char *s, const BIGNUM *a);
 356 int test_BN_eq_one(const char *file, int line, const char *s, const BIGNUM *a);
 357 int test_BN_odd(const char *file, int line, const char *s, const BIGNUM *a);
 358 int test_BN_even(const char *file, int line, const char *s, const BIGNUM *a);
 359 int test_BN_eq_word(const char *file, int line, const char *bns, const char *ws,
 360                     const BIGNUM *a, BN_ULONG w);
 361 int test_BN_abs_eq_word(const char *file, int line, const char *bns,
 362                         const char *ws, const BIGNUM *a, BN_ULONG w);
 363
 364 /*
 365  * Pretty print a failure message.
 366  * These should not be called directly, use the TEST_xxx macros below instead.
 367  */
 368 void test_error(const char *file, int line, const char *desc, ...)
 369     PRINTF_FORMAT(3, 4);
 370 void test_error_c90(const char *desc, ...) PRINTF_FORMAT(1, 2);
 371 void test_info(const char *file, int line, const char *desc, ...)
 372     PRINTF_FORMAT(3, 4);
 373 void test_info_c90(const char *desc, ...) PRINTF_FORMAT(1, 2);
 374 void test_note(const char *desc, ...) PRINTF_FORMAT(1, 2);
 375 int test_skip(const char *file, int line, const char *desc, ...)
 376     PRINTF_FORMAT(3, 4);
 377 int test_skip_c90(const char *desc, ...) PRINTF_FORMAT(1, 2);
 378 void test_openssl_errors(void);
 379 void test_perror(const char *s);
 380
 381 /*
 382  * The following macros provide wrapper calls to the test functions with
 383  * a default description that indicates the file and line number of the error.
 384  *
 385  * The following macros guarantee to evaluate each argument exactly once.
 386  * This allows constructs such as: if (!TEST_ptr(ptr = OPENSSL_malloc(..)))
 387  * to produce better contextual output than:
 388  *      ptr = OPENSSL_malloc(..);
 389  *      if (!TEST_ptr(ptr))
 390  */
 391 # define TEST_int_eq(a, b)    test_int_eq(__FILE__, __LINE__, #a, #b, a, b)
 392 # define TEST_int_ne(a, b)    test_int_ne(__FILE__, __LINE__, #a, #b, a, b)
 393 # define TEST_int_lt(a, b)    test_int_lt(__FILE__, __LINE__, #a, #b, a, b)
 394 # define TEST_int_le(a, b)    test_int_le(__FILE__, __LINE__, #a, #b, a, b)
 395 # define TEST_int_gt(a, b)    test_int_gt(__FILE__, __LINE__, #a, #b, a, b)
 396 # define TEST_int_ge(a, b)    test_int_ge(__FILE__, __LINE__, #a, #b, a, b)
 397
 398 # define TEST_uint_eq(a, b)   test_uint_eq(__FILE__, __LINE__, #a, #b, a, b)
 399 # define TEST_uint_ne(a, b)   test_uint_ne(__FILE__, __LINE__, #a, #b, a, b)
 400 # define TEST_uint_lt(a, b)   test_uint_lt(__FILE__, __LINE__, #a, #b, a, b)
 401 # define TEST_uint_le(a, b)   test_uint_le(__FILE__, __LINE__, #a, #b, a, b)
 402 # define TEST_uint_gt(a, b)   test_uint_gt(__FILE__, __LINE__, #a, #b, a, b)
 403 # define TEST_uint_ge(a, b)   test_uint_ge(__FILE__, __LINE__, #a, #b, a, b)
 404
 405 # define TEST_char_eq(a, b)   test_char_eq(__FILE__, __LINE__, #a, #b, a, b)
 406 # define TEST_char_ne(a, b)   test_char_ne(__FILE__, __LINE__, #a, #b, a, b)
 407 # define TEST_char_lt(a, b)   test_char_lt(__FILE__, __LINE__, #a, #b, a, b)
 408 # define TEST_char_le(a, b)   test_char_le(__FILE__, __LINE__, #a, #b, a, b)
 409 # define TEST_char_gt(a, b)   test_char_gt(__FILE__, __LINE__, #a, #b, a, b)
 410 # define TEST_char_ge(a, b)   test_char_ge(__FILE__, __LINE__, #a, #b, a, b)
 411
 412 # define TEST_uchar_eq(a, b)  test_uchar_eq(__FILE__, __LINE__, #a, #b, a, b)
 413 # define TEST_uchar_ne(a, b)  test_uchar_ne(__FILE__, __LINE__, #a, #b, a, b)
 414 # define TEST_uchar_lt(a, b)  test_uchar_lt(__FILE__, __LINE__, #a, #b, a, b)
 415 # define TEST_uchar_le(a, b)  test_uchar_le(__FILE__, __LINE__, #a, #b, a, b)
 416 # define TEST_uchar_gt(a, b)  test_uchar_gt(__FILE__, __LINE__, #a, #b, a, b)
 417 # define TEST_uchar_ge(a, b)  test_uchar_ge(__FILE__, __LINE__, #a, #b, a, b)
 418
 419 # define TEST_long_eq(a, b)   test_long_eq(__FILE__, __LINE__, #a, #b, a, b)
 420 # define TEST_long_ne(a, b)   test_long_ne(__FILE__, __LINE__, #a, #b, a, b)
 421 # define TEST_long_lt(a, b)   test_long_lt(__FILE__, __LINE__, #a, #b, a, b)
 422 # define TEST_long_le(a, b)   test_long_le(__FILE__, __LINE__, #a, #b, a, b)
 423 # define TEST_long_gt(a, b)   test_long_gt(__FILE__, __LINE__, #a, #b, a, b)
 424 # define TEST_long_ge(a, b)   test_long_ge(__FILE__, __LINE__, #a, #b, a, b)
 425
 426 # define TEST_ulong_eq(a, b)  test_ulong_eq(__FILE__, __LINE__, #a, #b, a, b)
 427 # define TEST_ulong_ne(a, b)  test_ulong_ne(__FILE__, __LINE__, #a, #b, a, b)
 428 # define TEST_ulong_lt(a, b)  test_ulong_lt(__FILE__, __LINE__, #a, #b, a, b)
 429 # define TEST_ulong_le(a, b)  test_ulong_le(__FILE__, __LINE__, #a, #b, a, b)
 430 # define TEST_ulong_gt(a, b)  test_ulong_gt(__FILE__, __LINE__, #a, #b, a, b)
 431 # define TEST_ulong_ge(a, b)  test_ulong_ge(__FILE__, __LINE__, #a, #b, a, b)
 432
 433 # define TEST_size_t_eq(a, b) test_size_t_eq(__FILE__, __LINE__, #a, #b, a, b)
 434 # define TEST_size_t_ne(a, b) test_size_t_ne(__FILE__, __LINE__, #a, #b, a, b)
 435 # define TEST_size_t_lt(a, b) test_size_t_lt(__FILE__, __LINE__, #a, #b, a, b)
 436 # define TEST_size_t_le(a, b) test_size_t_le(__FILE__, __LINE__, #a, #b, a, b)
 437 # define TEST_size_t_gt(a, b) test_size_t_gt(__FILE__, __LINE__, #a, #b, a, b)
 438 # define TEST_size_t_ge(a, b) test_size_t_ge(__FILE__, __LINE__, #a, #b, a, b)
 439
 440 # define TEST_double_eq(a, b) test_double_eq(__FILE__, __LINE__, #a, #b, a, b)
 441 # define TEST_double_ne(a, b) test_double_ne(__FILE__, __LINE__, #a, #b, a, b)
 442 # define TEST_double_lt(a, b) test_double_lt(__FILE__, __LINE__, #a, #b, a, b)
 443 # define TEST_double_le(a, b) test_double_le(__FILE__, __LINE__, #a, #b, a, b)
 444 # define TEST_double_gt(a, b) test_double_gt(__FILE__, __LINE__, #a, #b, a, b)
 445 # define TEST_double_ge(a, b) test_double_ge(__FILE__, __LINE__, #a, #b, a, b)
 446
 447 # define TEST_time_t_eq(a, b) test_time_t_eq(__FILE__, __LINE__, #a, #b, a, b)
 448 # define TEST_time_t_ne(a, b) test_time_t_ne(__FILE__, __LINE__, #a, #b, a, b)
 449 # define TEST_time_t_lt(a, b) test_time_t_lt(__FILE__, __LINE__, #a, #b, a, b)
 450 # define TEST_time_t_le(a, b) test_time_t_le(__FILE__, __LINE__, #a, #b, a, b)
 451 # define TEST_time_t_gt(a, b) test_time_t_gt(__FILE__, __LINE__, #a, #b, a, b)
 452 # define TEST_time_t_ge(a, b) test_time_t_ge(__FILE__, __LINE__, #a, #b, a, b)
 453
 454 # define TEST_ptr_eq(a, b)    test_ptr_eq(__FILE__, __LINE__, #a, #b, a, b)
 455 # define TEST_ptr_ne(a, b)    test_ptr_ne(__FILE__, __LINE__, #a, #b, a, b)
 456 # define TEST_ptr(a)          test_ptr(__FILE__, __LINE__, #a, a)
 457 # define TEST_ptr_null(a)     test_ptr_null(__FILE__, __LINE__, #a, a)
 458
 459 # define TEST_str_eq(a, b)    test_str_eq(__FILE__, __LINE__, #a, #b, a, b)
 460 # define TEST_str_ne(a, b)    test_str_ne(__FILE__, __LINE__, #a, #b, a, b)
 461 # define TEST_strn_eq(a, b, n) test_strn_eq(__FILE__, __LINE__, #a, #b, a, n, b, n)
 462 # define TEST_strn_ne(a, b, n) test_strn_ne(__FILE__, __LINE__, #a, #b, a, n, b, n)
 463 # define TEST_strn2_eq(a, m, b, n) test_strn_eq(__FILE__, __LINE__, #a, #b, a, m, b, n)
 464 # define TEST_strn2_ne(a, m, b, n) test_strn_ne(__FILE__, __LINE__, #a, #b, a, m, b, n)
 465
 466 # define TEST_mem_eq(a, m, b, n) test_mem_eq(__FILE__, __LINE__, #a, #b, a, m, b, n)
 467 # define TEST_mem_ne(a, m, b, n) test_mem_ne(__FILE__, __LINE__, #a, #b, a, m, b, n)
 468
 469 # define TEST_true(a)         test_true(__FILE__, __LINE__, #a, (a) != 0)
 470 # define TEST_false(a)        test_false(__FILE__, __LINE__, #a, (a) != 0)
 471
 472 # define TEST_BN_eq(a, b)     test_BN_eq(__FILE__, __LINE__, #a, #b, a, b)
 473 # define TEST_BN_ne(a, b)     test_BN_ne(__FILE__, __LINE__, #a, #b, a, b)
 474 # define TEST_BN_lt(a, b)     test_BN_lt(__FILE__, __LINE__, #a, #b, a, b)
 475 # define TEST_BN_gt(a, b)     test_BN_gt(__FILE__, __LINE__, #a, #b, a, b)
 476 # define TEST_BN_le(a, b)     test_BN_le(__FILE__, __LINE__, #a, #b, a, b)
 477 # define TEST_BN_ge(a, b)     test_BN_ge(__FILE__, __LINE__, #a, #b, a, b)
 478 # define TEST_BN_eq_zero(a)   test_BN_eq_zero(__FILE__, __LINE__, #a, a)
 479 # define TEST_BN_ne_zero(a)   test_BN_ne_zero(__FILE__, __LINE__, #a, a)
 480 # define TEST_BN_lt_zero(a)   test_BN_lt_zero(__FILE__, __LINE__, #a, a)
 481 # define TEST_BN_gt_zero(a)   test_BN_gt_zero(__FILE__, __LINE__, #a, a)
 482 # define TEST_BN_le_zero(a)   test_BN_le_zero(__FILE__, __LINE__, #a, a)
 483 # define TEST_BN_ge_zero(a)   test_BN_ge_zero(__FILE__, __LINE__, #a, a)
 484 # define TEST_BN_eq_one(a)    test_BN_eq_one(__FILE__, __LINE__, #a, a)
 485 # define TEST_BN_eq_word(a, w) test_BN_eq_word(__FILE__, __LINE__, #a, #w, a, w)
 486 # define TEST_BN_abs_eq_word(a, w) test_BN_abs_eq_word(__FILE__, __LINE__, #a, #w, a, w)
 487 # define TEST_BN_odd(a)       test_BN_odd(__FILE__, __LINE__, #a, a)
 488 # define TEST_BN_even(a)      test_BN_even(__FILE__, __LINE__, #a, a)
 489
 490 /*
 491  * TEST_error(desc, ...) prints an informative error message in the standard
 492  * format.  |desc| is a printf format string.
 493  */
 494 # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L
 495 #  define TEST_error         test_error_c90
 496 #  define TEST_info          test_info_c90
 497 #  define TEST_skip          test_skip_c90
 498 # else
 499 #  define TEST_error(...)    test_error(__FILE__, __LINE__, __VA_ARGS__)
 500 #  define TEST_info(...)     test_info(__FILE__, __LINE__, __VA_ARGS__)
 501 #  define TEST_skip(...)     test_skip(__FILE__, __LINE__, __VA_ARGS__)
 502 # endif
 503 # define TEST_note           test_note
 504 # define TEST_openssl_errors test_openssl_errors
 505 # define TEST_perror         test_perror
 506
 507 extern BIO *bio_out;
 508 extern BIO *bio_err;
 509
 510 /*
 511  * Formatted output for strings, memory and bignums.
 512  */
 513 void test_output_string(const char *name, const char *m, size_t l);
 514 void test_output_bignum(const char *name, const BIGNUM *bn);
 515 void test_output_memory(const char *name, const unsigned char *m, size_t l);
 516
 517
 518 /*
 519  * Utilities to parse a test file.
 520  */
 521 # define TESTMAXPAIRS        150
 522
 523 typedef struct pair_st {
 524     char *key;
 525     char *value;
 526 } PAIR;
 527
 528 typedef struct stanza_st {
 529     const char *test_file;      /* Input file name */
 530     BIO *fp;                    /* Input file */
 531     int curr;                   /* Current line in file */
 532     int start;                  /* Line where test starts */
 533     int errors;                 /* Error count */
 534     int numtests;               /* Number of tests */
 535     int numskip;                /* Number of skipped tests */
 536     int numpairs;
 537     PAIR pairs[TESTMAXPAIRS];
 538     BIO *key;                   /* temp memory BIO for reading in keys */
 539     char buff[4096];            /* Input buffer for a single key/value */
 540 } STANZA;
 541
 542 /*
 543  * Prepare to start reading the file |testfile| as input.
 544  */
 545 int test_start_file(STANZA *s, const char *testfile);
 546 int test_end_file(STANZA *s);
 547
 548 /*
 549  * Read a stanza from the test file.  A stanza consists of a block
 550  * of lines of the form
 551  *      key = value
 552  * The block is terminated by EOF or a blank line.
 553  * Return 1 if found, 0 on EOF or error.
 554  */
 555 int test_readstanza(STANZA *s);
 556
 557 /*
 558  * Clear a stanza, release all allocated memory.
 559  */
 560 void test_clearstanza(STANZA *s);
 561
 562 /*
 563  * Glue an array of strings together and return it as an allocated string.
 564  * Optionally return the whole length of this string in |out_len|
 565  */
 566 char *glue_strings(const char *list[], size_t *out_len);
 567
 568 /*
 569  * Pseudo random number generator of low quality but having repeatability
 570  * across platforms.  The two calls are replacements for random(3) and
 571  * srandom(3).
 572  */
 573 uint32_t test_random(void);
 574 void test_random_seed(uint32_t sd);
 575
 576 /* Fake non-secure random number generator */
 577 typedef int fake_random_generate_cb(unsigned char *out, size_t outlen,
 578                                     const char *name, EVP_RAND_CTX *ctx);
 579
 580 OSSL_PROVIDER *fake_rand_start(OSSL_LIB_CTX *libctx);
 581 void fake_rand_finish(OSSL_PROVIDER *p);
 582 void fake_rand_set_callback(EVP_RAND_CTX *ctx,
 583                             int (*cb)(unsigned char *out, size_t outlen,
 584                                       const char *name, EVP_RAND_CTX *ctx));
 585 void fake_rand_set_public_private_callbacks(OSSL_LIB_CTX *libctx,
 586                                             fake_random_generate_cb *cb);
 587
 588 /* Create a file path from a directory and a filename */
 589 char *test_mk_file_path(const char *dir, const char *file);
 590
 591 EVP_PKEY *load_pkey_pem(const char *file, OSSL_LIB_CTX *libctx);
 592 X509 *load_cert_pem(const char *file, OSSL_LIB_CTX *libctx);
 593 X509 *load_cert_der(const unsigned char *bytes, int len);
 594 STACK_OF(X509) *load_certs_pem(const char *file);
 595 X509_REQ *load_csr_der(const char *file);
 596
 597 #endif                          /* OSSL_TESTUTIL_H */