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 #ifdef HAVE_OPENSSL_ASYNC
  20 #include <openssl/async.h>
  21 #endif
  22 #include <dlfcn.h>
  23 #include <vnet/plugin/plugin.h>
  24 #include <vpp/app/version.h>
  25 #include <vnet/tls/tls.h>
  26 #include <ctype.h>
  27 #include <tlsopenssl/tls_openssl.h>
  28
  29 #define MAX_CRYPTO_LEN 16
  30
  31 static openssl_main_t openssl_main;
  32 static u32
  33 openssl_ctx_alloc (void)
  34 {
  35   u8 thread_index = vlib_get_thread_index ();
  36   openssl_main_t *tm = &openssl_main;
  37   openssl_ctx_t **ctx;
  38
  39   pool_get (tm->ctx_pool[thread_index], ctx);
  40   if (!(*ctx))
  41     *ctx = clib_mem_alloc (sizeof (openssl_ctx_t));
  42
  43   clib_memset (*ctx, 0, sizeof (openssl_ctx_t));
  44   (*ctx)->ctx.c_thread_index = thread_index;
  45   (*ctx)->ctx.tls_ctx_engine = TLS_ENGINE_OPENSSL;
  46   (*ctx)->ctx.app_session_handle = SESSION_INVALID_HANDLE;
  47   (*ctx)->openssl_ctx_index = ctx - tm->ctx_pool[thread_index];
  48   return ((*ctx)->openssl_ctx_index);
  49 }
  50
  51 static void
  52 openssl_ctx_free (tls_ctx_t * ctx)
  53 {
  54   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
  55
  56   if (SSL_is_init_finished (oc->ssl) && !ctx->is_passive_close)
  57     SSL_shutdown (oc->ssl);
  58
  59   SSL_free (oc->ssl);
  60
  61   vec_free (ctx->srv_hostname);
  62   pool_put_index (openssl_main.ctx_pool[ctx->c_thread_index],
  63                   oc->openssl_ctx_index);
  64 }
  65
  66 tls_ctx_t *
  67 openssl_ctx_get (u32 ctx_index)
  68 {
  69   openssl_ctx_t **ctx;
  70   ctx = pool_elt_at_index (openssl_main.ctx_pool[vlib_get_thread_index ()],
  71                            ctx_index);
  72   return &(*ctx)->ctx;
  73 }
  74
  75 tls_ctx_t *
  76 openssl_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
  77 {
  78   openssl_ctx_t **ctx;
  79   ctx = pool_elt_at_index (openssl_main.ctx_pool[thread_index], ctx_index);
  80   return &(*ctx)->ctx;
  81 }
  82
  83 static u32
  84 openssl_listen_ctx_alloc (void)
  85 {
  86   openssl_main_t *om = &openssl_main;
  87   openssl_listen_ctx_t *lctx;
  88
  89   pool_get (om->lctx_pool, lctx);
  90
  91   clib_memset (lctx, 0, sizeof (openssl_listen_ctx_t));
  92   lctx->openssl_lctx_index = lctx - om->lctx_pool;
  93   return lctx->openssl_lctx_index;
  94 }
  95
  96 static void
  97 openssl_listen_ctx_free (openssl_listen_ctx_t * lctx)
  98 {
  99   pool_put_index (openssl_main.lctx_pool, lctx->openssl_lctx_index);
 100 }
 101
 102 openssl_listen_ctx_t *
 103 openssl_lctx_get (u32 lctx_index)
 104 {
 105   return pool_elt_at_index (openssl_main.lctx_pool, lctx_index);
 106 }
 107
 108 static int
 109 openssl_try_handshake_read (openssl_ctx_t * oc, session_t * tls_session)
 110 {
 111   u32 deq_max, deq_now;
 112   svm_fifo_t *f;
 113   int wrote, rv;
 114
 115   f = tls_session->rx_fifo;
 116   deq_max = svm_fifo_max_dequeue_cons (f);
 117   if (!deq_max)
 118     return 0;
 119
 120   deq_now = clib_min (svm_fifo_max_read_chunk (f), deq_max);
 121   wrote = BIO_write (oc->wbio, svm_fifo_head (f), deq_now);
 122   if (wrote <= 0)
 123     return 0;
 124
 125   svm_fifo_dequeue_drop (f, wrote);
 126   if (wrote < deq_max)
 127     {
 128       deq_now = clib_min (svm_fifo_max_read_chunk (f), deq_max - wrote);
 129       rv = BIO_write (oc->wbio, svm_fifo_head (f), deq_now);
 130       if (rv > 0)
 131         {
 132           svm_fifo_dequeue_drop (f, rv);
 133           wrote += rv;
 134         }
 135     }
 136   return wrote;
 137 }
 138
 139 static int
 140 openssl_try_handshake_write (openssl_ctx_t * oc, session_t * tls_session)
 141 {
 142   u32 enq_max, deq_now;
 143   svm_fifo_t *f;
 144   int read, rv;
 145
 146   if (BIO_ctrl_pending (oc->rbio) <= 0)
 147     return 0;
 148
 149   f = tls_session->tx_fifo;
 150   enq_max = svm_fifo_max_enqueue_prod (f);
 151   if (!enq_max)
 152     return 0;
 153
 154   deq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max);
 155   read = BIO_read (oc->rbio, svm_fifo_tail (f), deq_now);
 156   if (read <= 0)
 157     return 0;
 158
 159   svm_fifo_enqueue_nocopy (f, read);
 160   tls_add_vpp_q_tx_evt (tls_session);
 161
 162   if (read < enq_max)
 163     {
 164       deq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max - read);
 165       rv = BIO_read (oc->rbio, svm_fifo_tail (f), deq_now);
 166       if (rv > 0)
 167         {
 168           svm_fifo_enqueue_nocopy (f, rv);
 169           read += rv;
 170         }
 171     }
 172
 173   return read;
 174 }
 175
 176 #ifdef HAVE_OPENSSL_ASYNC
 177 static int
 178 vpp_ssl_async_process_event (tls_ctx_t * ctx,
 179                              openssl_resume_handler * handler)
 180 {
 181   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 182   openssl_tls_callback_t *engine_cb;
 183
 184   engine_cb = vpp_add_async_pending_event (ctx, handler);
 185   if (engine_cb)
 186     {
 187       SSL_set_async_callback_arg (oc->ssl, (void *) engine_cb->arg);
 188       TLS_DBG (2, "set callback to engine %p\n", engine_cb->callback);
 189     }
 190   return 0;
 191
 192 }
 193
 194 /* Due to engine busy stat, VPP need to retry later */
 195 static int
 196 vpp_ssl_async_retry_func (tls_ctx_t * ctx, openssl_resume_handler * handler)
 197 {
 198
 199   if (vpp_add_async_run_event (ctx, handler))
 200     return 1;
 201
 202   return 0;
 203
 204 }
 205
 206 #endif
 207
 208 static void
 209 openssl_handle_handshake_failure (tls_ctx_t * ctx)
 210 {
 211   if (SSL_is_server (((openssl_ctx_t *) ctx)->ssl))
 212     {
 213       /*
 214        * Cleanup pre-allocated app session and close transport
 215        */
 216       session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
 217       ctx->no_app_session = 1;
 218       ctx->c_s_index = SESSION_INVALID_INDEX;
 219       tls_disconnect_transport (ctx);
 220     }
 221   else
 222     {
 223       /*
 224        * Also handles cleanup of the pre-allocated session
 225        */
 226       tls_notify_app_connected (ctx, /* is failed */ 1);
 227     }
 228 }
 229
 230 int
 231 openssl_ctx_handshake_rx (tls_ctx_t * ctx, session_t * tls_session)
 232 {
 233   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 234   int rv = 0, err;
 235 #ifdef HAVE_OPENSSL_ASYNC
 236   int estatus;
 237   openssl_resume_handler *myself;
 238 #endif
 239
 240   while (SSL_in_init (oc->ssl))
 241     {
 242       if (ctx->resume)
 243         {
 244           ctx->resume = 0;
 245         }
 246       else if (!openssl_try_handshake_read (oc, tls_session))
 247         {
 248           break;
 249         }
 250
 251 #ifdef HAVE_OPENSSL_ASYNC
 252       myself = openssl_ctx_handshake_rx;
 253       vpp_ssl_async_process_event (ctx, myself);
 254 #endif
 255
 256       rv = SSL_do_handshake (oc->ssl);
 257       err = SSL_get_error (oc->ssl, rv);
 258
 259       if (err == SSL_ERROR_SSL)
 260         {
 261           char buf[512];
 262           ERR_error_string (ERR_get_error (), buf);
 263           clib_warning ("Err: %s", buf);
 264
 265           openssl_handle_handshake_failure (ctx);
 266           return -1;
 267         }
 268
 269       openssl_try_handshake_write (oc, tls_session);
 270 #ifdef HAVE_OPENSSL_ASYNC
 271       if (err == SSL_ERROR_WANT_ASYNC)
 272         {
 273           SSL_get_async_status (oc->ssl, &estatus);
 274
 275           if (estatus == ASYNC_STATUS_EAGAIN)
 276             {
 277               vpp_ssl_async_retry_func (ctx, myself);
 278             }
 279         }
 280 #endif
 281
 282       if (err != SSL_ERROR_WANT_WRITE)
 283         break;
 284     }
 285   TLS_DBG (2, "tls state for %u is %s", oc->openssl_ctx_index,
 286            SSL_state_string_long (oc->ssl));
 287
 288   if (SSL_in_init (oc->ssl))
 289     return 0;
 290
 291   /*
 292    * Handshake complete
 293    */
 294   if (!SSL_is_server (oc->ssl))
 295     {
 296       /*
 297        * Verify server certificate
 298        */
 299       if ((rv = SSL_get_verify_result (oc->ssl)) != X509_V_OK)
 300         {
 301           TLS_DBG (1, " failed verify: %s\n",
 302                    X509_verify_cert_error_string (rv));
 303
 304           /*
 305            * Presence of hostname enforces strict certificate verification
 306            */
 307           if (ctx->srv_hostname)
 308             {
 309               tls_notify_app_connected (ctx, /* is failed */ 0);
 310               return -1;
 311             }
 312         }
 313       tls_notify_app_connected (ctx, /* is failed */ 0);
 314     }
 315   else
 316     {
 317       tls_notify_app_accept (ctx);
 318     }
 319
 320   TLS_DBG (1, "Handshake for %u complete. TLS cipher is %s",
 321            oc->openssl_ctx_index, SSL_get_cipher (oc->ssl));
 322   return rv;
 323 }
 324
 325 static void
 326 openssl_confirm_app_close (tls_ctx_t * ctx)
 327 {
 328   tls_disconnect_transport (ctx);
 329   session_transport_closed_notify (&ctx->connection);
 330 }
 331
 332 static inline int
 333 openssl_ctx_write (tls_ctx_t * ctx, session_t * app_session)
 334 {
 335   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 336   int wrote = 0, rv, read, max_buf = 100 * TLS_CHUNK_SIZE, max_space;
 337   u32 enq_max, deq_max, deq_now, to_write;
 338   session_t *tls_session;
 339   svm_fifo_t *f;
 340
 341   f = app_session->tx_fifo;
 342   deq_max = svm_fifo_max_dequeue_cons (f);
 343   if (!deq_max)
 344     goto check_tls_fifo;
 345
 346   max_space = max_buf - BIO_ctrl_pending (oc->rbio);
 347   max_space = (max_space < 0) ? 0 : max_space;
 348   deq_now = clib_min (deq_max, (u32) max_space);
 349   to_write = clib_min (svm_fifo_max_read_chunk (f), deq_now);
 350   wrote = SSL_write (oc->ssl, svm_fifo_head (f), to_write);
 351   if (wrote <= 0)
 352     {
 353       tls_add_vpp_q_builtin_tx_evt (app_session);
 354       goto check_tls_fifo;
 355     }
 356   svm_fifo_dequeue_drop (app_session->tx_fifo, wrote);
 357   if (wrote < deq_now)
 358     {
 359       to_write = clib_min (svm_fifo_max_read_chunk (f), deq_now - wrote);
 360       rv = SSL_write (oc->ssl, svm_fifo_head (f), to_write);
 361       if (rv > 0)
 362         {
 363           svm_fifo_dequeue_drop (app_session->tx_fifo, rv);
 364           wrote += rv;
 365         }
 366     }
 367
 368   if (svm_fifo_needs_deq_ntf (app_session->tx_fifo, wrote))
 369     session_dequeue_notify (app_session);
 370
 371   if (wrote < deq_max)
 372     tls_add_vpp_q_builtin_tx_evt (app_session);
 373
 374 check_tls_fifo:
 375
 376   if (BIO_ctrl_pending (oc->rbio) <= 0)
 377     return wrote;
 378
 379   tls_session = session_get_from_handle (ctx->tls_session_handle);
 380   f = tls_session->tx_fifo;
 381   enq_max = svm_fifo_max_enqueue_prod (f);
 382   if (!enq_max)
 383     {
 384       tls_add_vpp_q_builtin_tx_evt (app_session);
 385       return wrote;
 386     }
 387
 388   deq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max);
 389   read = BIO_read (oc->rbio, svm_fifo_tail (f), deq_now);
 390   if (read <= 0)
 391     {
 392       tls_add_vpp_q_builtin_tx_evt (app_session);
 393       return wrote;
 394     }
 395
 396   svm_fifo_enqueue_nocopy (f, read);
 397   tls_add_vpp_q_tx_evt (tls_session);
 398
 399   if (read < enq_max && BIO_ctrl_pending (oc->rbio) > 0)
 400     {
 401       deq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max - read);
 402       read = BIO_read (oc->rbio, svm_fifo_tail (f), deq_now);
 403       if (read > 0)
 404         svm_fifo_enqueue_nocopy (f, read);
 405     }
 406
 407   if (BIO_ctrl_pending (oc->rbio) > 0)
 408     tls_add_vpp_q_builtin_tx_evt (app_session);
 409   else if (ctx->app_closed)
 410     openssl_confirm_app_close (ctx);
 411
 412   return wrote;
 413 }
 414
 415 static inline int
 416 openssl_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
 417 {
 418   int read, wrote = 0, max_space, max_buf = 100 * TLS_CHUNK_SIZE, rv;
 419   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 420   u32 deq_max, enq_max, deq_now, to_read;
 421   session_t *app_session;
 422   svm_fifo_t *f;
 423
 424   if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
 425     {
 426       openssl_ctx_handshake_rx (ctx, tls_session);
 427       return 0;
 428     }
 429
 430   f = tls_session->rx_fifo;
 431   deq_max = svm_fifo_max_dequeue_cons (f);
 432   max_space = max_buf - BIO_ctrl_pending (oc->wbio);
 433   max_space = max_space < 0 ? 0 : max_space;
 434   deq_now = clib_min (deq_max, max_space);
 435   if (!deq_now)
 436     goto check_app_fifo;
 437
 438   to_read = clib_min (svm_fifo_max_read_chunk (f), deq_now);
 439   wrote = BIO_write (oc->wbio, svm_fifo_head (f), to_read);
 440   if (wrote <= 0)
 441     {
 442       tls_add_vpp_q_builtin_rx_evt (tls_session);
 443       goto check_app_fifo;
 444     }
 445   svm_fifo_dequeue_drop (f, wrote);
 446   if (wrote < deq_now)
 447     {
 448       to_read = clib_min (svm_fifo_max_read_chunk (f), deq_now - wrote);
 449       rv = BIO_write (oc->wbio, svm_fifo_head (f), to_read);
 450       if (rv > 0)
 451         {
 452           svm_fifo_dequeue_drop (f, rv);
 453           wrote += rv;
 454         }
 455     }
 456   if (svm_fifo_max_dequeue_cons (f))
 457     tls_add_vpp_q_builtin_rx_evt (tls_session);
 458
 459 check_app_fifo:
 460
 461   if (BIO_ctrl_pending (oc->wbio) <= 0)
 462     return wrote;
 463
 464   app_session = session_get_from_handle (ctx->app_session_handle);
 465   f = app_session->rx_fifo;
 466   enq_max = svm_fifo_max_enqueue_prod (f);
 467   if (!enq_max)
 468     {
 469       tls_add_vpp_q_builtin_rx_evt (tls_session);
 470       return wrote;
 471     }
 472
 473   deq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max);
 474   read = SSL_read (oc->ssl, svm_fifo_tail (f), deq_now);
 475   if (read <= 0)
 476     {
 477       tls_add_vpp_q_builtin_rx_evt (tls_session);
 478       return wrote;
 479     }
 480   svm_fifo_enqueue_nocopy (f, read);
 481   if (read < enq_max && BIO_ctrl_pending (oc->wbio) > 0)
 482     {
 483       deq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max - read);
 484       read = SSL_read (oc->ssl, svm_fifo_tail (f), deq_now);
 485       if (read > 0)
 486         svm_fifo_enqueue_nocopy (f, read);
 487     }
 488
 489   tls_notify_app_enqueue (ctx, app_session);
 490   if (BIO_ctrl_pending (oc->wbio) > 0)
 491     tls_add_vpp_q_builtin_rx_evt (tls_session);
 492
 493   return wrote;
 494 }
 495
 496 static int
 497 openssl_ctx_init_client (tls_ctx_t * ctx)
 498 {
 499   long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
 500   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 501   openssl_main_t *om = &openssl_main;
 502   session_t *tls_session;
 503   const SSL_METHOD *method;
 504   int rv, err;
 505 #ifdef HAVE_OPENSSL_ASYNC
 506   openssl_resume_handler *handler;
 507 #endif
 508
 509   method = SSLv23_client_method ();
 510   if (method == NULL)
 511     {
 512       TLS_DBG (1, "SSLv23_method returned null");
 513       return -1;
 514     }
 515
 516   oc->ssl_ctx = SSL_CTX_new (method);
 517   if (oc->ssl_ctx == NULL)
 518     {
 519       TLS_DBG (1, "SSL_CTX_new returned null");
 520       return -1;
 521     }
 522
 523   SSL_CTX_set_ecdh_auto (oc->ssl_ctx, 1);
 524   SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
 525 #ifdef HAVE_OPENSSL_ASYNC
 526   if (om->async)
 527     SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ASYNC);
 528 #endif
 529   rv = SSL_CTX_set_cipher_list (oc->ssl_ctx, (const char *) om->ciphers);
 530   if (rv != 1)
 531     {
 532       TLS_DBG (1, "Couldn't set cipher");
 533       return -1;
 534     }
 535
 536   SSL_CTX_set_options (oc->ssl_ctx, flags);
 537   SSL_CTX_set_cert_store (oc->ssl_ctx, om->cert_store);
 538
 539   oc->ssl = SSL_new (oc->ssl_ctx);
 540   if (oc->ssl == NULL)
 541     {
 542       TLS_DBG (1, "Couldn't initialize ssl struct");
 543       return -1;
 544     }
 545
 546   oc->rbio = BIO_new (BIO_s_mem ());
 547   oc->wbio = BIO_new (BIO_s_mem ());
 548
 549   BIO_set_mem_eof_return (oc->rbio, -1);
 550   BIO_set_mem_eof_return (oc->wbio, -1);
 551
 552   SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
 553   SSL_set_connect_state (oc->ssl);
 554
 555   rv = SSL_set_tlsext_host_name (oc->ssl, ctx->srv_hostname);
 556   if (rv != 1)
 557     {
 558       TLS_DBG (1, "Couldn't set hostname");
 559       return -1;
 560     }
 561
 562   /*
 563    * 2. Do the first steps in the handshake.
 564    */
 565   TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
 566            oc->openssl_ctx_index);
 567
 568   tls_session = session_get_from_handle (ctx->tls_session_handle);
 569   while (1)
 570     {
 571       rv = SSL_do_handshake (oc->ssl);
 572       err = SSL_get_error (oc->ssl, rv);
 573       openssl_try_handshake_write (oc, tls_session);
 574 #ifdef HAVE_OPENSSL_ASYNC
 575       if (err == SSL_ERROR_WANT_ASYNC)
 576         {
 577           handler = (openssl_resume_handler *) openssl_ctx_handshake_rx;
 578           vpp_ssl_async_process_event (ctx, handler);
 579           break;
 580         }
 581 #endif
 582       if (err != SSL_ERROR_WANT_WRITE)
 583         break;
 584     }
 585
 586   TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
 587            oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
 588   return 0;
 589 }
 590
 591 static int
 592 openssl_start_listen (tls_ctx_t * lctx)
 593 {
 594   application_t *app;
 595   const SSL_METHOD *method;
 596   SSL_CTX *ssl_ctx;
 597   int rv;
 598   BIO *cert_bio;
 599   X509 *srvcert;
 600   EVP_PKEY *pkey;
 601   u32 olc_index;
 602   openssl_listen_ctx_t *olc;
 603   app_worker_t *app_wrk;
 604
 605   long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
 606   openssl_main_t *om = &openssl_main;
 607
 608   app_wrk = app_worker_get (lctx->parent_app_wrk_index);
 609   if (!app_wrk)
 610     return -1;
 611
 612   app = application_get (app_wrk->app_index);
 613   if (!app->tls_cert || !app->tls_key)
 614     {
 615       TLS_DBG (1, "tls cert and/or key not configured %d",
 616                lctx->parent_app_wrk_index);
 617       return -1;
 618     }
 619
 620   method = SSLv23_method ();
 621   ssl_ctx = SSL_CTX_new (method);
 622   if (!ssl_ctx)
 623     {
 624       clib_warning ("Unable to create SSL context");
 625       return -1;
 626     }
 627
 628   SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
 629 #ifdef HAVE_OPENSSL_ASYNC
 630   if (om->async)
 631     SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ASYNC);
 632   SSL_CTX_set_async_callback (ssl_ctx, tls_async_openssl_callback);
 633 #endif
 634   SSL_CTX_set_options (ssl_ctx, flags);
 635   SSL_CTX_set_ecdh_auto (ssl_ctx, 1);
 636
 637   rv = SSL_CTX_set_cipher_list (ssl_ctx, (const char *) om->ciphers);
 638   if (rv != 1)
 639     {
 640       TLS_DBG (1, "Couldn't set cipher");
 641       return -1;
 642     }
 643
 644   /*
 645    * Set the key and cert
 646    */
 647   cert_bio = BIO_new (BIO_s_mem ());
 648   BIO_write (cert_bio, app->tls_cert, vec_len (app->tls_cert));
 649   srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
 650   if (!srvcert)
 651     {
 652       clib_warning ("unable to parse certificate");
 653       return -1;
 654     }
 655   SSL_CTX_use_certificate (ssl_ctx, srvcert);
 656   BIO_free (cert_bio);
 657
 658   cert_bio = BIO_new (BIO_s_mem ());
 659   BIO_write (cert_bio, app->tls_key, vec_len (app->tls_key));
 660   pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
 661   if (!pkey)
 662     {
 663       clib_warning ("unable to parse pkey");
 664       return -1;
 665     }
 666   SSL_CTX_use_PrivateKey (ssl_ctx, pkey);
 667   BIO_free (cert_bio);
 668
 669   olc_index = openssl_listen_ctx_alloc ();
 670   olc = openssl_lctx_get (olc_index);
 671   olc->ssl_ctx = ssl_ctx;
 672   olc->srvcert = srvcert;
 673   olc->pkey = pkey;
 674
 675   /* store SSL_CTX into TLS level structure */
 676   lctx->tls_ssl_ctx = olc_index;
 677
 678   return 0;
 679
 680 }
 681
 682 static int
 683 openssl_stop_listen (tls_ctx_t * lctx)
 684 {
 685   u32 olc_index;
 686   openssl_listen_ctx_t *olc;
 687
 688   olc_index = lctx->tls_ssl_ctx;
 689   olc = openssl_lctx_get (olc_index);
 690
 691   X509_free (olc->srvcert);
 692   EVP_PKEY_free (olc->pkey);
 693
 694   SSL_CTX_free (olc->ssl_ctx);
 695   openssl_listen_ctx_free (olc);
 696
 697   return 0;
 698 }
 699
 700 static int
 701 openssl_ctx_init_server (tls_ctx_t * ctx)
 702 {
 703   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 704   u32 olc_index = ctx->tls_ssl_ctx;
 705   openssl_listen_ctx_t *olc;
 706   session_t *tls_session;
 707   int rv, err;
 708 #ifdef HAVE_OPENSSL_ASYNC
 709   openssl_resume_handler *handler;
 710 #endif
 711
 712   /* Start a new connection */
 713
 714   olc = openssl_lctx_get (olc_index);
 715   oc->ssl = SSL_new (olc->ssl_ctx);
 716   if (oc->ssl == NULL)
 717     {
 718       TLS_DBG (1, "Couldn't initialize ssl struct");
 719       return -1;
 720     }
 721
 722   oc->rbio = BIO_new (BIO_s_mem ());
 723   oc->wbio = BIO_new (BIO_s_mem ());
 724
 725   BIO_set_mem_eof_return (oc->rbio, -1);
 726   BIO_set_mem_eof_return (oc->wbio, -1);
 727
 728   SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
 729   SSL_set_accept_state (oc->ssl);
 730
 731   TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
 732            oc->openssl_ctx_index);
 733
 734   tls_session = session_get_from_handle (ctx->tls_session_handle);
 735   while (1)
 736     {
 737       rv = SSL_do_handshake (oc->ssl);
 738       err = SSL_get_error (oc->ssl, rv);
 739       openssl_try_handshake_write (oc, tls_session);
 740 #ifdef HAVE_OPENSSL_ASYNC
 741       if (err == SSL_ERROR_WANT_ASYNC)
 742         {
 743           handler = (openssl_resume_handler *) openssl_ctx_handshake_rx;
 744           vpp_ssl_async_process_event (ctx, handler);
 745           break;
 746         }
 747 #endif
 748       if (err != SSL_ERROR_WANT_WRITE)
 749         break;
 750     }
 751
 752   TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
 753            oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
 754   return 0;
 755 }
 756
 757 static u8
 758 openssl_handshake_is_over (tls_ctx_t * ctx)
 759 {
 760   openssl_ctx_t *mc = (openssl_ctx_t *) ctx;
 761   if (!mc->ssl)
 762     return 0;
 763   return SSL_is_init_finished (mc->ssl);
 764 }
 765
 766 static int
 767 openssl_transport_close (tls_ctx_t * ctx)
 768 {
 769   if (!openssl_handshake_is_over (ctx))
 770     {
 771       openssl_handle_handshake_failure (ctx);
 772       return 0;
 773     }
 774   session_transport_closing_notify (&ctx->connection);
 775   return 0;
 776 }
 777
 778 static int
 779 openssl_app_close (tls_ctx_t * ctx)
 780 {
 781   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 782   session_t *app_session;
 783
 784   /* Wait for all data to be written to tcp */
 785   app_session = session_get_from_handle (ctx->app_session_handle);
 786   if (BIO_ctrl_pending (oc->rbio) <= 0
 787       && !svm_fifo_max_dequeue_cons (app_session->tx_fifo))
 788     openssl_confirm_app_close (ctx);
 789   else
 790     ctx->app_closed = 1;
 791   return 0;
 792 }
 793
 794 const static tls_engine_vft_t openssl_engine = {
 795   .ctx_alloc = openssl_ctx_alloc,
 796   .ctx_free = openssl_ctx_free,
 797   .ctx_get = openssl_ctx_get,
 798   .ctx_get_w_thread = openssl_ctx_get_w_thread,
 799   .ctx_init_server = openssl_ctx_init_server,
 800   .ctx_init_client = openssl_ctx_init_client,
 801   .ctx_write = openssl_ctx_write,
 802   .ctx_read = openssl_ctx_read,
 803   .ctx_handshake_is_over = openssl_handshake_is_over,
 804   .ctx_start_listen = openssl_start_listen,
 805   .ctx_stop_listen = openssl_stop_listen,
 806   .ctx_transport_close = openssl_transport_close,
 807   .ctx_app_close = openssl_app_close,
 808 };
 809
 810 int
 811 tls_init_ca_chain (void)
 812 {
 813   openssl_main_t *om = &openssl_main;
 814   tls_main_t *tm = vnet_tls_get_main ();
 815   BIO *cert_bio;
 816   X509 *testcert;
 817   int rv;
 818
 819   if (access (tm->ca_cert_path, F_OK | R_OK) == -1)
 820     {
 821       clib_warning ("Could not initialize TLS CA certificates");
 822       return -1;
 823     }
 824
 825   if (!(om->cert_store = X509_STORE_new ()))
 826     {
 827       clib_warning ("failed to create cert store");
 828       return -1;
 829     }
 830
 831   rv = X509_STORE_load_locations (om->cert_store, tm->ca_cert_path, 0);
 832   if (rv < 0)
 833     {
 834       clib_warning ("failed to load ca certificate");
 835     }
 836
 837   if (tm->use_test_cert_in_ca)
 838     {
 839       cert_bio = BIO_new (BIO_s_mem ());
 840       BIO_write (cert_bio, test_srv_crt_rsa, test_srv_crt_rsa_len);
 841       testcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
 842       if (!testcert)
 843         {
 844           clib_warning ("unable to parse certificate");
 845           return -1;
 846         }
 847       X509_STORE_add_cert (om->cert_store, testcert);
 848       rv = 0;
 849     }
 850   return (rv < 0 ? -1 : 0);
 851 }
 852
 853 static int
 854 tls_openssl_set_ciphers (char *ciphers)
 855 {
 856   openssl_main_t *om = &openssl_main;
 857   int i;
 858
 859   if (!ciphers)
 860     {
 861       return -1;
 862     }
 863
 864   vec_validate (om->ciphers, strlen (ciphers) - 1);
 865   for (i = 0; i < vec_len (om->ciphers); i++)
 866     {
 867       om->ciphers[i] = toupper (ciphers[i]);
 868     }
 869
 870   return 0;
 871
 872 }
 873
 874 static clib_error_t *
 875 tls_openssl_init (vlib_main_t * vm)
 876 {
 877   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 878   openssl_main_t *om = &openssl_main;
 879   u32 num_threads;
 880
 881   num_threads = 1 /* main thread */  + vtm->n_threads;
 882
 883   SSL_library_init ();
 884   SSL_load_error_strings ();
 885
 886   if (tls_init_ca_chain ())
 887     {
 888       clib_warning ("failed to initialize TLS CA chain");
 889       return 0;
 890     }
 891
 892   vec_validate (om->ctx_pool, num_threads - 1);
 893
 894   tls_register_engine (&openssl_engine, TLS_ENGINE_OPENSSL);
 895
 896   om->engine_init = 0;
 897
 898   /* default ciphers */
 899   tls_openssl_set_ciphers
 900     ("ALL:!ADH:!LOW:!EXP:!MD5:!RC4-SHA:!DES-CBC3-SHA:@STRENGTH");
 901
 902   return 0;
 903 }
 904 /* *INDENT-OFF* */
 905 VLIB_INIT_FUNCTION (tls_openssl_init) =
 906 {
 907   .runs_after = VLIB_INITS("tls_init"),
 908 };
 909 /* *INDENT-ON* */
 910
 911 #ifdef HAVE_OPENSSL_ASYNC
 912 static clib_error_t *
 913 tls_openssl_set_command_fn (vlib_main_t * vm, unformat_input_t * input,
 914                             vlib_cli_command_t * cmd)
 915 {
 916   openssl_main_t *om = &openssl_main;
 917   char *engine_name = NULL;
 918   char *engine_alg = NULL;
 919   char *ciphers = NULL;
 920   u8 engine_name_set = 0;
 921   int i;
 922
 923   /* By present, it is not allowed to configure engine again after running */
 924   if (om->engine_init)
 925     {
 926       clib_warning ("engine has started!\n");
 927       return clib_error_return
 928         (0, "engine has started, and no config is accepted");
 929     }
 930
 931   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 932     {
 933       if (unformat (input, "engine %s", &engine_name))
 934         {
 935           engine_name_set = 1;
 936         }
 937       else if (unformat (input, "async"))
 938         {
 939           om->async = 1;
 940           openssl_async_node_enable_disable (1);
 941         }
 942       else if (unformat (input, "alg %s", &engine_alg))
 943         {
 944           for (i = 0; i < strnlen (engine_alg, MAX_CRYPTO_LEN); i++)
 945             engine_alg[i] = toupper (engine_alg[i]);
 946         }
 947       else if (unformat (input, "ciphers %s", &ciphers))
 948         {
 949           tls_openssl_set_ciphers (ciphers);
 950         }
 951       else
 952         return clib_error_return (0, "failed: unknown input `%U'",
 953                                   format_unformat_error, input);
 954     }
 955
 956   /* reset parameters if engine is not configured */
 957   if (!engine_name_set)
 958     {
 959       clib_warning ("No engine provided! \n");
 960       om->async = 0;
 961     }
 962   else
 963     {
 964       if (!openssl_engine_register (engine_name, engine_alg))
 965         {
 966           return clib_error_return (0, "failed to register %s polling",
 967                                     engine_name);
 968         }
 969     }
 970
 971   return 0;
 972 }
 973
 974 /* *INDENT-OFF* */
 975 VLIB_CLI_COMMAND (tls_openssl_set_command, static) =
 976 {
 977   .path = "tls openssl set",
 978   .short_help = "tls openssl set [engine <engine name>] [alg [algorithm] [async]",
 979   .function = tls_openssl_set_command_fn,
 980 };
 981 /* *INDENT-ON* */
 982 #endif
 983
 984 /* *INDENT-OFF* */
 985 VLIB_PLUGIN_REGISTER () = {
 986     .version = VPP_BUILD_VER,
 987     .description = "Transport Layer Security (TLS) Engine, OpenSSL Based",
 988 };
 989 /* *INDENT-ON* */
 990
 991 /*
 992  * fd.io coding-style-patch-verification: ON
 993  *
 994  * Local Variables:
 995  * eval: (c-set-style "gnu")
 996  * End:
 997  */