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