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