test/cmp_client_test.c

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