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 #include <vnet/session/application_interface.h>
  17 #include <vnet/session/application.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 struct tls_cxt_id_
  41 {
  42   union {
  43     session_handle_t app_session_handle;
  44     u32 parent_app_api_ctx;
  45   };
  46   session_handle_t tls_session_handle;
  47   u32 parent_app_wrk_index;
  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) <= TRANSPORT_CONN_ID_LEN,
  56                "ctx id must be less than TRANSPORT_CONN_ID_LEN");
  57
  58 typedef struct tls_ctx_
  59 {
  60   union
  61   {
  62     transport_connection_t connection;
  63     tls_ctx_id_t c_tls_ctx_id;
  64   };
  65 #define parent_app_wrk_index c_tls_ctx_id.parent_app_wrk_index
  66 #define app_session_handle c_tls_ctx_id.app_session_handle
  67 #define tls_session_handle c_tls_ctx_id.tls_session_handle
  68 #define listener_ctx_index c_tls_ctx_id.listener_ctx_index
  69 #define tcp_is_ip4 c_tls_ctx_id.tcp_is_ip4
  70 #define tls_ctx_engine c_tls_ctx_id.tls_engine_id
  71 #define tls_ssl_ctx c_tls_ctx_id.ssl_ctx
  72 #define tls_ctx_handle c_c_index
  73   /* Temporary storage for session open opaque. Overwritten once
  74    * underlying tcp connection is established */
  75 #define parent_app_api_context c_tls_ctx_id.parent_app_api_ctx
  76
  77   u8 is_passive_close;
  78   u8 resume;
  79   u8 app_closed;
  80   u8 no_app_session;
  81   u8 *srv_hostname;
  82   u32 ckpair_index;
  83 } tls_ctx_t;
  84
  85 typedef struct tls_main_
  86 {
  87   u32 app_index;
  88   tls_ctx_t *listener_ctx_pool;
  89   tls_ctx_t *half_open_ctx_pool;
  90   clib_rwlock_t half_open_rwlock;
  91   u8 **rx_bufs;
  92   u8 **tx_bufs;
  93
  94   /*
  95    * Config
  96    */
  97   u8 use_test_cert_in_ca;
  98   char *ca_cert_path;
  99   u64 first_seg_size;
 100   u32 fifo_size;
 101 } tls_main_t;
 102
 103 typedef struct tls_engine_vft_
 104 {
 105   u32 (*ctx_alloc) (void);
 106   void (*ctx_free) (tls_ctx_t * ctx);
 107   tls_ctx_t *(*ctx_get) (u32 ctx_index);
 108   tls_ctx_t *(*ctx_get_w_thread) (u32 ctx_index, u8 thread_index);
 109   int (*ctx_init_client) (tls_ctx_t * ctx);
 110   int (*ctx_init_server) (tls_ctx_t * ctx);
 111   int (*ctx_read) (tls_ctx_t * ctx, session_t * tls_session);
 112   int (*ctx_write) (tls_ctx_t * ctx, session_t * app_session);
 113     u8 (*ctx_handshake_is_over) (tls_ctx_t * ctx);
 114   int (*ctx_start_listen) (tls_ctx_t * ctx);
 115   int (*ctx_stop_listen) (tls_ctx_t * ctx);
 116   int (*ctx_transport_close) (tls_ctx_t * ctx);
 117   int (*ctx_app_close) (tls_ctx_t * ctx);
 118 } tls_engine_vft_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 void tls_disconnect_transport (tls_ctx_t * ctx);
 131 #endif /* SRC_VNET_TLS_TLS_H_ */
 132
 133 /*
 134  * fd.io coding-style-patch-verification: ON
 135  *
 136  * Local Variables:
 137  * eval: (c-set-style "gnu")
 138  * End:
 139  */