test/cmp_hdr_test.c

   1 /*
   2  * Copyright 2007-2019 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 "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()))
  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) X509_NAME_add_entry_by_txt((n), (rd),          \
  69                                 MBSTRING_ASC, (unsigned char *)(s), -1, -1, 0)
  70
  71 static int execute_HDR_get0_senderNonce_test(CMP_HDR_TEST_FIXTURE *fixture)
  72 {
  73     X509_NAME *sender = X509_NAME_new();
  74     ASN1_OCTET_STRING *sn;
  75
  76     if (!TEST_ptr(sender))
  77         return 0;
  78
  79     X509_NAME_ADD(sender, "CN", "A common sender name");
  80     if (!TEST_int_eq(OSSL_CMP_CTX_set1_subjectName(fixture->cmp_ctx, sender),
  81                      1))
  82         return 0;
  83     if (!TEST_int_eq(ossl_cmp_hdr_init(fixture->cmp_ctx, fixture->hdr),
  84                      1))
  85         return 0;
  86     sn = ossl_cmp_hdr_get0_senderNonce(fixture->hdr);
  87     if (!TEST_int_eq(ASN1_OCTET_STRING_cmp(fixture->cmp_ctx->senderNonce, sn),
  88                      0))
  89         return 0;
  90     X509_NAME_free(sender);
  91     return 1;
  92 }
  93
  94 static int test_HDR_get0_senderNonce(void)
  95 {
  96     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
  97     fixture->expected = 1;
  98     EXECUTE_TEST(execute_HDR_get0_senderNonce_test, tear_down);
  99     return result;
 100 }
 101
 102 static int execute_HDR_set1_sender_test(CMP_HDR_TEST_FIXTURE *fixture)
 103 {
 104     X509_NAME *x509name = X509_NAME_new();
 105
 106     if (!TEST_ptr(x509name))
 107         return 0;
 108
 109     X509_NAME_ADD(x509name, "CN", "A common sender name");
 110     if (!TEST_int_eq(ossl_cmp_hdr_set1_sender(fixture->hdr, x509name), 1))
 111         return 0;
 112     if (!TEST_int_eq(fixture->hdr->sender->type, GEN_DIRNAME))
 113         return 0;
 114
 115     if (!TEST_int_eq(
 116             X509_NAME_cmp(fixture->hdr->sender->d.directoryName, x509name), 0))
 117         return 0;
 118
 119     X509_NAME_free(x509name);
 120     return 1;
 121 }
 122
 123 static int test_HDR_set1_sender(void)
 124 {
 125     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 126     fixture->expected = 1;
 127     EXECUTE_TEST(execute_HDR_set1_sender_test, tear_down);
 128     return result;
 129 }
 130
 131 static int execute_HDR_set1_recipient_test(CMP_HDR_TEST_FIXTURE *fixture)
 132 {
 133     X509_NAME *x509name = X509_NAME_new();
 134
 135     if (!TEST_ptr(x509name))
 136         return 0;
 137
 138     X509_NAME_ADD(x509name, "CN", "A common recipient name");
 139     if (!TEST_int_eq(ossl_cmp_hdr_set1_recipient(fixture->hdr, x509name), 1))
 140         return 0;
 141
 142     if (!TEST_int_eq(fixture->hdr->recipient->type, GEN_DIRNAME))
 143         return 0;
 144
 145     if (!TEST_int_eq(
 146             X509_NAME_cmp(fixture->hdr->recipient->d.directoryName, x509name),0))
 147         return 0;
 148
 149     X509_NAME_free(x509name);
 150     return 1;
 151 }
 152
 153 static int test_HDR_set1_recipient(void)
 154 {
 155     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 156     fixture->expected = 1;
 157     EXECUTE_TEST(execute_HDR_set1_recipient_test, tear_down);
 158     return result;
 159 }
 160
 161 static int execute_HDR_update_messageTime_test(CMP_HDR_TEST_FIXTURE *fixture)
 162 {
 163     struct tm hdrtm;
 164     time_t hdrtime, before, after, now;
 165
 166     now = time(NULL);
 167     before = mktime(gmtime(&now));
 168     if (!TEST_true(ossl_cmp_hdr_update_messageTime(fixture->hdr)))
 169         return 0;
 170     if (!TEST_true(ASN1_TIME_to_tm(fixture->hdr->messageTime, &hdrtm)))
 171         return 0;
 172
 173     hdrtime = mktime(&hdrtm);
 174     if (!TEST_true(before <= hdrtime))
 175         return 0;
 176     now = time(NULL);
 177     after = mktime(gmtime(&now));
 178     return TEST_true(hdrtime <= after);
 179 }
 180
 181 static int test_HDR_update_messageTime(void)
 182 {
 183     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 184     fixture->expected = 1;
 185     EXECUTE_TEST(execute_HDR_update_messageTime_test, tear_down);
 186     return result;
 187 }
 188
 189 static int execute_HDR_set1_senderKID_test(CMP_HDR_TEST_FIXTURE *fixture)
 190 {
 191     ASN1_OCTET_STRING* senderKID = ASN1_OCTET_STRING_new();
 192
 193     if (!TEST_ptr(senderKID))
 194         return 0;
 195
 196     ASN1_OCTET_STRING_set(senderKID, rand_data, sizeof(rand_data));
 197     if (!TEST_int_eq(ossl_cmp_hdr_set1_senderKID(fixture->hdr, senderKID), 1))
 198         return 0;
 199     if (!TEST_int_eq(
 200             ASN1_OCTET_STRING_cmp(fixture->hdr->senderKID, senderKID), 0))
 201         return 0;
 202
 203     ASN1_OCTET_STRING_free(senderKID);
 204     return 1;
 205 }
 206
 207 static int test_HDR_set1_senderKID(void)
 208 {
 209     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 210     fixture->expected = 1;
 211     EXECUTE_TEST(execute_HDR_set1_senderKID_test, tear_down);
 212     return result;
 213 }
 214
 215 static int execute_HDR_push0_freeText_test(CMP_HDR_TEST_FIXTURE *fixture)
 216 {
 217     ASN1_UTF8STRING* text = ASN1_UTF8STRING_new();
 218
 219     if (!TEST_ptr(text))
 220         return 0;
 221
 222     if (!ASN1_STRING_set(text, "A free text", -1))
 223         return 0;
 224
 225     if (!TEST_int_eq(
 226             ossl_cmp_hdr_push0_freeText(fixture->hdr, text), 1))
 227         return 0;
 228     if (!TEST_true(text == sk_ASN1_UTF8STRING_value(
 229             fixture->hdr->freeText, 0)))
 230         return 0;
 231
 232     return 1;
 233 }
 234
 235 static int test_HDR_push0_freeText(void)
 236 {
 237     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 238     fixture->expected = 1;
 239     EXECUTE_TEST(execute_HDR_push0_freeText_test, tear_down);
 240     return result;
 241 }
 242
 243 static int execute_HDR_push1_freeText_test(CMP_HDR_TEST_FIXTURE *fixture)
 244 {
 245     ASN1_UTF8STRING* text = ASN1_UTF8STRING_new();
 246
 247     if (!TEST_ptr(text))
 248         return 0;
 249
 250     if (!ASN1_STRING_set(text, "A free text", -1))
 251         return 0;
 252
 253     if (!TEST_int_eq(
 254             ossl_cmp_hdr_push1_freeText(fixture->hdr, text), 1))
 255         return 0;
 256     if (!TEST_int_eq(ASN1_STRING_cmp(
 257             sk_ASN1_UTF8STRING_value(fixture->hdr->freeText, 0), text), 0))
 258         return 0;
 259
 260     ASN1_UTF8STRING_free(text);
 261     return 1;
 262 }
 263
 264 static int test_HDR_push1_freeText(void)
 265 {
 266     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 267     fixture->expected = 1;
 268     EXECUTE_TEST(execute_HDR_push1_freeText_test, tear_down);
 269     return result;
 270 }
 271
 272 static int
 273 execute_HDR_generalInfo_push0_item_test(CMP_HDR_TEST_FIXTURE *fixture)
 274 {
 275     OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_new();
 276
 277     if (!TEST_ptr(itav))
 278         return 0;
 279
 280     if (!TEST_int_eq(
 281             ossl_cmp_hdr_generalInfo_push0_item(fixture->hdr, itav), 1))
 282         return 0;
 283     if (!TEST_true(itav == sk_OSSL_CMP_ITAV_value(
 284             fixture->hdr->generalInfo, 0)))
 285         return 0;
 286
 287     return 1;
 288 }
 289
 290 static int test_HDR_generalInfo_push0_item(void)
 291 {
 292     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 293     fixture->expected = 1;
 294     EXECUTE_TEST(execute_HDR_generalInfo_push0_item_test, tear_down);
 295     return result;
 296 }
 297
 298 static int
 299 execute_HDR_generalInfo_push1_items_test(CMP_HDR_TEST_FIXTURE *fixture)
 300 {
 301     const char oid[] = "1.2.3.4";
 302     char buf[20];
 303     OSSL_CMP_ITAV *itav;
 304     STACK_OF(OSSL_CMP_ITAV) *itavs = NULL;
 305     ASN1_INTEGER *asn1int = ASN1_INTEGER_new();
 306     ASN1_TYPE *val = ASN1_TYPE_new();
 307
 308     if (!TEST_ptr(asn1int))
 309         return 0;
 310
 311     if (!TEST_ptr(val))
 312         return 0;
 313
 314     ASN1_INTEGER_set(asn1int, 88);
 315     ASN1_TYPE_set(val, V_ASN1_INTEGER, asn1int);
 316     itav = OSSL_CMP_ITAV_create(OBJ_txt2obj(oid, 1), val);
 317     OSSL_CMP_ITAV_push0_stack_item(&itavs, itav);
 318
 319     if (!TEST_int_eq(
 320         ossl_cmp_hdr_generalInfo_push1_items(fixture->hdr, itavs), 1))
 321         return 0;
 322     OBJ_obj2txt(buf, sizeof(buf), OSSL_CMP_ITAV_get0_type(
 323             sk_OSSL_CMP_ITAV_value(fixture->hdr->generalInfo, 0)), 0);
 324     if (!TEST_int_eq(memcmp(oid, buf, sizeof(oid)), 0))
 325         return 0;
 326
 327     if (!TEST_int_eq(ASN1_TYPE_cmp(itav->infoValue.other,
 328                                    OSSL_CMP_ITAV_get0_value(
 329             sk_OSSL_CMP_ITAV_value(fixture->hdr->generalInfo, 0))), 0))
 330         return 0;
 331
 332     sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
 333     return 1;
 334 }
 335
 336 static int test_HDR_generalInfo_push1_items(void)
 337 {
 338     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 339     fixture->expected = 1;
 340     EXECUTE_TEST(execute_HDR_generalInfo_push1_items_test, tear_down);
 341     return result;
 342 }
 343
 344 static int
 345 execute_HDR_set_and_check_implicitConfirm_test(CMP_HDR_TEST_FIXTURE
 346                                                * fixture)
 347 {
 348     return TEST_false(ossl_cmp_hdr_check_implicitConfirm(fixture->hdr))
 349         && TEST_true(ossl_cmp_hdr_set_implicitConfirm(fixture->hdr))
 350         && TEST_true(ossl_cmp_hdr_check_implicitConfirm(fixture->hdr));
 351 }
 352
 353 static int test_HDR_set_and_check_implicit_confirm(void)
 354 {
 355     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 356     EXECUTE_TEST(execute_HDR_set_and_check_implicitConfirm_test, tear_down);
 357     return result;
 358 }
 359
 360
 361 static int execute_HDR_init_test(CMP_HDR_TEST_FIXTURE *fixture)
 362 {
 363     ASN1_OCTET_STRING *header_nonce = NULL;
 364     ASN1_OCTET_STRING *ctx_nonce = NULL;
 365     int res = 0;
 366
 367     if (!TEST_int_eq(fixture->expected,
 368                      ossl_cmp_hdr_init(fixture->cmp_ctx, fixture->hdr)))
 369         goto err;
 370     if (fixture->expected != 0) {
 371         if (!TEST_int_eq(ossl_cmp_hdr_get_pvno(fixture->hdr), OSSL_CMP_PVNO)
 372                 || !TEST_true(0 == ASN1_OCTET_STRING_cmp(
 373                         ossl_cmp_hdr_get0_senderNonce(fixture->hdr),
 374                         fixture->cmp_ctx->senderNonce))
 375                 || !TEST_true(0 ==  ASN1_OCTET_STRING_cmp(
 376                             OSSL_CMP_HDR_get0_transactionID(fixture->hdr),
 377                             fixture->cmp_ctx->transactionID)))
 378             goto err;
 379         header_nonce = OSSL_CMP_HDR_get0_recipNonce(fixture->hdr);
 380         ctx_nonce = fixture->cmp_ctx->recipNonce;
 381         if (ctx_nonce != NULL
 382                 && (!TEST_ptr(header_nonce)
 383                 || !TEST_int_eq(0, ASN1_OCTET_STRING_cmp(header_nonce,
 384                                                          ctx_nonce))))
 385             goto err;
 386     }
 387
 388     res = 1;
 389
 390  err:
 391     return res;
 392 }
 393
 394 static int test_HDR_init(void)
 395 {
 396     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 397     unsigned char ref[CMP_TEST_REFVALUE_LENGTH];
 398
 399     fixture->expected = 1;
 400     if (!TEST_int_eq(1, RAND_bytes(ref, sizeof(ref)))
 401             || !TEST_true(OSSL_CMP_CTX_set1_referenceValue(fixture->cmp_ctx,
 402                                                            ref, sizeof(ref)))) {
 403         tear_down(fixture);
 404         fixture = NULL;
 405     }
 406     EXECUTE_TEST(execute_HDR_init_test, tear_down);
 407     return result;
 408 }
 409
 410 static int test_HDR_init_with_subject(void)
 411 {
 412     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 413     X509_NAME *subject = NULL;
 414
 415     fixture->expected = 1;
 416     if (!TEST_ptr(subject = X509_NAME_new())
 417         || !TEST_true(X509_NAME_ADD(subject, "CN", "Common Name"))
 418         || !TEST_true(OSSL_CMP_CTX_set1_subjectName(fixture->cmp_ctx,
 419                                                     subject))) {
 420         tear_down(fixture);
 421         fixture = NULL;
 422     }
 423     X509_NAME_free(subject);
 424     EXECUTE_TEST(execute_HDR_init_test, tear_down);
 425     return result;
 426 }
 427
 428 static int test_HDR_init_no_ref_no_subject(void)
 429 {
 430     SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
 431     fixture->expected = 0;
 432     EXECUTE_TEST(execute_HDR_init_test, tear_down);
 433     return result;
 434 }
 435
 436
 437 void cleanup_tests(void)
 438 {
 439     return;
 440 }
 441
 442 int setup_tests(void)
 443 {
 444     RAND_bytes(rand_data, OSSL_CMP_TRANSACTIONID_LENGTH);
 445     /* Message header tests */
 446     ADD_TEST(test_HDR_set_get_pvno);
 447     ADD_TEST(test_HDR_get0_senderNonce);
 448     ADD_TEST(test_HDR_set1_sender);
 449     ADD_TEST(test_HDR_set1_recipient);
 450     ADD_TEST(test_HDR_update_messageTime);
 451     ADD_TEST(test_HDR_set1_senderKID);
 452     ADD_TEST(test_HDR_push0_freeText);
 453     /* indirectly tests ossl_cmp_pkifreetext_push_str(): */
 454     ADD_TEST(test_HDR_push1_freeText);
 455     ADD_TEST(test_HDR_generalInfo_push0_item);
 456     ADD_TEST(test_HDR_generalInfo_push1_items);
 457     ADD_TEST(test_HDR_set_and_check_implicit_confirm);
 458     /* also tests public function OSSL_CMP_HDR_get0_transactionID(): */
 459     /* also tests public function OSSL_CMP_HDR_get0_recipNonce(): */
 460     /* also tests internal function ossl_cmp_hdr_get_pvno(): */
 461     ADD_TEST(test_HDR_init);
 462     ADD_TEST(test_HDR_init_with_subject);
 463     ADD_TEST(test_HDR_init_no_ref_no_subject);
 464     /* TODO make sure that total number of tests (here currently 24) is shown,
 465      also for other cmp_*text.c. Currently the test drivers always show 1. */
 466
 467     return 1;
 468 }