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_vpp_q_builtin_tx_evt (session_t * s)
80 if (svm_fifo_set_event (s->tx_fifo))
81 session_send_io_evt_to_thread_custom (s, s->thread_index,
82 SESSION_IO_EVT_BUILTIN_TX);
87 tls_add_app_q_evt (app_worker_t * app, session_t * app_session)
89 return app_worker_lock_and_send_event (app, app_session, SESSION_IO_EVT_RX);
93 tls_listener_ctx_alloc (void)
95 tls_main_t *tm = &tls_main;
98 pool_get (tm->listener_ctx_pool, ctx);
99 clib_memset (ctx, 0, sizeof (*ctx));
100 return ctx - tm->listener_ctx_pool;
104 tls_listener_ctx_free (tls_ctx_t * ctx)
107 memset (ctx, 0xfb, sizeof (*ctx));
108 pool_put (tls_main.listener_ctx_pool, ctx);
112 tls_listener_ctx_get (u32 ctx_index)
114 return pool_elt_at_index (tls_main.listener_ctx_pool, ctx_index);
118 tls_listener_ctx_index (tls_ctx_t * ctx)
120 return (ctx - tls_main.listener_ctx_pool);
124 tls_ctx_half_open_alloc (void)
126 tls_main_t *tm = &tls_main;
131 pool_get_aligned_will_expand (tm->half_open_ctx_pool, will_expand, 0);
132 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
134 clib_rwlock_writer_lock (&tm->half_open_rwlock);
135 pool_get (tm->half_open_ctx_pool, ctx);
136 ctx_index = ctx - tm->half_open_ctx_pool;
137 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
141 /* reader lock assumption: only main thread will call pool_get */
142 clib_rwlock_reader_lock (&tm->half_open_rwlock);
143 pool_get (tm->half_open_ctx_pool, ctx);
144 ctx_index = ctx - tm->half_open_ctx_pool;
145 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
147 clib_memset (ctx, 0, sizeof (*ctx));
152 tls_ctx_half_open_free (u32 ho_index)
154 tls_main_t *tm = &tls_main;
155 clib_rwlock_writer_lock (&tm->half_open_rwlock);
156 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
157 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
161 tls_ctx_half_open_get (u32 ctx_index)
163 tls_main_t *tm = &tls_main;
164 clib_rwlock_reader_lock (&tm->half_open_rwlock);
165 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
169 tls_ctx_half_open_reader_unlock ()
171 clib_rwlock_reader_unlock (&tls_main.half_open_rwlock);
175 tls_ctx_half_open_index (tls_ctx_t * ctx)
177 return (ctx - tls_main.half_open_ctx_pool);
181 tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
183 app_worker_t *app_wrk;
184 app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
185 if (PREDICT_TRUE (app_wrk != 0))
186 tls_add_app_q_evt (app_wrk, app_session);
190 tls_notify_app_accept (tls_ctx_t * ctx)
192 session_t *app_listener, *app_session;
193 app_worker_t *app_wrk;
197 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
198 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
200 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
201 app_session->app_wrk_index = ctx->parent_app_wrk_index;
202 app_session->connection_index = ctx->tls_ctx_handle;
203 app_session->session_type = app_listener->session_type;
204 app_session->listener_handle = listen_session_get_handle (app_listener);
205 app_session->session_state = SESSION_STATE_ACCEPTING;
207 if ((rv = app_worker_init_accepted (app_session)))
209 TLS_DBG (1, "failed to allocate fifos");
210 session_free (app_session);
213 ctx->app_session_handle = session_handle (app_session);
214 ctx->parent_app_wrk_index = app_session->app_wrk_index;
215 app_wrk = app_worker_get (app_session->app_wrk_index);
216 return app_worker_accept_notify (app_wrk, app_session);
220 tls_notify_app_connected (tls_ctx_t * ctx, u8 is_failed)
222 session_t *app_session;
223 app_worker_t *app_wrk;
225 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
228 tls_disconnect_transport (ctx);
235 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
236 app_session->app_wrk_index = ctx->parent_app_wrk_index;
237 app_session->connection_index = ctx->tls_ctx_handle;
238 app_session->session_type =
239 session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
241 if (app_worker_init_connected (app_wrk, app_session))
244 app_session->session_state = SESSION_STATE_CONNECTING;
245 if (app_worker_connect_notify (app_wrk, app_session,
246 ctx->parent_app_api_context))
248 TLS_DBG (1, "failed to notify app");
249 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
253 ctx->app_session_handle = session_handle (app_session);
254 app_session->session_state = SESSION_STATE_READY;
255 session_lookup_add_connection (&ctx->connection,
256 session_handle (app_session));
261 /* Free app session pre-allocated when transport was established */
262 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
263 ctx->no_app_session = 1;
264 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
265 return app_worker_connect_notify (app_wrk, 0, ctx->parent_app_api_context);
269 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
271 *ctx_index = ctx_handle & TLS_IDX_MASK;
272 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
275 static inline crypto_engine_type_t
276 tls_get_engine_type (crypto_engine_type_t preferred)
278 if (!tls_vfts[preferred].ctx_alloc)
279 return tls_get_available_engine ();
284 tls_ctx_alloc (crypto_engine_type_t engine_type)
287 ctx_index = tls_vfts[engine_type].ctx_alloc ();
288 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
291 static inline tls_ctx_t *
292 tls_ctx_get (u32 ctx_handle)
294 u32 ctx_index, engine_type;
295 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
296 return tls_vfts[engine_type].ctx_get (ctx_index);
299 static inline tls_ctx_t *
300 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
302 u32 ctx_index, engine_type;
303 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
304 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
308 tls_ctx_init_server (tls_ctx_t * ctx)
310 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
314 tls_ctx_init_client (tls_ctx_t * ctx)
316 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
320 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session)
322 return tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session);
326 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
328 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
332 tls_ctx_transport_close (tls_ctx_t * ctx)
334 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
338 tls_ctx_app_close (tls_ctx_t * ctx)
340 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
344 tls_ctx_free (tls_ctx_t * ctx)
346 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
350 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
352 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
356 tls_session_reset_callback (session_t * s)
359 transport_connection_t *tc;
360 session_t *app_session;
362 ctx = tls_ctx_get (s->opaque);
363 tc = &ctx->connection;
364 if (tls_ctx_handshake_is_over (ctx))
366 session_transport_reset_notify (tc);
367 session_transport_closed_notify (tc);
369 else if ((app_session = session_get (tc->s_index, tc->thread_index)))
370 session_free (app_session);
371 tls_disconnect_transport (ctx);
375 tls_add_segment_callback (u32 client_index, u64 segment_handle)
377 /* No-op for builtin */
382 tls_del_segment_callback (u32 client_index, u64 segment_handle)
388 tls_session_disconnect_callback (session_t * tls_session)
392 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
393 tls_session->session_index);
395 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
396 || vlib_thread_is_main_w_barrier ());
398 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
399 ctx->is_passive_close = 1;
400 tls_ctx_transport_close (ctx);
404 tls_session_accept_callback (session_t * tls_session)
406 session_t *tls_listener, *app_session;
407 tls_ctx_t *lctx, *ctx;
411 listen_session_get_from_handle (tls_session->listener_handle);
412 lctx = tls_listener_ctx_get (tls_listener->opaque);
414 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
415 ctx = tls_ctx_get (ctx_handle);
416 memcpy (ctx, lctx, sizeof (*lctx));
417 ctx->c_thread_index = vlib_get_thread_index ();
418 ctx->tls_ctx_handle = ctx_handle;
419 tls_session->session_state = SESSION_STATE_READY;
420 tls_session->opaque = ctx_handle;
421 ctx->tls_session_handle = session_handle (tls_session);
422 ctx->listener_ctx_index = tls_listener->opaque;
423 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
424 ctx->ckpair_index = lctx->ckpair_index;
426 /* Preallocate app session. Avoids allocating a session post handshake
427 * on tls_session rx and potentially invalidating the session pool */
428 app_session = session_alloc (ctx->c_thread_index);
429 app_session->session_state = SESSION_STATE_CREATED;
430 ctx->c_s_index = app_session->session_index;
432 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
433 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
435 return tls_ctx_init_server (ctx);
439 tls_app_rx_callback (session_t * tls_session)
443 ctx = tls_ctx_get (tls_session->opaque);
444 tls_ctx_read (ctx, tls_session);
449 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
450 session_t * tls_session, u8 is_fail)
452 session_t *app_session;
453 tls_ctx_t *ho_ctx, *ctx;
456 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
460 app_worker_t *app_wrk;
464 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
467 api_context = ho_ctx->c_s_index;
468 app_worker_connect_notify (app_wrk, 0, api_context);
470 tls_ctx_half_open_reader_unlock ();
471 tls_ctx_half_open_free (ho_ctx_index);
475 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
476 ctx = tls_ctx_get (ctx_handle);
477 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
478 tls_ctx_half_open_reader_unlock ();
479 tls_ctx_half_open_free (ho_ctx_index);
481 ctx->c_thread_index = vlib_get_thread_index ();
482 ctx->tls_ctx_handle = ctx_handle;
483 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
485 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
486 ho_ctx_index, is_fail, vlib_get_thread_index (),
487 (ctx) ? ctx_handle : ~0);
489 ctx->tls_session_handle = session_handle (tls_session);
490 tls_session->opaque = ctx_handle;
491 tls_session->session_state = SESSION_STATE_READY;
493 /* Preallocate app session. Avoids allocating a session post handshake
494 * on tls_session rx and potentially invalidating the session pool */
495 app_session = session_alloc (ctx->c_thread_index);
496 app_session->session_state = SESSION_STATE_CREATED;
497 ctx->c_s_index = app_session->session_index;
499 return tls_ctx_init_client (ctx);
503 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
507 if (ntf == SESSION_CLEANUP_TRANSPORT)
510 ctx = tls_ctx_get (s->opaque);
511 if (!ctx->no_app_session)
512 session_transport_delete_notify (&ctx->connection);
517 static session_cb_vft_t tls_app_cb_vft = {
518 .session_accept_callback = tls_session_accept_callback,
519 .session_disconnect_callback = tls_session_disconnect_callback,
520 .session_connected_callback = tls_session_connected_callback,
521 .session_reset_callback = tls_session_reset_callback,
522 .add_segment_callback = tls_add_segment_callback,
523 .del_segment_callback = tls_del_segment_callback,
524 .builtin_app_rx_callback = tls_app_rx_callback,
525 .session_cleanup_callback = tls_app_session_cleanup,
530 tls_connect (transport_endpoint_cfg_t * tep)
532 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
533 session_endpoint_cfg_t *sep;
534 crypto_engine_type_t engine_type;
535 tls_main_t *tm = &tls_main;
536 app_worker_t *app_wrk;
542 sep = (session_endpoint_cfg_t *) tep;
543 app_wrk = app_worker_get (sep->app_wrk_index);
544 app = application_get (app_wrk->app_index);
545 engine_type = tls_get_engine_type (app->tls_engine);
546 if (engine_type == CRYPTO_ENGINE_NONE)
548 clib_warning ("No tls engine_type available");
552 ctx_index = tls_ctx_half_open_alloc ();
553 ctx = tls_ctx_half_open_get (ctx_index);
554 ctx->parent_app_wrk_index = sep->app_wrk_index;
555 ctx->parent_app_api_context = sep->opaque;
556 ctx->tcp_is_ip4 = sep->is_ip4;
559 ctx->srv_hostname = format (0, "%v", sep->hostname);
560 vec_terminate_c_string (ctx->srv_hostname);
562 tls_ctx_half_open_reader_unlock ();
564 app_worker_alloc_connects_segment_manager (app_wrk);
565 ctx->tls_ctx_engine = engine_type;
567 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
568 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
569 cargs->app_index = tm->app_index;
570 cargs->api_context = ctx_index;
571 cargs->sep_ext.ns_index = app->ns_index;
572 if ((rv = vnet_connect (cargs)))
575 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
580 tls_disconnect (u32 ctx_handle, u32 thread_index)
584 TLS_DBG (1, "Disconnecting %x", ctx_handle);
586 ctx = tls_ctx_get (ctx_handle);
587 tls_ctx_app_close (ctx);
591 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
593 vnet_listen_args_t _bargs, *args = &_bargs;
594 app_worker_t *app_wrk;
595 tls_main_t *tm = &tls_main;
596 session_handle_t tls_al_handle;
597 session_endpoint_cfg_t *sep;
598 session_t *tls_listener;
599 session_t *app_listener;
600 crypto_engine_type_t engine_type;
606 sep = (session_endpoint_cfg_t *) tep;
607 app_wrk = app_worker_get (sep->app_wrk_index);
608 app = application_get (app_wrk->app_index);
609 engine_type = tls_get_engine_type (app->tls_engine);
610 if (engine_type == CRYPTO_ENGINE_NONE)
612 clib_warning ("No tls engine_type available");
616 clib_memset (args, 0, sizeof (*args));
617 args->app_index = tm->app_index;
618 args->sep_ext = *sep;
619 args->sep_ext.ns_index = app->ns_index;
620 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
621 if (vnet_listen (args))
624 lctx_index = tls_listener_ctx_alloc ();
625 tls_al_handle = args->handle;
626 al = app_listener_get_w_handle (tls_al_handle);
627 tls_listener = app_listener_get_session (al);
628 tls_listener->opaque = lctx_index;
630 app_listener = listen_session_get (app_listener_index);
632 lctx = tls_listener_ctx_get (lctx_index);
633 lctx->parent_app_wrk_index = sep->app_wrk_index;
634 lctx->tls_session_handle = tls_al_handle;
635 lctx->app_session_handle = listen_session_get_handle (app_listener);
636 lctx->tcp_is_ip4 = sep->is_ip4;
637 lctx->tls_ctx_engine = engine_type;
638 lctx->ckpair_index = sep->ckpair_index;
640 if (tls_vfts[engine_type].ctx_start_listen (lctx))
642 vnet_unlisten_args_t a = {
643 .handle = lctx->tls_session_handle,
644 .app_index = tls_main.app_index,
647 if ((vnet_unlisten (&a)))
648 clib_warning ("unlisten returned");
649 tls_listener_ctx_free (lctx);
650 lctx_index = SESSION_INVALID_INDEX;
653 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
659 tls_stop_listen (u32 lctx_index)
661 crypto_engine_type_t engine_type;
665 lctx = tls_listener_ctx_get (lctx_index);
666 vnet_unlisten_args_t a = {
667 .handle = lctx->tls_session_handle,
668 .app_index = tls_main.app_index,
669 .wrk_map_index = 0 /* default wrk */
671 if ((rv = vnet_unlisten (&a)))
672 clib_warning ("unlisten returned %d", rv);
674 engine_type = lctx->tls_ctx_engine;
675 tls_vfts[engine_type].ctx_stop_listen (lctx);
677 tls_listener_ctx_free (lctx);
681 transport_connection_t *
682 tls_connection_get (u32 ctx_index, u32 thread_index)
685 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
686 return &ctx->connection;
689 transport_connection_t *
690 tls_listener_get (u32 listener_index)
693 ctx = tls_listener_ctx_get (listener_index);
694 return &ctx->connection;
698 tls_custom_tx_callback (void *session, u32 max_burst_size)
700 session_t *app_session = (session_t *) session;
703 if (PREDICT_FALSE (app_session->session_state
704 >= SESSION_STATE_TRANSPORT_CLOSED))
707 ctx = tls_ctx_get (app_session->connection_index);
708 tls_ctx_write (ctx, app_session);
713 format_tls_ctx (u8 * s, va_list * args)
715 u32 tcp_si, tcp_ti, ctx_index, ctx_engine, app_si, app_ti;
716 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
718 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
719 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
720 session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
721 s = format (s, "[%d:%d][TLS] app_wrk %u index %u engine %u tcp %d:%d",
722 app_ti, app_si, ctx->parent_app_wrk_index, ctx_index,
723 ctx_engine, tcp_ti, tcp_si);
729 format_tls_listener_ctx (u8 * s, va_list * args)
731 session_t *tls_listener;
736 ctx = va_arg (*args, tls_ctx_t *);
738 al = app_listener_get_w_handle (ctx->tls_session_handle);
739 tls_listener = app_listener_get_session (al);
740 session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
741 s = format (s, "[%d:%d][TLS] app_wrk %u engine %u tcp %d:%d",
742 app_ti, app_si, ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
743 tls_listener->thread_index, tls_listener->session_index);
749 format_tls_ctx_state (u8 * s, va_list * args)
754 ctx = va_arg (*args, tls_ctx_t *);
755 ts = session_get_from_handle (ctx->app_session_handle);
756 if (ts->session_state == SESSION_STATE_LISTENING)
757 s = format (s, "%s", "LISTEN");
758 else if (tls_ctx_handshake_is_over (ctx))
759 s = format (s, "%s", "ESTABLISHED");
761 s = format (s, "%s", "HANDSHAKE");
767 format_tls_connection (u8 * s, va_list * args)
769 u32 ctx_index = va_arg (*args, u32);
770 u32 thread_index = va_arg (*args, u32);
771 u32 verbose = va_arg (*args, u32);
774 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
778 s = format (s, "%-50U", format_tls_ctx, ctx);
781 s = format (s, "%-15U", format_tls_ctx_state, ctx);
783 s = format (s, "\n");
789 format_tls_listener (u8 * s, va_list * args)
791 u32 tc_index = va_arg (*args, u32);
792 u32 __clib_unused thread_index = va_arg (*args, u32);
793 u32 verbose = va_arg (*args, u32);
794 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
796 s = format (s, "%-50U", format_tls_listener_ctx, ctx);
798 s = format (s, "%-15U", format_tls_ctx_state, ctx);
803 format_tls_half_open (u8 * s, va_list * args)
805 u32 tc_index = va_arg (*args, u32);
806 u32 __clib_unused thread_index = va_arg (*args, u32);
807 tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
808 s = format (s, "[TLS] half-open app %u", ctx->parent_app_wrk_index);
809 tls_ctx_half_open_reader_unlock ();
814 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
815 transport_endpoint_t * tep, u8 is_lcl)
817 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
818 session_t *tcp_session;
820 tcp_session = session_get_from_handle (ctx->tls_session_handle);
821 session_get_endpoint (tcp_session, tep, is_lcl);
825 tls_transport_listener_endpoint_get (u32 ctx_handle,
826 transport_endpoint_t * tep, u8 is_lcl)
828 session_t *tls_listener;
830 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
832 al = app_listener_get_w_handle (ctx->tls_session_handle);
833 tls_listener = app_listener_get_session (al);
834 session_get_endpoint (tls_listener, tep, is_lcl);
838 static const transport_proto_vft_t tls_proto = {
839 .connect = tls_connect,
840 .close = tls_disconnect,
841 .start_listen = tls_start_listen,
842 .stop_listen = tls_stop_listen,
843 .get_connection = tls_connection_get,
844 .get_listener = tls_listener_get,
845 .custom_tx = tls_custom_tx_callback,
846 .format_connection = format_tls_connection,
847 .format_half_open = format_tls_half_open,
848 .format_listener = format_tls_listener,
849 .get_transport_endpoint = tls_transport_endpoint_get,
850 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
851 .transport_options = {
852 .tx_type = TRANSPORT_TX_INTERNAL,
853 .service_type = TRANSPORT_SERVICE_APP,
859 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
861 vec_validate (tls_vfts, type);
862 tls_vfts[type] = *vft;
865 static clib_error_t *
866 tls_init (vlib_main_t * vm)
868 u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
869 vlib_thread_main_t *vtm = vlib_get_thread_main ();
870 u32 num_threads, fifo_size = 128 << 10;
871 vnet_app_attach_args_t _a, *a = &_a;
872 u64 options[APP_OPTIONS_N_OPTIONS];
873 tls_main_t *tm = &tls_main;
875 first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
876 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
877 num_threads = 1 /* main thread */ + vtm->n_threads;
879 clib_memset (a, 0, sizeof (*a));
880 clib_memset (options, 0, sizeof (options));
882 a->session_cb_vft = &tls_app_cb_vft;
883 a->api_client_index = APP_INVALID_INDEX;
884 a->options = options;
885 a->name = format (0, "tls");
886 a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
887 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
888 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
889 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
890 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
891 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
892 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
894 if (vnet_application_attach (a))
896 clib_warning ("failed to attach tls app");
897 return clib_error_return (0, "failed to attach tls app");
900 if (!tm->ca_cert_path)
901 tm->ca_cert_path = TLS_CA_CERT_PATH;
903 tm->app_index = a->app_index;
904 clib_rwlock_init (&tm->half_open_rwlock);
906 vec_validate (tm->rx_bufs, num_threads - 1);
907 vec_validate (tm->tx_bufs, num_threads - 1);
909 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
910 FIB_PROTOCOL_IP4, ~0);
911 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
912 FIB_PROTOCOL_IP6, ~0);
917 VLIB_INIT_FUNCTION (tls_init);
919 static clib_error_t *
920 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
922 tls_main_t *tm = &tls_main;
924 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
926 if (unformat (input, "use-test-cert-in-ca"))
927 tm->use_test_cert_in_ca = 1;
928 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
930 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
931 &tm->first_seg_size))
933 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
935 if (tmp >= 0x100000000ULL)
937 return clib_error_return
938 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
943 return clib_error_return (0, "unknown input `%U'",
944 format_unformat_error, input);
949 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
952 vnet_tls_get_main (void)
958 * fd.io coding-style-patch-verification: ON
961 * eval: (c-set-style "gnu")