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