2 * Copyright 2007-2019 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 "cmp_testlib.h"
14 static const char *ir_protected_f;
15 static const char *ir_unprotected_f;
16 static const char *ip_PBM_f;
18 typedef struct test_fixture {
19 const char *test_case_name;
20 OSSL_CMP_CTX *cmp_ctx;
21 /* for protection tests */
23 OSSL_CMP_PKISI *si; /* for error and response messages */
24 ASN1_OCTET_STRING *secret;
30 STACK_OF(X509) *certs;
31 STACK_OF(X509) *chain;
34 } CMP_PROTECT_TEST_FIXTURE;
36 static void tear_down(CMP_PROTECT_TEST_FIXTURE *fixture)
38 OSSL_CMP_CTX_free(fixture->cmp_ctx);
39 OSSL_CMP_MSG_free(fixture->msg);
40 ASN1_OCTET_STRING_free(fixture->secret);
41 OSSL_CMP_PKISI_free(fixture->si);
43 OPENSSL_free(fixture->mem);
44 sk_X509_free(fixture->certs);
45 sk_X509_free(fixture->chain);
47 OPENSSL_free(fixture);
50 static CMP_PROTECT_TEST_FIXTURE *set_up(const char *const test_case_name)
52 CMP_PROTECT_TEST_FIXTURE *fixture;
54 if (!TEST_ptr(fixture = OPENSSL_zalloc(sizeof(*fixture))))
56 fixture->test_case_name = test_case_name;
57 if (!TEST_ptr(fixture->cmp_ctx = OSSL_CMP_CTX_new())) {
64 static EVP_PKEY *loadedprivkey = NULL;
65 static EVP_PKEY *loadedpubkey = NULL;
66 static EVP_PKEY *loadedkey = NULL;
67 static X509 *cert = NULL;
68 static unsigned char rand_data[OSSL_CMP_TRANSACTIONID_LENGTH];
69 static OSSL_CMP_MSG *ir_unprotected, *ir_protected;
70 static X509 *endentity1 = NULL, *endentity2 = NULL,
71 *root = NULL, *intermediate = NULL;
73 static int execute_calc_protection_fails_test(CMP_PROTECT_TEST_FIXTURE *fixture)
75 ASN1_BIT_STRING *protection =
76 ossl_cmp_calc_protection(fixture->msg, fixture->secret,
78 int res = TEST_ptr_null(protection);
80 ASN1_BIT_STRING_free(protection);
84 static int execute_calc_protection_pbmac_test(CMP_PROTECT_TEST_FIXTURE *fixture)
86 ASN1_BIT_STRING *protection =
87 ossl_cmp_calc_protection(fixture->msg, fixture->secret, NULL);
88 int res = TEST_ptr(protection)
89 && TEST_true(ASN1_STRING_cmp(protection, fixture->msg->protection) == 0);
91 ASN1_BIT_STRING_free(protection);
96 * This function works similarly to parts of CMP_verify_signature in cmp_vfy.c,
97 * but without the need for a OSSL_CMP_CTX or a X509 certificate
99 static int verify_signature(OSSL_CMP_MSG *msg,
100 ASN1_BIT_STRING *protection,
101 EVP_PKEY *pkey, int digest_nid)
103 CMP_PROTECTEDPART prot_part;
104 unsigned char *prot_part_der = NULL;
106 EVP_MD_CTX *ctx = NULL;
107 const EVP_MD *digest = EVP_get_digestbynid(digest_nid);
110 prot_part.header = OSSL_CMP_MSG_get0_header(msg);
111 prot_part.body = msg->body;
113 TEST_int_ge(len = i2d_CMP_PROTECTEDPART(&prot_part, &prot_part_der), 0)
114 && TEST_ptr(ctx = EVP_MD_CTX_new())
115 && TEST_true(EVP_DigestVerifyInit(ctx, NULL, digest, NULL, pkey))
116 && TEST_int_eq(EVP_DigestVerify(ctx, protection->data,
118 prot_part_der, len), 1);
120 EVP_MD_CTX_free(ctx);
121 OPENSSL_free(prot_part_der);
125 /* Calls OSSL_CMP_calc_protection and compares and verifies signature */
126 static int execute_calc_protection_signature_test(CMP_PROTECT_TEST_FIXTURE *
129 ASN1_BIT_STRING *protection =
130 ossl_cmp_calc_protection(fixture->msg, NULL, fixture->privkey);
131 int ret = (TEST_ptr(protection)
132 && TEST_true(ASN1_STRING_cmp(protection,
133 fixture->msg->protection) == 0)
134 && TEST_true(verify_signature(fixture->msg, protection,
136 fixture->cmp_ctx->digest)));
138 ASN1_BIT_STRING_free(protection);
142 static int test_cmp_calc_protection_no_key_no_secret(void)
144 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
145 if (!TEST_ptr(fixture->msg = load_pkimsg(ir_unprotected_f))
146 || !TEST_ptr(fixture->msg->header->protectionAlg =
147 X509_ALGOR_new() /* no specific alg needed here */)) {
152 EXECUTE_TEST(execute_calc_protection_fails_test, tear_down);
156 static int test_cmp_calc_protection_pkey(void)
158 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
159 fixture->pubkey = loadedpubkey;
160 fixture->privkey = loadedprivkey;
161 if (!TEST_ptr(fixture->msg = load_pkimsg(ir_protected_f))) {
165 EXECUTE_TEST(execute_calc_protection_signature_test, tear_down);
169 static int test_cmp_calc_protection_pbmac(void)
171 unsigned char sec_insta[] = { 'i', 'n', 's', 't', 'a' };
173 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
174 if (!TEST_ptr(fixture->secret = ASN1_OCTET_STRING_new())
175 || !TEST_true(ASN1_OCTET_STRING_set
176 (fixture->secret, sec_insta, sizeof(sec_insta)))
177 || !TEST_ptr(fixture->msg = load_pkimsg(ip_PBM_f))) {
181 EXECUTE_TEST(execute_calc_protection_pbmac_test, tear_down);
184 static int execute_MSG_protect_test(CMP_PROTECT_TEST_FIXTURE *fixture)
186 return TEST_int_eq(fixture->expected,
187 ossl_cmp_msg_protect(fixture->cmp_ctx, fixture->msg));
190 #define SET_OPT_UNPROTECTED_SEND(ctx, val) \
191 OSSL_CMP_CTX_set_option((ctx), OSSL_CMP_OPT_UNPROTECTED_SEND, (val))
192 static int test_MSG_protect_unprotected_request(void)
194 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
196 fixture->expected = 1;
197 if (!TEST_ptr(fixture->msg = OSSL_CMP_MSG_dup(ir_unprotected))
198 || !TEST_true(SET_OPT_UNPROTECTED_SEND(fixture->cmp_ctx, 1))) {
202 EXECUTE_TEST(execute_MSG_protect_test, tear_down);
206 static int test_MSG_protect_with_msg_sig_alg_protection_plus_rsa_key(void)
208 const size_t size = sizeof(rand_data) / 2;
210 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
211 fixture->expected = 1;
213 if (!TEST_ptr(fixture->msg =
214 OSSL_CMP_MSG_dup(ir_unprotected))
215 || !TEST_true(SET_OPT_UNPROTECTED_SEND(fixture->cmp_ctx, 0))
217 * Use half of the 16 bytes of random input
218 * for each reference and secret value
220 || !TEST_true(OSSL_CMP_CTX_set1_referenceValue(fixture->cmp_ctx,
222 || !TEST_true(OSSL_CMP_CTX_set1_secretValue(fixture->cmp_ctx,
228 EXECUTE_TEST(execute_MSG_protect_test, tear_down);
232 static int test_MSG_protect_with_certificate_and_key(void)
234 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
235 fixture->expected = 1;
237 if (!TEST_ptr(fixture->msg =
238 OSSL_CMP_MSG_dup(ir_unprotected))
239 || !TEST_true(SET_OPT_UNPROTECTED_SEND(fixture->cmp_ctx, 0))
240 || !TEST_true(OSSL_CMP_CTX_set1_pkey(fixture->cmp_ctx, loadedkey))
241 || !TEST_true(OSSL_CMP_CTX_set1_clCert(fixture->cmp_ctx, cert))) {
245 EXECUTE_TEST(execute_MSG_protect_test, tear_down);
249 static int test_MSG_protect_certificate_based_without_cert(void)
251 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
252 OSSL_CMP_CTX *ctx = fixture->cmp_ctx;
254 fixture->expected = 0;
255 if (!TEST_ptr(fixture->msg =
256 OSSL_CMP_MSG_dup(ir_unprotected))
257 || !TEST_true(SET_OPT_UNPROTECTED_SEND(ctx, 0))
258 || !TEST_true(OSSL_CMP_CTX_set0_newPkey(ctx, 1, loadedkey))) {
262 EVP_PKEY_up_ref(loadedkey);
263 EXECUTE_TEST(execute_MSG_protect_test, tear_down);
267 static int test_MSG_protect_no_key_no_secret(void)
269 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
270 fixture->expected = 0;
271 if (!TEST_ptr(fixture->msg = OSSL_CMP_MSG_dup(ir_unprotected))
272 || !TEST_true(SET_OPT_UNPROTECTED_SEND(fixture->cmp_ctx, 0))) {
276 EXECUTE_TEST(execute_MSG_protect_test, tear_down);
280 static int execute_MSG_add_extraCerts_test(CMP_PROTECT_TEST_FIXTURE *fixture)
282 return TEST_true(ossl_cmp_msg_add_extraCerts(fixture->cmp_ctx,
286 static int test_MSG_add_extraCerts(void)
288 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
289 if (!TEST_ptr(fixture->msg = OSSL_CMP_MSG_dup(ir_protected))) {
293 EXECUTE_TEST(execute_MSG_add_extraCerts_test, tear_down);
297 #ifndef OPENSSL_NO_EC
298 /* The cert chain tests use EC certs so we skip them in no-ec builds */
299 static int execute_cmp_build_cert_chain_test(CMP_PROTECT_TEST_FIXTURE *fixture)
301 STACK_OF(X509) *result = NULL;
304 if (TEST_ptr(result = ossl_cmp_build_cert_chain(fixture->certs,
306 /* Check whether chain built is equal to the expected one */
307 ret = TEST_int_eq(0, STACK_OF_X509_cmp(result, fixture->chain));
308 sk_X509_pop_free(result, X509_free);
313 static int test_cmp_build_cert_chain(void)
315 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
316 fixture->cert = endentity2;
317 if (!TEST_ptr(fixture->certs = sk_X509_new_null())
318 || !TEST_ptr(fixture->chain = sk_X509_new_null())
319 || !TEST_true(sk_X509_push(fixture->certs, endentity1))
320 || !TEST_true(sk_X509_push(fixture->certs, root))
321 || !TEST_true(sk_X509_push(fixture->certs, intermediate))
322 || !TEST_true(sk_X509_push(fixture->chain, endentity2))
323 || !TEST_true(sk_X509_push(fixture->chain, intermediate))) {
327 EXECUTE_TEST(execute_cmp_build_cert_chain_test, tear_down);
331 static int test_cmp_build_cert_chain_missing_intermediate(void)
333 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
334 fixture->cert = endentity2;
335 if (!TEST_ptr(fixture->certs = sk_X509_new_null())
336 || !TEST_ptr(fixture->chain = sk_X509_new_null())
337 || !TEST_true(sk_X509_push(fixture->certs, endentity1))
338 || !TEST_true(sk_X509_push(fixture->certs, root))
339 || !TEST_true(sk_X509_push(fixture->chain, endentity2))) {
343 EXECUTE_TEST(execute_cmp_build_cert_chain_test, tear_down);
347 static int test_cmp_build_cert_chain_missing_root(void)
349 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
350 fixture->cert = endentity2;
351 if (!TEST_ptr(fixture->certs = sk_X509_new_null())
352 || !TEST_ptr(fixture->chain = sk_X509_new_null())
353 || !TEST_true(sk_X509_push(fixture->certs, endentity1))
354 || !TEST_true(sk_X509_push(fixture->certs, intermediate))
355 || !TEST_true(sk_X509_push(fixture->chain, endentity2))
356 || !TEST_true(sk_X509_push(fixture->chain, intermediate))) {
360 EXECUTE_TEST(execute_cmp_build_cert_chain_test, tear_down);
364 static int test_cmp_build_cert_chain_no_certs(void)
366 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
367 fixture->cert = endentity2;
368 if (!TEST_ptr(fixture->certs = sk_X509_new_null())
369 || !TEST_ptr(fixture->chain = sk_X509_new_null())
370 || !TEST_true(sk_X509_push(fixture->chain, endentity2))) {
374 EXECUTE_TEST(execute_cmp_build_cert_chain_test, tear_down);
377 #endif /* OPENSSL_NO_EC */
379 static int execute_X509_STORE_test(CMP_PROTECT_TEST_FIXTURE *fixture)
381 X509_STORE *store = X509_STORE_new();
382 STACK_OF(X509) *sk = NULL;
385 if (!TEST_true(ossl_cmp_X509_STORE_add1_certs(store,
387 fixture->callback_arg)))
389 sk = ossl_cmp_X509_STORE_get1_certs(store);
390 if (!TEST_int_eq(0, STACK_OF_X509_cmp(sk, fixture->chain)))
394 X509_STORE_free(store);
395 sk_X509_pop_free(sk, X509_free);
400 static int test_X509_STORE(void)
402 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
403 fixture->callback_arg = 0; /* self-signed allowed */
404 if (!TEST_ptr(fixture->certs = sk_X509_new_null())
405 || !sk_X509_push(fixture->certs, endentity1)
406 || !sk_X509_push(fixture->certs, endentity2)
407 || !sk_X509_push(fixture->certs, root)
408 || !sk_X509_push(fixture->certs, intermediate)
409 || !TEST_ptr(fixture->chain = sk_X509_dup(fixture->certs))) {
413 EXECUTE_TEST(execute_X509_STORE_test, tear_down);
417 static int test_X509_STORE_only_self_signed(void)
419 SETUP_TEST_FIXTURE(CMP_PROTECT_TEST_FIXTURE, set_up);
420 fixture->certs = sk_X509_new_null();
421 fixture->chain = sk_X509_new_null();
422 fixture->callback_arg = 1; /* only self-signed */
423 if (!TEST_true(sk_X509_push(fixture->certs, endentity1))
424 || !TEST_true(sk_X509_push(fixture->certs, endentity2))
425 || !TEST_true(sk_X509_push(fixture->certs, root))
426 || !TEST_true(sk_X509_push(fixture->certs, intermediate))
427 || !TEST_true(sk_X509_push(fixture->chain, root))) {
431 EXECUTE_TEST(execute_X509_STORE_test, tear_down);
436 void cleanup_tests(void)
438 EVP_PKEY_free(loadedprivkey);
439 EVP_PKEY_free(loadedpubkey);
440 EVP_PKEY_free(loadedkey);
442 X509_free(endentity1);
443 X509_free(endentity2);
445 X509_free(intermediate);
446 OSSL_CMP_MSG_free(ir_protected);
447 OSSL_CMP_MSG_free(ir_unprotected);
451 int setup_tests(void)
459 char *intermediate_f;
461 if (!test_skip_common_options()) {
462 TEST_error("Error parsing test options\n");
466 RAND_bytes(rand_data, OSSL_CMP_TRANSACTIONID_LENGTH);
467 if (!TEST_ptr(server_f = test_get_argument(0))
468 || !TEST_ptr(ir_protected_f = test_get_argument(1))
469 || !TEST_ptr(ir_unprotected_f = test_get_argument(2))
470 || !TEST_ptr(ip_PBM_f = test_get_argument(3))
471 || !TEST_ptr(server_cert_f = test_get_argument(4))
472 || !TEST_ptr(server_key_f = test_get_argument(5))
473 || !TEST_ptr(endentity1_f = test_get_argument(6))
474 || !TEST_ptr(endentity2_f = test_get_argument(7))
475 || !TEST_ptr(root_f = test_get_argument(8))
476 || !TEST_ptr(intermediate_f = test_get_argument(9))) {
477 TEST_error("usage: cmp_protect_test server.pem "
478 "IR_protected.der IR_unprotected.der IP_PBM.der "
479 "server.crt server.pem"
480 "EndEntity1.crt EndEntity2.crt "
481 "Root_CA.crt Intermediate_CA.crt\n");
484 if (!TEST_ptr(loadedkey = load_pem_key(server_key_f))
485 || !TEST_ptr(cert = load_pem_cert(server_cert_f)))
488 if (!TEST_ptr(loadedprivkey = load_pem_key(server_f)))
490 if (TEST_true(EVP_PKEY_up_ref(loadedprivkey)))
491 loadedpubkey = loadedprivkey;
492 if (!TEST_ptr(ir_protected = load_pkimsg(ir_protected_f))
493 || !TEST_ptr(ir_unprotected = load_pkimsg(ir_unprotected_f)))
495 if (!TEST_ptr(endentity1 = load_pem_cert(endentity1_f))
496 || !TEST_ptr(endentity2 = load_pem_cert(endentity2_f))
497 || !TEST_ptr(root = load_pem_cert(root_f))
498 || !TEST_ptr(intermediate = load_pem_cert(intermediate_f)))
500 if (!TEST_int_eq(1, RAND_bytes(rand_data, OSSL_CMP_TRANSACTIONID_LENGTH)))
503 /* Message protection tests */
504 ADD_TEST(test_cmp_calc_protection_no_key_no_secret);
505 ADD_TEST(test_cmp_calc_protection_pkey);
506 ADD_TEST(test_cmp_calc_protection_pbmac);
508 ADD_TEST(test_MSG_protect_with_msg_sig_alg_protection_plus_rsa_key);
509 ADD_TEST(test_MSG_protect_with_certificate_and_key);
510 ADD_TEST(test_MSG_protect_certificate_based_without_cert);
511 ADD_TEST(test_MSG_protect_unprotected_request);
512 ADD_TEST(test_MSG_protect_no_key_no_secret);
514 ADD_TEST(test_MSG_add_extraCerts);
516 #ifndef OPENSSL_NO_EC
517 ADD_TEST(test_cmp_build_cert_chain);
518 ADD_TEST(test_cmp_build_cert_chain_missing_root);
519 ADD_TEST(test_cmp_build_cert_chain_missing_intermediate);
520 ADD_TEST(test_cmp_build_cert_chain_no_certs);
523 ADD_TEST(test_X509_STORE);
524 ADD_TEST(test_X509_STORE_only_self_signed);