1/*
2 * Copyright 2017-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#include "../testutil.h"
11#include "output.h"
12#include "tu_local.h"
13
14#include <errno.h>
15#include <string.h>
16#include <ctype.h>
17#include "internal/nelem.h"
18#include <openssl/asn1.h>
19
20/*
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.
25 */
26void test_fail_message_prefix(const char *prefix, const char *file,
27                              int line, const char *type,
28                              const char *left, const char *right,
29                              const char *op)
30{
31    test_printf_stderr("%s: ", prefix != NULL ? prefix : "ERROR");
32    if (type)
33        test_printf_stderr("(%s) ", type);
34    if (op != NULL) {
35        if (left != NULL && right != NULL)
36            test_printf_stderr("'%s %s %s' failed", left, op, right);
37        else
38            test_printf_stderr("'%s'", op);
39    }
40    if (file != NULL) {
41        test_printf_stderr(" @ %s:%d", file, line);
42    }
43    test_printf_stderr("\n");
44}
45
46/*
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.
49 *
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.
55 *
56 * The typical use for this is from an utility test function:
57 *
58 * int test6(const char *file, int line, int n) {
59 *     if (n != 6) {
60 *         test_fail_message(1, file, line, "int", "value %d is not %d", n, 6);
61 *         return 0;
62 *     }
63 *     return 1;
64 * }
65 *
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
68 */
69static 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,
72                              const char *fmt, ...)
73            PRINTF_FORMAT(8, 9);
74
75static 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)
79{
80    test_fail_message_prefix(prefix, file, line, type, left, right, op);
81    if (fmt != NULL) {
82        test_vprintf_stderr(fmt, ap);
83        test_printf_stderr("\n");
84    }
85    test_flush_stderr();
86}
87
88static 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, ...)
92{
93    va_list ap;
94
95    va_start(ap, fmt);
96    test_fail_message_va(prefix, file, line, type, left, right, op, fmt, ap);
97    va_end(ap);
98}
99
100void test_info_c90(const char *desc, ...)
101{
102    va_list ap;
103
104    va_start(ap, desc);
105    test_fail_message_va("INFO", NULL, -1, NULL, NULL, NULL, NULL, desc, ap);
106    va_end(ap);
107}
108
109void test_info(const char *file, int line, const char *desc, ...)
110{
111    va_list ap;
112
113    va_start(ap, desc);
114    test_fail_message_va("INFO", file, line, NULL, NULL, NULL, NULL, desc, ap);
115    va_end(ap);
116}
117
118void test_error_c90(const char *desc, ...)
119{
120    va_list ap;
121
122    va_start(ap, desc);
123    test_fail_message_va(NULL, NULL, -1, NULL, NULL, NULL, NULL, desc, ap);
124    va_end(ap);
125    test_printf_stderr("\n");
126}
127
128void test_error(const char *file, int line, const char *desc, ...)
129{
130    va_list ap;
131
132    va_start(ap, desc);
133    test_fail_message_va(NULL, file, line, NULL, NULL, NULL, NULL, desc, ap);
134    va_end(ap);
135    test_printf_stderr("\n");
136}
137
138void test_perror(const char *s)
139{
140    /*
141     * Using openssl_strerror_r causes linking issues since it isn't
142     * exported from libcrypto.so
143     */
144    TEST_error("%s: %s", s, strerror(errno));
145}
146
147void test_note(const char *fmt, ...)
148{
149    if (fmt != NULL) {
150        va_list ap;
151
152        va_start(ap, fmt);
153        test_vprintf_stderr(fmt, ap);
154        va_end(ap);
155        test_printf_stderr("\n");
156    }
157    test_flush_stderr();
158}
159
160
161int test_skip(const char *file, int line, const char *desc, ...)
162{
163    va_list ap;
164
165    va_start(ap, desc);
166    test_fail_message_va("SKIP", file, line, NULL, NULL, NULL, NULL, desc, ap);
167    va_end(ap);
168    return TEST_SKIP_CODE;
169}
170
171int test_skip_c90(const char *desc, ...)
172{
173    va_list ap;
174
175    va_start(ap, desc);
176    test_fail_message_va("SKIP", NULL, -1, NULL, NULL, NULL, NULL, desc, ap);
177    va_end(ap);
178    test_printf_stderr("\n");
179    return TEST_SKIP_CODE;
180}
181
182
183void test_openssl_errors(void)
184{
185    ERR_print_errors_cb(openssl_error_cb, NULL);
186    ERR_clear_error();
187}
188
189/*
190 * Define some comparisons between pairs of various types.
191 * These functions return 1 if the test is true.
192 * Otherwise, they return 0 and pretty-print diagnostics.
193 *
194 * In each case the functions produced are:
195 *  int test_name_eq(const type t1, const type t2, const char *desc, ...);
196 *  int test_name_ne(const type t1, const type t2, const char *desc, ...);
197 *  int test_name_lt(const type t1, const type t2, const char *desc, ...);
198 *  int test_name_le(const type t1, const type t2, const char *desc, ...);
199 *  int test_name_gt(const type t1, const type t2, const char *desc, ...);
200 *  int test_name_ge(const type t1, const type t2, const char *desc, ...);
201 *
202 * The t1 and t2 arguments are to be compared for equality, inequality,
203 * less than, less than or equal to, greater than and greater than or
204 * equal to respectively.  If the specified condition holds, the functions
205 * return 1.  If the condition does not hold, the functions print a diagnostic
206 * message and return 0.
207 *
208 * The desc argument is a printf format string followed by its arguments and
209 * this is included in the output if the condition being tested for is false.
210 */
211#define DEFINE_COMPARISON(type, name, opname, op, fmt)                  \
212    int test_ ## name ## _ ## opname(const char *file, int line,        \
213                                     const char *s1, const char *s2,    \
214                                     const type t1, const type t2)      \
215    {                                                                   \
216        if (t1 op t2)                                                   \
217            return 1;                                                   \
218        test_fail_message(NULL, file, line, #type, s1, s2, #op,         \
219                          "[" fmt "] compared to [" fmt "]",            \
220                          t1, t2);                                      \
221        return 0;                                                       \
222    }
223
224#define DEFINE_COMPARISONS(type, name, fmt)                             \
225    DEFINE_COMPARISON(type, name, eq, ==, fmt)                          \
226    DEFINE_COMPARISON(type, name, ne, !=, fmt)                          \
227    DEFINE_COMPARISON(type, name, lt, <, fmt)                           \
228    DEFINE_COMPARISON(type, name, le, <=, fmt)                          \
229    DEFINE_COMPARISON(type, name, gt, >, fmt)                           \
230    DEFINE_COMPARISON(type, name, ge, >=, fmt)
231
232DEFINE_COMPARISONS(int, int, "%d")
233DEFINE_COMPARISONS(unsigned int, uint, "%u")
234DEFINE_COMPARISONS(char, char, "%c")
235DEFINE_COMPARISONS(unsigned char, uchar, "%u")
236DEFINE_COMPARISONS(long, long, "%ld")
237DEFINE_COMPARISONS(unsigned long, ulong, "%lu")
238DEFINE_COMPARISONS(size_t, size_t, "%zu")
239DEFINE_COMPARISONS(double, double, "%g")
240
241DEFINE_COMPARISON(void *, ptr, eq, ==, "%p")
242DEFINE_COMPARISON(void *, ptr, ne, !=, "%p")
243
244int test_ptr_null(const char *file, int line, const char *s, const void *p)
245{
246    if (p == NULL)
247        return 1;
248    test_fail_message(NULL, file, line, "ptr", s, "NULL", "==", "%p", p);
249    return 0;
250}
251
252int test_ptr(const char *file, int line, const char *s, const void *p)
253{
254    if (p != NULL)
255        return 1;
256    test_fail_message(NULL, file, line, "ptr", s, "NULL", "!=", "%p", p);
257    return 0;
258}
259
260int test_true(const char *file, int line, const char *s, int b)
261{
262    if (b)
263        return 1;
264    test_fail_message(NULL, file, line, "bool", s, "true", "==", "false");
265    return 0;
266}
267
268int test_false(const char *file, int line, const char *s, int b)
269{
270    if (!b)
271        return 1;
272    test_fail_message(NULL, file, line, "bool", s, "false", "==", "true");
273    return 0;
274}
275
276int test_str_eq(const char *file, int line, const char *st1, const char *st2,
277                const char *s1, const char *s2)
278{
279    if (s1 == NULL && s2 == NULL)
280      return 1;
281    if (s1 == NULL || s2 == NULL || strcmp(s1, s2) != 0) {
282        test_fail_string_message(NULL, file, line, "string", st1, st2, "==",
283                                 s1, s1 == NULL ? 0 : strlen(s1),
284                                 s2, s2 == NULL ? 0 : strlen(s2));
285        return 0;
286    }
287    return 1;
288}
289
290int test_str_ne(const char *file, int line, const char *st1, const char *st2,
291                const char *s1, const char *s2)
292{
293    if ((s1 == NULL) ^ (s2 == NULL))
294      return 1;
295    if (s1 == NULL || strcmp(s1, s2) == 0) {
296        test_fail_string_message(NULL, file, line, "string", st1, st2, "!=",
297                                 s1, s1 == NULL ? 0 : strlen(s1),
298                                 s2, s2 == NULL ? 0 : strlen(s2));
299        return 0;
300    }
301    return 1;
302}
303
304int test_strn_eq(const char *file, int line, const char *st1, const char *st2,
305                 const char *s1, size_t n1, const char *s2, size_t n2)
306{
307    if (s1 == NULL && s2 == NULL)
308      return 1;
309    if (n1 != n2 || s1 == NULL || s2 == NULL || strncmp(s1, s2, n1) != 0) {
310        test_fail_string_message(NULL, file, line, "string", st1, st2, "==",
311                                 s1, s1 == NULL ? 0 : OPENSSL_strnlen(s1, n1),
312                                 s2, s2 == NULL ? 0 : OPENSSL_strnlen(s2, n2));
313        return 0;
314    }
315    return 1;
316}
317
318int test_strn_ne(const char *file, int line, const char *st1, const char *st2,
319                 const char *s1, size_t n1, const char *s2, size_t n2)
320{
321    if ((s1 == NULL) ^ (s2 == NULL))
322      return 1;
323    if (n1 != n2 || s1 == NULL || strncmp(s1, s2, n1) == 0) {
324        test_fail_string_message(NULL, file, line, "string", st1, st2, "!=",
325                                 s1, s1 == NULL ? 0 : OPENSSL_strnlen(s1, n1),
326                                 s2, s2 == NULL ? 0 : OPENSSL_strnlen(s2, n2));
327        return 0;
328    }
329    return 1;
330}
331
332int test_mem_eq(const char *file, int line, const char *st1, const char *st2,
333                const void *s1, size_t n1, const void *s2, size_t n2)
334{
335    if (s1 == NULL && s2 == NULL)
336        return 1;
337    if (n1 != n2 || s1 == NULL || s2 == NULL || memcmp(s1, s2, n1) != 0) {
338        test_fail_memory_message(NULL, file, line, "memory", st1, st2, "==",
339                                 s1, n1, s2, n2);
340        return 0;
341    }
342    return 1;
343}
344
345int test_mem_ne(const char *file, int line, const char *st1, const char *st2,
346                const void *s1, size_t n1, const void *s2, size_t n2)
347{
348    if ((s1 == NULL) ^ (s2 == NULL))
349        return 1;
350    if (n1 != n2)
351        return 1;
352    if (s1 == NULL || memcmp(s1, s2, n1) == 0) {
353        test_fail_memory_message(NULL, file, line, "memory", st1, st2, "!=",
354                                 s1, n1, s2, n2);
355        return 0;
356    }
357    return 1;
358}
359
360#define DEFINE_BN_COMPARISONS(opname, op, zero_cond)                    \
361    int test_BN_ ## opname(const char *file, int line,                  \
362                           const char *s1, const char *s2,              \
363                           const BIGNUM *t1, const BIGNUM *t2)          \
364    {                                                                   \
365        if (BN_cmp(t1, t2) op 0)                                        \
366            return 1;                                                   \
367        test_fail_bignum_message(NULL, file, line, "BIGNUM", s1, s2,    \
368                                 #op, t1, t2);                          \
369        return 0;                                                       \
370    }                                                                   \
371    int test_BN_ ## opname ## _zero(const char *file, int line,         \
372                                    const char *s, const BIGNUM *a)     \
373    {                                                                   \
374        if (a != NULL &&(zero_cond))                                    \
375            return 1;                                                   \
376        test_fail_bignum_mono_message(NULL, file, line, "BIGNUM",       \
377                                      s, "0", #op, a);                  \
378        return 0;                                                       \
379    }
380
381DEFINE_BN_COMPARISONS(eq, ==, BN_is_zero(a))
382DEFINE_BN_COMPARISONS(ne, !=, !BN_is_zero(a))
383DEFINE_BN_COMPARISONS(gt, >,  !BN_is_negative(a) && !BN_is_zero(a))
384DEFINE_BN_COMPARISONS(ge, >=, !BN_is_negative(a) || BN_is_zero(a))
385DEFINE_BN_COMPARISONS(lt, <,  BN_is_negative(a) && !BN_is_zero(a))
386DEFINE_BN_COMPARISONS(le, <=, BN_is_negative(a) || BN_is_zero(a))
387
388int test_BN_eq_one(const char *file, int line, const char *s, const BIGNUM *a)
389{
390    if (a != NULL && BN_is_one(a))
391        return 1;
392    test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", s, "1", "==", a);
393    return 0;
394}
395
396int test_BN_odd(const char *file, int line, const char *s, const BIGNUM *a)
397{
398    if (a != NULL && BN_is_odd(a))
399        return 1;
400    test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", "ODD(", ")", s, a);
401    return 0;
402}
403
404int test_BN_even(const char *file, int line, const char *s, const BIGNUM *a)
405{
406    if (a != NULL && !BN_is_odd(a))
407        return 1;
408    test_fail_bignum_mono_message(NULL, file, line, "BIGNUM", "EVEN(", ")", s,
409                                  a);
410    return 0;
411}
412
413int test_BN_eq_word(const char *file, int line, const char *bns, const char *ws,
414                    const BIGNUM *a, BN_ULONG w)
415{
416    BIGNUM *bw;
417
418    if (a != NULL && BN_is_word(a, w))
419        return 1;
420    if ((bw = BN_new()) != NULL)
421        BN_set_word(bw, w);
422    test_fail_bignum_message(NULL, file, line, "BIGNUM", bns, ws, "==", a, bw);
423    BN_free(bw);
424    return 0;
425}
426
427int test_BN_abs_eq_word(const char *file, int line, const char *bns,
428                        const char *ws, const BIGNUM *a, BN_ULONG w)
429{
430    BIGNUM *bw, *aa;
431
432    if (a != NULL && BN_abs_is_word(a, w))
433        return 1;
434    if ((aa = BN_dup(a)) != NULL)
435        BN_set_negative(aa, 0);
436    if ((bw = BN_new()) != NULL)
437        BN_set_word(bw, w);
438    test_fail_bignum_message(NULL, file, line, "BIGNUM", bns, ws, "abs==",
439                             aa, bw);
440    BN_free(bw);
441    BN_free(aa);
442    return 0;
443}
444
445static const char *print_time(const ASN1_TIME *t)
446{
447    return t == NULL ? "<null>" : (const char *)ASN1_STRING_get0_data(t);
448}
449
450#define DEFINE_TIME_T_COMPARISON(opname, op)                            \
451    int test_time_t_ ## opname(const char *file, int line,              \
452                               const char *s1, const char *s2,          \
453                               const time_t t1, const time_t t2)        \
454    {                                                                   \
455        ASN1_TIME *at1 = ASN1_TIME_set(NULL, t1);                       \
456        ASN1_TIME *at2 = ASN1_TIME_set(NULL, t2);                       \
457        int r = at1 != NULL && at2 != NULL                              \
458                && ASN1_TIME_compare(at1, at2) op 0;                    \
459        if (!r)                                                         \
460            test_fail_message(NULL, file, line, "time_t", s1, s2, #op,  \
461                              "[%s] compared to [%s]",                  \
462                              print_time(at1), print_time(at2));        \
463        ASN1_STRING_free(at1);                                          \
464        ASN1_STRING_free(at2);                                          \
465        return r;                                                       \
466    }
467DEFINE_TIME_T_COMPARISON(eq, ==)
468DEFINE_TIME_T_COMPARISON(ne, !=)
469DEFINE_TIME_T_COMPARISON(gt, >)
470DEFINE_TIME_T_COMPARISON(ge, >=)
471DEFINE_TIME_T_COMPARISON(lt, <)
472DEFINE_TIME_T_COMPARISON(le, <=)
473