test/cmp_client_test.c

   1 /*
   2  * Copyright 2007-2020 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 #include "apps/cmp_mock_srv.h"
  15
  16 #ifndef NDEBUG /* tests need mock server, which is available only if !NDEBUG */
  17
  18 DEFINE_STACK_OF(X509)
  19 DEFINE_STACK_OF(OSSL_CMP_ITAV)
  20
  21 static const char *server_key_f;
  22 static const char *server_cert_f;
  23 static const char *client_key_f;
  24 static const char *client_cert_f;
  25 static const char *pkcs10_f;
  26
  27 typedef struct test_fixture {
  28     const char *test_case_name;
  29     OSSL_CMP_CTX *cmp_ctx;
  30     OSSL_CMP_SRV_CTX *srv_ctx;
  31     int req_type;
  32     int expected;
  33     STACK_OF(X509) *caPubs;
  34 } CMP_SES_TEST_FIXTURE;
  35
  36 static OPENSSL_CTX *libctx = NULL;
  37 static OSSL_PROVIDER *default_null_provider = NULL, *provider = NULL;
  38
  39 static EVP_PKEY *server_key = NULL;
  40 static X509 *server_cert = NULL;
  41 static EVP_PKEY *client_key = NULL;
  42 static X509 *client_cert = NULL;
  43 static unsigned char ref[CMP_TEST_REFVALUE_LENGTH];
  44
  45 /*
  46  * For these unit tests, the client abandons message protection, and for
  47  * error messages the mock server does so as well.
  48  * Message protection and verification is tested in cmp_lib_test.c
  49  */
  50
  51 static void tear_down(CMP_SES_TEST_FIXTURE *fixture)
  52 {
  53     OSSL_CMP_CTX_free(fixture->cmp_ctx);
  54     ossl_cmp_mock_srv_free(fixture->srv_ctx);
  55     sk_X509_free(fixture->caPubs);
  56     OPENSSL_free(fixture);
  57 }
  58
  59 static CMP_SES_TEST_FIXTURE *set_up(const char *const test_case_name)
  60 {
  61     CMP_SES_TEST_FIXTURE *fixture;
  62     OSSL_CMP_CTX *srv_cmp_ctx = NULL;
  63     OSSL_CMP_CTX *ctx = NULL; /* for client */
  64
  65     if (!TEST_ptr(fixture = OPENSSL_zalloc(sizeof(*fixture))))
  66         return NULL;
  67     fixture->test_case_name = test_case_name;
  68     if (!TEST_ptr(fixture->srv_ctx = ossl_cmp_mock_srv_new(libctx, NULL))
  69             || !OSSL_CMP_SRV_CTX_set_accept_unprotected(fixture->srv_ctx, 1)
  70             || !ossl_cmp_mock_srv_set1_certOut(fixture->srv_ctx, client_cert)
  71             || (srv_cmp_ctx =
  72                 OSSL_CMP_SRV_CTX_get0_cmp_ctx(fixture->srv_ctx)) == NULL
  73             || !OSSL_CMP_CTX_set1_cert(srv_cmp_ctx, server_cert)
  74             || !OSSL_CMP_CTX_set1_pkey(srv_cmp_ctx, server_key))
  75         goto err;
  76     if (!TEST_ptr(fixture->cmp_ctx = ctx = OSSL_CMP_CTX_new(libctx, NULL))
  77             || !OSSL_CMP_CTX_set_log_cb(fixture->cmp_ctx, print_to_bio_out)
  78             || !OSSL_CMP_CTX_set_transfer_cb(ctx, OSSL_CMP_CTX_server_perform)
  79             || !OSSL_CMP_CTX_set_transfer_cb_arg(ctx, fixture->srv_ctx)
  80             || !OSSL_CMP_CTX_set_option(ctx, OSSL_CMP_OPT_UNPROTECTED_SEND, 1)
  81             || !OSSL_CMP_CTX_set_option(ctx, OSSL_CMP_OPT_UNPROTECTED_ERRORS, 1)
  82             || !OSSL_CMP_CTX_set1_oldCert(ctx, client_cert)
  83             || !OSSL_CMP_CTX_set1_pkey(ctx, client_key)
  84             || !OSSL_CMP_CTX_set1_srvCert(ctx, server_cert)
  85             || !OSSL_CMP_CTX_set1_referenceValue(ctx, ref, sizeof(ref)))
  86         goto err;
  87     fixture->req_type = -1;
  88     return fixture;
  89
  90  err:
  91     tear_down(fixture);
  92     return NULL;
  93 }
  94
  95 static int execute_exec_RR_ses_test(CMP_SES_TEST_FIXTURE *fixture)
  96 {
  97     return TEST_int_eq(fixture->expected,
  98                        OSSL_CMP_exec_RR_ses(fixture->cmp_ctx) == client_cert);
  99 }
 100
 101 static int execute_exec_GENM_ses_test(CMP_SES_TEST_FIXTURE *fixture)
 102 {
 103     STACK_OF(OSSL_CMP_ITAV) *itavs = NULL;
 104     if (!TEST_ptr(itavs = OSSL_CMP_exec_GENM_ses(fixture->cmp_ctx)))
 105         return 0;
 106     sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
 107     /* TODO: check if the returned value is the expected one (same as sent) */
 108     return 1;
 109 }
 110
 111 static int execute_exec_certrequest_ses_test(CMP_SES_TEST_FIXTURE *fixture)
 112 {
 113     X509 *res = OSSL_CMP_exec_certreq(fixture->cmp_ctx,
 114                                       fixture->req_type, NULL);
 115
 116     if (fixture->expected == 0)
 117         return TEST_ptr_null(res);
 118
 119     if (!TEST_ptr(res) || !TEST_int_eq(X509_cmp(res, client_cert), 0))
 120         return 0;
 121     /* TODO: check that cerfConf has been exchanged unless implicitConfirm */
 122     if (fixture->caPubs != NULL) {
 123         STACK_OF(X509) *caPubs = OSSL_CMP_CTX_get1_caPubs(fixture->cmp_ctx);
 124         int ret = TEST_int_eq(STACK_OF_X509_cmp(fixture->caPubs, caPubs), 0);
 125
 126         sk_X509_pop_free(caPubs, X509_free);
 127         return ret;
 128     }
 129     return 1;
 130 }
 131
 132 static int test_exec_RR_ses(void)
 133 {
 134     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 135     fixture->expected = 1;
 136     EXECUTE_TEST(execute_exec_RR_ses_test, tear_down);
 137     return result;
 138 }
 139
 140 static int test_exec_RR_ses_receive_error(void)
 141 {
 142     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 143     ossl_cmp_mock_srv_set_statusInfo(fixture->srv_ctx,
 144                                      OSSL_CMP_PKISTATUS_rejection,
 145                                      OSSL_CMP_CTX_FAILINFO_signerNotTrusted,
 146                                      "test string");
 147     ossl_cmp_mock_srv_set_send_error(fixture->srv_ctx, 1);
 148     fixture->expected = 0;
 149     EXECUTE_TEST(execute_exec_RR_ses_test, tear_down);
 150     return result;
 151 }
 152
 153 static int test_exec_IR_ses(void)
 154 {
 155     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 156     fixture->req_type = OSSL_CMP_IR;
 157     fixture->expected = 1;
 158     fixture->caPubs = sk_X509_new_null();
 159     sk_X509_push(fixture->caPubs, server_cert);
 160     sk_X509_push(fixture->caPubs, server_cert);
 161     ossl_cmp_mock_srv_set1_caPubsOut(fixture->srv_ctx, fixture->caPubs);
 162     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 163     return result;
 164 }
 165
 166 static const int checkAfter = 1;
 167 static int test_exec_IR_ses_poll(void)
 168 {
 169     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 170     fixture->req_type = OSSL_CMP_IR;
 171     fixture->expected = 1;
 172     ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, 2);
 173     ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, checkAfter);
 174     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 175     /* TODO: check that 2 rounds are done or session takes 2..3 seconds */
 176     return result;
 177 }
 178
 179 static int test_exec_IR_ses_poll_timeout(void)
 180 {
 181     const int pollCount = 3;
 182     const int tout = pollCount * checkAfter;
 183
 184     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 185     fixture->req_type = OSSL_CMP_IR;
 186     fixture->expected = 0;
 187     ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, pollCount + 1);
 188     ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, checkAfter);
 189     OSSL_CMP_CTX_set_option(fixture->cmp_ctx, OSSL_CMP_OPT_TOTAL_TIMEOUT, tout);
 190     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 191     return result;
 192 }
 193
 194
 195 static int test_exec_CR_ses(void)
 196 {
 197     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 198     fixture->req_type = OSSL_CMP_CR;
 199     fixture->expected = 1;
 200     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 201     return result;
 202 }
 203
 204 static int test_exec_CR_ses_implicit_confirm(void)
 205 {
 206     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 207     fixture->req_type = OSSL_CMP_CR;
 208     fixture->expected = 1;
 209     OSSL_CMP_CTX_set_option(fixture->cmp_ctx,
 210                             OSSL_CMP_OPT_IMPLICIT_CONFIRM, 1);
 211     OSSL_CMP_SRV_CTX_set_grant_implicit_confirm(fixture->srv_ctx, 1);
 212     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 213     return result;
 214 }
 215
 216 static int test_exec_KUR_ses(void)
 217 {
 218     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 219     fixture->req_type = OSSL_CMP_KUR;
 220     fixture->expected = 1;
 221     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 222     return result;
 223 }
 224
 225 static int test_exec_P10CR_ses(void)
 226 {
 227     X509_REQ *req = NULL;
 228
 229     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 230     fixture->req_type = OSSL_CMP_P10CR;
 231     fixture->expected = 1;
 232     if (!TEST_ptr(req = load_csr(pkcs10_f))
 233             || !TEST_true(OSSL_CMP_CTX_set1_p10CSR(fixture->cmp_ctx, req))) {
 234         tear_down(fixture);
 235         fixture = NULL;
 236     }
 237     X509_REQ_free(req);
 238     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 239     return result;
 240 }
 241
 242 static int execute_try_certreq_poll_test(CMP_SES_TEST_FIXTURE *fixture)
 243 {
 244     OSSL_CMP_CTX *ctx = fixture->cmp_ctx;
 245     int check_after;
 246     const int CHECK_AFTER = 5;
 247     const int TYPE = OSSL_CMP_KUR;
 248
 249     ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, 3);
 250     ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, CHECK_AFTER);
 251     return TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
 252         && check_after == CHECK_AFTER
 253         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
 254         && TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
 255         && check_after == CHECK_AFTER
 256         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
 257         && TEST_int_eq(fixture->expected,
 258                        OSSL_CMP_try_certreq(ctx, TYPE, NULL, NULL))
 259         && TEST_int_eq(0,
 260                        X509_cmp(OSSL_CMP_CTX_get0_newCert(ctx), client_cert));
 261 }
 262
 263 static int test_try_certreq_poll(void)
 264 {
 265     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 266     fixture->expected = 1;
 267     EXECUTE_TEST(execute_try_certreq_poll_test, tear_down);
 268     return result;
 269 }
 270
 271 static int execute_try_certreq_poll_abort_test(CMP_SES_TEST_FIXTURE *fixture)
 272 {
 273     OSSL_CMP_CTX *ctx = fixture->cmp_ctx;
 274     int check_after;
 275     const int CHECK_AFTER = INT_MAX;
 276     const int TYPE = OSSL_CMP_CR;
 277
 278     ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, 3);
 279     ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, CHECK_AFTER);
 280     return TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
 281         && check_after == CHECK_AFTER
 282         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
 283         && TEST_int_eq(fixture->expected,
 284                        OSSL_CMP_try_certreq(ctx, -1, NULL, NULL))
 285         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(fixture->cmp_ctx), NULL);
 286 }
 287
 288 static int test_try_certreq_poll_abort(void)
 289 {
 290     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 291     fixture->expected = 1;
 292     EXECUTE_TEST(execute_try_certreq_poll_abort_test, tear_down);
 293     return result;
 294 }
 295
 296 static int test_exec_GENM_ses(void)
 297 {
 298     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 299     EXECUTE_TEST(execute_exec_GENM_ses_test, tear_down);
 300     return result;
 301 }
 302
 303 static int execute_exchange_certConf_test(CMP_SES_TEST_FIXTURE *fixture)
 304 {
 305     int res =
 306         ossl_cmp_exchange_certConf(fixture->cmp_ctx,
 307                                    OSSL_CMP_PKIFAILUREINFO_addInfoNotAvailable,
 308                                    "abcdefg");
 309     return TEST_int_eq(fixture->expected, res);
 310 }
 311
 312 static int execute_exchange_error_test(CMP_SES_TEST_FIXTURE *fixture)
 313 {
 314     int res =
 315         ossl_cmp_exchange_error(fixture->cmp_ctx,
 316                                 OSSL_CMP_PKISTATUS_rejection,
 317                                 1 << OSSL_CMP_PKIFAILUREINFO_unsupportedVersion,
 318                                 "foo_status", 999, "foo_details");
 319
 320     return TEST_int_eq(fixture->expected, res);
 321 }
 322
 323 static int test_exchange_certConf(void)
 324 {
 325     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 326     fixture->expected = 0; /* client should not send certConf immediately */
 327     if (!ossl_cmp_ctx_set0_newCert(fixture->cmp_ctx, X509_dup(client_cert))) {
 328         tear_down(fixture);
 329         fixture = NULL;
 330     }
 331     EXECUTE_TEST(execute_exchange_certConf_test, tear_down);
 332     return result;
 333 }
 334
 335 static int test_exchange_error(void)
 336 {
 337     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 338     fixture->expected = 1; /* client may send error any time */
 339     EXECUTE_TEST(execute_exchange_error_test, tear_down);
 340     return result;
 341 }
 342
 343 void cleanup_tests(void)
 344 {
 345     X509_free(server_cert);
 346     EVP_PKEY_free(server_key);
 347     X509_free(client_cert);
 348     EVP_PKEY_free(client_key);
 349     OPENSSL_CTX_free(libctx);
 350     return;
 351 }
 352
 353 # define USAGE "server.key server.crt client.key client.crt client.csr module_name [module_conf_file]\n"
 354 OPT_TEST_DECLARE_USAGE(USAGE)
 355
 356 int setup_tests(void)
 357 {
 358     if (!test_skip_common_options()) {
 359         TEST_error("Error parsing test options\n");
 360         return 0;
 361     }
 362
 363     if (!TEST_ptr(server_key_f = test_get_argument(0))
 364             || !TEST_ptr(server_cert_f = test_get_argument(1))
 365             || !TEST_ptr(client_key_f = test_get_argument(2))
 366             || !TEST_ptr(client_cert_f = test_get_argument(3))
 367             || !TEST_ptr(pkcs10_f = test_get_argument(4))) {
 368         TEST_error("usage: cmp_client_test %s", USAGE);
 369         return 0;
 370     }
 371
 372     if (!test_get_libctx(&libctx, &default_null_provider, &provider, 5, USAGE))
 373         return 0;
 374
 375     if (!TEST_ptr(server_key = load_pem_key(server_key_f, libctx))
 376             || !TEST_ptr(server_cert = load_pem_cert(server_cert_f, libctx))
 377             || !TEST_ptr(client_key = load_pem_key(client_key_f, libctx))
 378             || !TEST_ptr(client_cert = load_pem_cert(client_cert_f, libctx))
 379             || !TEST_int_eq(1, RAND_bytes_ex(libctx, ref, sizeof(ref)))) {
 380         cleanup_tests();
 381         return 0;
 382     }
 383
 384     ADD_TEST(test_exec_RR_ses);
 385     ADD_TEST(test_exec_RR_ses_receive_error);
 386     ADD_TEST(test_exec_CR_ses);
 387     ADD_TEST(test_exec_CR_ses_implicit_confirm);
 388     ADD_TEST(test_exec_IR_ses);
 389     ADD_TEST(test_exec_IR_ses_poll);
 390     ADD_TEST(test_exec_IR_ses_poll_timeout);
 391     ADD_TEST(test_exec_KUR_ses);
 392     ADD_TEST(test_exec_P10CR_ses);
 393     ADD_TEST(test_try_certreq_poll);
 394     ADD_TEST(test_try_certreq_poll_abort);
 395     ADD_TEST(test_exec_GENM_ses);
 396     ADD_TEST(test_exchange_certConf);
 397     ADD_TEST(test_exchange_error);
 398     return 1;
 399 }
 400
 401 #else /* !defined (NDEBUG) */
 402
 403 int setup_tests(void)
 404 {
 405     TEST_note("CMP session tests are disabled in this build (NDEBUG).");
 406     return 1;
 407 }
 408
 409 #endif