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 u32 parent_app_api_ctx;
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 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
221 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
222 ctx->no_app_session = 1;
228 /* Free app session pre-allocated when transport was established */
229 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
230 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
231 ctx->no_app_session = 1;
235 /* For DTLS the app session is not preallocated because the underlying udp
236 * session might migrate to a different worker during the handshake */
237 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
240 /* Cleanup half-open session as we don't get notification from udp */
241 session_half_open_delete_notify (&ctx->connection);
242 app_session = session_alloc (ctx->c_thread_index);
243 app_session->session_state = SESSION_STATE_CREATED;
244 ctx->c_s_index = app_session->session_index;
246 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
247 app_session->session_type = st;
248 app_session->connection_index = ctx->tls_ctx_handle;
252 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
255 app_session->app_wrk_index = ctx->parent_app_wrk_index;
257 if ((err = app_worker_init_connected (app_wrk, app_session)))
260 app_session->session_state = SESSION_STATE_READY;
261 parent_app_api_ctx = ctx->parent_app_api_context;
262 ctx->app_session_handle = session_handle (app_session);
264 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
267 TLS_DBG (1, "failed to notify app");
268 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
269 ctx->no_app_session = 1;
276 ctx->no_app_session = 1;
277 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
279 return app_worker_connect_notify (app_wrk, 0, err,
280 ctx->parent_app_api_context);
284 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
286 *ctx_index = ctx_handle & TLS_IDX_MASK;
287 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
290 static inline crypto_engine_type_t
291 tls_get_engine_type (crypto_engine_type_t requested,
292 crypto_engine_type_t preferred)
294 if (requested != CRYPTO_ENGINE_NONE)
296 if (tls_vfts[requested].ctx_alloc)
298 return CRYPTO_ENGINE_NONE;
300 if (!tls_vfts[preferred].ctx_alloc)
301 return tls_get_available_engine ();
306 tls_ctx_alloc (crypto_engine_type_t engine_type)
309 ctx_index = tls_vfts[engine_type].ctx_alloc ();
310 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
314 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
317 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
318 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
322 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
325 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
326 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
330 tls_ctx_detach (tls_ctx_t *ctx)
332 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
335 static inline tls_ctx_t *
336 tls_ctx_get (u32 ctx_handle)
338 u32 ctx_index, engine_type;
339 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
340 return tls_vfts[engine_type].ctx_get (ctx_index);
343 static inline tls_ctx_t *
344 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
346 u32 ctx_index, engine_type;
347 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
348 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
352 tls_ctx_init_server (tls_ctx_t * ctx)
354 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
358 tls_ctx_init_client (tls_ctx_t * ctx)
360 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
364 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
365 transport_send_params_t * sp)
369 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
370 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
371 sp->bytes_dequeued = n_wrote;
372 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
376 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
378 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
382 tls_ctx_transport_close (tls_ctx_t * ctx)
384 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
388 tls_ctx_app_close (tls_ctx_t * ctx)
390 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
394 tls_ctx_free (tls_ctx_t * ctx)
396 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
400 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
402 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
406 tls_reinit_ca_chain (crypto_engine_type_t tls_engine_id)
408 return tls_vfts[tls_engine_id].ctx_reinit_cachain ();
412 tls_notify_app_io_error (tls_ctx_t *ctx)
414 ASSERT (tls_ctx_handshake_is_over (ctx));
416 session_transport_reset_notify (&ctx->connection);
417 session_transport_closed_notify (&ctx->connection);
418 tls_disconnect_transport (ctx);
422 tls_session_reset_callback (session_t * s)
425 transport_connection_t *tc;
426 session_t *app_session;
428 ctx = tls_ctx_get (s->opaque);
429 ctx->is_passive_close = 1;
430 tc = &ctx->connection;
431 if (tls_ctx_handshake_is_over (ctx))
433 session_transport_reset_notify (tc);
434 session_transport_closed_notify (tc);
435 tls_disconnect_transport (ctx);
439 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
441 session_free (app_session);
442 ctx->c_s_index = SESSION_INVALID_INDEX;
443 tls_disconnect_transport (ctx);
448 tls_session_cleanup_ho (session_t *s)
453 /* session opaque stores the opaque passed on connect */
454 ho_index = s->opaque;
455 ctx = tls_ctx_half_open_get (ho_index);
456 session_half_open_delete_notify (&ctx->connection);
457 tls_ctx_half_open_reader_unlock ();
458 tls_ctx_half_open_free (ho_index);
462 tls_add_segment_callback (u32 client_index, u64 segment_handle)
464 /* No-op for builtin */
469 tls_del_segment_callback (u32 client_index, u64 segment_handle)
475 tls_session_disconnect_callback (session_t * tls_session)
479 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
480 tls_session->session_index);
482 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
483 || vlib_thread_is_main_w_barrier ());
485 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
486 ctx->is_passive_close = 1;
487 tls_ctx_transport_close (ctx);
491 tls_session_accept_callback (session_t * tls_session)
493 session_t *tls_listener, *app_session;
494 tls_ctx_t *lctx, *ctx;
498 listen_session_get_from_handle (tls_session->listener_handle);
499 lctx = tls_listener_ctx_get (tls_listener->opaque);
501 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
502 ctx = tls_ctx_get (ctx_handle);
503 memcpy (ctx, lctx, sizeof (*lctx));
504 ctx->c_thread_index = vlib_get_thread_index ();
505 ctx->tls_ctx_handle = ctx_handle;
506 tls_session->session_state = SESSION_STATE_READY;
507 tls_session->opaque = ctx_handle;
508 ctx->tls_session_handle = session_handle (tls_session);
509 ctx->listener_ctx_index = tls_listener->opaque;
510 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
511 ctx->ckpair_index = lctx->ckpair_index;
513 /* Preallocate app session. Avoids allocating a session post handshake
514 * on tls_session rx and potentially invalidating the session pool */
515 app_session = session_alloc (ctx->c_thread_index);
516 app_session->session_state = SESSION_STATE_CREATED;
517 ctx->c_s_index = app_session->session_index;
519 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
520 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
522 return tls_ctx_init_server (ctx);
526 tls_app_rx_callback (session_t * tls_session)
530 /* DTLS session migrating, wait for next notification */
531 if (PREDICT_FALSE (tls_session->flags & SESSION_F_IS_MIGRATING))
534 ctx = tls_ctx_get (tls_session->opaque);
535 if (PREDICT_FALSE (ctx->no_app_session))
537 TLS_DBG (1, "Local App closed");
540 tls_ctx_read (ctx, tls_session);
545 tls_app_tx_callback (session_t * tls_session)
549 ctx = tls_ctx_get (tls_session->opaque);
550 transport_connection_reschedule (&ctx->connection);
556 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
557 session_t *tls_session, session_error_t err)
559 session_t *app_session;
560 tls_ctx_t *ho_ctx, *ctx;
564 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
566 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
567 ctx = tls_ctx_get (ctx_handle);
568 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
569 /* Half-open freed on tcp half-open cleanup notification */
570 tls_ctx_half_open_reader_unlock ();
572 ctx->c_thread_index = vlib_get_thread_index ();
573 ctx->tls_ctx_handle = ctx_handle;
574 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
576 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
577 ho_ctx_index, err, vlib_get_thread_index (),
578 (ctx) ? ctx_handle : ~0);
580 ctx->tls_session_handle = session_handle (tls_session);
581 tls_session->opaque = ctx_handle;
582 tls_session->session_state = SESSION_STATE_READY;
584 /* Preallocate app session. Avoids allocating a session post handshake
585 * on tls_session rx and potentially invalidating the session pool */
586 app_session = session_alloc (ctx->c_thread_index);
587 app_session->session_state = SESSION_STATE_CREATED;
588 ctx->c_s_index = app_session->session_index;
589 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
590 app_session->session_type = st;
591 app_session->connection_index = ctx->tls_ctx_handle;
593 return tls_ctx_init_client (ctx);
597 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
602 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
604 ctx->tls_session_handle = session_handle (us);
605 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
606 us->opaque = ctx_handle;
608 /* We don't preallocate the app session because the udp session might
609 * actually migrate to a different worker at the end of the handshake */
611 return tls_ctx_init_client (ctx);
615 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
616 session_t *tls_session, session_error_t err)
620 app_worker_t *app_wrk;
624 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
625 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
628 api_context = ho_ctx->parent_app_api_context;
629 app_worker_connect_notify (app_wrk, 0, err, api_context);
631 tls_ctx_half_open_reader_unlock ();
636 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
637 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
640 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
645 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
649 if (ntf == SESSION_CLEANUP_TRANSPORT)
651 /* Allow cleanup of tcp session */
652 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
657 ctx = tls_ctx_get (s->opaque);
658 if (!ctx->no_app_session)
659 session_transport_delete_notify (&ctx->connection);
664 dtls_migrate_ctx (void *arg)
666 tls_ctx_t *ctx = (tls_ctx_t *) arg;
667 u32 ctx_handle, thread_index;
670 thread_index = session_thread_from_handle (ctx->tls_session_handle);
671 ASSERT (thread_index == vlib_get_thread_index ());
673 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
674 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
675 ctx->tls_ctx_handle = ctx_handle;
677 us = session_get_from_handle (ctx->tls_session_handle);
678 us->opaque = ctx_handle;
679 us->flags &= ~SESSION_F_IS_MIGRATING;
681 /* Probably the app detached while the session was migrating. Cleanup */
682 if (session_half_open_migrated_notify (&ctx->connection))
684 ctx->no_app_session = 1;
685 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
689 if (svm_fifo_max_dequeue (us->tx_fifo))
690 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
694 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
696 u32 new_thread = session_thread_from_handle (new_sh);
697 tls_ctx_t *ctx, *cloned_ctx;
699 /* Migrate dtls context to new thread */
700 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
701 ctx->tls_session_handle = new_sh;
702 cloned_ctx = tls_ctx_detach (ctx);
703 ctx->is_migrated = 1;
704 session_half_open_migrate_notify (&ctx->connection);
706 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
707 (void *) cloned_ctx);
712 static session_cb_vft_t tls_app_cb_vft = {
713 .session_accept_callback = tls_session_accept_callback,
714 .session_disconnect_callback = tls_session_disconnect_callback,
715 .session_connected_callback = tls_session_connected_callback,
716 .session_reset_callback = tls_session_reset_callback,
717 .half_open_cleanup_callback = tls_session_cleanup_ho,
718 .add_segment_callback = tls_add_segment_callback,
719 .del_segment_callback = tls_del_segment_callback,
720 .builtin_app_rx_callback = tls_app_rx_callback,
721 .builtin_app_tx_callback = tls_app_tx_callback,
722 .session_migrate_callback = dtls_session_migrate_callback,
723 .session_cleanup_callback = tls_app_session_cleanup,
727 tls_connect (transport_endpoint_cfg_t * tep)
729 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
730 transport_endpt_crypto_cfg_t *ccfg;
731 crypto_engine_type_t engine_type;
732 session_endpoint_cfg_t *sep;
733 tls_main_t *tm = &tls_main;
734 app_worker_t *app_wrk;
740 sep = (session_endpoint_cfg_t *) tep;
742 return SESSION_E_NOEXTCFG;
744 app_wrk = app_worker_get (sep->app_wrk_index);
745 app = application_get (app_wrk->app_index);
747 ccfg = &sep->ext_cfg->crypto;
748 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
749 if (engine_type == CRYPTO_ENGINE_NONE)
751 clib_warning ("No tls engine_type available");
752 return SESSION_E_NOCRYPTOENG;
755 ctx_index = tls_ctx_half_open_alloc ();
756 ctx = tls_ctx_half_open_get (ctx_index);
757 ctx->parent_app_wrk_index = sep->app_wrk_index;
758 ctx->parent_app_api_context = sep->opaque;
759 ctx->tcp_is_ip4 = sep->is_ip4;
760 ctx->tls_type = sep->transport_proto;
761 ctx->ckpair_index = ccfg->ckpair_index;
762 ctx->c_proto = TRANSPORT_PROTO_TLS;
763 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
764 if (ccfg->hostname[0])
766 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
767 vec_terminate_c_string (ctx->srv_hostname);
769 tls_ctx_half_open_reader_unlock ();
771 ctx->tls_ctx_engine = engine_type;
773 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
774 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
775 cargs->app_index = tm->app_index;
776 cargs->api_context = ctx_index;
777 cargs->sep_ext.ns_index = app->ns_index;
778 if ((rv = vnet_connect (cargs)))
781 /* Track half-open tcp session in case we need to clean it up */
782 ctx->tls_session_handle = cargs->sh;
784 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
789 tls_disconnect (u32 ctx_handle, u32 thread_index)
793 TLS_DBG (1, "Disconnecting %x", ctx_handle);
795 ctx = tls_ctx_get (ctx_handle);
796 tls_ctx_app_close (ctx);
800 tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
802 vnet_listen_args_t _bargs, *args = &_bargs;
803 transport_endpt_crypto_cfg_t *ccfg;
804 app_worker_t *app_wrk;
805 tls_main_t *tm = &tls_main;
806 session_handle_t tls_al_handle;
807 session_endpoint_cfg_t *sep;
808 session_t *tls_listener;
809 session_t *app_listener;
810 crypto_engine_type_t engine_type;
817 sep = (session_endpoint_cfg_t *) tep;
819 return SESSION_E_NOEXTCFG;
821 app_wrk = app_worker_get (sep->app_wrk_index);
822 app = application_get (app_wrk->app_index);
824 ccfg = &sep->ext_cfg->crypto;
825 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
826 if (engine_type == CRYPTO_ENGINE_NONE)
828 clib_warning ("No tls engine_type available");
829 return SESSION_E_NOCRYPTOENG;
832 clib_memset (args, 0, sizeof (*args));
833 args->app_index = tm->app_index;
834 args->sep_ext = *sep;
835 args->sep_ext.ns_index = app->ns_index;
836 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
837 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
839 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
840 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
842 if ((rv = vnet_listen (args)))
845 lctx_index = tls_listener_ctx_alloc ();
846 tls_al_handle = args->handle;
847 al = app_listener_get_w_handle (tls_al_handle);
848 tls_listener = app_listener_get_session (al);
849 tls_listener->opaque = lctx_index;
851 app_listener = listen_session_get (app_listener_index);
853 lctx = tls_listener_ctx_get (lctx_index);
854 lctx->parent_app_wrk_index = sep->app_wrk_index;
855 lctx->tls_session_handle = tls_al_handle;
856 lctx->app_session_handle = listen_session_get_handle (app_listener);
857 lctx->tcp_is_ip4 = sep->is_ip4;
858 lctx->tls_ctx_engine = engine_type;
859 lctx->tls_type = sep->transport_proto;
860 lctx->ckpair_index = ccfg->ckpair_index;
861 lctx->c_s_index = app_listener_index;
862 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
864 if (tls_vfts[engine_type].ctx_start_listen (lctx))
866 vnet_unlisten_args_t a = {
867 .handle = lctx->tls_session_handle,
868 .app_index = tls_main.app_index,
871 if ((vnet_unlisten (&a)))
872 clib_warning ("unlisten returned");
873 tls_listener_ctx_free (lctx);
874 lctx_index = SESSION_INVALID_INDEX;
877 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
883 tls_stop_listen (u32 lctx_index)
885 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
886 crypto_engine_type_t engine_type;
887 transport_connection_t *lc;
892 lctx = tls_listener_ctx_get (lctx_index);
894 /* Cleanup listener from session lookup table */
895 ls = session_get_from_handle (lctx->tls_session_handle);
896 lc = session_get_transport (ls);
898 sep.fib_index = lc->fib_index;
899 sep.port = lc->lcl_port;
900 sep.is_ip4 = lc->is_ip4;
901 sep.transport_proto = lctx->tls_type;
902 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
903 session_lookup_del_session_endpoint2 (&sep);
905 vnet_unlisten_args_t a = {
906 .handle = lctx->tls_session_handle,
907 .app_index = tls_main.app_index,
908 .wrk_map_index = 0 /* default wrk */
910 if ((rv = vnet_unlisten (&a)))
911 clib_warning ("unlisten returned %d", rv);
913 engine_type = lctx->tls_ctx_engine;
914 tls_vfts[engine_type].ctx_stop_listen (lctx);
916 tls_listener_ctx_free (lctx);
920 transport_connection_t *
921 tls_connection_get (u32 ctx_index, u32 thread_index)
924 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
925 return &ctx->connection;
928 transport_connection_t *
929 tls_listener_get (u32 listener_index)
932 ctx = tls_listener_ctx_get (listener_index);
933 return &ctx->connection;
936 static transport_connection_t *
937 tls_half_open_get (u32 ho_index)
939 tls_main_t *tm = &tls_main;
941 ctx = tls_ctx_half_open_get (ho_index);
942 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
943 return &ctx->connection;
947 tls_cleanup_ho (u32 ho_index)
949 tls_main_t *tm = &tls_main;
950 session_handle_t tcp_sh;
953 ctx = tls_ctx_half_open_get (ho_index);
954 tcp_sh = ctx->tls_session_handle;
955 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
956 session_cleanup_half_open (tcp_sh);
957 tls_ctx_half_open_free (ho_index);
961 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
963 session_t *app_session = (session_t *) session;
966 if (PREDICT_FALSE (app_session->session_state
967 >= SESSION_STATE_TRANSPORT_CLOSED))
970 ctx = tls_ctx_get (app_session->connection_index);
971 return tls_ctx_write (ctx, app_session, sp);
975 format_tls_ctx (u8 * s, va_list * args)
977 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
978 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
981 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
982 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
983 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
985 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
986 ctx->c_thread_index, ctx->c_s_index, proto,
987 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
993 format_tls_listener_ctx (u8 * s, va_list * args)
995 session_t *tls_listener;
1000 ctx = va_arg (*args, tls_ctx_t *);
1002 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
1003 al = app_listener_get_w_handle (ctx->tls_session_handle);
1004 tls_listener = app_listener_get_session (al);
1005 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
1006 ctx->c_thread_index, ctx->c_s_index, proto,
1007 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
1008 tls_listener->thread_index, tls_listener->session_index);
1014 format_tls_ctx_state (u8 * s, va_list * args)
1019 ctx = va_arg (*args, tls_ctx_t *);
1020 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
1021 if (ts->session_state == SESSION_STATE_LISTENING)
1022 s = format (s, "%s", "LISTEN");
1025 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1026 s = format (s, "%s", "CLOSED");
1027 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1028 s = format (s, "%s", "APP-CLOSED");
1029 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1030 s = format (s, "%s", "CLOSING");
1031 else if (tls_ctx_handshake_is_over (ctx))
1032 s = format (s, "%s", "ESTABLISHED");
1034 s = format (s, "%s", "HANDSHAKE");
1041 format_tls_connection (u8 * s, va_list * args)
1043 u32 ctx_index = va_arg (*args, u32);
1044 u32 thread_index = va_arg (*args, u32);
1045 u32 verbose = va_arg (*args, u32);
1048 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1052 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1055 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1058 s = format (s, "\n");
1064 format_tls_listener (u8 * s, va_list * args)
1066 u32 tc_index = va_arg (*args, u32);
1067 u32 __clib_unused thread_index = va_arg (*args, u32);
1068 u32 verbose = va_arg (*args, u32);
1069 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1071 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1073 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1078 format_tls_half_open (u8 * s, va_list * args)
1080 u32 ho_index = va_arg (*args, u32);
1081 u32 __clib_unused thread_index = va_arg (*args, u32);
1085 ho_ctx = tls_ctx_half_open_get (ho_index);
1087 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1088 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1089 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1090 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1091 tcp_ho->thread_index, tcp_ho->session_index);
1093 tls_ctx_half_open_reader_unlock ();
1098 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1099 transport_endpoint_t * tep, u8 is_lcl)
1101 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1102 session_t *tcp_session;
1104 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1105 session_get_endpoint (tcp_session, tep, is_lcl);
1109 tls_transport_listener_endpoint_get (u32 ctx_handle,
1110 transport_endpoint_t * tep, u8 is_lcl)
1112 session_t *tls_listener;
1114 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1116 al = app_listener_get_w_handle (ctx->tls_session_handle);
1117 tls_listener = app_listener_get_session (al);
1118 session_get_endpoint (tls_listener, tep, is_lcl);
1121 static clib_error_t *
1122 tls_enable (vlib_main_t * vm, u8 is_en)
1124 vnet_app_detach_args_t _da, *da = &_da;
1125 vnet_app_attach_args_t _a, *a = &_a;
1126 u64 options[APP_OPTIONS_N_OPTIONS];
1127 tls_main_t *tm = &tls_main;
1128 u32 fifo_size = 128 << 12;
1132 da->app_index = tm->app_index;
1133 da->api_client_index = APP_INVALID_INDEX;
1134 vnet_application_detach (da);
1138 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1140 clib_memset (a, 0, sizeof (*a));
1141 clib_memset (options, 0, sizeof (options));
1143 a->session_cb_vft = &tls_app_cb_vft;
1144 a->api_client_index = APP_INVALID_INDEX;
1145 a->options = options;
1146 a->name = format (0, "tls");
1147 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1148 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
1149 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1150 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1151 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1152 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1153 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1155 if (vnet_application_attach (a))
1157 clib_warning ("failed to attach tls app");
1158 return clib_error_return (0, "failed to attach tls app");
1161 tm->app_index = a->app_index;
1167 static const transport_proto_vft_t tls_proto = {
1168 .enable = tls_enable,
1169 .connect = tls_connect,
1170 .close = tls_disconnect,
1171 .start_listen = tls_start_listen,
1172 .stop_listen = tls_stop_listen,
1173 .get_connection = tls_connection_get,
1174 .get_listener = tls_listener_get,
1175 .get_half_open = tls_half_open_get,
1176 .cleanup_ho = tls_cleanup_ho,
1177 .custom_tx = tls_custom_tx_callback,
1178 .format_connection = format_tls_connection,
1179 .format_half_open = format_tls_half_open,
1180 .format_listener = format_tls_listener,
1181 .get_transport_endpoint = tls_transport_endpoint_get,
1182 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1183 .transport_options = {
1186 .tx_type = TRANSPORT_TX_INTERNAL,
1187 .service_type = TRANSPORT_SERVICE_VC,
1192 dtls_connect (transport_endpoint_cfg_t *tep)
1194 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1195 transport_endpt_crypto_cfg_t *ccfg;
1196 crypto_engine_type_t engine_type;
1197 session_endpoint_cfg_t *sep;
1198 tls_main_t *tm = &tls_main;
1199 app_worker_t *app_wrk;
1205 sep = (session_endpoint_cfg_t *) tep;
1209 app_wrk = app_worker_get (sep->app_wrk_index);
1210 app = application_get (app_wrk->app_index);
1212 ccfg = &sep->ext_cfg->crypto;
1213 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1214 if (engine_type == CRYPTO_ENGINE_NONE)
1216 clib_warning ("No tls engine_type available");
1220 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1221 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1222 ctx->parent_app_wrk_index = sep->app_wrk_index;
1223 ctx->parent_app_api_context = sep->opaque;
1224 ctx->tcp_is_ip4 = sep->is_ip4;
1225 ctx->ckpair_index = ccfg->ckpair_index;
1226 ctx->tls_type = sep->transport_proto;
1227 ctx->tls_ctx_handle = ctx_handle;
1228 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1229 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1230 if (ccfg->hostname[0])
1232 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1233 vec_terminate_c_string (ctx->srv_hostname);
1236 ctx->tls_ctx_engine = engine_type;
1238 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1239 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1240 cargs->app_index = tm->app_index;
1241 cargs->api_context = ctx_handle;
1242 cargs->sep_ext.ns_index = app->ns_index;
1243 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1244 if ((rv = vnet_connect (cargs)))
1247 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1252 static transport_connection_t *
1253 dtls_half_open_get (u32 ho_index)
1256 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1257 return &ho_ctx->connection;
1261 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1267 dtls_cleanup_ho (u32 ho_index)
1270 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1275 format_dtls_half_open (u8 *s, va_list *args)
1277 u32 ho_index = va_arg (*args, u32);
1278 u32 __clib_unused thread_index = va_arg (*args, u32);
1282 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1284 us = session_get_from_handle (ho_ctx->tls_session_handle);
1285 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1286 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1287 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1288 us->thread_index, us->session_index);
1293 static const transport_proto_vft_t dtls_proto = {
1295 .connect = dtls_connect,
1296 .close = tls_disconnect,
1297 .start_listen = tls_start_listen,
1298 .stop_listen = tls_stop_listen,
1299 .get_connection = tls_connection_get,
1300 .get_listener = tls_listener_get,
1301 .get_half_open = dtls_half_open_get,
1302 .custom_tx = tls_custom_tx_callback,
1303 .cleanup = dtls_cleanup_callback,
1304 .cleanup_ho = dtls_cleanup_ho,
1305 .format_connection = format_tls_connection,
1306 .format_half_open = format_dtls_half_open,
1307 .format_listener = format_tls_listener,
1308 .get_transport_endpoint = tls_transport_endpoint_get,
1309 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1310 .transport_options = {
1313 .tx_type = TRANSPORT_TX_INTERNAL,
1314 .service_type = TRANSPORT_SERVICE_VC,
1319 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1321 vec_validate (tls_vfts, type);
1322 tls_vfts[type] = *vft;
1325 static clib_error_t *
1326 tls_init (vlib_main_t * vm)
1328 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1329 tls_main_t *tm = &tls_main;
1332 num_threads = 1 /* main thread */ + vtm->n_threads;
1334 if (!tm->ca_cert_path)
1335 tm->ca_cert_path = TLS_CA_CERT_PATH;
1337 clib_rwlock_init (&tm->half_open_rwlock);
1339 vec_validate (tm->rx_bufs, num_threads - 1);
1340 vec_validate (tm->tx_bufs, num_threads - 1);
1342 tm->first_seg_size = 32 << 20;
1343 tm->add_seg_size = 256 << 20;
1345 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1346 FIB_PROTOCOL_IP4, ~0);
1347 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1348 FIB_PROTOCOL_IP6, ~0);
1350 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1351 FIB_PROTOCOL_IP4, ~0);
1352 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1353 FIB_PROTOCOL_IP6, ~0);
1357 VLIB_INIT_FUNCTION (tls_init);
1359 static clib_error_t *
1360 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1362 tls_main_t *tm = &tls_main;
1364 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1366 if (unformat (input, "use-test-cert-in-ca"))
1367 tm->use_test_cert_in_ca = 1;
1368 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1370 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1371 &tm->first_seg_size))
1373 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1376 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1378 if (tmp >= 0x100000000ULL)
1380 return clib_error_return
1381 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1383 tm->fifo_size = tmp;
1386 return clib_error_return (0, "unknown input `%U'",
1387 format_unformat_error, input);
1392 VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
1395 vnet_tls_get_main (void)
1401 * fd.io coding-style-patch-verification: ON
1404 * eval: (c-set-style "gnu")