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 29
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;
122 pool_get_aligned_will_expand (tm->half_open_ctx_pool, will_expand, 0);
123 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
125 clib_rwlock_writer_lock (&tm->half_open_rwlock);
126 pool_get_zero (tm->half_open_ctx_pool, ctx);
127 ctx->c_c_index = ctx - tm->half_open_ctx_pool;
128 ctx_index = ctx->c_c_index;
129 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
133 /* reader lock assumption: only main thread will call pool_get */
134 clib_rwlock_reader_lock (&tm->half_open_rwlock);
135 pool_get_zero (tm->half_open_ctx_pool, ctx);
136 ctx->c_c_index = ctx - tm->half_open_ctx_pool;
137 ctx_index = ctx->c_c_index;
138 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
144 tls_ctx_half_open_free (u32 ho_index)
146 tls_main_t *tm = &tls_main;
147 clib_rwlock_writer_lock (&tm->half_open_rwlock);
148 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
149 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
153 tls_ctx_half_open_get (u32 ctx_index)
155 tls_main_t *tm = &tls_main;
156 clib_rwlock_reader_lock (&tm->half_open_rwlock);
157 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
161 tls_ctx_half_open_reader_unlock ()
163 clib_rwlock_reader_unlock (&tls_main.half_open_rwlock);
167 tls_ctx_half_open_index (tls_ctx_t * ctx)
169 return (ctx - tls_main.half_open_ctx_pool);
173 tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
175 app_worker_t *app_wrk;
176 app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
177 if (PREDICT_TRUE (app_wrk != 0))
178 tls_add_app_q_evt (app_wrk, app_session);
182 tls_notify_app_accept (tls_ctx_t * ctx)
184 session_t *app_listener, *app_session;
185 app_worker_t *app_wrk;
189 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
190 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
192 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
193 app_session->app_wrk_index = ctx->parent_app_wrk_index;
194 app_session->connection_index = ctx->tls_ctx_handle;
195 app_session->session_type = app_listener->session_type;
196 app_session->listener_handle = listen_session_get_handle (app_listener);
197 app_session->session_state = SESSION_STATE_ACCEPTING;
199 if ((rv = app_worker_init_accepted (app_session)))
201 TLS_DBG (1, "failed to allocate fifos");
202 session_free (app_session);
205 ctx->app_session_handle = session_handle (app_session);
206 ctx->parent_app_wrk_index = app_session->app_wrk_index;
207 app_wrk = app_worker_get (app_session->app_wrk_index);
208 return app_worker_accept_notify (app_wrk, app_session);
212 tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
214 session_t *app_session;
215 app_worker_t *app_wrk;
217 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
220 tls_disconnect_transport (ctx);
226 /* Free app session pre-allocated when transport was established */
227 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
228 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
229 ctx->no_app_session = 1;
233 /* For DTLS the app session is not preallocated because the underlying udp
234 * session might migrate to a different worker during the handshake */
235 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
238 /* Cleanup half-open session as we don't get notification from udp */
239 session_half_open_delete_notify (&ctx->connection);
240 app_session = session_alloc (ctx->c_thread_index);
241 app_session->session_state = SESSION_STATE_CREATED;
242 ctx->c_s_index = app_session->session_index;
244 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
245 app_session->session_type = st;
246 app_session->connection_index = ctx->tls_ctx_handle;
250 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
253 app_session->app_wrk_index = ctx->parent_app_wrk_index;
255 if ((err = app_worker_init_connected (app_wrk, app_session)))
258 app_session->session_state = SESSION_STATE_READY;
259 if (app_worker_connect_notify (app_wrk, app_session,
260 SESSION_E_NONE, ctx->parent_app_api_context))
262 TLS_DBG (1, "failed to notify app");
263 app_session->session_state = SESSION_STATE_CONNECTING;
264 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
268 ctx->app_session_handle = session_handle (app_session);
273 ctx->no_app_session = 1;
274 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
276 return app_worker_connect_notify (app_wrk, 0, err,
277 ctx->parent_app_api_context);
281 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
283 *ctx_index = ctx_handle & TLS_IDX_MASK;
284 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
287 static inline crypto_engine_type_t
288 tls_get_engine_type (crypto_engine_type_t requested,
289 crypto_engine_type_t preferred)
291 if (requested != CRYPTO_ENGINE_NONE)
293 if (tls_vfts[requested].ctx_alloc)
295 return CRYPTO_ENGINE_NONE;
297 if (!tls_vfts[preferred].ctx_alloc)
298 return tls_get_available_engine ();
303 tls_ctx_alloc (crypto_engine_type_t engine_type)
306 ctx_index = tls_vfts[engine_type].ctx_alloc ();
307 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
311 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
314 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
315 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
319 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
322 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
323 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
327 tls_ctx_detach (tls_ctx_t *ctx)
329 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
332 static inline tls_ctx_t *
333 tls_ctx_get (u32 ctx_handle)
335 u32 ctx_index, engine_type;
336 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
337 return tls_vfts[engine_type].ctx_get (ctx_index);
340 static inline tls_ctx_t *
341 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
343 u32 ctx_index, engine_type;
344 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
345 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
349 tls_ctx_init_server (tls_ctx_t * ctx)
351 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
355 tls_ctx_init_client (tls_ctx_t * ctx)
357 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
361 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
362 transport_send_params_t * sp)
366 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
367 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
368 sp->max_burst_size = n_wrote;
369 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
373 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
375 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
379 tls_ctx_transport_close (tls_ctx_t * ctx)
381 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
385 tls_ctx_app_close (tls_ctx_t * ctx)
387 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
391 tls_ctx_free (tls_ctx_t * ctx)
393 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
397 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
399 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
403 tls_session_reset_callback (session_t * s)
406 transport_connection_t *tc;
407 session_t *app_session;
409 ctx = tls_ctx_get (s->opaque);
410 ctx->is_passive_close = 1;
411 tc = &ctx->connection;
412 if (tls_ctx_handshake_is_over (ctx))
414 session_transport_reset_notify (tc);
415 session_transport_closed_notify (tc);
416 tls_disconnect_transport (ctx);
420 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
422 session_free (app_session);
423 ctx->c_s_index = SESSION_INVALID_INDEX;
424 tls_disconnect_transport (ctx);
429 tls_session_cleanup_ho (session_t *s)
434 /* session opaque stores the opaque passed on connect */
435 ho_index = s->opaque;
436 ctx = tls_ctx_half_open_get (ho_index);
437 session_half_open_delete_notify (&ctx->connection);
438 tls_ctx_half_open_reader_unlock ();
439 tls_ctx_half_open_free (ho_index);
443 tls_add_segment_callback (u32 client_index, u64 segment_handle)
445 /* No-op for builtin */
450 tls_del_segment_callback (u32 client_index, u64 segment_handle)
456 tls_session_disconnect_callback (session_t * tls_session)
460 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
461 tls_session->session_index);
463 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
464 || vlib_thread_is_main_w_barrier ());
466 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
467 ctx->is_passive_close = 1;
468 tls_ctx_transport_close (ctx);
472 tls_session_accept_callback (session_t * tls_session)
474 session_t *tls_listener, *app_session;
475 tls_ctx_t *lctx, *ctx;
479 listen_session_get_from_handle (tls_session->listener_handle);
480 lctx = tls_listener_ctx_get (tls_listener->opaque);
482 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
483 ctx = tls_ctx_get (ctx_handle);
484 memcpy (ctx, lctx, sizeof (*lctx));
485 ctx->c_thread_index = vlib_get_thread_index ();
486 ctx->tls_ctx_handle = ctx_handle;
487 tls_session->session_state = SESSION_STATE_READY;
488 tls_session->opaque = ctx_handle;
489 ctx->tls_session_handle = session_handle (tls_session);
490 ctx->listener_ctx_index = tls_listener->opaque;
491 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
492 ctx->ckpair_index = lctx->ckpair_index;
494 /* Preallocate app session. Avoids allocating a session post handshake
495 * on tls_session rx and potentially invalidating the session pool */
496 app_session = session_alloc (ctx->c_thread_index);
497 app_session->session_state = SESSION_STATE_CREATED;
498 ctx->c_s_index = app_session->session_index;
500 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
501 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
503 return tls_ctx_init_server (ctx);
507 tls_app_rx_callback (session_t * tls_session)
511 /* DTLS session migrating, wait for next notification */
512 if (PREDICT_FALSE (tls_session->flags & SESSION_F_IS_MIGRATING))
515 ctx = tls_ctx_get (tls_session->opaque);
516 tls_ctx_read (ctx, tls_session);
521 tls_app_tx_callback (session_t * tls_session)
525 ctx = tls_ctx_get (tls_session->opaque);
526 transport_connection_reschedule (&ctx->connection);
532 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
533 session_t *tls_session, session_error_t err)
535 session_t *app_session;
536 tls_ctx_t *ho_ctx, *ctx;
540 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
542 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
543 ctx = tls_ctx_get (ctx_handle);
544 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
545 /* Half-open freed on tcp half-open cleanup notification */
546 tls_ctx_half_open_reader_unlock ();
548 ctx->c_thread_index = vlib_get_thread_index ();
549 ctx->tls_ctx_handle = ctx_handle;
550 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
552 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
553 ho_ctx_index, err, vlib_get_thread_index (),
554 (ctx) ? ctx_handle : ~0);
556 ctx->tls_session_handle = session_handle (tls_session);
557 tls_session->opaque = ctx_handle;
558 tls_session->session_state = SESSION_STATE_READY;
560 /* Preallocate app session. Avoids allocating a session post handshake
561 * on tls_session rx and potentially invalidating the session pool */
562 app_session = session_alloc (ctx->c_thread_index);
563 app_session->session_state = SESSION_STATE_CREATED;
564 ctx->c_s_index = app_session->session_index;
565 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
566 app_session->session_type = st;
567 app_session->connection_index = ctx->tls_ctx_handle;
569 return tls_ctx_init_client (ctx);
573 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
578 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
580 ctx->tls_session_handle = session_handle (us);
581 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
582 us->opaque = ctx_handle;
584 /* We don't preallocate the app session because the udp session might
585 * actually migrate to a different worker at the end of the handshake */
587 return tls_ctx_init_client (ctx);
591 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
592 session_t *tls_session, session_error_t err)
596 app_worker_t *app_wrk;
600 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
601 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
604 api_context = ho_ctx->parent_app_api_context;
605 app_worker_connect_notify (app_wrk, 0, err, api_context);
607 tls_ctx_half_open_reader_unlock ();
612 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
613 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
616 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
621 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
625 if (ntf == SESSION_CLEANUP_TRANSPORT)
627 /* Allow cleanup of tcp session */
628 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
633 ctx = tls_ctx_get (s->opaque);
634 if (!ctx->no_app_session)
635 session_transport_delete_notify (&ctx->connection);
640 dtls_migrate_ctx (void *arg)
642 tls_ctx_t *ctx = (tls_ctx_t *) arg;
643 u32 ctx_handle, thread_index;
646 thread_index = session_thread_from_handle (ctx->tls_session_handle);
647 ASSERT (thread_index == vlib_get_thread_index ());
649 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
650 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
651 ctx->tls_ctx_handle = ctx_handle;
653 us = session_get_from_handle (ctx->tls_session_handle);
654 us->opaque = ctx_handle;
655 us->flags &= ~SESSION_F_IS_MIGRATING;
657 /* Probably the app detached while the session was migrating. Cleanup */
658 if (session_half_open_migrated_notify (&ctx->connection))
660 ctx->no_app_session = 1;
661 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
665 if (svm_fifo_max_dequeue (us->tx_fifo))
666 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
670 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
672 u32 new_thread = session_thread_from_handle (new_sh);
673 tls_ctx_t *ctx, *cloned_ctx;
675 /* Migrate dtls context to new thread */
676 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
677 ctx->tls_session_handle = new_sh;
678 cloned_ctx = tls_ctx_detach (ctx);
679 ctx->is_migrated = 1;
680 session_half_open_migrate_notify (&ctx->connection);
682 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
683 (void *) cloned_ctx);
688 static session_cb_vft_t tls_app_cb_vft = {
689 .session_accept_callback = tls_session_accept_callback,
690 .session_disconnect_callback = tls_session_disconnect_callback,
691 .session_connected_callback = tls_session_connected_callback,
692 .session_reset_callback = tls_session_reset_callback,
693 .half_open_cleanup_callback = tls_session_cleanup_ho,
694 .add_segment_callback = tls_add_segment_callback,
695 .del_segment_callback = tls_del_segment_callback,
696 .builtin_app_rx_callback = tls_app_rx_callback,
697 .builtin_app_tx_callback = tls_app_tx_callback,
698 .session_migrate_callback = dtls_session_migrate_callback,
699 .session_cleanup_callback = tls_app_session_cleanup,
703 tls_connect (transport_endpoint_cfg_t * tep)
705 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
706 transport_endpt_crypto_cfg_t *ccfg;
707 crypto_engine_type_t engine_type;
708 session_endpoint_cfg_t *sep;
709 tls_main_t *tm = &tls_main;
710 app_worker_t *app_wrk;
716 sep = (session_endpoint_cfg_t *) tep;
718 return SESSION_E_NOEXTCFG;
720 app_wrk = app_worker_get (sep->app_wrk_index);
721 app = application_get (app_wrk->app_index);
723 ccfg = &sep->ext_cfg->crypto;
724 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
725 if (engine_type == CRYPTO_ENGINE_NONE)
727 clib_warning ("No tls engine_type available");
728 return SESSION_E_NOCRYPTOENG;
731 ctx_index = tls_ctx_half_open_alloc ();
732 ctx = tls_ctx_half_open_get (ctx_index);
733 ctx->parent_app_wrk_index = sep->app_wrk_index;
734 ctx->parent_app_api_context = sep->opaque;
735 ctx->tcp_is_ip4 = sep->is_ip4;
736 ctx->tls_type = sep->transport_proto;
737 ctx->ckpair_index = ccfg->ckpair_index;
738 ctx->c_proto = TRANSPORT_PROTO_TLS;
739 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
740 if (ccfg->hostname[0])
742 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
743 vec_terminate_c_string (ctx->srv_hostname);
745 tls_ctx_half_open_reader_unlock ();
747 ctx->tls_ctx_engine = engine_type;
749 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
750 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
751 cargs->app_index = tm->app_index;
752 cargs->api_context = ctx_index;
753 cargs->sep_ext.ns_index = app->ns_index;
754 if ((rv = vnet_connect (cargs)))
757 /* Track half-open tcp session in case we need to clean it up */
758 ctx->tls_session_handle = cargs->sh;
760 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
765 tls_disconnect (u32 ctx_handle, u32 thread_index)
769 TLS_DBG (1, "Disconnecting %x", ctx_handle);
771 ctx = tls_ctx_get (ctx_handle);
772 tls_ctx_app_close (ctx);
776 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
778 vnet_listen_args_t _bargs, *args = &_bargs;
779 transport_endpt_crypto_cfg_t *ccfg;
780 app_worker_t *app_wrk;
781 tls_main_t *tm = &tls_main;
782 session_handle_t tls_al_handle;
783 session_endpoint_cfg_t *sep;
784 session_t *tls_listener;
785 session_t *app_listener;
786 crypto_engine_type_t engine_type;
793 sep = (session_endpoint_cfg_t *) tep;
795 return SESSION_E_NOEXTCFG;
797 app_wrk = app_worker_get (sep->app_wrk_index);
798 app = application_get (app_wrk->app_index);
800 ccfg = &sep->ext_cfg->crypto;
801 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
802 if (engine_type == CRYPTO_ENGINE_NONE)
804 clib_warning ("No tls engine_type available");
805 return SESSION_E_NOCRYPTOENG;
808 clib_memset (args, 0, sizeof (*args));
809 args->app_index = tm->app_index;
810 args->sep_ext = *sep;
811 args->sep_ext.ns_index = app->ns_index;
812 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
813 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
815 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
816 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
818 if ((rv = vnet_listen (args)))
821 lctx_index = tls_listener_ctx_alloc ();
822 tls_al_handle = args->handle;
823 al = app_listener_get_w_handle (tls_al_handle);
824 tls_listener = app_listener_get_session (al);
825 tls_listener->opaque = lctx_index;
827 app_listener = listen_session_get (app_listener_index);
829 lctx = tls_listener_ctx_get (lctx_index);
830 lctx->parent_app_wrk_index = sep->app_wrk_index;
831 lctx->tls_session_handle = tls_al_handle;
832 lctx->app_session_handle = listen_session_get_handle (app_listener);
833 lctx->tcp_is_ip4 = sep->is_ip4;
834 lctx->tls_ctx_engine = engine_type;
835 lctx->tls_type = sep->transport_proto;
836 lctx->ckpair_index = ccfg->ckpair_index;
838 if (tls_vfts[engine_type].ctx_start_listen (lctx))
840 vnet_unlisten_args_t a = {
841 .handle = lctx->tls_session_handle,
842 .app_index = tls_main.app_index,
845 if ((vnet_unlisten (&a)))
846 clib_warning ("unlisten returned");
847 tls_listener_ctx_free (lctx);
848 lctx_index = SESSION_INVALID_INDEX;
851 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
857 tls_stop_listen (u32 lctx_index)
859 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
860 crypto_engine_type_t engine_type;
861 transport_connection_t *lc;
866 lctx = tls_listener_ctx_get (lctx_index);
868 /* Cleanup listener from session lookup table */
869 ls = session_get_from_handle (lctx->tls_session_handle);
870 lc = session_get_transport (ls);
872 sep.fib_index = lc->fib_index;
873 sep.port = lc->lcl_port;
874 sep.is_ip4 = lc->is_ip4;
875 sep.transport_proto = lctx->tls_type;
876 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
877 session_lookup_del_session_endpoint2 (&sep);
879 vnet_unlisten_args_t a = {
880 .handle = lctx->tls_session_handle,
881 .app_index = tls_main.app_index,
882 .wrk_map_index = 0 /* default wrk */
884 if ((rv = vnet_unlisten (&a)))
885 clib_warning ("unlisten returned %d", rv);
887 engine_type = lctx->tls_ctx_engine;
888 tls_vfts[engine_type].ctx_stop_listen (lctx);
890 tls_listener_ctx_free (lctx);
894 transport_connection_t *
895 tls_connection_get (u32 ctx_index, u32 thread_index)
898 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
899 return &ctx->connection;
902 transport_connection_t *
903 tls_listener_get (u32 listener_index)
906 ctx = tls_listener_ctx_get (listener_index);
907 return &ctx->connection;
910 static transport_connection_t *
911 tls_half_open_get (u32 ho_index)
913 tls_main_t *tm = &tls_main;
915 ctx = tls_ctx_half_open_get (ho_index);
916 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
917 return &ctx->connection;
921 tls_cleanup_ho (u32 ho_index)
923 tls_main_t *tm = &tls_main;
924 session_handle_t tcp_sh;
927 ctx = tls_ctx_half_open_get (ho_index);
928 tcp_sh = ctx->tls_session_handle;
929 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
930 session_cleanup_half_open (tcp_sh);
931 tls_ctx_half_open_free (ho_index);
935 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
937 session_t *app_session = (session_t *) session;
940 if (PREDICT_FALSE (app_session->session_state
941 >= SESSION_STATE_TRANSPORT_CLOSED))
945 ctx = tls_ctx_get (app_session->connection_index);
946 return tls_ctx_write (ctx, app_session, sp);
950 format_tls_ctx (u8 * s, va_list * args)
952 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
953 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
956 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
957 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
958 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
960 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
961 ctx->c_thread_index, ctx->c_s_index, proto,
962 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
968 format_tls_listener_ctx (u8 * s, va_list * args)
970 session_t *tls_listener;
975 ctx = va_arg (*args, tls_ctx_t *);
977 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
978 al = app_listener_get_w_handle (ctx->tls_session_handle);
979 tls_listener = app_listener_get_session (al);
980 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
981 ctx->c_thread_index, ctx->c_s_index, proto,
982 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
983 tls_listener->thread_index, tls_listener->session_index);
989 format_tls_ctx_state (u8 * s, va_list * args)
994 ctx = va_arg (*args, tls_ctx_t *);
995 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
996 if (ts->session_state == SESSION_STATE_LISTENING)
997 s = format (s, "%s", "LISTEN");
1000 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1001 s = format (s, "%s", "CLOSED");
1002 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1003 s = format (s, "%s", "APP-CLOSED");
1004 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1005 s = format (s, "%s", "CLOSING");
1006 else if (tls_ctx_handshake_is_over (ctx))
1007 s = format (s, "%s", "ESTABLISHED");
1009 s = format (s, "%s", "HANDSHAKE");
1016 format_tls_connection (u8 * s, va_list * args)
1018 u32 ctx_index = va_arg (*args, u32);
1019 u32 thread_index = va_arg (*args, u32);
1020 u32 verbose = va_arg (*args, u32);
1023 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1027 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1030 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1033 s = format (s, "\n");
1039 format_tls_listener (u8 * s, va_list * args)
1041 u32 tc_index = va_arg (*args, u32);
1042 u32 __clib_unused thread_index = va_arg (*args, u32);
1043 u32 verbose = va_arg (*args, u32);
1044 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1046 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1048 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1053 format_tls_half_open (u8 * s, va_list * args)
1055 u32 ho_index = va_arg (*args, u32);
1056 u32 __clib_unused thread_index = va_arg (*args, u32);
1060 ho_ctx = tls_ctx_half_open_get (ho_index);
1062 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1063 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1064 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1065 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1066 tcp_ho->thread_index, tcp_ho->session_index);
1068 tls_ctx_half_open_reader_unlock ();
1073 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1074 transport_endpoint_t * tep, u8 is_lcl)
1076 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1077 session_t *tcp_session;
1079 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1080 session_get_endpoint (tcp_session, tep, is_lcl);
1084 tls_transport_listener_endpoint_get (u32 ctx_handle,
1085 transport_endpoint_t * tep, u8 is_lcl)
1087 session_t *tls_listener;
1089 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1091 al = app_listener_get_w_handle (ctx->tls_session_handle);
1092 tls_listener = app_listener_get_session (al);
1093 session_get_endpoint (tls_listener, tep, is_lcl);
1096 static clib_error_t *
1097 tls_enable (vlib_main_t * vm, u8 is_en)
1099 u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
1100 vnet_app_detach_args_t _da, *da = &_da;
1101 vnet_app_attach_args_t _a, *a = &_a;
1102 u64 options[APP_OPTIONS_N_OPTIONS];
1103 tls_main_t *tm = &tls_main;
1104 u32 fifo_size = 128 << 12;
1108 da->app_index = tm->app_index;
1109 da->api_client_index = APP_INVALID_INDEX;
1110 vnet_application_detach (da);
1114 first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
1115 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1117 clib_memset (a, 0, sizeof (*a));
1118 clib_memset (options, 0, sizeof (options));
1120 a->session_cb_vft = &tls_app_cb_vft;
1121 a->api_client_index = APP_INVALID_INDEX;
1122 a->options = options;
1123 a->name = format (0, "tls");
1124 a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
1125 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
1126 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1127 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1128 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1129 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1130 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1132 if (vnet_application_attach (a))
1134 clib_warning ("failed to attach tls app");
1135 return clib_error_return (0, "failed to attach tls app");
1138 tm->app_index = a->app_index;
1144 static const transport_proto_vft_t tls_proto = {
1145 .enable = tls_enable,
1146 .connect = tls_connect,
1147 .close = tls_disconnect,
1148 .start_listen = tls_start_listen,
1149 .stop_listen = tls_stop_listen,
1150 .get_connection = tls_connection_get,
1151 .get_listener = tls_listener_get,
1152 .get_half_open = tls_half_open_get,
1153 .cleanup_ho = tls_cleanup_ho,
1154 .custom_tx = tls_custom_tx_callback,
1155 .format_connection = format_tls_connection,
1156 .format_half_open = format_tls_half_open,
1157 .format_listener = format_tls_listener,
1158 .get_transport_endpoint = tls_transport_endpoint_get,
1159 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1160 .transport_options = {
1163 .tx_type = TRANSPORT_TX_INTERNAL,
1164 .service_type = TRANSPORT_SERVICE_VC,
1169 dtls_connect (transport_endpoint_cfg_t *tep)
1171 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1172 transport_endpt_crypto_cfg_t *ccfg;
1173 crypto_engine_type_t engine_type;
1174 session_endpoint_cfg_t *sep;
1175 tls_main_t *tm = &tls_main;
1176 app_worker_t *app_wrk;
1182 sep = (session_endpoint_cfg_t *) tep;
1186 app_wrk = app_worker_get (sep->app_wrk_index);
1187 app = application_get (app_wrk->app_index);
1189 ccfg = &sep->ext_cfg->crypto;
1190 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1191 if (engine_type == CRYPTO_ENGINE_NONE)
1193 clib_warning ("No tls engine_type available");
1197 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1198 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1199 ctx->parent_app_wrk_index = sep->app_wrk_index;
1200 ctx->parent_app_api_context = sep->opaque;
1201 ctx->tcp_is_ip4 = sep->is_ip4;
1202 ctx->ckpair_index = ccfg->ckpair_index;
1203 ctx->tls_type = sep->transport_proto;
1204 ctx->tls_ctx_handle = ctx_handle;
1205 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1206 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1207 if (ccfg->hostname[0])
1209 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1210 vec_terminate_c_string (ctx->srv_hostname);
1213 ctx->tls_ctx_engine = engine_type;
1215 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1216 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1217 cargs->app_index = tm->app_index;
1218 cargs->api_context = ctx_handle;
1219 cargs->sep_ext.ns_index = app->ns_index;
1220 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1221 if ((rv = vnet_connect (cargs)))
1224 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1229 static transport_connection_t *
1230 dtls_half_open_get (u32 ho_index)
1233 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1234 return &ho_ctx->connection;
1238 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1244 dtls_cleanup_ho (u32 ho_index)
1247 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1252 format_dtls_half_open (u8 *s, va_list *args)
1254 u32 ho_index = va_arg (*args, u32);
1255 u32 __clib_unused thread_index = va_arg (*args, u32);
1259 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1261 us = session_get_from_handle (ho_ctx->tls_session_handle);
1262 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1263 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1264 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1265 us->thread_index, us->session_index);
1270 static const transport_proto_vft_t dtls_proto = {
1272 .connect = dtls_connect,
1273 .close = tls_disconnect,
1274 .start_listen = tls_start_listen,
1275 .stop_listen = tls_stop_listen,
1276 .get_connection = tls_connection_get,
1277 .get_listener = tls_listener_get,
1278 .get_half_open = dtls_half_open_get,
1279 .custom_tx = tls_custom_tx_callback,
1280 .cleanup = dtls_cleanup_callback,
1281 .cleanup_ho = dtls_cleanup_ho,
1282 .format_connection = format_tls_connection,
1283 .format_half_open = format_dtls_half_open,
1284 .format_listener = format_tls_listener,
1285 .get_transport_endpoint = tls_transport_endpoint_get,
1286 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1287 .transport_options = {
1290 .tx_type = TRANSPORT_TX_INTERNAL,
1291 .service_type = TRANSPORT_SERVICE_VC,
1296 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1298 vec_validate (tls_vfts, type);
1299 tls_vfts[type] = *vft;
1302 static clib_error_t *
1303 tls_init (vlib_main_t * vm)
1305 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1306 tls_main_t *tm = &tls_main;
1309 num_threads = 1 /* main thread */ + vtm->n_threads;
1311 if (!tm->ca_cert_path)
1312 tm->ca_cert_path = TLS_CA_CERT_PATH;
1314 clib_rwlock_init (&tm->half_open_rwlock);
1316 vec_validate (tm->rx_bufs, num_threads - 1);
1317 vec_validate (tm->tx_bufs, num_threads - 1);
1319 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1320 FIB_PROTOCOL_IP4, ~0);
1321 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1322 FIB_PROTOCOL_IP6, ~0);
1324 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1325 FIB_PROTOCOL_IP4, ~0);
1326 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1327 FIB_PROTOCOL_IP6, ~0);
1331 VLIB_INIT_FUNCTION (tls_init);
1333 static clib_error_t *
1334 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1336 tls_main_t *tm = &tls_main;
1338 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1340 if (unformat (input, "use-test-cert-in-ca"))
1341 tm->use_test_cert_in_ca = 1;
1342 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1344 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1345 &tm->first_seg_size))
1347 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1349 if (tmp >= 0x100000000ULL)
1351 return clib_error_return
1352 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1354 tm->fifo_size = tmp;
1357 return clib_error_return (0, "unknown input `%U'",
1358 format_unformat_error, input);
1363 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
1366 vnet_tls_get_main (void)
1372 * fd.io coding-style-patch-verification: ON
1375 * eval: (c-set-style "gnu")