2 * Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
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
10 #include "../testutil.h"
16 #include "../../e_os.h"
18 /* The size of memory buffers to display on failure */
19 #define MEM_BUFFER_SIZE (2000)
20 #define MAX_STRING_WIDTH (80)
21 #define BN_OUTPUT_SIZE (8)
23 /* Output a failed test first line */
24 static void test_fail_message_prefix(const char *prefix, const char *file,
25 int line, const char *type,
26 const char *left, const char *right,
29 test_printf_stderr("%*s# %s: ", subtest_level(), "",
30 prefix != NULL ? prefix : "ERROR");
32 test_printf_stderr("(%s) ", type);
34 test_printf_stderr("'%s %s %s' failed", left, op, right);
36 test_printf_stderr(" @ %s:%d", file, line);
38 test_printf_stderr("\n");
41 /* Output a diff header */
42 static void test_diff_header(const char *left, const char *right)
44 test_printf_stderr("%*s# --- %s\n", subtest_level(), "", left);
45 test_printf_stderr("%*s# +++ %s\n", subtest_level(), "", right);
49 * A common routine to output test failure messages. Generally this should not
50 * be called directly, rather it should be called by the following functions.
52 * |desc| is a printf formatted description with arguments |args| that is
53 * supplied by the user and |desc| can be NULL. |type| is the data type
54 * that was tested (int, char, ptr, ...). |fmt| is a system provided
55 * printf format with following arguments that spell out the failure
56 * details i.e. the actual values compared and the operator used.
58 * The typical use for this is from an utility test function:
60 * int test6(const char *file, int line, int n) {
62 * test_fail_message(1, file, line, "int", "value %d is not %d", n, 6);
68 * calling test6(3, "oops") will return 0 and produce out along the lines of:
69 * FAIL oops: (int) value 3 is not 6\n
71 static void test_fail_message(const char *prefix, const char *file, int line,
72 const char *type, const char *left,
73 const char *right, const char *op,
77 static void test_fail_message_va(const char *prefix, const char *file,
78 int line, const char *type,
79 const char *left, const char *right,
80 const char *op, const char *fmt, va_list ap)
82 test_fail_message_prefix(prefix, file, line, type, left, right, op);
84 test_printf_stderr("%*s# ", subtest_level(), "");
85 test_vprintf_stderr(fmt, ap);
86 test_printf_stderr("\n");
88 test_printf_stderr("\n");
92 static void test_string_null_empty(const char *m, int indent, char c)
95 test_printf_stderr("%*s# % 4s %c NULL\n", indent, "", "", c);
97 test_printf_stderr("%*s# % 4u:%c ''\n", indent, "", 0u, c);
100 static void test_fail_string_message(const char *prefix, const char *file,
101 int line, const char *type,
102 const char *left, const char *right,
103 const char *op, const char *m1, size_t l1,
104 const char *m2, size_t l2)
106 const int indent = subtest_level();
107 const size_t width = (MAX_STRING_WIDTH - indent - 12) / 16 * 16;
108 char b1[MAX_STRING_WIDTH + 1], b2[MAX_STRING_WIDTH + 1];
109 char bdiff[MAX_STRING_WIDTH + 1];
111 unsigned int cnt = 0, diff;
113 test_fail_message_prefix(prefix, file, line, type, left, right, op);
118 if (l1 == 0 && l2 == 0) {
119 if ((m1 == NULL) == (m2 == NULL)) {
120 test_string_null_empty(m1, indent, ' ');
122 test_diff_header(left, right);
123 test_string_null_empty(m1, indent, '-');
124 test_string_null_empty(m2, indent, '+');
129 if (l1 != l2 || strcmp(m1, m2) != 0)
130 test_diff_header(left, right);
132 while (l1 > 0 || l2 > 0) {
135 b1[n1 = l1 > width ? width : l1] = 0;
136 for (i = 0; i < n1; i++)
137 b1[i] = isprint(m1[i]) ? m1[i] : '.';
140 b2[n2 = l2 > width ? width : l2] = 0;
141 for (i = 0; i < n2; i++)
142 b2[i] = isprint(m2[i]) ? m2[i] : '.';
146 if (n1 > 0 && n2 > 0) {
147 const size_t j = n1 < n2 ? n1 : n2;
150 if (m1[i] == m2[i]) {
158 if (n1 == n2 && !diff) {
159 test_printf_stderr("%*s# % 4u: '%s'\n", indent, "", cnt,
162 if (cnt == 0 && (m1 == NULL || *m1 == '\0'))
163 test_string_null_empty(m1, indent, '-');
165 test_printf_stderr("%*s# % 4u:- '%s'\n", indent, "", cnt, b1);
166 if (cnt == 0 && (m2 == NULL || *m2 == '\0'))
167 test_string_null_empty(m2, indent, '+');
169 test_printf_stderr("%*s# % 4u:+ '%s'\n", indent, "", cnt, b2);
171 test_printf_stderr("%*s# % 4s %s\n", indent, "", "", bdiff);
180 test_printf_stderr("\n");
184 static void hex_convert_memory(const unsigned char *m, size_t n, char *b,
189 for (i = 0; i < n; i++) {
190 const unsigned char c = *m++;
192 *b++ = "0123456789abcdef"[c >> 4];
193 *b++ = "0123456789abcdef"[c & 15];
194 if (i % width == width - 1 && i != n - 1)
200 static const int bn_bytes = (MAX_STRING_WIDTH - 9) / (BN_OUTPUT_SIZE * 2 + 1)
202 static const int bn_chars = (MAX_STRING_WIDTH - 9) / (BN_OUTPUT_SIZE * 2 + 1)
203 * (BN_OUTPUT_SIZE * 2 + 1) - 1;
205 static void test_bignum_header_line(void)
207 test_printf_stderr("%*s# %*s\n", subtest_level(), "", bn_chars + 6,
211 static void test_bignum_zero_print(const BIGNUM *bn, char sep)
213 const char *v = "NULL", *suf = "";
216 v = BN_is_negative(bn) ? "-0" : "0";
218 test_printf_stderr("%*s# %c%*s%s\n", subtest_level(), "", sep, bn_chars,
222 static int convert_bn_memory(const unsigned char *in, size_t bytes,
223 char *out, int *lz, const BIGNUM *bn)
225 int n = bytes * 2, i;
226 char *p = out, *q = NULL;
228 if (bn != NULL && !BN_is_zero(bn)) {
229 hex_convert_memory(in, bytes, out, BN_OUTPUT_SIZE);
231 for (; *p == '0' || *p == ' '; p++)
239 * in[bytes] is defined because we're converting a non-zero
240 * number and we've not seen a non-zero yet.
242 if ((in[bytes] & 0xf0) != 0 && BN_is_negative(bn)) {
249 if (BN_is_negative(bn)) {
251 * This is valid because we always convert more digits than
262 for (i = 0; i < n; i++) {
264 if (i % (2 * BN_OUTPUT_SIZE) == 2 * BN_OUTPUT_SIZE - 1 && i != n - 1)
271 q = BN_is_negative(bn) ? "-0" : "0";
272 strcpy(p - strlen(q), q);
276 static void test_fail_bignum_common(const char *prefix, const char *file,
277 int line, const char *type,
278 const char *left, const char *right,
280 const BIGNUM *bn1, const BIGNUM *bn2)
282 const int indent = subtest_level();
283 const size_t bytes = bn_bytes;
284 char b1[MAX_STRING_WIDTH + 1], b2[MAX_STRING_WIDTH + 1];
285 char *p, bdiff[MAX_STRING_WIDTH + 1];
286 size_t l1, l2, n1, n2, i, len;
287 unsigned int cnt, diff, real_diff;
288 unsigned char *m1 = NULL, *m2 = NULL;
289 int lz1 = 1, lz2 = 1;
290 unsigned char buffer[MEM_BUFFER_SIZE * 2], *bufp = buffer;
292 l1 = bn1 == NULL ? 0 : (BN_num_bytes(bn1) + (BN_is_negative(bn1) ? 1 : 0));
293 l2 = bn2 == NULL ? 0 : (BN_num_bytes(bn2) + (BN_is_negative(bn2) ? 1 : 0));
294 if (l1 == 0 && l2 == 0) {
295 if ((bn1 == NULL) == (bn2 == NULL)) {
296 test_bignum_header_line();
297 test_bignum_zero_print(bn1, ' ');
299 test_diff_header(left, right);
300 test_bignum_header_line();
301 test_bignum_zero_print(bn1, '-');
302 test_bignum_zero_print(bn2, '+');
307 if (l1 != l2 || bn1 == NULL || bn2 == NULL || BN_cmp(bn1, bn2) != 0)
308 test_diff_header(left, right);
309 test_bignum_header_line();
311 len = ((l1 > l2 ? l1 : l2) + bytes - 1) / bytes * bytes;
313 if (len > MEM_BUFFER_SIZE && (bufp = OPENSSL_malloc(len * 2)) == NULL) {
315 len = MEM_BUFFER_SIZE;
316 test_printf_stderr("%*s# WARNING: these BIGNUMs have been truncated",
322 BN_bn2binpad(bn1, m1, len);
326 BN_bn2binpad(bn2, m2, len);
330 cnt = 8 * (len - bytes);
331 n1 = convert_bn_memory(m1, bytes, b1, &lz1, bn1);
332 n2 = convert_bn_memory(m2, bytes, b2, &lz2, bn2);
334 diff = real_diff = 0;
337 for (i=0; b1[i] != '\0'; i++)
338 if (b1[i] == b2[i] || b1[i] == ' ' || b2[i] == ' ') {
340 diff |= b1[i] != b2[i];
343 real_diff = diff = 1;
347 test_printf_stderr("%*s# %s:% 5d\n", indent, "",
348 n2 > n1 ? b2 : b1, cnt);
350 if (cnt == 0 && bn1 == NULL)
351 test_printf_stderr("%*s# -%s\n", indent, "", b1);
352 else if (cnt == 0 || n1 > 0)
353 test_printf_stderr("%*s# -%s:% 5d\n", indent, "", b1, cnt);
354 if (cnt == 0 && bn2 == NULL)
355 test_printf_stderr("%*s# +%s\n", indent, "", b2);
356 else if (cnt == 0 || n2 > 0)
357 test_printf_stderr("%*s# +%s:% 5d\n", indent, "", b2, cnt);
358 if (real_diff && (cnt == 0 || (n1 > 0 && n2 > 0))
359 && bn1 != NULL && bn2 != NULL)
360 test_printf_stderr("%*s# %s\n", indent, "", bdiff);
369 test_printf_stderr("\n");
375 static void test_fail_bignum_message(const char *prefix, const char *file,
376 int line, const char *type,
377 const char *left, const char *right,
379 const BIGNUM *bn1, const BIGNUM *bn2)
381 test_fail_message_prefix(prefix, file, line, type, left, right, op);
382 test_fail_bignum_common(prefix, file, line, type, left, right, op, bn1, bn2);
385 static void test_fail_bignum_mono_message(const char *prefix, const char *file,
386 int line, const char *type,
387 const char *left, const char *right,
388 const char *op, const BIGNUM *bn)
390 test_fail_message_prefix(prefix, file, line, type, left, right, op);
391 test_fail_bignum_common(prefix, file, line, type, left, right, op, bn, bn);
394 static void test_memory_null_empty(const unsigned char *m, int indent, char c)
397 test_printf_stderr("%*s# % 4s %c%s\n", indent, "", "", c, "NULL");
399 test_printf_stderr("%*s# %04x %c%s\n", indent, "", 0u, c, "empty");
402 static void test_fail_memory_message(const char *prefix, const char *file,
403 int line, const char *type,
404 const char *left, const char *right,
406 const unsigned char *m1, size_t l1,
407 const unsigned char *m2, size_t l2)
409 const int indent = subtest_level();
410 const size_t bytes = (MAX_STRING_WIDTH - 9) / 17 * 8;
411 char b1[MAX_STRING_WIDTH + 1], b2[MAX_STRING_WIDTH + 1];
412 char *p, bdiff[MAX_STRING_WIDTH + 1];
414 unsigned int cnt = 0, diff;
416 test_fail_message_prefix(prefix, file, line, type, left, right, op);
421 if (l1 == 0 && l2 == 0) {
422 if ((m1 == NULL) == (m2 == NULL)) {
423 test_memory_null_empty(m1, indent, ' ');
425 test_diff_header(left, right);
426 test_memory_null_empty(m1, indent, '-');
427 test_memory_null_empty(m2, indent, '+');
432 if (l1 != l2 || memcmp(m1, m2, l1) != 0)
433 test_diff_header(left, right);
435 while (l1 > 0 || l2 > 0) {
438 n1 = l1 > bytes ? bytes : l1;
439 hex_convert_memory(m1, n1, b1, 8);
442 n2 = l2 > bytes ? bytes : l2;
443 hex_convert_memory(m2, n2, b2, 8);
449 if (n1 > 0 && n2 > 0) {
450 const size_t j = n1 < n2 ? n1 : n2;
453 if (m1[i] == m2[i]) {
461 if (i % 8 == 7 && i != j - 1)
467 if (n1 == n2 && !diff) {
468 test_printf_stderr("%*s# %04x: %s\n", indent, "", cnt, b1);
470 if (cnt == 0 && (m1 == NULL || l1 == 0))
471 test_memory_null_empty(m1, indent, '-');
473 test_printf_stderr("%*s# %04x:-%s\n", indent, "", cnt, b1);
474 if (cnt == 0 && (m2 == NULL || l2 == 0))
475 test_memory_null_empty(m2, indent, '+');
477 test_printf_stderr("%*s# %04x:+%s\n", indent, "", cnt, b2);
479 test_printf_stderr("%*s# % 4s %s\n", indent, "", "", bdiff);
488 test_printf_stderr("\n");
492 static void test_fail_message(const char *prefix, const char *file,
493 int line, const char *type,
494 const char *left, const char *right,
495 const char *op, const char *fmt, ...)
500 test_fail_message_va(prefix, file, line, type, left, right, op, fmt, ap);
504 void test_info_c90(const char *desc, ...)
509 test_fail_message_va("INFO", NULL, -1, NULL, NULL, NULL, NULL, desc, ap);
513 void test_info(const char *file, int line, const char *desc, ...)
518 test_fail_message_va("INFO", file, line, NULL, NULL, NULL, NULL, desc, ap);
522 void test_error_c90(const char *desc, ...)
527 test_fail_message_va(NULL, NULL, -1, NULL, NULL, NULL, NULL, desc, ap);
531 void test_error(const char *file, int line, const char *desc, ...)
536 test_fail_message_va(NULL, file, line, NULL, NULL, NULL, NULL, desc, ap);
540 void test_openssl_errors(void)
542 ERR_print_errors_cb(openssl_error_cb, NULL);
546 * Define some comparisons between pairs of various types.
547 * These functions return 1 if the test is true.
548 * Otherwise, they return 0 and pretty-print diagnostics.
550 * In each case the functions produced are:
551 * int test_name_eq(const type t1, const type t2, const char *desc, ...);
552 * int test_name_ne(const type t1, const type t2, const char *desc, ...);
553 * int test_name_lt(const type t1, const type t2, const char *desc, ...);
554 * int test_name_le(const type t1, const type t2, const char *desc, ...);
555 * int test_name_gt(const type t1, const type t2, const char *desc, ...);
556 * int test_name_ge(const type t1, const type t2, const char *desc, ...);
558 * The t1 and t2 arguments are to be compared for equality, inequality,
559 * less than, less than or equal to, greater than and greater than or
560 * equal to respectively. If the specified condition holds, the functions
561 * return 1. If the condition does not hold, the functions print a diagnostic
562 * message and return 0.
564 * The desc argument is a printf format string followed by its arguments and
565 * this is included in the output if the condition being tested for is false.
567 #define DEFINE_COMPARISON(type, name, opname, op, fmt) \
568 int test_ ## name ## _ ## opname(const char *file, int line, \
569 const char *s1, const char *s2, \
570 const type t1, const type t2) \
574 test_fail_message(NULL, file, line, #type, s1, s2, #op, \
575 "[" fmt "] compared to [" fmt "]", \
580 #define DEFINE_COMPARISONS(type, name, fmt) \
581 DEFINE_COMPARISON(type, name, eq, ==, fmt) \
582 DEFINE_COMPARISON(type, name, ne, !=, fmt) \
583 DEFINE_COMPARISON(type, name, lt, <, fmt) \
584 DEFINE_COMPARISON(type, name, le, <=, fmt) \
585 DEFINE_COMPARISON(type, name, gt, >, fmt) \
586 DEFINE_COMPARISON(type, name, ge, >=, fmt)
588 DEFINE_COMPARISONS(int, int, "%d")
589 DEFINE_COMPARISONS(unsigned int, uint, "%u")
590 DEFINE_COMPARISONS(char, char, "%c")
591 DEFINE_COMPARISONS(unsigned char, uchar, "%u")
592 DEFINE_COMPARISONS(long, long, "%ld")
593 DEFINE_COMPARISONS(unsigned long, ulong, "%lu")
594 DEFINE_COMPARISONS(size_t, size_t, "%zu")
596 DEFINE_COMPARISON(void *, ptr, eq, ==, "%p")
597 DEFINE_COMPARISON(void *, ptr, ne, !=, "%p")
599 int test_ptr_null(const char *file, int line, const char *s, const void *p)
603 test_fail_message(NULL, file, line, "ptr", s, "NULL", "==", "%p", p);
607 int test_ptr(const char *file, int line, const char *s, const void *p)
611 test_fail_message(NULL, file, line, "ptr", s, "NULL", "!=", "%p", p);
615 int test_true(const char *file, int line, const char *s, int b)
619 test_fail_message(NULL, file, line, "bool", s, "true", "==", "false");
623 int test_false(const char *file, int line, const char *s, int b)
627 test_fail_message(NULL, file, line, "bool", s, "false", "==", "true");
631 int test_str_eq(const char *file, int line, const char *st1, const char *st2,
632 const char *s1, const char *s2)
634 if (s1 == NULL && s2 == NULL)
636 if (s1 == NULL || s2 == NULL || strcmp(s1, s2) != 0) {
637 test_fail_string_message(NULL, file, line, "string", st1, st2, "==",
638 s1, s1 == NULL ? 0 : strlen(s1),
639 s2, s2 == NULL ? 0 : strlen(s2));
645 int test_str_ne(const char *file, int line, const char *st1, const char *st2,
646 const char *s1, const char *s2)
648 if ((s1 == NULL) ^ (s2 == NULL))
650 if (s1 == NULL || strcmp(s1, s2) == 0) {
651 test_fail_string_message(NULL, file, line, "string", st1, st2, "!=",
652 s1, s1 == NULL ? 0 : strlen(s1),
653 s2, s2 == NULL ? 0 : strlen(s2));
659 int test_strn_eq(const char *file, int line, const char *st1, const char *st2,
660 const char *s1, const char *s2, size_t len)
662 if (s1 == NULL && s2 == NULL)
664 if (s1 == NULL || s2 == NULL || strncmp(s1, s2, len) != 0) {
665 test_fail_string_message(NULL, file, line, "string", st1, st2, "==",
666 s1, s1 == NULL ? 0 : OPENSSL_strnlen(s1, len),
667 s2, s2 == NULL ? 0 : OPENSSL_strnlen(s2, len));
673 int test_strn_ne(const char *file, int line, const char *st1, const char *st2,
674 const char *s1, const char *s2, size_t len)
676 if ((s1 == NULL) ^ (s2 == NULL))
678 if (s1 == NULL || strncmp(s1, s2, len) == 0) {
679 test_fail_string_message(NULL, file, line, "string", st1, st2, "!=",
680 s1, s1 == NULL ? 0 : OPENSSL_strnlen(s1, len),
681 s2, s2 == NULL ? 0 : OPENSSL_strnlen(s2, len));
687 int test_mem_eq(const char *file, int line, const char *st1, const char *st2,
688 const void *s1, size_t n1, const void *s2, size_t n2)
690 if (s1 == NULL && s2 == NULL)
692 if (n1 != n2 || s1 == NULL || s2 == NULL || memcmp(s1, s2, n1) != 0) {
693 test_fail_memory_message(NULL, file, line, "memory", st1, st2, "==",
700 int test_mem_ne(const char *file, int line, const char *st1, const char *st2,
701 const void *s1, size_t n1, const void *s2, size_t n2)
703 if ((s1 == NULL) ^ (s2 == NULL))
707 if (s1 == NULL || memcmp(s1, s2, n1) == 0) {
708 test_fail_memory_message(NULL, file, line, "memory", st1, st2, "!=",
715 #define DEFINE_BN_COMPARISONS(opname, op, zero_cond) \
716 int test_BN_ ## opname(const char *file, int line, \
717 const char *s1, const char *s2, \
718 const BIGNUM *t1, const BIGNUM *t2) \
720 if (BN_cmp(t1, t2) op 0) \
722 test_fail_bignum_message(NULL, file, line, "BIGNUM", s1, s2, \
726 int test_BN_ ## opname ## _zero(const char *file, int line, \
727 const char *s, const BIGNUM *a) \
729 if (a != NULL &&(zero_cond)) \
731 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", \
736 DEFINE_BN_COMPARISONS(eq, ==, BN_is_zero(a))
737 DEFINE_BN_COMPARISONS(ne, !=, !BN_is_zero(a))
738 DEFINE_BN_COMPARISONS(gt, >, !BN_is_negative(a) && !BN_is_zero(a))
739 DEFINE_BN_COMPARISONS(ge, >=, !BN_is_negative(a) || BN_is_zero(a))
740 DEFINE_BN_COMPARISONS(lt, <, BN_is_negative(a) && !BN_is_zero(a))
741 DEFINE_BN_COMPARISONS(le, <=, BN_is_negative(a) || BN_is_zero(a))
743 int test_BN_eq_one(const char *file, int line, const char *s, const BIGNUM *a)
745 if (a != NULL && BN_is_one(a))
747 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", s, "1", "==", a);
751 int test_BN_odd(const char *file, int line, const char *s, const BIGNUM *a)
753 if (a != NULL && BN_is_odd(a))
755 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", "ODD(", ")", s, a);
759 int test_BN_even(const char *file, int line, const char *s, const BIGNUM *a)
761 if (a != NULL && !BN_is_odd(a))
763 test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", "EVEN(", ")", s,
768 int test_BN_eq_word(const char *file, int line, const char *bns, const char *ws,
769 const BIGNUM *a, BN_ULONG w)
773 if (a != NULL && BN_is_word(a, w))
777 test_fail_bignum_message(NULL, file, line, "BIGNUM", bns, ws, "==", a, bw);
782 int test_BN_abs_eq_word(const char *file, int line, const char *bns,
783 const char *ws, const BIGNUM *a, BN_ULONG w)
787 if (a != NULL && BN_abs_is_word(a, w))
791 BN_set_negative(aa, 0);
793 test_fail_bignum_message(NULL, file, line, "BIGNUM", bns, ws, "abs==",