blob: 996c20f28291f4db01983f2dbed48f9b2e0bcc81 [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 Coras288eaab2019-02-03 15:26:14 -0800489tls_session_accept_callback (session_t * tls_session)
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
Nathan Skrzypczak2f0f96b2019-06-13 10:14:28 +0200495 tls_listener =
496 listen_session_get_from_handle (tls_session->listener_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800497 lctx = tls_listener_ctx_get (tls_listener->opaque);
Florin Coras58d36f02018-03-09 13:05:53 -0800498
499 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
500 ctx = tls_ctx_get (ctx_handle);
Florin Coras60732df2024-02-23 18:01:45 -0800501 clib_memcpy (ctx, lctx, sizeof (*lctx));
Florin Coras371ca502018-02-21 12:07:41 -0800502 ctx->c_thread_index = vlib_get_thread_index ();
Florin Coras58d36f02018-03-09 13:05:53 -0800503 ctx->tls_ctx_handle = ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800504 tls_session->session_state = SESSION_STATE_READY;
Florin Coras58d36f02018-03-09 13:05:53 -0800505 tls_session->opaque = ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800506 ctx->tls_session_handle = session_handle (tls_session);
507 ctx->listener_ctx_index = tls_listener->opaque;
Florin Corasd09236d2019-08-08 17:38:26 -0700508 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200509 ctx->ckpair_index = lctx->ckpair_index;
Florin Coras371ca502018-02-21 12:07:41 -0800510
Florin Coras58d36f02018-03-09 13:05:53 -0800511 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
512 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800513
Florin Coras14bfd3d2023-11-08 19:57:38 -0800514 if (tls_ctx_init_server (ctx))
Xiaoming Jiang47781642023-05-26 00:32:25 +0000515 {
Florin Coras14bfd3d2023-11-08 19:57:38 -0800516 /* Do not free ctx yet, in case we have pending rx events */
Florin Coras4a98b932024-01-31 13:45:39 -0800517 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coras14bfd3d2023-11-08 19:57:38 -0800518 tls_disconnect_transport (ctx);
Xiaoming Jiang47781642023-05-26 00:32:25 +0000519 }
520
Florin Coras14bfd3d2023-11-08 19:57:38 -0800521 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800522}
523
524int
Florin Corascfc2a0e2023-11-08 14:14:17 -0800525tls_app_rx_callback (session_t *ts)
Florin Coras371ca502018-02-21 12:07:41 -0800526{
Florin Coras371ca502018-02-21 12:07:41 -0800527 tls_ctx_t *ctx;
Florin Coras371ca502018-02-21 12:07:41 -0800528
Florin Coras4b47ee22020-11-19 13:38:26 -0800529 /* DTLS session migrating, wait for next notification */
Florin Corascfc2a0e2023-11-08 14:14:17 -0800530 if (PREDICT_FALSE (ts->flags & SESSION_F_IS_MIGRATING))
Florin Coras4b47ee22020-11-19 13:38:26 -0800531 return 0;
532
Florin Corascfc2a0e2023-11-08 14:14:17 -0800533 /* Read rescheduled but underlying transport deleted now */
534 if (PREDICT_FALSE ((ts->session_state == SESSION_STATE_TRANSPORT_DELETED)))
535 return 0;
536
537 ctx = tls_ctx_get (ts->opaque);
Florin Coras4a98b932024-01-31 13:45:39 -0800538 if (PREDICT_FALSE ((ctx->flags & TLS_CONN_F_NO_APP_SESSION) ||
539 (ctx->flags & TLS_CONN_F_APP_CLOSED)))
Saravanan Murugesan3683d1b2022-02-28 10:55:26 +0530540 {
541 TLS_DBG (1, "Local App closed");
542 return 0;
543 }
Florin Corascfc2a0e2023-11-08 14:14:17 -0800544 tls_ctx_read (ctx, ts);
Florin Coras58d36f02018-03-09 13:05:53 -0800545 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800546}
547
548int
Florin Coras9f86d222020-03-23 15:34:22 +0000549tls_app_tx_callback (session_t * tls_session)
550{
551 tls_ctx_t *ctx;
552
553 ctx = tls_ctx_get (tls_session->opaque);
554 transport_connection_reschedule (&ctx->connection);
555
556 return 0;
557}
558
559int
Florin Coras4b47ee22020-11-19 13:38:26 -0800560tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
561 session_t *tls_session, session_error_t err)
Florin Coras371ca502018-02-21 12:07:41 -0800562{
Florin Coras371ca502018-02-21 12:07:41 -0800563 tls_ctx_t *ho_ctx, *ctx;
Florin Coras58d36f02018-03-09 13:05:53 -0800564 u32 ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800565
566 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
Florin Coras371ca502018-02-21 12:07:41 -0800567
Florin Coras58d36f02018-03-09 13:05:53 -0800568 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
569 ctx = tls_ctx_get (ctx_handle);
Dave Barach178cf492018-11-13 16:34:13 -0500570 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
Florin Coras0ded4892024-02-13 15:37:20 -0500571
Florin Coras2c876f92021-05-10 21:12:27 -0700572 /* Half-open freed on tcp half-open cleanup notification */
Florin Coras0ded4892024-02-13 15:37:20 -0500573 __atomic_fetch_or (&ho_ctx->flags, TLS_CONN_F_HO_DONE, __ATOMIC_RELEASE);
Florin Coras371ca502018-02-21 12:07:41 -0800574
Florin Corasdcde9272018-03-02 09:23:42 -0800575 ctx->c_thread_index = vlib_get_thread_index ();
Florin Coras58d36f02018-03-09 13:05:53 -0800576 ctx->tls_ctx_handle = ctx_handle;
Florin Corasd09236d2019-08-08 17:38:26 -0700577 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasdcde9272018-03-02 09:23:42 -0800578
Florin Coras58d36f02018-03-09 13:05:53 -0800579 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
Florin Coras4b47ee22020-11-19 13:38:26 -0800580 ho_ctx_index, err, vlib_get_thread_index (),
Florin Coras58d36f02018-03-09 13:05:53 -0800581 (ctx) ? ctx_handle : ~0);
Florin Coras371ca502018-02-21 12:07:41 -0800582
583 ctx->tls_session_handle = session_handle (tls_session);
Florin Coras58d36f02018-03-09 13:05:53 -0800584 tls_session->opaque = ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800585
Florin Coras14bfd3d2023-11-08 19:57:38 -0800586 if (tls_ctx_init_client (ctx))
Xiaoming Jiang47781642023-05-26 00:32:25 +0000587 {
Florin Coras14bfd3d2023-11-08 19:57:38 -0800588 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
589 tls_disconnect_transport (ctx);
Xiaoming Jiang47781642023-05-26 00:32:25 +0000590 }
591
Florin Corasa8d266a2024-03-22 14:47:16 -0700592 if (tls_session->session_state < SESSION_STATE_READY)
593 tls_session->session_state = SESSION_STATE_READY;
594
Florin Coras14bfd3d2023-11-08 19:57:38 -0800595 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800596}
597
Florin Coras4b47ee22020-11-19 13:38:26 -0800598int
599dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
600 session_error_t err)
601{
602 tls_ctx_t *ctx;
603
Florin Corasfb50bc32021-05-18 00:28:59 -0700604 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
Florin Coras4b47ee22020-11-19 13:38:26 -0800605
606 ctx->tls_session_handle = session_handle (us);
607 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
608 us->opaque = ctx_handle;
609
610 /* We don't preallocate the app session because the udp session might
611 * actually migrate to a different worker at the end of the handshake */
612
613 return tls_ctx_init_client (ctx);
614}
615
616int
617tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
618 session_t *tls_session, session_error_t err)
619{
Florin Coras71ee3752021-05-28 18:29:08 -0700620 if (err)
621 {
622 app_worker_t *app_wrk;
623 tls_ctx_t *ho_ctx;
624 u32 api_context;
625
626 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
Florin Corasa474bc82023-12-04 20:29:52 -0800627 ho_ctx->flags |= TLS_CONN_F_HO_DONE;
Florin Coras71ee3752021-05-28 18:29:08 -0700628 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
629 if (app_wrk)
630 {
631 api_context = ho_ctx->parent_app_api_context;
632 app_worker_connect_notify (app_wrk, 0, err, api_context);
633 }
Florin Coras71ee3752021-05-28 18:29:08 -0700634
635 return 0;
636 }
637
Florin Coras4b47ee22020-11-19 13:38:26 -0800638 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
639 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
640 err);
641 else
642 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
643 err);
644}
645
Florin Corasef2b3352019-08-07 11:14:56 -0700646static void
647tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
648{
649 tls_ctx_t *ctx;
650
651 if (ntf == SESSION_CLEANUP_TRANSPORT)
Florin Coras36d49392020-04-24 23:00:11 +0000652 {
653 /* Allow cleanup of tcp session */
654 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
655 session_close (s);
656 return;
657 }
Florin Corasef2b3352019-08-07 11:14:56 -0700658
659 ctx = tls_ctx_get (s->opaque);
Florin Coras4a98b932024-01-31 13:45:39 -0800660 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
Florin Corasef2b3352019-08-07 11:14:56 -0700661 session_transport_delete_notify (&ctx->connection);
662 tls_ctx_free (ctx);
663}
664
Florin Coras4b47ee22020-11-19 13:38:26 -0800665static void
Florin Coras88dd3cf2021-05-01 19:01:42 -0700666dtls_migrate_ctx (void *arg)
Florin Coras4b47ee22020-11-19 13:38:26 -0800667{
668 tls_ctx_t *ctx = (tls_ctx_t *) arg;
669 u32 ctx_handle, thread_index;
670 session_t *us;
671
672 thread_index = session_thread_from_handle (ctx->tls_session_handle);
673 ASSERT (thread_index == vlib_get_thread_index ());
674
675 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
676 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
677 ctx->tls_ctx_handle = ctx_handle;
678
679 us = session_get_from_handle (ctx->tls_session_handle);
680 us->opaque = ctx_handle;
681 us->flags &= ~SESSION_F_IS_MIGRATING;
Florin Corasbab6c522021-05-13 08:36:56 -0700682
683 /* Probably the app detached while the session was migrating. Cleanup */
684 if (session_half_open_migrated_notify (&ctx->connection))
685 {
Florin Coras4a98b932024-01-31 13:45:39 -0800686 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasbab6c522021-05-13 08:36:56 -0700687 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
688 return;
689 }
690
Florin Coras4b47ee22020-11-19 13:38:26 -0800691 if (svm_fifo_max_dequeue (us->tx_fifo))
692 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
693}
694
695static void
696dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
697{
698 u32 new_thread = session_thread_from_handle (new_sh);
Florin Coras88dd3cf2021-05-01 19:01:42 -0700699 tls_ctx_t *ctx, *cloned_ctx;
Florin Coras4b47ee22020-11-19 13:38:26 -0800700
701 /* Migrate dtls context to new thread */
702 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
703 ctx->tls_session_handle = new_sh;
Florin Coras88dd3cf2021-05-01 19:01:42 -0700704 cloned_ctx = tls_ctx_detach (ctx);
Florin Coras4a98b932024-01-31 13:45:39 -0800705 ctx->flags |= TLS_CONN_F_MIGRATED;
Florin Corasbab6c522021-05-13 08:36:56 -0700706 session_half_open_migrate_notify (&ctx->connection);
Florin Coras4b47ee22020-11-19 13:38:26 -0800707
Florin Coras88dd3cf2021-05-01 19:01:42 -0700708 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
709 (void *) cloned_ctx);
710
711 tls_ctx_free (ctx);
Florin Coras4b47ee22020-11-19 13:38:26 -0800712}
713
Florin Corascfc2a0e2023-11-08 14:14:17 -0800714static void
715tls_session_transport_closed_callback (session_t *ts)
716{
717 tls_ctx_t *ctx;
718
719 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
Florin Coras4a98b932024-01-31 13:45:39 -0800720 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
Florin Coras86b02c72023-12-13 14:26:19 -0800721 session_transport_closed_notify (&ctx->connection);
Florin Corascfc2a0e2023-11-08 14:14:17 -0800722}
723
Florin Coras371ca502018-02-21 12:07:41 -0800724static session_cb_vft_t tls_app_cb_vft = {
725 .session_accept_callback = tls_session_accept_callback,
726 .session_disconnect_callback = tls_session_disconnect_callback,
727 .session_connected_callback = tls_session_connected_callback,
728 .session_reset_callback = tls_session_reset_callback,
Florin Corascfc2a0e2023-11-08 14:14:17 -0800729 .session_transport_closed_callback = tls_session_transport_closed_callback,
Florin Coras2c876f92021-05-10 21:12:27 -0700730 .half_open_cleanup_callback = tls_session_cleanup_ho,
Florin Coras371ca502018-02-21 12:07:41 -0800731 .add_segment_callback = tls_add_segment_callback,
732 .del_segment_callback = tls_del_segment_callback,
733 .builtin_app_rx_callback = tls_app_rx_callback,
Florin Coras9f86d222020-03-23 15:34:22 +0000734 .builtin_app_tx_callback = tls_app_tx_callback,
Florin Coras4b47ee22020-11-19 13:38:26 -0800735 .session_migrate_callback = dtls_session_migrate_callback,
Florin Corasef2b3352019-08-07 11:14:56 -0700736 .session_cleanup_callback = tls_app_session_cleanup,
Florin Coras371ca502018-02-21 12:07:41 -0800737};
Florin Coras371ca502018-02-21 12:07:41 -0800738
739int
Florin Coras5665ced2018-10-25 18:03:45 -0700740tls_connect (transport_endpoint_cfg_t * tep)
Florin Coras371ca502018-02-21 12:07:41 -0800741{
Florin Coras15531972018-08-12 23:50:53 -0700742 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
Florin Corasa54b62d2021-04-21 09:05:56 -0700743 transport_endpt_crypto_cfg_t *ccfg;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200744 crypto_engine_type_t engine_type;
Florin Coras4b47ee22020-11-19 13:38:26 -0800745 session_endpoint_cfg_t *sep;
Florin Coras371ca502018-02-21 12:07:41 -0800746 tls_main_t *tm = &tls_main;
Florin Coras15531972018-08-12 23:50:53 -0700747 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800748 application_t *app;
749 tls_ctx_t *ctx;
750 u32 ctx_index;
Florin Corasc1a42652019-02-08 18:27:29 -0800751 int rv;
Florin Coras371ca502018-02-21 12:07:41 -0800752
Florin Coras5665ced2018-10-25 18:03:45 -0700753 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -0700754 if (!sep->ext_cfg)
Florin Corase5f18332021-04-22 11:48:35 -0700755 return SESSION_E_NOEXTCFG;
Florin Corasa54b62d2021-04-21 09:05:56 -0700756
Florin Coras15531972018-08-12 23:50:53 -0700757 app_wrk = app_worker_get (sep->app_wrk_index);
758 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -0700759
760 ccfg = &sep->ext_cfg->crypto;
761 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200762 if (engine_type == CRYPTO_ENGINE_NONE)
Florin Coras58d36f02018-03-09 13:05:53 -0800763 {
764 clib_warning ("No tls engine_type available");
Florin Corase5f18332021-04-22 11:48:35 -0700765 return SESSION_E_NOCRYPTOENG;
Florin Coras58d36f02018-03-09 13:05:53 -0800766 }
Florin Coras371ca502018-02-21 12:07:41 -0800767
768 ctx_index = tls_ctx_half_open_alloc ();
769 ctx = tls_ctx_half_open_get (ctx_index);
Florin Corasdf57ea02019-02-18 20:14:20 -0800770 ctx->parent_app_wrk_index = sep->app_wrk_index;
Florin Coras371ca502018-02-21 12:07:41 -0800771 ctx->parent_app_api_context = sep->opaque;
772 ctx->tcp_is_ip4 = sep->is_ip4;
Florin Coras4b47ee22020-11-19 13:38:26 -0800773 ctx->tls_type = sep->transport_proto;
Florin Corasa54b62d2021-04-21 09:05:56 -0700774 ctx->ckpair_index = ccfg->ckpair_index;
Florin Coras2c876f92021-05-10 21:12:27 -0700775 ctx->c_proto = TRANSPORT_PROTO_TLS;
776 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasa54b62d2021-04-21 09:05:56 -0700777 if (ccfg->hostname[0])
Florin Coras8f89dd02018-03-05 16:53:07 -0800778 {
Florin Corasa54b62d2021-04-21 09:05:56 -0700779 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
Florin Coras8f89dd02018-03-05 16:53:07 -0800780 vec_terminate_c_string (ctx->srv_hostname);
781 }
Florin Coras371ca502018-02-21 12:07:41 -0800782
Florin Coras58d36f02018-03-09 13:05:53 -0800783 ctx->tls_ctx_engine = engine_type;
Florin Coras371ca502018-02-21 12:07:41 -0800784
Dave Barach178cf492018-11-13 16:34:13 -0500785 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
Florin Coras15531972018-08-12 23:50:53 -0700786 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
787 cargs->app_index = tm->app_index;
788 cargs->api_context = ctx_index;
Florin Coras8a140612019-02-18 22:39:39 -0800789 cargs->sep_ext.ns_index = app->ns_index;
Florin Corasc1a42652019-02-08 18:27:29 -0800790 if ((rv = vnet_connect (cargs)))
Florin Coras3109d1c2024-01-22 18:27:43 -0800791 {
792 tls_ctx_half_open_free (ctx_index);
793 return rv;
794 }
Florin Coras371ca502018-02-21 12:07:41 -0800795
Florin Coras2c876f92021-05-10 21:12:27 -0700796 /* Track half-open tcp session in case we need to clean it up */
797 ctx->tls_session_handle = cargs->sh;
798
Florin Coras58d36f02018-03-09 13:05:53 -0800799 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
Florin Coras2c876f92021-05-10 21:12:27 -0700800 return ctx_index;
Florin Coras371ca502018-02-21 12:07:41 -0800801}
802
803void
Florin Coras58d36f02018-03-09 13:05:53 -0800804tls_disconnect (u32 ctx_handle, u32 thread_index)
Florin Coras371ca502018-02-21 12:07:41 -0800805{
Florin Coras371ca502018-02-21 12:07:41 -0800806 tls_ctx_t *ctx;
807
Florin Coras58d36f02018-03-09 13:05:53 -0800808 TLS_DBG (1, "Disconnecting %x", ctx_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800809
Florin Coras58d36f02018-03-09 13:05:53 -0800810 ctx = tls_ctx_get (ctx_handle);
Florin Corasd7f17a22024-01-31 16:18:17 -0800811 ctx->flags |= TLS_CONN_F_APP_CLOSED;
Florin Coras06a6a302019-04-17 14:19:12 -0700812 tls_ctx_app_close (ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800813}
814
815u32
Florin Coras0bce71e2022-02-10 11:57:06 -0800816tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
Florin Coras371ca502018-02-21 12:07:41 -0800817{
Florin Corasc9940fc2019-02-05 20:55:11 -0800818 vnet_listen_args_t _bargs, *args = &_bargs;
Florin Corasa54b62d2021-04-21 09:05:56 -0700819 transport_endpt_crypto_cfg_t *ccfg;
Florin Corasab2f6db2018-08-31 14:31:41 -0700820 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800821 tls_main_t *tm = &tls_main;
Florin Corasa27a46e2019-02-18 13:02:28 -0800822 session_handle_t tls_al_handle;
Florin Coras5665ced2018-10-25 18:03:45 -0700823 session_endpoint_cfg_t *sep;
Florin Coras288eaab2019-02-03 15:26:14 -0800824 session_t *tls_listener;
825 session_t *app_listener;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200826 crypto_engine_type_t engine_type;
Florin Coras74cac882018-09-07 09:13:15 -0700827 application_t *app;
Florin Corasa27a46e2019-02-18 13:02:28 -0800828 app_listener_t *al;
Florin Coras15531972018-08-12 23:50:53 -0700829 tls_ctx_t *lctx;
830 u32 lctx_index;
Florin Corase5f18332021-04-22 11:48:35 -0700831 int rv;
Florin Coras371ca502018-02-21 12:07:41 -0800832
Florin Coras5665ced2018-10-25 18:03:45 -0700833 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -0700834 if (!sep->ext_cfg)
Florin Corase5f18332021-04-22 11:48:35 -0700835 return SESSION_E_NOEXTCFG;
Florin Corasa54b62d2021-04-21 09:05:56 -0700836
Florin Coras15531972018-08-12 23:50:53 -0700837 app_wrk = app_worker_get (sep->app_wrk_index);
838 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -0700839
840 ccfg = &sep->ext_cfg->crypto;
841 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200842 if (engine_type == CRYPTO_ENGINE_NONE)
Florin Coras58d36f02018-03-09 13:05:53 -0800843 {
844 clib_warning ("No tls engine_type available");
Florin Corase5f18332021-04-22 11:48:35 -0700845 return SESSION_E_NOCRYPTOENG;
Florin Coras58d36f02018-03-09 13:05:53 -0800846 }
847
Dave Barachb7b92992018-10-17 10:38:51 -0400848 clib_memset (args, 0, sizeof (*args));
Florin Coras74cac882018-09-07 09:13:15 -0700849 args->app_index = tm->app_index;
850 args->sep_ext = *sep;
Florin Coras8a140612019-02-18 22:39:39 -0800851 args->sep_ext.ns_index = app->ns_index;
Florin Coras95cd8642019-12-30 21:53:19 -0800852 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
Florin Coras4b47ee22020-11-19 13:38:26 -0800853 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
854 {
855 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
856 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
857 }
Florin Corase5f18332021-04-22 11:48:35 -0700858 if ((rv = vnet_listen (args)))
859 return rv;
Florin Coras371ca502018-02-21 12:07:41 -0800860
Florin Coras74cac882018-09-07 09:13:15 -0700861 lctx_index = tls_listener_ctx_alloc ();
Florin Corasa27a46e2019-02-18 13:02:28 -0800862 tls_al_handle = args->handle;
863 al = app_listener_get_w_handle (tls_al_handle);
864 tls_listener = app_listener_get_session (al);
Florin Coras371ca502018-02-21 12:07:41 -0800865 tls_listener->opaque = lctx_index;
Florin Coras58d36f02018-03-09 13:05:53 -0800866
Florin Coras5c9083d2018-04-13 06:39:07 -0700867 app_listener = listen_session_get (app_listener_index);
Florin Coras58d36f02018-03-09 13:05:53 -0800868
869 lctx = tls_listener_ctx_get (lctx_index);
Florin Corasdf57ea02019-02-18 20:14:20 -0800870 lctx->parent_app_wrk_index = sep->app_wrk_index;
Florin Corasa27a46e2019-02-18 13:02:28 -0800871 lctx->tls_session_handle = tls_al_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800872 lctx->app_session_handle = listen_session_get_handle (app_listener);
873 lctx->tcp_is_ip4 = sep->is_ip4;
Florin Coras58d36f02018-03-09 13:05:53 -0800874 lctx->tls_ctx_engine = engine_type;
Florin Coras4b47ee22020-11-19 13:38:26 -0800875 lctx->tls_type = sep->transport_proto;
Florin Corasa54b62d2021-04-21 09:05:56 -0700876 lctx->ckpair_index = ccfg->ckpair_index;
Florin Coras7705b492022-02-16 17:12:01 -0800877 lctx->c_s_index = app_listener_index;
Filip Tehlar61e26be2021-12-20 14:40:59 +0000878 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Coras58d36f02018-03-09 13:05:53 -0800879
Florin Corasae3eaac2019-07-23 22:38:16 -0700880 if (tls_vfts[engine_type].ctx_start_listen (lctx))
881 {
882 vnet_unlisten_args_t a = {
883 .handle = lctx->tls_session_handle,
884 .app_index = tls_main.app_index,
885 .wrk_map_index = 0
886 };
887 if ((vnet_unlisten (&a)))
888 clib_warning ("unlisten returned");
889 tls_listener_ctx_free (lctx);
890 lctx_index = SESSION_INVALID_INDEX;
891 }
Ping Yudecda5b2018-08-13 06:20:00 -0400892
Florin Coras58d36f02018-03-09 13:05:53 -0800893 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
894 engine_type);
Florin Coras371ca502018-02-21 12:07:41 -0800895 return lctx_index;
896}
897
898u32
Florin Corase3e2f072018-03-04 07:24:30 -0800899tls_stop_listen (u32 lctx_index)
Florin Coras371ca502018-02-21 12:07:41 -0800900{
Florin Corasaab06042020-02-26 02:56:14 +0000901 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200902 crypto_engine_type_t engine_type;
Florin Corasaab06042020-02-26 02:56:14 +0000903 transport_connection_t *lc;
Florin Corasb5e94e32018-09-14 14:46:39 -0700904 tls_ctx_t *lctx;
Florin Corasaab06042020-02-26 02:56:14 +0000905 session_t *ls;
Florin Corasc1a42652019-02-08 18:27:29 -0800906 int rv;
Ping Yudecda5b2018-08-13 06:20:00 -0400907
Florin Corase3e2f072018-03-04 07:24:30 -0800908 lctx = tls_listener_ctx_get (lctx_index);
Florin Corasaab06042020-02-26 02:56:14 +0000909
910 /* Cleanup listener from session lookup table */
911 ls = session_get_from_handle (lctx->tls_session_handle);
912 lc = session_get_transport (ls);
913
914 sep.fib_index = lc->fib_index;
915 sep.port = lc->lcl_port;
916 sep.is_ip4 = lc->is_ip4;
Florin Coras4b47ee22020-11-19 13:38:26 -0800917 sep.transport_proto = lctx->tls_type;
Florin Corasaab06042020-02-26 02:56:14 +0000918 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
919 session_lookup_del_session_endpoint2 (&sep);
920
Florin Corasc1a42652019-02-08 18:27:29 -0800921 vnet_unlisten_args_t a = {
Florin Corasb5e94e32018-09-14 14:46:39 -0700922 .handle = lctx->tls_session_handle,
923 .app_index = tls_main.app_index,
924 .wrk_map_index = 0 /* default wrk */
925 };
Florin Corasc1a42652019-02-08 18:27:29 -0800926 if ((rv = vnet_unlisten (&a)))
927 clib_warning ("unlisten returned %d", rv);
Florin Corasb5e94e32018-09-14 14:46:39 -0700928
Ping Yudecda5b2018-08-13 06:20:00 -0400929 engine_type = lctx->tls_ctx_engine;
930 tls_vfts[engine_type].ctx_stop_listen (lctx);
931
Florin Corase3e2f072018-03-04 07:24:30 -0800932 tls_listener_ctx_free (lctx);
Florin Coras371ca502018-02-21 12:07:41 -0800933 return 0;
934}
935
936transport_connection_t *
Florin Corase3e2f072018-03-04 07:24:30 -0800937tls_connection_get (u32 ctx_index, u32 thread_index)
938{
939 tls_ctx_t *ctx;
940 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
941 return &ctx->connection;
942}
943
944transport_connection_t *
Florin Coras371ca502018-02-21 12:07:41 -0800945tls_listener_get (u32 listener_index)
946{
947 tls_ctx_t *ctx;
948 ctx = tls_listener_ctx_get (listener_index);
949 return &ctx->connection;
950}
951
Florin Coras2c876f92021-05-10 21:12:27 -0700952static transport_connection_t *
953tls_half_open_get (u32 ho_index)
954{
Florin Coras2c876f92021-05-10 21:12:27 -0700955 tls_ctx_t *ctx;
956 ctx = tls_ctx_half_open_get (ho_index);
Florin Coras2c876f92021-05-10 21:12:27 -0700957 return &ctx->connection;
958}
959
960static void
961tls_cleanup_ho (u32 ho_index)
962{
Florin Coras2c876f92021-05-10 21:12:27 -0700963 tls_ctx_t *ctx;
Florin Coras4aaedaa2023-11-10 09:48:39 -0800964 session_t *s;
Florin Corasbab6c522021-05-13 08:36:56 -0700965
Florin Coras2c876f92021-05-10 21:12:27 -0700966 ctx = tls_ctx_half_open_get (ho_index);
Florin Corasa474bc82023-12-04 20:29:52 -0800967 /* Already pending cleanup */
968 if (ctx->tls_session_handle == SESSION_INVALID_HANDLE)
969 {
970 ASSERT (ctx->flags & TLS_CONN_F_HO_DONE);
Florin Coras4a98b932024-01-31 13:45:39 -0800971 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasa474bc82023-12-04 20:29:52 -0800972 return;
973 }
974
Florin Coras4aaedaa2023-11-10 09:48:39 -0800975 s = session_get_from_handle (ctx->tls_session_handle);
976 /* If no pending cleanup notification, force cleanup now. Otherwise,
977 * wait for cleanup notification and set no app session on ctx */
978 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
979 {
980 session_cleanup_half_open (ctx->tls_session_handle);
981 tls_ctx_half_open_free (ho_index);
982 }
983 else
Florin Coras4a98b932024-01-31 13:45:39 -0800984 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coras2c876f92021-05-10 21:12:27 -0700985}
986
Florin Corasf940f8a2019-03-06 10:44:38 -0800987int
Florin Coras9f86d222020-03-23 15:34:22 +0000988tls_custom_tx_callback (void *session, transport_send_params_t * sp)
Florin Corasf940f8a2019-03-06 10:44:38 -0800989{
Florin Coras00d7d862023-09-22 19:26:33 -0700990 session_t *as = (session_t *) session;
Florin Corasf940f8a2019-03-06 10:44:38 -0800991 tls_ctx_t *ctx;
Florin Corasbf7ce2c2019-03-06 14:44:42 -0800992
Florin Coras00d7d862023-09-22 19:26:33 -0700993 if (PREDICT_FALSE (as->session_state >= SESSION_STATE_TRANSPORT_CLOSED ||
994 as->session_state <= SESSION_STATE_ACCEPTING))
995 {
996 sp->flags |= TRANSPORT_SND_F_DESCHED;
997 return 0;
998 }
Florin Corasbf7ce2c2019-03-06 14:44:42 -0800999
Florin Coras00d7d862023-09-22 19:26:33 -07001000 ctx = tls_ctx_get (as->connection_index);
1001 return tls_ctx_write (ctx, as, sp);
Florin Corasf940f8a2019-03-06 10:44:38 -08001002}
1003
Florin Coras371ca502018-02-21 12:07:41 -08001004u8 *
1005format_tls_ctx (u8 * s, va_list * args)
1006{
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001007 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
Florin Coras371ca502018-02-21 12:07:41 -08001008 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
Florin Coras4b47ee22020-11-19 13:38:26 -08001009 char *proto;
Florin Coras371ca502018-02-21 12:07:41 -08001010
Florin Coras4b47ee22020-11-19 13:38:26 -08001011 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001012 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
1013 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
Florin Coras4b47ee22020-11-19 13:38:26 -08001014 s =
1015 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
1016 ctx->c_thread_index, ctx->c_s_index, proto,
1017 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
Florin Coras371ca502018-02-21 12:07:41 -08001018
Florin Coras371ca502018-02-21 12:07:41 -08001019 return s;
1020}
1021
Florin Coras0d74dd12020-01-07 19:01:26 +00001022static u8 *
1023format_tls_listener_ctx (u8 * s, va_list * args)
1024{
1025 session_t *tls_listener;
1026 app_listener_t *al;
Florin Coras0d74dd12020-01-07 19:01:26 +00001027 tls_ctx_t *ctx;
Florin Coras4b47ee22020-11-19 13:38:26 -08001028 char *proto;
Florin Coras0d74dd12020-01-07 19:01:26 +00001029
1030 ctx = va_arg (*args, tls_ctx_t *);
1031
Florin Coras4b47ee22020-11-19 13:38:26 -08001032 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
Florin Coras0d74dd12020-01-07 19:01:26 +00001033 al = app_listener_get_w_handle (ctx->tls_session_handle);
1034 tls_listener = app_listener_get_session (al);
Florin Coras4b47ee22020-11-19 13:38:26 -08001035 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
1036 ctx->c_thread_index, ctx->c_s_index, proto,
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001037 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
Florin Coras0d74dd12020-01-07 19:01:26 +00001038 tls_listener->thread_index, tls_listener->session_index);
1039
1040 return s;
1041}
1042
1043static u8 *
1044format_tls_ctx_state (u8 * s, va_list * args)
1045{
1046 tls_ctx_t *ctx;
1047 session_t *ts;
1048
1049 ctx = va_arg (*args, tls_ctx_t *);
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001050 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
Florin Coras0d74dd12020-01-07 19:01:26 +00001051 if (ts->session_state == SESSION_STATE_LISTENING)
1052 s = format (s, "%s", "LISTEN");
Florin Coras0d74dd12020-01-07 19:01:26 +00001053 else
Florin Coras681ea6d2020-04-24 16:59:49 +00001054 {
1055 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1056 s = format (s, "%s", "CLOSED");
1057 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1058 s = format (s, "%s", "APP-CLOSED");
1059 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1060 s = format (s, "%s", "CLOSING");
1061 else if (tls_ctx_handshake_is_over (ctx))
1062 s = format (s, "%s", "ESTABLISHED");
1063 else
1064 s = format (s, "%s", "HANDSHAKE");
1065 }
Florin Coras0d74dd12020-01-07 19:01:26 +00001066
1067 return s;
1068}
1069
Florin Coras371ca502018-02-21 12:07:41 -08001070u8 *
1071format_tls_connection (u8 * s, va_list * args)
1072{
1073 u32 ctx_index = va_arg (*args, u32);
1074 u32 thread_index = va_arg (*args, u32);
1075 u32 verbose = va_arg (*args, u32);
1076 tls_ctx_t *ctx;
1077
1078 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1079 if (!ctx)
1080 return s;
1081
Florin Coras7bf6ed62020-09-23 12:02:08 -07001082 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
Florin Coras371ca502018-02-21 12:07:41 -08001083 if (verbose)
1084 {
Florin Coras7bf6ed62020-09-23 12:02:08 -07001085 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1086 ctx);
Florin Coras371ca502018-02-21 12:07:41 -08001087 if (verbose > 1)
1088 s = format (s, "\n");
1089 }
1090 return s;
1091}
1092
1093u8 *
1094format_tls_listener (u8 * s, va_list * args)
1095{
1096 u32 tc_index = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +02001097 u32 __clib_unused thread_index = va_arg (*args, u32);
Florin Coras0d74dd12020-01-07 19:01:26 +00001098 u32 verbose = va_arg (*args, u32);
Florin Coras371ca502018-02-21 12:07:41 -08001099 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
Florin Coras371ca502018-02-21 12:07:41 -08001100
Florin Coras7bf6ed62020-09-23 12:02:08 -07001101 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
Florin Coras0d74dd12020-01-07 19:01:26 +00001102 if (verbose)
Florin Coras7bf6ed62020-09-23 12:02:08 -07001103 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001104 return s;
Florin Coras371ca502018-02-21 12:07:41 -08001105}
1106
1107u8 *
1108format_tls_half_open (u8 * s, va_list * args)
1109{
Florin Coras2c876f92021-05-10 21:12:27 -07001110 u32 ho_index = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +02001111 u32 __clib_unused thread_index = va_arg (*args, u32);
Florin Corasd69ef3a2023-10-02 10:41:54 -07001112 u32 __clib_unused verbose = va_arg (*args, u32);
Florin Coras2c876f92021-05-10 21:12:27 -07001113 session_t *tcp_ho;
1114 tls_ctx_t *ho_ctx;
1115
1116 ho_ctx = tls_ctx_half_open_get (ho_index);
1117
1118 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1119 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1120 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1121 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1122 tcp_ho->thread_index, tcp_ho->session_index);
1123
Florin Coras371ca502018-02-21 12:07:41 -08001124 return s;
1125}
1126
Yu Ping0b819152019-05-07 02:24:30 +08001127static void
1128tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1129 transport_endpoint_t * tep, u8 is_lcl)
1130{
1131 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
Florin Coras8074fc62024-02-20 11:24:54 -08001132 session_t *ts;
Yu Ping0b819152019-05-07 02:24:30 +08001133
Florin Coras8074fc62024-02-20 11:24:54 -08001134 ts = session_get_from_handle (ctx->tls_session_handle);
1135 if (ts && ts->session_state < SESSION_STATE_TRANSPORT_DELETED)
1136 session_get_endpoint (ts, tep, is_lcl);
Yu Ping0b819152019-05-07 02:24:30 +08001137}
1138
1139static void
1140tls_transport_listener_endpoint_get (u32 ctx_handle,
1141 transport_endpoint_t * tep, u8 is_lcl)
1142{
1143 session_t *tls_listener;
1144 app_listener_t *al;
1145 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1146
1147 al = app_listener_get_w_handle (ctx->tls_session_handle);
1148 tls_listener = app_listener_get_session (al);
1149 session_get_endpoint (tls_listener, tep, is_lcl);
1150}
1151
Florin Coras0a9ab822020-10-25 14:01:37 -07001152static clib_error_t *
1153tls_enable (vlib_main_t * vm, u8 is_en)
1154{
Florin Coras0a9ab822020-10-25 14:01:37 -07001155 vnet_app_detach_args_t _da, *da = &_da;
1156 vnet_app_attach_args_t _a, *a = &_a;
1157 u64 options[APP_OPTIONS_N_OPTIONS];
1158 tls_main_t *tm = &tls_main;
Florin Corasc1b03802023-09-30 15:21:08 -07001159 u32 fifo_size = 512 << 10;
Florin Coras0a9ab822020-10-25 14:01:37 -07001160
1161 if (!is_en)
1162 {
1163 da->app_index = tm->app_index;
1164 da->api_client_index = APP_INVALID_INDEX;
1165 vnet_application_detach (da);
1166 return 0;
1167 }
1168
Florin Coras0a9ab822020-10-25 14:01:37 -07001169 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1170
1171 clib_memset (a, 0, sizeof (*a));
1172 clib_memset (options, 0, sizeof (options));
1173
1174 a->session_cb_vft = &tls_app_cb_vft;
1175 a->api_client_index = APP_INVALID_INDEX;
1176 a->options = options;
1177 a->name = format (0, "tls");
Florin Corasa3767bd2021-11-18 15:25:31 -08001178 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1179 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
Florin Coras0a9ab822020-10-25 14:01:37 -07001180 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1181 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1182 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1183 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1184 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1185
1186 if (vnet_application_attach (a))
1187 {
1188 clib_warning ("failed to attach tls app");
1189 return clib_error_return (0, "failed to attach tls app");
1190 }
1191
1192 tm->app_index = a->app_index;
1193 vec_free (a->name);
1194
1195 return 0;
1196}
1197
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001198static const transport_proto_vft_t tls_proto = {
Florin Coras0a9ab822020-10-25 14:01:37 -07001199 .enable = tls_enable,
Florin Coras1ee78302019-02-05 15:51:15 -08001200 .connect = tls_connect,
Florin Coras371ca502018-02-21 12:07:41 -08001201 .close = tls_disconnect,
Florin Coras1ee78302019-02-05 15:51:15 -08001202 .start_listen = tls_start_listen,
1203 .stop_listen = tls_stop_listen,
Florin Corase3e2f072018-03-04 07:24:30 -08001204 .get_connection = tls_connection_get,
Florin Coras371ca502018-02-21 12:07:41 -08001205 .get_listener = tls_listener_get,
Florin Coras2c876f92021-05-10 21:12:27 -07001206 .get_half_open = tls_half_open_get,
1207 .cleanup_ho = tls_cleanup_ho,
Florin Corasf940f8a2019-03-06 10:44:38 -08001208 .custom_tx = tls_custom_tx_callback,
Florin Coras371ca502018-02-21 12:07:41 -08001209 .format_connection = format_tls_connection,
1210 .format_half_open = format_tls_half_open,
1211 .format_listener = format_tls_listener,
Yu Ping0b819152019-05-07 02:24:30 +08001212 .get_transport_endpoint = tls_transport_endpoint_get,
1213 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001214 .transport_options = {
Florin Coras07063b82020-03-13 04:44:51 +00001215 .name = "tls",
1216 .short_name = "J",
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001217 .tx_type = TRANSPORT_TX_INTERNAL,
Florin Coras2c876f92021-05-10 21:12:27 -07001218 .service_type = TRANSPORT_SERVICE_VC,
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001219 },
Florin Coras371ca502018-02-21 12:07:41 -08001220};
Florin Coras4b47ee22020-11-19 13:38:26 -08001221
1222int
1223dtls_connect (transport_endpoint_cfg_t *tep)
1224{
1225 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
Florin Corasa54b62d2021-04-21 09:05:56 -07001226 transport_endpt_crypto_cfg_t *ccfg;
Florin Coras4b47ee22020-11-19 13:38:26 -08001227 crypto_engine_type_t engine_type;
1228 session_endpoint_cfg_t *sep;
1229 tls_main_t *tm = &tls_main;
1230 app_worker_t *app_wrk;
1231 application_t *app;
1232 tls_ctx_t *ctx;
1233 u32 ctx_handle;
1234 int rv;
1235
1236 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -07001237 if (!sep->ext_cfg)
1238 return -1;
1239
Florin Coras4b47ee22020-11-19 13:38:26 -08001240 app_wrk = app_worker_get (sep->app_wrk_index);
1241 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -07001242
1243 ccfg = &sep->ext_cfg->crypto;
1244 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Florin Coras4b47ee22020-11-19 13:38:26 -08001245 if (engine_type == CRYPTO_ENGINE_NONE)
1246 {
1247 clib_warning ("No tls engine_type available");
1248 return -1;
1249 }
1250
Florin Corasfb50bc32021-05-18 00:28:59 -07001251 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1252 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
Florin Coras4b47ee22020-11-19 13:38:26 -08001253 ctx->parent_app_wrk_index = sep->app_wrk_index;
1254 ctx->parent_app_api_context = sep->opaque;
1255 ctx->tcp_is_ip4 = sep->is_ip4;
Florin Corasa54b62d2021-04-21 09:05:56 -07001256 ctx->ckpair_index = ccfg->ckpair_index;
Florin Coras4b47ee22020-11-19 13:38:26 -08001257 ctx->tls_type = sep->transport_proto;
1258 ctx->tls_ctx_handle = ctx_handle;
Florin Corasbab6c522021-05-13 08:36:56 -07001259 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1260 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasa54b62d2021-04-21 09:05:56 -07001261 if (ccfg->hostname[0])
Florin Coras4b47ee22020-11-19 13:38:26 -08001262 {
Florin Corasa54b62d2021-04-21 09:05:56 -07001263 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
Florin Coras4b47ee22020-11-19 13:38:26 -08001264 vec_terminate_c_string (ctx->srv_hostname);
1265 }
1266
Florin Coras4b47ee22020-11-19 13:38:26 -08001267 ctx->tls_ctx_engine = engine_type;
1268
1269 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1270 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1271 cargs->app_index = tm->app_index;
1272 cargs->api_context = ctx_handle;
1273 cargs->sep_ext.ns_index = app->ns_index;
1274 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1275 if ((rv = vnet_connect (cargs)))
1276 return rv;
1277
1278 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1279 engine_type);
Florin Corasbab6c522021-05-13 08:36:56 -07001280 return ctx_handle;
1281}
1282
1283static transport_connection_t *
1284dtls_half_open_get (u32 ho_index)
1285{
1286 tls_ctx_t *ho_ctx;
Florin Corasfb50bc32021-05-18 00:28:59 -07001287 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
Florin Corasbab6c522021-05-13 08:36:56 -07001288 return &ho_ctx->connection;
Florin Coras4b47ee22020-11-19 13:38:26 -08001289}
1290
1291static void
1292dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1293{
1294 /* No op */
1295}
1296
Florin Corasbab6c522021-05-13 08:36:56 -07001297static void
1298dtls_cleanup_ho (u32 ho_index)
1299{
1300 tls_ctx_t *ctx;
Florin Corasfb50bc32021-05-18 00:28:59 -07001301 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
Florin Corasbab6c522021-05-13 08:36:56 -07001302 tls_ctx_free (ctx);
1303}
1304
1305u8 *
1306format_dtls_half_open (u8 *s, va_list *args)
1307{
1308 u32 ho_index = va_arg (*args, u32);
1309 u32 __clib_unused thread_index = va_arg (*args, u32);
1310 tls_ctx_t *ho_ctx;
1311 session_t *us;
1312
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
1315 us = session_get_from_handle (ho_ctx->tls_session_handle);
1316 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1317 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1318 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1319 us->thread_index, us->session_index);
1320
1321 return s;
1322}
1323
Florin Coras4b47ee22020-11-19 13:38:26 -08001324static const transport_proto_vft_t dtls_proto = {
1325 .enable = 0,
1326 .connect = dtls_connect,
1327 .close = tls_disconnect,
1328 .start_listen = tls_start_listen,
1329 .stop_listen = tls_stop_listen,
1330 .get_connection = tls_connection_get,
1331 .get_listener = tls_listener_get,
Florin Corasbab6c522021-05-13 08:36:56 -07001332 .get_half_open = dtls_half_open_get,
Florin Coras4b47ee22020-11-19 13:38:26 -08001333 .custom_tx = tls_custom_tx_callback,
1334 .cleanup = dtls_cleanup_callback,
Florin Corasbab6c522021-05-13 08:36:56 -07001335 .cleanup_ho = dtls_cleanup_ho,
Florin Coras4b47ee22020-11-19 13:38:26 -08001336 .format_connection = format_tls_connection,
Florin Corasbab6c522021-05-13 08:36:56 -07001337 .format_half_open = format_dtls_half_open,
Florin Coras4b47ee22020-11-19 13:38:26 -08001338 .format_listener = format_tls_listener,
1339 .get_transport_endpoint = tls_transport_endpoint_get,
1340 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1341 .transport_options = {
1342 .name = "dtls",
1343 .short_name = "D",
1344 .tx_type = TRANSPORT_TX_INTERNAL,
Florin Corasbab6c522021-05-13 08:36:56 -07001345 .service_type = TRANSPORT_SERVICE_VC,
Florin Coras4b47ee22020-11-19 13:38:26 -08001346 },
1347};
Florin Coras371ca502018-02-21 12:07:41 -08001348
Florin Corasd77eee62018-03-07 08:49:27 -08001349void
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +02001350tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
Florin Coras371ca502018-02-21 12:07:41 -08001351{
Florin Corasd77eee62018-03-07 08:49:27 -08001352 vec_validate (tls_vfts, type);
1353 tls_vfts[type] = *vft;
Florin Coras371ca502018-02-21 12:07:41 -08001354}
1355
Dave Barachcc5677b2018-03-28 19:08:45 -04001356static clib_error_t *
Florin Coras371ca502018-02-21 12:07:41 -08001357tls_init (vlib_main_t * vm)
1358{
Florin Coras58d36f02018-03-09 13:05:53 -08001359 vlib_thread_main_t *vtm = vlib_get_thread_main ();
Florin Coras371ca502018-02-21 12:07:41 -08001360 tls_main_t *tm = &tls_main;
Florin Coras0a9ab822020-10-25 14:01:37 -07001361 u32 num_threads;
Florin Coras58d36f02018-03-09 13:05:53 -08001362
1363 num_threads = 1 /* main thread */ + vtm->n_threads;
Florin Coras371ca502018-02-21 12:07:41 -08001364
Florin Corasd77eee62018-03-07 08:49:27 -08001365 if (!tm->ca_cert_path)
1366 tm->ca_cert_path = TLS_CA_CERT_PATH;
1367
Florin Coras58d36f02018-03-09 13:05:53 -08001368 vec_validate (tm->rx_bufs, num_threads - 1);
1369 vec_validate (tm->tx_bufs, num_threads - 1);
1370
Florin Corasa3767bd2021-11-18 15:25:31 -08001371 tm->first_seg_size = 32 << 20;
1372 tm->add_seg_size = 256 << 20;
1373
Florin Coras371ca502018-02-21 12:07:41 -08001374 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1375 FIB_PROTOCOL_IP4, ~0);
1376 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1377 FIB_PROTOCOL_IP6, ~0);
Florin Coras4b47ee22020-11-19 13:38:26 -08001378
1379 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1380 FIB_PROTOCOL_IP4, ~0);
1381 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1382 FIB_PROTOCOL_IP6, ~0);
Florin Coras371ca502018-02-21 12:07:41 -08001383 return 0;
1384}
1385
1386VLIB_INIT_FUNCTION (tls_init);
1387
Florin Coras8f89dd02018-03-05 16:53:07 -08001388static clib_error_t *
1389tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1390{
1391 tls_main_t *tm = &tls_main;
Dave Wallaceb1a81aa2019-10-30 17:53:56 +00001392 uword tmp;
Florin Coras8f89dd02018-03-05 16:53:07 -08001393 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1394 {
1395 if (unformat (input, "use-test-cert-in-ca"))
1396 tm->use_test_cert_in_ca = 1;
1397 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1398 ;
Florin Corasddd98f32019-03-25 08:30:53 -07001399 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1400 &tm->first_seg_size))
1401 ;
Florin Corasa3767bd2021-11-18 15:25:31 -08001402 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1403 &tm->add_seg_size))
1404 ;
Dave Wallaceb1a81aa2019-10-30 17:53:56 +00001405 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1406 {
1407 if (tmp >= 0x100000000ULL)
1408 {
1409 return clib_error_return
1410 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1411 }
1412 tm->fifo_size = tmp;
1413 }
Florin Coras8f89dd02018-03-05 16:53:07 -08001414 else
1415 return clib_error_return (0, "unknown input `%U'",
1416 format_unformat_error, input);
1417 }
1418 return 0;
1419}
1420
Florin Coras1cbcdce2022-04-06 15:10:13 -07001421VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
Florin Corasd77eee62018-03-07 08:49:27 -08001422
1423tls_main_t *
1424vnet_tls_get_main (void)
1425{
1426 return &tls_main;
1427}
1428
Florin Coras371ca502018-02-21 12:07:41 -08001429/*
1430 * fd.io coding-style-patch-verification: ON
1431 *
1432 * Local Variables:
1433 * eval: (c-set-style "gnu")
1434 * End:
1435 */