blob: 3c06498e6e0b430079444b432d08cb58f7c5479d [file] [log] [blame]
Florin Coras371ca502018-02-21 12:07:41 -08001/*
Florin Corasc9940fc2019-02-05 20:55:11 -08002 * Copyright (c) 2018-2019 Cisco and/or its affiliates.
Florin Coras371ca502018-02-21 12:07:41 -08003 * 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 <vppinfra/lock.h>
Florin Corasd77eee62018-03-07 08:49:27 -080018#include <vnet/tls/tls.h>
Florin Coras371ca502018-02-21 12:07:41 -080019
20static tls_main_t tls_main;
Florin Corasd77eee62018-03-07 08:49:27 -080021static tls_engine_vft_t *tls_vfts;
Florin Coras371ca502018-02-21 12:07:41 -080022
Florin Coras58d36f02018-03-09 13:05:53 -080023#define TLS_INVALID_HANDLE ~0
24#define TLS_IDX_MASK 0x00FFFFFF
jxm975fde82021-06-17 04:44:40 +000025#define TLS_ENGINE_TYPE_SHIFT 28
Florin Coras58d36f02018-03-09 13:05:53 -080026
27void tls_disconnect (u32 ctx_handle, u32 thread_index);
28
Florin Coras06a6a302019-04-17 14:19:12 -070029void
Florin Corasc01d5782018-10-17 14:53:11 -070030tls_disconnect_transport (tls_ctx_t * ctx)
31{
32 vnet_disconnect_args_t a = {
33 .handle = ctx->tls_session_handle,
34 .app_index = tls_main.app_index,
35 };
36
37 if (vnet_disconnect_session (&a))
38 clib_warning ("disconnect returned");
39}
40
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +020041crypto_engine_type_t
Florin Coras58d36f02018-03-09 13:05:53 -080042tls_get_available_engine (void)
43{
44 int i;
45 for (i = 0; i < vec_len (tls_vfts); i++)
46 {
47 if (tls_vfts[i].ctx_alloc)
48 return i;
49 }
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +020050 return CRYPTO_ENGINE_NONE;
Florin Coras58d36f02018-03-09 13:05:53 -080051}
Florin Coras371ca502018-02-21 12:07:41 -080052
Florin Corasd77eee62018-03-07 08:49:27 -080053int
Florin Coras288eaab2019-02-03 15:26:14 -080054tls_add_vpp_q_rx_evt (session_t * s)
Florin Coras371ca502018-02-21 12:07:41 -080055{
Florin Coras288eaab2019-02-03 15:26:14 -080056 if (svm_fifo_set_event (s->rx_fifo))
Florin Corasfe97da32019-03-06 10:09:04 -080057 session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_RX);
Florin Corasef915342018-09-29 10:23:06 -070058 return 0;
59}
60
61int
Florin Coras288eaab2019-02-03 15:26:14 -080062tls_add_vpp_q_builtin_rx_evt (session_t * s)
Florin Corasef915342018-09-29 10:23:06 -070063{
Florin Coras0242d302022-12-22 15:03:44 -080064 session_enqueue_notify (s);
Florin Corasef915342018-09-29 10:23:06 -070065 return 0;
66}
67
68int
Florin Coras288eaab2019-02-03 15:26:14 -080069tls_add_vpp_q_tx_evt (session_t * s)
Florin Corasef915342018-09-29 10:23:06 -070070{
Florin Coras288eaab2019-02-03 15:26:14 -080071 if (svm_fifo_set_event (s->tx_fifo))
Florin Corasfe97da32019-03-06 10:09:04 -080072 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
Florin Corasef915342018-09-29 10:23:06 -070073 return 0;
74}
75
Florin Coras371ca502018-02-21 12:07:41 -080076static inline int
Florin Coras0242d302022-12-22 15:03:44 -080077tls_add_app_q_evt (app_worker_t *app_wrk, session_t *app_session)
Florin Coras371ca502018-02-21 12:07:41 -080078{
Florin Coras0242d302022-12-22 15:03:44 -080079 app_worker_add_event (app_wrk, app_session, SESSION_IO_EVT_RX);
80 return 0;
Florin Coras371ca502018-02-21 12:07:41 -080081}
82
83u32
Florin Coras371ca502018-02-21 12:07:41 -080084tls_listener_ctx_alloc (void)
85{
86 tls_main_t *tm = &tls_main;
87 tls_ctx_t *ctx;
88
89 pool_get (tm->listener_ctx_pool, ctx);
Dave Barachb7b92992018-10-17 10:38:51 -040090 clib_memset (ctx, 0, sizeof (*ctx));
Florin Coras371ca502018-02-21 12:07:41 -080091 return ctx - tm->listener_ctx_pool;
92}
93
94void
Florin Corase3e2f072018-03-04 07:24:30 -080095tls_listener_ctx_free (tls_ctx_t * ctx)
Florin Coras371ca502018-02-21 12:07:41 -080096{
Florin Corasc01d5782018-10-17 14:53:11 -070097 if (CLIB_DEBUG)
98 memset (ctx, 0xfb, sizeof (*ctx));
Florin Corase3e2f072018-03-04 07:24:30 -080099 pool_put (tls_main.listener_ctx_pool, ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800100}
101
102tls_ctx_t *
103tls_listener_ctx_get (u32 ctx_index)
104{
105 return pool_elt_at_index (tls_main.listener_ctx_pool, ctx_index);
106}
107
108u32
109tls_listener_ctx_index (tls_ctx_t * ctx)
110{
111 return (ctx - tls_main.listener_ctx_pool);
112}
113
114u32
115tls_ctx_half_open_alloc (void)
116{
117 tls_main_t *tm = &tls_main;
Florin Coras371ca502018-02-21 12:07:41 -0800118 tls_ctx_t *ctx;
Florin Coras371ca502018-02-21 12:07:41 -0800119
Florin Corasa474bc82023-12-04 20:29:52 -0800120 if (vec_len (tm->postponed_ho_free))
121 tls_flush_postponed_ho_cleanups ();
122
Florin Coras009303d2022-03-29 17:49:37 -0700123 pool_get_aligned_safe (tm->half_open_ctx_pool, ctx, CLIB_CACHE_LINE_BYTES);
124
125 clib_memset (ctx, 0, sizeof (*ctx));
126 ctx->c_c_index = ctx - tm->half_open_ctx_pool;
Florin Coras309f7aa2022-03-18 08:33:08 -0700127 ctx->c_thread_index = transport_cl_thread ();
Florin Coras009303d2022-03-29 17:49:37 -0700128
129 return ctx->c_c_index;
Florin Coras371ca502018-02-21 12:07:41 -0800130}
131
132void
133tls_ctx_half_open_free (u32 ho_index)
134{
Florin Coras371ca502018-02-21 12:07:41 -0800135 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
Florin Coras371ca502018-02-21 12:07:41 -0800136}
137
138tls_ctx_t *
139tls_ctx_half_open_get (u32 ctx_index)
140{
141 tls_main_t *tm = &tls_main;
Florin Coras371ca502018-02-21 12:07:41 -0800142 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
143}
144
145void
Florin Corasa474bc82023-12-04 20:29:52 -0800146tls_add_postponed_ho_cleanups (u32 ho_index)
147{
148 tls_main_t *tm = &tls_main;
149 vec_add1 (tm->postponed_ho_free, ho_index);
150}
151
152static void
153tls_ctx_ho_try_free (u32 ho_index)
154{
155 tls_ctx_t *ctx;
156
157 ctx = tls_ctx_half_open_get (ho_index);
158 /* Probably tcp connected just before tcp establish timeout and
159 * worker that owns established session has not yet received
160 * @ref tls_session_connected_cb */
161 if (!(ctx->flags & TLS_CONN_F_HO_DONE))
162 {
163 ctx->tls_session_handle = SESSION_INVALID_HANDLE;
164 tls_add_postponed_ho_cleanups (ho_index);
165 return;
166 }
Florin Coras4a98b932024-01-31 13:45:39 -0800167 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
Florin Corasa474bc82023-12-04 20:29:52 -0800168 session_half_open_delete_notify (&ctx->connection);
169 tls_ctx_half_open_free (ho_index);
170}
171
172void
173tls_flush_postponed_ho_cleanups ()
174{
175 tls_main_t *tm = &tls_main;
176 u32 *ho_indexp, *tmp;
177
178 tmp = tm->postponed_ho_free;
179 tm->postponed_ho_free = tm->ho_free_list;
180 tm->ho_free_list = tmp;
181
182 vec_foreach (ho_indexp, tm->ho_free_list)
183 tls_ctx_ho_try_free (*ho_indexp);
184
185 vec_reset_length (tm->ho_free_list);
186}
187
188void
Florin Coras288eaab2019-02-03 15:26:14 -0800189tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
Florin Coras58d36f02018-03-09 13:05:53 -0800190{
Florin Corasbf7ce2c2019-03-06 14:44:42 -0800191 app_worker_t *app_wrk;
192 app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
193 if (PREDICT_TRUE (app_wrk != 0))
194 tls_add_app_q_evt (app_wrk, app_session);
Florin Coras58d36f02018-03-09 13:05:53 -0800195}
196
197int
Florin Coras371ca502018-02-21 12:07:41 -0800198tls_notify_app_accept (tls_ctx_t * ctx)
199{
Florin Coras288eaab2019-02-03 15:26:14 -0800200 session_t *app_listener, *app_session;
Florin Coras15531972018-08-12 23:50:53 -0700201 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800202 tls_ctx_t *lctx;
203 int rv;
204
Florin Coras371ca502018-02-21 12:07:41 -0800205 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
Florin Corasa27a46e2019-02-18 13:02:28 -0800206 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800207
Florin Coras58a93e82019-01-14 23:33:46 -0800208 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
Florin Corasdf57ea02019-02-18 20:14:20 -0800209 app_session->app_wrk_index = ctx->parent_app_wrk_index;
Florin Coras58d36f02018-03-09 13:05:53 -0800210 app_session->connection_index = ctx->tls_ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800211 app_session->session_type = app_listener->session_type;
Nathan Skrzypczak2f0f96b2019-06-13 10:14:28 +0200212 app_session->listener_handle = listen_session_get_handle (app_listener);
Florin Coras8a140612019-02-18 22:39:39 -0800213 app_session->session_state = SESSION_STATE_ACCEPTING;
Florin Coras15531972018-08-12 23:50:53 -0700214
Florin Corasa27a46e2019-02-18 13:02:28 -0800215 if ((rv = app_worker_init_accepted (app_session)))
Florin Coras371ca502018-02-21 12:07:41 -0800216 {
217 TLS_DBG (1, "failed to allocate fifos");
Florin Corasa27a46e2019-02-18 13:02:28 -0800218 session_free (app_session);
Florin Coras4a98b932024-01-31 13:45:39 -0800219 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coras371ca502018-02-21 12:07:41 -0800220 return rv;
221 }
Florin Coras371ca502018-02-21 12:07:41 -0800222 ctx->app_session_handle = session_handle (app_session);
Florin Corasdf57ea02019-02-18 20:14:20 -0800223 ctx->parent_app_wrk_index = app_session->app_wrk_index;
Florin Corasa27a46e2019-02-18 13:02:28 -0800224 app_wrk = app_worker_get (app_session->app_wrk_index);
225 return app_worker_accept_notify (app_wrk, app_session);
Florin Coras371ca502018-02-21 12:07:41 -0800226}
227
Florin Coras58d36f02018-03-09 13:05:53 -0800228int
Florin Coras00e01d32019-10-21 16:07:46 -0700229tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
Florin Coras371ca502018-02-21 12:07:41 -0800230{
Florin Coras179711d2022-04-10 13:34:47 -0700231 u32 parent_app_api_ctx;
Florin Coras288eaab2019-02-03 15:26:14 -0800232 session_t *app_session;
Florin Coras15531972018-08-12 23:50:53 -0700233 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800234
Florin Corasdf57ea02019-02-18 20:14:20 -0800235 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
Florin Corasef915342018-09-29 10:23:06 -0700236 if (!app_wrk)
237 {
Florin Coras179711d2022-04-10 13:34:47 -0700238 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
239 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
Florin Coras4a98b932024-01-31 13:45:39 -0800240 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasef915342018-09-29 10:23:06 -0700241 return -1;
242 }
243
Florin Coras00e01d32019-10-21 16:07:46 -0700244 if (err)
Florin Coras4b47ee22020-11-19 13:38:26 -0800245 {
246 /* Free app session pre-allocated when transport was established */
247 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
248 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
Florin Coras4a98b932024-01-31 13:45:39 -0800249 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corase3c6a542021-05-19 19:28:40 -0700250 goto send_reply;
Florin Coras4b47ee22020-11-19 13:38:26 -0800251 }
Florin Coras8f89dd02018-03-05 16:53:07 -0800252
Florin Coras4b47ee22020-11-19 13:38:26 -0800253 /* For DTLS the app session is not preallocated because the underlying udp
254 * session might migrate to a different worker during the handshake */
255 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
256 {
257 session_type_t st;
Florin Corasbab6c522021-05-13 08:36:56 -0700258 /* Cleanup half-open session as we don't get notification from udp */
259 session_half_open_delete_notify (&ctx->connection);
Florin Coras4b47ee22020-11-19 13:38:26 -0800260 app_session = session_alloc (ctx->c_thread_index);
261 app_session->session_state = SESSION_STATE_CREATED;
262 ctx->c_s_index = app_session->session_index;
263 st =
264 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
265 app_session->session_type = st;
266 app_session->connection_index = ctx->tls_ctx_handle;
267 }
268 else
269 {
270 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
271 }
272
Florin Corasdf57ea02019-02-18 20:14:20 -0800273 app_session->app_wrk_index = ctx->parent_app_wrk_index;
Florin Coras2ceb8182023-08-31 17:33:47 -0700274 app_session->opaque = ctx->parent_app_api_context;
Florin Coras15531972018-08-12 23:50:53 -0700275
Florin Coras00e01d32019-10-21 16:07:46 -0700276 if ((err = app_worker_init_connected (app_wrk, app_session)))
Florin Corasa3d55df2023-10-06 19:06:35 -0700277 {
278 app_worker_connect_notify (app_wrk, 0, err, ctx->parent_app_api_context);
Florin Coras4a98b932024-01-31 13:45:39 -0800279 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasa3d55df2023-10-06 19:06:35 -0700280 session_free (app_session);
281 return -1;
282 }
Florin Coras371ca502018-02-21 12:07:41 -0800283
jiangxiaoming5b7ea912020-09-23 10:29:21 +0800284 app_session->session_state = SESSION_STATE_READY;
Florin Coras179711d2022-04-10 13:34:47 -0700285 parent_app_api_ctx = ctx->parent_app_api_context;
286 ctx->app_session_handle = session_handle (app_session);
287
288 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
289 parent_app_api_ctx))
Florin Coras371ca502018-02-21 12:07:41 -0800290 {
291 TLS_DBG (1, "failed to notify app");
Florin Coras6e7ebb02022-05-04 12:02:56 -0700292 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
Florin Coras4a98b932024-01-31 13:45:39 -0800293 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coraseb97e5f2018-10-15 21:35:42 -0700294 return -1;
Florin Coras371ca502018-02-21 12:07:41 -0800295 }
296
297 return 0;
298
Florin Corase3c6a542021-05-19 19:28:40 -0700299send_reply:
Florin Coras00e01d32019-10-21 16:07:46 -0700300 return app_worker_connect_notify (app_wrk, 0, err,
301 ctx->parent_app_api_context);
Florin Coras371ca502018-02-21 12:07:41 -0800302}
303
Florin Coras58d36f02018-03-09 13:05:53 -0800304static inline void
305tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
Florin Corasd77eee62018-03-07 08:49:27 -0800306{
Florin Coras58d36f02018-03-09 13:05:53 -0800307 *ctx_index = ctx_handle & TLS_IDX_MASK;
308 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
309}
310
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200311static inline crypto_engine_type_t
Florin Corasa54b62d2021-04-21 09:05:56 -0700312tls_get_engine_type (crypto_engine_type_t requested,
313 crypto_engine_type_t preferred)
Florin Coras58d36f02018-03-09 13:05:53 -0800314{
Florin Corasa54b62d2021-04-21 09:05:56 -0700315 if (requested != CRYPTO_ENGINE_NONE)
316 {
317 if (tls_vfts[requested].ctx_alloc)
318 return requested;
319 return CRYPTO_ENGINE_NONE;
320 }
Florin Coras58d36f02018-03-09 13:05:53 -0800321 if (!tls_vfts[preferred].ctx_alloc)
322 return tls_get_available_engine ();
323 return preferred;
324}
325
326static inline u32
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200327tls_ctx_alloc (crypto_engine_type_t engine_type)
Florin Coras58d36f02018-03-09 13:05:53 -0800328{
329 u32 ctx_index;
330 ctx_index = tls_vfts[engine_type].ctx_alloc ();
331 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
Florin Corasd77eee62018-03-07 08:49:27 -0800332}
333
Florin Coras4b47ee22020-11-19 13:38:26 -0800334static inline u32
335tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
336{
337 u32 ctx_index;
338 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
339 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
340}
341
342static inline u32
343tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
344{
345 u32 ctx_index;
346 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
347 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
348}
349
350static inline void *
351tls_ctx_detach (tls_ctx_t *ctx)
352{
353 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
354}
355
Florin Corasd77eee62018-03-07 08:49:27 -0800356static inline tls_ctx_t *
Florin Coras58d36f02018-03-09 13:05:53 -0800357tls_ctx_get (u32 ctx_handle)
Florin Corasd77eee62018-03-07 08:49:27 -0800358{
Florin Coras58d36f02018-03-09 13:05:53 -0800359 u32 ctx_index, engine_type;
360 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
361 return tls_vfts[engine_type].ctx_get (ctx_index);
Florin Corasd77eee62018-03-07 08:49:27 -0800362}
363
364static inline tls_ctx_t *
Florin Coras58d36f02018-03-09 13:05:53 -0800365tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
Florin Corasd77eee62018-03-07 08:49:27 -0800366{
Florin Coras58d36f02018-03-09 13:05:53 -0800367 u32 ctx_index, engine_type;
368 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
369 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
Florin Corasd77eee62018-03-07 08:49:27 -0800370}
371
372static inline int
373tls_ctx_init_server (tls_ctx_t * ctx)
374{
Florin Coras58d36f02018-03-09 13:05:53 -0800375 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
Florin Corasd77eee62018-03-07 08:49:27 -0800376}
377
378static inline int
379tls_ctx_init_client (tls_ctx_t * ctx)
380{
Florin Coras58d36f02018-03-09 13:05:53 -0800381 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
Florin Corasd77eee62018-03-07 08:49:27 -0800382}
383
384static inline int
Florin Coras9f86d222020-03-23 15:34:22 +0000385tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
386 transport_send_params_t * sp)
Florin Corasd77eee62018-03-07 08:49:27 -0800387{
Florin Coras9f86d222020-03-23 15:34:22 +0000388 u32 n_wrote;
Florin Corased8db522020-02-27 04:32:51 +0000389
Florin Coras9f86d222020-03-23 15:34:22 +0000390 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
391 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
Florin Coras3e157102022-02-04 13:31:25 -0800392 sp->bytes_dequeued = n_wrote;
Florin Corased8db522020-02-27 04:32:51 +0000393 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
Florin Corasd77eee62018-03-07 08:49:27 -0800394}
395
396static inline int
Florin Coras288eaab2019-02-03 15:26:14 -0800397tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
Florin Corasd77eee62018-03-07 08:49:27 -0800398{
Florin Coras58d36f02018-03-09 13:05:53 -0800399 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
Florin Corasd77eee62018-03-07 08:49:27 -0800400}
401
Florin Coras06a6a302019-04-17 14:19:12 -0700402static inline int
403tls_ctx_transport_close (tls_ctx_t * ctx)
404{
405 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
406}
407
408static inline int
Florin Corasea158d62024-02-26 18:11:43 -0800409tls_ctx_transport_reset (tls_ctx_t *ctx)
410{
411 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_reset (ctx);
412}
413
414static inline int
Florin Coras06a6a302019-04-17 14:19:12 -0700415tls_ctx_app_close (tls_ctx_t * ctx)
416{
417 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
418}
419
420void
421tls_ctx_free (tls_ctx_t * ctx)
422{
Florin Coras06a6a302019-04-17 14:19:12 -0700423 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
424}
425
426u8
Florin Corasd77eee62018-03-07 08:49:27 -0800427tls_ctx_handshake_is_over (tls_ctx_t * ctx)
428{
Florin Coras58d36f02018-03-09 13:05:53 -0800429 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800430}
431
Saravanan Murugesand918cc52022-02-28 19:54:11 +0530432int
433tls_reinit_ca_chain (crypto_engine_type_t tls_engine_id)
434{
435 return tls_vfts[tls_engine_id].ctx_reinit_cachain ();
436}
437
Florin Coras371ca502018-02-21 12:07:41 -0800438void
Florin Coras8c5e5f62022-02-24 16:35:26 -0800439tls_notify_app_io_error (tls_ctx_t *ctx)
440{
441 ASSERT (tls_ctx_handshake_is_over (ctx));
442
443 session_transport_reset_notify (&ctx->connection);
444 session_transport_closed_notify (&ctx->connection);
445 tls_disconnect_transport (ctx);
446}
447
448void
Florin Corasea158d62024-02-26 18:11:43 -0800449tls_session_reset_callback (session_t *ts)
Florin Coras371ca502018-02-21 12:07:41 -0800450{
Florin Corasf03c4942019-08-07 21:39:27 -0700451 tls_ctx_t *ctx;
452
Florin Corasea158d62024-02-26 18:11:43 -0800453 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
Florin Coras4a98b932024-01-31 13:45:39 -0800454 ctx->flags |= TLS_CONN_F_PASSIVE_CLOSE;
Florin Corasea158d62024-02-26 18:11:43 -0800455 tls_ctx_transport_reset (ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800456}
457
Florin Coras2c876f92021-05-10 21:12:27 -0700458static void
459tls_session_cleanup_ho (session_t *s)
460{
Florin Coras2c876f92021-05-10 21:12:27 -0700461 /* session opaque stores the opaque passed on connect */
Florin Corasa474bc82023-12-04 20:29:52 -0800462 tls_ctx_ho_try_free (s->opaque);
Florin Coras2c876f92021-05-10 21:12:27 -0700463}
464
Florin Coras371ca502018-02-21 12:07:41 -0800465int
Florin Corasfa76a762018-11-29 12:40:10 -0800466tls_add_segment_callback (u32 client_index, u64 segment_handle)
Florin Coras371ca502018-02-21 12:07:41 -0800467{
468 /* No-op for builtin */
469 return 0;
470}
471
472int
Florin Corasfa76a762018-11-29 12:40:10 -0800473tls_del_segment_callback (u32 client_index, u64 segment_handle)
Florin Coras371ca502018-02-21 12:07:41 -0800474{
475 return 0;
476}
477
478void
Florin Coras288eaab2019-02-03 15:26:14 -0800479tls_session_disconnect_callback (session_t * tls_session)
Florin Coras371ca502018-02-21 12:07:41 -0800480{
Florin Coras371ca502018-02-21 12:07:41 -0800481 tls_ctx_t *ctx;
Florin Corasbf7ce2c2019-03-06 14:44:42 -0800482
483 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
484 tls_session->session_index);
Florin Coras371ca502018-02-21 12:07:41 -0800485
Florin Coras6faac162019-10-11 08:00:43 -0700486 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
487 || vlib_thread_is_main_w_barrier ());
488
489 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
Florin Coras4a98b932024-01-31 13:45:39 -0800490 ctx->flags |= TLS_CONN_F_PASSIVE_CLOSE;
Florin Coras06a6a302019-04-17 14:19:12 -0700491 tls_ctx_transport_close (ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800492}
493
494int
Florin Coras288eaab2019-02-03 15:26:14 -0800495tls_session_accept_callback (session_t * tls_session)
Florin Coras371ca502018-02-21 12:07:41 -0800496{
Florin Coras288eaab2019-02-03 15:26:14 -0800497 session_t *tls_listener, *app_session;
Florin Coras371ca502018-02-21 12:07:41 -0800498 tls_ctx_t *lctx, *ctx;
Florin Coras58d36f02018-03-09 13:05:53 -0800499 u32 ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800500
Nathan Skrzypczak2f0f96b2019-06-13 10:14:28 +0200501 tls_listener =
502 listen_session_get_from_handle (tls_session->listener_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800503 lctx = tls_listener_ctx_get (tls_listener->opaque);
Florin Coras58d36f02018-03-09 13:05:53 -0800504
505 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
506 ctx = tls_ctx_get (ctx_handle);
Florin Coras60732df2024-02-23 18:01:45 -0800507 clib_memcpy (ctx, lctx, sizeof (*lctx));
Florin Coras371ca502018-02-21 12:07:41 -0800508 ctx->c_thread_index = vlib_get_thread_index ();
Florin Coras58d36f02018-03-09 13:05:53 -0800509 ctx->tls_ctx_handle = ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800510 tls_session->session_state = SESSION_STATE_READY;
Florin Coras58d36f02018-03-09 13:05:53 -0800511 tls_session->opaque = ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800512 ctx->tls_session_handle = session_handle (tls_session);
513 ctx->listener_ctx_index = tls_listener->opaque;
Florin Corasd09236d2019-08-08 17:38:26 -0700514 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200515 ctx->ckpair_index = lctx->ckpair_index;
Florin Coras371ca502018-02-21 12:07:41 -0800516
Florin Coras58a93e82019-01-14 23:33:46 -0800517 /* Preallocate app session. Avoids allocating a session post handshake
518 * on tls_session rx and potentially invalidating the session pool */
519 app_session = session_alloc (ctx->c_thread_index);
Srikanth Akulae140d5d2019-11-18 11:49:58 -0800520 app_session->session_state = SESSION_STATE_CREATED;
Florin Corasa127d3c2023-09-25 19:50:48 -0700521 app_session->session_type =
522 session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
523 app_session->connection_index = ctx->tls_ctx_handle;
Florin Coras60732df2024-02-23 18:01:45 -0800524 app_session->app_wrk_index = APP_INVALID_INDEX;
Florin Coras58a93e82019-01-14 23:33:46 -0800525 ctx->c_s_index = app_session->session_index;
526
Florin Coras58d36f02018-03-09 13:05:53 -0800527 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
528 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800529
Florin Coras14bfd3d2023-11-08 19:57:38 -0800530 if (tls_ctx_init_server (ctx))
Xiaoming Jiang47781642023-05-26 00:32:25 +0000531 {
Florin Coras14bfd3d2023-11-08 19:57:38 -0800532 /* Do not free ctx yet, in case we have pending rx events */
Xiaoming Jiang47781642023-05-26 00:32:25 +0000533 session_free (app_session);
Florin Coras4a98b932024-01-31 13:45:39 -0800534 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coras14bfd3d2023-11-08 19:57:38 -0800535 tls_disconnect_transport (ctx);
Xiaoming Jiang47781642023-05-26 00:32:25 +0000536 }
537
Florin Coras14bfd3d2023-11-08 19:57:38 -0800538 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800539}
540
541int
Florin Corascfc2a0e2023-11-08 14:14:17 -0800542tls_app_rx_callback (session_t *ts)
Florin Coras371ca502018-02-21 12:07:41 -0800543{
Florin Coras371ca502018-02-21 12:07:41 -0800544 tls_ctx_t *ctx;
Florin Coras371ca502018-02-21 12:07:41 -0800545
Florin Coras4b47ee22020-11-19 13:38:26 -0800546 /* DTLS session migrating, wait for next notification */
Florin Corascfc2a0e2023-11-08 14:14:17 -0800547 if (PREDICT_FALSE (ts->flags & SESSION_F_IS_MIGRATING))
Florin Coras4b47ee22020-11-19 13:38:26 -0800548 return 0;
549
Florin Corascfc2a0e2023-11-08 14:14:17 -0800550 /* Read rescheduled but underlying transport deleted now */
551 if (PREDICT_FALSE ((ts->session_state == SESSION_STATE_TRANSPORT_DELETED)))
552 return 0;
553
554 ctx = tls_ctx_get (ts->opaque);
Florin Coras4a98b932024-01-31 13:45:39 -0800555 if (PREDICT_FALSE ((ctx->flags & TLS_CONN_F_NO_APP_SESSION) ||
556 (ctx->flags & TLS_CONN_F_APP_CLOSED)))
Saravanan Murugesan3683d1b2022-02-28 10:55:26 +0530557 {
558 TLS_DBG (1, "Local App closed");
559 return 0;
560 }
Florin Corascfc2a0e2023-11-08 14:14:17 -0800561 tls_ctx_read (ctx, ts);
Florin Coras58d36f02018-03-09 13:05:53 -0800562 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800563}
564
565int
Florin Coras9f86d222020-03-23 15:34:22 +0000566tls_app_tx_callback (session_t * tls_session)
567{
568 tls_ctx_t *ctx;
569
570 ctx = tls_ctx_get (tls_session->opaque);
571 transport_connection_reschedule (&ctx->connection);
572
573 return 0;
574}
575
576int
Florin Coras4b47ee22020-11-19 13:38:26 -0800577tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
578 session_t *tls_session, session_error_t err)
Florin Coras371ca502018-02-21 12:07:41 -0800579{
Florin Coras288eaab2019-02-03 15:26:14 -0800580 session_t *app_session;
Florin Coras371ca502018-02-21 12:07:41 -0800581 tls_ctx_t *ho_ctx, *ctx;
Florin Coras4b47ee22020-11-19 13:38:26 -0800582 session_type_t st;
Florin Coras58d36f02018-03-09 13:05:53 -0800583 u32 ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800584
585 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
Florin Coras371ca502018-02-21 12:07:41 -0800586
Florin Coras58d36f02018-03-09 13:05:53 -0800587 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
588 ctx = tls_ctx_get (ctx_handle);
Dave Barach178cf492018-11-13 16:34:13 -0500589 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
Florin Coras0ded4892024-02-13 15:37:20 -0500590
Florin Coras2c876f92021-05-10 21:12:27 -0700591 /* Half-open freed on tcp half-open cleanup notification */
Florin Coras0ded4892024-02-13 15:37:20 -0500592 __atomic_fetch_or (&ho_ctx->flags, TLS_CONN_F_HO_DONE, __ATOMIC_RELEASE);
Florin Coras371ca502018-02-21 12:07:41 -0800593
Florin Corasdcde9272018-03-02 09:23:42 -0800594 ctx->c_thread_index = vlib_get_thread_index ();
Florin Coras58d36f02018-03-09 13:05:53 -0800595 ctx->tls_ctx_handle = ctx_handle;
Florin Corasd09236d2019-08-08 17:38:26 -0700596 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasdcde9272018-03-02 09:23:42 -0800597
Florin Coras58d36f02018-03-09 13:05:53 -0800598 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
Florin Coras4b47ee22020-11-19 13:38:26 -0800599 ho_ctx_index, err, vlib_get_thread_index (),
Florin Coras58d36f02018-03-09 13:05:53 -0800600 (ctx) ? ctx_handle : ~0);
Florin Coras371ca502018-02-21 12:07:41 -0800601
602 ctx->tls_session_handle = session_handle (tls_session);
Florin Coras58d36f02018-03-09 13:05:53 -0800603 tls_session->opaque = ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800604 tls_session->session_state = SESSION_STATE_READY;
605
Florin Coras58a93e82019-01-14 23:33:46 -0800606 /* Preallocate app session. Avoids allocating a session post handshake
607 * on tls_session rx and potentially invalidating the session pool */
608 app_session = session_alloc (ctx->c_thread_index);
Srikanth Akulae140d5d2019-11-18 11:49:58 -0800609 app_session->session_state = SESSION_STATE_CREATED;
Florin Coras58a93e82019-01-14 23:33:46 -0800610 ctx->c_s_index = app_session->session_index;
Florin Coras4b47ee22020-11-19 13:38:26 -0800611 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
612 app_session->session_type = st;
613 app_session->connection_index = ctx->tls_ctx_handle;
Florin Coras58a93e82019-01-14 23:33:46 -0800614
Florin Coras14bfd3d2023-11-08 19:57:38 -0800615 if (tls_ctx_init_client (ctx))
Xiaoming Jiang47781642023-05-26 00:32:25 +0000616 {
Florin Coras14bfd3d2023-11-08 19:57:38 -0800617 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
618 tls_disconnect_transport (ctx);
Xiaoming Jiang47781642023-05-26 00:32:25 +0000619 }
620
Florin Coras14bfd3d2023-11-08 19:57:38 -0800621 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800622}
623
Florin Coras4b47ee22020-11-19 13:38:26 -0800624int
625dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
626 session_error_t err)
627{
628 tls_ctx_t *ctx;
629
Florin Corasfb50bc32021-05-18 00:28:59 -0700630 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
Florin Coras4b47ee22020-11-19 13:38:26 -0800631
632 ctx->tls_session_handle = session_handle (us);
633 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
634 us->opaque = ctx_handle;
635
636 /* We don't preallocate the app session because the udp session might
637 * actually migrate to a different worker at the end of the handshake */
638
639 return tls_ctx_init_client (ctx);
640}
641
642int
643tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
644 session_t *tls_session, session_error_t err)
645{
Florin Coras71ee3752021-05-28 18:29:08 -0700646 if (err)
647 {
648 app_worker_t *app_wrk;
649 tls_ctx_t *ho_ctx;
650 u32 api_context;
651
652 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
Florin Corasa474bc82023-12-04 20:29:52 -0800653 ho_ctx->flags |= TLS_CONN_F_HO_DONE;
Florin Coras71ee3752021-05-28 18:29:08 -0700654 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
655 if (app_wrk)
656 {
657 api_context = ho_ctx->parent_app_api_context;
658 app_worker_connect_notify (app_wrk, 0, err, api_context);
659 }
Florin Coras71ee3752021-05-28 18:29:08 -0700660
661 return 0;
662 }
663
Florin Coras4b47ee22020-11-19 13:38:26 -0800664 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
665 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
666 err);
667 else
668 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
669 err);
670}
671
Florin Corasef2b3352019-08-07 11:14:56 -0700672static void
673tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
674{
675 tls_ctx_t *ctx;
676
677 if (ntf == SESSION_CLEANUP_TRANSPORT)
Florin Coras36d49392020-04-24 23:00:11 +0000678 {
679 /* Allow cleanup of tcp session */
680 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
681 session_close (s);
682 return;
683 }
Florin Corasef2b3352019-08-07 11:14:56 -0700684
685 ctx = tls_ctx_get (s->opaque);
Florin Coras4a98b932024-01-31 13:45:39 -0800686 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
Florin Corasef2b3352019-08-07 11:14:56 -0700687 session_transport_delete_notify (&ctx->connection);
688 tls_ctx_free (ctx);
689}
690
Florin Coras4b47ee22020-11-19 13:38:26 -0800691static void
Florin Coras88dd3cf2021-05-01 19:01:42 -0700692dtls_migrate_ctx (void *arg)
Florin Coras4b47ee22020-11-19 13:38:26 -0800693{
694 tls_ctx_t *ctx = (tls_ctx_t *) arg;
695 u32 ctx_handle, thread_index;
696 session_t *us;
697
698 thread_index = session_thread_from_handle (ctx->tls_session_handle);
699 ASSERT (thread_index == vlib_get_thread_index ());
700
701 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
702 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
703 ctx->tls_ctx_handle = ctx_handle;
704
705 us = session_get_from_handle (ctx->tls_session_handle);
706 us->opaque = ctx_handle;
707 us->flags &= ~SESSION_F_IS_MIGRATING;
Florin Corasbab6c522021-05-13 08:36:56 -0700708
709 /* Probably the app detached while the session was migrating. Cleanup */
710 if (session_half_open_migrated_notify (&ctx->connection))
711 {
Florin Coras4a98b932024-01-31 13:45:39 -0800712 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasbab6c522021-05-13 08:36:56 -0700713 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
714 return;
715 }
716
Florin Coras4b47ee22020-11-19 13:38:26 -0800717 if (svm_fifo_max_dequeue (us->tx_fifo))
718 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
719}
720
721static void
722dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
723{
724 u32 new_thread = session_thread_from_handle (new_sh);
Florin Coras88dd3cf2021-05-01 19:01:42 -0700725 tls_ctx_t *ctx, *cloned_ctx;
Florin Coras4b47ee22020-11-19 13:38:26 -0800726
727 /* Migrate dtls context to new thread */
728 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
729 ctx->tls_session_handle = new_sh;
Florin Coras88dd3cf2021-05-01 19:01:42 -0700730 cloned_ctx = tls_ctx_detach (ctx);
Florin Coras4a98b932024-01-31 13:45:39 -0800731 ctx->flags |= TLS_CONN_F_MIGRATED;
Florin Corasbab6c522021-05-13 08:36:56 -0700732 session_half_open_migrate_notify (&ctx->connection);
Florin Coras4b47ee22020-11-19 13:38:26 -0800733
Florin Coras88dd3cf2021-05-01 19:01:42 -0700734 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
735 (void *) cloned_ctx);
736
737 tls_ctx_free (ctx);
Florin Coras4b47ee22020-11-19 13:38:26 -0800738}
739
Florin Corascfc2a0e2023-11-08 14:14:17 -0800740static void
741tls_session_transport_closed_callback (session_t *ts)
742{
743 tls_ctx_t *ctx;
744
745 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
Florin Coras4a98b932024-01-31 13:45:39 -0800746 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
Florin Coras86b02c72023-12-13 14:26:19 -0800747 session_transport_closed_notify (&ctx->connection);
Florin Corascfc2a0e2023-11-08 14:14:17 -0800748}
749
Florin Coras371ca502018-02-21 12:07:41 -0800750static session_cb_vft_t tls_app_cb_vft = {
751 .session_accept_callback = tls_session_accept_callback,
752 .session_disconnect_callback = tls_session_disconnect_callback,
753 .session_connected_callback = tls_session_connected_callback,
754 .session_reset_callback = tls_session_reset_callback,
Florin Corascfc2a0e2023-11-08 14:14:17 -0800755 .session_transport_closed_callback = tls_session_transport_closed_callback,
Florin Coras2c876f92021-05-10 21:12:27 -0700756 .half_open_cleanup_callback = tls_session_cleanup_ho,
Florin Coras371ca502018-02-21 12:07:41 -0800757 .add_segment_callback = tls_add_segment_callback,
758 .del_segment_callback = tls_del_segment_callback,
759 .builtin_app_rx_callback = tls_app_rx_callback,
Florin Coras9f86d222020-03-23 15:34:22 +0000760 .builtin_app_tx_callback = tls_app_tx_callback,
Florin Coras4b47ee22020-11-19 13:38:26 -0800761 .session_migrate_callback = dtls_session_migrate_callback,
Florin Corasef2b3352019-08-07 11:14:56 -0700762 .session_cleanup_callback = tls_app_session_cleanup,
Florin Coras371ca502018-02-21 12:07:41 -0800763};
Florin Coras371ca502018-02-21 12:07:41 -0800764
765int
Florin Coras5665ced2018-10-25 18:03:45 -0700766tls_connect (transport_endpoint_cfg_t * tep)
Florin Coras371ca502018-02-21 12:07:41 -0800767{
Florin Coras15531972018-08-12 23:50:53 -0700768 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
Florin Corasa54b62d2021-04-21 09:05:56 -0700769 transport_endpt_crypto_cfg_t *ccfg;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200770 crypto_engine_type_t engine_type;
Florin Coras4b47ee22020-11-19 13:38:26 -0800771 session_endpoint_cfg_t *sep;
Florin Coras371ca502018-02-21 12:07:41 -0800772 tls_main_t *tm = &tls_main;
Florin Coras15531972018-08-12 23:50:53 -0700773 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800774 application_t *app;
775 tls_ctx_t *ctx;
776 u32 ctx_index;
Florin Corasc1a42652019-02-08 18:27:29 -0800777 int rv;
Florin Coras371ca502018-02-21 12:07:41 -0800778
Florin Coras5665ced2018-10-25 18:03:45 -0700779 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -0700780 if (!sep->ext_cfg)
Florin Corase5f18332021-04-22 11:48:35 -0700781 return SESSION_E_NOEXTCFG;
Florin Corasa54b62d2021-04-21 09:05:56 -0700782
Florin Coras15531972018-08-12 23:50:53 -0700783 app_wrk = app_worker_get (sep->app_wrk_index);
784 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -0700785
786 ccfg = &sep->ext_cfg->crypto;
787 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200788 if (engine_type == CRYPTO_ENGINE_NONE)
Florin Coras58d36f02018-03-09 13:05:53 -0800789 {
790 clib_warning ("No tls engine_type available");
Florin Corase5f18332021-04-22 11:48:35 -0700791 return SESSION_E_NOCRYPTOENG;
Florin Coras58d36f02018-03-09 13:05:53 -0800792 }
Florin Coras371ca502018-02-21 12:07:41 -0800793
794 ctx_index = tls_ctx_half_open_alloc ();
795 ctx = tls_ctx_half_open_get (ctx_index);
Florin Corasdf57ea02019-02-18 20:14:20 -0800796 ctx->parent_app_wrk_index = sep->app_wrk_index;
Florin Coras371ca502018-02-21 12:07:41 -0800797 ctx->parent_app_api_context = sep->opaque;
798 ctx->tcp_is_ip4 = sep->is_ip4;
Florin Coras4b47ee22020-11-19 13:38:26 -0800799 ctx->tls_type = sep->transport_proto;
Florin Corasa54b62d2021-04-21 09:05:56 -0700800 ctx->ckpair_index = ccfg->ckpair_index;
Florin Coras2c876f92021-05-10 21:12:27 -0700801 ctx->c_proto = TRANSPORT_PROTO_TLS;
802 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasa54b62d2021-04-21 09:05:56 -0700803 if (ccfg->hostname[0])
Florin Coras8f89dd02018-03-05 16:53:07 -0800804 {
Florin Corasa54b62d2021-04-21 09:05:56 -0700805 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
Florin Coras8f89dd02018-03-05 16:53:07 -0800806 vec_terminate_c_string (ctx->srv_hostname);
807 }
Florin Coras371ca502018-02-21 12:07:41 -0800808
Florin Coras58d36f02018-03-09 13:05:53 -0800809 ctx->tls_ctx_engine = engine_type;
Florin Coras371ca502018-02-21 12:07:41 -0800810
Dave Barach178cf492018-11-13 16:34:13 -0500811 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
Florin Coras15531972018-08-12 23:50:53 -0700812 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
813 cargs->app_index = tm->app_index;
814 cargs->api_context = ctx_index;
Florin Coras8a140612019-02-18 22:39:39 -0800815 cargs->sep_ext.ns_index = app->ns_index;
Florin Corasc1a42652019-02-08 18:27:29 -0800816 if ((rv = vnet_connect (cargs)))
Florin Coras3109d1c2024-01-22 18:27:43 -0800817 {
818 tls_ctx_half_open_free (ctx_index);
819 return rv;
820 }
Florin Coras371ca502018-02-21 12:07:41 -0800821
Florin Coras2c876f92021-05-10 21:12:27 -0700822 /* Track half-open tcp session in case we need to clean it up */
823 ctx->tls_session_handle = cargs->sh;
824
Florin Coras58d36f02018-03-09 13:05:53 -0800825 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
Florin Coras2c876f92021-05-10 21:12:27 -0700826 return ctx_index;
Florin Coras371ca502018-02-21 12:07:41 -0800827}
828
829void
Florin Coras58d36f02018-03-09 13:05:53 -0800830tls_disconnect (u32 ctx_handle, u32 thread_index)
Florin Coras371ca502018-02-21 12:07:41 -0800831{
Florin Coras371ca502018-02-21 12:07:41 -0800832 tls_ctx_t *ctx;
833
Florin Coras58d36f02018-03-09 13:05:53 -0800834 TLS_DBG (1, "Disconnecting %x", ctx_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800835
Florin Coras58d36f02018-03-09 13:05:53 -0800836 ctx = tls_ctx_get (ctx_handle);
Florin Corasd7f17a22024-01-31 16:18:17 -0800837 ctx->flags |= TLS_CONN_F_APP_CLOSED;
Florin Coras06a6a302019-04-17 14:19:12 -0700838 tls_ctx_app_close (ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800839}
840
841u32
Florin Coras0bce71e2022-02-10 11:57:06 -0800842tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
Florin Coras371ca502018-02-21 12:07:41 -0800843{
Florin Corasc9940fc2019-02-05 20:55:11 -0800844 vnet_listen_args_t _bargs, *args = &_bargs;
Florin Corasa54b62d2021-04-21 09:05:56 -0700845 transport_endpt_crypto_cfg_t *ccfg;
Florin Corasab2f6db2018-08-31 14:31:41 -0700846 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800847 tls_main_t *tm = &tls_main;
Florin Corasa27a46e2019-02-18 13:02:28 -0800848 session_handle_t tls_al_handle;
Florin Coras5665ced2018-10-25 18:03:45 -0700849 session_endpoint_cfg_t *sep;
Florin Coras288eaab2019-02-03 15:26:14 -0800850 session_t *tls_listener;
851 session_t *app_listener;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200852 crypto_engine_type_t engine_type;
Florin Coras74cac882018-09-07 09:13:15 -0700853 application_t *app;
Florin Corasa27a46e2019-02-18 13:02:28 -0800854 app_listener_t *al;
Florin Coras15531972018-08-12 23:50:53 -0700855 tls_ctx_t *lctx;
856 u32 lctx_index;
Florin Corase5f18332021-04-22 11:48:35 -0700857 int rv;
Florin Coras371ca502018-02-21 12:07:41 -0800858
Florin Coras5665ced2018-10-25 18:03:45 -0700859 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -0700860 if (!sep->ext_cfg)
Florin Corase5f18332021-04-22 11:48:35 -0700861 return SESSION_E_NOEXTCFG;
Florin Corasa54b62d2021-04-21 09:05:56 -0700862
Florin Coras15531972018-08-12 23:50:53 -0700863 app_wrk = app_worker_get (sep->app_wrk_index);
864 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -0700865
866 ccfg = &sep->ext_cfg->crypto;
867 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200868 if (engine_type == CRYPTO_ENGINE_NONE)
Florin Coras58d36f02018-03-09 13:05:53 -0800869 {
870 clib_warning ("No tls engine_type available");
Florin Corase5f18332021-04-22 11:48:35 -0700871 return SESSION_E_NOCRYPTOENG;
Florin Coras58d36f02018-03-09 13:05:53 -0800872 }
873
Dave Barachb7b92992018-10-17 10:38:51 -0400874 clib_memset (args, 0, sizeof (*args));
Florin Coras74cac882018-09-07 09:13:15 -0700875 args->app_index = tm->app_index;
876 args->sep_ext = *sep;
Florin Coras8a140612019-02-18 22:39:39 -0800877 args->sep_ext.ns_index = app->ns_index;
Florin Coras95cd8642019-12-30 21:53:19 -0800878 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
Florin Coras4b47ee22020-11-19 13:38:26 -0800879 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
880 {
881 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
882 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
883 }
Florin Corase5f18332021-04-22 11:48:35 -0700884 if ((rv = vnet_listen (args)))
885 return rv;
Florin Coras371ca502018-02-21 12:07:41 -0800886
Florin Coras74cac882018-09-07 09:13:15 -0700887 lctx_index = tls_listener_ctx_alloc ();
Florin Corasa27a46e2019-02-18 13:02:28 -0800888 tls_al_handle = args->handle;
889 al = app_listener_get_w_handle (tls_al_handle);
890 tls_listener = app_listener_get_session (al);
Florin Coras371ca502018-02-21 12:07:41 -0800891 tls_listener->opaque = lctx_index;
Florin Coras58d36f02018-03-09 13:05:53 -0800892
Florin Coras5c9083d2018-04-13 06:39:07 -0700893 app_listener = listen_session_get (app_listener_index);
Florin Coras58d36f02018-03-09 13:05:53 -0800894
895 lctx = tls_listener_ctx_get (lctx_index);
Florin Corasdf57ea02019-02-18 20:14:20 -0800896 lctx->parent_app_wrk_index = sep->app_wrk_index;
Florin Corasa27a46e2019-02-18 13:02:28 -0800897 lctx->tls_session_handle = tls_al_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800898 lctx->app_session_handle = listen_session_get_handle (app_listener);
899 lctx->tcp_is_ip4 = sep->is_ip4;
Florin Coras58d36f02018-03-09 13:05:53 -0800900 lctx->tls_ctx_engine = engine_type;
Florin Coras4b47ee22020-11-19 13:38:26 -0800901 lctx->tls_type = sep->transport_proto;
Florin Corasa54b62d2021-04-21 09:05:56 -0700902 lctx->ckpair_index = ccfg->ckpair_index;
Florin Coras7705b492022-02-16 17:12:01 -0800903 lctx->c_s_index = app_listener_index;
Filip Tehlar61e26be2021-12-20 14:40:59 +0000904 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Coras58d36f02018-03-09 13:05:53 -0800905
Florin Corasae3eaac2019-07-23 22:38:16 -0700906 if (tls_vfts[engine_type].ctx_start_listen (lctx))
907 {
908 vnet_unlisten_args_t a = {
909 .handle = lctx->tls_session_handle,
910 .app_index = tls_main.app_index,
911 .wrk_map_index = 0
912 };
913 if ((vnet_unlisten (&a)))
914 clib_warning ("unlisten returned");
915 tls_listener_ctx_free (lctx);
916 lctx_index = SESSION_INVALID_INDEX;
917 }
Ping Yudecda5b2018-08-13 06:20:00 -0400918
Florin Coras58d36f02018-03-09 13:05:53 -0800919 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
920 engine_type);
Florin Coras371ca502018-02-21 12:07:41 -0800921 return lctx_index;
922}
923
924u32
Florin Corase3e2f072018-03-04 07:24:30 -0800925tls_stop_listen (u32 lctx_index)
Florin Coras371ca502018-02-21 12:07:41 -0800926{
Florin Corasaab06042020-02-26 02:56:14 +0000927 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200928 crypto_engine_type_t engine_type;
Florin Corasaab06042020-02-26 02:56:14 +0000929 transport_connection_t *lc;
Florin Corasb5e94e32018-09-14 14:46:39 -0700930 tls_ctx_t *lctx;
Florin Corasaab06042020-02-26 02:56:14 +0000931 session_t *ls;
Florin Corasc1a42652019-02-08 18:27:29 -0800932 int rv;
Ping Yudecda5b2018-08-13 06:20:00 -0400933
Florin Corase3e2f072018-03-04 07:24:30 -0800934 lctx = tls_listener_ctx_get (lctx_index);
Florin Corasaab06042020-02-26 02:56:14 +0000935
936 /* Cleanup listener from session lookup table */
937 ls = session_get_from_handle (lctx->tls_session_handle);
938 lc = session_get_transport (ls);
939
940 sep.fib_index = lc->fib_index;
941 sep.port = lc->lcl_port;
942 sep.is_ip4 = lc->is_ip4;
Florin Coras4b47ee22020-11-19 13:38:26 -0800943 sep.transport_proto = lctx->tls_type;
Florin Corasaab06042020-02-26 02:56:14 +0000944 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
945 session_lookup_del_session_endpoint2 (&sep);
946
Florin Corasc1a42652019-02-08 18:27:29 -0800947 vnet_unlisten_args_t a = {
Florin Corasb5e94e32018-09-14 14:46:39 -0700948 .handle = lctx->tls_session_handle,
949 .app_index = tls_main.app_index,
950 .wrk_map_index = 0 /* default wrk */
951 };
Florin Corasc1a42652019-02-08 18:27:29 -0800952 if ((rv = vnet_unlisten (&a)))
953 clib_warning ("unlisten returned %d", rv);
Florin Corasb5e94e32018-09-14 14:46:39 -0700954
Ping Yudecda5b2018-08-13 06:20:00 -0400955 engine_type = lctx->tls_ctx_engine;
956 tls_vfts[engine_type].ctx_stop_listen (lctx);
957
Florin Corase3e2f072018-03-04 07:24:30 -0800958 tls_listener_ctx_free (lctx);
Florin Coras371ca502018-02-21 12:07:41 -0800959 return 0;
960}
961
962transport_connection_t *
Florin Corase3e2f072018-03-04 07:24:30 -0800963tls_connection_get (u32 ctx_index, u32 thread_index)
964{
965 tls_ctx_t *ctx;
966 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
967 return &ctx->connection;
968}
969
970transport_connection_t *
Florin Coras371ca502018-02-21 12:07:41 -0800971tls_listener_get (u32 listener_index)
972{
973 tls_ctx_t *ctx;
974 ctx = tls_listener_ctx_get (listener_index);
975 return &ctx->connection;
976}
977
Florin Coras2c876f92021-05-10 21:12:27 -0700978static transport_connection_t *
979tls_half_open_get (u32 ho_index)
980{
Florin Coras2c876f92021-05-10 21:12:27 -0700981 tls_ctx_t *ctx;
982 ctx = tls_ctx_half_open_get (ho_index);
Florin Coras2c876f92021-05-10 21:12:27 -0700983 return &ctx->connection;
984}
985
986static void
987tls_cleanup_ho (u32 ho_index)
988{
Florin Coras2c876f92021-05-10 21:12:27 -0700989 tls_ctx_t *ctx;
Florin Coras4aaedaa2023-11-10 09:48:39 -0800990 session_t *s;
Florin Corasbab6c522021-05-13 08:36:56 -0700991
Florin Coras2c876f92021-05-10 21:12:27 -0700992 ctx = tls_ctx_half_open_get (ho_index);
Florin Corasa474bc82023-12-04 20:29:52 -0800993 /* Already pending cleanup */
994 if (ctx->tls_session_handle == SESSION_INVALID_HANDLE)
995 {
996 ASSERT (ctx->flags & TLS_CONN_F_HO_DONE);
Florin Coras4a98b932024-01-31 13:45:39 -0800997 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasa474bc82023-12-04 20:29:52 -0800998 return;
999 }
1000
Florin Coras4aaedaa2023-11-10 09:48:39 -08001001 s = session_get_from_handle (ctx->tls_session_handle);
1002 /* If no pending cleanup notification, force cleanup now. Otherwise,
1003 * wait for cleanup notification and set no app session on ctx */
1004 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1005 {
1006 session_cleanup_half_open (ctx->tls_session_handle);
1007 tls_ctx_half_open_free (ho_index);
1008 }
1009 else
Florin Coras4a98b932024-01-31 13:45:39 -08001010 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coras2c876f92021-05-10 21:12:27 -07001011}
1012
Florin Corasf940f8a2019-03-06 10:44:38 -08001013int
Florin Coras9f86d222020-03-23 15:34:22 +00001014tls_custom_tx_callback (void *session, transport_send_params_t * sp)
Florin Corasf940f8a2019-03-06 10:44:38 -08001015{
Florin Coras00d7d862023-09-22 19:26:33 -07001016 session_t *as = (session_t *) session;
Florin Corasf940f8a2019-03-06 10:44:38 -08001017 tls_ctx_t *ctx;
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001018
Florin Coras00d7d862023-09-22 19:26:33 -07001019 if (PREDICT_FALSE (as->session_state >= SESSION_STATE_TRANSPORT_CLOSED ||
1020 as->session_state <= SESSION_STATE_ACCEPTING))
1021 {
1022 sp->flags |= TRANSPORT_SND_F_DESCHED;
1023 return 0;
1024 }
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001025
Florin Coras00d7d862023-09-22 19:26:33 -07001026 ctx = tls_ctx_get (as->connection_index);
1027 return tls_ctx_write (ctx, as, sp);
Florin Corasf940f8a2019-03-06 10:44:38 -08001028}
1029
Florin Coras371ca502018-02-21 12:07:41 -08001030u8 *
1031format_tls_ctx (u8 * s, va_list * args)
1032{
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001033 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
Florin Coras371ca502018-02-21 12:07:41 -08001034 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
Florin Coras4b47ee22020-11-19 13:38:26 -08001035 char *proto;
Florin Coras371ca502018-02-21 12:07:41 -08001036
Florin Coras4b47ee22020-11-19 13:38:26 -08001037 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001038 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
1039 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
Florin Coras4b47ee22020-11-19 13:38:26 -08001040 s =
1041 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
1042 ctx->c_thread_index, ctx->c_s_index, proto,
1043 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
Florin Coras371ca502018-02-21 12:07:41 -08001044
Florin Coras371ca502018-02-21 12:07:41 -08001045 return s;
1046}
1047
Florin Coras0d74dd12020-01-07 19:01:26 +00001048static u8 *
1049format_tls_listener_ctx (u8 * s, va_list * args)
1050{
1051 session_t *tls_listener;
1052 app_listener_t *al;
Florin Coras0d74dd12020-01-07 19:01:26 +00001053 tls_ctx_t *ctx;
Florin Coras4b47ee22020-11-19 13:38:26 -08001054 char *proto;
Florin Coras0d74dd12020-01-07 19:01:26 +00001055
1056 ctx = va_arg (*args, tls_ctx_t *);
1057
Florin Coras4b47ee22020-11-19 13:38:26 -08001058 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
Florin Coras0d74dd12020-01-07 19:01:26 +00001059 al = app_listener_get_w_handle (ctx->tls_session_handle);
1060 tls_listener = app_listener_get_session (al);
Florin Coras4b47ee22020-11-19 13:38:26 -08001061 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
1062 ctx->c_thread_index, ctx->c_s_index, proto,
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001063 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
Florin Coras0d74dd12020-01-07 19:01:26 +00001064 tls_listener->thread_index, tls_listener->session_index);
1065
1066 return s;
1067}
1068
1069static u8 *
1070format_tls_ctx_state (u8 * s, va_list * args)
1071{
1072 tls_ctx_t *ctx;
1073 session_t *ts;
1074
1075 ctx = va_arg (*args, tls_ctx_t *);
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001076 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
Florin Coras0d74dd12020-01-07 19:01:26 +00001077 if (ts->session_state == SESSION_STATE_LISTENING)
1078 s = format (s, "%s", "LISTEN");
Florin Coras0d74dd12020-01-07 19:01:26 +00001079 else
Florin Coras681ea6d2020-04-24 16:59:49 +00001080 {
1081 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1082 s = format (s, "%s", "CLOSED");
1083 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1084 s = format (s, "%s", "APP-CLOSED");
1085 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1086 s = format (s, "%s", "CLOSING");
1087 else if (tls_ctx_handshake_is_over (ctx))
1088 s = format (s, "%s", "ESTABLISHED");
1089 else
1090 s = format (s, "%s", "HANDSHAKE");
1091 }
Florin Coras0d74dd12020-01-07 19:01:26 +00001092
1093 return s;
1094}
1095
Florin Coras371ca502018-02-21 12:07:41 -08001096u8 *
1097format_tls_connection (u8 * s, va_list * args)
1098{
1099 u32 ctx_index = va_arg (*args, u32);
1100 u32 thread_index = va_arg (*args, u32);
1101 u32 verbose = va_arg (*args, u32);
1102 tls_ctx_t *ctx;
1103
1104 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1105 if (!ctx)
1106 return s;
1107
Florin Coras7bf6ed62020-09-23 12:02:08 -07001108 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
Florin Coras371ca502018-02-21 12:07:41 -08001109 if (verbose)
1110 {
Florin Coras7bf6ed62020-09-23 12:02:08 -07001111 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1112 ctx);
Florin Coras371ca502018-02-21 12:07:41 -08001113 if (verbose > 1)
1114 s = format (s, "\n");
1115 }
1116 return s;
1117}
1118
1119u8 *
1120format_tls_listener (u8 * s, va_list * args)
1121{
1122 u32 tc_index = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +02001123 u32 __clib_unused thread_index = va_arg (*args, u32);
Florin Coras0d74dd12020-01-07 19:01:26 +00001124 u32 verbose = va_arg (*args, u32);
Florin Coras371ca502018-02-21 12:07:41 -08001125 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
Florin Coras371ca502018-02-21 12:07:41 -08001126
Florin Coras7bf6ed62020-09-23 12:02:08 -07001127 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
Florin Coras0d74dd12020-01-07 19:01:26 +00001128 if (verbose)
Florin Coras7bf6ed62020-09-23 12:02:08 -07001129 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001130 return s;
Florin Coras371ca502018-02-21 12:07:41 -08001131}
1132
1133u8 *
1134format_tls_half_open (u8 * s, va_list * args)
1135{
Florin Coras2c876f92021-05-10 21:12:27 -07001136 u32 ho_index = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +02001137 u32 __clib_unused thread_index = va_arg (*args, u32);
Florin Corasd69ef3a2023-10-02 10:41:54 -07001138 u32 __clib_unused verbose = va_arg (*args, u32);
Florin Coras2c876f92021-05-10 21:12:27 -07001139 session_t *tcp_ho;
1140 tls_ctx_t *ho_ctx;
1141
1142 ho_ctx = tls_ctx_half_open_get (ho_index);
1143
1144 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1145 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1146 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1147 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1148 tcp_ho->thread_index, tcp_ho->session_index);
1149
Florin Coras371ca502018-02-21 12:07:41 -08001150 return s;
1151}
1152
Yu Ping0b819152019-05-07 02:24:30 +08001153static void
1154tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1155 transport_endpoint_t * tep, u8 is_lcl)
1156{
1157 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
Florin Coras8074fc62024-02-20 11:24:54 -08001158 session_t *ts;
Yu Ping0b819152019-05-07 02:24:30 +08001159
Florin Coras8074fc62024-02-20 11:24:54 -08001160 ts = session_get_from_handle (ctx->tls_session_handle);
1161 if (ts && ts->session_state < SESSION_STATE_TRANSPORT_DELETED)
1162 session_get_endpoint (ts, tep, is_lcl);
Yu Ping0b819152019-05-07 02:24:30 +08001163}
1164
1165static void
1166tls_transport_listener_endpoint_get (u32 ctx_handle,
1167 transport_endpoint_t * tep, u8 is_lcl)
1168{
1169 session_t *tls_listener;
1170 app_listener_t *al;
1171 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1172
1173 al = app_listener_get_w_handle (ctx->tls_session_handle);
1174 tls_listener = app_listener_get_session (al);
1175 session_get_endpoint (tls_listener, tep, is_lcl);
1176}
1177
Florin Coras0a9ab822020-10-25 14:01:37 -07001178static clib_error_t *
1179tls_enable (vlib_main_t * vm, u8 is_en)
1180{
Florin Coras0a9ab822020-10-25 14:01:37 -07001181 vnet_app_detach_args_t _da, *da = &_da;
1182 vnet_app_attach_args_t _a, *a = &_a;
1183 u64 options[APP_OPTIONS_N_OPTIONS];
1184 tls_main_t *tm = &tls_main;
Florin Corasc1b03802023-09-30 15:21:08 -07001185 u32 fifo_size = 512 << 10;
Florin Coras0a9ab822020-10-25 14:01:37 -07001186
1187 if (!is_en)
1188 {
1189 da->app_index = tm->app_index;
1190 da->api_client_index = APP_INVALID_INDEX;
1191 vnet_application_detach (da);
1192 return 0;
1193 }
1194
Florin Coras0a9ab822020-10-25 14:01:37 -07001195 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1196
1197 clib_memset (a, 0, sizeof (*a));
1198 clib_memset (options, 0, sizeof (options));
1199
1200 a->session_cb_vft = &tls_app_cb_vft;
1201 a->api_client_index = APP_INVALID_INDEX;
1202 a->options = options;
1203 a->name = format (0, "tls");
Florin Corasa3767bd2021-11-18 15:25:31 -08001204 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1205 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
Florin Coras0a9ab822020-10-25 14:01:37 -07001206 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1207 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1208 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1209 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1210 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1211
1212 if (vnet_application_attach (a))
1213 {
1214 clib_warning ("failed to attach tls app");
1215 return clib_error_return (0, "failed to attach tls app");
1216 }
1217
1218 tm->app_index = a->app_index;
1219 vec_free (a->name);
1220
1221 return 0;
1222}
1223
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001224static const transport_proto_vft_t tls_proto = {
Florin Coras0a9ab822020-10-25 14:01:37 -07001225 .enable = tls_enable,
Florin Coras1ee78302019-02-05 15:51:15 -08001226 .connect = tls_connect,
Florin Coras371ca502018-02-21 12:07:41 -08001227 .close = tls_disconnect,
Florin Coras1ee78302019-02-05 15:51:15 -08001228 .start_listen = tls_start_listen,
1229 .stop_listen = tls_stop_listen,
Florin Corase3e2f072018-03-04 07:24:30 -08001230 .get_connection = tls_connection_get,
Florin Coras371ca502018-02-21 12:07:41 -08001231 .get_listener = tls_listener_get,
Florin Coras2c876f92021-05-10 21:12:27 -07001232 .get_half_open = tls_half_open_get,
1233 .cleanup_ho = tls_cleanup_ho,
Florin Corasf940f8a2019-03-06 10:44:38 -08001234 .custom_tx = tls_custom_tx_callback,
Florin Coras371ca502018-02-21 12:07:41 -08001235 .format_connection = format_tls_connection,
1236 .format_half_open = format_tls_half_open,
1237 .format_listener = format_tls_listener,
Yu Ping0b819152019-05-07 02:24:30 +08001238 .get_transport_endpoint = tls_transport_endpoint_get,
1239 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001240 .transport_options = {
Florin Coras07063b82020-03-13 04:44:51 +00001241 .name = "tls",
1242 .short_name = "J",
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001243 .tx_type = TRANSPORT_TX_INTERNAL,
Florin Coras2c876f92021-05-10 21:12:27 -07001244 .service_type = TRANSPORT_SERVICE_VC,
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001245 },
Florin Coras371ca502018-02-21 12:07:41 -08001246};
Florin Coras4b47ee22020-11-19 13:38:26 -08001247
1248int
1249dtls_connect (transport_endpoint_cfg_t *tep)
1250{
1251 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
Florin Corasa54b62d2021-04-21 09:05:56 -07001252 transport_endpt_crypto_cfg_t *ccfg;
Florin Coras4b47ee22020-11-19 13:38:26 -08001253 crypto_engine_type_t engine_type;
1254 session_endpoint_cfg_t *sep;
1255 tls_main_t *tm = &tls_main;
1256 app_worker_t *app_wrk;
1257 application_t *app;
1258 tls_ctx_t *ctx;
1259 u32 ctx_handle;
1260 int rv;
1261
1262 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -07001263 if (!sep->ext_cfg)
1264 return -1;
1265
Florin Coras4b47ee22020-11-19 13:38:26 -08001266 app_wrk = app_worker_get (sep->app_wrk_index);
1267 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -07001268
1269 ccfg = &sep->ext_cfg->crypto;
1270 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Florin Coras4b47ee22020-11-19 13:38:26 -08001271 if (engine_type == CRYPTO_ENGINE_NONE)
1272 {
1273 clib_warning ("No tls engine_type available");
1274 return -1;
1275 }
1276
Florin Corasfb50bc32021-05-18 00:28:59 -07001277 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1278 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
Florin Coras4b47ee22020-11-19 13:38:26 -08001279 ctx->parent_app_wrk_index = sep->app_wrk_index;
1280 ctx->parent_app_api_context = sep->opaque;
1281 ctx->tcp_is_ip4 = sep->is_ip4;
Florin Corasa54b62d2021-04-21 09:05:56 -07001282 ctx->ckpair_index = ccfg->ckpair_index;
Florin Coras4b47ee22020-11-19 13:38:26 -08001283 ctx->tls_type = sep->transport_proto;
1284 ctx->tls_ctx_handle = ctx_handle;
Florin Corasbab6c522021-05-13 08:36:56 -07001285 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1286 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasa54b62d2021-04-21 09:05:56 -07001287 if (ccfg->hostname[0])
Florin Coras4b47ee22020-11-19 13:38:26 -08001288 {
Florin Corasa54b62d2021-04-21 09:05:56 -07001289 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
Florin Coras4b47ee22020-11-19 13:38:26 -08001290 vec_terminate_c_string (ctx->srv_hostname);
1291 }
1292
Florin Coras4b47ee22020-11-19 13:38:26 -08001293 ctx->tls_ctx_engine = engine_type;
1294
1295 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1296 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1297 cargs->app_index = tm->app_index;
1298 cargs->api_context = ctx_handle;
1299 cargs->sep_ext.ns_index = app->ns_index;
1300 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1301 if ((rv = vnet_connect (cargs)))
1302 return rv;
1303
1304 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1305 engine_type);
Florin Corasbab6c522021-05-13 08:36:56 -07001306 return ctx_handle;
1307}
1308
1309static transport_connection_t *
1310dtls_half_open_get (u32 ho_index)
1311{
1312 tls_ctx_t *ho_ctx;
Florin Corasfb50bc32021-05-18 00:28:59 -07001313 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
Florin Corasbab6c522021-05-13 08:36:56 -07001314 return &ho_ctx->connection;
Florin Coras4b47ee22020-11-19 13:38:26 -08001315}
1316
1317static void
1318dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1319{
1320 /* No op */
1321}
1322
Florin Corasbab6c522021-05-13 08:36:56 -07001323static void
1324dtls_cleanup_ho (u32 ho_index)
1325{
1326 tls_ctx_t *ctx;
Florin Corasfb50bc32021-05-18 00:28:59 -07001327 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
Florin Corasbab6c522021-05-13 08:36:56 -07001328 tls_ctx_free (ctx);
1329}
1330
1331u8 *
1332format_dtls_half_open (u8 *s, va_list *args)
1333{
1334 u32 ho_index = va_arg (*args, u32);
1335 u32 __clib_unused thread_index = va_arg (*args, u32);
1336 tls_ctx_t *ho_ctx;
1337 session_t *us;
1338
Florin Corasfb50bc32021-05-18 00:28:59 -07001339 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
Florin Corasbab6c522021-05-13 08:36:56 -07001340
1341 us = session_get_from_handle (ho_ctx->tls_session_handle);
1342 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1343 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1344 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1345 us->thread_index, us->session_index);
1346
1347 return s;
1348}
1349
Florin Coras4b47ee22020-11-19 13:38:26 -08001350static const transport_proto_vft_t dtls_proto = {
1351 .enable = 0,
1352 .connect = dtls_connect,
1353 .close = tls_disconnect,
1354 .start_listen = tls_start_listen,
1355 .stop_listen = tls_stop_listen,
1356 .get_connection = tls_connection_get,
1357 .get_listener = tls_listener_get,
Florin Corasbab6c522021-05-13 08:36:56 -07001358 .get_half_open = dtls_half_open_get,
Florin Coras4b47ee22020-11-19 13:38:26 -08001359 .custom_tx = tls_custom_tx_callback,
1360 .cleanup = dtls_cleanup_callback,
Florin Corasbab6c522021-05-13 08:36:56 -07001361 .cleanup_ho = dtls_cleanup_ho,
Florin Coras4b47ee22020-11-19 13:38:26 -08001362 .format_connection = format_tls_connection,
Florin Corasbab6c522021-05-13 08:36:56 -07001363 .format_half_open = format_dtls_half_open,
Florin Coras4b47ee22020-11-19 13:38:26 -08001364 .format_listener = format_tls_listener,
1365 .get_transport_endpoint = tls_transport_endpoint_get,
1366 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1367 .transport_options = {
1368 .name = "dtls",
1369 .short_name = "D",
1370 .tx_type = TRANSPORT_TX_INTERNAL,
Florin Corasbab6c522021-05-13 08:36:56 -07001371 .service_type = TRANSPORT_SERVICE_VC,
Florin Coras4b47ee22020-11-19 13:38:26 -08001372 },
1373};
Florin Coras371ca502018-02-21 12:07:41 -08001374
Florin Corasd77eee62018-03-07 08:49:27 -08001375void
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +02001376tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
Florin Coras371ca502018-02-21 12:07:41 -08001377{
Florin Corasd77eee62018-03-07 08:49:27 -08001378 vec_validate (tls_vfts, type);
1379 tls_vfts[type] = *vft;
Florin Coras371ca502018-02-21 12:07:41 -08001380}
1381
Dave Barachcc5677b2018-03-28 19:08:45 -04001382static clib_error_t *
Florin Coras371ca502018-02-21 12:07:41 -08001383tls_init (vlib_main_t * vm)
1384{
Florin Coras58d36f02018-03-09 13:05:53 -08001385 vlib_thread_main_t *vtm = vlib_get_thread_main ();
Florin Coras371ca502018-02-21 12:07:41 -08001386 tls_main_t *tm = &tls_main;
Florin Coras0a9ab822020-10-25 14:01:37 -07001387 u32 num_threads;
Florin Coras58d36f02018-03-09 13:05:53 -08001388
1389 num_threads = 1 /* main thread */ + vtm->n_threads;
Florin Coras371ca502018-02-21 12:07:41 -08001390
Florin Corasd77eee62018-03-07 08:49:27 -08001391 if (!tm->ca_cert_path)
1392 tm->ca_cert_path = TLS_CA_CERT_PATH;
1393
Florin Coras58d36f02018-03-09 13:05:53 -08001394 vec_validate (tm->rx_bufs, num_threads - 1);
1395 vec_validate (tm->tx_bufs, num_threads - 1);
1396
Florin Corasa3767bd2021-11-18 15:25:31 -08001397 tm->first_seg_size = 32 << 20;
1398 tm->add_seg_size = 256 << 20;
1399
Florin Coras371ca502018-02-21 12:07:41 -08001400 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1401 FIB_PROTOCOL_IP4, ~0);
1402 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1403 FIB_PROTOCOL_IP6, ~0);
Florin Coras4b47ee22020-11-19 13:38:26 -08001404
1405 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1406 FIB_PROTOCOL_IP4, ~0);
1407 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1408 FIB_PROTOCOL_IP6, ~0);
Florin Coras371ca502018-02-21 12:07:41 -08001409 return 0;
1410}
1411
1412VLIB_INIT_FUNCTION (tls_init);
1413
Florin Coras8f89dd02018-03-05 16:53:07 -08001414static clib_error_t *
1415tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1416{
1417 tls_main_t *tm = &tls_main;
Dave Wallaceb1a81aa2019-10-30 17:53:56 +00001418 uword tmp;
Florin Coras8f89dd02018-03-05 16:53:07 -08001419 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1420 {
1421 if (unformat (input, "use-test-cert-in-ca"))
1422 tm->use_test_cert_in_ca = 1;
1423 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1424 ;
Florin Corasddd98f32019-03-25 08:30:53 -07001425 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1426 &tm->first_seg_size))
1427 ;
Florin Corasa3767bd2021-11-18 15:25:31 -08001428 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1429 &tm->add_seg_size))
1430 ;
Dave Wallaceb1a81aa2019-10-30 17:53:56 +00001431 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1432 {
1433 if (tmp >= 0x100000000ULL)
1434 {
1435 return clib_error_return
1436 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1437 }
1438 tm->fifo_size = tmp;
1439 }
Florin Coras8f89dd02018-03-05 16:53:07 -08001440 else
1441 return clib_error_return (0, "unknown input `%U'",
1442 format_unformat_error, input);
1443 }
1444 return 0;
1445}
1446
Florin Coras1cbcdce2022-04-06 15:10:13 -07001447VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
Florin Corasd77eee62018-03-07 08:49:27 -08001448
1449tls_main_t *
1450vnet_tls_get_main (void)
1451{
1452 return &tls_main;
1453}
1454
Florin Coras371ca502018-02-21 12:07:41 -08001455/*
1456 * fd.io coding-style-patch-verification: ON
1457 *
1458 * Local Variables:
1459 * eval: (c-set-style "gnu")
1460 * End:
1461 */