Add a test for SSL_set_bio()
[openssl.git] / test / sslapitest.c
index 4c94f27cbc13bdba146142645b243883f835a58e..f8acfa9b4008d544f769f8550e9e120a06045325 100644 (file)
@@ -13,6 +13,7 @@
 #include <openssl/ssl.h>
 
 #include "ssltestlib.h"
+#include "testutil.h"
 
 static char *cert = NULL;
 static char *privkey = NULL;
@@ -78,11 +79,50 @@ static int test_tlsext_status_type(void)
     return testresult;
 }
 
-static int test_session(void)
+typedef struct ssl_session_test_fixture {
+    const char *test_case_name;
+    int use_ext_cache;
+    int use_int_cache;
+} SSL_SESSION_TEST_FIXTURE;
+
+static int new_called = 0, remove_called = 0;
+
+static SSL_SESSION_TEST_FIXTURE
+ssl_session_set_up(const char *const test_case_name)
+{
+    SSL_SESSION_TEST_FIXTURE fixture;
+
+    fixture.test_case_name = test_case_name;
+    fixture.use_ext_cache = 1;
+    fixture.use_int_cache = 1;
+
+    new_called = remove_called = 0;
+
+    return fixture;
+}
+
+static void ssl_session_tear_down(SSL_SESSION_TEST_FIXTURE fixture)
+{
+}
+
+static int new_session_cb(SSL *ssl, SSL_SESSION *sess)
+{
+    new_called++;
+
+    return 1;
+}
+
+static void remove_session_cb(SSL_CTX *ctx, SSL_SESSION *sess)
+{
+    remove_called++;
+}
+
+static int execute_test_session(SSL_SESSION_TEST_FIXTURE fix)
 {
     SSL_CTX *sctx = NULL, *cctx = NULL;
     SSL *serverssl1 = NULL, *clientssl1 = NULL;
     SSL *serverssl2 = NULL, *clientssl2 = NULL;
+    SSL *serverssl3 = NULL, *clientssl3 = NULL;
     SSL_SESSION *sess1 = NULL, *sess2 = NULL;
     int testresult = 0;
 
@@ -92,27 +132,47 @@ static int test_session(void)
         return 0;
     }
 
-    /* Turn on client session cache */
-    SSL_CTX_set_session_cache_mode(cctx, SSL_SESS_CACHE_CLIENT);
+#ifndef OPENSSL_NO_TLS1_2
+    /* Only allow TLS1.2 so we can force a connection failure later */
+    SSL_CTX_set_min_proto_version(cctx, TLS1_2_VERSION);
+#endif
+
+    /* Set up session cache */
+    if (fix.use_ext_cache) {
+        SSL_CTX_sess_set_new_cb(cctx, new_session_cb);
+        SSL_CTX_sess_set_remove_cb(cctx, remove_session_cb);
+    }
+    if (fix.use_int_cache) {
+        /* Also covers instance where both are set */
+        SSL_CTX_set_session_cache_mode(cctx, SSL_SESS_CACHE_CLIENT);
+    } else {
+        SSL_CTX_set_session_cache_mode(cctx,
+                                       SSL_SESS_CACHE_CLIENT
+                                       | SSL_SESS_CACHE_NO_INTERNAL_STORE);
+    }
 
     if (!create_ssl_connection(sctx, cctx, &serverssl1, &clientssl1, NULL,
                                NULL)) {
         printf("Unable to create SSL connection\n");
         goto end;
     }
-
     sess1 = SSL_get1_session(clientssl1);
     if (sess1 == NULL) {
         printf("Unexpected NULL session\n");
         goto end;
     }
 
-    if (SSL_CTX_add_session(cctx, sess1)) {
+    if (fix.use_int_cache && SSL_CTX_add_session(cctx, sess1)) {
         /* Should have failed because it should already be in the cache */
         printf("Unexpected success adding session to cache\n");
         goto end;
     }
 
+    if (fix.use_ext_cache && (new_called != 1 || remove_called != 0)) {
+        printf("Session not added to cache\n");
+        goto end;
+    }
+
     if (!create_ssl_connection(sctx, cctx, &serverssl2, &clientssl2, NULL,
                                NULL)) {
         printf("Unable to create second SSL connection\n");
@@ -125,6 +185,11 @@ static int test_session(void)
         goto end;
     }
 
+    if (fix.use_ext_cache && (new_called != 2 || remove_called != 0)) {
+        printf("Remove session callback unexpectedly called\n");
+        goto end;
+    }
+
     /*
      * This should clear sess2 from the cache because it is a "bad" session. See
      * SSL_set_session() documentation.
@@ -134,62 +199,256 @@ static int test_session(void)
         goto end;
     }
 
+    if (fix.use_ext_cache && (new_called != 2 || remove_called != 1)) {
+        printf("Failed to call callback to remove session\n");
+        goto end;
+    }
+
+
     if (SSL_get_session(clientssl2) != sess1) {
         printf("Unexpected session found\n");
         goto end;
     }
 
-    if (!SSL_CTX_add_session(cctx, sess2)) {
-        /*
-         * Should have succeeded because it should not already be in the cache
+    if (fix.use_int_cache) {
+        if (!SSL_CTX_add_session(cctx, sess2)) {
+            /*
+             * Should have succeeded because it should not already be in the cache
+             */
+            printf("Unexpected failure adding session to cache\n");
+            goto end;
+        }
+
+        if (!SSL_CTX_remove_session(cctx, sess2)) {
+            printf("Unexpected failure removing session from cache\n");
+            goto end;
+        }
+
+        /* This is for the purposes of internal cache testing...ignore the
+         * counter for external cache
          */
