blob: 9694b27a79e8604b6e6cdc5f87c573738f50562c [file] [log] [blame]
Florin Coras371ca502018-02-21 12:07:41 -08001/*
Florin Corasc9940fc2019-02-05 20:55:11 -08002 * Copyright (c) 2018-2019 Cisco and/or its affiliates.
Florin Coras371ca502018-02-21 12:07:41 -08003 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16#include <vnet/session/application_interface.h>
17#include <vppinfra/lock.h>
Florin Corasd77eee62018-03-07 08:49:27 -080018#include <vnet/tls/tls.h>
Florin Coras371ca502018-02-21 12:07:41 -080019
20static tls_main_t tls_main;
Florin Corasd77eee62018-03-07 08:49:27 -080021static tls_engine_vft_t *tls_vfts;
Florin Coras371ca502018-02-21 12:07:41 -080022
Florin Coras58d36f02018-03-09 13:05:53 -080023#define TLS_INVALID_HANDLE ~0
24#define TLS_IDX_MASK 0x00FFFFFF
jxm975fde82021-06-17 04:44:40 +000025#define TLS_ENGINE_TYPE_SHIFT 28
Florin Coras58d36f02018-03-09 13:05:53 -080026
27void tls_disconnect (u32 ctx_handle, u32 thread_index);
28
Florin Coras06a6a302019-04-17 14:19:12 -070029void
Florin Corasc01d5782018-10-17 14:53:11 -070030tls_disconnect_transport (tls_ctx_t * ctx)
31{
32 vnet_disconnect_args_t a = {
33 .handle = ctx->tls_session_handle,
34 .app_index = tls_main.app_index,
35 };
36
37 if (vnet_disconnect_session (&a))
38 clib_warning ("disconnect returned");
39}
40
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +020041crypto_engine_type_t
Florin Coras58d36f02018-03-09 13:05:53 -080042tls_get_available_engine (void)
43{
44 int i;
45 for (i = 0; i < vec_len (tls_vfts); i++)
46 {
47 if (tls_vfts[i].ctx_alloc)
48 return i;
49 }
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +020050 return CRYPTO_ENGINE_NONE;
Florin Coras58d36f02018-03-09 13:05:53 -080051}
Florin Coras371ca502018-02-21 12:07:41 -080052
Florin Corasd77eee62018-03-07 08:49:27 -080053int
Florin Coras288eaab2019-02-03 15:26:14 -080054tls_add_vpp_q_rx_evt (session_t * s)
Florin Coras371ca502018-02-21 12:07:41 -080055{
Florin Coras288eaab2019-02-03 15:26:14 -080056 if (svm_fifo_set_event (s->rx_fifo))
Florin Corasfe97da32019-03-06 10:09:04 -080057 session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_RX);
Florin Corasef915342018-09-29 10:23:06 -070058 return 0;
59}
60
61int
Florin Coras288eaab2019-02-03 15:26:14 -080062tls_add_vpp_q_builtin_rx_evt (session_t * s)
Florin Corasef915342018-09-29 10:23:06 -070063{
Florin Coras0242d302022-12-22 15:03:44 -080064 session_enqueue_notify (s);
Florin Corasef915342018-09-29 10:23:06 -070065 return 0;
66}
67
68int
Florin Coras288eaab2019-02-03 15:26:14 -080069tls_add_vpp_q_tx_evt (session_t * s)
Florin Corasef915342018-09-29 10:23:06 -070070{
Florin Coras288eaab2019-02-03 15:26:14 -080071 if (svm_fifo_set_event (s->tx_fifo))
Florin Corasfe97da32019-03-06 10:09:04 -080072 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
Florin Corasef915342018-09-29 10:23:06 -070073 return 0;
74}
75
Florin Coras371ca502018-02-21 12:07:41 -080076static inline int
Florin Coras0242d302022-12-22 15:03:44 -080077tls_add_app_q_evt (app_worker_t *app_wrk, session_t *app_session)
Florin Coras371ca502018-02-21 12:07:41 -080078{
Florin Coras0242d302022-12-22 15:03:44 -080079 app_worker_add_event (app_wrk, app_session, SESSION_IO_EVT_RX);
80 return 0;
Florin Coras371ca502018-02-21 12:07:41 -080081}
82
83u32
Florin Coras371ca502018-02-21 12:07:41 -080084tls_listener_ctx_alloc (void)
85{
86 tls_main_t *tm = &tls_main;
87 tls_ctx_t *ctx;
88
89 pool_get (tm->listener_ctx_pool, ctx);
Dave Barachb7b92992018-10-17 10:38:51 -040090 clib_memset (ctx, 0, sizeof (*ctx));
Florin Coras371ca502018-02-21 12:07:41 -080091 return ctx - tm->listener_ctx_pool;
92}
93
94void
Florin Corase3e2f072018-03-04 07:24:30 -080095tls_listener_ctx_free (tls_ctx_t * ctx)
Florin Coras371ca502018-02-21 12:07:41 -080096{
Florin Corasc01d5782018-10-17 14:53:11 -070097 if (CLIB_DEBUG)
98 memset (ctx, 0xfb, sizeof (*ctx));
Florin Corase3e2f072018-03-04 07:24:30 -080099 pool_put (tls_main.listener_ctx_pool, ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800100}
101
102tls_ctx_t *
103tls_listener_ctx_get (u32 ctx_index)
104{
105 return pool_elt_at_index (tls_main.listener_ctx_pool, ctx_index);
106}
107
108u32
109tls_listener_ctx_index (tls_ctx_t * ctx)
110{
111 return (ctx - tls_main.listener_ctx_pool);
112}
113
114u32
115tls_ctx_half_open_alloc (void)
116{
117 tls_main_t *tm = &tls_main;
Florin Coras371ca502018-02-21 12:07:41 -0800118 tls_ctx_t *ctx;
Florin Coras371ca502018-02-21 12:07:41 -0800119
Florin Corasa474bc82023-12-04 20:29:52 -0800120 if (vec_len (tm->postponed_ho_free))
121 tls_flush_postponed_ho_cleanups ();
122
Florin Coras009303d2022-03-29 17:49:37 -0700123 pool_get_aligned_safe (tm->half_open_ctx_pool, ctx, CLIB_CACHE_LINE_BYTES);
124
125 clib_memset (ctx, 0, sizeof (*ctx));
126 ctx->c_c_index = ctx - tm->half_open_ctx_pool;
Florin Coras309f7aa2022-03-18 08:33:08 -0700127 ctx->c_thread_index = transport_cl_thread ();
Florin Coras009303d2022-03-29 17:49:37 -0700128
129 return ctx->c_c_index;
Florin Coras371ca502018-02-21 12:07:41 -0800130}
131
132void
133tls_ctx_half_open_free (u32 ho_index)
134{
Florin Coras371ca502018-02-21 12:07:41 -0800135 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
Florin Coras371ca502018-02-21 12:07:41 -0800136}
137
138tls_ctx_t *
139tls_ctx_half_open_get (u32 ctx_index)
140{
141 tls_main_t *tm = &tls_main;
Florin Coras371ca502018-02-21 12:07:41 -0800142 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
143}
144
145void
Florin Corasa474bc82023-12-04 20:29:52 -0800146tls_add_postponed_ho_cleanups (u32 ho_index)
147{
148 tls_main_t *tm = &tls_main;
149 vec_add1 (tm->postponed_ho_free, ho_index);
150}
151
152static void
153tls_ctx_ho_try_free (u32 ho_index)
154{
155 tls_ctx_t *ctx;
156
157 ctx = tls_ctx_half_open_get (ho_index);
158 /* Probably tcp connected just before tcp establish timeout and
159 * worker that owns established session has not yet received
160 * @ref tls_session_connected_cb */
161 if (!(ctx->flags & TLS_CONN_F_HO_DONE))
162 {
163 ctx->tls_session_handle = SESSION_INVALID_HANDLE;
164 tls_add_postponed_ho_cleanups (ho_index);
165 return;
166 }
Florin Coras4a98b932024-01-31 13:45:39 -0800167 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
Florin Corasa474bc82023-12-04 20:29:52 -0800168 session_half_open_delete_notify (&ctx->connection);
169 tls_ctx_half_open_free (ho_index);
170}
171
172void
173tls_flush_postponed_ho_cleanups ()
174{
175 tls_main_t *tm = &tls_main;
176 u32 *ho_indexp, *tmp;
177
178 tmp = tm->postponed_ho_free;
179 tm->postponed_ho_free = tm->ho_free_list;
180 tm->ho_free_list = tmp;
181
182 vec_foreach (ho_indexp, tm->ho_free_list)
183 tls_ctx_ho_try_free (*ho_indexp);
184
185 vec_reset_length (tm->ho_free_list);
186}
187
188void
Florin Coras288eaab2019-02-03 15:26:14 -0800189tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
Florin Coras58d36f02018-03-09 13:05:53 -0800190{
Florin Corasbf7ce2c2019-03-06 14:44:42 -0800191 app_worker_t *app_wrk;
192 app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
193 if (PREDICT_TRUE (app_wrk != 0))
194 tls_add_app_q_evt (app_wrk, app_session);
Florin Coras58d36f02018-03-09 13:05:53 -0800195}
196
197int
Florin Coras371ca502018-02-21 12:07:41 -0800198tls_notify_app_accept (tls_ctx_t * ctx)
199{
Florin Coras288eaab2019-02-03 15:26:14 -0800200 session_t *app_listener, *app_session;
Florin Coras15531972018-08-12 23:50:53 -0700201 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800202 tls_ctx_t *lctx;
203 int rv;
204
Florin Coras371ca502018-02-21 12:07:41 -0800205 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
Florin Corasa27a46e2019-02-18 13:02:28 -0800206 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800207
Florin Coras58a93e82019-01-14 23:33:46 -0800208 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
Florin Corasdf57ea02019-02-18 20:14:20 -0800209 app_session->app_wrk_index = ctx->parent_app_wrk_index;
Florin Coras58d36f02018-03-09 13:05:53 -0800210 app_session->connection_index = ctx->tls_ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800211 app_session->session_type = app_listener->session_type;
Nathan Skrzypczak2f0f96b2019-06-13 10:14:28 +0200212 app_session->listener_handle = listen_session_get_handle (app_listener);
Florin Coras8a140612019-02-18 22:39:39 -0800213 app_session->session_state = SESSION_STATE_ACCEPTING;
Florin Coras15531972018-08-12 23:50:53 -0700214
Florin Corasa27a46e2019-02-18 13:02:28 -0800215 if ((rv = app_worker_init_accepted (app_session)))
Florin Coras371ca502018-02-21 12:07:41 -0800216 {
217 TLS_DBG (1, "failed to allocate fifos");
Florin Corasa27a46e2019-02-18 13:02:28 -0800218 session_free (app_session);
Florin Coras4a98b932024-01-31 13:45:39 -0800219 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coras371ca502018-02-21 12:07:41 -0800220 return rv;
221 }
Florin Coras371ca502018-02-21 12:07:41 -0800222 ctx->app_session_handle = session_handle (app_session);
Florin Corasdf57ea02019-02-18 20:14:20 -0800223 ctx->parent_app_wrk_index = app_session->app_wrk_index;
Florin Corasa27a46e2019-02-18 13:02:28 -0800224 app_wrk = app_worker_get (app_session->app_wrk_index);
225 return app_worker_accept_notify (app_wrk, app_session);
Florin Coras371ca502018-02-21 12:07:41 -0800226}
227
Florin Coras58d36f02018-03-09 13:05:53 -0800228int
Florin Coras00e01d32019-10-21 16:07:46 -0700229tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
Florin Coras371ca502018-02-21 12:07:41 -0800230{
Florin Coras179711d2022-04-10 13:34:47 -0700231 u32 parent_app_api_ctx;
Florin Coras288eaab2019-02-03 15:26:14 -0800232 session_t *app_session;
Florin Coras15531972018-08-12 23:50:53 -0700233 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800234
Florin Corasdf57ea02019-02-18 20:14:20 -0800235 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
Florin Corasef915342018-09-29 10:23:06 -0700236 if (!app_wrk)
237 {
Florin Coras179711d2022-04-10 13:34:47 -0700238 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
239 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
Florin Coras4a98b932024-01-31 13:45:39 -0800240 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasef915342018-09-29 10:23:06 -0700241 return -1;
242 }
243
Florin Coras00e01d32019-10-21 16:07:46 -0700244 if (err)
Florin Coras4b47ee22020-11-19 13:38:26 -0800245 {
246 /* Free app session pre-allocated when transport was established */
247 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
248 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
Florin Coras4a98b932024-01-31 13:45:39 -0800249 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corase3c6a542021-05-19 19:28:40 -0700250 goto send_reply;
Florin Coras4b47ee22020-11-19 13:38:26 -0800251 }
Florin Coras8f89dd02018-03-05 16:53:07 -0800252
Florin Coras4b47ee22020-11-19 13:38:26 -0800253 /* For DTLS the app session is not preallocated because the underlying udp
254 * session might migrate to a different worker during the handshake */
255 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
256 {
257 session_type_t st;
Florin Corasbab6c522021-05-13 08:36:56 -0700258 /* Cleanup half-open session as we don't get notification from udp */
259 session_half_open_delete_notify (&ctx->connection);
Florin Coras4b47ee22020-11-19 13:38:26 -0800260 app_session = session_alloc (ctx->c_thread_index);
261 app_session->session_state = SESSION_STATE_CREATED;
262 ctx->c_s_index = app_session->session_index;
263 st =
264 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
265 app_session->session_type = st;
266 app_session->connection_index = ctx->tls_ctx_handle;
267 }
268 else
269 {
270 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
271 }
272
Florin Corasdf57ea02019-02-18 20:14:20 -0800273 app_session->app_wrk_index = ctx->parent_app_wrk_index;
Florin Coras2ceb8182023-08-31 17:33:47 -0700274 app_session->opaque = ctx->parent_app_api_context;
Florin Coras15531972018-08-12 23:50:53 -0700275
Florin Coras00e01d32019-10-21 16:07:46 -0700276 if ((err = app_worker_init_connected (app_wrk, app_session)))
Florin Corasa3d55df2023-10-06 19:06:35 -0700277 {
278 app_worker_connect_notify (app_wrk, 0, err, ctx->parent_app_api_context);
Florin Coras4a98b932024-01-31 13:45:39 -0800279 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasa3d55df2023-10-06 19:06:35 -0700280 session_free (app_session);
281 return -1;
282 }
Florin Coras371ca502018-02-21 12:07:41 -0800283
jiangxiaoming5b7ea912020-09-23 10:29:21 +0800284 app_session->session_state = SESSION_STATE_READY;
Florin Coras179711d2022-04-10 13:34:47 -0700285 parent_app_api_ctx = ctx->parent_app_api_context;
286 ctx->app_session_handle = session_handle (app_session);
287
288 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
289 parent_app_api_ctx))
Florin Coras371ca502018-02-21 12:07:41 -0800290 {
291 TLS_DBG (1, "failed to notify app");
Florin Coras6e7ebb02022-05-04 12:02:56 -0700292 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
Florin Coras4a98b932024-01-31 13:45:39 -0800293 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coraseb97e5f2018-10-15 21:35:42 -0700294 return -1;
Florin Coras371ca502018-02-21 12:07:41 -0800295 }
296
297 return 0;
298
Florin Corase3c6a542021-05-19 19:28:40 -0700299send_reply:
Florin Coras00e01d32019-10-21 16:07:46 -0700300 return app_worker_connect_notify (app_wrk, 0, err,
301 ctx->parent_app_api_context);
Florin Coras371ca502018-02-21 12:07:41 -0800302}
303
Florin Coras58d36f02018-03-09 13:05:53 -0800304static inline void
305tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
Florin Corasd77eee62018-03-07 08:49:27 -0800306{
Florin Coras58d36f02018-03-09 13:05:53 -0800307 *ctx_index = ctx_handle & TLS_IDX_MASK;
308 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
309}
310
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200311static inline crypto_engine_type_t
Florin Corasa54b62d2021-04-21 09:05:56 -0700312tls_get_engine_type (crypto_engine_type_t requested,
313 crypto_engine_type_t preferred)
Florin Coras58d36f02018-03-09 13:05:53 -0800314{
Florin Corasa54b62d2021-04-21 09:05:56 -0700315 if (requested != CRYPTO_ENGINE_NONE)
316 {
317 if (tls_vfts[requested].ctx_alloc)
318 return requested;
319 return CRYPTO_ENGINE_NONE;
320 }
Florin Coras58d36f02018-03-09 13:05:53 -0800321 if (!tls_vfts[preferred].ctx_alloc)
322 return tls_get_available_engine ();
323 return preferred;
324}
325
326static inline u32
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200327tls_ctx_alloc (crypto_engine_type_t engine_type)
Florin Coras58d36f02018-03-09 13:05:53 -0800328{
329 u32 ctx_index;
330 ctx_index = tls_vfts[engine_type].ctx_alloc ();
331 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
Florin Corasd77eee62018-03-07 08:49:27 -0800332}
333
Florin Coras4b47ee22020-11-19 13:38:26 -0800334static inline u32
335tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
336{
337 u32 ctx_index;
338 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
339 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
340}
341
342static inline u32
343tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
344{
345 u32 ctx_index;
346 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
347 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
348}
349
350static inline void *
351tls_ctx_detach (tls_ctx_t *ctx)
352{
353 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
354}
355
Florin Corasd77eee62018-03-07 08:49:27 -0800356static inline tls_ctx_t *
Florin Coras58d36f02018-03-09 13:05:53 -0800357tls_ctx_get (u32 ctx_handle)
Florin Corasd77eee62018-03-07 08:49:27 -0800358{
Florin Coras58d36f02018-03-09 13:05:53 -0800359 u32 ctx_index, engine_type;
360 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
361 return tls_vfts[engine_type].ctx_get (ctx_index);
Florin Corasd77eee62018-03-07 08:49:27 -0800362}
363
364static inline tls_ctx_t *
Florin Coras58d36f02018-03-09 13:05:53 -0800365tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
Florin Corasd77eee62018-03-07 08:49:27 -0800366{
Florin Coras58d36f02018-03-09 13:05:53 -0800367 u32 ctx_index, engine_type;
368 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
369 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
Florin Corasd77eee62018-03-07 08:49:27 -0800370}
371
372static inline int
373tls_ctx_init_server (tls_ctx_t * ctx)
374{
Florin Coras58d36f02018-03-09 13:05:53 -0800375 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
Florin Corasd77eee62018-03-07 08:49:27 -0800376}
377
378static inline int
379tls_ctx_init_client (tls_ctx_t * ctx)
380{
Florin Coras58d36f02018-03-09 13:05:53 -0800381 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
Florin Corasd77eee62018-03-07 08:49:27 -0800382}
383
384static inline int
Florin Coras9f86d222020-03-23 15:34:22 +0000385tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
386 transport_send_params_t * sp)
Florin Corasd77eee62018-03-07 08:49:27 -0800387{
Florin Coras9f86d222020-03-23 15:34:22 +0000388 u32 n_wrote;
Florin Corased8db522020-02-27 04:32:51 +0000389
Florin Coras9f86d222020-03-23 15:34:22 +0000390 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
391 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
Florin Coras3e157102022-02-04 13:31:25 -0800392 sp->bytes_dequeued = n_wrote;
Florin Corased8db522020-02-27 04:32:51 +0000393 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
Florin Corasd77eee62018-03-07 08:49:27 -0800394}
395
396static inline int
Florin Coras288eaab2019-02-03 15:26:14 -0800397tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
Florin Corasd77eee62018-03-07 08:49:27 -0800398{
Florin Coras58d36f02018-03-09 13:05:53 -0800399 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
Florin Corasd77eee62018-03-07 08:49:27 -0800400}
401
Florin Coras06a6a302019-04-17 14:19:12 -0700402static inline int
403tls_ctx_transport_close (tls_ctx_t * ctx)
404{
405 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
406}
407
408static inline int
409tls_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 Coras288eaab2019-02-03 15:26:14 -0800443tls_session_reset_callback (session_t * s)
Florin Coras371ca502018-02-21 12:07:41 -0800444{
Florin Corasf03c4942019-08-07 21:39:27 -0700445 tls_ctx_t *ctx;
Zeyu Zhangcbbc4a22019-10-12 14:21:59 +0800446 transport_connection_t *tc;
447 session_t *app_session;
Florin Corasf03c4942019-08-07 21:39:27 -0700448
449 ctx = tls_ctx_get (s->opaque);
Florin Coras4a98b932024-01-31 13:45:39 -0800450 ctx->flags |= TLS_CONN_F_PASSIVE_CLOSE;
Zeyu Zhangcbbc4a22019-10-12 14:21:59 +0800451 tc = &ctx->connection;
452 if (tls_ctx_handshake_is_over (ctx))
453 {
454 session_transport_reset_notify (tc);
455 session_transport_closed_notify (tc);
Yu Ping83782612020-02-19 02:31:22 +0800456 tls_disconnect_transport (ctx);
Zeyu Zhangcbbc4a22019-10-12 14:21:59 +0800457 }
Yu Ping83782612020-02-19 02:31:22 +0800458 else
Yu Ping83782612020-02-19 02:31:22 +0800459 {
Florin Corasfad689e2024-01-22 18:06:41 -0800460 app_session = session_get_if_valid (ctx->c_s_index, ctx->c_thread_index);
461 if (app_session)
462 {
463 session_free (app_session);
464 ctx->c_s_index = SESSION_INVALID_INDEX;
Florin Coras4a98b932024-01-31 13:45:39 -0800465 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasfad689e2024-01-22 18:06:41 -0800466 tls_disconnect_transport (ctx);
467 }
Yu Ping83782612020-02-19 02:31:22 +0800468 }
Florin Coras371ca502018-02-21 12:07:41 -0800469}
470
Florin Coras2c876f92021-05-10 21:12:27 -0700471static void
472tls_session_cleanup_ho (session_t *s)
473{
Florin Coras2c876f92021-05-10 21:12:27 -0700474 /* session opaque stores the opaque passed on connect */
Florin Corasa474bc82023-12-04 20:29:52 -0800475 tls_ctx_ho_try_free (s->opaque);
Florin Coras2c876f92021-05-10 21:12:27 -0700476}
477
Florin Coras371ca502018-02-21 12:07:41 -0800478int
Florin Corasfa76a762018-11-29 12:40:10 -0800479tls_add_segment_callback (u32 client_index, u64 segment_handle)
Florin Coras371ca502018-02-21 12:07:41 -0800480{
481 /* No-op for builtin */
482 return 0;
483}
484
485int
Florin Corasfa76a762018-11-29 12:40:10 -0800486tls_del_segment_callback (u32 client_index, u64 segment_handle)
Florin Coras371ca502018-02-21 12:07:41 -0800487{
488 return 0;
489}
490
491void
Florin Coras288eaab2019-02-03 15:26:14 -0800492tls_session_disconnect_callback (session_t * tls_session)
Florin Coras371ca502018-02-21 12:07:41 -0800493{
Florin Coras371ca502018-02-21 12:07:41 -0800494 tls_ctx_t *ctx;
Florin Corasbf7ce2c2019-03-06 14:44:42 -0800495
496 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
497 tls_session->session_index);
Florin Coras371ca502018-02-21 12:07:41 -0800498
Florin Coras6faac162019-10-11 08:00:43 -0700499 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
500 || vlib_thread_is_main_w_barrier ());
501
502 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
Florin Coras4a98b932024-01-31 13:45:39 -0800503 ctx->flags |= TLS_CONN_F_PASSIVE_CLOSE;
Florin Coras06a6a302019-04-17 14:19:12 -0700504 tls_ctx_transport_close (ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800505}
506
507int
Florin Coras288eaab2019-02-03 15:26:14 -0800508tls_session_accept_callback (session_t * tls_session)
Florin Coras371ca502018-02-21 12:07:41 -0800509{
Florin Coras288eaab2019-02-03 15:26:14 -0800510 session_t *tls_listener, *app_session;
Florin Coras371ca502018-02-21 12:07:41 -0800511 tls_ctx_t *lctx, *ctx;
Florin Coras58d36f02018-03-09 13:05:53 -0800512 u32 ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800513
Nathan Skrzypczak2f0f96b2019-06-13 10:14:28 +0200514 tls_listener =
515 listen_session_get_from_handle (tls_session->listener_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800516 lctx = tls_listener_ctx_get (tls_listener->opaque);
Florin Coras58d36f02018-03-09 13:05:53 -0800517
518 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
519 ctx = tls_ctx_get (ctx_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800520 memcpy (ctx, lctx, sizeof (*lctx));
521 ctx->c_thread_index = vlib_get_thread_index ();
Florin Coras58d36f02018-03-09 13:05:53 -0800522 ctx->tls_ctx_handle = ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800523 tls_session->session_state = SESSION_STATE_READY;
Florin Coras58d36f02018-03-09 13:05:53 -0800524 tls_session->opaque = ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800525 ctx->tls_session_handle = session_handle (tls_session);
526 ctx->listener_ctx_index = tls_listener->opaque;
Florin Corasd09236d2019-08-08 17:38:26 -0700527 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Nathan Skrzypczak79f89532019-09-13 11:08:13 +0200528 ctx->ckpair_index = lctx->ckpair_index;
Florin Coras371ca502018-02-21 12:07:41 -0800529
Florin Coras58a93e82019-01-14 23:33:46 -0800530 /* Preallocate app session. Avoids allocating a session post handshake
531 * on tls_session rx and potentially invalidating the session pool */
532 app_session = session_alloc (ctx->c_thread_index);
Srikanth Akulae140d5d2019-11-18 11:49:58 -0800533 app_session->session_state = SESSION_STATE_CREATED;
Florin Corasa127d3c2023-09-25 19:50:48 -0700534 app_session->session_type =
535 session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
536 app_session->connection_index = ctx->tls_ctx_handle;
Florin Coras58a93e82019-01-14 23:33:46 -0800537 ctx->c_s_index = app_session->session_index;
538
Florin Coras58d36f02018-03-09 13:05:53 -0800539 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
540 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800541
Florin Coras14bfd3d2023-11-08 19:57:38 -0800542 if (tls_ctx_init_server (ctx))
Xiaoming Jiang47781642023-05-26 00:32:25 +0000543 {
Florin Coras14bfd3d2023-11-08 19:57:38 -0800544 /* Do not free ctx yet, in case we have pending rx events */
Xiaoming Jiang47781642023-05-26 00:32:25 +0000545 session_free (app_session);
Florin Coras4a98b932024-01-31 13:45:39 -0800546 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coras14bfd3d2023-11-08 19:57:38 -0800547 tls_disconnect_transport (ctx);
Xiaoming Jiang47781642023-05-26 00:32:25 +0000548 }
549
Florin Coras14bfd3d2023-11-08 19:57:38 -0800550 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800551}
552
553int
Florin Corascfc2a0e2023-11-08 14:14:17 -0800554tls_app_rx_callback (session_t *ts)
Florin Coras371ca502018-02-21 12:07:41 -0800555{
Florin Coras371ca502018-02-21 12:07:41 -0800556 tls_ctx_t *ctx;
Florin Coras371ca502018-02-21 12:07:41 -0800557
Florin Coras4b47ee22020-11-19 13:38:26 -0800558 /* DTLS session migrating, wait for next notification */
Florin Corascfc2a0e2023-11-08 14:14:17 -0800559 if (PREDICT_FALSE (ts->flags & SESSION_F_IS_MIGRATING))
Florin Coras4b47ee22020-11-19 13:38:26 -0800560 return 0;
561
Florin Corascfc2a0e2023-11-08 14:14:17 -0800562 /* Read rescheduled but underlying transport deleted now */
563 if (PREDICT_FALSE ((ts->session_state == SESSION_STATE_TRANSPORT_DELETED)))
564 return 0;
565
566 ctx = tls_ctx_get (ts->opaque);
Florin Coras4a98b932024-01-31 13:45:39 -0800567 if (PREDICT_FALSE ((ctx->flags & TLS_CONN_F_NO_APP_SESSION) ||
568 (ctx->flags & TLS_CONN_F_APP_CLOSED)))
Saravanan Murugesan3683d1b2022-02-28 10:55:26 +0530569 {
570 TLS_DBG (1, "Local App closed");
571 return 0;
572 }
Florin Corascfc2a0e2023-11-08 14:14:17 -0800573 tls_ctx_read (ctx, ts);
Florin Coras58d36f02018-03-09 13:05:53 -0800574 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800575}
576
577int
Florin Coras9f86d222020-03-23 15:34:22 +0000578tls_app_tx_callback (session_t * tls_session)
579{
580 tls_ctx_t *ctx;
581
582 ctx = tls_ctx_get (tls_session->opaque);
583 transport_connection_reschedule (&ctx->connection);
584
585 return 0;
586}
587
588int
Florin Coras4b47ee22020-11-19 13:38:26 -0800589tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
590 session_t *tls_session, session_error_t err)
Florin Coras371ca502018-02-21 12:07:41 -0800591{
Florin Coras288eaab2019-02-03 15:26:14 -0800592 session_t *app_session;
Florin Coras371ca502018-02-21 12:07:41 -0800593 tls_ctx_t *ho_ctx, *ctx;
Florin Coras4b47ee22020-11-19 13:38:26 -0800594 session_type_t st;
Florin Coras58d36f02018-03-09 13:05:53 -0800595 u32 ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800596
597 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
Florin Coras371ca502018-02-21 12:07:41 -0800598
Florin Coras58d36f02018-03-09 13:05:53 -0800599 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
600 ctx = tls_ctx_get (ctx_handle);
Dave Barach178cf492018-11-13 16:34:13 -0500601 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
Florin Coras0ded4892024-02-13 15:37:20 -0500602
Florin Coras2c876f92021-05-10 21:12:27 -0700603 /* Half-open freed on tcp half-open cleanup notification */
Florin Coras0ded4892024-02-13 15:37:20 -0500604 __atomic_fetch_or (&ho_ctx->flags, TLS_CONN_F_HO_DONE, __ATOMIC_RELEASE);
Florin Coras371ca502018-02-21 12:07:41 -0800605
Florin Corasdcde9272018-03-02 09:23:42 -0800606 ctx->c_thread_index = vlib_get_thread_index ();
Florin Coras58d36f02018-03-09 13:05:53 -0800607 ctx->tls_ctx_handle = ctx_handle;
Florin Corasd09236d2019-08-08 17:38:26 -0700608 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasdcde9272018-03-02 09:23:42 -0800609
Florin Coras58d36f02018-03-09 13:05:53 -0800610 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
Florin Coras4b47ee22020-11-19 13:38:26 -0800611 ho_ctx_index, err, vlib_get_thread_index (),
Florin Coras58d36f02018-03-09 13:05:53 -0800612 (ctx) ? ctx_handle : ~0);
Florin Coras371ca502018-02-21 12:07:41 -0800613
614 ctx->tls_session_handle = session_handle (tls_session);
Florin Coras58d36f02018-03-09 13:05:53 -0800615 tls_session->opaque = ctx_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800616 tls_session->session_state = SESSION_STATE_READY;
617
Florin Coras58a93e82019-01-14 23:33:46 -0800618 /* Preallocate app session. Avoids allocating a session post handshake
619 * on tls_session rx and potentially invalidating the session pool */
620 app_session = session_alloc (ctx->c_thread_index);
Srikanth Akulae140d5d2019-11-18 11:49:58 -0800621 app_session->session_state = SESSION_STATE_CREATED;
Florin Coras58a93e82019-01-14 23:33:46 -0800622 ctx->c_s_index = app_session->session_index;
Florin Coras4b47ee22020-11-19 13:38:26 -0800623 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
624 app_session->session_type = st;
625 app_session->connection_index = ctx->tls_ctx_handle;
Florin Coras58a93e82019-01-14 23:33:46 -0800626
Florin Coras14bfd3d2023-11-08 19:57:38 -0800627 if (tls_ctx_init_client (ctx))
Xiaoming Jiang47781642023-05-26 00:32:25 +0000628 {
Florin Coras14bfd3d2023-11-08 19:57:38 -0800629 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
630 tls_disconnect_transport (ctx);
Xiaoming Jiang47781642023-05-26 00:32:25 +0000631 }
632
Florin Coras14bfd3d2023-11-08 19:57:38 -0800633 return 0;
Florin Coras371ca502018-02-21 12:07:41 -0800634}
635
Florin Coras4b47ee22020-11-19 13:38:26 -0800636int
637dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
638 session_error_t err)
639{
640 tls_ctx_t *ctx;
641
Florin Corasfb50bc32021-05-18 00:28:59 -0700642 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
Florin Coras4b47ee22020-11-19 13:38:26 -0800643
644 ctx->tls_session_handle = session_handle (us);
645 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
646 us->opaque = ctx_handle;
647
648 /* We don't preallocate the app session because the udp session might
649 * actually migrate to a different worker at the end of the handshake */
650
651 return tls_ctx_init_client (ctx);
652}
653
654int
655tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
656 session_t *tls_session, session_error_t err)
657{
Florin Coras71ee3752021-05-28 18:29:08 -0700658 if (err)
659 {
660 app_worker_t *app_wrk;
661 tls_ctx_t *ho_ctx;
662 u32 api_context;
663
664 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
Florin Corasa474bc82023-12-04 20:29:52 -0800665 ho_ctx->flags |= TLS_CONN_F_HO_DONE;
Florin Coras71ee3752021-05-28 18:29:08 -0700666 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
667 if (app_wrk)
668 {
669 api_context = ho_ctx->parent_app_api_context;
670 app_worker_connect_notify (app_wrk, 0, err, api_context);
671 }
Florin Coras71ee3752021-05-28 18:29:08 -0700672
673 return 0;
674 }
675
Florin Coras4b47ee22020-11-19 13:38:26 -0800676 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
677 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
678 err);
679 else
680 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
681 err);
682}
683
Florin Corasef2b3352019-08-07 11:14:56 -0700684static void
685tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
686{
687 tls_ctx_t *ctx;
688
689 if (ntf == SESSION_CLEANUP_TRANSPORT)
Florin Coras36d49392020-04-24 23:00:11 +0000690 {
691 /* Allow cleanup of tcp session */
692 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
693 session_close (s);
694 return;
695 }
Florin Corasef2b3352019-08-07 11:14:56 -0700696
697 ctx = tls_ctx_get (s->opaque);
Florin Coras4a98b932024-01-31 13:45:39 -0800698 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
Florin Corasef2b3352019-08-07 11:14:56 -0700699 session_transport_delete_notify (&ctx->connection);
700 tls_ctx_free (ctx);
701}
702
Florin Coras4b47ee22020-11-19 13:38:26 -0800703static void
Florin Coras88dd3cf2021-05-01 19:01:42 -0700704dtls_migrate_ctx (void *arg)
Florin Coras4b47ee22020-11-19 13:38:26 -0800705{
706 tls_ctx_t *ctx = (tls_ctx_t *) arg;
707 u32 ctx_handle, thread_index;
708 session_t *us;
709
710 thread_index = session_thread_from_handle (ctx->tls_session_handle);
711 ASSERT (thread_index == vlib_get_thread_index ());
712
713 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
714 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
715 ctx->tls_ctx_handle = ctx_handle;
716
717 us = session_get_from_handle (ctx->tls_session_handle);
718 us->opaque = ctx_handle;
719 us->flags &= ~SESSION_F_IS_MIGRATING;
Florin Corasbab6c522021-05-13 08:36:56 -0700720
721 /* Probably the app detached while the session was migrating. Cleanup */
722 if (session_half_open_migrated_notify (&ctx->connection))
723 {
Florin Coras4a98b932024-01-31 13:45:39 -0800724 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasbab6c522021-05-13 08:36:56 -0700725 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
726 return;
727 }
728
Florin Coras4b47ee22020-11-19 13:38:26 -0800729 if (svm_fifo_max_dequeue (us->tx_fifo))
730 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
731}
732
733static void
734dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
735{
736 u32 new_thread = session_thread_from_handle (new_sh);
Florin Coras88dd3cf2021-05-01 19:01:42 -0700737 tls_ctx_t *ctx, *cloned_ctx;
Florin Coras4b47ee22020-11-19 13:38:26 -0800738
739 /* Migrate dtls context to new thread */
740 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
741 ctx->tls_session_handle = new_sh;
Florin Coras88dd3cf2021-05-01 19:01:42 -0700742 cloned_ctx = tls_ctx_detach (ctx);
Florin Coras4a98b932024-01-31 13:45:39 -0800743 ctx->flags |= TLS_CONN_F_MIGRATED;
Florin Corasbab6c522021-05-13 08:36:56 -0700744 session_half_open_migrate_notify (&ctx->connection);
Florin Coras4b47ee22020-11-19 13:38:26 -0800745
Florin Coras88dd3cf2021-05-01 19:01:42 -0700746 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
747 (void *) cloned_ctx);
748
749 tls_ctx_free (ctx);
Florin Coras4b47ee22020-11-19 13:38:26 -0800750}
751
Florin Corascfc2a0e2023-11-08 14:14:17 -0800752static void
753tls_session_transport_closed_callback (session_t *ts)
754{
755 tls_ctx_t *ctx;
756
757 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
Florin Coras4a98b932024-01-31 13:45:39 -0800758 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
Florin Coras86b02c72023-12-13 14:26:19 -0800759 session_transport_closed_notify (&ctx->connection);
Florin Corascfc2a0e2023-11-08 14:14:17 -0800760}
761
Florin Coras371ca502018-02-21 12:07:41 -0800762static session_cb_vft_t tls_app_cb_vft = {
763 .session_accept_callback = tls_session_accept_callback,
764 .session_disconnect_callback = tls_session_disconnect_callback,
765 .session_connected_callback = tls_session_connected_callback,
766 .session_reset_callback = tls_session_reset_callback,
Florin Corascfc2a0e2023-11-08 14:14:17 -0800767 .session_transport_closed_callback = tls_session_transport_closed_callback,
Florin Coras2c876f92021-05-10 21:12:27 -0700768 .half_open_cleanup_callback = tls_session_cleanup_ho,
Florin Coras371ca502018-02-21 12:07:41 -0800769 .add_segment_callback = tls_add_segment_callback,
770 .del_segment_callback = tls_del_segment_callback,
771 .builtin_app_rx_callback = tls_app_rx_callback,
Florin Coras9f86d222020-03-23 15:34:22 +0000772 .builtin_app_tx_callback = tls_app_tx_callback,
Florin Coras4b47ee22020-11-19 13:38:26 -0800773 .session_migrate_callback = dtls_session_migrate_callback,
Florin Corasef2b3352019-08-07 11:14:56 -0700774 .session_cleanup_callback = tls_app_session_cleanup,
Florin Coras371ca502018-02-21 12:07:41 -0800775};
Florin Coras371ca502018-02-21 12:07:41 -0800776
777int
Florin Coras5665ced2018-10-25 18:03:45 -0700778tls_connect (transport_endpoint_cfg_t * tep)
Florin Coras371ca502018-02-21 12:07:41 -0800779{
Florin Coras15531972018-08-12 23:50:53 -0700780 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
Florin Corasa54b62d2021-04-21 09:05:56 -0700781 transport_endpt_crypto_cfg_t *ccfg;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200782 crypto_engine_type_t engine_type;
Florin Coras4b47ee22020-11-19 13:38:26 -0800783 session_endpoint_cfg_t *sep;
Florin Coras371ca502018-02-21 12:07:41 -0800784 tls_main_t *tm = &tls_main;
Florin Coras15531972018-08-12 23:50:53 -0700785 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800786 application_t *app;
787 tls_ctx_t *ctx;
788 u32 ctx_index;
Florin Corasc1a42652019-02-08 18:27:29 -0800789 int rv;
Florin Coras371ca502018-02-21 12:07:41 -0800790
Florin Coras5665ced2018-10-25 18:03:45 -0700791 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -0700792 if (!sep->ext_cfg)
Florin Corase5f18332021-04-22 11:48:35 -0700793 return SESSION_E_NOEXTCFG;
Florin Corasa54b62d2021-04-21 09:05:56 -0700794
Florin Coras15531972018-08-12 23:50:53 -0700795 app_wrk = app_worker_get (sep->app_wrk_index);
796 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -0700797
798 ccfg = &sep->ext_cfg->crypto;
799 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200800 if (engine_type == CRYPTO_ENGINE_NONE)
Florin Coras58d36f02018-03-09 13:05:53 -0800801 {
802 clib_warning ("No tls engine_type available");
Florin Corase5f18332021-04-22 11:48:35 -0700803 return SESSION_E_NOCRYPTOENG;
Florin Coras58d36f02018-03-09 13:05:53 -0800804 }
Florin Coras371ca502018-02-21 12:07:41 -0800805
806 ctx_index = tls_ctx_half_open_alloc ();
807 ctx = tls_ctx_half_open_get (ctx_index);
Florin Corasdf57ea02019-02-18 20:14:20 -0800808 ctx->parent_app_wrk_index = sep->app_wrk_index;
Florin Coras371ca502018-02-21 12:07:41 -0800809 ctx->parent_app_api_context = sep->opaque;
810 ctx->tcp_is_ip4 = sep->is_ip4;
Florin Coras4b47ee22020-11-19 13:38:26 -0800811 ctx->tls_type = sep->transport_proto;
Florin Corasa54b62d2021-04-21 09:05:56 -0700812 ctx->ckpair_index = ccfg->ckpair_index;
Florin Coras2c876f92021-05-10 21:12:27 -0700813 ctx->c_proto = TRANSPORT_PROTO_TLS;
814 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasa54b62d2021-04-21 09:05:56 -0700815 if (ccfg->hostname[0])
Florin Coras8f89dd02018-03-05 16:53:07 -0800816 {
Florin Corasa54b62d2021-04-21 09:05:56 -0700817 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
Florin Coras8f89dd02018-03-05 16:53:07 -0800818 vec_terminate_c_string (ctx->srv_hostname);
819 }
Florin Coras371ca502018-02-21 12:07:41 -0800820
Florin Coras58d36f02018-03-09 13:05:53 -0800821 ctx->tls_ctx_engine = engine_type;
Florin Coras371ca502018-02-21 12:07:41 -0800822
Dave Barach178cf492018-11-13 16:34:13 -0500823 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
Florin Coras15531972018-08-12 23:50:53 -0700824 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
825 cargs->app_index = tm->app_index;
826 cargs->api_context = ctx_index;
Florin Coras8a140612019-02-18 22:39:39 -0800827 cargs->sep_ext.ns_index = app->ns_index;
Florin Corasc1a42652019-02-08 18:27:29 -0800828 if ((rv = vnet_connect (cargs)))
Florin Coras3109d1c2024-01-22 18:27:43 -0800829 {
830 tls_ctx_half_open_free (ctx_index);
831 return rv;
832 }
Florin Coras371ca502018-02-21 12:07:41 -0800833
Florin Coras2c876f92021-05-10 21:12:27 -0700834 /* Track half-open tcp session in case we need to clean it up */
835 ctx->tls_session_handle = cargs->sh;
836
Florin Coras58d36f02018-03-09 13:05:53 -0800837 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
Florin Coras2c876f92021-05-10 21:12:27 -0700838 return ctx_index;
Florin Coras371ca502018-02-21 12:07:41 -0800839}
840
841void
Florin Coras58d36f02018-03-09 13:05:53 -0800842tls_disconnect (u32 ctx_handle, u32 thread_index)
Florin Coras371ca502018-02-21 12:07:41 -0800843{
Florin Coras371ca502018-02-21 12:07:41 -0800844 tls_ctx_t *ctx;
845
Florin Coras58d36f02018-03-09 13:05:53 -0800846 TLS_DBG (1, "Disconnecting %x", ctx_handle);
Florin Coras371ca502018-02-21 12:07:41 -0800847
Florin Coras58d36f02018-03-09 13:05:53 -0800848 ctx = tls_ctx_get (ctx_handle);
Florin Corasd7f17a22024-01-31 16:18:17 -0800849 ctx->flags |= TLS_CONN_F_APP_CLOSED;
Florin Coras06a6a302019-04-17 14:19:12 -0700850 tls_ctx_app_close (ctx);
Florin Coras371ca502018-02-21 12:07:41 -0800851}
852
853u32
Florin Coras0bce71e2022-02-10 11:57:06 -0800854tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
Florin Coras371ca502018-02-21 12:07:41 -0800855{
Florin Corasc9940fc2019-02-05 20:55:11 -0800856 vnet_listen_args_t _bargs, *args = &_bargs;
Florin Corasa54b62d2021-04-21 09:05:56 -0700857 transport_endpt_crypto_cfg_t *ccfg;
Florin Corasab2f6db2018-08-31 14:31:41 -0700858 app_worker_t *app_wrk;
Florin Coras371ca502018-02-21 12:07:41 -0800859 tls_main_t *tm = &tls_main;
Florin Corasa27a46e2019-02-18 13:02:28 -0800860 session_handle_t tls_al_handle;
Florin Coras5665ced2018-10-25 18:03:45 -0700861 session_endpoint_cfg_t *sep;
Florin Coras288eaab2019-02-03 15:26:14 -0800862 session_t *tls_listener;
863 session_t *app_listener;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200864 crypto_engine_type_t engine_type;
Florin Coras74cac882018-09-07 09:13:15 -0700865 application_t *app;
Florin Corasa27a46e2019-02-18 13:02:28 -0800866 app_listener_t *al;
Florin Coras15531972018-08-12 23:50:53 -0700867 tls_ctx_t *lctx;
868 u32 lctx_index;
Florin Corase5f18332021-04-22 11:48:35 -0700869 int rv;
Florin Coras371ca502018-02-21 12:07:41 -0800870
Florin Coras5665ced2018-10-25 18:03:45 -0700871 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -0700872 if (!sep->ext_cfg)
Florin Corase5f18332021-04-22 11:48:35 -0700873 return SESSION_E_NOEXTCFG;
Florin Corasa54b62d2021-04-21 09:05:56 -0700874
Florin Coras15531972018-08-12 23:50:53 -0700875 app_wrk = app_worker_get (sep->app_wrk_index);
876 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -0700877
878 ccfg = &sep->ext_cfg->crypto;
879 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200880 if (engine_type == CRYPTO_ENGINE_NONE)
Florin Coras58d36f02018-03-09 13:05:53 -0800881 {
882 clib_warning ("No tls engine_type available");
Florin Corase5f18332021-04-22 11:48:35 -0700883 return SESSION_E_NOCRYPTOENG;
Florin Coras58d36f02018-03-09 13:05:53 -0800884 }
885
Dave Barachb7b92992018-10-17 10:38:51 -0400886 clib_memset (args, 0, sizeof (*args));
Florin Coras74cac882018-09-07 09:13:15 -0700887 args->app_index = tm->app_index;
888 args->sep_ext = *sep;
Florin Coras8a140612019-02-18 22:39:39 -0800889 args->sep_ext.ns_index = app->ns_index;
Florin Coras95cd8642019-12-30 21:53:19 -0800890 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
Florin Coras4b47ee22020-11-19 13:38:26 -0800891 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
892 {
893 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
894 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
895 }
Florin Corase5f18332021-04-22 11:48:35 -0700896 if ((rv = vnet_listen (args)))
897 return rv;
Florin Coras371ca502018-02-21 12:07:41 -0800898
Florin Coras74cac882018-09-07 09:13:15 -0700899 lctx_index = tls_listener_ctx_alloc ();
Florin Corasa27a46e2019-02-18 13:02:28 -0800900 tls_al_handle = args->handle;
901 al = app_listener_get_w_handle (tls_al_handle);
902 tls_listener = app_listener_get_session (al);
Florin Coras371ca502018-02-21 12:07:41 -0800903 tls_listener->opaque = lctx_index;
Florin Coras58d36f02018-03-09 13:05:53 -0800904
Florin Coras5c9083d2018-04-13 06:39:07 -0700905 app_listener = listen_session_get (app_listener_index);
Florin Coras58d36f02018-03-09 13:05:53 -0800906
907 lctx = tls_listener_ctx_get (lctx_index);
Florin Corasdf57ea02019-02-18 20:14:20 -0800908 lctx->parent_app_wrk_index = sep->app_wrk_index;
Florin Corasa27a46e2019-02-18 13:02:28 -0800909 lctx->tls_session_handle = tls_al_handle;
Florin Coras371ca502018-02-21 12:07:41 -0800910 lctx->app_session_handle = listen_session_get_handle (app_listener);
911 lctx->tcp_is_ip4 = sep->is_ip4;
Florin Coras58d36f02018-03-09 13:05:53 -0800912 lctx->tls_ctx_engine = engine_type;
Florin Coras4b47ee22020-11-19 13:38:26 -0800913 lctx->tls_type = sep->transport_proto;
Florin Corasa54b62d2021-04-21 09:05:56 -0700914 lctx->ckpair_index = ccfg->ckpair_index;
Florin Coras7705b492022-02-16 17:12:01 -0800915 lctx->c_s_index = app_listener_index;
Filip Tehlar61e26be2021-12-20 14:40:59 +0000916 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Coras58d36f02018-03-09 13:05:53 -0800917
Florin Corasae3eaac2019-07-23 22:38:16 -0700918 if (tls_vfts[engine_type].ctx_start_listen (lctx))
919 {
920 vnet_unlisten_args_t a = {
921 .handle = lctx->tls_session_handle,
922 .app_index = tls_main.app_index,
923 .wrk_map_index = 0
924 };
925 if ((vnet_unlisten (&a)))
926 clib_warning ("unlisten returned");
927 tls_listener_ctx_free (lctx);
928 lctx_index = SESSION_INVALID_INDEX;
929 }
Ping Yudecda5b2018-08-13 06:20:00 -0400930
Florin Coras58d36f02018-03-09 13:05:53 -0800931 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
932 engine_type);
Florin Coras371ca502018-02-21 12:07:41 -0800933 return lctx_index;
934}
935
936u32
Florin Corase3e2f072018-03-04 07:24:30 -0800937tls_stop_listen (u32 lctx_index)
Florin Coras371ca502018-02-21 12:07:41 -0800938{
Florin Corasaab06042020-02-26 02:56:14 +0000939 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +0200940 crypto_engine_type_t engine_type;
Florin Corasaab06042020-02-26 02:56:14 +0000941 transport_connection_t *lc;
Florin Corasb5e94e32018-09-14 14:46:39 -0700942 tls_ctx_t *lctx;
Florin Corasaab06042020-02-26 02:56:14 +0000943 session_t *ls;
Florin Corasc1a42652019-02-08 18:27:29 -0800944 int rv;
Ping Yudecda5b2018-08-13 06:20:00 -0400945
Florin Corase3e2f072018-03-04 07:24:30 -0800946 lctx = tls_listener_ctx_get (lctx_index);
Florin Corasaab06042020-02-26 02:56:14 +0000947
948 /* Cleanup listener from session lookup table */
949 ls = session_get_from_handle (lctx->tls_session_handle);
950 lc = session_get_transport (ls);
951
952 sep.fib_index = lc->fib_index;
953 sep.port = lc->lcl_port;
954 sep.is_ip4 = lc->is_ip4;
Florin Coras4b47ee22020-11-19 13:38:26 -0800955 sep.transport_proto = lctx->tls_type;
Florin Corasaab06042020-02-26 02:56:14 +0000956 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
957 session_lookup_del_session_endpoint2 (&sep);
958
Florin Corasc1a42652019-02-08 18:27:29 -0800959 vnet_unlisten_args_t a = {
Florin Corasb5e94e32018-09-14 14:46:39 -0700960 .handle = lctx->tls_session_handle,
961 .app_index = tls_main.app_index,
962 .wrk_map_index = 0 /* default wrk */
963 };
Florin Corasc1a42652019-02-08 18:27:29 -0800964 if ((rv = vnet_unlisten (&a)))
965 clib_warning ("unlisten returned %d", rv);
Florin Corasb5e94e32018-09-14 14:46:39 -0700966
Ping Yudecda5b2018-08-13 06:20:00 -0400967 engine_type = lctx->tls_ctx_engine;
968 tls_vfts[engine_type].ctx_stop_listen (lctx);
969
Florin Corase3e2f072018-03-04 07:24:30 -0800970 tls_listener_ctx_free (lctx);
Florin Coras371ca502018-02-21 12:07:41 -0800971 return 0;
972}
973
974transport_connection_t *
Florin Corase3e2f072018-03-04 07:24:30 -0800975tls_connection_get (u32 ctx_index, u32 thread_index)
976{
977 tls_ctx_t *ctx;
978 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
979 return &ctx->connection;
980}
981
982transport_connection_t *
Florin Coras371ca502018-02-21 12:07:41 -0800983tls_listener_get (u32 listener_index)
984{
985 tls_ctx_t *ctx;
986 ctx = tls_listener_ctx_get (listener_index);
987 return &ctx->connection;
988}
989
Florin Coras2c876f92021-05-10 21:12:27 -0700990static transport_connection_t *
991tls_half_open_get (u32 ho_index)
992{
Florin Coras2c876f92021-05-10 21:12:27 -0700993 tls_ctx_t *ctx;
994 ctx = tls_ctx_half_open_get (ho_index);
Florin Coras2c876f92021-05-10 21:12:27 -0700995 return &ctx->connection;
996}
997
998static void
999tls_cleanup_ho (u32 ho_index)
1000{
Florin Coras2c876f92021-05-10 21:12:27 -07001001 tls_ctx_t *ctx;
Florin Coras4aaedaa2023-11-10 09:48:39 -08001002 session_t *s;
Florin Corasbab6c522021-05-13 08:36:56 -07001003
Florin Coras2c876f92021-05-10 21:12:27 -07001004 ctx = tls_ctx_half_open_get (ho_index);
Florin Corasa474bc82023-12-04 20:29:52 -08001005 /* Already pending cleanup */
1006 if (ctx->tls_session_handle == SESSION_INVALID_HANDLE)
1007 {
1008 ASSERT (ctx->flags & TLS_CONN_F_HO_DONE);
Florin Coras4a98b932024-01-31 13:45:39 -08001009 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Corasa474bc82023-12-04 20:29:52 -08001010 return;
1011 }
1012
Florin Coras4aaedaa2023-11-10 09:48:39 -08001013 s = session_get_from_handle (ctx->tls_session_handle);
1014 /* If no pending cleanup notification, force cleanup now. Otherwise,
1015 * wait for cleanup notification and set no app session on ctx */
1016 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1017 {
1018 session_cleanup_half_open (ctx->tls_session_handle);
1019 tls_ctx_half_open_free (ho_index);
1020 }
1021 else
Florin Coras4a98b932024-01-31 13:45:39 -08001022 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
Florin Coras2c876f92021-05-10 21:12:27 -07001023}
1024
Florin Corasf940f8a2019-03-06 10:44:38 -08001025int
Florin Coras9f86d222020-03-23 15:34:22 +00001026tls_custom_tx_callback (void *session, transport_send_params_t * sp)
Florin Corasf940f8a2019-03-06 10:44:38 -08001027{
Florin Coras00d7d862023-09-22 19:26:33 -07001028 session_t *as = (session_t *) session;
Florin Corasf940f8a2019-03-06 10:44:38 -08001029 tls_ctx_t *ctx;
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001030
Florin Coras00d7d862023-09-22 19:26:33 -07001031 if (PREDICT_FALSE (as->session_state >= SESSION_STATE_TRANSPORT_CLOSED ||
1032 as->session_state <= SESSION_STATE_ACCEPTING))
1033 {
1034 sp->flags |= TRANSPORT_SND_F_DESCHED;
1035 return 0;
1036 }
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001037
Florin Coras00d7d862023-09-22 19:26:33 -07001038 ctx = tls_ctx_get (as->connection_index);
1039 return tls_ctx_write (ctx, as, sp);
Florin Corasf940f8a2019-03-06 10:44:38 -08001040}
1041
Florin Coras371ca502018-02-21 12:07:41 -08001042u8 *
1043format_tls_ctx (u8 * s, va_list * args)
1044{
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001045 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
Florin Coras371ca502018-02-21 12:07:41 -08001046 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
Florin Coras4b47ee22020-11-19 13:38:26 -08001047 char *proto;
Florin Coras371ca502018-02-21 12:07:41 -08001048
Florin Coras4b47ee22020-11-19 13:38:26 -08001049 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001050 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
1051 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
Florin Coras4b47ee22020-11-19 13:38:26 -08001052 s =
1053 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
1054 ctx->c_thread_index, ctx->c_s_index, proto,
1055 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
Florin Coras371ca502018-02-21 12:07:41 -08001056
Florin Coras371ca502018-02-21 12:07:41 -08001057 return s;
1058}
1059
Florin Coras0d74dd12020-01-07 19:01:26 +00001060static u8 *
1061format_tls_listener_ctx (u8 * s, va_list * args)
1062{
1063 session_t *tls_listener;
1064 app_listener_t *al;
Florin Coras0d74dd12020-01-07 19:01:26 +00001065 tls_ctx_t *ctx;
Florin Coras4b47ee22020-11-19 13:38:26 -08001066 char *proto;
Florin Coras0d74dd12020-01-07 19:01:26 +00001067
1068 ctx = va_arg (*args, tls_ctx_t *);
1069
Florin Coras4b47ee22020-11-19 13:38:26 -08001070 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
Florin Coras0d74dd12020-01-07 19:01:26 +00001071 al = app_listener_get_w_handle (ctx->tls_session_handle);
1072 tls_listener = app_listener_get_session (al);
Florin Coras4b47ee22020-11-19 13:38:26 -08001073 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
1074 ctx->c_thread_index, ctx->c_s_index, proto,
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001075 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
Florin Coras0d74dd12020-01-07 19:01:26 +00001076 tls_listener->thread_index, tls_listener->session_index);
1077
1078 return s;
1079}
1080
1081static u8 *
1082format_tls_ctx_state (u8 * s, va_list * args)
1083{
1084 tls_ctx_t *ctx;
1085 session_t *ts;
1086
1087 ctx = va_arg (*args, tls_ctx_t *);
jiangxiaoming5b7ea912020-09-23 10:29:21 +08001088 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
Florin Coras0d74dd12020-01-07 19:01:26 +00001089 if (ts->session_state == SESSION_STATE_LISTENING)
1090 s = format (s, "%s", "LISTEN");
Florin Coras0d74dd12020-01-07 19:01:26 +00001091 else
Florin Coras681ea6d2020-04-24 16:59:49 +00001092 {
1093 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1094 s = format (s, "%s", "CLOSED");
1095 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1096 s = format (s, "%s", "APP-CLOSED");
1097 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1098 s = format (s, "%s", "CLOSING");
1099 else if (tls_ctx_handshake_is_over (ctx))
1100 s = format (s, "%s", "ESTABLISHED");
1101 else
1102 s = format (s, "%s", "HANDSHAKE");
1103 }
Florin Coras0d74dd12020-01-07 19:01:26 +00001104
1105 return s;
1106}
1107
Florin Coras371ca502018-02-21 12:07:41 -08001108u8 *
1109format_tls_connection (u8 * s, va_list * args)
1110{
1111 u32 ctx_index = va_arg (*args, u32);
1112 u32 thread_index = va_arg (*args, u32);
1113 u32 verbose = va_arg (*args, u32);
1114 tls_ctx_t *ctx;
1115
1116 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1117 if (!ctx)
1118 return s;
1119
Florin Coras7bf6ed62020-09-23 12:02:08 -07001120 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
Florin Coras371ca502018-02-21 12:07:41 -08001121 if (verbose)
1122 {
Florin Coras7bf6ed62020-09-23 12:02:08 -07001123 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1124 ctx);
Florin Coras371ca502018-02-21 12:07:41 -08001125 if (verbose > 1)
1126 s = format (s, "\n");
1127 }
1128 return s;
1129}
1130
1131u8 *
1132format_tls_listener (u8 * s, va_list * args)
1133{
1134 u32 tc_index = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +02001135 u32 __clib_unused thread_index = va_arg (*args, u32);
Florin Coras0d74dd12020-01-07 19:01:26 +00001136 u32 verbose = va_arg (*args, u32);
Florin Coras371ca502018-02-21 12:07:41 -08001137 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
Florin Coras371ca502018-02-21 12:07:41 -08001138
Florin Coras7bf6ed62020-09-23 12:02:08 -07001139 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
Florin Coras0d74dd12020-01-07 19:01:26 +00001140 if (verbose)
Florin Coras7bf6ed62020-09-23 12:02:08 -07001141 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
Florin Corasbf7ce2c2019-03-06 14:44:42 -08001142 return s;
Florin Coras371ca502018-02-21 12:07:41 -08001143}
1144
1145u8 *
1146format_tls_half_open (u8 * s, va_list * args)
1147{
Florin Coras2c876f92021-05-10 21:12:27 -07001148 u32 ho_index = va_arg (*args, u32);
Aloys Augustina0abbff2019-07-12 12:16:16 +02001149 u32 __clib_unused thread_index = va_arg (*args, u32);
Florin Corasd69ef3a2023-10-02 10:41:54 -07001150 u32 __clib_unused verbose = va_arg (*args, u32);
Florin Coras2c876f92021-05-10 21:12:27 -07001151 session_t *tcp_ho;
1152 tls_ctx_t *ho_ctx;
1153
1154 ho_ctx = tls_ctx_half_open_get (ho_index);
1155
1156 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1157 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1158 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1159 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1160 tcp_ho->thread_index, tcp_ho->session_index);
1161
Florin Coras371ca502018-02-21 12:07:41 -08001162 return s;
1163}
1164
Yu Ping0b819152019-05-07 02:24:30 +08001165static void
1166tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1167 transport_endpoint_t * tep, u8 is_lcl)
1168{
1169 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1170 session_t *tcp_session;
1171
1172 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1173 session_get_endpoint (tcp_session, tep, is_lcl);
1174}
1175
1176static void
1177tls_transport_listener_endpoint_get (u32 ctx_handle,
1178 transport_endpoint_t * tep, u8 is_lcl)
1179{
1180 session_t *tls_listener;
1181 app_listener_t *al;
1182 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1183
1184 al = app_listener_get_w_handle (ctx->tls_session_handle);
1185 tls_listener = app_listener_get_session (al);
1186 session_get_endpoint (tls_listener, tep, is_lcl);
1187}
1188
Florin Coras0a9ab822020-10-25 14:01:37 -07001189static clib_error_t *
1190tls_enable (vlib_main_t * vm, u8 is_en)
1191{
Florin Coras0a9ab822020-10-25 14:01:37 -07001192 vnet_app_detach_args_t _da, *da = &_da;
1193 vnet_app_attach_args_t _a, *a = &_a;
1194 u64 options[APP_OPTIONS_N_OPTIONS];
1195 tls_main_t *tm = &tls_main;
Florin Corasc1b03802023-09-30 15:21:08 -07001196 u32 fifo_size = 512 << 10;
Florin Coras0a9ab822020-10-25 14:01:37 -07001197
1198 if (!is_en)
1199 {
1200 da->app_index = tm->app_index;
1201 da->api_client_index = APP_INVALID_INDEX;
1202 vnet_application_detach (da);
1203 return 0;
1204 }
1205
Florin Coras0a9ab822020-10-25 14:01:37 -07001206 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1207
1208 clib_memset (a, 0, sizeof (*a));
1209 clib_memset (options, 0, sizeof (options));
1210
1211 a->session_cb_vft = &tls_app_cb_vft;
1212 a->api_client_index = APP_INVALID_INDEX;
1213 a->options = options;
1214 a->name = format (0, "tls");
Florin Corasa3767bd2021-11-18 15:25:31 -08001215 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1216 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
Florin Coras0a9ab822020-10-25 14:01:37 -07001217 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1218 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1219 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1220 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1221 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1222
1223 if (vnet_application_attach (a))
1224 {
1225 clib_warning ("failed to attach tls app");
1226 return clib_error_return (0, "failed to attach tls app");
1227 }
1228
1229 tm->app_index = a->app_index;
1230 vec_free (a->name);
1231
1232 return 0;
1233}
1234
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001235static const transport_proto_vft_t tls_proto = {
Florin Coras0a9ab822020-10-25 14:01:37 -07001236 .enable = tls_enable,
Florin Coras1ee78302019-02-05 15:51:15 -08001237 .connect = tls_connect,
Florin Coras371ca502018-02-21 12:07:41 -08001238 .close = tls_disconnect,
Florin Coras1ee78302019-02-05 15:51:15 -08001239 .start_listen = tls_start_listen,
1240 .stop_listen = tls_stop_listen,
Florin Corase3e2f072018-03-04 07:24:30 -08001241 .get_connection = tls_connection_get,
Florin Coras371ca502018-02-21 12:07:41 -08001242 .get_listener = tls_listener_get,
Florin Coras2c876f92021-05-10 21:12:27 -07001243 .get_half_open = tls_half_open_get,
1244 .cleanup_ho = tls_cleanup_ho,
Florin Corasf940f8a2019-03-06 10:44:38 -08001245 .custom_tx = tls_custom_tx_callback,
Florin Coras371ca502018-02-21 12:07:41 -08001246 .format_connection = format_tls_connection,
1247 .format_half_open = format_tls_half_open,
1248 .format_listener = format_tls_listener,
Yu Ping0b819152019-05-07 02:24:30 +08001249 .get_transport_endpoint = tls_transport_endpoint_get,
1250 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001251 .transport_options = {
Florin Coras07063b82020-03-13 04:44:51 +00001252 .name = "tls",
1253 .short_name = "J",
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001254 .tx_type = TRANSPORT_TX_INTERNAL,
Florin Coras2c876f92021-05-10 21:12:27 -07001255 .service_type = TRANSPORT_SERVICE_VC,
Nathan Skrzypczake971bc92019-06-19 13:42:37 +02001256 },
Florin Coras371ca502018-02-21 12:07:41 -08001257};
Florin Coras4b47ee22020-11-19 13:38:26 -08001258
1259int
1260dtls_connect (transport_endpoint_cfg_t *tep)
1261{
1262 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
Florin Corasa54b62d2021-04-21 09:05:56 -07001263 transport_endpt_crypto_cfg_t *ccfg;
Florin Coras4b47ee22020-11-19 13:38:26 -08001264 crypto_engine_type_t engine_type;
1265 session_endpoint_cfg_t *sep;
1266 tls_main_t *tm = &tls_main;
1267 app_worker_t *app_wrk;
1268 application_t *app;
1269 tls_ctx_t *ctx;
1270 u32 ctx_handle;
1271 int rv;
1272
1273 sep = (session_endpoint_cfg_t *) tep;
Florin Corasa54b62d2021-04-21 09:05:56 -07001274 if (!sep->ext_cfg)
1275 return -1;
1276
Florin Coras4b47ee22020-11-19 13:38:26 -08001277 app_wrk = app_worker_get (sep->app_wrk_index);
1278 app = application_get (app_wrk->app_index);
Florin Corasa54b62d2021-04-21 09:05:56 -07001279
1280 ccfg = &sep->ext_cfg->crypto;
1281 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
Florin Coras4b47ee22020-11-19 13:38:26 -08001282 if (engine_type == CRYPTO_ENGINE_NONE)
1283 {
1284 clib_warning ("No tls engine_type available");
1285 return -1;
1286 }
1287
Florin Corasfb50bc32021-05-18 00:28:59 -07001288 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1289 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
Florin Coras4b47ee22020-11-19 13:38:26 -08001290 ctx->parent_app_wrk_index = sep->app_wrk_index;
1291 ctx->parent_app_api_context = sep->opaque;
1292 ctx->tcp_is_ip4 = sep->is_ip4;
Florin Corasa54b62d2021-04-21 09:05:56 -07001293 ctx->ckpair_index = ccfg->ckpair_index;
Florin Coras4b47ee22020-11-19 13:38:26 -08001294 ctx->tls_type = sep->transport_proto;
1295 ctx->tls_ctx_handle = ctx_handle;
Florin Corasbab6c522021-05-13 08:36:56 -07001296 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1297 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
Florin Corasa54b62d2021-04-21 09:05:56 -07001298 if (ccfg->hostname[0])
Florin Coras4b47ee22020-11-19 13:38:26 -08001299 {
Florin Corasa54b62d2021-04-21 09:05:56 -07001300 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
Florin Coras4b47ee22020-11-19 13:38:26 -08001301 vec_terminate_c_string (ctx->srv_hostname);
1302 }
1303
Florin Coras4b47ee22020-11-19 13:38:26 -08001304 ctx->tls_ctx_engine = engine_type;
1305
1306 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1307 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1308 cargs->app_index = tm->app_index;
1309 cargs->api_context = ctx_handle;
1310 cargs->sep_ext.ns_index = app->ns_index;
1311 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1312 if ((rv = vnet_connect (cargs)))
1313 return rv;
1314
1315 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1316 engine_type);
Florin Corasbab6c522021-05-13 08:36:56 -07001317 return ctx_handle;
1318}
1319
1320static transport_connection_t *
1321dtls_half_open_get (u32 ho_index)
1322{
1323 tls_ctx_t *ho_ctx;
Florin Corasfb50bc32021-05-18 00:28:59 -07001324 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
Florin Corasbab6c522021-05-13 08:36:56 -07001325 return &ho_ctx->connection;
Florin Coras4b47ee22020-11-19 13:38:26 -08001326}
1327
1328static void
1329dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1330{
1331 /* No op */
1332}
1333
Florin Corasbab6c522021-05-13 08:36:56 -07001334static void
1335dtls_cleanup_ho (u32 ho_index)
1336{
1337 tls_ctx_t *ctx;
Florin Corasfb50bc32021-05-18 00:28:59 -07001338 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
Florin Corasbab6c522021-05-13 08:36:56 -07001339 tls_ctx_free (ctx);
1340}
1341
1342u8 *
1343format_dtls_half_open (u8 *s, va_list *args)
1344{
1345 u32 ho_index = va_arg (*args, u32);
1346 u32 __clib_unused thread_index = va_arg (*args, u32);
1347 tls_ctx_t *ho_ctx;
1348 session_t *us;
1349
Florin Corasfb50bc32021-05-18 00:28:59 -07001350 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
Florin Corasbab6c522021-05-13 08:36:56 -07001351
1352 us = session_get_from_handle (ho_ctx->tls_session_handle);
1353 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1354 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1355 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1356 us->thread_index, us->session_index);
1357
1358 return s;
1359}
1360
Florin Coras4b47ee22020-11-19 13:38:26 -08001361static const transport_proto_vft_t dtls_proto = {
1362 .enable = 0,
1363 .connect = dtls_connect,
1364 .close = tls_disconnect,
1365 .start_listen = tls_start_listen,
1366 .stop_listen = tls_stop_listen,
1367 .get_connection = tls_connection_get,
1368 .get_listener = tls_listener_get,
Florin Corasbab6c522021-05-13 08:36:56 -07001369 .get_half_open = dtls_half_open_get,
Florin Coras4b47ee22020-11-19 13:38:26 -08001370 .custom_tx = tls_custom_tx_callback,
1371 .cleanup = dtls_cleanup_callback,
Florin Corasbab6c522021-05-13 08:36:56 -07001372 .cleanup_ho = dtls_cleanup_ho,
Florin Coras4b47ee22020-11-19 13:38:26 -08001373 .format_connection = format_tls_connection,
Florin Corasbab6c522021-05-13 08:36:56 -07001374 .format_half_open = format_dtls_half_open,
Florin Coras4b47ee22020-11-19 13:38:26 -08001375 .format_listener = format_tls_listener,
1376 .get_transport_endpoint = tls_transport_endpoint_get,
1377 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1378 .transport_options = {
1379 .name = "dtls",
1380 .short_name = "D",
1381 .tx_type = TRANSPORT_TX_INTERNAL,
Florin Corasbab6c522021-05-13 08:36:56 -07001382 .service_type = TRANSPORT_SERVICE_VC,
Florin Coras4b47ee22020-11-19 13:38:26 -08001383 },
1384};
Florin Coras371ca502018-02-21 12:07:41 -08001385
Florin Corasd77eee62018-03-07 08:49:27 -08001386void
Nathan Skrzypczak82fc5fd2019-09-13 10:20:15 +02001387tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
Florin Coras371ca502018-02-21 12:07:41 -08001388{
Florin Corasd77eee62018-03-07 08:49:27 -08001389 vec_validate (tls_vfts, type);
1390 tls_vfts[type] = *vft;
Florin Coras371ca502018-02-21 12:07:41 -08001391}
1392
Dave Barachcc5677b2018-03-28 19:08:45 -04001393static clib_error_t *
Florin Coras371ca502018-02-21 12:07:41 -08001394tls_init (vlib_main_t * vm)
1395{
Florin Coras58d36f02018-03-09 13:05:53 -08001396 vlib_thread_main_t *vtm = vlib_get_thread_main ();
Florin Coras371ca502018-02-21 12:07:41 -08001397 tls_main_t *tm = &tls_main;
Florin Coras0a9ab822020-10-25 14:01:37 -07001398 u32 num_threads;
Florin Coras58d36f02018-03-09 13:05:53 -08001399
1400 num_threads = 1 /* main thread */ + vtm->n_threads;
Florin Coras371ca502018-02-21 12:07:41 -08001401
Florin Corasd77eee62018-03-07 08:49:27 -08001402 if (!tm->ca_cert_path)
1403 tm->ca_cert_path = TLS_CA_CERT_PATH;
1404
Florin Coras58d36f02018-03-09 13:05:53 -08001405 vec_validate (tm->rx_bufs, num_threads - 1);
1406 vec_validate (tm->tx_bufs, num_threads - 1);
1407
Florin Corasa3767bd2021-11-18 15:25:31 -08001408 tm->first_seg_size = 32 << 20;
1409 tm->add_seg_size = 256 << 20;
1410
Florin Coras371ca502018-02-21 12:07:41 -08001411 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1412 FIB_PROTOCOL_IP4, ~0);
1413 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1414 FIB_PROTOCOL_IP6, ~0);
Florin Coras4b47ee22020-11-19 13:38:26 -08001415
1416 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1417 FIB_PROTOCOL_IP4, ~0);
1418 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1419 FIB_PROTOCOL_IP6, ~0);
Florin Coras371ca502018-02-21 12:07:41 -08001420 return 0;
1421}
1422
1423VLIB_INIT_FUNCTION (tls_init);
1424
Florin Coras8f89dd02018-03-05 16:53:07 -08001425static clib_error_t *
1426tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1427{
1428 tls_main_t *tm = &tls_main;
Dave Wallaceb1a81aa2019-10-30 17:53:56 +00001429 uword tmp;
Florin Coras8f89dd02018-03-05 16:53:07 -08001430 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1431 {
1432 if (unformat (input, "use-test-cert-in-ca"))
1433 tm->use_test_cert_in_ca = 1;
1434 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1435 ;
Florin Corasddd98f32019-03-25 08:30:53 -07001436 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1437 &tm->first_seg_size))
1438 ;
Florin Corasa3767bd2021-11-18 15:25:31 -08001439 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1440 &tm->add_seg_size))
1441 ;
Dave Wallaceb1a81aa2019-10-30 17:53:56 +00001442 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1443 {
1444 if (tmp >= 0x100000000ULL)
1445 {
1446 return clib_error_return
1447 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1448 }
1449 tm->fifo_size = tmp;
1450 }
Florin Coras8f89dd02018-03-05 16:53:07 -08001451 else
1452 return clib_error_return (0, "unknown input `%U'",
1453 format_unformat_error, input);
1454 }
1455 return 0;
1456}
1457
Florin Coras1cbcdce2022-04-06 15:10:13 -07001458VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
Florin Corasd77eee62018-03-07 08:49:27 -08001459
1460tls_main_t *
1461vnet_tls_get_main (void)
1462{
1463 return &tls_main;
1464}
1465
Florin Coras371ca502018-02-21 12:07:41 -08001466/*
1467 * fd.io coding-style-patch-verification: ON
1468 *
1469 * Local Variables:
1470 * eval: (c-set-style "gnu")
1471 * End:
1472 */