2 * Copyright 2017-2018 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"
16 #include "internal/nelem.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 diff header */
24 static void test_diff_header(const char *left, const char *right)
26 test_printf_stderr("--- %s\n", left);
27 test_printf_stderr("+++ %s\n", right);
30 /* Formatted string output routines */
31 static void test_string_null_empty(const char *m, char c)
34 test_printf_stderr("%4s %c NULL\n", "", c);
36 test_printf_stderr("%4u:%c ''\n", 0u, c);
39 static void test_fail_string_common(const char *prefix, const char *file,
40 int line, const char *type,
41 const char *left, const char *right,
42 const char *op, const char *m1, size_t l1,
43 const char *m2, size_t l2)
46 (MAX_STRING_WIDTH - BIO_get_indent(bio_err) - 12) / 16 * 16;
47 char b1[MAX_STRING_WIDTH + 1], b2[MAX_STRING_WIDTH + 1];
48 char bdiff[MAX_STRING_WIDTH + 1];
50 unsigned int cnt = 0, diff;
52 test_fail_message_prefix(prefix, file, line, type, left, right, op);
57 if (l1 == 0 && l2 == 0) {
58 if ((m1 == NULL) == (m2 == NULL)) {
59 test_string_null_empty(m1, ' ');
61 test_diff_header(left, right);
62 test_string_null_empty(m1, '-');
63 test_string_null_empty(m2, '+');
68 if (l1 != l2 || strcmp(m1, m2) != 0)
69 test_diff_header(left, right);
71 while (l1 > 0 || l2 > 0) {
74 b1[n1 = l1 > width ? width : l1] = 0;
75 for (i = 0; i < n1; i++)
76 b1[i] = isprint((unsigned char)m1[i]) ? m1[i] : '.';
79 b2[n2 = l2 > width ? width : l2] = 0;
80 for (i = 0; i < n2; i++)
81 b2[i] = isprint((unsigned char)m2[i]) ? m2[i] : '.';
85 if (n1 > 0 && n2 > 0) {
86 const size_t j = n1 < n2 ? n1 : n2;
97 if (n1 == n2 && !diff) {
98 test_printf_stderr("%4u: '%s'\n", cnt, n2 > n1 ? b2 : b1);
100 if (cnt == 0 && (m1 == NULL || *m1 == '\0'))
101 test_string_null_empty(m1, '-');
103 test_printf_stderr("%4u:- '%s'\n", cnt, b1);
104 if (cnt == 0 && (m2 == NULL || *m2 == '\0'))
105 test_string_null_empty(m2, '+');
107 test_printf_stderr("%4u:+ '%s'\n", cnt, b2);
109 test_printf_stderr("%4s %s\n", "", bdiff);
122 * Wrapper routines so that the underlying code can be shared.
123 * The first is the call from inside the test utilities when a conditional
124 * fails. The second is the user's call to dump a string.
126 void test_fail_string_message(const char *prefix, const char *file,
127 int line, const char *type,
128 const char *left, const char *right,
129 const char *op, const char *m1, size_t l1,
130 const char *m2, size_t l2)
132 test_fail_string_common(prefix, file, line, type, left, right, op,
134 test_printf_stderr("\n");
137 void test_output_string(const char *name, const char *m, size_t l)
139 test_fail_string_common("string", NULL, 0, NULL, NULL, NULL, name,
143 /* BIGNUM formatted output routines */
146 * A basic memory byte to hex digit converter with allowance for spacing
149 static void hex_convert_memory(const unsigned char *m, size_t n, char *b,
154 for (i = 0; i < n; i++) {
155 const unsigned char c = *m++;
157 *b++ = "0123456789abcdef"[c >> 4];
158 *b++ = "0123456789abcdef"[c & 15];
159 if (i % width == width - 1 && i != n - 1)
166 * Constants to define the number of bytes to display per line and the number
167 * of characters these take.
169 static const int bn_bytes = (MAX_STRING_WIDTH - 9) / (BN_OUTPUT_SIZE * 2 + 1)
171 static const int bn_chars = (MAX_STRING_WIDTH - 9) / (BN_OUTPUT_SIZE * 2 + 1)
172 * (BN_OUTPUT_SIZE * 2 + 1) - 1;
175 * Output the header line for the bignum
177 static void test_bignum_header_line(void)
179 test_printf_stderr(" %*s\n", bn_chars + 6, "bit position");
182 static const char *test_bignum_zero_null(const BIGNUM *bn)
185 return BN_is_negative(bn) ? "-0" : "0";
190 * Print a bignum zero taking care to include the correct sign.
191 * This routine correctly deals with a NULL bignum pointer as input.
193 static void test_bignum_zero_print(const BIGNUM *bn, char sep)
195 const char *v = test_bignum_zero_null(bn);
196 const char *suf = bn != NULL ? ": 0" : "";
198 test_printf_stderr("%c%*s%s\n", sep, bn_chars, v, suf);
202 * Convert a section of memory from inside a bignum into a displayable
203 * string with appropriate visual aid spaces inserted.
205 static int convert_bn_memory(const unsigned char *in, size_t bytes,
206 char *out, int *lz, const BIGNUM *bn)
208 int n = bytes * 2, i;
209 char *p = out, *q = NULL;
212 if (bn != NULL && !BN_is_zero(bn)) {
213 hex_convert_memory(in, bytes, out, BN_OUTPUT_SIZE);
215 for (; *p == '0' || *p == ' '; p++)
223 * in[bytes] is defined because we're converting a non-zero
224 * number and we've not seen a non-zero yet.
226 if ((in[bytes] & 0xf0) != 0 && BN_is_negative(bn)) {
233 if (BN_is_negative(bn)) {
235 * This is valid because we always convert more digits than
246 for (i = 0; i < n; i++) {
248 if (i % (2 * BN_OUTPUT_SIZE) == 2 * BN_OUTPUT_SIZE - 1 && i != n - 1)
255 r = BN_is_negative(bn) ? "-0" : "0";
256 strcpy(p - strlen(r), r);
261 * Common code to display either one or two bignums, including the diff
262 * pointers for changes (only when there are two).
264 static void test_fail_bignum_common(const char *prefix, const char *file,
265 int line, const char *type,
266 const char *left, const char *right,
268 const BIGNUM *bn1, const BIGNUM *bn2)
270 const size_t bytes = bn_bytes;
271 char b1[MAX_STRING_WIDTH + 1], b2[MAX_STRING_WIDTH + 1];
272 char *p, bdiff[MAX_STRING_WIDTH + 1];
273 size_t l1, l2, n1, n2, i, len;
274 unsigned int cnt, diff, real_diff;
275 unsigned char *m1 = NULL, *m2 = NULL;
276 int lz1 = 1, lz2 = 1;
277 unsigned char buffer[MEM_BUFFER_SIZE * 2], *bufp = buffer;
279 test_fail_message_prefix(prefix, file, line, type, left, right, op);
280 l1 = bn1 == NULL ? 0 : (BN_num_bytes(bn1) + (BN_is_negative(bn1) ? 1 : 0));
281 l2 = bn2 == NULL ? 0 : (BN_num_bytes(bn2) + (BN_is_negative(bn2) ? 1 : 0));
282 if (l1 == 0 && l2 == 0) {
283 if ((bn1 == NULL) == (bn2 == NULL)) {
284 test_bignum_header_line();
285 test_bignum_zero_print(bn1, ' ');
287 test_diff_header(left, right);
288 test_bignum_header_line();
289 test_bignum_zero_print(bn1, '-');
290 test_bignum_zero_print(bn2, '+');
295 if (l1 != l2 || bn1 == NULL || bn2 == NULL || BN_cmp(bn1, bn2) != 0)
296 test_diff_header(left, right);
297 test_bignum_header_line();
299 len = ((l1 > l2 ? l1 : l2) + bytes - 1) / bytes * bytes;
301 if (len > MEM_BUFFER_SIZE && (bufp = OPENSSL_malloc(len * 2)) == NULL) {
303 len = MEM_BUFFER_SIZE;
304 test_printf_stderr("WARNING: these BIGNUMs have been truncated\n");
309 BN_bn2binpad(bn1, m1, len);
313 BN_bn2binpad(bn2, m2, len);
317 cnt = 8 * (len - bytes);
318 n1 = convert_bn_memory(m1, bytes, b1, &lz1, bn1);
319 n2 = convert_bn_memory(m2, bytes, b2, &lz2, bn2);
321 diff = real_diff = 0;
324 for (i=0; b1[i] != '\0'; i++)
325 if (b1[i] == b2[i] || b1[i] == ' ' || b2[i] == ' ') {
327 diff |= b1[i] != b2[i];
330 real_diff = diff = 1;
334 test_printf_stderr(" %s:% 5d\n", n2 > n1 ? b2 : b1, cnt);
336 if (cnt == 0 && bn1 == NULL)
337 test_printf_stderr("-%s\n", b1);
338 else if (cnt == 0 || n1 > 0)
339 test_printf_stderr("-%s:% 5d\n", b1, cnt);
340 if (cnt == 0 && bn2 == NULL)
341 test_printf_stderr("+%s\n", b2);
342 else if (cnt == 0 || n2 > 0)
343 test_printf_stderr("+%s:% 5d\n", b2, cnt);
344 if (real_diff && (cnt == 0 || (n1 > 0 && n2 > 0))
345 && bn1 != NULL && bn2 != NULL)
346 test_printf_stderr(" %s\n", bdiff);
361 * Wrapper routines so that the underlying code can be shared.
362 * The first two are calls from inside the test utilities when a conditional
363 * fails. The third is the user's call to dump a bignum.
365 void test_fail_bignum_message(const char *prefix, const char *file,
366 int line, const char *type,
367 const char *left, const char *right,
369 const BIGNUM *bn1, const BIGNUM *bn2)
371 test_fail_bignum_common(prefix, file, line, type, left, right, op, bn1, bn2);
372 test_printf_stderr("\n");
375 void test_fail_bignum_mono_message(const char *prefix, const char *file,
376 int line, const char *type,
377 const char *left, const char *right,
378 const char *op, const BIGNUM *bn)
380 test_fail_bignum_common(prefix, file, line, type, left, right, op, bn, bn);
381 test_printf_stderr("\n");
384 void test_output_bignum(const char *name, const BIGNUM *bn)
386 if (bn == NULL || BN_is_zero(bn)) {
387 test_printf_stderr("bignum: '%s' = %s\n", name,
388 test_bignum_zero_null(bn));
389 } else if (BN_num_bytes(bn) <= BN_OUTPUT_SIZE) {
390 unsigned char buf[BN_OUTPUT_SIZE];
391 char out[2 * sizeof(buf) + 1];
393 int n = BN_bn2bin(bn, buf);
395 hex_convert_memory(buf, n, p, BN_OUTPUT_SIZE);
396 while (*p == '0' && *++p != '\0')
398 test_printf_stderr("bignum: '%s' = %s0x%s\n", name,
399 BN_is_negative(bn) ? "-" : "", p);
401 test_fail_bignum_common("bignum", NULL, 0, NULL, NULL, NULL, name,
406 /* Memory output routines */
409 * Handle zero length blocks of memory or NULL pointers to memory
411 static void test_memory_null_empty(const unsigned char *m, char c)
414 test_printf_stderr("%4s %c%s\n", "", c, "NULL");
416 test_printf_stderr("%04x %c%s\n", 0u, c, "empty");
420 * Common code to display one or two blocks of memory.
422 static void test_fail_memory_common(const char *prefix, const char *file,
423 int line, const char *type,
424 const char *left, const char *right,
426 const unsigned char *m1, size_t l1,
427 const unsigned char *m2, size_t l2)
429 const size_t bytes = (MAX_STRING_WIDTH - 9) / 17 * 8;
430 char b1[MAX_STRING_WIDTH + 1], b2[MAX_STRING_WIDTH + 1];
431 char *p, bdiff[MAX_STRING_WIDTH + 1];
433 unsigned int cnt = 0, diff;
435 test_fail_message_prefix(prefix, file, line, type, left, right, op);
440 if (l1 == 0 && l2 == 0) {
441 if ((m1 == NULL) == (m2 == NULL)) {
442 test_memory_null_empty(m1, ' ');
444 test_diff_header(left, right);
445 test_memory_null_empty(m1, '-');
446 test_memory_null_empty(m2, '+');
451 if (l1 != l2 || (m1 != m2 && memcmp(m1, m2, l1) != 0))
452 test_diff_header(left, right);
454 while (l1 > 0 || l2 > 0) {
457 n1 = l1 > bytes ? bytes : l1;
458 hex_convert_memory(m1, n1, b1, 8);
461 n2 = l2 > bytes ? bytes : l2;
462 hex_convert_memory(m2, n2, b2, 8);
468 if (n1 > 0 && n2 > 0) {
469 const size_t j = n1 < n2 ? n1 : n2;
472 if (m1[i] == m2[i]) {
480 if (i % 8 == 7 && i != j - 1)
486 if (n1 == n2 && !diff) {
487 test_printf_stderr("%04x: %s\n", cnt, b1);
489 if (cnt == 0 && (m1 == NULL || l1 == 0))
490 test_memory_null_empty(m1, '-');
492 test_printf_stderr("%04x:-%s\n", cnt, b1);
493 if (cnt == 0 && (m2 == NULL || l2 == 0))
494 test_memory_null_empty(m2, '+');
496 test_printf_stderr("%04x:+%s\n", cnt, b2);
498 test_printf_stderr("%4s %s\n", "", bdiff);
511 * Wrapper routines so that the underlying code can be shared.
512 * The first is the call from inside the test utilities when a conditional
513 * fails. The second is the user's call to dump memory.
515 void test_fail_memory_message(const char *prefix, const char *file,
516 int line, const char *type,
517 const char *left, const char *right,
519 const unsigned char *m1, size_t l1,
520 const unsigned char *m2, size_t l2)
522 test_fail_memory_common(prefix, file, line, type, left, right, op,
524 test_printf_stderr("\n");
527 void test_output_memory(const char *name, const unsigned char *m, size_t l)
529 test_fail_memory_common("memory", NULL, 0, NULL, NULL, NULL, name,