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;
125 return ctx->c_c_index;
129 tls_ctx_half_open_free (u32 ho_index)
131 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
135 tls_ctx_half_open_get (u32 ctx_index)
137 tls_main_t *tm = &tls_main;
138 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
142 tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
144 app_worker_t *app_wrk;
145 app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
146 if (PREDICT_TRUE (app_wrk != 0))
147 tls_add_app_q_evt (app_wrk, app_session);
151 tls_notify_app_accept (tls_ctx_t * ctx)
153 session_t *app_listener, *app_session;
154 app_worker_t *app_wrk;
158 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
159 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
161 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
162 app_session->app_wrk_index = ctx->parent_app_wrk_index;
163 app_session->connection_index = ctx->tls_ctx_handle;
164 app_session->session_type = app_listener->session_type;
165 app_session->listener_handle = listen_session_get_handle (app_listener);
166 app_session->session_state = SESSION_STATE_ACCEPTING;
168 if ((rv = app_worker_init_accepted (app_session)))
170 TLS_DBG (1, "failed to allocate fifos");
171 session_free (app_session);
174 ctx->app_session_handle = session_handle (app_session);
175 ctx->parent_app_wrk_index = app_session->app_wrk_index;
176 app_wrk = app_worker_get (app_session->app_wrk_index);
177 return app_worker_accept_notify (app_wrk, app_session);
181 tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
183 u32 parent_app_api_ctx;
184 session_t *app_session;
185 app_worker_t *app_wrk;
187 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
190 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
191 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
192 ctx->no_app_session = 1;
198 /* Free app session pre-allocated when transport was established */
199 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
200 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
201 ctx->no_app_session = 1;
205 /* For DTLS the app session is not preallocated because the underlying udp
206 * session might migrate to a different worker during the handshake */
207 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
210 /* Cleanup half-open session as we don't get notification from udp */
211 session_half_open_delete_notify (&ctx->connection);
212 app_session = session_alloc (ctx->c_thread_index);
213 app_session->session_state = SESSION_STATE_CREATED;
214 ctx->c_s_index = app_session->session_index;
216 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
217 app_session->session_type = st;
218 app_session->connection_index = ctx->tls_ctx_handle;
222 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
225 app_session->app_wrk_index = ctx->parent_app_wrk_index;
227 if ((err = app_worker_init_connected (app_wrk, app_session)))
230 app_session->session_state = SESSION_STATE_READY;
231 parent_app_api_ctx = ctx->parent_app_api_context;
232 ctx->app_session_handle = session_handle (app_session);
234 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
237 TLS_DBG (1, "failed to notify app");
238 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
239 ctx->no_app_session = 1;
246 ctx->no_app_session = 1;
247 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
249 return app_worker_connect_notify (app_wrk, 0, err,
250 ctx->parent_app_api_context);
254 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
256 *ctx_index = ctx_handle & TLS_IDX_MASK;
257 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
260 static inline crypto_engine_type_t
261 tls_get_engine_type (crypto_engine_type_t requested,
262 crypto_engine_type_t preferred)
264 if (requested != CRYPTO_ENGINE_NONE)
266 if (tls_vfts[requested].ctx_alloc)
268 return CRYPTO_ENGINE_NONE;
270 if (!tls_vfts[preferred].ctx_alloc)
271 return tls_get_available_engine ();
276 tls_ctx_alloc (crypto_engine_type_t engine_type)
279 ctx_index = tls_vfts[engine_type].ctx_alloc ();
280 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
284 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
287 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
288 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
292 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
295 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
296 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
300 tls_ctx_detach (tls_ctx_t *ctx)
302 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
305 static inline tls_ctx_t *
306 tls_ctx_get (u32 ctx_handle)
308 u32 ctx_index, engine_type;
309 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
310 return tls_vfts[engine_type].ctx_get (ctx_index);
313 static inline tls_ctx_t *
314 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
316 u32 ctx_index, engine_type;
317 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
318 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
322 tls_ctx_init_server (tls_ctx_t * ctx)
324 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
328 tls_ctx_init_client (tls_ctx_t * ctx)
330 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
334 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
335 transport_send_params_t * sp)
339 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
340 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
341 sp->bytes_dequeued = n_wrote;
342 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
346 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
348 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
352 tls_ctx_transport_close (tls_ctx_t * ctx)
354 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
358 tls_ctx_app_close (tls_ctx_t * ctx)
360 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
364 tls_ctx_free (tls_ctx_t * ctx)
366 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
370 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
372 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
376 tls_reinit_ca_chain (crypto_engine_type_t tls_engine_id)
378 return tls_vfts[tls_engine_id].ctx_reinit_cachain ();
382 tls_notify_app_io_error (tls_ctx_t *ctx)
384 ASSERT (tls_ctx_handshake_is_over (ctx));
386 session_transport_reset_notify (&ctx->connection);
387 session_transport_closed_notify (&ctx->connection);
388 tls_disconnect_transport (ctx);
392 tls_session_reset_callback (session_t * s)
395 transport_connection_t *tc;
396 session_t *app_session;
398 ctx = tls_ctx_get (s->opaque);
399 ctx->is_passive_close = 1;
400 tc = &ctx->connection;
401 if (tls_ctx_handshake_is_over (ctx))
403 session_transport_reset_notify (tc);
404 session_transport_closed_notify (tc);
405 tls_disconnect_transport (ctx);
409 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
411 session_free (app_session);
412 ctx->c_s_index = SESSION_INVALID_INDEX;
413 tls_disconnect_transport (ctx);
418 tls_session_cleanup_ho (session_t *s)
423 /* session opaque stores the opaque passed on connect */
424 ho_index = s->opaque;
425 ctx = tls_ctx_half_open_get (ho_index);
426 session_half_open_delete_notify (&ctx->connection);
427 tls_ctx_half_open_free (ho_index);
431 tls_add_segment_callback (u32 client_index, u64 segment_handle)
433 /* No-op for builtin */
438 tls_del_segment_callback (u32 client_index, u64 segment_handle)
444 tls_session_disconnect_callback (session_t * tls_session)
448 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
449 tls_session->session_index);
451 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
452 || vlib_thread_is_main_w_barrier ());
454 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
455 ctx->is_passive_close = 1;
456 tls_ctx_transport_close (ctx);
460 tls_session_accept_callback (session_t * tls_session)
462 session_t *tls_listener, *app_session;
463 tls_ctx_t *lctx, *ctx;
467 listen_session_get_from_handle (tls_session->listener_handle);
468 lctx = tls_listener_ctx_get (tls_listener->opaque);
470 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
471 ctx = tls_ctx_get (ctx_handle);
472 memcpy (ctx, lctx, sizeof (*lctx));
473 ctx->c_thread_index = vlib_get_thread_index ();
474 ctx->tls_ctx_handle = ctx_handle;
475 tls_session->session_state = SESSION_STATE_READY;
476 tls_session->opaque = ctx_handle;
477 ctx->tls_session_handle = session_handle (tls_session);
478 ctx->listener_ctx_index = tls_listener->opaque;
479 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
480 ctx->ckpair_index = lctx->ckpair_index;
482 /* Preallocate app session. Avoids allocating a session post handshake
483 * on tls_session rx and potentially invalidating the session pool */
484 app_session = session_alloc (ctx->c_thread_index);
485 app_session->session_state = SESSION_STATE_CREATED;
486 ctx->c_s_index = app_session->session_index;
488 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
489 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
491 return tls_ctx_init_server (ctx);
495 tls_app_rx_callback (session_t * tls_session)
499 /* DTLS session migrating, wait for next notification */
500 if (PREDICT_FALSE (tls_session->flags & SESSION_F_IS_MIGRATING))
503 ctx = tls_ctx_get (tls_session->opaque);
504 if (PREDICT_FALSE (ctx->no_app_session))
506 TLS_DBG (1, "Local App closed");
509 tls_ctx_read (ctx, tls_session);
514 tls_app_tx_callback (session_t * tls_session)
518 ctx = tls_ctx_get (tls_session->opaque);
519 transport_connection_reschedule (&ctx->connection);
525 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
526 session_t *tls_session, session_error_t err)
528 session_t *app_session;
529 tls_ctx_t *ho_ctx, *ctx;
533 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
535 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
536 ctx = tls_ctx_get (ctx_handle);
537 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
538 /* Half-open freed on tcp half-open cleanup notification */
540 ctx->c_thread_index = vlib_get_thread_index ();
541 ctx->tls_ctx_handle = ctx_handle;
542 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
544 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
545 ho_ctx_index, err, vlib_get_thread_index (),
546 (ctx) ? ctx_handle : ~0);
548 ctx->tls_session_handle = session_handle (tls_session);
549 tls_session->opaque = ctx_handle;
550 tls_session->session_state = SESSION_STATE_READY;
552 /* Preallocate app session. Avoids allocating a session post handshake
553 * on tls_session rx and potentially invalidating the session pool */
554 app_session = session_alloc (ctx->c_thread_index);
555 app_session->session_state = SESSION_STATE_CREATED;
556 ctx->c_s_index = app_session->session_index;
557 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
558 app_session->session_type = st;
559 app_session->connection_index = ctx->tls_ctx_handle;
561 return tls_ctx_init_client (ctx);
565 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
570 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
572 ctx->tls_session_handle = session_handle (us);
573 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
574 us->opaque = ctx_handle;
576 /* We don't preallocate the app session because the udp session might
577 * actually migrate to a different worker at the end of the handshake */
579 return tls_ctx_init_client (ctx);
583 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
584 session_t *tls_session, session_error_t err)
588 app_worker_t *app_wrk;
592 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
593 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
596 api_context = ho_ctx->parent_app_api_context;
597 app_worker_connect_notify (app_wrk, 0, err, api_context);
603 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
604 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
607 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
612 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
616 if (ntf == SESSION_CLEANUP_TRANSPORT)
618 /* Allow cleanup of tcp session */
619 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
624 ctx = tls_ctx_get (s->opaque);
625 if (!ctx->no_app_session)
626 session_transport_delete_notify (&ctx->connection);
631 dtls_migrate_ctx (void *arg)
633 tls_ctx_t *ctx = (tls_ctx_t *) arg;
634 u32 ctx_handle, thread_index;
637 thread_index = session_thread_from_handle (ctx->tls_session_handle);
638 ASSERT (thread_index == vlib_get_thread_index ());
640 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
641 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
642 ctx->tls_ctx_handle = ctx_handle;
644 us = session_get_from_handle (ctx->tls_session_handle);
645 us->opaque = ctx_handle;
646 us->flags &= ~SESSION_F_IS_MIGRATING;
648 /* Probably the app detached while the session was migrating. Cleanup */
649 if (session_half_open_migrated_notify (&ctx->connection))
651 ctx->no_app_session = 1;
652 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
656 if (svm_fifo_max_dequeue (us->tx_fifo))
657 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
661 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
663 u32 new_thread = session_thread_from_handle (new_sh);
664 tls_ctx_t *ctx, *cloned_ctx;
666 /* Migrate dtls context to new thread */
667 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
668 ctx->tls_session_handle = new_sh;
669 cloned_ctx = tls_ctx_detach (ctx);
670 ctx->is_migrated = 1;
671 session_half_open_migrate_notify (&ctx->connection);
673 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
674 (void *) cloned_ctx);
679 static session_cb_vft_t tls_app_cb_vft = {
680 .session_accept_callback = tls_session_accept_callback,
681 .session_disconnect_callback = tls_session_disconnect_callback,
682 .session_connected_callback = tls_session_connected_callback,
683 .session_reset_callback = tls_session_reset_callback,
684 .half_open_cleanup_callback = tls_session_cleanup_ho,
685 .add_segment_callback = tls_add_segment_callback,
686 .del_segment_callback = tls_del_segment_callback,
687 .builtin_app_rx_callback = tls_app_rx_callback,
688 .builtin_app_tx_callback = tls_app_tx_callback,
689 .session_migrate_callback = dtls_session_migrate_callback,
690 .session_cleanup_callback = tls_app_session_cleanup,
694 tls_connect (transport_endpoint_cfg_t * tep)
696 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
697 transport_endpt_crypto_cfg_t *ccfg;
698 crypto_engine_type_t engine_type;
699 session_endpoint_cfg_t *sep;
700 tls_main_t *tm = &tls_main;
701 app_worker_t *app_wrk;
707 sep = (session_endpoint_cfg_t *) tep;
709 return SESSION_E_NOEXTCFG;
711 app_wrk = app_worker_get (sep->app_wrk_index);
712 app = application_get (app_wrk->app_index);
714 ccfg = &sep->ext_cfg->crypto;
715 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
716 if (engine_type == CRYPTO_ENGINE_NONE)
718 clib_warning ("No tls engine_type available");
719 return SESSION_E_NOCRYPTOENG;
722 ctx_index = tls_ctx_half_open_alloc ();
723 ctx = tls_ctx_half_open_get (ctx_index);
724 ctx->parent_app_wrk_index = sep->app_wrk_index;
725 ctx->parent_app_api_context = sep->opaque;
726 ctx->tcp_is_ip4 = sep->is_ip4;
727 ctx->tls_type = sep->transport_proto;
728 ctx->ckpair_index = ccfg->ckpair_index;
729 ctx->c_proto = TRANSPORT_PROTO_TLS;
730 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
731 if (ccfg->hostname[0])
733 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
734 vec_terminate_c_string (ctx->srv_hostname);
737 ctx->tls_ctx_engine = engine_type;
739 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
740 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
741 cargs->app_index = tm->app_index;
742 cargs->api_context = ctx_index;
743 cargs->sep_ext.ns_index = app->ns_index;
744 if ((rv = vnet_connect (cargs)))
747 /* Track half-open tcp session in case we need to clean it up */
748 ctx->tls_session_handle = cargs->sh;
750 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
755 tls_disconnect (u32 ctx_handle, u32 thread_index)
759 TLS_DBG (1, "Disconnecting %x", ctx_handle);
761 ctx = tls_ctx_get (ctx_handle);
762 tls_ctx_app_close (ctx);
766 tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
768 vnet_listen_args_t _bargs, *args = &_bargs;
769 transport_endpt_crypto_cfg_t *ccfg;
770 app_worker_t *app_wrk;
771 tls_main_t *tm = &tls_main;
772 session_handle_t tls_al_handle;
773 session_endpoint_cfg_t *sep;
774 session_t *tls_listener;
775 session_t *app_listener;
776 crypto_engine_type_t engine_type;
783 sep = (session_endpoint_cfg_t *) tep;
785 return SESSION_E_NOEXTCFG;
787 app_wrk = app_worker_get (sep->app_wrk_index);
788 app = application_get (app_wrk->app_index);
790 ccfg = &sep->ext_cfg->crypto;
791 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
792 if (engine_type == CRYPTO_ENGINE_NONE)
794 clib_warning ("No tls engine_type available");
795 return SESSION_E_NOCRYPTOENG;
798 clib_memset (args, 0, sizeof (*args));
799 args->app_index = tm->app_index;
800 args->sep_ext = *sep;
801 args->sep_ext.ns_index = app->ns_index;
802 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
803 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
805 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
806 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
808 if ((rv = vnet_listen (args)))
811 lctx_index = tls_listener_ctx_alloc ();
812 tls_al_handle = args->handle;
813 al = app_listener_get_w_handle (tls_al_handle);
814 tls_listener = app_listener_get_session (al);
815 tls_listener->opaque = lctx_index;
817 app_listener = listen_session_get (app_listener_index);
819 lctx = tls_listener_ctx_get (lctx_index);
820 lctx->parent_app_wrk_index = sep->app_wrk_index;
821 lctx->tls_session_handle = tls_al_handle;
822 lctx->app_session_handle = listen_session_get_handle (app_listener);
823 lctx->tcp_is_ip4 = sep->is_ip4;
824 lctx->tls_ctx_engine = engine_type;
825 lctx->tls_type = sep->transport_proto;
826 lctx->ckpair_index = ccfg->ckpair_index;
827 lctx->c_s_index = app_listener_index;
828 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
830 if (tls_vfts[engine_type].ctx_start_listen (lctx))
832 vnet_unlisten_args_t a = {
833 .handle = lctx->tls_session_handle,
834 .app_index = tls_main.app_index,
837 if ((vnet_unlisten (&a)))
838 clib_warning ("unlisten returned");
839 tls_listener_ctx_free (lctx);
840 lctx_index = SESSION_INVALID_INDEX;
843 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
849 tls_stop_listen (u32 lctx_index)
851 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
852 crypto_engine_type_t engine_type;
853 transport_connection_t *lc;
858 lctx = tls_listener_ctx_get (lctx_index);
860 /* Cleanup listener from session lookup table */
861 ls = session_get_from_handle (lctx->tls_session_handle);
862 lc = session_get_transport (ls);
864 sep.fib_index = lc->fib_index;
865 sep.port = lc->lcl_port;
866 sep.is_ip4 = lc->is_ip4;
867 sep.transport_proto = lctx->tls_type;
868 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
869 session_lookup_del_session_endpoint2 (&sep);
871 vnet_unlisten_args_t a = {
872 .handle = lctx->tls_session_handle,
873 .app_index = tls_main.app_index,
874 .wrk_map_index = 0 /* default wrk */
876 if ((rv = vnet_unlisten (&a)))
877 clib_warning ("unlisten returned %d", rv);
879 engine_type = lctx->tls_ctx_engine;
880 tls_vfts[engine_type].ctx_stop_listen (lctx);
882 tls_listener_ctx_free (lctx);
886 transport_connection_t *
887 tls_connection_get (u32 ctx_index, u32 thread_index)
890 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
891 return &ctx->connection;
894 transport_connection_t *
895 tls_listener_get (u32 listener_index)
898 ctx = tls_listener_ctx_get (listener_index);
899 return &ctx->connection;
902 static transport_connection_t *
903 tls_half_open_get (u32 ho_index)
906 ctx = tls_ctx_half_open_get (ho_index);
907 return &ctx->connection;
911 tls_cleanup_ho (u32 ho_index)
915 ctx = tls_ctx_half_open_get (ho_index);
916 session_cleanup_half_open (ctx->tls_session_handle);
917 tls_ctx_half_open_free (ho_index);
921 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
923 session_t *app_session = (session_t *) session;
926 if (PREDICT_FALSE (app_session->session_state
927 >= SESSION_STATE_TRANSPORT_CLOSED))
930 ctx = tls_ctx_get (app_session->connection_index);
931 return tls_ctx_write (ctx, app_session, sp);
935 format_tls_ctx (u8 * s, va_list * args)
937 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
938 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
941 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
942 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
943 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
945 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
946 ctx->c_thread_index, ctx->c_s_index, proto,
947 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
953 format_tls_listener_ctx (u8 * s, va_list * args)
955 session_t *tls_listener;
960 ctx = va_arg (*args, tls_ctx_t *);
962 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
963 al = app_listener_get_w_handle (ctx->tls_session_handle);
964 tls_listener = app_listener_get_session (al);
965 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
966 ctx->c_thread_index, ctx->c_s_index, proto,
967 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
968 tls_listener->thread_index, tls_listener->session_index);
974 format_tls_ctx_state (u8 * s, va_list * args)
979 ctx = va_arg (*args, tls_ctx_t *);
980 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
981 if (ts->session_state == SESSION_STATE_LISTENING)
982 s = format (s, "%s", "LISTEN");
985 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
986 s = format (s, "%s", "CLOSED");
987 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
988 s = format (s, "%s", "APP-CLOSED");
989 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
990 s = format (s, "%s", "CLOSING");
991 else if (tls_ctx_handshake_is_over (ctx))
992 s = format (s, "%s", "ESTABLISHED");
994 s = format (s, "%s", "HANDSHAKE");
1001 format_tls_connection (u8 * s, va_list * args)
1003 u32 ctx_index = va_arg (*args, u32);
1004 u32 thread_index = va_arg (*args, u32);
1005 u32 verbose = va_arg (*args, u32);
1008 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1012 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1015 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1018 s = format (s, "\n");
1024 format_tls_listener (u8 * s, va_list * args)
1026 u32 tc_index = va_arg (*args, u32);
1027 u32 __clib_unused thread_index = va_arg (*args, u32);
1028 u32 verbose = va_arg (*args, u32);
1029 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1031 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1033 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1038 format_tls_half_open (u8 * s, va_list * args)
1040 u32 ho_index = va_arg (*args, u32);
1041 u32 __clib_unused thread_index = va_arg (*args, u32);
1045 ho_ctx = tls_ctx_half_open_get (ho_index);
1047 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1048 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1049 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1050 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1051 tcp_ho->thread_index, tcp_ho->session_index);
1057 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1058 transport_endpoint_t * tep, u8 is_lcl)
1060 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1061 session_t *tcp_session;
1063 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1064 session_get_endpoint (tcp_session, tep, is_lcl);
1068 tls_transport_listener_endpoint_get (u32 ctx_handle,
1069 transport_endpoint_t * tep, u8 is_lcl)
1071 session_t *tls_listener;
1073 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1075 al = app_listener_get_w_handle (ctx->tls_session_handle);
1076 tls_listener = app_listener_get_session (al);
1077 session_get_endpoint (tls_listener, tep, is_lcl);
1080 static clib_error_t *
1081 tls_enable (vlib_main_t * vm, u8 is_en)
1083 vnet_app_detach_args_t _da, *da = &_da;
1084 vnet_app_attach_args_t _a, *a = &_a;
1085 u64 options[APP_OPTIONS_N_OPTIONS];
1086 tls_main_t *tm = &tls_main;
1087 u32 fifo_size = 128 << 12;
1091 da->app_index = tm->app_index;
1092 da->api_client_index = APP_INVALID_INDEX;
1093 vnet_application_detach (da);
1097 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1099 clib_memset (a, 0, sizeof (*a));
1100 clib_memset (options, 0, sizeof (options));
1102 a->session_cb_vft = &tls_app_cb_vft;
1103 a->api_client_index = APP_INVALID_INDEX;
1104 a->options = options;
1105 a->name = format (0, "tls");
1106 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1107 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
1108 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1109 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1110 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1111 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1112 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1114 if (vnet_application_attach (a))
1116 clib_warning ("failed to attach tls app");
1117 return clib_error_return (0, "failed to attach tls app");
1120 tm->app_index = a->app_index;
1126 static const transport_proto_vft_t tls_proto = {
1127 .enable = tls_enable,
1128 .connect = tls_connect,
1129 .close = tls_disconnect,
1130 .start_listen = tls_start_listen,
1131 .stop_listen = tls_stop_listen,
1132 .get_connection = tls_connection_get,
1133 .get_listener = tls_listener_get,
1134 .get_half_open = tls_half_open_get,
1135 .cleanup_ho = tls_cleanup_ho,
1136 .custom_tx = tls_custom_tx_callback,
1137 .format_connection = format_tls_connection,
1138 .format_half_open = format_tls_half_open,
1139 .format_listener = format_tls_listener,
1140 .get_transport_endpoint = tls_transport_endpoint_get,
1141 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1142 .transport_options = {
1145 .tx_type = TRANSPORT_TX_INTERNAL,
1146 .service_type = TRANSPORT_SERVICE_VC,
1151 dtls_connect (transport_endpoint_cfg_t *tep)
1153 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1154 transport_endpt_crypto_cfg_t *ccfg;
1155 crypto_engine_type_t engine_type;
1156 session_endpoint_cfg_t *sep;
1157 tls_main_t *tm = &tls_main;
1158 app_worker_t *app_wrk;
1164 sep = (session_endpoint_cfg_t *) tep;
1168 app_wrk = app_worker_get (sep->app_wrk_index);
1169 app = application_get (app_wrk->app_index);
1171 ccfg = &sep->ext_cfg->crypto;
1172 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1173 if (engine_type == CRYPTO_ENGINE_NONE)
1175 clib_warning ("No tls engine_type available");
1179 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1180 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1181 ctx->parent_app_wrk_index = sep->app_wrk_index;
1182 ctx->parent_app_api_context = sep->opaque;
1183 ctx->tcp_is_ip4 = sep->is_ip4;
1184 ctx->ckpair_index = ccfg->ckpair_index;
1185 ctx->tls_type = sep->transport_proto;
1186 ctx->tls_ctx_handle = ctx_handle;
1187 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1188 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1189 if (ccfg->hostname[0])
1191 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1192 vec_terminate_c_string (ctx->srv_hostname);
1195 ctx->tls_ctx_engine = engine_type;
1197 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1198 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1199 cargs->app_index = tm->app_index;
1200 cargs->api_context = ctx_handle;
1201 cargs->sep_ext.ns_index = app->ns_index;
1202 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1203 if ((rv = vnet_connect (cargs)))
1206 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1211 static transport_connection_t *
1212 dtls_half_open_get (u32 ho_index)
1215 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1216 return &ho_ctx->connection;
1220 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1226 dtls_cleanup_ho (u32 ho_index)
1229 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1234 format_dtls_half_open (u8 *s, va_list *args)
1236 u32 ho_index = va_arg (*args, u32);
1237 u32 __clib_unused thread_index = va_arg (*args, u32);
1241 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1243 us = session_get_from_handle (ho_ctx->tls_session_handle);
1244 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1245 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1246 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1247 us->thread_index, us->session_index);
1252 static const transport_proto_vft_t dtls_proto = {
1254 .connect = dtls_connect,
1255 .close = tls_disconnect,
1256 .start_listen = tls_start_listen,
1257 .stop_listen = tls_stop_listen,
1258 .get_connection = tls_connection_get,
1259 .get_listener = tls_listener_get,
1260 .get_half_open = dtls_half_open_get,
1261 .custom_tx = tls_custom_tx_callback,
1262 .cleanup = dtls_cleanup_callback,
1263 .cleanup_ho = dtls_cleanup_ho,
1264 .format_connection = format_tls_connection,
1265 .format_half_open = format_dtls_half_open,
1266 .format_listener = format_tls_listener,
1267 .get_transport_endpoint = tls_transport_endpoint_get,
1268 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1269 .transport_options = {
1272 .tx_type = TRANSPORT_TX_INTERNAL,
1273 .service_type = TRANSPORT_SERVICE_VC,
1278 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1280 vec_validate (tls_vfts, type);
1281 tls_vfts[type] = *vft;
1284 static clib_error_t *
1285 tls_init (vlib_main_t * vm)
1287 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1288 tls_main_t *tm = &tls_main;
1291 num_threads = 1 /* main thread */ + vtm->n_threads;
1293 if (!tm->ca_cert_path)
1294 tm->ca_cert_path = TLS_CA_CERT_PATH;
1296 vec_validate (tm->rx_bufs, num_threads - 1);
1297 vec_validate (tm->tx_bufs, num_threads - 1);
1299 tm->first_seg_size = 32 << 20;
1300 tm->add_seg_size = 256 << 20;
1302 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1303 FIB_PROTOCOL_IP4, ~0);
1304 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1305 FIB_PROTOCOL_IP6, ~0);
1307 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1308 FIB_PROTOCOL_IP4, ~0);
1309 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1310 FIB_PROTOCOL_IP6, ~0);
1314 VLIB_INIT_FUNCTION (tls_init);
1316 static clib_error_t *
1317 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1319 tls_main_t *tm = &tls_main;
1321 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1323 if (unformat (input, "use-test-cert-in-ca"))
1324 tm->use_test_cert_in_ca = 1;
1325 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1327 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1328 &tm->first_seg_size))
1330 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1333 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1335 if (tmp >= 0x100000000ULL)
1337 return clib_error_return
1338 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1340 tm->fifo_size = tmp;
1343 return clib_error_return (0, "unknown input `%U'",
1344 format_unformat_error, input);
1349 VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
1352 vnet_tls_get_main (void)
1358 * fd.io coding-style-patch-verification: ON
1361 * eval: (c-set-style "gnu")