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 (application_t * app, stream_session_t * app_session)
52 return application_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 memset (ctx, 0, sizeof (*ctx));
98 ctx_index = ctx - tm->half_open_ctx_pool;
99 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
103 pool_get (tm->half_open_ctx_pool, ctx);
104 memset (ctx, 0, sizeof (*ctx));
105 ctx_index = ctx - tm->half_open_ctx_pool;
111 tls_ctx_half_open_free (u32 ho_index)
113 tls_main_t *tm = &tls_main;
114 clib_rwlock_writer_lock (&tm->half_open_rwlock);
115 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
116 clib_rwlock_writer_unlock (&tm->half_open_rwlock);
120 tls_ctx_half_open_get (u32 ctx_index)
122 tls_main_t *tm = &tls_main;
123 clib_rwlock_reader_lock (&tm->half_open_rwlock);
124 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
128 tls_ctx_half_open_reader_unlock ()
130 clib_rwlock_reader_unlock (&tls_main.half_open_rwlock);
134 tls_ctx_half_open_index (tls_ctx_t * ctx)
136 return (ctx - tls_main.half_open_ctx_pool);
140 tls_notify_app_enqueue (tls_ctx_t * ctx, stream_session_t * app_session)
143 app = application_get_if_valid (app_session->app_index);
144 if (PREDICT_TRUE (app != 0))
145 tls_add_app_q_evt (app, app_session);
149 tls_notify_app_accept (tls_ctx_t * ctx)
151 stream_session_t *app_listener, *app_session;
152 segment_manager_t *sm;
157 app = application_get (ctx->parent_app_index);
158 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
159 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
160 sm = application_get_listen_segment_manager (app, app_listener);
162 app_session = session_alloc (vlib_get_thread_index ());
163 app_session->app_index = ctx->parent_app_index;
164 app_session->connection_index = ctx->tls_ctx_handle;
165 app_session->session_type = app_listener->session_type;
166 app_session->listener_index = app_listener->session_index;
167 if ((rv = session_alloc_fifos (sm, app_session)))
169 TLS_DBG (1, "failed to allocate fifos");
172 ctx->c_s_index = app_session->session_index;
173 ctx->app_session_handle = session_handle (app_session);
174 return app->cb_fns.session_accept_callback (app_session);
178 tls_notify_app_connected (tls_ctx_t * ctx, u8 is_failed)
180 int (*cb_fn) (u32, u32, stream_session_t *, u8);
181 stream_session_t *app_session;
182 segment_manager_t *sm;
185 app = application_get (ctx->parent_app_index);
186 cb_fn = app->cb_fns.session_connected_callback;
191 sm = application_get_connect_segment_manager (app);
192 app_session = session_alloc (vlib_get_thread_index ());
193 app_session->app_index = ctx->parent_app_index;
194 app_session->connection_index = ctx->tls_ctx_handle;
195 app_session->session_type =
196 session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
197 if (session_alloc_fifos (sm, app_session))
200 ctx->app_session_handle = session_handle (app_session);
201 ctx->c_s_index = app_session->session_index;
202 app_session->session_state = SESSION_STATE_READY;
203 if (cb_fn (ctx->parent_app_index, ctx->parent_app_api_context,
204 app_session, 0 /* not failed */ ))
206 TLS_DBG (1, "failed to notify app");
207 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
213 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
214 return cb_fn (ctx->parent_app_index, ctx->parent_app_api_context, 0,
219 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
221 *ctx_index = ctx_handle & TLS_IDX_MASK;
222 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
225 static inline tls_engine_type_t
226 tls_get_engine_type (tls_engine_type_t preferred)
228 if (!tls_vfts[preferred].ctx_alloc)
229 return tls_get_available_engine ();
234 tls_ctx_alloc (tls_engine_type_t engine_type)
237 ctx_index = tls_vfts[engine_type].ctx_alloc ();
238 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
242 tls_ctx_free (tls_ctx_t * ctx)
244 vec_free (ctx->srv_hostname);
245 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
248 static inline tls_ctx_t *
249 tls_ctx_get (u32 ctx_handle)
251 u32 ctx_index, engine_type;
252 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
253 return tls_vfts[engine_type].ctx_get (ctx_index);
256 static inline tls_ctx_t *
257 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
259 u32 ctx_index, engine_type;
260 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
261 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
265 tls_ctx_init_server (tls_ctx_t * ctx)
267 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
271 tls_ctx_init_client (tls_ctx_t * ctx)
273 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
277 tls_ctx_write (tls_ctx_t * ctx, stream_session_t * app_session)
279 return tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session);
283 tls_ctx_read (tls_ctx_t * ctx, stream_session_t * tls_session)
285 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
289 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
291 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
295 tls_session_reset_callback (stream_session_t * s)
297 clib_warning ("called...");
301 tls_add_segment_callback (u32 client_index, const ssvm_private_t * fs)
303 /* No-op for builtin */
308 tls_del_segment_callback (u32 client_index, const ssvm_private_t * fs)
314 tls_session_disconnect_callback (stream_session_t * tls_session)
316 stream_session_t *app_session;
320 ctx = tls_ctx_get (tls_session->opaque);
321 if (!tls_ctx_handshake_is_over (ctx))
323 stream_session_disconnect (tls_session);
326 ctx->is_passive_close = 1;
327 app = application_get (ctx->parent_app_index);
328 app_session = session_get_from_handle (ctx->app_session_handle);
329 app->cb_fns.session_disconnect_callback (app_session);
333 tls_session_accept_callback (stream_session_t * tls_session)
335 stream_session_t *tls_listener;
336 tls_ctx_t *lctx, *ctx;
339 tls_listener = listen_session_get (tls_session->listener_index);
340 lctx = tls_listener_ctx_get (tls_listener->opaque);
342 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
343 ctx = tls_ctx_get (ctx_handle);
344 memcpy (ctx, lctx, sizeof (*lctx));
345 ctx->c_thread_index = vlib_get_thread_index ();
346 ctx->tls_ctx_handle = ctx_handle;
347 tls_session->session_state = SESSION_STATE_READY;
348 tls_session->opaque = ctx_handle;
349 ctx->tls_session_handle = session_handle (tls_session);
350 ctx->listener_ctx_index = tls_listener->opaque;
352 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
353 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
355 return tls_ctx_init_server (ctx);
359 tls_app_tx_callback (stream_session_t * app_session)
362 if (PREDICT_FALSE (app_session->session_state == SESSION_STATE_CLOSED))
364 ctx = tls_ctx_get (app_session->connection_index);
365 tls_ctx_write (ctx, app_session);
370 tls_app_rx_callback (stream_session_t * tls_session)
374 ctx = tls_ctx_get (tls_session->opaque);
375 tls_ctx_read (ctx, tls_session);
380 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
381 stream_session_t * tls_session, u8 is_fail)
383 int (*cb_fn) (u32, u32, stream_session_t *, u8);
385 tls_ctx_t *ho_ctx, *ctx;
388 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
389 app = application_get (ho_ctx->parent_app_index);
390 cb_fn = app->cb_fns.session_connected_callback;
394 tls_ctx_half_open_reader_unlock ();
395 tls_ctx_half_open_free (ho_ctx_index);
396 return cb_fn (ho_ctx->parent_app_index, ho_ctx->c_s_index, 0,
400 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
401 ctx = tls_ctx_get (ctx_handle);
402 clib_memcpy (ctx, ho_ctx, sizeof (*ctx));
403 tls_ctx_half_open_reader_unlock ();
404 tls_ctx_half_open_free (ho_ctx_index);
406 ctx->c_thread_index = vlib_get_thread_index ();
407 ctx->tls_ctx_handle = ctx_handle;
409 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
410 ho_ctx_index, is_fail, vlib_get_thread_index (),
411 (ctx) ? ctx_handle : ~0);
413 ctx->tls_session_handle = session_handle (tls_session);
414 tls_session->opaque = ctx_handle;
415 tls_session->session_state = SESSION_STATE_READY;
417 return tls_ctx_init_client (ctx);
421 static session_cb_vft_t tls_app_cb_vft = {
422 .session_accept_callback = tls_session_accept_callback,
423 .session_disconnect_callback = tls_session_disconnect_callback,
424 .session_connected_callback = tls_session_connected_callback,
425 .session_reset_callback = tls_session_reset_callback,
426 .add_segment_callback = tls_add_segment_callback,
427 .del_segment_callback = tls_del_segment_callback,
428 .builtin_app_rx_callback = tls_app_rx_callback,
429 .builtin_app_tx_callback = tls_app_tx_callback,
434 tls_connect (transport_endpoint_t * tep)
436 session_endpoint_extended_t *sep;
437 tls_engine_type_t engine_type;
438 session_endpoint_t tls_sep;
439 tls_main_t *tm = &tls_main;
445 sep = (session_endpoint_extended_t *) tep;
446 app = application_get (sep->app_index);
447 engine_type = tls_get_engine_type (app->tls_engine);
448 if (engine_type == TLS_ENGINE_NONE)
450 clib_warning ("No tls engine_type available");
454 ctx_index = tls_ctx_half_open_alloc ();
455 ctx = tls_ctx_half_open_get (ctx_index);
456 ctx->parent_app_index = sep->app_index;
457 ctx->parent_app_api_context = sep->opaque;
458 ctx->tcp_is_ip4 = sep->is_ip4;
461 ctx->srv_hostname = format (0, "%v", sep->hostname);
462 vec_terminate_c_string (ctx->srv_hostname);
464 tls_ctx_half_open_reader_unlock ();
466 application_alloc_connects_segment_manager (app);
467 ctx->tls_ctx_engine = engine_type;
469 clib_memcpy (&tls_sep, sep, sizeof (tls_sep));
470 tls_sep.transport_proto = TRANSPORT_PROTO_TCP;
471 if ((rv = application_connect (tm->app_index, ctx_index, &tls_sep)))
474 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
479 tls_disconnect (u32 ctx_handle, u32 thread_index)
481 stream_session_t *tls_session, *app_session;
484 TLS_DBG (1, "Disconnecting %x", ctx_handle);
486 ctx = tls_ctx_get (ctx_handle);
487 tls_session = session_get_from_handle (ctx->tls_session_handle);
488 stream_session_disconnect (tls_session);
490 app_session = session_get_from_handle_if_valid (ctx->app_session_handle);
493 segment_manager_dealloc_fifos (app_session->svm_segment_index,
494 app_session->server_rx_fifo,
495 app_session->server_tx_fifo);
496 session_free (app_session);
502 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
504 tls_main_t *tm = &tls_main;
505 application_t *tls_app, *app;
506 session_handle_t tls_handle;
507 session_endpoint_extended_t *sep;
508 stream_session_t *tls_listener;
511 stream_session_t *app_listener;
512 tls_engine_type_t engine_type;
514 sep = (session_endpoint_extended_t *) tep;
515 app = application_get (sep->app_index);
516 engine_type = tls_get_engine_type (app->tls_engine);
517 if (engine_type == TLS_ENGINE_NONE)
519 clib_warning ("No tls engine_type available");
523 lctx_index = tls_listener_ctx_alloc ();
525 tls_app = application_get (tm->app_index);
526 sep->transport_proto = TRANSPORT_PROTO_TCP;
527 if (application_start_listen (tls_app, (session_endpoint_t *) sep,
531 tls_listener = listen_session_get_from_handle (tls_handle);
532 tls_listener->opaque = lctx_index;
534 app_listener = listen_session_get (app_listener_index);
536 lctx = tls_listener_ctx_get (lctx_index);
537 lctx->parent_app_index = sep->app_index;
538 lctx->tls_session_handle = tls_handle;
539 lctx->app_session_handle = listen_session_get_handle (app_listener);
540 lctx->tcp_is_ip4 = sep->is_ip4;
541 lctx->tls_ctx_engine = engine_type;
543 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
549 tls_stop_listen (u32 lctx_index)
551 tls_main_t *tm = &tls_main;
552 application_t *tls_app;
554 lctx = tls_listener_ctx_get (lctx_index);
555 tls_app = application_get (tm->app_index);
556 application_stop_listen (tls_app, lctx->tls_session_handle);
557 tls_listener_ctx_free (lctx);
561 transport_connection_t *
562 tls_connection_get (u32 ctx_index, u32 thread_index)
565 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
566 return &ctx->connection;
569 transport_connection_t *
570 tls_listener_get (u32 listener_index)
573 ctx = tls_listener_ctx_get (listener_index);
574 return &ctx->connection;
578 format_tls_ctx (u8 * s, va_list * args)
580 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
581 u32 thread_index = va_arg (*args, u32);
582 u32 child_si, child_ti;
584 session_parse_handle (ctx->tls_session_handle, &child_si, &child_ti);
585 if (thread_index != child_ti)
586 clib_warning ("app and tls sessions are on different threads!");
588 s = format (s, "[#%d][TLS] app %u child %u", child_ti,
589 ctx->parent_app_index, child_si);
594 format_tls_connection (u8 * s, va_list * args)
596 u32 ctx_index = va_arg (*args, u32);
597 u32 thread_index = va_arg (*args, u32);
598 u32 verbose = va_arg (*args, u32);
601 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
605 s = format (s, "%-50U", format_tls_ctx, ctx, thread_index);
608 s = format (s, "%-15s", "state");
610 s = format (s, "\n");
616 format_tls_listener (u8 * s, va_list * args)
618 u32 tc_index = va_arg (*args, u32);
619 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
620 u32 listener_index, thread_index;
622 listen_session_parse_handle (ctx->tls_session_handle, &listener_index,
624 return format (s, "[TLS] listener app %u child %u", ctx->parent_app_index,
629 format_tls_half_open (u8 * s, va_list * args)
631 u32 tc_index = va_arg (*args, u32);
632 tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
633 s = format (s, "[TLS] half-open app %u", ctx->parent_app_index);
634 tls_ctx_half_open_reader_unlock ();
639 const static transport_proto_vft_t tls_proto = {
641 .close = tls_disconnect,
642 .bind = tls_start_listen,
643 .get_connection = tls_connection_get,
644 .get_listener = tls_listener_get,
645 .unbind = tls_stop_listen,
646 .tx_type = TRANSPORT_TX_INTERNAL,
647 .service_type = TRANSPORT_SERVICE_APP,
648 .format_connection = format_tls_connection,
649 .format_half_open = format_tls_half_open,
650 .format_listener = format_tls_listener,
655 tls_register_engine (const tls_engine_vft_t * vft, tls_engine_type_t type)
657 vec_validate (tls_vfts, type);
658 tls_vfts[type] = *vft;
661 static clib_error_t *
662 tls_init (vlib_main_t * vm)
664 vlib_thread_main_t *vtm = vlib_get_thread_main ();
665 vnet_app_attach_args_t _a, *a = &_a;
666 u64 options[APP_OPTIONS_N_OPTIONS];
667 u32 segment_size = 512 << 20;
668 tls_main_t *tm = &tls_main;
669 u32 fifo_size = 64 << 10;
672 num_threads = 1 /* main thread */ + vtm->n_threads;
674 memset (a, 0, sizeof (*a));
675 memset (options, 0, sizeof (options));
677 a->session_cb_vft = &tls_app_cb_vft;
678 a->api_client_index = APP_INVALID_INDEX;
679 a->options = options;
680 a->name = format (0, "tls");
681 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
682 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
683 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
684 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
685 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
687 if (vnet_application_attach (a))
689 clib_warning ("failed to attach tls app");
690 return clib_error_return (0, "failed to attach tls app");
693 if (!tm->ca_cert_path)
694 tm->ca_cert_path = TLS_CA_CERT_PATH;
696 tm->app_index = a->app_index;
697 clib_rwlock_init (&tm->half_open_rwlock);
699 vec_validate (tm->rx_bufs, num_threads - 1);
700 vec_validate (tm->tx_bufs, num_threads - 1);
702 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
703 FIB_PROTOCOL_IP4, ~0);
704 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
705 FIB_PROTOCOL_IP6, ~0);
710 VLIB_INIT_FUNCTION (tls_init);
712 static clib_error_t *
713 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
715 tls_main_t *tm = &tls_main;
716 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
718 if (unformat (input, "use-test-cert-in-ca"))
719 tm->use_test_cert_in_ca = 1;
720 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
723 return clib_error_return (0, "unknown input `%U'",
724 format_unformat_error, input);
729 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
732 vnet_tls_get_main (void)
738 * fd.io coding-style-patch-verification: ON
741 * eval: (c-set-style "gnu")