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 if (svm_fifo_set_event (s->rx_fifo))
65 session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_BUILTIN_RX);
70 tls_add_vpp_q_tx_evt (session_t * s)
72 if (svm_fifo_set_event (s->tx_fifo))
73 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
78 tls_add_app_q_evt (app_worker_t * app, session_t * app_session)
80 return app_worker_lock_and_send_event (app, 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;
228 if ((err = app_worker_init_connected (app_wrk, app_session)))
231 app_session->session_state = SESSION_STATE_READY;
232 parent_app_api_ctx = ctx->parent_app_api_context;
233 ctx->app_session_handle = session_handle (app_session);
235 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
238 TLS_DBG (1, "failed to notify app");
239 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
240 ctx->no_app_session = 1;
247 ctx->no_app_session = 1;
248 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
250 return app_worker_connect_notify (app_wrk, 0, err,
251 ctx->parent_app_api_context);
255 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
257 *ctx_index = ctx_handle & TLS_IDX_MASK;
258 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
261 static inline crypto_engine_type_t
262 tls_get_engine_type (crypto_engine_type_t requested,
263 crypto_engine_type_t preferred)
265 if (requested != CRYPTO_ENGINE_NONE)
267 if (tls_vfts[requested].ctx_alloc)
269 return CRYPTO_ENGINE_NONE;
271 if (!tls_vfts[preferred].ctx_alloc)
272 return tls_get_available_engine ();
277 tls_ctx_alloc (crypto_engine_type_t engine_type)
280 ctx_index = tls_vfts[engine_type].ctx_alloc ();
281 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
285 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
288 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
289 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
293 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
296 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
297 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
301 tls_ctx_detach (tls_ctx_t *ctx)
303 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
306 static inline tls_ctx_t *
307 tls_ctx_get (u32 ctx_handle)
309 u32 ctx_index, engine_type;
310 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
311 return tls_vfts[engine_type].ctx_get (ctx_index);
314 static inline tls_ctx_t *
315 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
317 u32 ctx_index, engine_type;
318 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
319 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
323 tls_ctx_init_server (tls_ctx_t * ctx)
325 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
329 tls_ctx_init_client (tls_ctx_t * ctx)
331 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
335 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
336 transport_send_params_t * sp)
340 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
341 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
342 sp->bytes_dequeued = n_wrote;
343 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
347 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
349 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
353 tls_ctx_transport_close (tls_ctx_t * ctx)
355 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
359 tls_ctx_app_close (tls_ctx_t * ctx)
361 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
365 tls_ctx_free (tls_ctx_t * ctx)
367 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
371 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
373 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
377 tls_reinit_ca_chain (crypto_engine_type_t tls_engine_id)
379 return tls_vfts[tls_engine_id].ctx_reinit_cachain ();
383 tls_notify_app_io_error (tls_ctx_t *ctx)
385 ASSERT (tls_ctx_handshake_is_over (ctx));
387 session_transport_reset_notify (&ctx->connection);
388 session_transport_closed_notify (&ctx->connection);
389 tls_disconnect_transport (ctx);
393 tls_session_reset_callback (session_t * s)
396 transport_connection_t *tc;
397 session_t *app_session;
399 ctx = tls_ctx_get (s->opaque);
400 ctx->is_passive_close = 1;
401 tc = &ctx->connection;
402 if (tls_ctx_handshake_is_over (ctx))
404 session_transport_reset_notify (tc);
405 session_transport_closed_notify (tc);
406 tls_disconnect_transport (ctx);
410 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
412 session_free (app_session);
413 ctx->c_s_index = SESSION_INVALID_INDEX;
414 tls_disconnect_transport (ctx);
419 tls_session_cleanup_ho (session_t *s)
424 /* session opaque stores the opaque passed on connect */
425 ho_index = s->opaque;
426 ctx = tls_ctx_half_open_get (ho_index);
427 session_half_open_delete_notify (&ctx->connection);
428 tls_ctx_half_open_free (ho_index);
432 tls_add_segment_callback (u32 client_index, u64 segment_handle)
434 /* No-op for builtin */
439 tls_del_segment_callback (u32 client_index, u64 segment_handle)
445 tls_session_disconnect_callback (session_t * tls_session)
449 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
450 tls_session->session_index);
452 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
453 || vlib_thread_is_main_w_barrier ());
455 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
456 ctx->is_passive_close = 1;
457 tls_ctx_transport_close (ctx);
461 tls_session_accept_callback (session_t * tls_session)
463 session_t *tls_listener, *app_session;
464 tls_ctx_t *lctx, *ctx;
468 listen_session_get_from_handle (tls_session->listener_handle);
469 lctx = tls_listener_ctx_get (tls_listener->opaque);
471 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
472 ctx = tls_ctx_get (ctx_handle);
473 memcpy (ctx, lctx, sizeof (*lctx));
474 ctx->c_thread_index = vlib_get_thread_index ();
475 ctx->tls_ctx_handle = ctx_handle;
476 tls_session->session_state = SESSION_STATE_READY;
477 tls_session->opaque = ctx_handle;
478 ctx->tls_session_handle = session_handle (tls_session);
479 ctx->listener_ctx_index = tls_listener->opaque;
480 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
481 ctx->ckpair_index = lctx->ckpair_index;
483 /* Preallocate app session. Avoids allocating a session post handshake
484 * on tls_session rx and potentially invalidating the session pool */
485 app_session = session_alloc (ctx->c_thread_index);
486 app_session->session_state = SESSION_STATE_CREATED;
487 ctx->c_s_index = app_session->session_index;
489 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
490 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
492 return tls_ctx_init_server (ctx);
496 tls_app_rx_callback (session_t * tls_session)
500 /* DTLS session migrating, wait for next notification */
501 if (PREDICT_FALSE (tls_session->flags & SESSION_F_IS_MIGRATING))
504 ctx = tls_ctx_get (tls_session->opaque);
505 if (PREDICT_FALSE (ctx->no_app_session))
507 TLS_DBG (1, "Local App closed");
510 tls_ctx_read (ctx, tls_session);
515 tls_app_tx_callback (session_t * tls_session)
519 ctx = tls_ctx_get (tls_session->opaque);
520 transport_connection_reschedule (&ctx->connection);
526 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
527 session_t *tls_session, session_error_t err)
529 session_t *app_session;
530 tls_ctx_t *ho_ctx, *ctx;
534 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
536 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
537 ctx = tls_ctx_get (ctx_handle);
538 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
539 /* Half-open freed on tcp half-open cleanup notification */
541 ctx->c_thread_index = vlib_get_thread_index ();
542 ctx->tls_ctx_handle = ctx_handle;
543 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
545 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
546 ho_ctx_index, err, vlib_get_thread_index (),
547 (ctx) ? ctx_handle : ~0);
549 ctx->tls_session_handle = session_handle (tls_session);
550 tls_session->opaque = ctx_handle;
551 tls_session->session_state = SESSION_STATE_READY;
553 /* Preallocate app session. Avoids allocating a session post handshake
554 * on tls_session rx and potentially invalidating the session pool */
555 app_session = session_alloc (ctx->c_thread_index);
556 app_session->session_state = SESSION_STATE_CREATED;
557 ctx->c_s_index = app_session->session_index;
558 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
559 app_session->session_type = st;
560 app_session->connection_index = ctx->tls_ctx_handle;
562 return tls_ctx_init_client (ctx);
566 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
571 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
573 ctx->tls_session_handle = session_handle (us);
574 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
575 us->opaque = ctx_handle;
577 /* We don't preallocate the app session because the udp session might
578 * actually migrate to a different worker at the end of the handshake */
580 return tls_ctx_init_client (ctx);
584 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
585 session_t *tls_session, session_error_t err)
589 app_worker_t *app_wrk;
593 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
594 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
597 api_context = ho_ctx->parent_app_api_context;
598 app_worker_connect_notify (app_wrk, 0, err, api_context);
604 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
605 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
608 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
613 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
617 if (ntf == SESSION_CLEANUP_TRANSPORT)
619 /* Allow cleanup of tcp session */
620 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
625 ctx = tls_ctx_get (s->opaque);
626 if (!ctx->no_app_session)
627 session_transport_delete_notify (&ctx->connection);
632 dtls_migrate_ctx (void *arg)
634 tls_ctx_t *ctx = (tls_ctx_t *) arg;
635 u32 ctx_handle, thread_index;
638 thread_index = session_thread_from_handle (ctx->tls_session_handle);
639 ASSERT (thread_index == vlib_get_thread_index ());
641 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
642 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
643 ctx->tls_ctx_handle = ctx_handle;
645 us = session_get_from_handle (ctx->tls_session_handle);
646 us->opaque = ctx_handle;
647 us->flags &= ~SESSION_F_IS_MIGRATING;
649 /* Probably the app detached while the session was migrating. Cleanup */
650 if (session_half_open_migrated_notify (&ctx->connection))
652 ctx->no_app_session = 1;
653 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
657 if (svm_fifo_max_dequeue (us->tx_fifo))
658 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
662 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
664 u32 new_thread = session_thread_from_handle (new_sh);
665 tls_ctx_t *ctx, *cloned_ctx;
667 /* Migrate dtls context to new thread */
668 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
669 ctx->tls_session_handle = new_sh;
670 cloned_ctx = tls_ctx_detach (ctx);
671 ctx->is_migrated = 1;
672 session_half_open_migrate_notify (&ctx->connection);
674 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
675 (void *) cloned_ctx);
680 static session_cb_vft_t tls_app_cb_vft = {
681 .session_accept_callback = tls_session_accept_callback,
682 .session_disconnect_callback = tls_session_disconnect_callback,
683 .session_connected_callback = tls_session_connected_callback,
684 .session_reset_callback = tls_session_reset_callback,
685 .half_open_cleanup_callback = tls_session_cleanup_ho,
686 .add_segment_callback = tls_add_segment_callback,
687 .del_segment_callback = tls_del_segment_callback,
688 .builtin_app_rx_callback = tls_app_rx_callback,
689 .builtin_app_tx_callback = tls_app_tx_callback,
690 .session_migrate_callback = dtls_session_migrate_callback,
691 .session_cleanup_callback = tls_app_session_cleanup,
695 tls_connect (transport_endpoint_cfg_t * tep)
697 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
698 transport_endpt_crypto_cfg_t *ccfg;
699 crypto_engine_type_t engine_type;
700 session_endpoint_cfg_t *sep;
701 tls_main_t *tm = &tls_main;
702 app_worker_t *app_wrk;
708 sep = (session_endpoint_cfg_t *) tep;
710 return SESSION_E_NOEXTCFG;
712 app_wrk = app_worker_get (sep->app_wrk_index);
713 app = application_get (app_wrk->app_index);
715 ccfg = &sep->ext_cfg->crypto;
716 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
717 if (engine_type == CRYPTO_ENGINE_NONE)
719 clib_warning ("No tls engine_type available");
720 return SESSION_E_NOCRYPTOENG;
723 ctx_index = tls_ctx_half_open_alloc ();
724 ctx = tls_ctx_half_open_get (ctx_index);
725 ctx->parent_app_wrk_index = sep->app_wrk_index;
726 ctx->parent_app_api_context = sep->opaque;
727 ctx->tcp_is_ip4 = sep->is_ip4;
728 ctx->tls_type = sep->transport_proto;
729 ctx->ckpair_index = ccfg->ckpair_index;
730 ctx->c_proto = TRANSPORT_PROTO_TLS;
731 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
732 if (ccfg->hostname[0])
734 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
735 vec_terminate_c_string (ctx->srv_hostname);
738 ctx->tls_ctx_engine = engine_type;
740 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
741 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
742 cargs->app_index = tm->app_index;
743 cargs->api_context = ctx_index;
744 cargs->sep_ext.ns_index = app->ns_index;
745 if ((rv = vnet_connect (cargs)))
748 /* Track half-open tcp session in case we need to clean it up */
749 ctx->tls_session_handle = cargs->sh;
751 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
756 tls_disconnect (u32 ctx_handle, u32 thread_index)
760 TLS_DBG (1, "Disconnecting %x", ctx_handle);
762 ctx = tls_ctx_get (ctx_handle);
763 tls_ctx_app_close (ctx);
767 tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
769 vnet_listen_args_t _bargs, *args = &_bargs;
770 transport_endpt_crypto_cfg_t *ccfg;
771 app_worker_t *app_wrk;
772 tls_main_t *tm = &tls_main;
773 session_handle_t tls_al_handle;
774 session_endpoint_cfg_t *sep;
775 session_t *tls_listener;
776 session_t *app_listener;
777 crypto_engine_type_t engine_type;
784 sep = (session_endpoint_cfg_t *) tep;
786 return SESSION_E_NOEXTCFG;
788 app_wrk = app_worker_get (sep->app_wrk_index);
789 app = application_get (app_wrk->app_index);
791 ccfg = &sep->ext_cfg->crypto;
792 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
793 if (engine_type == CRYPTO_ENGINE_NONE)
795 clib_warning ("No tls engine_type available");
796 return SESSION_E_NOCRYPTOENG;
799 clib_memset (args, 0, sizeof (*args));
800 args->app_index = tm->app_index;
801 args->sep_ext = *sep;
802 args->sep_ext.ns_index = app->ns_index;
803 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
804 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
806 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
807 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
809 if ((rv = vnet_listen (args)))
812 lctx_index = tls_listener_ctx_alloc ();
813 tls_al_handle = args->handle;
814 al = app_listener_get_w_handle (tls_al_handle);
815 tls_listener = app_listener_get_session (al);
816 tls_listener->opaque = lctx_index;
818 app_listener = listen_session_get (app_listener_index);
820 lctx = tls_listener_ctx_get (lctx_index);
821 lctx->parent_app_wrk_index = sep->app_wrk_index;
822 lctx->tls_session_handle = tls_al_handle;
823 lctx->app_session_handle = listen_session_get_handle (app_listener);
824 lctx->tcp_is_ip4 = sep->is_ip4;
825 lctx->tls_ctx_engine = engine_type;
826 lctx->tls_type = sep->transport_proto;
827 lctx->ckpair_index = ccfg->ckpair_index;
828 lctx->c_s_index = app_listener_index;
829 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
831 if (tls_vfts[engine_type].ctx_start_listen (lctx))
833 vnet_unlisten_args_t a = {
834 .handle = lctx->tls_session_handle,
835 .app_index = tls_main.app_index,
838 if ((vnet_unlisten (&a)))
839 clib_warning ("unlisten returned");
840 tls_listener_ctx_free (lctx);
841 lctx_index = SESSION_INVALID_INDEX;
844 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
850 tls_stop_listen (u32 lctx_index)
852 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
853 crypto_engine_type_t engine_type;
854 transport_connection_t *lc;
859 lctx = tls_listener_ctx_get (lctx_index);
861 /* Cleanup listener from session lookup table */
862 ls = session_get_from_handle (lctx->tls_session_handle);
863 lc = session_get_transport (ls);
865 sep.fib_index = lc->fib_index;
866 sep.port = lc->lcl_port;
867 sep.is_ip4 = lc->is_ip4;
868 sep.transport_proto = lctx->tls_type;
869 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
870 session_lookup_del_session_endpoint2 (&sep);
872 vnet_unlisten_args_t a = {
873 .handle = lctx->tls_session_handle,
874 .app_index = tls_main.app_index,
875 .wrk_map_index = 0 /* default wrk */
877 if ((rv = vnet_unlisten (&a)))
878 clib_warning ("unlisten returned %d", rv);
880 engine_type = lctx->tls_ctx_engine;
881 tls_vfts[engine_type].ctx_stop_listen (lctx);
883 tls_listener_ctx_free (lctx);
887 transport_connection_t *
888 tls_connection_get (u32 ctx_index, u32 thread_index)
891 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
892 return &ctx->connection;
895 transport_connection_t *
896 tls_listener_get (u32 listener_index)
899 ctx = tls_listener_ctx_get (listener_index);
900 return &ctx->connection;
903 static transport_connection_t *
904 tls_half_open_get (u32 ho_index)
907 ctx = tls_ctx_half_open_get (ho_index);
908 return &ctx->connection;
912 tls_cleanup_ho (u32 ho_index)
916 ctx = tls_ctx_half_open_get (ho_index);
917 session_cleanup_half_open (ctx->tls_session_handle);
918 tls_ctx_half_open_free (ho_index);
922 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
924 session_t *app_session = (session_t *) session;
927 if (PREDICT_FALSE (app_session->session_state
928 >= SESSION_STATE_TRANSPORT_CLOSED))
931 ctx = tls_ctx_get (app_session->connection_index);
932 return tls_ctx_write (ctx, app_session, sp);
936 format_tls_ctx (u8 * s, va_list * args)
938 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
939 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
942 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
943 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
944 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
946 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
947 ctx->c_thread_index, ctx->c_s_index, proto,
948 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
954 format_tls_listener_ctx (u8 * s, va_list * args)
956 session_t *tls_listener;
961 ctx = va_arg (*args, tls_ctx_t *);
963 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
964 al = app_listener_get_w_handle (ctx->tls_session_handle);
965 tls_listener = app_listener_get_session (al);
966 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
967 ctx->c_thread_index, ctx->c_s_index, proto,
968 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
969 tls_listener->thread_index, tls_listener->session_index);
975 format_tls_ctx_state (u8 * s, va_list * args)
980 ctx = va_arg (*args, tls_ctx_t *);
981 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
982 if (ts->session_state == SESSION_STATE_LISTENING)
983 s = format (s, "%s", "LISTEN");
986 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
987 s = format (s, "%s", "CLOSED");
988 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
989 s = format (s, "%s", "APP-CLOSED");
990 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
991 s = format (s, "%s", "CLOSING");
992 else if (tls_ctx_handshake_is_over (ctx))
993 s = format (s, "%s", "ESTABLISHED");
995 s = format (s, "%s", "HANDSHAKE");
1002 format_tls_connection (u8 * s, va_list * args)
1004 u32 ctx_index = va_arg (*args, u32);
1005 u32 thread_index = va_arg (*args, u32);
1006 u32 verbose = va_arg (*args, u32);
1009 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1013 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1016 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1019 s = format (s, "\n");
1025 format_tls_listener (u8 * s, va_list * args)
1027 u32 tc_index = va_arg (*args, u32);
1028 u32 __clib_unused thread_index = va_arg (*args, u32);
1029 u32 verbose = va_arg (*args, u32);
1030 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1032 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1034 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1039 format_tls_half_open (u8 * s, va_list * args)
1041 u32 ho_index = va_arg (*args, u32);
1042 u32 __clib_unused thread_index = va_arg (*args, u32);
1046 ho_ctx = tls_ctx_half_open_get (ho_index);
1048 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1049 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1050 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1051 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1052 tcp_ho->thread_index, tcp_ho->session_index);
1058 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1059 transport_endpoint_t * tep, u8 is_lcl)
1061 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1062 session_t *tcp_session;
1064 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1065 session_get_endpoint (tcp_session, tep, is_lcl);
1069 tls_transport_listener_endpoint_get (u32 ctx_handle,
1070 transport_endpoint_t * tep, u8 is_lcl)
1072 session_t *tls_listener;
1074 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1076 al = app_listener_get_w_handle (ctx->tls_session_handle);
1077 tls_listener = app_listener_get_session (al);
1078 session_get_endpoint (tls_listener, tep, is_lcl);
1081 static clib_error_t *
1082 tls_enable (vlib_main_t * vm, u8 is_en)
1084 vnet_app_detach_args_t _da, *da = &_da;
1085 vnet_app_attach_args_t _a, *a = &_a;
1086 u64 options[APP_OPTIONS_N_OPTIONS];
1087 tls_main_t *tm = &tls_main;
1088 u32 fifo_size = 128 << 12;
1092 da->app_index = tm->app_index;
1093 da->api_client_index = APP_INVALID_INDEX;
1094 vnet_application_detach (da);
1098 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1100 clib_memset (a, 0, sizeof (*a));
1101 clib_memset (options, 0, sizeof (options));
1103 a->session_cb_vft = &tls_app_cb_vft;
1104 a->api_client_index = APP_INVALID_INDEX;
1105 a->options = options;
1106 a->name = format (0, "tls");
1107 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1108 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
1109 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1110 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1111 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1112 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1113 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1115 if (vnet_application_attach (a))
1117 clib_warning ("failed to attach tls app");
1118 return clib_error_return (0, "failed to attach tls app");
1121 tm->app_index = a->app_index;
1127 static const transport_proto_vft_t tls_proto = {
1128 .enable = tls_enable,
1129 .connect = tls_connect,
1130 .close = tls_disconnect,
1131 .start_listen = tls_start_listen,
1132 .stop_listen = tls_stop_listen,
1133 .get_connection = tls_connection_get,
1134 .get_listener = tls_listener_get,
1135 .get_half_open = tls_half_open_get,
1136 .cleanup_ho = tls_cleanup_ho,
1137 .custom_tx = tls_custom_tx_callback,
1138 .format_connection = format_tls_connection,
1139 .format_half_open = format_tls_half_open,
1140 .format_listener = format_tls_listener,
1141 .get_transport_endpoint = tls_transport_endpoint_get,
1142 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1143 .transport_options = {
1146 .tx_type = TRANSPORT_TX_INTERNAL,
1147 .service_type = TRANSPORT_SERVICE_VC,
1152 dtls_connect (transport_endpoint_cfg_t *tep)
1154 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1155 transport_endpt_crypto_cfg_t *ccfg;
1156 crypto_engine_type_t engine_type;
1157 session_endpoint_cfg_t *sep;
1158 tls_main_t *tm = &tls_main;
1159 app_worker_t *app_wrk;
1165 sep = (session_endpoint_cfg_t *) tep;
1169 app_wrk = app_worker_get (sep->app_wrk_index);
1170 app = application_get (app_wrk->app_index);
1172 ccfg = &sep->ext_cfg->crypto;
1173 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1174 if (engine_type == CRYPTO_ENGINE_NONE)
1176 clib_warning ("No tls engine_type available");
1180 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1181 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1182 ctx->parent_app_wrk_index = sep->app_wrk_index;
1183 ctx->parent_app_api_context = sep->opaque;
1184 ctx->tcp_is_ip4 = sep->is_ip4;
1185 ctx->ckpair_index = ccfg->ckpair_index;
1186 ctx->tls_type = sep->transport_proto;
1187 ctx->tls_ctx_handle = ctx_handle;
1188 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1189 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1190 if (ccfg->hostname[0])
1192 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1193 vec_terminate_c_string (ctx->srv_hostname);
1196 ctx->tls_ctx_engine = engine_type;
1198 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1199 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1200 cargs->app_index = tm->app_index;
1201 cargs->api_context = ctx_handle;
1202 cargs->sep_ext.ns_index = app->ns_index;
1203 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1204 if ((rv = vnet_connect (cargs)))
1207 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1212 static transport_connection_t *
1213 dtls_half_open_get (u32 ho_index)
1216 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1217 return &ho_ctx->connection;
1221 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1227 dtls_cleanup_ho (u32 ho_index)
1230 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1235 format_dtls_half_open (u8 *s, va_list *args)
1237 u32 ho_index = va_arg (*args, u32);
1238 u32 __clib_unused thread_index = va_arg (*args, u32);
1242 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1244 us = session_get_from_handle (ho_ctx->tls_session_handle);
1245 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1246 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1247 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1248 us->thread_index, us->session_index);
1253 static const transport_proto_vft_t dtls_proto = {
1255 .connect = dtls_connect,
1256 .close = tls_disconnect,
1257 .start_listen = tls_start_listen,
1258 .stop_listen = tls_stop_listen,
1259 .get_connection = tls_connection_get,
1260 .get_listener = tls_listener_get,
1261 .get_half_open = dtls_half_open_get,
1262 .custom_tx = tls_custom_tx_callback,
1263 .cleanup = dtls_cleanup_callback,
1264 .cleanup_ho = dtls_cleanup_ho,
1265 .format_connection = format_tls_connection,
1266 .format_half_open = format_dtls_half_open,
1267 .format_listener = format_tls_listener,
1268 .get_transport_endpoint = tls_transport_endpoint_get,
1269 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1270 .transport_options = {
1273 .tx_type = TRANSPORT_TX_INTERNAL,
1274 .service_type = TRANSPORT_SERVICE_VC,
1279 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1281 vec_validate (tls_vfts, type);
1282 tls_vfts[type] = *vft;
1285 static clib_error_t *
1286 tls_init (vlib_main_t * vm)
1288 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1289 tls_main_t *tm = &tls_main;
1292 num_threads = 1 /* main thread */ + vtm->n_threads;
1294 if (!tm->ca_cert_path)
1295 tm->ca_cert_path = TLS_CA_CERT_PATH;
1297 vec_validate (tm->rx_bufs, num_threads - 1);
1298 vec_validate (tm->tx_bufs, num_threads - 1);
1300 tm->first_seg_size = 32 << 20;
1301 tm->add_seg_size = 256 << 20;
1303 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1304 FIB_PROTOCOL_IP4, ~0);
1305 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1306 FIB_PROTOCOL_IP6, ~0);
1308 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1309 FIB_PROTOCOL_IP4, ~0);
1310 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1311 FIB_PROTOCOL_IP6, ~0);
1315 VLIB_INIT_FUNCTION (tls_init);
1317 static clib_error_t *
1318 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1320 tls_main_t *tm = &tls_main;
1322 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1324 if (unformat (input, "use-test-cert-in-ca"))
1325 tm->use_test_cert_in_ca = 1;
1326 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1328 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1329 &tm->first_seg_size))
1331 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1334 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1336 if (tmp >= 0x100000000ULL)
1338 return clib_error_return
1339 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1341 tm->fifo_size = tmp;
1344 return clib_error_return (0, "unknown input `%U'",
1345 format_unformat_error, input);
1350 VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
1353 vnet_tls_get_main (void)
1359 * fd.io coding-style-patch-verification: ON
1362 * eval: (c-set-style "gnu")