2 * Copyright 2007-2021 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright Nokia 2007-2019
4 * Copyright Siemens AG 2015-2019
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
12 #include "helpers/cmp_testlib.h"
14 static unsigned char rand_data[OSSL_CMP_TRANSACTIONID_LENGTH];
16 typedef struct test_fixture {
17 const char *test_case_name;
19 OSSL_CMP_CTX *cmp_ctx;
20 OSSL_CMP_PKIHEADER *hdr;
22 } CMP_HDR_TEST_FIXTURE;
24 static void tear_down(CMP_HDR_TEST_FIXTURE *fixture)
26 OSSL_CMP_PKIHEADER_free(fixture->hdr);
27 OSSL_CMP_CTX_free(fixture->cmp_ctx);
28 OPENSSL_free(fixture);
31 static CMP_HDR_TEST_FIXTURE *set_up(const char *const test_case_name)
33 CMP_HDR_TEST_FIXTURE *fixture;
35 if (!TEST_ptr(fixture = OPENSSL_zalloc(sizeof(*fixture))))
37 fixture->test_case_name = test_case_name;
38 if (!TEST_ptr(fixture->cmp_ctx = OSSL_CMP_CTX_new(NULL, NULL)))
40 if (!TEST_ptr(fixture->hdr = OSSL_CMP_PKIHEADER_new()))
49 static int execute_HDR_set_get_pvno_test(CMP_HDR_TEST_FIXTURE *fixture)
53 if (!TEST_int_eq(ossl_cmp_hdr_set_pvno(fixture->hdr, pvno), 1))
55 if (!TEST_int_eq(ossl_cmp_hdr_get_pvno(fixture->hdr), pvno))
60 static int test_HDR_set_get_pvno(void)
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);
68 #define X509_NAME_ADD(n, rd, s) \
69 X509_NAME_add_entry_by_txt((n), (rd), MBSTRING_ASC, (unsigned char *)(s), \
72 static int execute_HDR_get0_senderNonce_test(CMP_HDR_TEST_FIXTURE *fixture)
74 X509_NAME *sender = X509_NAME_new();
75 ASN1_OCTET_STRING *sn;
77 if (!TEST_ptr(sender))
80 X509_NAME_ADD(sender, "CN", "A common sender name");
81 if (!TEST_int_eq(OSSL_CMP_CTX_set1_subjectName(fixture->cmp_ctx, sender),
84 if (!TEST_int_eq(ossl_cmp_hdr_init(fixture->cmp_ctx, fixture->hdr),
87 sn = ossl_cmp_hdr_get0_senderNonce(fixture->hdr);
88 if (!TEST_int_eq(ASN1_OCTET_STRING_cmp(fixture->cmp_ctx->senderNonce, sn),
91 X509_NAME_free(sender);
95 static int test_HDR_get0_senderNonce(void)
97 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
98 fixture->expected = 1;
99 EXECUTE_TEST(execute_HDR_get0_senderNonce_test, tear_down);
103 static int execute_HDR_set1_sender_test(CMP_HDR_TEST_FIXTURE *fixture)
105 X509_NAME *x509name = X509_NAME_new();
107 if (!TEST_ptr(x509name))
110 X509_NAME_ADD(x509name, "CN", "A common sender name");
111 if (!TEST_int_eq(ossl_cmp_hdr_set1_sender(fixture->hdr, x509name), 1))
113 if (!TEST_int_eq(fixture->hdr->sender->type, GEN_DIRNAME))
116 if (!TEST_int_eq(X509_NAME_cmp(fixture->hdr->sender->d.directoryName,
120 X509_NAME_free(x509name);
124 static int test_HDR_set1_sender(void)
126 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
127 fixture->expected = 1;
128 EXECUTE_TEST(execute_HDR_set1_sender_test, tear_down);
132 static int execute_HDR_set1_recipient_test(CMP_HDR_TEST_FIXTURE *fixture)
134 X509_NAME *x509name = X509_NAME_new();
136 if (!TEST_ptr(x509name))
139 X509_NAME_ADD(x509name, "CN", "A common recipient name");
140 if (!TEST_int_eq(ossl_cmp_hdr_set1_recipient(fixture->hdr, x509name), 1))
143 if (!TEST_int_eq(fixture->hdr->recipient->type, GEN_DIRNAME))
146 if (!TEST_int_eq(X509_NAME_cmp(fixture->hdr->recipient->d.directoryName,
150 X509_NAME_free(x509name);
154 static int test_HDR_set1_recipient(void)
156 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
157 fixture->expected = 1;
158 EXECUTE_TEST(execute_HDR_set1_recipient_test, tear_down);
162 static int execute_HDR_update_messageTime_test(CMP_HDR_TEST_FIXTURE *fixture)
164 struct tm hdrtm, tmptm;
165 time_t hdrtime, before, after, now;
169 * Trial and error reveals that passing the return value from gmtime
170 * directly to mktime in a mingw 32 bit build gives unexpected results. To
171 * work around this we take a copy of the return value first.
173 tmptm = *gmtime(&now);
174 before = mktime(&tmptm);
176 if (!TEST_true(ossl_cmp_hdr_update_messageTime(fixture->hdr)))
178 if (!TEST_true(ASN1_TIME_to_tm(fixture->hdr->messageTime, &hdrtm)))
181 hdrtime = mktime(&hdrtm);
183 if (!TEST_time_t_le(before, hdrtime))
186 tmptm = *gmtime(&now);
187 after = mktime(&tmptm);
189 return TEST_time_t_le(hdrtime, after);
192 static int test_HDR_update_messageTime(void)
194 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
195 fixture->expected = 1;
196 EXECUTE_TEST(execute_HDR_update_messageTime_test, tear_down);
200 static int execute_HDR_set1_senderKID_test(CMP_HDR_TEST_FIXTURE *fixture)
202 ASN1_OCTET_STRING *senderKID = ASN1_OCTET_STRING_new();
205 if (!TEST_ptr(senderKID))
208 if (!TEST_int_eq(ASN1_OCTET_STRING_set(senderKID, rand_data,
209 sizeof(rand_data)), 1))
211 if (!TEST_int_eq(ossl_cmp_hdr_set1_senderKID(fixture->hdr, senderKID), 1))
213 if (!TEST_int_eq(ASN1_OCTET_STRING_cmp(fixture->hdr->senderKID,
218 ASN1_OCTET_STRING_free(senderKID);
222 static int test_HDR_set1_senderKID(void)
224 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
225 fixture->expected = 1;
226 EXECUTE_TEST(execute_HDR_set1_senderKID_test, tear_down);
230 static int execute_HDR_push0_freeText_test(CMP_HDR_TEST_FIXTURE *fixture)
232 ASN1_UTF8STRING *text = ASN1_UTF8STRING_new();
237 if (!ASN1_STRING_set(text, "A free text", -1))
240 if (!TEST_int_eq(ossl_cmp_hdr_push0_freeText(fixture->hdr, text), 1))
243 if (!TEST_true(text == sk_ASN1_UTF8STRING_value(fixture->hdr->freeText, 0)))
249 ASN1_UTF8STRING_free(text);
253 static int test_HDR_push0_freeText(void)
255 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
256 fixture->expected = 1;
257 EXECUTE_TEST(execute_HDR_push0_freeText_test, tear_down);
261 static int execute_HDR_push1_freeText_test(CMP_HDR_TEST_FIXTURE *fixture)
263 ASN1_UTF8STRING *text = ASN1_UTF8STRING_new();
264 ASN1_UTF8STRING *pushed_text;
270 if (!ASN1_STRING_set(text, "A free text", -1))
273 if (!TEST_int_eq(ossl_cmp_hdr_push1_freeText(fixture->hdr, text), 1))
276 pushed_text = sk_ASN1_UTF8STRING_value(fixture->hdr->freeText, 0);
277 if (!TEST_int_eq(ASN1_STRING_cmp(text, pushed_text), 0))
282 ASN1_UTF8STRING_free(text);
286 static int test_HDR_push1_freeText(void)
288 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
289 fixture->expected = 1;
290 EXECUTE_TEST(execute_HDR_push1_freeText_test, tear_down);
295 execute_HDR_generalInfo_push0_item_test(CMP_HDR_TEST_FIXTURE *fixture)
297 OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_new();
302 if (!TEST_int_eq(ossl_cmp_hdr_generalInfo_push0_item(fixture->hdr, itav),
306 if (!TEST_true(itav == sk_OSSL_CMP_ITAV_value(fixture->hdr->generalInfo,
313 static int test_HDR_generalInfo_push0_item(void)
315 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
316 fixture->expected = 1;
317 EXECUTE_TEST(execute_HDR_generalInfo_push0_item_test, tear_down);
322 execute_HDR_generalInfo_push1_items_test(CMP_HDR_TEST_FIXTURE *fixture)
324 const char oid[] = "1.2.3.4";
326 OSSL_CMP_ITAV *itav, *pushed_itav;
327 STACK_OF(OSSL_CMP_ITAV) *itavs = NULL, *ginfo;
328 ASN1_INTEGER *asn1int = ASN1_INTEGER_new();
329 ASN1_TYPE *val = ASN1_TYPE_new();
330 ASN1_TYPE *pushed_val;
333 if (!TEST_ptr(asn1int))
336 if (!TEST_ptr(val)) {
337 ASN1_INTEGER_free(asn1int);
341 ASN1_INTEGER_set(asn1int, 88);
342 ASN1_TYPE_set(val, V_ASN1_INTEGER, asn1int);
343 if (!TEST_ptr(itav = OSSL_CMP_ITAV_create(OBJ_txt2obj(oid, 1), val))) {
347 if (!TEST_true(OSSL_CMP_ITAV_push0_stack_item(&itavs, itav))) {
348 OSSL_CMP_ITAV_free(itav);
352 if (!TEST_int_eq(ossl_cmp_hdr_generalInfo_push1_items(fixture->hdr, itavs),
355 ginfo = fixture->hdr->generalInfo;
356 pushed_itav = sk_OSSL_CMP_ITAV_value(ginfo, 0);
357 OBJ_obj2txt(buf, sizeof(buf), OSSL_CMP_ITAV_get0_type(pushed_itav), 0);
358 if (!TEST_int_eq(memcmp(oid, buf, sizeof(oid)), 0))
361 pushed_val = OSSL_CMP_ITAV_get0_value(sk_OSSL_CMP_ITAV_value(ginfo, 0));
362 if (!TEST_int_eq(ASN1_TYPE_cmp(itav->infoValue.other, pushed_val), 0))
368 sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
372 static int test_HDR_generalInfo_push1_items(void)
374 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
375 fixture->expected = 1;
376 EXECUTE_TEST(execute_HDR_generalInfo_push1_items_test, tear_down);
381 execute_HDR_set_and_check_implicitConfirm_test(CMP_HDR_TEST_FIXTURE
384 return TEST_false(ossl_cmp_hdr_has_implicitConfirm(fixture->hdr))
385 && TEST_true(ossl_cmp_hdr_set_implicitConfirm(fixture->hdr))
386 && TEST_true(ossl_cmp_hdr_has_implicitConfirm(fixture->hdr));
389 static int test_HDR_set_and_check_implicit_confirm(void)
391 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
392 EXECUTE_TEST(execute_HDR_set_and_check_implicitConfirm_test, tear_down);
396 static int execute_HDR_init_test(CMP_HDR_TEST_FIXTURE *fixture)
398 ASN1_OCTET_STRING *header_nonce, *header_transactionID;
399 ASN1_OCTET_STRING *ctx_nonce;
401 if (!TEST_int_eq(fixture->expected,
402 ossl_cmp_hdr_init(fixture->cmp_ctx, fixture->hdr)))
404 if (fixture->expected == 0)
407 if (!TEST_int_eq(ossl_cmp_hdr_get_pvno(fixture->hdr), OSSL_CMP_PVNO))
410 header_nonce = ossl_cmp_hdr_get0_senderNonce(fixture->hdr);
411 if (!TEST_int_eq(0, ASN1_OCTET_STRING_cmp(header_nonce,
412 fixture->cmp_ctx->senderNonce)))
414 header_transactionID = OSSL_CMP_HDR_get0_transactionID(fixture->hdr);
415 if (!TEST_true(ASN1_OCTET_STRING_cmp(header_transactionID,
416 fixture->cmp_ctx->transactionID) == 0))
419 header_nonce = OSSL_CMP_HDR_get0_recipNonce(fixture->hdr);
420 ctx_nonce = fixture->cmp_ctx->recipNonce;
421 if (ctx_nonce != NULL
422 && (!TEST_ptr(header_nonce)
423 || !TEST_int_eq(0, ASN1_OCTET_STRING_cmp(header_nonce,
430 static int test_HDR_init_with_ref(void)
432 unsigned char ref[CMP_TEST_REFVALUE_LENGTH];
434 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
436 fixture->expected = 1;
437 if (!TEST_int_eq(1, RAND_bytes(ref, sizeof(ref)))
438 || !TEST_true(OSSL_CMP_CTX_set1_referenceValue(fixture->cmp_ctx,
439 ref, sizeof(ref)))) {
443 EXECUTE_TEST(execute_HDR_init_test, tear_down);
447 static int test_HDR_init_with_subject(void)
449 X509_NAME *subject = NULL;
451 SETUP_TEST_FIXTURE(CMP_HDR_TEST_FIXTURE, set_up);
452 fixture->expected = 1;
453 if (!TEST_ptr(subject = X509_NAME_new())
454 || !TEST_true(X509_NAME_ADD(subject, "CN", "Common Name"))
455 || !TEST_true(OSSL_CMP_CTX_set1_subjectName(fixture->cmp_ctx,
460 X509_NAME_free(subject);
461 EXECUTE_TEST(execute_HDR_init_test, tear_down);
465 void cleanup_tests(void)
470 int setup_tests(void)
472 RAND_bytes(rand_data, OSSL_CMP_TRANSACTIONID_LENGTH);
473 /* Message header tests */
474 ADD_TEST(test_HDR_set_get_pvno);
475 ADD_TEST(test_HDR_get0_senderNonce);
476 ADD_TEST(test_HDR_set1_sender);
477 ADD_TEST(test_HDR_set1_recipient);
478 ADD_TEST(test_HDR_update_messageTime);
479 ADD_TEST(test_HDR_set1_senderKID);
480 ADD_TEST(test_HDR_push0_freeText);
481 /* indirectly tests ossl_cmp_pkifreetext_push_str(): */
482 ADD_TEST(test_HDR_push1_freeText);
483 ADD_TEST(test_HDR_generalInfo_push0_item);
484 ADD_TEST(test_HDR_generalInfo_push1_items);
485 ADD_TEST(test_HDR_set_and_check_implicit_confirm);
486 /* also tests public function OSSL_CMP_HDR_get0_transactionID(): */
487 /* also tests public function OSSL_CMP_HDR_get0_recipNonce(): */
488 /* also tests internal function ossl_cmp_hdr_get_pvno(): */
489 ADD_TEST(test_HDR_init_with_ref);
490 ADD_TEST(test_HDR_init_with_subject);