blob: 5f00e6e302da577ebfbd3c92a238437d49abcc94 [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 Corase5659022024-02-27 17:10:25 -0800208 app_session = session_alloc (ctx->c_thread_index);
209 app_session->session_state = SESSION_STATE_ACCEPTING;
Florin Coras371ca502018-02-21 12:07:41 -0800210 app_session->session_type = app_listener->session_type;
Nathan Skrzypczak2f0f96b2019-06-13 10:14:28 +0200211 app_session->listener_handle = listen_session_get_handle (app_listener);
Florin Corase5659022024-02-27 17:10:25 -0800212 app_session->app_wrk_index = ctx->parent_app_wrk_index;
213 app_session->connection_index = ctx->tls_ctx_handle;
214 ctx->c_s_index = app_session->session_index;
Florin Coras15531972018-08-12 23:50:53 -0700215
Florin Corasa27a46e2019-02-18 13:02:28 -0800216 if ((rv = app_worker_init_accepted (app_session)))
Florin Coras371ca502018-02-21 12:07:41 -0800217 {
218 TLS_DBG (1, "failed to allocate fifos");
Florin Corasa27a46e2019-02-18 13:02:28 -0800219 session_free (app_session);
Florin Coras4a98b932024-01-31 13:45:39 -0800220 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coras371ca502018-02-21 12:07:41 -0800221 return rv;
222 }
Florin Coras371ca502018-02-21 12:07:41 -0800223 ctx->app_session_handle = session_handle (app_session);
Florin Corasdf57ea02019-02-18 20:14:20 -0800224 ctx->parent_app_wrk_index = app_session->app_wrk_index;
Florin Corasa27a46e2019-02-18 13:02:28 -0800225 app_wrk = app_worker_get (app_session->app_wrk_index);
226 return app_worker_accept_notify (app_wrk, app_session);
Florin Coras371ca502018-02-21 12:07:41 -0800227}
228
Florin Coras58d36f02018-03-09 13:05:53 -0800229int
Florin Coras00e01d32019-10-21 16:07:46 -0700230tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
Florin Coras371ca502018-02-21 12:07:41 -0800231{
Florin Coras179711d2022-04-10 13:34:47 -0700232 u32 parent_app_api_ctx;
Florin Coras288eaab2019-02-03 15:26:14 -0800233 session_t *app_session;
Florin Coras15531972018-08-12 23:50:53 -0700234 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800235
Florin Corasdf57ea02019-02-18 20:14:20 -0800236 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
Florin Corasef915342018-09-29 10:23:06 -0700237 if (!app_wrk)
238 {
Florin Coras4a98b932024-01-31 13:45:39 -0800239 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasef915342018-09-29 10:23:06 -0700240 return -1;
241 }
242
Florin Coras00e01d32019-10-21 16:07:46 -0700243 if (err)
Florin Coras4b47ee22020-11-19 13:38:26 -0800244 {
Florin Coras4a98b932024-01-31 13:45:39 -0800245 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corase3c6a542021-05-19 19:28:40 -0700246 goto send_reply;
Florin Coras4b47ee22020-11-19 13:38:26 -0800247 }
Florin Coras8f89dd02018-03-05 16:53:07 -0800248
Florin Corase5659022024-02-27 17:10:25 -0800249 app_session = session_alloc (ctx->c_thread_index);
250 app_session->session_state = SESSION_STATE_CREATED;
251 app_session->connection_index = ctx->tls_ctx_handle;
252
Florin Coras4b47ee22020-11-19 13:38:26 -0800253 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
254 {
Florin Corasbab6c522021-05-13 08:36:56 -0700255 /* Cleanup half-open session as we don't get notification from udp */
256 session_half_open_delete_notify (&ctx->connection);
Florin Corase5659022024-02-27 17:10:25 -0800257 app_session->session_type =
Florin Coras4b47ee22020-11-19 13:38:26 -0800258 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
Florin Coras4b47ee22020-11-19 13:38:26 -0800259 }
260 else
261 {
Florin Corase5659022024-02-27 17:10:25 -0800262 app_session->session_type =
263 session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
Florin Coras4b47ee22020-11-19 13:38:26 -0800264 }
265
Florin Corasdf57ea02019-02-18 20:14:20 -0800266 app_session->app_wrk_index = ctx->parent_app_wrk_index;
Florin Coras2ceb8182023-08-31 17:33:47 -0700267 app_session->opaque = ctx->parent_app_api_context;
Florin Corase5659022024-02-27 17:10:25 -0800268 ctx->c_s_index = app_session->session_index;
Florin Coras15531972018-08-12 23:50:53 -0700269
Florin Coras00e01d32019-10-21 16:07:46 -0700270 if ((err = app_worker_init_connected (app_wrk, app_session)))
Florin Corasa3d55df2023-10-06 19:06:35 -0700271 {
272 app_worker_connect_notify (app_wrk, 0, err, ctx->parent_app_api_context);
Florin Coras4a98b932024-01-31 13:45:39 -0800273 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasa3d55df2023-10-06 19:06:35 -0700274 session_free (app_session);
275 return -1;
276 }
Florin Coras371ca502018-02-21 12:07:41 -0800277
jiangxiaoming5b7ea912020-09-23 10:29:21 +0800278 app_session->session_state = SESSION_STATE_READY;
Florin Coras179711d2022-04-10 13:34:47 -0700279 parent_app_api_ctx = ctx->parent_app_api_context;
280 ctx->app_session_handle = session_handle (app_session);
281
282 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
283 parent_app_api_ctx))
Florin Coras371ca502018-02-21 12:07:41 -0800284 {
285 TLS_DBG (1, "failed to notify app");
Florin Coras6e7ebb02022-05-04 12:02:56 -0700286 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
Florin Coras4a98b932024-01-31 13:45:39 -0800287 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coraseb97e5f2018-10-15 21:35:42 -0700288 return -1;
Florin Coras371ca502018-02-21 12:07:41 -0800289 }
290
291 return 0;
292
Florin Corase3c6a542021-05-19 19:28:40 -0700293send_reply:
Florin Coras00e01d32019-10-21 16:07:46 -0700294 return app_worker_connect_notify (app_wrk, 0, err,
295 ctx->parent_app_api_context);
Florin Coras371ca502018-02-21 12:07:41 -0800296}
297
Florin Coras58d36f02018-03-09 13:05:53 -0800298static inline void
299tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
Florin Corasd77eee62018-03-07 08:49:27 -0800300{
Florin Coras58d36f02018-03-09 13:05:53 -0800301 *ctx_index = ctx_handle & TLS_IDX_MASK;
302 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
303}
304
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200305static inline crypto_engine_type_t
Florin Corasa54b62d2021-04-21 09:05:56 -0700306tls_get_engine_type (crypto_engine_type_t requested,
307 crypto_engine_type_t preferred)
Florin Coras58d36f02018-03-09 13:05:53 -0800308{
Florin Corasa54b62d2021-04-21 09:05:56 -0700309 if (requested != CRYPTO_ENGINE_NONE)
310 {
311 if (tls_vfts[requested].ctx_alloc)
312 return requested;
313 return CRYPTO_ENGINE_NONE;
314 }
Florin Coras58d36f02018-03-09 13:05:53 -0800315 if (!tls_vfts[preferred].ctx_alloc)
316 return tls_get_available_engine ();
317 return preferred;
318}
319
320static inline u32
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200321tls_ctx_alloc (crypto_engine_type_t engine_type)
Florin Coras58d36f02018-03-09 13:05:53 -0800322{
323 u32 ctx_index;
324 ctx_index = tls_vfts[engine_type].ctx_alloc ();
325 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
Florin Corasd77eee62018-03-07 08:49:27 -0800326}
327
Florin Coras4b47ee22020-11-19 13:38:26 -0800328static inline u32
329tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
330{
331 u32 ctx_index;
332 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
333 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
334}
335
336static inline u32
337tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
338{
339 u32 ctx_index;
340 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
341 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
342}
343
344static inline void *
345tls_ctx_detach (tls_ctx_t *ctx)
346{
347 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
348}
349
Florin Corasd77eee62018-03-07 08:49:27 -0800350static inline tls_ctx_t *
Florin Coras58d36f02018-03-09 13:05:53 -0800351tls_ctx_get (u32 ctx_handle)
Florin Corasd77eee62018-03-07 08:49:27 -0800352{
Florin Coras58d36f02018-03-09 13:05:53 -0800353 u32 ctx_index, engine_type;
354 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
355 return tls_vfts[engine_type].ctx_get (ctx_index);
Florin Corasd77eee62018-03-07 08:49:27 -0800356}
357
358static inline tls_ctx_t *
Florin Coras58d36f02018-03-09 13:05:53 -0800359tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
Florin Corasd77eee62018-03-07 08:49:27 -0800360{
Florin Coras58d36f02018-03-09 13:05:53 -0800361 u32 ctx_index, engine_type;
362 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
363 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
Florin Corasd77eee62018-03-07 08:49:27 -0800364}
365
366static inline int
367tls_ctx_init_server (tls_ctx_t * ctx)
368{
Florin Coras58d36f02018-03-09 13:05:53 -0800369 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
Florin Corasd77eee62018-03-07 08:49:27 -0800370}
371
372static inline int
373tls_ctx_init_client (tls_ctx_t * ctx)
374{
Florin Coras58d36f02018-03-09 13:05:53 -0800375 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
Florin Corasd77eee62018-03-07 08:49:27 -0800376}
377
378static inline int
Florin Coras9f86d222020-03-23 15:34:22 +0000379tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
380 transport_send_params_t * sp)
Florin Corasd77eee62018-03-07 08:49:27 -0800381{
Florin Coras9f86d222020-03-23 15:34:22 +0000382 u32 n_wrote;
Florin Corased8db522020-02-27 04:32:51 +0000383
Florin Coras9f86d222020-03-23 15:34:22 +0000384 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
385 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
Florin Coras3e157102022-02-04 13:31:25 -0800386 sp->bytes_dequeued = n_wrote;
Florin Corased8db522020-02-27 04:32:51 +0000387 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
Florin Corasd77eee62018-03-07 08:49:27 -0800388}
389
390static inline int
Florin Coras288eaab2019-02-03 15:26:14 -0800391tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
Florin Corasd77eee62018-03-07 08:49:27 -0800392{
Florin Coras58d36f02018-03-09 13:05:53 -0800393 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
Florin Corasd77eee62018-03-07 08:49:27 -0800394}
395
Florin Coras06a6a302019-04-17 14:19:12 -0700396static inline int
397tls_ctx_transport_close (tls_ctx_t * ctx)
398{
399 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
400}
401
402static inline int
Florin Corasea158d62024-02-26 18:11:43 -0800403tls_ctx_transport_reset (tls_ctx_t *ctx)
404{
405 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_reset (ctx);
406}
407
408static inline int
Florin Coras06a6a302019-04-17 14:19:12 -0700409tls_ctx_app_close (tls_ctx_t * ctx)
410{
411 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
412}
413
414void
415tls_ctx_free (tls_ctx_t * ctx)
416{
Florin Coras06a6a302019-04-17 14:19:12 -0700417 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
418}
419
420u8
Florin Corasd77eee62018-03-07 08:49:27 -0800421tls_ctx_handshake_is_over (tls_ctx_t * ctx)
422{
Florin Coras58d36f02018-03-09 13:05:53 -0800423 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800424}
425
Saravanan Murugesand918cc52022-02-28 19:54:11 +0530426int
427tls_reinit_ca_chain (crypto_engine_type_t tls_engine_id)
428{
429 return tls_vfts[tls_engine_id].ctx_reinit_cachain ();
430}
431
Florin Coras371ca502018-02-21 12:07:41 -0800432void
Florin Coras8c5e5f62022-02-24 16:35:26 -0800433tls_notify_app_io_error (tls_ctx_t *ctx)
434{
435 ASSERT (tls_ctx_handshake_is_over (ctx));
436
437 session_transport_reset_notify (&ctx->connection);
438 session_transport_closed_notify (&ctx->connection);
439 tls_disconnect_transport (ctx);
440}
441
442void
Florin Corasea158d62024-02-26 18:11:43 -0800443tls_session_reset_callback (session_t *ts)
Florin Coras371ca502018-02-21 12:07:41 -0800444{
Florin Corasf03c4942019-08-07 21:39:27 -0700445 tls_ctx_t *ctx;
446
Florin Corasea158d62024-02-26 18:11:43 -0800447 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
Florin Coras4a98b932024-01-31 13:45:39 -0800448 ctx->flags |= TLS_CONN_F_PASSIVE_CLOSE;
Florin Corasea158d62024-02-26 18:11:43 -0800449 tls_ctx_transport_reset (ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800450}
451
Florin Coras2c876f92021-05-10 21:12:27 -0700452static void
453tls_session_cleanup_ho (session_t *s)
454{
Florin Coras2c876f92021-05-10 21:12:27 -0700455 /* session opaque stores the opaque passed on connect */
Florin Corasa474bc82023-12-04 20:29:52 -0800456 tls_ctx_ho_try_free (s->opaque);
Florin Coras2c876f92021-05-10 21:12:27 -0700457}
458
Florin Coras371ca502018-02-21 12:07:41 -0800459int
Florin Corasfa76a762018-11-29 12:40:10 -0800460tls_add_segment_callback (u32 client_index, u64 segment_handle)
Florin Coras371ca502018-02-21 12:07:41 -0800461{
462 /* No-op for builtin */
463 return 0;
464}
465
466int
Florin Corasfa76a762018-11-29 12:40:10 -0800467tls_del_segment_callback (u32 client_index, u64 segment_handle)
Florin Coras371ca502018-02-21 12:07:41 -0800468{
469 return 0;
470}
471
472void
Florin Coras288eaab2019-02-03 15:26:14 -0800473tls_session_disconnect_callback (session_t * tls_session)
Florin Coras371ca502018-02-21 12:07:41 -0800474{
Florin Coras371ca502018-02-21 12:07:41 -0800475 tls_ctx_t *ctx;
Florin Corasbf7ce2c2019-03-06 14:44:42 -0800476
477 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
478 tls_session->session_index);
Florin Coras371ca502018-02-21 12:07:41 -0800479
Florin Coras6faac162019-10-11 08:00:43 -0700480 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
481 || vlib_thread_is_main_w_barrier ());
482
483 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
Florin Coras4a98b932024-01-31 13:45:39 -0800484 ctx->flags |= TLS_CONN_F_PASSIVE_CLOSE;
Florin Coras06a6a302019-04-17 14:19:12 -0700485 tls_ctx_transport_close (ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800486}
487
488int
Florin Coras7c2a3352024-03-26 19:47:27 -0700489tls_session_accept_callback (session_t *ts)
Florin Coras371ca502018-02-21 12:07:41 -0800490{
Florin Corase5659022024-02-27 17:10:25 -0800491 session_t *tls_listener;
Florin Coras371ca502018-02-21 12:07:41 -0800492 tls_ctx_t *lctx, *ctx;
Florin Coras58d36f02018-03-09 13:05:53 -0800493 u32 ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800494
Florin Coras7c2a3352024-03-26 19:47:27 -0700495 tls_listener = listen_session_get_from_handle (ts->listener_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800496 lctx = tls_listener_ctx_get (tls_listener->opaque);
Florin Coras58d36f02018-03-09 13:05:53 -0800497
498 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
499 ctx = tls_ctx_get (ctx_handle);
Florin Coras60732df2024-02-23 18:01:45 -0800500 clib_memcpy (ctx, lctx, sizeof (*lctx));
Florin Coras7c2a3352024-03-26 19:47:27 -0700501 ctx->c_s_index = SESSION_INVALID_INDEX;
502 ctx->c_thread_index = ts->thread_index;
Florin Coras58d36f02018-03-09 13:05:53 -0800503 ctx->tls_ctx_handle = ctx_handle;
Florin Coras7c2a3352024-03-26 19:47:27 -0700504 ts->opaque = ctx_handle;
505 ctx->tls_session_handle = session_handle (ts);
Florin Coras371ca502018-02-21 12:07:41 -0800506 ctx->listener_ctx_index = tls_listener->opaque;
Florin Corasd09236d2019-08-08 17:38:26 -0700507 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200508 ctx->ckpair_index = lctx->ckpair_index;
Florin Coras371ca502018-02-21 12:07:41 -0800509
Florin Coras58d36f02018-03-09 13:05:53 -0800510 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
511 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800512
Florin Coras14bfd3d2023-11-08 19:57:38 -0800513 if (tls_ctx_init_server (ctx))
Xiaoming Jiang47781642023-05-26 00:32:25 +0000514 {
Florin Coras14bfd3d2023-11-08 19:57:38 -0800515 /* Do not free ctx yet, in case we have pending rx events */
Florin Coras4a98b932024-01-31 13:45:39 -0800516 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coras14bfd3d2023-11-08 19:57:38 -0800517 tls_disconnect_transport (ctx);
Xiaoming Jiang47781642023-05-26 00:32:25 +0000518 }
519
Florin Coras0bfce6b2024-04-05 14:50:10 -0700520 if (ts->session_state < SESSION_STATE_READY)
521 ts->session_state = SESSION_STATE_READY;
522
Florin Coras14bfd3d2023-11-08 19:57:38 -0800523 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800524}
525
526int
Florin Corascfc2a0e2023-11-08 14:14:17 -0800527tls_app_rx_callback (session_t *ts)
Florin Coras371ca502018-02-21 12:07:41 -0800528{
Florin Coras371ca502018-02-21 12:07:41 -0800529 tls_ctx_t *ctx;
Florin Coras371ca502018-02-21 12:07:41 -0800530
Florin Coras4b47ee22020-11-19 13:38:26 -0800531 /* DTLS session migrating, wait for next notification */
Florin Corascfc2a0e2023-11-08 14:14:17 -0800532 if (PREDICT_FALSE (ts->flags & SESSION_F_IS_MIGRATING))
Florin Coras4b47ee22020-11-19 13:38:26 -0800533 return 0;
534
Florin Corascfc2a0e2023-11-08 14:14:17 -0800535 /* Read rescheduled but underlying transport deleted now */
536 if (PREDICT_FALSE ((ts->session_state == SESSION_STATE_TRANSPORT_DELETED)))
537 return 0;
538
539 ctx = tls_ctx_get (ts->opaque);
Florin Coras4a98b932024-01-31 13:45:39 -0800540 if (PREDICT_FALSE ((ctx->flags & TLS_CONN_F_NO_APP_SESSION) ||
541 (ctx->flags & TLS_CONN_F_APP_CLOSED)))
Saravanan Murugesan3683d1b2022-02-28 10:55:26 +0530542 {
543 TLS_DBG (1, "Local App closed");
544 return 0;
545 }
Florin Corascfc2a0e2023-11-08 14:14:17 -0800546 tls_ctx_read (ctx, ts);
Florin Coras58d36f02018-03-09 13:05:53 -0800547 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800548}
549
550int
Florin Coras9f86d222020-03-23 15:34:22 +0000551tls_app_tx_callback (session_t * tls_session)
552{
553 tls_ctx_t *ctx;
554
555 ctx = tls_ctx_get (tls_session->opaque);
556 transport_connection_reschedule (&ctx->connection);
557
558 return 0;
559}
560
561int
Florin Coras4b47ee22020-11-19 13:38:26 -0800562tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
563 session_t *tls_session, session_error_t err)
Florin Coras371ca502018-02-21 12:07:41 -0800564{
Florin Coras371ca502018-02-21 12:07:41 -0800565 tls_ctx_t *ho_ctx, *ctx;
Florin Coras58d36f02018-03-09 13:05:53 -0800566 u32 ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800567
568 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
Florin Coras371ca502018-02-21 12:07:41 -0800569
Florin Coras58d36f02018-03-09 13:05:53 -0800570 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
571 ctx = tls_ctx_get (ctx_handle);
Dave Barach178cf492018-11-13 16:34:13 -0500572 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
Florin Coras0ded4892024-02-13 15:37:20 -0500573
Florin Coras2c876f92021-05-10 21:12:27 -0700574 /* Half-open freed on tcp half-open cleanup notification */
Florin Coras0ded4892024-02-13 15:37:20 -0500575 __atomic_fetch_or (&ho_ctx->flags, TLS_CONN_F_HO_DONE, __ATOMIC_RELEASE);
Florin Coras371ca502018-02-21 12:07:41 -0800576
Florin Corasdcde9272018-03-02 09:23:42 -0800577 ctx->c_thread_index = vlib_get_thread_index ();
Florin Coras58d36f02018-03-09 13:05:53 -0800578 ctx->tls_ctx_handle = ctx_handle;
Florin Corasd09236d2019-08-08 17:38:26 -0700579 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasdcde9272018-03-02 09:23:42 -0800580
Florin Coras58d36f02018-03-09 13:05:53 -0800581 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
Florin Coras4b47ee22020-11-19 13:38:26 -0800582 ho_ctx_index, err, vlib_get_thread_index (),
Florin Coras58d36f02018-03-09 13:05:53 -0800583 (ctx) ? ctx_handle : ~0);
Florin Coras371ca502018-02-21 12:07:41 -0800584
585 ctx->tls_session_handle = session_handle (tls_session);
Florin Coras58d36f02018-03-09 13:05:53 -0800586 tls_session->opaque = ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800587
Florin Coras14bfd3d2023-11-08 19:57:38 -0800588 if (tls_ctx_init_client (ctx))
Xiaoming Jiang47781642023-05-26 00:32:25 +0000589 {
Florin Coras14bfd3d2023-11-08 19:57:38 -0800590 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
591 tls_disconnect_transport (ctx);
Xiaoming Jiang47781642023-05-26 00:32:25 +0000592 }
593
Florin Corasa8d266a2024-03-22 14:47:16 -0700594 if (tls_session->session_state < SESSION_STATE_READY)
595 tls_session->session_state = SESSION_STATE_READY;
596
Florin Coras14bfd3d2023-11-08 19:57:38 -0800597 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800598}
599
Florin Coras4b47ee22020-11-19 13:38:26 -0800600int
601dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
602 session_error_t err)
603{
604 tls_ctx_t *ctx;
605
Florin Corasfb50bc32021-05-18 00:28:59 -0700606 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
Florin Coras4b47ee22020-11-19 13:38:26 -0800607
608 ctx->tls_session_handle = session_handle (us);
609 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
610 us->opaque = ctx_handle;
611
612 /* We don't preallocate the app session because the udp session might
613 * actually migrate to a different worker at the end of the handshake */
614
615 return tls_ctx_init_client (ctx);
616}
617
618int
619tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
620 session_t *tls_session, session_error_t err)
621{
Florin Coras71ee3752021-05-28 18:29:08 -0700622 if (err)
623 {
624 app_worker_t *app_wrk;
625 tls_ctx_t *ho_ctx;
626 u32 api_context;
627
628 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
Florin Corasa474bc82023-12-04 20:29:52 -0800629 ho_ctx->flags |= TLS_CONN_F_HO_DONE;
Florin Coras71ee3752021-05-28 18:29:08 -0700630 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
631 if (app_wrk)
632 {
633 api_context = ho_ctx->parent_app_api_context;
634 app_worker_connect_notify (app_wrk, 0, err, api_context);
635 }
Florin Coras71ee3752021-05-28 18:29:08 -0700636
637 return 0;
638 }
639
Florin Coras4b47ee22020-11-19 13:38:26 -0800640 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
641 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
642 err);
643 else
644 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
645 err);
646}
647
Florin Corasef2b3352019-08-07 11:14:56 -0700648static void
649tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
650{
651 tls_ctx_t *ctx;
652
653 if (ntf == SESSION_CLEANUP_TRANSPORT)
Florin Coras36d49392020-04-24 23:00:11 +0000654 {
655 /* Allow cleanup of tcp session */
656 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
657 session_close (s);
658 return;
659 }
Florin Corasef2b3352019-08-07 11:14:56 -0700660
661 ctx = tls_ctx_get (s->opaque);
Florin Coras4a98b932024-01-31 13:45:39 -0800662 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
Florin Corasef2b3352019-08-07 11:14:56 -0700663 session_transport_delete_notify (&ctx->connection);
664 tls_ctx_free (ctx);
665}
666
Florin Coras4b47ee22020-11-19 13:38:26 -0800667static void
Florin Coras88dd3cf2021-05-01 19:01:42 -0700668dtls_migrate_ctx (void *arg)
Florin Coras4b47ee22020-11-19 13:38:26 -0800669{
670 tls_ctx_t *ctx = (tls_ctx_t *) arg;
671 u32 ctx_handle, thread_index;
672 session_t *us;
673
674 thread_index = session_thread_from_handle (ctx->tls_session_handle);
675 ASSERT (thread_index == vlib_get_thread_index ());
676
677 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
678 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
679 ctx->tls_ctx_handle = ctx_handle;
680
681 us = session_get_from_handle (ctx->tls_session_handle);
682 us->opaque = ctx_handle;
683 us->flags &= ~SESSION_F_IS_MIGRATING;
Florin Corasbab6c522021-05-13 08:36:56 -0700684
685 /* Probably the app detached while the session was migrating. Cleanup */
686 if (session_half_open_migrated_notify (&ctx->connection))
687 {
Florin Coras4a98b932024-01-31 13:45:39 -0800688 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasbab6c522021-05-13 08:36:56 -0700689 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
690 return;
691 }
692
Florin Coras4b47ee22020-11-19 13:38:26 -0800693 if (svm_fifo_max_dequeue (us->tx_fifo))
694 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
695}
696
697static void
698dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
699{
700 u32 new_thread = session_thread_from_handle (new_sh);
Florin Coras88dd3cf2021-05-01 19:01:42 -0700701 tls_ctx_t *ctx, *cloned_ctx;
Florin Coras4b47ee22020-11-19 13:38:26 -0800702
703 /* Migrate dtls context to new thread */
704 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
705 ctx->tls_session_handle = new_sh;
Florin Coras88dd3cf2021-05-01 19:01:42 -0700706 cloned_ctx = tls_ctx_detach (ctx);
Florin Coras4a98b932024-01-31 13:45:39 -0800707 ctx->flags |= TLS_CONN_F_MIGRATED;
Florin Corasbab6c522021-05-13 08:36:56 -0700708 session_half_open_migrate_notify (&ctx->connection);
Florin Coras4b47ee22020-11-19 13:38:26 -0800709
Florin Coras88dd3cf2021-05-01 19:01:42 -0700710 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
711 (void *) cloned_ctx);
712
713 tls_ctx_free (ctx);
Florin Coras4b47ee22020-11-19 13:38:26 -0800714}
715
Florin Corascfc2a0e2023-11-08 14:14:17 -0800716static void
717tls_session_transport_closed_callback (session_t *ts)
718{
719 tls_ctx_t *ctx;
720
721 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
Florin Coras4a98b932024-01-31 13:45:39 -0800722 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
Florin Coras86b02c72023-12-13 14:26:19 -0800723 session_transport_closed_notify (&ctx->connection);
Florin Corascfc2a0e2023-11-08 14:14:17 -0800724}
725
Florin Coras371ca502018-02-21 12:07:41 -0800726static session_cb_vft_t tls_app_cb_vft = {
727 .session_accept_callback = tls_session_accept_callback,
728 .session_disconnect_callback = tls_session_disconnect_callback,
729 .session_connected_callback = tls_session_connected_callback,
730 .session_reset_callback = tls_session_reset_callback,
Florin Corascfc2a0e2023-11-08 14:14:17 -0800731 .session_transport_closed_callback = tls_session_transport_closed_callback,
Florin Coras2c876f92021-05-10 21:12:27 -0700732 .half_open_cleanup_callback = tls_session_cleanup_ho,
Florin Coras371ca502018-02-21 12:07:41 -0800733 .add_segment_callback = tls_add_segment_callback,
734 .del_segment_callback = tls_del_segment_callback,
735 .builtin_app_rx_callback = tls_app_rx_callback,
Florin Coras9f86d222020-03-23 15:34:22 +0000736 .builtin_app_tx_callback = tls_app_tx_callback,
Florin Coras4b47ee22020-11-19 13:38:26 -0800737 .session_migrate_callback = dtls_session_migrate_callback,
Florin Corasef2b3352019-08-07 11:14:56 -0700738 .session_cleanup_callback = tls_app_session_cleanup,
Florin Coras371ca502018-02-21 12:07:41 -0800739};
Florin Coras371ca502018-02-21 12:07:41 -0800740
741int
Florin Coras5665ced2018-10-25 18:03:45 -0700742tls_connect (transport_endpoint_cfg_t * tep)
Florin Coras371ca502018-02-21 12:07:41 -0800743{
Florin Coras15531972018-08-12 23:50:53 -0700744 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
Florin Corasa54b62d2021-04-21 09:05:56 -0700745 transport_endpt_crypto_cfg_t *ccfg;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200746 crypto_engine_type_t engine_type;
Florin Coras4b47ee22020-11-19 13:38:26 -0800747 session_endpoint_cfg_t *sep;
Florin Coras371ca502018-02-21 12:07:41 -0800748 tls_main_t *tm = &tls_main;
Florin Coras15531972018-08-12 23:50:53 -0700749 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800750 application_t *app;
751 tls_ctx_t *ctx;
752 u32 ctx_index;
Florin Corasc1a42652019-02-08 18:27:29 -0800753 int rv;
Florin Coras371ca502018-02-21 12:07:41 -0800754
Florin Coras5665ced2018-10-25 18:03:45 -0700755 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -0700756 if (!sep->ext_cfg)
Florin Corase5f18332021-04-22 11:48:35 -0700757 return SESSION_E_NOEXTCFG;
Florin Corasa54b62d2021-04-21 09:05:56 -0700758
Florin Coras15531972018-08-12 23:50:53 -0700759 app_wrk = app_worker_get (sep->app_wrk_index);
760 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -0700761
762 ccfg = &sep->ext_cfg->crypto;
763 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200764 if (engine_type == CRYPTO_ENGINE_NONE)
Florin Coras58d36f02018-03-09 13:05:53 -0800765 {
766 clib_warning ("No tls engine_type available");
Florin Corase5f18332021-04-22 11:48:35 -0700767 return SESSION_E_NOCRYPTOENG;
Florin Coras58d36f02018-03-09 13:05:53 -0800768 }
Florin Coras371ca502018-02-21 12:07:41 -0800769
770 ctx_index = tls_ctx_half_open_alloc ();
771 ctx = tls_ctx_half_open_get (ctx_index);
Florin Corasdf57ea02019-02-18 20:14:20 -0800772 ctx->parent_app_wrk_index = sep->app_wrk_index;
Florin Coras371ca502018-02-21 12:07:41 -0800773 ctx->parent_app_api_context = sep->opaque;
774 ctx->tcp_is_ip4 = sep->is_ip4;
Florin Coras4b47ee22020-11-19 13:38:26 -0800775 ctx->tls_type = sep->transport_proto;
Florin Corasa54b62d2021-04-21 09:05:56 -0700776 ctx->ckpair_index = ccfg->ckpair_index;
Florin Coras2c876f92021-05-10 21:12:27 -0700777 ctx->c_proto = TRANSPORT_PROTO_TLS;
778 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasa54b62d2021-04-21 09:05:56 -0700779 if (ccfg->hostname[0])
Florin Coras8f89dd02018-03-05 16:53:07 -0800780 {
Florin Corasa54b62d2021-04-21 09:05:56 -0700781 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
Florin Coras8f89dd02018-03-05 16:53:07 -0800782 vec_terminate_c_string (ctx->srv_hostname);
783 }
Florin Coras371ca502018-02-21 12:07:41 -0800784
Florin Coras58d36f02018-03-09 13:05:53 -0800785 ctx->tls_ctx_engine = engine_type;
Florin Coras371ca502018-02-21 12:07:41 -0800786
Dave Barach178cf492018-11-13 16:34:13 -0500787 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
Florin Coras15531972018-08-12 23:50:53 -0700788 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
789 cargs->app_index = tm->app_index;
790 cargs->api_context = ctx_index;
Florin Coras8a140612019-02-18 22:39:39 -0800791 cargs->sep_ext.ns_index = app->ns_index;
Florin Corasc1a42652019-02-08 18:27:29 -0800792 if ((rv = vnet_connect (cargs)))
Florin Coras3109d1c2024-01-22 18:27:43 -0800793 {
794 tls_ctx_half_open_free (ctx_index);
795 return rv;
796 }
Florin Coras371ca502018-02-21 12:07:41 -0800797
Florin Coras2c876f92021-05-10 21:12:27 -0700798 /* Track half-open tcp session in case we need to clean it up */
799 ctx->tls_session_handle = cargs->sh;
800
Florin Coras58d36f02018-03-09 13:05:53 -0800801 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
Florin Coras2c876f92021-05-10 21:12:27 -0700802 return ctx_index;
Florin Coras371ca502018-02-21 12:07:41 -0800803}
804
805void
Florin Coras58d36f02018-03-09 13:05:53 -0800806tls_disconnect (u32 ctx_handle, u32 thread_index)
Florin Coras371ca502018-02-21 12:07:41 -0800807{
Florin Coras371ca502018-02-21 12:07:41 -0800808 tls_ctx_t *ctx;
809
Florin Coras58d36f02018-03-09 13:05:53 -0800810 TLS_DBG (1, "Disconnecting %x", ctx_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800811
Florin Coras58d36f02018-03-09 13:05:53 -0800812 ctx = tls_ctx_get (ctx_handle);
Florin Corasd7f17a22024-01-31 16:18:17 -0800813 ctx->flags |= TLS_CONN_F_APP_CLOSED;
Florin Coras06a6a302019-04-17 14:19:12 -0700814 tls_ctx_app_close (ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800815}
816
817u32
Florin Coras0bce71e2022-02-10 11:57:06 -0800818tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
Florin Coras371ca502018-02-21 12:07:41 -0800819{
Florin Corasc9940fc2019-02-05 20:55:11 -0800820 vnet_listen_args_t _bargs, *args = &_bargs;
Florin Corasa54b62d2021-04-21 09:05:56 -0700821 transport_endpt_crypto_cfg_t *ccfg;
Florin Corasab2f6db2018-08-31 14:31:41 -0700822 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800823 tls_main_t *tm = &tls_main;
Florin Corasa27a46e2019-02-18 13:02:28 -0800824 session_handle_t tls_al_handle;
Florin Coras5665ced2018-10-25 18:03:45 -0700825 session_endpoint_cfg_t *sep;
Florin Coras288eaab2019-02-03 15:26:14 -0800826 session_t *tls_listener;
827 session_t *app_listener;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200828 crypto_engine_type_t engine_type;
Florin Coras74cac882018-09-07 09:13:15 -0700829 application_t *app;
Florin Corasa27a46e2019-02-18 13:02:28 -0800830 app_listener_t *al;
Florin Coras15531972018-08-12 23:50:53 -0700831 tls_ctx_t *lctx;
832 u32 lctx_index;
Florin Corase5f18332021-04-22 11:48:35 -0700833 int rv;
Florin Coras371ca502018-02-21 12:07:41 -0800834
Florin Coras5665ced2018-10-25 18:03:45 -0700835 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -0700836 if (!sep->ext_cfg)
Florin Corase5f18332021-04-22 11:48:35 -0700837 return SESSION_E_NOEXTCFG;
Florin Corasa54b62d2021-04-21 09:05:56 -0700838
Florin Coras15531972018-08-12 23:50:53 -0700839 app_wrk = app_worker_get (sep->app_wrk_index);
840 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -0700841
842 ccfg = &sep->ext_cfg->crypto;
843 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200844 if (engine_type == CRYPTO_ENGINE_NONE)
Florin Coras58d36f02018-03-09 13:05:53 -0800845 {
846 clib_warning ("No tls engine_type available");
Florin Corase5f18332021-04-22 11:48:35 -0700847 return SESSION_E_NOCRYPTOENG;
Florin Coras58d36f02018-03-09 13:05:53 -0800848 }
849
Dave Barachb7b92992018-10-17 10:38:51 -0400850 clib_memset (args, 0, sizeof (*args));
Florin Coras74cac882018-09-07 09:13:15 -0700851 args->app_index = tm->app_index;
852 args->sep_ext = *sep;
Florin Coras8a140612019-02-18 22:39:39 -0800853 args->sep_ext.ns_index = app->ns_index;
Florin Coras95cd8642019-12-30 21:53:19 -0800854 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
Florin Coras4b47ee22020-11-19 13:38:26 -0800855 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
856 {
857 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
858 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
859 }
Florin Corase5f18332021-04-22 11:48:35 -0700860 if ((rv = vnet_listen (args)))
861 return rv;
Florin Coras371ca502018-02-21 12:07:41 -0800862
Florin Coras74cac882018-09-07 09:13:15 -0700863 lctx_index = tls_listener_ctx_alloc ();
Florin Corasa27a46e2019-02-18 13:02:28 -0800864 tls_al_handle = args->handle;
865 al = app_listener_get_w_handle (tls_al_handle);
866 tls_listener = app_listener_get_session (al);
Florin Coras371ca502018-02-21 12:07:41 -0800867 tls_listener->opaque = lctx_index;
Florin Coras58d36f02018-03-09 13:05:53 -0800868
Florin Coras5c9083d2018-04-13 06:39:07 -0700869 app_listener = listen_session_get (app_listener_index);
Florin Coras58d36f02018-03-09 13:05:53 -0800870
871 lctx = tls_listener_ctx_get (lctx_index);
Florin Corasdf57ea02019-02-18 20:14:20 -0800872 lctx->parent_app_wrk_index = sep->app_wrk_index;
Florin Corasa27a46e2019-02-18 13:02:28 -0800873 lctx->tls_session_handle = tls_al_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800874 lctx->app_session_handle = listen_session_get_handle (app_listener);
875 lctx->tcp_is_ip4 = sep->is_ip4;
Florin Coras58d36f02018-03-09 13:05:53 -0800876 lctx->tls_ctx_engine = engine_type;
Florin Coras4b47ee22020-11-19 13:38:26 -0800877 lctx->tls_type = sep->transport_proto;
Florin Corasa54b62d2021-04-21 09:05:56 -0700878 lctx->ckpair_index = ccfg->ckpair_index;
Florin Coras7705b492022-02-16 17:12:01 -0800879 lctx->c_s_index = app_listener_index;
Filip Tehlar61e26be2021-12-20 14:40:59 +0000880 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Coras58d36f02018-03-09 13:05:53 -0800881
Florin Corasae3eaac2019-07-23 22:38:16 -0700882 if (tls_vfts[engine_type].ctx_start_listen (lctx))
883 {
884 vnet_unlisten_args_t a = {
885 .handle = lctx->tls_session_handle,
886 .app_index = tls_main.app_index,
887 .wrk_map_index = 0
888 };
889 if ((vnet_unlisten (&a)))
890 clib_warning ("unlisten returned");
891 tls_listener_ctx_free (lctx);
892 lctx_index = SESSION_INVALID_INDEX;
893 }
Ping Yudecda5b2018-08-13 06:20:00 -0400894
Florin Coras58d36f02018-03-09 13:05:53 -0800895 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
896 engine_type);
Florin Coras371ca502018-02-21 12:07:41 -0800897 return lctx_index;
898}
899
900u32
Florin Corase3e2f072018-03-04 07:24:30 -0800901tls_stop_listen (u32 lctx_index)
Florin Coras371ca502018-02-21 12:07:41 -0800902{
Florin Corasaab06042020-02-26 02:56:14 +0000903 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200904 crypto_engine_type_t engine_type;
Florin Corasaab06042020-02-26 02:56:14 +0000905 transport_connection_t *lc;
Florin Corasb5e94e32018-09-14 14:46:39 -0700906 tls_ctx_t *lctx;
Florin Corasaab06042020-02-26 02:56:14 +0000907 session_t *ls;
Florin Corasc1a42652019-02-08 18:27:29 -0800908 int rv;
Ping Yudecda5b2018-08-13 06:20:00 -0400909
Florin Corase3e2f072018-03-04 07:24:30 -0800910 lctx = tls_listener_ctx_get (lctx_index);
Florin Corasaab06042020-02-26 02:56:14 +0000911
912 /* Cleanup listener from session lookup table */
913 ls = session_get_from_handle (lctx->tls_session_handle);
914 lc = session_get_transport (ls);
915
916 sep.fib_index = lc->fib_index;
917 sep.port = lc->lcl_port;
918 sep.is_ip4 = lc->is_ip4;
Florin Coras4b47ee22020-11-19 13:38:26 -0800919 sep.transport_proto = lctx->tls_type;
Florin Corasaab06042020-02-26 02:56:14 +0000920 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
921 session_lookup_del_session_endpoint2 (&sep);
922
Florin Corasc1a42652019-02-08 18:27:29 -0800923 vnet_unlisten_args_t a = {
Florin Corasb5e94e32018-09-14 14:46:39 -0700924 .handle = lctx->tls_session_handle,
925 .app_index = tls_main.app_index,
926 .wrk_map_index = 0 /* default wrk */
927 };
Florin Corasc1a42652019-02-08 18:27:29 -0800928 if ((rv = vnet_unlisten (&a)))
929 clib_warning ("unlisten returned %d", rv);
Florin Corasb5e94e32018-09-14 14:46:39 -0700930
Ping Yudecda5b2018-08-13 06:20:00 -0400931 engine_type = lctx->tls_ctx_engine;
932 tls_vfts[engine_type].ctx_stop_listen (lctx);
933
Florin Corase3e2f072018-03-04 07:24:30 -0800934 tls_listener_ctx_free (lctx);
Florin Coras371ca502018-02-21 12:07:41 -0800935 return 0;
936}
937
938transport_connection_t *
Florin Corase3e2f072018-03-04 07:24:30 -0800939tls_connection_get (u32 ctx_index, u32 thread_index)
940{
941 tls_ctx_t *ctx;
942 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
943 return &ctx->connection;
944}
945
946transport_connection_t *
Florin Coras371ca502018-02-21 12:07:41 -0800947tls_listener_get (u32 listener_index)
948{
949 tls_ctx_t *ctx;
950 ctx = tls_listener_ctx_get (listener_index);
951 return &ctx->connection;
952}
953
Florin Coras2c876f92021-05-10 21:12:27 -0700954static transport_connection_t *
955tls_half_open_get (u32 ho_index)
956{
Florin Coras2c876f92021-05-10 21:12:27 -0700957 tls_ctx_t *ctx;
958 ctx = tls_ctx_half_open_get (ho_index);
Florin Coras2c876f92021-05-10 21:12:27 -0700959 return &ctx->connection;
960}
961
962static void
963tls_cleanup_ho (u32 ho_index)
964{
Florin Coras2c876f92021-05-10 21:12:27 -0700965 tls_ctx_t *ctx;
Florin Coras4aaedaa2023-11-10 09:48:39 -0800966 session_t *s;
Florin Corasbab6c522021-05-13 08:36:56 -0700967
Florin Coras2c876f92021-05-10 21:12:27 -0700968 ctx = tls_ctx_half_open_get (ho_index);
Florin Corasa474bc82023-12-04 20:29:52 -0800969 /* Already pending cleanup */
970 if (ctx->tls_session_handle == SESSION_INVALID_HANDLE)
971 {
972 ASSERT (ctx->flags & TLS_CONN_F_HO_DONE);
Florin Coras4a98b932024-01-31 13:45:39 -0800973 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasa474bc82023-12-04 20:29:52 -0800974 return;
975 }
976
Florin Coras4aaedaa2023-11-10 09:48:39 -0800977 s = session_get_from_handle (ctx->tls_session_handle);
978 /* If no pending cleanup notification, force cleanup now. Otherwise,
979 * wait for cleanup notification and set no app session on ctx */
980 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
981 {
982 session_cleanup_half_open (ctx->tls_session_handle);
983 tls_ctx_half_open_free (ho_index);
984 }
985 else
Florin Coras4a98b932024-01-31 13:45:39 -0800986 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coras2c876f92021-05-10 21:12:27 -0700987}
988
Florin Corasf940f8a2019-03-06 10:44:38 -0800989int
Florin Coras9f86d222020-03-23 15:34:22 +0000990tls_custom_tx_callback (void *session, transport_send_params_t * sp)
Florin Corasf940f8a2019-03-06 10:44:38 -0800991{
Florin Coras00d7d862023-09-22 19:26:33 -0700992 session_t *as = (session_t *) session;
Florin Corasf940f8a2019-03-06 10:44:38 -0800993 tls_ctx_t *ctx;
Florin Corasbf7ce2c2019-03-06 14:44:42 -0800994
Florin Coras00d7d862023-09-22 19:26:33 -0700995 if (PREDICT_FALSE (as->session_state >= SESSION_STATE_TRANSPORT_CLOSED ||
996 as->session_state <= SESSION_STATE_ACCEPTING))
997 {
998 sp->flags |= TRANSPORT_SND_F_DESCHED;
999 return 0;
1000 }
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001001
Florin Coras00d7d862023-09-22 19:26:33 -07001002 ctx = tls_ctx_get (as->connection_index);
1003 return tls_ctx_write (ctx, as, sp);
Florin Corasf940f8a2019-03-06 10:44:38 -08001004}
1005
Florin Coras371ca502018-02-21 12:07:41 -08001006u8 *
1007format_tls_ctx (u8 * s, va_list * args)
1008{
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001009 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
Florin Coras371ca502018-02-21 12:07:41 -08001010 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
Florin Coras4b47ee22020-11-19 13:38:26 -08001011 char *proto;
Florin Coras371ca502018-02-21 12:07:41 -08001012
Florin Coras4b47ee22020-11-19 13:38:26 -08001013 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001014 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
1015 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
Florin Coras4b47ee22020-11-19 13:38:26 -08001016 s =
1017 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
1018 ctx->c_thread_index, ctx->c_s_index, proto,
1019 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
Florin Coras371ca502018-02-21 12:07:41 -08001020
Florin Coras371ca502018-02-21 12:07:41 -08001021 return s;
1022}
1023
Florin Coras0d74dd12020-01-07 19:01:26 +00001024static u8 *
1025format_tls_listener_ctx (u8 * s, va_list * args)
1026{
1027 session_t *tls_listener;
1028 app_listener_t *al;
Florin Coras0d74dd12020-01-07 19:01:26 +00001029 tls_ctx_t *ctx;
Florin Coras4b47ee22020-11-19 13:38:26 -08001030 char *proto;
Florin Coras0d74dd12020-01-07 19:01:26 +00001031
1032 ctx = va_arg (*args, tls_ctx_t *);
1033
Florin Coras4b47ee22020-11-19 13:38:26 -08001034 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
Florin Coras0d74dd12020-01-07 19:01:26 +00001035 al = app_listener_get_w_handle (ctx->tls_session_handle);
1036 tls_listener = app_listener_get_session (al);
Florin Coras4b47ee22020-11-19 13:38:26 -08001037 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
1038 ctx->c_thread_index, ctx->c_s_index, proto,
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001039 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
Florin Coras0d74dd12020-01-07 19:01:26 +00001040 tls_listener->thread_index, tls_listener->session_index);
1041
1042 return s;
1043}
1044
1045static u8 *
1046format_tls_ctx_state (u8 * s, va_list * args)
1047{
1048 tls_ctx_t *ctx;
1049 session_t *ts;
1050
1051 ctx = va_arg (*args, tls_ctx_t *);
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001052 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
Florin Coras0d74dd12020-01-07 19:01:26 +00001053 if (ts->session_state == SESSION_STATE_LISTENING)
1054 s = format (s, "%s", "LISTEN");
Florin Coras0d74dd12020-01-07 19:01:26 +00001055 else
Florin Coras681ea6d2020-04-24 16:59:49 +00001056 {
1057 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1058 s = format (s, "%s", "CLOSED");
1059 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1060 s = format (s, "%s", "APP-CLOSED");
1061 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1062 s = format (s, "%s", "CLOSING");
1063 else if (tls_ctx_handshake_is_over (ctx))
1064 s = format (s, "%s", "ESTABLISHED");
1065 else
1066 s = format (s, "%s", "HANDSHAKE");
1067 }
Florin Coras0d74dd12020-01-07 19:01:26 +00001068
1069 return s;
1070}
1071
Florin Coras371ca502018-02-21 12:07:41 -08001072u8 *
1073format_tls_connection (u8 * s, va_list * args)
1074{
1075 u32 ctx_index = va_arg (*args, u32);
1076 u32 thread_index = va_arg (*args, u32);
1077 u32 verbose = va_arg (*args, u32);
1078 tls_ctx_t *ctx;
1079
1080 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1081 if (!ctx)
1082 return s;
1083
Florin Coras7bf6ed62020-09-23 12:02:08 -07001084 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
Florin Coras371ca502018-02-21 12:07:41 -08001085 if (verbose)
1086 {
Florin Coras7bf6ed62020-09-23 12:02:08 -07001087 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1088 ctx);
Florin Coras371ca502018-02-21 12:07:41 -08001089 if (verbose > 1)
1090 s = format (s, "\n");
1091 }
1092 return s;
1093}
1094
1095u8 *
1096format_tls_listener (u8 * s, va_list * args)
1097{
1098 u32 tc_index = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +02001099 u32 __clib_unused thread_index = va_arg (*args, u32);
Florin Coras0d74dd12020-01-07 19:01:26 +00001100 u32 verbose = va_arg (*args, u32);
Florin Coras371ca502018-02-21 12:07:41 -08001101 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
Florin Coras371ca502018-02-21 12:07:41 -08001102
Florin Coras7bf6ed62020-09-23 12:02:08 -07001103 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
Florin Coras0d74dd12020-01-07 19:01:26 +00001104 if (verbose)
Florin Coras7bf6ed62020-09-23 12:02:08 -07001105 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001106 return s;
Florin Coras371ca502018-02-21 12:07:41 -08001107}
1108
1109u8 *
1110format_tls_half_open (u8 * s, va_list * args)
1111{
Florin Coras2c876f92021-05-10 21:12:27 -07001112 u32 ho_index = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +02001113 u32 __clib_unused thread_index = va_arg (*args, u32);
Florin Corasd69ef3a2023-10-02 10:41:54 -07001114 u32 __clib_unused verbose = va_arg (*args, u32);
Florin Coras2c876f92021-05-10 21:12:27 -07001115 session_t *tcp_ho;
1116 tls_ctx_t *ho_ctx;
1117
1118 ho_ctx = tls_ctx_half_open_get (ho_index);
1119
1120 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1121 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1122 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1123 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1124 tcp_ho->thread_index, tcp_ho->session_index);
1125
Florin Coras371ca502018-02-21 12:07:41 -08001126 return s;
1127}
1128
Yu Ping0b819152019-05-07 02:24:30 +08001129static void
1130tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1131 transport_endpoint_t * tep, u8 is_lcl)
1132{
1133 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
Florin Coras8074fc62024-02-20 11:24:54 -08001134 session_t *ts;
Yu Ping0b819152019-05-07 02:24:30 +08001135
Florin Coras8074fc62024-02-20 11:24:54 -08001136 ts = session_get_from_handle (ctx->tls_session_handle);
1137 if (ts && ts->session_state < SESSION_STATE_TRANSPORT_DELETED)
1138 session_get_endpoint (ts, tep, is_lcl);
Yu Ping0b819152019-05-07 02:24:30 +08001139}
1140
1141static void
1142tls_transport_listener_endpoint_get (u32 ctx_handle,
1143 transport_endpoint_t * tep, u8 is_lcl)
1144{
1145 session_t *tls_listener;
1146 app_listener_t *al;
1147 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1148
1149 al = app_listener_get_w_handle (ctx->tls_session_handle);
1150 tls_listener = app_listener_get_session (al);
1151 session_get_endpoint (tls_listener, tep, is_lcl);
1152}
1153
Florin Coras0a9ab822020-10-25 14:01:37 -07001154static clib_error_t *
1155tls_enable (vlib_main_t * vm, u8 is_en)
1156{
Florin Coras0a9ab822020-10-25 14:01:37 -07001157 vnet_app_detach_args_t _da, *da = &_da;
1158 vnet_app_attach_args_t _a, *a = &_a;
1159 u64 options[APP_OPTIONS_N_OPTIONS];
1160 tls_main_t *tm = &tls_main;
Florin Corasc1b03802023-09-30 15:21:08 -07001161 u32 fifo_size = 512 << 10;
Florin Coras0a9ab822020-10-25 14:01:37 -07001162
1163 if (!is_en)
1164 {
1165 da->app_index = tm->app_index;
1166 da->api_client_index = APP_INVALID_INDEX;
1167 vnet_application_detach (da);
1168 return 0;
1169 }
1170
Florin Coras0a9ab822020-10-25 14:01:37 -07001171 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1172
1173 clib_memset (a, 0, sizeof (*a));
1174 clib_memset (options, 0, sizeof (options));
1175
1176 a->session_cb_vft = &tls_app_cb_vft;
1177 a->api_client_index = APP_INVALID_INDEX;
1178 a->options = options;
1179 a->name = format (0, "tls");
Florin Corasa3767bd2021-11-18 15:25:31 -08001180 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1181 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
Florin Coras0a9ab822020-10-25 14:01:37 -07001182 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1183 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1184 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1185 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1186 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1187
1188 if (vnet_application_attach (a))
1189 {
1190 clib_warning ("failed to attach tls app");
1191 return clib_error_return (0, "failed to attach tls app");
1192 }
1193
1194 tm->app_index = a->app_index;
1195 vec_free (a->name);
1196
1197 return 0;
1198}
1199
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001200static const transport_proto_vft_t tls_proto = {
Florin Coras0a9ab822020-10-25 14:01:37 -07001201 .enable = tls_enable,
Florin Coras1ee78302019-02-05 15:51:15 -08001202 .connect = tls_connect,
Florin Coras371ca502018-02-21 12:07:41 -08001203 .close = tls_disconnect,
Florin Coras1ee78302019-02-05 15:51:15 -08001204 .start_listen = tls_start_listen,
1205 .stop_listen = tls_stop_listen,
Florin Corase3e2f072018-03-04 07:24:30 -08001206 .get_connection = tls_connection_get,
Florin Coras371ca502018-02-21 12:07:41 -08001207 .get_listener = tls_listener_get,
Florin Coras2c876f92021-05-10 21:12:27 -07001208 .get_half_open = tls_half_open_get,
1209 .cleanup_ho = tls_cleanup_ho,
Florin Corasf940f8a2019-03-06 10:44:38 -08001210 .custom_tx = tls_custom_tx_callback,
Florin Coras371ca502018-02-21 12:07:41 -08001211 .format_connection = format_tls_connection,
1212 .format_half_open = format_tls_half_open,
1213 .format_listener = format_tls_listener,
Yu Ping0b819152019-05-07 02:24:30 +08001214 .get_transport_endpoint = tls_transport_endpoint_get,
1215 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001216 .transport_options = {
Florin Coras07063b82020-03-13 04:44:51 +00001217 .name = "tls",
1218 .short_name = "J",
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001219 .tx_type = TRANSPORT_TX_INTERNAL,
Florin Coras2c876f92021-05-10 21:12:27 -07001220 .service_type = TRANSPORT_SERVICE_VC,
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001221 },
Florin Coras371ca502018-02-21 12:07:41 -08001222};
Florin Coras4b47ee22020-11-19 13:38:26 -08001223
1224int
1225dtls_connect (transport_endpoint_cfg_t *tep)
1226{
1227 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
Florin Corasa54b62d2021-04-21 09:05:56 -07001228 transport_endpt_crypto_cfg_t *ccfg;
Florin Coras4b47ee22020-11-19 13:38:26 -08001229 crypto_engine_type_t engine_type;
1230 session_endpoint_cfg_t *sep;
1231 tls_main_t *tm = &tls_main;
1232 app_worker_t *app_wrk;
1233 application_t *app;
1234 tls_ctx_t *ctx;
1235 u32 ctx_handle;
1236 int rv;
1237
1238 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -07001239 if (!sep->ext_cfg)
1240 return -1;
1241
Florin Coras4b47ee22020-11-19 13:38:26 -08001242 app_wrk = app_worker_get (sep->app_wrk_index);
1243 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -07001244
1245 ccfg = &sep->ext_cfg->crypto;
1246 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Florin Coras4b47ee22020-11-19 13:38:26 -08001247 if (engine_type == CRYPTO_ENGINE_NONE)
1248 {
1249 clib_warning ("No tls engine_type available");
1250 return -1;
1251 }
1252
Florin Corasfb50bc32021-05-18 00:28:59 -07001253 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1254 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
Florin Coras4b47ee22020-11-19 13:38:26 -08001255 ctx->parent_app_wrk_index = sep->app_wrk_index;
1256 ctx->parent_app_api_context = sep->opaque;
1257 ctx->tcp_is_ip4 = sep->is_ip4;
Florin Corasa54b62d2021-04-21 09:05:56 -07001258 ctx->ckpair_index = ccfg->ckpair_index;
Florin Coras4b47ee22020-11-19 13:38:26 -08001259 ctx->tls_type = sep->transport_proto;
1260 ctx->tls_ctx_handle = ctx_handle;
Florin Corasbab6c522021-05-13 08:36:56 -07001261 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1262 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasa54b62d2021-04-21 09:05:56 -07001263 if (ccfg->hostname[0])
Florin Coras4b47ee22020-11-19 13:38:26 -08001264 {
Florin Corasa54b62d2021-04-21 09:05:56 -07001265 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
Florin Coras4b47ee22020-11-19 13:38:26 -08001266 vec_terminate_c_string (ctx->srv_hostname);
1267 }
1268
Florin Coras4b47ee22020-11-19 13:38:26 -08001269 ctx->tls_ctx_engine = engine_type;
1270
1271 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1272 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1273 cargs->app_index = tm->app_index;
1274 cargs->api_context = ctx_handle;
1275 cargs->sep_ext.ns_index = app->ns_index;
1276 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1277 if ((rv = vnet_connect (cargs)))
1278 return rv;
1279
1280 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1281 engine_type);
Florin Corasbab6c522021-05-13 08:36:56 -07001282 return ctx_handle;
1283}
1284
1285static transport_connection_t *
1286dtls_half_open_get (u32 ho_index)
1287{
1288 tls_ctx_t *ho_ctx;
Florin Corasfb50bc32021-05-18 00:28:59 -07001289 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
Florin Corasbab6c522021-05-13 08:36:56 -07001290 return &ho_ctx->connection;
Florin Coras4b47ee22020-11-19 13:38:26 -08001291}
1292
1293static void
1294dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1295{
1296 /* No op */
1297}
1298
Florin Corasbab6c522021-05-13 08:36:56 -07001299static void
1300dtls_cleanup_ho (u32 ho_index)
1301{
1302 tls_ctx_t *ctx;
Florin Corasfb50bc32021-05-18 00:28:59 -07001303 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
Florin Corasbab6c522021-05-13 08:36:56 -07001304 tls_ctx_free (ctx);
1305}
1306
1307u8 *
1308format_dtls_half_open (u8 *s, va_list *args)
1309{
1310 u32 ho_index = va_arg (*args, u32);
1311 u32 __clib_unused thread_index = va_arg (*args, u32);
1312 tls_ctx_t *ho_ctx;
1313 session_t *us;
1314
Florin Corasfb50bc32021-05-18 00:28:59 -07001315 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
Florin Corasbab6c522021-05-13 08:36:56 -07001316
1317 us = session_get_from_handle (ho_ctx->tls_session_handle);
1318 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1319 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1320 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1321 us->thread_index, us->session_index);
1322
1323 return s;
1324}
1325
Florin Coras4b47ee22020-11-19 13:38:26 -08001326static const transport_proto_vft_t dtls_proto = {
1327 .enable = 0,
1328 .connect = dtls_connect,
1329 .close = tls_disconnect,
1330 .start_listen = tls_start_listen,
1331 .stop_listen = tls_stop_listen,
1332 .get_connection = tls_connection_get,
1333 .get_listener = tls_listener_get,
Florin Corasbab6c522021-05-13 08:36:56 -07001334 .get_half_open = dtls_half_open_get,
Florin Coras4b47ee22020-11-19 13:38:26 -08001335 .custom_tx = tls_custom_tx_callback,
1336 .cleanup = dtls_cleanup_callback,
Florin Corasbab6c522021-05-13 08:36:56 -07001337 .cleanup_ho = dtls_cleanup_ho,
Florin Coras4b47ee22020-11-19 13:38:26 -08001338 .format_connection = format_tls_connection,
Florin Corasbab6c522021-05-13 08:36:56 -07001339 .format_half_open = format_dtls_half_open,
Florin Coras4b47ee22020-11-19 13:38:26 -08001340 .format_listener = format_tls_listener,
1341 .get_transport_endpoint = tls_transport_endpoint_get,
1342 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1343 .transport_options = {
1344 .name = "dtls",
1345 .short_name = "D",
1346 .tx_type = TRANSPORT_TX_INTERNAL,
Florin Corasbab6c522021-05-13 08:36:56 -07001347 .service_type = TRANSPORT_SERVICE_VC,
Florin Coras4b47ee22020-11-19 13:38:26 -08001348 },
1349};
Florin Coras371ca502018-02-21 12:07:41 -08001350
Florin Corasd77eee62018-03-07 08:49:27 -08001351void
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +02001352tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
Florin Coras371ca502018-02-21 12:07:41 -08001353{
Florin Corasd77eee62018-03-07 08:49:27 -08001354 vec_validate (tls_vfts, type);
1355 tls_vfts[type] = *vft;
Florin Coras371ca502018-02-21 12:07:41 -08001356}
1357
Dave Barachcc5677b2018-03-28 19:08:45 -04001358static clib_error_t *
Florin Coras371ca502018-02-21 12:07:41 -08001359tls_init (vlib_main_t * vm)
1360{
Florin Coras58d36f02018-03-09 13:05:53 -08001361 vlib_thread_main_t *vtm = vlib_get_thread_main ();
Florin Coras371ca502018-02-21 12:07:41 -08001362 tls_main_t *tm = &tls_main;
Florin Coras0a9ab822020-10-25 14:01:37 -07001363 u32 num_threads;
Florin Coras58d36f02018-03-09 13:05:53 -08001364
1365 num_threads = 1 /* main thread */ + vtm->n_threads;
Florin Coras371ca502018-02-21 12:07:41 -08001366
Florin Corasd77eee62018-03-07 08:49:27 -08001367 if (!tm->ca_cert_path)
1368 tm->ca_cert_path = TLS_CA_CERT_PATH;
1369
Florin Coras58d36f02018-03-09 13:05:53 -08001370 vec_validate (tm->rx_bufs, num_threads - 1);
1371 vec_validate (tm->tx_bufs, num_threads - 1);
1372
Florin Corasa3767bd2021-11-18 15:25:31 -08001373 tm->first_seg_size = 32 << 20;
1374 tm->add_seg_size = 256 << 20;
1375
Florin Coras371ca502018-02-21 12:07:41 -08001376 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1377 FIB_PROTOCOL_IP4, ~0);
1378 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1379 FIB_PROTOCOL_IP6, ~0);
Florin Coras4b47ee22020-11-19 13:38:26 -08001380
1381 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1382 FIB_PROTOCOL_IP4, ~0);
1383 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1384 FIB_PROTOCOL_IP6, ~0);
Florin Coras371ca502018-02-21 12:07:41 -08001385 return 0;
1386}
1387
1388VLIB_INIT_FUNCTION (tls_init);
1389
Florin Coras8f89dd02018-03-05 16:53:07 -08001390static clib_error_t *
1391tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1392{
1393 tls_main_t *tm = &tls_main;
Dave Wallaceb1a81aa2019-10-30 17:53:56 +00001394 uword tmp;
Florin Coras8f89dd02018-03-05 16:53:07 -08001395 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1396 {
1397 if (unformat (input, "use-test-cert-in-ca"))
1398 tm->use_test_cert_in_ca = 1;
1399 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1400 ;
Florin Corasddd98f32019-03-25 08:30:53 -07001401 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1402 &tm->first_seg_size))
1403 ;
Florin Corasa3767bd2021-11-18 15:25:31 -08001404 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1405 &tm->add_seg_size))
1406 ;
Dave Wallaceb1a81aa2019-10-30 17:53:56 +00001407 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1408 {
1409 if (tmp >= 0x100000000ULL)
1410 {
1411 return clib_error_return
1412 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1413 }
1414 tm->fifo_size = tmp;
1415 }
Florin Coras8f89dd02018-03-05 16:53:07 -08001416 else
1417 return clib_error_return (0, "unknown input `%U'",
1418 format_unformat_error, input);
1419 }
1420 return 0;
1421}
1422
Florin Coras1cbcdce2022-04-06 15:10:13 -07001423VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
Florin Corasd77eee62018-03-07 08:49:27 -08001424
1425tls_main_t *
1426vnet_tls_get_main (void)
1427{
1428 return &tls_main;
1429}
1430
Florin Coras371ca502018-02-21 12:07:41 -08001431/*
1432 * fd.io coding-style-patch-verification: ON
1433 *
1434 * Local Variables:
1435 * eval: (c-set-style "gnu")
1436 * End:
1437 */