Add more session tests

Add some more tests for sessions following on from the previous commit
to ensure the callbacks are called when appropriate.

Reviewed-by: Richard Levitte <levitte@openssl.org>

test/sslapitest.c

@@ -79,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;
 
@@ -93,27 +132,47 @@ static int test_session(void)
         return 0;
     }
 
-    /* Turn on client session cache */
+#ifndef OPENSSL_NO_TLS1_2
-    SSL_CTX_set_session_cache_mode(cctx, SSL_SESS_CACHE_CLIENT);
+    /* 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");
@@ -126,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.
@@ -135,43 +199,130 @@ 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)) {
+    if (fix.use_int_cache) {
-        /*
+        if (!SSL_CTX_add_session(cctx, sess2)) {
-         * Should have succeeded because it should not already be in the cache
+            /*
+             * 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)
-        goto end;
+            remove_called--;
-    }
-
-    if (!SSL_CTX_remove_session(cctx, sess2)) {
-        printf("Unexpected failure removing session from cache\n");
-        goto end;
     }
 
+    /* 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 (fix.use_ext_cache && (new_called != 2 || remove_called != 2)) {
+        printf("Failed to call callback to remove session #2\n");
+        goto end;
+    }
+
+#ifndef OPENSSL_NO_TLS1_1
+    /* 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;
 }
 
+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;
+
+    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);
+}
+
 int main(int argc, char *argv[])
 {
     BIO *err = NULL;
@@ -191,7 +342,9 @@ int main(int argc, char *argv[])
     CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
 
     ADD_TEST(test_tlsext_status_type);
-    ADD_TEST(test_session);
+    ADD_TEST(test_session_with_only_int_cache);
+    ADD_TEST(test_session_with_only_ext_cache);
+    ADD_TEST(test_session_with_both_cache);
 
     testresult = run_tests(argv[0]);
 

test/ssltestlib.c

@@ -56,11 +56,18 @@ int create_ssl_connection(SSL_CTX *serverctx, SSL_CTX *clientctx, SSL **sssl,
                           SSL **cssl, BIO *s_to_c_fbio, BIO *c_to_s_fbio)
 {
     int retc = -1, rets = -1, err, abortctr = 0;
+    int clienterr = 0, servererr = 0;
     SSL *serverssl, *clientssl;
     BIO *s_to_c_bio = NULL, *c_to_s_bio = NULL;
 
-    serverssl = SSL_new(serverctx);
+    if (*sssl == NULL)
-    clientssl = SSL_new(clientctx);
+        serverssl = SSL_new(serverctx);
+    else
+        serverssl = *sssl;
+    if (*cssl == NULL)
+        clientssl = SSL_new(clientctx);
+    else
+        clientssl = *cssl;
 
     if (serverssl == NULL || clientssl == NULL) {
         printf("Failed to create SSL object\n");
@@ -100,28 +107,30 @@ int create_ssl_connection(SSL_CTX *serverctx, SSL_CTX *clientctx, SSL **sssl,
 
     do {
         err = SSL_ERROR_WANT_WRITE;
-        while (retc <= 0 && err == SSL_ERROR_WANT_WRITE) {
+        while (!clienterr && retc <= 0 && err == SSL_ERROR_WANT_WRITE) {
             retc = SSL_connect(clientssl);
             if (retc <= 0)
                 err = SSL_get_error(clientssl, retc);
         }
 
-        if (retc <= 0 && err != SSL_ERROR_WANT_READ) {
+        if (!clienterr && retc <= 0 && err != SSL_ERROR_WANT_READ) {
             printf("SSL_connect() failed %d, %d\n", retc, err);
-            goto error;
+            clienterr = 1;
         }
 
         err = SSL_ERROR_WANT_WRITE;
-        while (rets <= 0 && err == SSL_ERROR_WANT_WRITE) {
+        while (!servererr && rets <= 0 && err == SSL_ERROR_WANT_WRITE) {
             rets = SSL_accept(serverssl);
             if (rets <= 0)
                 err = SSL_get_error(serverssl, rets);
         }
 
-        if (rets <= 0 && err != SSL_ERROR_WANT_READ) {
+        if (!servererr && rets <= 0 && err != SSL_ERROR_WANT_READ) {
             printf("SSL_accept() failed %d, %d\n", retc, err);
-            goto error;
+            servererr = 1;
         }
+        if (clienterr && servererr)
+            goto error;
         if (++abortctr == MAXLOOPS) {
             printf("No progress made\n");
             goto error;
@@ -134,12 +143,16 @@ int create_ssl_connection(SSL_CTX *serverctx, SSL_CTX *clientctx, SSL **sssl,
     return 1;
 
  error:
-    SSL_free(serverssl);
+    if (*sssl == NULL) {
-    SSL_free(clientssl);
+        SSL_free(serverssl);
-    BIO_free(s_to_c_bio);
+        BIO_free(s_to_c_bio);
-    BIO_free(c_to_s_bio);
+        BIO_free(s_to_c_fbio);
-    BIO_free(s_to_c_fbio);
+    }
-    BIO_free(c_to_s_fbio);
+    if (*cssl == NULL) {
+        SSL_free(clientssl);
+        BIO_free(c_to_s_bio);
+        BIO_free(c_to_s_fbio);
+    }
 
     return 0;
 }