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)))
231 app_worker_connect_notify (app_wrk, 0, err, ctx->parent_app_api_context);
232 ctx->no_app_session = 1;
233 session_free (app_session);
237 app_session->session_state = SESSION_STATE_READY;
238 parent_app_api_ctx = ctx->parent_app_api_context;
239 ctx->app_session_handle = session_handle (app_session);
241 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
244 TLS_DBG (1, "failed to notify app");
245 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
246 ctx->no_app_session = 1;
253 return app_worker_connect_notify (app_wrk, 0, err,
254 ctx->parent_app_api_context);
258 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
260 *ctx_index = ctx_handle & TLS_IDX_MASK;
261 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
264 static inline crypto_engine_type_t
265 tls_get_engine_type (crypto_engine_type_t requested,
266 crypto_engine_type_t preferred)
268 if (requested != CRYPTO_ENGINE_NONE)
270 if (tls_vfts[requested].ctx_alloc)
272 return CRYPTO_ENGINE_NONE;
274 if (!tls_vfts[preferred].ctx_alloc)
275 return tls_get_available_engine ();
280 tls_ctx_alloc (crypto_engine_type_t engine_type)
283 ctx_index = tls_vfts[engine_type].ctx_alloc ();
284 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
288 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
291 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
292 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
296 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
299 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
300 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
304 tls_ctx_detach (tls_ctx_t *ctx)
306 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
309 static inline tls_ctx_t *
310 tls_ctx_get (u32 ctx_handle)
312 u32 ctx_index, engine_type;
313 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
314 return tls_vfts[engine_type].ctx_get (ctx_index);
317 static inline tls_ctx_t *
318 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
320 u32 ctx_index, engine_type;
321 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
322 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
326 tls_ctx_init_server (tls_ctx_t * ctx)
328 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
332 tls_ctx_init_client (tls_ctx_t * ctx)
334 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
338 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
339 transport_send_params_t * sp)
343 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
344 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
345 sp->bytes_dequeued = n_wrote;
346 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
350 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
352 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
356 tls_ctx_transport_close (tls_ctx_t * ctx)
358 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
362 tls_ctx_app_close (tls_ctx_t * ctx)
364 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
368 tls_ctx_free (tls_ctx_t * ctx)
370 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
374 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
376 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
380 tls_reinit_ca_chain (crypto_engine_type_t tls_engine_id)
382 return tls_vfts[tls_engine_id].ctx_reinit_cachain ();
386 tls_notify_app_io_error (tls_ctx_t *ctx)
388 ASSERT (tls_ctx_handshake_is_over (ctx));
390 session_transport_reset_notify (&ctx->connection);
391 session_transport_closed_notify (&ctx->connection);
392 tls_disconnect_transport (ctx);
396 tls_session_reset_callback (session_t * s)
399 transport_connection_t *tc;
400 session_t *app_session;
402 ctx = tls_ctx_get (s->opaque);
403 ctx->is_passive_close = 1;
404 tc = &ctx->connection;
405 if (tls_ctx_handshake_is_over (ctx))
407 session_transport_reset_notify (tc);
408 session_transport_closed_notify (tc);
409 tls_disconnect_transport (ctx);
413 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
415 session_free (app_session);
416 ctx->c_s_index = SESSION_INVALID_INDEX;
417 tls_disconnect_transport (ctx);
422 tls_session_cleanup_ho (session_t *s)
427 /* session opaque stores the opaque passed on connect */
428 ho_index = s->opaque;
429 ctx = tls_ctx_half_open_get (ho_index);
430 if (!ctx->no_app_session)
431 session_half_open_delete_notify (&ctx->connection);
432 tls_ctx_half_open_free (ho_index);
436 tls_add_segment_callback (u32 client_index, u64 segment_handle)
438 /* No-op for builtin */
443 tls_del_segment_callback (u32 client_index, u64 segment_handle)
449 tls_session_disconnect_callback (session_t * tls_session)
453 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
454 tls_session->session_index);
456 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
457 || vlib_thread_is_main_w_barrier ());
459 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
460 ctx->is_passive_close = 1;
461 tls_ctx_transport_close (ctx);
465 tls_session_accept_callback (session_t * tls_session)
467 session_t *tls_listener, *app_session;
468 tls_ctx_t *lctx, *ctx;
472 listen_session_get_from_handle (tls_session->listener_handle);
473 lctx = tls_listener_ctx_get (tls_listener->opaque);
475 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
476 ctx = tls_ctx_get (ctx_handle);
477 memcpy (ctx, lctx, sizeof (*lctx));
478 ctx->c_thread_index = vlib_get_thread_index ();
479 ctx->tls_ctx_handle = ctx_handle;
480 tls_session->session_state = SESSION_STATE_READY;
481 tls_session->opaque = ctx_handle;
482 ctx->tls_session_handle = session_handle (tls_session);
483 ctx->listener_ctx_index = tls_listener->opaque;
484 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
485 ctx->ckpair_index = lctx->ckpair_index;
487 /* Preallocate app session. Avoids allocating a session post handshake
488 * on tls_session rx and potentially invalidating the session pool */
489 app_session = session_alloc (ctx->c_thread_index);
490 app_session->session_state = SESSION_STATE_CREATED;
491 app_session->session_type =
492 session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
493 app_session->connection_index = ctx->tls_ctx_handle;
494 ctx->c_s_index = app_session->session_index;
496 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
497 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
499 if (tls_ctx_init_server (ctx))
501 /* Do not free ctx yet, in case we have pending rx events */
502 session_free (app_session);
503 ctx->no_app_session = 1;
504 tls_disconnect_transport (ctx);
511 tls_app_rx_callback (session_t *ts)
515 /* DTLS session migrating, wait for next notification */
516 if (PREDICT_FALSE (ts->flags & SESSION_F_IS_MIGRATING))
519 /* Read rescheduled but underlying transport deleted now */
520 if (PREDICT_FALSE ((ts->session_state == SESSION_STATE_TRANSPORT_DELETED)))
523 ctx = tls_ctx_get (ts->opaque);
524 if (PREDICT_FALSE (ctx->no_app_session || ctx->app_closed))
526 TLS_DBG (1, "Local App closed");
529 tls_ctx_read (ctx, ts);
534 tls_app_tx_callback (session_t * tls_session)
538 ctx = tls_ctx_get (tls_session->opaque);
539 transport_connection_reschedule (&ctx->connection);
545 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
546 session_t *tls_session, session_error_t err)
548 session_t *app_session;
549 tls_ctx_t *ho_ctx, *ctx;
553 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
555 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
556 ctx = tls_ctx_get (ctx_handle);
557 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
558 /* Half-open freed on tcp half-open cleanup notification */
560 ctx->c_thread_index = vlib_get_thread_index ();
561 ctx->tls_ctx_handle = ctx_handle;
562 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
564 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
565 ho_ctx_index, err, vlib_get_thread_index (),
566 (ctx) ? ctx_handle : ~0);
568 ctx->tls_session_handle = session_handle (tls_session);
569 tls_session->opaque = ctx_handle;
570 tls_session->session_state = SESSION_STATE_READY;
572 /* Preallocate app session. Avoids allocating a session post handshake
573 * on tls_session rx and potentially invalidating the session pool */
574 app_session = session_alloc (ctx->c_thread_index);
575 app_session->session_state = SESSION_STATE_CREATED;
576 ctx->c_s_index = app_session->session_index;
577 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
578 app_session->session_type = st;
579 app_session->connection_index = ctx->tls_ctx_handle;
581 if (tls_ctx_init_client (ctx))
583 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
584 tls_disconnect_transport (ctx);
591 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
596 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
598 ctx->tls_session_handle = session_handle (us);
599 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
600 us->opaque = ctx_handle;
602 /* We don't preallocate the app session because the udp session might
603 * actually migrate to a different worker at the end of the handshake */
605 return tls_ctx_init_client (ctx);
609 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
610 session_t *tls_session, session_error_t err)
614 app_worker_t *app_wrk;
618 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
619 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
622 api_context = ho_ctx->parent_app_api_context;
623 app_worker_connect_notify (app_wrk, 0, err, api_context);
629 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
630 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
633 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
638 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
642 if (ntf == SESSION_CLEANUP_TRANSPORT)
644 /* Allow cleanup of tcp session */
645 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
650 ctx = tls_ctx_get (s->opaque);
651 if (!ctx->no_app_session)
652 session_transport_delete_notify (&ctx->connection);
657 dtls_migrate_ctx (void *arg)
659 tls_ctx_t *ctx = (tls_ctx_t *) arg;
660 u32 ctx_handle, thread_index;
663 thread_index = session_thread_from_handle (ctx->tls_session_handle);
664 ASSERT (thread_index == vlib_get_thread_index ());
666 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
667 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
668 ctx->tls_ctx_handle = ctx_handle;
670 us = session_get_from_handle (ctx->tls_session_handle);
671 us->opaque = ctx_handle;
672 us->flags &= ~SESSION_F_IS_MIGRATING;
674 /* Probably the app detached while the session was migrating. Cleanup */
675 if (session_half_open_migrated_notify (&ctx->connection))
677 ctx->no_app_session = 1;
678 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
682 if (svm_fifo_max_dequeue (us->tx_fifo))
683 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
687 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
689 u32 new_thread = session_thread_from_handle (new_sh);
690 tls_ctx_t *ctx, *cloned_ctx;
692 /* Migrate dtls context to new thread */
693 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
694 ctx->tls_session_handle = new_sh;
695 cloned_ctx = tls_ctx_detach (ctx);
696 ctx->is_migrated = 1;
697 session_half_open_migrate_notify (&ctx->connection);
699 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
700 (void *) cloned_ctx);
706 tls_session_transport_closed_callback (session_t *ts)
710 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
711 session_transport_closed_notify (&ctx->connection);
714 static session_cb_vft_t tls_app_cb_vft = {
715 .session_accept_callback = tls_session_accept_callback,
716 .session_disconnect_callback = tls_session_disconnect_callback,
717 .session_connected_callback = tls_session_connected_callback,
718 .session_reset_callback = tls_session_reset_callback,
719 .session_transport_closed_callback = tls_session_transport_closed_callback,
720 .half_open_cleanup_callback = tls_session_cleanup_ho,
721 .add_segment_callback = tls_add_segment_callback,
722 .del_segment_callback = tls_del_segment_callback,
723 .builtin_app_rx_callback = tls_app_rx_callback,
724 .builtin_app_tx_callback = tls_app_tx_callback,
725 .session_migrate_callback = dtls_session_migrate_callback,
726 .session_cleanup_callback = tls_app_session_cleanup,
730 tls_connect (transport_endpoint_cfg_t * tep)
732 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
733 transport_endpt_crypto_cfg_t *ccfg;
734 crypto_engine_type_t engine_type;
735 session_endpoint_cfg_t *sep;
736 tls_main_t *tm = &tls_main;
737 app_worker_t *app_wrk;
743 sep = (session_endpoint_cfg_t *) tep;
745 return SESSION_E_NOEXTCFG;
747 app_wrk = app_worker_get (sep->app_wrk_index);
748 app = application_get (app_wrk->app_index);
750 ccfg = &sep->ext_cfg->crypto;
751 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
752 if (engine_type == CRYPTO_ENGINE_NONE)
754 clib_warning ("No tls engine_type available");
755 return SESSION_E_NOCRYPTOENG;
758 ctx_index = tls_ctx_half_open_alloc ();
759 ctx = tls_ctx_half_open_get (ctx_index);
760 ctx->parent_app_wrk_index = sep->app_wrk_index;
761 ctx->parent_app_api_context = sep->opaque;
762 ctx->tcp_is_ip4 = sep->is_ip4;
763 ctx->tls_type = sep->transport_proto;
764 ctx->ckpair_index = ccfg->ckpair_index;
765 ctx->c_proto = TRANSPORT_PROTO_TLS;
766 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
767 if (ccfg->hostname[0])
769 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
770 vec_terminate_c_string (ctx->srv_hostname);
773 ctx->tls_ctx_engine = engine_type;
775 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
776 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
777 cargs->app_index = tm->app_index;
778 cargs->api_context = ctx_index;
779 cargs->sep_ext.ns_index = app->ns_index;
780 if ((rv = vnet_connect (cargs)))
783 /* Track half-open tcp session in case we need to clean it up */
784 ctx->tls_session_handle = cargs->sh;
786 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
791 tls_disconnect (u32 ctx_handle, u32 thread_index)
795 TLS_DBG (1, "Disconnecting %x", ctx_handle);
797 ctx = tls_ctx_get (ctx_handle);
798 tls_ctx_app_close (ctx);
802 tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
804 vnet_listen_args_t _bargs, *args = &_bargs;
805 transport_endpt_crypto_cfg_t *ccfg;
806 app_worker_t *app_wrk;
807 tls_main_t *tm = &tls_main;
808 session_handle_t tls_al_handle;
809 session_endpoint_cfg_t *sep;
810 session_t *tls_listener;
811 session_t *app_listener;
812 crypto_engine_type_t engine_type;
819 sep = (session_endpoint_cfg_t *) tep;
821 return SESSION_E_NOEXTCFG;
823 app_wrk = app_worker_get (sep->app_wrk_index);
824 app = application_get (app_wrk->app_index);
826 ccfg = &sep->ext_cfg->crypto;
827 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
828 if (engine_type == CRYPTO_ENGINE_NONE)
830 clib_warning ("No tls engine_type available");
831 return SESSION_E_NOCRYPTOENG;
834 clib_memset (args, 0, sizeof (*args));
835 args->app_index = tm->app_index;
836 args->sep_ext = *sep;
837 args->sep_ext.ns_index = app->ns_index;
838 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
839 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
841 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
842 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
844 if ((rv = vnet_listen (args)))
847 lctx_index = tls_listener_ctx_alloc ();
848 tls_al_handle = args->handle;
849 al = app_listener_get_w_handle (tls_al_handle);
850 tls_listener = app_listener_get_session (al);
851 tls_listener->opaque = lctx_index;
853 app_listener = listen_session_get (app_listener_index);
855 lctx = tls_listener_ctx_get (lctx_index);
856 lctx->parent_app_wrk_index = sep->app_wrk_index;
857 lctx->tls_session_handle = tls_al_handle;
858 lctx->app_session_handle = listen_session_get_handle (app_listener);
859 lctx->tcp_is_ip4 = sep->is_ip4;
860 lctx->tls_ctx_engine = engine_type;
861 lctx->tls_type = sep->transport_proto;
862 lctx->ckpair_index = ccfg->ckpair_index;
863 lctx->c_s_index = app_listener_index;
864 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
866 if (tls_vfts[engine_type].ctx_start_listen (lctx))
868 vnet_unlisten_args_t a = {
869 .handle = lctx->tls_session_handle,
870 .app_index = tls_main.app_index,
873 if ((vnet_unlisten (&a)))
874 clib_warning ("unlisten returned");
875 tls_listener_ctx_free (lctx);
876 lctx_index = SESSION_INVALID_INDEX;
879 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
885 tls_stop_listen (u32 lctx_index)
887 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
888 crypto_engine_type_t engine_type;
889 transport_connection_t *lc;
894 lctx = tls_listener_ctx_get (lctx_index);
896 /* Cleanup listener from session lookup table */
897 ls = session_get_from_handle (lctx->tls_session_handle);
898 lc = session_get_transport (ls);
900 sep.fib_index = lc->fib_index;
901 sep.port = lc->lcl_port;
902 sep.is_ip4 = lc->is_ip4;
903 sep.transport_proto = lctx->tls_type;
904 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
905 session_lookup_del_session_endpoint2 (&sep);
907 vnet_unlisten_args_t a = {
908 .handle = lctx->tls_session_handle,
909 .app_index = tls_main.app_index,
910 .wrk_map_index = 0 /* default wrk */
912 if ((rv = vnet_unlisten (&a)))
913 clib_warning ("unlisten returned %d", rv);
915 engine_type = lctx->tls_ctx_engine;
916 tls_vfts[engine_type].ctx_stop_listen (lctx);
918 tls_listener_ctx_free (lctx);
922 transport_connection_t *
923 tls_connection_get (u32 ctx_index, u32 thread_index)
926 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
927 return &ctx->connection;
930 transport_connection_t *
931 tls_listener_get (u32 listener_index)
934 ctx = tls_listener_ctx_get (listener_index);
935 return &ctx->connection;
938 static transport_connection_t *
939 tls_half_open_get (u32 ho_index)
942 ctx = tls_ctx_half_open_get (ho_index);
943 return &ctx->connection;
947 tls_cleanup_ho (u32 ho_index)
952 ctx = tls_ctx_half_open_get (ho_index);
953 s = session_get_from_handle (ctx->tls_session_handle);
954 /* If no pending cleanup notification, force cleanup now. Otherwise,
955 * wait for cleanup notification and set no app session on ctx */
956 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
958 session_cleanup_half_open (ctx->tls_session_handle);
959 tls_ctx_half_open_free (ho_index);
962 ctx->no_app_session = 1;
966 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
968 session_t *as = (session_t *) session;
971 if (PREDICT_FALSE (as->session_state >= SESSION_STATE_TRANSPORT_CLOSED ||
972 as->session_state <= SESSION_STATE_ACCEPTING))
974 sp->flags |= TRANSPORT_SND_F_DESCHED;
978 ctx = tls_ctx_get (as->connection_index);
979 return tls_ctx_write (ctx, as, sp);
983 format_tls_ctx (u8 * s, va_list * args)
985 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
986 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
989 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
990 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
991 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
993 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
994 ctx->c_thread_index, ctx->c_s_index, proto,
995 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
1001 format_tls_listener_ctx (u8 * s, va_list * args)
1003 session_t *tls_listener;
1008 ctx = va_arg (*args, tls_ctx_t *);
1010 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
1011 al = app_listener_get_w_handle (ctx->tls_session_handle);
1012 tls_listener = app_listener_get_session (al);
1013 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
1014 ctx->c_thread_index, ctx->c_s_index, proto,
1015 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
1016 tls_listener->thread_index, tls_listener->session_index);
1022 format_tls_ctx_state (u8 * s, va_list * args)
1027 ctx = va_arg (*args, tls_ctx_t *);
1028 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
1029 if (ts->session_state == SESSION_STATE_LISTENING)
1030 s = format (s, "%s", "LISTEN");
1033 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1034 s = format (s, "%s", "CLOSED");
1035 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1036 s = format (s, "%s", "APP-CLOSED");
1037 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1038 s = format (s, "%s", "CLOSING");
1039 else if (tls_ctx_handshake_is_over (ctx))
1040 s = format (s, "%s", "ESTABLISHED");
1042 s = format (s, "%s", "HANDSHAKE");
1049 format_tls_connection (u8 * s, va_list * args)
1051 u32 ctx_index = va_arg (*args, u32);
1052 u32 thread_index = va_arg (*args, u32);
1053 u32 verbose = va_arg (*args, u32);
1056 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1060 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1063 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1066 s = format (s, "\n");
1072 format_tls_listener (u8 * s, va_list * args)
1074 u32 tc_index = va_arg (*args, u32);
1075 u32 __clib_unused thread_index = va_arg (*args, u32);
1076 u32 verbose = va_arg (*args, u32);
1077 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1079 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1081 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1086 format_tls_half_open (u8 * s, va_list * args)
1088 u32 ho_index = va_arg (*args, u32);
1089 u32 __clib_unused thread_index = va_arg (*args, u32);
1090 u32 __clib_unused verbose = va_arg (*args, u32);
1094 ho_ctx = tls_ctx_half_open_get (ho_index);
1096 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1097 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1098 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1099 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1100 tcp_ho->thread_index, tcp_ho->session_index);
1106 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1107 transport_endpoint_t * tep, u8 is_lcl)
1109 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1110 session_t *tcp_session;
1112 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1113 session_get_endpoint (tcp_session, tep, is_lcl);
1117 tls_transport_listener_endpoint_get (u32 ctx_handle,
1118 transport_endpoint_t * tep, u8 is_lcl)
1120 session_t *tls_listener;
1122 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1124 al = app_listener_get_w_handle (ctx->tls_session_handle);
1125 tls_listener = app_listener_get_session (al);
1126 session_get_endpoint (tls_listener, tep, is_lcl);
1129 static clib_error_t *
1130 tls_enable (vlib_main_t * vm, u8 is_en)
1132 vnet_app_detach_args_t _da, *da = &_da;
1133 vnet_app_attach_args_t _a, *a = &_a;
1134 u64 options[APP_OPTIONS_N_OPTIONS];
1135 tls_main_t *tm = &tls_main;
1136 u32 fifo_size = 512 << 10;
1140 da->app_index = tm->app_index;
1141 da->api_client_index = APP_INVALID_INDEX;
1142 vnet_application_detach (da);
1146 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1148 clib_memset (a, 0, sizeof (*a));
1149 clib_memset (options, 0, sizeof (options));
1151 a->session_cb_vft = &tls_app_cb_vft;
1152 a->api_client_index = APP_INVALID_INDEX;
1153 a->options = options;
1154 a->name = format (0, "tls");
1155 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1156 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
1157 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1158 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1159 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1160 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1161 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1163 if (vnet_application_attach (a))
1165 clib_warning ("failed to attach tls app");
1166 return clib_error_return (0, "failed to attach tls app");
1169 tm->app_index = a->app_index;
1175 static const transport_proto_vft_t tls_proto = {
1176 .enable = tls_enable,
1177 .connect = tls_connect,
1178 .close = tls_disconnect,
1179 .start_listen = tls_start_listen,
1180 .stop_listen = tls_stop_listen,
1181 .get_connection = tls_connection_get,
1182 .get_listener = tls_listener_get,
1183 .get_half_open = tls_half_open_get,
1184 .cleanup_ho = tls_cleanup_ho,
1185 .custom_tx = tls_custom_tx_callback,
1186 .format_connection = format_tls_connection,
1187 .format_half_open = format_tls_half_open,
1188 .format_listener = format_tls_listener,
1189 .get_transport_endpoint = tls_transport_endpoint_get,
1190 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1191 .transport_options = {
1194 .tx_type = TRANSPORT_TX_INTERNAL,
1195 .service_type = TRANSPORT_SERVICE_VC,
1200 dtls_connect (transport_endpoint_cfg_t *tep)
1202 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1203 transport_endpt_crypto_cfg_t *ccfg;
1204 crypto_engine_type_t engine_type;
1205 session_endpoint_cfg_t *sep;
1206 tls_main_t *tm = &tls_main;
1207 app_worker_t *app_wrk;
1213 sep = (session_endpoint_cfg_t *) tep;
1217 app_wrk = app_worker_get (sep->app_wrk_index);
1218 app = application_get (app_wrk->app_index);
1220 ccfg = &sep->ext_cfg->crypto;
1221 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1222 if (engine_type == CRYPTO_ENGINE_NONE)
1224 clib_warning ("No tls engine_type available");
1228 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1229 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1230 ctx->parent_app_wrk_index = sep->app_wrk_index;
1231 ctx->parent_app_api_context = sep->opaque;
1232 ctx->tcp_is_ip4 = sep->is_ip4;
1233 ctx->ckpair_index = ccfg->ckpair_index;
1234 ctx->tls_type = sep->transport_proto;
1235 ctx->tls_ctx_handle = ctx_handle;
1236 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1237 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1238 if (ccfg->hostname[0])
1240 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1241 vec_terminate_c_string (ctx->srv_hostname);
1244 ctx->tls_ctx_engine = engine_type;
1246 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1247 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1248 cargs->app_index = tm->app_index;
1249 cargs->api_context = ctx_handle;
1250 cargs->sep_ext.ns_index = app->ns_index;
1251 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1252 if ((rv = vnet_connect (cargs)))
1255 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1260 static transport_connection_t *
1261 dtls_half_open_get (u32 ho_index)
1264 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1265 return &ho_ctx->connection;
1269 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1275 dtls_cleanup_ho (u32 ho_index)
1278 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1283 format_dtls_half_open (u8 *s, va_list *args)
1285 u32 ho_index = va_arg (*args, u32);
1286 u32 __clib_unused thread_index = va_arg (*args, u32);
1290 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1292 us = session_get_from_handle (ho_ctx->tls_session_handle);
1293 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1294 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1295 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1296 us->thread_index, us->session_index);
1301 static const transport_proto_vft_t dtls_proto = {
1303 .connect = dtls_connect,
1304 .close = tls_disconnect,
1305 .start_listen = tls_start_listen,
1306 .stop_listen = tls_stop_listen,
1307 .get_connection = tls_connection_get,
1308 .get_listener = tls_listener_get,
1309 .get_half_open = dtls_half_open_get,
1310 .custom_tx = tls_custom_tx_callback,
1311 .cleanup = dtls_cleanup_callback,
1312 .cleanup_ho = dtls_cleanup_ho,
1313 .format_connection = format_tls_connection,
1314 .format_half_open = format_dtls_half_open,
1315 .format_listener = format_tls_listener,
1316 .get_transport_endpoint = tls_transport_endpoint_get,
1317 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1318 .transport_options = {
1321 .tx_type = TRANSPORT_TX_INTERNAL,
1322 .service_type = TRANSPORT_SERVICE_VC,
1327 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1329 vec_validate (tls_vfts, type);
1330 tls_vfts[type] = *vft;
1333 static clib_error_t *
1334 tls_init (vlib_main_t * vm)
1336 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1337 tls_main_t *tm = &tls_main;
1340 num_threads = 1 /* main thread */ + vtm->n_threads;
1342 if (!tm->ca_cert_path)
1343 tm->ca_cert_path = TLS_CA_CERT_PATH;
1345 vec_validate (tm->rx_bufs, num_threads - 1);
1346 vec_validate (tm->tx_bufs, num_threads - 1);
1348 tm->first_seg_size = 32 << 20;
1349 tm->add_seg_size = 256 << 20;
1351 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1352 FIB_PROTOCOL_IP4, ~0);
1353 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1354 FIB_PROTOCOL_IP6, ~0);
1356 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1357 FIB_PROTOCOL_IP4, ~0);
1358 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1359 FIB_PROTOCOL_IP6, ~0);
1363 VLIB_INIT_FUNCTION (tls_init);
1365 static clib_error_t *
1366 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1368 tls_main_t *tm = &tls_main;
1370 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1372 if (unformat (input, "use-test-cert-in-ca"))
1373 tm->use_test_cert_in_ca = 1;
1374 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1376 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1377 &tm->first_seg_size))
1379 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1382 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1384 if (tmp >= 0x100000000ULL)
1386 return clib_error_return
1387 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1389 tm->fifo_size = tmp;
1392 return clib_error_return (0, "unknown input `%U'",
1393 format_unformat_error, input);
1398 VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
1401 vnet_tls_get_main (void)
1407 * fd.io coding-style-patch-verification: ON
1410 * eval: (c-set-style "gnu")