-        printf("Unexpected failure adding session to cache\n");
+        if (fix.use_ext_cache)
+            remove_called--;
+    }
+
+    /* This shouldn't be in the cache so should fail */
+    if (SSL_CTX_remove_session(cctx, sess2)) {
+        printf("Unexpected success removing session from cache\n");
         goto end;
     }
 
-    if (!SSL_CTX_remove_session(cctx, sess2)) {
-        printf("Unexpected failure removing session from cache\n");
+    if (fix.use_ext_cache && (new_called != 2 || remove_called != 2)) {
+        printf("Failed to call callback to remove session #2\n");
         goto end;
     }
 
-    if (SSL_CTX_remove_session(cctx, sess2)) {
-        printf("Unexpected success removing session from cache\n");
+#if !defined(OPENSSL_NO_TLS1_1) && !defined(OPENSSL_NO_TLS1_2)
+    /* Force a connection failure */
+    SSL_CTX_set_max_proto_version(sctx, TLS1_1_VERSION);
+    clientssl3 = SSL_new(cctx);
+    if (clientssl3 == NULL) {
+        printf("Malloc failure\n");
+        goto end;
+    }
+    if (!SSL_set_session(clientssl3, sess1)) {
+        printf("Unable to set session for third connection\n");
         goto end;
     }
 
+    /* This should fail because of the mismatched protocol versions */
+    if (create_ssl_connection(sctx, cctx, &serverssl3, &clientssl3, NULL,
+                               NULL)) {
+        printf("Unexpected success creating SSL connection\n");
+        goto end;
+    }
+
+    /* We should have automatically removed the session from the cache */
+    if (fix.use_ext_cache && (new_called != 2 || remove_called != 3)) {
+        printf("Failed to call callback to remove session #2\n");
+        goto end;
+    }
+
+    if (fix.use_int_cache && !SSL_CTX_add_session(cctx, sess2)) {
+        /*
+         * Should have succeeded because it should not already be in the cache
+         */
+        printf("Unexpected failure adding session to cache #2\n");
+        goto end;
+    }
+#endif
+
     testresult = 1;
+
  end:
     SSL_free(serverssl1);
     SSL_free(clientssl1);
     SSL_free(serverssl2);
     SSL_free(clientssl2);
+    SSL_free(serverssl3);
+    SSL_free(clientssl3);
     SSL_SESSION_free(sess1);
     SSL_SESSION_free(sess2);
+    /*
+     * Check if we need to remove any sessions up-refed for the external cache
+     */
+    if (new_called >= 1)
+        SSL_SESSION_free(sess1);
+    if (new_called >= 2)
+        SSL_SESSION_free(sess2);
     SSL_CTX_free(sctx);
     SSL_CTX_free(cctx);
 
     return testresult;
 }
 
-#define RUNTEST(testname)   \
-    do { \
-        printf("Testing " #testname "..."); \
-        if (test_##testname()) {\
-            printf("ok\n"); \
-        } else { \
-            printf("not ok\n"); \
-            goto end; \
-        } \
-    } while(0)
+static int test_session_with_only_int_cache(void)
+{
+    SETUP_TEST_FIXTURE(SSL_SESSION_TEST_FIXTURE, ssl_session_set_up);
+
+    fixture.use_ext_cache = 0;
 
-int main(int argc, char *argv[])
+    EXECUTE_TEST(execute_test_session, ssl_session_tear_down);
+}
+
+static int test_session_with_only_ext_cache(void)
+{
+    SETUP_TEST_FIXTURE(SSL_SESSION_TEST_FIXTURE, ssl_session_set_up);
+
+    fixture.use_int_cache = 0;
+
+    EXECUTE_TEST(execute_test_session, ssl_session_tear_down);
+}
+
+static int test_session_with_both_cache(void)
+{
+    SETUP_TEST_FIXTURE(SSL_SESSION_TEST_FIXTURE, ssl_session_set_up);
+
+    EXECUTE_TEST(execute_test_session, ssl_session_tear_down);
+}
+
+#define USE_NULL    0
+#define USE_BIO_1   1
+#define USE_BIO_2   2
+
+#define TOTAL_SSL_SET_BIO_TESTS (3 * 3 * 3 * 3)
+
+static void setupbio(BIO **res, BIO *bio1, BIO *bio2, int type)
+{
+    switch (type) {
+    case USE_NULL:
+        *res = NULL;
+        break;
+    case USE_BIO_1:
+        *res = bio1;
+        break;
+    case USE_BIO_2:
+        *res = bio2;
+        break;
+    }
+}
+
+static int test_ssl_set_bio(int idx)
 {
-    BIO *err;
+    SSL_CTX *ctx = SSL_CTX_new(TLS_method());
+    BIO *bio1 = NULL;
+    BIO *bio2 = NULL;
+    BIO *irbio, *iwbio, *nrbio, *nwbio;
+    SSL *ssl = NULL;
+    int initrbio, initwbio, newrbio, newwbio;
     int testresult = 0;
 
+    if (ctx == NULL) {
+        printf("Failed to allocate SSL_CTX\n");
+        goto end;
+    }
+
+    ssl = SSL_new(ctx);
+    if (ssl == NULL) {
+        printf("Failed to allocate SSL object\n");
+        goto end;
+    }
+
+    initrbio = idx % 3;
+    idx /= 3;
+    initwbio = idx % 3;
+    idx /= 3;
+    newrbio = idx % 3;
+    idx /= 3;
+    newwbio = idx;
+    OPENSSL_assert(newwbio <= 2);
+
+    if (initrbio == USE_BIO_1 || initwbio == USE_BIO_1 || newrbio == USE_BIO_1
+            || newwbio == USE_BIO_1) {
+        bio1 = BIO_new(BIO_s_mem());
+        if (bio1 == NULL) {
+            printf("Failed to allocate bio1\n");
+            goto end;
+        }
+    }
+
+    if (initrbio == USE_BIO_2 || initwbio == USE_BIO_2 || newrbio == USE_BIO_2
+            || newwbio == USE_BIO_2) {
+        bio2 = BIO_new(BIO_s_mem());
+        if (bio2 == NULL) {
+            printf("Failed to allocate bio2\n");
+            goto end;
+        }
+    }
+
+    setupbio(&irbio, bio1, bio2, initrbio);
+    setupbio(&iwbio, bio1, bio2, initwbio);
+
+    /*
+     * We want to maintain our own refs to these BIO, so do an up ref for each
+     * BIO that will have ownersip transferred in the SSL_set_bio() call
+     */
+    if (irbio != NULL)
+        BIO_up_ref(irbio);
+    if (iwbio != NULL && iwbio != irbio)
+        BIO_up_ref(iwbio);
+
+    SSL_set_bio(ssl, irbio, iwbio);
+
+    setupbio(&nrbio, bio1, bio2, newrbio);
+    setupbio(&nwbio, bio1, bio2, newwbio);
+
+    /*
+     * We will (maybe) transfer ownership again so do more up refs.
+     * SSL_set_bio() has some really complicated ownership rules where BIOs have
+     * already been set!
+     */
+    if (nrbio != NULL && nrbio != irbio && (nwbio != iwbio || nrbio != nwbio))
+        BIO_up_ref(nrbio);
+    if (nwbio != NULL && nwbio != nrbio && (nwbio != iwbio || (nwbio == iwbio && irbio == iwbio)))
+        BIO_up_ref(nwbio);
+
+    SSL_set_bio(ssl, nrbio, nwbio);
+
+    testresult = 1;
+
+ end:
+    SSL_free(ssl);
+    BIO_free(bio1);
+    BIO_free(bio2);
+    /*
+     * This test is checking that the ref counting for SSL_set_bio is correct.
+     * If we get here and we did too many frees then we will fail in the above
+     * functions. If we haven't done enough then this will only be detected in
+     * a crypto-mdebug build
+     */
+    SSL_CTX_free(ctx);
+
+    return testresult;
+}
+
+int main(int argc, char *argv[])
+{
+    BIO *err = NULL;
+    int testresult = 1;
+
     if (argc != 3) {
         printf("Invalid argument count\n");
-        goto end;
+        return 1;
     }
 
     cert = argv[1];
@@ -200,21 +459,22 @@ int main(int argc, char *argv[])
     CRYPTO_set_mem_debug(1);
     CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
 
-    RUNTEST(tlsext_status_type);
-    RUNTEST(session);
+    ADD_TEST(test_tlsext_status_type);
+    ADD_TEST(test_session_with_only_int_cache);
+    ADD_TEST(test_session_with_only_ext_cache);
+    ADD_TEST(test_session_with_both_cache);
+    ADD_ALL_TESTS(test_ssl_set_bio, TOTAL_SSL_SET_BIO_TESTS);
 
-    testresult = 1;
-
- end:
+    testresult = run_tests(argv[0]);
 
 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
     if (CRYPTO_mem_leaks(err) <= 0)
-        testresult = 0;
+        testresult = 1;
 #endif
     BIO_free(err);
 
-    if (testresult)
+    if (!testresult)
         printf("PASS\n");
 
-    return testresult ? 0 : 1;
+    return testresult;
 }