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 *fixture)
  92 {
  93     return TEST_int_eq(fixture->expected,
  94                        OSSL_CMP_exec_RR_ses(fixture->cmp_ctx) == 1);
  95 }
  96
  97 static int execute_exec_GENM_ses_test(CMP_SES_TEST_FIXTURE *fixture)
  98 {
  99     STACK_OF(OSSL_CMP_ITAV) *itavs = NULL;
 100     if (!TEST_ptr(itavs = OSSL_CMP_exec_GENM_ses(fixture->cmp_ctx)))
 101         return 0;
 102     sk_OSSL_CMP_ITAV_pop_free(itavs, OSSL_CMP_ITAV_free);
 103     return 1;
 104 }
 105
 106 static int execute_exec_certrequest_ses_test(CMP_SES_TEST_FIXTURE *fixture)
 107 {
 108     X509 *res = OSSL_CMP_exec_certreq(fixture->cmp_ctx,
 109                                       fixture->req_type, NULL);
 110
 111     if (fixture->expected == 0)
 112         return TEST_ptr_null(res);
 113
 114     if (!TEST_ptr(res) || !TEST_int_eq(X509_cmp(res, client_cert), 0))
 115         return 0;
 116     if (fixture->caPubs != NULL) {
 117         STACK_OF(X509) *caPubs = OSSL_CMP_CTX_get1_caPubs(fixture->cmp_ctx);
 118         int ret = TEST_int_eq(STACK_OF_X509_cmp(fixture->caPubs, caPubs), 0);
 119
 120         OSSL_STACK_OF_X509_free(caPubs);
 121         return ret;
 122     }
 123     return 1;
 124 }
 125
 126 static int test_exec_RR_ses(void)
 127 {
 128     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 129     fixture->expected = 1;
 130     EXECUTE_TEST(execute_exec_RR_ses_test, tear_down);
 131     return result;
 132 }
 133
 134 static int test_exec_RR_ses_receive_error(void)
 135 {
 136     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 137     ossl_cmp_mock_srv_set_statusInfo(fixture->srv_ctx,
 138                                      OSSL_CMP_PKISTATUS_rejection,
 139                                      OSSL_CMP_CTX_FAILINFO_signerNotTrusted,
 140                                      "test string");
 141     ossl_cmp_mock_srv_set_send_error(fixture->srv_ctx, 1);
 142     fixture->expected = 0;
 143     EXECUTE_TEST(execute_exec_RR_ses_test, tear_down);
 144     return result;
 145 }
 146
 147 static int test_exec_IR_ses(void)
 148 {
 149     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 150     fixture->req_type = OSSL_CMP_IR;
 151     fixture->expected = 1;
 152     fixture->caPubs = sk_X509_new_null();
 153     sk_X509_push(fixture->caPubs, server_cert);
 154     sk_X509_push(fixture->caPubs, server_cert);
 155     ossl_cmp_mock_srv_set1_caPubsOut(fixture->srv_ctx, fixture->caPubs);
 156     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 157     return result;
 158 }
 159
 160 static const int checkAfter = 1;
 161 static int test_exec_IR_ses_poll(void)
 162 {
 163     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 164     fixture->req_type = OSSL_CMP_IR;
 165     fixture->expected = 1;
 166     ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, 2);
 167     ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, checkAfter);
 168     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 169     return result;
 170 }
 171
 172 static int test_exec_IR_ses_poll_timeout(void)
 173 {
 174     const int pollCount = 3;
 175     const int tout = pollCount * checkAfter;
 176
 177     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 178     fixture->req_type = OSSL_CMP_IR;
 179     fixture->expected = 0;
 180     ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, pollCount + 1);
 181     ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, checkAfter);
 182     OSSL_CMP_CTX_set_option(fixture->cmp_ctx, OSSL_CMP_OPT_TOTAL_TIMEOUT, tout);
 183     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 184     return result;
 185 }
 186
 187
 188 static int test_exec_CR_ses(void)
 189 {
 190     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 191     fixture->req_type = OSSL_CMP_CR;
 192     fixture->expected = 1;
 193     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 194     return result;
 195 }
 196
 197 static int test_exec_CR_ses_implicit_confirm(void)
 198 {
 199     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 200     fixture->req_type = OSSL_CMP_CR;
 201     fixture->expected = 1;
 202     OSSL_CMP_CTX_set_option(fixture->cmp_ctx,
 203                             OSSL_CMP_OPT_IMPLICIT_CONFIRM, 1);
 204     OSSL_CMP_SRV_CTX_set_grant_implicit_confirm(fixture->srv_ctx, 1);
 205     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 206     return result;
 207 }
 208
 209 static int test_exec_KUR_ses(void)
 210 {
 211     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 212     fixture->req_type = OSSL_CMP_KUR;
 213     fixture->expected = 1;
 214     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 215     return result;
 216 }
 217
 218 static int test_exec_P10CR_ses(void)
 219 {
 220     X509_REQ *req = NULL;
 221
 222     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 223     fixture->req_type = OSSL_CMP_P10CR;
 224     fixture->expected = 1;
 225     if (!TEST_ptr(req = load_csr_der(pkcs10_f, libctx))
 226             || !TEST_true(OSSL_CMP_CTX_set1_p10CSR(fixture->cmp_ctx, req))) {
 227         tear_down(fixture);
 228         fixture = NULL;
 229     }
 230     X509_REQ_free(req);
 231     EXECUTE_TEST(execute_exec_certrequest_ses_test, tear_down);
 232     return result;
 233 }
 234
 235 static int execute_try_certreq_poll_test(CMP_SES_TEST_FIXTURE *fixture)
 236 {
 237     OSSL_CMP_CTX *ctx = fixture->cmp_ctx;
 238     int check_after;
 239     const int CHECK_AFTER = 5;
 240     const int TYPE = OSSL_CMP_KUR;
 241
 242     ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, 3);
 243     ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, CHECK_AFTER);
 244     return TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
 245         && check_after == CHECK_AFTER
 246         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
 247         && TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
 248         && check_after == CHECK_AFTER
 249         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
 250         && TEST_int_eq(fixture->expected,
 251                        OSSL_CMP_try_certreq(ctx, TYPE, NULL, NULL))
 252         && TEST_int_eq(0,
 253                        X509_cmp(OSSL_CMP_CTX_get0_newCert(ctx), client_cert));
 254 }
 255
 256 static int test_try_certreq_poll(void)
 257 {
 258     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 259     fixture->expected = 1;
 260     EXECUTE_TEST(execute_try_certreq_poll_test, tear_down);
 261     return result;
 262 }
 263
 264 static int execute_try_certreq_poll_abort_test(CMP_SES_TEST_FIXTURE *fixture)
 265 {
 266     OSSL_CMP_CTX *ctx = fixture->cmp_ctx;
 267     int check_after;
 268     const int CHECK_AFTER = INT_MAX;
 269     const int TYPE = OSSL_CMP_CR;
 270
 271     ossl_cmp_mock_srv_set_pollCount(fixture->srv_ctx, 3);
 272     ossl_cmp_mock_srv_set_checkAfterTime(fixture->srv_ctx, CHECK_AFTER);
 273     return TEST_int_eq(-1, OSSL_CMP_try_certreq(ctx, TYPE, NULL, &check_after))
 274         && check_after == CHECK_AFTER
 275         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(ctx), NULL)
 276         && TEST_int_eq(fixture->expected,
 277                        OSSL_CMP_try_certreq(ctx, -1, NULL, NULL))
 278         && TEST_ptr_eq(OSSL_CMP_CTX_get0_newCert(fixture->cmp_ctx), NULL);
 279 }
 280
 281 static int test_try_certreq_poll_abort(void)
 282 {
 283     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 284     fixture->expected = 1;
 285     EXECUTE_TEST(execute_try_certreq_poll_abort_test, tear_down);
 286     return result;
 287 }
 288
 289 static int test_exec_GENM_ses(void)
 290 {
 291     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 292     EXECUTE_TEST(execute_exec_GENM_ses_test, tear_down);
 293     return result;
 294 }
 295
 296 static int execute_exchange_certConf_test(CMP_SES_TEST_FIXTURE *fixture)
 297 {
 298     int res =
 299         ossl_cmp_exchange_certConf(fixture->cmp_ctx,
 300                                    OSSL_CMP_PKIFAILUREINFO_addInfoNotAvailable,
 301                                    "abcdefg");
 302     return TEST_int_eq(fixture->expected, res);
 303 }
 304
 305 static int execute_exchange_error_test(CMP_SES_TEST_FIXTURE *fixture)
 306 {
 307     int res =
 308         ossl_cmp_exchange_error(fixture->cmp_ctx,
 309                                 OSSL_CMP_PKISTATUS_rejection,
 310                                 1 << OSSL_CMP_PKIFAILUREINFO_unsupportedVersion,
 311                                 "foo_status", 999, "foo_details");
 312
 313     return TEST_int_eq(fixture->expected, res);
 314 }
 315
 316 static int test_exchange_certConf(void)
 317 {
 318     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 319     fixture->expected = 0; /* client should not send certConf immediately */
 320     if (!ossl_cmp_ctx_set0_newCert(fixture->cmp_ctx, X509_dup(client_cert))) {
 321         tear_down(fixture);
 322         fixture = NULL;
 323     }
 324     EXECUTE_TEST(execute_exchange_certConf_test, tear_down);
 325     return result;
 326 }
 327
 328 static int test_exchange_error(void)
 329 {
 330     SETUP_TEST_FIXTURE(CMP_SES_TEST_FIXTURE, set_up);
 331     fixture->expected = 1; /* client may send error any time */
 332     EXECUTE_TEST(execute_exchange_error_test, tear_down);
 333     return result;
 334 }
 335
 336 void cleanup_tests(void)
 337 {
 338     X509_free(server_cert);
 339     EVP_PKEY_free(server_key);
 340     X509_free(client_cert);
 341     EVP_PKEY_free(client_key);
 342     OSSL_LIB_CTX_free(libctx);
 343     return;
 344 }
 345
 346 #define USAGE "server.key server.crt client.key client.crt client.csr module_name [module_conf_file]\n"
 347 OPT_TEST_DECLARE_USAGE(USAGE)
 348
 349 int setup_tests(void)
 350 {
 351     if (!test_skip_common_options()) {
 352         TEST_error("Error parsing test options\n");
 353         return 0;
 354     }
 355
 356     if (!TEST_ptr(server_key_f = test_get_argument(0))
 357             || !TEST_ptr(server_cert_f = test_get_argument(1))
 358             || !TEST_ptr(client_key_f = test_get_argument(2))
 359             || !TEST_ptr(client_cert_f = test_get_argument(3))
 360             || !TEST_ptr(pkcs10_f = test_get_argument(4))) {
 361         TEST_error("usage: cmp_client_test %s", USAGE);
 362         return 0;
 363     }
 364
 365     if (!test_arg_libctx(&libctx, &default_null_provider, &provider, 5, USAGE))
 366         return 0;
 367
 368     if (!TEST_ptr(server_key = load_pkey_pem(server_key_f, libctx))
 369             || !TEST_ptr(server_cert = load_cert_pem(server_cert_f, libctx))
 370             || !TEST_ptr(client_key = load_pkey_pem(client_key_f, libctx))
 371             || !TEST_ptr(client_cert = load_cert_pem(client_cert_f, libctx))
 372             || !TEST_int_eq(1, RAND_bytes_ex(libctx, ref, sizeof(ref), 0))) {
 373         cleanup_tests();
 374         return 0;
 375     }
 376
 377     ADD_TEST(test_exec_RR_ses);
 378     ADD_TEST(test_exec_RR_ses_receive_error);
 379     ADD_TEST(test_exec_CR_ses);
 380     ADD_TEST(test_exec_CR_ses_implicit_confirm);
 381     ADD_TEST(test_exec_IR_ses);
 382     ADD_TEST(test_exec_IR_ses_poll);
 383     ADD_TEST(test_exec_IR_ses_poll_timeout);
 384     ADD_TEST(test_exec_KUR_ses);
 385     ADD_TEST(test_exec_P10CR_ses);
 386     ADD_TEST(test_try_certreq_poll);
 387     ADD_TEST(test_try_certreq_poll_abort);
 388     ADD_TEST(test_exec_GENM_ses);
 389     ADD_TEST(test_exchange_certConf);
 390     ADD_TEST(test_exchange_error);
 391     return 1;
 392 }