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");
106 X509_free(chaincert);
115 static int test_large_message_tls(void)
117 return execute_test_large_message(TLS_server_method(), TLS_client_method(),
121 static int test_large_message_tls_read_ahead(void)
123 return execute_test_large_message(TLS_server_method(), TLS_client_method(),
127 #ifndef OPENSSL_NO_DTLS
128 static int test_large_message_dtls(void)
131 * read_ahead is not relevant to DTLS because DTLS always acts as if
134 return execute_test_large_message(DTLS_server_method(),
135 DTLS_client_method(), 0);
139 static int ocsp_server_cb(SSL *s, void *arg)
141 int *argi = (int *)arg;
142 unsigned char *orespdercopy = NULL;
143 STACK_OF(OCSP_RESPID) *ids = NULL;
144 OCSP_RESPID *id = NULL;
147 /* In this test we are expecting exactly 1 OCSP_RESPID */
148 SSL_get_tlsext_status_ids(s, &ids);
149 if (ids == NULL || sk_OCSP_RESPID_num(ids) != 1)
150 return SSL_TLSEXT_ERR_ALERT_FATAL;
152 id = sk_OCSP_RESPID_value(ids, 0);
153 if (id == NULL || !OCSP_RESPID_match(id, ocspcert))
154 return SSL_TLSEXT_ERR_ALERT_FATAL;
155 } else if (*argi != 1) {
156 return SSL_TLSEXT_ERR_ALERT_FATAL;
160 orespdercopy = OPENSSL_memdup(orespder, sizeof(orespder));
161 if (orespdercopy == NULL)
162 return SSL_TLSEXT_ERR_ALERT_FATAL;
164 SSL_set_tlsext_status_ocsp_resp(s, orespdercopy, sizeof(orespder));
166 ocsp_server_called = 1;
168 return SSL_TLSEXT_ERR_OK;
171 static int ocsp_client_cb(SSL *s, void *arg)
173 int *argi = (int *)arg;
174 const unsigned char *respderin;
177 if (*argi != 1 && *argi != 2)
180 len = SSL_get_tlsext_status_ocsp_resp(s, &respderin);
182 if (memcmp(orespder, respderin, len) != 0)
185 ocsp_client_called = 1;
190 static int test_tlsext_status_type(void)
192 SSL_CTX *cctx = NULL, *sctx = NULL;
193 SSL *clientssl = NULL, *serverssl = NULL;
195 STACK_OF(OCSP_RESPID) *ids = NULL;
196 OCSP_RESPID *id = NULL;
199 if (!create_ssl_ctx_pair(TLS_server_method(), TLS_client_method(), &sctx,
200 &cctx, cert, privkey)) {
201 printf("Unable to create SSL_CTX pair\n");
205 if (SSL_CTX_get_tlsext_status_type(cctx) != -1) {
206 printf("Unexpected initial value for "
207 "SSL_CTX_get_tlsext_status_type()\n");
211 /* First just do various checks getting and setting tlsext_status_type */
213 clientssl = SSL_new(cctx);
214 if (SSL_get_tlsext_status_type(clientssl) != -1) {
215 printf("Unexpected initial value for SSL_get_tlsext_status_type()\n");
219 if (!SSL_set_tlsext_status_type(clientssl, TLSEXT_STATUSTYPE_ocsp)) {
220 printf("Unexpected fail for SSL_set_tlsext_status_type()\n");
224 if (SSL_get_tlsext_status_type(clientssl) != TLSEXT_STATUSTYPE_ocsp) {
225 printf("Unexpected result for SSL_get_tlsext_status_type()\n");
232 if (!SSL_CTX_set_tlsext_status_type(cctx, TLSEXT_STATUSTYPE_ocsp)) {
233 printf("Unexpected fail for SSL_CTX_set_tlsext_status_type()\n");
237 if (SSL_CTX_get_tlsext_status_type(cctx) != TLSEXT_STATUSTYPE_ocsp) {
238 printf("Unexpected result for SSL_CTX_get_tlsext_status_type()\n");
242 clientssl = SSL_new(cctx);
244 if (SSL_get_tlsext_status_type(clientssl) != TLSEXT_STATUSTYPE_ocsp) {
245 printf("Unexpected result for SSL_get_tlsext_status_type() (test 2)\n");
253 * Now actually do a handshake and check OCSP information is exchanged and
254 * the callbacks get called
257 SSL_CTX_set_tlsext_status_cb(cctx, ocsp_client_cb);
258 SSL_CTX_set_tlsext_status_arg(cctx, &cdummyarg);
259 SSL_CTX_set_tlsext_status_cb(sctx, ocsp_server_cb);
260 SSL_CTX_set_tlsext_status_arg(sctx, &cdummyarg);
262 if (!create_ssl_objects(sctx, cctx, &serverssl, &clientssl, NULL, NULL)) {
263 printf("Unable to create SSL objects\n");
267 if (!create_ssl_connection(serverssl, clientssl)) {
268 printf("Unable to create SSL connection\n");
272 if (!ocsp_client_called || !ocsp_server_called) {
273 printf("OCSP callbacks not called\n");
282 /* Try again but this time force the server side callback to fail */
283 ocsp_client_called = 0;
284 ocsp_server_called = 0;
287 if (!create_ssl_objects(sctx, cctx, &serverssl, &clientssl, NULL, NULL)) {
288 printf("Unable to create SSL objects\n");
292 /* This should fail because the callback will fail */
293 if (create_ssl_connection(serverssl, clientssl)) {
294 printf("Unexpected success creating the connection\n");
298 if (ocsp_client_called || ocsp_server_called) {
299 printf("OCSP callbacks successfully called unexpectedly\n");
309 * This time we'll get the client to send an OCSP_RESPID that it will
312 ocsp_client_called = 0;
313 ocsp_server_called = 0;
316 if (!create_ssl_objects(sctx, cctx, &serverssl, &clientssl, NULL, NULL)) {
317 printf("Unable to create SSL objects\n");
322 * We'll just use any old cert for this test - it doesn't have to be an OCSP
323 * specifc one. We'll use the server cert.
325 certbio = BIO_new_file(cert, "r");
326 if (certbio == NULL) {
327 printf("Can't load the certficate file\n");
330 id = OCSP_RESPID_new();
331 ids = sk_OCSP_RESPID_new_null();
332 ocspcert = PEM_read_bio_X509(certbio, NULL, NULL, NULL);
333 if (id == NULL || ids == NULL || ocspcert == NULL
334 || !OCSP_RESPID_set_by_key(id, ocspcert)
335 || !sk_OCSP_RESPID_push(ids, id)) {
336 printf("Unable to set OCSP_RESPIDs\n");
340 SSL_set_tlsext_status_ids(clientssl, ids);
341 /* Control has been transferred */
347 if (!create_ssl_connection(serverssl, clientssl)) {
348 printf("Unable to create SSL connection\n");
352 if (!ocsp_client_called || !ocsp_server_called) {
353 printf("OCSP callbacks not called\n");
364 sk_OCSP_RESPID_pop_free(ids, OCSP_RESPID_free);
365 OCSP_RESPID_free(id);
373 typedef struct ssl_session_test_fixture {
374 const char *test_case_name;
377 } SSL_SESSION_TEST_FIXTURE;
379 static int new_called = 0, remove_called = 0;
381 static SSL_SESSION_TEST_FIXTURE
382 ssl_session_set_up(const char *const test_case_name)
384 SSL_SESSION_TEST_FIXTURE fixture;
386 fixture.test_case_name = test_case_name;
387 fixture.use_ext_cache = 1;
388 fixture.use_int_cache = 1;
390 new_called = remove_called = 0;
395 static void ssl_session_tear_down(SSL_SESSION_TEST_FIXTURE fixture)
399 static int new_session_cb(SSL *ssl, SSL_SESSION *sess)
406 static void remove_session_cb(SSL_CTX *ctx, SSL_SESSION *sess)
411 static int execute_test_session(SSL_SESSION_TEST_FIXTURE fix)
413 SSL_CTX *sctx = NULL, *cctx = NULL;
414 SSL *serverssl1 = NULL, *clientssl1 = NULL;
415 SSL *serverssl2 = NULL, *clientssl2 = NULL;
416 #ifndef OPENSSL_NO_TLS1_1
417 SSL *serverssl3 = NULL, *clientssl3 = NULL;
419 SSL_SESSION *sess1 = NULL, *sess2 = NULL;
422 if (!create_ssl_ctx_pair(TLS_server_method(), TLS_client_method(), &sctx,
423 &cctx, cert, privkey)) {
424 printf("Unable to create SSL_CTX pair\n");
428 #ifndef OPENSSL_NO_TLS1_2
429 /* Only allow TLS1.2 so we can force a connection failure later */
430 SSL_CTX_set_min_proto_version(cctx, TLS1_2_VERSION);
434 * TODO(TLS1.3): Test temporarily disabled for TLS1.3 until we've
435 * implemented session resumption.
437 SSL_CTX_set_max_proto_version(cctx, TLS1_2_VERSION);
439 /* Set up session cache */
440 if (fix.use_ext_cache) {
441 SSL_CTX_sess_set_new_cb(cctx, new_session_cb);
442 SSL_CTX_sess_set_remove_cb(cctx, remove_session_cb);
444 if (fix.use_int_cache) {
445 /* Also covers instance where both are set */
446 SSL_CTX_set_session_cache_mode(cctx, SSL_SESS_CACHE_CLIENT);
448 SSL_CTX_set_session_cache_mode(cctx,
449 SSL_SESS_CACHE_CLIENT
450 | SSL_SESS_CACHE_NO_INTERNAL_STORE);
453 if (!create_ssl_objects(sctx, cctx, &serverssl1, &clientssl1, NULL,
455 printf("Unable to create SSL objects\n");
459 if (!create_ssl_connection(serverssl1, clientssl1)) {
460 printf("Unable to create SSL connection\n");
463 sess1 = SSL_get1_session(clientssl1);
465 printf("Unexpected NULL session\n");
469 if (fix.use_int_cache && SSL_CTX_add_session(cctx, sess1)) {
470 /* Should have failed because it should already be in the cache */
471 printf("Unexpected success adding session to cache\n");
475 if (fix.use_ext_cache && (new_called != 1 || remove_called != 0)) {
476 printf("Session not added to cache\n");
480 if (!create_ssl_objects(sctx, cctx, &serverssl2, &clientssl2, NULL, NULL)) {
481 printf("Unable to create second SSL objects\n");
485 if (!create_ssl_connection(serverssl2, clientssl2)) {
486 printf("Unable to create second SSL connection\n");
490 sess2 = SSL_get1_session(clientssl2);
492 printf("Unexpected NULL session from clientssl2\n");
496 if (fix.use_ext_cache && (new_called != 2 || remove_called != 0)) {
497 printf("Remove session callback unexpectedly called\n");
502 * This should clear sess2 from the cache because it is a "bad" session. See
503 * SSL_set_session() documentation.
505 if (!SSL_set_session(clientssl2, sess1)) {
506 printf("Unexpected failure setting session\n");
510 if (fix.use_ext_cache && (new_called != 2 || remove_called != 1)) {
511 printf("Failed to call callback to remove session\n");
516 if (SSL_get_session(clientssl2) != sess1) {
517 printf("Unexpected session found\n");
521 if (fix.use_int_cache) {
522 if (!SSL_CTX_add_session(cctx, sess2)) {
524 * Should have succeeded because it should not already be in the cache
526 printf("Unexpected failure adding session to cache\n");
530 if (!SSL_CTX_remove_session(cctx, sess2)) {
531 printf("Unexpected failure removing session from cache\n");
535 /* This is for the purposes of internal cache testing...ignore the
536 * counter for external cache
538 if (fix.use_ext_cache)
542 /* This shouldn't be in the cache so should fail */
543 if (SSL_CTX_remove_session(cctx, sess2)) {
544 printf("Unexpected success removing session from cache\n");
548 if (fix.use_ext_cache && (new_called != 2 || remove_called != 2)) {
549 printf("Failed to call callback to remove session #2\n");
553 #if !defined(OPENSSL_NO_TLS1_1) && !defined(OPENSSL_NO_TLS1_2)
554 /* Force a connection failure */
555 SSL_CTX_set_max_proto_version(sctx, TLS1_1_VERSION);
557 if (!create_ssl_objects(sctx, cctx, &serverssl3, &clientssl3, NULL, NULL)) {
558 printf("Unable to create third SSL objects\n");
562 if (!SSL_set_session(clientssl3, sess1)) {
563 printf("Unable to set session for third connection\n");
567 /* This should fail because of the mismatched protocol versions */
568 if (create_ssl_connection(serverssl3, clientssl3)) {
569 printf("Unable to create third SSL connection\n");
574 /* We should have automatically removed the session from the cache */
575 if (fix.use_ext_cache && (new_called != 2 || remove_called != 3)) {
576 printf("Failed to call callback to remove session #2\n");
580 if (fix.use_int_cache && !SSL_CTX_add_session(cctx, sess2)) {
582 * Should have succeeded because it should not already be in the cache
584 printf("Unexpected failure adding session to cache #2\n");
592 SSL_free(serverssl1);
593 SSL_free(clientssl1);
594 SSL_free(serverssl2);
595 SSL_free(clientssl2);
596 #ifndef OPENSSL_NO_TLS1_1
597 SSL_free(serverssl3);
598 SSL_free(clientssl3);
600 SSL_SESSION_free(sess1);
601 SSL_SESSION_free(sess2);
603 * Check if we need to remove any sessions up-refed for the external cache
606 SSL_SESSION_free(sess1);
608 SSL_SESSION_free(sess2);
615 static int test_session_with_only_int_cache(void)
617 SETUP_TEST_FIXTURE(SSL_SESSION_TEST_FIXTURE, ssl_session_set_up);
619 fixture.use_ext_cache = 0;
621 EXECUTE_TEST(execute_test_session, ssl_session_tear_down);
624 static int test_session_with_only_ext_cache(void)
626 SETUP_TEST_FIXTURE(SSL_SESSION_TEST_FIXTURE, ssl_session_set_up);
628 fixture.use_int_cache = 0;
630 EXECUTE_TEST(execute_test_session, ssl_session_tear_down);
633 static int test_session_with_both_cache(void)
635 SETUP_TEST_FIXTURE(SSL_SESSION_TEST_FIXTURE, ssl_session_set_up);
637 EXECUTE_TEST(execute_test_session, ssl_session_tear_down);
644 #define TOTAL_SSL_SET_BIO_TESTS (3 * 3 * 3 * 3)
646 static void setupbio(BIO **res, BIO *bio1, BIO *bio2, int type)
661 static int test_ssl_set_bio(int idx)
663 SSL_CTX *ctx = SSL_CTX_new(TLS_method());
666 BIO *irbio = NULL, *iwbio = NULL, *nrbio = NULL, *nwbio = NULL;
668 int initrbio, initwbio, newrbio, newwbio;
672 printf("Failed to allocate SSL_CTX\n");
678 printf("Failed to allocate SSL object\n");
689 OPENSSL_assert(newwbio <= 2);
691 if (initrbio == USE_BIO_1 || initwbio == USE_BIO_1 || newrbio == USE_BIO_1
692 || newwbio == USE_BIO_1) {
693 bio1 = BIO_new(BIO_s_mem());
695 printf("Failed to allocate bio1\n");
700 if (initrbio == USE_BIO_2 || initwbio == USE_BIO_2 || newrbio == USE_BIO_2
701 || newwbio == USE_BIO_2) {
702 bio2 = BIO_new(BIO_s_mem());
704 printf("Failed to allocate bio2\n");
709 setupbio(&irbio, bio1, bio2, initrbio);
710 setupbio(&iwbio, bio1, bio2, initwbio);
713 * We want to maintain our own refs to these BIO, so do an up ref for each
714 * BIO that will have ownersip transferred in the SSL_set_bio() call
718 if (iwbio != NULL && iwbio != irbio)
721 SSL_set_bio(ssl, irbio, iwbio);
723 setupbio(&nrbio, bio1, bio2, newrbio);
724 setupbio(&nwbio, bio1, bio2, newwbio);
727 * We will (maybe) transfer ownership again so do more up refs.
728 * SSL_set_bio() has some really complicated ownership rules where BIOs have
731 if (nrbio != NULL && nrbio != irbio && (nwbio != iwbio || nrbio != nwbio))
733 if (nwbio != NULL && nwbio != nrbio && (nwbio != iwbio || (nwbio == iwbio && irbio == iwbio)))
736 SSL_set_bio(ssl, nrbio, nwbio);
745 * This test is checking that the ref counting for SSL_set_bio is correct.
746 * If we get here and we did too many frees then we will fail in the above
747 * functions. If we haven't done enough then this will only be detected in
748 * a crypto-mdebug build
755 typedef struct ssl_bio_test_fixture {
756 const char *test_case_name;
758 enum { NO_BIO_CHANGE, CHANGE_RBIO, CHANGE_WBIO } change_bio;
759 } SSL_BIO_TEST_FIXTURE;
761 static SSL_BIO_TEST_FIXTURE ssl_bio_set_up(const char *const test_case_name)
763 SSL_BIO_TEST_FIXTURE fixture;
765 fixture.test_case_name = test_case_name;
767 fixture.change_bio = NO_BIO_CHANGE;
772 static void ssl_bio_tear_down(SSL_BIO_TEST_FIXTURE fixture)
776 static int execute_test_ssl_bio(SSL_BIO_TEST_FIXTURE fix)
778 BIO *sslbio = NULL, *membio1 = NULL, *membio2 = NULL;
779 SSL_CTX *ctx = SSL_CTX_new(TLS_method());
784 printf("Failed to allocate SSL_CTX\n");
790 printf("Failed to allocate SSL object\n");
794 sslbio = BIO_new(BIO_f_ssl());
795 membio1 = BIO_new(BIO_s_mem());
797 if (sslbio == NULL || membio1 == NULL) {
798 printf("Malloc failure creating BIOs\n");
802 BIO_set_ssl(sslbio, ssl, BIO_CLOSE);
805 * If anything goes wrong here then we could leak memory, so this will
806 * be caught in a crypto-mdebug build
808 BIO_push(sslbio, membio1);
810 /* Verify chaning the rbio/wbio directly does not cause leaks */
811 if (fix.change_bio != NO_BIO_CHANGE) {
812 membio2 = BIO_new(BIO_s_mem());
813 if (membio2 == NULL) {
814 printf("Malloc failure creating membio2\n");
817 if (fix.change_bio == CHANGE_RBIO)
818 SSL_set0_rbio(ssl, membio2);
820 SSL_set0_wbio(ssl, membio2);
839 static int test_ssl_bio_pop_next_bio(void)
841 SETUP_TEST_FIXTURE(SSL_BIO_TEST_FIXTURE, ssl_bio_set_up);
843 EXECUTE_TEST(execute_test_ssl_bio, ssl_bio_tear_down);
846 static int test_ssl_bio_pop_ssl_bio(void)
848 SETUP_TEST_FIXTURE(SSL_BIO_TEST_FIXTURE, ssl_bio_set_up);
852 EXECUTE_TEST(execute_test_ssl_bio, ssl_bio_tear_down);
855 static int test_ssl_bio_change_rbio(void)
857 SETUP_TEST_FIXTURE(SSL_BIO_TEST_FIXTURE, ssl_bio_set_up);
859 fixture.change_bio = CHANGE_RBIO;
861 EXECUTE_TEST(execute_test_ssl_bio, ssl_bio_tear_down);
864 static int test_ssl_bio_change_wbio(void)
866 SETUP_TEST_FIXTURE(SSL_BIO_TEST_FIXTURE, ssl_bio_set_up);
868 fixture.change_bio = CHANGE_WBIO;
870 EXECUTE_TEST(execute_test_ssl_bio, ssl_bio_tear_down);
873 int test_main(int argc, char *argv[])
878 printf("Invalid argument count\n");
885 ADD_TEST(test_large_message_tls);
886 ADD_TEST(test_large_message_tls_read_ahead);
887 #ifndef OPENSSL_NO_DTLS
888 ADD_TEST(test_large_message_dtls);
890 ADD_TEST(test_tlsext_status_type);
891 ADD_TEST(test_session_with_only_int_cache);
892 ADD_TEST(test_session_with_only_ext_cache);
893 ADD_TEST(test_session_with_both_cache);
894 ADD_ALL_TESTS(test_ssl_set_bio, TOTAL_SSL_SET_BIO_TESTS);
895 ADD_TEST(test_ssl_bio_pop_next_bio);
896 ADD_TEST(test_ssl_bio_pop_ssl_bio);
897 ADD_TEST(test_ssl_bio_change_rbio);
898 ADD_TEST(test_ssl_bio_change_wbio);
900 testresult = run_tests(argv[0]);
902 bio_s_mempacket_test_free();