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;
259 /* Free app session pre-allocated when transport was established */
260 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
261 ctx->no_app_session = 1;
262 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
263 return app_worker_connect_notify (app_wrk, 0, ctx->parent_app_api_context);
267 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
269 *ctx_index = ctx_handle & TLS_IDX_MASK;
270 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
273 static inline crypto_engine_type_t
274 tls_get_engine_type (crypto_engine_type_t preferred)
276 if (!tls_vfts[preferred].ctx_alloc)
277 return tls_get_available_engine ();
282 tls_ctx_alloc (crypto_engine_type_t engine_type)
285 ctx_index = tls_vfts[engine_type].ctx_alloc ();
286 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
289 static inline tls_ctx_t *
290 tls_ctx_get (u32 ctx_handle)
292 u32 ctx_index, engine_type;
293 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
294 return tls_vfts[engine_type].ctx_get (ctx_index);
297 static inline tls_ctx_t *
298 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
300 u32 ctx_index, engine_type;
301 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
302 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
306 tls_ctx_init_server (tls_ctx_t * ctx)
308 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
312 tls_ctx_init_client (tls_ctx_t * ctx)
314 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
318 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session)
320 return tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session);
324 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
326 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
330 tls_ctx_transport_close (tls_ctx_t * ctx)
332 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
336 tls_ctx_app_close (tls_ctx_t * ctx)
338 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
342 tls_ctx_free (tls_ctx_t * ctx)
344 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
348 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
350 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
354 tls_session_reset_callback (session_t * s)
357 transport_connection_t *tc;
358 session_t *app_session;
360 ctx = tls_ctx_get (s->opaque);
361 ctx->is_passive_close = 1;
362 tc = &ctx->connection;
363 if (tls_ctx_handshake_is_over (ctx))
365 session_transport_reset_notify (tc);
366 session_transport_closed_notify (tc);
367 tls_disconnect_transport (ctx);
371 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
373 session_free (app_session);
374 ctx->c_s_index = SESSION_INVALID_INDEX;
375 tls_disconnect_transport (ctx);
380 tls_add_segment_callback (u32 client_index, u64 segment_handle)
382 /* No-op for builtin */
387 tls_del_segment_callback (u32 client_index, u64 segment_handle)
393 tls_session_disconnect_callback (session_t * tls_session)
397 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
398 tls_session->session_index);
400 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
401 || vlib_thread_is_main_w_barrier ());
403 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
404 ctx->is_passive_close = 1;
405 tls_ctx_transport_close (ctx);
409 tls_session_accept_callback (session_t * tls_session)
411 session_t *tls_listener, *app_session;
412 tls_ctx_t *lctx, *ctx;
416 listen_session_get_from_handle (tls_session->listener_handle);
417 lctx = tls_listener_ctx_get (tls_listener->opaque);
419 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
420 ctx = tls_ctx_get (ctx_handle);
421 memcpy (ctx, lctx, sizeof (*lctx));
422 ctx->c_thread_index = vlib_get_thread_index ();
423 ctx->tls_ctx_handle = ctx_handle;
424 tls_session->session_state = SESSION_STATE_READY;
425 tls_session->opaque = ctx_handle;
426 ctx->tls_session_handle = session_handle (tls_session);
427 ctx->listener_ctx_index = tls_listener->opaque;
428 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
429 ctx->ckpair_index = lctx->ckpair_index;
431 /* Preallocate app session. Avoids allocating a session post handshake
432 * on tls_session rx and potentially invalidating the session pool */
433 app_session = session_alloc (ctx->c_thread_index);
434 app_session->session_state = SESSION_STATE_CREATED;
435 ctx->c_s_index = app_session->session_index;
437 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
438 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
440 return tls_ctx_init_server (ctx);
444 tls_app_rx_callback (session_t * tls_session)
448 ctx = tls_ctx_get (tls_session->opaque);
449 tls_ctx_read (ctx, tls_session);
454 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
455 session_t * tls_session, u8 is_fail)
457 session_t *app_session;
458 tls_ctx_t *ho_ctx, *ctx;
461 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
465 app_worker_t *app_wrk;
469 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
472 api_context = ho_ctx->c_s_index;
473 app_worker_connect_notify (app_wrk, 0, api_context);
475 tls_ctx_half_open_reader_unlock ();
476 tls_ctx_half_open_free (ho_ctx_index);
480 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
481 ctx = tls_ctx_get (ctx_handle);
482 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
483 tls_ctx_half_open_reader_unlock ();
484 tls_ctx_half_open_free (ho_ctx_index);
486 ctx->c_thread_index = vlib_get_thread_index ();
487 ctx->tls_ctx_handle = ctx_handle;
488 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
490 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
491 ho_ctx_index, is_fail, vlib_get_thread_index (),
492 (ctx) ? ctx_handle : ~0);
494 ctx->tls_session_handle = session_handle (tls_session);
495 tls_session->opaque = ctx_handle;
496 tls_session->session_state = SESSION_STATE_READY;
498 /* Preallocate app session. Avoids allocating a session post handshake
499 * on tls_session rx and potentially invalidating the session pool */
500 app_session = session_alloc (ctx->c_thread_index);
501 app_session->session_state = SESSION_STATE_CREATED;
502 ctx->c_s_index = app_session->session_index;
504 return tls_ctx_init_client (ctx);
508 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
512 if (ntf == SESSION_CLEANUP_TRANSPORT)
515 ctx = tls_ctx_get (s->opaque);
516 if (!ctx->no_app_session)
517 session_transport_delete_notify (&ctx->connection);
522 static session_cb_vft_t tls_app_cb_vft = {
523 .session_accept_callback = tls_session_accept_callback,
524 .session_disconnect_callback = tls_session_disconnect_callback,
525 .session_connected_callback = tls_session_connected_callback,
526 .session_reset_callback = tls_session_reset_callback,
527 .add_segment_callback = tls_add_segment_callback,
528 .del_segment_callback = tls_del_segment_callback,
529 .builtin_app_rx_callback = tls_app_rx_callback,
530 .session_cleanup_callback = tls_app_session_cleanup,
535 tls_connect (transport_endpoint_cfg_t * tep)
537 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
538 session_endpoint_cfg_t *sep;
539 crypto_engine_type_t engine_type;
540 tls_main_t *tm = &tls_main;
541 app_worker_t *app_wrk;
547 sep = (session_endpoint_cfg_t *) tep;
548 app_wrk = app_worker_get (sep->app_wrk_index);
549 app = application_get (app_wrk->app_index);
550 engine_type = tls_get_engine_type (app->tls_engine);
551 if (engine_type == CRYPTO_ENGINE_NONE)
553 clib_warning ("No tls engine_type available");
557 ctx_index = tls_ctx_half_open_alloc ();
558 ctx = tls_ctx_half_open_get (ctx_index);
559 ctx->parent_app_wrk_index = sep->app_wrk_index;
560 ctx->parent_app_api_context = sep->opaque;
561 ctx->tcp_is_ip4 = sep->is_ip4;
564 ctx->srv_hostname = format (0, "%v", sep->hostname);
565 vec_terminate_c_string (ctx->srv_hostname);
567 tls_ctx_half_open_reader_unlock ();
569 app_worker_alloc_connects_segment_manager (app_wrk);
570 ctx->tls_ctx_engine = engine_type;
572 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
573 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
574 cargs->app_index = tm->app_index;
575 cargs->api_context = ctx_index;
576 cargs->sep_ext.ns_index = app->ns_index;
577 if ((rv = vnet_connect (cargs)))
580 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
585 tls_disconnect (u32 ctx_handle, u32 thread_index)
589 TLS_DBG (1, "Disconnecting %x", ctx_handle);
591 ctx = tls_ctx_get (ctx_handle);
592 tls_ctx_app_close (ctx);
596 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
598 vnet_listen_args_t _bargs, *args = &_bargs;
599 app_worker_t *app_wrk;
600 tls_main_t *tm = &tls_main;
601 session_handle_t tls_al_handle;
602 session_endpoint_cfg_t *sep;
603 session_t *tls_listener;
604 session_t *app_listener;
605 crypto_engine_type_t engine_type;
611 sep = (session_endpoint_cfg_t *) tep;
612 app_wrk = app_worker_get (sep->app_wrk_index);
613 app = application_get (app_wrk->app_index);
614 engine_type = tls_get_engine_type (app->tls_engine);
615 if (engine_type == CRYPTO_ENGINE_NONE)
617 clib_warning ("No tls engine_type available");
621 clib_memset (args, 0, sizeof (*args));
622 args->app_index = tm->app_index;
623 args->sep_ext = *sep;
624 args->sep_ext.ns_index = app->ns_index;
625 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
626 if (vnet_listen (args))
629 lctx_index = tls_listener_ctx_alloc ();
630 tls_al_handle = args->handle;
631 al = app_listener_get_w_handle (tls_al_handle);
632 tls_listener = app_listener_get_session (al);
633 tls_listener->opaque = lctx_index;
635 app_listener = listen_session_get (app_listener_index);
637 lctx = tls_listener_ctx_get (lctx_index);
638 lctx->parent_app_wrk_index = sep->app_wrk_index;
639 lctx->tls_session_handle = tls_al_handle;
640 lctx->app_session_handle = listen_session_get_handle (app_listener);
641 lctx->tcp_is_ip4 = sep->is_ip4;
642 lctx->tls_ctx_engine = engine_type;
643 lctx->ckpair_index = sep->ckpair_index;
645 if (tls_vfts[engine_type].ctx_start_listen (lctx))
647 vnet_unlisten_args_t a = {
648 .handle = lctx->tls_session_handle,
649 .app_index = tls_main.app_index,
652 if ((vnet_unlisten (&a)))
653 clib_warning ("unlisten returned");
654 tls_listener_ctx_free (lctx);
655 lctx_index = SESSION_INVALID_INDEX;
658 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
664 tls_stop_listen (u32 lctx_index)
666 crypto_engine_type_t engine_type;
670 lctx = tls_listener_ctx_get (lctx_index);
671 vnet_unlisten_args_t a = {
672 .handle = lctx->tls_session_handle,
673 .app_index = tls_main.app_index,
674 .wrk_map_index = 0 /* default wrk */
676 if ((rv = vnet_unlisten (&a)))
677 clib_warning ("unlisten returned %d", rv);
679 engine_type = lctx->tls_ctx_engine;
680 tls_vfts[engine_type].ctx_stop_listen (lctx);
682 tls_listener_ctx_free (lctx);
686 transport_connection_t *
687 tls_connection_get (u32 ctx_index, u32 thread_index)
690 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
691 return &ctx->connection;
694 transport_connection_t *
695 tls_listener_get (u32 listener_index)
698 ctx = tls_listener_ctx_get (listener_index);
699 return &ctx->connection;
703 tls_custom_tx_callback (void *session, u32 max_burst_size)
705 session_t *app_session = (session_t *) session;
708 if (PREDICT_FALSE (app_session->session_state
709 >= SESSION_STATE_TRANSPORT_CLOSED))
712 ctx = tls_ctx_get (app_session->connection_index);
713 tls_ctx_write (ctx, app_session);
718 format_tls_ctx (u8 * s, va_list * args)
720 u32 tcp_si, tcp_ti, ctx_index, ctx_engine, app_si, app_ti;
721 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
723 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
724 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
725 session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
726 s = format (s, "[%d:%d][TLS] app_wrk %u index %u engine %u tcp %d:%d",
727 app_ti, app_si, ctx->parent_app_wrk_index, ctx_index,
728 ctx_engine, tcp_ti, tcp_si);
734 format_tls_listener_ctx (u8 * s, va_list * args)
736 session_t *tls_listener;
741 ctx = va_arg (*args, tls_ctx_t *);
743 al = app_listener_get_w_handle (ctx->tls_session_handle);
744 tls_listener = app_listener_get_session (al);
745 session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
746 s = format (s, "[%d:%d][TLS] app_wrk %u engine %u tcp %d:%d",
747 app_ti, app_si, ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
748 tls_listener->thread_index, tls_listener->session_index);
754 format_tls_ctx_state (u8 * s, va_list * args)
759 ctx = va_arg (*args, tls_ctx_t *);
760 ts = session_get_from_handle (ctx->app_session_handle);
761 if (ts->session_state == SESSION_STATE_LISTENING)
762 s = format (s, "%s", "LISTEN");
763 else if (tls_ctx_handshake_is_over (ctx))
764 s = format (s, "%s", "ESTABLISHED");
766 s = format (s, "%s", "HANDSHAKE");
772 format_tls_connection (u8 * s, va_list * args)
774 u32 ctx_index = va_arg (*args, u32);
775 u32 thread_index = va_arg (*args, u32);
776 u32 verbose = va_arg (*args, u32);
779 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
783 s = format (s, "%-50U", format_tls_ctx, ctx);
786 s = format (s, "%-15U", format_tls_ctx_state, ctx);
788 s = format (s, "\n");
794 format_tls_listener (u8 * s, va_list * args)
796 u32 tc_index = va_arg (*args, u32);
797 u32 __clib_unused thread_index = va_arg (*args, u32);
798 u32 verbose = va_arg (*args, u32);
799 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
801 s = format (s, "%-50U", format_tls_listener_ctx, ctx);
803 s = format (s, "%-15U", format_tls_ctx_state, ctx);
808 format_tls_half_open (u8 * s, va_list * args)
810 u32 tc_index = va_arg (*args, u32);
811 u32 __clib_unused thread_index = va_arg (*args, u32);
812 tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
813 s = format (s, "[TLS] half-open app %u", ctx->parent_app_wrk_index);
814 tls_ctx_half_open_reader_unlock ();
819 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
820 transport_endpoint_t * tep, u8 is_lcl)
822 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
823 session_t *tcp_session;
825 tcp_session = session_get_from_handle (ctx->tls_session_handle);
826 session_get_endpoint (tcp_session, tep, is_lcl);
830 tls_transport_listener_endpoint_get (u32 ctx_handle,
831 transport_endpoint_t * tep, u8 is_lcl)
833 session_t *tls_listener;
835 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
837 al = app_listener_get_w_handle (ctx->tls_session_handle);
838 tls_listener = app_listener_get_session (al);
839 session_get_endpoint (tls_listener, tep, is_lcl);
843 static const transport_proto_vft_t tls_proto = {
844 .connect = tls_connect,
845 .close = tls_disconnect,
846 .start_listen = tls_start_listen,
847 .stop_listen = tls_stop_listen,
848 .get_connection = tls_connection_get,
849 .get_listener = tls_listener_get,
850 .custom_tx = tls_custom_tx_callback,
851 .format_connection = format_tls_connection,
852 .format_half_open = format_tls_half_open,
853 .format_listener = format_tls_listener,
854 .get_transport_endpoint = tls_transport_endpoint_get,
855 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
856 .transport_options = {
857 .tx_type = TRANSPORT_TX_INTERNAL,
858 .service_type = TRANSPORT_SERVICE_APP,
864 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
866 vec_validate (tls_vfts, type);
867 tls_vfts[type] = *vft;
870 static clib_error_t *
871 tls_init (vlib_main_t * vm)
873 u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
874 vlib_thread_main_t *vtm = vlib_get_thread_main ();
875 u32 num_threads, fifo_size = 128 << 10;
876 vnet_app_attach_args_t _a, *a = &_a;
877 u64 options[APP_OPTIONS_N_OPTIONS];
878 tls_main_t *tm = &tls_main;
880 first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
881 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
882 num_threads = 1 /* main thread */ + vtm->n_threads;
884 clib_memset (a, 0, sizeof (*a));
885 clib_memset (options, 0, sizeof (options));
887 a->session_cb_vft = &tls_app_cb_vft;
888 a->api_client_index = APP_INVALID_INDEX;
889 a->options = options;
890 a->name = format (0, "tls");
891 a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
892 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
893 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
894 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
895 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
896 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
897 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
899 if (vnet_application_attach (a))
901 clib_warning ("failed to attach tls app");
902 return clib_error_return (0, "failed to attach tls app");
905 if (!tm->ca_cert_path)
906 tm->ca_cert_path = TLS_CA_CERT_PATH;
908 tm->app_index = a->app_index;
909 clib_rwlock_init (&tm->half_open_rwlock);
911 vec_validate (tm->rx_bufs, num_threads - 1);
912 vec_validate (tm->tx_bufs, num_threads - 1);
914 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
915 FIB_PROTOCOL_IP4, ~0);
916 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
917 FIB_PROTOCOL_IP6, ~0);
922 VLIB_INIT_FUNCTION (tls_init);
924 static clib_error_t *
925 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
927 tls_main_t *tm = &tls_main;
929 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
931 if (unformat (input, "use-test-cert-in-ca"))
932 tm->use_test_cert_in_ca = 1;
933 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
935 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
936 &tm->first_seg_size))
938 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
940 if (tmp >= 0x100000000ULL)
942 return clib_error_return
943 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
948 return clib_error_return (0, "unknown input `%U'",
949 format_unformat_error, input);
954 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
957 vnet_tls_get_main (void)
963 * fd.io coding-style-patch-verification: ON
966 * eval: (c-set-style "gnu")