2 * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
12 #include <openssl/opensslconf.h>
13 #include <openssl/bio.h>
14 #include <openssl/crypto.h>
15 #include <openssl/ssl.h>
16 #include <openssl/ocsp.h>
18 #include "ssltestlib.h"
20 #include "test_main_custom.h"
22 static char *cert = NULL;
23 static char *privkey = NULL;
25 static const unsigned char orespder[] = "Dummy OCSP Response";
26 static int ocsp_server_called = 0;
27 static int ocsp_client_called = 0;
29 static int cdummyarg = 1;
30 static X509 *ocspcert = NULL;
32 #define NUM_EXTRA_CERTS 40
34 static int execute_test_large_message(const SSL_METHOD *smeth,
35 const SSL_METHOD *cmeth, int read_ahead)
37 SSL_CTX *cctx = NULL, *sctx = NULL;
38 SSL *clientssl = NULL, *serverssl = NULL;
41 BIO *certbio = BIO_new_file(cert, "r");
42 X509 *chaincert = NULL;
45 if (certbio == NULL) {
46 printf("Can't load the certficate file\n");
49 chaincert = PEM_read_bio_X509(certbio, NULL, NULL, NULL);
52 if (chaincert == NULL) {
53 printf("Unable to load certificate for chain\n");
57 if (!create_ssl_ctx_pair(smeth, cmeth, &sctx,
58 &cctx, cert, privkey)) {
59 printf("Unable to create SSL_CTX pair\n");
65 * Test that read_ahead works correctly when dealing with large
68 SSL_CTX_set_read_ahead(cctx, 1);
72 * We assume the supplied certificate is big enough so that if we add
73 * NUM_EXTRA_CERTS it will make the overall message large enough. The
74 * default buffer size is requested to be 16k, but due to the way BUF_MEM
75 * works, it ends up allocing a little over 21k (16 * 4/3). So, in this test
76 * we need to have a message larger than that.
78 certlen = i2d_X509(chaincert, NULL);
79 OPENSSL_assert((certlen * NUM_EXTRA_CERTS)
80 > ((SSL3_RT_MAX_PLAIN_LENGTH * 4) / 3));
81 for (i = 0; i < NUM_EXTRA_CERTS; i++) {
82 if (!X509_up_ref(chaincert)) {
83 printf("Unable to up ref cert\n");
86 if (!SSL_CTX_add_extra_chain_cert(sctx, chaincert)) {
87 printf("Unable to add extra chain cert %d\n", i);
93 if (!create_ssl_objects(sctx, cctx, &serverssl, &clientssl, NULL, NULL)) {
94 printf("Unable to create SSL objects\n");
98 if (!create_ssl_connection(serverssl, clientssl)) {
99 printf("Unable to create SSL connection\n");
104 * Calling SSL_clear() first is not required but this tests that SSL_clear()
105 * doesn't leak (when using enable-crypto-mdebug).
107 if (!SSL_clear(serverssl)) {
108 printf("Unexpected failure from SSL_clear()\n");
114 X509_free(chaincert);
123 static int test_large_message_tls(void)
125 return execute_test_large_message(TLS_server_method(), TLS_client_method(),
129 static int test_large_message_tls_read_ahead(void)
131 return execute_test_large_message(TLS_server_method(), TLS_client_method(),
135 #ifndef OPENSSL_NO_DTLS
136 static int test_large_message_dtls(void)
139 * read_ahead is not relevant to DTLS because DTLS always acts as if
142 return execute_test_large_message(DTLS_server_method(),
143 DTLS_client_method(), 0);
147 static int ocsp_server_cb(SSL *s, void *arg)
149 int *argi = (int *)arg;
150 unsigned char *orespdercopy = NULL;
151 STACK_OF(OCSP_RESPID) *ids = NULL;
152 OCSP_RESPID *id = NULL;
155 /* In this test we are expecting exactly 1 OCSP_RESPID */
156 SSL_get_tlsext_status_ids(s, &ids);
157 if (ids == NULL || sk_OCSP_RESPID_num(ids) != 1)
158 return SSL_TLSEXT_ERR_ALERT_FATAL;
160 id = sk_OCSP_RESPID_value(ids, 0);
161 if (id == NULL || !OCSP_RESPID_match(id, ocspcert))
162 return SSL_TLSEXT_ERR_ALERT_FATAL;
163 } else if (*argi != 1) {
164 return SSL_TLSEXT_ERR_ALERT_FATAL;
168 orespdercopy = OPENSSL_memdup(orespder, sizeof(orespder));
169 if (orespdercopy == NULL)
170 return SSL_TLSEXT_ERR_ALERT_FATAL;
172 SSL_set_tlsext_status_ocsp_resp(s, orespdercopy, sizeof(orespder));
174 ocsp_server_called = 1;
176 return SSL_TLSEXT_ERR_OK;
179 static int ocsp_client_cb(SSL *s, void *arg)
181 int *argi = (int *)arg;
182 const unsigned char *respderin;
185 if (*argi != 1 && *argi != 2)
188 len = SSL_get_tlsext_status_ocsp_resp(s, &respderin);
190 if (memcmp(orespder, respderin, len) != 0)
193 ocsp_client_called = 1;
198 static int test_tlsext_status_type(void)
200 SSL_CTX *cctx = NULL, *sctx = NULL;
201 SSL *clientssl = NULL, *serverssl = NULL;
203 STACK_OF(OCSP_RESPID) *ids = NULL;
204 OCSP_RESPID *id = NULL;
207 if (!create_ssl_ctx_pair(TLS_server_method(), TLS_client_method(), &sctx,
208 &cctx, cert, privkey)) {
209 printf("Unable to create SSL_CTX pair\n");
213 if (SSL_CTX_get_tlsext_status_type(cctx) != -1) {
214 printf("Unexpected initial value for "
215 "SSL_CTX_get_tlsext_status_type()\n");
219 /* First just do various checks getting and setting tlsext_status_type */
221 clientssl = SSL_new(cctx);
222 if (SSL_get_tlsext_status_type(clientssl) != -1) {
223 printf("Unexpected initial value for SSL_get_tlsext_status_type()\n");
227 if (!SSL_set_tlsext_status_type(clientssl, TLSEXT_STATUSTYPE_ocsp)) {
228 printf("Unexpected fail for SSL_set_tlsext_status_type()\n");
232 if (SSL_get_tlsext_status_type(clientssl) != TLSEXT_STATUSTYPE_ocsp) {
233 printf("Unexpected result for SSL_get_tlsext_status_type()\n");
240 if (!SSL_CTX_set_tlsext_status_type(cctx, TLSEXT_STATUSTYPE_ocsp)) {
241 printf("Unexpected fail for SSL_CTX_set_tlsext_status_type()\n");
245 if (SSL_CTX_get_tlsext_status_type(cctx) != TLSEXT_STATUSTYPE_ocsp) {
246 printf("Unexpected result for SSL_CTX_get_tlsext_status_type()\n");
250 clientssl = SSL_new(cctx);
252 if (SSL_get_tlsext_status_type(clientssl) != TLSEXT_STATUSTYPE_ocsp) {
253 printf("Unexpected result for SSL_get_tlsext_status_type() (test 2)\n");
261 * Now actually do a handshake and check OCSP information is exchanged and
262 * the callbacks get called
265 SSL_CTX_set_tlsext_status_cb(cctx, ocsp_client_cb);
266 SSL_CTX_set_tlsext_status_arg(cctx, &cdummyarg);
267 SSL_CTX_set_tlsext_status_cb(sctx, ocsp_server_cb);
268 SSL_CTX_set_tlsext_status_arg(sctx, &cdummyarg);
270 if (!create_ssl_objects(sctx, cctx, &serverssl, &clientssl, NULL, NULL)) {
271 printf("Unable to create SSL objects\n");
275 if (!create_ssl_connection(serverssl, clientssl)) {
276 printf("Unable to create SSL connection\n");
280 if (!ocsp_client_called || !ocsp_server_called) {
281 printf("OCSP callbacks not called\n");
290 /* Try again but this time force the server side callback to fail */
291 ocsp_client_called = 0;
292 ocsp_server_called = 0;
295 if (!create_ssl_objects(sctx, cctx, &serverssl, &clientssl, NULL, NULL)) {
296 printf("Unable to create SSL objects\n");
300 /* This should fail because the callback will fail */
301 if (create_ssl_connection(serverssl, clientssl)) {
302 printf("Unexpected success creating the connection\n");
306 if (ocsp_client_called || ocsp_server_called) {
307 printf("OCSP callbacks successfully called unexpectedly\n");
317 * This time we'll get the client to send an OCSP_RESPID that it will
320 ocsp_client_called = 0;
321 ocsp_server_called = 0;
324 if (!create_ssl_objects(sctx, cctx, &serverssl, &clientssl, NULL, NULL)) {
325 printf("Unable to create SSL objects\n");
330 * We'll just use any old cert for this test - it doesn't have to be an OCSP
331 * specifc one. We'll use the server cert.
333 certbio = BIO_new_file(cert, "r");
334 if (certbio == NULL) {
335 printf("Can't load the certficate file\n");
338 id = OCSP_RESPID_new();
339 ids = sk_OCSP_RESPID_new_null();
340 ocspcert = PEM_read_bio_X509(certbio, NULL, NULL, NULL);
341 if (id == NULL || ids == NULL || ocspcert == NULL
342 || !OCSP_RESPID_set_by_key(id, ocspcert)
343 || !sk_OCSP_RESPID_push(ids, id)) {
344 printf("Unable to set OCSP_RESPIDs\n");
348 SSL_set_tlsext_status_ids(clientssl, ids);
349 /* Control has been transferred */
355 if (!create_ssl_connection(serverssl, clientssl)) {
356 printf("Unable to create SSL connection\n");
360 if (!ocsp_client_called || !ocsp_server_called) {
361 printf("OCSP callbacks not called\n");
372 sk_OCSP_RESPID_pop_free(ids, OCSP_RESPID_free);
373 OCSP_RESPID_free(id);
381 typedef struct ssl_session_test_fixture {
382 const char *test_case_name;
385 } SSL_SESSION_TEST_FIXTURE;
387 static int new_called = 0, remove_called = 0;
389 static SSL_SESSION_TEST_FIXTURE
390 ssl_session_set_up(const char *const test_case_name)
392 SSL_SESSION_TEST_FIXTURE fixture;
394 fixture.test_case_name = test_case_name;
395 fixture.use_ext_cache = 1;
396 fixture.use_int_cache = 1;
398 new_called = remove_called = 0;
403 static void ssl_session_tear_down(SSL_SESSION_TEST_FIXTURE fixture)
407 static int new_session_cb(SSL *ssl, SSL_SESSION *sess)
414 static void remove_session_cb(SSL_CTX *ctx, SSL_SESSION *sess)
419 static int execute_test_session(SSL_SESSION_TEST_FIXTURE fix)
421 SSL_CTX *sctx = NULL, *cctx = NULL;
422 SSL *serverssl1 = NULL, *clientssl1 = NULL;
423 SSL *serverssl2 = NULL, *clientssl2 = NULL;
424 #ifndef OPENSSL_NO_TLS1_1
425 SSL *serverssl3 = NULL, *clientssl3 = NULL;
427 SSL_SESSION *sess1 = NULL, *sess2 = NULL;
430 if (!create_ssl_ctx_pair(TLS_server_method(), TLS_client_method(), &sctx,
431 &cctx, cert, privkey)) {
432 printf("Unable to create SSL_CTX pair\n");
436 #ifndef OPENSSL_NO_TLS1_2
437 /* Only allow TLS1.2 so we can force a connection failure later */
438 SSL_CTX_set_min_proto_version(cctx, TLS1_2_VERSION);
442 * TODO(TLS1.3): Test temporarily disabled for TLS1.3 until we've
443 * implemented session resumption.
445 SSL_CTX_set_max_proto_version(cctx, TLS1_2_VERSION);
447 /* Set up session cache */
448 if (fix.use_ext_cache) {
449 SSL_CTX_sess_set_new_cb(cctx, new_session_cb);
450 SSL_CTX_sess_set_remove_cb(cctx, remove_session_cb);
452 if (fix.use_int_cache) {
453 /* Also covers instance where both are set */
454 SSL_CTX_set_session_cache_mode(cctx, SSL_SESS_CACHE_CLIENT);
456 SSL_CTX_set_session_cache_mode(cctx,
457 SSL_SESS_CACHE_CLIENT
458 | SSL_SESS_CACHE_NO_INTERNAL_STORE);
461 if (!create_ssl_objects(sctx, cctx, &serverssl1, &clientssl1, NULL,
463 printf("Unable to create SSL objects\n");
467 if (!create_ssl_connection(serverssl1, clientssl1)) {
468 printf("Unable to create SSL connection\n");
471 sess1 = SSL_get1_session(clientssl1);
473 printf("Unexpected NULL session\n");
477 if (fix.use_int_cache && SSL_CTX_add_session(cctx, sess1)) {
478 /* Should have failed because it should already be in the cache */
479 printf("Unexpected success adding session to cache\n");
483 if (fix.use_ext_cache && (new_called != 1 || remove_called != 0)) {
484 printf("Session not added to cache\n");
488 if (!create_ssl_objects(sctx, cctx, &serverssl2, &clientssl2, NULL, NULL)) {
489 printf("Unable to create second SSL objects\n");
493 if (!create_ssl_connection(serverssl2, clientssl2)) {
494 printf("Unable to create second SSL connection\n");
498 sess2 = SSL_get1_session(clientssl2);
500 printf("Unexpected NULL session from clientssl2\n");
504 if (fix.use_ext_cache && (new_called != 2 || remove_called != 0)) {
505 printf("Remove session callback unexpectedly called\n");
510 * This should clear sess2 from the cache because it is a "bad" session. See
511 * SSL_set_session() documentation.
513 if (!SSL_set_session(clientssl2, sess1)) {
514 printf("Unexpected failure setting session\n");
518 if (fix.use_ext_cache && (new_called != 2 || remove_called != 1)) {
519 printf("Failed to call callback to remove session\n");
524 if (SSL_get_session(clientssl2) != sess1) {
525 printf("Unexpected session found\n");
529 if (fix.use_int_cache) {
530 if (!SSL_CTX_add_session(cctx, sess2)) {
532 * Should have succeeded because it should not already be in the cache
534 printf("Unexpected failure adding session to cache\n");
538 if (!SSL_CTX_remove_session(cctx, sess2)) {
539 printf("Unexpected failure removing session from cache\n");
543 /* This is for the purposes of internal cache testing...ignore the
544 * counter for external cache
546 if (fix.use_ext_cache)
550 /* This shouldn't be in the cache so should fail */
551 if (SSL_CTX_remove_session(cctx, sess2)) {
552 printf("Unexpected success removing session from cache\n");
556 if (fix.use_ext_cache && (new_called != 2 || remove_called != 2)) {
557 printf("Failed to call callback to remove session #2\n");
561 #if !defined(OPENSSL_NO_TLS1_1) && !defined(OPENSSL_NO_TLS1_2)
562 /* Force a connection failure */
563 SSL_CTX_set_max_proto_version(sctx, TLS1_1_VERSION);
565 if (!create_ssl_objects(sctx, cctx, &serverssl3, &clientssl3, NULL, NULL)) {
566 printf("Unable to create third SSL objects\n");
570 if (!SSL_set_session(clientssl3, sess1)) {
571 printf("Unable to set session for third connection\n");
575 /* This should fail because of the mismatched protocol versions */
576 if (create_ssl_connection(serverssl3, clientssl3)) {
577 printf("Unable to create third SSL connection\n");
582 /* We should have automatically removed the session from the cache */
583 if (fix.use_ext_cache && (new_called != 2 || remove_called != 3)) {
584 printf("Failed to call callback to remove session #2\n");
588 if (fix.use_int_cache && !SSL_CTX_add_session(cctx, sess2)) {
590 * Should have succeeded because it should not already be in the cache
592 printf("Unexpected failure adding session to cache #2\n");
600 SSL_free(serverssl1);
601 SSL_free(clientssl1);
602 SSL_free(serverssl2);
603 SSL_free(clientssl2);
604 #ifndef OPENSSL_NO_TLS1_1
605 SSL_free(serverssl3);
606 SSL_free(clientssl3);
608 SSL_SESSION_free(sess1);
609 SSL_SESSION_free(sess2);
611 * Check if we need to remove any sessions up-refed for the external cache
614 SSL_SESSION_free(sess1);
616 SSL_SESSION_free(sess2);
623 static int test_session_with_only_int_cache(void)
625 SETUP_TEST_FIXTURE(SSL_SESSION_TEST_FIXTURE, ssl_session_set_up);
627 fixture.use_ext_cache = 0;
629 EXECUTE_TEST(execute_test_session, ssl_session_tear_down);
632 static int test_session_with_only_ext_cache(void)
634 SETUP_TEST_FIXTURE(SSL_SESSION_TEST_FIXTURE, ssl_session_set_up);
636 fixture.use_int_cache = 0;
638 EXECUTE_TEST(execute_test_session, ssl_session_tear_down);
641 static int test_session_with_both_cache(void)
643 SETUP_TEST_FIXTURE(SSL_SESSION_TEST_FIXTURE, ssl_session_set_up);
645 EXECUTE_TEST(execute_test_session, ssl_session_tear_down);
652 #define TOTAL_SSL_SET_BIO_TESTS (3 * 3 * 3 * 3)
654 static void setupbio(BIO **res, BIO *bio1, BIO *bio2, int type)
669 static int test_ssl_set_bio(int idx)
671 SSL_CTX *ctx = SSL_CTX_new(TLS_method());
674 BIO *irbio = NULL, *iwbio = NULL, *nrbio = NULL, *nwbio = NULL;
676 int initrbio, initwbio, newrbio, newwbio;
680 printf("Failed to allocate SSL_CTX\n");
686 printf("Failed to allocate SSL object\n");
697 OPENSSL_assert(newwbio <= 2);
699 if (initrbio == USE_BIO_1 || initwbio == USE_BIO_1 || newrbio == USE_BIO_1
700 || newwbio == USE_BIO_1) {
701 bio1 = BIO_new(BIO_s_mem());
703 printf("Failed to allocate bio1\n");
708 if (initrbio == USE_BIO_2 || initwbio == USE_BIO_2 || newrbio == USE_BIO_2
709 || newwbio == USE_BIO_2) {
710 bio2 = BIO_new(BIO_s_mem());
712 printf("Failed to allocate bio2\n");
717 setupbio(&irbio, bio1, bio2, initrbio);
718 setupbio(&iwbio, bio1, bio2, initwbio);
721 * We want to maintain our own refs to these BIO, so do an up ref for each
722 * BIO that will have ownersip transferred in the SSL_set_bio() call
726 if (iwbio != NULL && iwbio != irbio)
729 SSL_set_bio(ssl, irbio, iwbio);
731 setupbio(&nrbio, bio1, bio2, newrbio);
732 setupbio(&nwbio, bio1, bio2, newwbio);
735 * We will (maybe) transfer ownership again so do more up refs.
736 * SSL_set_bio() has some really complicated ownership rules where BIOs have
739 if (nrbio != NULL && nrbio != irbio && (nwbio != iwbio || nrbio != nwbio))
741 if (nwbio != NULL && nwbio != nrbio && (nwbio != iwbio || (nwbio == iwbio && irbio == iwbio)))
744 SSL_set_bio(ssl, nrbio, nwbio);
753 * This test is checking that the ref counting for SSL_set_bio is correct.
754 * If we get here and we did too many frees then we will fail in the above
755 * functions. If we haven't done enough then this will only be detected in
756 * a crypto-mdebug build
763 typedef struct ssl_bio_test_fixture {
764 const char *test_case_name;
766 enum { NO_BIO_CHANGE, CHANGE_RBIO, CHANGE_WBIO } change_bio;
767 } SSL_BIO_TEST_FIXTURE;
769 static SSL_BIO_TEST_FIXTURE ssl_bio_set_up(const char *const test_case_name)
771 SSL_BIO_TEST_FIXTURE fixture;
773 fixture.test_case_name = test_case_name;
775 fixture.change_bio = NO_BIO_CHANGE;
780 static void ssl_bio_tear_down(SSL_BIO_TEST_FIXTURE fixture)
784 static int execute_test_ssl_bio(SSL_BIO_TEST_FIXTURE fix)
786 BIO *sslbio = NULL, *membio1 = NULL, *membio2 = NULL;
787 SSL_CTX *ctx = SSL_CTX_new(TLS_method());
792 printf("Failed to allocate SSL_CTX\n");
798 printf("Failed to allocate SSL object\n");
802 sslbio = BIO_new(BIO_f_ssl());
803 membio1 = BIO_new(BIO_s_mem());
805 if (sslbio == NULL || membio1 == NULL) {
806 printf("Malloc failure creating BIOs\n");
810 BIO_set_ssl(sslbio, ssl, BIO_CLOSE);
813 * If anything goes wrong here then we could leak memory, so this will
814 * be caught in a crypto-mdebug build
816 BIO_push(sslbio, membio1);
818 /* Verify chaning the rbio/wbio directly does not cause leaks */
819 if (fix.change_bio != NO_BIO_CHANGE) {
820 membio2 = BIO_new(BIO_s_mem());
821 if (membio2 == NULL) {
822 printf("Malloc failure creating membio2\n");
825 if (fix.change_bio == CHANGE_RBIO)
826 SSL_set0_rbio(ssl, membio2);
828 SSL_set0_wbio(ssl, membio2);
847 static int test_ssl_bio_pop_next_bio(void)
849 SETUP_TEST_FIXTURE(SSL_BIO_TEST_FIXTURE, ssl_bio_set_up);
851 EXECUTE_TEST(execute_test_ssl_bio, ssl_bio_tear_down);
854 static int test_ssl_bio_pop_ssl_bio(void)
856 SETUP_TEST_FIXTURE(SSL_BIO_TEST_FIXTURE, ssl_bio_set_up);
860 EXECUTE_TEST(execute_test_ssl_bio, ssl_bio_tear_down);
863 static int test_ssl_bio_change_rbio(void)
865 SETUP_TEST_FIXTURE(SSL_BIO_TEST_FIXTURE, ssl_bio_set_up);
867 fixture.change_bio = CHANGE_RBIO;
869 EXECUTE_TEST(execute_test_ssl_bio, ssl_bio_tear_down);
872 static int test_ssl_bio_change_wbio(void)
874 SETUP_TEST_FIXTURE(SSL_BIO_TEST_FIXTURE, ssl_bio_set_up);
876 fixture.change_bio = CHANGE_WBIO;
878 EXECUTE_TEST(execute_test_ssl_bio, ssl_bio_tear_down);
881 int test_main(int argc, char *argv[])
886 printf("Invalid argument count\n");
893 ADD_TEST(test_large_message_tls);
894 ADD_TEST(test_large_message_tls_read_ahead);
895 #ifndef OPENSSL_NO_DTLS
896 ADD_TEST(test_large_message_dtls);
898 ADD_TEST(test_tlsext_status_type);
899 ADD_TEST(test_session_with_only_int_cache);
900 ADD_TEST(test_session_with_only_ext_cache);
901 ADD_TEST(test_session_with_both_cache);
902 ADD_ALL_TESTS(test_ssl_set_bio, TOTAL_SSL_SET_BIO_TESTS);
903 ADD_TEST(test_ssl_bio_pop_next_bio);
904 ADD_TEST(test_ssl_bio_pop_ssl_bio);
905 ADD_TEST(test_ssl_bio_change_rbio);
906 ADD_TEST(test_ssl_bio_change_wbio);
908 testresult = run_tests(argv[0]);
910 bio_s_mempacket_test_free();