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 28
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 session_enqueue_notify (s);
69 tls_add_vpp_q_tx_evt (session_t * s)
71 if (svm_fifo_set_event (s->tx_fifo))
72 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
77 tls_add_app_q_evt (app_worker_t *app_wrk, session_t *app_session)
79 app_worker_add_event (app_wrk, 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;
120 if (vec_len (tm->postponed_ho_free))
121 tls_flush_postponed_ho_cleanups ();
123 pool_get_aligned_safe (tm->half_open_ctx_pool, ctx, CLIB_CACHE_LINE_BYTES);
125 clib_memset (ctx, 0, sizeof (*ctx));
126 ctx->c_c_index = ctx - tm->half_open_ctx_pool;
127 ctx->c_thread_index = transport_cl_thread ();
129 return ctx->c_c_index;
133 tls_ctx_half_open_free (u32 ho_index)
135 pool_put_index (tls_main.half_open_ctx_pool, ho_index);
139 tls_ctx_half_open_get (u32 ctx_index)
141 tls_main_t *tm = &tls_main;
142 return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
146 tls_add_postponed_ho_cleanups (u32 ho_index)
148 tls_main_t *tm = &tls_main;
149 vec_add1 (tm->postponed_ho_free, ho_index);
153 tls_ctx_ho_try_free (u32 ho_index)
157 ctx = tls_ctx_half_open_get (ho_index);
158 /* Probably tcp connected just before tcp establish timeout and
159 * worker that owns established session has not yet received
160 * @ref tls_session_connected_cb */
161 if (!(ctx->flags & TLS_CONN_F_HO_DONE))
163 ctx->tls_session_handle = SESSION_INVALID_HANDLE;
164 tls_add_postponed_ho_cleanups (ho_index);
167 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
168 session_half_open_delete_notify (&ctx->connection);
169 tls_ctx_half_open_free (ho_index);
173 tls_flush_postponed_ho_cleanups ()
175 tls_main_t *tm = &tls_main;
176 u32 *ho_indexp, *tmp;
178 tmp = tm->postponed_ho_free;
179 tm->postponed_ho_free = tm->ho_free_list;
180 tm->ho_free_list = tmp;
182 vec_foreach (ho_indexp, tm->ho_free_list)
183 tls_ctx_ho_try_free (*ho_indexp);
185 vec_reset_length (tm->ho_free_list);
189 tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
191 app_worker_t *app_wrk;
192 app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
193 if (PREDICT_TRUE (app_wrk != 0))
194 tls_add_app_q_evt (app_wrk, app_session);
198 tls_notify_app_accept (tls_ctx_t * ctx)
200 session_t *app_listener, *app_session;
201 app_worker_t *app_wrk;
205 lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
206 app_listener = listen_session_get_from_handle (lctx->app_session_handle);
208 app_session = session_alloc (ctx->c_thread_index);
209 app_session->session_state = SESSION_STATE_ACCEPTING;
210 app_session->session_type = app_listener->session_type;
211 app_session->listener_handle = listen_session_get_handle (app_listener);
212 app_session->app_wrk_index = ctx->parent_app_wrk_index;
213 app_session->connection_index = ctx->tls_ctx_handle;
214 ctx->c_s_index = app_session->session_index;
216 if ((rv = app_worker_init_accepted (app_session)))
218 TLS_DBG (1, "failed to allocate fifos");
219 session_free (app_session);
220 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
223 ctx->app_session_handle = session_handle (app_session);
224 ctx->parent_app_wrk_index = app_session->app_wrk_index;
225 app_wrk = app_worker_get (app_session->app_wrk_index);
226 return app_worker_accept_notify (app_wrk, app_session);
230 tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
232 u32 parent_app_api_ctx;
233 session_t *app_session;
234 app_worker_t *app_wrk;
236 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
239 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
245 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
249 app_session = session_alloc (ctx->c_thread_index);
250 app_session->session_state = SESSION_STATE_CREATED;
251 app_session->connection_index = ctx->tls_ctx_handle;
253 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
255 /* Cleanup half-open session as we don't get notification from udp */
256 session_half_open_delete_notify (&ctx->connection);
257 app_session->session_type =
258 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
262 app_session->session_type =
263 session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
266 app_session->app_wrk_index = ctx->parent_app_wrk_index;
267 app_session->opaque = ctx->parent_app_api_context;
268 ctx->c_s_index = app_session->session_index;
270 if ((err = app_worker_init_connected (app_wrk, app_session)))
272 app_worker_connect_notify (app_wrk, 0, err, ctx->parent_app_api_context);
273 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
274 session_free (app_session);
278 app_session->session_state = SESSION_STATE_READY;
279 parent_app_api_ctx = ctx->parent_app_api_context;
280 ctx->app_session_handle = session_handle (app_session);
282 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
285 TLS_DBG (1, "failed to notify app");
286 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
287 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
294 return app_worker_connect_notify (app_wrk, 0, err,
295 ctx->parent_app_api_context);
299 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
301 *ctx_index = ctx_handle & TLS_IDX_MASK;
302 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
305 static inline crypto_engine_type_t
306 tls_get_engine_type (crypto_engine_type_t requested,
307 crypto_engine_type_t preferred)
309 if (requested != CRYPTO_ENGINE_NONE)
311 if (tls_vfts[requested].ctx_alloc)
313 return CRYPTO_ENGINE_NONE;
315 if (!tls_vfts[preferred].ctx_alloc)
316 return tls_get_available_engine ();
321 tls_ctx_alloc (crypto_engine_type_t engine_type)
324 ctx_index = tls_vfts[engine_type].ctx_alloc ();
325 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
329 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
332 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
333 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
337 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
340 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
341 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
345 tls_ctx_detach (tls_ctx_t *ctx)
347 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
350 static inline tls_ctx_t *
351 tls_ctx_get (u32 ctx_handle)
353 u32 ctx_index, engine_type;
354 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
355 return tls_vfts[engine_type].ctx_get (ctx_index);
358 static inline tls_ctx_t *
359 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
361 u32 ctx_index, engine_type;
362 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
363 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
367 tls_ctx_init_server (tls_ctx_t * ctx)
369 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
373 tls_ctx_init_client (tls_ctx_t * ctx)
375 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
379 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
380 transport_send_params_t * sp)
384 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
385 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
386 sp->bytes_dequeued = n_wrote;
387 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
391 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
393 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
397 tls_ctx_transport_close (tls_ctx_t * ctx)
399 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
403 tls_ctx_transport_reset (tls_ctx_t *ctx)
405 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_reset (ctx);
409 tls_ctx_app_close (tls_ctx_t * ctx)
411 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
415 tls_ctx_free (tls_ctx_t * ctx)
417 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
421 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
423 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
427 tls_reinit_ca_chain (crypto_engine_type_t tls_engine_id)
429 return tls_vfts[tls_engine_id].ctx_reinit_cachain ();
433 tls_notify_app_io_error (tls_ctx_t *ctx)
435 ASSERT (tls_ctx_handshake_is_over (ctx));
437 session_transport_reset_notify (&ctx->connection);
438 session_transport_closed_notify (&ctx->connection);
439 tls_disconnect_transport (ctx);
443 tls_session_reset_callback (session_t *ts)
447 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
448 ctx->flags |= TLS_CONN_F_PASSIVE_CLOSE;
449 tls_ctx_transport_reset (ctx);
453 tls_session_cleanup_ho (session_t *s)
455 /* session opaque stores the opaque passed on connect */
456 tls_ctx_ho_try_free (s->opaque);
460 tls_add_segment_callback (u32 client_index, u64 segment_handle)
462 /* No-op for builtin */
467 tls_del_segment_callback (u32 client_index, u64 segment_handle)
473 tls_session_disconnect_callback (session_t * tls_session)
477 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
478 tls_session->session_index);
480 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
481 || vlib_thread_is_main_w_barrier ());
483 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
484 ctx->flags |= TLS_CONN_F_PASSIVE_CLOSE;
485 tls_ctx_transport_close (ctx);
489 tls_session_accept_callback (session_t *ts)
491 session_t *tls_listener;
492 tls_ctx_t *lctx, *ctx;
495 tls_listener = listen_session_get_from_handle (ts->listener_handle);
496 lctx = tls_listener_ctx_get (tls_listener->opaque);
498 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
499 ctx = tls_ctx_get (ctx_handle);
500 clib_memcpy (ctx, lctx, sizeof (*lctx));
501 ctx->c_s_index = SESSION_INVALID_INDEX;
502 ctx->c_thread_index = ts->thread_index;
503 ctx->tls_ctx_handle = ctx_handle;
504 ts->session_state = SESSION_STATE_READY;
505 ts->opaque = ctx_handle;
506 ctx->tls_session_handle = session_handle (ts);
507 ctx->listener_ctx_index = tls_listener->opaque;
508 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
509 ctx->ckpair_index = lctx->ckpair_index;
511 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
512 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
514 if (tls_ctx_init_server (ctx))
516 /* Do not free ctx yet, in case we have pending rx events */
517 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
518 tls_disconnect_transport (ctx);
525 tls_app_rx_callback (session_t *ts)
529 /* DTLS session migrating, wait for next notification */
530 if (PREDICT_FALSE (ts->flags & SESSION_F_IS_MIGRATING))
533 /* Read rescheduled but underlying transport deleted now */
534 if (PREDICT_FALSE ((ts->session_state == SESSION_STATE_TRANSPORT_DELETED)))
537 ctx = tls_ctx_get (ts->opaque);
538 if (PREDICT_FALSE ((ctx->flags & TLS_CONN_F_NO_APP_SESSION) ||
539 (ctx->flags & TLS_CONN_F_APP_CLOSED)))
541 TLS_DBG (1, "Local App closed");
544 tls_ctx_read (ctx, ts);
549 tls_app_tx_callback (session_t * tls_session)
553 ctx = tls_ctx_get (tls_session->opaque);
554 transport_connection_reschedule (&ctx->connection);
560 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
561 session_t *tls_session, session_error_t err)
563 tls_ctx_t *ho_ctx, *ctx;
566 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
568 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
569 ctx = tls_ctx_get (ctx_handle);
570 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
572 /* Half-open freed on tcp half-open cleanup notification */
573 __atomic_fetch_or (&ho_ctx->flags, TLS_CONN_F_HO_DONE, __ATOMIC_RELEASE);
575 ctx->c_thread_index = vlib_get_thread_index ();
576 ctx->tls_ctx_handle = ctx_handle;
577 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
579 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
580 ho_ctx_index, err, vlib_get_thread_index (),
581 (ctx) ? ctx_handle : ~0);
583 ctx->tls_session_handle = session_handle (tls_session);
584 tls_session->opaque = ctx_handle;
586 if (tls_ctx_init_client (ctx))
588 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
589 tls_disconnect_transport (ctx);
592 if (tls_session->session_state < SESSION_STATE_READY)
593 tls_session->session_state = SESSION_STATE_READY;
599 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
604 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
606 ctx->tls_session_handle = session_handle (us);
607 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
608 us->opaque = ctx_handle;
610 /* We don't preallocate the app session because the udp session might
611 * actually migrate to a different worker at the end of the handshake */
613 return tls_ctx_init_client (ctx);
617 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
618 session_t *tls_session, session_error_t err)
622 app_worker_t *app_wrk;
626 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
627 ho_ctx->flags |= TLS_CONN_F_HO_DONE;
628 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
631 api_context = ho_ctx->parent_app_api_context;
632 app_worker_connect_notify (app_wrk, 0, err, api_context);
638 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
639 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
642 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
647 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
651 if (ntf == SESSION_CLEANUP_TRANSPORT)
653 /* Allow cleanup of tcp session */
654 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
659 ctx = tls_ctx_get (s->opaque);
660 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
661 session_transport_delete_notify (&ctx->connection);
666 dtls_migrate_ctx (void *arg)
668 tls_ctx_t *ctx = (tls_ctx_t *) arg;
669 u32 ctx_handle, thread_index;
672 thread_index = session_thread_from_handle (ctx->tls_session_handle);
673 ASSERT (thread_index == vlib_get_thread_index ());
675 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
676 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
677 ctx->tls_ctx_handle = ctx_handle;
679 us = session_get_from_handle (ctx->tls_session_handle);
680 us->opaque = ctx_handle;
681 us->flags &= ~SESSION_F_IS_MIGRATING;
683 /* Probably the app detached while the session was migrating. Cleanup */
684 if (session_half_open_migrated_notify (&ctx->connection))
686 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
687 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
691 if (svm_fifo_max_dequeue (us->tx_fifo))
692 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
696 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
698 u32 new_thread = session_thread_from_handle (new_sh);
699 tls_ctx_t *ctx, *cloned_ctx;
701 /* Migrate dtls context to new thread */
702 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
703 ctx->tls_session_handle = new_sh;
704 cloned_ctx = tls_ctx_detach (ctx);
705 ctx->flags |= TLS_CONN_F_MIGRATED;
706 session_half_open_migrate_notify (&ctx->connection);
708 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
709 (void *) cloned_ctx);
715 tls_session_transport_closed_callback (session_t *ts)
719 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
720 if (!(ctx->flags & TLS_CONN_F_NO_APP_SESSION))
721 session_transport_closed_notify (&ctx->connection);
724 static session_cb_vft_t tls_app_cb_vft = {
725 .session_accept_callback = tls_session_accept_callback,
726 .session_disconnect_callback = tls_session_disconnect_callback,
727 .session_connected_callback = tls_session_connected_callback,
728 .session_reset_callback = tls_session_reset_callback,
729 .session_transport_closed_callback = tls_session_transport_closed_callback,
730 .half_open_cleanup_callback = tls_session_cleanup_ho,
731 .add_segment_callback = tls_add_segment_callback,
732 .del_segment_callback = tls_del_segment_callback,
733 .builtin_app_rx_callback = tls_app_rx_callback,
734 .builtin_app_tx_callback = tls_app_tx_callback,
735 .session_migrate_callback = dtls_session_migrate_callback,
736 .session_cleanup_callback = tls_app_session_cleanup,
740 tls_connect (transport_endpoint_cfg_t * tep)
742 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
743 transport_endpt_crypto_cfg_t *ccfg;
744 crypto_engine_type_t engine_type;
745 session_endpoint_cfg_t *sep;
746 tls_main_t *tm = &tls_main;
747 app_worker_t *app_wrk;
753 sep = (session_endpoint_cfg_t *) tep;
755 return SESSION_E_NOEXTCFG;
757 app_wrk = app_worker_get (sep->app_wrk_index);
758 app = application_get (app_wrk->app_index);
760 ccfg = &sep->ext_cfg->crypto;
761 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
762 if (engine_type == CRYPTO_ENGINE_NONE)
764 clib_warning ("No tls engine_type available");
765 return SESSION_E_NOCRYPTOENG;
768 ctx_index = tls_ctx_half_open_alloc ();
769 ctx = tls_ctx_half_open_get (ctx_index);
770 ctx->parent_app_wrk_index = sep->app_wrk_index;
771 ctx->parent_app_api_context = sep->opaque;
772 ctx->tcp_is_ip4 = sep->is_ip4;
773 ctx->tls_type = sep->transport_proto;
774 ctx->ckpair_index = ccfg->ckpair_index;
775 ctx->c_proto = TRANSPORT_PROTO_TLS;
776 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
777 if (ccfg->hostname[0])
779 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
780 vec_terminate_c_string (ctx->srv_hostname);
783 ctx->tls_ctx_engine = engine_type;
785 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
786 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
787 cargs->app_index = tm->app_index;
788 cargs->api_context = ctx_index;
789 cargs->sep_ext.ns_index = app->ns_index;
790 if ((rv = vnet_connect (cargs)))
792 tls_ctx_half_open_free (ctx_index);
796 /* Track half-open tcp session in case we need to clean it up */
797 ctx->tls_session_handle = cargs->sh;
799 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
804 tls_disconnect (u32 ctx_handle, u32 thread_index)
808 TLS_DBG (1, "Disconnecting %x", ctx_handle);
810 ctx = tls_ctx_get (ctx_handle);
811 ctx->flags |= TLS_CONN_F_APP_CLOSED;
812 tls_ctx_app_close (ctx);
816 tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
818 vnet_listen_args_t _bargs, *args = &_bargs;
819 transport_endpt_crypto_cfg_t *ccfg;
820 app_worker_t *app_wrk;
821 tls_main_t *tm = &tls_main;
822 session_handle_t tls_al_handle;
823 session_endpoint_cfg_t *sep;
824 session_t *tls_listener;
825 session_t *app_listener;
826 crypto_engine_type_t engine_type;
833 sep = (session_endpoint_cfg_t *) tep;
835 return SESSION_E_NOEXTCFG;
837 app_wrk = app_worker_get (sep->app_wrk_index);
838 app = application_get (app_wrk->app_index);
840 ccfg = &sep->ext_cfg->crypto;
841 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
842 if (engine_type == CRYPTO_ENGINE_NONE)
844 clib_warning ("No tls engine_type available");
845 return SESSION_E_NOCRYPTOENG;
848 clib_memset (args, 0, sizeof (*args));
849 args->app_index = tm->app_index;
850 args->sep_ext = *sep;
851 args->sep_ext.ns_index = app->ns_index;
852 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
853 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
855 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
856 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
858 if ((rv = vnet_listen (args)))
861 lctx_index = tls_listener_ctx_alloc ();
862 tls_al_handle = args->handle;
863 al = app_listener_get_w_handle (tls_al_handle);
864 tls_listener = app_listener_get_session (al);
865 tls_listener->opaque = lctx_index;
867 app_listener = listen_session_get (app_listener_index);
869 lctx = tls_listener_ctx_get (lctx_index);
870 lctx->parent_app_wrk_index = sep->app_wrk_index;
871 lctx->tls_session_handle = tls_al_handle;
872 lctx->app_session_handle = listen_session_get_handle (app_listener);
873 lctx->tcp_is_ip4 = sep->is_ip4;
874 lctx->tls_ctx_engine = engine_type;
875 lctx->tls_type = sep->transport_proto;
876 lctx->ckpair_index = ccfg->ckpair_index;
877 lctx->c_s_index = app_listener_index;
878 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
880 if (tls_vfts[engine_type].ctx_start_listen (lctx))
882 vnet_unlisten_args_t a = {
883 .handle = lctx->tls_session_handle,
884 .app_index = tls_main.app_index,
887 if ((vnet_unlisten (&a)))
888 clib_warning ("unlisten returned");
889 tls_listener_ctx_free (lctx);
890 lctx_index = SESSION_INVALID_INDEX;
893 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
899 tls_stop_listen (u32 lctx_index)
901 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
902 crypto_engine_type_t engine_type;
903 transport_connection_t *lc;
908 lctx = tls_listener_ctx_get (lctx_index);
910 /* Cleanup listener from session lookup table */
911 ls = session_get_from_handle (lctx->tls_session_handle);
912 lc = session_get_transport (ls);
914 sep.fib_index = lc->fib_index;
915 sep.port = lc->lcl_port;
916 sep.is_ip4 = lc->is_ip4;
917 sep.transport_proto = lctx->tls_type;
918 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
919 session_lookup_del_session_endpoint2 (&sep);
921 vnet_unlisten_args_t a = {
922 .handle = lctx->tls_session_handle,
923 .app_index = tls_main.app_index,
924 .wrk_map_index = 0 /* default wrk */
926 if ((rv = vnet_unlisten (&a)))
927 clib_warning ("unlisten returned %d", rv);
929 engine_type = lctx->tls_ctx_engine;
930 tls_vfts[engine_type].ctx_stop_listen (lctx);
932 tls_listener_ctx_free (lctx);
936 transport_connection_t *
937 tls_connection_get (u32 ctx_index, u32 thread_index)
940 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
941 return &ctx->connection;
944 transport_connection_t *
945 tls_listener_get (u32 listener_index)
948 ctx = tls_listener_ctx_get (listener_index);
949 return &ctx->connection;
952 static transport_connection_t *
953 tls_half_open_get (u32 ho_index)
956 ctx = tls_ctx_half_open_get (ho_index);
957 return &ctx->connection;
961 tls_cleanup_ho (u32 ho_index)
966 ctx = tls_ctx_half_open_get (ho_index);
967 /* Already pending cleanup */
968 if (ctx->tls_session_handle == SESSION_INVALID_HANDLE)
970 ASSERT (ctx->flags & TLS_CONN_F_HO_DONE);
971 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
975 s = session_get_from_handle (ctx->tls_session_handle);
976 /* If no pending cleanup notification, force cleanup now. Otherwise,
977 * wait for cleanup notification and set no app session on ctx */
978 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
980 session_cleanup_half_open (ctx->tls_session_handle);
981 tls_ctx_half_open_free (ho_index);
984 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
988 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
990 session_t *as = (session_t *) session;
993 if (PREDICT_FALSE (as->session_state >= SESSION_STATE_TRANSPORT_CLOSED ||
994 as->session_state <= SESSION_STATE_ACCEPTING))
996 sp->flags |= TRANSPORT_SND_F_DESCHED;
1000 ctx = tls_ctx_get (as->connection_index);
1001 return tls_ctx_write (ctx, as, sp);
1005 format_tls_ctx (u8 * s, va_list * args)
1007 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
1008 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
1011 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
1012 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
1013 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
1015 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
1016 ctx->c_thread_index, ctx->c_s_index, proto,
1017 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
1023 format_tls_listener_ctx (u8 * s, va_list * args)
1025 session_t *tls_listener;
1030 ctx = va_arg (*args, tls_ctx_t *);
1032 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
1033 al = app_listener_get_w_handle (ctx->tls_session_handle);
1034 tls_listener = app_listener_get_session (al);
1035 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
1036 ctx->c_thread_index, ctx->c_s_index, proto,
1037 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
1038 tls_listener->thread_index, tls_listener->session_index);
1044 format_tls_ctx_state (u8 * s, va_list * args)
1049 ctx = va_arg (*args, tls_ctx_t *);
1050 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
1051 if (ts->session_state == SESSION_STATE_LISTENING)
1052 s = format (s, "%s", "LISTEN");
1055 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1056 s = format (s, "%s", "CLOSED");
1057 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1058 s = format (s, "%s", "APP-CLOSED");
1059 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1060 s = format (s, "%s", "CLOSING");
1061 else if (tls_ctx_handshake_is_over (ctx))
1062 s = format (s, "%s", "ESTABLISHED");
1064 s = format (s, "%s", "HANDSHAKE");
1071 format_tls_connection (u8 * s, va_list * args)
1073 u32 ctx_index = va_arg (*args, u32);
1074 u32 thread_index = va_arg (*args, u32);
1075 u32 verbose = va_arg (*args, u32);
1078 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1082 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1085 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1088 s = format (s, "\n");
1094 format_tls_listener (u8 * s, va_list * args)
1096 u32 tc_index = va_arg (*args, u32);
1097 u32 __clib_unused thread_index = va_arg (*args, u32);
1098 u32 verbose = va_arg (*args, u32);
1099 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1101 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1103 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1108 format_tls_half_open (u8 * s, va_list * args)
1110 u32 ho_index = va_arg (*args, u32);
1111 u32 __clib_unused thread_index = va_arg (*args, u32);
1112 u32 __clib_unused verbose = va_arg (*args, u32);
1116 ho_ctx = tls_ctx_half_open_get (ho_index);
1118 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1119 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1120 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1121 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1122 tcp_ho->thread_index, tcp_ho->session_index);
1128 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1129 transport_endpoint_t * tep, u8 is_lcl)
1131 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1134 ts = session_get_from_handle (ctx->tls_session_handle);
1135 if (ts && ts->session_state < SESSION_STATE_TRANSPORT_DELETED)
1136 session_get_endpoint (ts, tep, is_lcl);
1140 tls_transport_listener_endpoint_get (u32 ctx_handle,
1141 transport_endpoint_t * tep, u8 is_lcl)
1143 session_t *tls_listener;
1145 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1147 al = app_listener_get_w_handle (ctx->tls_session_handle);
1148 tls_listener = app_listener_get_session (al);
1149 session_get_endpoint (tls_listener, tep, is_lcl);
1152 static clib_error_t *
1153 tls_enable (vlib_main_t * vm, u8 is_en)
1155 vnet_app_detach_args_t _da, *da = &_da;
1156 vnet_app_attach_args_t _a, *a = &_a;
1157 u64 options[APP_OPTIONS_N_OPTIONS];
1158 tls_main_t *tm = &tls_main;
1159 u32 fifo_size = 512 << 10;
1163 da->app_index = tm->app_index;
1164 da->api_client_index = APP_INVALID_INDEX;
1165 vnet_application_detach (da);
1169 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1171 clib_memset (a, 0, sizeof (*a));
1172 clib_memset (options, 0, sizeof (options));
1174 a->session_cb_vft = &tls_app_cb_vft;
1175 a->api_client_index = APP_INVALID_INDEX;
1176 a->options = options;
1177 a->name = format (0, "tls");
1178 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1179 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
1180 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1181 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1182 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1183 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1184 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1186 if (vnet_application_attach (a))
1188 clib_warning ("failed to attach tls app");
1189 return clib_error_return (0, "failed to attach tls app");
1192 tm->app_index = a->app_index;
1198 static const transport_proto_vft_t tls_proto = {
1199 .enable = tls_enable,
1200 .connect = tls_connect,
1201 .close = tls_disconnect,
1202 .start_listen = tls_start_listen,
1203 .stop_listen = tls_stop_listen,
1204 .get_connection = tls_connection_get,
1205 .get_listener = tls_listener_get,
1206 .get_half_open = tls_half_open_get,
1207 .cleanup_ho = tls_cleanup_ho,
1208 .custom_tx = tls_custom_tx_callback,
1209 .format_connection = format_tls_connection,
1210 .format_half_open = format_tls_half_open,
1211 .format_listener = format_tls_listener,
1212 .get_transport_endpoint = tls_transport_endpoint_get,
1213 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1214 .transport_options = {
1217 .tx_type = TRANSPORT_TX_INTERNAL,
1218 .service_type = TRANSPORT_SERVICE_VC,
1223 dtls_connect (transport_endpoint_cfg_t *tep)
1225 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1226 transport_endpt_crypto_cfg_t *ccfg;
1227 crypto_engine_type_t engine_type;
1228 session_endpoint_cfg_t *sep;
1229 tls_main_t *tm = &tls_main;
1230 app_worker_t *app_wrk;
1236 sep = (session_endpoint_cfg_t *) tep;
1240 app_wrk = app_worker_get (sep->app_wrk_index);
1241 app = application_get (app_wrk->app_index);
1243 ccfg = &sep->ext_cfg->crypto;
1244 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1245 if (engine_type == CRYPTO_ENGINE_NONE)
1247 clib_warning ("No tls engine_type available");
1251 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1252 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1253 ctx->parent_app_wrk_index = sep->app_wrk_index;
1254 ctx->parent_app_api_context = sep->opaque;
1255 ctx->tcp_is_ip4 = sep->is_ip4;
1256 ctx->ckpair_index = ccfg->ckpair_index;
1257 ctx->tls_type = sep->transport_proto;
1258 ctx->tls_ctx_handle = ctx_handle;
1259 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1260 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1261 if (ccfg->hostname[0])
1263 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1264 vec_terminate_c_string (ctx->srv_hostname);
1267 ctx->tls_ctx_engine = engine_type;
1269 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1270 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1271 cargs->app_index = tm->app_index;
1272 cargs->api_context = ctx_handle;
1273 cargs->sep_ext.ns_index = app->ns_index;
1274 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1275 if ((rv = vnet_connect (cargs)))
1278 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1283 static transport_connection_t *
1284 dtls_half_open_get (u32 ho_index)
1287 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1288 return &ho_ctx->connection;
1292 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1298 dtls_cleanup_ho (u32 ho_index)
1301 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1306 format_dtls_half_open (u8 *s, va_list *args)
1308 u32 ho_index = va_arg (*args, u32);
1309 u32 __clib_unused thread_index = va_arg (*args, u32);
1313 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1315 us = session_get_from_handle (ho_ctx->tls_session_handle);
1316 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1317 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1318 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1319 us->thread_index, us->session_index);
1324 static const transport_proto_vft_t dtls_proto = {
1326 .connect = dtls_connect,
1327 .close = tls_disconnect,
1328 .start_listen = tls_start_listen,
1329 .stop_listen = tls_stop_listen,
1330 .get_connection = tls_connection_get,
1331 .get_listener = tls_listener_get,
1332 .get_half_open = dtls_half_open_get,
1333 .custom_tx = tls_custom_tx_callback,
1334 .cleanup = dtls_cleanup_callback,
1335 .cleanup_ho = dtls_cleanup_ho,
1336 .format_connection = format_tls_connection,
1337 .format_half_open = format_dtls_half_open,
1338 .format_listener = format_tls_listener,
1339 .get_transport_endpoint = tls_transport_endpoint_get,
1340 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1341 .transport_options = {
1344 .tx_type = TRANSPORT_TX_INTERNAL,
1345 .service_type = TRANSPORT_SERVICE_VC,
1350 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1352 vec_validate (tls_vfts, type);
1353 tls_vfts[type] = *vft;
1356 static clib_error_t *
1357 tls_init (vlib_main_t * vm)
1359 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1360 tls_main_t *tm = &tls_main;
1363 num_threads = 1 /* main thread */ + vtm->n_threads;
1365 if (!tm->ca_cert_path)
1366 tm->ca_cert_path = TLS_CA_CERT_PATH;
1368 vec_validate (tm->rx_bufs, num_threads - 1);
1369 vec_validate (tm->tx_bufs, num_threads - 1);
1371 tm->first_seg_size = 32 << 20;
1372 tm->add_seg_size = 256 << 20;
1374 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1375 FIB_PROTOCOL_IP4, ~0);
1376 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1377 FIB_PROTOCOL_IP6, ~0);
1379 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1380 FIB_PROTOCOL_IP4, ~0);
1381 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1382 FIB_PROTOCOL_IP6, ~0);
1386 VLIB_INIT_FUNCTION (tls_init);
1388 static clib_error_t *
1389 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1391 tls_main_t *tm = &tls_main;
1393 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1395 if (unformat (input, "use-test-cert-in-ca"))
1396 tm->use_test_cert_in_ca = 1;
1397 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1399 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1400 &tm->first_seg_size))
1402 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1405 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1407 if (tmp >= 0x100000000ULL)
1409 return clib_error_return
1410 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1412 tm->fifo_size = tmp;
1415 return clib_error_return (0, "unknown input `%U'",
1416 format_unformat_error, input);
1421 VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
1424 vnet_tls_get_main (void)
1430 * fd.io coding-style-patch-verification: ON
1433 * eval: (c-set-style "gnu")