test/params_test.c

   1 /*
   2  * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   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.
   9  */
  10
  11 /*
  12  * This program tests the use of OSSL_PARAM, currently in raw form.
  13  */
  14
  15 #include <string.h>
  16 #include <openssl/bn.h>
  17 #include <openssl/core.h>
  18 #include <openssl/params.h>
  19 #include "internal/nelem.h"
  20 #include "testutil.h"
  21
  22 /*-
  23  * PROVIDER SECTION
  24  * ================
  25  *
  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.
  29  */
  30
  31 /*
  32  * In real use cases, setters and getters would take an object with
  33  * which the parameters are associated.  This structure is a cheap
  34  * simulation.
  35  */
  36 struct object_st {
  37     /*
  38      * Documented as a native integer, of the size given by sizeof(int).
  39      * Assumed data type OSSL_PARAM_INTEGER
  40      */
  41     int p1;
  42     /*
  43      * Documented as a native double, of the size given by sizeof(double).
  44      * Assumed data type OSSL_PARAM_REAL
  45      */
  46     double p2;
  47     /*
  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
  51      */
  52     BIGNUM *p3;
  53     /*
  54      * Documented as a C string.
  55      * The data size must be large enough to accommodate.
  56      * Assumed data type OSSL_PARAM_UTF8_STRING
  57      */
  58     char *p4;
  59     size_t p4_l;
  60     /*
  61      * Documented as a C string.
  62      * Assumed data type OSSL_PARAM_UTF8_STRING
  63      */
  64     char p5[256];
  65     size_t p5_l;
  66     /*
  67      * Documented as a pointer to a constant C string.
  68      * Assumed data type OSSL_PARAM_UTF8_PTR
  69      */
  70     const char *p6;
  71     size_t p6_l;
  72 };
  73
  74 #define p1_init 42                              /* The ultimate answer */
  75 #define p2_init 6.283                           /* Magic number */
  76 /* Stolen from evp_data, BLAKE2s256 test */
  77 #define p3_init                                 \
  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 */
  85
  86 static void cleanup_object(void *vobj)
  87 {
  88     struct object_st *obj = vobj;
  89
  90     BN_free(obj->p3);
  91     obj->p3 = NULL;
  92     OPENSSL_free(obj->p4);
  93     obj->p4 = NULL;
  94     OPENSSL_free(obj);
  95 }
  96
  97 static void *init_object(void)
  98 {
  99     struct object_st *obj = OPENSSL_zalloc(sizeof(*obj));
 100
 101     obj->p1 = p1_init;
 102     obj->p2 = p2_init;
 103     if (!TEST_true(BN_hex2bn(&obj->p3, p3_init)))
 104         goto fail;
 105     if (!TEST_ptr(obj->p4 = OPENSSL_strdup(p4_init)))
 106         goto fail;
 107     strcpy(obj->p5, p5_init);
 108     obj->p6 = p6_init;
 109
 110     return obj;
 111  fail:
 112     cleanup_object(obj);
 113     obj = NULL;
 114
 115     return NULL;
 116 }
 117
 118 /*
 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
 122  * array right.
 123  */
 124
 125 static int raw_set_params(void *vobj, const OSSL_PARAM *params)
 126 {
 127     struct object_st *obj = vobj;
 128
 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) {
 135             BN_free(obj->p3);
 136             if (!TEST_ptr(obj->p3 = BN_native2bn(params->data,
 137                                                  params->data_size, NULL)))
 138                 return 0;
 139         } else if (strcmp(params->key, "p4") == 0) {
 140             OPENSSL_free(obj->p4);
 141             if (!TEST_ptr(obj->p4 = OPENSSL_strndup(params->data,
 142                                                     params->data_size)))
 143                 return 0;
 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;
 150         }
 151
 152     return 1;
 153 }
 154
 155 static int raw_get_params(void *vobj, OSSL_PARAM *params)
 156 {
 157     struct object_st *obj = vobj;
 158
 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);
 168
 169             params->return_size = bytes;
 170             if (!TEST_size_t_ge(params->data_size, bytes))
 171                 return 0;
 172             BN_bn2nativepad(obj->p3, params->data, bytes);
 173         } else if (strcmp(params->key, "p4") == 0) {
 174             size_t bytes = strlen(obj->p4) + 1;
 175
 176             params->return_size = bytes;
 177             if (!TEST_size_t_ge(params->data_size, bytes))
 178                 return 0;
 179             strcpy(params->data, obj->p4);
 180         } else if (strcmp(params->key, "p5") == 0) {
 181             size_t bytes = strlen(obj->p5) + 1;
 182
 183             params->return_size = bytes;
 184             if (!TEST_size_t_ge(params->data_size, bytes))
 185                 return 0;
 186             strcpy(params->data, obj->p5);
 187         } else if (strcmp(params->key, "p6") == 0) {
 188             /*
 189              * We COULD also use OPENSSL_FULL_VERSION_STR directly and
 190              * use sizeof(OPENSSL_FULL_VERSION_STR) instead of calling
 191              * strlen().
 192              * The caller wouldn't know the difference.
 193              */
 194             size_t bytes = strlen(obj->p6) + 1;
 195
 196             params->return_size = bytes;
 197             *(const char **)params->data = obj->p6;
 198         }
 199
 200     return 1;
 201 }
 202
 203 /*
 204  * API provider, which handles the parameters using the API from params.h
 205  */
 206
 207 static int api_set_params(void *vobj, const OSSL_PARAM *params)
 208 {
 209     struct object_st *obj = vobj;
 210     const OSSL_PARAM *p = NULL;
 211
 212     if ((p = OSSL_PARAM_locate_const(params, "p1")) != NULL
 213         && !TEST_true(OSSL_PARAM_get_int(p, &obj->p1)))
 214         return 0;
 215     if ((p = OSSL_PARAM_locate_const(params, "p2")) != NULL
 216         && !TEST_true(OSSL_PARAM_get_double(p, &obj->p2)))
 217         return 0;
 218     if ((p = OSSL_PARAM_locate_const(params, "p3")) != NULL
 219         && !TEST_true(OSSL_PARAM_get_BN(p, &obj->p3)))
 220         return 0;
 221     if ((p = OSSL_PARAM_locate_const(params, "p4")) != NULL) {
 222         OPENSSL_free(obj->p4);
 223         obj->p4 = NULL;
 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)))
 226             return 0;
 227     }
 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))))
 231             return 0;
 232         obj->p5_l = strlen(obj->p5) + 1;
 233     }
 234     if ((p = OSSL_PARAM_locate_const(params, "p6")) != NULL) {
 235         if (!TEST_true(OSSL_PARAM_get_utf8_ptr(p, &obj->p6)))
 236             return 0;
 237         obj->p6_l = strlen(obj->p6) + 1;
 238     }
 239
 240     return 1;
 241 }
 242
 243 static int api_get_params(void *vobj, OSSL_PARAM *params)
 244 {
 245     struct object_st *obj = vobj;
 246     OSSL_PARAM *p = NULL;
 247
 248     if ((p = OSSL_PARAM_locate(params, "p1")) != NULL
 249         && !TEST_true(OSSL_PARAM_set_int(p, obj->p1)))
 250         return 0;
 251     if ((p = OSSL_PARAM_locate(params, "p2")) != NULL
 252         && !TEST_true(OSSL_PARAM_set_double(p, obj->p2)))
 253         return 0;
 254     if ((p = OSSL_PARAM_locate(params, "p3")) != NULL
 255         && !TEST_true(OSSL_PARAM_set_BN(p, obj->p3)))
 256         return 0;
 257     if ((p = OSSL_PARAM_locate(params, "p4")) != NULL
 258         && !TEST_true(OSSL_PARAM_set_utf8_string(p, obj->p4)))
 259         return 0;
 260     if ((p = OSSL_PARAM_locate(params, "p5")) != NULL
 261         && !TEST_true(OSSL_PARAM_set_utf8_string(p, obj->p5)))
 262         return 0;
 263     if ((p = OSSL_PARAM_locate(params, "p6")) != NULL
 264         && !TEST_true(OSSL_PARAM_set_utf8_ptr(p, obj->p6)))
 265         return 0;
 266
 267     return 1;
 268 }
 269
 270 /*
 271  * This structure only simulates a provider dispatch, the real deal is
 272  * a bit more code that's not necessary in these tests.
 273  */
 274 struct provider_dispatch_st {
 275     int (*set_params)(void *obj, const OSSL_PARAM *params);
 276     int (*get_params)(void *obj, OSSL_PARAM *params);
 277 };
 278
 279 /* "raw" provider */
 280 static const struct provider_dispatch_st provider_raw = {
 281     raw_set_params, raw_get_params
 282 };
 283
 284 /* "api" provider */
 285 static const struct provider_dispatch_st provider_api = {
 286     api_set_params, api_get_params
 287 };
 288
 289 /*-
 290  * APPLICATION SECTION
 291  * ===================
 292  */
 293
 294 /* In all our tests, these are variables that get manipulated as parameters
 295  *
 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
 301  * parameters).
 302  */
 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" */
 311
 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'
 319
 320 static int cleanup_app_variables(void)
 321 {
 322     BN_free(app_p3);
 323     app_p3 = NULL;
 324     return 1;
 325 }
 326
 327 static int init_app_variables(void)
 328 {
 329     int l = 0;
 330
 331     cleanup_app_variables();
 332
 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)
 337         return 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;
 342
 343     return 1;
 344 }
 345
 346 /*
 347  * Here, we define test OSSL_PARAM arrays
 348  */
 349
 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 }
 360 };
 361
 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)),
 371     OSSL_PARAM_END
 372 };
 373
 374 /*
 375  * The same array again, but constructed at run-time
 376  * This exercises the OSSL_PARAM constructor functions
 377  */
 378 static OSSL_PARAM *construct_api_params(void)
 379 {
 380     size_t n = 0;
 381     static OSSL_PARAM params[10];
 382
 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,
 386                                                    sizeof(app_p4));
 387     params[n++] = OSSL_PARAM_construct_utf8_string("p5", app_p5,
 388                                                    sizeof(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();
 394
 395     return params;
 396 }
 397
 398 struct param_owner_st {
 399     OSSL_PARAM *static_params;
 400     OSSL_PARAM *(*constructed_params)(void);
 401 };
 402
 403 static const struct param_owner_st raw_params = {
 404     static_raw_params, NULL
 405 };
 406
 407 static const struct param_owner_st api_params = {
 408     static_api_params, construct_api_params
 409 };
 410
 411 /*-
 412  * TESTING
 413  * =======
 414  */
 415
 416 /*
 417  * Test cases to combine parameters with "provider side" functions
 418  */
 419 static struct {
 420     const struct provider_dispatch_st *prov;
 421     const struct param_owner_st *app;
 422     const char *desc;
 423 } test_cases[] = {
 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" },
 427
 428     /* Mixed methods */
 429     { &provider_raw, &api_params, "raw provider vs api params" },
 430     { &provider_api, &raw_params, "api provider vs raw params" },
 431 };
 432
 433 /* Generic tester of combinations of "providers" and params */
 434 static int test_case_variant(OSSL_PARAM *params, const struct provider_dispatch_st *prov)
 435 {
 436     BIGNUM *verify_p3 = NULL;
 437     void *obj = NULL;
 438     int errcnt = 0;
 439     OSSL_PARAM *p;
 440
 441     /*
 442      * Initialize
 443      */
 444     if (!TEST_ptr(obj = init_object())
 445         || !TEST_true(BN_hex2bn(&verify_p3, p3_init))) {
 446         errcnt++;
 447         goto fin;
 448     }
 449
 450     /*
 451      * Get parameters a first time, just to see that getting works and
 452      * gets us the values we expect.
 453      */
 454     init_app_variables();
 455
 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         errcnt++;
 472
 473     /*
 474      * Set parameters, then sneak into the object itself and check
 475      * that its attributes got set (or ignored) properly.
 476      */
 477     init_app_variables();
 478
 479     if (!TEST_true(prov->set_params(obj, params))) {
 480         errcnt++;
 481     } else {
 482         struct object_st *sneakpeek = obj;
 483
 484         if (!TEST_int_eq(sneakpeek->p1, app_p1)         /* app value set */
 485             || !TEST_double_eq(sneakpeek->p2, p2_init)  /* Should remain untouched */
 486             || !TEST_BN_eq(sneakpeek->p3, app_p3)       /* app value set */
 487             || !TEST_str_eq(sneakpeek->p4, app_p4)      /* app value set */
 488             || !TEST_str_eq(sneakpeek->p5, app_p5)      /* app value set */
 489             || !TEST_str_eq(sneakpeek->p6, app_p6))     /* app value set */
 490             errcnt++;
 491     }
 492
 493     /*
 494      * Get parameters again, checking that we get different values
 495      * than earlier where relevant.
 496      */
 497     BN_free(verify_p3);
 498     verify_p3 = NULL;
 499
 500     if (!TEST_true(BN_hex2bn(&verify_p3, app_p3_init))) {
 501         errcnt++;
 502         goto fin;
 503     }
 504
 505     if (!TEST_true(prov->get_params(obj, params))
 506         || !TEST_int_eq(app_p1, app_p1_init)    /* app value */
 507         || !TEST_double_eq(app_p2, app_p2_init) /* Should remain untouched */
 508         || !TEST_ptr(p = OSSL_PARAM_locate(params, "p3"))
 509         || !TEST_ptr(BN_native2bn(bignumbin, p->return_size, app_p3))
 510         || !TEST_BN_eq(app_p3, verify_p3)       /* app value */
 511         || !TEST_str_eq(app_p4, app_p4_init)    /* app value */
 512         || !TEST_ptr(p = OSSL_PARAM_locate(params, "p5"))
 513         || !TEST_size_t_eq(p->return_size,
 514                            sizeof(app_p5_init)) /* app value */
 515         || !TEST_str_eq(app_p5, app_p5_init)    /* app value */
 516         || !TEST_ptr(p = OSSL_PARAM_locate(params, "p6"))
 517         || !TEST_size_t_eq(p->return_size,
 518                            sizeof(app_p6_init)) /* app value */
 519         || !TEST_str_eq(app_p6, app_p6_init)    /* app value */
 520         || !TEST_char_eq(foo[0], app_foo_init)  /* Should remain untouched */
 521         || !TEST_ptr(p = OSSL_PARAM_locate(params, "foo")))
 522         errcnt++;
 523
 524  fin:
 525     BN_free(verify_p3);
 526     verify_p3 = NULL;
 527     cleanup_app_variables();
 528     cleanup_object(obj);
 529
 530     return errcnt == 0;
 531 }
 532
 533 static int test_case(int i)
 534 {
 535     TEST_info("Case: %s", test_cases[i].desc);
 536
 537     return test_case_variant(test_cases[i].app->static_params,
 538                              test_cases[i].prov)
 539         && (test_cases[i].app->constructed_params == NULL
 540             || test_case_variant(test_cases[i].app->constructed_params(),
 541                                  test_cases[i].prov));
 542 }
 543
 544 int setup_tests(void)
 545 {
 546     ADD_ALL_TESTS(test_case, OSSL_NELEM(test_cases));
 547     return 1;
 548 }