2 * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 * https://www.openssl.org/source/license.html
8 * or in the file LICENSE in the source distribution.
12 * This program tests the use of OSSL_PARAM, currently in raw form.
16 #include <openssl/bn.h>
17 #include <openssl/core.h>
18 #include <openssl/params.h>
19 #include "internal/nelem.h"
26 * Even though it's not necessarily ONLY providers doing this part,
27 * they are naturally going to be the most common users of
28 * set_params and get_params functions.
32 * In real use cases, setters and getters would take an object with
33 * which the parameters are associated. This structure is a cheap
38 * Documented as a native integer, of the size given by sizeof(int).
39 * Assumed data type OSSL_PARAM_INTEGER
43 * Documented as a native double, of the size given by sizeof(double).
44 * Assumed data type OSSL_PARAM_REAL
48 * Documented as an arbitrarly large unsigned integer.
49 * The data size must be large enough to accommodate.
50 * Assumed data type OSSL_PARAM_UNSIGNED_INTEGER
54 * Documented as a C string.
55 * The data size must be large enough to accommodate.
56 * Assumed data type OSSL_PARAM_UTF8_STRING
61 * Documented as a C string.
62 * Assumed data type OSSL_PARAM_UTF8_STRING
67 * Documented as a pointer to a constant C string.
68 * Assumed data type OSSL_PARAM_UTF8_PTR
74 #define p1_init 42 /* The ultimate answer */
75 #define p2_init 6.283 /* Magic number */
76 /* Stolen from evp_data, BLAKE2s256 test */
78 "4142434445464748494a4b4c4d4e4f50" \
79 "5152535455565758595a616263646566" \
80 "6768696a6b6c6d6e6f70717273747576" \
81 "7778797a30313233343536373839"
82 #define p4_init "BLAKE2s256" /* Random string */
83 #define p5_init "Hellow World" /* Random string */
84 #define p6_init OPENSSL_FULL_VERSION_STR /* Static string */
86 static void cleanup_object(void *vobj
)
88 struct object_st
*obj
= vobj
;
92 OPENSSL_free(obj
->p4
);
97 static void *init_object(void)
99 struct object_st
*obj
= OPENSSL_zalloc(sizeof(*obj
));
103 if (!TEST_true(BN_hex2bn(&obj
->p3
, p3_init
)))
105 if (!TEST_ptr(obj
->p4
= OPENSSL_strdup(p4_init
)))
107 strcpy(obj
->p5
, p5_init
);
119 * RAW provider, which handles the parameters in a very raw manner,
120 * with no fancy API and very minimal checking. The application that
121 * calls these to set or request parameters MUST get its OSSL_PARAM
125 static int raw_set_params(void *vobj
, const OSSL_PARAM
*params
)
127 struct object_st
*obj
= vobj
;
129 for (; params
->key
!= NULL
; params
++)
130 if (strcmp(params
->key
, "p1") == 0) {
131 obj
->p1
= *(int *)params
->data
;
132 } else if (strcmp(params
->key
, "p2") == 0) {
133 obj
->p2
= *(double *)params
->data
;
134 } else if (strcmp(params
->key
, "p3") == 0) {
136 if (!TEST_ptr(obj
->p3
= BN_native2bn(params
->data
,
137 params
->data_size
, NULL
)))
139 } else if (strcmp(params
->key
, "p4") == 0) {
140 OPENSSL_free(obj
->p4
);
141 if (!TEST_ptr(obj
->p4
= OPENSSL_strndup(params
->data
,
144 } else if (strcmp(params
->key
, "p5") == 0) {
145 strncpy(obj
->p5
, params
->data
, params
->data_size
);
146 obj
->p5_l
= strlen(obj
->p5
) + 1;
147 } else if (strcmp(params
->key
, "p6") == 0) {
148 obj
->p6
= *(const char **)params
->data
;
149 obj
->p6_l
= params
->data_size
;
155 static int raw_get_params(void *vobj
, OSSL_PARAM
*params
)
157 struct object_st
*obj
= vobj
;
159 for (; params
->key
!= NULL
; params
++)
160 if (strcmp(params
->key
, "p1") == 0) {
161 params
->return_size
= sizeof(obj
->p1
);
162 *(int *)params
->data
= obj
->p1
;
163 } else if (strcmp(params
->key
, "p2") == 0) {
164 params
->return_size
= sizeof(obj
->p2
);
165 *(double *)params
->data
= obj
->p2
;
166 } else if (strcmp(params
->key
, "p3") == 0) {
167 size_t bytes
= BN_num_bytes(obj
->p3
);
169 params
->return_size
= bytes
;
170 if (!TEST_size_t_ge(params
->data_size
, bytes
))
172 BN_bn2nativepad(obj
->p3
, params
->data
, bytes
);
173 } else if (strcmp(params
->key
, "p4") == 0) {
174 size_t bytes
= strlen(obj
->p4
) + 1;
176 params
->return_size
= bytes
;
177 if (!TEST_size_t_ge(params
->data_size
, bytes
))
179 strcpy(params
->data
, obj
->p4
);
180 } else if (strcmp(params
->key
, "p5") == 0) {
181 size_t bytes
= strlen(obj
->p5
) + 1;
183 params
->return_size
= bytes
;
184 if (!TEST_size_t_ge(params
->data_size
, bytes
))
186 strcpy(params
->data
, obj
->p5
);
187 } else if (strcmp(params
->key
, "p6") == 0) {
189 * We COULD also use OPENSSL_FULL_VERSION_STR directly and
190 * use sizeof(OPENSSL_FULL_VERSION_STR) instead of calling
192 * The caller wouldn't know the difference.
194 size_t bytes
= strlen(obj
->p6
) + 1;
196 params
->return_size
= bytes
;
197 *(const char **)params
->data
= obj
->p6
;
204 * API provider, which handles the parameters using the API from params.h
207 static int api_set_params(void *vobj
, const OSSL_PARAM
*params
)
209 struct object_st
*obj
= vobj
;
210 const OSSL_PARAM
*p
= NULL
;
212 if ((p
= OSSL_PARAM_locate_const(params
, "p1")) != NULL
213 && !TEST_true(OSSL_PARAM_get_int(p
, &obj
->p1
)))
215 if ((p
= OSSL_PARAM_locate_const(params
, "p2")) != NULL
216 && !TEST_true(OSSL_PARAM_get_double(p
, &obj
->p2
)))
218 if ((p
= OSSL_PARAM_locate_const(params
, "p3")) != NULL
219 && !TEST_true(OSSL_PARAM_get_BN(p
, &obj
->p3
)))
221 if ((p
= OSSL_PARAM_locate_const(params
, "p4")) != NULL
) {
222 OPENSSL_free(obj
->p4
);
224 /* If the value pointer is NULL, we get it automatically allocated */
225 if (!TEST_true(OSSL_PARAM_get_utf8_string(p
, &obj
->p4
, 0)))
228 if ((p
= OSSL_PARAM_locate_const(params
, "p5")) != NULL
) {
229 char *p5_ptr
= obj
->p5
;
230 if (!TEST_true(OSSL_PARAM_get_utf8_string(p
, &p5_ptr
, sizeof(obj
->p5
))))
232 obj
->p5_l
= strlen(obj
->p5
) + 1;
234 if ((p
= OSSL_PARAM_locate_const(params
, "p6")) != NULL
) {
235 if (!TEST_true(OSSL_PARAM_get_utf8_ptr(p
, &obj
->p6
)))
237 obj
->p6_l
= strlen(obj
->p6
) + 1;
243 static int api_get_params(void *vobj
, OSSL_PARAM
*params
)
245 struct object_st
*obj
= vobj
;
246 OSSL_PARAM
*p
= NULL
;
248 if ((p
= OSSL_PARAM_locate(params
, "p1")) != NULL
249 && !TEST_true(OSSL_PARAM_set_int(p
, obj
->p1
)))
251 if ((p
= OSSL_PARAM_locate(params
, "p2")) != NULL
252 && !TEST_true(OSSL_PARAM_set_double(p
, obj
->p2
)))
254 if ((p
= OSSL_PARAM_locate(params
, "p3")) != NULL
255 && !TEST_true(OSSL_PARAM_set_BN(p
, obj
->p3
)))
257 if ((p
= OSSL_PARAM_locate(params
, "p4")) != NULL
258 && !TEST_true(OSSL_PARAM_set_utf8_string(p
, obj
->p4
)))
260 if ((p
= OSSL_PARAM_locate(params
, "p5")) != NULL
261 && !TEST_true(OSSL_PARAM_set_utf8_string(p
, obj
->p5
)))
263 if ((p
= OSSL_PARAM_locate(params
, "p6")) != NULL
264 && !TEST_true(OSSL_PARAM_set_utf8_ptr(p
, obj
->p6
)))
271 * This structure only simulates a provider dispatch, the real deal is
272 * a bit more code that's not necessary in these tests.
274 struct provider_dispatch_st
{
275 int (*set_params
)(void *obj
, const OSSL_PARAM
*params
);
276 int (*get_params
)(void *obj
, OSSL_PARAM
*params
);
280 static const struct provider_dispatch_st provider_raw
= {
281 raw_set_params
, raw_get_params
285 static const struct provider_dispatch_st provider_api
= {
286 api_set_params
, api_get_params
290 * APPLICATION SECTION
291 * ===================
294 /* In all our tests, these are variables that get manipulated as parameters
296 * These arrays consistently do nothing with the "p2" parameter, and
297 * always include a "foo" parameter. This is to check that the
298 * set_params and get_params calls ignore the lack of parameters that
299 * the application isn't interested in, as well as ignore parameters
300 * they don't understand (the application may have one big bag of
303 static int app_p1
; /* "p1" */
304 static double app_p2
; /* "p2" is ignored */
305 static BIGNUM
*app_p3
= NULL
; /* "p3" */
306 static unsigned char bignumbin
[4096]; /* "p3" */
307 static char app_p4
[256]; /* "p4" */
308 static char app_p5
[256]; /* "p5" */
309 static const char *app_p6
= NULL
; /* "p6" */
310 static unsigned char foo
[1]; /* "foo" */
312 #define app_p1_init 17 /* A random number */
313 #define app_p2_init 47.11 /* Another random number */
314 #define app_p3_init "deadbeef" /* Classic */
315 #define app_p4_init "Hello"
316 #define app_p5_init "World"
317 #define app_p6_init "Cookie"
318 #define app_foo_init 'z'
320 static int cleanup_app_variables(void)
327 static int init_app_variables(void)
331 cleanup_app_variables();
333 app_p1
= app_p1_init
;
334 app_p2
= app_p2_init
;
335 if (!BN_hex2bn(&app_p3
, app_p3_init
)
336 || (l
= BN_bn2nativepad(app_p3
, bignumbin
, sizeof(bignumbin
))) < 0)
338 strcpy(app_p4
, app_p4_init
);
339 strcpy(app_p5
, app_p5_init
);
340 app_p6
= app_p6_init
;
341 foo
[0] = app_foo_init
;
347 * Here, we define test OSSL_PARAM arrays
350 /* An array of OSSL_PARAM, specific in the most raw manner possible */
351 static OSSL_PARAM static_raw_params
[] = {
352 { "p1", OSSL_PARAM_INTEGER
, &app_p1
, sizeof(app_p1
), 0 },
353 { "p3", OSSL_PARAM_UNSIGNED_INTEGER
, &bignumbin
, sizeof(bignumbin
), 0 },
354 { "p4", OSSL_PARAM_UTF8_STRING
, &app_p4
, sizeof(app_p4
), 0 },
355 { "p5", OSSL_PARAM_UTF8_STRING
, &app_p5
, sizeof(app_p5
), 0 },
356 /* sizeof(app_p6_init), because we know that's what we're using */
357 { "p6", OSSL_PARAM_UTF8_PTR
, &app_p6
, sizeof(app_p6_init
), 0 },
358 { "foo", OSSL_PARAM_OCTET_STRING
, &foo
, sizeof(foo
), 0 },
359 { NULL
, 0, NULL
, 0, 0 }
362 /* The same array of OSSL_PARAM, specified with the macros from params.h */
363 static OSSL_PARAM static_api_params
[] = {
364 OSSL_PARAM_int("p1", &app_p1
),
365 OSSL_PARAM_BN("p3", &bignumbin
, sizeof(bignumbin
)),
366 OSSL_PARAM_DEFN("p4", OSSL_PARAM_UTF8_STRING
, &app_p4
, sizeof(app_p4
)),
367 OSSL_PARAM_DEFN("p5", OSSL_PARAM_UTF8_STRING
, &app_p5
, sizeof(app_p5
)),
368 /* sizeof(app_p6_init), because we know that's what we're using */
369 OSSL_PARAM_DEFN("p6", OSSL_PARAM_UTF8_PTR
, &app_p6
, sizeof(app_p6_init
)),
370 OSSL_PARAM_DEFN("foo", OSSL_PARAM_OCTET_STRING
, &foo
, sizeof(foo
)),
375 * The same array again, but constructed at run-time
376 * This exercises the OSSL_PARAM constructor functions
378 static OSSL_PARAM
*construct_api_params(void)
381 static OSSL_PARAM params
[10];
383 params
[n
++] = OSSL_PARAM_construct_int("p1", &app_p1
);
384 params
[n
++] = OSSL_PARAM_construct_BN("p3", bignumbin
, sizeof(bignumbin
));
385 params
[n
++] = OSSL_PARAM_construct_utf8_string("p4", app_p4
,
387 params
[n
++] = OSSL_PARAM_construct_utf8_string("p5", app_p5
,
389 /* sizeof(app_p6_init), because we know that's what we're using */
390 params
[n
++] = OSSL_PARAM_construct_utf8_ptr("p6", (char **)&app_p6
,
391 sizeof(app_p6_init
));
392 params
[n
++] = OSSL_PARAM_construct_octet_string("foo", &foo
, sizeof(foo
));
393 params
[n
++] = OSSL_PARAM_construct_end();
398 struct param_owner_st
{
399 OSSL_PARAM
*static_params
;
400 OSSL_PARAM
*(*constructed_params
)(void);
403 static const struct param_owner_st raw_params
= {
404 static_raw_params
, NULL
407 static const struct param_owner_st api_params
= {
408 static_api_params
, construct_api_params
417 * Test cases to combine parameters with "provider side" functions
420 const struct provider_dispatch_st
*prov
;
421 const struct param_owner_st
*app
;
424 /* Tests within specific methods */
425 { &provider_raw
, &raw_params
, "raw provider vs raw params" },
426 { &provider_api
, &api_params
, "api provider vs api params" },
429 { &provider_raw
, &api_params
, "raw provider vs api params" },
430 { &provider_api
, &raw_params
, "api provider vs raw params" },
433 /* Generic tester of combinations of "providers" and params */
434 static int test_case_variant(OSSL_PARAM
*params
, const struct provider_dispatch_st
*prov
)
436 BIGNUM
*verify_p3
= NULL
;
444 if (!TEST_ptr(obj
= init_object())
445 || !TEST_true(BN_hex2bn(&verify_p3
, p3_init
))) {
451 * Get parameters a first time, just to see that getting works and
452 * gets us the values we expect.
454 init_app_variables();
456 if (!TEST_true(prov
->get_params(obj
, params
))
457 || !TEST_int_eq(app_p1
, p1_init
) /* "provider" value */
458 || !TEST_double_eq(app_p2
, app_p2_init
) /* Should remain untouched */
459 || !TEST_ptr(p
= OSSL_PARAM_locate(params
, "p3"))
460 || !TEST_ptr(BN_native2bn(bignumbin
, p
->return_size
, app_p3
))
461 || !TEST_BN_eq(app_p3
, verify_p3
) /* "provider" value */
462 || !TEST_str_eq(app_p4
, p4_init
) /* "provider" value */
463 || !TEST_ptr(p
= OSSL_PARAM_locate(params
, "p5"))
464 || !TEST_size_t_eq(p
->return_size
, sizeof(p5_init
)) /* "provider" value */
465 || !TEST_str_eq(app_p5
, p5_init
) /* "provider" value */
466 || !TEST_ptr(p
= OSSL_PARAM_locate(params
, "p6"))
467 || !TEST_size_t_eq(p
->return_size
, sizeof(p6_init
)) /* "provider" value */
468 || !TEST_str_eq(app_p6
, p6_init
) /* "provider" value */
469 || !TEST_char_eq(foo
[0], app_foo_init
) /* Should remain untouched */
470 || !TEST_ptr(p
= OSSL_PARAM_locate(params
, "foo"))
471 || !TEST_int_eq(p
->return_size
, 0))
475 * Set parameters, then sneak into the object itself and check
476 * that its attributes got set (or ignored) properly.
478 init_app_variables();
480 if (!TEST_true(prov
->set_params(obj
, params
))) {
483 struct object_st
*sneakpeek
= obj
;
485 if (!TEST_int_eq(sneakpeek
->p1
, app_p1
) /* app value set */
486 || !TEST_double_eq(sneakpeek
->p2
, p2_init
) /* Should remain untouched */
487 || !TEST_BN_eq(sneakpeek
->p3
, app_p3
) /* app value set */
488 || !TEST_str_eq(sneakpeek
->p4
, app_p4
) /* app value set */
489 || !TEST_str_eq(sneakpeek
->p5
, app_p5
) /* app value set */
490 || !TEST_str_eq(sneakpeek
->p6
, app_p6
)) /* app value set */
495 * Get parameters again, checking that we get different values
496 * than earlier where relevant.
501 if (!TEST_true(BN_hex2bn(&verify_p3
, app_p3_init
))) {
506 if (!TEST_true(prov
->get_params(obj
, params
))
507 || !TEST_int_eq(app_p1
, app_p1_init
) /* app value */
508 || !TEST_double_eq(app_p2
, app_p2_init
) /* Should remain untouched */
509 || !TEST_ptr(p
= OSSL_PARAM_locate(params
, "p3"))
510 || !TEST_ptr(BN_native2bn(bignumbin
, p
->return_size
, app_p3
))
511 || !TEST_BN_eq(app_p3
, verify_p3
) /* app value */
512 || !TEST_str_eq(app_p4
, app_p4_init
) /* app value */
513 || !TEST_ptr(p
= OSSL_PARAM_locate(params
, "p5"))
514 || !TEST_size_t_eq(p
->return_size
,
515 sizeof(app_p5_init
)) /* app value */
516 || !TEST_str_eq(app_p5
, app_p5_init
) /* app value */
517 || !TEST_ptr(p
= OSSL_PARAM_locate(params
, "p6"))
518 || !TEST_size_t_eq(p
->return_size
,
519 sizeof(app_p6_init
)) /* app value */
520 || !TEST_str_eq(app_p6
, app_p6_init
) /* app value */
521 || !TEST_char_eq(foo
[0], app_foo_init
) /* Should remain untouched */
522 || !TEST_ptr(p
= OSSL_PARAM_locate(params
, "foo"))
523 || !TEST_int_eq(p
->return_size
, 0))
529 cleanup_app_variables();
535 static int test_case(int i
)
537 TEST_info("Case: %s", test_cases
[i
].desc
);
539 return test_case_variant(test_cases
[i
].app
->static_params
,
541 && (test_cases
[i
].app
->constructed_params
== NULL
542 || test_case_variant(test_cases
[i
].app
->constructed_params(),
543 test_cases
[i
].prov
));
546 int setup_tests(void)
548 ADD_ALL_TESTS(test_case
, OSSL_NELEM(test_cases
));