src/plugins/tlsopenssl/tls_openssl.c

   1 /*
   2  * Copyright (c) 2018 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 <openssl/ssl.h>
  17 #include <openssl/conf.h>
  18 #include <openssl/err.h>
  19
  20 #ifdef HAVE_OPENSSL_ASYNC
  21 #include <openssl/async.h>
  22 #endif
  23 #include <dlfcn.h>
  24 #include <vnet/plugin/plugin.h>
  25 #include <vpp/app/version.h>
  26 #include <vnet/tls/tls.h>
  27 #include <ctype.h>
  28 #include <tlsopenssl/tls_openssl.h>
  29 #include <tlsopenssl/tls_bios.h>
  30
  31 #define MAX_CRYPTO_LEN 64
  32
  33 openssl_main_t openssl_main;
  34
  35 static u32
  36 openssl_ctx_alloc_w_thread (u32 thread_index)
  37 {
  38   openssl_main_t *om = &openssl_main;
  39   openssl_ctx_t **ctx;
  40
  41   pool_get (om->ctx_pool[thread_index], ctx);
  42   if (!(*ctx))
  43     *ctx = clib_mem_alloc (sizeof (openssl_ctx_t));
  44
  45   clib_memset (*ctx, 0, sizeof (openssl_ctx_t));
  46   (*ctx)->ctx.c_thread_index = thread_index;
  47   (*ctx)->ctx.tls_ctx_engine = CRYPTO_ENGINE_OPENSSL;
  48   (*ctx)->ctx.app_session_handle = SESSION_INVALID_HANDLE;
  49   (*ctx)->openssl_ctx_index = ctx - om->ctx_pool[thread_index];
  50   return ((*ctx)->openssl_ctx_index);
  51 }
  52
  53 static u32
  54 openssl_ctx_alloc (void)
  55 {
  56   return openssl_ctx_alloc_w_thread (vlib_get_thread_index ());
  57 }
  58
  59 static void
  60 openssl_ctx_free (tls_ctx_t * ctx)
  61 {
  62   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
  63
  64   /* Cleanup ssl ctx unless migrated */
  65   if (!ctx->is_migrated)
  66     {
  67       if (SSL_is_init_finished (oc->ssl) && !ctx->is_passive_close)
  68         SSL_shutdown (oc->ssl);
  69
  70       SSL_free (oc->ssl);
  71       vec_free (ctx->srv_hostname);
  72
  73 #ifdef HAVE_OPENSSL_ASYNC
  74   openssl_evt_free (ctx->evt_index, ctx->c_thread_index);
  75 #endif
  76     }
  77
  78   pool_put_index (openssl_main.ctx_pool[ctx->c_thread_index],
  79                   oc->openssl_ctx_index);
  80 }
  81
  82 static void *
  83 openssl_ctx_detach (tls_ctx_t *ctx)
  84 {
  85   openssl_ctx_t *oc = (openssl_ctx_t *) ctx, *oc_copy;
  86
  87   oc_copy = clib_mem_alloc (sizeof (*oc_copy));
  88   clib_memcpy (oc_copy, oc, sizeof (*oc));
  89
  90   return oc_copy;
  91 }
  92
  93 static u32
  94 openssl_ctx_attach (u32 thread_index, void *ctx_ptr)
  95 {
  96   openssl_main_t *om = &openssl_main;
  97   session_handle_t sh;
  98   openssl_ctx_t **oc;
  99
 100   pool_get (om->ctx_pool[thread_index], oc);
 101   /* Free the old instance instead of looking for an empty spot */
 102   if (*oc)
 103     clib_mem_free (*oc);
 104
 105   *oc = ctx_ptr;
 106   (*oc)->openssl_ctx_index = oc - om->ctx_pool[thread_index];
 107   (*oc)->ctx.c_thread_index = thread_index;
 108
 109   sh = (*oc)->ctx.tls_session_handle;
 110   BIO_set_data ((*oc)->rbio, uword_to_pointer (sh, void *));
 111   BIO_set_data ((*oc)->wbio, uword_to_pointer (sh, void *));
 112
 113   return ((*oc)->openssl_ctx_index);
 114 }
 115
 116 tls_ctx_t *
 117 openssl_ctx_get (u32 ctx_index)
 118 {
 119   openssl_ctx_t **ctx;
 120   ctx = pool_elt_at_index (openssl_main.ctx_pool[vlib_get_thread_index ()],
 121                            ctx_index);
 122   return &(*ctx)->ctx;
 123 }
 124
 125 tls_ctx_t *
 126 openssl_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
 127 {
 128   openssl_ctx_t **ctx;
 129   ctx = pool_elt_at_index (openssl_main.ctx_pool[thread_index], ctx_index);
 130   return &(*ctx)->ctx;
 131 }
 132
 133 static u32
 134 openssl_listen_ctx_alloc (void)
 135 {
 136   openssl_main_t *om = &openssl_main;
 137   openssl_listen_ctx_t *lctx;
 138
 139   pool_get (om->lctx_pool, lctx);
 140
 141   clib_memset (lctx, 0, sizeof (openssl_listen_ctx_t));
 142   lctx->openssl_lctx_index = lctx - om->lctx_pool;
 143   return lctx->openssl_lctx_index;
 144 }
 145
 146 static void
 147 openssl_listen_ctx_free (openssl_listen_ctx_t * lctx)
 148 {
 149   pool_put_index (openssl_main.lctx_pool, lctx->openssl_lctx_index);
 150 }
 151
 152 openssl_listen_ctx_t *
 153 openssl_lctx_get (u32 lctx_index)
 154 {
 155   return pool_elt_at_index (openssl_main.lctx_pool, lctx_index);
 156 }
 157
 158 static int
 159 openssl_read_from_ssl_into_fifo (svm_fifo_t * f, SSL * ssl)
 160 {
 161   int read, rv, n_fs, i;
 162   const int n_segs = 2;
 163   svm_fifo_seg_t fs[n_segs];
 164   u32 max_enq;
 165
 166   max_enq = svm_fifo_max_enqueue_prod (f);
 167   if (!max_enq)
 168     return 0;
 169
 170   n_fs = svm_fifo_provision_chunks (f, fs, n_segs, max_enq);
 171   if (n_fs < 0)
 172     return 0;
 173
 174   /* Return early if we can't read anything */
 175   read = SSL_read (ssl, fs[0].data, fs[0].len);
 176   if (read <= 0)
 177     return 0;
 178
 179   for (i = 1; i < n_fs; i++)
 180     {
 181       rv = SSL_read (ssl, fs[i].data, fs[i].len);
 182       read += rv > 0 ? rv : 0;
 183
 184       if (rv < (int) fs[i].len)
 185         break;
 186     }
 187
 188   svm_fifo_enqueue_nocopy (f, read);
 189
 190   return read;
 191 }
 192
 193 static int
 194 openssl_write_from_fifo_into_ssl (svm_fifo_t *f, SSL *ssl, u32 max_len)
 195 {
 196   int wrote = 0, rv, i = 0, len;
 197   const int n_segs = 2;
 198   svm_fifo_seg_t fs[n_segs];
 199
 200   len = svm_fifo_segments (f, 0, fs, n_segs, max_len);
 201   if (len <= 0)
 202     return 0;
 203
 204   while (wrote < len && i < n_segs)
 205     {
 206       rv = SSL_write (ssl, fs[i].data, fs[i].len);
 207       wrote += (rv > 0) ? rv : 0;
 208       if (rv < (int) fs[i].len)
 209         break;
 210       i++;
 211     }
 212
 213   if (wrote)
 214     svm_fifo_dequeue_drop (f, wrote);
 215
 216   return wrote;
 217 }
 218
 219 #ifdef HAVE_OPENSSL_ASYNC
 220 static int
 221 openssl_check_async_status (tls_ctx_t * ctx, openssl_resume_handler * handler,
 222                             session_t * session)
 223 {
 224   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 225   int estatus;
 226
 227   SSL_get_async_status (oc->ssl, &estatus);
 228   if (estatus == ASYNC_STATUS_EAGAIN)
 229     {
 230       vpp_tls_async_update_event (ctx, 1);
 231     }
 232   else
 233     {
 234       vpp_tls_async_update_event (ctx, 0);
 235     }
 236
 237   return 1;
 238
 239 }
 240
 241 #endif
 242
 243 static void
 244 openssl_handle_handshake_failure (tls_ctx_t * ctx)
 245 {
 246   session_t *app_session;
 247
 248   if (SSL_is_server (((openssl_ctx_t *) ctx)->ssl))
 249     {
 250       /*
 251        * Cleanup pre-allocated app session and close transport
 252        */
 253       app_session =
 254         session_get_if_valid (ctx->c_s_index, ctx->c_thread_index);
 255       if (app_session)
 256         {
 257           session_free (app_session);
 258           ctx->no_app_session = 1;
 259           ctx->c_s_index = SESSION_INVALID_INDEX;
 260           tls_disconnect_transport (ctx);
 261         }
 262     }
 263   else
 264     {
 265       /*
 266        * Also handles cleanup of the pre-allocated session
 267        */
 268       tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
 269     }
 270 }
 271
 272 int
 273 openssl_ctx_handshake_rx (tls_ctx_t * ctx, session_t * tls_session)
 274 {
 275   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 276   int rv = 0, err;
 277
 278   while (SSL_in_init (oc->ssl))
 279     {
 280       if (ctx->resume)
 281         {
 282           ctx->resume = 0;
 283         }
 284       else if (!svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
 285         break;
 286
 287       rv = SSL_do_handshake (oc->ssl);
 288       err = SSL_get_error (oc->ssl, rv);
 289
 290 #ifdef HAVE_OPENSSL_ASYNC
 291       if (err == SSL_ERROR_WANT_ASYNC)
 292         {
 293           openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
 294                                       tls_session);
 295         }
 296 #endif
 297       if (err == SSL_ERROR_SSL)
 298         {
 299           char buf[512];
 300           ERR_error_string (ERR_get_error (), buf);
 301           clib_warning ("Err: %s", buf);
 302
 303           openssl_handle_handshake_failure (ctx);
 304           return -1;
 305         }
 306
 307       if (err != SSL_ERROR_WANT_WRITE && err != SSL_ERROR_WANT_READ)
 308         break;
 309     }
 310   TLS_DBG (2, "tls state for %u is %s", oc->openssl_ctx_index,
 311            SSL_state_string_long (oc->ssl));
 312
 313   if (SSL_in_init (oc->ssl))
 314     return -1;
 315
 316   /*
 317    * Handshake complete
 318    */
 319   if (!SSL_is_server (oc->ssl))
 320     {
 321       /*
 322        * Verify server certificate
 323        */
 324       if ((rv = SSL_get_verify_result (oc->ssl)) != X509_V_OK)
 325         {
 326           TLS_DBG (1, " failed verify: %s\n",
 327                    X509_verify_cert_error_string (rv));
 328
 329           /*
 330            * Presence of hostname enforces strict certificate verification
 331            */
 332           if (ctx->srv_hostname)
 333             {
 334               tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
 335               return -1;
 336             }
 337         }
 338       tls_notify_app_connected (ctx, SESSION_E_NONE);
 339     }
 340   else
 341     {
 342       /* Need to check transport status */
 343       if (ctx->is_passive_close)
 344         {
 345           openssl_handle_handshake_failure (ctx);
 346           return -1;
 347         }
 348
 349       /* Accept failed, cleanup */
 350       if (tls_notify_app_accept (ctx))
 351         {
 352           ctx->c_s_index = SESSION_INVALID_INDEX;
 353           tls_disconnect_transport (ctx);
 354           return -1;
 355         }
 356     }
 357
 358   TLS_DBG (1, "Handshake for %u complete. TLS cipher is %s",
 359            oc->openssl_ctx_index, SSL_get_cipher (oc->ssl));
 360   return rv;
 361 }
 362
 363 static void
 364 openssl_confirm_app_close (tls_ctx_t * ctx)
 365 {
 366   tls_disconnect_transport (ctx);
 367   session_transport_closed_notify (&ctx->connection);
 368 }
 369
 370 static int
 371 openssl_ctx_write_tls (tls_ctx_t *ctx, session_t *app_session,
 372                        transport_send_params_t *sp)
 373 {
 374   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 375   u32 deq_max, space, enq_buf;
 376   session_t *ts;
 377   int wrote = 0;
 378   svm_fifo_t *f;
 379
 380   ts = session_get_from_handle (ctx->tls_session_handle);
 381   space = svm_fifo_max_enqueue_prod (ts->tx_fifo);
 382   /* Leave a bit of extra space for tls ctrl data, if any needed */
 383   space = clib_max ((int) space - TLSO_CTRL_BYTES, 0);
 384
 385   f = app_session->tx_fifo;
 386
 387   deq_max = svm_fifo_max_dequeue_cons (f);
 388   deq_max = clib_min (deq_max, space);
 389   if (!deq_max)
 390     goto check_tls_fifo;
 391
 392   deq_max = clib_min (deq_max, sp->max_burst_size);
 393
 394   /* Make sure tcp's tx fifo can actually buffer all bytes to be dequeued.
 395    * If under memory pressure, tls's fifo segment might not be able to
 396    * allocate the chunks needed. This also avoids errors from the underlying
 397    * custom bio to the ssl infra which at times can get stuck. */
 398   if (svm_fifo_provision_chunks (ts->tx_fifo, 0, 0, deq_max + TLSO_CTRL_BYTES))
 399     goto check_tls_fifo;
 400
 401   wrote = openssl_write_from_fifo_into_ssl (f, oc->ssl, deq_max);
 402   if (!wrote)
 403     goto check_tls_fifo;
 404
 405   if (svm_fifo_needs_deq_ntf (f, wrote))
 406     session_dequeue_notify (app_session);
 407
 408 check_tls_fifo:
 409
 410   if (PREDICT_FALSE (ctx->app_closed && BIO_ctrl_pending (oc->rbio) <= 0))
 411     openssl_confirm_app_close (ctx);
 412
 413   /* Deschedule and wait for deq notification if fifo is almost full */
 414   enq_buf = clib_min (svm_fifo_size (ts->tx_fifo) / 2, TLSO_MIN_ENQ_SPACE);
 415   if (space < wrote + enq_buf)
 416     {
 417       svm_fifo_add_want_deq_ntf (ts->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
 418       transport_connection_deschedule (&ctx->connection);
 419       sp->flags |= TRANSPORT_SND_F_DESCHED;
 420     }
 421   else
 422     /* Request tx reschedule of the app session */
 423     app_session->flags |= SESSION_F_CUSTOM_TX;
 424
 425   return wrote;
 426 }
 427
 428 static int
 429 openssl_ctx_write_dtls (tls_ctx_t *ctx, session_t *app_session,
 430                         transport_send_params_t *sp)
 431 {
 432   openssl_main_t *om = &openssl_main;
 433   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 434   u32 read = 0, to_deq, dgram_sz, enq_max;
 435   session_dgram_pre_hdr_t hdr;
 436   session_t *us;
 437   int wrote, rv;
 438   u8 *buf;
 439
 440   us = session_get_from_handle (ctx->tls_session_handle);
 441   to_deq = svm_fifo_max_dequeue_cons (app_session->tx_fifo);
 442   buf = om->tx_bufs[ctx->c_thread_index];
 443
 444   while (to_deq > 0)
 445     {
 446       /* Peeking only pre-header dgram because the session is connected */
 447       rv = svm_fifo_peek (app_session->tx_fifo, 0, sizeof (hdr), (u8 *) &hdr);
 448       ASSERT (rv == sizeof (hdr) && hdr.data_length < vec_len (buf));
 449       ASSERT (to_deq >= hdr.data_length + SESSION_CONN_HDR_LEN);
 450
 451       dgram_sz = hdr.data_length + SESSION_CONN_HDR_LEN;
 452       enq_max = dgram_sz + TLSO_CTRL_BYTES;
 453       if (svm_fifo_max_enqueue_prod (us->tx_fifo) < enq_max ||
 454           svm_fifo_provision_chunks (us->tx_fifo, 0, 0, enq_max))
 455         {
 456           svm_fifo_add_want_deq_ntf (us->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
 457           transport_connection_deschedule (&ctx->connection);
 458           sp->flags |= TRANSPORT_SND_F_DESCHED;
 459           goto done;
 460         }
 461
 462       rv = svm_fifo_peek (app_session->tx_fifo, SESSION_CONN_HDR_LEN,
 463                           hdr.data_length, buf);
 464       ASSERT (rv == hdr.data_length);
 465       svm_fifo_dequeue_drop (app_session->tx_fifo, dgram_sz);
 466
 467       wrote = SSL_write (oc->ssl, buf, rv);
 468       ASSERT (wrote > 0);
 469
 470       read += rv;
 471       to_deq -= dgram_sz;
 472     }
 473
 474 done:
 475
 476   if (svm_fifo_needs_deq_ntf (app_session->tx_fifo, read))
 477     session_dequeue_notify (app_session);
 478
 479   if (read)
 480     tls_add_vpp_q_tx_evt (us);
 481
 482   if (PREDICT_FALSE (ctx->app_closed &&
 483                      !svm_fifo_max_enqueue_prod (us->rx_fifo)))
 484     openssl_confirm_app_close (ctx);
 485
 486   return read;
 487 }
 488
 489 static inline int
 490 openssl_ctx_write (tls_ctx_t *ctx, session_t *app_session,
 491                    transport_send_params_t *sp)
 492 {
 493   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
 494     return openssl_ctx_write_tls (ctx, app_session, sp);
 495   else
 496     return openssl_ctx_write_dtls (ctx, app_session, sp);
 497 }
 498
 499 static inline int
 500 openssl_ctx_read_tls (tls_ctx_t *ctx, session_t *tls_session)
 501 {
 502   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 503   session_t *app_session;
 504   int read;
 505   svm_fifo_t *f;
 506
 507   if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
 508     {
 509       if (openssl_ctx_handshake_rx (ctx, tls_session) < 0)
 510         return 0;
 511     }
 512
 513   app_session = session_get_from_handle (ctx->app_session_handle);
 514   f = app_session->rx_fifo;
 515
 516   read = openssl_read_from_ssl_into_fifo (f, oc->ssl);
 517
 518   /* If handshake just completed, session may still be in accepting state */
 519   if (read && app_session->session_state >= SESSION_STATE_READY)
 520     tls_notify_app_enqueue (ctx, app_session);
 521
 522   if ((SSL_pending (oc->ssl) > 0) ||
 523       svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
 524     tls_add_vpp_q_builtin_rx_evt (tls_session);
 525
 526   return read;
 527 }
 528
 529 static inline int
 530 openssl_ctx_read_dtls (tls_ctx_t *ctx, session_t *us)
 531 {
 532   openssl_main_t *om = &openssl_main;
 533   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 534   session_dgram_hdr_t hdr;
 535   session_t *app_session;
 536   u32 wrote = 0;
 537   int read, rv;
 538   u8 *buf;
 539
 540   if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
 541     {
 542       u32 us_index = us->session_index;
 543       if (openssl_ctx_handshake_rx (ctx, us) < 0)
 544         return 0;
 545       /* Session pool might grow when allocating the app's session */
 546       us = session_get (us_index, ctx->c_thread_index);
 547     }
 548
 549   buf = om->rx_bufs[ctx->c_thread_index];
 550   app_session = session_get_from_handle (ctx->app_session_handle);
 551   svm_fifo_fill_chunk_list (app_session->rx_fifo);
 552
 553   while (svm_fifo_max_dequeue_cons (us->rx_fifo) > 0)
 554     {
 555       if (svm_fifo_max_enqueue_prod (app_session->rx_fifo) < DTLSO_MAX_DGRAM)
 556         {
 557           tls_add_vpp_q_builtin_rx_evt (us);
 558           goto done;
 559         }
 560
 561       read = SSL_read (oc->ssl, buf, vec_len (buf));
 562       if (PREDICT_FALSE (read <= 0))
 563         {
 564           if (read < 0)
 565             tls_add_vpp_q_builtin_rx_evt (us);
 566           goto done;
 567         }
 568       wrote += read;
 569
 570       hdr.data_length = read;
 571       hdr.data_offset = 0;
 572
 573       svm_fifo_seg_t segs[2] = { { (u8 *) &hdr, sizeof (hdr) },
 574                                  { buf, read } };
 575
 576       rv = svm_fifo_enqueue_segments (app_session->rx_fifo, segs, 2,
 577                                       0 /* allow partial */);
 578       ASSERT (rv > 0);
 579     }
 580
 581 done:
 582
 583   /* If handshake just completed, session may still be in accepting state */
 584   if (app_session->session_state >= SESSION_STATE_READY)
 585     tls_notify_app_enqueue (ctx, app_session);
 586
 587   return wrote;
 588 }
 589
 590 static inline int
 591 openssl_ctx_read (tls_ctx_t *ctx, session_t *ts)
 592 {
 593   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
 594     return openssl_ctx_read_tls (ctx, ts);
 595   else
 596     return openssl_ctx_read_dtls (ctx, ts);
 597 }
 598
 599 static int
 600 openssl_ctx_init_client (tls_ctx_t * ctx)
 601 {
 602   long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
 603   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 604   openssl_main_t *om = &openssl_main;
 605   const SSL_METHOD *method;
 606   int rv, err;
 607
 608   method = ctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_client_method () :
 609                                                   DTLS_client_method ();
 610   if (method == NULL)
 611     {
 612       TLS_DBG (1, "(D)TLS_method returned null");
 613       return -1;
 614     }
 615
 616   oc->ssl_ctx = SSL_CTX_new (method);
 617   if (oc->ssl_ctx == NULL)
 618     {
 619       TLS_DBG (1, "SSL_CTX_new returned null");
 620       return -1;
 621     }
 622
 623   SSL_CTX_set_ecdh_auto (oc->ssl_ctx, 1);
 624   SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
 625 #ifdef HAVE_OPENSSL_ASYNC
 626   if (om->async)
 627     SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ASYNC);
 628 #endif
 629   rv = SSL_CTX_set_cipher_list (oc->ssl_ctx, (const char *) om->ciphers);
 630   if (rv != 1)
 631     {
 632       TLS_DBG (1, "Couldn't set cipher");
 633       return -1;
 634     }
 635
 636   SSL_CTX_set_options (oc->ssl_ctx, flags);
 637   SSL_CTX_set_cert_store (oc->ssl_ctx, om->cert_store);
 638
 639   oc->ssl = SSL_new (oc->ssl_ctx);
 640   if (oc->ssl == NULL)
 641     {
 642       TLS_DBG (1, "Couldn't initialize ssl struct");
 643       return -1;
 644     }
 645
 646   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
 647     {
 648       oc->rbio = BIO_new_tls (ctx->tls_session_handle);
 649       oc->wbio = BIO_new_tls (ctx->tls_session_handle);
 650     }
 651   else
 652     {
 653       oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
 654       oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
 655     }
 656
 657   SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
 658   SSL_set_connect_state (oc->ssl);
 659
 660   rv = SSL_set_tlsext_host_name (oc->ssl, ctx->srv_hostname);
 661   if (rv != 1)
 662     {
 663       TLS_DBG (1, "Couldn't set hostname");
 664       return -1;
 665     }
 666
 667   /*
 668    * 2. Do the first steps in the handshake.
 669    */
 670   TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
 671            oc->openssl_ctx_index);
 672
 673 #ifdef HAVE_OPENSSL_ASYNC
 674   session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
 675   vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
 676 #endif
 677   while (1)
 678     {
 679       rv = SSL_do_handshake (oc->ssl);
 680       err = SSL_get_error (oc->ssl, rv);
 681 #ifdef HAVE_OPENSSL_ASYNC
 682       if (err == SSL_ERROR_WANT_ASYNC)
 683         {
 684           openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
 685                                       tls_session);
 686           break;
 687         }
 688 #endif
 689       if (err != SSL_ERROR_WANT_WRITE)
 690         break;
 691     }
 692
 693   TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
 694            oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
 695   return 0;
 696 }
 697
 698 static int
 699 openssl_start_listen (tls_ctx_t * lctx)
 700 {
 701   const SSL_METHOD *method;
 702   SSL_CTX *ssl_ctx;
 703   int rv;
 704   BIO *cert_bio;
 705   X509 *srvcert;
 706   EVP_PKEY *pkey;
 707   u32 olc_index;
 708   openssl_listen_ctx_t *olc;
 709   app_cert_key_pair_t *ckpair;
 710
 711   long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
 712   openssl_main_t *om = &openssl_main;
 713
 714   ckpair = app_cert_key_pair_get_if_valid (lctx->ckpair_index);
 715   if (!ckpair)
 716     return -1;
 717
 718   if (!ckpair->cert || !ckpair->key)
 719     {
 720       TLS_DBG (1, "tls cert and/or key not configured %d",
 721                lctx->parent_app_wrk_index);
 722       return -1;
 723     }
 724
 725   method = lctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_server_method () :
 726                                                    DTLS_server_method ();
 727   ssl_ctx = SSL_CTX_new (method);
 728   if (!ssl_ctx)
 729     {
 730       clib_warning ("Unable to create SSL context");
 731       return -1;
 732     }
 733
 734   SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
 735 #ifdef HAVE_OPENSSL_ASYNC
 736   if (om->async)
 737     {
 738       SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ASYNC);
 739       SSL_CTX_set_async_callback (ssl_ctx, tls_async_openssl_callback);
 740     }
 741 #endif
 742   SSL_CTX_set_options (ssl_ctx, flags);
 743   SSL_CTX_set_ecdh_auto (ssl_ctx, 1);
 744
 745   rv = SSL_CTX_set_cipher_list (ssl_ctx, (const char *) om->ciphers);
 746   if (rv != 1)
 747     {
 748       TLS_DBG (1, "Couldn't set cipher");
 749       return -1;
 750     }
 751
 752   /*
 753    * Set the key and cert
 754    */
 755   cert_bio = BIO_new (BIO_s_mem ());
 756   if (!cert_bio)
 757     {
 758       clib_warning ("unable to allocate memory");
 759       return -1;
 760     }
 761   BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
 762   srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
 763   if (!srvcert)
 764     {
 765       clib_warning ("unable to parse certificate");
 766       goto err;
 767     }
 768   rv = SSL_CTX_use_certificate (ssl_ctx, srvcert);
 769   if (rv != 1)
 770     {
 771       clib_warning ("unable to use SSL certificate");
 772       goto err;
 773     }
 774
 775   BIO_free (cert_bio);
 776
 777   cert_bio = BIO_new (BIO_s_mem ());
 778   if (!cert_bio)
 779     {
 780       clib_warning ("unable to allocate memory");
 781       return -1;
 782     }
 783   BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
 784   pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
 785   if (!pkey)
 786     {
 787       clib_warning ("unable to parse pkey");
 788       goto err;
 789     }
 790   rv = SSL_CTX_use_PrivateKey (ssl_ctx, pkey);
 791   if (rv != 1)
 792     {
 793       clib_warning ("unable to use SSL PrivateKey");
 794       goto err;
 795     }
 796
 797   BIO_free (cert_bio);
 798
 799   olc_index = openssl_listen_ctx_alloc ();
 800   olc = openssl_lctx_get (olc_index);
 801   olc->ssl_ctx = ssl_ctx;
 802   olc->srvcert = srvcert;
 803   olc->pkey = pkey;
 804
 805   /* store SSL_CTX into TLS level structure */
 806   lctx->tls_ssl_ctx = olc_index;
 807
 808   return 0;
 809
 810 err:
 811   if (cert_bio)
 812     BIO_free (cert_bio);
 813   return -1;
 814 }
 815
 816 static int
 817 openssl_stop_listen (tls_ctx_t * lctx)
 818 {
 819   u32 olc_index;
 820   openssl_listen_ctx_t *olc;
 821
 822   olc_index = lctx->tls_ssl_ctx;
 823   olc = openssl_lctx_get (olc_index);
 824
 825   X509_free (olc->srvcert);
 826   EVP_PKEY_free (olc->pkey);
 827
 828   SSL_CTX_free (olc->ssl_ctx);
 829   openssl_listen_ctx_free (olc);
 830
 831   return 0;
 832 }
 833
 834 static int
 835 openssl_ctx_init_server (tls_ctx_t * ctx)
 836 {
 837   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 838   u32 olc_index = ctx->tls_ssl_ctx;
 839   openssl_listen_ctx_t *olc;
 840   int rv, err;
 841
 842   /* Start a new connection */
 843
 844   olc = openssl_lctx_get (olc_index);
 845   oc->ssl = SSL_new (olc->ssl_ctx);
 846   if (oc->ssl == NULL)
 847     {
 848       TLS_DBG (1, "Couldn't initialize ssl struct");
 849       return -1;
 850     }
 851
 852   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
 853     {
 854       oc->rbio = BIO_new_tls (ctx->tls_session_handle);
 855       oc->wbio = BIO_new_tls (ctx->tls_session_handle);
 856     }
 857   else
 858     {
 859       oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
 860       oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
 861     }
 862
 863   SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
 864   SSL_set_accept_state (oc->ssl);
 865
 866   TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
 867            oc->openssl_ctx_index);
 868
 869 #ifdef HAVE_OPENSSL_ASYNC
 870   session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
 871   vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
 872 #endif
 873   while (1)
 874     {
 875       rv = SSL_do_handshake (oc->ssl);
 876       err = SSL_get_error (oc->ssl, rv);
 877 #ifdef HAVE_OPENSSL_ASYNC
 878       if (err == SSL_ERROR_WANT_ASYNC)
 879         {
 880           openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
 881                                       tls_session);
 882           break;
 883         }
 884 #endif
 885       if (err != SSL_ERROR_WANT_WRITE)
 886         break;
 887     }
 888
 889   TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
 890            oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
 891   return 0;
 892 }
 893
 894 static u8
 895 openssl_handshake_is_over (tls_ctx_t * ctx)
 896 {
 897   openssl_ctx_t *mc = (openssl_ctx_t *) ctx;
 898   if (!mc->ssl)
 899     return 0;
 900   return SSL_is_init_finished (mc->ssl);
 901 }
 902
 903 static int
 904 openssl_transport_close (tls_ctx_t * ctx)
 905 {
 906 #ifdef HAVE_OPENSSL_ASYNC
 907   if (vpp_openssl_is_inflight (ctx))
 908     return 0;
 909 #endif
 910
 911   if (!openssl_handshake_is_over (ctx))
 912     {
 913       openssl_handle_handshake_failure (ctx);
 914       return 0;
 915     }
 916   session_transport_closing_notify (&ctx->connection);
 917   return 0;
 918 }
 919
 920 static int
 921 openssl_app_close (tls_ctx_t * ctx)
 922 {
 923   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 924   session_t *app_session;
 925
 926   /* Wait for all data to be written to tcp */
 927   app_session = session_get_from_handle (ctx->app_session_handle);
 928   if (BIO_ctrl_pending (oc->rbio) <= 0
 929       && !svm_fifo_max_dequeue_cons (app_session->tx_fifo))
 930     openssl_confirm_app_close (ctx);
 931   else
 932     ctx->app_closed = 1;
 933   return 0;
 934 }
 935
 936 const static tls_engine_vft_t openssl_engine = {
 937   .ctx_alloc = openssl_ctx_alloc,
 938   .ctx_alloc_w_thread = openssl_ctx_alloc_w_thread,
 939   .ctx_free = openssl_ctx_free,
 940   .ctx_attach = openssl_ctx_attach,
 941   .ctx_detach = openssl_ctx_detach,
 942   .ctx_get = openssl_ctx_get,
 943   .ctx_get_w_thread = openssl_ctx_get_w_thread,
 944   .ctx_init_server = openssl_ctx_init_server,
 945   .ctx_init_client = openssl_ctx_init_client,
 946   .ctx_write = openssl_ctx_write,
 947   .ctx_read = openssl_ctx_read,
 948   .ctx_handshake_is_over = openssl_handshake_is_over,
 949   .ctx_start_listen = openssl_start_listen,
 950   .ctx_stop_listen = openssl_stop_listen,
 951   .ctx_transport_close = openssl_transport_close,
 952   .ctx_app_close = openssl_app_close,
 953 };
 954
 955 int
 956 tls_init_ca_chain (void)
 957 {
 958   openssl_main_t *om = &openssl_main;
 959   tls_main_t *tm = vnet_tls_get_main ();
 960   BIO *cert_bio;
 961   X509 *testcert;
 962   int rv;
 963
 964   if (access (tm->ca_cert_path, F_OK | R_OK) == -1)
 965     {
 966       clib_warning ("Could not initialize TLS CA certificates");
 967       return -1;
 968     }
 969
 970   if (!(om->cert_store = X509_STORE_new ()))
 971     {
 972       clib_warning ("failed to create cert store");
 973       return -1;
 974     }
 975
 976 #if OPENSSL_VERSION_NUMBER >= 0x30000000L
 977   rv = X509_STORE_load_file (om->cert_store, tm->ca_cert_path);
 978 #else
 979   rv = X509_STORE_load_locations (om->cert_store, tm->ca_cert_path, 0);
 980 #endif
 981
 982   if (rv < 0)
 983     {
 984       clib_warning ("failed to load ca certificate");
 985     }
 986
 987   if (tm->use_test_cert_in_ca)
 988     {
 989       cert_bio = BIO_new (BIO_s_mem ());
 990       BIO_write (cert_bio, test_srv_crt_rsa, test_srv_crt_rsa_len);
 991       testcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
 992       if (!testcert)
 993         {
 994           clib_warning ("unable to parse certificate");
 995           return -1;
 996         }
 997       X509_STORE_add_cert (om->cert_store, testcert);
 998       rv = 0;
 999     }
1000   return (rv < 0 ? -1 : 0);
1001 }
1002
1003 int
1004 tls_openssl_set_ciphers (char *ciphers)
1005 {
1006   openssl_main_t *om = &openssl_main;
1007   int i;
1008
1009   if (!ciphers)
1010     {
1011       return -1;
1012     }
1013
1014   vec_validate (om->ciphers, strlen (ciphers) - 1);
1015   for (i = 0; i < vec_len (om->ciphers); i++)
1016     {
1017       om->ciphers[i] = toupper (ciphers[i]);
1018     }
1019
1020   return 0;
1021
1022 }
1023
1024 static clib_error_t *
1025 tls_openssl_init (vlib_main_t * vm)
1026 {
1027   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1028   openssl_main_t *om = &openssl_main;
1029   clib_error_t *error = 0;
1030   u32 num_threads, i;
1031
1032   error = tls_openssl_api_init (vm);
1033   num_threads = 1 /* main thread */  + vtm->n_threads;
1034
1035   SSL_library_init ();
1036   SSL_load_error_strings ();
1037
1038   if (tls_init_ca_chain ())
1039     {
1040       clib_warning ("failed to initialize TLS CA chain");
1041       return 0;
1042     }
1043
1044   vec_validate (om->ctx_pool, num_threads - 1);
1045   vec_validate (om->rx_bufs, num_threads - 1);
1046   vec_validate (om->tx_bufs, num_threads - 1);
1047   for (i = 0; i < num_threads; i++)
1048     {
1049       vec_validate (om->rx_bufs[i], DTLSO_MAX_DGRAM);
1050       vec_validate (om->tx_bufs[i], DTLSO_MAX_DGRAM);
1051     }
1052   tls_register_engine (&openssl_engine, CRYPTO_ENGINE_OPENSSL);
1053
1054   om->engine_init = 0;
1055
1056   /* default ciphers */
1057   tls_openssl_set_ciphers
1058     ("ALL:!ADH:!LOW:!EXP:!MD5:!RC4-SHA:!DES-CBC3-SHA:@STRENGTH");
1059
1060   return error;
1061 }
1062 /* *INDENT-OFF* */
1063 VLIB_INIT_FUNCTION (tls_openssl_init) =
1064 {
1065   .runs_after = VLIB_INITS("tls_init"),
1066 };
1067 /* *INDENT-ON* */
1068
1069 #ifdef HAVE_OPENSSL_ASYNC
1070 static clib_error_t *
1071 tls_openssl_set_command_fn (vlib_main_t * vm, unformat_input_t * input,
1072                             vlib_cli_command_t * cmd)
1073 {
1074   openssl_main_t *om = &openssl_main;
1075   char *engine_name = NULL;
1076   char *engine_alg = NULL;
1077   char *ciphers = NULL;
1078   u8 engine_name_set = 0;
1079   int i, async = 0;
1080
1081   /* By present, it is not allowed to configure engine again after running */
1082   if (om->engine_init)
1083     {
1084       clib_warning ("engine has started!\n");
1085       return clib_error_return
1086         (0, "engine has started, and no config is accepted");
1087     }
1088
1089   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1090     {
1091       if (unformat (input, "engine %s", &engine_name))
1092         {
1093           engine_name_set = 1;
1094         }
1095       else if (unformat (input, "async"))
1096         {
1097           async = 1;
1098         }
1099       else if (unformat (input, "alg %s", &engine_alg))
1100         {
1101           for (i = 0; i < strnlen (engine_alg, MAX_CRYPTO_LEN); i++)
1102             engine_alg[i] = toupper (engine_alg[i]);
1103         }
1104       else if (unformat (input, "ciphers %s", &ciphers))
1105         {
1106           tls_openssl_set_ciphers (ciphers);
1107         }
1108       else
1109         return clib_error_return (0, "failed: unknown input `%U'",
1110                                   format_unformat_error, input);
1111     }
1112
1113   /* reset parameters if engine is not configured */
1114   if (!engine_name_set)
1115     {
1116       clib_warning ("No engine provided! \n");
1117       async = 0;
1118     }
1119   else
1120     {
1121       vnet_session_enable_disable (vm, 1);
1122       if (openssl_engine_register (engine_name, engine_alg, async) < 0)
1123         {
1124           return clib_error_return (0, "Failed to register %s polling",
1125                                     engine_name);
1126         }
1127       else
1128         {
1129           vlib_cli_output (vm, "Successfully register engine %s\n",
1130                            engine_name);
1131         }
1132     }
1133   om->async = async;
1134
1135   return 0;
1136 }
1137
1138 /* *INDENT-OFF* */
1139 VLIB_CLI_COMMAND (tls_openssl_set_command, static) =
1140 {
1141   .path = "tls openssl set",
1142   .short_help = "tls openssl set [engine <engine name>] [alg [algorithm] [async]",
1143   .function = tls_openssl_set_command_fn,
1144 };
1145 /* *INDENT-ON* */
1146 #endif
1147
1148 /* *INDENT-OFF* */
1149 VLIB_PLUGIN_REGISTER () = {
1150     .version = VPP_BUILD_VER,
1151     .description = "Transport Layer Security (TLS) Engine, OpenSSL Based",
1152 };
1153 /* *INDENT-ON* */
1154
1155 /*
1156  * fd.io coding-style-patch-verification: ON
1157  *
1158  * Local Variables:
1159  * eval: (c-set-style "gnu")
1160  * End:
1161  */