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 pool_get_aligned_safe (tm->half_open_ctx_pool, ctx, CLIB_CACHE_LINE_BYTES);
122 clib_memset (ctx, 0, sizeof (*ctx));
123 ctx->c_c_index = ctx - tm->half_open_ctx_pool;
124 ctx->c_thread_index = transport_cl_thread ();
126 return ctx->c_c_index;
130 tls_ctx_half_open_free (u32 ho_index)
132 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
136 tls_ctx_half_open_get (u32 ctx_index)
138 tls_main_t *tm = &tls_main;
139 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
143 tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
145 app_worker_t *app_wrk;
146 app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
147 if (PREDICT_TRUE (app_wrk != 0))
148 tls_add_app_q_evt (app_wrk, app_session);
152 tls_notify_app_accept (tls_ctx_t * ctx)
154 session_t *app_listener, *app_session;
155 app_worker_t *app_wrk;
159 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
160 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
162 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
163 app_session->app_wrk_index = ctx->parent_app_wrk_index;
164 app_session->connection_index = ctx->tls_ctx_handle;
165 app_session->session_type = app_listener->session_type;
166 app_session->listener_handle = listen_session_get_handle (app_listener);
167 app_session->session_state = SESSION_STATE_ACCEPTING;
169 if ((rv = app_worker_init_accepted (app_session)))
171 TLS_DBG (1, "failed to allocate fifos");
172 session_free (app_session);
175 ctx->app_session_handle = session_handle (app_session);
176 ctx->parent_app_wrk_index = app_session->app_wrk_index;
177 app_wrk = app_worker_get (app_session->app_wrk_index);
178 return app_worker_accept_notify (app_wrk, app_session);
182 tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
184 u32 parent_app_api_ctx;
185 session_t *app_session;
186 app_worker_t *app_wrk;
188 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
191 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
192 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
193 ctx->no_app_session = 1;
199 /* Free app session pre-allocated when transport was established */
200 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
201 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
202 ctx->no_app_session = 1;
206 /* For DTLS the app session is not preallocated because the underlying udp
207 * session might migrate to a different worker during the handshake */
208 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
211 /* Cleanup half-open session as we don't get notification from udp */
212 session_half_open_delete_notify (&ctx->connection);
213 app_session = session_alloc (ctx->c_thread_index);
214 app_session->session_state = SESSION_STATE_CREATED;
215 ctx->c_s_index = app_session->session_index;
217 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
218 app_session->session_type = st;
219 app_session->connection_index = ctx->tls_ctx_handle;
223 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
226 app_session->app_wrk_index = ctx->parent_app_wrk_index;
227 app_session->opaque = ctx->parent_app_api_context;
229 if ((err = app_worker_init_connected (app_wrk, app_session)))
232 app_session->session_state = SESSION_STATE_READY;
233 parent_app_api_ctx = ctx->parent_app_api_context;
234 ctx->app_session_handle = session_handle (app_session);
236 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
239 TLS_DBG (1, "failed to notify app");
240 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
241 ctx->no_app_session = 1;
248 ctx->no_app_session = 1;
249 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
251 return app_worker_connect_notify (app_wrk, 0, err,
252 ctx->parent_app_api_context);
256 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
258 *ctx_index = ctx_handle & TLS_IDX_MASK;
259 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
262 static inline crypto_engine_type_t
263 tls_get_engine_type (crypto_engine_type_t requested,
264 crypto_engine_type_t preferred)
266 if (requested != CRYPTO_ENGINE_NONE)
268 if (tls_vfts[requested].ctx_alloc)
270 return CRYPTO_ENGINE_NONE;
272 if (!tls_vfts[preferred].ctx_alloc)
273 return tls_get_available_engine ();
278 tls_ctx_alloc (crypto_engine_type_t engine_type)
281 ctx_index = tls_vfts[engine_type].ctx_alloc ();
282 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
286 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
289 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
290 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
294 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
297 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
298 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
302 tls_ctx_detach (tls_ctx_t *ctx)
304 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
307 static inline tls_ctx_t *
308 tls_ctx_get (u32 ctx_handle)
310 u32 ctx_index, engine_type;
311 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
312 return tls_vfts[engine_type].ctx_get (ctx_index);
315 static inline tls_ctx_t *
316 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
318 u32 ctx_index, engine_type;
319 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
320 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
324 tls_ctx_init_server (tls_ctx_t * ctx)
326 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
330 tls_ctx_init_client (tls_ctx_t * ctx)
332 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
336 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
337 transport_send_params_t * sp)
341 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
342 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
343 sp->bytes_dequeued = n_wrote;
344 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
348 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
350 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
354 tls_ctx_transport_close (tls_ctx_t * ctx)
356 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
360 tls_ctx_app_close (tls_ctx_t * ctx)
362 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
366 tls_ctx_free (tls_ctx_t * ctx)
368 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
372 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
374 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
378 tls_reinit_ca_chain (crypto_engine_type_t tls_engine_id)
380 return tls_vfts[tls_engine_id].ctx_reinit_cachain ();
384 tls_notify_app_io_error (tls_ctx_t *ctx)
386 ASSERT (tls_ctx_handshake_is_over (ctx));
388 session_transport_reset_notify (&ctx->connection);
389 session_transport_closed_notify (&ctx->connection);
390 tls_disconnect_transport (ctx);
394 tls_session_reset_callback (session_t * s)
397 transport_connection_t *tc;
398 session_t *app_session;
400 ctx = tls_ctx_get (s->opaque);
401 ctx->is_passive_close = 1;
402 tc = &ctx->connection;
403 if (tls_ctx_handshake_is_over (ctx))
405 session_transport_reset_notify (tc);
406 session_transport_closed_notify (tc);
407 tls_disconnect_transport (ctx);
411 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
413 session_free (app_session);
414 ctx->c_s_index = SESSION_INVALID_INDEX;
415 tls_disconnect_transport (ctx);
420 tls_session_cleanup_ho (session_t *s)
425 /* session opaque stores the opaque passed on connect */
426 ho_index = s->opaque;
427 ctx = tls_ctx_half_open_get (ho_index);
428 session_half_open_delete_notify (&ctx->connection);
429 tls_ctx_half_open_free (ho_index);
433 tls_add_segment_callback (u32 client_index, u64 segment_handle)
435 /* No-op for builtin */
440 tls_del_segment_callback (u32 client_index, u64 segment_handle)
446 tls_session_disconnect_callback (session_t * tls_session)
450 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
451 tls_session->session_index);
453 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
454 || vlib_thread_is_main_w_barrier ());
456 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
457 ctx->is_passive_close = 1;
458 tls_ctx_transport_close (ctx);
462 tls_session_accept_callback (session_t * tls_session)
464 session_t *tls_listener, *app_session;
465 tls_ctx_t *lctx, *ctx;
470 listen_session_get_from_handle (tls_session->listener_handle);
471 lctx = tls_listener_ctx_get (tls_listener->opaque);
473 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
474 ctx = tls_ctx_get (ctx_handle);
475 memcpy (ctx, lctx, sizeof (*lctx));
476 ctx->c_thread_index = vlib_get_thread_index ();
477 ctx->tls_ctx_handle = ctx_handle;
478 tls_session->session_state = SESSION_STATE_READY;
479 tls_session->opaque = ctx_handle;
480 ctx->tls_session_handle = session_handle (tls_session);
481 ctx->listener_ctx_index = tls_listener->opaque;
482 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
483 ctx->ckpair_index = lctx->ckpair_index;
485 /* Preallocate app session. Avoids allocating a session post handshake
486 * on tls_session rx and potentially invalidating the session pool */
487 app_session = session_alloc (ctx->c_thread_index);
488 app_session->session_state = SESSION_STATE_CREATED;
489 app_session->session_type =
490 session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
491 app_session->connection_index = ctx->tls_ctx_handle;
492 ctx->c_s_index = app_session->session_index;
494 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
495 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
497 rv = tls_ctx_init_server (ctx);
500 session_free (app_session);
508 tls_app_rx_callback (session_t * tls_session)
512 /* DTLS session migrating, wait for next notification */
513 if (PREDICT_FALSE (tls_session->flags & SESSION_F_IS_MIGRATING))
516 ctx = tls_ctx_get (tls_session->opaque);
517 if (PREDICT_FALSE (ctx->no_app_session))
519 TLS_DBG (1, "Local App closed");
522 tls_ctx_read (ctx, tls_session);
527 tls_app_tx_callback (session_t * tls_session)
531 ctx = tls_ctx_get (tls_session->opaque);
532 transport_connection_reschedule (&ctx->connection);
538 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
539 session_t *tls_session, session_error_t err)
541 session_t *app_session;
542 tls_ctx_t *ho_ctx, *ctx;
547 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
549 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
550 ctx = tls_ctx_get (ctx_handle);
551 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
552 /* Half-open freed on tcp half-open cleanup notification */
554 ctx->c_thread_index = vlib_get_thread_index ();
555 ctx->tls_ctx_handle = ctx_handle;
556 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
558 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
559 ho_ctx_index, err, vlib_get_thread_index (),
560 (ctx) ? ctx_handle : ~0);
562 ctx->tls_session_handle = session_handle (tls_session);
563 tls_session->opaque = ctx_handle;
564 tls_session->session_state = SESSION_STATE_READY;
566 /* Preallocate app session. Avoids allocating a session post handshake
567 * on tls_session rx and potentially invalidating the session pool */
568 app_session = session_alloc (ctx->c_thread_index);
569 app_session->session_state = SESSION_STATE_CREATED;
570 ctx->c_s_index = app_session->session_index;
571 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
572 app_session->session_type = st;
573 app_session->connection_index = ctx->tls_ctx_handle;
575 rv = tls_ctx_init_client (ctx);
578 session_free (app_session);
586 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
591 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
593 ctx->tls_session_handle = session_handle (us);
594 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
595 us->opaque = ctx_handle;
597 /* We don't preallocate the app session because the udp session might
598 * actually migrate to a different worker at the end of the handshake */
600 return tls_ctx_init_client (ctx);
604 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
605 session_t *tls_session, session_error_t err)
609 app_worker_t *app_wrk;
613 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
614 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
617 api_context = ho_ctx->parent_app_api_context;
618 app_worker_connect_notify (app_wrk, 0, err, api_context);
624 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
625 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
628 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
633 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
637 if (ntf == SESSION_CLEANUP_TRANSPORT)
639 /* Allow cleanup of tcp session */
640 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
645 ctx = tls_ctx_get (s->opaque);
646 if (!ctx->no_app_session)
647 session_transport_delete_notify (&ctx->connection);
652 dtls_migrate_ctx (void *arg)
654 tls_ctx_t *ctx = (tls_ctx_t *) arg;
655 u32 ctx_handle, thread_index;
658 thread_index = session_thread_from_handle (ctx->tls_session_handle);
659 ASSERT (thread_index == vlib_get_thread_index ());
661 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
662 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
663 ctx->tls_ctx_handle = ctx_handle;
665 us = session_get_from_handle (ctx->tls_session_handle);
666 us->opaque = ctx_handle;
667 us->flags &= ~SESSION_F_IS_MIGRATING;
669 /* Probably the app detached while the session was migrating. Cleanup */
670 if (session_half_open_migrated_notify (&ctx->connection))
672 ctx->no_app_session = 1;
673 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
677 if (svm_fifo_max_dequeue (us->tx_fifo))
678 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
682 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
684 u32 new_thread = session_thread_from_handle (new_sh);
685 tls_ctx_t *ctx, *cloned_ctx;
687 /* Migrate dtls context to new thread */
688 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
689 ctx->tls_session_handle = new_sh;
690 cloned_ctx = tls_ctx_detach (ctx);
691 ctx->is_migrated = 1;
692 session_half_open_migrate_notify (&ctx->connection);
694 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
695 (void *) cloned_ctx);
700 static session_cb_vft_t tls_app_cb_vft = {
701 .session_accept_callback = tls_session_accept_callback,
702 .session_disconnect_callback = tls_session_disconnect_callback,
703 .session_connected_callback = tls_session_connected_callback,
704 .session_reset_callback = tls_session_reset_callback,
705 .half_open_cleanup_callback = tls_session_cleanup_ho,
706 .add_segment_callback = tls_add_segment_callback,
707 .del_segment_callback = tls_del_segment_callback,
708 .builtin_app_rx_callback = tls_app_rx_callback,
709 .builtin_app_tx_callback = tls_app_tx_callback,
710 .session_migrate_callback = dtls_session_migrate_callback,
711 .session_cleanup_callback = tls_app_session_cleanup,
715 tls_connect (transport_endpoint_cfg_t * tep)
717 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
718 transport_endpt_crypto_cfg_t *ccfg;
719 crypto_engine_type_t engine_type;
720 session_endpoint_cfg_t *sep;
721 tls_main_t *tm = &tls_main;
722 app_worker_t *app_wrk;
728 sep = (session_endpoint_cfg_t *) tep;
730 return SESSION_E_NOEXTCFG;
732 app_wrk = app_worker_get (sep->app_wrk_index);
733 app = application_get (app_wrk->app_index);
735 ccfg = &sep->ext_cfg->crypto;
736 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
737 if (engine_type == CRYPTO_ENGINE_NONE)
739 clib_warning ("No tls engine_type available");
740 return SESSION_E_NOCRYPTOENG;
743 ctx_index = tls_ctx_half_open_alloc ();
744 ctx = tls_ctx_half_open_get (ctx_index);
745 ctx->parent_app_wrk_index = sep->app_wrk_index;
746 ctx->parent_app_api_context = sep->opaque;
747 ctx->tcp_is_ip4 = sep->is_ip4;
748 ctx->tls_type = sep->transport_proto;
749 ctx->ckpair_index = ccfg->ckpair_index;
750 ctx->c_proto = TRANSPORT_PROTO_TLS;
751 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
752 if (ccfg->hostname[0])
754 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
755 vec_terminate_c_string (ctx->srv_hostname);
758 ctx->tls_ctx_engine = engine_type;
760 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
761 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
762 cargs->app_index = tm->app_index;
763 cargs->api_context = ctx_index;
764 cargs->sep_ext.ns_index = app->ns_index;
765 if ((rv = vnet_connect (cargs)))
768 /* Track half-open tcp session in case we need to clean it up */
769 ctx->tls_session_handle = cargs->sh;
771 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
776 tls_disconnect (u32 ctx_handle, u32 thread_index)
780 TLS_DBG (1, "Disconnecting %x", ctx_handle);
782 ctx = tls_ctx_get (ctx_handle);
783 tls_ctx_app_close (ctx);
787 tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
789 vnet_listen_args_t _bargs, *args = &_bargs;
790 transport_endpt_crypto_cfg_t *ccfg;
791 app_worker_t *app_wrk;
792 tls_main_t *tm = &tls_main;
793 session_handle_t tls_al_handle;
794 session_endpoint_cfg_t *sep;
795 session_t *tls_listener;
796 session_t *app_listener;
797 crypto_engine_type_t engine_type;
804 sep = (session_endpoint_cfg_t *) tep;
806 return SESSION_E_NOEXTCFG;
808 app_wrk = app_worker_get (sep->app_wrk_index);
809 app = application_get (app_wrk->app_index);
811 ccfg = &sep->ext_cfg->crypto;
812 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
813 if (engine_type == CRYPTO_ENGINE_NONE)
815 clib_warning ("No tls engine_type available");
816 return SESSION_E_NOCRYPTOENG;
819 clib_memset (args, 0, sizeof (*args));
820 args->app_index = tm->app_index;
821 args->sep_ext = *sep;
822 args->sep_ext.ns_index = app->ns_index;
823 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
824 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
826 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
827 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
829 if ((rv = vnet_listen (args)))
832 lctx_index = tls_listener_ctx_alloc ();
833 tls_al_handle = args->handle;
834 al = app_listener_get_w_handle (tls_al_handle);
835 tls_listener = app_listener_get_session (al);
836 tls_listener->opaque = lctx_index;
838 app_listener = listen_session_get (app_listener_index);
840 lctx = tls_listener_ctx_get (lctx_index);
841 lctx->parent_app_wrk_index = sep->app_wrk_index;
842 lctx->tls_session_handle = tls_al_handle;
843 lctx->app_session_handle = listen_session_get_handle (app_listener);
844 lctx->tcp_is_ip4 = sep->is_ip4;
845 lctx->tls_ctx_engine = engine_type;
846 lctx->tls_type = sep->transport_proto;
847 lctx->ckpair_index = ccfg->ckpair_index;
848 lctx->c_s_index = app_listener_index;
849 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
851 if (tls_vfts[engine_type].ctx_start_listen (lctx))
853 vnet_unlisten_args_t a = {
854 .handle = lctx->tls_session_handle,
855 .app_index = tls_main.app_index,
858 if ((vnet_unlisten (&a)))
859 clib_warning ("unlisten returned");
860 tls_listener_ctx_free (lctx);
861 lctx_index = SESSION_INVALID_INDEX;
864 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
870 tls_stop_listen (u32 lctx_index)
872 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
873 crypto_engine_type_t engine_type;
874 transport_connection_t *lc;
879 lctx = tls_listener_ctx_get (lctx_index);
881 /* Cleanup listener from session lookup table */
882 ls = session_get_from_handle (lctx->tls_session_handle);
883 lc = session_get_transport (ls);
885 sep.fib_index = lc->fib_index;
886 sep.port = lc->lcl_port;
887 sep.is_ip4 = lc->is_ip4;
888 sep.transport_proto = lctx->tls_type;
889 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
890 session_lookup_del_session_endpoint2 (&sep);
892 vnet_unlisten_args_t a = {
893 .handle = lctx->tls_session_handle,
894 .app_index = tls_main.app_index,
895 .wrk_map_index = 0 /* default wrk */
897 if ((rv = vnet_unlisten (&a)))
898 clib_warning ("unlisten returned %d", rv);
900 engine_type = lctx->tls_ctx_engine;
901 tls_vfts[engine_type].ctx_stop_listen (lctx);
903 tls_listener_ctx_free (lctx);
907 transport_connection_t *
908 tls_connection_get (u32 ctx_index, u32 thread_index)
911 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
912 return &ctx->connection;
915 transport_connection_t *
916 tls_listener_get (u32 listener_index)
919 ctx = tls_listener_ctx_get (listener_index);
920 return &ctx->connection;
923 static transport_connection_t *
924 tls_half_open_get (u32 ho_index)
927 ctx = tls_ctx_half_open_get (ho_index);
928 return &ctx->connection;
932 tls_cleanup_ho (u32 ho_index)
936 ctx = tls_ctx_half_open_get (ho_index);
937 session_cleanup_half_open (ctx->tls_session_handle);
938 tls_ctx_half_open_free (ho_index);
942 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
944 session_t *as = (session_t *) session;
947 if (PREDICT_FALSE (as->session_state >= SESSION_STATE_TRANSPORT_CLOSED ||
948 as->session_state <= SESSION_STATE_ACCEPTING))
950 sp->flags |= TRANSPORT_SND_F_DESCHED;
954 ctx = tls_ctx_get (as->connection_index);
955 return tls_ctx_write (ctx, as, sp);
959 format_tls_ctx (u8 * s, va_list * args)
961 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
962 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
965 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
966 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
967 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
969 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
970 ctx->c_thread_index, ctx->c_s_index, proto,
971 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
977 format_tls_listener_ctx (u8 * s, va_list * args)
979 session_t *tls_listener;
984 ctx = va_arg (*args, tls_ctx_t *);
986 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
987 al = app_listener_get_w_handle (ctx->tls_session_handle);
988 tls_listener = app_listener_get_session (al);
989 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
990 ctx->c_thread_index, ctx->c_s_index, proto,
991 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
992 tls_listener->thread_index, tls_listener->session_index);
998 format_tls_ctx_state (u8 * s, va_list * args)
1003 ctx = va_arg (*args, tls_ctx_t *);
1004 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
1005 if (ts->session_state == SESSION_STATE_LISTENING)
1006 s = format (s, "%s", "LISTEN");
1009 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1010 s = format (s, "%s", "CLOSED");
1011 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1012 s = format (s, "%s", "APP-CLOSED");
1013 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1014 s = format (s, "%s", "CLOSING");
1015 else if (tls_ctx_handshake_is_over (ctx))
1016 s = format (s, "%s", "ESTABLISHED");
1018 s = format (s, "%s", "HANDSHAKE");
1025 format_tls_connection (u8 * s, va_list * args)
1027 u32 ctx_index = va_arg (*args, u32);
1028 u32 thread_index = va_arg (*args, u32);
1029 u32 verbose = va_arg (*args, u32);
1032 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1036 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1039 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1042 s = format (s, "\n");
1048 format_tls_listener (u8 * s, va_list * args)
1050 u32 tc_index = va_arg (*args, u32);
1051 u32 __clib_unused thread_index = va_arg (*args, u32);
1052 u32 verbose = va_arg (*args, u32);
1053 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1055 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1057 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1062 format_tls_half_open (u8 * s, va_list * args)
1064 u32 ho_index = va_arg (*args, u32);
1065 u32 __clib_unused thread_index = va_arg (*args, u32);
1066 u32 __clib_unused verbose = va_arg (*args, u32);
1070 ho_ctx = tls_ctx_half_open_get (ho_index);
1072 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1073 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1074 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1075 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1076 tcp_ho->thread_index, tcp_ho->session_index);
1082 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1083 transport_endpoint_t * tep, u8 is_lcl)
1085 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1086 session_t *tcp_session;
1088 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1089 session_get_endpoint (tcp_session, tep, is_lcl);
1093 tls_transport_listener_endpoint_get (u32 ctx_handle,
1094 transport_endpoint_t * tep, u8 is_lcl)
1096 session_t *tls_listener;
1098 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1100 al = app_listener_get_w_handle (ctx->tls_session_handle);
1101 tls_listener = app_listener_get_session (al);
1102 session_get_endpoint (tls_listener, tep, is_lcl);
1105 static clib_error_t *
1106 tls_enable (vlib_main_t * vm, u8 is_en)
1108 vnet_app_detach_args_t _da, *da = &_da;
1109 vnet_app_attach_args_t _a, *a = &_a;
1110 u64 options[APP_OPTIONS_N_OPTIONS];
1111 tls_main_t *tm = &tls_main;
1112 u32 fifo_size = 128 << 12;
1116 da->app_index = tm->app_index;
1117 da->api_client_index = APP_INVALID_INDEX;
1118 vnet_application_detach (da);
1122 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1124 clib_memset (a, 0, sizeof (*a));
1125 clib_memset (options, 0, sizeof (options));
1127 a->session_cb_vft = &tls_app_cb_vft;
1128 a->api_client_index = APP_INVALID_INDEX;
1129 a->options = options;
1130 a->name = format (0, "tls");
1131 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1132 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
1133 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1134 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1135 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1136 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1137 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1139 if (vnet_application_attach (a))
1141 clib_warning ("failed to attach tls app");
1142 return clib_error_return (0, "failed to attach tls app");
1145 tm->app_index = a->app_index;
1151 static const transport_proto_vft_t tls_proto = {
1152 .enable = tls_enable,
1153 .connect = tls_connect,
1154 .close = tls_disconnect,
1155 .start_listen = tls_start_listen,
1156 .stop_listen = tls_stop_listen,
1157 .get_connection = tls_connection_get,
1158 .get_listener = tls_listener_get,
1159 .get_half_open = tls_half_open_get,
1160 .cleanup_ho = tls_cleanup_ho,
1161 .custom_tx = tls_custom_tx_callback,
1162 .format_connection = format_tls_connection,
1163 .format_half_open = format_tls_half_open,
1164 .format_listener = format_tls_listener,
1165 .get_transport_endpoint = tls_transport_endpoint_get,
1166 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1167 .transport_options = {
1170 .tx_type = TRANSPORT_TX_INTERNAL,
1171 .service_type = TRANSPORT_SERVICE_VC,
1176 dtls_connect (transport_endpoint_cfg_t *tep)
1178 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1179 transport_endpt_crypto_cfg_t *ccfg;
1180 crypto_engine_type_t engine_type;
1181 session_endpoint_cfg_t *sep;
1182 tls_main_t *tm = &tls_main;
1183 app_worker_t *app_wrk;
1189 sep = (session_endpoint_cfg_t *) tep;
1193 app_wrk = app_worker_get (sep->app_wrk_index);
1194 app = application_get (app_wrk->app_index);
1196 ccfg = &sep->ext_cfg->crypto;
1197 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1198 if (engine_type == CRYPTO_ENGINE_NONE)
1200 clib_warning ("No tls engine_type available");
1204 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1205 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1206 ctx->parent_app_wrk_index = sep->app_wrk_index;
1207 ctx->parent_app_api_context = sep->opaque;
1208 ctx->tcp_is_ip4 = sep->is_ip4;
1209 ctx->ckpair_index = ccfg->ckpair_index;
1210 ctx->tls_type = sep->transport_proto;
1211 ctx->tls_ctx_handle = ctx_handle;
1212 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1213 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1214 if (ccfg->hostname[0])
1216 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1217 vec_terminate_c_string (ctx->srv_hostname);
1220 ctx->tls_ctx_engine = engine_type;
1222 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1223 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1224 cargs->app_index = tm->app_index;
1225 cargs->api_context = ctx_handle;
1226 cargs->sep_ext.ns_index = app->ns_index;
1227 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1228 if ((rv = vnet_connect (cargs)))
1231 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1236 static transport_connection_t *
1237 dtls_half_open_get (u32 ho_index)
1240 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1241 return &ho_ctx->connection;
1245 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1251 dtls_cleanup_ho (u32 ho_index)
1254 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1259 format_dtls_half_open (u8 *s, va_list *args)
1261 u32 ho_index = va_arg (*args, u32);
1262 u32 __clib_unused thread_index = va_arg (*args, u32);
1266 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1268 us = session_get_from_handle (ho_ctx->tls_session_handle);
1269 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1270 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1271 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1272 us->thread_index, us->session_index);
1277 static const transport_proto_vft_t dtls_proto = {
1279 .connect = dtls_connect,
1280 .close = tls_disconnect,
1281 .start_listen = tls_start_listen,
1282 .stop_listen = tls_stop_listen,
1283 .get_connection = tls_connection_get,
1284 .get_listener = tls_listener_get,
1285 .get_half_open = dtls_half_open_get,
1286 .custom_tx = tls_custom_tx_callback,
1287 .cleanup = dtls_cleanup_callback,
1288 .cleanup_ho = dtls_cleanup_ho,
1289 .format_connection = format_tls_connection,
1290 .format_half_open = format_dtls_half_open,
1291 .format_listener = format_tls_listener,
1292 .get_transport_endpoint = tls_transport_endpoint_get,
1293 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1294 .transport_options = {
1297 .tx_type = TRANSPORT_TX_INTERNAL,
1298 .service_type = TRANSPORT_SERVICE_VC,
1303 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1305 vec_validate (tls_vfts, type);
1306 tls_vfts[type] = *vft;
1309 static clib_error_t *
1310 tls_init (vlib_main_t * vm)
1312 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1313 tls_main_t *tm = &tls_main;
1316 num_threads = 1 /* main thread */ + vtm->n_threads;
1318 if (!tm->ca_cert_path)
1319 tm->ca_cert_path = TLS_CA_CERT_PATH;
1321 vec_validate (tm->rx_bufs, num_threads - 1);
1322 vec_validate (tm->tx_bufs, num_threads - 1);
1324 tm->first_seg_size = 32 << 20;
1325 tm->add_seg_size = 256 << 20;
1327 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1328 FIB_PROTOCOL_IP4, ~0);
1329 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1330 FIB_PROTOCOL_IP6, ~0);
1332 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1333 FIB_PROTOCOL_IP4, ~0);
1334 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1335 FIB_PROTOCOL_IP6, ~0);
1339 VLIB_INIT_FUNCTION (tls_init);
1341 static clib_error_t *
1342 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1344 tls_main_t *tm = &tls_main;
1346 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1348 if (unformat (input, "use-test-cert-in-ca"))
1349 tm->use_test_cert_in_ca = 1;
1350 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1352 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1353 &tm->first_seg_size))
1355 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1358 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1360 if (tmp >= 0x100000000ULL)
1362 return clib_error_return
1363 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1365 tm->fifo_size = tmp;
1368 return clib_error_return (0, "unknown input `%U'",
1369 format_unformat_error, input);
1374 VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
1377 vnet_tls_get_main (void)
1383 * fd.io coding-style-patch-verification: ON
1386 * eval: (c-set-style "gnu")