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));
232 /* For DTLS the app session is not preallocated because the underlying udp
233 * session might migrate to a different worker during the handshake */
234 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
237 /* Cleanup half-open session as we don't get notification from udp */
238 session_half_open_delete_notify (&ctx->connection);
239 app_session = session_alloc (ctx->c_thread_index);
240 app_session->session_state = SESSION_STATE_CREATED;
241 ctx->c_s_index = app_session->session_index;
243 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
244 app_session->session_type = st;
245 app_session->connection_index = ctx->tls_ctx_handle;
249 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
252 app_session->app_wrk_index = ctx->parent_app_wrk_index;
254 if ((err = app_worker_init_connected (app_wrk, app_session)))
257 app_session->session_state = SESSION_STATE_READY;
258 if (app_worker_connect_notify (app_wrk, app_session,
259 SESSION_E_NONE, ctx->parent_app_api_context))
261 TLS_DBG (1, "failed to notify app");
262 app_session->session_state = SESSION_STATE_CONNECTING;
263 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
267 ctx->app_session_handle = session_handle (app_session);
272 ctx->no_app_session = 1;
273 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
274 return app_worker_connect_notify (app_wrk, 0, err,
275 ctx->parent_app_api_context);
279 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
281 *ctx_index = ctx_handle & TLS_IDX_MASK;
282 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
285 static inline crypto_engine_type_t
286 tls_get_engine_type (crypto_engine_type_t requested,
287 crypto_engine_type_t preferred)
289 if (requested != CRYPTO_ENGINE_NONE)
291 if (tls_vfts[requested].ctx_alloc)
293 return CRYPTO_ENGINE_NONE;
295 if (!tls_vfts[preferred].ctx_alloc)
296 return tls_get_available_engine ();
301 tls_ctx_alloc (crypto_engine_type_t engine_type)
304 ctx_index = tls_vfts[engine_type].ctx_alloc ();
305 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
309 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
312 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
313 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
317 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
320 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
321 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
325 tls_ctx_detach (tls_ctx_t *ctx)
327 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
330 static inline tls_ctx_t *
331 tls_ctx_get (u32 ctx_handle)
333 u32 ctx_index, engine_type;
334 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
335 return tls_vfts[engine_type].ctx_get (ctx_index);
338 static inline tls_ctx_t *
339 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
341 u32 ctx_index, engine_type;
342 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
343 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
347 tls_ctx_init_server (tls_ctx_t * ctx)
349 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
353 tls_ctx_init_client (tls_ctx_t * ctx)
355 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
359 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
360 transport_send_params_t * sp)
364 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
365 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
366 sp->max_burst_size = n_wrote;
367 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
371 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
373 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
377 tls_ctx_transport_close (tls_ctx_t * ctx)
379 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
383 tls_ctx_app_close (tls_ctx_t * ctx)
385 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
389 tls_ctx_free (tls_ctx_t * ctx)
391 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
395 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
397 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
401 tls_session_reset_callback (session_t * s)
404 transport_connection_t *tc;
405 session_t *app_session;
407 ctx = tls_ctx_get (s->opaque);
408 ctx->is_passive_close = 1;
409 tc = &ctx->connection;
410 if (tls_ctx_handshake_is_over (ctx))
412 session_transport_reset_notify (tc);
413 session_transport_closed_notify (tc);
414 tls_disconnect_transport (ctx);
418 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
420 session_free (app_session);
421 ctx->c_s_index = SESSION_INVALID_INDEX;
422 tls_disconnect_transport (ctx);
427 tls_session_cleanup_ho (session_t *s)
432 /* session opaque stores the opaque passed on connect */
433 ho_index = s->opaque;
434 ctx = tls_ctx_half_open_get (ho_index);
435 session_half_open_delete_notify (&ctx->connection);
436 tls_ctx_half_open_reader_unlock ();
437 tls_ctx_half_open_free (ho_index);
441 tls_add_segment_callback (u32 client_index, u64 segment_handle)
443 /* No-op for builtin */
448 tls_del_segment_callback (u32 client_index, u64 segment_handle)
454 tls_session_disconnect_callback (session_t * tls_session)
458 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
459 tls_session->session_index);
461 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
462 || vlib_thread_is_main_w_barrier ());
464 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
465 ctx->is_passive_close = 1;
466 tls_ctx_transport_close (ctx);
470 tls_session_accept_callback (session_t * tls_session)
472 session_t *tls_listener, *app_session;
473 tls_ctx_t *lctx, *ctx;
477 listen_session_get_from_handle (tls_session->listener_handle);
478 lctx = tls_listener_ctx_get (tls_listener->opaque);
480 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
481 ctx = tls_ctx_get (ctx_handle);
482 memcpy (ctx, lctx, sizeof (*lctx));
483 ctx->c_thread_index = vlib_get_thread_index ();
484 ctx->tls_ctx_handle = ctx_handle;
485 tls_session->session_state = SESSION_STATE_READY;
486 tls_session->opaque = ctx_handle;
487 ctx->tls_session_handle = session_handle (tls_session);
488 ctx->listener_ctx_index = tls_listener->opaque;
489 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
490 ctx->ckpair_index = lctx->ckpair_index;
492 /* Preallocate app session. Avoids allocating a session post handshake
493 * on tls_session rx and potentially invalidating the session pool */
494 app_session = session_alloc (ctx->c_thread_index);
495 app_session->session_state = SESSION_STATE_CREATED;
496 ctx->c_s_index = app_session->session_index;
498 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
499 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
501 return tls_ctx_init_server (ctx);
505 tls_app_rx_callback (session_t * tls_session)
509 /* DTLS session migrating, wait for next notification */
510 if (PREDICT_FALSE (tls_session->flags & SESSION_F_IS_MIGRATING))
513 ctx = tls_ctx_get (tls_session->opaque);
514 tls_ctx_read (ctx, tls_session);
519 tls_app_tx_callback (session_t * tls_session)
523 ctx = tls_ctx_get (tls_session->opaque);
524 transport_connection_reschedule (&ctx->connection);
530 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
531 session_t *tls_session, session_error_t err)
533 session_t *app_session;
534 tls_ctx_t *ho_ctx, *ctx;
538 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
542 app_worker_t *app_wrk;
546 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
549 api_context = ho_ctx->parent_app_api_context;
550 app_worker_connect_notify (app_wrk, 0, err, api_context);
552 tls_ctx_half_open_reader_unlock ();
556 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
557 ctx = tls_ctx_get (ctx_handle);
558 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
559 /* Half-open freed on tcp half-open cleanup notification */
560 tls_ctx_half_open_reader_unlock ();
562 ctx->c_thread_index = vlib_get_thread_index ();
563 ctx->tls_ctx_handle = ctx_handle;
564 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
566 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
567 ho_ctx_index, err, vlib_get_thread_index (),
568 (ctx) ? ctx_handle : ~0);
570 ctx->tls_session_handle = session_handle (tls_session);
571 tls_session->opaque = ctx_handle;
572 tls_session->session_state = SESSION_STATE_READY;
574 /* Preallocate app session. Avoids allocating a session post handshake
575 * on tls_session rx and potentially invalidating the session pool */
576 app_session = session_alloc (ctx->c_thread_index);
577 app_session->session_state = SESSION_STATE_CREATED;
578 ctx->c_s_index = app_session->session_index;
579 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
580 app_session->session_type = st;
581 app_session->connection_index = ctx->tls_ctx_handle;
583 return tls_ctx_init_client (ctx);
587 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
592 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
594 ctx->tls_session_handle = session_handle (us);
595 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
596 us->opaque = ctx_handle;
598 /* We don't preallocate the app session because the udp session might
599 * actually migrate to a different worker at the end of the handshake */
601 return tls_ctx_init_client (ctx);
605 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
606 session_t *tls_session, session_error_t err)
608 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
609 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
612 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
617 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
621 if (ntf == SESSION_CLEANUP_TRANSPORT)
623 /* Allow cleanup of tcp session */
624 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
629 ctx = tls_ctx_get (s->opaque);
630 if (!ctx->no_app_session)
631 session_transport_delete_notify (&ctx->connection);
636 dtls_migrate_ctx (void *arg)
638 tls_ctx_t *ctx = (tls_ctx_t *) arg;
639 u32 ctx_handle, thread_index;
642 thread_index = session_thread_from_handle (ctx->tls_session_handle);
643 ASSERT (thread_index == vlib_get_thread_index ());
645 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
646 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
647 ctx->tls_ctx_handle = ctx_handle;
649 us = session_get_from_handle (ctx->tls_session_handle);
650 us->opaque = ctx_handle;
651 us->flags &= ~SESSION_F_IS_MIGRATING;
653 /* Probably the app detached while the session was migrating. Cleanup */
654 if (session_half_open_migrated_notify (&ctx->connection))
656 ctx->no_app_session = 1;
657 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
661 if (svm_fifo_max_dequeue (us->tx_fifo))
662 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
666 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
668 u32 new_thread = session_thread_from_handle (new_sh);
669 tls_ctx_t *ctx, *cloned_ctx;
671 /* Migrate dtls context to new thread */
672 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
673 ctx->tls_session_handle = new_sh;
674 cloned_ctx = tls_ctx_detach (ctx);
675 ctx->is_migrated = 1;
676 session_half_open_migrate_notify (&ctx->connection);
678 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
679 (void *) cloned_ctx);
684 static session_cb_vft_t tls_app_cb_vft = {
685 .session_accept_callback = tls_session_accept_callback,
686 .session_disconnect_callback = tls_session_disconnect_callback,
687 .session_connected_callback = tls_session_connected_callback,
688 .session_reset_callback = tls_session_reset_callback,
689 .half_open_cleanup_callback = tls_session_cleanup_ho,
690 .add_segment_callback = tls_add_segment_callback,
691 .del_segment_callback = tls_del_segment_callback,
692 .builtin_app_rx_callback = tls_app_rx_callback,
693 .builtin_app_tx_callback = tls_app_tx_callback,
694 .session_migrate_callback = dtls_session_migrate_callback,
695 .session_cleanup_callback = tls_app_session_cleanup,
699 tls_connect (transport_endpoint_cfg_t * tep)
701 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
702 transport_endpt_crypto_cfg_t *ccfg;
703 crypto_engine_type_t engine_type;
704 session_endpoint_cfg_t *sep;
705 tls_main_t *tm = &tls_main;
706 app_worker_t *app_wrk;
712 sep = (session_endpoint_cfg_t *) tep;
714 return SESSION_E_NOEXTCFG;
716 app_wrk = app_worker_get (sep->app_wrk_index);
717 app = application_get (app_wrk->app_index);
719 ccfg = &sep->ext_cfg->crypto;
720 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
721 if (engine_type == CRYPTO_ENGINE_NONE)
723 clib_warning ("No tls engine_type available");
724 return SESSION_E_NOCRYPTOENG;
727 ctx_index = tls_ctx_half_open_alloc ();
728 ctx = tls_ctx_half_open_get (ctx_index);
729 ctx->parent_app_wrk_index = sep->app_wrk_index;
730 ctx->parent_app_api_context = sep->opaque;
731 ctx->tcp_is_ip4 = sep->is_ip4;
732 ctx->tls_type = sep->transport_proto;
733 ctx->ckpair_index = ccfg->ckpair_index;
734 ctx->c_proto = TRANSPORT_PROTO_TLS;
735 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
736 if (ccfg->hostname[0])
738 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
739 vec_terminate_c_string (ctx->srv_hostname);
741 tls_ctx_half_open_reader_unlock ();
743 ctx->tls_ctx_engine = engine_type;
745 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
746 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
747 cargs->app_index = tm->app_index;
748 cargs->api_context = ctx_index;
749 cargs->sep_ext.ns_index = app->ns_index;
750 if ((rv = vnet_connect (cargs)))
753 /* Track half-open tcp session in case we need to clean it up */
754 ctx->tls_session_handle = cargs->sh;
756 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
761 tls_disconnect (u32 ctx_handle, u32 thread_index)
765 TLS_DBG (1, "Disconnecting %x", ctx_handle);
767 ctx = tls_ctx_get (ctx_handle);
768 tls_ctx_app_close (ctx);
772 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
774 vnet_listen_args_t _bargs, *args = &_bargs;
775 transport_endpt_crypto_cfg_t *ccfg;
776 app_worker_t *app_wrk;
777 tls_main_t *tm = &tls_main;
778 session_handle_t tls_al_handle;
779 session_endpoint_cfg_t *sep;
780 session_t *tls_listener;
781 session_t *app_listener;
782 crypto_engine_type_t engine_type;
789 sep = (session_endpoint_cfg_t *) tep;
791 return SESSION_E_NOEXTCFG;
793 app_wrk = app_worker_get (sep->app_wrk_index);
794 app = application_get (app_wrk->app_index);
796 ccfg = &sep->ext_cfg->crypto;
797 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
798 if (engine_type == CRYPTO_ENGINE_NONE)
800 clib_warning ("No tls engine_type available");
801 return SESSION_E_NOCRYPTOENG;
804 clib_memset (args, 0, sizeof (*args));
805 args->app_index = tm->app_index;
806 args->sep_ext = *sep;
807 args->sep_ext.ns_index = app->ns_index;
808 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
809 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
811 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
812 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
814 if ((rv = vnet_listen (args)))
817 lctx_index = tls_listener_ctx_alloc ();
818 tls_al_handle = args->handle;
819 al = app_listener_get_w_handle (tls_al_handle);
820 tls_listener = app_listener_get_session (al);
821 tls_listener->opaque = lctx_index;
823 app_listener = listen_session_get (app_listener_index);
825 lctx = tls_listener_ctx_get (lctx_index);
826 lctx->parent_app_wrk_index = sep->app_wrk_index;
827 lctx->tls_session_handle = tls_al_handle;
828 lctx->app_session_handle = listen_session_get_handle (app_listener);
829 lctx->tcp_is_ip4 = sep->is_ip4;
830 lctx->tls_ctx_engine = engine_type;
831 lctx->tls_type = sep->transport_proto;
832 lctx->ckpair_index = ccfg->ckpair_index;
834 if (tls_vfts[engine_type].ctx_start_listen (lctx))
836 vnet_unlisten_args_t a = {
837 .handle = lctx->tls_session_handle,
838 .app_index = tls_main.app_index,
841 if ((vnet_unlisten (&a)))
842 clib_warning ("unlisten returned");
843 tls_listener_ctx_free (lctx);
844 lctx_index = SESSION_INVALID_INDEX;
847 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
853 tls_stop_listen (u32 lctx_index)
855 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
856 crypto_engine_type_t engine_type;
857 transport_connection_t *lc;
862 lctx = tls_listener_ctx_get (lctx_index);
864 /* Cleanup listener from session lookup table */
865 ls = session_get_from_handle (lctx->tls_session_handle);
866 lc = session_get_transport (ls);
868 sep.fib_index = lc->fib_index;
869 sep.port = lc->lcl_port;
870 sep.is_ip4 = lc->is_ip4;
871 sep.transport_proto = lctx->tls_type;
872 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
873 session_lookup_del_session_endpoint2 (&sep);
875 vnet_unlisten_args_t a = {
876 .handle = lctx->tls_session_handle,
877 .app_index = tls_main.app_index,
878 .wrk_map_index = 0 /* default wrk */
880 if ((rv = vnet_unlisten (&a)))
881 clib_warning ("unlisten returned %d", rv);
883 engine_type = lctx->tls_ctx_engine;
884 tls_vfts[engine_type].ctx_stop_listen (lctx);
886 tls_listener_ctx_free (lctx);
890 transport_connection_t *
891 tls_connection_get (u32 ctx_index, u32 thread_index)
894 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
895 return &ctx->connection;
898 transport_connection_t *
899 tls_listener_get (u32 listener_index)
902 ctx = tls_listener_ctx_get (listener_index);
903 return &ctx->connection;
906 static transport_connection_t *
907 tls_half_open_get (u32 ho_index)
909 tls_main_t *tm = &tls_main;
911 ctx = tls_ctx_half_open_get (ho_index);
912 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
913 return &ctx->connection;
917 tls_cleanup_ho (u32 ho_index)
919 tls_main_t *tm = &tls_main;
920 session_handle_t tcp_sh;
923 ctx = tls_ctx_half_open_get (ho_index);
924 tcp_sh = ctx->tls_session_handle;
925 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
926 session_cleanup_half_open (tcp_sh);
927 tls_ctx_half_open_free (ho_index);
931 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
933 session_t *app_session = (session_t *) session;
936 if (PREDICT_FALSE (app_session->session_state
937 >= SESSION_STATE_TRANSPORT_CLOSED))
941 ctx = tls_ctx_get (app_session->connection_index);
942 return tls_ctx_write (ctx, app_session, sp);
946 format_tls_ctx (u8 * s, va_list * args)
948 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
949 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
952 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
953 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
954 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
956 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
957 ctx->c_thread_index, ctx->c_s_index, proto,
958 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
964 format_tls_listener_ctx (u8 * s, va_list * args)
966 session_t *tls_listener;
971 ctx = va_arg (*args, tls_ctx_t *);
973 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
974 al = app_listener_get_w_handle (ctx->tls_session_handle);
975 tls_listener = app_listener_get_session (al);
976 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
977 ctx->c_thread_index, ctx->c_s_index, proto,
978 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
979 tls_listener->thread_index, tls_listener->session_index);
985 format_tls_ctx_state (u8 * s, va_list * args)
990 ctx = va_arg (*args, tls_ctx_t *);
991 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
992 if (ts->session_state == SESSION_STATE_LISTENING)
993 s = format (s, "%s", "LISTEN");
996 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
997 s = format (s, "%s", "CLOSED");
998 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
999 s = format (s, "%s", "APP-CLOSED");
1000 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1001 s = format (s, "%s", "CLOSING");
1002 else if (tls_ctx_handshake_is_over (ctx))
1003 s = format (s, "%s", "ESTABLISHED");
1005 s = format (s, "%s", "HANDSHAKE");
1012 format_tls_connection (u8 * s, va_list * args)
1014 u32 ctx_index = va_arg (*args, u32);
1015 u32 thread_index = va_arg (*args, u32);
1016 u32 verbose = va_arg (*args, u32);
1019 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1023 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1026 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1029 s = format (s, "\n");
1035 format_tls_listener (u8 * s, va_list * args)
1037 u32 tc_index = va_arg (*args, u32);
1038 u32 __clib_unused thread_index = va_arg (*args, u32);
1039 u32 verbose = va_arg (*args, u32);
1040 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1042 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1044 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1049 format_tls_half_open (u8 * s, va_list * args)
1051 u32 ho_index = va_arg (*args, u32);
1052 u32 __clib_unused thread_index = va_arg (*args, u32);
1056 ho_ctx = tls_ctx_half_open_get (ho_index);
1058 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1059 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1060 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1061 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1062 tcp_ho->thread_index, tcp_ho->session_index);
1064 tls_ctx_half_open_reader_unlock ();
1069 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1070 transport_endpoint_t * tep, u8 is_lcl)
1072 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1073 session_t *tcp_session;
1075 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1076 session_get_endpoint (tcp_session, tep, is_lcl);
1080 tls_transport_listener_endpoint_get (u32 ctx_handle,
1081 transport_endpoint_t * tep, u8 is_lcl)
1083 session_t *tls_listener;
1085 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1087 al = app_listener_get_w_handle (ctx->tls_session_handle);
1088 tls_listener = app_listener_get_session (al);
1089 session_get_endpoint (tls_listener, tep, is_lcl);
1092 static clib_error_t *
1093 tls_enable (vlib_main_t * vm, u8 is_en)
1095 u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
1096 vnet_app_detach_args_t _da, *da = &_da;
1097 vnet_app_attach_args_t _a, *a = &_a;
1098 u64 options[APP_OPTIONS_N_OPTIONS];
1099 tls_main_t *tm = &tls_main;
1100 u32 fifo_size = 128 << 12;
1104 da->app_index = tm->app_index;
1105 da->api_client_index = APP_INVALID_INDEX;
1106 vnet_application_detach (da);
1110 first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
1111 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1113 clib_memset (a, 0, sizeof (*a));
1114 clib_memset (options, 0, sizeof (options));
1116 a->session_cb_vft = &tls_app_cb_vft;
1117 a->api_client_index = APP_INVALID_INDEX;
1118 a->options = options;
1119 a->name = format (0, "tls");
1120 a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
1121 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
1122 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1123 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1124 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1125 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1126 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1128 if (vnet_application_attach (a))
1130 clib_warning ("failed to attach tls app");
1131 return clib_error_return (0, "failed to attach tls app");
1134 tm->app_index = a->app_index;
1140 static const transport_proto_vft_t tls_proto = {
1141 .enable = tls_enable,
1142 .connect = tls_connect,
1143 .close = tls_disconnect,
1144 .start_listen = tls_start_listen,
1145 .stop_listen = tls_stop_listen,
1146 .get_connection = tls_connection_get,
1147 .get_listener = tls_listener_get,
1148 .get_half_open = tls_half_open_get,
1149 .cleanup_ho = tls_cleanup_ho,
1150 .custom_tx = tls_custom_tx_callback,
1151 .format_connection = format_tls_connection,
1152 .format_half_open = format_tls_half_open,
1153 .format_listener = format_tls_listener,
1154 .get_transport_endpoint = tls_transport_endpoint_get,
1155 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1156 .transport_options = {
1159 .tx_type = TRANSPORT_TX_INTERNAL,
1160 .service_type = TRANSPORT_SERVICE_VC,
1165 dtls_connect (transport_endpoint_cfg_t *tep)
1167 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1168 transport_endpt_crypto_cfg_t *ccfg;
1169 crypto_engine_type_t engine_type;
1170 session_endpoint_cfg_t *sep;
1171 tls_main_t *tm = &tls_main;
1172 app_worker_t *app_wrk;
1178 sep = (session_endpoint_cfg_t *) tep;
1182 app_wrk = app_worker_get (sep->app_wrk_index);
1183 app = application_get (app_wrk->app_index);
1185 ccfg = &sep->ext_cfg->crypto;
1186 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1187 if (engine_type == CRYPTO_ENGINE_NONE)
1189 clib_warning ("No tls engine_type available");
1193 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1194 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1195 ctx->parent_app_wrk_index = sep->app_wrk_index;
1196 ctx->parent_app_api_context = sep->opaque;
1197 ctx->tcp_is_ip4 = sep->is_ip4;
1198 ctx->ckpair_index = ccfg->ckpair_index;
1199 ctx->tls_type = sep->transport_proto;
1200 ctx->tls_ctx_handle = ctx_handle;
1201 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1202 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1203 if (ccfg->hostname[0])
1205 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1206 vec_terminate_c_string (ctx->srv_hostname);
1209 ctx->tls_ctx_engine = engine_type;
1211 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1212 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1213 cargs->app_index = tm->app_index;
1214 cargs->api_context = ctx_handle;
1215 cargs->sep_ext.ns_index = app->ns_index;
1216 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1217 if ((rv = vnet_connect (cargs)))
1220 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1225 static transport_connection_t *
1226 dtls_half_open_get (u32 ho_index)
1229 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1230 return &ho_ctx->connection;
1234 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1240 dtls_cleanup_ho (u32 ho_index)
1243 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1248 format_dtls_half_open (u8 *s, va_list *args)
1250 u32 ho_index = va_arg (*args, u32);
1251 u32 __clib_unused thread_index = va_arg (*args, u32);
1255 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1257 us = session_get_from_handle (ho_ctx->tls_session_handle);
1258 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1259 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1260 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1261 us->thread_index, us->session_index);
1266 static const transport_proto_vft_t dtls_proto = {
1268 .connect = dtls_connect,
1269 .close = tls_disconnect,
1270 .start_listen = tls_start_listen,
1271 .stop_listen = tls_stop_listen,
1272 .get_connection = tls_connection_get,
1273 .get_listener = tls_listener_get,
1274 .get_half_open = dtls_half_open_get,
1275 .custom_tx = tls_custom_tx_callback,
1276 .cleanup = dtls_cleanup_callback,
1277 .cleanup_ho = dtls_cleanup_ho,
1278 .format_connection = format_tls_connection,
1279 .format_half_open = format_dtls_half_open,
1280 .format_listener = format_tls_listener,
1281 .get_transport_endpoint = tls_transport_endpoint_get,
1282 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1283 .transport_options = {
1286 .tx_type = TRANSPORT_TX_INTERNAL,
1287 .service_type = TRANSPORT_SERVICE_VC,
1292 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1294 vec_validate (tls_vfts, type);
1295 tls_vfts[type] = *vft;
1298 static clib_error_t *
1299 tls_init (vlib_main_t * vm)
1301 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1302 tls_main_t *tm = &tls_main;
1305 num_threads = 1 /* main thread */ + vtm->n_threads;
1307 if (!tm->ca_cert_path)
1308 tm->ca_cert_path = TLS_CA_CERT_PATH;
1310 clib_rwlock_init (&tm->half_open_rwlock);
1312 vec_validate (tm->rx_bufs, num_threads - 1);
1313 vec_validate (tm->tx_bufs, num_threads - 1);
1315 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1316 FIB_PROTOCOL_IP4, ~0);
1317 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1318 FIB_PROTOCOL_IP6, ~0);
1320 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1321 FIB_PROTOCOL_IP4, ~0);
1322 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1323 FIB_PROTOCOL_IP6, ~0);
1327 VLIB_INIT_FUNCTION (tls_init);
1329 static clib_error_t *
1330 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1332 tls_main_t *tm = &tls_main;
1334 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1336 if (unformat (input, "use-test-cert-in-ca"))
1337 tm->use_test_cert_in_ca = 1;
1338 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1340 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1341 &tm->first_seg_size))
1343 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1345 if (tmp >= 0x100000000ULL)
1347 return clib_error_return
1348 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1350 tm->fifo_size = tmp;
1353 return clib_error_return (0, "unknown input `%U'",
1354 format_unformat_error, input);
1359 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
1362 vnet_tls_get_main (void)
1368 * fd.io coding-style-patch-verification: ON
1371 * eval: (c-set-style "gnu")