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