2 * Copyright (c) 2018 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_get_available_engine (void)
33 for (i = 0; i < vec_len (tls_vfts); i++)
35 if (tls_vfts[i].ctx_alloc)
38 return TLS_ENGINE_NONE;
42 tls_add_vpp_q_evt (svm_fifo_t * f, u8 evt_type)
44 if (svm_fifo_set_event (f))
45 session_send_io_evt_to_thread (f, evt_type);
50 tls_add_app_q_evt (app_worker_t * app, stream_session_t * app_session)
52 return app_worker_lock_and_send_event (app, app_session, FIFO_EVENT_APP_RX);
56 tls_listener_ctx_alloc (void)
58 tls_main_t *tm = &tls_main;
61 pool_get (tm->listener_ctx_pool, ctx);
62 memset (ctx, 0, sizeof (*ctx));
63 return ctx - tm->listener_ctx_pool;
67 tls_listener_ctx_free (tls_ctx_t * ctx)
69 pool_put (tls_main.listener_ctx_pool, ctx);
73 tls_listener_ctx_get (u32 ctx_index)
75 return pool_elt_at_index (tls_main.listener_ctx_pool, ctx_index);
79 tls_listener_ctx_index (tls_ctx_t * ctx)
81 return (ctx - tls_main.listener_ctx_pool);
85 tls_ctx_half_open_alloc (void)
87 tls_main_t *tm = &tls_main;
92 pool_get_aligned_will_expand (tm->half_open_ctx_pool, will_expand, 0);
93 if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
95 clib_rwlock_writer_lock (&tm->half_open_rwlock);
96 pool_get (tm->half_open_ctx_pool, ctx);
97 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
101 /* reader lock assumption: only main thread will call pool_get */
102 clib_rwlock_reader_lock (&tm->half_open_rwlock);
103 pool_get (tm->half_open_ctx_pool, ctx);
104 clib_rwlock_reader_unlock (&tm->half_open_rwlock);
106 memset (ctx, 0, sizeof (*ctx));
107 ctx_index = ctx - tm->half_open_ctx_pool;
112 tls_ctx_half_open_free (u32 ho_index)
114 tls_main_t *tm = &tls_main;
115 clib_rwlock_writer_lock (&tm->half_open_rwlock);
116 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
117 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
121 tls_ctx_half_open_get (u32 ctx_index)
123 tls_main_t *tm = &tls_main;
124 clib_rwlock_reader_lock (&tm->half_open_rwlock);
125 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
129 tls_ctx_half_open_reader_unlock ()
131 clib_rwlock_reader_unlock (&tls_main.half_open_rwlock);
135 tls_ctx_half_open_index (tls_ctx_t * ctx)
137 return (ctx - tls_main.half_open_ctx_pool);
141 tls_notify_app_enqueue (tls_ctx_t * ctx, stream_session_t * app_session)
144 app = app_worker_get_if_valid (app_session->app_wrk_index);
145 if (PREDICT_TRUE (app != 0))
146 tls_add_app_q_evt (app, app_session);
150 tls_notify_app_accept (tls_ctx_t * ctx)
152 stream_session_t *app_listener, *app_session;
153 segment_manager_t *sm;
154 app_worker_t *app_wrk;
159 app_wrk = app_worker_get (ctx->parent_app_index);
160 app = application_get (app_wrk->app_index);
161 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
163 app_session = session_alloc (vlib_get_thread_index ());
164 app_session->app_wrk_index = ctx->parent_app_index;
165 app_session->connection_index = ctx->tls_ctx_handle;
167 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
168 app_session->session_type = app_listener->session_type;
169 app_session->listener_index = app_listener->session_index;
170 sm = app_worker_get_listen_segment_manager (app_wrk, app_listener);
171 app_session->t_app_index = tls_main.app_index;
173 if ((rv = session_alloc_fifos (sm, app_session)))
175 TLS_DBG (1, "failed to allocate fifos");
178 ctx->c_s_index = app_session->session_index;
179 ctx->app_session_handle = session_handle (app_session);
180 session_lookup_add_connection (&ctx->connection,
181 session_handle (app_session));
182 return app->cb_fns.session_accept_callback (app_session);
186 tls_notify_app_connected (tls_ctx_t * ctx, u8 is_failed)
188 int (*cb_fn) (u32, u32, stream_session_t *, u8);
189 stream_session_t *app_session;
190 segment_manager_t *sm;
191 app_worker_t *app_wrk;
194 app_wrk = app_worker_get (ctx->parent_app_index);
195 app = application_get (app_wrk->app_index);
196 cb_fn = app->cb_fns.session_connected_callback;
201 sm = app_worker_get_connect_segment_manager (app_wrk);
202 app_session = session_alloc (vlib_get_thread_index ());
203 app_session->app_wrk_index = ctx->parent_app_index;
204 app_session->connection_index = ctx->tls_ctx_handle;
205 app_session->session_type =
206 session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
207 app_session->t_app_index = tls_main.app_index;
209 if (session_alloc_fifos (sm, app_session))
212 ctx->app_session_handle = session_handle (app_session);
213 ctx->c_s_index = app_session->session_index;
214 app_session->session_state = SESSION_STATE_READY;
215 if (cb_fn (ctx->parent_app_index, ctx->parent_app_api_context,
216 app_session, 0 /* not failed */ ))
218 TLS_DBG (1, "failed to notify app");
219 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
222 session_lookup_add_connection (&ctx->connection,
223 session_handle (app_session));
228 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
229 return cb_fn (ctx->parent_app_index, ctx->parent_app_api_context, 0,
234 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
236 *ctx_index = ctx_handle & TLS_IDX_MASK;
237 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
240 static inline tls_engine_type_t
241 tls_get_engine_type (tls_engine_type_t preferred)
243 if (!tls_vfts[preferred].ctx_alloc)
244 return tls_get_available_engine ();
249 tls_ctx_alloc (tls_engine_type_t engine_type)
252 ctx_index = tls_vfts[engine_type].ctx_alloc ();
253 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
257 tls_ctx_free (tls_ctx_t * ctx)
259 vec_free (ctx->srv_hostname);
260 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
263 static inline tls_ctx_t *
264 tls_ctx_get (u32 ctx_handle)
266 u32 ctx_index, engine_type;
267 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
268 return tls_vfts[engine_type].ctx_get (ctx_index);
271 static inline tls_ctx_t *
272 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
274 u32 ctx_index, engine_type;
275 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
276 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
280 tls_ctx_init_server (tls_ctx_t * ctx)
282 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
286 tls_ctx_init_client (tls_ctx_t * ctx)
288 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
292 tls_ctx_write (tls_ctx_t * ctx, stream_session_t * app_session)
294 return tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session);
298 tls_ctx_read (tls_ctx_t * ctx, stream_session_t * tls_session)
300 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
304 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
306 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
310 tls_session_reset_callback (stream_session_t * s)
312 clib_warning ("called...");
316 tls_add_segment_callback (u32 client_index, const ssvm_private_t * fs)
318 /* No-op for builtin */
323 tls_del_segment_callback (u32 client_index, const ssvm_private_t * fs)
329 tls_session_disconnect_callback (stream_session_t * tls_session)
331 stream_session_t *app_session;
333 app_worker_t *app_wrk;
336 ctx = tls_ctx_get (tls_session->opaque);
337 if (!tls_ctx_handshake_is_over (ctx))
339 stream_session_disconnect (tls_session);
342 ctx->is_passive_close = 1;
343 app_wrk = app_worker_get (ctx->parent_app_index);
344 app = application_get (app_wrk->app_index);
345 app_session = session_get_from_handle (ctx->app_session_handle);
346 app->cb_fns.session_disconnect_callback (app_session);
350 tls_session_accept_callback (stream_session_t * tls_session)
352 stream_session_t *tls_listener;
353 tls_ctx_t *lctx, *ctx;
356 tls_listener = listen_session_get (tls_session->listener_index);
357 lctx = tls_listener_ctx_get (tls_listener->opaque);
359 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
360 ctx = tls_ctx_get (ctx_handle);
361 memcpy (ctx, lctx, sizeof (*lctx));
362 ctx->c_thread_index = vlib_get_thread_index ();
363 ctx->tls_ctx_handle = ctx_handle;
364 tls_session->session_state = SESSION_STATE_READY;
365 tls_session->opaque = ctx_handle;
366 ctx->tls_session_handle = session_handle (tls_session);
367 ctx->listener_ctx_index = tls_listener->opaque;
369 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
370 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
372 return tls_ctx_init_server (ctx);
376 tls_app_tx_callback (stream_session_t * app_session)
379 if (PREDICT_FALSE (app_session->session_state == SESSION_STATE_CLOSED))
381 ctx = tls_ctx_get (app_session->connection_index);
382 tls_ctx_write (ctx, app_session);
387 tls_app_rx_callback (stream_session_t * tls_session)
391 ctx = tls_ctx_get (tls_session->opaque);
392 tls_ctx_read (ctx, tls_session);
397 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
398 stream_session_t * tls_session, u8 is_fail)
400 tls_ctx_t *ho_ctx, *ctx;
403 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
407 int (*cb_fn) (u32, u32, stream_session_t *, u8);
408 u32 wrk_index, api_context;
409 app_worker_t *app_wrk;
412 wrk_index = ho_ctx->parent_app_index;
413 api_context = ho_ctx->c_s_index;
414 tls_ctx_half_open_reader_unlock ();
415 tls_ctx_half_open_free (ho_ctx_index);
416 app_wrk = app_worker_get (ho_ctx->parent_app_index);
417 app = application_get (app_wrk->app_index);
418 cb_fn = app->cb_fns.session_connected_callback;
419 return cb_fn (wrk_index, api_context, 0, 1 /* failed */ );
422 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
423 ctx = tls_ctx_get (ctx_handle);
424 clib_memcpy (ctx, ho_ctx, sizeof (*ctx));
425 tls_ctx_half_open_reader_unlock ();
426 tls_ctx_half_open_free (ho_ctx_index);
428 ctx->c_thread_index = vlib_get_thread_index ();
429 ctx->tls_ctx_handle = ctx_handle;
431 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
432 ho_ctx_index, is_fail, vlib_get_thread_index (),
433 (ctx) ? ctx_handle : ~0);
435 ctx->tls_session_handle = session_handle (tls_session);
436 tls_session->opaque = ctx_handle;
437 tls_session->session_state = SESSION_STATE_READY;
439 return tls_ctx_init_client (ctx);
443 static session_cb_vft_t tls_app_cb_vft = {
444 .session_accept_callback = tls_session_accept_callback,
445 .session_disconnect_callback = tls_session_disconnect_callback,
446 .session_connected_callback = tls_session_connected_callback,
447 .session_reset_callback = tls_session_reset_callback,
448 .add_segment_callback = tls_add_segment_callback,
449 .del_segment_callback = tls_del_segment_callback,
450 .builtin_app_rx_callback = tls_app_rx_callback,
451 .builtin_app_tx_callback = tls_app_tx_callback,
456 tls_connect (transport_endpoint_t * tep)
458 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
459 session_endpoint_extended_t *sep;
460 tls_engine_type_t engine_type;
461 tls_main_t *tm = &tls_main;
462 app_worker_t *app_wrk;
468 sep = (session_endpoint_extended_t *) tep;
469 app_wrk = app_worker_get (sep->app_wrk_index);
470 app = application_get (app_wrk->app_index);
471 engine_type = tls_get_engine_type (app->tls_engine);
472 if (engine_type == TLS_ENGINE_NONE)
474 clib_warning ("No tls engine_type available");
478 ctx_index = tls_ctx_half_open_alloc ();
479 ctx = tls_ctx_half_open_get (ctx_index);
480 ctx->parent_app_index = sep->app_wrk_index;
481 ctx->parent_app_api_context = sep->opaque;
482 ctx->tcp_is_ip4 = sep->is_ip4;
485 ctx->srv_hostname = format (0, "%v", sep->hostname);
486 vec_terminate_c_string (ctx->srv_hostname);
488 tls_ctx_half_open_reader_unlock ();
490 app_worker_alloc_connects_segment_manager (app_wrk);
491 ctx->tls_ctx_engine = engine_type;
493 clib_memcpy (&cargs->sep, sep, sizeof (session_endpoint_t));
494 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
495 cargs->app_index = tm->app_index;
496 cargs->api_context = ctx_index;
497 if ((error = vnet_connect (cargs)))
498 return clib_error_get_code (error);
500 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
505 tls_disconnect (u32 ctx_handle, u32 thread_index)
509 TLS_DBG (1, "Disconnecting %x", ctx_handle);
511 ctx = tls_ctx_get (ctx_handle);
513 vnet_disconnect_args_t a = {
514 .handle = ctx->tls_session_handle,
515 .app_index = tls_main.app_index,
518 if (vnet_disconnect_session (&a))
519 clib_warning ("disconnect returned");
521 stream_session_delete_notify (&ctx->connection);
526 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
528 vnet_bind_args_t _bargs, *args = &_bargs;
529 app_worker_t *app_wrk;
530 tls_main_t *tm = &tls_main;
531 session_handle_t tls_handle;
532 session_endpoint_extended_t *sep;
533 stream_session_t *tls_listener;
534 stream_session_t *app_listener;
535 tls_engine_type_t engine_type;
540 sep = (session_endpoint_extended_t *) tep;
541 app_wrk = app_worker_get (sep->app_wrk_index);
542 app = application_get (app_wrk->app_index);
543 engine_type = tls_get_engine_type (app->tls_engine);
544 if (engine_type == TLS_ENGINE_NONE)
546 clib_warning ("No tls engine_type available");
550 sep->transport_proto = TRANSPORT_PROTO_TCP;
551 memset (args, 0, sizeof (*args));
552 args->app_index = tm->app_index;
553 args->sep_ext = *sep;
554 if (vnet_bind (args))
557 tls_handle = args->handle;
558 lctx_index = tls_listener_ctx_alloc ();
559 tls_listener = listen_session_get_from_handle (tls_handle);
560 tls_listener->opaque = lctx_index;
562 app_listener = listen_session_get (app_listener_index);
564 lctx = tls_listener_ctx_get (lctx_index);
565 lctx->parent_app_index = sep->app_wrk_index;
566 lctx->tls_session_handle = tls_handle;
567 lctx->app_session_handle = listen_session_get_handle (app_listener);
568 lctx->tcp_is_ip4 = sep->is_ip4;
569 lctx->tls_ctx_engine = engine_type;
571 tls_vfts[engine_type].ctx_start_listen (lctx);
573 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
579 tls_stop_listen (u32 lctx_index)
581 tls_engine_type_t engine_type;
584 lctx = tls_listener_ctx_get (lctx_index);
585 vnet_unbind_args_t a = {
586 .handle = lctx->tls_session_handle,
587 .app_index = tls_main.app_index,
588 .wrk_map_index = 0 /* default wrk */
590 if (vnet_unbind (&a))
591 clib_warning ("unbind returned");
593 engine_type = lctx->tls_ctx_engine;
594 tls_vfts[engine_type].ctx_stop_listen (lctx);
596 tls_listener_ctx_free (lctx);
600 transport_connection_t *
601 tls_connection_get (u32 ctx_index, u32 thread_index)
604 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
605 return &ctx->connection;
608 transport_connection_t *
609 tls_listener_get (u32 listener_index)
612 ctx = tls_listener_ctx_get (listener_index);
613 return &ctx->connection;
617 format_tls_ctx (u8 * s, va_list * args)
619 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
620 u32 thread_index = va_arg (*args, u32);
621 u32 child_si, child_ti;
623 session_parse_handle (ctx->tls_session_handle, &child_si, &child_ti);
624 if (thread_index != child_ti)
625 clib_warning ("app and tls sessions are on different threads!");
627 s = format (s, "[#%d][TLS] app %u child %u", child_ti,
628 ctx->parent_app_index, child_si);
633 format_tls_connection (u8 * s, va_list * args)
635 u32 ctx_index = va_arg (*args, u32);
636 u32 thread_index = va_arg (*args, u32);
637 u32 verbose = va_arg (*args, u32);
640 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
644 s = format (s, "%-50U", format_tls_ctx, ctx, thread_index);
647 s = format (s, "%-15s", "state");
649 s = format (s, "\n");
655 format_tls_listener (u8 * s, va_list * args)
657 u32 tc_index = va_arg (*args, u32);
658 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
659 u32 listener_index, thread_index;
661 listen_session_parse_handle (ctx->tls_session_handle, &listener_index,
663 return format (s, "[TLS] listener app %u child %u", ctx->parent_app_index,
668 format_tls_half_open (u8 * s, va_list * args)
670 u32 tc_index = va_arg (*args, u32);
671 tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
672 s = format (s, "[TLS] half-open app %u", ctx->parent_app_index);
673 tls_ctx_half_open_reader_unlock ();
678 const static transport_proto_vft_t tls_proto = {
680 .close = tls_disconnect,
681 .bind = tls_start_listen,
682 .get_connection = tls_connection_get,
683 .get_listener = tls_listener_get,
684 .unbind = tls_stop_listen,
685 .tx_type = TRANSPORT_TX_INTERNAL,
686 .service_type = TRANSPORT_SERVICE_APP,
687 .format_connection = format_tls_connection,
688 .format_half_open = format_tls_half_open,
689 .format_listener = format_tls_listener,
694 tls_register_engine (const tls_engine_vft_t * vft, tls_engine_type_t type)
696 vec_validate (tls_vfts, type);
697 tls_vfts[type] = *vft;
700 static clib_error_t *
701 tls_init (vlib_main_t * vm)
703 vlib_thread_main_t *vtm = vlib_get_thread_main ();
704 vnet_app_attach_args_t _a, *a = &_a;
705 u64 options[APP_OPTIONS_N_OPTIONS];
706 u32 segment_size = 512 << 20;
707 tls_main_t *tm = &tls_main;
708 u32 fifo_size = 64 << 10;
711 num_threads = 1 /* main thread */ + vtm->n_threads;
713 memset (a, 0, sizeof (*a));
714 memset (options, 0, sizeof (options));
716 a->session_cb_vft = &tls_app_cb_vft;
717 a->api_client_index = APP_INVALID_INDEX;
718 a->options = options;
719 a->name = format (0, "tls");
720 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
721 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
722 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
723 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
724 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
725 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
727 if (vnet_application_attach (a))
729 clib_warning ("failed to attach tls app");
730 return clib_error_return (0, "failed to attach tls app");
733 if (!tm->ca_cert_path)
734 tm->ca_cert_path = TLS_CA_CERT_PATH;
736 tm->app_index = a->app_index;
737 clib_rwlock_init (&tm->half_open_rwlock);
739 vec_validate (tm->rx_bufs, num_threads - 1);
740 vec_validate (tm->tx_bufs, num_threads - 1);
742 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
743 FIB_PROTOCOL_IP4, ~0);
744 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
745 FIB_PROTOCOL_IP6, ~0);
750 VLIB_INIT_FUNCTION (tls_init);
752 static clib_error_t *
753 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
755 tls_main_t *tm = &tls_main;
756 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
758 if (unformat (input, "use-test-cert-in-ca"))
759 tm->use_test_cert_in_ca = 1;
760 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
763 return clib_error_return (0, "unknown input `%U'",
764 format_unformat_error, input);
769 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
772 vnet_tls_get_main (void)
778 * fd.io coding-style-patch-verification: ON
781 * eval: (c-set-style "gnu")