2 * Copyright 2007-2022 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 #include "cmp_mock_srv.h"
16 static const char *server_key_f;
17 static const char *server_cert_f;
18 static const char *client_key_f;
19 static const char *client_cert_f;
20 static const char *pkcs10_f;
22 typedef struct test_fixture {
23 const char *test_case_name;
24 OSSL_CMP_CTX *cmp_ctx;
25 OSSL_CMP_SRV_CTX *srv_ctx;
28 STACK_OF(X509) *caPubs;
29 } CMP_SES_TEST_FIXTURE;
31 static OSSL_LIB_CTX *libctx = NULL;
32 static OSSL_PROVIDER *default_null_provider = NULL, *provider = NULL;
34 static EVP_PKEY *server_key = NULL;
35 static X509 *server_cert = NULL;
36 static EVP_PKEY *client_key = NULL;
37 static X509 *client_cert = NULL;
38 static unsigned char ref[CMP_TEST_REFVALUE_LENGTH];
41 * For these unit tests, the client abandons message protection, and for
42 * error messages the mock server does so as well.
43 * Message protection and verification is tested in cmp_lib_test.c
46 static void tear_down(CMP_SES_TEST_FIXTURE *fixture)
48 OSSL_CMP_CTX_free(fixture->cmp_ctx);
49 ossl_cmp_mock_srv_free(fixture->srv_ctx);
50 sk_X509_free(fixture->caPubs);
51 OPENSSL_free(fixture);
54 static CMP_SES_TEST_FIXTURE *set_up(const char *const test_case_name)
56 CMP_SES_TEST_FIXTURE *fixture;
57 OSSL_CMP_CTX *srv_cmp_ctx = NULL;
58 OSSL_CMP_CTX *ctx = NULL; /* for client */
60 if (!TEST_ptr(fixture = OPENSSL_zalloc(sizeof(*fixture))))
62 fixture->test_case_name = test_case_name;
63 if (!TEST_ptr(fixture->srv_ctx = ossl_cmp_mock_srv_new(libctx, NULL))
64 || !OSSL_CMP_SRV_CTX_set_accept_unprotected(fixture->srv_ctx, 1)
65 || !ossl_cmp_mock_srv_set1_refCert(fixture->srv_ctx, client_cert)
66 || !ossl_cmp_mock_srv_set1_certOut(fixture->srv_ctx, client_cert)
68 OSSL_CMP_SRV_CTX_get0_cmp_ctx(fixture->srv_ctx)) == NULL
69 || !OSSL_CMP_CTX_set1_cert(srv_cmp_ctx, server_cert)
70 || !OSSL_CMP_CTX_set1_pkey(srv_cmp_ctx, server_key))
72 if (!TEST_ptr(fixture->cmp_ctx = ctx = OSSL_CMP_CTX_new(libctx, NULL))
73 || !OSSL_CMP_CTX_set_log_cb(fixture->cmp_ctx, print_to_bio_out)
74 || !OSSL_CMP_CTX_set_transfer_cb(ctx, OSSL_CMP_CTX_server_perform)
75 || !OSSL_CMP_CTX_set_transfer_cb_arg(ctx, fixture->srv_ctx)
76 || !OSSL_CMP_CTX_set_option(ctx, OSSL_CMP_OPT_UNPROTECTED_SEND, 1)
77 || !OSSL_CMP_CTX_set_option(ctx, OSSL_CMP_OPT_UNPROTECTED_ERRORS, 1)
78 || !OSSL_CMP_CTX_set1_oldCert(ctx, client_cert)
79 || !OSSL_CMP_CTX_set1_pkey(ctx, client_key)
80 || !OSSL_CMP_CTX_set1_srvCert(ctx, server_cert)
81 || !OSSL_CMP_CTX_set1_referenceValue(ctx, ref, sizeof(ref)))
83 fixture->req_type = -1;
91 static int execute_exec_RR_ses_test(CMP_SES_TEST_FIXTURE *fixt)
93 return TEST_int_eq(OSSL_CMP_CTX_get_status(fixt->cmp_ctx),
94 OSSL_CMP_PKISTATUS_unspecified)
95 && TEST_int_eq(OSSL_CMP_exec_RR_ses(fixt->cmp_ctx),
96 fixt->expected == OSSL_CMP_PKISTATUS_accepted)
97 && TEST_int_eq(OSSL_CMP_CTX_get_status(fixt->cmp_ctx), fixt->expected);
100 static int execute_exec_GENM_ses_test_single(CMP_SES_TEST_FIXTURE *fixture)
102 OSSL_CMP_CTX *ctx = fixture->cmp_ctx;
103 ASN1_OBJECT *type = OBJ_txt2obj("1.3.6.1.5.5.7.4.2", 1);
104 OSSL_CMP_ITAV *itav = OSSL_CMP_ITAV_create(type, NULL);
105 STACK_OF(OSSL_CMP_ITAV) *itavs;
107 OSSL_CMP_CTX_push0_genm_ITAV(ctx, itav);
108 itavs = OSSL_CMP_exec_GENM_ses(ctx);
110 sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
111 return TEST_int_eq(OSSL_CMP_CTX_get_status(ctx), fixture->expected)
112 && fixture->expected == OSSL_CMP_PKISTATUS_accepted ?
113 TEST_ptr(itavs) : TEST_ptr_null(itavs);
116 static int execute_exec_GENM_ses_test(CMP_SES_TEST_FIXTURE *fixture)
118 return execute_exec_GENM_ses_test_single(fixture)
119 && OSSL_CMP_CTX_reinit(fixture->cmp_ctx)
120 && execute_exec_GENM_ses_test_single(fixture);
123 static int execute_exec_certrequest_ses_test(CMP_SES_TEST_FIXTURE *fixture)
125 OSSL_CMP_CTX *ctx = fixture->cmp_ctx;
126 X509 *res = OSSL_CMP_exec_certreq(ctx, fixture->req_type, NULL);
127 int status = OSSL_CMP_CTX_get_status(ctx);
129 OSSL_CMP_CTX_print_errors(ctx);
130 if (!TEST_int_eq(status, fixture->expected)
131 && !(fixture->expected == OSSL_CMP_PKISTATUS_waiting
132 && TEST_int_eq(status, OSSL_CMP_PKISTATUS_trans)))
134 if (fixture->expected != OSSL_CMP_PKISTATUS_accepted)
135 return TEST_ptr_null(res);
137 if (!TEST_ptr(res) || !TEST_int_eq(X509_cmp(res, client_cert), 0))
139 if (fixture->caPubs != NULL) {
140 STACK_OF(X509) *caPubs = OSSL_CMP_CTX_get1_caPubs(fixture->cmp_ctx);
141 int ret = TEST_int_eq(STACK_OF_X509_cmp(fixture->caPubs, caPubs), 0);
143 OSSL_STACK_OF_X509_free(caPubs);
149 static int test_exec_RR_ses(int request_error)
151 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
153 OSSL_CMP_CTX_set1_oldCert(fixture->cmp_ctx, NULL);
154 fixture->expected = request_error ? OSSL_CMP_PKISTATUS_request
155 : OSSL_CMP_PKISTATUS_accepted;
156 EXECUTE_TEST(execute_exec_RR_ses_test, tear_down);
160 static int test_exec_RR_ses_ok(void)
162 return test_exec_RR_ses(0);
165 static int test_exec_RR_ses_request_error(void)
167 return test_exec_RR_ses(1);
170 static int test_exec_RR_ses_receive_error(void)
172 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
173 ossl_cmp_mock_srv_set_statusInfo(fixture->srv_ctx,
174 OSSL_CMP_PKISTATUS_rejection,
175 OSSL_CMP_CTX_FAILINFO_signerNotTrusted,
177 ossl_cmp_mock_srv_set_sendError(fixture->srv_ctx, OSSL_CMP_PKIBODY_RR);
178 fixture->expected = OSSL_CMP_PKISTATUS_rejection;
179 EXECUTE_TEST(execute_exec_RR_ses_test, tear_down);
183 static int test_exec_IR_ses(void)
185 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
186 fixture->req_type = OSSL_CMP_IR;
187 fixture->expected = OSSL_CMP_PKISTATUS_accepted;
188 fixture->caPubs = sk_X509_new_null();
189 sk_X509_push(fixture->caPubs, server_cert);
190 sk_X509_push(fixture->caPubs, server_cert);
191 ossl_cmp_mock_srv_set1_caPubsOut(fixture->srv_ctx, fixture->caPubs);
192 EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
196 static int test_exec_IR_ses_poll(int check_after, int poll_count,
197 int total_timeout, int expect)
199 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
200 fixture->req_type = OSSL_CMP_IR;
201 fixture->expected = expect;
202 ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, check_after);
203 ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, poll_count);
204 OSSL_CMP_CTX_set_option(fixture->cmp_ctx,
205 OSSL_CMP_OPT_TOTAL_TIMEOUT, total_timeout);
206 EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
210 static int checkAfter = 1;
211 static int test_exec_IR_ses_poll_ok(void)
213 return test_exec_IR_ses_poll(checkAfter, 2, 0, OSSL_CMP_PKISTATUS_accepted);
216 static int test_exec_IR_ses_poll_no_timeout(void)
218 return test_exec_IR_ses_poll(checkAfter, 1 /* pollCount */, checkAfter + 1,
219 OSSL_CMP_PKISTATUS_accepted);
222 static int test_exec_IR_ses_poll_total_timeout(void)
224 return test_exec_IR_ses_poll(checkAfter + 1, 2 /* pollCount */, checkAfter,
225 OSSL_CMP_PKISTATUS_waiting);
228 static int test_exec_CR_ses(int implicit_confirm, int granted, int reject)
230 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
231 fixture->req_type = OSSL_CMP_CR;
232 OSSL_CMP_CTX_set_option(fixture->cmp_ctx,
233 OSSL_CMP_OPT_IMPLICIT_CONFIRM, implicit_confirm);
234 OSSL_CMP_SRV_CTX_set_grant_implicit_confirm(fixture->srv_ctx, granted);
235 ossl_cmp_mock_srv_set_sendError(fixture->srv_ctx,
236 reject ? OSSL_CMP_PKIBODY_CERTCONF : -1);
237 fixture->expected = reject ? OSSL_CMP_PKISTATUS_rejection
238 : OSSL_CMP_PKISTATUS_accepted;
239 EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
243 static int test_exec_CR_ses_explicit_confirm(void)
245 return test_exec_CR_ses(0, 0, 0)
246 && test_exec_CR_ses(0, 0, 1 /* reject */);
249 static int test_exec_CR_ses_implicit_confirm(void)
251 return test_exec_CR_ses(1, 0, 0)
252 && test_exec_CR_ses(1, 1 /* granted */, 0);
255 static int test_exec_KUR_ses(int transfer_error)
257 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
258 fixture->req_type = OSSL_CMP_KUR;
260 OSSL_CMP_CTX_set_transfer_cb_arg(fixture->cmp_ctx, NULL);
261 fixture->expected = transfer_error ? OSSL_CMP_PKISTATUS_trans
262 : OSSL_CMP_PKISTATUS_accepted;
263 EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
267 static int test_exec_KUR_ses_ok(void)
269 return test_exec_KUR_ses(0);
272 static int test_exec_KUR_ses_transfer_error(void)
274 return test_exec_KUR_ses(1);
277 static int test_certConf_cb(OSSL_CMP_CTX *ctx, X509 *cert, int fail_info,
280 int *reject = OSSL_CMP_CTX_get_certConf_cb_arg(ctx);
283 *txt = "not to my taste";
284 fail_info = OSSL_CMP_PKIFAILUREINFO_badCertTemplate;
289 static int test_exec_P10CR_ses(int reject)
292 X509_REQ *csr = NULL;
294 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
295 fixture->req_type = OSSL_CMP_P10CR;
296 fixture->expected = reject ? OSSL_CMP_PKISTATUS_rejection
297 : OSSL_CMP_PKISTATUS_accepted;
298 ctx = fixture->cmp_ctx;
299 if (!TEST_ptr(csr = load_csr_der(pkcs10_f, libctx))
300 || !TEST_true(OSSL_CMP_CTX_set1_p10CSR(ctx, csr))
301 || !TEST_true(OSSL_CMP_CTX_set_certConf_cb(ctx, test_certConf_cb))
302 || !TEST_true(OSSL_CMP_CTX_set_certConf_cb_arg(ctx, &reject))) {
307 EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
311 static int test_exec_P10CR_ses_ok(void)
313 return test_exec_P10CR_ses(0);
316 static int test_exec_P10CR_ses_reject(void)
318 return test_exec_P10CR_ses(1);
321 static int execute_try_certreq_poll_test(CMP_SES_TEST_FIXTURE *fixture)
323 OSSL_CMP_CTX *ctx = fixture->cmp_ctx;
325 const int CHECK_AFTER = 5;
326 const int TYPE = OSSL_CMP_KUR;
328 ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, 3);
329 ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, CHECK_AFTER);
330 return TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
331 && check_after == CHECK_AFTER
332 && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
333 && TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
334 && check_after == CHECK_AFTER
335 && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
336 && TEST_int_eq(fixture->expected,
337 OSSL_CMP_try_certreq(ctx, TYPE, NULL, NULL))
339 X509_cmp(OSSL_CMP_CTX_get0_newCert(ctx), client_cert));
342 static int test_try_certreq_poll(void)
344 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
345 fixture->expected = 1;
346 EXECUTE_TEST(execute_try_certreq_poll_test, tear_down);
350 static int execute_try_certreq_poll_abort_test(CMP_SES_TEST_FIXTURE *fixture)
352 OSSL_CMP_CTX *ctx = fixture->cmp_ctx;
354 const int CHECK_AFTER = 99;
355 const int TYPE = OSSL_CMP_CR;
357 ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, 3);
358 ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, CHECK_AFTER);
359 return TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
360 && check_after == CHECK_AFTER
361 && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
362 && TEST_int_eq(fixture->expected,
363 OSSL_CMP_try_certreq(ctx, -1 /* abort */, NULL, NULL))
364 && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(fixture->cmp_ctx), NULL);
367 static int test_try_certreq_poll_abort(void)
369 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
370 fixture->expected = 1;
371 EXECUTE_TEST(execute_try_certreq_poll_abort_test, tear_down);
375 static int test_exec_GENM_ses(int transfer_error, int total_timeout, int expect)
377 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
379 OSSL_CMP_CTX_set_transfer_cb_arg(fixture->cmp_ctx, NULL);
381 * cannot use OSSL_CMP_CTX_set_option(... OSSL_CMP_OPT_TOTAL_TIMEOUT)
382 * here because this will correct total_timeout to be >= 0
384 fixture->cmp_ctx->total_timeout = total_timeout;
385 fixture->expected = expect;
386 EXECUTE_TEST(execute_exec_GENM_ses_test, tear_down);
390 static int test_exec_GENM_ses_ok(void)
392 return test_exec_GENM_ses(0, 0, OSSL_CMP_PKISTATUS_accepted);
395 static int test_exec_GENM_ses_transfer_error(void)
397 return test_exec_GENM_ses(1, 0, OSSL_CMP_PKISTATUS_trans);
400 static int test_exec_GENM_ses_total_timeout(void)
402 return test_exec_GENM_ses(0, -1, OSSL_CMP_PKISTATUS_trans);
405 static int execute_exchange_certConf_test(CMP_SES_TEST_FIXTURE *fixture)
408 ossl_cmp_exchange_certConf(fixture->cmp_ctx, OSSL_CMP_CERTREQID,
409 OSSL_CMP_PKIFAILUREINFO_addInfoNotAvailable,
412 return TEST_int_eq(fixture->expected, res);
415 static int execute_exchange_error_test(CMP_SES_TEST_FIXTURE *fixture)
418 ossl_cmp_exchange_error(fixture->cmp_ctx,
419 OSSL_CMP_PKISTATUS_rejection,
420 1 << OSSL_CMP_PKIFAILUREINFO_unsupportedVersion,
421 "foo_status", 999, "foo_details");
423 return TEST_int_eq(fixture->expected, res);
426 static int test_exchange_certConf(void)
428 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
429 fixture->expected = 0; /* client should not send certConf immediately */
430 if (!ossl_cmp_ctx_set0_newCert(fixture->cmp_ctx, X509_dup(client_cert))) {
434 EXECUTE_TEST(execute_exchange_certConf_test, tear_down);
438 static int test_exchange_error(void)
440 SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
441 fixture->expected = 1; /* client may send error any time */
442 EXECUTE_TEST(execute_exchange_error_test, tear_down);
446 void cleanup_tests(void)
448 X509_free(server_cert);
449 EVP_PKEY_free(server_key);
450 X509_free(client_cert);
451 EVP_PKEY_free(client_key);
452 OSSL_PROVIDER_unload(default_null_provider);
453 OSSL_PROVIDER_unload(provider);
454 OSSL_LIB_CTX_free(libctx);
458 #define USAGE "server.key server.crt client.key client.crt client.csr module_name [module_conf_file]\n"
459 OPT_TEST_DECLARE_USAGE(USAGE)
461 int setup_tests(void)
463 if (!test_skip_common_options()) {
464 TEST_error("Error parsing test options\n");
468 if (!TEST_ptr(server_key_f = test_get_argument(0))
469 || !TEST_ptr(server_cert_f = test_get_argument(1))
470 || !TEST_ptr(client_key_f = test_get_argument(2))
471 || !TEST_ptr(client_cert_f = test_get_argument(3))
472 || !TEST_ptr(pkcs10_f = test_get_argument(4))) {
473 TEST_error("usage: cmp_client_test %s", USAGE);
477 if (!test_arg_libctx(&libctx, &default_null_provider, &provider, 5, USAGE))
480 if (!TEST_ptr(server_key = load_pkey_pem(server_key_f, libctx))
481 || !TEST_ptr(server_cert = load_cert_pem(server_cert_f, libctx))
482 || !TEST_ptr(client_key = load_pkey_pem(client_key_f, libctx))
483 || !TEST_ptr(client_cert = load_cert_pem(client_cert_f, libctx))
484 || !TEST_int_eq(1, RAND_bytes_ex(libctx, ref, sizeof(ref), 0))) {
489 ADD_TEST(test_exec_RR_ses_ok);
490 ADD_TEST(test_exec_RR_ses_request_error);
491 ADD_TEST(test_exec_RR_ses_receive_error);
492 ADD_TEST(test_exec_CR_ses_explicit_confirm);
493 ADD_TEST(test_exec_CR_ses_implicit_confirm);
494 ADD_TEST(test_exec_IR_ses);
495 ADD_TEST(test_exec_IR_ses_poll_ok);
496 ADD_TEST(test_exec_IR_ses_poll_no_timeout);
497 ADD_TEST(test_exec_IR_ses_poll_total_timeout);
498 ADD_TEST(test_exec_KUR_ses_ok);
499 ADD_TEST(test_exec_KUR_ses_transfer_error);
500 ADD_TEST(test_exec_P10CR_ses_ok);
501 ADD_TEST(test_exec_P10CR_ses_reject);
502 ADD_TEST(test_try_certreq_poll);
503 ADD_TEST(test_try_certreq_poll_abort);
504 ADD_TEST(test_exec_GENM_ses_ok);
505 ADD_TEST(test_exec_GENM_ses_transfer_error);
506 ADD_TEST(test_exec_GENM_ses_total_timeout);
507 ADD_TEST(test_exchange_certConf);
508 ADD_TEST(test_exchange_error);