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_aligned_safe (om->ctx_pool[thread_index], ctx, 0);
46 *ctx = clib_mem_alloc (sizeof (openssl_ctx_t));
48 clib_memset (*ctx, 0, sizeof (openssl_ctx_t));
49 (*ctx)->ctx.c_thread_index = thread_index;
50 (*ctx)->ctx.tls_ctx_engine = CRYPTO_ENGINE_OPENSSL;
51 (*ctx)->ctx.app_session_handle = SESSION_INVALID_HANDLE;
52 (*ctx)->openssl_ctx_index = ctx - om->ctx_pool[thread_index];
53 return ((*ctx)->openssl_ctx_index);
57 openssl_ctx_alloc (void)
59 return openssl_ctx_alloc_w_thread (vlib_get_thread_index ());
63 openssl_ctx_free (tls_ctx_t * ctx)
65 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
67 /* Cleanup ssl ctx unless migrated */
68 if (!ctx->is_migrated)
70 if (SSL_is_init_finished (oc->ssl) && !ctx->is_passive_close)
71 SSL_shutdown (oc->ssl);
74 vec_free (ctx->srv_hostname);
75 SSL_CTX_free (oc->client_ssl_ctx);
76 #ifdef HAVE_OPENSSL_ASYNC
77 openssl_evt_free (ctx->evt_index, ctx->c_thread_index);
81 pool_put_index (openssl_main.ctx_pool[ctx->c_thread_index],
82 oc->openssl_ctx_index);
86 openssl_ctx_detach (tls_ctx_t *ctx)
88 openssl_ctx_t *oc = (openssl_ctx_t *) ctx, *oc_copy;
90 oc_copy = clib_mem_alloc (sizeof (*oc_copy));
91 clib_memcpy (oc_copy, oc, sizeof (*oc));
97 openssl_ctx_attach (u32 thread_index, void *ctx_ptr)
99 openssl_main_t *om = &openssl_main;
103 pool_get_aligned_safe (om->ctx_pool[thread_index], oc, 0);
104 /* Free the old instance instead of looking for an empty spot */
109 (*oc)->openssl_ctx_index = oc - om->ctx_pool[thread_index];
110 (*oc)->ctx.c_thread_index = thread_index;
112 sh = (*oc)->ctx.tls_session_handle;
113 BIO_set_data ((*oc)->rbio, uword_to_pointer (sh, void *));
114 BIO_set_data ((*oc)->wbio, uword_to_pointer (sh, void *));
116 return ((*oc)->openssl_ctx_index);
120 openssl_ctx_get (u32 ctx_index)
123 ctx = pool_elt_at_index (openssl_main.ctx_pool[vlib_get_thread_index ()],
129 openssl_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
132 ctx = pool_elt_at_index (openssl_main.ctx_pool[thread_index], ctx_index);
137 openssl_listen_ctx_alloc (void)
139 openssl_main_t *om = &openssl_main;
140 openssl_listen_ctx_t *lctx;
142 pool_get (om->lctx_pool, lctx);
144 clib_memset (lctx, 0, sizeof (openssl_listen_ctx_t));
145 lctx->openssl_lctx_index = lctx - om->lctx_pool;
146 return lctx->openssl_lctx_index;
150 openssl_listen_ctx_free (openssl_listen_ctx_t * lctx)
152 pool_put_index (openssl_main.lctx_pool, lctx->openssl_lctx_index);
155 openssl_listen_ctx_t *
156 openssl_lctx_get (u32 lctx_index)
158 return pool_elt_at_index (openssl_main.lctx_pool, lctx_index);
161 #define ossl_check_err_is_fatal(_ssl, _rv) \
162 if (PREDICT_FALSE (_rv < 0 && SSL_get_error (_ssl, _rv) == SSL_ERROR_SSL)) \
166 openssl_read_from_ssl_into_fifo (svm_fifo_t *f, SSL *ssl, u32 max_len)
168 int read, rv, n_fs, i;
169 const int n_segs = 2;
170 svm_fifo_seg_t fs[n_segs];
173 max_enq = svm_fifo_max_enqueue_prod (f);
177 max_enq = clib_min (max_len, max_enq);
178 n_fs = svm_fifo_provision_chunks (f, fs, n_segs, max_enq);
182 /* Return early if we can't read anything */
183 read = SSL_read (ssl, fs[0].data, fs[0].len);
186 ossl_check_err_is_fatal (ssl, read);
190 if (read == (int) fs[0].len)
192 for (i = 1; i < n_fs; i++)
194 rv = SSL_read (ssl, fs[i].data, fs[i].len);
195 read += rv > 0 ? rv : 0;
197 if (rv < (int) fs[i].len)
199 ossl_check_err_is_fatal (ssl, rv);
204 svm_fifo_enqueue_nocopy (f, read);
210 openssl_write_from_fifo_into_ssl (svm_fifo_t *f, SSL *ssl, u32 max_len)
212 int wrote = 0, rv, i = 0, len;
214 svm_fifo_seg_t fs[n_segs];
216 len = svm_fifo_segments (f, 0, fs, &n_segs, max_len);
220 while (wrote < len && i < n_segs)
222 rv = SSL_write (ssl, fs[i].data, fs[i].len);
223 wrote += (rv > 0) ? rv : 0;
224 if (rv < (int) fs[i].len)
226 ossl_check_err_is_fatal (ssl, rv);
233 svm_fifo_dequeue_drop (f, wrote);
238 #ifdef HAVE_OPENSSL_ASYNC
240 openssl_check_async_status (tls_ctx_t * ctx, openssl_resume_handler * handler,
243 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
246 SSL_get_async_status (oc->ssl, &estatus);
247 if (estatus == ASYNC_STATUS_EAGAIN)
249 vpp_tls_async_update_event (ctx, 1);
253 vpp_tls_async_update_event (ctx, 0);
263 openssl_handle_handshake_failure (tls_ctx_t * ctx)
265 session_t *app_session;
267 if (SSL_is_server (((openssl_ctx_t *) ctx)->ssl))
270 * Cleanup pre-allocated app session and close transport
273 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index);
276 session_free (app_session);
277 ctx->c_s_index = SESSION_INVALID_INDEX;
278 tls_disconnect_transport (ctx);
280 ctx->no_app_session = 1;
285 * Also handles cleanup of the pre-allocated session
287 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
288 tls_disconnect_transport (ctx);
293 openssl_ctx_handshake_rx (tls_ctx_t * ctx, session_t * tls_session)
295 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
298 while (SSL_in_init (oc->ssl))
304 else if (!svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
307 rv = SSL_do_handshake (oc->ssl);
308 err = SSL_get_error (oc->ssl, rv);
310 #ifdef HAVE_OPENSSL_ASYNC
311 if (err == SSL_ERROR_WANT_ASYNC)
313 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
317 if (err == SSL_ERROR_SSL)
320 ERR_error_string (ERR_get_error (), buf);
321 clib_warning ("Err: %s", buf);
323 openssl_handle_handshake_failure (ctx);
327 if (err != SSL_ERROR_WANT_WRITE && err != SSL_ERROR_WANT_READ)
330 TLS_DBG (2, "tls state for %u is %s", oc->openssl_ctx_index,
331 SSL_state_string_long (oc->ssl));
333 if (SSL_in_init (oc->ssl))
339 if (!SSL_is_server (oc->ssl))
342 * Verify server certificate
344 if ((rv = SSL_get_verify_result (oc->ssl)) != X509_V_OK)
346 TLS_DBG (1, " failed verify: %s\n",
347 X509_verify_cert_error_string (rv));
350 * Presence of hostname enforces strict certificate verification
352 if (ctx->srv_hostname)
354 openssl_handle_handshake_failure (ctx);
358 if (tls_notify_app_connected (ctx, SESSION_E_NONE))
360 tls_disconnect_transport (ctx);
366 /* Need to check transport status */
367 if (ctx->is_passive_close)
369 openssl_handle_handshake_failure (ctx);
373 /* Accept failed, cleanup */
374 if (tls_notify_app_accept (ctx))
376 ctx->c_s_index = SESSION_INVALID_INDEX;
377 tls_disconnect_transport (ctx);
382 TLS_DBG (1, "Handshake for %u complete. TLS cipher is %s",
383 oc->openssl_ctx_index, SSL_get_cipher (oc->ssl));
388 openssl_confirm_app_close (tls_ctx_t * ctx)
390 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
391 SSL_shutdown (oc->ssl);
392 tls_disconnect_transport (ctx);
393 session_transport_closed_notify (&ctx->connection);
397 openssl_ctx_write_tls (tls_ctx_t *ctx, session_t *app_session,
398 transport_send_params_t *sp)
400 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
401 u32 deq_max, space, enq_buf;
406 ts = session_get_from_handle (ctx->tls_session_handle);
407 space = svm_fifo_max_enqueue_prod (ts->tx_fifo);
408 /* Leave a bit of extra space for tls ctrl data, if any needed */
409 space = clib_max ((int) space - TLSO_CTRL_BYTES, 0);
411 f = app_session->tx_fifo;
413 deq_max = svm_fifo_max_dequeue_cons (f);
414 deq_max = clib_min (deq_max, space);
418 deq_max = clib_min (deq_max, sp->max_burst_size);
420 /* Make sure tcp's tx fifo can actually buffer all bytes to be dequeued.
421 * If under memory pressure, tls's fifo segment might not be able to
422 * allocate the chunks needed. This also avoids errors from the underlying
423 * custom bio to the ssl infra which at times can get stuck. */
424 if (svm_fifo_provision_chunks (ts->tx_fifo, 0, 0, deq_max + TLSO_CTRL_BYTES))
427 wrote = openssl_write_from_fifo_into_ssl (f, oc->ssl, deq_max);
429 /* Unrecoverable protocol error. Reset connection */
430 if (PREDICT_FALSE (wrote < 0))
432 tls_notify_app_io_error (ctx);
439 if (svm_fifo_needs_deq_ntf (f, wrote))
440 session_dequeue_notify (app_session);
444 if (PREDICT_FALSE (ctx->app_closed && BIO_ctrl_pending (oc->rbio) <= 0))
445 openssl_confirm_app_close (ctx);
447 /* Deschedule and wait for deq notification if fifo is almost full */
448 enq_buf = clib_min (svm_fifo_size (ts->tx_fifo) / 2, TLSO_MIN_ENQ_SPACE);
449 if (space < wrote + enq_buf)
451 svm_fifo_add_want_deq_ntf (ts->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
452 transport_connection_deschedule (&ctx->connection);
453 sp->flags |= TRANSPORT_SND_F_DESCHED;
456 /* Request tx reschedule of the app session */
457 app_session->flags |= SESSION_F_CUSTOM_TX;
463 openssl_ctx_write_dtls (tls_ctx_t *ctx, session_t *app_session,
464 transport_send_params_t *sp)
466 openssl_main_t *om = &openssl_main;
467 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
468 u32 read = 0, to_deq, dgram_sz, enq_max;
469 session_dgram_pre_hdr_t hdr;
474 us = session_get_from_handle (ctx->tls_session_handle);
475 to_deq = svm_fifo_max_dequeue_cons (app_session->tx_fifo);
476 buf = om->tx_bufs[ctx->c_thread_index];
480 /* Peeking only pre-header dgram because the session is connected */
481 rv = svm_fifo_peek (app_session->tx_fifo, 0, sizeof (hdr), (u8 *) &hdr);
482 ASSERT (rv == sizeof (hdr) && hdr.data_length < vec_len (buf));
483 ASSERT (to_deq >= hdr.data_length + SESSION_CONN_HDR_LEN);
485 dgram_sz = hdr.data_length + SESSION_CONN_HDR_LEN;
486 enq_max = dgram_sz + TLSO_CTRL_BYTES;
487 if (svm_fifo_max_enqueue_prod (us->tx_fifo) < enq_max ||
488 svm_fifo_provision_chunks (us->tx_fifo, 0, 0, enq_max))
490 svm_fifo_add_want_deq_ntf (us->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
491 transport_connection_deschedule (&ctx->connection);
492 sp->flags |= TRANSPORT_SND_F_DESCHED;
496 rv = svm_fifo_peek (app_session->tx_fifo, SESSION_CONN_HDR_LEN,
497 hdr.data_length, buf);
498 ASSERT (rv == hdr.data_length);
499 svm_fifo_dequeue_drop (app_session->tx_fifo, dgram_sz);
501 wrote = SSL_write (oc->ssl, buf, rv);
510 if (svm_fifo_needs_deq_ntf (app_session->tx_fifo, read))
511 session_dequeue_notify (app_session);
514 tls_add_vpp_q_tx_evt (us);
516 if (PREDICT_FALSE (ctx->app_closed &&
517 !svm_fifo_max_enqueue_prod (us->rx_fifo)))
518 openssl_confirm_app_close (ctx);
524 openssl_ctx_write (tls_ctx_t *ctx, session_t *app_session,
525 transport_send_params_t *sp)
527 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
528 return openssl_ctx_write_tls (ctx, app_session, sp);
530 return openssl_ctx_write_dtls (ctx, app_session, sp);
534 openssl_ctx_read_tls (tls_ctx_t *ctx, session_t *tls_session)
536 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
537 const u32 max_len = 128 << 10;
538 session_t *app_session;
542 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
544 if (openssl_ctx_handshake_rx (ctx, tls_session) < 0)
547 /* Application might force a session pool realloc on accept */
548 tls_session = session_get_from_handle (ctx->tls_session_handle);
551 app_session = session_get_from_handle (ctx->app_session_handle);
552 f = app_session->rx_fifo;
554 read = openssl_read_from_ssl_into_fifo (f, oc->ssl, max_len);
556 /* Unrecoverable protocol error. Reset connection */
557 if (PREDICT_FALSE (read < 0))
559 tls_notify_app_io_error (ctx);
564 tls_notify_app_enqueue (ctx, app_session);
566 if ((SSL_pending (oc->ssl) > 0) ||
567 svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
568 tls_add_vpp_q_builtin_rx_evt (tls_session);
574 openssl_ctx_read_dtls (tls_ctx_t *ctx, session_t *us)
576 openssl_main_t *om = &openssl_main;
577 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
578 session_dgram_hdr_t hdr;
579 session_t *app_session;
584 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
586 u32 us_index = us->session_index;
587 if (openssl_ctx_handshake_rx (ctx, us) < 0)
589 /* Session pool might grow when allocating the app's session */
590 us = session_get (us_index, ctx->c_thread_index);
593 buf = om->rx_bufs[ctx->c_thread_index];
594 app_session = session_get_from_handle (ctx->app_session_handle);
595 svm_fifo_fill_chunk_list (app_session->rx_fifo);
597 while (svm_fifo_max_dequeue_cons (us->rx_fifo) > 0)
599 if (svm_fifo_max_enqueue_prod (app_session->rx_fifo) < DTLSO_MAX_DGRAM)
601 tls_add_vpp_q_builtin_rx_evt (us);
605 read = SSL_read (oc->ssl, buf, vec_len (buf));
606 if (PREDICT_FALSE (read <= 0))
609 tls_add_vpp_q_builtin_rx_evt (us);
614 hdr.data_length = read;
617 svm_fifo_seg_t segs[2] = { { (u8 *) &hdr, sizeof (hdr) },
620 rv = svm_fifo_enqueue_segments (app_session->rx_fifo, segs, 2,
621 0 /* allow partial */);
627 /* If handshake just completed, session may still be in accepting state */
628 if (app_session->session_state >= SESSION_STATE_READY)
629 tls_notify_app_enqueue (ctx, app_session);
635 openssl_ctx_read (tls_ctx_t *ctx, session_t *ts)
637 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
638 return openssl_ctx_read_tls (ctx, ts);
640 return openssl_ctx_read_dtls (ctx, ts);
644 openssl_set_ckpair (SSL *ssl, u32 ckpair_index)
646 app_cert_key_pair_t *ckpair;
651 /* Configure a ckpair index only if non-default/test provided */
652 if (ckpair_index == 0)
655 ckpair = app_cert_key_pair_get_if_valid (ckpair_index);
659 if (!ckpair->cert || !ckpair->key)
661 TLS_DBG (1, "tls cert and/or key not configured");
665 * Set the key and cert
667 cert_bio = BIO_new (BIO_s_mem ());
668 BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
669 srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
672 clib_warning ("unable to parse certificate");
675 SSL_use_certificate (ssl, srvcert);
678 cert_bio = BIO_new (BIO_s_mem ());
679 BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
680 pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
683 clib_warning ("unable to parse pkey");
686 SSL_use_PrivateKey (ssl, pkey);
688 TLS_DBG (1, "TLS client using ckpair index: %d", ckpair_index);
693 openssl_client_init_verify (SSL *ssl, const char *srv_hostname,
694 int set_hostname_verification,
695 int set_hostname_strict_check)
697 if (set_hostname_verification)
699 X509_VERIFY_PARAM *param = SSL_get0_param (ssl);
702 TLS_DBG (1, "Couldn't fetch SSL param");
706 if (set_hostname_strict_check)
707 X509_VERIFY_PARAM_set_hostflags (param,
708 X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS);
710 if (!X509_VERIFY_PARAM_set1_host (param, srv_hostname, 0))
712 TLS_DBG (1, "Couldn't set hostname for verification");
715 SSL_set_verify (ssl, SSL_VERIFY_PEER, 0);
717 if (!SSL_set_tlsext_host_name (ssl, srv_hostname))
719 TLS_DBG (1, "Couldn't set hostname");
726 openssl_ctx_init_client (tls_ctx_t * ctx)
728 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
729 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
730 openssl_main_t *om = &openssl_main;
731 const SSL_METHOD *method;
734 method = ctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_client_method () :
735 DTLS_client_method ();
738 TLS_DBG (1, "(D)TLS_method returned null");
742 oc->client_ssl_ctx = SSL_CTX_new (method);
743 if (oc->client_ssl_ctx == NULL)
745 TLS_DBG (1, "SSL_CTX_new returned null");
749 SSL_CTX_set_ecdh_auto (oc->client_ssl_ctx, 1);
750 SSL_CTX_set_mode (oc->client_ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
751 #ifdef HAVE_OPENSSL_ASYNC
753 SSL_CTX_set_mode (oc->client_ssl_ctx, SSL_MODE_ASYNC);
756 SSL_CTX_set_cipher_list (oc->client_ssl_ctx, (const char *) om->ciphers);
759 TLS_DBG (1, "Couldn't set cipher");
763 SSL_CTX_set_options (oc->client_ssl_ctx, flags);
764 SSL_CTX_set1_cert_store (oc->client_ssl_ctx, om->cert_store);
766 oc->ssl = SSL_new (oc->client_ssl_ctx);
769 TLS_DBG (1, "Couldn't initialize ssl struct");
773 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
775 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
776 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
780 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
781 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
784 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
785 SSL_set_connect_state (oc->ssl);
787 /* Hostname validation and strict check by name are disabled by default */
788 rv = openssl_client_init_verify (oc->ssl, (const char *) ctx->srv_hostname,
792 TLS_DBG (1, "ERROR:verify init failed:%d", rv);
795 if (openssl_set_ckpair (oc->ssl, ctx->ckpair_index))
797 TLS_DBG (1, "Couldn't set client certificate-key pair");
801 * 2. Do the first steps in the handshake.
803 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
804 oc->openssl_ctx_index);
806 #ifdef HAVE_OPENSSL_ASYNC
807 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
808 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
812 rv = SSL_do_handshake (oc->ssl);
813 err = SSL_get_error (oc->ssl, rv);
814 #ifdef HAVE_OPENSSL_ASYNC
815 if (err == SSL_ERROR_WANT_ASYNC)
817 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
822 if (err != SSL_ERROR_WANT_WRITE)
826 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
827 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
832 openssl_start_listen (tls_ctx_t * lctx)
834 const SSL_METHOD *method;
841 openssl_listen_ctx_t *olc;
842 app_cert_key_pair_t *ckpair;
844 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
845 openssl_main_t *om = &openssl_main;
847 ckpair = app_cert_key_pair_get_if_valid (lctx->ckpair_index);
851 if (!ckpair->cert || !ckpair->key)
853 TLS_DBG (1, "tls cert and/or key not configured %d",
854 lctx->parent_app_wrk_index);
858 method = lctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_server_method () :
859 DTLS_server_method ();
860 ssl_ctx = SSL_CTX_new (method);
863 clib_warning ("Unable to create SSL context");
867 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
868 #ifdef HAVE_OPENSSL_ASYNC
871 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ASYNC);
872 SSL_CTX_set_async_callback (ssl_ctx, tls_async_openssl_callback);
875 SSL_CTX_set_options (ssl_ctx, flags);
876 SSL_CTX_set_ecdh_auto (ssl_ctx, 1);
878 rv = SSL_CTX_set_cipher_list (ssl_ctx, (const char *) om->ciphers);
881 TLS_DBG (1, "Couldn't set cipher");
885 /* use the default OpenSSL built-in DH parameters */
886 rv = SSL_CTX_set_dh_auto (ssl_ctx, 1);
889 TLS_DBG (1, "Couldn't set temp DH parameters");
894 * Set the key and cert
896 cert_bio = BIO_new (BIO_s_mem ());
899 clib_warning ("unable to allocate memory");
902 BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
903 srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
906 clib_warning ("unable to parse certificate");
909 rv = SSL_CTX_use_certificate (ssl_ctx, srvcert);
912 clib_warning ("unable to use SSL certificate");
918 cert_bio = BIO_new (BIO_s_mem ());
921 clib_warning ("unable to allocate memory");
924 BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
925 pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
928 clib_warning ("unable to parse pkey");
931 rv = SSL_CTX_use_PrivateKey (ssl_ctx, pkey);
934 clib_warning ("unable to use SSL PrivateKey");
940 olc_index = openssl_listen_ctx_alloc ();
941 olc = openssl_lctx_get (olc_index);
942 olc->ssl_ctx = ssl_ctx;
943 olc->srvcert = srvcert;
946 /* store SSL_CTX into TLS level structure */
947 lctx->tls_ssl_ctx = olc_index;
958 openssl_stop_listen (tls_ctx_t * lctx)
961 openssl_listen_ctx_t *olc;
963 olc_index = lctx->tls_ssl_ctx;
964 olc = openssl_lctx_get (olc_index);
966 X509_free (olc->srvcert);
967 EVP_PKEY_free (olc->pkey);
969 SSL_CTX_free (olc->ssl_ctx);
970 openssl_listen_ctx_free (olc);
976 openssl_ctx_init_server (tls_ctx_t * ctx)
978 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
979 u32 olc_index = ctx->tls_ssl_ctx;
980 openssl_listen_ctx_t *olc;
983 /* Start a new connection */
985 olc = openssl_lctx_get (olc_index);
986 oc->ssl = SSL_new (olc->ssl_ctx);
989 TLS_DBG (1, "Couldn't initialize ssl struct");
993 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
995 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
996 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
1000 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
1001 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
1004 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
1005 SSL_set_accept_state (oc->ssl);
1007 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
1008 oc->openssl_ctx_index);
1010 #ifdef HAVE_OPENSSL_ASYNC
1011 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
1012 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
1016 rv = SSL_do_handshake (oc->ssl);
1017 err = SSL_get_error (oc->ssl, rv);
1018 #ifdef HAVE_OPENSSL_ASYNC
1019 if (err == SSL_ERROR_WANT_ASYNC)
1021 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
1026 if (err != SSL_ERROR_WANT_WRITE)
1030 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
1031 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
1036 openssl_handshake_is_over (tls_ctx_t * ctx)
1038 openssl_ctx_t *mc = (openssl_ctx_t *) ctx;
1041 return SSL_is_init_finished (mc->ssl);
1045 openssl_transport_close (tls_ctx_t * ctx)
1047 #ifdef HAVE_OPENSSL_ASYNC
1048 if (vpp_openssl_is_inflight (ctx))
1052 if (!openssl_handshake_is_over (ctx))
1054 openssl_handle_handshake_failure (ctx);
1057 session_transport_closing_notify (&ctx->connection);
1062 openssl_app_close (tls_ctx_t * ctx)
1064 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
1065 session_t *app_session;
1067 /* Wait for all data to be written to tcp */
1068 app_session = session_get_from_handle (ctx->app_session_handle);
1069 if (BIO_ctrl_pending (oc->rbio) <= 0
1070 && !svm_fifo_max_dequeue_cons (app_session->tx_fifo))
1071 openssl_confirm_app_close (ctx);
1073 ctx->app_closed = 1;
1078 tls_init_ca_chain (void)
1080 openssl_main_t *om = &openssl_main;
1081 tls_main_t *tm = vnet_tls_get_main ();
1086 if (access (tm->ca_cert_path, F_OK | R_OK) == -1)
1088 clib_warning ("Could not initialize TLS CA certificates");
1092 if (!(om->cert_store = X509_STORE_new ()))
1094 clib_warning ("failed to create cert store");
1098 #if OPENSSL_VERSION_NUMBER >= 0x30000000L
1099 rv = X509_STORE_load_file (om->cert_store, tm->ca_cert_path);
1101 rv = X509_STORE_load_locations (om->cert_store, tm->ca_cert_path, 0);
1106 clib_warning ("failed to load ca certificate");
1109 if (tm->use_test_cert_in_ca)
1111 cert_bio = BIO_new (BIO_s_mem ());
1112 BIO_write (cert_bio, test_srv_crt_rsa, test_srv_crt_rsa_len);
1113 testcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
1116 clib_warning ("unable to parse certificate");
1119 X509_STORE_add_cert (om->cert_store, testcert);
1122 return (rv < 0 ? -1 : 0);
1126 openssl_reinit_ca_chain (void)
1128 openssl_main_t *om = &openssl_main;
1130 /* Remove/free existing x509_store */
1133 X509_STORE_free (om->cert_store);
1135 return tls_init_ca_chain ();
1138 const static tls_engine_vft_t openssl_engine = {
1139 .ctx_alloc = openssl_ctx_alloc,
1140 .ctx_alloc_w_thread = openssl_ctx_alloc_w_thread,
1141 .ctx_free = openssl_ctx_free,
1142 .ctx_attach = openssl_ctx_attach,
1143 .ctx_detach = openssl_ctx_detach,
1144 .ctx_get = openssl_ctx_get,
1145 .ctx_get_w_thread = openssl_ctx_get_w_thread,
1146 .ctx_init_server = openssl_ctx_init_server,
1147 .ctx_init_client = openssl_ctx_init_client,
1148 .ctx_write = openssl_ctx_write,
1149 .ctx_read = openssl_ctx_read,
1150 .ctx_handshake_is_over = openssl_handshake_is_over,
1151 .ctx_start_listen = openssl_start_listen,
1152 .ctx_stop_listen = openssl_stop_listen,
1153 .ctx_transport_close = openssl_transport_close,
1154 .ctx_app_close = openssl_app_close,
1155 .ctx_reinit_cachain = openssl_reinit_ca_chain,
1159 tls_openssl_set_ciphers (char *ciphers)
1161 openssl_main_t *om = &openssl_main;
1169 vec_validate (om->ciphers, strlen (ciphers));
1170 for (i = 0; i < vec_len (om->ciphers) - 1; i++)
1172 om->ciphers[i] = toupper (ciphers[i]);
1179 static clib_error_t *
1180 tls_openssl_init (vlib_main_t * vm)
1182 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1183 openssl_main_t *om = &openssl_main;
1184 clib_error_t *error = 0;
1187 error = tls_openssl_api_init (vm);
1188 num_threads = 1 /* main thread */ + vtm->n_threads;
1190 SSL_library_init ();
1191 SSL_load_error_strings ();
1193 vec_validate (om->ctx_pool, num_threads - 1);
1194 vec_validate (om->rx_bufs, num_threads - 1);
1195 vec_validate (om->tx_bufs, num_threads - 1);
1196 for (i = 0; i < num_threads; i++)
1198 vec_validate (om->rx_bufs[i], DTLSO_MAX_DGRAM);
1199 vec_validate (om->tx_bufs[i], DTLSO_MAX_DGRAM);
1201 tls_register_engine (&openssl_engine, CRYPTO_ENGINE_OPENSSL);
1203 om->engine_init = 0;
1205 /* default ciphers */
1206 tls_openssl_set_ciphers
1207 ("ALL:!ADH:!LOW:!EXP:!MD5:!RC4-SHA:!DES-CBC3-SHA:@STRENGTH");
1209 if (tls_init_ca_chain ())
1211 clib_warning ("failed to initialize TLS CA chain");
1218 VLIB_INIT_FUNCTION (tls_openssl_init) =
1220 .runs_after = VLIB_INITS("tls_init"),
1224 #ifdef HAVE_OPENSSL_ASYNC
1225 static clib_error_t *
1226 tls_openssl_set_command_fn (vlib_main_t * vm, unformat_input_t * input,
1227 vlib_cli_command_t * cmd)
1229 openssl_main_t *om = &openssl_main;
1230 char *engine_name = NULL;
1231 char *engine_alg = NULL;
1232 char *ciphers = NULL;
1233 u8 engine_name_set = 0;
1236 /* By present, it is not allowed to configure engine again after running */
1237 if (om->engine_init)
1239 clib_warning ("engine has started!\n");
1240 return clib_error_return
1241 (0, "engine has started, and no config is accepted");
1244 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1246 if (unformat (input, "engine %s", &engine_name))
1248 engine_name_set = 1;
1250 else if (unformat (input, "async"))
1254 else if (unformat (input, "alg %s", &engine_alg))
1256 for (i = 0; i < strnlen (engine_alg, MAX_CRYPTO_LEN); i++)
1257 engine_alg[i] = toupper (engine_alg[i]);
1259 else if (unformat (input, "ciphers %s", &ciphers))
1261 tls_openssl_set_ciphers (ciphers);
1264 return clib_error_return (0, "failed: unknown input `%U'",
1265 format_unformat_error, input);
1268 /* reset parameters if engine is not configured */
1269 if (!engine_name_set)
1271 clib_warning ("No engine provided! \n");
1276 vnet_session_enable_disable (vm, 1);
1277 if (openssl_engine_register (engine_name, engine_alg, async) < 0)
1279 return clib_error_return (0, "Failed to register %s polling",
1284 vlib_cli_output (vm, "Successfully register engine %s\n",
1294 VLIB_CLI_COMMAND (tls_openssl_set_command, static) =
1296 .path = "tls openssl set",
1297 .short_help = "tls openssl set [engine <engine name>] [alg [algorithm] [async]",
1298 .function = tls_openssl_set_command_fn,
1304 VLIB_PLUGIN_REGISTER () = {
1305 .version = VPP_BUILD_VER,
1306 .description = "Transport Layer Security (TLS) Engine, OpenSSL Based",
1311 * fd.io coding-style-patch-verification: ON
1314 * eval: (c-set-style "gnu")