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 int
 209 openssl_ctx_handshake_rx (tls_ctx_t * ctx, session_t * tls_session)
 210 {
 211   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 212   int rv = 0, err;
 213 #ifdef HAVE_OPENSSL_ASYNC
 214   int estatus;
 215   openssl_resume_handler *myself;
 216 #endif
 217
 218   while (SSL_in_init (oc->ssl))
 219     {
 220       if (ctx->resume)
 221         {
 222           ctx->resume = 0;
 223         }
 224       else if (!openssl_try_handshake_read (oc, tls_session))
 225         {
 226           break;
 227         }
 228
 229 #ifdef HAVE_OPENSSL_ASYNC
 230       myself = openssl_ctx_handshake_rx;
 231       vpp_ssl_async_process_event (ctx, myself);
 232 #endif
 233
 234       rv = SSL_do_handshake (oc->ssl);
 235       err = SSL_get_error (oc->ssl, rv);
 236       openssl_try_handshake_write (oc, tls_session);
 237 #ifdef HAVE_OPENSSL_ASYNC
 238       if (err == SSL_ERROR_WANT_ASYNC)
 239         {
 240           SSL_get_async_status (oc->ssl, &estatus);
 241
 242           if (estatus == ASYNC_STATUS_EAGAIN)
 243             {
 244               vpp_ssl_async_retry_func (ctx, myself);
 245             }
 246         }
 247 #endif
 248
 249       if (err != SSL_ERROR_WANT_WRITE)
 250         {
 251           if (err == SSL_ERROR_SSL)
 252             {
 253               char buf[512];
 254               ERR_error_string (ERR_get_error (), buf);
 255               clib_warning ("Err: %s", buf);
 256             }
 257           break;
 258         }
 259     }
 260   TLS_DBG (2, "tls state for %u is %s", oc->openssl_ctx_index,
 261            SSL_state_string_long (oc->ssl));
 262
 263   if (SSL_in_init (oc->ssl))
 264     return 0;
 265
 266   /*
 267    * Handshake complete
 268    */
 269   if (!SSL_is_server (oc->ssl))
 270     {
 271       /*
 272        * Verify server certificate
 273        */
 274       if ((rv = SSL_get_verify_result (oc->ssl)) != X509_V_OK)
 275         {
 276           TLS_DBG (1, " failed verify: %s\n",
 277                    X509_verify_cert_error_string (rv));
 278
 279           /*
 280            * Presence of hostname enforces strict certificate verification
 281            */
 282           if (ctx->srv_hostname)
 283             {
 284               tls_notify_app_connected (ctx, /* is failed */ 0);
 285               return -1;
 286             }
 287         }
 288       tls_notify_app_connected (ctx, /* is failed */ 0);
 289     }
 290   else
 291     {
 292       tls_notify_app_accept (ctx);
 293     }
 294
 295   TLS_DBG (1, "Handshake for %u complete. TLS cipher is %s",
 296            oc->openssl_ctx_index, SSL_get_cipher (oc->ssl));
 297   return rv;
 298 }
 299
 300 static inline int
 301 openssl_ctx_write (tls_ctx_t * ctx, session_t * app_session)
 302 {
 303   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 304   int wrote = 0, rv, read, max_buf = 100 * TLS_CHUNK_SIZE, max_space;
 305   u32 enq_max, deq_max, deq_now, to_write;
 306   session_t *tls_session;
 307   svm_fifo_t *f;
 308
 309   f = app_session->tx_fifo;
 310   deq_max = svm_fifo_max_dequeue_cons (f);
 311   if (!deq_max)
 312     goto check_tls_fifo;
 313
 314   max_space = max_buf - BIO_ctrl_pending (oc->rbio);
 315   max_space = (max_space < 0) ? 0 : max_space;
 316   deq_now = clib_min (deq_max, (u32) max_space);
 317   to_write = clib_min (svm_fifo_max_read_chunk (f), deq_now);
 318   wrote = SSL_write (oc->ssl, svm_fifo_head (f), to_write);
 319   if (wrote <= 0)
 320     {
 321       tls_add_vpp_q_builtin_tx_evt (app_session);
 322       goto check_tls_fifo;
 323     }
 324   svm_fifo_dequeue_drop (app_session->tx_fifo, wrote);
 325   if (wrote < deq_now)
 326     {
 327       to_write = clib_min (svm_fifo_max_read_chunk (f), deq_now - wrote);
 328       rv = SSL_write (oc->ssl, svm_fifo_head (f), to_write);
 329       if (rv > 0)
 330         {
 331           svm_fifo_dequeue_drop (app_session->tx_fifo, rv);
 332           wrote += rv;
 333         }
 334     }
 335
 336   if (svm_fifo_needs_tx_ntf (app_session->tx_fifo, wrote))
 337     session_dequeue_notify (app_session);
 338
 339   if (wrote < deq_max)
 340     tls_add_vpp_q_builtin_tx_evt (app_session);
 341
 342 check_tls_fifo:
 343
 344   if (BIO_ctrl_pending (oc->rbio) <= 0)
 345     return wrote;
 346
 347   tls_session = session_get_from_handle (ctx->tls_session_handle);
 348   f = tls_session->tx_fifo;
 349   enq_max = svm_fifo_max_enqueue_prod (f);
 350   if (!enq_max)
 351     {
 352       tls_add_vpp_q_builtin_tx_evt (app_session);
 353       return wrote;
 354     }
 355
 356   deq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max);
 357   read = BIO_read (oc->rbio, svm_fifo_tail (f), deq_now);
 358   if (read <= 0)
 359     {
 360       tls_add_vpp_q_builtin_tx_evt (app_session);
 361       return wrote;
 362     }
 363
 364   svm_fifo_enqueue_nocopy (f, read);
 365   tls_add_vpp_q_tx_evt (tls_session);
 366
 367   if (read < enq_max && BIO_ctrl_pending (oc->rbio) > 0)
 368     {
 369       deq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max - read);
 370       read = BIO_read (oc->rbio, svm_fifo_tail (f), deq_now);
 371       if (read > 0)
 372         svm_fifo_enqueue_nocopy (f, read);
 373     }
 374
 375   if (BIO_ctrl_pending (oc->rbio) > 0)
 376     tls_add_vpp_q_builtin_tx_evt (app_session);
 377
 378   return wrote;
 379 }
 380
 381 static inline int
 382 openssl_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
 383 {
 384   int read, wrote = 0, max_space, max_buf = 100 * TLS_CHUNK_SIZE, rv;
 385   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 386   u32 deq_max, enq_max, deq_now, to_read;
 387   session_t *app_session;
 388   svm_fifo_t *f;
 389
 390   if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
 391     {
 392       openssl_ctx_handshake_rx (ctx, tls_session);
 393       return 0;
 394     }
 395
 396   f = tls_session->rx_fifo;
 397   deq_max = svm_fifo_max_dequeue_cons (f);
 398   max_space = max_buf - BIO_ctrl_pending (oc->wbio);
 399   max_space = max_space < 0 ? 0 : max_space;
 400   deq_now = clib_min (deq_max, max_space);
 401   if (!deq_now)
 402     goto check_app_fifo;
 403
 404   to_read = clib_min (svm_fifo_max_read_chunk (f), deq_now);
 405   wrote = BIO_write (oc->wbio, svm_fifo_head (f), to_read);
 406   if (wrote <= 0)
 407     {
 408       tls_add_vpp_q_builtin_rx_evt (tls_session);
 409       goto check_app_fifo;
 410     }
 411   svm_fifo_dequeue_drop (f, wrote);
 412   if (wrote < deq_now)
 413     {
 414       to_read = clib_min (svm_fifo_max_read_chunk (f), deq_now - wrote);
 415       rv = BIO_write (oc->wbio, svm_fifo_head (f), to_read);
 416       if (rv > 0)
 417         {
 418           svm_fifo_dequeue_drop (f, rv);
 419           wrote += rv;
 420         }
 421     }
 422   if (svm_fifo_max_dequeue_cons (f))
 423     tls_add_vpp_q_builtin_rx_evt (tls_session);
 424
 425 check_app_fifo:
 426
 427   if (BIO_ctrl_pending (oc->wbio) <= 0)
 428     return wrote;
 429
 430   app_session = session_get_from_handle (ctx->app_session_handle);
 431   f = app_session->rx_fifo;
 432   enq_max = svm_fifo_max_enqueue_prod (f);
 433   if (!enq_max)
 434     {
 435       tls_add_vpp_q_builtin_rx_evt (tls_session);
 436       return wrote;
 437     }
 438
 439   deq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max);
 440   read = SSL_read (oc->ssl, svm_fifo_tail (f), deq_now);
 441   if (read <= 0)
 442     {
 443       tls_add_vpp_q_builtin_rx_evt (tls_session);
 444       return wrote;
 445     }
 446   svm_fifo_enqueue_nocopy (f, read);
 447   if (read < enq_max && BIO_ctrl_pending (oc->wbio) > 0)
 448     {
 449       deq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max - read);
 450       read = SSL_read (oc->ssl, svm_fifo_tail (f), deq_now);
 451       if (read > 0)
 452         svm_fifo_enqueue_nocopy (f, read);
 453     }
 454
 455   tls_notify_app_enqueue (ctx, app_session);
 456   if (BIO_ctrl_pending (oc->wbio) > 0)
 457     tls_add_vpp_q_builtin_rx_evt (tls_session);
 458
 459   return wrote;
 460 }
 461
 462 static int
 463 openssl_ctx_init_client (tls_ctx_t * ctx)
 464 {
 465   long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
 466   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 467   openssl_main_t *om = &openssl_main;
 468   session_t *tls_session;
 469   const SSL_METHOD *method;
 470   int rv, err;
 471 #ifdef HAVE_OPENSSL_ASYNC
 472   openssl_resume_handler *handler;
 473 #endif
 474
 475   method = SSLv23_client_method ();
 476   if (method == NULL)
 477     {
 478       TLS_DBG (1, "SSLv23_method returned null");
 479       return -1;
 480     }
 481
 482   oc->ssl_ctx = SSL_CTX_new (method);
 483   if (oc->ssl_ctx == NULL)
 484     {
 485       TLS_DBG (1, "SSL_CTX_new returned null");
 486       return -1;
 487     }
 488
 489   SSL_CTX_set_ecdh_auto (oc->ssl_ctx, 1);
 490   SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
 491 #ifdef HAVE_OPENSSL_ASYNC
 492   if (om->async)
 493     SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ASYNC);
 494 #endif
 495   rv = SSL_CTX_set_cipher_list (oc->ssl_ctx, (const char *) om->ciphers);
 496   if (rv != 1)
 497     {
 498       TLS_DBG (1, "Couldn't set cipher");
 499       return -1;
 500     }
 501
 502   SSL_CTX_set_options (oc->ssl_ctx, flags);
 503   SSL_CTX_set_cert_store (oc->ssl_ctx, om->cert_store);
 504
 505   oc->ssl = SSL_new (oc->ssl_ctx);
 506   if (oc->ssl == NULL)
 507     {
 508       TLS_DBG (1, "Couldn't initialize ssl struct");
 509       return -1;
 510     }
 511
 512   oc->rbio = BIO_new (BIO_s_mem ());
 513   oc->wbio = BIO_new (BIO_s_mem ());
 514
 515   BIO_set_mem_eof_return (oc->rbio, -1);
 516   BIO_set_mem_eof_return (oc->wbio, -1);
 517
 518   SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
 519   SSL_set_connect_state (oc->ssl);
 520
 521   rv = SSL_set_tlsext_host_name (oc->ssl, ctx->srv_hostname);
 522   if (rv != 1)
 523     {
 524       TLS_DBG (1, "Couldn't set hostname");
 525       return -1;
 526     }
 527
 528   /*
 529    * 2. Do the first steps in the handshake.
 530    */
 531   TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
 532            oc->openssl_ctx_index);
 533
 534   tls_session = session_get_from_handle (ctx->tls_session_handle);
 535   while (1)
 536     {
 537       rv = SSL_do_handshake (oc->ssl);
 538       err = SSL_get_error (oc->ssl, rv);
 539       openssl_try_handshake_write (oc, tls_session);
 540 #ifdef HAVE_OPENSSL_ASYNC
 541       if (err == SSL_ERROR_WANT_ASYNC)
 542         {
 543           handler = (openssl_resume_handler *) openssl_ctx_handshake_rx;
 544           vpp_ssl_async_process_event (ctx, handler);
 545           break;
 546         }
 547 #endif
 548       if (err != SSL_ERROR_WANT_WRITE)
 549         break;
 550     }
 551
 552   TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
 553            oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
 554   return 0;
 555 }
 556
 557 static int
 558 openssl_start_listen (tls_ctx_t * lctx)
 559 {
 560   application_t *app;
 561   const SSL_METHOD *method;
 562   SSL_CTX *ssl_ctx;
 563   int rv;
 564   BIO *cert_bio;
 565   X509 *srvcert;
 566   EVP_PKEY *pkey;
 567   u32 olc_index;
 568   openssl_listen_ctx_t *olc;
 569   app_worker_t *app_wrk;
 570
 571   long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
 572   openssl_main_t *om = &openssl_main;
 573
 574   app_wrk = app_worker_get (lctx->parent_app_wrk_index);
 575   if (!app_wrk)
 576     return -1;
 577
 578   app = application_get (app_wrk->app_index);
 579   if (!app->tls_cert || !app->tls_key)
 580     {
 581       TLS_DBG (1, "tls cert and/or key not configured %d",
 582                lctx->parent_app_wrk_index);
 583       return -1;
 584     }
 585
 586   method = SSLv23_method ();
 587   ssl_ctx = SSL_CTX_new (method);
 588   if (!ssl_ctx)
 589     {
 590       clib_warning ("Unable to create SSL context");
 591       return -1;
 592     }
 593
 594   SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
 595 #ifdef HAVE_OPENSSL_ASYNC
 596   if (om->async)
 597     SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ASYNC);
 598   SSL_CTX_set_async_callback (ssl_ctx, tls_async_openssl_callback);
 599 #endif
 600   SSL_CTX_set_options (ssl_ctx, flags);
 601   SSL_CTX_set_ecdh_auto (ssl_ctx, 1);
 602
 603   rv = SSL_CTX_set_cipher_list (ssl_ctx, (const char *) om->ciphers);
 604   if (rv != 1)
 605     {
 606       TLS_DBG (1, "Couldn't set cipher");
 607       return -1;
 608     }
 609
 610   /*
 611    * Set the key and cert
 612    */
 613   cert_bio = BIO_new (BIO_s_mem ());
 614   BIO_write (cert_bio, app->tls_cert, vec_len (app->tls_cert));
 615   srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
 616   if (!srvcert)
 617     {
 618       clib_warning ("unable to parse certificate");
 619       return -1;
 620     }
 621   SSL_CTX_use_certificate (ssl_ctx, srvcert);
 622   BIO_free (cert_bio);
 623
 624   cert_bio = BIO_new (BIO_s_mem ());
 625   BIO_write (cert_bio, app->tls_key, vec_len (app->tls_key));
 626   pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
 627   if (!pkey)
 628     {
 629       clib_warning ("unable to parse pkey");
 630       return -1;
 631     }
 632   SSL_CTX_use_PrivateKey (ssl_ctx, pkey);
 633   BIO_free (cert_bio);
 634
 635   olc_index = openssl_listen_ctx_alloc ();
 636   olc = openssl_lctx_get (olc_index);
 637   olc->ssl_ctx = ssl_ctx;
 638   olc->srvcert = srvcert;
 639   olc->pkey = pkey;
 640
 641   /* store SSL_CTX into TLS level structure */
 642   lctx->tls_ssl_ctx = olc_index;
 643
 644   return 0;
 645
 646 }
 647
 648 static int
 649 openssl_stop_listen (tls_ctx_t * lctx)
 650 {
 651   u32 olc_index;
 652   openssl_listen_ctx_t *olc;
 653
 654   olc_index = lctx->tls_ssl_ctx;
 655   olc = openssl_lctx_get (olc_index);
 656
 657   X509_free (olc->srvcert);
 658   EVP_PKEY_free (olc->pkey);
 659
 660   SSL_CTX_free (olc->ssl_ctx);
 661   openssl_listen_ctx_free (olc);
 662
 663   return 0;
 664 }
 665
 666 static int
 667 openssl_ctx_init_server (tls_ctx_t * ctx)
 668 {
 669   openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
 670   u32 olc_index = ctx->tls_ssl_ctx;
 671   openssl_listen_ctx_t *olc;
 672   session_t *tls_session;
 673   int rv, err;
 674 #ifdef HAVE_OPENSSL_ASYNC
 675   openssl_resume_handler *handler;
 676 #endif
 677
 678   /* Start a new connection */
 679
 680   olc = openssl_lctx_get (olc_index);
 681   oc->ssl = SSL_new (olc->ssl_ctx);
 682   if (oc->ssl == NULL)
 683     {
 684       TLS_DBG (1, "Couldn't initialize ssl struct");
 685       return -1;
 686     }
 687
 688   oc->rbio = BIO_new (BIO_s_mem ());
 689   oc->wbio = BIO_new (BIO_s_mem ());
 690
 691   BIO_set_mem_eof_return (oc->rbio, -1);
 692   BIO_set_mem_eof_return (oc->wbio, -1);
 693
 694   SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
 695   SSL_set_accept_state (oc->ssl);
 696
 697   TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
 698            oc->openssl_ctx_index);
 699
 700   tls_session = session_get_from_handle (ctx->tls_session_handle);
 701   while (1)
 702     {
 703       rv = SSL_do_handshake (oc->ssl);
 704       err = SSL_get_error (oc->ssl, rv);
 705       openssl_try_handshake_write (oc, tls_session);
 706 #ifdef HAVE_OPENSSL_ASYNC
 707       if (err == SSL_ERROR_WANT_ASYNC)
 708         {
 709           handler = (openssl_resume_handler *) openssl_ctx_handshake_rx;
 710           vpp_ssl_async_process_event (ctx, handler);
 711           break;
 712         }
 713 #endif
 714       if (err != SSL_ERROR_WANT_WRITE)
 715         break;
 716     }
 717
 718   TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
 719            oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
 720   return 0;
 721 }
 722
 723 static u8
 724 openssl_handshake_is_over (tls_ctx_t * ctx)
 725 {
 726   openssl_ctx_t *mc = (openssl_ctx_t *) ctx;
 727   if (!mc->ssl)
 728     return 0;
 729   return SSL_is_init_finished (mc->ssl);
 730 }
 731
 732 static int
 733 openssl_transport_close (tls_ctx_t * ctx)
 734 {
 735   if (!openssl_handshake_is_over (ctx))
 736     {
 737       session_close (session_get_from_handle (ctx->tls_session_handle));
 738       return 0;
 739     }
 740   session_transport_closing_notify (&ctx->connection);
 741   return 0;
 742 }
 743
 744 static int
 745 openssl_app_close (tls_ctx_t * ctx)
 746 {
 747   tls_disconnect_transport (ctx);
 748   session_transport_delete_notify (&ctx->connection);
 749   openssl_ctx_free (ctx);
 750   return 0;
 751 }
 752
 753 const static tls_engine_vft_t openssl_engine = {
 754   .ctx_alloc = openssl_ctx_alloc,
 755   .ctx_free = openssl_ctx_free,
 756   .ctx_get = openssl_ctx_get,
 757   .ctx_get_w_thread = openssl_ctx_get_w_thread,
 758   .ctx_init_server = openssl_ctx_init_server,
 759   .ctx_init_client = openssl_ctx_init_client,
 760   .ctx_write = openssl_ctx_write,
 761   .ctx_read = openssl_ctx_read,
 762   .ctx_handshake_is_over = openssl_handshake_is_over,
 763   .ctx_start_listen = openssl_start_listen,
 764   .ctx_stop_listen = openssl_stop_listen,
 765   .ctx_transport_close = openssl_transport_close,
 766   .ctx_app_close = openssl_app_close,
 767 };
 768
 769 int
 770 tls_init_ca_chain (void)
 771 {
 772   openssl_main_t *om = &openssl_main;
 773   tls_main_t *tm = vnet_tls_get_main ();
 774   BIO *cert_bio;
 775   X509 *testcert;
 776   int rv;
 777
 778   if (access (tm->ca_cert_path, F_OK | R_OK) == -1)
 779     {
 780       clib_warning ("Could not initialize TLS CA certificates");
 781       return -1;
 782     }
 783
 784   if (!(om->cert_store = X509_STORE_new ()))
 785     {
 786       clib_warning ("failed to create cert store");
 787       return -1;
 788     }
 789
 790   rv = X509_STORE_load_locations (om->cert_store, tm->ca_cert_path, 0);
 791   if (rv < 0)
 792     {
 793       clib_warning ("failed to load ca certificate");
 794     }
 795
 796   if (tm->use_test_cert_in_ca)
 797     {
 798       cert_bio = BIO_new (BIO_s_mem ());
 799       BIO_write (cert_bio, test_srv_crt_rsa, test_srv_crt_rsa_len);
 800       testcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
 801       if (!testcert)
 802         {
 803           clib_warning ("unable to parse certificate");
 804           return -1;
 805         }
 806       X509_STORE_add_cert (om->cert_store, testcert);
 807       rv = 0;
 808     }
 809   return (rv < 0 ? -1 : 0);
 810 }
 811
 812 static int
 813 tls_openssl_set_ciphers (char *ciphers)
 814 {
 815   openssl_main_t *om = &openssl_main;
 816   int i;
 817
 818   if (!ciphers)
 819     {
 820       return -1;
 821     }
 822
 823   vec_validate (om->ciphers, strlen (ciphers) - 1);
 824   for (i = 0; i < vec_len (om->ciphers); i++)
 825     {
 826       om->ciphers[i] = toupper (ciphers[i]);
 827     }
 828
 829   return 0;
 830
 831 }
 832
 833 static clib_error_t *
 834 tls_openssl_init (vlib_main_t * vm)
 835 {
 836   vlib_thread_main_t *vtm = vlib_get_thread_main ();
 837   openssl_main_t *om = &openssl_main;
 838   clib_error_t *error;
 839   u32 num_threads;
 840
 841   num_threads = 1 /* main thread */  + vtm->n_threads;
 842
 843   if ((error = vlib_call_init_function (vm, tls_init)))
 844     return error;
 845
 846   SSL_library_init ();
 847   SSL_load_error_strings ();
 848
 849   if (tls_init_ca_chain ())
 850     {
 851       clib_warning ("failed to initialize TLS CA chain");
 852       return 0;
 853     }
 854
 855   vec_validate (om->ctx_pool, num_threads - 1);
 856
 857   tls_register_engine (&openssl_engine, TLS_ENGINE_OPENSSL);
 858
 859   om->engine_init = 0;
 860
 861   /* default ciphers */
 862   tls_openssl_set_ciphers
 863     ("ALL:!ADH:!LOW:!EXP:!MD5:!RC4-SHA:!DES-CBC3-SHA:@STRENGTH");
 864
 865   return 0;
 866 }
 867
 868 #ifdef HAVE_OPENSSL_ASYNC
 869 static clib_error_t *
 870 tls_openssl_set_command_fn (vlib_main_t * vm, unformat_input_t * input,
 871                             vlib_cli_command_t * cmd)
 872 {
 873   openssl_main_t *om = &openssl_main;
 874   char *engine_name = NULL;
 875   char *engine_alg = NULL;
 876   char *ciphers = NULL;
 877   u8 engine_name_set = 0;
 878   int i;
 879
 880   /* By present, it is not allowed to configure engine again after running */
 881   if (om->engine_init)
 882     {
 883       clib_warning ("engine has started!\n");
 884       return clib_error_return
 885         (0, "engine has started, and no config is accepted");
 886     }
 887
 888   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 889     {
 890       if (unformat (input, "engine %s", &engine_name))
 891         {
 892           engine_name_set = 1;
 893         }
 894       else if (unformat (input, "async"))
 895         {
 896           om->async = 1;
 897           openssl_async_node_enable_disable (1);
 898         }
 899       else if (unformat (input, "alg %s", &engine_alg))
 900         {
 901           for (i = 0; i < strnlen (engine_alg, MAX_CRYPTO_LEN); i++)
 902             engine_alg[i] = toupper (engine_alg[i]);
 903         }
 904       else if (unformat (input, "ciphers %s", &ciphers))
 905         {
 906           tls_openssl_set_ciphers (ciphers);
 907         }
 908       else
 909         return clib_error_return (0, "failed: unknown input `%U'",
 910                                   format_unformat_error, input);
 911     }
 912
 913   /* reset parameters if engine is not configured */
 914   if (!engine_name_set)
 915     {
 916       clib_warning ("No engine provided! \n");
 917       om->async = 0;
 918     }
 919   else
 920     {
 921       if (!openssl_engine_register (engine_name, engine_alg))
 922         {
 923           return clib_error_return (0, "failed to register %s polling",
 924                                     engine_name);
 925         }
 926     }
 927
 928   return 0;
 929 }
 930
 931 /* *INDENT-OFF* */
 932 VLIB_CLI_COMMAND (tls_openssl_set_command, static) =
 933 {
 934   .path = "tls openssl set",
 935   .short_help = "tls openssl set [engine <engine name>] [alg [algorithm] [async]",
 936   .function = tls_openssl_set_command_fn,
 937 };
 938 /* *INDENT-ON* */
 939 #endif
 940
 941
 942 VLIB_INIT_FUNCTION (tls_openssl_init);
 943
 944 /* *INDENT-OFF* */
 945 VLIB_PLUGIN_REGISTER () = {
 946     .version = VPP_BUILD_VER,
 947     .description = "Transport Layer Security (TLS) Engine, OpenSSL Based",
 948 };
 949 /* *INDENT-ON* */
 950
 951 /*
 952  * fd.io coding-style-patch-verification: ON
 953  *
 954  * Local Variables:
 955  * eval: (c-set-style "gnu")
 956  * End:
 957  */