tls: add custom openssl bio

The bio interacts directly with the session so it avoids using an
intermediary mem bio and, implicitly, higher memory consumption and an
extra memcpy.

Type: improvement

Signed-off-by: Florin Coras <fcoras@cisco.com>
Change-Id: Ifb675cfd12df86396a7a738a6cd4d0882c69ad2f

src/plugins/tlsopenssl/CMakeLists.txt

@@ -12,10 +12,11 @@
 # limitations under the License.
 
 include (CheckFunctionExists)
-if(OPENSSL_FOUND)
+if(OPENSSL_FOUND AND OPENSSL_VERSION VERSION_GREATER_EQUAL "1.1.0")
   include_directories(${OPENSSL_INCLUDE_DIR})
   add_vpp_plugin(tlsopenssl
     SOURCES
+    tls_bio.c
     tls_openssl.c
     tls_openssl_api.c
     tls_async.c

src/plugins/tlsopenssl/tls_bio.c

@@ -0,0 +1,182 @@
+
+/*
+ * Copyright (c) 2020 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#include <openssl/bio.h>
+#include <openssl/err.h>
+#include <vnet/session/session.h>
+#include <vnet/session/application_interface.h>
+
+static inline session_t *
+bio_session (BIO * bio)
+{
+  return session_get_from_handle (pointer_to_uword (BIO_get_data (bio)));
+}
+
+static int
+bio_tls_alloc (BIO * bio)
+{
+  BIO_set_init (bio, 0);
+  BIO_set_data (bio, 0);
+  BIO_set_flags (bio, 0);
+  BIO_set_shutdown (bio, 0);
+  return 1;
+}
+
+static int
+bio_tls_free (BIO * bio)
+{
+  if (!bio)
+    return 0;
+
+  if (BIO_get_shutdown (bio))
+    {
+      if (BIO_get_init (bio))
+	session_close (bio_session (bio));
+      BIO_set_init (bio, 0);
+      BIO_set_flags (bio, 0);
+    }
+
+  return 1;
+}
+
+static int
+bio_tls_read (BIO * b, char *out, int outl)
+{
+  session_t *s;
+  int rv;
+
+  if (PREDICT_FALSE (!out))
+    return 0;
+
+  s = bio_session (b);
+  if (!s)
+    {
+      clib_warning ("no session");
+      errno = EBADFD;
+      return -1;
+    }
+
+  rv = app_recv_stream_raw (s->rx_fifo, (u8 *) out, outl,
+			    0 /* clear evt */ , 0 /* peek */ );
+  if (rv < 0)
+    {
+      BIO_set_retry_read (b);
+      errno = EAGAIN;
+      return -1;
+    }
+
+  if (svm_fifo_is_empty_cons (s->rx_fifo))
+    svm_fifo_unset_event (s->rx_fifo);
+
+  BIO_clear_retry_flags (b);
+
+  return rv;
+}
+
+static int
+bio_tls_write (BIO * b, const char *in, int inl)
+{
+  svm_msg_q_t *mq;
+  session_t *s;
+  int rv;
+
+  if (PREDICT_FALSE (!in))
+    return 0;
+
+  s = bio_session (b);
+  if (!s)
+    {
+      clib_warning ("no session");
+      errno = EBADFD;
+      return -1;
+    }
+
+  mq = session_main_get_vpp_event_queue (s->thread_index);
+  rv = app_send_stream_raw (s->tx_fifo, mq, (u8 *) in, inl,
+			    SESSION_IO_EVT_TX, 1 /* do_evt */ ,
+			    0 /* noblock */ );
+  if (rv < 0)
+    {
+      BIO_set_retry_write (b);
+      errno = EAGAIN;
+      return -1;
+    }
+
+  BIO_clear_retry_flags (b);
+
+  return rv;
+}
+
+long
+bio_tls_ctrl (BIO * b, int cmd, long larg, void *ptr)
+{
+  long ret = 1;
+
+  switch (cmd)
+    {
+    case BIO_C_SET_FD:
+      ASSERT (0);
+      break;
+    case BIO_C_GET_FD:
+      ASSERT (0);
+      break;
+    case BIO_CTRL_GET_CLOSE:
+      ret = BIO_get_shutdown (b);
+      break;
+    case BIO_CTRL_SET_CLOSE:
+      BIO_set_shutdown (b, (int) larg);
+      break;
+    case BIO_CTRL_DUP:
+    case BIO_CTRL_FLUSH:
+      ret = 1;
+      break;
+    case BIO_CTRL_PENDING:
+      ret = 0;
+      break;
+    default:
+      ret = 0;
+      break;
+    }
+  return ret;
+}
+
+BIO *
+BIO_new_tls (session_handle_t sh)
+{
+  static BIO_METHOD *tls_bio_method;
+  BIO *b;
+  if (!tls_bio_method)
+    {
+      tls_bio_method = BIO_meth_new (BIO_TYPE_SOCKET, "tls_bio");
+      BIO_meth_set_write (tls_bio_method, bio_tls_write);
+      BIO_meth_set_read (tls_bio_method, bio_tls_read);
+      BIO_meth_set_create (tls_bio_method, bio_tls_alloc);
+      BIO_meth_set_destroy (tls_bio_method, bio_tls_free);
+      BIO_meth_set_ctrl (tls_bio_method, bio_tls_ctrl);
+    }
+  b = BIO_new (tls_bio_method);
+  /* Initialize the BIO */
+  BIO_set_data (b, uword_to_pointer (sh, void *));
+  BIO_set_init (b, 1);
+  return b;
+}
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/plugins/tlsopenssl/tls_bio.h

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2020 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef SRC_PLUGINS_TLSOPENSSL_TLS_BIO_H_
+#define SRC_PLUGINS_TLSOPENSSL_TLS_BIO_H_
+
+#include <vnet/session/session_types.h>
+
+BIO *BIO_new_tls (session_handle_t sh);
+
+#endif /* SRC_PLUGINS_TLSOPENSSL_TLS_BIO_H_ */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */

src/plugins/tlsopenssl/tls_openssl.h

@@ -21,6 +21,9 @@
 #include <vpp/app/version.h>
 #include <vnet/tls/tls.h>
 
+#define TLSO_CTRL_BYTES 1000
+#define TLSO_MIN_ENQ_SPACE (1 << 16)
+
 typedef struct tls_ctx_openssl_
 {
   tls_ctx_t ctx;			/**< First */