src/vnet/tls/tls.c

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #include <vnet/session/application_interface.h>
  17 #include <vppinfra/lock.h>
  18 #include <vnet/tls/tls.h>
  19
  20 static tls_main_t tls_main;
  21 static tls_engine_vft_t *tls_vfts;
  22
  23 #define TLS_INVALID_HANDLE      ~0
  24 #define TLS_IDX_MASK            0x00FFFFFF
  25 #define TLS_ENGINE_TYPE_SHIFT   29
  26
  27 void tls_disconnect (u32 ctx_handle, u32 thread_index);
  28
  29 void
  30 tls_disconnect_transport (tls_ctx_t * ctx)
  31 {
  32   vnet_disconnect_args_t a = {
  33     .handle = ctx->tls_session_handle,
  34     .app_index = tls_main.app_index,
  35   };
  36
  37   if (vnet_disconnect_session (&a))
  38     clib_warning ("disconnect returned");
  39 }
  40
  41 crypto_engine_type_t
  42 tls_get_available_engine (void)
  43 {
  44   int i;
  45   for (i = 0; i < vec_len (tls_vfts); i++)
  46     {
  47       if (tls_vfts[i].ctx_alloc)
  48         return i;
  49     }
  50   return CRYPTO_ENGINE_NONE;
  51 }
  52
  53 int
  54 tls_add_vpp_q_rx_evt (session_t * s)
  55 {
  56   if (svm_fifo_set_event (s->rx_fifo))
  57     session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_RX);
  58   return 0;
  59 }
  60
  61 int
  62 tls_add_vpp_q_builtin_rx_evt (session_t * s)
  63 {
  64   if (svm_fifo_set_event (s->rx_fifo))
  65     session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_BUILTIN_RX);
  66   return 0;
  67 }
  68
  69 int
  70 tls_add_vpp_q_tx_evt (session_t * s)
  71 {
  72   if (svm_fifo_set_event (s->tx_fifo))
  73     session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
  74   return 0;
  75 }
  76
  77 int
  78 tls_add_vpp_q_builtin_tx_evt (session_t * s)
  79 {
  80   if (svm_fifo_set_event (s->tx_fifo))
  81     session_send_io_evt_to_thread_custom (s, s->thread_index,
  82                                           SESSION_IO_EVT_BUILTIN_TX);
  83   return 0;
  84 }
  85
  86 static inline int
  87 tls_add_app_q_evt (app_worker_t * app, session_t * app_session)
  88 {
  89   return app_worker_lock_and_send_event (app, app_session, SESSION_IO_EVT_RX);
  90 }
  91
  92 u32
  93 tls_listener_ctx_alloc (void)
  94 {
  95   tls_main_t *tm = &tls_main;
  96   tls_ctx_t *ctx;
  97
  98   pool_get (tm->listener_ctx_pool, ctx);
  99   clib_memset (ctx, 0, sizeof (*ctx));
 100   return ctx - tm->listener_ctx_pool;
 101 }
 102
 103 void
 104 tls_listener_ctx_free (tls_ctx_t * ctx)
 105 {
 106   if (CLIB_DEBUG)
 107     memset (ctx, 0xfb, sizeof (*ctx));
 108   pool_put (tls_main.listener_ctx_pool, ctx);
 109 }
 110
 111 tls_ctx_t *
 112 tls_listener_ctx_get (u32 ctx_index)
 113 {
 114   return pool_elt_at_index (tls_main.listener_ctx_pool, ctx_index);
 115 }
 116
 117 u32
 118 tls_listener_ctx_index (tls_ctx_t * ctx)
 119 {
 120   return (ctx - tls_main.listener_ctx_pool);
 121 }
 122
 123 u32
 124 tls_ctx_half_open_alloc (void)
 125 {
 126   tls_main_t *tm = &tls_main;
 127   u8 will_expand = 0;
 128   tls_ctx_t *ctx;
 129   u32 ctx_index;
 130
 131   pool_get_aligned_will_expand (tm->half_open_ctx_pool, will_expand, 0);
 132   if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
 133     {
 134       clib_rwlock_writer_lock (&tm->half_open_rwlock);
 135       pool_get (tm->half_open_ctx_pool, ctx);
 136       ctx_index = ctx - tm->half_open_ctx_pool;
 137       clib_rwlock_writer_unlock (&tm->half_open_rwlock);
 138     }
 139   else
 140     {
 141       /* reader lock assumption: only main thread will call pool_get */
 142       clib_rwlock_reader_lock (&tm->half_open_rwlock);
 143       pool_get (tm->half_open_ctx_pool, ctx);
 144       ctx_index = ctx - tm->half_open_ctx_pool;
 145       clib_rwlock_reader_unlock (&tm->half_open_rwlock);
 146     }
 147   clib_memset (ctx, 0, sizeof (*ctx));
 148   return ctx_index;
 149 }
 150
 151 void
 152 tls_ctx_half_open_free (u32 ho_index)
 153 {
 154   tls_main_t *tm = &tls_main;
 155   clib_rwlock_writer_lock (&tm->half_open_rwlock);
 156   pool_put_index (tls_main.half_open_ctx_pool, ho_index);
 157   clib_rwlock_writer_unlock (&tm->half_open_rwlock);
 158 }
 159
 160 tls_ctx_t *
 161 tls_ctx_half_open_get (u32 ctx_index)
 162 {
 163   tls_main_t *tm = &tls_main;
 164   clib_rwlock_reader_lock (&tm->half_open_rwlock);
 165   return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
 166 }
 167
 168 void
 169 tls_ctx_half_open_reader_unlock ()
 170 {
 171   clib_rwlock_reader_unlock (&tls_main.half_open_rwlock);
 172 }
 173
 174 u32
 175 tls_ctx_half_open_index (tls_ctx_t * ctx)
 176 {
 177   return (ctx - tls_main.half_open_ctx_pool);
 178 }
 179
 180 void
 181 tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
 182 {
 183   app_worker_t *app_wrk;
 184   app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
 185   if (PREDICT_TRUE (app_wrk != 0))
 186     tls_add_app_q_evt (app_wrk, app_session);
 187 }
 188
 189 int
 190 tls_notify_app_accept (tls_ctx_t * ctx)
 191 {
 192   session_t *app_listener, *app_session;
 193   app_worker_t *app_wrk;
 194   tls_ctx_t *lctx;
 195   int rv;
 196
 197   lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
 198   app_listener = listen_session_get_from_handle (lctx->app_session_handle);
 199
 200   app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
 201   app_session->app_wrk_index = ctx->parent_app_wrk_index;
 202   app_session->connection_index = ctx->tls_ctx_handle;
 203   app_session->session_type = app_listener->session_type;
 204   app_session->listener_handle = listen_session_get_handle (app_listener);
 205   app_session->session_state = SESSION_STATE_ACCEPTING;
 206
 207   if ((rv = app_worker_init_accepted (app_session)))
 208     {
 209       TLS_DBG (1, "failed to allocate fifos");
 210       session_free (app_session);
 211       return rv;
 212     }
 213   ctx->app_session_handle = session_handle (app_session);
 214   session_lookup_add_connection (&ctx->connection,
 215                                  session_handle (app_session));
 216   ctx->parent_app_wrk_index = app_session->app_wrk_index;
 217   app_wrk = app_worker_get (app_session->app_wrk_index);
 218   return app_worker_accept_notify (app_wrk, app_session);
 219 }
 220
 221 int
 222 tls_notify_app_connected (tls_ctx_t * ctx, u8 is_failed)
 223 {
 224   session_t *app_session;
 225   app_worker_t *app_wrk;
 226
 227   app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
 228   if (!app_wrk)
 229     {
 230       tls_disconnect_transport (ctx);
 231       return -1;
 232     }
 233
 234   if (is_failed)
 235     goto failed;
 236
 237   app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
 238   app_session->app_wrk_index = ctx->parent_app_wrk_index;
 239   app_session->connection_index = ctx->tls_ctx_handle;
 240   app_session->session_type =
 241     session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
 242
 243   if (app_worker_init_connected (app_wrk, app_session))
 244     goto failed;
 245
 246   app_session->session_state = SESSION_STATE_CONNECTING;
 247   if (app_worker_connect_notify (app_wrk, app_session,
 248                                  ctx->parent_app_api_context))
 249     {
 250       TLS_DBG (1, "failed to notify app");
 251       tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
 252       return -1;
 253     }
 254
 255   ctx->app_session_handle = session_handle (app_session);
 256   app_session->session_state = SESSION_STATE_READY;
 257   session_lookup_add_connection (&ctx->connection,
 258                                  session_handle (app_session));
 259
 260   return 0;
 261
 262 failed:
 263   /* Free app session pre-allocated when transport was established */
 264   session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
 265   ctx->no_app_session = 1;
 266   tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
 267   return app_worker_connect_notify (app_wrk, 0, ctx->parent_app_api_context);
 268 }
 269
 270 static inline void
 271 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
 272 {
 273   *ctx_index = ctx_handle & TLS_IDX_MASK;
 274   *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
 275 }
 276
 277 static inline crypto_engine_type_t
 278 tls_get_engine_type (crypto_engine_type_t preferred)
 279 {
 280   if (!tls_vfts[preferred].ctx_alloc)
 281     return tls_get_available_engine ();
 282   return preferred;
 283 }
 284
 285 static inline u32
 286 tls_ctx_alloc (crypto_engine_type_t engine_type)
 287 {
 288   u32 ctx_index;
 289   ctx_index = tls_vfts[engine_type].ctx_alloc ();
 290   return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
 291 }
 292
 293 static inline tls_ctx_t *
 294 tls_ctx_get (u32 ctx_handle)
 295 {
 296   u32 ctx_index, engine_type;
 297   tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
 298   return tls_vfts[engine_type].ctx_get (ctx_index);
 299 }
 300
 301 static inline tls_ctx_t *
 302 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
 303 {
 304   u32 ctx_index, engine_type;
 305   tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
 306   return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
 307 }
 308
 309 static inline int
 310 tls_ctx_init_server (tls_ctx_t * ctx)
 311 {
 312   return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
 313 }
 314
 315 static inline int
 316 tls_ctx_init_client (tls_ctx_t * ctx)
 317 {
 318   return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
 319 }
 320
 321 static inline int
 322 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session)
 323 {
 324   return tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session);
 325 }
 326
 327 static inline int
 328 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
 329 {
 330   return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
 331 }
 332
 333 static inline int
 334 tls_ctx_transport_close (tls_ctx_t * ctx)
 335 {
 336   return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
 337 }
 338
 339 static inline int
 340 tls_ctx_app_close (tls_ctx_t * ctx)
 341 {
 342   return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
 343 }
 344
 345 void
 346 tls_ctx_free (tls_ctx_t * ctx)
 347 {
 348   tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
 349 }
 350
 351 u8
 352 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
 353 {
 354   return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
 355 }
 356
 357 void
 358 tls_session_reset_callback (session_t * s)
 359 {
 360   tls_ctx_t *ctx;
 361
 362   ctx = tls_ctx_get (s->opaque);
 363   session_transport_reset_notify (&ctx->connection);
 364   session_transport_closed_notify (&ctx->connection);
 365   tls_disconnect_transport (ctx);
 366 }
 367
 368 int
 369 tls_add_segment_callback (u32 client_index, u64 segment_handle)
 370 {
 371   /* No-op for builtin */
 372   return 0;
 373 }
 374
 375 int
 376 tls_del_segment_callback (u32 client_index, u64 segment_handle)
 377 {
 378   return 0;
 379 }
 380
 381 void
 382 tls_session_disconnect_callback (session_t * tls_session)
 383 {
 384   tls_ctx_t *ctx;
 385
 386   TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
 387            tls_session->session_index);
 388
 389   ASSERT (tls_session->thread_index == vlib_get_thread_index ()
 390           || vlib_thread_is_main_w_barrier ());
 391
 392   ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
 393   ctx->is_passive_close = 1;
 394   tls_ctx_transport_close (ctx);
 395 }
 396
 397 int
 398 tls_session_accept_callback (session_t * tls_session)
 399 {
 400   session_t *tls_listener, *app_session;
 401   tls_ctx_t *lctx, *ctx;
 402   u32 ctx_handle;
 403
 404   tls_listener =
 405     listen_session_get_from_handle (tls_session->listener_handle);
 406   lctx = tls_listener_ctx_get (tls_listener->opaque);
 407
 408   ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
 409   ctx = tls_ctx_get (ctx_handle);
 410   memcpy (ctx, lctx, sizeof (*lctx));
 411   ctx->c_thread_index = vlib_get_thread_index ();
 412   ctx->tls_ctx_handle = ctx_handle;
 413   tls_session->session_state = SESSION_STATE_READY;
 414   tls_session->opaque = ctx_handle;
 415   ctx->tls_session_handle = session_handle (tls_session);
 416   ctx->listener_ctx_index = tls_listener->opaque;
 417   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
 418   ctx->ckpair_index = lctx->ckpair_index;
 419
 420   /* Preallocate app session. Avoids allocating a session post handshake
 421    * on tls_session rx and potentially invalidating the session pool */
 422   app_session = session_alloc (ctx->c_thread_index);
 423   app_session->session_state = SESSION_STATE_CLOSED;
 424   ctx->c_s_index = app_session->session_index;
 425
 426   TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
 427            tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
 428
 429   return tls_ctx_init_server (ctx);
 430 }
 431
 432 int
 433 tls_app_rx_callback (session_t * tls_session)
 434 {
 435   tls_ctx_t *ctx;
 436
 437   ctx = tls_ctx_get (tls_session->opaque);
 438   tls_ctx_read (ctx, tls_session);
 439   return 0;
 440 }
 441
 442 int
 443 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
 444                                 session_t * tls_session, u8 is_fail)
 445 {
 446   session_t *app_session;
 447   tls_ctx_t *ho_ctx, *ctx;
 448   u32 ctx_handle;
 449
 450   ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
 451
 452   if (is_fail)
 453     {
 454       app_worker_t *app_wrk;
 455       u32 api_context;
 456       int rv = 0;
 457
 458       app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
 459       if (app_wrk)
 460         {
 461           api_context = ho_ctx->c_s_index;
 462           app_worker_connect_notify (app_wrk, 0, api_context);
 463         }
 464       tls_ctx_half_open_reader_unlock ();
 465       tls_ctx_half_open_free (ho_ctx_index);
 466       return rv;
 467     }
 468
 469   ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
 470   ctx = tls_ctx_get (ctx_handle);
 471   clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
 472   tls_ctx_half_open_reader_unlock ();
 473   tls_ctx_half_open_free (ho_ctx_index);
 474
 475   ctx->c_thread_index = vlib_get_thread_index ();
 476   ctx->tls_ctx_handle = ctx_handle;
 477   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
 478
 479   TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
 480            ho_ctx_index, is_fail, vlib_get_thread_index (),
 481            (ctx) ? ctx_handle : ~0);
 482
 483   ctx->tls_session_handle = session_handle (tls_session);
 484   tls_session->opaque = ctx_handle;
 485   tls_session->session_state = SESSION_STATE_READY;
 486
 487   /* Preallocate app session. Avoids allocating a session post handshake
 488    * on tls_session rx and potentially invalidating the session pool */
 489   app_session = session_alloc (ctx->c_thread_index);
 490   app_session->session_state = SESSION_STATE_CLOSED;
 491   ctx->c_s_index = app_session->session_index;
 492
 493   return tls_ctx_init_client (ctx);
 494 }
 495
 496 static void
 497 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
 498 {
 499   tls_ctx_t *ctx;
 500
 501   if (ntf == SESSION_CLEANUP_TRANSPORT)
 502     return;
 503
 504   ctx = tls_ctx_get (s->opaque);
 505   if (!ctx->no_app_session)
 506     session_transport_delete_notify (&ctx->connection);
 507   tls_ctx_free (ctx);
 508 }
 509
 510 /* *INDENT-OFF* */
 511 static session_cb_vft_t tls_app_cb_vft = {
 512   .session_accept_callback = tls_session_accept_callback,
 513   .session_disconnect_callback = tls_session_disconnect_callback,
 514   .session_connected_callback = tls_session_connected_callback,
 515   .session_reset_callback = tls_session_reset_callback,
 516   .add_segment_callback = tls_add_segment_callback,
 517   .del_segment_callback = tls_del_segment_callback,
 518   .builtin_app_rx_callback = tls_app_rx_callback,
 519   .session_cleanup_callback = tls_app_session_cleanup,
 520 };
 521 /* *INDENT-ON* */
 522
 523 int
 524 tls_connect (transport_endpoint_cfg_t * tep)
 525 {
 526   vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
 527   session_endpoint_cfg_t *sep;
 528   crypto_engine_type_t engine_type;
 529   tls_main_t *tm = &tls_main;
 530   app_worker_t *app_wrk;
 531   application_t *app;
 532   tls_ctx_t *ctx;
 533   u32 ctx_index;
 534   int rv;
 535
 536   sep = (session_endpoint_cfg_t *) tep;
 537   app_wrk = app_worker_get (sep->app_wrk_index);
 538   app = application_get (app_wrk->app_index);
 539   engine_type = tls_get_engine_type (app->tls_engine);
 540   if (engine_type == CRYPTO_ENGINE_NONE)
 541     {
 542       clib_warning ("No tls engine_type available");
 543       return -1;
 544     }
 545
 546   ctx_index = tls_ctx_half_open_alloc ();
 547   ctx = tls_ctx_half_open_get (ctx_index);
 548   ctx->parent_app_wrk_index = sep->app_wrk_index;
 549   ctx->parent_app_api_context = sep->opaque;
 550   ctx->tcp_is_ip4 = sep->is_ip4;
 551   if (sep->hostname)
 552     {
 553       ctx->srv_hostname = format (0, "%v", sep->hostname);
 554       vec_terminate_c_string (ctx->srv_hostname);
 555     }
 556   tls_ctx_half_open_reader_unlock ();
 557
 558   app_worker_alloc_connects_segment_manager (app_wrk);
 559   ctx->tls_ctx_engine = engine_type;
 560
 561   clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
 562   cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
 563   cargs->app_index = tm->app_index;
 564   cargs->api_context = ctx_index;
 565   cargs->sep_ext.ns_index = app->ns_index;
 566   if ((rv = vnet_connect (cargs)))
 567     return rv;
 568
 569   TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
 570   return 0;
 571 }
 572
 573 void
 574 tls_disconnect (u32 ctx_handle, u32 thread_index)
 575 {
 576   tls_ctx_t *ctx;
 577
 578   TLS_DBG (1, "Disconnecting %x", ctx_handle);
 579
 580   ctx = tls_ctx_get (ctx_handle);
 581   tls_ctx_app_close (ctx);
 582 }
 583
 584 u32
 585 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
 586 {
 587   vnet_listen_args_t _bargs, *args = &_bargs;
 588   app_worker_t *app_wrk;
 589   tls_main_t *tm = &tls_main;
 590   session_handle_t tls_al_handle;
 591   session_endpoint_cfg_t *sep;
 592   session_t *tls_listener;
 593   session_t *app_listener;
 594   crypto_engine_type_t engine_type;
 595   application_t *app;
 596   app_listener_t *al;
 597   tls_ctx_t *lctx;
 598   u32 lctx_index;
 599
 600   sep = (session_endpoint_cfg_t *) tep;
 601   app_wrk = app_worker_get (sep->app_wrk_index);
 602   app = application_get (app_wrk->app_index);
 603   engine_type = tls_get_engine_type (app->tls_engine);
 604   if (engine_type == CRYPTO_ENGINE_NONE)
 605     {
 606       clib_warning ("No tls engine_type available");
 607       return -1;
 608     }
 609
 610   sep->transport_proto = TRANSPORT_PROTO_TCP;
 611   clib_memset (args, 0, sizeof (*args));
 612   args->app_index = tm->app_index;
 613   args->sep_ext = *sep;
 614   args->sep_ext.ns_index = app->ns_index;
 615   if (vnet_listen (args))
 616     return -1;
 617
 618   lctx_index = tls_listener_ctx_alloc ();
 619   tls_al_handle = args->handle;
 620   al = app_listener_get_w_handle (tls_al_handle);
 621   tls_listener = app_listener_get_session (al);
 622   tls_listener->opaque = lctx_index;
 623
 624   app_listener = listen_session_get (app_listener_index);
 625
 626   lctx = tls_listener_ctx_get (lctx_index);
 627   lctx->parent_app_wrk_index = sep->app_wrk_index;
 628   lctx->tls_session_handle = tls_al_handle;
 629   lctx->app_session_handle = listen_session_get_handle (app_listener);
 630   lctx->tcp_is_ip4 = sep->is_ip4;
 631   lctx->tls_ctx_engine = engine_type;
 632   lctx->ckpair_index = sep->ckpair_index;
 633
 634   if (tls_vfts[engine_type].ctx_start_listen (lctx))
 635     {
 636       vnet_unlisten_args_t a = {
 637         .handle = lctx->tls_session_handle,
 638         .app_index = tls_main.app_index,
 639         .wrk_map_index = 0
 640       };
 641       if ((vnet_unlisten (&a)))
 642         clib_warning ("unlisten returned");
 643       tls_listener_ctx_free (lctx);
 644       lctx_index = SESSION_INVALID_INDEX;
 645     }
 646
 647   TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
 648            engine_type);
 649   return lctx_index;
 650 }
 651
 652 u32
 653 tls_stop_listen (u32 lctx_index)
 654 {
 655   crypto_engine_type_t engine_type;
 656   tls_ctx_t *lctx;
 657   int rv;
 658
 659   lctx = tls_listener_ctx_get (lctx_index);
 660   vnet_unlisten_args_t a = {
 661     .handle = lctx->tls_session_handle,
 662     .app_index = tls_main.app_index,
 663     .wrk_map_index = 0          /* default wrk */
 664   };
 665   if ((rv = vnet_unlisten (&a)))
 666     clib_warning ("unlisten returned %d", rv);
 667
 668   engine_type = lctx->tls_ctx_engine;
 669   tls_vfts[engine_type].ctx_stop_listen (lctx);
 670
 671   tls_listener_ctx_free (lctx);
 672   return 0;
 673 }
 674
 675 transport_connection_t *
 676 tls_connection_get (u32 ctx_index, u32 thread_index)
 677 {
 678   tls_ctx_t *ctx;
 679   ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
 680   return &ctx->connection;
 681 }
 682
 683 transport_connection_t *
 684 tls_listener_get (u32 listener_index)
 685 {
 686   tls_ctx_t *ctx;
 687   ctx = tls_listener_ctx_get (listener_index);
 688   return &ctx->connection;
 689 }
 690
 691 int
 692 tls_custom_tx_callback (void *session, u32 max_burst_size)
 693 {
 694   session_t *app_session = (session_t *) session;
 695   tls_ctx_t *ctx;
 696
 697   if (PREDICT_FALSE (app_session->session_state
 698                      >= SESSION_STATE_TRANSPORT_CLOSED))
 699     return 0;
 700
 701   ctx = tls_ctx_get (app_session->connection_index);
 702   tls_ctx_write (ctx, app_session);
 703   return 0;
 704 }
 705
 706 u8 *
 707 format_tls_ctx (u8 * s, va_list * args)
 708 {
 709   u32 tcp_si, tcp_ti, ctx_index, ctx_engine, app_si, app_ti;
 710   tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
 711
 712   session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
 713   tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
 714   session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
 715   s = format (s, "[%d:%d][TLS] app_wrk %u index %u engine %u tcp %d:%d",
 716               app_ti, app_si, ctx->parent_app_wrk_index, ctx_index,
 717               ctx_engine, tcp_ti, tcp_si);
 718
 719   return s;
 720 }
 721
 722 u8 *
 723 format_tls_connection (u8 * s, va_list * args)
 724 {
 725   u32 ctx_index = va_arg (*args, u32);
 726   u32 thread_index = va_arg (*args, u32);
 727   u32 verbose = va_arg (*args, u32);
 728   tls_ctx_t *ctx;
 729
 730   ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
 731   if (!ctx)
 732     return s;
 733
 734   s = format (s, "%-50U", format_tls_ctx, ctx);
 735   if (verbose)
 736     {
 737       session_t *ts;
 738       ts = session_get_from_handle (ctx->app_session_handle);
 739       s = format (s, "state: %-7u", ts->session_state);
 740       if (verbose > 1)
 741         s = format (s, "\n");
 742     }
 743   return s;
 744 }
 745
 746 u8 *
 747 format_tls_listener (u8 * s, va_list * args)
 748 {
 749   u32 tc_index = va_arg (*args, u32);
 750   u32 __clib_unused thread_index = va_arg (*args, u32);
 751   u32 __clib_unused verbose = va_arg (*args, u32);
 752   tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
 753   session_t *tls_listener;
 754   app_listener_t *al;
 755   u32 app_si, app_ti;
 756
 757   al = app_listener_get_w_handle (ctx->tls_session_handle);
 758   tls_listener = app_listener_get_session (al);
 759   session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
 760   s = format (s, "[%d:%d][TLS] app_wrk %u engine %u tcp %d:%d",
 761               app_ti, app_si, ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
 762               tls_listener->thread_index, tls_listener->session_index);
 763   return s;
 764 }
 765
 766 u8 *
 767 format_tls_half_open (u8 * s, va_list * args)
 768 {
 769   u32 tc_index = va_arg (*args, u32);
 770   u32 __clib_unused thread_index = va_arg (*args, u32);
 771   tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
 772   s = format (s, "[TLS] half-open app %u", ctx->parent_app_wrk_index);
 773   tls_ctx_half_open_reader_unlock ();
 774   return s;
 775 }
 776
 777 static void
 778 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
 779                             transport_endpoint_t * tep, u8 is_lcl)
 780 {
 781   tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
 782   session_t *tcp_session;
 783
 784   tcp_session = session_get_from_handle (ctx->tls_session_handle);
 785   session_get_endpoint (tcp_session, tep, is_lcl);
 786 }
 787
 788 static void
 789 tls_transport_listener_endpoint_get (u32 ctx_handle,
 790                                      transport_endpoint_t * tep, u8 is_lcl)
 791 {
 792   session_t *tls_listener;
 793   app_listener_t *al;
 794   tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
 795
 796   al = app_listener_get_w_handle (ctx->tls_session_handle);
 797   tls_listener = app_listener_get_session (al);
 798   session_get_endpoint (tls_listener, tep, is_lcl);
 799 }
 800
 801 /* *INDENT-OFF* */
 802 static const transport_proto_vft_t tls_proto = {
 803   .connect = tls_connect,
 804   .close = tls_disconnect,
 805   .start_listen = tls_start_listen,
 806   .stop_listen = tls_stop_listen,
 807   .get_connection = tls_connection_get,
 808   .get_listener = tls_listener_get,
 809   .custom_tx = tls_custom_tx_callback,
 810   .format_connection = format_tls_connection,
 811   .format_half_open = format_tls_half_open,
 812   .format_listener = format_tls_listener,
 813   .get_transport_endpoint = tls_transport_endpoint_get,
 814   .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
 815   .transport_options = {
 816     .tx_type = TRANSPORT_TX_INTERNAL,
 817     .service_type = TRANSPORT_SERVICE_APP,
 818   },
 819 };
 820 /* *INDENT-ON* */
 821
 822 void
 823 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
 824 {
 825   vec_validate (tls_vfts, type);
 826   tls_vfts[type] = *vft;
 827 }
 828
 829 static clib_error_t *
 830 tls_init (vlib_main_t * vm)
 831 {
 832   u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
 833   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 834   u32 num_threads, fifo_size = 128 << 10;
 835   vnet_app_attach_args_t _a, *a = &_a;
 836   u64 options[APP_OPTIONS_N_OPTIONS];
 837   tls_main_t *tm = &tls_main;
 838
 839   first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
 840   fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
 841   num_threads = 1 /* main thread */  + vtm->n_threads;
 842
 843   clib_memset (a, 0, sizeof (*a));
 844   clib_memset (options, 0, sizeof (options));
 845
 846   a->session_cb_vft = &tls_app_cb_vft;
 847   a->api_client_index = APP_INVALID_INDEX;
 848   a->options = options;
 849   a->name = format (0, "tls");
 850   a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
 851   a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
 852   a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
 853   a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
 854   a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
 855   a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 856   a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
 857
 858   if (vnet_application_attach (a))
 859     {
 860       clib_warning ("failed to attach tls app");
 861       return clib_error_return (0, "failed to attach tls app");
 862     }
 863
 864   if (!tm->ca_cert_path)
 865     tm->ca_cert_path = TLS_CA_CERT_PATH;
 866
 867   tm->app_index = a->app_index;
 868   clib_rwlock_init (&tm->half_open_rwlock);
 869
 870   vec_validate (tm->rx_bufs, num_threads - 1);
 871   vec_validate (tm->tx_bufs, num_threads - 1);
 872
 873   transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
 874                                FIB_PROTOCOL_IP4, ~0);
 875   transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
 876                                FIB_PROTOCOL_IP6, ~0);
 877   vec_free (a->name);
 878   return 0;
 879 }
 880
 881 VLIB_INIT_FUNCTION (tls_init);
 882
 883 static clib_error_t *
 884 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
 885 {
 886   tls_main_t *tm = &tls_main;
 887   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 888     {
 889       if (unformat (input, "use-test-cert-in-ca"))
 890         tm->use_test_cert_in_ca = 1;
 891       else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
 892         ;
 893       else if (unformat (input, "first-segment-size %U", unformat_memory_size,
 894                          &tm->first_seg_size))
 895         ;
 896       else if (unformat (input, "fifo-size %U", unformat_memory_size,
 897                          &tm->fifo_size))
 898         ;
 899       else
 900         return clib_error_return (0, "unknown input `%U'",
 901                                   format_unformat_error, input);
 902     }
 903   return 0;
 904 }
 905
 906 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
 907
 908 tls_main_t *
 909 vnet_tls_get_main (void)
 910 {
 911   return &tls_main;
 912 }
 913
 914 /*
 915  * fd.io coding-style-patch-verification: ON
 916  *
 917  * Local Variables:
 918  * eval: (c-set-style "gnu")
 919  * End:
 920  */