test/cmp_client_test.c

   1 /*
   2  * Copyright 2007-2022 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 #include "cmp_mock_srv.h"
  15
  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;
  21
  22 typedef struct test_fixture {
  23     const char *test_case_name;
  24     OSSL_CMP_CTX *cmp_ctx;
  25     OSSL_CMP_SRV_CTX *srv_ctx;
  26     int req_type;
  27     int expected;
  28     STACK_OF(X509) *caPubs;
  29 } CMP_SES_TEST_FIXTURE;
  30
  31 static OSSL_LIB_CTX *libctx = NULL;
  32 static OSSL_PROVIDER *default_null_provider = NULL, *provider = NULL;
  33
  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];
  39
  40 /*
  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
  44  */
  45
  46 static void tear_down(CMP_SES_TEST_FIXTURE *fixture)
  47 {
  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);
  52 }
  53
  54 static CMP_SES_TEST_FIXTURE *set_up(const char *const test_case_name)
  55 {
  56     CMP_SES_TEST_FIXTURE *fixture;
  57     OSSL_CMP_CTX *srv_cmp_ctx = NULL;
  58     OSSL_CMP_CTX *ctx = NULL; /* for client */
  59
  60     if (!TEST_ptr(fixture = OPENSSL_zalloc(sizeof(*fixture))))
  61         return NULL;
  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)
  67             || (srv_cmp_ctx =
  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))
  71         goto err;
  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)))
  82         goto err;
  83     fixture->req_type = -1;
  84     return fixture;
  85
  86  err:
  87     tear_down(fixture);
  88     return NULL;
  89 }
  90
  91 static int execute_exec_RR_ses_test(CMP_SES_TEST_FIXTURE *fixt)
  92 {
  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);
  98 }
  99
 100 static int execute_exec_GENM_ses_test_single(CMP_SES_TEST_FIXTURE *fixture)
 101 {
 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;
 106
 107     OSSL_CMP_CTX_push0_genm_ITAV(ctx, itav);
 108     itavs = OSSL_CMP_exec_GENM_ses(ctx);
 109
 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);
 114 }
 115
 116 static int execute_exec_GENM_ses_test(CMP_SES_TEST_FIXTURE *fixture)
 117 {
 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);
 121 }
 122
 123 static int execute_exec_certrequest_ses_test(CMP_SES_TEST_FIXTURE *fixture)
 124 {
 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);
 128
 129     if (!TEST_int_eq(status, fixture->expected)
 130         && !(fixture->expected == OSSL_CMP_PKISTATUS_waiting
 131              && TEST_int_eq(status, OSSL_CMP_PKISTATUS_trans)))
 132         return 0;
 133     if (fixture->expected != OSSL_CMP_PKISTATUS_accepted)
 134         return TEST_ptr_null(res);
 135
 136     if (!TEST_ptr(res) || !TEST_int_eq(X509_cmp(res, client_cert), 0))
 137         return 0;
 138     if (fixture->caPubs != NULL) {
 139         STACK_OF(X509) *caPubs = OSSL_CMP_CTX_get1_caPubs(fixture->cmp_ctx);
 140         int ret = TEST_int_eq(STACK_OF_X509_cmp(fixture->caPubs, caPubs), 0);
 141
 142         OSSL_STACK_OF_X509_free(caPubs);
 143         return ret;
 144     }
 145     return 1;
 146 }
 147
 148 static int test_exec_RR_ses(int request_error)
 149 {
 150     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 151     if (request_error)
 152         OSSL_CMP_CTX_set1_oldCert(fixture->cmp_ctx, NULL);
 153     fixture->expected = request_error ? OSSL_CMP_PKISTATUS_request
 154         : OSSL_CMP_PKISTATUS_accepted;
 155     EXECUTE_TEST(execute_exec_RR_ses_test, tear_down);
 156     return result;
 157 }
 158
 159 static int test_exec_RR_ses_ok(void)
 160 {
 161     return test_exec_RR_ses(0);
 162 }
 163
 164 static int test_exec_RR_ses_request_error(void)
 165 {
 166     return test_exec_RR_ses(1);
 167 }
 168
 169 static int test_exec_RR_ses_receive_error(void)
 170 {
 171     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 172     ossl_cmp_mock_srv_set_statusInfo(fixture->srv_ctx,
 173                                      OSSL_CMP_PKISTATUS_rejection,
 174                                      OSSL_CMP_CTX_FAILINFO_signerNotTrusted,
 175                                      "test string");
 176     ossl_cmp_mock_srv_set_send_error(fixture->srv_ctx, 1);
 177     fixture->expected = OSSL_CMP_PKISTATUS_rejection;
 178     EXECUTE_TEST(execute_exec_RR_ses_test, tear_down);
 179     return result;
 180 }
 181
 182 static int test_exec_IR_ses(void)
 183 {
 184     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 185     fixture->req_type = OSSL_CMP_IR;
 186     fixture->expected = OSSL_CMP_PKISTATUS_accepted;
 187     fixture->caPubs = sk_X509_new_null();
 188     sk_X509_push(fixture->caPubs, server_cert);
 189     sk_X509_push(fixture->caPubs, server_cert);
 190     ossl_cmp_mock_srv_set1_caPubsOut(fixture->srv_ctx, fixture->caPubs);
 191     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 192     return result;
 193 }
 194
 195 static int test_exec_IR_ses_poll(int check_after, int poll_count,
 196                                  int total_timeout, int expect)
 197 {
 198     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 199     fixture->req_type = OSSL_CMP_IR;
 200     fixture->expected = expect;
 201     ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, check_after);
 202     ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, poll_count);
 203     OSSL_CMP_CTX_set_option(fixture->cmp_ctx,
 204                             OSSL_CMP_OPT_TOTAL_TIMEOUT, total_timeout);
 205     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 206     return result;
 207 }
 208
 209 static int checkAfter = 1;
 210 static int test_exec_IR_ses_poll_ok(void)
 211 {
 212     return test_exec_IR_ses_poll(checkAfter, 2, 0, OSSL_CMP_PKISTATUS_accepted);
 213 }
 214
 215 static int test_exec_IR_ses_poll_no_timeout(void)
 216 {
 217     return test_exec_IR_ses_poll(checkAfter, 1 /* pollCount */, checkAfter + 1,
 218                                  OSSL_CMP_PKISTATUS_accepted);
 219 }
 220
 221 static int test_exec_IR_ses_poll_total_timeout(void)
 222 {
 223     return test_exec_IR_ses_poll(checkAfter + 1, 2 /* pollCount */, checkAfter,
 224                                  OSSL_CMP_PKISTATUS_waiting);
 225 }
 226
 227 static int test_exec_CR_ses(int implicit_confirm, int granted)
 228 {
 229     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 230     fixture->req_type = OSSL_CMP_CR;
 231     fixture->expected = OSSL_CMP_PKISTATUS_accepted;
 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     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 236     return result;
 237 }
 238
 239 static int test_exec_CR_ses_explicit_confirm(void)
 240 {
 241     return test_exec_CR_ses(0, 0);
 242 }
 243
 244 static int test_exec_CR_ses_implicit_confirm(void)
 245 {
 246     return test_exec_CR_ses(1, 0)
 247         && test_exec_CR_ses(1, 1);
 248 }
 249
 250 static int test_exec_KUR_ses(int transfer_error)
 251 {
 252     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 253     fixture->req_type = OSSL_CMP_KUR;
 254     if (transfer_error)
 255         OSSL_CMP_CTX_set_transfer_cb_arg(fixture->cmp_ctx, NULL);
 256     fixture->expected = transfer_error ? OSSL_CMP_PKISTATUS_trans
 257         : OSSL_CMP_PKISTATUS_accepted;
 258     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 259     return result;
 260 }
 261
 262 static int test_exec_KUR_ses_ok(void)
 263 {
 264     return test_exec_KUR_ses(0);
 265 }
 266
 267 static int test_exec_KUR_ses_transfer_error(void)
 268 {
 269     return test_exec_KUR_ses(1);
 270 }
 271
 272 static int test_exec_P10CR_ses(void)
 273 {
 274     X509_REQ *req = NULL;
 275
 276     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 277     fixture->req_type = OSSL_CMP_P10CR;
 278     fixture->expected = OSSL_CMP_PKISTATUS_accepted;
 279     if (!TEST_ptr(req = load_csr_der(pkcs10_f, libctx))
 280             || !TEST_true(OSSL_CMP_CTX_set1_p10CSR(fixture->cmp_ctx, req))) {
 281         tear_down(fixture);
 282         fixture = NULL;
 283     }
 284     X509_REQ_free(req);
 285     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 286     return result;
 287 }
 288
 289 static int execute_try_certreq_poll_test(CMP_SES_TEST_FIXTURE *fixture)
 290 {
 291     OSSL_CMP_CTX *ctx = fixture->cmp_ctx;
 292     int check_after;
 293     const int CHECK_AFTER = 5;
 294     const int TYPE = OSSL_CMP_KUR;
 295
 296     ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, 3);
 297     ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, CHECK_AFTER);
 298     return TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
 299         && check_after == CHECK_AFTER
 300         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
 301         && TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
 302         && check_after == CHECK_AFTER
 303         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
 304         && TEST_int_eq(fixture->expected,
 305                        OSSL_CMP_try_certreq(ctx, TYPE, NULL, NULL))
 306         && TEST_int_eq(0,
 307                        X509_cmp(OSSL_CMP_CTX_get0_newCert(ctx), client_cert));
 308 }
 309
 310 static int test_try_certreq_poll(void)
 311 {
 312     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 313     fixture->expected = 1;
 314     EXECUTE_TEST(execute_try_certreq_poll_test, tear_down);
 315     return result;
 316 }
 317
 318 static int execute_try_certreq_poll_abort_test(CMP_SES_TEST_FIXTURE *fixture)
 319 {
 320     OSSL_CMP_CTX *ctx = fixture->cmp_ctx;
 321     int check_after;
 322     const int CHECK_AFTER = INT_MAX;
 323     const int TYPE = OSSL_CMP_CR;
 324
 325     ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, 3);
 326     ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, CHECK_AFTER);
 327     return TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
 328         && check_after == CHECK_AFTER
 329         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
 330         && TEST_int_eq(fixture->expected,
 331                        OSSL_CMP_try_certreq(ctx, -1, NULL, NULL))
 332         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(fixture->cmp_ctx), NULL);
 333 }
 334
 335 static int test_try_certreq_poll_abort(void)
 336 {
 337     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 338     fixture->expected = 1;
 339     EXECUTE_TEST(execute_try_certreq_poll_abort_test, tear_down);
 340     return result;
 341 }
 342
 343 static int test_exec_GENM_ses(int transfer_error)
 344 {
 345     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 346     if (transfer_error)
 347         OSSL_CMP_CTX_set_transfer_cb_arg(fixture->cmp_ctx, NULL);
 348     fixture->expected = transfer_error ? OSSL_CMP_PKISTATUS_trans
 349         : OSSL_CMP_PKISTATUS_accepted;
 350     EXECUTE_TEST(execute_exec_GENM_ses_test, tear_down);
 351     return result;
 352 }
 353
 354 static int test_exec_GENM_ses_ok(void)
 355 {
 356     return test_exec_GENM_ses(0);
 357 }
 358
 359 static int test_exec_GENM_ses_error(void)
 360 {
 361     return test_exec_GENM_ses(1);
 362 }
 363
 364 static int execute_exchange_certConf_test(CMP_SES_TEST_FIXTURE *fixture)
 365 {
 366     int res =
 367         ossl_cmp_exchange_certConf(fixture->cmp_ctx,
 368                                    OSSL_CMP_PKIFAILUREINFO_addInfoNotAvailable,
 369                                    "abcdefg");
 370
 371     return TEST_int_eq(fixture->expected, res);
 372 }
 373
 374 static int execute_exchange_error_test(CMP_SES_TEST_FIXTURE *fixture)
 375 {
 376     int res =
 377         ossl_cmp_exchange_error(fixture->cmp_ctx,
 378                                 OSSL_CMP_PKISTATUS_rejection,
 379                                 1 << OSSL_CMP_PKIFAILUREINFO_unsupportedVersion,
 380                                 "foo_status", 999, "foo_details");
 381
 382     return TEST_int_eq(fixture->expected, res);
 383 }
 384
 385 static int test_exchange_certConf(void)
 386 {
 387     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 388     fixture->expected = 0; /* client should not send certConf immediately */
 389     if (!ossl_cmp_ctx_set0_newCert(fixture->cmp_ctx, X509_dup(client_cert))) {
 390         tear_down(fixture);
 391         fixture = NULL;
 392     }
 393     EXECUTE_TEST(execute_exchange_certConf_test, tear_down);
 394     return result;
 395 }
 396
 397 static int test_exchange_error(void)
 398 {
 399     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 400     fixture->expected = 1; /* client may send error any time */
 401     EXECUTE_TEST(execute_exchange_error_test, tear_down);
 402     return result;
 403 }
 404
 405 void cleanup_tests(void)
 406 {
 407     X509_free(server_cert);
 408     EVP_PKEY_free(server_key);
 409     X509_free(client_cert);
 410     EVP_PKEY_free(client_key);
 411     OSSL_LIB_CTX_free(libctx);
 412     return;
 413 }
 414
 415 #define USAGE "server.key server.crt client.key client.crt client.csr module_name [module_conf_file]\n"
 416 OPT_TEST_DECLARE_USAGE(USAGE)
 417
 418 int setup_tests(void)
 419 {
 420     if (!test_skip_common_options()) {
 421         TEST_error("Error parsing test options\n");
 422         return 0;
 423     }
 424
 425     if (!TEST_ptr(server_key_f = test_get_argument(0))
 426             || !TEST_ptr(server_cert_f = test_get_argument(1))
 427             || !TEST_ptr(client_key_f = test_get_argument(2))
 428             || !TEST_ptr(client_cert_f = test_get_argument(3))
 429             || !TEST_ptr(pkcs10_f = test_get_argument(4))) {
 430         TEST_error("usage: cmp_client_test %s", USAGE);
 431         return 0;
 432     }
 433
 434     if (!test_arg_libctx(&libctx, &default_null_provider, &provider, 5, USAGE))
 435         return 0;
 436
 437     if (!TEST_ptr(server_key = load_pkey_pem(server_key_f, libctx))
 438             || !TEST_ptr(server_cert = load_cert_pem(server_cert_f, libctx))
 439             || !TEST_ptr(client_key = load_pkey_pem(client_key_f, libctx))
 440             || !TEST_ptr(client_cert = load_cert_pem(client_cert_f, libctx))
 441             || !TEST_int_eq(1, RAND_bytes_ex(libctx, ref, sizeof(ref), 0))) {
 442         cleanup_tests();
 443         return 0;
 444     }
 445
 446     ADD_TEST(test_exec_RR_ses_ok);
 447     ADD_TEST(test_exec_RR_ses_request_error);
 448     ADD_TEST(test_exec_RR_ses_receive_error);
 449     ADD_TEST(test_exec_CR_ses_explicit_confirm);
 450     ADD_TEST(test_exec_CR_ses_implicit_confirm);
 451     ADD_TEST(test_exec_IR_ses);
 452     ADD_TEST(test_exec_IR_ses_poll_ok);
 453     ADD_TEST(test_exec_IR_ses_poll_no_timeout);
 454     ADD_TEST(test_exec_IR_ses_poll_total_timeout);
 455     ADD_TEST(test_exec_KUR_ses_ok);
 456     ADD_TEST(test_exec_KUR_ses_transfer_error);
 457     ADD_TEST(test_exec_P10CR_ses);
 458     ADD_TEST(test_try_certreq_poll);
 459     ADD_TEST(test_try_certreq_poll_abort);
 460     ADD_TEST(test_exec_GENM_ses_ok);
 461     ADD_TEST(test_exec_GENM_ses_error);
 462     ADD_TEST(test_exchange_certConf);
 463     ADD_TEST(test_exchange_error);
 464     return 1;
 465 }