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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include <vnet/session/application_interface.h>
17 #include <vnet/session/application.h>
18 #include <vnet/session/session.h>
19 #include <vppinfra/lock.h>
21 #ifndef SRC_VNET_TLS_TLS_H_
22 #define SRC_VNET_TLS_TLS_H_
25 #define TLS_DEBUG_LEVEL_CLIENT 0
26 #define TLS_DEBUG_LEVEL_SERVER 0
28 #define TLS_CHUNK_SIZE (1 << 14)
29 #define TLS_CA_CERT_PATH "/etc/ssl/certs/ca-certificates.crt"
32 #define TLS_DBG(_lvl, _fmt, _args...) \
33 if (_lvl <= TLS_DEBUG) \
34 clib_warning (_fmt, ##_args)
36 #define TLS_DBG(_lvl, _fmt, _args...)
40 typedef struct tls_cxt_id_
43 session_handle_t app_session_handle;
44 u32 parent_app_api_ctx;
46 session_handle_t tls_session_handle;
47 u32 parent_app_wrk_index;
49 u32 listener_ctx_index;
55 STATIC_ASSERT (sizeof (tls_ctx_id_t) <= TRANSPORT_CONN_ID_LEN,
56 "ctx id must be less than TRANSPORT_CONN_ID_LEN");
58 typedef struct tls_ctx_
62 transport_connection_t connection;
63 tls_ctx_id_t c_tls_ctx_id;
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
84 typedef struct tls_main_
87 tls_ctx_t *listener_ctx_pool;
88 tls_ctx_t *half_open_ctx_pool;
89 clib_rwlock_t half_open_rwlock;
96 u8 use_test_cert_in_ca;
102 typedef struct tls_engine_vft_
104 u32 (*ctx_alloc) (void);
105 void (*ctx_free) (tls_ctx_t * ctx);
106 tls_ctx_t *(*ctx_get) (u32 ctx_index);
107 tls_ctx_t *(*ctx_get_w_thread) (u32 ctx_index, u8 thread_index);
108 int (*ctx_init_client) (tls_ctx_t * ctx);
109 int (*ctx_init_server) (tls_ctx_t * ctx);
110 int (*ctx_read) (tls_ctx_t * ctx, session_t * tls_session);
111 int (*ctx_write) (tls_ctx_t * ctx, session_t * app_session);
112 u8 (*ctx_handshake_is_over) (tls_ctx_t * ctx);
113 int (*ctx_start_listen) (tls_ctx_t * ctx);
114 int (*ctx_stop_listen) (tls_ctx_t * ctx);
115 int (*ctx_transport_close) (tls_ctx_t * ctx);
116 int (*ctx_app_close) (tls_ctx_t * ctx);
119 tls_main_t *vnet_tls_get_main (void);
120 void tls_register_engine (const tls_engine_vft_t * vft,
121 tls_engine_type_t type);
122 int tls_add_vpp_q_rx_evt (session_t * s);
123 int tls_add_vpp_q_tx_evt (session_t * s);
124 int tls_add_vpp_q_builtin_tx_evt (session_t * s);
125 int tls_add_vpp_q_builtin_rx_evt (session_t * s);
126 int tls_notify_app_accept (tls_ctx_t * ctx);
127 int tls_notify_app_connected (tls_ctx_t * ctx, u8 is_failed);
128 void tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session);
129 void tls_disconnect_transport (tls_ctx_t * ctx);
130 #endif /* SRC_VNET_TLS_TLS_H_ */
133 * fd.io coding-style-patch-verification: ON
136 * eval: (c-set-style "gnu")