src/plugins/tlsopenssl/tls_openssl.c

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