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 (tm->half_open_ctx_pool, ctx);
127 ctx_index = ctx - tm->half_open_ctx_pool;
128 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
132 /* reader lock assumption: only main thread will call pool_get */
133 clib_rwlock_reader_lock (&tm->half_open_rwlock);
134 pool_get (tm->half_open_ctx_pool, ctx);
135 ctx_index = ctx - tm->half_open_ctx_pool;
136 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
138 clib_memset (ctx, 0, sizeof (*ctx));
143 tls_ctx_half_open_free (u32 ho_index)
145 tls_main_t *tm = &tls_main;
146 clib_rwlock_writer_lock (&tm->half_open_rwlock);
147 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
148 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
152 tls_ctx_half_open_get (u32 ctx_index)
154 tls_main_t *tm = &tls_main;
155 clib_rwlock_reader_lock (&tm->half_open_rwlock);
156 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
160 tls_ctx_half_open_reader_unlock ()
162 clib_rwlock_reader_unlock (&tls_main.half_open_rwlock);
166 tls_ctx_half_open_index (tls_ctx_t * ctx)
168 return (ctx - tls_main.half_open_ctx_pool);
172 tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
174 app_worker_t *app_wrk;
175 app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
176 if (PREDICT_TRUE (app_wrk != 0))
177 tls_add_app_q_evt (app_wrk, app_session);
181 tls_notify_app_accept (tls_ctx_t * ctx)
183 session_t *app_listener, *app_session;
184 app_worker_t *app_wrk;
188 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
189 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
191 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
192 app_session->app_wrk_index = ctx->parent_app_wrk_index;
193 app_session->connection_index = ctx->tls_ctx_handle;
194 app_session->session_type = app_listener->session_type;
195 app_session->listener_handle = listen_session_get_handle (app_listener);
196 app_session->session_state = SESSION_STATE_ACCEPTING;
198 if ((rv = app_worker_init_accepted (app_session)))
200 TLS_DBG (1, "failed to allocate fifos");
201 session_free (app_session);
204 ctx->app_session_handle = session_handle (app_session);
205 ctx->parent_app_wrk_index = app_session->app_wrk_index;
206 app_wrk = app_worker_get (app_session->app_wrk_index);
207 return app_worker_accept_notify (app_wrk, app_session);
211 tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
213 session_t *app_session;
214 app_worker_t *app_wrk;
216 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
219 tls_disconnect_transport (ctx);
225 /* Free app session pre-allocated when transport was established */
226 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
227 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
231 /* For DTLS the app session is not preallocated because the underlying udp
232 * session might migrate to a different worker during the handshake */
233 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
236 app_session = session_alloc (ctx->c_thread_index);
237 app_session->session_state = SESSION_STATE_CREATED;
238 ctx->c_s_index = app_session->session_index;
240 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
241 app_session->session_type = st;
242 app_session->connection_index = ctx->tls_ctx_handle;
246 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
249 app_session->app_wrk_index = ctx->parent_app_wrk_index;
251 if ((err = app_worker_init_connected (app_wrk, app_session)))
254 app_session->session_state = SESSION_STATE_READY;
255 if (app_worker_connect_notify (app_wrk, app_session,
256 SESSION_E_NONE, ctx->parent_app_api_context))
258 TLS_DBG (1, "failed to notify app");
259 app_session->session_state = SESSION_STATE_CONNECTING;
260 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
264 ctx->app_session_handle = session_handle (app_session);
269 ctx->no_app_session = 1;
270 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
271 return app_worker_connect_notify (app_wrk, 0, err,
272 ctx->parent_app_api_context);
276 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
278 *ctx_index = ctx_handle & TLS_IDX_MASK;
279 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
282 static inline crypto_engine_type_t
283 tls_get_engine_type (crypto_engine_type_t preferred)
285 if (!tls_vfts[preferred].ctx_alloc)
286 return tls_get_available_engine ();
291 tls_ctx_alloc (crypto_engine_type_t engine_type)
294 ctx_index = tls_vfts[engine_type].ctx_alloc ();
295 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
299 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
302 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
303 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
307 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
310 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
311 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
315 tls_ctx_detach (tls_ctx_t *ctx)
317 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
320 static inline tls_ctx_t *
321 tls_ctx_get (u32 ctx_handle)
323 u32 ctx_index, engine_type;
324 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
325 return tls_vfts[engine_type].ctx_get (ctx_index);
328 static inline tls_ctx_t *
329 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
331 u32 ctx_index, engine_type;
332 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
333 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
337 tls_ctx_init_server (tls_ctx_t * ctx)
339 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
343 tls_ctx_init_client (tls_ctx_t * ctx)
345 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
349 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
350 transport_send_params_t * sp)
354 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
355 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
356 sp->max_burst_size = n_wrote;
357 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
361 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
363 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
367 tls_ctx_transport_close (tls_ctx_t * ctx)
369 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
373 tls_ctx_app_close (tls_ctx_t * ctx)
375 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
379 tls_ctx_free (tls_ctx_t * ctx)
381 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
385 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
387 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
391 tls_session_reset_callback (session_t * s)
394 transport_connection_t *tc;
395 session_t *app_session;
397 ctx = tls_ctx_get (s->opaque);
398 ctx->is_passive_close = 1;
399 tc = &ctx->connection;
400 if (tls_ctx_handshake_is_over (ctx))
402 session_transport_reset_notify (tc);
403 session_transport_closed_notify (tc);
404 tls_disconnect_transport (ctx);
408 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
410 session_free (app_session);
411 ctx->c_s_index = SESSION_INVALID_INDEX;
412 tls_disconnect_transport (ctx);
417 tls_add_segment_callback (u32 client_index, u64 segment_handle)
419 /* No-op for builtin */
424 tls_del_segment_callback (u32 client_index, u64 segment_handle)
430 tls_session_disconnect_callback (session_t * tls_session)
434 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
435 tls_session->session_index);
437 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
438 || vlib_thread_is_main_w_barrier ());
440 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
441 ctx->is_passive_close = 1;
442 tls_ctx_transport_close (ctx);
446 tls_session_accept_callback (session_t * tls_session)
448 session_t *tls_listener, *app_session;
449 tls_ctx_t *lctx, *ctx;
453 listen_session_get_from_handle (tls_session->listener_handle);
454 lctx = tls_listener_ctx_get (tls_listener->opaque);
456 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
457 ctx = tls_ctx_get (ctx_handle);
458 memcpy (ctx, lctx, sizeof (*lctx));
459 ctx->c_thread_index = vlib_get_thread_index ();
460 ctx->tls_ctx_handle = ctx_handle;
461 tls_session->session_state = SESSION_STATE_READY;
462 tls_session->opaque = ctx_handle;
463 ctx->tls_session_handle = session_handle (tls_session);
464 ctx->listener_ctx_index = tls_listener->opaque;
465 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
466 ctx->ckpair_index = lctx->ckpair_index;
468 /* Preallocate app session. Avoids allocating a session post handshake
469 * on tls_session rx and potentially invalidating the session pool */
470 app_session = session_alloc (ctx->c_thread_index);
471 app_session->session_state = SESSION_STATE_CREATED;
472 ctx->c_s_index = app_session->session_index;
474 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
475 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
477 return tls_ctx_init_server (ctx);
481 tls_app_rx_callback (session_t * tls_session)
485 /* DTLS session migrating, wait for next notification */
486 if (PREDICT_FALSE (tls_session->flags & SESSION_F_IS_MIGRATING))
489 ctx = tls_ctx_get (tls_session->opaque);
490 tls_ctx_read (ctx, tls_session);
495 tls_app_tx_callback (session_t * tls_session)
499 ctx = tls_ctx_get (tls_session->opaque);
500 transport_connection_reschedule (&ctx->connection);
506 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
507 session_t *tls_session, session_error_t err)
509 session_t *app_session;
510 tls_ctx_t *ho_ctx, *ctx;
514 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
518 app_worker_t *app_wrk;
522 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
525 api_context = ho_ctx->parent_app_api_context;
526 app_worker_connect_notify (app_wrk, 0, err, api_context);
528 tls_ctx_half_open_reader_unlock ();
529 tls_ctx_half_open_free (ho_ctx_index);
533 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
534 ctx = tls_ctx_get (ctx_handle);
535 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
536 tls_ctx_half_open_reader_unlock ();
537 tls_ctx_half_open_free (ho_ctx_index);
539 ctx->c_thread_index = vlib_get_thread_index ();
540 ctx->tls_ctx_handle = ctx_handle;
541 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
543 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
544 ho_ctx_index, err, vlib_get_thread_index (),
545 (ctx) ? ctx_handle : ~0);
547 ctx->tls_session_handle = session_handle (tls_session);
548 tls_session->opaque = ctx_handle;
549 tls_session->session_state = SESSION_STATE_READY;
551 /* Preallocate app session. Avoids allocating a session post handshake
552 * on tls_session rx and potentially invalidating the session pool */
553 app_session = session_alloc (ctx->c_thread_index);
554 app_session->session_state = SESSION_STATE_CREATED;
555 ctx->c_s_index = app_session->session_index;
556 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
557 app_session->session_type = st;
558 app_session->connection_index = ctx->tls_ctx_handle;
560 return tls_ctx_init_client (ctx);
564 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
569 ctx = tls_ctx_get_w_thread (ctx_handle, 1 /* udp allocs on thread 1 */);
571 ctx->tls_session_handle = session_handle (us);
572 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
573 us->opaque = ctx_handle;
575 /* We don't preallocate the app session because the udp session might
576 * actually migrate to a different worker at the end of the handshake */
578 return tls_ctx_init_client (ctx);
582 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
583 session_t *tls_session, session_error_t err)
585 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
586 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
589 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
594 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
598 if (ntf == SESSION_CLEANUP_TRANSPORT)
600 /* Allow cleanup of tcp session */
601 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
606 ctx = tls_ctx_get (s->opaque);
607 if (!ctx->no_app_session)
608 session_transport_delete_notify (&ctx->connection);
613 dtls_migrate_udp (void *arg)
615 tls_ctx_t *ctx = (tls_ctx_t *) arg;
616 u32 ctx_handle, thread_index;
619 thread_index = session_thread_from_handle (ctx->tls_session_handle);
620 ASSERT (thread_index == vlib_get_thread_index ());
622 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
623 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
624 ctx->tls_ctx_handle = ctx_handle;
626 us = session_get_from_handle (ctx->tls_session_handle);
627 us->opaque = ctx_handle;
628 us->flags &= ~SESSION_F_IS_MIGRATING;
629 if (svm_fifo_max_dequeue (us->tx_fifo))
630 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
634 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
636 u32 new_thread = session_thread_from_handle (new_sh);
639 /* Migrate dtls context to new thread */
640 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
641 ctx->tls_session_handle = new_sh;
642 ctx = tls_ctx_detach (ctx);
643 ctx->is_migrated = 1;
645 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_udp, (void *) ctx);
648 static session_cb_vft_t tls_app_cb_vft = {
649 .session_accept_callback = tls_session_accept_callback,
650 .session_disconnect_callback = tls_session_disconnect_callback,
651 .session_connected_callback = tls_session_connected_callback,
652 .session_reset_callback = tls_session_reset_callback,
653 .add_segment_callback = tls_add_segment_callback,
654 .del_segment_callback = tls_del_segment_callback,
655 .builtin_app_rx_callback = tls_app_rx_callback,
656 .builtin_app_tx_callback = tls_app_tx_callback,
657 .session_migrate_callback = dtls_session_migrate_callback,
658 .session_cleanup_callback = tls_app_session_cleanup,
662 tls_connect (transport_endpoint_cfg_t * tep)
664 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
665 crypto_engine_type_t engine_type;
666 session_endpoint_cfg_t *sep;
667 tls_main_t *tm = &tls_main;
668 app_worker_t *app_wrk;
674 sep = (session_endpoint_cfg_t *) tep;
675 app_wrk = app_worker_get (sep->app_wrk_index);
676 app = application_get (app_wrk->app_index);
677 engine_type = tls_get_engine_type (app->tls_engine);
678 if (engine_type == CRYPTO_ENGINE_NONE)
680 clib_warning ("No tls engine_type available");
684 ctx_index = tls_ctx_half_open_alloc ();
685 ctx = tls_ctx_half_open_get (ctx_index);
686 ctx->parent_app_wrk_index = sep->app_wrk_index;
687 ctx->parent_app_api_context = sep->opaque;
688 ctx->tcp_is_ip4 = sep->is_ip4;
689 ctx->ckpair_index = sep->ckpair_index;
690 ctx->tls_type = sep->transport_proto;
693 ctx->srv_hostname = format (0, "%v", sep->hostname);
694 vec_terminate_c_string (ctx->srv_hostname);
696 tls_ctx_half_open_reader_unlock ();
698 app_worker_alloc_connects_segment_manager (app_wrk);
699 ctx->tls_ctx_engine = engine_type;
701 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
702 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
703 cargs->app_index = tm->app_index;
704 cargs->api_context = ctx_index;
705 cargs->sep_ext.ns_index = app->ns_index;
706 if ((rv = vnet_connect (cargs)))
709 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
714 tls_disconnect (u32 ctx_handle, u32 thread_index)
718 TLS_DBG (1, "Disconnecting %x", ctx_handle);
720 ctx = tls_ctx_get (ctx_handle);
721 tls_ctx_app_close (ctx);
725 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
727 vnet_listen_args_t _bargs, *args = &_bargs;
728 app_worker_t *app_wrk;
729 tls_main_t *tm = &tls_main;
730 session_handle_t tls_al_handle;
731 session_endpoint_cfg_t *sep;
732 session_t *tls_listener;
733 session_t *app_listener;
734 crypto_engine_type_t engine_type;
740 sep = (session_endpoint_cfg_t *) tep;
741 app_wrk = app_worker_get (sep->app_wrk_index);
742 app = application_get (app_wrk->app_index);
743 engine_type = tls_get_engine_type (app->tls_engine);
744 if (engine_type == CRYPTO_ENGINE_NONE)
746 clib_warning ("No tls engine_type available");
750 clib_memset (args, 0, sizeof (*args));
751 args->app_index = tm->app_index;
752 args->sep_ext = *sep;
753 args->sep_ext.ns_index = app->ns_index;
754 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
755 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
757 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
758 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
760 if (vnet_listen (args))
763 lctx_index = tls_listener_ctx_alloc ();
764 tls_al_handle = args->handle;
765 al = app_listener_get_w_handle (tls_al_handle);
766 tls_listener = app_listener_get_session (al);
767 tls_listener->opaque = lctx_index;
769 app_listener = listen_session_get (app_listener_index);
771 lctx = tls_listener_ctx_get (lctx_index);
772 lctx->parent_app_wrk_index = sep->app_wrk_index;
773 lctx->tls_session_handle = tls_al_handle;
774 lctx->app_session_handle = listen_session_get_handle (app_listener);
775 lctx->tcp_is_ip4 = sep->is_ip4;
776 lctx->tls_ctx_engine = engine_type;
777 lctx->ckpair_index = sep->ckpair_index;
778 lctx->tls_type = sep->transport_proto;
780 if (tls_vfts[engine_type].ctx_start_listen (lctx))
782 vnet_unlisten_args_t a = {
783 .handle = lctx->tls_session_handle,
784 .app_index = tls_main.app_index,
787 if ((vnet_unlisten (&a)))
788 clib_warning ("unlisten returned");
789 tls_listener_ctx_free (lctx);
790 lctx_index = SESSION_INVALID_INDEX;
793 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
799 tls_stop_listen (u32 lctx_index)
801 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
802 crypto_engine_type_t engine_type;
803 transport_connection_t *lc;
808 lctx = tls_listener_ctx_get (lctx_index);
810 /* Cleanup listener from session lookup table */
811 ls = session_get_from_handle (lctx->tls_session_handle);
812 lc = session_get_transport (ls);
814 sep.fib_index = lc->fib_index;
815 sep.port = lc->lcl_port;
816 sep.is_ip4 = lc->is_ip4;
817 sep.transport_proto = lctx->tls_type;
818 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
819 session_lookup_del_session_endpoint2 (&sep);
821 vnet_unlisten_args_t a = {
822 .handle = lctx->tls_session_handle,
823 .app_index = tls_main.app_index,
824 .wrk_map_index = 0 /* default wrk */
826 if ((rv = vnet_unlisten (&a)))
827 clib_warning ("unlisten returned %d", rv);
829 engine_type = lctx->tls_ctx_engine;
830 tls_vfts[engine_type].ctx_stop_listen (lctx);
832 tls_listener_ctx_free (lctx);
836 transport_connection_t *
837 tls_connection_get (u32 ctx_index, u32 thread_index)
840 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
841 return &ctx->connection;
844 transport_connection_t *
845 tls_listener_get (u32 listener_index)
848 ctx = tls_listener_ctx_get (listener_index);
849 return &ctx->connection;
853 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
855 session_t *app_session = (session_t *) session;
858 if (PREDICT_FALSE (app_session->session_state
859 >= SESSION_STATE_TRANSPORT_CLOSED))
863 ctx = tls_ctx_get (app_session->connection_index);
864 return tls_ctx_write (ctx, app_session, sp);
868 format_tls_ctx (u8 * s, va_list * args)
870 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
871 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
874 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
875 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
876 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
878 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
879 ctx->c_thread_index, ctx->c_s_index, proto,
880 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
886 format_tls_listener_ctx (u8 * s, va_list * args)
888 session_t *tls_listener;
893 ctx = va_arg (*args, tls_ctx_t *);
895 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
896 al = app_listener_get_w_handle (ctx->tls_session_handle);
897 tls_listener = app_listener_get_session (al);
898 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
899 ctx->c_thread_index, ctx->c_s_index, proto,
900 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
901 tls_listener->thread_index, tls_listener->session_index);
907 format_tls_ctx_state (u8 * s, va_list * args)
912 ctx = va_arg (*args, tls_ctx_t *);
913 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
914 if (ts->session_state == SESSION_STATE_LISTENING)
915 s = format (s, "%s", "LISTEN");
918 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
919 s = format (s, "%s", "CLOSED");
920 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
921 s = format (s, "%s", "APP-CLOSED");
922 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
923 s = format (s, "%s", "CLOSING");
924 else if (tls_ctx_handshake_is_over (ctx))
925 s = format (s, "%s", "ESTABLISHED");
927 s = format (s, "%s", "HANDSHAKE");
934 format_tls_connection (u8 * s, va_list * args)
936 u32 ctx_index = va_arg (*args, u32);
937 u32 thread_index = va_arg (*args, u32);
938 u32 verbose = va_arg (*args, u32);
941 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
945 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
948 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
951 s = format (s, "\n");
957 format_tls_listener (u8 * s, va_list * args)
959 u32 tc_index = va_arg (*args, u32);
960 u32 __clib_unused thread_index = va_arg (*args, u32);
961 u32 verbose = va_arg (*args, u32);
962 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
964 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
966 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
971 format_tls_half_open (u8 * s, va_list * args)
973 u32 tc_index = va_arg (*args, u32);
974 u32 __clib_unused thread_index = va_arg (*args, u32);
975 tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
976 s = format (s, "[TLS] half-open app %u", ctx->parent_app_wrk_index);
977 tls_ctx_half_open_reader_unlock ();
982 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
983 transport_endpoint_t * tep, u8 is_lcl)
985 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
986 session_t *tcp_session;
988 tcp_session = session_get_from_handle (ctx->tls_session_handle);
989 session_get_endpoint (tcp_session, tep, is_lcl);
993 tls_transport_listener_endpoint_get (u32 ctx_handle,
994 transport_endpoint_t * tep, u8 is_lcl)
996 session_t *tls_listener;
998 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1000 al = app_listener_get_w_handle (ctx->tls_session_handle);
1001 tls_listener = app_listener_get_session (al);
1002 session_get_endpoint (tls_listener, tep, is_lcl);
1005 static clib_error_t *
1006 tls_enable (vlib_main_t * vm, u8 is_en)
1008 u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
1009 vnet_app_detach_args_t _da, *da = &_da;
1010 vnet_app_attach_args_t _a, *a = &_a;
1011 u64 options[APP_OPTIONS_N_OPTIONS];
1012 tls_main_t *tm = &tls_main;
1013 u32 fifo_size = 128 << 12;
1017 da->app_index = tm->app_index;
1018 da->api_client_index = APP_INVALID_INDEX;
1019 vnet_application_detach (da);
1023 first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
1024 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1026 clib_memset (a, 0, sizeof (*a));
1027 clib_memset (options, 0, sizeof (options));
1029 a->session_cb_vft = &tls_app_cb_vft;
1030 a->api_client_index = APP_INVALID_INDEX;
1031 a->options = options;
1032 a->name = format (0, "tls");
1033 a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
1034 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
1035 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1036 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1037 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1038 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1039 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1041 if (vnet_application_attach (a))
1043 clib_warning ("failed to attach tls app");
1044 return clib_error_return (0, "failed to attach tls app");
1047 tm->app_index = a->app_index;
1053 static const transport_proto_vft_t tls_proto = {
1054 .enable = tls_enable,
1055 .connect = tls_connect,
1056 .close = tls_disconnect,
1057 .start_listen = tls_start_listen,
1058 .stop_listen = tls_stop_listen,
1059 .get_connection = tls_connection_get,
1060 .get_listener = tls_listener_get,
1061 .custom_tx = tls_custom_tx_callback,
1062 .format_connection = format_tls_connection,
1063 .format_half_open = format_tls_half_open,
1064 .format_listener = format_tls_listener,
1065 .get_transport_endpoint = tls_transport_endpoint_get,
1066 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1067 .transport_options = {
1070 .tx_type = TRANSPORT_TX_INTERNAL,
1071 .service_type = TRANSPORT_SERVICE_APP,
1076 dtls_connect (transport_endpoint_cfg_t *tep)
1078 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1079 crypto_engine_type_t engine_type;
1080 session_endpoint_cfg_t *sep;
1081 tls_main_t *tm = &tls_main;
1082 app_worker_t *app_wrk;
1088 sep = (session_endpoint_cfg_t *) tep;
1089 app_wrk = app_worker_get (sep->app_wrk_index);
1090 app = application_get (app_wrk->app_index);
1091 engine_type = tls_get_engine_type (app->tls_engine);
1092 if (engine_type == CRYPTO_ENGINE_NONE)
1094 clib_warning ("No tls engine_type available");
1098 ctx_handle = tls_ctx_alloc_w_thread (engine_type, 1 /* because of udp */);
1099 ctx = tls_ctx_get_w_thread (ctx_handle, 1);
1100 ctx->parent_app_wrk_index = sep->app_wrk_index;
1101 ctx->parent_app_api_context = sep->opaque;
1102 ctx->tcp_is_ip4 = sep->is_ip4;
1103 ctx->ckpair_index = sep->ckpair_index;
1104 ctx->tls_type = sep->transport_proto;
1105 ctx->tls_ctx_handle = ctx_handle;
1108 ctx->srv_hostname = format (0, "%v", sep->hostname);
1109 vec_terminate_c_string (ctx->srv_hostname);
1112 app_worker_alloc_connects_segment_manager (app_wrk);
1113 ctx->tls_ctx_engine = engine_type;
1115 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1116 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1117 cargs->app_index = tm->app_index;
1118 cargs->api_context = ctx_handle;
1119 cargs->sep_ext.ns_index = app->ns_index;
1120 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1121 if ((rv = vnet_connect (cargs)))
1124 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1130 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1135 static const transport_proto_vft_t dtls_proto = {
1137 .connect = dtls_connect,
1138 .close = tls_disconnect,
1139 .start_listen = tls_start_listen,
1140 .stop_listen = tls_stop_listen,
1141 .get_connection = tls_connection_get,
1142 .get_listener = tls_listener_get,
1143 .custom_tx = tls_custom_tx_callback,
1144 .cleanup = dtls_cleanup_callback,
1145 .format_connection = format_tls_connection,
1146 .format_half_open = format_tls_half_open,
1147 .format_listener = format_tls_listener,
1148 .get_transport_endpoint = tls_transport_endpoint_get,
1149 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1150 .transport_options = {
1153 .tx_type = TRANSPORT_TX_INTERNAL,
1154 .service_type = TRANSPORT_SERVICE_APP,
1159 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1161 vec_validate (tls_vfts, type);
1162 tls_vfts[type] = *vft;
1165 static clib_error_t *
1166 tls_init (vlib_main_t * vm)
1168 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1169 tls_main_t *tm = &tls_main;
1172 num_threads = 1 /* main thread */ + vtm->n_threads;
1174 if (!tm->ca_cert_path)
1175 tm->ca_cert_path = TLS_CA_CERT_PATH;
1177 clib_rwlock_init (&tm->half_open_rwlock);
1179 vec_validate (tm->rx_bufs, num_threads - 1);
1180 vec_validate (tm->tx_bufs, num_threads - 1);
1182 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1183 FIB_PROTOCOL_IP4, ~0);
1184 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1185 FIB_PROTOCOL_IP6, ~0);
1187 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1188 FIB_PROTOCOL_IP4, ~0);
1189 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1190 FIB_PROTOCOL_IP6, ~0);
1194 VLIB_INIT_FUNCTION (tls_init);
1196 static clib_error_t *
1197 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1199 tls_main_t *tm = &tls_main;
1201 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1203 if (unformat (input, "use-test-cert-in-ca"))
1204 tm->use_test_cert_in_ca = 1;
1205 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1207 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1208 &tm->first_seg_size))
1210 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1212 if (tmp >= 0x100000000ULL)
1214 return clib_error_return
1215 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1217 tm->fifo_size = tmp;
1220 return clib_error_return (0, "unknown input `%U'",
1221 format_unformat_error, input);
1226 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
1229 vnet_tls_get_main (void)
1235 * fd.io coding-style-patch-verification: ON
1238 * eval: (c-set-style "gnu")