2 * Copyright (c) 2018-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/session/application_interface.h>
17 #include <vppinfra/lock.h>
18 #include <vnet/tls/tls.h>
20 static tls_main_t tls_main;
21 static tls_engine_vft_t *tls_vfts;
23 #define TLS_INVALID_HANDLE ~0
24 #define TLS_IDX_MASK 0x00FFFFFF
25 #define TLS_ENGINE_TYPE_SHIFT 28
27 void tls_disconnect (u32 ctx_handle, u32 thread_index);
30 tls_disconnect_transport (tls_ctx_t * ctx)
32 vnet_disconnect_args_t a = {
33 .handle = ctx->tls_session_handle,
34 .app_index = tls_main.app_index,
37 if (vnet_disconnect_session (&a))
38 clib_warning ("disconnect returned");
42 tls_get_available_engine (void)
45 for (i = 0; i < vec_len (tls_vfts); i++)
47 if (tls_vfts[i].ctx_alloc)
50 return CRYPTO_ENGINE_NONE;
54 tls_add_vpp_q_rx_evt (session_t * s)
56 if (svm_fifo_set_event (s->rx_fifo))
57 session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_RX);
62 tls_add_vpp_q_builtin_rx_evt (session_t * s)
64 session_enqueue_notify (s);
69 tls_add_vpp_q_tx_evt (session_t * s)
71 if (svm_fifo_set_event (s->tx_fifo))
72 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
77 tls_add_app_q_evt (app_worker_t *app_wrk, session_t *app_session)
79 app_worker_add_event (app_wrk, app_session, SESSION_IO_EVT_RX);
84 tls_listener_ctx_alloc (void)
86 tls_main_t *tm = &tls_main;
89 pool_get (tm->listener_ctx_pool, ctx);
90 clib_memset (ctx, 0, sizeof (*ctx));
91 return ctx - tm->listener_ctx_pool;
95 tls_listener_ctx_free (tls_ctx_t * ctx)
98 memset (ctx, 0xfb, sizeof (*ctx));
99 pool_put (tls_main.listener_ctx_pool, ctx);
103 tls_listener_ctx_get (u32 ctx_index)
105 return pool_elt_at_index (tls_main.listener_ctx_pool, ctx_index);
109 tls_listener_ctx_index (tls_ctx_t * ctx)
111 return (ctx - tls_main.listener_ctx_pool);
115 tls_ctx_half_open_alloc (void)
117 tls_main_t *tm = &tls_main;
120 if (vec_len (tm->postponed_ho_free))
121 tls_flush_postponed_ho_cleanups ();
123 pool_get_aligned_safe (tm->half_open_ctx_pool, ctx, CLIB_CACHE_LINE_BYTES);
125 clib_memset (ctx, 0, sizeof (*ctx));
126 ctx->c_c_index = ctx - tm->half_open_ctx_pool;
127 ctx->c_thread_index = transport_cl_thread ();
129 return ctx->c_c_index;
133 tls_ctx_half_open_free (u32 ho_index)
135 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
139 tls_ctx_half_open_get (u32 ctx_index)
141 tls_main_t *tm = &tls_main;
142 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
146 tls_add_postponed_ho_cleanups (u32 ho_index)
148 tls_main_t *tm = &tls_main;
149 vec_add1 (tm->postponed_ho_free, ho_index);
153 tls_ctx_ho_try_free (u32 ho_index)
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))
163 ctx->tls_session_handle = SESSION_INVALID_HANDLE;
164 tls_add_postponed_ho_cleanups (ho_index);
167 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
168 session_half_open_delete_notify (&ctx->connection);
169 tls_ctx_half_open_free (ho_index);
173 tls_flush_postponed_ho_cleanups ()
175 tls_main_t *tm = &tls_main;
176 u32 *ho_indexp, *tmp;
178 tmp = tm->postponed_ho_free;
179 tm->postponed_ho_free = tm->ho_free_list;
180 tm->ho_free_list = tmp;
182 vec_foreach (ho_indexp, tm->ho_free_list)
183 tls_ctx_ho_try_free (*ho_indexp);
185 vec_reset_length (tm->ho_free_list);
189 tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
191 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);
198 tls_notify_app_accept (tls_ctx_t * ctx)
200 session_t *app_listener, *app_session;
201 app_worker_t *app_wrk;
205 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
206 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
208 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
209 app_session->app_wrk_index = ctx->parent_app_wrk_index;
210 app_session->connection_index = ctx->tls_ctx_handle;
211 app_session->session_type = app_listener->session_type;
212 app_session->listener_handle = listen_session_get_handle (app_listener);
213 app_session->session_state = SESSION_STATE_ACCEPTING;
215 if ((rv = app_worker_init_accepted (app_session)))
217 TLS_DBG (1, "failed to allocate fifos");
218 session_free (app_session);
219 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
222 ctx->app_session_handle = session_handle (app_session);
223 ctx->parent_app_wrk_index = app_session->app_wrk_index;
224 app_wrk = app_worker_get (app_session->app_wrk_index);
225 return app_worker_accept_notify (app_wrk, app_session);
229 tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
231 u32 parent_app_api_ctx;
232 session_t *app_session;
233 app_worker_t *app_wrk;
235 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
238 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
239 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
240 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
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));
249 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
253 /* 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)
258 /* Cleanup half-open session as we don't get notification from udp */
259 session_half_open_delete_notify (&ctx->connection);
260 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;
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;
270 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
273 app_session->app_wrk_index = ctx->parent_app_wrk_index;
274 app_session->opaque = ctx->parent_app_api_context;
276 if ((err = app_worker_init_connected (app_wrk, app_session)))
278 app_worker_connect_notify (app_wrk, 0, err, ctx->parent_app_api_context);
279 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
280 session_free (app_session);
284 app_session->session_state = SESSION_STATE_READY;
285 parent_app_api_ctx = ctx->parent_app_api_context;
286 ctx->app_session_handle = session_handle (app_session);
288 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
291 TLS_DBG (1, "failed to notify app");
292 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
293 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
300 return app_worker_connect_notify (app_wrk, 0, err,
301 ctx->parent_app_api_context);
305 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
307 *ctx_index = ctx_handle & TLS_IDX_MASK;
308 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
311 static inline crypto_engine_type_t
312 tls_get_engine_type (crypto_engine_type_t requested,
313 crypto_engine_type_t preferred)
315 if (requested != CRYPTO_ENGINE_NONE)
317 if (tls_vfts[requested].ctx_alloc)
319 return CRYPTO_ENGINE_NONE;
321 if (!tls_vfts[preferred].ctx_alloc)
322 return tls_get_available_engine ();
327 tls_ctx_alloc (crypto_engine_type_t engine_type)
330 ctx_index = tls_vfts[engine_type].ctx_alloc ();
331 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
335 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_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);
343 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
346 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
347 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
351 tls_ctx_detach (tls_ctx_t *ctx)
353 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
356 static inline tls_ctx_t *
357 tls_ctx_get (u32 ctx_handle)
359 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);
364 static inline tls_ctx_t *
365 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
367 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);
373 tls_ctx_init_server (tls_ctx_t * ctx)
375 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
379 tls_ctx_init_client (tls_ctx_t * ctx)
381 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
385 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
386 transport_send_params_t * sp)
390 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);
392 sp->bytes_dequeued = n_wrote;
393 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
397 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
399 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
403 tls_ctx_transport_close (tls_ctx_t * ctx)
405 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
409 tls_ctx_app_close (tls_ctx_t * ctx)
411 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
415 tls_ctx_free (tls_ctx_t * ctx)
417 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
421 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
423 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
427 tls_reinit_ca_chain (crypto_engine_type_t tls_engine_id)
429 return tls_vfts[tls_engine_id].ctx_reinit_cachain ();
433 tls_notify_app_io_error (tls_ctx_t *ctx)
435 ASSERT (tls_ctx_handshake_is_over (ctx));
437 session_transport_reset_notify (&ctx->connection);
438 session_transport_closed_notify (&ctx->connection);
439 tls_disconnect_transport (ctx);
443 tls_session_reset_callback (session_t * s)
446 transport_connection_t *tc;
447 session_t *app_session;
449 ctx = tls_ctx_get (s->opaque);
450 ctx->flags |= TLS_CONN_F_PASSIVE_CLOSE;
451 tc = &ctx->connection;
452 if (tls_ctx_handshake_is_over (ctx))
454 session_transport_reset_notify (tc);
455 session_transport_closed_notify (tc);
456 tls_disconnect_transport (ctx);
460 app_session = session_get_if_valid (ctx->c_s_index, ctx->c_thread_index);
463 session_free (app_session);
464 ctx->c_s_index = SESSION_INVALID_INDEX;
465 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
466 tls_disconnect_transport (ctx);
472 tls_session_cleanup_ho (session_t *s)
474 /* session opaque stores the opaque passed on connect */
475 tls_ctx_ho_try_free (s->opaque);
479 tls_add_segment_callback (u32 client_index, u64 segment_handle)
481 /* No-op for builtin */
486 tls_del_segment_callback (u32 client_index, u64 segment_handle)
492 tls_session_disconnect_callback (session_t * tls_session)
496 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
497 tls_session->session_index);
499 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
500 || vlib_thread_is_main_w_barrier ());
502 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
503 ctx->flags |= TLS_CONN_F_PASSIVE_CLOSE;
504 tls_ctx_transport_close (ctx);
508 tls_session_accept_callback (session_t * tls_session)
510 session_t *tls_listener, *app_session;
511 tls_ctx_t *lctx, *ctx;
515 listen_session_get_from_handle (tls_session->listener_handle);
516 lctx = tls_listener_ctx_get (tls_listener->opaque);
518 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
519 ctx = tls_ctx_get (ctx_handle);
520 memcpy (ctx, lctx, sizeof (*lctx));
521 ctx->c_thread_index = vlib_get_thread_index ();
522 ctx->tls_ctx_handle = ctx_handle;
523 tls_session->session_state = SESSION_STATE_READY;
524 tls_session->opaque = ctx_handle;
525 ctx->tls_session_handle = session_handle (tls_session);
526 ctx->listener_ctx_index = tls_listener->opaque;
527 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
528 ctx->ckpair_index = lctx->ckpair_index;
530 /* 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);
533 app_session->session_state = SESSION_STATE_CREATED;
534 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;
537 ctx->c_s_index = app_session->session_index;
539 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
540 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
542 if (tls_ctx_init_server (ctx))
544 /* Do not free ctx yet, in case we have pending rx events */
545 session_free (app_session);
546 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
547 tls_disconnect_transport (ctx);
554 tls_app_rx_callback (session_t *ts)
558 /* DTLS session migrating, wait for next notification */
559 if (PREDICT_FALSE (ts->flags & SESSION_F_IS_MIGRATING))
562 /* Read rescheduled but underlying transport deleted now */
563 if (PREDICT_FALSE ((ts->session_state == SESSION_STATE_TRANSPORT_DELETED)))
566 ctx = tls_ctx_get (ts->opaque);
567 if (PREDICT_FALSE ((ctx->flags & TLS_CONN_F_NO_APP_SESSION) ||
568 (ctx->flags & TLS_CONN_F_APP_CLOSED)))
570 TLS_DBG (1, "Local App closed");
573 tls_ctx_read (ctx, ts);
578 tls_app_tx_callback (session_t * tls_session)
582 ctx = tls_ctx_get (tls_session->opaque);
583 transport_connection_reschedule (&ctx->connection);
589 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
590 session_t *tls_session, session_error_t err)
592 session_t *app_session;
593 tls_ctx_t *ho_ctx, *ctx;
597 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
598 ho_ctx->flags |= TLS_CONN_F_HO_DONE;
600 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
601 ctx = tls_ctx_get (ctx_handle);
602 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
603 /* Half-open freed on tcp half-open cleanup notification */
605 ctx->c_thread_index = vlib_get_thread_index ();
606 ctx->tls_ctx_handle = ctx_handle;
607 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
609 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
610 ho_ctx_index, err, vlib_get_thread_index (),
611 (ctx) ? ctx_handle : ~0);
613 ctx->tls_session_handle = session_handle (tls_session);
614 tls_session->opaque = ctx_handle;
615 tls_session->session_state = SESSION_STATE_READY;
617 /* Preallocate app session. Avoids allocating a session post handshake
618 * on tls_session rx and potentially invalidating the session pool */
619 app_session = session_alloc (ctx->c_thread_index);
620 app_session->session_state = SESSION_STATE_CREATED;
621 ctx->c_s_index = app_session->session_index;
622 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
623 app_session->session_type = st;
624 app_session->connection_index = ctx->tls_ctx_handle;
626 if (tls_ctx_init_client (ctx))
628 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
629 tls_disconnect_transport (ctx);
636 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
641 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
643 ctx->tls_session_handle = session_handle (us);
644 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
645 us->opaque = ctx_handle;
647 /* We don't preallocate the app session because the udp session might
648 * actually migrate to a different worker at the end of the handshake */
650 return tls_ctx_init_client (ctx);
654 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
655 session_t *tls_session, session_error_t err)
659 app_worker_t *app_wrk;
663 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
664 ho_ctx->flags |= TLS_CONN_F_HO_DONE;
665 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
668 api_context = ho_ctx->parent_app_api_context;
669 app_worker_connect_notify (app_wrk, 0, err, api_context);
675 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
676 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
679 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
684 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
688 if (ntf == SESSION_CLEANUP_TRANSPORT)
690 /* Allow cleanup of tcp session */
691 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
696 ctx = tls_ctx_get (s->opaque);
697 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
698 session_transport_delete_notify (&ctx->connection);
703 dtls_migrate_ctx (void *arg)
705 tls_ctx_t *ctx = (tls_ctx_t *) arg;
706 u32 ctx_handle, thread_index;
709 thread_index = session_thread_from_handle (ctx->tls_session_handle);
710 ASSERT (thread_index == vlib_get_thread_index ());
712 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
713 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
714 ctx->tls_ctx_handle = ctx_handle;
716 us = session_get_from_handle (ctx->tls_session_handle);
717 us->opaque = ctx_handle;
718 us->flags &= ~SESSION_F_IS_MIGRATING;
720 /* Probably the app detached while the session was migrating. Cleanup */
721 if (session_half_open_migrated_notify (&ctx->connection))
723 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
724 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
728 if (svm_fifo_max_dequeue (us->tx_fifo))
729 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
733 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
735 u32 new_thread = session_thread_from_handle (new_sh);
736 tls_ctx_t *ctx, *cloned_ctx;
738 /* Migrate dtls context to new thread */
739 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
740 ctx->tls_session_handle = new_sh;
741 cloned_ctx = tls_ctx_detach (ctx);
742 ctx->flags |= TLS_CONN_F_MIGRATED;
743 session_half_open_migrate_notify (&ctx->connection);
745 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
746 (void *) cloned_ctx);
752 tls_session_transport_closed_callback (session_t *ts)
756 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
757 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
758 session_transport_closed_notify (&ctx->connection);
761 static session_cb_vft_t tls_app_cb_vft = {
762 .session_accept_callback = tls_session_accept_callback,
763 .session_disconnect_callback = tls_session_disconnect_callback,
764 .session_connected_callback = tls_session_connected_callback,
765 .session_reset_callback = tls_session_reset_callback,
766 .session_transport_closed_callback = tls_session_transport_closed_callback,
767 .half_open_cleanup_callback = tls_session_cleanup_ho,
768 .add_segment_callback = tls_add_segment_callback,
769 .del_segment_callback = tls_del_segment_callback,
770 .builtin_app_rx_callback = tls_app_rx_callback,
771 .builtin_app_tx_callback = tls_app_tx_callback,
772 .session_migrate_callback = dtls_session_migrate_callback,
773 .session_cleanup_callback = tls_app_session_cleanup,
777 tls_connect (transport_endpoint_cfg_t * tep)
779 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
780 transport_endpt_crypto_cfg_t *ccfg;
781 crypto_engine_type_t engine_type;
782 session_endpoint_cfg_t *sep;
783 tls_main_t *tm = &tls_main;
784 app_worker_t *app_wrk;
790 sep = (session_endpoint_cfg_t *) tep;
792 return SESSION_E_NOEXTCFG;
794 app_wrk = app_worker_get (sep->app_wrk_index);
795 app = application_get (app_wrk->app_index);
797 ccfg = &sep->ext_cfg->crypto;
798 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
799 if (engine_type == CRYPTO_ENGINE_NONE)
801 clib_warning ("No tls engine_type available");
802 return SESSION_E_NOCRYPTOENG;
805 ctx_index = tls_ctx_half_open_alloc ();
806 ctx = tls_ctx_half_open_get (ctx_index);
807 ctx->parent_app_wrk_index = sep->app_wrk_index;
808 ctx->parent_app_api_context = sep->opaque;
809 ctx->tcp_is_ip4 = sep->is_ip4;
810 ctx->tls_type = sep->transport_proto;
811 ctx->ckpair_index = ccfg->ckpair_index;
812 ctx->c_proto = TRANSPORT_PROTO_TLS;
813 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
814 if (ccfg->hostname[0])
816 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
817 vec_terminate_c_string (ctx->srv_hostname);
820 ctx->tls_ctx_engine = engine_type;
822 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
823 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
824 cargs->app_index = tm->app_index;
825 cargs->api_context = ctx_index;
826 cargs->sep_ext.ns_index = app->ns_index;
827 if ((rv = vnet_connect (cargs)))
829 tls_ctx_half_open_free (ctx_index);
833 /* Track half-open tcp session in case we need to clean it up */
834 ctx->tls_session_handle = cargs->sh;
836 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
841 tls_disconnect (u32 ctx_handle, u32 thread_index)
845 TLS_DBG (1, "Disconnecting %x", ctx_handle);
847 ctx = tls_ctx_get (ctx_handle);
848 ctx->flags |= TLS_CONN_F_APP_CLOSED;
849 tls_ctx_app_close (ctx);
853 tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
855 vnet_listen_args_t _bargs, *args = &_bargs;
856 transport_endpt_crypto_cfg_t *ccfg;
857 app_worker_t *app_wrk;
858 tls_main_t *tm = &tls_main;
859 session_handle_t tls_al_handle;
860 session_endpoint_cfg_t *sep;
861 session_t *tls_listener;
862 session_t *app_listener;
863 crypto_engine_type_t engine_type;
870 sep = (session_endpoint_cfg_t *) tep;
872 return SESSION_E_NOEXTCFG;
874 app_wrk = app_worker_get (sep->app_wrk_index);
875 app = application_get (app_wrk->app_index);
877 ccfg = &sep->ext_cfg->crypto;
878 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
879 if (engine_type == CRYPTO_ENGINE_NONE)
881 clib_warning ("No tls engine_type available");
882 return SESSION_E_NOCRYPTOENG;
885 clib_memset (args, 0, sizeof (*args));
886 args->app_index = tm->app_index;
887 args->sep_ext = *sep;
888 args->sep_ext.ns_index = app->ns_index;
889 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
890 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
892 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
893 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
895 if ((rv = vnet_listen (args)))
898 lctx_index = tls_listener_ctx_alloc ();
899 tls_al_handle = args->handle;
900 al = app_listener_get_w_handle (tls_al_handle);
901 tls_listener = app_listener_get_session (al);
902 tls_listener->opaque = lctx_index;
904 app_listener = listen_session_get (app_listener_index);
906 lctx = tls_listener_ctx_get (lctx_index);
907 lctx->parent_app_wrk_index = sep->app_wrk_index;
908 lctx->tls_session_handle = tls_al_handle;
909 lctx->app_session_handle = listen_session_get_handle (app_listener);
910 lctx->tcp_is_ip4 = sep->is_ip4;
911 lctx->tls_ctx_engine = engine_type;
912 lctx->tls_type = sep->transport_proto;
913 lctx->ckpair_index = ccfg->ckpair_index;
914 lctx->c_s_index = app_listener_index;
915 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
917 if (tls_vfts[engine_type].ctx_start_listen (lctx))
919 vnet_unlisten_args_t a = {
920 .handle = lctx->tls_session_handle,
921 .app_index = tls_main.app_index,
924 if ((vnet_unlisten (&a)))
925 clib_warning ("unlisten returned");
926 tls_listener_ctx_free (lctx);
927 lctx_index = SESSION_INVALID_INDEX;
930 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
936 tls_stop_listen (u32 lctx_index)
938 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
939 crypto_engine_type_t engine_type;
940 transport_connection_t *lc;
945 lctx = tls_listener_ctx_get (lctx_index);
947 /* Cleanup listener from session lookup table */
948 ls = session_get_from_handle (lctx->tls_session_handle);
949 lc = session_get_transport (ls);
951 sep.fib_index = lc->fib_index;
952 sep.port = lc->lcl_port;
953 sep.is_ip4 = lc->is_ip4;
954 sep.transport_proto = lctx->tls_type;
955 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
956 session_lookup_del_session_endpoint2 (&sep);
958 vnet_unlisten_args_t a = {
959 .handle = lctx->tls_session_handle,
960 .app_index = tls_main.app_index,
961 .wrk_map_index = 0 /* default wrk */
963 if ((rv = vnet_unlisten (&a)))
964 clib_warning ("unlisten returned %d", rv);
966 engine_type = lctx->tls_ctx_engine;
967 tls_vfts[engine_type].ctx_stop_listen (lctx);
969 tls_listener_ctx_free (lctx);
973 transport_connection_t *
974 tls_connection_get (u32 ctx_index, u32 thread_index)
977 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
978 return &ctx->connection;
981 transport_connection_t *
982 tls_listener_get (u32 listener_index)
985 ctx = tls_listener_ctx_get (listener_index);
986 return &ctx->connection;
989 static transport_connection_t *
990 tls_half_open_get (u32 ho_index)
993 ctx = tls_ctx_half_open_get (ho_index);
994 return &ctx->connection;
998 tls_cleanup_ho (u32 ho_index)
1003 ctx = tls_ctx_half_open_get (ho_index);
1004 /* Already pending cleanup */
1005 if (ctx->tls_session_handle == SESSION_INVALID_HANDLE)
1007 ASSERT (ctx->flags & TLS_CONN_F_HO_DONE);
1008 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
1012 s = session_get_from_handle (ctx->tls_session_handle);
1013 /* If no pending cleanup notification, force cleanup now. Otherwise,
1014 * wait for cleanup notification and set no app session on ctx */
1015 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1017 session_cleanup_half_open (ctx->tls_session_handle);
1018 tls_ctx_half_open_free (ho_index);
1021 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
1025 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
1027 session_t *as = (session_t *) session;
1030 if (PREDICT_FALSE (as->session_state >= SESSION_STATE_TRANSPORT_CLOSED ||
1031 as->session_state <= SESSION_STATE_ACCEPTING))
1033 sp->flags |= TRANSPORT_SND_F_DESCHED;
1037 ctx = tls_ctx_get (as->connection_index);
1038 return tls_ctx_write (ctx, as, sp);
1042 format_tls_ctx (u8 * s, va_list * args)
1044 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
1045 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
1048 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
1049 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
1050 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
1052 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
1053 ctx->c_thread_index, ctx->c_s_index, proto,
1054 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
1060 format_tls_listener_ctx (u8 * s, va_list * args)
1062 session_t *tls_listener;
1067 ctx = va_arg (*args, tls_ctx_t *);
1069 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
1070 al = app_listener_get_w_handle (ctx->tls_session_handle);
1071 tls_listener = app_listener_get_session (al);
1072 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
1073 ctx->c_thread_index, ctx->c_s_index, proto,
1074 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
1075 tls_listener->thread_index, tls_listener->session_index);
1081 format_tls_ctx_state (u8 * s, va_list * args)
1086 ctx = va_arg (*args, tls_ctx_t *);
1087 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
1088 if (ts->session_state == SESSION_STATE_LISTENING)
1089 s = format (s, "%s", "LISTEN");
1092 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1093 s = format (s, "%s", "CLOSED");
1094 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1095 s = format (s, "%s", "APP-CLOSED");
1096 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1097 s = format (s, "%s", "CLOSING");
1098 else if (tls_ctx_handshake_is_over (ctx))
1099 s = format (s, "%s", "ESTABLISHED");
1101 s = format (s, "%s", "HANDSHAKE");
1108 format_tls_connection (u8 * s, va_list * args)
1110 u32 ctx_index = va_arg (*args, u32);
1111 u32 thread_index = va_arg (*args, u32);
1112 u32 verbose = va_arg (*args, u32);
1115 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1119 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1122 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1125 s = format (s, "\n");
1131 format_tls_listener (u8 * s, va_list * args)
1133 u32 tc_index = va_arg (*args, u32);
1134 u32 __clib_unused thread_index = va_arg (*args, u32);
1135 u32 verbose = va_arg (*args, u32);
1136 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1138 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1140 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1145 format_tls_half_open (u8 * s, va_list * args)
1147 u32 ho_index = va_arg (*args, u32);
1148 u32 __clib_unused thread_index = va_arg (*args, u32);
1149 u32 __clib_unused verbose = va_arg (*args, u32);
1153 ho_ctx = tls_ctx_half_open_get (ho_index);
1155 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1156 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1157 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1158 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1159 tcp_ho->thread_index, tcp_ho->session_index);
1165 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1166 transport_endpoint_t * tep, u8 is_lcl)
1168 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1169 session_t *tcp_session;
1171 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1172 session_get_endpoint (tcp_session, tep, is_lcl);
1176 tls_transport_listener_endpoint_get (u32 ctx_handle,
1177 transport_endpoint_t * tep, u8 is_lcl)
1179 session_t *tls_listener;
1181 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1183 al = app_listener_get_w_handle (ctx->tls_session_handle);
1184 tls_listener = app_listener_get_session (al);
1185 session_get_endpoint (tls_listener, tep, is_lcl);
1188 static clib_error_t *
1189 tls_enable (vlib_main_t * vm, u8 is_en)
1191 vnet_app_detach_args_t _da, *da = &_da;
1192 vnet_app_attach_args_t _a, *a = &_a;
1193 u64 options[APP_OPTIONS_N_OPTIONS];
1194 tls_main_t *tm = &tls_main;
1195 u32 fifo_size = 512 << 10;
1199 da->app_index = tm->app_index;
1200 da->api_client_index = APP_INVALID_INDEX;
1201 vnet_application_detach (da);
1205 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1207 clib_memset (a, 0, sizeof (*a));
1208 clib_memset (options, 0, sizeof (options));
1210 a->session_cb_vft = &tls_app_cb_vft;
1211 a->api_client_index = APP_INVALID_INDEX;
1212 a->options = options;
1213 a->name = format (0, "tls");
1214 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1215 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
1216 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1217 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1218 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1219 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1220 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1222 if (vnet_application_attach (a))
1224 clib_warning ("failed to attach tls app");
1225 return clib_error_return (0, "failed to attach tls app");
1228 tm->app_index = a->app_index;
1234 static const transport_proto_vft_t tls_proto = {
1235 .enable = tls_enable,
1236 .connect = tls_connect,
1237 .close = tls_disconnect,
1238 .start_listen = tls_start_listen,
1239 .stop_listen = tls_stop_listen,
1240 .get_connection = tls_connection_get,
1241 .get_listener = tls_listener_get,
1242 .get_half_open = tls_half_open_get,
1243 .cleanup_ho = tls_cleanup_ho,
1244 .custom_tx = tls_custom_tx_callback,
1245 .format_connection = format_tls_connection,
1246 .format_half_open = format_tls_half_open,
1247 .format_listener = format_tls_listener,
1248 .get_transport_endpoint = tls_transport_endpoint_get,
1249 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1250 .transport_options = {
1253 .tx_type = TRANSPORT_TX_INTERNAL,
1254 .service_type = TRANSPORT_SERVICE_VC,
1259 dtls_connect (transport_endpoint_cfg_t *tep)
1261 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1262 transport_endpt_crypto_cfg_t *ccfg;
1263 crypto_engine_type_t engine_type;
1264 session_endpoint_cfg_t *sep;
1265 tls_main_t *tm = &tls_main;
1266 app_worker_t *app_wrk;
1272 sep = (session_endpoint_cfg_t *) tep;
1276 app_wrk = app_worker_get (sep->app_wrk_index);
1277 app = application_get (app_wrk->app_index);
1279 ccfg = &sep->ext_cfg->crypto;
1280 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1281 if (engine_type == CRYPTO_ENGINE_NONE)
1283 clib_warning ("No tls engine_type available");
1287 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1288 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1289 ctx->parent_app_wrk_index = sep->app_wrk_index;
1290 ctx->parent_app_api_context = sep->opaque;
1291 ctx->tcp_is_ip4 = sep->is_ip4;
1292 ctx->ckpair_index = ccfg->ckpair_index;
1293 ctx->tls_type = sep->transport_proto;
1294 ctx->tls_ctx_handle = ctx_handle;
1295 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1296 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1297 if (ccfg->hostname[0])
1299 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1300 vec_terminate_c_string (ctx->srv_hostname);
1303 ctx->tls_ctx_engine = engine_type;
1305 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1306 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1307 cargs->app_index = tm->app_index;
1308 cargs->api_context = ctx_handle;
1309 cargs->sep_ext.ns_index = app->ns_index;
1310 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1311 if ((rv = vnet_connect (cargs)))
1314 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1319 static transport_connection_t *
1320 dtls_half_open_get (u32 ho_index)
1323 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1324 return &ho_ctx->connection;
1328 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1334 dtls_cleanup_ho (u32 ho_index)
1337 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1342 format_dtls_half_open (u8 *s, va_list *args)
1344 u32 ho_index = va_arg (*args, u32);
1345 u32 __clib_unused thread_index = va_arg (*args, u32);
1349 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1351 us = session_get_from_handle (ho_ctx->tls_session_handle);
1352 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1353 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1354 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1355 us->thread_index, us->session_index);
1360 static const transport_proto_vft_t dtls_proto = {
1362 .connect = dtls_connect,
1363 .close = tls_disconnect,
1364 .start_listen = tls_start_listen,
1365 .stop_listen = tls_stop_listen,
1366 .get_connection = tls_connection_get,
1367 .get_listener = tls_listener_get,
1368 .get_half_open = dtls_half_open_get,
1369 .custom_tx = tls_custom_tx_callback,
1370 .cleanup = dtls_cleanup_callback,
1371 .cleanup_ho = dtls_cleanup_ho,
1372 .format_connection = format_tls_connection,
1373 .format_half_open = format_dtls_half_open,
1374 .format_listener = format_tls_listener,
1375 .get_transport_endpoint = tls_transport_endpoint_get,
1376 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1377 .transport_options = {
1380 .tx_type = TRANSPORT_TX_INTERNAL,
1381 .service_type = TRANSPORT_SERVICE_VC,
1386 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1388 vec_validate (tls_vfts, type);
1389 tls_vfts[type] = *vft;
1392 static clib_error_t *
1393 tls_init (vlib_main_t * vm)
1395 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1396 tls_main_t *tm = &tls_main;
1399 num_threads = 1 /* main thread */ + vtm->n_threads;
1401 if (!tm->ca_cert_path)
1402 tm->ca_cert_path = TLS_CA_CERT_PATH;
1404 vec_validate (tm->rx_bufs, num_threads - 1);
1405 vec_validate (tm->tx_bufs, num_threads - 1);
1407 tm->first_seg_size = 32 << 20;
1408 tm->add_seg_size = 256 << 20;
1410 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1411 FIB_PROTOCOL_IP4, ~0);
1412 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1413 FIB_PROTOCOL_IP6, ~0);
1415 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1416 FIB_PROTOCOL_IP4, ~0);
1417 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1418 FIB_PROTOCOL_IP6, ~0);
1422 VLIB_INIT_FUNCTION (tls_init);
1424 static clib_error_t *
1425 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1427 tls_main_t *tm = &tls_main;
1429 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1431 if (unformat (input, "use-test-cert-in-ca"))
1432 tm->use_test_cert_in_ca = 1;
1433 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1435 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1436 &tm->first_seg_size))
1438 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1441 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1443 if (tmp >= 0x100000000ULL)
1445 return clib_error_return
1446 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1448 tm->fifo_size = tmp;
1451 return clib_error_return (0, "unknown input `%U'",
1452 format_unformat_error, input);
1457 VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
1460 vnet_tls_get_main (void)
1466 * fd.io coding-style-patch-verification: ON
1469 * eval: (c-set-style "gnu")