src/vnet/tls/tls.h

   1 /*
   2  * Copyright (c) 2018-2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16
  17 #include <vnet/session/application_interface.h>
  18 #include <vnet/session/session.h>
  19 #include <vppinfra/lock.h>
  20
  21 #ifndef SRC_VNET_TLS_TLS_H_
  22 #define SRC_VNET_TLS_TLS_H_
  23
  24 #define TLS_DEBUG               0
  25 #define TLS_DEBUG_LEVEL_CLIENT  0
  26 #define TLS_DEBUG_LEVEL_SERVER  0
  27
  28 #define TLS_CHUNK_SIZE          (1 << 14)
  29 #define TLS_CA_CERT_PATH        "/etc/ssl/certs/ca-certificates.crt"
  30
  31 #if TLS_DEBUG
  32 #define TLS_DBG(_lvl, _fmt, _args...)                   \
  33   if (_lvl <= TLS_DEBUG)                                \
  34     clib_warning (_fmt, ##_args)
  35 #else
  36 #define TLS_DBG(_lvl, _fmt, _args...)
  37 #endif
  38
  39 /* *INDENT-OFF* */
  40 typedef CLIB_PACKED (struct tls_cxt_id_
  41 {
  42   u32 parent_app_index;
  43   union {
  44     session_handle_t app_session_handle;
  45     u32 parent_app_api_ctx;
  46   };
  47   session_handle_t tls_session_handle;
  48   u32 ssl_ctx;
  49   u32 listener_ctx_index;
  50   u8 tcp_is_ip4;
  51   u8 tls_engine_id;
  52 }) tls_ctx_id_t;
  53 /* *INDENT-ON* */
  54
  55 STATIC_ASSERT (sizeof (tls_ctx_id_t) <= 42, "ctx id must be less than 42");
  56
  57 typedef struct tls_ctx_
  58 {
  59   union
  60   {
  61     transport_connection_t connection;
  62     tls_ctx_id_t c_tls_ctx_id;
  63   };
  64 #define parent_app_index c_tls_ctx_id.parent_app_index
  65 #define app_session_handle c_tls_ctx_id.app_session_handle
  66 #define tls_session_handle c_tls_ctx_id.tls_session_handle
  67 #define listener_ctx_index c_tls_ctx_id.listener_ctx_index
  68 #define tcp_is_ip4 c_tls_ctx_id.tcp_is_ip4
  69 #define tls_ctx_engine c_tls_ctx_id.tls_engine_id
  70 #define tls_ssl_ctx c_tls_ctx_id.ssl_ctx
  71 #define tls_ctx_handle c_c_index
  72   /* Temporary storage for session open opaque. Overwritten once
  73    * underlying tcp connection is established */
  74 #define parent_app_api_context c_tls_ctx_id.parent_app_api_ctx
  75
  76   u8 is_passive_close;
  77   u8 resume;
  78   u8 *srv_hostname;
  79 } tls_ctx_t;
  80
  81 typedef struct tls_main_
  82 {
  83   u32 app_index;
  84   tls_ctx_t *listener_ctx_pool;
  85   tls_ctx_t *half_open_ctx_pool;
  86   clib_rwlock_t half_open_rwlock;
  87   u8 **rx_bufs;
  88   u8 **tx_bufs;
  89
  90   /*
  91    * Config
  92    */
  93   u8 use_test_cert_in_ca;
  94   char *ca_cert_path;
  95 } tls_main_t;
  96
  97 typedef struct tls_engine_vft_
  98 {
  99   u32 (*ctx_alloc) (void);
 100   void (*ctx_free) (tls_ctx_t * ctx);
 101   tls_ctx_t *(*ctx_get) (u32 ctx_index);
 102   tls_ctx_t *(*ctx_get_w_thread) (u32 ctx_index, u8 thread_index);
 103   int (*ctx_init_client) (tls_ctx_t * ctx);
 104   int (*ctx_init_server) (tls_ctx_t * ctx);
 105   int (*ctx_read) (tls_ctx_t * ctx, session_t * tls_session);
 106   int (*ctx_write) (tls_ctx_t * ctx, session_t * app_session);
 107     u8 (*ctx_handshake_is_over) (tls_ctx_t * ctx);
 108   int (*ctx_start_listen) (tls_ctx_t * ctx);
 109   int (*ctx_stop_listen) (tls_ctx_t * ctx);
 110 } tls_engine_vft_t;
 111
 112 typedef enum tls_engine_type_
 113 {
 114   TLS_ENGINE_NONE,
 115   TLS_ENGINE_MBEDTLS,
 116   TLS_ENGINE_OPENSSL,
 117   TLS_N_ENGINES
 118 } tls_engine_type_t;
 119
 120 tls_main_t *vnet_tls_get_main (void);
 121 void tls_register_engine (const tls_engine_vft_t * vft,
 122                           tls_engine_type_t type);
 123 int tls_add_vpp_q_rx_evt (session_t * s);
 124 int tls_add_vpp_q_tx_evt (session_t * s);
 125 int tls_add_vpp_q_builtin_tx_evt (session_t * s);
 126 int tls_add_vpp_q_builtin_rx_evt (session_t * s);
 127 int tls_notify_app_accept (tls_ctx_t * ctx);
 128 int tls_notify_app_connected (tls_ctx_t * ctx, u8 is_failed);
 129 void tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session);
 130 #endif /* SRC_VNET_TLS_TLS_H_ */
 131 /*
 132  * fd.io coding-style-patch-verification: ON
 133  *
 134  * Local Variables:
 135  * eval: (c-set-style "gnu")
 136  * End:
 137  */