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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include <openssl/ssl.h>
17 #include <openssl/conf.h>
18 #include <openssl/err.h>
20 #ifdef HAVE_OPENSSL_ASYNC
21 #include <openssl/async.h>
24 #include <vnet/plugin/plugin.h>
25 #include <vpp/app/version.h>
26 #include <vnet/tls/tls.h>
28 #include <tlsopenssl/tls_openssl.h>
29 #include <tlsopenssl/tls_bios.h>
30 #include <openssl/x509_vfy.h>
31 #include <openssl/x509v3.h>
33 #define MAX_CRYPTO_LEN 64
35 openssl_main_t openssl_main;
38 openssl_ctx_alloc_w_thread (u32 thread_index)
40 openssl_main_t *om = &openssl_main;
43 pool_get (om->ctx_pool[thread_index], ctx);
45 *ctx = clib_mem_alloc (sizeof (openssl_ctx_t));
47 clib_memset (*ctx, 0, sizeof (openssl_ctx_t));
48 (*ctx)->ctx.c_thread_index = thread_index;
49 (*ctx)->ctx.tls_ctx_engine = CRYPTO_ENGINE_OPENSSL;
50 (*ctx)->ctx.app_session_handle = SESSION_INVALID_HANDLE;
51 (*ctx)->openssl_ctx_index = ctx - om->ctx_pool[thread_index];
52 return ((*ctx)->openssl_ctx_index);
56 openssl_ctx_alloc (void)
58 return openssl_ctx_alloc_w_thread (vlib_get_thread_index ());
62 openssl_ctx_free (tls_ctx_t * ctx)
64 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
66 /* Cleanup ssl ctx unless migrated */
67 if (!ctx->is_migrated)
69 if (SSL_is_init_finished (oc->ssl) && !ctx->is_passive_close)
70 SSL_shutdown (oc->ssl);
73 vec_free (ctx->srv_hostname);
75 #ifdef HAVE_OPENSSL_ASYNC
76 openssl_evt_free (ctx->evt_index, ctx->c_thread_index);
80 pool_put_index (openssl_main.ctx_pool[ctx->c_thread_index],
81 oc->openssl_ctx_index);
85 openssl_ctx_detach (tls_ctx_t *ctx)
87 openssl_ctx_t *oc = (openssl_ctx_t *) ctx, *oc_copy;
89 oc_copy = clib_mem_alloc (sizeof (*oc_copy));
90 clib_memcpy (oc_copy, oc, sizeof (*oc));
96 openssl_ctx_attach (u32 thread_index, void *ctx_ptr)
98 openssl_main_t *om = &openssl_main;
102 pool_get (om->ctx_pool[thread_index], oc);
103 /* Free the old instance instead of looking for an empty spot */
108 (*oc)->openssl_ctx_index = oc - om->ctx_pool[thread_index];
109 (*oc)->ctx.c_thread_index = thread_index;
111 sh = (*oc)->ctx.tls_session_handle;
112 BIO_set_data ((*oc)->rbio, uword_to_pointer (sh, void *));
113 BIO_set_data ((*oc)->wbio, uword_to_pointer (sh, void *));
115 return ((*oc)->openssl_ctx_index);
119 openssl_ctx_get (u32 ctx_index)
122 ctx = pool_elt_at_index (openssl_main.ctx_pool[vlib_get_thread_index ()],
128 openssl_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
131 ctx = pool_elt_at_index (openssl_main.ctx_pool[thread_index], ctx_index);
136 openssl_listen_ctx_alloc (void)
138 openssl_main_t *om = &openssl_main;
139 openssl_listen_ctx_t *lctx;
141 pool_get (om->lctx_pool, lctx);
143 clib_memset (lctx, 0, sizeof (openssl_listen_ctx_t));
144 lctx->openssl_lctx_index = lctx - om->lctx_pool;
145 return lctx->openssl_lctx_index;
149 openssl_listen_ctx_free (openssl_listen_ctx_t * lctx)
151 pool_put_index (openssl_main.lctx_pool, lctx->openssl_lctx_index);
154 openssl_listen_ctx_t *
155 openssl_lctx_get (u32 lctx_index)
157 return pool_elt_at_index (openssl_main.lctx_pool, lctx_index);
160 #define ossl_check_err_is_fatal(_ssl, _rv) \
161 if (PREDICT_FALSE (_rv < 0 && SSL_get_error (_ssl, _rv) == SSL_ERROR_SSL)) \
165 openssl_read_from_ssl_into_fifo (svm_fifo_t * f, SSL * ssl)
167 int read, rv, n_fs, i;
168 const int n_segs = 2;
169 svm_fifo_seg_t fs[n_segs];
172 max_enq = svm_fifo_max_enqueue_prod (f);
176 n_fs = svm_fifo_provision_chunks (f, fs, n_segs, max_enq);
180 /* Return early if we can't read anything */
181 read = SSL_read (ssl, fs[0].data, fs[0].len);
184 ossl_check_err_is_fatal (ssl, read);
188 for (i = 1; i < n_fs; i++)
190 rv = SSL_read (ssl, fs[i].data, fs[i].len);
191 read += rv > 0 ? rv : 0;
193 if (rv < (int) fs[i].len)
195 ossl_check_err_is_fatal (ssl, rv);
200 svm_fifo_enqueue_nocopy (f, read);
206 openssl_write_from_fifo_into_ssl (svm_fifo_t *f, SSL *ssl, u32 max_len)
208 int wrote = 0, rv, i = 0, len;
210 svm_fifo_seg_t fs[n_segs];
212 len = svm_fifo_segments (f, 0, fs, &n_segs, max_len);
216 while (wrote < len && i < n_segs)
218 rv = SSL_write (ssl, fs[i].data, fs[i].len);
219 wrote += (rv > 0) ? rv : 0;
220 if (rv < (int) fs[i].len)
222 ossl_check_err_is_fatal (ssl, rv);
229 svm_fifo_dequeue_drop (f, wrote);
234 #ifdef HAVE_OPENSSL_ASYNC
236 openssl_check_async_status (tls_ctx_t * ctx, openssl_resume_handler * handler,
239 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
242 SSL_get_async_status (oc->ssl, &estatus);
243 if (estatus == ASYNC_STATUS_EAGAIN)
245 vpp_tls_async_update_event (ctx, 1);
249 vpp_tls_async_update_event (ctx, 0);
259 openssl_handle_handshake_failure (tls_ctx_t * ctx)
261 session_t *app_session;
263 if (SSL_is_server (((openssl_ctx_t *) ctx)->ssl))
266 * Cleanup pre-allocated app session and close transport
269 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index);
272 session_free (app_session);
273 ctx->no_app_session = 1;
274 ctx->c_s_index = SESSION_INVALID_INDEX;
275 tls_disconnect_transport (ctx);
281 * Also handles cleanup of the pre-allocated session
283 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
284 tls_disconnect_transport (ctx);
289 openssl_ctx_handshake_rx (tls_ctx_t * ctx, session_t * tls_session)
291 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
294 while (SSL_in_init (oc->ssl))
300 else if (!svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
303 rv = SSL_do_handshake (oc->ssl);
304 err = SSL_get_error (oc->ssl, rv);
306 #ifdef HAVE_OPENSSL_ASYNC
307 if (err == SSL_ERROR_WANT_ASYNC)
309 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
313 if (err == SSL_ERROR_SSL)
316 ERR_error_string (ERR_get_error (), buf);
317 clib_warning ("Err: %s", buf);
319 openssl_handle_handshake_failure (ctx);
323 if (err != SSL_ERROR_WANT_WRITE && err != SSL_ERROR_WANT_READ)
326 TLS_DBG (2, "tls state for %u is %s", oc->openssl_ctx_index,
327 SSL_state_string_long (oc->ssl));
329 if (SSL_in_init (oc->ssl))
335 if (!SSL_is_server (oc->ssl))
338 * Verify server certificate
340 if ((rv = SSL_get_verify_result (oc->ssl)) != X509_V_OK)
342 TLS_DBG (1, " failed verify: %s\n",
343 X509_verify_cert_error_string (rv));
346 * Presence of hostname enforces strict certificate verification
348 if (ctx->srv_hostname)
350 openssl_handle_handshake_failure (ctx);
354 if (tls_notify_app_connected (ctx, SESSION_E_NONE))
356 tls_disconnect_transport (ctx);
362 /* Need to check transport status */
363 if (ctx->is_passive_close)
365 openssl_handle_handshake_failure (ctx);
369 /* Accept failed, cleanup */
370 if (tls_notify_app_accept (ctx))
372 ctx->c_s_index = SESSION_INVALID_INDEX;
373 tls_disconnect_transport (ctx);
378 TLS_DBG (1, "Handshake for %u complete. TLS cipher is %s",
379 oc->openssl_ctx_index, SSL_get_cipher (oc->ssl));
384 openssl_confirm_app_close (tls_ctx_t * ctx)
386 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
387 SSL_shutdown (oc->ssl);
388 tls_disconnect_transport (ctx);
389 session_transport_closed_notify (&ctx->connection);
393 openssl_ctx_write_tls (tls_ctx_t *ctx, session_t *app_session,
394 transport_send_params_t *sp)
396 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
397 u32 deq_max, space, enq_buf;
402 ts = session_get_from_handle (ctx->tls_session_handle);
403 space = svm_fifo_max_enqueue_prod (ts->tx_fifo);
404 /* Leave a bit of extra space for tls ctrl data, if any needed */
405 space = clib_max ((int) space - TLSO_CTRL_BYTES, 0);
407 f = app_session->tx_fifo;
409 deq_max = svm_fifo_max_dequeue_cons (f);
410 deq_max = clib_min (deq_max, space);
414 deq_max = clib_min (deq_max, sp->max_burst_size);
416 /* Make sure tcp's tx fifo can actually buffer all bytes to be dequeued.
417 * If under memory pressure, tls's fifo segment might not be able to
418 * allocate the chunks needed. This also avoids errors from the underlying
419 * custom bio to the ssl infra which at times can get stuck. */
420 if (svm_fifo_provision_chunks (ts->tx_fifo, 0, 0, deq_max + TLSO_CTRL_BYTES))
423 wrote = openssl_write_from_fifo_into_ssl (f, oc->ssl, deq_max);
425 /* Unrecoverable protocol error. Reset connection */
426 if (PREDICT_FALSE (wrote < 0))
428 tls_notify_app_io_error (ctx);
435 if (svm_fifo_needs_deq_ntf (f, wrote))
436 session_dequeue_notify (app_session);
440 if (PREDICT_FALSE (ctx->app_closed && BIO_ctrl_pending (oc->rbio) <= 0))
441 openssl_confirm_app_close (ctx);
443 /* Deschedule and wait for deq notification if fifo is almost full */
444 enq_buf = clib_min (svm_fifo_size (ts->tx_fifo) / 2, TLSO_MIN_ENQ_SPACE);
445 if (space < wrote + enq_buf)
447 svm_fifo_add_want_deq_ntf (ts->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
448 transport_connection_deschedule (&ctx->connection);
449 sp->flags |= TRANSPORT_SND_F_DESCHED;
452 /* Request tx reschedule of the app session */
453 app_session->flags |= SESSION_F_CUSTOM_TX;
459 openssl_ctx_write_dtls (tls_ctx_t *ctx, session_t *app_session,
460 transport_send_params_t *sp)
462 openssl_main_t *om = &openssl_main;
463 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
464 u32 read = 0, to_deq, dgram_sz, enq_max;
465 session_dgram_pre_hdr_t hdr;
470 us = session_get_from_handle (ctx->tls_session_handle);
471 to_deq = svm_fifo_max_dequeue_cons (app_session->tx_fifo);
472 buf = om->tx_bufs[ctx->c_thread_index];
476 /* Peeking only pre-header dgram because the session is connected */
477 rv = svm_fifo_peek (app_session->tx_fifo, 0, sizeof (hdr), (u8 *) &hdr);
478 ASSERT (rv == sizeof (hdr) && hdr.data_length < vec_len (buf));
479 ASSERT (to_deq >= hdr.data_length + SESSION_CONN_HDR_LEN);
481 dgram_sz = hdr.data_length + SESSION_CONN_HDR_LEN;
482 enq_max = dgram_sz + TLSO_CTRL_BYTES;
483 if (svm_fifo_max_enqueue_prod (us->tx_fifo) < enq_max ||
484 svm_fifo_provision_chunks (us->tx_fifo, 0, 0, enq_max))
486 svm_fifo_add_want_deq_ntf (us->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
487 transport_connection_deschedule (&ctx->connection);
488 sp->flags |= TRANSPORT_SND_F_DESCHED;
492 rv = svm_fifo_peek (app_session->tx_fifo, SESSION_CONN_HDR_LEN,
493 hdr.data_length, buf);
494 ASSERT (rv == hdr.data_length);
495 svm_fifo_dequeue_drop (app_session->tx_fifo, dgram_sz);
497 wrote = SSL_write (oc->ssl, buf, rv);
506 if (svm_fifo_needs_deq_ntf (app_session->tx_fifo, read))
507 session_dequeue_notify (app_session);
510 tls_add_vpp_q_tx_evt (us);
512 if (PREDICT_FALSE (ctx->app_closed &&
513 !svm_fifo_max_enqueue_prod (us->rx_fifo)))
514 openssl_confirm_app_close (ctx);
520 openssl_ctx_write (tls_ctx_t *ctx, session_t *app_session,
521 transport_send_params_t *sp)
523 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
524 return openssl_ctx_write_tls (ctx, app_session, sp);
526 return openssl_ctx_write_dtls (ctx, app_session, sp);
530 openssl_ctx_read_tls (tls_ctx_t *ctx, session_t *tls_session)
532 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
533 session_t *app_session;
537 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
539 if (openssl_ctx_handshake_rx (ctx, tls_session) < 0)
542 /* Application might force a session pool realloc on accept */
543 tls_session = session_get_from_handle (ctx->tls_session_handle);
546 app_session = session_get_from_handle (ctx->app_session_handle);
547 f = app_session->rx_fifo;
549 read = openssl_read_from_ssl_into_fifo (f, oc->ssl);
551 /* Unrecoverable protocol error. Reset connection */
552 if (PREDICT_FALSE (read < 0))
554 tls_notify_app_io_error (ctx);
558 /* If handshake just completed, session may still be in accepting state */
559 if (read && app_session->session_state >= SESSION_STATE_READY)
560 tls_notify_app_enqueue (ctx, app_session);
562 if ((SSL_pending (oc->ssl) > 0) ||
563 svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
564 tls_add_vpp_q_builtin_rx_evt (tls_session);
570 openssl_ctx_read_dtls (tls_ctx_t *ctx, session_t *us)
572 openssl_main_t *om = &openssl_main;
573 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
574 session_dgram_hdr_t hdr;
575 session_t *app_session;
580 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
582 u32 us_index = us->session_index;
583 if (openssl_ctx_handshake_rx (ctx, us) < 0)
585 /* Session pool might grow when allocating the app's session */
586 us = session_get (us_index, ctx->c_thread_index);
589 buf = om->rx_bufs[ctx->c_thread_index];
590 app_session = session_get_from_handle (ctx->app_session_handle);
591 svm_fifo_fill_chunk_list (app_session->rx_fifo);
593 while (svm_fifo_max_dequeue_cons (us->rx_fifo) > 0)
595 if (svm_fifo_max_enqueue_prod (app_session->rx_fifo) < DTLSO_MAX_DGRAM)
597 tls_add_vpp_q_builtin_rx_evt (us);
601 read = SSL_read (oc->ssl, buf, vec_len (buf));
602 if (PREDICT_FALSE (read <= 0))
605 tls_add_vpp_q_builtin_rx_evt (us);
610 hdr.data_length = read;
613 svm_fifo_seg_t segs[2] = { { (u8 *) &hdr, sizeof (hdr) },
616 rv = svm_fifo_enqueue_segments (app_session->rx_fifo, segs, 2,
617 0 /* allow partial */);
623 /* If handshake just completed, session may still be in accepting state */
624 if (app_session->session_state >= SESSION_STATE_READY)
625 tls_notify_app_enqueue (ctx, app_session);
631 openssl_ctx_read (tls_ctx_t *ctx, session_t *ts)
633 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
634 return openssl_ctx_read_tls (ctx, ts);
636 return openssl_ctx_read_dtls (ctx, ts);
640 openssl_set_ckpair (SSL *ssl, u32 ckpair_index)
642 app_cert_key_pair_t *ckpair;
647 /* Configure a ckpair index only if non-default/test provided */
648 if (ckpair_index == 0)
651 ckpair = app_cert_key_pair_get_if_valid (ckpair_index);
655 if (!ckpair->cert || !ckpair->key)
657 TLS_DBG (1, "tls cert and/or key not configured");
661 * Set the key and cert
663 cert_bio = BIO_new (BIO_s_mem ());
664 BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
665 srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
668 clib_warning ("unable to parse certificate");
671 SSL_use_certificate (ssl, srvcert);
674 cert_bio = BIO_new (BIO_s_mem ());
675 BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
676 pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
679 clib_warning ("unable to parse pkey");
682 SSL_use_PrivateKey (ssl, pkey);
684 TLS_DBG (1, "TLS client using ckpair index: %d", ckpair_index);
689 openssl_client_init_verify (SSL *ssl, const char *srv_hostname,
690 int set_hostname_verification,
691 int set_hostname_strict_check)
693 if (set_hostname_verification)
695 X509_VERIFY_PARAM *param = SSL_get0_param (ssl);
698 TLS_DBG (1, "Couldn't fetch SSL param");
702 if (set_hostname_strict_check)
703 X509_VERIFY_PARAM_set_hostflags (param,
704 X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS);
706 if (!X509_VERIFY_PARAM_set1_host (param, srv_hostname, 0))
708 TLS_DBG (1, "Couldn't set hostname for verification");
711 SSL_set_verify (ssl, SSL_VERIFY_PEER, 0);
713 if (!SSL_set_tlsext_host_name (ssl, srv_hostname))
715 TLS_DBG (1, "Couldn't set hostname");
722 openssl_ctx_init_client (tls_ctx_t * ctx)
724 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
725 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
726 openssl_main_t *om = &openssl_main;
727 const SSL_METHOD *method;
730 method = ctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_client_method () :
731 DTLS_client_method ();
734 TLS_DBG (1, "(D)TLS_method returned null");
738 oc->ssl_ctx = SSL_CTX_new (method);
739 if (oc->ssl_ctx == NULL)
741 TLS_DBG (1, "SSL_CTX_new returned null");
745 SSL_CTX_set_ecdh_auto (oc->ssl_ctx, 1);
746 SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
747 #ifdef HAVE_OPENSSL_ASYNC
749 SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ASYNC);
751 rv = SSL_CTX_set_cipher_list (oc->ssl_ctx, (const char *) om->ciphers);
754 TLS_DBG (1, "Couldn't set cipher");
758 SSL_CTX_set_options (oc->ssl_ctx, flags);
759 SSL_CTX_set_cert_store (oc->ssl_ctx, om->cert_store);
761 oc->ssl = SSL_new (oc->ssl_ctx);
764 TLS_DBG (1, "Couldn't initialize ssl struct");
768 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
770 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
771 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
775 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
776 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
779 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
780 SSL_set_connect_state (oc->ssl);
782 /* Hostname validation and strict check by name are disabled by default */
783 rv = openssl_client_init_verify (oc->ssl, (const char *) ctx->srv_hostname,
787 TLS_DBG (1, "ERROR:verify init failed:%d", rv);
790 if (openssl_set_ckpair (oc->ssl, ctx->ckpair_index))
792 TLS_DBG (1, "Couldn't set client certificate-key pair");
796 * 2. Do the first steps in the handshake.
798 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
799 oc->openssl_ctx_index);
801 #ifdef HAVE_OPENSSL_ASYNC
802 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
803 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
807 rv = SSL_do_handshake (oc->ssl);
808 err = SSL_get_error (oc->ssl, rv);
809 #ifdef HAVE_OPENSSL_ASYNC
810 if (err == SSL_ERROR_WANT_ASYNC)
812 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
817 if (err != SSL_ERROR_WANT_WRITE)
821 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
822 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
827 openssl_start_listen (tls_ctx_t * lctx)
829 const SSL_METHOD *method;
836 openssl_listen_ctx_t *olc;
837 app_cert_key_pair_t *ckpair;
839 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
840 openssl_main_t *om = &openssl_main;
842 ckpair = app_cert_key_pair_get_if_valid (lctx->ckpair_index);
846 if (!ckpair->cert || !ckpair->key)
848 TLS_DBG (1, "tls cert and/or key not configured %d",
849 lctx->parent_app_wrk_index);
853 method = lctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_server_method () :
854 DTLS_server_method ();
855 ssl_ctx = SSL_CTX_new (method);
858 clib_warning ("Unable to create SSL context");
862 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
863 #ifdef HAVE_OPENSSL_ASYNC
866 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ASYNC);
867 SSL_CTX_set_async_callback (ssl_ctx, tls_async_openssl_callback);
870 SSL_CTX_set_options (ssl_ctx, flags);
871 SSL_CTX_set_ecdh_auto (ssl_ctx, 1);
873 rv = SSL_CTX_set_cipher_list (ssl_ctx, (const char *) om->ciphers);
876 TLS_DBG (1, "Couldn't set cipher");
880 /* use the default OpenSSL built-in DH parameters */
881 rv = SSL_CTX_set_dh_auto (ssl_ctx, 1);
884 TLS_DBG (1, "Couldn't set temp DH parameters");
889 * Set the key and cert
891 cert_bio = BIO_new (BIO_s_mem ());
894 clib_warning ("unable to allocate memory");
897 BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
898 srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
901 clib_warning ("unable to parse certificate");
904 rv = SSL_CTX_use_certificate (ssl_ctx, srvcert);
907 clib_warning ("unable to use SSL certificate");
913 cert_bio = BIO_new (BIO_s_mem ());
916 clib_warning ("unable to allocate memory");
919 BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
920 pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
923 clib_warning ("unable to parse pkey");
926 rv = SSL_CTX_use_PrivateKey (ssl_ctx, pkey);
929 clib_warning ("unable to use SSL PrivateKey");
935 olc_index = openssl_listen_ctx_alloc ();
936 olc = openssl_lctx_get (olc_index);
937 olc->ssl_ctx = ssl_ctx;
938 olc->srvcert = srvcert;
941 /* store SSL_CTX into TLS level structure */
942 lctx->tls_ssl_ctx = olc_index;
953 openssl_stop_listen (tls_ctx_t * lctx)
956 openssl_listen_ctx_t *olc;
958 olc_index = lctx->tls_ssl_ctx;
959 olc = openssl_lctx_get (olc_index);
961 X509_free (olc->srvcert);
962 EVP_PKEY_free (olc->pkey);
964 SSL_CTX_free (olc->ssl_ctx);
965 openssl_listen_ctx_free (olc);
971 openssl_ctx_init_server (tls_ctx_t * ctx)
973 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
974 u32 olc_index = ctx->tls_ssl_ctx;
975 openssl_listen_ctx_t *olc;
978 /* Start a new connection */
980 olc = openssl_lctx_get (olc_index);
981 oc->ssl = SSL_new (olc->ssl_ctx);
984 TLS_DBG (1, "Couldn't initialize ssl struct");
988 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
990 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
991 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
995 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
996 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
999 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
1000 SSL_set_accept_state (oc->ssl);
1002 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
1003 oc->openssl_ctx_index);
1005 #ifdef HAVE_OPENSSL_ASYNC
1006 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
1007 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
1011 rv = SSL_do_handshake (oc->ssl);
1012 err = SSL_get_error (oc->ssl, rv);
1013 #ifdef HAVE_OPENSSL_ASYNC
1014 if (err == SSL_ERROR_WANT_ASYNC)
1016 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
1021 if (err != SSL_ERROR_WANT_WRITE)
1025 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
1026 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
1031 openssl_handshake_is_over (tls_ctx_t * ctx)
1033 openssl_ctx_t *mc = (openssl_ctx_t *) ctx;
1036 return SSL_is_init_finished (mc->ssl);
1040 openssl_transport_close (tls_ctx_t * ctx)
1042 #ifdef HAVE_OPENSSL_ASYNC
1043 if (vpp_openssl_is_inflight (ctx))
1047 if (!openssl_handshake_is_over (ctx))
1049 openssl_handle_handshake_failure (ctx);
1052 session_transport_closing_notify (&ctx->connection);
1057 openssl_app_close (tls_ctx_t * ctx)
1059 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
1060 session_t *app_session;
1062 /* Wait for all data to be written to tcp */
1063 app_session = session_get_from_handle (ctx->app_session_handle);
1064 if (BIO_ctrl_pending (oc->rbio) <= 0
1065 && !svm_fifo_max_dequeue_cons (app_session->tx_fifo))
1066 openssl_confirm_app_close (ctx);
1068 ctx->app_closed = 1;
1073 tls_init_ca_chain (void)
1075 openssl_main_t *om = &openssl_main;
1076 tls_main_t *tm = vnet_tls_get_main ();
1081 if (access (tm->ca_cert_path, F_OK | R_OK) == -1)
1083 clib_warning ("Could not initialize TLS CA certificates");
1087 if (!(om->cert_store = X509_STORE_new ()))
1089 clib_warning ("failed to create cert store");
1093 #if OPENSSL_VERSION_NUMBER >= 0x30000000L
1094 rv = X509_STORE_load_file (om->cert_store, tm->ca_cert_path);
1096 rv = X509_STORE_load_locations (om->cert_store, tm->ca_cert_path, 0);
1101 clib_warning ("failed to load ca certificate");
1104 if (tm->use_test_cert_in_ca)
1106 cert_bio = BIO_new (BIO_s_mem ());
1107 BIO_write (cert_bio, test_srv_crt_rsa, test_srv_crt_rsa_len);
1108 testcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
1111 clib_warning ("unable to parse certificate");
1114 X509_STORE_add_cert (om->cert_store, testcert);
1117 return (rv < 0 ? -1 : 0);
1121 openssl_reinit_ca_chain (void)
1123 openssl_main_t *om = &openssl_main;
1125 /* Remove/free existing x509_store */
1128 X509_STORE_free (om->cert_store);
1130 return tls_init_ca_chain ();
1133 const static tls_engine_vft_t openssl_engine = {
1134 .ctx_alloc = openssl_ctx_alloc,
1135 .ctx_alloc_w_thread = openssl_ctx_alloc_w_thread,
1136 .ctx_free = openssl_ctx_free,
1137 .ctx_attach = openssl_ctx_attach,
1138 .ctx_detach = openssl_ctx_detach,
1139 .ctx_get = openssl_ctx_get,
1140 .ctx_get_w_thread = openssl_ctx_get_w_thread,
1141 .ctx_init_server = openssl_ctx_init_server,
1142 .ctx_init_client = openssl_ctx_init_client,
1143 .ctx_write = openssl_ctx_write,
1144 .ctx_read = openssl_ctx_read,
1145 .ctx_handshake_is_over = openssl_handshake_is_over,
1146 .ctx_start_listen = openssl_start_listen,
1147 .ctx_stop_listen = openssl_stop_listen,
1148 .ctx_transport_close = openssl_transport_close,
1149 .ctx_app_close = openssl_app_close,
1150 .ctx_reinit_cachain = openssl_reinit_ca_chain,
1154 tls_openssl_set_ciphers (char *ciphers)
1156 openssl_main_t *om = &openssl_main;
1164 vec_validate (om->ciphers, strlen (ciphers));
1165 for (i = 0; i < vec_len (om->ciphers) - 1; i++)
1167 om->ciphers[i] = toupper (ciphers[i]);
1174 static clib_error_t *
1175 tls_openssl_init (vlib_main_t * vm)
1177 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1178 openssl_main_t *om = &openssl_main;
1179 clib_error_t *error = 0;
1182 error = tls_openssl_api_init (vm);
1183 num_threads = 1 /* main thread */ + vtm->n_threads;
1185 SSL_library_init ();
1186 SSL_load_error_strings ();
1188 vec_validate (om->ctx_pool, num_threads - 1);
1189 vec_validate (om->rx_bufs, num_threads - 1);
1190 vec_validate (om->tx_bufs, num_threads - 1);
1191 for (i = 0; i < num_threads; i++)
1193 vec_validate (om->rx_bufs[i], DTLSO_MAX_DGRAM);
1194 vec_validate (om->tx_bufs[i], DTLSO_MAX_DGRAM);
1196 tls_register_engine (&openssl_engine, CRYPTO_ENGINE_OPENSSL);
1198 om->engine_init = 0;
1200 /* default ciphers */
1201 tls_openssl_set_ciphers
1202 ("ALL:!ADH:!LOW:!EXP:!MD5:!RC4-SHA:!DES-CBC3-SHA:@STRENGTH");
1204 if (tls_init_ca_chain ())
1206 clib_warning ("failed to initialize TLS CA chain");
1213 VLIB_INIT_FUNCTION (tls_openssl_init) =
1215 .runs_after = VLIB_INITS("tls_init"),
1219 #ifdef HAVE_OPENSSL_ASYNC
1220 static clib_error_t *
1221 tls_openssl_set_command_fn (vlib_main_t * vm, unformat_input_t * input,
1222 vlib_cli_command_t * cmd)
1224 openssl_main_t *om = &openssl_main;
1225 char *engine_name = NULL;
1226 char *engine_alg = NULL;
1227 char *ciphers = NULL;
1228 u8 engine_name_set = 0;
1231 /* By present, it is not allowed to configure engine again after running */
1232 if (om->engine_init)
1234 clib_warning ("engine has started!\n");
1235 return clib_error_return
1236 (0, "engine has started, and no config is accepted");
1239 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1241 if (unformat (input, "engine %s", &engine_name))
1243 engine_name_set = 1;
1245 else if (unformat (input, "async"))
1249 else if (unformat (input, "alg %s", &engine_alg))
1251 for (i = 0; i < strnlen (engine_alg, MAX_CRYPTO_LEN); i++)
1252 engine_alg[i] = toupper (engine_alg[i]);
1254 else if (unformat (input, "ciphers %s", &ciphers))
1256 tls_openssl_set_ciphers (ciphers);
1259 return clib_error_return (0, "failed: unknown input `%U'",
1260 format_unformat_error, input);
1263 /* reset parameters if engine is not configured */
1264 if (!engine_name_set)
1266 clib_warning ("No engine provided! \n");
1271 vnet_session_enable_disable (vm, 1);
1272 if (openssl_engine_register (engine_name, engine_alg, async) < 0)
1274 return clib_error_return (0, "Failed to register %s polling",
1279 vlib_cli_output (vm, "Successfully register engine %s\n",
1289 VLIB_CLI_COMMAND (tls_openssl_set_command, static) =
1291 .path = "tls openssl set",
1292 .short_help = "tls openssl set [engine <engine name>] [alg [algorithm] [async]",
1293 .function = tls_openssl_set_command_fn,
1299 VLIB_PLUGIN_REGISTER () = {
1300 .version = VPP_BUILD_VER,
1301 .description = "Transport Layer Security (TLS) Engine, OpenSSL Based",
1306 * fd.io coding-style-patch-verification: ON
1309 * eval: (c-set-style "gnu")