2 * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
13 #include "internal/nelem.h"
14 #include "ossl_test_endian.h"
15 #include <openssl/params.h>
16 #include <openssl/bn.h>
18 /* The maximum size of the static buffers used to test most things */
21 static void swap_copy(unsigned char *out, const void *in, size_t len)
25 for (j = 0; j < len; j++)
26 out[j] = ((unsigned char *)in)[len - j - 1];
30 * A memory copy that converts the native byte ordering either to or from
31 * little endian format.
33 * On a little endian machine copying either is just a memcpy(3), on a
34 * big endian machine copying from native to or from little endian involves
37 static void le_copy(unsigned char *out, const void *in, size_t len)
44 swap_copy(out, in, len);
49 unsigned char value[MAX_LEN];
51 { 4, { 0x38, 0x27, 0xbf, 0x3b } },
52 { 4, { 0x9f, 0x26, 0x48, 0x22 } },
53 { 8, { 0x59, 0xb2, 0x1a, 0xe9, 0x2a, 0xd8, 0x46, 0x40 } },
54 { 8, { 0xb4, 0xae, 0xbd, 0xb4, 0xdd, 0x04, 0xb1, 0x4c } },
55 { 16, { 0x61, 0xe8, 0x7e, 0x31, 0xe9, 0x33, 0x83, 0x3d,
56 0x87, 0x99, 0xc7, 0xd8, 0x5d, 0xa9, 0x8b, 0x42 } },
57 { 16, { 0xee, 0x6e, 0x8b, 0xc3, 0xec, 0xcf, 0x37, 0xcc,
58 0x89, 0x67, 0xf2, 0x68, 0x33, 0xa0, 0x14, 0xb0 } },
61 static int test_param_type_extra(OSSL_PARAM *param, const unsigned char *cmp,
67 unsigned char buf[MAX_LEN];
68 const int bit32 = param->data_size == sizeof(int32_t);
69 const int sizet = bit32 && sizeof(size_t) > sizeof(int32_t);
70 const int signd = param->data_type == OSSL_PARAM_INTEGER;
73 if ((bit32 && !TEST_true(OSSL_PARAM_get_int32(param, &i32)))
74 || !TEST_true(OSSL_PARAM_get_int64(param, &i64)))
78 && !TEST_true(OSSL_PARAM_get_uint32(param, (uint32_t *)&i32)))
79 || !TEST_true(OSSL_PARAM_get_uint64(param, (uint64_t *)&i64))
80 || (sizet && !TEST_true(OSSL_PARAM_get_size_t(param, &s))))
84 /* Check signed types */
86 le_copy(buf, &i32, sizeof(i32));
87 sz = sizeof(i32) < width ? sizeof(i32) : width;
88 if (!TEST_mem_eq(buf, sz, cmp, sz))
91 le_copy(buf, &i64, sizeof(i64));
92 sz = sizeof(i64) < width ? sizeof(i64) : width;
93 if (!TEST_mem_eq(buf, sz, cmp, sz))
95 if (sizet && !signd) {
96 le_copy(buf, &s, sizeof(s));
97 sz = sizeof(s) < width ? sizeof(s) : width;
98 if (!TEST_mem_eq(buf, sz, cmp, sz))
102 /* Check a widening write if possible */
103 if (sizeof(size_t) > width) {
105 if (!TEST_true(OSSL_PARAM_set_int32(param, 12345))
106 || !TEST_true(OSSL_PARAM_get_int64(param, &i64))
107 || !TEST_size_t_eq((size_t)i64, 12345))
110 if (!TEST_true(OSSL_PARAM_set_uint32(param, 12345))
111 || !TEST_true(OSSL_PARAM_get_uint64(param, (uint64_t *)&i64))
112 || !TEST_size_t_eq((size_t)i64, 12345))
120 * The test cases for each of the bastic integral types are similar.
121 * For each type, a param of that type is set and an attempt to read it
122 * get is made. Finally, the above function is called to verify that
123 * the params can be read as other types.
125 * All the real work is done via byte buffers which are converted to machine
126 * byte order and to little endian for comparisons. Narrower values are best
127 * compared using little endian because their values and positions don't
131 static int test_param_int(int n)
134 unsigned char buf[MAX_LEN], cmp[sizeof(int)];
135 const size_t len = raw_values[n].len >= sizeof(int) ?
136 sizeof(int) : raw_values[n].len;
137 OSSL_PARAM param = OSSL_PARAM_int("a", NULL);
139 memset(buf, 0, sizeof(buf));
140 le_copy(buf, raw_values[n].value, sizeof(in));
141 memcpy(&in, buf, sizeof(in));
143 if (!TEST_true(OSSL_PARAM_set_int(¶m, in)))
145 le_copy(cmp, &out, sizeof(out));
146 if (!TEST_mem_eq(cmp, len, raw_values[n].value, len))
149 if (!TEST_true(OSSL_PARAM_get_int(¶m, &in)))
151 le_copy(cmp, &in, sizeof(in));
152 if (!TEST_mem_eq(cmp, sizeof(in), raw_values[n].value, sizeof(in)))
155 return test_param_type_extra(¶m, raw_values[n].value, sizeof(int));
158 static int test_param_long(int n)
161 unsigned char buf[MAX_LEN], cmp[sizeof(long int)];
162 const size_t len = raw_values[n].len >= sizeof(long int)
163 ? sizeof(long int) : raw_values[n].len;
164 OSSL_PARAM param = OSSL_PARAM_long("a", NULL);
166 memset(buf, 0, sizeof(buf));
167 le_copy(buf, raw_values[n].value, sizeof(in));
168 memcpy(&in, buf, sizeof(in));
170 if (!TEST_true(OSSL_PARAM_set_long(¶m, in)))
172 le_copy(cmp, &out, sizeof(out));
173 if (!TEST_mem_eq(cmp, len, raw_values[n].value, len))
176 if (!TEST_true(OSSL_PARAM_get_long(¶m, &in)))
178 le_copy(cmp, &in, sizeof(in));
179 if (!TEST_mem_eq(cmp, sizeof(in), raw_values[n].value, sizeof(in)))
182 return test_param_type_extra(¶m, raw_values[n].value, sizeof(long int));
185 static int test_param_uint(int n)
187 unsigned int in, out;
188 unsigned char buf[MAX_LEN], cmp[sizeof(unsigned int)];
189 const size_t len = raw_values[n].len >= sizeof(unsigned int) ? sizeof(unsigned int) : raw_values[n].len;
190 OSSL_PARAM param = OSSL_PARAM_uint("a", NULL);
192 memset(buf, 0, sizeof(buf));
193 le_copy(buf, raw_values[n].value, sizeof(in));
194 memcpy(&in, buf, sizeof(in));
196 if (!TEST_true(OSSL_PARAM_set_uint(¶m, in)))
198 le_copy(cmp, &out, sizeof(out));
199 if (!TEST_mem_eq(cmp, len, raw_values[n].value, len))
202 if (!TEST_true(OSSL_PARAM_get_uint(¶m, &in)))
204 le_copy(cmp, &in, sizeof(in));
205 if (!TEST_mem_eq(cmp, sizeof(in), raw_values[n].value, sizeof(in)))
208 return test_param_type_extra(¶m, raw_values[n].value, sizeof(unsigned int));
211 static int test_param_ulong(int n)
213 unsigned long int in, out;
214 unsigned char buf[MAX_LEN], cmp[sizeof(unsigned long int)];
215 const size_t len = raw_values[n].len >= sizeof(unsigned long int)
216 ? sizeof(unsigned long int) : raw_values[n].len;
217 OSSL_PARAM param = OSSL_PARAM_ulong("a", NULL);
219 memset(buf, 0, sizeof(buf));
220 le_copy(buf, raw_values[n].value, sizeof(in));
221 memcpy(&in, buf, sizeof(in));
223 if (!TEST_true(OSSL_PARAM_set_ulong(¶m, in)))
225 le_copy(cmp, &out, sizeof(out));
226 if (!TEST_mem_eq(cmp, len, raw_values[n].value, len))
229 if (!TEST_true(OSSL_PARAM_get_ulong(¶m, &in)))
231 le_copy(cmp, &in, sizeof(in));
232 if (!TEST_mem_eq(cmp, sizeof(in), raw_values[n].value, sizeof(in)))
235 return test_param_type_extra(¶m, raw_values[n].value, sizeof(unsigned long int));
238 static int test_param_int32(int n)
241 unsigned char buf[MAX_LEN], cmp[sizeof(int32_t)];
242 const size_t len = raw_values[n].len >= sizeof(int32_t)
243 ? sizeof(int32_t) : raw_values[n].len;
244 OSSL_PARAM param = OSSL_PARAM_int32("a", NULL);
246 memset(buf, 0, sizeof(buf));
247 le_copy(buf, raw_values[n].value, sizeof(in));
248 memcpy(&in, buf, sizeof(in));
250 if (!TEST_true(OSSL_PARAM_set_int32(¶m, in)))
252 le_copy(cmp, &out, sizeof(out));
253 if (!TEST_mem_eq(cmp, len, raw_values[n].value, len))
256 if (!TEST_true(OSSL_PARAM_get_int32(¶m, &in)))
258 le_copy(cmp, &in, sizeof(in));
259 if (!TEST_mem_eq(cmp, sizeof(in), raw_values[n].value, sizeof(in)))
262 return test_param_type_extra(¶m, raw_values[n].value, sizeof(int32_t));
265 static int test_param_uint32(int n)
268 unsigned char buf[MAX_LEN], cmp[sizeof(uint32_t)];
269 const size_t len = raw_values[n].len >= sizeof(uint32_t)
270 ? sizeof(uint32_t) : raw_values[n].len;
271 OSSL_PARAM param = OSSL_PARAM_uint32("a", NULL);
273 memset(buf, 0, sizeof(buf));
274 le_copy(buf, raw_values[n].value, sizeof(in));
275 memcpy(&in, buf, sizeof(in));
277 if (!TEST_true(OSSL_PARAM_set_uint32(¶m, in)))
279 le_copy(cmp, &out, sizeof(out));
280 if (!TEST_mem_eq(cmp, len, raw_values[n].value, len))
283 if (!TEST_true(OSSL_PARAM_get_uint32(¶m, &in)))
285 le_copy(cmp, &in, sizeof(in));
286 if (!TEST_mem_eq(cmp, sizeof(in), raw_values[n].value, sizeof(in)))
289 return test_param_type_extra(¶m, raw_values[n].value, sizeof(uint32_t));
292 static int test_param_int64(int n)
295 unsigned char buf[MAX_LEN], cmp[sizeof(int64_t)];
296 const size_t len = raw_values[n].len >= sizeof(int64_t)
297 ? sizeof(int64_t) : raw_values[n].len;
298 OSSL_PARAM param = OSSL_PARAM_int64("a", NULL);
300 memset(buf, 0, sizeof(buf));
301 le_copy(buf, raw_values[n].value, sizeof(in));
302 memcpy(&in, buf, sizeof(in));
304 if (!TEST_true(OSSL_PARAM_set_int64(¶m, in)))
306 le_copy(cmp, &out, sizeof(out));
307 if (!TEST_mem_eq(cmp, len, raw_values[n].value, len))
310 if (!TEST_true(OSSL_PARAM_get_int64(¶m, &in)))
312 le_copy(cmp, &in, sizeof(in));
313 if (!TEST_mem_eq(cmp, sizeof(in), raw_values[n].value, sizeof(in)))
316 return test_param_type_extra(¶m, raw_values[n].value, sizeof(int64_t));
319 static int test_param_uint64(int n)
322 unsigned char buf[MAX_LEN], cmp[sizeof(uint64_t)];
323 const size_t len = raw_values[n].len >= sizeof(uint64_t)
324 ? sizeof(uint64_t) : raw_values[n].len;
325 OSSL_PARAM param = OSSL_PARAM_uint64("a", NULL);
327 memset(buf, 0, sizeof(buf));
328 le_copy(buf, raw_values[n].value, sizeof(in));
329 memcpy(&in, buf, sizeof(in));
331 if (!TEST_true(OSSL_PARAM_set_uint64(¶m, in)))
333 le_copy(cmp, &out, sizeof(out));
334 if (!TEST_mem_eq(cmp, len, raw_values[n].value, len))
337 if (!TEST_true(OSSL_PARAM_get_uint64(¶m, &in)))
339 le_copy(cmp, &in, sizeof(in));
340 if (!TEST_mem_eq(cmp, sizeof(in), raw_values[n].value, sizeof(in)))
343 return test_param_type_extra(¶m, raw_values[n].value, sizeof(uint64_t));
346 static int test_param_size_t(int n)
349 unsigned char buf[MAX_LEN], cmp[sizeof(size_t)];
350 const size_t len = raw_values[n].len >= sizeof(size_t)
351 ? sizeof(size_t) : raw_values[n].len;
352 OSSL_PARAM param = OSSL_PARAM_size_t("a", NULL);
354 memset(buf, 0, sizeof(buf));
355 le_copy(buf, raw_values[n].value, sizeof(in));
356 memcpy(&in, buf, sizeof(in));
358 if (!TEST_true(OSSL_PARAM_set_size_t(¶m, in)))
360 le_copy(cmp, &out, sizeof(out));
361 if (!TEST_mem_eq(cmp, len, raw_values[n].value, len))
364 if (!TEST_true(OSSL_PARAM_get_size_t(¶m, &in)))
366 le_copy(cmp, &in, sizeof(in));
367 if (!TEST_mem_eq(cmp, sizeof(in), raw_values[n].value, sizeof(in)))
370 return test_param_type_extra(¶m, raw_values[n].value, sizeof(size_t));
373 static int test_param_bignum(int n)
375 unsigned char buf[MAX_LEN], bnbuf[MAX_LEN];
376 const size_t len = raw_values[n].len;
377 BIGNUM *b = NULL, *c = NULL;
378 OSSL_PARAM param = OSSL_PARAM_DEFN("bn", OSSL_PARAM_UNSIGNED_INTEGER,
383 param.data_size = len;
385 le_copy(buf, raw_values[n].value, len);
386 if (!TEST_ptr(b = BN_lebin2bn(raw_values[n].value, (int)len, NULL)))
389 if (!TEST_true(OSSL_PARAM_set_BN(¶m, b))
390 || !TEST_mem_eq(bnbuf, param.return_size, buf, param.return_size))
392 param.data_size = param.return_size;
393 if (!TEST_true(OSSL_PARAM_get_BN(¶m, &c))
394 || !TEST_BN_eq(b, c))
404 static int test_param_real(void)
407 OSSL_PARAM param = OSSL_PARAM_double("r", NULL);
410 return TEST_true(OSSL_PARAM_set_double(¶m, 3.14159))
411 && TEST_double_eq(p, 3.14159);
414 static int test_param_construct(void)
416 static const char *int_names[] = {
417 "int", "long", "int32", "int64"
419 static const char *uint_names[] = {
420 "uint", "ulong", "uint32", "uint64", "size_t"
422 static const unsigned char bn_val[16] = {
423 0xac, 0x75, 0x22, 0x7d, 0x81, 0x06, 0x7a, 0x23,
424 0xa6, 0xed, 0x87, 0xc7, 0xab, 0xf4, 0x73, 0x22
426 OSSL_PARAM params[20];
427 char buf[100], buf2[100], *bufp, *bufp2;
428 unsigned char ubuf[100];
429 void *vp, *vpn = NULL, *vp2;
431 int i, n = 0, ret = 0;
434 unsigned long int ul;
441 BIGNUM *bn = NULL, *bn2 = NULL;
443 params[n++] = OSSL_PARAM_construct_int("int", &i);
444 params[n++] = OSSL_PARAM_construct_uint("uint", &u);
445 params[n++] = OSSL_PARAM_construct_long("long", &l);
446 params[n++] = OSSL_PARAM_construct_ulong("ulong", &ul);
447 params[n++] = OSSL_PARAM_construct_int32("int32", &i32);
448 params[n++] = OSSL_PARAM_construct_int64("int64", &i64);
449 params[n++] = OSSL_PARAM_construct_uint32("uint32", &u32);
450 params[n++] = OSSL_PARAM_construct_uint64("uint64", &u64);
451 params[n++] = OSSL_PARAM_construct_size_t("size_t", &s);
452 params[n++] = OSSL_PARAM_construct_double("double", &d);
453 params[n++] = OSSL_PARAM_construct_BN("bignum", ubuf, sizeof(ubuf));
454 params[n++] = OSSL_PARAM_construct_utf8_string("utf8str", buf, sizeof(buf));
455 params[n++] = OSSL_PARAM_construct_octet_string("octstr", buf, sizeof(buf));
456 params[n++] = OSSL_PARAM_construct_utf8_ptr("utf8ptr", &bufp, 0);
457 params[n++] = OSSL_PARAM_construct_octet_ptr("octptr", &vp, 0);
458 params[n] = OSSL_PARAM_construct_end();
461 if (!TEST_ptr_null(OSSL_PARAM_locate(params, "fnord")))
464 /* All signed integral types */
465 for (j = 0; j < OSSL_NELEM(int_names); j++) {
466 if (!TEST_ptr(cp = OSSL_PARAM_locate(params, int_names[j]))
467 || !TEST_true(OSSL_PARAM_set_int32(cp, (int32_t)(3 + j)))
468 || !TEST_true(OSSL_PARAM_get_int64(cp, &i64))
469 || !TEST_size_t_eq(cp->data_size, cp->return_size)
470 || !TEST_size_t_eq((size_t)i64, 3 + j)) {
471 TEST_note("iteration %zu var %s", j + 1, int_names[j]);
475 /* All unsigned integral types */
476 for (j = 0; j < OSSL_NELEM(uint_names); j++) {
477 if (!TEST_ptr(cp = OSSL_PARAM_locate(params, uint_names[j]))
478 || !TEST_true(OSSL_PARAM_set_uint32(cp, (uint32_t)(3 + j)))
479 || !TEST_true(OSSL_PARAM_get_uint64(cp, &u64))
480 || !TEST_size_t_eq(cp->data_size, cp->return_size)
481 || !TEST_size_t_eq((size_t)u64, 3 + j)) {
482 TEST_note("iteration %zu var %s", j + 1, uint_names[j]);
487 if (!TEST_ptr(cp = OSSL_PARAM_locate(params, "double"))
488 || !TEST_true(OSSL_PARAM_set_double(cp, 3.14))
489 || !TEST_true(OSSL_PARAM_get_double(cp, &d2))
490 || !TEST_size_t_eq(cp->return_size, sizeof(double))
491 || !TEST_double_eq(d, d2))
495 if (!TEST_ptr(cp = OSSL_PARAM_locate(params, "utf8str"))
496 || !TEST_true(OSSL_PARAM_set_utf8_string(cp, "abcdef"))
497 || !TEST_size_t_eq(cp->return_size, sizeof("abcdef"))
498 || !TEST_true(OSSL_PARAM_get_utf8_string(cp, &bufp, 0))
499 || !TEST_str_eq(bufp, "abcdef"))
503 if (!TEST_true(OSSL_PARAM_get_utf8_string(cp, &bufp, sizeof(buf2)))
504 || !TEST_str_eq(buf2, "abcdef"))
508 if (!TEST_ptr(cp = OSSL_PARAM_locate(params, "utf8ptr"))
509 || !TEST_true(OSSL_PARAM_set_utf8_ptr(cp, "tuvwxyz"))
510 || !TEST_size_t_eq(cp->return_size, sizeof("tuvwxyz"))
511 || !TEST_str_eq(bufp, "tuvwxyz")
512 || !TEST_true(OSSL_PARAM_get_utf8_ptr(cp, (const char **)&bufp2))
513 || !TEST_ptr_eq(bufp2, bufp))
516 if (!TEST_ptr(cp = OSSL_PARAM_locate(params, "octstr"))
517 || !TEST_true(OSSL_PARAM_set_octet_string(cp, "abcdefghi",
518 sizeof("abcdefghi")))
519 || !TEST_size_t_eq(cp->return_size, sizeof("abcdefghi")))
521 /* Match the return size to avoid trailing garbage bytes */
522 cp->data_size = cp->return_size;
523 if (!TEST_true(OSSL_PARAM_get_octet_string(cp, &vpn, 0, &s))
524 || !TEST_size_t_eq(s, sizeof("abcdefghi"))
525 || !TEST_mem_eq(vpn, sizeof("abcdefghi"),
526 "abcdefghi", sizeof("abcdefghi")))
529 if (!TEST_true(OSSL_PARAM_get_octet_string(cp, &vp, sizeof(buf2), &s))
530 || !TEST_size_t_eq(s, sizeof("abcdefghi"))
531 || !TEST_mem_eq(vp, sizeof("abcdefghi"),
532 "abcdefghi", sizeof("abcdefghi")))
536 if (!TEST_ptr(cp = OSSL_PARAM_locate(params, "octptr"))
537 || !TEST_true(OSSL_PARAM_set_octet_ptr(cp, &ul, sizeof(ul)))
538 || !TEST_size_t_eq(cp->return_size, sizeof(ul))
539 || !TEST_ptr_eq(vp, &ul))
541 /* Match the return size to avoid trailing garbage bytes */
542 cp->data_size = cp->return_size;
543 if (!TEST_true(OSSL_PARAM_get_octet_ptr(cp, (const void **)&vp2, &k))
544 || !TEST_size_t_eq(k, sizeof(ul))
545 || !TEST_ptr_eq(vp2, vp))
548 if (!TEST_ptr(cp = OSSL_PARAM_locate(params, "bignum"))
549 || !TEST_ptr(bn = BN_lebin2bn(bn_val, (int)sizeof(bn_val), NULL))
550 || !TEST_true(OSSL_PARAM_set_BN(cp, bn))
551 || !TEST_size_t_eq(cp->return_size, sizeof(bn_val)))
553 /* Match the return size to avoid trailing garbage bytes */
554 cp->data_size = cp->return_size;
555 if(!TEST_true(OSSL_PARAM_get_BN(cp, &bn2))
556 || !TEST_BN_eq(bn, bn2))
566 int setup_tests(void)
568 ADD_ALL_TESTS(test_param_int, OSSL_NELEM(raw_values));
569 ADD_ALL_TESTS(test_param_long, OSSL_NELEM(raw_values));
570 ADD_ALL_TESTS(test_param_uint, OSSL_NELEM(raw_values));
571 ADD_ALL_TESTS(test_param_ulong, OSSL_NELEM(raw_values));
572 ADD_ALL_TESTS(test_param_int32, OSSL_NELEM(raw_values));
573 ADD_ALL_TESTS(test_param_uint32, OSSL_NELEM(raw_values));
574 ADD_ALL_TESTS(test_param_size_t, OSSL_NELEM(raw_values));
575 ADD_ALL_TESTS(test_param_int64, OSSL_NELEM(raw_values));
576 ADD_ALL_TESTS(test_param_uint64, OSSL_NELEM(raw_values));
577 ADD_ALL_TESTS(test_param_bignum, OSSL_NELEM(raw_values));
578 ADD_TEST(test_param_real);
579 ADD_TEST(test_param_construct);