diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/configure.ac | 16 | ||||
| -rw-r--r-- | src/plugins/Makefile.am | 4 | ||||
| -rw-r--r-- | src/plugins/tlsmbedtls.am | 21 | ||||
| -rw-r--r-- | src/plugins/tlsmbedtls/tls_mbedtls.c | 548 | ||||
| -rw-r--r-- | src/vnet.am | 17 | ||||
| -rw-r--r-- | src/vnet/tls/tls.c (renamed from src/vnet/session-apps/tls.c) | 605 | ||||
| -rw-r--r-- | src/vnet/tls/tls.h | 127 |
7 files changed, 814 insertions, 524 deletions
diff --git a/src/configure.ac b/src/configure.ac index 1ee55e7ba68..041849e4312 100644 --- a/src/configure.ac +++ b/src/configure.ac @@ -230,6 +230,7 @@ PLUGIN_ENABLED(srv6ad) PLUGIN_ENABLED(srv6am) PLUGIN_ENABLED(srv6as) PLUGIN_ENABLED(stn) +PLUGIN_ENABLED(tlsmbedtls) ############################################################################### # Dependency checks @@ -288,15 +289,24 @@ AM_COND_IF([ENABLE_MARVELL_PLUGIN], ]) ]) -AM_COND_IF([WITH_MBEDTLS], +AM_COND_IF([WITH_MBEDTLS], [], +[ + AC_MSG_WARN([mbedtls not enabled. Disabling tlsmbedtls plugin]) + enable_tlsmbedtls_plugin=no + AM_CONDITIONAL(ENABLE_TLSMBEDTLS_PLUGIN, false) +]) + +AM_COND_IF([ENABLE_TLSMBEDTLS_PLUGIN], [ AC_CHECK_HEADERS([mbedtls/ssl.h], [], [ - AC_MSG_WARN([mbedtls headers not found. TLS app disabled]) - AM_CONDITIONAL(WITH_MBEDTLS, false) + AC_MSG_WARN([mbedtls headers not found. TLS engine implementation disabled]) + enable_tlsmbedtls_plugin=no + AM_CONDITIONAL(ENABLE_TLSMBEDTLS_PLUGIN, false) ], []) ]) + ############################################################################### # JAVA ############################################################################### diff --git a/src/plugins/Makefile.am b/src/plugins/Makefile.am index 64faeda9963..1acca70a6dc 100644 --- a/src/plugins/Makefile.am +++ b/src/plugins/Makefile.am @@ -111,6 +111,10 @@ if ENABLE_GBP_PLUGIN include gbp.am endif +if ENABLE_TLSMBEDTLS_PLUGIN +include tlsmbedtls.am +endif + include ../suffix-rules.mk # Remove *.la files diff --git a/src/plugins/tlsmbedtls.am b/src/plugins/tlsmbedtls.am new file mode 100644 index 00000000000..5d1cf2b99f7 --- /dev/null +++ b/src/plugins/tlsmbedtls.am @@ -0,0 +1,21 @@ +# Copyright (c) 2018 Cisco Systems, Inc. +# 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. + + +vppplugins_LTLIBRARIES += tlsmbedtls_plugin.la + +tlsmbedtls_plugin_la_SOURCES = tlsmbedtls/tls_mbedtls.c +tlsmbedtls_plugin_la_LDFLAGS = $(AM_LDFLAGS) -lmbedtls -lmbedx509 -lmbedcrypto +tlsmbedtls_plugin_la_CFLAGS = $(AM_CFLAGS) + +# vi:syntax=automake diff --git a/src/plugins/tlsmbedtls/tls_mbedtls.c b/src/plugins/tlsmbedtls/tls_mbedtls.c new file mode 100644 index 00000000000..1bae1f726f8 --- /dev/null +++ b/src/plugins/tlsmbedtls/tls_mbedtls.c @@ -0,0 +1,548 @@ +/* + * Copyright (c) 2018 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 <mbedtls/ssl.h> +#include <mbedtls/certs.h> +#include <mbedtls/entropy.h> +#include <mbedtls/ctr_drbg.h> +#include <mbedtls/timing.h> +#include <mbedtls/debug.h> +#include <vnet/plugin/plugin.h> +#include <vpp/app/version.h> +#include <vnet/tls/tls.h> + +#define TLS_USE_OUR_MEM_FUNCS 0 + +typedef struct tls_ctx_mbedtls_ +{ + tls_ctx_t ctx; /**< First */ + mbedtls_ssl_context ssl; + mbedtls_ssl_config conf; + mbedtls_x509_crt srvcert; + mbedtls_pk_context pkey; +} mbedtls_ctx_t; + +typedef struct mbedtls_main_ +{ + mbedtls_ctx_t ***ctx_pool; + mbedtls_ctr_drbg_context *ctr_drbgs; + mbedtls_entropy_context *entropy_pools; + mbedtls_x509_crt cacert; +} mbedtls_main_t; + +static mbedtls_main_t mbedtls_main; + +#if TLS_USE_OUR_MEM_FUNCS +#include <mbedtls/platform.h> + +void * +mbedtls_calloc_fn (size_t n, size_t size) +{ + void *ptr; + ptr = clib_mem_alloc (n * size); + memset (ptr, 0, sizeof (*ptr)); + return ptr; +} + +void +mbedtls_free_fn (void *ptr) +{ + if (ptr) + clib_mem_free (ptr); +} +#endif + +u32 +mbedtls_ctx_alloc (void) +{ + u8 thread_index = vlib_get_thread_index (); + mbedtls_main_t *tm = &mbedtls_main; + mbedtls_ctx_t **ctx; + + pool_get (tm->ctx_pool[thread_index], ctx); + if (!(*ctx)) + *ctx = clib_mem_alloc (sizeof (mbedtls_ctx_t)); + + memset (*ctx, 0, sizeof (mbedtls_ctx_t)); + (*ctx)->ctx.c_thread_index = thread_index; + return ctx - tm->ctx_pool[thread_index]; +} + +void +mbedtls_ctx_free (tls_ctx_t * ctx) +{ + mbedtls_ctx_t *mc = (mbedtls_ctx_t *) ctx; + + if (mc->ssl.state == MBEDTLS_SSL_HANDSHAKE_OVER && !ctx->is_passive_close) + mbedtls_ssl_close_notify (&mc->ssl); + if (mc->ssl.conf->endpoint == MBEDTLS_SSL_IS_SERVER) + { + mbedtls_x509_crt_free (&mc->srvcert); + mbedtls_pk_free (&mc->pkey); + } + mbedtls_ssl_free (&mc->ssl); + mbedtls_ssl_config_free (&mc->conf); + + pool_put_index (mbedtls_main.ctx_pool[vlib_get_thread_index ()], + ctx->tls_ctx_idx); +} + +tls_ctx_t * +mbedtls_ctx_get (u32 ctx_index) +{ + mbedtls_ctx_t **ctx; + ctx = pool_elt_at_index (mbedtls_main.ctx_pool[vlib_get_thread_index ()], + ctx_index); + return &(*ctx)->ctx; +} + +tls_ctx_t * +mbedtls_ctx_get_w_thread (u32 ctx_index, u8 thread_index) +{ + mbedtls_ctx_t **ctx; + ctx = pool_elt_at_index (mbedtls_main.ctx_pool[thread_index], ctx_index); + return &(*ctx)->ctx; +} + +static int +tls_init_ctr_seed_drbgs (void) +{ + u32 thread_index = vlib_get_thread_index (); + mbedtls_main_t *tm = &mbedtls_main; + u8 *pers; + int rv; + pers = format (0, "vpp thread %u", thread_index); + + mbedtls_entropy_init (&tm->entropy_pools[thread_index]); + mbedtls_ctr_drbg_init (&mbedtls_main.ctr_drbgs[thread_index]); + if ((rv = mbedtls_ctr_drbg_seed (&tm->ctr_drbgs[thread_index], + mbedtls_entropy_func, + &tm->entropy_pools[thread_index], + (const unsigned char *) pers, + vec_len (pers))) != 0) + { + vec_free (pers); + TLS_DBG (1, " failed\n ! mbedtls_ctr_drbg_seed returned %d\n", rv); + return -1; + } + vec_free (pers); + return 0; +} + +mbedtls_ctr_drbg_context * +tls_get_ctr_drbg () +{ + u8 thread_index = vlib_get_thread_index (); + if (PREDICT_FALSE (!mbedtls_main.ctr_drbgs[thread_index].f_entropy)) + tls_init_ctr_seed_drbgs (); + return &mbedtls_main.ctr_drbgs[thread_index]; +} + +static int +tls_net_send (void *ctx_indexp, const unsigned char *buf, size_t len) +{ + stream_session_t *tls_session; + uword ctx_index; + tls_ctx_t *ctx; + int rv; + + ctx_index = pointer_to_uword (ctx_indexp); + ctx = mbedtls_ctx_get (ctx_index); + tls_session = session_get_from_handle (ctx->tls_session_handle); + rv = svm_fifo_enqueue_nowait (tls_session->server_tx_fifo, len, buf); + if (rv < 0) + return MBEDTLS_ERR_SSL_WANT_WRITE; + tls_add_vpp_q_evt (tls_session->server_tx_fifo, FIFO_EVENT_APP_TX); + return rv; +} + +static int +tls_net_recv (void *ctx_indexp, unsigned char *buf, size_t len) +{ + stream_session_t *tls_session; + uword ctx_index; + tls_ctx_t *ctx; + int rv; + + ctx_index = pointer_to_uword (ctx_indexp); + ctx = mbedtls_ctx_get (ctx_index); + tls_session = session_get_from_handle (ctx->tls_session_handle); + rv = svm_fifo_dequeue_nowait (tls_session->server_rx_fifo, len, buf); + return (rv < 0) ? 0 : rv; +} + +static void +mbedtls_debug (void *ctx, int level, const char *file, int line, + const char *str) +{ + ((void) level); + fprintf ((FILE *) ctx, "%s:%04d: %s", file, line, str); + fflush ((FILE *) ctx); +} + +static int +mbedtls_ctx_init_client (tls_ctx_t * ctx) +{ + mbedtls_ctx_t *mc = (mbedtls_ctx_t *) ctx; + mbedtls_main_t *mm = &mbedtls_main; + void *ctx_ptr; + int rv; + + /* + * 1. Setup SSL + */ + mbedtls_ssl_init (&mc->ssl); + mbedtls_ssl_config_init (&mc->conf); + if ((rv = mbedtls_ssl_config_defaults (&mc->conf, MBEDTLS_SSL_IS_CLIENT, + MBEDTLS_SSL_TRANSPORT_STREAM, + MBEDTLS_SSL_PRESET_DEFAULT)) != 0) + { + TLS_DBG (1, "failed\n ! mbedtls_ssl_config_defaults returned %d\n\n", + rv); + return -1; + } + + mbedtls_ssl_conf_authmode (&mc->conf, MBEDTLS_SSL_VERIFY_OPTIONAL); + mbedtls_ssl_conf_ca_chain (&mc->conf, &mm->cacert, NULL); + mbedtls_ssl_conf_rng (&mc->conf, mbedtls_ctr_drbg_random, + tls_get_ctr_drbg ()); + mbedtls_ssl_conf_dbg (&mc->conf, mbedtls_debug, stdout); + + if ((rv = mbedtls_ssl_setup (&mc->ssl, &mc->conf)) != 0) + { + TLS_DBG (1, "failed\n ! mbedtls_ssl_setup returned %d\n", rv); + return -1; + } + + if ((rv = mbedtls_ssl_set_hostname (&mc->ssl, + (const char *) ctx->srv_hostname)) != 0) + { + TLS_DBG (1, "failed\n ! mbedtls_ssl_set_hostname returned %d\n", rv); + return -1; + } + + ctx_ptr = uword_to_pointer (ctx->tls_ctx_idx, void *); + mbedtls_ssl_set_bio (&mc->ssl, ctx_ptr, tls_net_send, tls_net_recv, NULL); + mbedtls_debug_set_threshold (TLS_DEBUG_LEVEL_CLIENT); + + /* + * 2. Do the first 2 steps in the handshake. + */ + TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index, + ctx->tls_ctx_idx); + while (mc->ssl.state != MBEDTLS_SSL_HANDSHAKE_OVER) + { + rv = mbedtls_ssl_handshake_step (&mc->ssl); + if (rv != 0) + break; + } + TLS_DBG (2, "tls state for [%u]%u is %u", ctx->c_thread_index, + ctx->tls_ctx_idx, mc->ssl.state); + return 0; +} + +static int +mbedtls_ctx_init_server (tls_ctx_t * ctx) +{ + mbedtls_ctx_t *mc = (mbedtls_ctx_t *) ctx; + mbedtls_main_t *mm = &mbedtls_main; + application_t *app; + void *ctx_ptr; + int rv; + + mbedtls_ssl_init (&mc->ssl); + mbedtls_ssl_config_init (&mc->conf); + mbedtls_x509_crt_init (&mc->srvcert); + mbedtls_pk_init (&mc->pkey); + + /* + * 1. Cert + */ + app = application_get (ctx->parent_app_index); + if (!app->tls_cert || !app->tls_key) + { + TLS_DBG (1, " failed\n ! tls cert and/or key not configured %d", + ctx->parent_app_index); + return -1; + } + + rv = mbedtls_x509_crt_parse (&mc->srvcert, + (const unsigned char *) app->tls_cert, + vec_len (app->tls_cert)); + if (rv != 0) + { + TLS_DBG (1, " failed\n ! mbedtls_x509_crt_parse returned %d", rv); + goto exit; + } + + rv = mbedtls_pk_parse_key (&mc->pkey, + (const unsigned char *) app->tls_key, + vec_len (app->tls_key), NULL, 0); + if (rv != 0) + { + TLS_DBG (1, " failed\n ! mbedtls_pk_parse_key returned %d", rv); + goto exit; + } + + /* + * 2. SSL context config + */ + if ((rv = mbedtls_ssl_config_defaults (&mc->conf, MBEDTLS_SSL_IS_SERVER, + MBEDTLS_SSL_TRANSPORT_STREAM, + MBEDTLS_SSL_PRESET_DEFAULT)) != 0) + { + TLS_DBG (1, " failed\n ! mbedtls_ssl_config_defaults returned %d", rv); + goto exit; + } + + mbedtls_ssl_conf_rng (&mc->conf, mbedtls_ctr_drbg_random, + tls_get_ctr_drbg ()); + mbedtls_ssl_conf_dbg (&mc->conf, mbedtls_debug, stdout); + + /* TODO CACHE + mbedtls_ssl_conf_session_cache( &ctx->conf, &cache, + mbedtls_ssl_cache_get, + mbedtls_ssl_cache_set ); + */ + + mbedtls_ssl_conf_ca_chain (&mc->conf, &mm->cacert, NULL); + if ((rv = mbedtls_ssl_conf_own_cert (&mc->conf, &mc->srvcert, &mc->pkey)) + != 0) + { + TLS_DBG (1, " failed\n ! mbedtls_ssl_conf_own_cert returned %d", rv); + goto exit; + } + + if ((rv = mbedtls_ssl_setup (&mc->ssl, &mc->conf)) != 0) + { + TLS_DBG (1, " failed\n ! mbedtls_ssl_setup returned %d", rv); + goto exit; + } + + mbedtls_ssl_session_reset (&mc->ssl); + ctx_ptr = uword_to_pointer (ctx->tls_ctx_idx, void *); + mbedtls_ssl_set_bio (&mc->ssl, ctx_ptr, tls_net_send, tls_net_recv, NULL); + mbedtls_debug_set_threshold (TLS_DEBUG_LEVEL_SERVER); + + /* + * 3. Start handshake state machine + */ + TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index, + ctx->tls_ctx_idx); + while (mc->ssl.state != MBEDTLS_SSL_HANDSHAKE_OVER) + { + rv = mbedtls_ssl_handshake_step (&mc->ssl); + if (rv != 0) + break; + } + + TLS_DBG (2, "tls state for [%u]%u is %u", ctx->c_thread_index, + ctx->tls_ctx_idx, mc->ssl.state); + return 0; + +exit: + return -1; +} + +static int +mbedtls_handshake_rx (tls_ctx_t * ctx) +{ + mbedtls_ctx_t *mc = (mbedtls_ctx_t *) ctx; + u32 flags; + int rv; + while (mc->ssl.state != MBEDTLS_SSL_HANDSHAKE_OVER) + { + rv = mbedtls_ssl_handshake_step (&mc->ssl); + if (rv != 0) + break; + } + TLS_DBG (2, "tls state for %u is %u", ctx->tls_ctx_idx, mc->ssl.state); + + if (mc->ssl.state != MBEDTLS_SSL_HANDSHAKE_OVER) + return HANDSHAKE_NOT_OVER; + + /* + * Handshake complete + */ + if (mc->ssl.conf->endpoint == MBEDTLS_SSL_IS_CLIENT) + { + /* + * Verify server certificate + */ + if ((flags = mbedtls_ssl_get_verify_result (&mc->ssl)) != 0) + { + char buf[512]; + TLS_DBG (1, " failed\n"); + mbedtls_x509_crt_verify_info (buf, sizeof (buf), " ! ", flags); + TLS_DBG (1, "%s\n", buf); + + /* + * Presence of hostname enforces strict certificate verification + */ + if (ctx->srv_hostname) + return CLIENT_HANDSHAKE_FAIL; + } + rv = CLIENT_HANDSHAKE_OK; + } + else + { + rv = SERVER_HANDSHAKE_OK; + } + + TLS_DBG (1, "Handshake for %u complete. TLS cipher is %x", + ctx->tls_ctx_idx, mc->ssl.session->ciphersuite); + return rv; +} + +static int +mbedtls_write (tls_ctx_t * ctx, u8 * buf, u32 len) +{ + mbedtls_ctx_t *mc = (mbedtls_ctx_t *) ctx; + return mbedtls_ssl_write (&mc->ssl, buf, len); +} + +static int +mbedtls_read (tls_ctx_t * ctx, u8 * buf, u32 len) +{ + mbedtls_ctx_t *mc = (mbedtls_ctx_t *) ctx; + return mbedtls_ssl_read (&mc->ssl, buf, len); +} + +static u8 +mbedtls_handshake_is_over (tls_ctx_t * ctx) +{ + mbedtls_ctx_t *mc = (mbedtls_ctx_t *) ctx; + return (mc->ssl.state == MBEDTLS_SSL_HANDSHAKE_OVER); +} + +const static tls_engine_vft_t mbedtls_engine = { + .ctx_alloc = mbedtls_ctx_alloc, + .ctx_free = mbedtls_ctx_free, + .ctx_get = mbedtls_ctx_get, + .ctx_get_w_thread = mbedtls_ctx_get_w_thread, + .ctx_init_server = mbedtls_ctx_init_server, + .ctx_init_client = mbedtls_ctx_init_client, + .ctx_handshake_rx = mbedtls_handshake_rx, + .ctx_write = mbedtls_write, + .ctx_read = mbedtls_read, + .ctx_handshake_is_over = mbedtls_handshake_is_over, +}; + +int +tls_init_mem (void) +{ +#if TLS_USE_OUR_MEM_FUNCS + mbedtls_platform_set_calloc_free (mbedtls_calloc_fn, mbedtls_free_fn); +#endif + return 0; +} + +static int +tls_init_ctr_drbgs_and_entropy (u32 num_threads) +{ + mbedtls_main_t *mm = &mbedtls_main; + int i; + + vec_validate (mm->ctr_drbgs, num_threads - 1); + vec_validate (mm->entropy_pools, num_threads - 1); + for (i = 0; i < num_threads; i++) + mm->ctr_drbgs[i].f_entropy = 0; + + return 0; +} + +int +tls_init_ca_chain (void) +{ + mbedtls_main_t *mm = &mbedtls_main; + tls_main_t *tm = vnet_tls_get_main (); + int rv; + + if (access (tm->ca_cert_path, F_OK | R_OK) == -1) + { + clib_warning ("Could not initialize TLS CA certificates"); + return -1; + } + + mbedtls_x509_crt_init (&mm->cacert); + rv = mbedtls_x509_crt_parse_file (&mm->cacert, tm->ca_cert_path); + if (rv < 0) + { + clib_warning ("Couldn't parse system CA certificates: -0x%x", -rv); + } + if (tm->use_test_cert_in_ca) + { + rv = mbedtls_x509_crt_parse (&mm->cacert, + (const unsigned char *) test_srv_crt_rsa, + test_srv_crt_rsa_len); + if (rv < 0) + { + clib_warning ("Couldn't parse test certificate: -0x%x", -rv); + return -1; + } + } + return (rv < 0 ? -1 : 0); +} + +static clib_error_t * +tls_mbedtls_init (vlib_main_t * vm) +{ + vlib_thread_main_t *vtm = vlib_get_thread_main (); + mbedtls_main_t *mm = &mbedtls_main; + clib_error_t *error; + u32 num_threads; + + num_threads = 1 /* main thread */ + vtm->n_threads; + + if ((error = vlib_call_init_function (vm, tls_init))) + return error; + + if (tls_init_ca_chain ()) + { + clib_warning ("failed to initialize TLS CA chain"); + return 0; + } + if (tls_init_mem ()) + { + clib_warning ("failed to initialize mem"); + return 0; + } + if (tls_init_ctr_drbgs_and_entropy (num_threads)) + { + clib_warning ("failed to initialize entropy and random generators"); + return 0; + } + + vec_validate (mm->ctx_pool, num_threads - 1); + tls_register_engine (&mbedtls_engine, TLS_ENGINE_MBEDTLS); + return 0; +} + +VLIB_INIT_FUNCTION (tls_mbedtls_init); + +/* *INDENT-OFF* */ +VLIB_PLUGIN_REGISTER () = { + .version = VPP_BUILD_VER, + .description = "mbedtls based TLS Engine", +}; +/* *INDENT-ON* */ + +/* + * fd.io coding-style-patch-verification: ON + * + * Local Variables: + * eval: (c-set-style "gnu") + * End: + */ diff --git a/src/vnet.am b/src/vnet.am index e1e69b1827c..a08b4bb5108 100644 --- a/src/vnet.am +++ b/src/vnet.am @@ -27,10 +27,6 @@ if WITH_LIBSSL libvnet_la_LIBADD += -lcrypto endif -if WITH_MBEDTLS -libvnet_la_LIBADD += -lmbedtls -lmbedx509 -lmbedcrypto -endif - ######################################## # Generic stuff ######################################## @@ -976,15 +972,20 @@ libvnet_la_SOURCES += \ vnet/session-apps/http_server.c \ vnet/session-apps/proxy.c -if WITH_MBEDTLS -libvnet_la_SOURCES += vnet/session-apps/tls.c -endif - nobase_include_HEADERS += \ vnet/session-apps/echo_client.h \ vnet/session-apps/proxy.h ######################################## +# TLS protocol +######################################## + +libvnet_la_SOURCES += vnet/tls/tls.c + +nobase_include_HEADERS += \ + vnet/tls/tls.h + +######################################## # Linux packet interface ######################################## diff --git a/src/vnet/session-apps/tls.c b/src/vnet/tls/tls.c index d71dfb43d3c..65900c8b2cf 100644 --- a/src/vnet/session-apps/tls.c +++ b/src/vnet/tls/tls.c @@ -15,110 +15,15 @@ #include <vnet/session/application_interface.h> #include <vppinfra/lock.h> -#include <mbedtls/ssl.h> -#include <mbedtls/certs.h> -#include <mbedtls/entropy.h> -#include <mbedtls/ctr_drbg.h> -#include <mbedtls/timing.h> -#include <mbedtls/debug.h> - -#define TLS_DEBUG 0 -#define TLS_DEBUG_LEVEL_CLIENT 0 -#define TLS_DEBUG_LEVEL_SERVER 0 - -#define TLS_CHUNK_SIZE (1 << 14) -#define TLS_USE_OUR_MEM_FUNCS 0 -#define TLS_CA_CERT_PATH "/etc/ssl/certs/ca-certificates.crt" - -#if TLS_DEBUG -#define TLS_DBG(_lvl, _fmt, _args...) \ - if (_lvl <= TLS_DEBUG) \ - clib_warning (_fmt, ##_args) -#else -#define TLS_DBG(_fmt, _args...) -#endif - -#if TLS_USE_OUR_MEM_FUNCS -#include <mbedtls/platform.h> - -void * -mbedtls_calloc_fn (size_t n, size_t size) -{ - void *ptr; - ptr = clib_mem_alloc (n * size); - memset (ptr, 0, sizeof (*ptr)); - return ptr; -} - -void -mbedtls_free_fn (void *ptr) -{ - if (ptr) - clib_mem_free (ptr); -} -#endif - -/* *INDENT-OFF* */ -typedef CLIB_PACKED (struct tls_cxt_id_ -{ - u32 parent_app_index; - session_handle_t app_session_handle; - session_handle_t tls_session_handle; - u32 listener_ctx_index; - u8 tcp_is_ip4; -}) tls_ctx_id_t; -/* *INDENT-ON* */ - -STATIC_ASSERT (sizeof (tls_ctx_id_t) <= 42, "ctx id must be less than 42"); - -typedef struct tls_ctx_ -{ - union - { - transport_connection_t connection; - tls_ctx_id_t c_tls_ctx_id; - }; -#define parent_app_index c_tls_ctx_id.parent_app_index -#define app_session_handle c_tls_ctx_id.app_session_handle -#define tls_session_handle c_tls_ctx_id.tls_session_handle -#define listener_ctx_index c_tls_ctx_id.listener_ctx_index -#define tcp_is_ip4 c_tls_ctx_id.tcp_is_ip4 -#define tls_ctx_idx c_c_index - /* Temporary storage for session open opaque. Overwritten once - * underlying tcp connection is established */ -#define parent_app_api_context c_s_index - - u8 is_passive_close; - u8 *srv_hostname; - mbedtls_ssl_context ssl; - mbedtls_ssl_config conf; - mbedtls_x509_crt srvcert; - mbedtls_pk_context pkey; -} tls_ctx_t; - -typedef struct tls_main_ -{ - u32 app_index; - tls_ctx_t ***ctx_pool; - mbedtls_ctr_drbg_context *ctr_drbgs; - mbedtls_entropy_context *entropy_pools; - tls_ctx_t *listener_ctx_pool; - tls_ctx_t *half_open_ctx_pool; - clib_rwlock_t half_open_rwlock; - mbedtls_x509_crt cacert; - - /* - * Config - */ - u8 use_test_cert_in_ca; - char *ca_cert_path; -} tls_main_t; +#include <vnet/tls/tls.h> static tls_main_t tls_main; +static tls_engine_vft_t *tls_vfts; +#define DEFAULT_ENGINE 0 void tls_disconnect (u32 ctx_index, u32 thread_index); -static inline int +int tls_add_vpp_q_evt (svm_fifo_t * f, u8 evt_type) { session_fifo_event_t evt; @@ -181,47 +86,6 @@ tls_add_app_q_evt (application_t * app, stream_session_t * app_session) } u32 -tls_ctx_alloc (void) -{ - u8 thread_index = vlib_get_thread_index (); - tls_main_t *tm = &tls_main; - tls_ctx_t **ctx; - - pool_get (tm->ctx_pool[thread_index], ctx); - if (!(*ctx)) - *ctx = clib_mem_alloc (sizeof (tls_ctx_t)); - - memset (*ctx, 0, sizeof (tls_ctx_t)); - (*ctx)->c_thread_index = thread_index; - return ctx - tm->ctx_pool[thread_index]; -} - -void -tls_ctx_free (tls_ctx_t * ctx) -{ - vec_free (ctx->srv_hostname); - pool_put_index (tls_main.ctx_pool[vlib_get_thread_index ()], - ctx->tls_ctx_idx); -} - -tls_ctx_t * -tls_ctx_get (u32 ctx_index) -{ - tls_ctx_t **ctx; - ctx = pool_elt_at_index (tls_main.ctx_pool[vlib_get_thread_index ()], - ctx_index); - return (*ctx); -} - -tls_ctx_t * -tls_ctx_get_w_thread (u32 ctx_index, u8 thread_index) -{ - tls_ctx_t **ctx; - ctx = pool_elt_at_index (tls_main.ctx_pool[thread_index], ctx_index); - return (*ctx); -} - -u32 tls_listener_ctx_alloc (void) { tls_main_t *tm = &tls_main; @@ -306,259 +170,6 @@ tls_ctx_half_open_index (tls_ctx_t * ctx) } static int -tls_init_ctr_drbgs_and_entropy (u32 num_threads) -{ - tls_main_t *tm = &tls_main; - int i; - - vec_validate (tm->ctr_drbgs, num_threads - 1); - vec_validate (tm->entropy_pools, num_threads - 1); - for (i = 0; i < num_threads; i++) - tls_main.ctr_drbgs[i].f_entropy = 0; - - return 0; -} - -static int -tls_init_ctr_seed_drbgs (void) -{ - u32 thread_index = vlib_get_thread_index (); - tls_main_t *tm = &tls_main; - u8 *pers; - int rv; - pers = format (0, "vpp thread %u", thread_index); - - mbedtls_entropy_init (&tm->entropy_pools[thread_index]); - mbedtls_ctr_drbg_init (&tls_main.ctr_drbgs[thread_index]); - if ((rv = mbedtls_ctr_drbg_seed (&tm->ctr_drbgs[thread_index], - mbedtls_entropy_func, - &tm->entropy_pools[thread_index], - (const unsigned char *) pers, - vec_len (pers))) != 0) - { - vec_free (pers); - TLS_DBG (1, " failed\n ! mbedtls_ctr_drbg_seed returned %d\n", rv); - return -1; - } - vec_free (pers); - return 0; -} - -mbedtls_ctr_drbg_context * -tls_get_ctr_drbg () -{ - u8 thread_index = vlib_get_thread_index (); - if (PREDICT_FALSE (!tls_main.ctr_drbgs[thread_index].f_entropy)) - tls_init_ctr_seed_drbgs (); - return &tls_main.ctr_drbgs[thread_index]; -} - -static int -tls_net_send (void *ctx_indexp, const unsigned char *buf, size_t len) -{ - stream_session_t *tls_session; - uword ctx_index; - tls_ctx_t *ctx; - int rv; - - ctx_index = pointer_to_uword (ctx_indexp); - ctx = tls_ctx_get (ctx_index); - tls_session = session_get_from_handle (ctx->tls_session_handle); - rv = svm_fifo_enqueue_nowait (tls_session->server_tx_fifo, len, buf); - if (rv < 0) - return MBEDTLS_ERR_SSL_WANT_WRITE; - tls_add_vpp_q_evt (tls_session->server_tx_fifo, FIFO_EVENT_APP_TX); - return rv; -} - -static int -tls_net_recv (void *ctx_indexp, unsigned char *buf, size_t len) -{ - stream_session_t *tls_session; - uword ctx_index; - tls_ctx_t *ctx; - int rv; - - ctx_index = pointer_to_uword (ctx_indexp); - ctx = tls_ctx_get (ctx_index); - tls_session = session_get_from_handle (ctx->tls_session_handle); - rv = svm_fifo_dequeue_nowait (tls_session->server_rx_fifo, len, buf); - return (rv < 0) ? 0 : rv; -} - -static void -mbedtls_debug (void *ctx, int level, const char *file, int line, - const char *str) -{ - ((void) level); - fprintf ((FILE *) ctx, "%s:%04d: %s", file, line, str); - fflush ((FILE *) ctx); -} - -static int -tls_ctx_init_client (tls_ctx_t * ctx) -{ - tls_main_t *tm = &tls_main; - void *ctx_ptr; - int rv; - - /* - * 1. Setup SSL - */ - mbedtls_ssl_init (&ctx->ssl); - mbedtls_ssl_config_init (&ctx->conf); - if ((rv = mbedtls_ssl_config_defaults (&ctx->conf, MBEDTLS_SSL_IS_CLIENT, - MBEDTLS_SSL_TRANSPORT_STREAM, - MBEDTLS_SSL_PRESET_DEFAULT)) != 0) - { - TLS_DBG (1, "failed\n ! mbedtls_ssl_config_defaults returned %d\n\n", - rv); - return -1; - } - - mbedtls_ssl_conf_authmode (&ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL); - mbedtls_ssl_conf_ca_chain (&ctx->conf, &tm->cacert, NULL); - mbedtls_ssl_conf_rng (&ctx->conf, mbedtls_ctr_drbg_random, - tls_get_ctr_drbg ()); - mbedtls_ssl_conf_dbg (&ctx->conf, mbedtls_debug, stdout); - - if ((rv = mbedtls_ssl_setup (&ctx->ssl, &ctx->conf)) != 0) - { - TLS_DBG (1, "failed\n ! mbedtls_ssl_setup returned %d\n", rv); - return -1; - } - - if ((rv = mbedtls_ssl_set_hostname (&ctx->ssl, - (const char *) ctx->srv_hostname)) != 0) - { - TLS_DBG (1, "failed\n ! mbedtls_ssl_set_hostname returned %d\n", rv); - return -1; - } - - ctx_ptr = uword_to_pointer (ctx->tls_ctx_idx, void *); - mbedtls_ssl_set_bio (&ctx->ssl, ctx_ptr, tls_net_send, tls_net_recv, NULL); - mbedtls_debug_set_threshold (TLS_DEBUG_LEVEL_CLIENT); - - /* - * 2. Do the first 2 steps in the handshake. - */ - TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index, - ctx->tls_ctx_idx); - while (ctx->ssl.state != MBEDTLS_SSL_HANDSHAKE_OVER) - { - rv = mbedtls_ssl_handshake_step (&ctx->ssl); - if (rv != 0) - break; - } - TLS_DBG (2, "tls state for [%u]%u is %u", ctx->c_thread_index, - ctx->tls_ctx_idx, ctx->ssl.state); - return 0; -} - -static int -tls_ctx_init_server (tls_ctx_t * ctx) -{ - tls_main_t *tm = &tls_main; - application_t *app; - void *ctx_ptr; - int rv; - - mbedtls_ssl_init (&ctx->ssl); - mbedtls_ssl_config_init (&ctx->conf); - mbedtls_x509_crt_init (&ctx->srvcert); - mbedtls_pk_init (&ctx->pkey); - - /* - * 1. Cert - */ - app = application_get (ctx->parent_app_index); - if (!app->tls_cert || !app->tls_key) - { - TLS_DBG (1, " failed\n ! tls cert and/or key not configured %d", - ctx->parent_app_index); - return -1; - } - - rv = mbedtls_x509_crt_parse (&ctx->srvcert, - (const unsigned char *) app->tls_cert, - vec_len (app->tls_cert)); - if (rv != 0) - { - TLS_DBG (1, " failed\n ! mbedtls_x509_crt_parse returned %d", rv); - goto exit; - } - - rv = mbedtls_pk_parse_key (&ctx->pkey, - (const unsigned char *) app->tls_key, - vec_len (app->tls_key), NULL, 0); - if (rv != 0) - { - TLS_DBG (1, " failed\n ! mbedtls_pk_parse_key returned %d", rv); - goto exit; - } - - /* - * 2. SSL context config - */ - if ((rv = mbedtls_ssl_config_defaults (&ctx->conf, MBEDTLS_SSL_IS_SERVER, - MBEDTLS_SSL_TRANSPORT_STREAM, - MBEDTLS_SSL_PRESET_DEFAULT)) != 0) - { - TLS_DBG (1, " failed\n ! mbedtls_ssl_config_defaults returned %d", rv); - goto exit; - } - - mbedtls_ssl_conf_rng (&ctx->conf, mbedtls_ctr_drbg_random, - tls_get_ctr_drbg ()); - mbedtls_ssl_conf_dbg (&ctx->conf, mbedtls_debug, stdout); - - /* TODO CACHE - mbedtls_ssl_conf_session_cache( &ctx->conf, &cache, - mbedtls_ssl_cache_get, - mbedtls_ssl_cache_set ); - */ - - mbedtls_ssl_conf_ca_chain (&ctx->conf, &tm->cacert, NULL); - if ((rv = mbedtls_ssl_conf_own_cert (&ctx->conf, &ctx->srvcert, &ctx->pkey)) - != 0) - { - TLS_DBG (1, " failed\n ! mbedtls_ssl_conf_own_cert returned %d", rv); - goto exit; - } - - if ((rv = mbedtls_ssl_setup (&ctx->ssl, &ctx->conf)) != 0) - { - TLS_DBG (1, " failed\n ! mbedtls_ssl_setup returned %d", rv); - goto exit; - } - - mbedtls_ssl_session_reset (&ctx->ssl); - ctx_ptr = uword_to_pointer (ctx->tls_ctx_idx, void *); - mbedtls_ssl_set_bio (&ctx->ssl, ctx_ptr, tls_net_send, tls_net_recv, NULL); - - mbedtls_debug_set_threshold (TLS_DEBUG_LEVEL_SERVER); - - /* - * 3. Start handshake state machine - */ - TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index, - ctx->tls_ctx_idx); - while (ctx->ssl.state != MBEDTLS_SSL_HANDSHAKE_OVER) - { - rv = mbedtls_ssl_handshake_step (&ctx->ssl); - if (rv != 0) - break; - } - - TLS_DBG (2, "tls state for [%u]%u is %u", ctx->c_thread_index, - ctx->tls_ctx_idx, ctx->ssl.state); - return 0; - -exit: - return -1; -} - -static int tls_notify_app_accept (tls_ctx_t * ctx) { stream_session_t *app_listener, *app_session; @@ -627,56 +238,82 @@ failed: 1 /* failed */ ); } -static int +static inline u32 +tls_ctx_alloc (void) +{ + return tls_vfts[DEFAULT_ENGINE].ctx_alloc (); +} + +static inline void +tls_ctx_free (tls_ctx_t * ctx) +{ + vec_free (ctx->srv_hostname); + tls_vfts[DEFAULT_ENGINE].ctx_free (ctx); +} + +static inline tls_ctx_t * +tls_ctx_get (u32 ctx_index) +{ + return tls_vfts[DEFAULT_ENGINE].ctx_get (ctx_index); +} + +static inline tls_ctx_t * +tls_ctx_get_w_thread (u32 ctx_index, u8 thread_index) +{ + return tls_vfts[DEFAULT_ENGINE].ctx_get_w_thread (ctx_index, thread_index); +} + +static inline int +tls_ctx_init_server (tls_ctx_t * ctx) +{ + return tls_vfts[DEFAULT_ENGINE].ctx_init_server (ctx); +} + +static inline int +tls_ctx_init_client (tls_ctx_t * ctx) +{ + return tls_vfts[DEFAULT_ENGINE].ctx_init_client (ctx); +} + +static inline int +tls_ctx_write (tls_ctx_t * ctx, u8 * buf, u32 len) +{ + return tls_vfts[DEFAULT_ENGINE].ctx_write (ctx, buf, len); +} + +static inline int +tls_ctx_read (tls_ctx_t * ctx, u8 * buf, u32 len) +{ + return tls_vfts[DEFAULT_ENGINE].ctx_read (ctx, buf, len); +} + +static inline u8 +tls_ctx_handshake_is_over (tls_ctx_t * ctx) +{ + return tls_vfts[DEFAULT_ENGINE].ctx_handshake_is_over (ctx); +} + +static inline int tls_handshake_rx (tls_ctx_t * ctx) { - u32 flags; int rv; - while (ctx->ssl.state != MBEDTLS_SSL_HANDSHAKE_OVER) - { - rv = mbedtls_ssl_handshake_step (&ctx->ssl); - if (rv != 0) - break; - } - TLS_DBG (2, "tls state for %u is %u", ctx->tls_ctx_idx, ctx->ssl.state); + rv = tls_vfts[DEFAULT_ENGINE].ctx_handshake_rx (ctx); - if (ctx->ssl.state != MBEDTLS_SSL_HANDSHAKE_OVER) - return 0; - - /* - * Handshake complete - */ - if (ctx->ssl.conf->endpoint == MBEDTLS_SSL_IS_CLIENT) + switch (rv) { - /* - * Verify server certificate - */ - if ((flags = mbedtls_ssl_get_verify_result (&ctx->ssl)) != 0) - { - char buf[512]; - TLS_DBG (1, " failed\n"); - mbedtls_x509_crt_verify_info (buf, sizeof (buf), " ! ", flags); - TLS_DBG (1, "%s\n", buf); - - /* - * Presence of hostname enforces strict certificate verification - */ - if (ctx->srv_hostname) - { - tls_disconnect (ctx->tls_ctx_idx, vlib_get_thread_index ()); - tls_notify_app_connected (ctx, /* is failed */ 1); - return -1; - } - } + case CLIENT_HANDSHAKE_OK: tls_notify_app_connected (ctx, /* is failed */ 0); - } - else - { + break; + case CLIENT_HANDSHAKE_FAIL: + tls_disconnect (ctx->tls_ctx_idx, vlib_get_thread_index ()); + tls_notify_app_connected (ctx, /* is failed */ 1); + break; + case SERVER_HANDSHAKE_OK: tls_notify_app_accept (ctx); + break; + default: + return 0; } - - TLS_DBG (1, "Handshake for %u complete. TLS cipher is %x", - ctx->tls_ctx_idx, ctx->ssl.session->ciphersuite); return 0; } @@ -707,7 +344,7 @@ tls_session_disconnect_callback (stream_session_t * tls_session) application_t *app; ctx = tls_ctx_get (tls_session->opaque); - if (ctx->ssl.state != MBEDTLS_SSL_HANDSHAKE_OVER) + if (!tls_ctx_handshake_is_over (ctx)) { stream_session_disconnect (tls_session); return; @@ -754,7 +391,7 @@ tls_app_tx_callback (stream_session_t * app_session) int wrote; ctx = tls_ctx_get (app_session->connection_index); - if (ctx->ssl.state != MBEDTLS_SSL_HANDSHAKE_OVER) + if (!tls_ctx_handshake_is_over (ctx)) tls_add_vpp_q_evt (app_session->server_tx_fifo, FIFO_EVENT_APP_TX); deq_max = svm_fifo_max_dequeue (app_session->server_tx_fifo); @@ -773,7 +410,7 @@ tls_app_tx_callback (stream_session_t * app_session) vec_validate (tmp_buf, deq_now); svm_fifo_peek (app_session->server_tx_fifo, 0, deq_now, tmp_buf); - wrote = mbedtls_ssl_write (&ctx->ssl, tmp_buf, deq_now); + wrote = tls_ctx_write (ctx, tmp_buf, deq_now); if (wrote <= 0) { tls_add_vpp_q_evt (app_session->server_tx_fifo, FIFO_EVENT_APP_TX); @@ -802,7 +439,7 @@ tls_app_rx_callback (stream_session_t * tls_session) int read, enq; ctx = tls_ctx_get (tls_session->opaque); - if (ctx->ssl.state != MBEDTLS_SSL_HANDSHAKE_OVER) + if (!tls_ctx_handshake_is_over (ctx)) return tls_handshake_rx (ctx); deq_max = svm_fifo_max_dequeue (tls_session->server_rx_fifo); @@ -820,7 +457,7 @@ tls_app_rx_callback (stream_session_t * tls_session) } vec_validate (tmp_buf, enq_now); - read = mbedtls_ssl_read (&ctx->ssl, tmp_buf, enq_now); + read = tls_ctx_read (ctx, tmp_buf, enq_now); if (read <= 0) { tls_add_vpp_q_evt (tls_session->server_rx_fifo, FIFO_EVENT_BUILTIN_RX); @@ -938,9 +575,6 @@ tls_disconnect (u32 ctx_index, u32 thread_index) TLS_DBG (1, "Disconnecting %u", ctx_index); ctx = tls_ctx_get (ctx_index); - if (ctx->ssl.state == MBEDTLS_SSL_HANDSHAKE_OVER && !ctx->is_passive_close) - mbedtls_ssl_close_notify (&ctx->ssl); - tls_session = session_get_from_handle (ctx->tls_session_handle); stream_session_disconnect (tls_session); @@ -952,13 +586,6 @@ tls_disconnect (u32 ctx_index, u32 thread_index) app_session->server_tx_fifo); session_free (app_session); } - if (ctx->ssl.conf->endpoint == MBEDTLS_SSL_IS_SERVER) - { - mbedtls_x509_crt_free (&ctx->srvcert); - mbedtls_pk_free (&ctx->pkey); - } - mbedtls_ssl_free (&ctx->ssl); - mbedtls_ssl_config_free (&ctx->conf); tls_ctx_free (ctx); } @@ -1102,78 +729,21 @@ const static transport_proto_vft_t tls_proto = { }; /* *INDENT-ON* */ -int -tls_init_mem (void) +void +tls_register_engine (const tls_engine_vft_t * vft, tls_engine_type_t type) { -#if TLS_USE_OUR_MEM_FUNCS - mbedtls_platform_set_calloc_free (mbedtls_calloc_fn, mbedtls_free_fn); -#endif - return 0; -} - -int -tls_init_ca_chain (void) -{ - tls_main_t *tm = &tls_main; - int rv; - - if (!tm->ca_cert_path) - tm->ca_cert_path = TLS_CA_CERT_PATH; - - if (access (tm->ca_cert_path, F_OK | R_OK) == -1) - { - clib_warning ("Could not initialize TLS CA certificates"); - return -1; - } - - mbedtls_x509_crt_init (&tm->cacert); - rv = mbedtls_x509_crt_parse_file (&tm->cacert, tm->ca_cert_path); - if (rv < 0) - { - clib_warning ("Couldn't parse system CA certificates: -0x%x", -rv); - } - if (tm->use_test_cert_in_ca) - { - rv = mbedtls_x509_crt_parse (&tm->cacert, - (const unsigned char *) test_srv_crt_rsa, - test_srv_crt_rsa_len); - if (rv < 0) - { - clib_warning ("Couldn't parse test certificate: -0x%x", -rv); - return -1; - } - } - return (rv < 0 ? -1 : 0); + vec_validate (tls_vfts, type); + tls_vfts[type] = *vft; } clib_error_t * tls_init (vlib_main_t * vm) { - vlib_thread_main_t *vtm = vlib_get_thread_main (); - u32 fifo_size = 64 << 10, num_threads; vnet_app_attach_args_t _a, *a = &_a; u64 options[APP_OPTIONS_N_OPTIONS]; u32 segment_size = 512 << 20; tls_main_t *tm = &tls_main; - - num_threads = 1 /* main thread */ + vtm->n_threads; - - if (tls_init_mem ()) - { - clib_warning ("failed to initialize mem"); - return clib_error_return (0, "failed to initalize mem"); - } - if (tls_init_ca_chain ()) - { - clib_warning ("failed to initialize TLS CA chain"); - return clib_error_return (0, "failed to initalize TLS CA chain"); - } - if (tls_init_ctr_drbgs_and_entropy (num_threads)) - { - clib_warning ("failed to initialize entropy and random generators"); - return clib_error_return (0, "failed to initialize entropy and random " - "generators"); - } + u32 fifo_size = 64 << 10; memset (a, 0, sizeof (*a)); memset (options, 0, sizeof (options)); @@ -1193,8 +763,10 @@ tls_init (vlib_main_t * vm) return clib_error_return (0, "failed to attach tls app"); } + if (!tm->ca_cert_path) + tm->ca_cert_path = TLS_CA_CERT_PATH; + tm->app_index = a->app_index; - vec_validate (tm->ctx_pool, num_threads - 1); clib_rwlock_init (&tm->half_open_rwlock); transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto, @@ -1225,6 +797,13 @@ tls_config_fn (vlib_main_t * vm, unformat_input_t * input) } VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls"); + +tls_main_t * +vnet_tls_get_main (void) +{ + return &tls_main; +} + /* * fd.io coding-style-patch-verification: ON * diff --git a/src/vnet/tls/tls.h b/src/vnet/tls/tls.h new file mode 100644 index 00000000000..0dfc48bd336 --- /dev/null +++ b/src/vnet/tls/tls.h @@ -0,0 +1,127 @@ +/* + * Copyright (c) 2018 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 <vnet/session/application_interface.h> +#include <vppinfra/lock.h> + +#ifndef SRC_VNET_TLS_TLS_H_ +#define SRC_VNET_TLS_TLS_H_ + +#define TLS_DEBUG 0 +#define TLS_DEBUG_LEVEL_CLIENT 0 +#define TLS_DEBUG_LEVEL_SERVER 0 + +#define TLS_CHUNK_SIZE (1 << 14) +#define TLS_CA_CERT_PATH "/etc/ssl/certs/ca-certificates.crt" + +#if TLS_DEBUG +#define TLS_DBG(_lvl, _fmt, _args...) \ + if (_lvl <= TLS_DEBUG) \ + clib_warning (_fmt, ##_args) +#else +#define TLS_DBG(_fmt, _args...) +#endif + +/* *INDENT-OFF* */ +typedef CLIB_PACKED (struct tls_cxt_id_ +{ + u32 parent_app_index; + session_handle_t app_session_handle; + session_handle_t tls_session_handle; + u32 listener_ctx_index; + u8 tcp_is_ip4; +}) tls_ctx_id_t; +/* *INDENT-ON* */ + +STATIC_ASSERT (sizeof (tls_ctx_id_t) <= 42, "ctx id must be less than 42"); + +typedef struct tls_ctx_ +{ + union + { + transport_connection_t connection; + tls_ctx_id_t c_tls_ctx_id; + }; +#define parent_app_index c_tls_ctx_id.parent_app_index +#define app_session_handle c_tls_ctx_id.app_session_handle +#define tls_session_handle c_tls_ctx_id.tls_session_handle +#define listener_ctx_index c_tls_ctx_id.listener_ctx_index +#define tcp_is_ip4 c_tls_ctx_id.tcp_is_ip4 +#define tls_ctx_idx c_c_index + /* Temporary storage for session open opaque. Overwritten once + * underlying tcp connection is established */ +#define parent_app_api_context c_s_index + + u8 is_passive_close; + u8 *srv_hostname; +} tls_ctx_t; + +typedef struct tls_main_ +{ + u32 app_index; + tls_ctx_t *listener_ctx_pool; + tls_ctx_t *half_open_ctx_pool; + clib_rwlock_t half_open_rwlock; + + /* + * Config + */ + u8 use_test_cert_in_ca; + char *ca_cert_path; +} tls_main_t; + +typedef struct tls_engine_vft_ +{ + u32 (*ctx_alloc) (void); + void (*ctx_free) (tls_ctx_t * ctx); + tls_ctx_t *(*ctx_get) (u32 ctx_index); + tls_ctx_t *(*ctx_get_w_thread) (u32 ctx_index, u8 thread_index); + int (*ctx_init_client) (tls_ctx_t * ctx); + int (*ctx_init_server) (tls_ctx_t * ctx); + int (*ctx_read) (tls_ctx_t * ctx, u8 * buf, u32 len); + int (*ctx_write) (tls_ctx_t * ctx, u8 * buf, u32 len); + int (*ctx_handshake_rx) (tls_ctx_t * ctx); + u8 (*ctx_handshake_is_over) (tls_ctx_t * ctx); +} tls_engine_vft_t; + +enum tls_handshake_results_ +{ + HANDSHAKE_NOT_OVER, + CLIENT_HANDSHAKE_OK, + CLIENT_HANDSHAKE_FAIL, + SERVER_HANDSHAKE_OK +}; + +typedef enum tls_engine_type_ +{ + TLS_ENGINE_MBEDTLS, + TLS_ENGINE_OPENSSL, + TLS_N_ENGINES +} tls_engine_type_t; + +tls_main_t *vnet_tls_get_main (void); +void tls_register_engine (const tls_engine_vft_t * vft, + tls_engine_type_t type); +int tls_add_vpp_q_evt (svm_fifo_t * f, u8 evt_type); + +#endif /* SRC_VNET_TLS_TLS_H_ */ +/* + * fd.io coding-style-patch-verification: ON + * + * Local Variables: + * eval: (c-set-style "gnu") + * End: + */ |