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 < 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 < 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         openssl_handle_handshake_failure (ctx);
 345       else
 346         tls_notify_app_accept (ctx);
 347     }
 348
 349   TLS_DBG (1, "Handshake for %u complete. TLS cipher is %s",
 350            oc->openssl_ctx_index, SSL_get_cipher (oc->ssl));
 351   return rv;
 352 }
 353
 354 static void
 355 openssl_confirm_app_close (tls_ctx_t * ctx)
 356 {
 357   tls_disconnect_transport (ctx);
 358   session_transport_closed_notify (&ctx->connection);
 359 }
 360
 361 static int
 362 openssl_ctx_write_tls (tls_ctx_t *ctx, session_t *app_session,
 363                        transport_send_params_t *sp)
 364 {
 365   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 366   u32 deq_max, space, enq_buf;
 367   session_t *ts;
 368   int wrote = 0;
 369   svm_fifo_t *f;
 370
 371   ts = session_get_from_handle (ctx->tls_session_handle);
 372   space = svm_fifo_max_enqueue_prod (ts->tx_fifo);
 373   /* Leave a bit of extra space for tls ctrl data, if any needed */
 374   space = clib_max ((int) space - TLSO_CTRL_BYTES, 0);
 375
 376   f = app_session->tx_fifo;
 377
 378   deq_max = svm_fifo_max_dequeue_cons (f);
 379   deq_max = clib_min (deq_max, space);
 380   if (!deq_max)
 381     goto check_tls_fifo;
 382
 383   deq_max = clib_min (deq_max, sp->max_burst_size);
 384
 385   wrote = openssl_write_from_fifo_into_ssl (f, oc->ssl, deq_max);
 386   if (!wrote)
 387     goto check_tls_fifo;
 388
 389   if (svm_fifo_needs_deq_ntf (f, wrote))
 390     session_dequeue_notify (app_session);
 391
 392 check_tls_fifo:
 393
 394   if (PREDICT_FALSE (ctx->app_closed && BIO_ctrl_pending (oc->rbio) <= 0))
 395     openssl_confirm_app_close (ctx);
 396
 397   /* Deschedule and wait for deq notification if fifo is almost full */
 398   enq_buf = clib_min (svm_fifo_size (ts->tx_fifo) / 2, TLSO_MIN_ENQ_SPACE);
 399   if (space < wrote + enq_buf)
 400     {
 401       svm_fifo_add_want_deq_ntf (ts->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
 402       transport_connection_deschedule (&ctx->connection);
 403       sp->flags |= TRANSPORT_SND_F_DESCHED;
 404     }
 405   else
 406     /* Request tx reschedule of the app session */
 407     app_session->flags |= SESSION_F_CUSTOM_TX;
 408
 409   return wrote;
 410 }
 411
 412 static int
 413 openssl_ctx_write_dtls (tls_ctx_t *ctx, session_t *app_session,
 414                         transport_send_params_t *sp)
 415 {
 416   openssl_main_t *om = &openssl_main;
 417   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 418   session_dgram_pre_hdr_t hdr;
 419   session_t *us;
 420   int wrote, rv;
 421   u32 read = 0, to_deq, dgram_sz;
 422   u8 *buf;
 423
 424   us = session_get_from_handle (ctx->tls_session_handle);
 425   to_deq = svm_fifo_max_dequeue_cons (app_session->tx_fifo);
 426   buf = om->tx_bufs[ctx->c_thread_index];
 427
 428   while (to_deq > 0)
 429     {
 430       /* Peeking only pre-header dgram because the session is connected */
 431       rv = svm_fifo_peek (app_session->tx_fifo, 0, sizeof (hdr), (u8 *) &hdr);
 432       ASSERT (rv == sizeof (hdr) && hdr.data_length < vec_len (buf));
 433       ASSERT (to_deq >= hdr.data_length + SESSION_CONN_HDR_LEN);
 434
 435       dgram_sz = hdr.data_length + SESSION_CONN_HDR_LEN;
 436       if (svm_fifo_max_enqueue_prod (us->tx_fifo) < dgram_sz + TLSO_CTRL_BYTES)
 437         {
 438           svm_fifo_add_want_deq_ntf (us->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
 439           transport_connection_deschedule (&ctx->connection);
 440           sp->flags |= TRANSPORT_SND_F_DESCHED;
 441           goto done;
 442         }
 443
 444       rv = svm_fifo_peek (app_session->tx_fifo, SESSION_CONN_HDR_LEN,
 445                           hdr.data_length, buf);
 446       ASSERT (rv == hdr.data_length);
 447       svm_fifo_dequeue_drop (app_session->tx_fifo, dgram_sz);
 448
 449       wrote = SSL_write (oc->ssl, buf, rv);
 450       ASSERT (wrote > 0);
 451
 452       read += rv;
 453       to_deq -= dgram_sz;
 454     }
 455
 456 done:
 457
 458   if (svm_fifo_needs_deq_ntf (app_session->tx_fifo, read))
 459     session_dequeue_notify (app_session);
 460
 461   if (read)
 462     tls_add_vpp_q_tx_evt (us);
 463
 464   if (PREDICT_FALSE (ctx->app_closed &&
 465                      !svm_fifo_max_enqueue_prod (us->rx_fifo)))
 466     openssl_confirm_app_close (ctx);
 467
 468   return read;
 469 }
 470
 471 static inline int
 472 openssl_ctx_write (tls_ctx_t *ctx, session_t *app_session,
 473                    transport_send_params_t *sp)
 474 {
 475   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
 476     return openssl_ctx_write_tls (ctx, app_session, sp);
 477   else
 478     return openssl_ctx_write_dtls (ctx, app_session, sp);
 479 }
 480
 481 static inline int
 482 openssl_ctx_read_tls (tls_ctx_t *ctx, session_t *tls_session)
 483 {
 484   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 485   session_t *app_session;
 486   int read;
 487   svm_fifo_t *f;
 488
 489   if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
 490     {
 491       if (openssl_ctx_handshake_rx (ctx, tls_session) < 0)
 492         return 0;
 493     }
 494
 495   app_session = session_get_from_handle (ctx->app_session_handle);
 496   f = app_session->rx_fifo;
 497
 498   read = openssl_read_from_ssl_into_fifo (f, oc->ssl);
 499
 500   /* If handshake just completed, session may still be in accepting state */
 501   if (read && app_session->session_state >= SESSION_STATE_READY)
 502     tls_notify_app_enqueue (ctx, app_session);
 503
 504   if ((SSL_pending (oc->ssl) > 0) ||
 505       svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
 506     tls_add_vpp_q_builtin_rx_evt (tls_session);
 507
 508   return read;
 509 }
 510
 511 static inline int
 512 openssl_ctx_read_dtls (tls_ctx_t *ctx, session_t *us)
 513 {
 514   openssl_main_t *om = &openssl_main;
 515   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 516   session_dgram_hdr_t hdr;
 517   session_t *app_session;
 518   u32 wrote = 0;
 519   int read, rv;
 520   u8 *buf;
 521
 522   if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
 523     {
 524       u32 us_index = us->session_index;
 525       if (openssl_ctx_handshake_rx (ctx, us) < 0)
 526         return 0;
 527       /* Session pool might grow when allocating the app's session */
 528       us = session_get (us_index, ctx->c_thread_index);
 529     }
 530
 531   buf = om->rx_bufs[ctx->c_thread_index];
 532   app_session = session_get_from_handle (ctx->app_session_handle);
 533   svm_fifo_fill_chunk_list (app_session->rx_fifo);
 534
 535   while (svm_fifo_max_dequeue_cons (us->rx_fifo) > 0)
 536     {
 537       if (svm_fifo_max_enqueue_prod (app_session->rx_fifo) < DTLSO_MAX_DGRAM)
 538         {
 539           tls_add_vpp_q_builtin_rx_evt (us);
 540           goto done;
 541         }
 542
 543       read = SSL_read (oc->ssl, buf, vec_len (buf));
 544       if (PREDICT_FALSE (read <= 0))
 545         {
 546           if (read < 0)
 547             tls_add_vpp_q_builtin_rx_evt (us);
 548           goto done;
 549         }
 550       wrote += read;
 551
 552       hdr.data_length = read;
 553       hdr.data_offset = 0;
 554
 555       svm_fifo_seg_t segs[2] = { { (u8 *) &hdr, sizeof (hdr) },
 556                                  { buf, read } };
 557
 558       rv = svm_fifo_enqueue_segments (app_session->rx_fifo, segs, 2,
 559                                       0 /* allow partial */);
 560       ASSERT (rv > 0);
 561     }
 562
 563 done:
 564
 565   /* If handshake just completed, session may still be in accepting state */
 566   if (app_session->session_state >= SESSION_STATE_READY)
 567     tls_notify_app_enqueue (ctx, app_session);
 568
 569   return wrote;
 570 }
 571
 572 static inline int
 573 openssl_ctx_read (tls_ctx_t *ctx, session_t *ts)
 574 {
 575   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
 576     return openssl_ctx_read_tls (ctx, ts);
 577   else
 578     return openssl_ctx_read_dtls (ctx, ts);
 579 }
 580
 581 static int
 582 openssl_ctx_init_client (tls_ctx_t * ctx)
 583 {
 584   long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
 585   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 586   openssl_main_t *om = &openssl_main;
 587   const SSL_METHOD *method;
 588   int rv, err;
 589
 590   method = ctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_client_method () :
 591                                                   DTLS_client_method ();
 592   if (method == NULL)
 593     {
 594       TLS_DBG (1, "(D)TLS_method returned null");
 595       return -1;
 596     }
 597
 598   oc->ssl_ctx = SSL_CTX_new (method);
 599   if (oc->ssl_ctx == NULL)
 600     {
 601       TLS_DBG (1, "SSL_CTX_new returned null");
 602       return -1;
 603     }
 604
 605   SSL_CTX_set_ecdh_auto (oc->ssl_ctx, 1);
 606   SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
 607 #ifdef HAVE_OPENSSL_ASYNC
 608   if (om->async)
 609     SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ASYNC);
 610 #endif
 611   rv = SSL_CTX_set_cipher_list (oc->ssl_ctx, (const char *) om->ciphers);
 612   if (rv != 1)
 613     {
 614       TLS_DBG (1, "Couldn't set cipher");
 615       return -1;
 616     }
 617
 618   SSL_CTX_set_options (oc->ssl_ctx, flags);
 619   SSL_CTX_set_cert_store (oc->ssl_ctx, om->cert_store);
 620
 621   oc->ssl = SSL_new (oc->ssl_ctx);
 622   if (oc->ssl == NULL)
 623     {
 624       TLS_DBG (1, "Couldn't initialize ssl struct");
 625       return -1;
 626     }
 627
 628   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
 629     {
 630       oc->rbio = BIO_new_tls (ctx->tls_session_handle);
 631       oc->wbio = BIO_new_tls (ctx->tls_session_handle);
 632     }
 633   else
 634     {
 635       oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
 636       oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
 637     }
 638
 639   SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
 640   SSL_set_connect_state (oc->ssl);
 641
 642   rv = SSL_set_tlsext_host_name (oc->ssl, ctx->srv_hostname);
 643   if (rv != 1)
 644     {
 645       TLS_DBG (1, "Couldn't set hostname");
 646       return -1;
 647     }
 648
 649   /*
 650    * 2. Do the first steps in the handshake.
 651    */
 652   TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
 653            oc->openssl_ctx_index);
 654
 655 #ifdef HAVE_OPENSSL_ASYNC
 656   session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
 657   vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
 658 #endif
 659   while (1)
 660     {
 661       rv = SSL_do_handshake (oc->ssl);
 662       err = SSL_get_error (oc->ssl, rv);
 663 #ifdef HAVE_OPENSSL_ASYNC
 664       if (err == SSL_ERROR_WANT_ASYNC)
 665         {
 666           openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
 667                                       tls_session);
 668           break;
 669         }
 670 #endif
 671       if (err != SSL_ERROR_WANT_WRITE)
 672         break;
 673     }
 674
 675   TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
 676            oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
 677   return 0;
 678 }
 679
 680 static int
 681 openssl_start_listen (tls_ctx_t * lctx)
 682 {
 683   const SSL_METHOD *method;
 684   SSL_CTX *ssl_ctx;
 685   int rv;
 686   BIO *cert_bio;
 687   X509 *srvcert;
 688   EVP_PKEY *pkey;
 689   u32 olc_index;
 690   openssl_listen_ctx_t *olc;
 691   app_cert_key_pair_t *ckpair;
 692
 693   long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
 694   openssl_main_t *om = &openssl_main;
 695
 696   ckpair = app_cert_key_pair_get_if_valid (lctx->ckpair_index);
 697   if (!ckpair)
 698     return -1;
 699
 700   if (!ckpair->cert || !ckpair->key)
 701     {
 702       TLS_DBG (1, "tls cert and/or key not configured %d",
 703                lctx->parent_app_wrk_index);
 704       return -1;
 705     }
 706
 707   method = lctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_server_method () :
 708                                                    DTLS_server_method ();
 709   ssl_ctx = SSL_CTX_new (method);
 710   if (!ssl_ctx)
 711     {
 712       clib_warning ("Unable to create SSL context");
 713       return -1;
 714     }
 715
 716   SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
 717 #ifdef HAVE_OPENSSL_ASYNC
 718   if (om->async)
 719     {
 720       SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ASYNC);
 721       SSL_CTX_set_async_callback (ssl_ctx, tls_async_openssl_callback);
 722     }
 723 #endif
 724   SSL_CTX_set_options (ssl_ctx, flags);
 725   SSL_CTX_set_ecdh_auto (ssl_ctx, 1);
 726
 727   rv = SSL_CTX_set_cipher_list (ssl_ctx, (const char *) om->ciphers);
 728   if (rv != 1)
 729     {
 730       TLS_DBG (1, "Couldn't set cipher");
 731       return -1;
 732     }
 733
 734   /*
 735    * Set the key and cert
 736    */
 737   cert_bio = BIO_new (BIO_s_mem ());
 738   BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
 739   srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
 740   if (!srvcert)
 741     {
 742       clib_warning ("unable to parse certificate");
 743       return -1;
 744     }
 745   SSL_CTX_use_certificate (ssl_ctx, srvcert);
 746   BIO_free (cert_bio);
 747
 748   cert_bio = BIO_new (BIO_s_mem ());
 749   BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
 750   pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
 751   if (!pkey)
 752     {
 753       clib_warning ("unable to parse pkey");
 754       return -1;
 755     }
 756   SSL_CTX_use_PrivateKey (ssl_ctx, pkey);
 757   BIO_free (cert_bio);
 758
 759   olc_index = openssl_listen_ctx_alloc ();
 760   olc = openssl_lctx_get (olc_index);
 761   olc->ssl_ctx = ssl_ctx;
 762   olc->srvcert = srvcert;
 763   olc->pkey = pkey;
 764
 765   /* store SSL_CTX into TLS level structure */
 766   lctx->tls_ssl_ctx = olc_index;
 767
 768   return 0;
 769
 770 }
 771
 772 static int
 773 openssl_stop_listen (tls_ctx_t * lctx)
 774 {
 775   u32 olc_index;
 776   openssl_listen_ctx_t *olc;
 777
 778   olc_index = lctx->tls_ssl_ctx;
 779   olc = openssl_lctx_get (olc_index);
 780
 781   X509_free (olc->srvcert);
 782   EVP_PKEY_free (olc->pkey);
 783
 784   SSL_CTX_free (olc->ssl_ctx);
 785   openssl_listen_ctx_free (olc);
 786
 787   return 0;
 788 }
 789
 790 static int
 791 openssl_ctx_init_server (tls_ctx_t * ctx)
 792 {
 793   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 794   u32 olc_index = ctx->tls_ssl_ctx;
 795   openssl_listen_ctx_t *olc;
 796   int rv, err;
 797
 798   /* Start a new connection */
 799
 800   olc = openssl_lctx_get (olc_index);
 801   oc->ssl = SSL_new (olc->ssl_ctx);
 802   if (oc->ssl == NULL)
 803     {
 804       TLS_DBG (1, "Couldn't initialize ssl struct");
 805       return -1;
 806     }
 807
 808   if (ctx->tls_type == TRANSPORT_PROTO_TLS)
 809     {
 810       oc->rbio = BIO_new_tls (ctx->tls_session_handle);
 811       oc->wbio = BIO_new_tls (ctx->tls_session_handle);
 812     }
 813   else
 814     {
 815       oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
 816       oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
 817     }
 818
 819   SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
 820   SSL_set_accept_state (oc->ssl);
 821
 822   TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
 823            oc->openssl_ctx_index);
 824
 825 #ifdef HAVE_OPENSSL_ASYNC
 826   session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
 827   vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
 828 #endif
 829   while (1)
 830     {
 831       rv = SSL_do_handshake (oc->ssl);
 832       err = SSL_get_error (oc->ssl, rv);
 833 #ifdef HAVE_OPENSSL_ASYNC
 834       if (err == SSL_ERROR_WANT_ASYNC)
 835         {
 836           openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
 837                                       tls_session);
 838           break;
 839         }
 840 #endif
 841       if (err != SSL_ERROR_WANT_WRITE)
 842         break;
 843     }
 844
 845   TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
 846            oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
 847   return 0;
 848 }
 849
 850 static u8
 851 openssl_handshake_is_over (tls_ctx_t * ctx)
 852 {
 853   openssl_ctx_t *mc = (openssl_ctx_t *) ctx;
 854   if (!mc->ssl)
 855     return 0;
 856   return SSL_is_init_finished (mc->ssl);
 857 }
 858
 859 static int
 860 openssl_transport_close (tls_ctx_t * ctx)
 861 {
 862 #ifdef HAVE_OPENSSL_ASYNC
 863   if (vpp_openssl_is_inflight (ctx))
 864     return 0;
 865 #endif
 866
 867   if (!openssl_handshake_is_over (ctx))
 868     {
 869       openssl_handle_handshake_failure (ctx);
 870       return 0;
 871     }
 872   session_transport_closing_notify (&ctx->connection);
 873   return 0;
 874 }
 875
 876 static int
 877 openssl_app_close (tls_ctx_t * ctx)
 878 {
 879   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 880   session_t *app_session;
 881
 882   /* Wait for all data to be written to tcp */
 883   app_session = session_get_from_handle (ctx->app_session_handle);
 884   if (BIO_ctrl_pending (oc->rbio) <= 0
 885       && !svm_fifo_max_dequeue_cons (app_session->tx_fifo))
 886     openssl_confirm_app_close (ctx);
 887   else
 888     ctx->app_closed = 1;
 889   return 0;
 890 }
 891
 892 const static tls_engine_vft_t openssl_engine = {
 893   .ctx_alloc = openssl_ctx_alloc,
 894   .ctx_alloc_w_thread = openssl_ctx_alloc_w_thread,
 895   .ctx_free = openssl_ctx_free,
 896   .ctx_attach = openssl_ctx_attach,
 897   .ctx_detach = openssl_ctx_detach,
 898   .ctx_get = openssl_ctx_get,
 899   .ctx_get_w_thread = openssl_ctx_get_w_thread,
 900   .ctx_init_server = openssl_ctx_init_server,
 901   .ctx_init_client = openssl_ctx_init_client,
 902   .ctx_write = openssl_ctx_write,
 903   .ctx_read = openssl_ctx_read,
 904   .ctx_handshake_is_over = openssl_handshake_is_over,
 905   .ctx_start_listen = openssl_start_listen,
 906   .ctx_stop_listen = openssl_stop_listen,
 907   .ctx_transport_close = openssl_transport_close,
 908   .ctx_app_close = openssl_app_close,
 909 };
 910
 911 int
 912 tls_init_ca_chain (void)
 913 {
 914   openssl_main_t *om = &openssl_main;
 915   tls_main_t *tm = vnet_tls_get_main ();
 916   BIO *cert_bio;
 917   X509 *testcert;
 918   int rv;
 919
 920   if (access (tm->ca_cert_path, F_OK | R_OK) == -1)
 921     {
 922       clib_warning ("Could not initialize TLS CA certificates");
 923       return -1;
 924     }
 925
 926   if (!(om->cert_store = X509_STORE_new ()))
 927     {
 928       clib_warning ("failed to create cert store");
 929       return -1;
 930     }
 931
 932 #if OPENSSL_VERSION_NUMBER >= 0x30000000L
 933   rv = X509_STORE_load_file (om->cert_store, tm->ca_cert_path);
 934 #else
 935   rv = X509_STORE_load_locations (om->cert_store, tm->ca_cert_path, 0);
 936 #endif
 937
 938   if (rv < 0)
 939     {
 940       clib_warning ("failed to load ca certificate");
 941     }
 942
 943   if (tm->use_test_cert_in_ca)
 944     {
 945       cert_bio = BIO_new (BIO_s_mem ());
 946       BIO_write (cert_bio, test_srv_crt_rsa, test_srv_crt_rsa_len);
 947       testcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
 948       if (!testcert)
 949         {
 950           clib_warning ("unable to parse certificate");
 951           return -1;
 952         }
 953       X509_STORE_add_cert (om->cert_store, testcert);
 954       rv = 0;
 955     }
 956   return (rv < 0 ? -1 : 0);
 957 }
 958
 959 int
 960 tls_openssl_set_ciphers (char *ciphers)
 961 {
 962   openssl_main_t *om = &openssl_main;
 963   int i;
 964
 965   if (!ciphers)
 966     {
 967       return -1;
 968     }
 969
 970   vec_validate (om->ciphers, strlen (ciphers) - 1);
 971   for (i = 0; i < vec_len (om->ciphers); i++)
 972     {
 973       om->ciphers[i] = toupper (ciphers[i]);
 974     }
 975
 976   return 0;
 977
 978 }
 979
 980 static clib_error_t *
 981 tls_openssl_init (vlib_main_t * vm)
 982 {
 983   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 984   openssl_main_t *om = &openssl_main;
 985   clib_error_t *error = 0;
 986   u32 num_threads, i;
 987
 988   error = tls_openssl_api_init (vm);
 989   num_threads = 1 /* main thread */  + vtm->n_threads;
 990
 991   SSL_library_init ();
 992   SSL_load_error_strings ();
 993
 994   if (tls_init_ca_chain ())
 995     {
 996       clib_warning ("failed to initialize TLS CA chain");
 997       return 0;
 998     }
 999
1000   vec_validate (om->ctx_pool, num_threads - 1);
1001   vec_validate (om->rx_bufs, num_threads - 1);
1002   vec_validate (om->tx_bufs, num_threads - 1);
1003   for (i = 0; i < num_threads; i++)
1004     {
1005       vec_validate (om->rx_bufs[i], DTLSO_MAX_DGRAM);
1006       vec_validate (om->tx_bufs[i], DTLSO_MAX_DGRAM);
1007     }
1008   tls_register_engine (&openssl_engine, CRYPTO_ENGINE_OPENSSL);
1009
1010   om->engine_init = 0;
1011
1012   /* default ciphers */
1013   tls_openssl_set_ciphers
1014     ("ALL:!ADH:!LOW:!EXP:!MD5:!RC4-SHA:!DES-CBC3-SHA:@STRENGTH");
1015
1016   return error;
1017 }
1018 /* *INDENT-OFF* */
1019 VLIB_INIT_FUNCTION (tls_openssl_init) =
1020 {
1021   .runs_after = VLIB_INITS("tls_init"),
1022 };
1023 /* *INDENT-ON* */
1024
1025 #ifdef HAVE_OPENSSL_ASYNC
1026 static clib_error_t *
1027 tls_openssl_set_command_fn (vlib_main_t * vm, unformat_input_t * input,
1028                             vlib_cli_command_t * cmd)
1029 {
1030   openssl_main_t *om = &openssl_main;
1031   char *engine_name = NULL;
1032   char *engine_alg = NULL;
1033   char *ciphers = NULL;
1034   u8 engine_name_set = 0;
1035   int i, async = 0;
1036
1037   /* By present, it is not allowed to configure engine again after running */
1038   if (om->engine_init)
1039     {
1040       clib_warning ("engine has started!\n");
1041       return clib_error_return
1042         (0, "engine has started, and no config is accepted");
1043     }
1044
1045   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1046     {
1047       if (unformat (input, "engine %s", &engine_name))
1048         {
1049           engine_name_set = 1;
1050         }
1051       else if (unformat (input, "async"))
1052         {
1053           async = 1;
1054         }
1055       else if (unformat (input, "alg %s", &engine_alg))
1056         {
1057           for (i = 0; i < strnlen (engine_alg, MAX_CRYPTO_LEN); i++)
1058             engine_alg[i] = toupper (engine_alg[i]);
1059         }
1060       else if (unformat (input, "ciphers %s", &ciphers))
1061         {
1062           tls_openssl_set_ciphers (ciphers);
1063         }
1064       else
1065         return clib_error_return (0, "failed: unknown input `%U'",
1066                                   format_unformat_error, input);
1067     }
1068
1069   /* reset parameters if engine is not configured */
1070   if (!engine_name_set)
1071     {
1072       clib_warning ("No engine provided! \n");
1073       async = 0;
1074     }
1075   else
1076     {
1077       vnet_session_enable_disable (vm, 1);
1078       if (openssl_engine_register (engine_name, engine_alg, async) < 0)
1079         {
1080           return clib_error_return (0, "Failed to register %s polling",
1081                                     engine_name);
1082         }
1083       else
1084         {
1085           vlib_cli_output (vm, "Successfully register engine %s\n",
1086                            engine_name);
1087         }
1088     }
1089   om->async = async;
1090
1091   return 0;
1092 }
1093
1094 /* *INDENT-OFF* */
1095 VLIB_CLI_COMMAND (tls_openssl_set_command, static) =
1096 {
1097   .path = "tls openssl set",
1098   .short_help = "tls openssl set [engine <engine name>] [alg [algorithm] [async]",
1099   .function = tls_openssl_set_command_fn,
1100 };
1101 /* *INDENT-ON* */
1102 #endif
1103
1104 /* *INDENT-OFF* */
1105 VLIB_PLUGIN_REGISTER () = {
1106     .version = VPP_BUILD_VER,
1107     .description = "Transport Layer Security (TLS) Engine, OpenSSL Based",
1108 };
1109 /* *INDENT-ON* */
1110
1111 /*
1112  * fd.io coding-style-patch-verification: ON
1113  *
1114  * Local Variables:
1115  * eval: (c-set-style "gnu")
1116  * End:
1117  */