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->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_get (ctx->c_s_index, ctx->c_thread_index);
209 app_session->app_wrk_index = ctx->parent_app_wrk_index;
210 app_session->connection_index = ctx->tls_ctx_handle;
211 app_session->session_type = app_listener->session_type;
212 app_session->listener_handle = listen_session_get_handle (app_listener);
213 app_session->session_state = SESSION_STATE_ACCEPTING;
215 if ((rv = app_worker_init_accepted (app_session)))
217 TLS_DBG (1, "failed to allocate fifos");
218 session_free (app_session);
221 ctx->app_session_handle = session_handle (app_session);
222 ctx->parent_app_wrk_index = app_session->app_wrk_index;
223 app_wrk = app_worker_get (app_session->app_wrk_index);
224 return app_worker_accept_notify (app_wrk, app_session);
228 tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
230 u32 parent_app_api_ctx;
231 session_t *app_session;
232 app_worker_t *app_wrk;
234 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
237 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
238 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
239 ctx->no_app_session = 1;
245 /* Free app session pre-allocated when transport was established */
246 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
247 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
248 ctx->no_app_session = 1;
252 /* For DTLS the app session is not preallocated because the underlying udp
253 * session might migrate to a different worker during the handshake */
254 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
257 /* Cleanup half-open session as we don't get notification from udp */
258 session_half_open_delete_notify (&ctx->connection);
259 app_session = session_alloc (ctx->c_thread_index);
260 app_session->session_state = SESSION_STATE_CREATED;
261 ctx->c_s_index = app_session->session_index;
263 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
264 app_session->session_type = st;
265 app_session->connection_index = ctx->tls_ctx_handle;
269 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
272 app_session->app_wrk_index = ctx->parent_app_wrk_index;
273 app_session->opaque = ctx->parent_app_api_context;
275 if ((err = app_worker_init_connected (app_wrk, app_session)))
277 app_worker_connect_notify (app_wrk, 0, err, ctx->parent_app_api_context);
278 ctx->no_app_session = 1;
279 session_free (app_session);
283 app_session->session_state = SESSION_STATE_READY;
284 parent_app_api_ctx = ctx->parent_app_api_context;
285 ctx->app_session_handle = session_handle (app_session);
287 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
290 TLS_DBG (1, "failed to notify app");
291 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
292 ctx->no_app_session = 1;
299 return app_worker_connect_notify (app_wrk, 0, err,
300 ctx->parent_app_api_context);
304 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
306 *ctx_index = ctx_handle & TLS_IDX_MASK;
307 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
310 static inline crypto_engine_type_t
311 tls_get_engine_type (crypto_engine_type_t requested,
312 crypto_engine_type_t preferred)
314 if (requested != CRYPTO_ENGINE_NONE)
316 if (tls_vfts[requested].ctx_alloc)
318 return CRYPTO_ENGINE_NONE;
320 if (!tls_vfts[preferred].ctx_alloc)
321 return tls_get_available_engine ();
326 tls_ctx_alloc (crypto_engine_type_t engine_type)
329 ctx_index = tls_vfts[engine_type].ctx_alloc ();
330 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
334 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
337 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
338 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
342 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
345 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
346 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
350 tls_ctx_detach (tls_ctx_t *ctx)
352 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
355 static inline tls_ctx_t *
356 tls_ctx_get (u32 ctx_handle)
358 u32 ctx_index, engine_type;
359 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
360 return tls_vfts[engine_type].ctx_get (ctx_index);
363 static inline tls_ctx_t *
364 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
366 u32 ctx_index, engine_type;
367 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
368 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
372 tls_ctx_init_server (tls_ctx_t * ctx)
374 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
378 tls_ctx_init_client (tls_ctx_t * ctx)
380 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
384 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
385 transport_send_params_t * sp)
389 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
390 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
391 sp->bytes_dequeued = n_wrote;
392 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
396 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
398 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
402 tls_ctx_transport_close (tls_ctx_t * ctx)
404 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
408 tls_ctx_app_close (tls_ctx_t * ctx)
410 return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
414 tls_ctx_free (tls_ctx_t * ctx)
416 tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
420 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
422 return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
426 tls_reinit_ca_chain (crypto_engine_type_t tls_engine_id)
428 return tls_vfts[tls_engine_id].ctx_reinit_cachain ();
432 tls_notify_app_io_error (tls_ctx_t *ctx)
434 ASSERT (tls_ctx_handshake_is_over (ctx));
436 session_transport_reset_notify (&ctx->connection);
437 session_transport_closed_notify (&ctx->connection);
438 tls_disconnect_transport (ctx);
442 tls_session_reset_callback (session_t * s)
445 transport_connection_t *tc;
446 session_t *app_session;
448 ctx = tls_ctx_get (s->opaque);
449 ctx->is_passive_close = 1;
450 tc = &ctx->connection;
451 if (tls_ctx_handshake_is_over (ctx))
453 session_transport_reset_notify (tc);
454 session_transport_closed_notify (tc);
455 tls_disconnect_transport (ctx);
459 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
461 session_free (app_session);
462 ctx->c_s_index = SESSION_INVALID_INDEX;
463 tls_disconnect_transport (ctx);
468 tls_session_cleanup_ho (session_t *s)
470 /* session opaque stores the opaque passed on connect */
471 tls_ctx_ho_try_free (s->opaque);
475 tls_add_segment_callback (u32 client_index, u64 segment_handle)
477 /* No-op for builtin */
482 tls_del_segment_callback (u32 client_index, u64 segment_handle)
488 tls_session_disconnect_callback (session_t * tls_session)
492 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
493 tls_session->session_index);
495 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
496 || vlib_thread_is_main_w_barrier ());
498 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
499 ctx->is_passive_close = 1;
500 tls_ctx_transport_close (ctx);
504 tls_session_accept_callback (session_t * tls_session)
506 session_t *tls_listener, *app_session;
507 tls_ctx_t *lctx, *ctx;
511 listen_session_get_from_handle (tls_session->listener_handle);
512 lctx = tls_listener_ctx_get (tls_listener->opaque);
514 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
515 ctx = tls_ctx_get (ctx_handle);
516 memcpy (ctx, lctx, sizeof (*lctx));
517 ctx->c_thread_index = vlib_get_thread_index ();
518 ctx->tls_ctx_handle = ctx_handle;
519 tls_session->session_state = SESSION_STATE_READY;
520 tls_session->opaque = ctx_handle;
521 ctx->tls_session_handle = session_handle (tls_session);
522 ctx->listener_ctx_index = tls_listener->opaque;
523 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
524 ctx->ckpair_index = lctx->ckpair_index;
526 /* Preallocate app session. Avoids allocating a session post handshake
527 * on tls_session rx and potentially invalidating the session pool */
528 app_session = session_alloc (ctx->c_thread_index);
529 app_session->session_state = SESSION_STATE_CREATED;
530 app_session->session_type =
531 session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
532 app_session->connection_index = ctx->tls_ctx_handle;
533 ctx->c_s_index = app_session->session_index;
535 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
536 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
538 if (tls_ctx_init_server (ctx))
540 /* Do not free ctx yet, in case we have pending rx events */
541 session_free (app_session);
542 ctx->no_app_session = 1;
543 tls_disconnect_transport (ctx);
550 tls_app_rx_callback (session_t *ts)
554 /* DTLS session migrating, wait for next notification */
555 if (PREDICT_FALSE (ts->flags & SESSION_F_IS_MIGRATING))
558 /* Read rescheduled but underlying transport deleted now */
559 if (PREDICT_FALSE ((ts->session_state == SESSION_STATE_TRANSPORT_DELETED)))
562 ctx = tls_ctx_get (ts->opaque);
563 if (PREDICT_FALSE (ctx->no_app_session || ctx->app_closed))
565 TLS_DBG (1, "Local App closed");
568 tls_ctx_read (ctx, ts);
573 tls_app_tx_callback (session_t * tls_session)
577 ctx = tls_ctx_get (tls_session->opaque);
578 transport_connection_reschedule (&ctx->connection);
584 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
585 session_t *tls_session, session_error_t err)
587 session_t *app_session;
588 tls_ctx_t *ho_ctx, *ctx;
592 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
593 ho_ctx->flags |= TLS_CONN_F_HO_DONE;
595 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
596 ctx = tls_ctx_get (ctx_handle);
597 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
598 /* Half-open freed on tcp half-open cleanup notification */
600 ctx->c_thread_index = vlib_get_thread_index ();
601 ctx->tls_ctx_handle = ctx_handle;
602 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
604 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
605 ho_ctx_index, err, vlib_get_thread_index (),
606 (ctx) ? ctx_handle : ~0);
608 ctx->tls_session_handle = session_handle (tls_session);
609 tls_session->opaque = ctx_handle;
610 tls_session->session_state = SESSION_STATE_READY;
612 /* Preallocate app session. Avoids allocating a session post handshake
613 * on tls_session rx and potentially invalidating the session pool */
614 app_session = session_alloc (ctx->c_thread_index);
615 app_session->session_state = SESSION_STATE_CREATED;
616 ctx->c_s_index = app_session->session_index;
617 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
618 app_session->session_type = st;
619 app_session->connection_index = ctx->tls_ctx_handle;
621 if (tls_ctx_init_client (ctx))
623 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
624 tls_disconnect_transport (ctx);
631 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
636 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
638 ctx->tls_session_handle = session_handle (us);
639 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
640 us->opaque = ctx_handle;
642 /* We don't preallocate the app session because the udp session might
643 * actually migrate to a different worker at the end of the handshake */
645 return tls_ctx_init_client (ctx);
649 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
650 session_t *tls_session, session_error_t err)
654 app_worker_t *app_wrk;
658 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
659 ho_ctx->flags |= TLS_CONN_F_HO_DONE;
660 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
663 api_context = ho_ctx->parent_app_api_context;
664 app_worker_connect_notify (app_wrk, 0, err, api_context);
670 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
671 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
674 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
679 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
683 if (ntf == SESSION_CLEANUP_TRANSPORT)
685 /* Allow cleanup of tcp session */
686 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
691 ctx = tls_ctx_get (s->opaque);
692 if (!ctx->no_app_session)
693 session_transport_delete_notify (&ctx->connection);
698 dtls_migrate_ctx (void *arg)
700 tls_ctx_t *ctx = (tls_ctx_t *) arg;
701 u32 ctx_handle, thread_index;
704 thread_index = session_thread_from_handle (ctx->tls_session_handle);
705 ASSERT (thread_index == vlib_get_thread_index ());
707 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
708 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
709 ctx->tls_ctx_handle = ctx_handle;
711 us = session_get_from_handle (ctx->tls_session_handle);
712 us->opaque = ctx_handle;
713 us->flags &= ~SESSION_F_IS_MIGRATING;
715 /* Probably the app detached while the session was migrating. Cleanup */
716 if (session_half_open_migrated_notify (&ctx->connection))
718 ctx->no_app_session = 1;
719 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
723 if (svm_fifo_max_dequeue (us->tx_fifo))
724 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
728 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
730 u32 new_thread = session_thread_from_handle (new_sh);
731 tls_ctx_t *ctx, *cloned_ctx;
733 /* Migrate dtls context to new thread */
734 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
735 ctx->tls_session_handle = new_sh;
736 cloned_ctx = tls_ctx_detach (ctx);
737 ctx->is_migrated = 1;
738 session_half_open_migrate_notify (&ctx->connection);
740 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
741 (void *) cloned_ctx);
747 tls_session_transport_closed_callback (session_t *ts)
751 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
752 session_transport_closed_notify (&ctx->connection);
755 static session_cb_vft_t tls_app_cb_vft = {
756 .session_accept_callback = tls_session_accept_callback,
757 .session_disconnect_callback = tls_session_disconnect_callback,
758 .session_connected_callback = tls_session_connected_callback,
759 .session_reset_callback = tls_session_reset_callback,
760 .session_transport_closed_callback = tls_session_transport_closed_callback,
761 .half_open_cleanup_callback = tls_session_cleanup_ho,
762 .add_segment_callback = tls_add_segment_callback,
763 .del_segment_callback = tls_del_segment_callback,
764 .builtin_app_rx_callback = tls_app_rx_callback,
765 .builtin_app_tx_callback = tls_app_tx_callback,
766 .session_migrate_callback = dtls_session_migrate_callback,
767 .session_cleanup_callback = tls_app_session_cleanup,
771 tls_connect (transport_endpoint_cfg_t * tep)
773 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
774 transport_endpt_crypto_cfg_t *ccfg;
775 crypto_engine_type_t engine_type;
776 session_endpoint_cfg_t *sep;
777 tls_main_t *tm = &tls_main;
778 app_worker_t *app_wrk;
784 sep = (session_endpoint_cfg_t *) tep;
786 return SESSION_E_NOEXTCFG;
788 app_wrk = app_worker_get (sep->app_wrk_index);
789 app = application_get (app_wrk->app_index);
791 ccfg = &sep->ext_cfg->crypto;
792 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
793 if (engine_type == CRYPTO_ENGINE_NONE)
795 clib_warning ("No tls engine_type available");
796 return SESSION_E_NOCRYPTOENG;
799 ctx_index = tls_ctx_half_open_alloc ();
800 ctx = tls_ctx_half_open_get (ctx_index);
801 ctx->parent_app_wrk_index = sep->app_wrk_index;
802 ctx->parent_app_api_context = sep->opaque;
803 ctx->tcp_is_ip4 = sep->is_ip4;
804 ctx->tls_type = sep->transport_proto;
805 ctx->ckpair_index = ccfg->ckpair_index;
806 ctx->c_proto = TRANSPORT_PROTO_TLS;
807 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
808 if (ccfg->hostname[0])
810 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
811 vec_terminate_c_string (ctx->srv_hostname);
814 ctx->tls_ctx_engine = engine_type;
816 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
817 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
818 cargs->app_index = tm->app_index;
819 cargs->api_context = ctx_index;
820 cargs->sep_ext.ns_index = app->ns_index;
821 if ((rv = vnet_connect (cargs)))
824 /* Track half-open tcp session in case we need to clean it up */
825 ctx->tls_session_handle = cargs->sh;
827 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
832 tls_disconnect (u32 ctx_handle, u32 thread_index)
836 TLS_DBG (1, "Disconnecting %x", ctx_handle);
838 ctx = tls_ctx_get (ctx_handle);
839 tls_ctx_app_close (ctx);
843 tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
845 vnet_listen_args_t _bargs, *args = &_bargs;
846 transport_endpt_crypto_cfg_t *ccfg;
847 app_worker_t *app_wrk;
848 tls_main_t *tm = &tls_main;
849 session_handle_t tls_al_handle;
850 session_endpoint_cfg_t *sep;
851 session_t *tls_listener;
852 session_t *app_listener;
853 crypto_engine_type_t engine_type;
860 sep = (session_endpoint_cfg_t *) tep;
862 return SESSION_E_NOEXTCFG;
864 app_wrk = app_worker_get (sep->app_wrk_index);
865 app = application_get (app_wrk->app_index);
867 ccfg = &sep->ext_cfg->crypto;
868 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
869 if (engine_type == CRYPTO_ENGINE_NONE)
871 clib_warning ("No tls engine_type available");
872 return SESSION_E_NOCRYPTOENG;
875 clib_memset (args, 0, sizeof (*args));
876 args->app_index = tm->app_index;
877 args->sep_ext = *sep;
878 args->sep_ext.ns_index = app->ns_index;
879 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
880 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
882 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
883 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
885 if ((rv = vnet_listen (args)))
888 lctx_index = tls_listener_ctx_alloc ();
889 tls_al_handle = args->handle;
890 al = app_listener_get_w_handle (tls_al_handle);
891 tls_listener = app_listener_get_session (al);
892 tls_listener->opaque = lctx_index;
894 app_listener = listen_session_get (app_listener_index);
896 lctx = tls_listener_ctx_get (lctx_index);
897 lctx->parent_app_wrk_index = sep->app_wrk_index;
898 lctx->tls_session_handle = tls_al_handle;
899 lctx->app_session_handle = listen_session_get_handle (app_listener);
900 lctx->tcp_is_ip4 = sep->is_ip4;
901 lctx->tls_ctx_engine = engine_type;
902 lctx->tls_type = sep->transport_proto;
903 lctx->ckpair_index = ccfg->ckpair_index;
904 lctx->c_s_index = app_listener_index;
905 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
907 if (tls_vfts[engine_type].ctx_start_listen (lctx))
909 vnet_unlisten_args_t a = {
910 .handle = lctx->tls_session_handle,
911 .app_index = tls_main.app_index,
914 if ((vnet_unlisten (&a)))
915 clib_warning ("unlisten returned");
916 tls_listener_ctx_free (lctx);
917 lctx_index = SESSION_INVALID_INDEX;
920 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
926 tls_stop_listen (u32 lctx_index)
928 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
929 crypto_engine_type_t engine_type;
930 transport_connection_t *lc;
935 lctx = tls_listener_ctx_get (lctx_index);
937 /* Cleanup listener from session lookup table */
938 ls = session_get_from_handle (lctx->tls_session_handle);
939 lc = session_get_transport (ls);
941 sep.fib_index = lc->fib_index;
942 sep.port = lc->lcl_port;
943 sep.is_ip4 = lc->is_ip4;
944 sep.transport_proto = lctx->tls_type;
945 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
946 session_lookup_del_session_endpoint2 (&sep);
948 vnet_unlisten_args_t a = {
949 .handle = lctx->tls_session_handle,
950 .app_index = tls_main.app_index,
951 .wrk_map_index = 0 /* default wrk */
953 if ((rv = vnet_unlisten (&a)))
954 clib_warning ("unlisten returned %d", rv);
956 engine_type = lctx->tls_ctx_engine;
957 tls_vfts[engine_type].ctx_stop_listen (lctx);
959 tls_listener_ctx_free (lctx);
963 transport_connection_t *
964 tls_connection_get (u32 ctx_index, u32 thread_index)
967 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
968 return &ctx->connection;
971 transport_connection_t *
972 tls_listener_get (u32 listener_index)
975 ctx = tls_listener_ctx_get (listener_index);
976 return &ctx->connection;
979 static transport_connection_t *
980 tls_half_open_get (u32 ho_index)
983 ctx = tls_ctx_half_open_get (ho_index);
984 return &ctx->connection;
988 tls_cleanup_ho (u32 ho_index)
993 ctx = tls_ctx_half_open_get (ho_index);
994 /* Already pending cleanup */
995 if (ctx->tls_session_handle == SESSION_INVALID_HANDLE)
997 ASSERT (ctx->flags & TLS_CONN_F_HO_DONE);
998 ctx->no_app_session = 1;
1002 s = session_get_from_handle (ctx->tls_session_handle);
1003 /* If no pending cleanup notification, force cleanup now. Otherwise,
1004 * wait for cleanup notification and set no app session on ctx */
1005 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1007 session_cleanup_half_open (ctx->tls_session_handle);
1008 tls_ctx_half_open_free (ho_index);
1011 ctx->no_app_session = 1;
1015 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
1017 session_t *as = (session_t *) session;
1020 if (PREDICT_FALSE (as->session_state >= SESSION_STATE_TRANSPORT_CLOSED ||
1021 as->session_state <= SESSION_STATE_ACCEPTING))
1023 sp->flags |= TRANSPORT_SND_F_DESCHED;
1027 ctx = tls_ctx_get (as->connection_index);
1028 return tls_ctx_write (ctx, as, sp);
1032 format_tls_ctx (u8 * s, va_list * args)
1034 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
1035 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
1038 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
1039 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
1040 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
1042 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
1043 ctx->c_thread_index, ctx->c_s_index, proto,
1044 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
1050 format_tls_listener_ctx (u8 * s, va_list * args)
1052 session_t *tls_listener;
1057 ctx = va_arg (*args, tls_ctx_t *);
1059 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
1060 al = app_listener_get_w_handle (ctx->tls_session_handle);
1061 tls_listener = app_listener_get_session (al);
1062 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
1063 ctx->c_thread_index, ctx->c_s_index, proto,
1064 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
1065 tls_listener->thread_index, tls_listener->session_index);
1071 format_tls_ctx_state (u8 * s, va_list * args)
1076 ctx = va_arg (*args, tls_ctx_t *);
1077 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
1078 if (ts->session_state == SESSION_STATE_LISTENING)
1079 s = format (s, "%s", "LISTEN");
1082 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1083 s = format (s, "%s", "CLOSED");
1084 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1085 s = format (s, "%s", "APP-CLOSED");
1086 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1087 s = format (s, "%s", "CLOSING");
1088 else if (tls_ctx_handshake_is_over (ctx))
1089 s = format (s, "%s", "ESTABLISHED");
1091 s = format (s, "%s", "HANDSHAKE");
1098 format_tls_connection (u8 * s, va_list * args)
1100 u32 ctx_index = va_arg (*args, u32);
1101 u32 thread_index = va_arg (*args, u32);
1102 u32 verbose = va_arg (*args, u32);
1105 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1109 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1112 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1115 s = format (s, "\n");
1121 format_tls_listener (u8 * s, va_list * args)
1123 u32 tc_index = va_arg (*args, u32);
1124 u32 __clib_unused thread_index = va_arg (*args, u32);
1125 u32 verbose = va_arg (*args, u32);
1126 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1128 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1130 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1135 format_tls_half_open (u8 * s, va_list * args)
1137 u32 ho_index = va_arg (*args, u32);
1138 u32 __clib_unused thread_index = va_arg (*args, u32);
1139 u32 __clib_unused verbose = va_arg (*args, u32);
1143 ho_ctx = tls_ctx_half_open_get (ho_index);
1145 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1146 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1147 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1148 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1149 tcp_ho->thread_index, tcp_ho->session_index);
1155 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1156 transport_endpoint_t * tep, u8 is_lcl)
1158 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1159 session_t *tcp_session;
1161 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1162 session_get_endpoint (tcp_session, tep, is_lcl);
1166 tls_transport_listener_endpoint_get (u32 ctx_handle,
1167 transport_endpoint_t * tep, u8 is_lcl)
1169 session_t *tls_listener;
1171 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1173 al = app_listener_get_w_handle (ctx->tls_session_handle);
1174 tls_listener = app_listener_get_session (al);
1175 session_get_endpoint (tls_listener, tep, is_lcl);
1178 static clib_error_t *
1179 tls_enable (vlib_main_t * vm, u8 is_en)
1181 vnet_app_detach_args_t _da, *da = &_da;
1182 vnet_app_attach_args_t _a, *a = &_a;
1183 u64 options[APP_OPTIONS_N_OPTIONS];
1184 tls_main_t *tm = &tls_main;
1185 u32 fifo_size = 512 << 10;
1189 da->app_index = tm->app_index;
1190 da->api_client_index = APP_INVALID_INDEX;
1191 vnet_application_detach (da);
1195 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1197 clib_memset (a, 0, sizeof (*a));
1198 clib_memset (options, 0, sizeof (options));
1200 a->session_cb_vft = &tls_app_cb_vft;
1201 a->api_client_index = APP_INVALID_INDEX;
1202 a->options = options;
1203 a->name = format (0, "tls");
1204 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1205 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
1206 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1207 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1208 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1209 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1210 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1212 if (vnet_application_attach (a))
1214 clib_warning ("failed to attach tls app");
1215 return clib_error_return (0, "failed to attach tls app");
1218 tm->app_index = a->app_index;
1224 static const transport_proto_vft_t tls_proto = {
1225 .enable = tls_enable,
1226 .connect = tls_connect,
1227 .close = tls_disconnect,
1228 .start_listen = tls_start_listen,
1229 .stop_listen = tls_stop_listen,
1230 .get_connection = tls_connection_get,
1231 .get_listener = tls_listener_get,
1232 .get_half_open = tls_half_open_get,
1233 .cleanup_ho = tls_cleanup_ho,
1234 .custom_tx = tls_custom_tx_callback,
1235 .format_connection = format_tls_connection,
1236 .format_half_open = format_tls_half_open,
1237 .format_listener = format_tls_listener,
1238 .get_transport_endpoint = tls_transport_endpoint_get,
1239 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1240 .transport_options = {
1243 .tx_type = TRANSPORT_TX_INTERNAL,
1244 .service_type = TRANSPORT_SERVICE_VC,
1249 dtls_connect (transport_endpoint_cfg_t *tep)
1251 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1252 transport_endpt_crypto_cfg_t *ccfg;
1253 crypto_engine_type_t engine_type;
1254 session_endpoint_cfg_t *sep;
1255 tls_main_t *tm = &tls_main;
1256 app_worker_t *app_wrk;
1262 sep = (session_endpoint_cfg_t *) tep;
1266 app_wrk = app_worker_get (sep->app_wrk_index);
1267 app = application_get (app_wrk->app_index);
1269 ccfg = &sep->ext_cfg->crypto;
1270 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1271 if (engine_type == CRYPTO_ENGINE_NONE)
1273 clib_warning ("No tls engine_type available");
1277 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1278 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1279 ctx->parent_app_wrk_index = sep->app_wrk_index;
1280 ctx->parent_app_api_context = sep->opaque;
1281 ctx->tcp_is_ip4 = sep->is_ip4;
1282 ctx->ckpair_index = ccfg->ckpair_index;
1283 ctx->tls_type = sep->transport_proto;
1284 ctx->tls_ctx_handle = ctx_handle;
1285 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1286 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1287 if (ccfg->hostname[0])
1289 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1290 vec_terminate_c_string (ctx->srv_hostname);
1293 ctx->tls_ctx_engine = engine_type;
1295 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1296 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1297 cargs->app_index = tm->app_index;
1298 cargs->api_context = ctx_handle;
1299 cargs->sep_ext.ns_index = app->ns_index;
1300 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1301 if ((rv = vnet_connect (cargs)))
1304 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1309 static transport_connection_t *
1310 dtls_half_open_get (u32 ho_index)
1313 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1314 return &ho_ctx->connection;
1318 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1324 dtls_cleanup_ho (u32 ho_index)
1327 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1332 format_dtls_half_open (u8 *s, va_list *args)
1334 u32 ho_index = va_arg (*args, u32);
1335 u32 __clib_unused thread_index = va_arg (*args, u32);
1339 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1341 us = session_get_from_handle (ho_ctx->tls_session_handle);
1342 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1343 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1344 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1345 us->thread_index, us->session_index);
1350 static const transport_proto_vft_t dtls_proto = {
1352 .connect = dtls_connect,
1353 .close = tls_disconnect,
1354 .start_listen = tls_start_listen,
1355 .stop_listen = tls_stop_listen,
1356 .get_connection = tls_connection_get,
1357 .get_listener = tls_listener_get,
1358 .get_half_open = dtls_half_open_get,
1359 .custom_tx = tls_custom_tx_callback,
1360 .cleanup = dtls_cleanup_callback,
1361 .cleanup_ho = dtls_cleanup_ho,
1362 .format_connection = format_tls_connection,
1363 .format_half_open = format_dtls_half_open,
1364 .format_listener = format_tls_listener,
1365 .get_transport_endpoint = tls_transport_endpoint_get,
1366 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1367 .transport_options = {
1370 .tx_type = TRANSPORT_TX_INTERNAL,
1371 .service_type = TRANSPORT_SERVICE_VC,
1376 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1378 vec_validate (tls_vfts, type);
1379 tls_vfts[type] = *vft;
1382 static clib_error_t *
1383 tls_init (vlib_main_t * vm)
1385 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1386 tls_main_t *tm = &tls_main;
1389 num_threads = 1 /* main thread */ + vtm->n_threads;
1391 if (!tm->ca_cert_path)
1392 tm->ca_cert_path = TLS_CA_CERT_PATH;
1394 vec_validate (tm->rx_bufs, num_threads - 1);
1395 vec_validate (tm->tx_bufs, num_threads - 1);
1397 tm->first_seg_size = 32 << 20;
1398 tm->add_seg_size = 256 << 20;
1400 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1401 FIB_PROTOCOL_IP4, ~0);
1402 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1403 FIB_PROTOCOL_IP6, ~0);
1405 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1406 FIB_PROTOCOL_IP4, ~0);
1407 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1408 FIB_PROTOCOL_IP6, ~0);
1412 VLIB_INIT_FUNCTION (tls_init);
1414 static clib_error_t *
1415 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1417 tls_main_t *tm = &tls_main;
1419 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1421 if (unformat (input, "use-test-cert-in-ca"))
1422 tm->use_test_cert_in_ca = 1;
1423 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1425 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1426 &tm->first_seg_size))
1428 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1431 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1433 if (tmp >= 0x100000000ULL)
1435 return clib_error_return
1436 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1438 tm->fifo_size = tmp;
1441 return clib_error_return (0, "unknown input `%U'",
1442 format_unformat_error, input);
1447 VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
1450 vnet_tls_get_main (void)
1456 * fd.io coding-style-patch-verification: ON
1459 * eval: (c-set-style "gnu")