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   ctx->parent_app_wrk_index = app_session->app_wrk_index;
 215   app_wrk = app_worker_get (app_session->app_wrk_index);
 216   return app_worker_accept_notify (app_wrk, app_session);
 217 }
 218
 219 int
 220 tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
 221 {
 222   session_t *app_session;
 223   app_worker_t *app_wrk;
 224
 225   app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
 226   if (!app_wrk)
 227     {
 228       tls_disconnect_transport (ctx);
 229       return -1;
 230     }
 231
 232   if (err)
 233     goto failed;
 234
 235   app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
 236   app_session->app_wrk_index = ctx->parent_app_wrk_index;
 237   app_session->connection_index = ctx->tls_ctx_handle;
 238   app_session->session_type =
 239     session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
 240
 241   if ((err = app_worker_init_connected (app_wrk, app_session)))
 242     goto failed;
 243
 244   app_session->session_state = SESSION_STATE_CONNECTING;
 245   if (app_worker_connect_notify (app_wrk, app_session,
 246                                  SESSION_E_NONE, ctx->parent_app_api_context))
 247     {
 248       TLS_DBG (1, "failed to notify app");
 249       tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
 250       return -1;
 251     }
 252
 253   ctx->app_session_handle = session_handle (app_session);
 254   app_session->session_state = SESSION_STATE_READY;
 255
 256   return 0;
 257
 258 failed:
 259   /* Free app session pre-allocated when transport was established */
 260   session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
 261   ctx->no_app_session = 1;
 262   tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
 263   return app_worker_connect_notify (app_wrk, 0, err,
 264                                     ctx->parent_app_api_context);
 265 }
 266
 267 static inline void
 268 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
 269 {
 270   *ctx_index = ctx_handle & TLS_IDX_MASK;
 271   *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
 272 }
 273
 274 static inline crypto_engine_type_t
 275 tls_get_engine_type (crypto_engine_type_t preferred)
 276 {
 277   if (!tls_vfts[preferred].ctx_alloc)
 278     return tls_get_available_engine ();
 279   return preferred;
 280 }
 281
 282 static inline u32
 283 tls_ctx_alloc (crypto_engine_type_t engine_type)
 284 {
 285   u32 ctx_index;
 286   ctx_index = tls_vfts[engine_type].ctx_alloc ();
 287   return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
 288 }
 289
 290 static inline tls_ctx_t *
 291 tls_ctx_get (u32 ctx_handle)
 292 {
 293   u32 ctx_index, engine_type;
 294   tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
 295   return tls_vfts[engine_type].ctx_get (ctx_index);
 296 }
 297
 298 static inline tls_ctx_t *
 299 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
 300 {
 301   u32 ctx_index, engine_type;
 302   tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
 303   return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
 304 }
 305
 306 static inline int
 307 tls_ctx_init_server (tls_ctx_t * ctx)
 308 {
 309   return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
 310 }
 311
 312 static inline int
 313 tls_ctx_init_client (tls_ctx_t * ctx)
 314 {
 315   return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
 316 }
 317
 318 static inline int
 319 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session)
 320 {
 321   return tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session);
 322 }
 323
 324 static inline int
 325 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
 326 {
 327   return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
 328 }
 329
 330 static inline int
 331 tls_ctx_transport_close (tls_ctx_t * ctx)
 332 {
 333   return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
 334 }
 335
 336 static inline int
 337 tls_ctx_app_close (tls_ctx_t * ctx)
 338 {
 339   return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
 340 }
 341
 342 void
 343 tls_ctx_free (tls_ctx_t * ctx)
 344 {
 345   tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
 346 }
 347
 348 u8
 349 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
 350 {
 351   return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
 352 }
 353
 354 void
 355 tls_session_reset_callback (session_t * s)
 356 {
 357   tls_ctx_t *ctx;
 358   transport_connection_t *tc;
 359   session_t *app_session;
 360
 361   ctx = tls_ctx_get (s->opaque);
 362   ctx->is_passive_close = 1;
 363   tc = &ctx->connection;
 364   if (tls_ctx_handshake_is_over (ctx))
 365     {
 366       session_transport_reset_notify (tc);
 367       session_transport_closed_notify (tc);
 368       tls_disconnect_transport (ctx);
 369     }
 370   else
 371     if ((app_session =
 372          session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
 373     {
 374       session_free (app_session);
 375       ctx->c_s_index = SESSION_INVALID_INDEX;
 376       tls_disconnect_transport (ctx);
 377     }
 378 }
 379
 380 int
 381 tls_add_segment_callback (u32 client_index, u64 segment_handle)
 382 {
 383   /* No-op for builtin */
 384   return 0;
 385 }
 386
 387 int
 388 tls_del_segment_callback (u32 client_index, u64 segment_handle)
 389 {
 390   return 0;
 391 }
 392
 393 void
 394 tls_session_disconnect_callback (session_t * tls_session)
 395 {
 396   tls_ctx_t *ctx;
 397
 398   TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
 399            tls_session->session_index);
 400
 401   ASSERT (tls_session->thread_index == vlib_get_thread_index ()
 402           || vlib_thread_is_main_w_barrier ());
 403
 404   ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
 405   ctx->is_passive_close = 1;
 406   tls_ctx_transport_close (ctx);
 407 }
 408
 409 int
 410 tls_session_accept_callback (session_t * tls_session)
 411 {
 412   session_t *tls_listener, *app_session;
 413   tls_ctx_t *lctx, *ctx;
 414   u32 ctx_handle;
 415
 416   tls_listener =
 417     listen_session_get_from_handle (tls_session->listener_handle);
 418   lctx = tls_listener_ctx_get (tls_listener->opaque);
 419
 420   ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
 421   ctx = tls_ctx_get (ctx_handle);
 422   memcpy (ctx, lctx, sizeof (*lctx));
 423   ctx->c_thread_index = vlib_get_thread_index ();
 424   ctx->tls_ctx_handle = ctx_handle;
 425   tls_session->session_state = SESSION_STATE_READY;
 426   tls_session->opaque = ctx_handle;
 427   ctx->tls_session_handle = session_handle (tls_session);
 428   ctx->listener_ctx_index = tls_listener->opaque;
 429   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
 430   ctx->ckpair_index = lctx->ckpair_index;
 431
 432   /* Preallocate app session. Avoids allocating a session post handshake
 433    * on tls_session rx and potentially invalidating the session pool */
 434   app_session = session_alloc (ctx->c_thread_index);
 435   app_session->session_state = SESSION_STATE_CREATED;
 436   ctx->c_s_index = app_session->session_index;
 437
 438   TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
 439            tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
 440
 441   return tls_ctx_init_server (ctx);
 442 }
 443
 444 int
 445 tls_app_rx_callback (session_t * tls_session)
 446 {
 447   tls_ctx_t *ctx;
 448
 449   ctx = tls_ctx_get (tls_session->opaque);
 450   tls_ctx_read (ctx, tls_session);
 451   return 0;
 452 }
 453
 454 int
 455 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
 456                                 session_t * tls_session, session_error_t err)
 457 {
 458   session_t *app_session;
 459   tls_ctx_t *ho_ctx, *ctx;
 460   u32 ctx_handle;
 461
 462   ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
 463
 464   if (err)
 465     {
 466       app_worker_t *app_wrk;
 467       u32 api_context;
 468       int rv = 0;
 469
 470       app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
 471       if (app_wrk)
 472         {
 473           api_context = ho_ctx->c_s_index;
 474           app_worker_connect_notify (app_wrk, 0, err, api_context);
 475         }
 476       tls_ctx_half_open_reader_unlock ();
 477       tls_ctx_half_open_free (ho_ctx_index);
 478       return rv;
 479     }
 480
 481   ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
 482   ctx = tls_ctx_get (ctx_handle);
 483   clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
 484   tls_ctx_half_open_reader_unlock ();
 485   tls_ctx_half_open_free (ho_ctx_index);
 486
 487   ctx->c_thread_index = vlib_get_thread_index ();
 488   ctx->tls_ctx_handle = ctx_handle;
 489   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
 490
 491   TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
 492            ho_ctx_index, is_fail, vlib_get_thread_index (),
 493            (ctx) ? ctx_handle : ~0);
 494
 495   ctx->tls_session_handle = session_handle (tls_session);
 496   tls_session->opaque = ctx_handle;
 497   tls_session->session_state = SESSION_STATE_READY;
 498
 499   /* Preallocate app session. Avoids allocating a session post handshake
 500    * on tls_session rx and potentially invalidating the session pool */
 501   app_session = session_alloc (ctx->c_thread_index);
 502   app_session->session_state = SESSION_STATE_CREATED;
 503   ctx->c_s_index = app_session->session_index;
 504
 505   return tls_ctx_init_client (ctx);
 506 }
 507
 508 static void
 509 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
 510 {
 511   tls_ctx_t *ctx;
 512
 513   if (ntf == SESSION_CLEANUP_TRANSPORT)
 514     return;
 515
 516   ctx = tls_ctx_get (s->opaque);
 517   if (!ctx->no_app_session)
 518     session_transport_delete_notify (&ctx->connection);
 519   tls_ctx_free (ctx);
 520 }
 521
 522 /* *INDENT-OFF* */
 523 static session_cb_vft_t tls_app_cb_vft = {
 524   .session_accept_callback = tls_session_accept_callback,
 525   .session_disconnect_callback = tls_session_disconnect_callback,
 526   .session_connected_callback = tls_session_connected_callback,
 527   .session_reset_callback = tls_session_reset_callback,
 528   .add_segment_callback = tls_add_segment_callback,
 529   .del_segment_callback = tls_del_segment_callback,
 530   .builtin_app_rx_callback = tls_app_rx_callback,
 531   .session_cleanup_callback = tls_app_session_cleanup,
 532 };
 533 /* *INDENT-ON* */
 534
 535 int
 536 tls_connect (transport_endpoint_cfg_t * tep)
 537 {
 538   vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
 539   session_endpoint_cfg_t *sep;
 540   crypto_engine_type_t engine_type;
 541   tls_main_t *tm = &tls_main;
 542   app_worker_t *app_wrk;
 543   application_t *app;
 544   tls_ctx_t *ctx;
 545   u32 ctx_index;
 546   int rv;
 547
 548   sep = (session_endpoint_cfg_t *) tep;
 549   app_wrk = app_worker_get (sep->app_wrk_index);
 550   app = application_get (app_wrk->app_index);
 551   engine_type = tls_get_engine_type (app->tls_engine);
 552   if (engine_type == CRYPTO_ENGINE_NONE)
 553     {
 554       clib_warning ("No tls engine_type available");
 555       return -1;
 556     }
 557
 558   ctx_index = tls_ctx_half_open_alloc ();
 559   ctx = tls_ctx_half_open_get (ctx_index);
 560   ctx->parent_app_wrk_index = sep->app_wrk_index;
 561   ctx->parent_app_api_context = sep->opaque;
 562   ctx->tcp_is_ip4 = sep->is_ip4;
 563   if (sep->hostname)
 564     {
 565       ctx->srv_hostname = format (0, "%v", sep->hostname);
 566       vec_terminate_c_string (ctx->srv_hostname);
 567     }
 568   tls_ctx_half_open_reader_unlock ();
 569
 570   app_worker_alloc_connects_segment_manager (app_wrk);
 571   ctx->tls_ctx_engine = engine_type;
 572
 573   clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
 574   cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
 575   cargs->app_index = tm->app_index;
 576   cargs->api_context = ctx_index;
 577   cargs->sep_ext.ns_index = app->ns_index;
 578   if ((rv = vnet_connect (cargs)))
 579     return rv;
 580
 581   TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
 582   return 0;
 583 }
 584
 585 void
 586 tls_disconnect (u32 ctx_handle, u32 thread_index)
 587 {
 588   tls_ctx_t *ctx;
 589
 590   TLS_DBG (1, "Disconnecting %x", ctx_handle);
 591
 592   ctx = tls_ctx_get (ctx_handle);
 593   tls_ctx_app_close (ctx);
 594 }
 595
 596 u32
 597 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
 598 {
 599   vnet_listen_args_t _bargs, *args = &_bargs;
 600   app_worker_t *app_wrk;
 601   tls_main_t *tm = &tls_main;
 602   session_handle_t tls_al_handle;
 603   session_endpoint_cfg_t *sep;
 604   session_t *tls_listener;
 605   session_t *app_listener;
 606   crypto_engine_type_t engine_type;
 607   application_t *app;
 608   app_listener_t *al;
 609   tls_ctx_t *lctx;
 610   u32 lctx_index;
 611
 612   sep = (session_endpoint_cfg_t *) tep;
 613   app_wrk = app_worker_get (sep->app_wrk_index);
 614   app = application_get (app_wrk->app_index);
 615   engine_type = tls_get_engine_type (app->tls_engine);
 616   if (engine_type == CRYPTO_ENGINE_NONE)
 617     {
 618       clib_warning ("No tls engine_type available");
 619       return -1;
 620     }
 621
 622   clib_memset (args, 0, sizeof (*args));
 623   args->app_index = tm->app_index;
 624   args->sep_ext = *sep;
 625   args->sep_ext.ns_index = app->ns_index;
 626   args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
 627   if (vnet_listen (args))
 628     return -1;
 629
 630   lctx_index = tls_listener_ctx_alloc ();
 631   tls_al_handle = args->handle;
 632   al = app_listener_get_w_handle (tls_al_handle);
 633   tls_listener = app_listener_get_session (al);
 634   tls_listener->opaque = lctx_index;
 635
 636   app_listener = listen_session_get (app_listener_index);
 637
 638   lctx = tls_listener_ctx_get (lctx_index);
 639   lctx->parent_app_wrk_index = sep->app_wrk_index;
 640   lctx->tls_session_handle = tls_al_handle;
 641   lctx->app_session_handle = listen_session_get_handle (app_listener);
 642   lctx->tcp_is_ip4 = sep->is_ip4;
 643   lctx->tls_ctx_engine = engine_type;
 644   lctx->ckpair_index = sep->ckpair_index;
 645
 646   if (tls_vfts[engine_type].ctx_start_listen (lctx))
 647     {
 648       vnet_unlisten_args_t a = {
 649         .handle = lctx->tls_session_handle,
 650         .app_index = tls_main.app_index,
 651         .wrk_map_index = 0
 652       };
 653       if ((vnet_unlisten (&a)))
 654         clib_warning ("unlisten returned");
 655       tls_listener_ctx_free (lctx);
 656       lctx_index = SESSION_INVALID_INDEX;
 657     }
 658
 659   TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
 660            engine_type);
 661   return lctx_index;
 662 }
 663
 664 u32
 665 tls_stop_listen (u32 lctx_index)
 666 {
 667   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
 668   crypto_engine_type_t engine_type;
 669   transport_connection_t *lc;
 670   tls_ctx_t *lctx;
 671   session_t *ls;
 672   int rv;
 673
 674   lctx = tls_listener_ctx_get (lctx_index);
 675
 676   /* Cleanup listener from session lookup table */
 677   ls = session_get_from_handle (lctx->tls_session_handle);
 678   lc = session_get_transport (ls);
 679
 680   sep.fib_index = lc->fib_index;
 681   sep.port = lc->lcl_port;
 682   sep.is_ip4 = lc->is_ip4;
 683   sep.transport_proto = TRANSPORT_PROTO_TLS;
 684   clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
 685   session_lookup_del_session_endpoint2 (&sep);
 686
 687   vnet_unlisten_args_t a = {
 688     .handle = lctx->tls_session_handle,
 689     .app_index = tls_main.app_index,
 690     .wrk_map_index = 0          /* default wrk */
 691   };
 692   if ((rv = vnet_unlisten (&a)))
 693     clib_warning ("unlisten returned %d", rv);
 694
 695   engine_type = lctx->tls_ctx_engine;
 696   tls_vfts[engine_type].ctx_stop_listen (lctx);
 697
 698   tls_listener_ctx_free (lctx);
 699   return 0;
 700 }
 701
 702 transport_connection_t *
 703 tls_connection_get (u32 ctx_index, u32 thread_index)
 704 {
 705   tls_ctx_t *ctx;
 706   ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
 707   return &ctx->connection;
 708 }
 709
 710 transport_connection_t *
 711 tls_listener_get (u32 listener_index)
 712 {
 713   tls_ctx_t *ctx;
 714   ctx = tls_listener_ctx_get (listener_index);
 715   return &ctx->connection;
 716 }
 717
 718 int
 719 tls_custom_tx_callback (void *session, u32 max_burst_size)
 720 {
 721   session_t *app_session = (session_t *) session;
 722   tls_ctx_t *ctx;
 723
 724   if (PREDICT_FALSE (app_session->session_state
 725                      >= SESSION_STATE_TRANSPORT_CLOSED))
 726     return 0;
 727
 728   ctx = tls_ctx_get (app_session->connection_index);
 729   tls_ctx_write (ctx, app_session);
 730   return 0;
 731 }
 732
 733 u8 *
 734 format_tls_ctx (u8 * s, va_list * args)
 735 {
 736   u32 tcp_si, tcp_ti, ctx_index, ctx_engine, app_si, app_ti;
 737   tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
 738
 739   session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
 740   tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
 741   session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
 742   s = format (s, "[%d:%d][TLS] app_wrk %u index %u engine %u tcp %d:%d",
 743               app_ti, app_si, ctx->parent_app_wrk_index, ctx_index,
 744               ctx_engine, tcp_ti, tcp_si);
 745
 746   return s;
 747 }
 748
 749 static u8 *
 750 format_tls_listener_ctx (u8 * s, va_list * args)
 751 {
 752   session_t *tls_listener;
 753   app_listener_t *al;
 754   u32 app_si, app_ti;
 755   tls_ctx_t *ctx;
 756
 757   ctx = va_arg (*args, tls_ctx_t *);
 758
 759   al = app_listener_get_w_handle (ctx->tls_session_handle);
 760   tls_listener = app_listener_get_session (al);
 761   session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
 762   s = format (s, "[%d:%d][TLS] app_wrk %u engine %u tcp %d:%d",
 763               app_ti, app_si, ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
 764               tls_listener->thread_index, tls_listener->session_index);
 765
 766   return s;
 767 }
 768
 769 static u8 *
 770 format_tls_ctx_state (u8 * s, va_list * args)
 771 {
 772   tls_ctx_t *ctx;
 773   session_t *ts;
 774
 775   ctx = va_arg (*args, tls_ctx_t *);
 776   ts = session_get_from_handle (ctx->app_session_handle);
 777   if (ts->session_state == SESSION_STATE_LISTENING)
 778     s = format (s, "%s", "LISTEN");
 779   else if (tls_ctx_handshake_is_over (ctx))
 780     s = format (s, "%s", "ESTABLISHED");
 781   else
 782     s = format (s, "%s", "HANDSHAKE");
 783
 784   return s;
 785 }
 786
 787 u8 *
 788 format_tls_connection (u8 * s, va_list * args)
 789 {
 790   u32 ctx_index = va_arg (*args, u32);
 791   u32 thread_index = va_arg (*args, u32);
 792   u32 verbose = va_arg (*args, u32);
 793   tls_ctx_t *ctx;
 794
 795   ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
 796   if (!ctx)
 797     return s;
 798
 799   s = format (s, "%-50U", format_tls_ctx, ctx);
 800   if (verbose)
 801     {
 802       s = format (s, "%-15U", format_tls_ctx_state, ctx);
 803       if (verbose > 1)
 804         s = format (s, "\n");
 805     }
 806   return s;
 807 }
 808
 809 u8 *
 810 format_tls_listener (u8 * s, va_list * args)
 811 {
 812   u32 tc_index = va_arg (*args, u32);
 813   u32 __clib_unused thread_index = va_arg (*args, u32);
 814   u32 verbose = va_arg (*args, u32);
 815   tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
 816
 817   s = format (s, "%-50U", format_tls_listener_ctx, ctx);
 818   if (verbose)
 819     s = format (s, "%-15U", format_tls_ctx_state, ctx);
 820   return s;
 821 }
 822
 823 u8 *
 824 format_tls_half_open (u8 * s, va_list * args)
 825 {
 826   u32 tc_index = va_arg (*args, u32);
 827   u32 __clib_unused thread_index = va_arg (*args, u32);
 828   tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
 829   s = format (s, "[TLS] half-open app %u", ctx->parent_app_wrk_index);
 830   tls_ctx_half_open_reader_unlock ();
 831   return s;
 832 }
 833
 834 static void
 835 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
 836                             transport_endpoint_t * tep, u8 is_lcl)
 837 {
 838   tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
 839   session_t *tcp_session;
 840
 841   tcp_session = session_get_from_handle (ctx->tls_session_handle);
 842   session_get_endpoint (tcp_session, tep, is_lcl);
 843 }
 844
 845 static void
 846 tls_transport_listener_endpoint_get (u32 ctx_handle,
 847                                      transport_endpoint_t * tep, u8 is_lcl)
 848 {
 849   session_t *tls_listener;
 850   app_listener_t *al;
 851   tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
 852
 853   al = app_listener_get_w_handle (ctx->tls_session_handle);
 854   tls_listener = app_listener_get_session (al);
 855   session_get_endpoint (tls_listener, tep, is_lcl);
 856 }
 857
 858 /* *INDENT-OFF* */
 859 static const transport_proto_vft_t tls_proto = {
 860   .connect = tls_connect,
 861   .close = tls_disconnect,
 862   .start_listen = tls_start_listen,
 863   .stop_listen = tls_stop_listen,
 864   .get_connection = tls_connection_get,
 865   .get_listener = tls_listener_get,
 866   .custom_tx = tls_custom_tx_callback,
 867   .format_connection = format_tls_connection,
 868   .format_half_open = format_tls_half_open,
 869   .format_listener = format_tls_listener,
 870   .get_transport_endpoint = tls_transport_endpoint_get,
 871   .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
 872   .transport_options = {
 873     .name = "tls",
 874     .short_name = "J",
 875     .tx_type = TRANSPORT_TX_INTERNAL,
 876     .service_type = TRANSPORT_SERVICE_APP,
 877   },
 878 };
 879 /* *INDENT-ON* */
 880
 881 void
 882 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
 883 {
 884   vec_validate (tls_vfts, type);
 885   tls_vfts[type] = *vft;
 886 }
 887
 888 static clib_error_t *
 889 tls_init (vlib_main_t * vm)
 890 {
 891   u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
 892   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 893   u32 num_threads, fifo_size = 128 << 10;
 894   vnet_app_attach_args_t _a, *a = &_a;
 895   u64 options[APP_OPTIONS_N_OPTIONS];
 896   tls_main_t *tm = &tls_main;
 897
 898   first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
 899   fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
 900   num_threads = 1 /* main thread */  + vtm->n_threads;
 901
 902   clib_memset (a, 0, sizeof (*a));
 903   clib_memset (options, 0, sizeof (options));
 904
 905   a->session_cb_vft = &tls_app_cb_vft;
 906   a->api_client_index = APP_INVALID_INDEX;
 907   a->options = options;
 908   a->name = format (0, "tls");
 909   a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
 910   a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
 911   a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
 912   a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
 913   a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
 914   a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
 915   a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
 916
 917   if (vnet_application_attach (a))
 918     {
 919       clib_warning ("failed to attach tls app");
 920       return clib_error_return (0, "failed to attach tls app");
 921     }
 922
 923   if (!tm->ca_cert_path)
 924     tm->ca_cert_path = TLS_CA_CERT_PATH;
 925
 926   tm->app_index = a->app_index;
 927   clib_rwlock_init (&tm->half_open_rwlock);
 928
 929   vec_validate (tm->rx_bufs, num_threads - 1);
 930   vec_validate (tm->tx_bufs, num_threads - 1);
 931
 932   transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
 933                                FIB_PROTOCOL_IP4, ~0);
 934   transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
 935                                FIB_PROTOCOL_IP6, ~0);
 936   vec_free (a->name);
 937   return 0;
 938 }
 939
 940 VLIB_INIT_FUNCTION (tls_init);
 941
 942 static clib_error_t *
 943 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
 944 {
 945   tls_main_t *tm = &tls_main;
 946   uword tmp;
 947   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 948     {
 949       if (unformat (input, "use-test-cert-in-ca"))
 950         tm->use_test_cert_in_ca = 1;
 951       else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
 952         ;
 953       else if (unformat (input, "first-segment-size %U", unformat_memory_size,
 954                          &tm->first_seg_size))
 955         ;
 956       else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
 957         {
 958           if (tmp >= 0x100000000ULL)
 959             {
 960               return clib_error_return
 961                 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
 962             }
 963           tm->fifo_size = tmp;
 964         }
 965       else
 966         return clib_error_return (0, "unknown input `%U'",
 967                                   format_unformat_error, input);
 968     }
 969   return 0;
 970 }
 971
 972 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
 973
 974 tls_main_t *
 975 vnet_tls_get_main (void)
 976 {
 977   return &tls_main;
 978 }
 979
 980 /*
 981  * fd.io coding-style-patch-verification: ON
 982  *
 983  * Local Variables:
 984  * eval: (c-set-style "gnu")
 985  * End:
 986  */