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