1 /* 2 * Copyright 2014-2019 The OpenSSL Project Authors. All Rights Reserved. 3 * 4 * Licensed under the OpenSSL license (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/err.h> 16 #include <openssl/e_os2.h> 17 #include <openssl/bn.h> 18 19 /*- 20 * Simple unit tests should implement setup_tests(). 21 * This function should return zero if the registration process fails. 22 * To register tests, call ADD_TEST or ADD_ALL_TESTS: 23 * 24 * int setup_tests(void) 25 * { 26 * ADD_TEST(test_foo); 27 * ADD_ALL_TESTS(test_bar, num_test_bar); 28 * return 1; 29 * } 30 * 31 * Tests that require clean up after execution should implement: 32 * 33 * void cleanup_tests(void); 34 * 35 * The cleanup_tests function will be called even if setup_tests() 36 * returns failure. 37 * 38 * In some cases, early initialization before the framework is set up 39 * may be needed. In such a case, this should be implemented: 40 * 41 * int global_init(void); 42 * 43 * This function should return zero if there is an unrecoverable error and 44 * non-zero if the initialization was successful. 45 */ 46 47 /* Adds a simple test case. */ 48 # define ADD_TEST(test_function) add_test(#test_function, test_function) 49 50 /* 51 * Simple parameterized tests. Calls test_function(idx) for each 0 <= idx < num. 52 */ 53 # define ADD_ALL_TESTS(test_function, num) \ 54 add_all_tests(#test_function, test_function, num, 1) 55 /* 56 * A variant of the same without TAP output. 57 */ 58 # define ADD_ALL_TESTS_NOSUBTEST(test_function, num) \ 59 add_all_tests(#test_function, test_function, num, 0) 60 61 /*- 62 * Test cases that share common setup should use the helper 63 * SETUP_TEST_FIXTURE and EXECUTE_TEST macros for test case functions. 64 * 65 * SETUP_TEST_FIXTURE will call set_up() to create a new TEST_FIXTURE_TYPE 66 * object called "fixture". It will also allocate the "result" variable used 67 * by EXECUTE_TEST. set_up() should take a const char* specifying the test 68 * case name and return a TEST_FIXTURE_TYPE by reference. 69 * 70 * EXECUTE_TEST will pass fixture to execute_func() by reference, call 71 * tear_down(), and return the result of execute_func(). execute_func() should 72 * take a TEST_FIXTURE_TYPE by reference and return 1 on success and 0 on 73 * failure. The tear_down function is responsible for deallocation of the 74 * result variable, if required. 75 * 76 * Unit tests can define their own SETUP_TEST_FIXTURE and EXECUTE_TEST 77 * variations like so: 78 * 79 * #define SETUP_FOOBAR_TEST_FIXTURE()\ 80 * SETUP_TEST_FIXTURE(FOOBAR_TEST_FIXTURE, set_up_foobar) 81 * 82 * #define EXECUTE_FOOBAR_TEST()\ 83 * EXECUTE_TEST(execute_foobar, tear_down_foobar) 84 * 85 * Then test case functions can take the form: 86 * 87 * static int test_foobar_feature() 88 * { 89 * SETUP_FOOBAR_TEST_FIXTURE(); 90 * [...set individual members of fixture...] 91 * EXECUTE_FOOBAR_TEST(); 92 * } 93 */ 94 # define SETUP_TEST_FIXTURE(TEST_FIXTURE_TYPE, set_up)\ 95 TEST_FIXTURE_TYPE *fixture = set_up(TEST_CASE_NAME); \ 96 int result = 0 97 98 # define EXECUTE_TEST(execute_func, tear_down)\ 99 if (fixture != NULL) {\ 100 result = execute_func(fixture);\ 101 tear_down(fixture);\ 102 } 103 104 /* 105 * TEST_CASE_NAME is defined as the name of the test case function where 106 * possible; otherwise we get by with the file name and line number. 107 */ 108 # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L 109 # if defined(_MSC_VER) 110 # define TEST_CASE_NAME __FUNCTION__ 111 # else 112 # define testutil_stringify_helper(s) #s 113 # define testutil_stringify(s) testutil_stringify_helper(s) 114 # define TEST_CASE_NAME __FILE__ ":" testutil_stringify(__LINE__) 115 # endif /* _MSC_VER */ 116 # else 117 # define TEST_CASE_NAME __func__ 118 # endif /* __STDC_VERSION__ */ 119 120 /* 121 * Tests that need access to command line arguments should use the functions: 122 * test_get_argument(int n) to get the nth argument, the first argument is 123 * argument 0. This function returns NULL on error. 124 * test_get_argument_count() to get the count of the arguments. 125 * test_has_option(const char *) to check if the specified option was passed. 126 * test_get_option_argument(const char *) to get an option which includes an 127 * argument. NULL is returns if the option is not found. 128 * const char *test_get_program_name(void) returns the name of the test program 129 * being executed. 130 */ 131 const char *test_get_program_name(void); 132 char *test_get_argument(size_t n); 133 size_t test_get_argument_count(void); 134 int test_has_option(const char *option); 135 const char *test_get_option_argument(const char *option); 136 137 /* 138 * Internal helpers. Test programs shouldn't use these directly, but should 139 * rather link to one of the helper main() methods. 140 */ 141 142 void add_test(const char *test_case_name, int (*test_fn) (void)); 143 void add_all_tests(const char *test_case_name, int (*test_fn)(int idx), int num, 144 int subtest); 145 146 /* 147 * Declarations for user defined functions. 148 * The first two return a boolean indicating that the test should not proceed. 149 */ 150 int global_init(void); 151 int setup_tests(void); 152 void cleanup_tests(void); 153 154 /* 155 * Test assumption verification helpers. 156 */ 157 158 #define PRINTF_FORMAT(a, b) 159 #if defined(__GNUC__) && defined(__STDC_VERSION__) 160 /* 161 * Because we support the 'z' modifier, which made its appearance in C99, 162 * we can't use __attribute__ with pre C99 dialects. 163 */ 164 # if __STDC_VERSION__ >= 199901L 165 # undef PRINTF_FORMAT 166 # define PRINTF_FORMAT(a, b) __attribute__ ((format(printf, a, b))) 167 # endif 168 #endif 169 170 # define DECLARE_COMPARISON(type, name, opname) \ 171 int test_ ## name ## _ ## opname(const char *, int, \ 172 const char *, const char *, \ 173 const type, const type); 174 175 # define DECLARE_COMPARISONS(type, name) \ 176 DECLARE_COMPARISON(type, name, eq) \ 177 DECLARE_COMPARISON(type, name, ne) \ 178 DECLARE_COMPARISON(type, name, lt) \ 179 DECLARE_COMPARISON(type, name, le) \ 180 DECLARE_COMPARISON(type, name, gt) \ 181 DECLARE_COMPARISON(type, name, ge) 182 183 DECLARE_COMPARISONS(int, int) 184 DECLARE_COMPARISONS(unsigned int, uint) 185 DECLARE_COMPARISONS(char, char) 186 DECLARE_COMPARISONS(unsigned char, uchar) 187 DECLARE_COMPARISONS(long, long) 188 DECLARE_COMPARISONS(unsigned long, ulong) 189 DECLARE_COMPARISONS(time_t, time_t) 190 /* 191 * Because this comparison uses a printf format specifier that's not 192 * universally known (yet), we provide an option to not have it declared. 193 */ 194 # ifndef TESTUTIL_NO_size_t_COMPARISON 195 DECLARE_COMPARISONS(size_t, size_t) 196 # endif 197 198 /* 199 * Pointer comparisons against other pointers and null. 200 * These functions return 1 if the test is true. 201 * Otherwise, they return 0 and pretty-print diagnostics. 202 * These should not be called directly, use the TEST_xxx macros below instead. 203 */ 204 DECLARE_COMPARISON(void *, ptr, eq) 205 DECLARE_COMPARISON(void *, ptr, ne) 206 int test_ptr(const char *file, int line, const char *s, const void *p); 207 int test_ptr_null(const char *file, int line, const char *s, const void *p); 208 209 /* 210 * Equality tests for strings where NULL is a legitimate value. 211 * These calls return 1 if the two passed strings compare true. 212 * Otherwise, they return 0 and pretty-print diagnostics. 213 * These should not be called directly, use the TEST_xxx macros below instead. 214 */ 215 DECLARE_COMPARISON(char *, str, eq) 216 DECLARE_COMPARISON(char *, str, ne) 217 218 /* 219 * Same as above, but for strncmp. 220 */ 221 int test_strn_eq(const char *file, int line, const char *, const char *, 222 const char *a, const char *b, size_t s); 223 int test_strn_ne(const char *file, int line, const char *, const char *, 224 const char *a, const char *b, size_t s); 225 226 /* 227 * Equality test for memory blocks where NULL is a legitimate value. 228 * These calls return 1 if the two memory blocks compare true. 229 * Otherwise, they return 0 and pretty-print diagnostics. 230 * These should not be called directly, use the TEST_xxx macros below instead. 231 */ 232 int test_mem_eq(const char *, int, const char *, const char *, 233 const void *, size_t, const void *, size_t); 234 int test_mem_ne(const char *, int, const char *, const char *, 235 const void *, size_t, const void *, size_t); 236 237 /* 238 * Check a boolean result for being true or false. 239 * They return 1 if the condition is true (i.e. the value is non-zero). 240 * Otherwise, they return 0 and pretty-prints diagnostics using |s|. 241 * These should not be called directly, use the TEST_xxx macros below instead. 242 */ 243 int test_true(const char *file, int line, const char *s, int b); 244 int test_false(const char *file, int line, const char *s, int b); 245 246 /* 247 * Comparisons between BIGNUMs. 248 * BIGNUMS can be compared against other BIGNUMs or zero. 249 * Some additional equality tests against 1 & specific values are provided. 250 * Tests for parity are included as well. 251 */ 252 DECLARE_COMPARISONS(BIGNUM *, BN) 253 int test_BN_eq_zero(const char *file, int line, const char *s, const BIGNUM *a); 254 int test_BN_ne_zero(const char *file, int line, const char *s, const BIGNUM *a); 255 int test_BN_lt_zero(const char *file, int line, const char *s, const BIGNUM *a); 256 int test_BN_le_zero(const char *file, int line, const char *s, const BIGNUM *a); 257 int test_BN_gt_zero(const char *file, int line, const char *s, const BIGNUM *a); 258 int test_BN_ge_zero(const char *file, int line, const char *s, const BIGNUM *a); 259 int test_BN_eq_one(const char *file, int line, const char *s, const BIGNUM *a); 260 int test_BN_odd(const char *file, int line, const char *s, const BIGNUM *a); 261 int test_BN_even(const char *file, int line, const char *s, const BIGNUM *a); 262 int test_BN_eq_word(const char *file, int line, const char *bns, const char *ws, 263 const BIGNUM *a, BN_ULONG w); 264 int test_BN_abs_eq_word(const char *file, int line, const char *bns, 265 const char *ws, const BIGNUM *a, BN_ULONG w); 266 267 /* 268 * Pretty print a failure message. 269 * These should not be called directly, use the TEST_xxx macros below instead. 270 */ 271 void test_error(const char *file, int line, const char *desc, ...) 272 PRINTF_FORMAT(3, 4); 273 void test_error_c90(const char *desc, ...) PRINTF_FORMAT(1, 2); 274 void test_info(const char *file, int line, const char *desc, ...) 275 PRINTF_FORMAT(3, 4); 276 void test_info_c90(const char *desc, ...) PRINTF_FORMAT(1, 2); 277 void test_note(const char *desc, ...) PRINTF_FORMAT(1, 2); 278 void test_openssl_errors(void); 279 void test_perror(const char *s); 280 281 /* 282 * The following macros provide wrapper calls to the test functions with 283 * a default description that indicates the file and line number of the error. 284 * 285 * The following macros guarantee to evaluate each argument exactly once. 286 * This allows constructs such as: if (!TEST_ptr(ptr = OPENSSL_malloc(..))) 287 * to produce better contextual output than: 288 * ptr = OPENSSL_malloc(..); 289 * if (!TEST_ptr(ptr)) 290 */ 291 # define TEST_int_eq(a, b) test_int_eq(__FILE__, __LINE__, #a, #b, a, b) 292 # define TEST_int_ne(a, b) test_int_ne(__FILE__, __LINE__, #a, #b, a, b) 293 # define TEST_int_lt(a, b) test_int_lt(__FILE__, __LINE__, #a, #b, a, b) 294 # define TEST_int_le(a, b) test_int_le(__FILE__, __LINE__, #a, #b, a, b) 295 # define TEST_int_gt(a, b) test_int_gt(__FILE__, __LINE__, #a, #b, a, b) 296 # define TEST_int_ge(a, b) test_int_ge(__FILE__, __LINE__, #a, #b, a, b) 297 298 # define TEST_uint_eq(a, b) test_uint_eq(__FILE__, __LINE__, #a, #b, a, b) 299 # define TEST_uint_ne(a, b) test_uint_ne(__FILE__, __LINE__, #a, #b, a, b) 300 # define TEST_uint_lt(a, b) test_uint_lt(__FILE__, __LINE__, #a, #b, a, b) 301 # define TEST_uint_le(a, b) test_uint_le(__FILE__, __LINE__, #a, #b, a, b) 302 # define TEST_uint_gt(a, b) test_uint_gt(__FILE__, __LINE__, #a, #b, a, b) 303 # define TEST_uint_ge(a, b) test_uint_ge(__FILE__, __LINE__, #a, #b, a, b) 304 305 # define TEST_char_eq(a, b) test_char_eq(__FILE__, __LINE__, #a, #b, a, b) 306 # define TEST_char_ne(a, b) test_char_ne(__FILE__, __LINE__, #a, #b, a, b) 307 # define TEST_char_lt(a, b) test_char_lt(__FILE__, __LINE__, #a, #b, a, b) 308 # define TEST_char_le(a, b) test_char_le(__FILE__, __LINE__, #a, #b, a, b) 309 # define TEST_char_gt(a, b) test_char_gt(__FILE__, __LINE__, #a, #b, a, b) 310 # define TEST_char_ge(a, b) test_char_ge(__FILE__, __LINE__, #a, #b, a, b) 311 312 # define TEST_uchar_eq(a, b) test_uchar_eq(__FILE__, __LINE__, #a, #b, a, b) 313 # define TEST_uchar_ne(a, b) test_uchar_ne(__FILE__, __LINE__, #a, #b, a, b) 314 # define TEST_uchar_lt(a, b) test_uchar_lt(__FILE__, __LINE__, #a, #b, a, b) 315 # define TEST_uchar_le(a, b) test_uchar_le(__FILE__, __LINE__, #a, #b, a, b) 316 # define TEST_uchar_gt(a, b) test_uchar_gt(__FILE__, __LINE__, #a, #b, a, b) 317 # define TEST_uchar_ge(a, b) test_uchar_ge(__FILE__, __LINE__, #a, #b, a, b) 318 319 # define TEST_long_eq(a, b) test_long_eq(__FILE__, __LINE__, #a, #b, a, b) 320 # define TEST_long_ne(a, b) test_long_ne(__FILE__, __LINE__, #a, #b, a, b) 321 # define TEST_long_lt(a, b) test_long_lt(__FILE__, __LINE__, #a, #b, a, b) 322 # define TEST_long_le(a, b) test_long_le(__FILE__, __LINE__, #a, #b, a, b) 323 # define TEST_long_gt(a, b) test_long_gt(__FILE__, __LINE__, #a, #b, a, b) 324 # define TEST_long_ge(a, b) test_long_ge(__FILE__, __LINE__, #a, #b, a, b) 325 326 # define TEST_ulong_eq(a, b) test_ulong_eq(__FILE__, __LINE__, #a, #b, a, b) 327 # define TEST_ulong_ne(a, b) test_ulong_ne(__FILE__, __LINE__, #a, #b, a, b) 328 # define TEST_ulong_lt(a, b) test_ulong_lt(__FILE__, __LINE__, #a, #b, a, b) 329 # define TEST_ulong_le(a, b) test_ulong_le(__FILE__, __LINE__, #a, #b, a, b) 330 # define TEST_ulong_gt(a, b) test_ulong_gt(__FILE__, __LINE__, #a, #b, a, b) 331 # define TEST_ulong_ge(a, b) test_ulong_ge(__FILE__, __LINE__, #a, #b, a, b) 332 333 # define TEST_size_t_eq(a, b) test_size_t_eq(__FILE__, __LINE__, #a, #b, a, b) 334 # define TEST_size_t_ne(a, b) test_size_t_ne(__FILE__, __LINE__, #a, #b, a, b) 335 # define TEST_size_t_lt(a, b) test_size_t_lt(__FILE__, __LINE__, #a, #b, a, b) 336 # define TEST_size_t_le(a, b) test_size_t_le(__FILE__, __LINE__, #a, #b, a, b) 337 # define TEST_size_t_gt(a, b) test_size_t_gt(__FILE__, __LINE__, #a, #b, a, b) 338 # define TEST_size_t_ge(a, b) test_size_t_ge(__FILE__, __LINE__, #a, #b, a, b) 339 340 # define TEST_time_t_eq(a, b) test_time_t_eq(__FILE__, __LINE__, #a, #b, a, b) 341 # define TEST_time_t_ne(a, b) test_time_t_ne(__FILE__, __LINE__, #a, #b, a, b) 342 # define TEST_time_t_lt(a, b) test_time_t_lt(__FILE__, __LINE__, #a, #b, a, b) 343 # define TEST_time_t_le(a, b) test_time_t_le(__FILE__, __LINE__, #a, #b, a, b) 344 # define TEST_time_t_gt(a, b) test_time_t_gt(__FILE__, __LINE__, #a, #b, a, b) 345 # define TEST_time_t_ge(a, b) test_time_t_ge(__FILE__, __LINE__, #a, #b, a, b) 346 347 # define TEST_ptr_eq(a, b) test_ptr_eq(__FILE__, __LINE__, #a, #b, a, b) 348 # define TEST_ptr_ne(a, b) test_ptr_ne(__FILE__, __LINE__, #a, #b, a, b) 349 # define TEST_ptr(a) test_ptr(__FILE__, __LINE__, #a, a) 350 # define TEST_ptr_null(a) test_ptr_null(__FILE__, __LINE__, #a, a) 351 352 # define TEST_str_eq(a, b) test_str_eq(__FILE__, __LINE__, #a, #b, a, b) 353 # define TEST_str_ne(a, b) test_str_ne(__FILE__, __LINE__, #a, #b, a, b) 354 # define TEST_strn_eq(a, b, n) test_strn_eq(__FILE__, __LINE__, #a, #b, a, b, n) 355 # define TEST_strn_ne(a, b, n) test_strn_ne(__FILE__, __LINE__, #a, #b, a, b, n) 356 357 # define TEST_mem_eq(a, m, b, n) test_mem_eq(__FILE__, __LINE__, #a, #b, a, m, b, n) 358 # define TEST_mem_ne(a, m, b, n) test_mem_ne(__FILE__, __LINE__, #a, #b, a, m, b, n) 359 360 # define TEST_true(a) test_true(__FILE__, __LINE__, #a, (a) != 0) 361 # define TEST_false(a) test_false(__FILE__, __LINE__, #a, (a) != 0) 362 363 # define TEST_BN_eq(a, b) test_BN_eq(__FILE__, __LINE__, #a, #b, a, b) 364 # define TEST_BN_ne(a, b) test_BN_ne(__FILE__, __LINE__, #a, #b, a, b) 365 # define TEST_BN_lt(a, b) test_BN_lt(__FILE__, __LINE__, #a, #b, a, b) 366 # define TEST_BN_gt(a, b) test_BN_gt(__FILE__, __LINE__, #a, #b, a, b) 367 # define TEST_BN_le(a, b) test_BN_le(__FILE__, __LINE__, #a, #b, a, b) 368 # define TEST_BN_ge(a, b) test_BN_ge(__FILE__, __LINE__, #a, #b, a, b) 369 # define TEST_BN_eq_zero(a) test_BN_eq_zero(__FILE__, __LINE__, #a, a) 370 # define TEST_BN_ne_zero(a) test_BN_ne_zero(__FILE__, __LINE__, #a, a) 371 # define TEST_BN_lt_zero(a) test_BN_lt_zero(__FILE__, __LINE__, #a, a) 372 # define TEST_BN_gt_zero(a) test_BN_gt_zero(__FILE__, __LINE__, #a, a) 373 # define TEST_BN_le_zero(a) test_BN_le_zero(__FILE__, __LINE__, #a, a) 374 # define TEST_BN_ge_zero(a) test_BN_ge_zero(__FILE__, __LINE__, #a, a) 375 # define TEST_BN_eq_one(a) test_BN_eq_one(__FILE__, __LINE__, #a, a) 376 # define TEST_BN_eq_word(a, w) test_BN_eq_word(__FILE__, __LINE__, #a, #w, a, w) 377 # define TEST_BN_abs_eq_word(a, w) test_BN_abs_eq_word(__FILE__, __LINE__, #a, #w, a, w) 378 # define TEST_BN_odd(a) test_BN_odd(__FILE__, __LINE__, #a, a) 379 # define TEST_BN_even(a) test_BN_even(__FILE__, __LINE__, #a, a) 380 381 /* 382 * TEST_error(desc, ...) prints an informative error message in the standard 383 * format. |desc| is a printf format string. 384 */ 385 # if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199901L 386 # define TEST_error test_error_c90 387 # define TEST_info test_info_c90 388 # else 389 # define TEST_error(...) test_error(__FILE__, __LINE__, __VA_ARGS__) 390 # define TEST_info(...) test_info(__FILE__, __LINE__, __VA_ARGS__) 391 # endif 392 # define TEST_note test_note 393 # define TEST_openssl_errors test_openssl_errors 394 # define TEST_perror test_perror 395 396 extern BIO *bio_out; 397 extern BIO *bio_err; 398 399 /* 400 * Formatted output for strings, memory and bignums. 401 */ 402 void test_output_string(const char *name, const char *m, size_t l); 403 void test_output_bignum(const char *name, const BIGNUM *bn); 404 void test_output_memory(const char *name, const unsigned char *m, size_t l); 405 406 407 /* 408 * Utilities to parse a test file. 409 */ 410 #define TESTMAXPAIRS 20 411 412 typedef struct pair_st { 413 char *key; 414 char *value; 415 } PAIR; 416 417 typedef struct stanza_st { 418 const char *test_file; /* Input file name */ 419 BIO *fp; /* Input file */ 420 int curr; /* Current line in file */ 421 int start; /* Line where test starts */ 422 int errors; /* Error count */ 423 int numtests; /* Number of tests */ 424 int numskip; /* Number of skipped tests */ 425 int numpairs; 426 PAIR pairs[TESTMAXPAIRS]; 427 BIO *key; /* temp memory BIO for reading in keys */ 428 char buff[4096]; /* Input buffer for a single key/value */ 429 } STANZA; 430 431 /* 432 * Prepare to start reading the file |testfile| as input. 433 */ 434 int test_start_file(STANZA *s, const char *testfile); 435 int test_end_file(STANZA *s); 436 437 /* 438 * Read a stanza from the test file. A stanza consists of a block 439 * of lines of the form 440 * key = value 441 * The block is terminated by EOF or a blank line. 442 * Return 1 if found, 0 on EOF or error. 443 */ 444 int test_readstanza(STANZA *s); 445 446 /* 447 * Clear a stanza, release all allocated memory. 448 */ 449 void test_clearstanza(STANZA *s); 450 451 /* 452 * Glue an array of strings together and return it as an allocated string. 453 * Optionally return the whole length of this string in |out_len| 454 */ 455 char *glue_strings(const char *list[], size_t *out_len); 456 457 /* 458 * Pseudo random number generator of low quality but having repeatability 459 * across platforms. The two calls are replacements for random(3) and 460 * srandom(3). 461 */ 462 uint32_t test_random(void); 463 void test_random_seed(uint32_t sd); 464 465 /* Create a file path from a directory and a filename */ 466 char *test_mk_file_path(const char *dir, const char *file); 467 468 #endif /* OSSL_TESTUTIL_H */ 469