2 * Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
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
10 #include "../testutil.h"
17 #include "internal/nelem.h"
18 #include <openssl/asn1.h>
21 * Output a failed test first line.
22 * All items are optional are generally not preinted if passed as NULL.
23 * The special cases are for prefix where "ERROR" is assumed and for left
24 * and right where a non-failure message is produced if either is NULL.
26 void test_fail_message_prefix(const char *prefix, const char *file,
27 int line, const char *type,
28 const char *left, const char *right,
31 test_printf_stderr("%s: ", prefix != NULL ? prefix : "ERROR");
33 test_printf_stderr("(%s) ", type);
35 if (left != NULL && right != NULL)
36 test_printf_stderr("'%s %s %s' failed", left, op, right);
38 test_printf_stderr("'%s'", op);
41 test_printf_stderr(" @ %s:%d", file, line);
43 test_printf_stderr("\n");
47 * A common routine to output test failure messages. Generally this should not
48 * be called directly, rather it should be called by the following functions.
50 * |desc| is a printf formatted description with arguments |args| that is
51 * supplied by the user and |desc| can be NULL. |type| is the data type
52 * that was tested (int, char, ptr, ...). |fmt| is a system provided
53 * printf format with following arguments that spell out the failure
54 * details i.e. the actual values compared and the operator used.
56 * The typical use for this is from an utility test function:
58 * int test6(const char *file, int line, int n) {
60 * test_fail_message(1, file, line, "int", "value %d is not %d", n, 6);
66 * calling test6(3, "oops") will return 0 and produce out along the lines of:
67 * FAIL oops: (int) value 3 is not 6\n
69 static void test_fail_message(const char *prefix, const char *file, int line,
70 const char *type, const char *left,
71 const char *right, const char *op,
75 static void test_fail_message_va(const char *prefix, const char *file,
76 int line, const char *type,
77 const char *left, const char *right,
78 const char *op, const char *fmt, va_list ap)
80 test_fail_message_prefix(prefix, file, line, type, left, right, op);
82 test_vprintf_stderr(fmt, ap);
83 test_printf_stderr("\n");
88 static void test_fail_message(const char *prefix, const char *file,
89 int line, const char *type,
90 const char *left, const char *right,
91 const char *op, const char *fmt, ...)
96 test_fail_message_va(prefix, file, line, type, left, right, op, fmt, ap);
100 void test_info_c90(const char *desc, ...)
105 test_fail_message_va("INFO", NULL, -1, NULL, NULL, NULL, NULL, desc, ap);
109 void test_info(const char *file, int line, const char *desc, ...)
114 test_fail_message_va("INFO", file, line, NULL, NULL, NULL, NULL, desc, ap);
118 void test_error_c90(const char *desc, ...)
123 test_fail_message_va(NULL, NULL, -1, NULL, NULL, NULL, NULL, desc, ap);
125 test_printf_stderr("\n");
128 void test_error(const char *file, int line, const char *desc, ...)
133 test_fail_message_va(NULL, file, line, NULL, NULL, NULL, NULL, desc, ap);
135 test_printf_stderr("\n");
138 void test_perror(const char *s)
141 * Using openssl_strerror_r causes linking issues since it isn't
142 * exported from libcrypto.so
144 TEST_error("%s: %s", s, strerror(errno));
147 void test_note(const char *fmt, ...)
153 test_vprintf_stderr(fmt, ap);
155 test_printf_stderr("\n");
160 void test_openssl_errors(void)
162 ERR_print_errors_cb(openssl_error_cb, NULL);
167 * Define some comparisons between pairs of various types.
168 * These functions return 1 if the test is true.
169 * Otherwise, they return 0 and pretty-print diagnostics.
171 * In each case the functions produced are:
172 * int test_name_eq(const type t1, const type t2, const char *desc, ...);
173 * int test_name_ne(const type t1, const type t2, const char *desc, ...);
174 * int test_name_lt(const type t1, const type t2, const char *desc, ...);
175 * int test_name_le(const type t1, const type t2, const char *desc, ...);
176 * int test_name_gt(const type t1, const type t2, const char *desc, ...);
177 * int test_name_ge(const type t1, const type t2, const char *desc, ...);
179 * The t1 and t2 arguments are to be compared for equality, inequality,
180 * less than, less than or equal to, greater than and greater than or
181 * equal to respectively. If the specified condition holds, the functions
182 * return 1. If the condition does not hold, the functions print a diagnostic
183 * message and return 0.
185 * The desc argument is a printf format string followed by its arguments and
186 * this is included in the output if the condition being tested for is false.
188 #define DEFINE_COMPARISON(type, name, opname, op, fmt) \
189 int test_ ## name ## _ ## opname(const char *file, int line, \
190 const char *s1, const char *s2, \
191 const type t1, const type t2) \
195 test_fail_message(NULL, file, line, #type, s1, s2, #op, \
196 "[" fmt "] compared to [" fmt "]", \
201 #define DEFINE_COMPARISONS(type, name, fmt) \
202 DEFINE_COMPARISON(type, name, eq, ==, fmt) \
203 DEFINE_COMPARISON(type, name, ne, !=, fmt) \
204 DEFINE_COMPARISON(type, name, lt, <, fmt) \
205 DEFINE_COMPARISON(type, name, le, <=, fmt) \
206 DEFINE_COMPARISON(type, name, gt, >, fmt) \
207 DEFINE_COMPARISON(type, name, ge, >=, fmt)
209 DEFINE_COMPARISONS(int, int, "%d")
210 DEFINE_COMPARISONS(unsigned int, uint, "%u")
211 DEFINE_COMPARISONS(char, char, "%c")
212 DEFINE_COMPARISONS(unsigned char, uchar, "%u")
213 DEFINE_COMPARISONS(long, long, "%ld")
214 DEFINE_COMPARISONS(unsigned long, ulong, "%lu")
215 DEFINE_COMPARISONS(size_t, size_t, "%zu")
216 DEFINE_COMPARISONS(double, double, "%g")
218 DEFINE_COMPARISON(void *, ptr, eq, ==, "%p")
219 DEFINE_COMPARISON(void *, ptr, ne, !=, "%p")
221 int test_ptr_null(const char *file, int line, const char *s, const void *p)
225 test_fail_message(NULL, file, line, "ptr", s, "NULL", "==", "%p", p);
229 int test_ptr(const char *file, int line, const char *s, const void *p)
233 test_fail_message(NULL, file, line, "ptr", s, "NULL", "!=", "%p", p);
237 int test_true(const char *file, int line, const char *s, int b)
241 test_fail_message(NULL, file, line, "bool", s, "true", "==", "false");
245 int test_false(const char *file, int line, const char *s, int b)
249 test_fail_message(NULL, file, line, "bool", s, "false", "==", "true");
253 int test_str_eq(const char *file, int line, const char *st1, const char *st2,
254 const char *s1, const char *s2)
256 if (s1 == NULL && s2 == NULL)
258 if (s1 == NULL || s2 == NULL || strcmp(s1, s2) != 0) {
259 test_fail_string_message(NULL, file, line, "string", st1, st2, "==",
260 s1, s1 == NULL ? 0 : strlen(s1),
261 s2, s2 == NULL ? 0 : strlen(s2));
267 int test_str_ne(const char *file, int line, const char *st1, const char *st2,
268 const char *s1, const char *s2)
270 if ((s1 == NULL) ^ (s2 == NULL))
272 if (s1 == NULL || strcmp(s1, s2) == 0) {
273 test_fail_string_message(NULL, file, line, "string", st1, st2, "!=",
274 s1, s1 == NULL ? 0 : strlen(s1),
275 s2, s2 == NULL ? 0 : strlen(s2));
281 int test_strn_eq(const char *file, int line, const char *st1, const char *st2,
282 const char *s1, const char *s2, size_t len)
284 if (s1 == NULL && s2 == NULL)
286 if (s1 == NULL || s2 == NULL || strncmp(s1, s2, len) != 0) {
287 test_fail_string_message(NULL, file, line, "string", st1, st2, "==",
288 s1, s1 == NULL ? 0 : OPENSSL_strnlen(s1, len),
289 s2, s2 == NULL ? 0 : OPENSSL_strnlen(s2, len));
295 int test_strn_ne(const char *file, int line, const char *st1, const char *st2,
296 const char *s1, const char *s2, size_t len)
298 if ((s1 == NULL) ^ (s2 == NULL))
300 if (s1 == NULL || strncmp(s1, s2, len) == 0) {
301 test_fail_string_message(NULL, file, line, "string", st1, st2, "!=",
302 s1, s1 == NULL ? 0 : OPENSSL_strnlen(s1, len),
303 s2, s2 == NULL ? 0 : OPENSSL_strnlen(s2, len));
309 int test_mem_eq(const char *file, int line, const char *st1, const char *st2,
310 const void *s1, size_t n1, const void *s2, size_t n2)
312 if (s1 == NULL && s2 == NULL)
314 if (n1 != n2 || s1 == NULL || s2 == NULL || memcmp(s1, s2, n1) != 0) {
315 test_fail_memory_message(NULL, file, line, "memory", st1, st2, "==",
322 int test_mem_ne(const char *file, int line, const char *st1, const char *st2,
323 const void *s1, size_t n1, const void *s2, size_t n2)
325 if ((s1 == NULL) ^ (s2 == NULL))
329 if (s1 == NULL || memcmp(s1, s2, n1) == 0) {
330 test_fail_memory_message(NULL, file, line, "memory", st1, st2, "!=",
337 #define DEFINE_BN_COMPARISONS(opname, op, zero_cond) \
338 int test_BN_ ## opname(const char *file, int line, \
339 const char *s1, const char *s2, \
340 const BIGNUM *t1, const BIGNUM *t2) \
342 if (BN_cmp(t1, t2) op 0) \
344 test_fail_bignum_message(NULL, file, line, "BIGNUM", s1, s2, \
348 int test_BN_ ## opname ## _zero(const char *file, int line, \
349 const char *s, const BIGNUM *a) \
351 if (a != NULL &&(zero_cond)) \
353 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", \
358 DEFINE_BN_COMPARISONS(eq, ==, BN_is_zero(a))
359 DEFINE_BN_COMPARISONS(ne, !=, !BN_is_zero(a))
360 DEFINE_BN_COMPARISONS(gt, >, !BN_is_negative(a) && !BN_is_zero(a))
361 DEFINE_BN_COMPARISONS(ge, >=, !BN_is_negative(a) || BN_is_zero(a))
362 DEFINE_BN_COMPARISONS(lt, <, BN_is_negative(a) && !BN_is_zero(a))
363 DEFINE_BN_COMPARISONS(le, <=, BN_is_negative(a) || BN_is_zero(a))
365 int test_BN_eq_one(const char *file, int line, const char *s, const BIGNUM *a)
367 if (a != NULL && BN_is_one(a))
369 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", s, "1", "==", a);
373 int test_BN_odd(const char *file, int line, const char *s, const BIGNUM *a)
375 if (a != NULL && BN_is_odd(a))
377 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", "ODD(", ")", s, a);
381 int test_BN_even(const char *file, int line, const char *s, const BIGNUM *a)
383 if (a != NULL && !BN_is_odd(a))
385 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", "EVEN(", ")", s,
390 int test_BN_eq_word(const char *file, int line, const char *bns, const char *ws,
391 const BIGNUM *a, BN_ULONG w)
395 if (a != NULL && BN_is_word(a, w))
399 test_fail_bignum_message(NULL, file, line, "BIGNUM", bns, ws, "==", a, bw);
404 int test_BN_abs_eq_word(const char *file, int line, const char *bns,
405 const char *ws, const BIGNUM *a, BN_ULONG w)
409 if (a != NULL && BN_abs_is_word(a, w))
413 BN_set_negative(aa, 0);
415 test_fail_bignum_message(NULL, file, line, "BIGNUM", bns, ws, "abs==",
422 static const char *print_time(const ASN1_TIME *t)
424 return t == NULL ? "<null>" : (const char *)ASN1_STRING_get0_data(t);
427 #define DEFINE_TIME_T_COMPARISON(opname, op) \
428 int test_time_t_ ## opname(const char *file, int line, \
429 const char *s1, const char *s2, \
430 const time_t t1, const time_t t2) \
432 ASN1_TIME *at1 = ASN1_TIME_set(NULL, t1); \
433 ASN1_TIME *at2 = ASN1_TIME_set(NULL, t2); \
434 int r = at1 != NULL && at2 != NULL \
435 && ASN1_TIME_compare(at1, at2) op 0; \
437 test_fail_message(NULL, file, line, "time_t", s1, s2, #op, \
438 "[%s] compared to [%s]", \
439 print_time(at1), print_time(at2)); \
440 ASN1_STRING_free(at1); \
441 ASN1_STRING_free(at2); \
444 DEFINE_TIME_T_COMPARISON(eq, ==)
445 DEFINE_TIME_T_COMPARISON(ne, !=)
446 DEFINE_TIME_T_COMPARISON(gt, >)
447 DEFINE_TIME_T_COMPARISON(ge, >=)
448 DEFINE_TIME_T_COMPARISON(lt, <)
449 DEFINE_TIME_T_COMPARISON(le, <=)