test/cmp_hdr_test.c

   1 /*
   2  * Copyright 2007-2021 The OpenSSL Project Authors. All Rights Reserved.
   3  * Copyright Nokia 2007-2019
   4  * Copyright Siemens AG 2015-2019
   5  *
   6  * Licensed under the Apache License 2.0 (the "License").  You may not use
   7  * this file except in compliance with the License.  You can obtain a copy
   8  * in the file LICENSE in the source distribution or at
   9  * https://www.openssl.org/source/license.html
  10  */
  11
  12 #include "helpers/cmp_testlib.h"
  13
  14 static unsigned char rand_data[OSSL_CMP_TRANSACTIONID_LENGTH];
  15
  16 typedef struct test_fixture {
  17     const char *test_case_name;
  18     int expected;
  19     OSSL_CMP_CTX *cmp_ctx;
  20     OSSL_CMP_PKIHEADER *hdr;
  21
  22 } CMP_HDR_TEST_FIXTURE;
  23
  24 static void tear_down(CMP_HDR_TEST_FIXTURE *fixture)
  25 {
  26     OSSL_CMP_PKIHEADER_free(fixture->hdr);
  27     OSSL_CMP_CTX_free(fixture->cmp_ctx);
  28     OPENSSL_free(fixture);
  29 }
  30
  31 static CMP_HDR_TEST_FIXTURE *set_up(const char *const test_case_name)
  32 {
  33     CMP_HDR_TEST_FIXTURE *fixture;
  34
  35     if (!TEST_ptr(fixture = OPENSSL_zalloc(sizeof(*fixture))))
  36         return NULL;
  37     fixture->test_case_name = test_case_name;
  38     if (!TEST_ptr(fixture->cmp_ctx = OSSL_CMP_CTX_new(NULL, NULL)))
  39         goto err;
  40     if (!TEST_ptr(fixture->hdr = OSSL_CMP_PKIHEADER_new()))
  41         goto err;
  42     return fixture;
  43
  44  err:
  45     tear_down(fixture);
  46     return NULL;
  47 }
  48
  49 static int execute_HDR_set_get_pvno_test(CMP_HDR_TEST_FIXTURE *fixture)
  50 {
  51     int pvno = 77;
  52
  53     if (!TEST_int_eq(ossl_cmp_hdr_set_pvno(fixture->hdr, pvno), 1))
  54         return 0;
  55     if (!TEST_int_eq(ossl_cmp_hdr_get_pvno(fixture->hdr), pvno))
  56         return 0;
  57     return 1;
  58 }
  59
  60 static int test_HDR_set_get_pvno(void)
  61 {
  62     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
  63     fixture->expected = 1;
  64     EXECUTE_TEST(execute_HDR_set_get_pvno_test, tear_down);
  65     return result;
  66 }
  67
  68 #define X509_NAME_ADD(n, rd, s) \
  69     X509_NAME_add_entry_by_txt((n), (rd), MBSTRING_ASC, (unsigned char *)(s), \
  70                                -1, -1, 0)
  71
  72 static int execute_HDR_get0_senderNonce_test(CMP_HDR_TEST_FIXTURE *fixture)
  73 {
  74     X509_NAME *sender = X509_NAME_new();
  75     ASN1_OCTET_STRING *sn;
  76
  77     if (!TEST_ptr(sender))
  78         return 0;
  79
  80     X509_NAME_ADD(sender, "CN", "A common sender name");
  81     if (!TEST_int_eq(OSSL_CMP_CTX_set1_subjectName(fixture->cmp_ctx, sender),
  82                      1))
  83         return 0;
  84     if (!TEST_int_eq(ossl_cmp_hdr_init(fixture->cmp_ctx, fixture->hdr),
  85                      1))
  86         return 0;
  87     sn = ossl_cmp_hdr_get0_senderNonce(fixture->hdr);
  88     if (!TEST_int_eq(ASN1_OCTET_STRING_cmp(fixture->cmp_ctx->senderNonce, sn),
  89                      0))
  90         return 0;
  91     X509_NAME_free(sender);
  92     return 1;
  93 }
  94
  95 static int test_HDR_get0_senderNonce(void)
  96 {
  97     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
  98     fixture->expected = 1;
  99     EXECUTE_TEST(execute_HDR_get0_senderNonce_test, tear_down);
 100     return result;
 101 }
 102
 103 static int execute_HDR_set1_sender_test(CMP_HDR_TEST_FIXTURE *fixture)
 104 {
 105     X509_NAME *x509name = X509_NAME_new();
 106
 107     if (!TEST_ptr(x509name))
 108         return 0;
 109
 110     X509_NAME_ADD(x509name, "CN", "A common sender name");
 111     if (!TEST_int_eq(ossl_cmp_hdr_set1_sender(fixture->hdr, x509name), 1))
 112         return 0;
 113     if (!TEST_int_eq(fixture->hdr->sender->type, GEN_DIRNAME))
 114         return 0;
 115
 116     if (!TEST_int_eq(X509_NAME_cmp(fixture->hdr->sender->d.directoryName,
 117                                    x509name), 0))
 118         return 0;
 119
 120     X509_NAME_free(x509name);
 121     return 1;
 122 }
 123
 124 static int test_HDR_set1_sender(void)
 125 {
 126     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 127     fixture->expected = 1;
 128     EXECUTE_TEST(execute_HDR_set1_sender_test, tear_down);
 129     return result;
 130 }
 131
 132 static int execute_HDR_set1_recipient_test(CMP_HDR_TEST_FIXTURE *fixture)
 133 {
 134     X509_NAME *x509name = X509_NAME_new();
 135
 136     if (!TEST_ptr(x509name))
 137         return 0;
 138
 139     X509_NAME_ADD(x509name, "CN", "A common recipient name");
 140     if (!TEST_int_eq(ossl_cmp_hdr_set1_recipient(fixture->hdr, x509name), 1))
 141         return 0;
 142
 143     if (!TEST_int_eq(fixture->hdr->recipient->type, GEN_DIRNAME))
 144         return 0;
 145
 146     if (!TEST_int_eq(X509_NAME_cmp(fixture->hdr->recipient->d.directoryName,
 147                                    x509name), 0))
 148         return 0;
 149
 150     X509_NAME_free(x509name);
 151     return 1;
 152 }
 153
 154 static int test_HDR_set1_recipient(void)
 155 {
 156     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 157     fixture->expected = 1;
 158     EXECUTE_TEST(execute_HDR_set1_recipient_test, tear_down);
 159     return result;
 160 }
 161
 162 static int execute_HDR_update_messageTime_test(CMP_HDR_TEST_FIXTURE *fixture)
 163 {
 164     struct tm hdrtm;
 165     time_t hdrtime, before, after, now;
 166
 167     now = time(NULL);
 168     before = mktime(gmtime(&now));
 169     if (!TEST_true(ossl_cmp_hdr_update_messageTime(fixture->hdr)))
 170         return 0;
 171     if (!TEST_true(ASN1_TIME_to_tm(fixture->hdr->messageTime, &hdrtm)))
 172         return 0;
 173
 174     hdrtime = mktime(&hdrtm);
 175     if (!TEST_true(before <= hdrtime))
 176         return 0;
 177     now = time(NULL);
 178     after = mktime(gmtime(&now));
 179     return TEST_true(hdrtime <= after);
 180 }
 181
 182 static int test_HDR_update_messageTime(void)
 183 {
 184     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 185     fixture->expected = 1;
 186     EXECUTE_TEST(execute_HDR_update_messageTime_test, tear_down);
 187     return result;
 188 }
 189
 190 static int execute_HDR_set1_senderKID_test(CMP_HDR_TEST_FIXTURE *fixture)
 191 {
 192     ASN1_OCTET_STRING *senderKID = ASN1_OCTET_STRING_new();
 193     int res = 0;
 194
 195     if (!TEST_ptr(senderKID))
 196         return 0;
 197
 198     if (!TEST_int_eq(ASN1_OCTET_STRING_set(senderKID, rand_data,
 199                                            sizeof(rand_data)), 1))
 200         goto err;
 201     if (!TEST_int_eq(ossl_cmp_hdr_set1_senderKID(fixture->hdr, senderKID), 1))
 202         goto err;
 203     if (!TEST_int_eq(ASN1_OCTET_STRING_cmp(fixture->hdr->senderKID,
 204                                            senderKID), 0))
 205         goto err;
 206     res = 1;
 207  err:
 208     ASN1_OCTET_STRING_free(senderKID);
 209     return res;
 210 }
 211
 212 static int test_HDR_set1_senderKID(void)
 213 {
 214     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 215     fixture->expected = 1;
 216     EXECUTE_TEST(execute_HDR_set1_senderKID_test, tear_down);
 217     return result;
 218 }
 219
 220 static int execute_HDR_push0_freeText_test(CMP_HDR_TEST_FIXTURE *fixture)
 221 {
 222     ASN1_UTF8STRING *text = ASN1_UTF8STRING_new();
 223
 224     if (!TEST_ptr(text))
 225         return 0;
 226
 227     if (!ASN1_STRING_set(text, "A free text", -1))
 228         goto err;
 229
 230     if (!TEST_int_eq(ossl_cmp_hdr_push0_freeText(fixture->hdr, text), 1))
 231         goto err;
 232
 233     if (!TEST_true(text == sk_ASN1_UTF8STRING_value(fixture->hdr->freeText, 0)))
 234         goto err;
 235
 236     return 1;
 237
 238  err:
 239     ASN1_UTF8STRING_free(text);
 240     return 0;
 241 }
 242
 243 static int test_HDR_push0_freeText(void)
 244 {
 245     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 246     fixture->expected = 1;
 247     EXECUTE_TEST(execute_HDR_push0_freeText_test, tear_down);
 248     return result;
 249 }
 250
 251 static int execute_HDR_push1_freeText_test(CMP_HDR_TEST_FIXTURE *fixture)
 252 {
 253     ASN1_UTF8STRING *text = ASN1_UTF8STRING_new();
 254     ASN1_UTF8STRING *pushed_text;
 255     int res = 0;
 256
 257     if (!TEST_ptr(text))
 258         return 0;
 259
 260     if (!ASN1_STRING_set(text, "A free text", -1))
 261         goto err;
 262
 263     if (!TEST_int_eq(ossl_cmp_hdr_push1_freeText(fixture->hdr, text), 1))
 264         goto err;
 265
 266     pushed_text = sk_ASN1_UTF8STRING_value(fixture->hdr->freeText, 0);
 267     if (!TEST_int_eq(ASN1_STRING_cmp(text, pushed_text), 0))
 268         goto err;
 269
 270     res = 1;
 271  err:
 272     ASN1_UTF8STRING_free(text);
 273     return res;
 274 }
 275
 276 static int test_HDR_push1_freeText(void)
 277 {
 278     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 279     fixture->expected = 1;
 280     EXECUTE_TEST(execute_HDR_push1_freeText_test, tear_down);
 281     return result;
 282 }
 283
 284 static int
 285 execute_HDR_generalInfo_push0_item_test(CMP_HDR_TEST_FIXTURE *fixture)
 286 {
 287     OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_new();
 288
 289     if (!TEST_ptr(itav))
 290         return 0;
 291
 292     if (!TEST_int_eq(ossl_cmp_hdr_generalInfo_push0_item(fixture->hdr, itav),
 293                      1))
 294         return 0;
 295
 296     if (!TEST_true(itav == sk_OSSL_CMP_ITAV_value(fixture->hdr->generalInfo,
 297                                                   0)))
 298         return 0;
 299
 300     return 1;
 301 }
 302
 303 static int test_HDR_generalInfo_push0_item(void)
 304 {
 305     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 306     fixture->expected = 1;
 307     EXECUTE_TEST(execute_HDR_generalInfo_push0_item_test, tear_down);
 308     return result;
 309 }
 310
 311 static int
 312 execute_HDR_generalInfo_push1_items_test(CMP_HDR_TEST_FIXTURE *fixture)
 313 {
 314     const char oid[] = "1.2.3.4";
 315     char buf[20];
 316     OSSL_CMP_ITAV *itav, *pushed_itav;
 317     STACK_OF(OSSL_CMP_ITAV) *itavs = NULL, *ginfo;
 318     ASN1_INTEGER *asn1int = ASN1_INTEGER_new();
 319     ASN1_TYPE *val = ASN1_TYPE_new();
 320     ASN1_TYPE *pushed_val;
 321     int res = 0;
 322
 323     if (!TEST_ptr(asn1int))
 324         return 0;
 325
 326     if (!TEST_ptr(val)) {
 327         ASN1_INTEGER_free(asn1int);
 328         return 0;
 329     }
 330
 331     ASN1_INTEGER_set(asn1int, 88);
 332     ASN1_TYPE_set(val, V_ASN1_INTEGER, asn1int);
 333     if (!TEST_ptr(itav = OSSL_CMP_ITAV_create(OBJ_txt2obj(oid, 1), val))) {
 334         ASN1_TYPE_free(val);
 335         return 0;
 336     }
 337     if (!TEST_true(OSSL_CMP_ITAV_push0_stack_item(&itavs, itav))) {
 338         OSSL_CMP_ITAV_free(itav);
 339         return 0;
 340     }
 341
 342     if (!TEST_int_eq(ossl_cmp_hdr_generalInfo_push1_items(fixture->hdr, itavs),
 343                      1))
 344         goto err;
 345     ginfo = fixture->hdr->generalInfo;
 346     pushed_itav = sk_OSSL_CMP_ITAV_value(ginfo, 0);
 347     OBJ_obj2txt(buf, sizeof(buf), OSSL_CMP_ITAV_get0_type(pushed_itav), 0);
 348     if (!TEST_int_eq(memcmp(oid, buf, sizeof(oid)), 0))
 349         goto err;
 350
 351     pushed_val = OSSL_CMP_ITAV_get0_value(sk_OSSL_CMP_ITAV_value(ginfo, 0));
 352     if (!TEST_int_eq(ASN1_TYPE_cmp(itav->infoValue.other, pushed_val), 0))
 353         goto err;
 354
 355     res = 1;
 356
 357  err:
 358     sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
 359     return res;
 360 }
 361
 362 static int test_HDR_generalInfo_push1_items(void)
 363 {
 364     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 365     fixture->expected = 1;
 366     EXECUTE_TEST(execute_HDR_generalInfo_push1_items_test, tear_down);
 367     return result;
 368 }
 369
 370 static int
 371 execute_HDR_set_and_check_implicitConfirm_test(CMP_HDR_TEST_FIXTURE
 372                                                * fixture)
 373 {
 374     return TEST_false(ossl_cmp_hdr_has_implicitConfirm(fixture->hdr))
 375         && TEST_true(ossl_cmp_hdr_set_implicitConfirm(fixture->hdr))
 376         && TEST_true(ossl_cmp_hdr_has_implicitConfirm(fixture->hdr));
 377 }
 378
 379 static int test_HDR_set_and_check_implicit_confirm(void)
 380 {
 381     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 382     EXECUTE_TEST(execute_HDR_set_and_check_implicitConfirm_test, tear_down);
 383     return result;
 384 }
 385
 386
 387 static int execute_HDR_init_test(CMP_HDR_TEST_FIXTURE *fixture)
 388 {
 389     ASN1_OCTET_STRING *header_nonce, *header_transactionID;
 390     ASN1_OCTET_STRING *ctx_nonce;
 391
 392     if (!TEST_int_eq(fixture->expected,
 393                      ossl_cmp_hdr_init(fixture->cmp_ctx, fixture->hdr)))
 394         return 0;
 395     if (fixture->expected == 0)
 396         return 1;
 397
 398     if (!TEST_int_eq(ossl_cmp_hdr_get_pvno(fixture->hdr), OSSL_CMP_PVNO))
 399         return 0;
 400
 401     header_nonce = ossl_cmp_hdr_get0_senderNonce(fixture->hdr);
 402     if (!TEST_int_eq(0, ASN1_OCTET_STRING_cmp(header_nonce,
 403                                               fixture->cmp_ctx->senderNonce)))
 404         return 0;
 405     header_transactionID = OSSL_CMP_HDR_get0_transactionID(fixture->hdr);
 406     if (!TEST_true(0 == ASN1_OCTET_STRING_cmp(header_transactionID,
 407                                               fixture->cmp_ctx->transactionID)))
 408         return 0;
 409
 410     header_nonce = OSSL_CMP_HDR_get0_recipNonce(fixture->hdr);
 411     ctx_nonce = fixture->cmp_ctx->recipNonce;
 412     if (ctx_nonce != NULL
 413             && (!TEST_ptr(header_nonce)
 414                     || !TEST_int_eq(0, ASN1_OCTET_STRING_cmp(header_nonce,
 415                                                              ctx_nonce))))
 416         return 0;
 417
 418     return 1;
 419 }
 420
 421 static int test_HDR_init_with_ref(void)
 422 {
 423     unsigned char ref[CMP_TEST_REFVALUE_LENGTH];
 424
 425     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 426
 427     fixture->expected = 1;
 428     if (!TEST_int_eq(1, RAND_bytes(ref, sizeof(ref)))
 429             || !TEST_true(OSSL_CMP_CTX_set1_referenceValue(fixture->cmp_ctx,
 430                                                            ref, sizeof(ref)))) {
 431         tear_down(fixture);
 432         fixture = NULL;
 433     }
 434     EXECUTE_TEST(execute_HDR_init_test, tear_down);
 435     return result;
 436 }
 437
 438 static int test_HDR_init_with_subject(void)
 439 {
 440     X509_NAME *subject = NULL;
 441
 442     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 443     fixture->expected = 1;
 444     if (!TEST_ptr(subject = X509_NAME_new())
 445             || !TEST_true(X509_NAME_ADD(subject, "CN", "Common Name"))
 446             || !TEST_true(OSSL_CMP_CTX_set1_subjectName(fixture->cmp_ctx,
 447                                                         subject))) {
 448         tear_down(fixture);
 449         fixture = NULL;
 450     }
 451     X509_NAME_free(subject);
 452     EXECUTE_TEST(execute_HDR_init_test, tear_down);
 453     return result;
 454 }
 455
 456
 457 void cleanup_tests(void)
 458 {
 459     return;
 460 }
 461
 462 int setup_tests(void)
 463 {
 464     RAND_bytes(rand_data, OSSL_CMP_TRANSACTIONID_LENGTH);
 465     /* Message header tests */
 466     ADD_TEST(test_HDR_set_get_pvno);
 467     ADD_TEST(test_HDR_get0_senderNonce);
 468     ADD_TEST(test_HDR_set1_sender);
 469     ADD_TEST(test_HDR_set1_recipient);
 470     ADD_TEST(test_HDR_update_messageTime);
 471     ADD_TEST(test_HDR_set1_senderKID);
 472     ADD_TEST(test_HDR_push0_freeText);
 473     /* indirectly tests ossl_cmp_pkifreetext_push_str(): */
 474     ADD_TEST(test_HDR_push1_freeText);
 475     ADD_TEST(test_HDR_generalInfo_push0_item);
 476     ADD_TEST(test_HDR_generalInfo_push1_items);
 477     ADD_TEST(test_HDR_set_and_check_implicit_confirm);
 478     /* also tests public function OSSL_CMP_HDR_get0_transactionID(): */
 479     /* also tests public function OSSL_CMP_HDR_get0_recipNonce(): */
 480     /* also tests internal function ossl_cmp_hdr_get_pvno(): */
 481     ADD_TEST(test_HDR_init_with_ref);
 482     ADD_TEST(test_HDR_init_with_subject);
 483     /*
 484      *  TODO make sure that total number of tests (here currently 24) is shown,
 485      *  also for other cmp_*text.c. Currently the test drivers always show 1.
 486      */
 487
 488     return 1;
 489 }