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);
219 ctx->no_app_session = 1;
222 ctx->app_session_handle = session_handle (app_session);
223 ctx->parent_app_wrk_index = app_session->app_wrk_index;
224 app_wrk = app_worker_get (app_session->app_wrk_index);
225 return app_worker_accept_notify (app_wrk, app_session);
229 tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
231 u32 parent_app_api_ctx;
232 session_t *app_session;
233 app_worker_t *app_wrk;
235 app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
238 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
239 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
240 ctx->no_app_session = 1;
246 /* Free app session pre-allocated when transport was established */
247 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
248 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
249 ctx->no_app_session = 1;
253 /* For DTLS the app session is not preallocated because the underlying udp
254 * session might migrate to a different worker during the handshake */
255 if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
258 /* Cleanup half-open session as we don't get notification from udp */
259 session_half_open_delete_notify (&ctx->connection);
260 app_session = session_alloc (ctx->c_thread_index);
261 app_session->session_state = SESSION_STATE_CREATED;
262 ctx->c_s_index = app_session->session_index;
264 session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
265 app_session->session_type = st;
266 app_session->connection_index = ctx->tls_ctx_handle;
270 app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
273 app_session->app_wrk_index = ctx->parent_app_wrk_index;
274 app_session->opaque = ctx->parent_app_api_context;
276 if ((err = app_worker_init_connected (app_wrk, app_session)))
278 app_worker_connect_notify (app_wrk, 0, err, ctx->parent_app_api_context);
279 ctx->no_app_session = 1;
280 session_free (app_session);
284 app_session->session_state = SESSION_STATE_READY;
285 parent_app_api_ctx = ctx->parent_app_api_context;
286 ctx->app_session_handle = session_handle (app_session);
288 if (app_worker_connect_notify (app_wrk, app_session, SESSION_E_NONE,
291 TLS_DBG (1, "failed to notify app");
292 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
293 ctx->no_app_session = 1;
300 return app_worker_connect_notify (app_wrk, 0, err,
301 ctx->parent_app_api_context);
305 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
307 *ctx_index = ctx_handle & TLS_IDX_MASK;
308 *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
311 static inline crypto_engine_type_t
312 tls_get_engine_type (crypto_engine_type_t requested,
313 crypto_engine_type_t preferred)
315 if (requested != CRYPTO_ENGINE_NONE)
317 if (tls_vfts[requested].ctx_alloc)
319 return CRYPTO_ENGINE_NONE;
321 if (!tls_vfts[preferred].ctx_alloc)
322 return tls_get_available_engine ();
327 tls_ctx_alloc (crypto_engine_type_t engine_type)
330 ctx_index = tls_vfts[engine_type].ctx_alloc ();
331 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
335 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
338 ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
339 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
343 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
346 ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
347 return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
351 tls_ctx_detach (tls_ctx_t *ctx)
353 return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
356 static inline tls_ctx_t *
357 tls_ctx_get (u32 ctx_handle)
359 u32 ctx_index, engine_type;
360 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
361 return tls_vfts[engine_type].ctx_get (ctx_index);
364 static inline tls_ctx_t *
365 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
367 u32 ctx_index, engine_type;
368 tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
369 return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
373 tls_ctx_init_server (tls_ctx_t * ctx)
375 return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
379 tls_ctx_init_client (tls_ctx_t * ctx)
381 return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
385 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
386 transport_send_params_t * sp)
390 sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
391 n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
392 sp->bytes_dequeued = n_wrote;
393 return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
397 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
399 return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
403 tls_ctx_transport_close (tls_ctx_t * ctx)
405 return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (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 * s)
446 transport_connection_t *tc;
447 session_t *app_session;
449 ctx = tls_ctx_get (s->opaque);
450 ctx->is_passive_close = 1;
451 tc = &ctx->connection;
452 if (tls_ctx_handshake_is_over (ctx))
454 session_transport_reset_notify (tc);
455 session_transport_closed_notify (tc);
456 tls_disconnect_transport (ctx);
460 app_session = session_get_if_valid (ctx->c_s_index, ctx->c_thread_index);
463 session_free (app_session);
464 ctx->c_s_index = SESSION_INVALID_INDEX;
465 ctx->no_app_session = 1;
466 tls_disconnect_transport (ctx);
472 tls_session_cleanup_ho (session_t *s)
474 /* session opaque stores the opaque passed on connect */
475 tls_ctx_ho_try_free (s->opaque);
479 tls_add_segment_callback (u32 client_index, u64 segment_handle)
481 /* No-op for builtin */
486 tls_del_segment_callback (u32 client_index, u64 segment_handle)
492 tls_session_disconnect_callback (session_t * tls_session)
496 TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
497 tls_session->session_index);
499 ASSERT (tls_session->thread_index == vlib_get_thread_index ()
500 || vlib_thread_is_main_w_barrier ());
502 ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
503 ctx->is_passive_close = 1;
504 tls_ctx_transport_close (ctx);
508 tls_session_accept_callback (session_t * tls_session)
510 session_t *tls_listener, *app_session;
511 tls_ctx_t *lctx, *ctx;
515 listen_session_get_from_handle (tls_session->listener_handle);
516 lctx = tls_listener_ctx_get (tls_listener->opaque);
518 ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
519 ctx = tls_ctx_get (ctx_handle);
520 memcpy (ctx, lctx, sizeof (*lctx));
521 ctx->c_thread_index = vlib_get_thread_index ();
522 ctx->tls_ctx_handle = ctx_handle;
523 tls_session->session_state = SESSION_STATE_READY;
524 tls_session->opaque = ctx_handle;
525 ctx->tls_session_handle = session_handle (tls_session);
526 ctx->listener_ctx_index = tls_listener->opaque;
527 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
528 ctx->ckpair_index = lctx->ckpair_index;
530 /* Preallocate app session. Avoids allocating a session post handshake
531 * on tls_session rx and potentially invalidating the session pool */
532 app_session = session_alloc (ctx->c_thread_index);
533 app_session->session_state = SESSION_STATE_CREATED;
534 app_session->session_type =
535 session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
536 app_session->connection_index = ctx->tls_ctx_handle;
537 ctx->c_s_index = app_session->session_index;
539 TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
540 tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
542 if (tls_ctx_init_server (ctx))
544 /* Do not free ctx yet, in case we have pending rx events */
545 session_free (app_session);
546 ctx->no_app_session = 1;
547 tls_disconnect_transport (ctx);
554 tls_app_rx_callback (session_t *ts)
558 /* DTLS session migrating, wait for next notification */
559 if (PREDICT_FALSE (ts->flags & SESSION_F_IS_MIGRATING))
562 /* Read rescheduled but underlying transport deleted now */
563 if (PREDICT_FALSE ((ts->session_state == SESSION_STATE_TRANSPORT_DELETED)))
566 ctx = tls_ctx_get (ts->opaque);
567 if (PREDICT_FALSE (ctx->no_app_session || ctx->app_closed))
569 TLS_DBG (1, "Local App closed");
572 tls_ctx_read (ctx, ts);
577 tls_app_tx_callback (session_t * tls_session)
581 ctx = tls_ctx_get (tls_session->opaque);
582 transport_connection_reschedule (&ctx->connection);
588 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
589 session_t *tls_session, session_error_t err)
591 session_t *app_session;
592 tls_ctx_t *ho_ctx, *ctx;
596 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
597 ho_ctx->flags |= TLS_CONN_F_HO_DONE;
599 ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
600 ctx = tls_ctx_get (ctx_handle);
601 clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
602 /* Half-open freed on tcp half-open cleanup notification */
604 ctx->c_thread_index = vlib_get_thread_index ();
605 ctx->tls_ctx_handle = ctx_handle;
606 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
608 TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
609 ho_ctx_index, err, vlib_get_thread_index (),
610 (ctx) ? ctx_handle : ~0);
612 ctx->tls_session_handle = session_handle (tls_session);
613 tls_session->opaque = ctx_handle;
614 tls_session->session_state = SESSION_STATE_READY;
616 /* Preallocate app session. Avoids allocating a session post handshake
617 * on tls_session rx and potentially invalidating the session pool */
618 app_session = session_alloc (ctx->c_thread_index);
619 app_session->session_state = SESSION_STATE_CREATED;
620 ctx->c_s_index = app_session->session_index;
621 st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
622 app_session->session_type = st;
623 app_session->connection_index = ctx->tls_ctx_handle;
625 if (tls_ctx_init_client (ctx))
627 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
628 tls_disconnect_transport (ctx);
635 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
640 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
642 ctx->tls_session_handle = session_handle (us);
643 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
644 us->opaque = ctx_handle;
646 /* We don't preallocate the app session because the udp session might
647 * actually migrate to a different worker at the end of the handshake */
649 return tls_ctx_init_client (ctx);
653 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
654 session_t *tls_session, session_error_t err)
658 app_worker_t *app_wrk;
662 ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
663 ho_ctx->flags |= TLS_CONN_F_HO_DONE;
664 app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
667 api_context = ho_ctx->parent_app_api_context;
668 app_worker_connect_notify (app_wrk, 0, err, api_context);
674 if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
675 return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
678 return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
683 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
687 if (ntf == SESSION_CLEANUP_TRANSPORT)
689 /* Allow cleanup of tcp session */
690 if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
695 ctx = tls_ctx_get (s->opaque);
696 if (!ctx->no_app_session)
697 session_transport_delete_notify (&ctx->connection);
702 dtls_migrate_ctx (void *arg)
704 tls_ctx_t *ctx = (tls_ctx_t *) arg;
705 u32 ctx_handle, thread_index;
708 thread_index = session_thread_from_handle (ctx->tls_session_handle);
709 ASSERT (thread_index == vlib_get_thread_index ());
711 ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
712 ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
713 ctx->tls_ctx_handle = ctx_handle;
715 us = session_get_from_handle (ctx->tls_session_handle);
716 us->opaque = ctx_handle;
717 us->flags &= ~SESSION_F_IS_MIGRATING;
719 /* Probably the app detached while the session was migrating. Cleanup */
720 if (session_half_open_migrated_notify (&ctx->connection))
722 ctx->no_app_session = 1;
723 tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
727 if (svm_fifo_max_dequeue (us->tx_fifo))
728 session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
732 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
734 u32 new_thread = session_thread_from_handle (new_sh);
735 tls_ctx_t *ctx, *cloned_ctx;
737 /* Migrate dtls context to new thread */
738 ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
739 ctx->tls_session_handle = new_sh;
740 cloned_ctx = tls_ctx_detach (ctx);
741 ctx->is_migrated = 1;
742 session_half_open_migrate_notify (&ctx->connection);
744 session_send_rpc_evt_to_thread (new_thread, dtls_migrate_ctx,
745 (void *) cloned_ctx);
751 tls_session_transport_closed_callback (session_t *ts)
755 ctx = tls_ctx_get_w_thread (ts->opaque, ts->thread_index);
756 if (!ctx->no_app_session)
757 session_transport_closed_notify (&ctx->connection);
760 static session_cb_vft_t tls_app_cb_vft = {
761 .session_accept_callback = tls_session_accept_callback,
762 .session_disconnect_callback = tls_session_disconnect_callback,
763 .session_connected_callback = tls_session_connected_callback,
764 .session_reset_callback = tls_session_reset_callback,
765 .session_transport_closed_callback = tls_session_transport_closed_callback,
766 .half_open_cleanup_callback = tls_session_cleanup_ho,
767 .add_segment_callback = tls_add_segment_callback,
768 .del_segment_callback = tls_del_segment_callback,
769 .builtin_app_rx_callback = tls_app_rx_callback,
770 .builtin_app_tx_callback = tls_app_tx_callback,
771 .session_migrate_callback = dtls_session_migrate_callback,
772 .session_cleanup_callback = tls_app_session_cleanup,
776 tls_connect (transport_endpoint_cfg_t * tep)
778 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
779 transport_endpt_crypto_cfg_t *ccfg;
780 crypto_engine_type_t engine_type;
781 session_endpoint_cfg_t *sep;
782 tls_main_t *tm = &tls_main;
783 app_worker_t *app_wrk;
789 sep = (session_endpoint_cfg_t *) tep;
791 return SESSION_E_NOEXTCFG;
793 app_wrk = app_worker_get (sep->app_wrk_index);
794 app = application_get (app_wrk->app_index);
796 ccfg = &sep->ext_cfg->crypto;
797 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
798 if (engine_type == CRYPTO_ENGINE_NONE)
800 clib_warning ("No tls engine_type available");
801 return SESSION_E_NOCRYPTOENG;
804 ctx_index = tls_ctx_half_open_alloc ();
805 ctx = tls_ctx_half_open_get (ctx_index);
806 ctx->parent_app_wrk_index = sep->app_wrk_index;
807 ctx->parent_app_api_context = sep->opaque;
808 ctx->tcp_is_ip4 = sep->is_ip4;
809 ctx->tls_type = sep->transport_proto;
810 ctx->ckpair_index = ccfg->ckpair_index;
811 ctx->c_proto = TRANSPORT_PROTO_TLS;
812 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
813 if (ccfg->hostname[0])
815 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
816 vec_terminate_c_string (ctx->srv_hostname);
819 ctx->tls_ctx_engine = engine_type;
821 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
822 cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
823 cargs->app_index = tm->app_index;
824 cargs->api_context = ctx_index;
825 cargs->sep_ext.ns_index = app->ns_index;
826 if ((rv = vnet_connect (cargs)))
828 tls_ctx_half_open_free (ctx_index);
832 /* Track half-open tcp session in case we need to clean it up */
833 ctx->tls_session_handle = cargs->sh;
835 TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
840 tls_disconnect (u32 ctx_handle, u32 thread_index)
844 TLS_DBG (1, "Disconnecting %x", ctx_handle);
846 ctx = tls_ctx_get (ctx_handle);
847 tls_ctx_app_close (ctx);
851 tls_start_listen (u32 app_listener_index, transport_endpoint_cfg_t *tep)
853 vnet_listen_args_t _bargs, *args = &_bargs;
854 transport_endpt_crypto_cfg_t *ccfg;
855 app_worker_t *app_wrk;
856 tls_main_t *tm = &tls_main;
857 session_handle_t tls_al_handle;
858 session_endpoint_cfg_t *sep;
859 session_t *tls_listener;
860 session_t *app_listener;
861 crypto_engine_type_t engine_type;
868 sep = (session_endpoint_cfg_t *) tep;
870 return SESSION_E_NOEXTCFG;
872 app_wrk = app_worker_get (sep->app_wrk_index);
873 app = application_get (app_wrk->app_index);
875 ccfg = &sep->ext_cfg->crypto;
876 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
877 if (engine_type == CRYPTO_ENGINE_NONE)
879 clib_warning ("No tls engine_type available");
880 return SESSION_E_NOCRYPTOENG;
883 clib_memset (args, 0, sizeof (*args));
884 args->app_index = tm->app_index;
885 args->sep_ext = *sep;
886 args->sep_ext.ns_index = app->ns_index;
887 args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
888 if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
890 args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
891 args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
893 if ((rv = vnet_listen (args)))
896 lctx_index = tls_listener_ctx_alloc ();
897 tls_al_handle = args->handle;
898 al = app_listener_get_w_handle (tls_al_handle);
899 tls_listener = app_listener_get_session (al);
900 tls_listener->opaque = lctx_index;
902 app_listener = listen_session_get (app_listener_index);
904 lctx = tls_listener_ctx_get (lctx_index);
905 lctx->parent_app_wrk_index = sep->app_wrk_index;
906 lctx->tls_session_handle = tls_al_handle;
907 lctx->app_session_handle = listen_session_get_handle (app_listener);
908 lctx->tcp_is_ip4 = sep->is_ip4;
909 lctx->tls_ctx_engine = engine_type;
910 lctx->tls_type = sep->transport_proto;
911 lctx->ckpair_index = ccfg->ckpair_index;
912 lctx->c_s_index = app_listener_index;
913 lctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
915 if (tls_vfts[engine_type].ctx_start_listen (lctx))
917 vnet_unlisten_args_t a = {
918 .handle = lctx->tls_session_handle,
919 .app_index = tls_main.app_index,
922 if ((vnet_unlisten (&a)))
923 clib_warning ("unlisten returned");
924 tls_listener_ctx_free (lctx);
925 lctx_index = SESSION_INVALID_INDEX;
928 TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
934 tls_stop_listen (u32 lctx_index)
936 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
937 crypto_engine_type_t engine_type;
938 transport_connection_t *lc;
943 lctx = tls_listener_ctx_get (lctx_index);
945 /* Cleanup listener from session lookup table */
946 ls = session_get_from_handle (lctx->tls_session_handle);
947 lc = session_get_transport (ls);
949 sep.fib_index = lc->fib_index;
950 sep.port = lc->lcl_port;
951 sep.is_ip4 = lc->is_ip4;
952 sep.transport_proto = lctx->tls_type;
953 clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
954 session_lookup_del_session_endpoint2 (&sep);
956 vnet_unlisten_args_t a = {
957 .handle = lctx->tls_session_handle,
958 .app_index = tls_main.app_index,
959 .wrk_map_index = 0 /* default wrk */
961 if ((rv = vnet_unlisten (&a)))
962 clib_warning ("unlisten returned %d", rv);
964 engine_type = lctx->tls_ctx_engine;
965 tls_vfts[engine_type].ctx_stop_listen (lctx);
967 tls_listener_ctx_free (lctx);
971 transport_connection_t *
972 tls_connection_get (u32 ctx_index, u32 thread_index)
975 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
976 return &ctx->connection;
979 transport_connection_t *
980 tls_listener_get (u32 listener_index)
983 ctx = tls_listener_ctx_get (listener_index);
984 return &ctx->connection;
987 static transport_connection_t *
988 tls_half_open_get (u32 ho_index)
991 ctx = tls_ctx_half_open_get (ho_index);
992 return &ctx->connection;
996 tls_cleanup_ho (u32 ho_index)
1001 ctx = tls_ctx_half_open_get (ho_index);
1002 /* Already pending cleanup */
1003 if (ctx->tls_session_handle == SESSION_INVALID_HANDLE)
1005 ASSERT (ctx->flags & TLS_CONN_F_HO_DONE);
1006 ctx->no_app_session = 1;
1010 s = session_get_from_handle (ctx->tls_session_handle);
1011 /* If no pending cleanup notification, force cleanup now. Otherwise,
1012 * wait for cleanup notification and set no app session on ctx */
1013 if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1015 session_cleanup_half_open (ctx->tls_session_handle);
1016 tls_ctx_half_open_free (ho_index);
1019 ctx->no_app_session = 1;
1023 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
1025 session_t *as = (session_t *) session;
1028 if (PREDICT_FALSE (as->session_state >= SESSION_STATE_TRANSPORT_CLOSED ||
1029 as->session_state <= SESSION_STATE_ACCEPTING))
1031 sp->flags |= TRANSPORT_SND_F_DESCHED;
1035 ctx = tls_ctx_get (as->connection_index);
1036 return tls_ctx_write (ctx, as, sp);
1040 format_tls_ctx (u8 * s, va_list * args)
1042 u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
1043 tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
1046 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
1047 session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
1048 tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
1050 format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
1051 ctx->c_thread_index, ctx->c_s_index, proto,
1052 ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
1058 format_tls_listener_ctx (u8 * s, va_list * args)
1060 session_t *tls_listener;
1065 ctx = va_arg (*args, tls_ctx_t *);
1067 proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
1068 al = app_listener_get_w_handle (ctx->tls_session_handle);
1069 tls_listener = app_listener_get_session (al);
1070 s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
1071 ctx->c_thread_index, ctx->c_s_index, proto,
1072 ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
1073 tls_listener->thread_index, tls_listener->session_index);
1079 format_tls_ctx_state (u8 * s, va_list * args)
1084 ctx = va_arg (*args, tls_ctx_t *);
1085 ts = session_get (ctx->c_s_index, ctx->c_thread_index);
1086 if (ts->session_state == SESSION_STATE_LISTENING)
1087 s = format (s, "%s", "LISTEN");
1090 if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
1091 s = format (s, "%s", "CLOSED");
1092 else if (ts->session_state == SESSION_STATE_APP_CLOSED)
1093 s = format (s, "%s", "APP-CLOSED");
1094 else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1095 s = format (s, "%s", "CLOSING");
1096 else if (tls_ctx_handshake_is_over (ctx))
1097 s = format (s, "%s", "ESTABLISHED");
1099 s = format (s, "%s", "HANDSHAKE");
1106 format_tls_connection (u8 * s, va_list * args)
1108 u32 ctx_index = va_arg (*args, u32);
1109 u32 thread_index = va_arg (*args, u32);
1110 u32 verbose = va_arg (*args, u32);
1113 ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
1117 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
1120 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
1123 s = format (s, "\n");
1129 format_tls_listener (u8 * s, va_list * args)
1131 u32 tc_index = va_arg (*args, u32);
1132 u32 __clib_unused thread_index = va_arg (*args, u32);
1133 u32 verbose = va_arg (*args, u32);
1134 tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
1136 s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
1138 s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
1143 format_tls_half_open (u8 * s, va_list * args)
1145 u32 ho_index = va_arg (*args, u32);
1146 u32 __clib_unused thread_index = va_arg (*args, u32);
1147 u32 __clib_unused verbose = va_arg (*args, u32);
1151 ho_ctx = tls_ctx_half_open_get (ho_index);
1153 tcp_ho = session_get_from_handle (ho_ctx->tls_session_handle);
1154 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u ts %d:%d",
1155 ho_ctx->c_thread_index, ho_ctx->c_s_index, "TLS",
1156 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1157 tcp_ho->thread_index, tcp_ho->session_index);
1163 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1164 transport_endpoint_t * tep, u8 is_lcl)
1166 tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1167 session_t *tcp_session;
1169 tcp_session = session_get_from_handle (ctx->tls_session_handle);
1170 session_get_endpoint (tcp_session, tep, is_lcl);
1174 tls_transport_listener_endpoint_get (u32 ctx_handle,
1175 transport_endpoint_t * tep, u8 is_lcl)
1177 session_t *tls_listener;
1179 tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1181 al = app_listener_get_w_handle (ctx->tls_session_handle);
1182 tls_listener = app_listener_get_session (al);
1183 session_get_endpoint (tls_listener, tep, is_lcl);
1186 static clib_error_t *
1187 tls_enable (vlib_main_t * vm, u8 is_en)
1189 vnet_app_detach_args_t _da, *da = &_da;
1190 vnet_app_attach_args_t _a, *a = &_a;
1191 u64 options[APP_OPTIONS_N_OPTIONS];
1192 tls_main_t *tm = &tls_main;
1193 u32 fifo_size = 512 << 10;
1197 da->app_index = tm->app_index;
1198 da->api_client_index = APP_INVALID_INDEX;
1199 vnet_application_detach (da);
1203 fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1205 clib_memset (a, 0, sizeof (*a));
1206 clib_memset (options, 0, sizeof (options));
1208 a->session_cb_vft = &tls_app_cb_vft;
1209 a->api_client_index = APP_INVALID_INDEX;
1210 a->options = options;
1211 a->name = format (0, "tls");
1212 a->options[APP_OPTIONS_SEGMENT_SIZE] = tm->first_seg_size;
1213 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = tm->add_seg_size;
1214 a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1215 a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1216 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1217 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1218 a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1220 if (vnet_application_attach (a))
1222 clib_warning ("failed to attach tls app");
1223 return clib_error_return (0, "failed to attach tls app");
1226 tm->app_index = a->app_index;
1232 static const transport_proto_vft_t tls_proto = {
1233 .enable = tls_enable,
1234 .connect = tls_connect,
1235 .close = tls_disconnect,
1236 .start_listen = tls_start_listen,
1237 .stop_listen = tls_stop_listen,
1238 .get_connection = tls_connection_get,
1239 .get_listener = tls_listener_get,
1240 .get_half_open = tls_half_open_get,
1241 .cleanup_ho = tls_cleanup_ho,
1242 .custom_tx = tls_custom_tx_callback,
1243 .format_connection = format_tls_connection,
1244 .format_half_open = format_tls_half_open,
1245 .format_listener = format_tls_listener,
1246 .get_transport_endpoint = tls_transport_endpoint_get,
1247 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1248 .transport_options = {
1251 .tx_type = TRANSPORT_TX_INTERNAL,
1252 .service_type = TRANSPORT_SERVICE_VC,
1257 dtls_connect (transport_endpoint_cfg_t *tep)
1259 vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1260 transport_endpt_crypto_cfg_t *ccfg;
1261 crypto_engine_type_t engine_type;
1262 session_endpoint_cfg_t *sep;
1263 tls_main_t *tm = &tls_main;
1264 app_worker_t *app_wrk;
1270 sep = (session_endpoint_cfg_t *) tep;
1274 app_wrk = app_worker_get (sep->app_wrk_index);
1275 app = application_get (app_wrk->app_index);
1277 ccfg = &sep->ext_cfg->crypto;
1278 engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1279 if (engine_type == CRYPTO_ENGINE_NONE)
1281 clib_warning ("No tls engine_type available");
1285 ctx_handle = tls_ctx_alloc_w_thread (engine_type, transport_cl_thread ());
1286 ctx = tls_ctx_get_w_thread (ctx_handle, transport_cl_thread ());
1287 ctx->parent_app_wrk_index = sep->app_wrk_index;
1288 ctx->parent_app_api_context = sep->opaque;
1289 ctx->tcp_is_ip4 = sep->is_ip4;
1290 ctx->ckpair_index = ccfg->ckpair_index;
1291 ctx->tls_type = sep->transport_proto;
1292 ctx->tls_ctx_handle = ctx_handle;
1293 ctx->c_proto = TRANSPORT_PROTO_DTLS;
1294 ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
1295 if (ccfg->hostname[0])
1297 ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1298 vec_terminate_c_string (ctx->srv_hostname);
1301 ctx->tls_ctx_engine = engine_type;
1303 clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1304 cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1305 cargs->app_index = tm->app_index;
1306 cargs->api_context = ctx_handle;
1307 cargs->sep_ext.ns_index = app->ns_index;
1308 cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1309 if ((rv = vnet_connect (cargs)))
1312 TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1317 static transport_connection_t *
1318 dtls_half_open_get (u32 ho_index)
1321 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1322 return &ho_ctx->connection;
1326 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1332 dtls_cleanup_ho (u32 ho_index)
1335 ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1340 format_dtls_half_open (u8 *s, va_list *args)
1342 u32 ho_index = va_arg (*args, u32);
1343 u32 __clib_unused thread_index = va_arg (*args, u32);
1347 ho_ctx = tls_ctx_get_w_thread (ho_index, transport_cl_thread ());
1349 us = session_get_from_handle (ho_ctx->tls_session_handle);
1350 s = format (s, "[%d:%d][%s] half-open app_wrk %u engine %u us %d:%d",
1351 ho_ctx->c_thread_index, ho_ctx->c_s_index, "DTLS",
1352 ho_ctx->parent_app_wrk_index, ho_ctx->tls_ctx_engine,
1353 us->thread_index, us->session_index);
1358 static const transport_proto_vft_t dtls_proto = {
1360 .connect = dtls_connect,
1361 .close = tls_disconnect,
1362 .start_listen = tls_start_listen,
1363 .stop_listen = tls_stop_listen,
1364 .get_connection = tls_connection_get,
1365 .get_listener = tls_listener_get,
1366 .get_half_open = dtls_half_open_get,
1367 .custom_tx = tls_custom_tx_callback,
1368 .cleanup = dtls_cleanup_callback,
1369 .cleanup_ho = dtls_cleanup_ho,
1370 .format_connection = format_tls_connection,
1371 .format_half_open = format_dtls_half_open,
1372 .format_listener = format_tls_listener,
1373 .get_transport_endpoint = tls_transport_endpoint_get,
1374 .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1375 .transport_options = {
1378 .tx_type = TRANSPORT_TX_INTERNAL,
1379 .service_type = TRANSPORT_SERVICE_VC,
1384 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1386 vec_validate (tls_vfts, type);
1387 tls_vfts[type] = *vft;
1390 static clib_error_t *
1391 tls_init (vlib_main_t * vm)
1393 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1394 tls_main_t *tm = &tls_main;
1397 num_threads = 1 /* main thread */ + vtm->n_threads;
1399 if (!tm->ca_cert_path)
1400 tm->ca_cert_path = TLS_CA_CERT_PATH;
1402 vec_validate (tm->rx_bufs, num_threads - 1);
1403 vec_validate (tm->tx_bufs, num_threads - 1);
1405 tm->first_seg_size = 32 << 20;
1406 tm->add_seg_size = 256 << 20;
1408 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1409 FIB_PROTOCOL_IP4, ~0);
1410 transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1411 FIB_PROTOCOL_IP6, ~0);
1413 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1414 FIB_PROTOCOL_IP4, ~0);
1415 transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1416 FIB_PROTOCOL_IP6, ~0);
1420 VLIB_INIT_FUNCTION (tls_init);
1422 static clib_error_t *
1423 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1425 tls_main_t *tm = &tls_main;
1427 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1429 if (unformat (input, "use-test-cert-in-ca"))
1430 tm->use_test_cert_in_ca = 1;
1431 else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1433 else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1434 &tm->first_seg_size))
1436 else if (unformat (input, "add-segment-size %U", unformat_memory_size,
1439 else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1441 if (tmp >= 0x100000000ULL)
1443 return clib_error_return
1444 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1446 tm->fifo_size = tmp;
1449 return clib_error_return (0, "unknown input `%U'",
1450 format_unformat_error, input);
1455 VLIB_CONFIG_FUNCTION (tls_config_fn, "tls");
1458 vnet_tls_get_main (void)
1464 * fd.io coding-style-patch-verification: ON
1467 * eval: (c-set-style "gnu")