2 * Copyright (c) 2018-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/session/application_interface.h>
17 #include <vppinfra/lock.h>
18 #include <vnet/tls/tls.h>
20 static tls_main_t tls_main;
21 static tls_engine_vft_t *tls_vfts;
23 #define TLS_INVALID_HANDLE ~0
24 #define TLS_IDX_MASK 0x00FFFFFF
25 #define TLS_ENGINE_TYPE_SHIFT 28
27 void tls_disconnect (u32 ctx_handle, u32 thread_index);
30 tls_disconnect_transport (tls_ctx_t * ctx)
32 vnet_disconnect_args_t a = {
33 .handle = ctx->tls_session_handle,
34 .app_index = tls_main.app_index,
37 if (vnet_disconnect_session (&a))
38 clib_warning ("disconnect returned");
42 tls_get_available_engine (void)
45 for (i = 0; i < vec_len (tls_vfts); i++)
47 if (tls_vfts[i].ctx_alloc)
50 return CRYPTO_ENGINE_NONE;
54 tls_add_vpp_q_rx_evt (session_t * s)
56 if (svm_fifo_set_event (s->rx_fifo))
57 session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_RX);
62 tls_add_vpp_q_builtin_rx_evt (session_t * s)
64 if (svm_fifo_set_event (s->rx_fifo))
65 session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_BUILTIN_RX);
70 tls_add_vpp_q_tx_evt (session_t * s)
72 if (svm_fifo_set_event (s->tx_fifo))
73 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
78 tls_add_app_q_evt (app_worker_t * app, session_t * app_session)
80 return app_worker_lock_and_send_event (app, app_session, SESSION_IO_EVT_RX);
84 tls_listener_ctx_alloc (void)
86 tls_main_t *tm = &tls_main;
89 pool_get (tm->listener_ctx_pool, ctx);
90 clib_memset (ctx, 0, sizeof (*ctx));
91 return ctx - tm->listener_ctx_pool;
95 tls_listener_ctx_free (tls_ctx_t * ctx)
98 memset (ctx, 0xfb, sizeof (*ctx));
99 pool_put (tls_main.listener_ctx_pool, ctx);
103 tls_listener_ctx_get (u32 ctx_index)
105 return pool_elt_at_index (tls_main.listener_ctx_pool, ctx_index);
109 tls_listener_ctx_index (tls_ctx_t * ctx)
111 return (ctx - tls_main.listener_ctx_pool);
115 tls_ctx_half_open_alloc (void)
117 tls_main_t *tm = &tls_main;
118 u8 will_expand = pool_get_will_expand (tm->half_open_ctx_pool);
122 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
124 clib_rwlock_writer_lock (&tm->half_open_rwlock);
125 pool_get_zero (tm->half_open_ctx_pool, ctx);
126 ctx->c_c_index = ctx - tm->half_open_ctx_pool;
127 ctx_index = ctx->c_c_index;
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_zero (tm->half_open_ctx_pool, ctx);
135 ctx->c_c_index = ctx - tm->half_open_ctx_pool;
136 ctx_index = ctx->c_c_index;
137 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
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));
228 ctx->no_app_session = 1;
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 ());
275 return app_worker_connect_notify (app_wrk, 0, err,
276 ctx->parent_app_api_context);
280 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
282 *ctx_index = ctx_handle & TLS_IDX_MASK;
283 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
286 static inline crypto_engine_type_t
287 tls_get_engine_type (crypto_engine_type_t requested,
288 crypto_engine_type_t preferred)
290 if (requested != CRYPTO_ENGINE_NONE)
292 if (tls_vfts[requested].ctx_alloc)
294 return CRYPTO_ENGINE_NONE;
296 if (!tls_vfts[preferred].ctx_alloc)
297 return tls_get_available_engine ();
302 tls_ctx_alloc (crypto_engine_type_t engine_type)
305 ctx_index = tls_vfts[engine_type].ctx_alloc ();
306 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
310 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
313 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
314 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
318 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
321 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
322 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
326 tls_ctx_detach (tls_ctx_t *ctx)
328 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
331 static inline tls_ctx_t *
332 tls_ctx_get (u32 ctx_handle)
334 u32 ctx_index, engine_type;
335 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
336 return tls_vfts[engine_type].ctx_get (ctx_index);
339 static inline tls_ctx_t *
340 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
342 u32 ctx_index, engine_type;
343 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
344 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
348 tls_ctx_init_server (tls_ctx_t * ctx)
350 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
354 tls_ctx_init_client (tls_ctx_t * ctx)
356 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
360 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
361 transport_send_params_t * sp)
365 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
366 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
367 sp->bytes_dequeued = n_wrote;
368 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
372 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
374 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
378 tls_ctx_transport_close (tls_ctx_t * ctx)
380 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
384 tls_ctx_app_close (tls_ctx_t * ctx)
386 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
390 tls_ctx_free (tls_ctx_t * ctx)
392 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
396 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
398 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
402 tls_reinit_ca_chain (crypto_engine_type_t tls_engine_id)
404 return tls_vfts[tls_engine_id].ctx_reinit_cachain ();
408 tls_notify_app_io_error (tls_ctx_t *ctx)
410 ASSERT (tls_ctx_handshake_is_over (ctx));
412 session_transport_reset_notify (&ctx->connection);
413 session_transport_closed_notify (&ctx->connection);
414 tls_disconnect_transport (ctx);
418 tls_session_reset_callback (session_t * s)
421 transport_connection_t *tc;
422 session_t *app_session;
424 ctx = tls_ctx_get (s->opaque);
425 ctx->is_passive_close = 1;
426 tc = &ctx->connection;
427 if (tls_ctx_handshake_is_over (ctx))
429 session_transport_reset_notify (tc);
430 session_transport_closed_notify (tc);
431 tls_disconnect_transport (ctx);
435 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
437 session_free (app_session);
438 ctx->c_s_index = SESSION_INVALID_INDEX;
439 tls_disconnect_transport (ctx);
444 tls_session_cleanup_ho (session_t *s)
449 /* session opaque stores the opaque passed on connect */
450 ho_index = s->opaque;
451 ctx = tls_ctx_half_open_get (ho_index);
452 session_half_open_delete_notify (&ctx->connection);
453 tls_ctx_half_open_reader_unlock ();
454 tls_ctx_half_open_free (ho_index);
458 tls_add_segment_callback (u32 client_index, u64 segment_handle)
460 /* No-op for builtin */
465 tls_del_segment_callback (u32 client_index, u64 segment_handle)
471 tls_session_disconnect_callback (session_t * tls_session)
475 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
476 tls_session->session_index);
478 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
479 || vlib_thread_is_main_w_barrier ());
481 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
482 ctx->is_passive_close = 1;
483 tls_ctx_transport_close (ctx);
487 tls_session_accept_callback (session_t * tls_session)
489 session_t *tls_listener, *app_session;
490 tls_ctx_t *lctx, *ctx;
494 listen_session_get_from_handle (tls_session->listener_handle);
495 lctx = tls_listener_ctx_get (tls_listener->opaque);
497 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
498 ctx = tls_ctx_get (ctx_handle);
499 memcpy (ctx, lctx, sizeof (*lctx));
500 ctx->c_thread_index = vlib_get_thread_index ();
501 ctx->tls_ctx_handle = ctx_handle;
502 tls_session->session_state = SESSION_STATE_READY;
503 tls_session->opaque = ctx_handle;
504 ctx->tls_session_handle = session_handle (tls_session);
505 ctx->listener_ctx_index = tls_listener->opaque;
506 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
507 ctx->ckpair_index = lctx->ckpair_index;
509 /* Preallocate app session. Avoids allocating a session post handshake
510 * on tls_session rx and potentially invalidating the session pool */
511 app_session = session_alloc (ctx->c_thread_index);
512 app_session->session_state = SESSION_STATE_CREATED;
513 ctx->c_s_index = app_session->session_index;
515 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
516 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
518 return tls_ctx_init_server (ctx);
522 tls_app_rx_callback (session_t * tls_session)
526 /* DTLS session migrating, wait for next notification */
527 if (PREDICT_FALSE (tls_session->flags & SESSION_F_IS_MIGRATING))
530 ctx = tls_ctx_get (tls_session->opaque);
531 if (PREDICT_FALSE (ctx->no_app_session))
533 TLS_DBG (1, "Local App closed");
536 tls_ctx_read (ctx, tls_session);
541 tls_app_tx_callback (session_t * tls_session)
545 ctx = tls_ctx_get (tls_session->opaque);
546 transport_connection_reschedule (&ctx->connection);
552 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
553 session_t *tls_session, session_error_t err)
555 session_t *app_session;
556 tls_ctx_t *ho_ctx, *ctx;
560 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
562 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
563 ctx = tls_ctx_get (ctx_handle);
564 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
565 /* Half-open freed on tcp half-open cleanup notification */
566 tls_ctx_half_open_reader_unlock ();
568 ctx->c_thread_index = vlib_get_thread_index ();
569 ctx->tls_ctx_handle = ctx_handle;
570 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
572 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
573 ho_ctx_index, err, vlib_get_thread_index (),
574 (ctx) ? ctx_handle : ~0);
576 ctx->tls_session_handle = session_handle (tls_session);
577 tls_session->opaque = ctx_handle;
578 tls_session->session_state = SESSION_STATE_READY;
580 /* Preallocate app session. Avoids allocating a session post handshake
581 * on tls_session rx and potentially invalidating the session pool */
582 app_session = session_alloc (ctx->c_thread_index);
583 app_session->session_state = SESSION_STATE_CREATED;
584 ctx->c_s_index = app_session->session_index;
585 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
586 app_session->session_type = st;
587 app_session->connection_index = ctx->tls_ctx_handle;
589 return tls_ctx_init_client (ctx);
593 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
598 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
600 ctx->tls_session_handle = session_handle (us);
601 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
602 us->opaque = ctx_handle;
604 /* We don't preallocate the app session because the udp session might
605 * actually migrate to a different worker at the end of the handshake */
607 return tls_ctx_init_client (ctx);
611 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
612 session_t *tls_session, session_error_t err)
616 app_worker_t *app_wrk;
620 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
621 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
624 api_context = ho_ctx->parent_app_api_context;
625 app_worker_connect_notify (app_wrk, 0, err, api_context);
627 tls_ctx_half_open_reader_unlock ();
632 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
633 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
636 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
641 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
645 if (ntf == SESSION_CLEANUP_TRANSPORT)
647 /* Allow cleanup of tcp session */
648 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
653 ctx = tls_ctx_get (s->opaque);
654 if (!ctx->no_app_session)
655 session_transport_delete_notify (&ctx->connection);
660 dtls_migrate_ctx (void *arg)
662 tls_ctx_t *ctx = (tls_ctx_t *) arg;
663 u32 ctx_handle, thread_index;
666 thread_index = session_thread_from_handle (ctx->tls_session_handle);
667 ASSERT (thread_index == vlib_get_thread_index ());
669 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
670 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
671 ctx->tls_ctx_handle = ctx_handle;
673 us = session_get_from_handle (ctx->tls_session_handle);
674 us->opaque = ctx_handle;
675 us->flags &= ~SESSION_F_IS_MIGRATING;
677 /* Probably the app detached while the session was migrating. Cleanup */
678 if (session_half_open_migrated_notify (&ctx->connection))
680 ctx->no_app_session = 1;
681 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
685 if (svm_fifo_max_dequeue (us->tx_fifo))
686 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
690 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
692 u32 new_thread = session_thread_from_handle (new_sh);
693 tls_ctx_t *ctx, *cloned_ctx;
695 /* Migrate dtls context to new thread */
696 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
697 ctx->tls_session_handle = new_sh;
698 cloned_ctx = tls_ctx_detach (ctx);
699 ctx->is_migrated = 1;
700 session_half_open_migrate_notify (&ctx->connection);
702 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
703 (void *) cloned_ctx);
708 static session_cb_vft_t tls_app_cb_vft = {
709 .session_accept_callback = tls_session_accept_callback,
710 .session_disconnect_callback = tls_session_disconnect_callback,
711 .session_connected_callback = tls_session_connected_callback,
712 .session_reset_callback = tls_session_reset_callback,
713 .half_open_cleanup_callback = tls_session_cleanup_ho,
714 .add_segment_callback = tls_add_segment_callback,
715 .del_segment_callback = tls_del_segment_callback,
716 .builtin_app_rx_callback = tls_app_rx_callback,
717 .builtin_app_tx_callback = tls_app_tx_callback,
718 .session_migrate_callback = dtls_session_migrate_callback,
719 .session_cleanup_callback = tls_app_session_cleanup,
723 tls_connect (transport_endpoint_cfg_t * tep)
725 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
726 transport_endpt_crypto_cfg_t *ccfg;
727 crypto_engine_type_t engine_type;
728 session_endpoint_cfg_t *sep;
729 tls_main_t *tm = &tls_main;
730 app_worker_t *app_wrk;
736 sep = (session_endpoint_cfg_t *) tep;
738 return SESSION_E_NOEXTCFG;
740 app_wrk = app_worker_get (sep->app_wrk_index);
741 app = application_get (app_wrk->app_index);
743 ccfg = &sep->ext_cfg->crypto;
744 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
745 if (engine_type == CRYPTO_ENGINE_NONE)
747 clib_warning ("No tls engine_type available");
748 return SESSION_E_NOCRYPTOENG;
751 ctx_index = tls_ctx_half_open_alloc ();
752 ctx = tls_ctx_half_open_get (ctx_index);
753 ctx->parent_app_wrk_index = sep->app_wrk_index;
754 ctx->parent_app_api_context = sep->opaque;
755 ctx->tcp_is_ip4 = sep->is_ip4;
756 ctx->tls_type = sep->transport_proto;
757 ctx->ckpair_index = ccfg->ckpair_index;
758 ctx->c_proto = TRANSPORT_PROTO_TLS;
759 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
760 if (ccfg->hostname[0])
762 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
763 vec_terminate_c_string (ctx->srv_hostname);
765 tls_ctx_half_open_reader_unlock ();
767 ctx->tls_ctx_engine = engine_type;
769 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
770 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
771 cargs->app_index = tm->app_index;
772 cargs->api_context = ctx_index;
773 cargs->sep_ext.ns_index = app->ns_index;
774 if ((rv = vnet_connect (cargs)))
777 /* Track half-open tcp session in case we need to clean it up */
778 ctx->tls_session_handle = cargs->sh;
780 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
785 tls_disconnect (u32 ctx_handle, u32 thread_index)
789 TLS_DBG (1, "Disconnecting %x", ctx_handle);
791 ctx = tls_ctx_get (ctx_handle);
792 tls_ctx_app_close (ctx);
796 tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
798 vnet_listen_args_t _bargs, *args = &_bargs;
799 transport_endpt_crypto_cfg_t *ccfg;
800 app_worker_t *app_wrk;
801 tls_main_t *tm = &tls_main;
802 session_handle_t tls_al_handle;
803 session_endpoint_cfg_t *sep;
804 session_t *tls_listener;
805 session_t *app_listener;
806 crypto_engine_type_t engine_type;
813 sep = (session_endpoint_cfg_t *) tep;
815 return SESSION_E_NOEXTCFG;
817 app_wrk = app_worker_get (sep->app_wrk_index);
818 app = application_get (app_wrk->app_index);
820 ccfg = &sep->ext_cfg->crypto;
821 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
822 if (engine_type == CRYPTO_ENGINE_NONE)
824 clib_warning ("No tls engine_type available");
825 return SESSION_E_NOCRYPTOENG;
828 clib_memset (args, 0, sizeof (*args));
829 args->app_index = tm->app_index;
830 args->sep_ext = *sep;
831 args->sep_ext.ns_index = app->ns_index;
832 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
833 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
835 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
836 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
838 if ((rv = vnet_listen (args)))
841 lctx_index = tls_listener_ctx_alloc ();
842 tls_al_handle = args->handle;
843 al = app_listener_get_w_handle (tls_al_handle);
844 tls_listener = app_listener_get_session (al);
845 tls_listener->opaque = lctx_index;
847 app_listener = listen_session_get (app_listener_index);
849 lctx = tls_listener_ctx_get (lctx_index);
850 lctx->parent_app_wrk_index = sep->app_wrk_index;
851 lctx->tls_session_handle = tls_al_handle;
852 lctx->app_session_handle = listen_session_get_handle (app_listener);
853 lctx->tcp_is_ip4 = sep->is_ip4;
854 lctx->tls_ctx_engine = engine_type;
855 lctx->tls_type = sep->transport_proto;
856 lctx->ckpair_index = ccfg->ckpair_index;
857 lctx->c_s_index = app_listener_index;
858 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
860 if (tls_vfts[engine_type].ctx_start_listen (lctx))
862 vnet_unlisten_args_t a = {
863 .handle = lctx->tls_session_handle,
864 .app_index = tls_main.app_index,
867 if ((vnet_unlisten (&a)))
868 clib_warning ("unlisten returned");
869 tls_listener_ctx_free (lctx);
870 lctx_index = SESSION_INVALID_INDEX;
873 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
879 tls_stop_listen (u32 lctx_index)
881 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
882 crypto_engine_type_t engine_type;
883 transport_connection_t *lc;
888 lctx = tls_listener_ctx_get (lctx_index);
890 /* Cleanup listener from session lookup table */
891 ls = session_get_from_handle (lctx->tls_session_handle);
892 lc = session_get_transport (ls);
894 sep.fib_index = lc->fib_index;
895 sep.port = lc->lcl_port;
896 sep.is_ip4 = lc->is_ip4;
897 sep.transport_proto = lctx->tls_type;
898 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
899 session_lookup_del_session_endpoint2 (&sep);
901 vnet_unlisten_args_t a = {
902 .handle = lctx->tls_session_handle,
903 .app_index = tls_main.app_index,
904 .wrk_map_index = 0 /* default wrk */
906 if ((rv = vnet_unlisten (&a)))
907 clib_warning ("unlisten returned %d", rv);
909 engine_type = lctx->tls_ctx_engine;
910 tls_vfts[engine_type].ctx_stop_listen (lctx);
912 tls_listener_ctx_free (lctx);
916 transport_connection_t *
917 tls_connection_get (u32 ctx_index, u32 thread_index)
920 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
921 return &ctx->connection;
924 transport_connection_t *
925 tls_listener_get (u32 listener_index)
928 ctx = tls_listener_ctx_get (listener_index);
929 return &ctx->connection;
932 static transport_connection_t *
933 tls_half_open_get (u32 ho_index)
935 tls_main_t *tm = &tls_main;
937 ctx = tls_ctx_half_open_get (ho_index);
938 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
939 return &ctx->connection;
943 tls_cleanup_ho (u32 ho_index)
945 tls_main_t *tm = &tls_main;
946 session_handle_t tcp_sh;
949 ctx = tls_ctx_half_open_get (ho_index);
950 tcp_sh = ctx->tls_session_handle;
951 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
952 session_cleanup_half_open (tcp_sh);
953 tls_ctx_half_open_free (ho_index);
957 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
959 session_t *app_session = (session_t *) session;
962 if (PREDICT_FALSE (app_session->session_state
963 >= SESSION_STATE_TRANSPORT_CLOSED))
966 ctx = tls_ctx_get (app_session->connection_index);
967 return tls_ctx_write (ctx, app_session, sp);
971 format_tls_ctx (u8 * s, va_list * args)
973 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
974 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
977 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
978 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
979 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
981 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
982 ctx->c_thread_index, ctx->c_s_index, proto,
983 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
989 format_tls_listener_ctx (u8 * s, va_list * args)
991 session_t *tls_listener;
996 ctx = va_arg (*args, tls_ctx_t *);
998 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
999 al = app_listener_get_w_handle (ctx->tls_session_handle);
1000 tls_listener = app_listener_get_session (al);
1001 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
1002 ctx->c_thread_index, ctx->c_s_index, proto,
1003 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
1004 tls_listener->thread_index, tls_listener->session_index);
1010 format_tls_ctx_state (u8 * s, va_list * args)
1015 ctx = va_arg (*args, tls_ctx_t *);
1016 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
1017 if (ts->session_state == SESSION_STATE_LISTENING)
1018 s = format (s, "%s", "LISTEN");
1021 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1022 s = format (s, "%s", "CLOSED");
1023 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1024 s = format (s, "%s", "APP-CLOSED");
1025 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1026 s = format (s, "%s", "CLOSING");
1027 else if (tls_ctx_handshake_is_over (ctx))
1028 s = format (s, "%s", "ESTABLISHED");
1030 s = format (s, "%s", "HANDSHAKE");
1037 format_tls_connection (u8 * s, va_list * args)
1039 u32 ctx_index = va_arg (*args, u32);
1040 u32 thread_index = va_arg (*args, u32);
1041 u32 verbose = va_arg (*args, u32);
1044 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1048 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1051 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1054 s = format (s, "\n");
1060 format_tls_listener (u8 * s, va_list * args)
1062 u32 tc_index = va_arg (*args, u32);
1063 u32 __clib_unused thread_index = va_arg (*args, u32);
1064 u32 verbose = va_arg (*args, u32);
1065 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1067 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1069 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1074 format_tls_half_open (u8 * s, va_list * args)
1076 u32 ho_index = va_arg (*args, u32);
1077 u32 __clib_unused thread_index = va_arg (*args, u32);
1081 ho_ctx = tls_ctx_half_open_get (ho_index);
1083 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1084 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1085 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1086 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1087 tcp_ho->thread_index, tcp_ho->session_index);
1089 tls_ctx_half_open_reader_unlock ();
1094 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1095 transport_endpoint_t * tep, u8 is_lcl)
1097 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1098 session_t *tcp_session;
1100 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1101 session_get_endpoint (tcp_session, tep, is_lcl);
1105 tls_transport_listener_endpoint_get (u32 ctx_handle,
1106 transport_endpoint_t * tep, u8 is_lcl)
1108 session_t *tls_listener;
1110 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1112 al = app_listener_get_w_handle (ctx->tls_session_handle);
1113 tls_listener = app_listener_get_session (al);
1114 session_get_endpoint (tls_listener, tep, is_lcl);
1117 static clib_error_t *
1118 tls_enable (vlib_main_t * vm, u8 is_en)
1120 vnet_app_detach_args_t _da, *da = &_da;
1121 vnet_app_attach_args_t _a, *a = &_a;
1122 u64 options[APP_OPTIONS_N_OPTIONS];
1123 tls_main_t *tm = &tls_main;
1124 u32 fifo_size = 128 << 12;
1128 da->app_index = tm->app_index;
1129 da->api_client_index = APP_INVALID_INDEX;
1130 vnet_application_detach (da);
1134 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1136 clib_memset (a, 0, sizeof (*a));
1137 clib_memset (options, 0, sizeof (options));
1139 a->session_cb_vft = &tls_app_cb_vft;
1140 a->api_client_index = APP_INVALID_INDEX;
1141 a->options = options;
1142 a->name = format (0, "tls");
1143 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1144 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
1145 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1146 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1147 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1148 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1149 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1151 if (vnet_application_attach (a))
1153 clib_warning ("failed to attach tls app");
1154 return clib_error_return (0, "failed to attach tls app");
1157 tm->app_index = a->app_index;
1163 static const transport_proto_vft_t tls_proto = {
1164 .enable = tls_enable,
1165 .connect = tls_connect,
1166 .close = tls_disconnect,
1167 .start_listen = tls_start_listen,
1168 .stop_listen = tls_stop_listen,
1169 .get_connection = tls_connection_get,
1170 .get_listener = tls_listener_get,
1171 .get_half_open = tls_half_open_get,
1172 .cleanup_ho = tls_cleanup_ho,
1173 .custom_tx = tls_custom_tx_callback,
1174 .format_connection = format_tls_connection,
1175 .format_half_open = format_tls_half_open,
1176 .format_listener = format_tls_listener,
1177 .get_transport_endpoint = tls_transport_endpoint_get,
1178 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1179 .transport_options = {
1182 .tx_type = TRANSPORT_TX_INTERNAL,
1183 .service_type = TRANSPORT_SERVICE_VC,
1188 dtls_connect (transport_endpoint_cfg_t *tep)
1190 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1191 transport_endpt_crypto_cfg_t *ccfg;
1192 crypto_engine_type_t engine_type;
1193 session_endpoint_cfg_t *sep;
1194 tls_main_t *tm = &tls_main;
1195 app_worker_t *app_wrk;
1201 sep = (session_endpoint_cfg_t *) tep;
1205 app_wrk = app_worker_get (sep->app_wrk_index);
1206 app = application_get (app_wrk->app_index);
1208 ccfg = &sep->ext_cfg->crypto;
1209 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1210 if (engine_type == CRYPTO_ENGINE_NONE)
1212 clib_warning ("No tls engine_type available");
1216 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1217 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1218 ctx->parent_app_wrk_index = sep->app_wrk_index;
1219 ctx->parent_app_api_context = sep->opaque;
1220 ctx->tcp_is_ip4 = sep->is_ip4;
1221 ctx->ckpair_index = ccfg->ckpair_index;
1222 ctx->tls_type = sep->transport_proto;
1223 ctx->tls_ctx_handle = ctx_handle;
1224 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1225 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1226 if (ccfg->hostname[0])
1228 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1229 vec_terminate_c_string (ctx->srv_hostname);
1232 ctx->tls_ctx_engine = engine_type;
1234 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1235 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1236 cargs->app_index = tm->app_index;
1237 cargs->api_context = ctx_handle;
1238 cargs->sep_ext.ns_index = app->ns_index;
1239 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1240 if ((rv = vnet_connect (cargs)))
1243 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1248 static transport_connection_t *
1249 dtls_half_open_get (u32 ho_index)
1252 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1253 return &ho_ctx->connection;
1257 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1263 dtls_cleanup_ho (u32 ho_index)
1266 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1271 format_dtls_half_open (u8 *s, va_list *args)
1273 u32 ho_index = va_arg (*args, u32);
1274 u32 __clib_unused thread_index = va_arg (*args, u32);
1278 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1280 us = session_get_from_handle (ho_ctx->tls_session_handle);
1281 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1282 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1283 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1284 us->thread_index, us->session_index);
1289 static const transport_proto_vft_t dtls_proto = {
1291 .connect = dtls_connect,
1292 .close = tls_disconnect,
1293 .start_listen = tls_start_listen,
1294 .stop_listen = tls_stop_listen,
1295 .get_connection = tls_connection_get,
1296 .get_listener = tls_listener_get,
1297 .get_half_open = dtls_half_open_get,
1298 .custom_tx = tls_custom_tx_callback,
1299 .cleanup = dtls_cleanup_callback,
1300 .cleanup_ho = dtls_cleanup_ho,
1301 .format_connection = format_tls_connection,
1302 .format_half_open = format_dtls_half_open,
1303 .format_listener = format_tls_listener,
1304 .get_transport_endpoint = tls_transport_endpoint_get,
1305 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1306 .transport_options = {
1309 .tx_type = TRANSPORT_TX_INTERNAL,
1310 .service_type = TRANSPORT_SERVICE_VC,
1315 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1317 vec_validate (tls_vfts, type);
1318 tls_vfts[type] = *vft;
1321 static clib_error_t *
1322 tls_init (vlib_main_t * vm)
1324 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1325 tls_main_t *tm = &tls_main;
1328 num_threads = 1 /* main thread */ + vtm->n_threads;
1330 if (!tm->ca_cert_path)
1331 tm->ca_cert_path = TLS_CA_CERT_PATH;
1333 clib_rwlock_init (&tm->half_open_rwlock);
1335 vec_validate (tm->rx_bufs, num_threads - 1);
1336 vec_validate (tm->tx_bufs, num_threads - 1);
1338 tm->first_seg_size = 32 << 20;
1339 tm->add_seg_size = 256 << 20;
1341 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1342 FIB_PROTOCOL_IP4, ~0);
1343 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1344 FIB_PROTOCOL_IP6, ~0);
1346 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1347 FIB_PROTOCOL_IP4, ~0);
1348 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1349 FIB_PROTOCOL_IP6, ~0);
1353 VLIB_INIT_FUNCTION (tls_init);
1355 static clib_error_t *
1356 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1358 tls_main_t *tm = &tls_main;
1360 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1362 if (unformat (input, "use-test-cert-in-ca"))
1363 tm->use_test_cert_in_ca = 1;
1364 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1366 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1367 &tm->first_seg_size))
1369 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1372 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1374 if (tmp >= 0x100000000ULL)
1376 return clib_error_return
1377 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1379 tm->fifo_size = tmp;
1382 return clib_error_return (0, "unknown input `%U'",
1383 format_unformat_error, input);
1388 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
1391 vnet_tls_get_main (void)
1397 * fd.io coding-style-patch-verification: ON
1400 * eval: (c-set-style "gnu")