2 * Copyright (c) 2018-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/session/application_interface.h>
17 #include <vppinfra/lock.h>
18 #include <vnet/tls/tls.h>
20 static tls_main_t tls_main;
21 static tls_engine_vft_t *tls_vfts;
23 #define TLS_INVALID_HANDLE ~0
24 #define TLS_IDX_MASK 0x00FFFFFF
25 #define TLS_ENGINE_TYPE_SHIFT 29
27 void tls_disconnect (u32 ctx_handle, u32 thread_index);
30 tls_disconnect_transport (tls_ctx_t * ctx)
32 vnet_disconnect_args_t a = {
33 .handle = ctx->tls_session_handle,
34 .app_index = tls_main.app_index,
37 if (vnet_disconnect_session (&a))
38 clib_warning ("disconnect returned");
42 tls_get_available_engine (void)
45 for (i = 0; i < vec_len (tls_vfts); i++)
47 if (tls_vfts[i].ctx_alloc)
50 return CRYPTO_ENGINE_NONE;
54 tls_add_vpp_q_rx_evt (session_t * s)
56 if (svm_fifo_set_event (s->rx_fifo))
57 session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_RX);
62 tls_add_vpp_q_builtin_rx_evt (session_t * s)
64 if (svm_fifo_set_event (s->rx_fifo))
65 session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_BUILTIN_RX);
70 tls_add_vpp_q_tx_evt (session_t * s)
72 if (svm_fifo_set_event (s->tx_fifo))
73 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
78 tls_add_app_q_evt (app_worker_t * app, session_t * app_session)
80 return app_worker_lock_and_send_event (app, app_session, SESSION_IO_EVT_RX);
84 tls_listener_ctx_alloc (void)
86 tls_main_t *tm = &tls_main;
89 pool_get (tm->listener_ctx_pool, ctx);
90 clib_memset (ctx, 0, sizeof (*ctx));
91 return ctx - tm->listener_ctx_pool;
95 tls_listener_ctx_free (tls_ctx_t * ctx)
98 memset (ctx, 0xfb, sizeof (*ctx));
99 pool_put (tls_main.listener_ctx_pool, ctx);
103 tls_listener_ctx_get (u32 ctx_index)
105 return pool_elt_at_index (tls_main.listener_ctx_pool, ctx_index);
109 tls_listener_ctx_index (tls_ctx_t * ctx)
111 return (ctx - tls_main.listener_ctx_pool);
115 tls_ctx_half_open_alloc (void)
117 tls_main_t *tm = &tls_main;
122 pool_get_aligned_will_expand (tm->half_open_ctx_pool, will_expand, 0);
123 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
125 clib_rwlock_writer_lock (&tm->half_open_rwlock);
126 pool_get_zero (tm->half_open_ctx_pool, ctx);
127 ctx->c_c_index = ctx - tm->half_open_ctx_pool;
128 ctx_index = ctx->c_c_index;
129 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
133 /* reader lock assumption: only main thread will call pool_get */
134 clib_rwlock_reader_lock (&tm->half_open_rwlock);
135 pool_get_zero (tm->half_open_ctx_pool, ctx);
136 ctx->c_c_index = ctx - tm->half_open_ctx_pool;
137 ctx_index = ctx->c_c_index;
138 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
144 tls_ctx_half_open_free (u32 ho_index)
146 tls_main_t *tm = &tls_main;
147 clib_rwlock_writer_lock (&tm->half_open_rwlock);
148 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
149 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
153 tls_ctx_half_open_get (u32 ctx_index)
155 tls_main_t *tm = &tls_main;
156 clib_rwlock_reader_lock (&tm->half_open_rwlock);
157 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
161 tls_ctx_half_open_reader_unlock ()
163 clib_rwlock_reader_unlock (&tls_main.half_open_rwlock);
167 tls_ctx_half_open_index (tls_ctx_t * ctx)
169 return (ctx - tls_main.half_open_ctx_pool);
173 tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
175 app_worker_t *app_wrk;
176 app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
177 if (PREDICT_TRUE (app_wrk != 0))
178 tls_add_app_q_evt (app_wrk, app_session);
182 tls_notify_app_accept (tls_ctx_t * ctx)
184 session_t *app_listener, *app_session;
185 app_worker_t *app_wrk;
189 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
190 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
192 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
193 app_session->app_wrk_index = ctx->parent_app_wrk_index;
194 app_session->connection_index = ctx->tls_ctx_handle;
195 app_session->session_type = app_listener->session_type;
196 app_session->listener_handle = listen_session_get_handle (app_listener);
197 app_session->session_state = SESSION_STATE_ACCEPTING;
199 if ((rv = app_worker_init_accepted (app_session)))
201 TLS_DBG (1, "failed to allocate fifos");
202 session_free (app_session);
205 ctx->app_session_handle = session_handle (app_session);
206 ctx->parent_app_wrk_index = app_session->app_wrk_index;
207 app_wrk = app_worker_get (app_session->app_wrk_index);
208 return app_worker_accept_notify (app_wrk, app_session);
212 tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
214 session_t *app_session;
215 app_worker_t *app_wrk;
217 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
220 tls_disconnect_transport (ctx);
226 /* Free app session pre-allocated when transport was established */
227 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
228 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
232 /* For DTLS the app session is not preallocated because the underlying udp
233 * session might migrate to a different worker during the handshake */
234 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
237 app_session = session_alloc (ctx->c_thread_index);
238 app_session->session_state = SESSION_STATE_CREATED;
239 ctx->c_s_index = app_session->session_index;
241 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
242 app_session->session_type = st;
243 app_session->connection_index = ctx->tls_ctx_handle;
247 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
250 app_session->app_wrk_index = ctx->parent_app_wrk_index;
252 if ((err = app_worker_init_connected (app_wrk, app_session)))
255 app_session->session_state = SESSION_STATE_READY;
256 if (app_worker_connect_notify (app_wrk, app_session,
257 SESSION_E_NONE, ctx->parent_app_api_context))
259 TLS_DBG (1, "failed to notify app");
260 app_session->session_state = SESSION_STATE_CONNECTING;
261 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
265 ctx->app_session_handle = session_handle (app_session);
270 ctx->no_app_session = 1;
271 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
272 return app_worker_connect_notify (app_wrk, 0, err,
273 ctx->parent_app_api_context);
277 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
279 *ctx_index = ctx_handle & TLS_IDX_MASK;
280 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
283 static inline crypto_engine_type_t
284 tls_get_engine_type (crypto_engine_type_t requested,
285 crypto_engine_type_t preferred)
287 if (requested != CRYPTO_ENGINE_NONE)
289 if (tls_vfts[requested].ctx_alloc)
291 return CRYPTO_ENGINE_NONE;
293 if (!tls_vfts[preferred].ctx_alloc)
294 return tls_get_available_engine ();
299 tls_ctx_alloc (crypto_engine_type_t engine_type)
302 ctx_index = tls_vfts[engine_type].ctx_alloc ();
303 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
307 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
310 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
311 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
315 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
318 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
319 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
323 tls_ctx_detach (tls_ctx_t *ctx)
325 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
328 static inline tls_ctx_t *
329 tls_ctx_get (u32 ctx_handle)
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 (ctx_index);
336 static inline tls_ctx_t *
337 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
339 u32 ctx_index, engine_type;
340 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
341 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
345 tls_ctx_init_server (tls_ctx_t * ctx)
347 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
351 tls_ctx_init_client (tls_ctx_t * ctx)
353 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
357 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
358 transport_send_params_t * sp)
362 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
363 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
364 sp->max_burst_size = n_wrote;
365 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
369 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
371 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
375 tls_ctx_transport_close (tls_ctx_t * ctx)
377 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
381 tls_ctx_app_close (tls_ctx_t * ctx)
383 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
387 tls_ctx_free (tls_ctx_t * ctx)
389 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
393 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
395 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
399 tls_session_reset_callback (session_t * s)
402 transport_connection_t *tc;
403 session_t *app_session;
405 ctx = tls_ctx_get (s->opaque);
406 ctx->is_passive_close = 1;
407 tc = &ctx->connection;
408 if (tls_ctx_handshake_is_over (ctx))
410 session_transport_reset_notify (tc);
411 session_transport_closed_notify (tc);
412 tls_disconnect_transport (ctx);
416 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
418 session_free (app_session);
419 ctx->c_s_index = SESSION_INVALID_INDEX;
420 tls_disconnect_transport (ctx);
425 tls_session_cleanup_ho (session_t *s)
430 /* session opaque stores the opaque passed on connect */
431 ho_index = s->opaque;
432 ctx = tls_ctx_half_open_get (ho_index);
433 session_half_open_delete_notify (&ctx->connection);
434 tls_ctx_half_open_reader_unlock ();
435 tls_ctx_half_open_free (ho_index);
439 tls_add_segment_callback (u32 client_index, u64 segment_handle)
441 /* No-op for builtin */
446 tls_del_segment_callback (u32 client_index, u64 segment_handle)
452 tls_session_disconnect_callback (session_t * tls_session)
456 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
457 tls_session->session_index);
459 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
460 || vlib_thread_is_main_w_barrier ());
462 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
463 ctx->is_passive_close = 1;
464 tls_ctx_transport_close (ctx);
468 tls_session_accept_callback (session_t * tls_session)
470 session_t *tls_listener, *app_session;
471 tls_ctx_t *lctx, *ctx;
475 listen_session_get_from_handle (tls_session->listener_handle);
476 lctx = tls_listener_ctx_get (tls_listener->opaque);
478 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
479 ctx = tls_ctx_get (ctx_handle);
480 memcpy (ctx, lctx, sizeof (*lctx));
481 ctx->c_thread_index = vlib_get_thread_index ();
482 ctx->tls_ctx_handle = ctx_handle;
483 tls_session->session_state = SESSION_STATE_READY;
484 tls_session->opaque = ctx_handle;
485 ctx->tls_session_handle = session_handle (tls_session);
486 ctx->listener_ctx_index = tls_listener->opaque;
487 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
488 ctx->ckpair_index = lctx->ckpair_index;
490 /* Preallocate app session. Avoids allocating a session post handshake
491 * on tls_session rx and potentially invalidating the session pool */
492 app_session = session_alloc (ctx->c_thread_index);
493 app_session->session_state = SESSION_STATE_CREATED;
494 ctx->c_s_index = app_session->session_index;
496 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
497 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
499 return tls_ctx_init_server (ctx);
503 tls_app_rx_callback (session_t * tls_session)
507 /* DTLS session migrating, wait for next notification */
508 if (PREDICT_FALSE (tls_session->flags & SESSION_F_IS_MIGRATING))
511 ctx = tls_ctx_get (tls_session->opaque);
512 tls_ctx_read (ctx, tls_session);
517 tls_app_tx_callback (session_t * tls_session)
521 ctx = tls_ctx_get (tls_session->opaque);
522 transport_connection_reschedule (&ctx->connection);
528 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
529 session_t *tls_session, session_error_t err)
531 session_t *app_session;
532 tls_ctx_t *ho_ctx, *ctx;
536 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
540 app_worker_t *app_wrk;
544 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
547 api_context = ho_ctx->parent_app_api_context;
548 app_worker_connect_notify (app_wrk, 0, err, api_context);
550 tls_ctx_half_open_reader_unlock ();
554 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
555 ctx = tls_ctx_get (ctx_handle);
556 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
557 /* Half-open freed on tcp half-open cleanup notification */
558 tls_ctx_half_open_reader_unlock ();
560 ctx->c_thread_index = vlib_get_thread_index ();
561 ctx->tls_ctx_handle = ctx_handle;
562 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
564 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
565 ho_ctx_index, err, vlib_get_thread_index (),
566 (ctx) ? ctx_handle : ~0);
568 ctx->tls_session_handle = session_handle (tls_session);
569 tls_session->opaque = ctx_handle;
570 tls_session->session_state = SESSION_STATE_READY;
572 /* Preallocate app session. Avoids allocating a session post handshake
573 * on tls_session rx and potentially invalidating the session pool */
574 app_session = session_alloc (ctx->c_thread_index);
575 app_session->session_state = SESSION_STATE_CREATED;
576 ctx->c_s_index = app_session->session_index;
577 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
578 app_session->session_type = st;
579 app_session->connection_index = ctx->tls_ctx_handle;
581 return tls_ctx_init_client (ctx);
585 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
590 ctx = tls_ctx_get_w_thread (ctx_handle, 1 /* udp allocs on thread 1 */);
592 ctx->tls_session_handle = session_handle (us);
593 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
594 us->opaque = ctx_handle;
596 /* We don't preallocate the app session because the udp session might
597 * actually migrate to a different worker at the end of the handshake */
599 return tls_ctx_init_client (ctx);
603 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
604 session_t *tls_session, session_error_t err)
606 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
607 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
610 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
615 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
619 if (ntf == SESSION_CLEANUP_TRANSPORT)
621 /* Allow cleanup of tcp session */
622 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
627 ctx = tls_ctx_get (s->opaque);
628 if (!ctx->no_app_session)
629 session_transport_delete_notify (&ctx->connection);
634 dtls_migrate_ctx (void *arg)
636 tls_ctx_t *ctx = (tls_ctx_t *) arg;
637 u32 ctx_handle, thread_index;
640 thread_index = session_thread_from_handle (ctx->tls_session_handle);
641 ASSERT (thread_index == vlib_get_thread_index ());
643 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
644 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
645 ctx->tls_ctx_handle = ctx_handle;
647 us = session_get_from_handle (ctx->tls_session_handle);
648 us->opaque = ctx_handle;
649 us->flags &= ~SESSION_F_IS_MIGRATING;
650 if (svm_fifo_max_dequeue (us->tx_fifo))
651 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
655 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
657 u32 new_thread = session_thread_from_handle (new_sh);
658 tls_ctx_t *ctx, *cloned_ctx;
660 /* Migrate dtls context to new thread */
661 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
662 ctx->tls_session_handle = new_sh;
663 cloned_ctx = tls_ctx_detach (ctx);
664 ctx->is_migrated = 1;
666 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
667 (void *) cloned_ctx);
672 static session_cb_vft_t tls_app_cb_vft = {
673 .session_accept_callback = tls_session_accept_callback,
674 .session_disconnect_callback = tls_session_disconnect_callback,
675 .session_connected_callback = tls_session_connected_callback,
676 .session_reset_callback = tls_session_reset_callback,
677 .half_open_cleanup_callback = tls_session_cleanup_ho,
678 .add_segment_callback = tls_add_segment_callback,
679 .del_segment_callback = tls_del_segment_callback,
680 .builtin_app_rx_callback = tls_app_rx_callback,
681 .builtin_app_tx_callback = tls_app_tx_callback,
682 .session_migrate_callback = dtls_session_migrate_callback,
683 .session_cleanup_callback = tls_app_session_cleanup,
687 tls_connect (transport_endpoint_cfg_t * tep)
689 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
690 transport_endpt_crypto_cfg_t *ccfg;
691 crypto_engine_type_t engine_type;
692 session_endpoint_cfg_t *sep;
693 tls_main_t *tm = &tls_main;
694 app_worker_t *app_wrk;
700 sep = (session_endpoint_cfg_t *) tep;
702 return SESSION_E_NOEXTCFG;
704 app_wrk = app_worker_get (sep->app_wrk_index);
705 app = application_get (app_wrk->app_index);
707 ccfg = &sep->ext_cfg->crypto;
708 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
709 if (engine_type == CRYPTO_ENGINE_NONE)
711 clib_warning ("No tls engine_type available");
712 return SESSION_E_NOCRYPTOENG;
715 ctx_index = tls_ctx_half_open_alloc ();
716 ctx = tls_ctx_half_open_get (ctx_index);
717 ctx->parent_app_wrk_index = sep->app_wrk_index;
718 ctx->parent_app_api_context = sep->opaque;
719 ctx->tcp_is_ip4 = sep->is_ip4;
720 ctx->tls_type = sep->transport_proto;
721 ctx->ckpair_index = ccfg->ckpair_index;
722 ctx->c_proto = TRANSPORT_PROTO_TLS;
723 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
724 if (ccfg->hostname[0])
726 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
727 vec_terminate_c_string (ctx->srv_hostname);
729 tls_ctx_half_open_reader_unlock ();
731 ctx->tls_ctx_engine = engine_type;
733 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
734 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
735 cargs->app_index = tm->app_index;
736 cargs->api_context = ctx_index;
737 cargs->sep_ext.ns_index = app->ns_index;
738 if ((rv = vnet_connect (cargs)))
741 /* Track half-open tcp session in case we need to clean it up */
742 ctx->tls_session_handle = cargs->sh;
744 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
749 tls_disconnect (u32 ctx_handle, u32 thread_index)
753 TLS_DBG (1, "Disconnecting %x", ctx_handle);
755 ctx = tls_ctx_get (ctx_handle);
756 tls_ctx_app_close (ctx);
760 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
762 vnet_listen_args_t _bargs, *args = &_bargs;
763 transport_endpt_crypto_cfg_t *ccfg;
764 app_worker_t *app_wrk;
765 tls_main_t *tm = &tls_main;
766 session_handle_t tls_al_handle;
767 session_endpoint_cfg_t *sep;
768 session_t *tls_listener;
769 session_t *app_listener;
770 crypto_engine_type_t engine_type;
777 sep = (session_endpoint_cfg_t *) tep;
779 return SESSION_E_NOEXTCFG;
781 app_wrk = app_worker_get (sep->app_wrk_index);
782 app = application_get (app_wrk->app_index);
784 ccfg = &sep->ext_cfg->crypto;
785 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
786 if (engine_type == CRYPTO_ENGINE_NONE)
788 clib_warning ("No tls engine_type available");
789 return SESSION_E_NOCRYPTOENG;
792 clib_memset (args, 0, sizeof (*args));
793 args->app_index = tm->app_index;
794 args->sep_ext = *sep;
795 args->sep_ext.ns_index = app->ns_index;
796 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
797 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
799 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
800 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
802 if ((rv = vnet_listen (args)))
805 lctx_index = tls_listener_ctx_alloc ();
806 tls_al_handle = args->handle;
807 al = app_listener_get_w_handle (tls_al_handle);
808 tls_listener = app_listener_get_session (al);
809 tls_listener->opaque = lctx_index;
811 app_listener = listen_session_get (app_listener_index);
813 lctx = tls_listener_ctx_get (lctx_index);
814 lctx->parent_app_wrk_index = sep->app_wrk_index;
815 lctx->tls_session_handle = tls_al_handle;
816 lctx->app_session_handle = listen_session_get_handle (app_listener);
817 lctx->tcp_is_ip4 = sep->is_ip4;
818 lctx->tls_ctx_engine = engine_type;
819 lctx->tls_type = sep->transport_proto;
820 lctx->ckpair_index = ccfg->ckpair_index;
822 if (tls_vfts[engine_type].ctx_start_listen (lctx))
824 vnet_unlisten_args_t a = {
825 .handle = lctx->tls_session_handle,
826 .app_index = tls_main.app_index,
829 if ((vnet_unlisten (&a)))
830 clib_warning ("unlisten returned");
831 tls_listener_ctx_free (lctx);
832 lctx_index = SESSION_INVALID_INDEX;
835 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
841 tls_stop_listen (u32 lctx_index)
843 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
844 crypto_engine_type_t engine_type;
845 transport_connection_t *lc;
850 lctx = tls_listener_ctx_get (lctx_index);
852 /* Cleanup listener from session lookup table */
853 ls = session_get_from_handle (lctx->tls_session_handle);
854 lc = session_get_transport (ls);
856 sep.fib_index = lc->fib_index;
857 sep.port = lc->lcl_port;
858 sep.is_ip4 = lc->is_ip4;
859 sep.transport_proto = lctx->tls_type;
860 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
861 session_lookup_del_session_endpoint2 (&sep);
863 vnet_unlisten_args_t a = {
864 .handle = lctx->tls_session_handle,
865 .app_index = tls_main.app_index,
866 .wrk_map_index = 0 /* default wrk */
868 if ((rv = vnet_unlisten (&a)))
869 clib_warning ("unlisten returned %d", rv);
871 engine_type = lctx->tls_ctx_engine;
872 tls_vfts[engine_type].ctx_stop_listen (lctx);
874 tls_listener_ctx_free (lctx);
878 transport_connection_t *
879 tls_connection_get (u32 ctx_index, u32 thread_index)
882 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
883 return &ctx->connection;
886 transport_connection_t *
887 tls_listener_get (u32 listener_index)
890 ctx = tls_listener_ctx_get (listener_index);
891 return &ctx->connection;
894 static transport_connection_t *
895 tls_half_open_get (u32 ho_index)
897 tls_main_t *tm = &tls_main;
899 ctx = tls_ctx_half_open_get (ho_index);
900 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
901 return &ctx->connection;
905 tls_cleanup_ho (u32 ho_index)
907 tls_main_t *tm = &tls_main;
909 ctx = tls_ctx_half_open_get (ho_index);
910 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
911 session_cleanup_half_open (ctx->tls_session_handle);
915 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
917 session_t *app_session = (session_t *) session;
920 if (PREDICT_FALSE (app_session->session_state
921 >= SESSION_STATE_TRANSPORT_CLOSED))
925 ctx = tls_ctx_get (app_session->connection_index);
926 return tls_ctx_write (ctx, app_session, sp);
930 format_tls_ctx (u8 * s, va_list * args)
932 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
933 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
936 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
937 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
938 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
940 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
941 ctx->c_thread_index, ctx->c_s_index, proto,
942 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
948 format_tls_listener_ctx (u8 * s, va_list * args)
950 session_t *tls_listener;
955 ctx = va_arg (*args, tls_ctx_t *);
957 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
958 al = app_listener_get_w_handle (ctx->tls_session_handle);
959 tls_listener = app_listener_get_session (al);
960 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
961 ctx->c_thread_index, ctx->c_s_index, proto,
962 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
963 tls_listener->thread_index, tls_listener->session_index);
969 format_tls_ctx_state (u8 * s, va_list * args)
974 ctx = va_arg (*args, tls_ctx_t *);
975 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
976 if (ts->session_state == SESSION_STATE_LISTENING)
977 s = format (s, "%s", "LISTEN");
980 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
981 s = format (s, "%s", "CLOSED");
982 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
983 s = format (s, "%s", "APP-CLOSED");
984 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
985 s = format (s, "%s", "CLOSING");
986 else if (tls_ctx_handshake_is_over (ctx))
987 s = format (s, "%s", "ESTABLISHED");
989 s = format (s, "%s", "HANDSHAKE");
996 format_tls_connection (u8 * s, va_list * args)
998 u32 ctx_index = va_arg (*args, u32);
999 u32 thread_index = va_arg (*args, u32);
1000 u32 verbose = va_arg (*args, u32);
1003 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1007 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1010 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1013 s = format (s, "\n");
1019 format_tls_listener (u8 * s, va_list * args)
1021 u32 tc_index = va_arg (*args, u32);
1022 u32 __clib_unused thread_index = va_arg (*args, u32);
1023 u32 verbose = va_arg (*args, u32);
1024 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1026 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1028 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1033 format_tls_half_open (u8 * s, va_list * args)
1035 u32 ho_index = va_arg (*args, u32);
1036 u32 __clib_unused thread_index = va_arg (*args, u32);
1040 ho_ctx = tls_ctx_half_open_get (ho_index);
1042 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1043 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1044 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1045 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1046 tcp_ho->thread_index, tcp_ho->session_index);
1048 tls_ctx_half_open_reader_unlock ();
1053 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1054 transport_endpoint_t * tep, u8 is_lcl)
1056 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1057 session_t *tcp_session;
1059 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1060 session_get_endpoint (tcp_session, tep, is_lcl);
1064 tls_transport_listener_endpoint_get (u32 ctx_handle,
1065 transport_endpoint_t * tep, u8 is_lcl)
1067 session_t *tls_listener;
1069 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1071 al = app_listener_get_w_handle (ctx->tls_session_handle);
1072 tls_listener = app_listener_get_session (al);
1073 session_get_endpoint (tls_listener, tep, is_lcl);
1076 static clib_error_t *
1077 tls_enable (vlib_main_t * vm, u8 is_en)
1079 u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
1080 vnet_app_detach_args_t _da, *da = &_da;
1081 vnet_app_attach_args_t _a, *a = &_a;
1082 u64 options[APP_OPTIONS_N_OPTIONS];
1083 tls_main_t *tm = &tls_main;
1084 u32 fifo_size = 128 << 12;
1088 da->app_index = tm->app_index;
1089 da->api_client_index = APP_INVALID_INDEX;
1090 vnet_application_detach (da);
1094 first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
1095 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1097 clib_memset (a, 0, sizeof (*a));
1098 clib_memset (options, 0, sizeof (options));
1100 a->session_cb_vft = &tls_app_cb_vft;
1101 a->api_client_index = APP_INVALID_INDEX;
1102 a->options = options;
1103 a->name = format (0, "tls");
1104 a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
1105 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
1106 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1107 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1108 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1109 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1110 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1112 if (vnet_application_attach (a))
1114 clib_warning ("failed to attach tls app");
1115 return clib_error_return (0, "failed to attach tls app");
1118 tm->app_index = a->app_index;
1124 static const transport_proto_vft_t tls_proto = {
1125 .enable = tls_enable,
1126 .connect = tls_connect,
1127 .close = tls_disconnect,
1128 .start_listen = tls_start_listen,
1129 .stop_listen = tls_stop_listen,
1130 .get_connection = tls_connection_get,
1131 .get_listener = tls_listener_get,
1132 .get_half_open = tls_half_open_get,
1133 .cleanup_ho = tls_cleanup_ho,
1134 .custom_tx = tls_custom_tx_callback,
1135 .format_connection = format_tls_connection,
1136 .format_half_open = format_tls_half_open,
1137 .format_listener = format_tls_listener,
1138 .get_transport_endpoint = tls_transport_endpoint_get,
1139 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1140 .transport_options = {
1143 .tx_type = TRANSPORT_TX_INTERNAL,
1144 .service_type = TRANSPORT_SERVICE_VC,
1149 dtls_connect (transport_endpoint_cfg_t *tep)
1151 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1152 transport_endpt_crypto_cfg_t *ccfg;
1153 crypto_engine_type_t engine_type;
1154 session_endpoint_cfg_t *sep;
1155 tls_main_t *tm = &tls_main;
1156 app_worker_t *app_wrk;
1162 sep = (session_endpoint_cfg_t *) tep;
1166 app_wrk = app_worker_get (sep->app_wrk_index);
1167 app = application_get (app_wrk->app_index);
1169 ccfg = &sep->ext_cfg->crypto;
1170 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1171 if (engine_type == CRYPTO_ENGINE_NONE)
1173 clib_warning ("No tls engine_type available");
1177 ctx_handle = tls_ctx_alloc_w_thread (engine_type, 1 /* because of udp */);
1178 ctx = tls_ctx_get_w_thread (ctx_handle, 1);
1179 ctx->parent_app_wrk_index = sep->app_wrk_index;
1180 ctx->parent_app_api_context = sep->opaque;
1181 ctx->tcp_is_ip4 = sep->is_ip4;
1182 ctx->ckpair_index = ccfg->ckpair_index;
1183 ctx->tls_type = sep->transport_proto;
1184 ctx->tls_ctx_handle = ctx_handle;
1185 if (ccfg->hostname[0])
1187 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1188 vec_terminate_c_string (ctx->srv_hostname);
1191 ctx->tls_ctx_engine = engine_type;
1193 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1194 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1195 cargs->app_index = tm->app_index;
1196 cargs->api_context = ctx_handle;
1197 cargs->sep_ext.ns_index = app->ns_index;
1198 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1199 if ((rv = vnet_connect (cargs)))
1202 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1208 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1213 static const transport_proto_vft_t dtls_proto = {
1215 .connect = dtls_connect,
1216 .close = tls_disconnect,
1217 .start_listen = tls_start_listen,
1218 .stop_listen = tls_stop_listen,
1219 .get_connection = tls_connection_get,
1220 .get_listener = tls_listener_get,
1221 .custom_tx = tls_custom_tx_callback,
1222 .cleanup = dtls_cleanup_callback,
1223 .format_connection = format_tls_connection,
1224 .format_half_open = format_tls_half_open,
1225 .format_listener = format_tls_listener,
1226 .get_transport_endpoint = tls_transport_endpoint_get,
1227 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1228 .transport_options = {
1231 .tx_type = TRANSPORT_TX_INTERNAL,
1232 .service_type = TRANSPORT_SERVICE_APP,
1237 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1239 vec_validate (tls_vfts, type);
1240 tls_vfts[type] = *vft;
1243 static clib_error_t *
1244 tls_init (vlib_main_t * vm)
1246 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1247 tls_main_t *tm = &tls_main;
1250 num_threads = 1 /* main thread */ + vtm->n_threads;
1252 if (!tm->ca_cert_path)
1253 tm->ca_cert_path = TLS_CA_CERT_PATH;
1255 clib_rwlock_init (&tm->half_open_rwlock);
1257 vec_validate (tm->rx_bufs, num_threads - 1);
1258 vec_validate (tm->tx_bufs, num_threads - 1);
1260 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1261 FIB_PROTOCOL_IP4, ~0);
1262 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1263 FIB_PROTOCOL_IP6, ~0);
1265 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1266 FIB_PROTOCOL_IP4, ~0);
1267 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1268 FIB_PROTOCOL_IP6, ~0);
1272 VLIB_INIT_FUNCTION (tls_init);
1274 static clib_error_t *
1275 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1277 tls_main_t *tm = &tls_main;
1279 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1281 if (unformat (input, "use-test-cert-in-ca"))
1282 tm->use_test_cert_in_ca = 1;
1283 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1285 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1286 &tm->first_seg_size))
1288 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1290 if (tmp >= 0x100000000ULL)
1292 return clib_error_return
1293 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1295 tm->fifo_size = tmp;
1298 return clib_error_return (0, "unknown input `%U'",
1299 format_unformat_error, input);
1304 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
1307 vnet_tls_get_main (void)
1313 * fd.io coding-style-patch-verification: ON
1316 * eval: (c-set-style "gnu")