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>
31 #define MAX_CRYPTO_LEN 64
33 openssl_main_t openssl_main;
36 openssl_ctx_alloc_w_thread (u32 thread_index)
38 openssl_main_t *om = &openssl_main;
41 pool_get (om->ctx_pool[thread_index], ctx);
43 *ctx = clib_mem_alloc (sizeof (openssl_ctx_t));
45 clib_memset (*ctx, 0, sizeof (openssl_ctx_t));
46 (*ctx)->ctx.c_thread_index = thread_index;
47 (*ctx)->ctx.tls_ctx_engine = CRYPTO_ENGINE_OPENSSL;
48 (*ctx)->ctx.app_session_handle = SESSION_INVALID_HANDLE;
49 (*ctx)->openssl_ctx_index = ctx - om->ctx_pool[thread_index];
50 return ((*ctx)->openssl_ctx_index);
54 openssl_ctx_alloc (void)
56 return openssl_ctx_alloc_w_thread (vlib_get_thread_index ());
60 openssl_ctx_free (tls_ctx_t * ctx)
62 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
64 /* Cleanup ssl ctx unless migrated */
65 if (!ctx->is_migrated)
67 if (SSL_is_init_finished (oc->ssl) && !ctx->is_passive_close)
68 SSL_shutdown (oc->ssl);
71 vec_free (ctx->srv_hostname);
73 #ifdef HAVE_OPENSSL_ASYNC
74 openssl_evt_free (ctx->evt_index, ctx->c_thread_index);
78 pool_put_index (openssl_main.ctx_pool[ctx->c_thread_index],
79 oc->openssl_ctx_index);
83 openssl_ctx_detach (tls_ctx_t *ctx)
85 openssl_ctx_t *oc = (openssl_ctx_t *) ctx, *oc_copy;
87 oc_copy = clib_mem_alloc (sizeof (*oc_copy));
88 clib_memcpy (oc_copy, oc, sizeof (*oc));
94 openssl_ctx_attach (u32 thread_index, void *ctx_ptr)
96 openssl_main_t *om = &openssl_main;
100 pool_get (om->ctx_pool[thread_index], oc);
101 /* Free the old instance instead of looking for an empty spot */
106 (*oc)->openssl_ctx_index = oc - om->ctx_pool[thread_index];
107 (*oc)->ctx.c_thread_index = thread_index;
109 sh = (*oc)->ctx.tls_session_handle;
110 BIO_set_data ((*oc)->rbio, uword_to_pointer (sh, void *));
111 BIO_set_data ((*oc)->wbio, uword_to_pointer (sh, void *));
113 return ((*oc)->openssl_ctx_index);
117 openssl_ctx_get (u32 ctx_index)
120 ctx = pool_elt_at_index (openssl_main.ctx_pool[vlib_get_thread_index ()],
126 openssl_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
129 ctx = pool_elt_at_index (openssl_main.ctx_pool[thread_index], ctx_index);
134 openssl_listen_ctx_alloc (void)
136 openssl_main_t *om = &openssl_main;
137 openssl_listen_ctx_t *lctx;
139 pool_get (om->lctx_pool, lctx);
141 clib_memset (lctx, 0, sizeof (openssl_listen_ctx_t));
142 lctx->openssl_lctx_index = lctx - om->lctx_pool;
143 return lctx->openssl_lctx_index;
147 openssl_listen_ctx_free (openssl_listen_ctx_t * lctx)
149 pool_put_index (openssl_main.lctx_pool, lctx->openssl_lctx_index);
152 openssl_listen_ctx_t *
153 openssl_lctx_get (u32 lctx_index)
155 return pool_elt_at_index (openssl_main.lctx_pool, lctx_index);
159 openssl_read_from_ssl_into_fifo (svm_fifo_t * f, SSL * ssl)
161 int read, rv, n_fs, i;
162 const int n_segs = 2;
163 svm_fifo_seg_t fs[n_segs];
166 max_enq = svm_fifo_max_enqueue_prod (f);
170 n_fs = svm_fifo_provision_chunks (f, fs, n_segs, max_enq);
174 /* Return early if we can't read anything */
175 read = SSL_read (ssl, fs[0].data, fs[0].len);
179 for (i = 1; i < n_fs; i++)
181 rv = SSL_read (ssl, fs[i].data, fs[i].len);
182 read += rv > 0 ? rv : 0;
184 if (rv < (int) fs[i].len)
188 svm_fifo_enqueue_nocopy (f, read);
194 openssl_write_from_fifo_into_ssl (svm_fifo_t *f, SSL *ssl, u32 max_len)
196 int wrote = 0, rv, i = 0, len;
197 const int n_segs = 2;
198 svm_fifo_seg_t fs[n_segs];
200 len = svm_fifo_segments (f, 0, fs, n_segs, max_len);
204 while (wrote < len && i < n_segs)
206 rv = SSL_write (ssl, fs[i].data, fs[i].len);
207 wrote += (rv > 0) ? rv : 0;
208 if (rv < (int) fs[i].len)
214 svm_fifo_dequeue_drop (f, wrote);
219 #ifdef HAVE_OPENSSL_ASYNC
221 openssl_check_async_status (tls_ctx_t * ctx, openssl_resume_handler * handler,
224 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
227 SSL_get_async_status (oc->ssl, &estatus);
228 if (estatus == ASYNC_STATUS_EAGAIN)
230 vpp_tls_async_update_event (ctx, 1);
234 vpp_tls_async_update_event (ctx, 0);
244 openssl_handle_handshake_failure (tls_ctx_t * ctx)
246 session_t *app_session;
248 if (SSL_is_server (((openssl_ctx_t *) ctx)->ssl))
251 * Cleanup pre-allocated app session and close transport
254 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index);
257 session_free (app_session);
258 ctx->no_app_session = 1;
259 ctx->c_s_index = SESSION_INVALID_INDEX;
260 tls_disconnect_transport (ctx);
266 * Also handles cleanup of the pre-allocated session
268 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
273 openssl_ctx_handshake_rx (tls_ctx_t * ctx, session_t * tls_session)
275 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
278 while (SSL_in_init (oc->ssl))
284 else if (!svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
287 rv = SSL_do_handshake (oc->ssl);
288 err = SSL_get_error (oc->ssl, rv);
290 #ifdef HAVE_OPENSSL_ASYNC
291 if (err == SSL_ERROR_WANT_ASYNC)
293 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
297 if (err == SSL_ERROR_SSL)
300 ERR_error_string (ERR_get_error (), buf);
301 clib_warning ("Err: %s", buf);
303 openssl_handle_handshake_failure (ctx);
307 if (err != SSL_ERROR_WANT_WRITE && err != SSL_ERROR_WANT_READ)
310 TLS_DBG (2, "tls state for %u is %s", oc->openssl_ctx_index,
311 SSL_state_string_long (oc->ssl));
313 if (SSL_in_init (oc->ssl))
319 if (!SSL_is_server (oc->ssl))
322 * Verify server certificate
324 if ((rv = SSL_get_verify_result (oc->ssl)) != X509_V_OK)
326 TLS_DBG (1, " failed verify: %s\n",
327 X509_verify_cert_error_string (rv));
330 * Presence of hostname enforces strict certificate verification
332 if (ctx->srv_hostname)
334 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
338 tls_notify_app_connected (ctx, SESSION_E_NONE);
342 /* Need to check transport status */
343 if (ctx->is_passive_close)
345 openssl_handle_handshake_failure (ctx);
349 /* Accept failed, cleanup */
350 if (tls_notify_app_accept (ctx))
352 ctx->c_s_index = SESSION_INVALID_INDEX;
353 tls_disconnect_transport (ctx);
358 TLS_DBG (1, "Handshake for %u complete. TLS cipher is %s",
359 oc->openssl_ctx_index, SSL_get_cipher (oc->ssl));
364 openssl_confirm_app_close (tls_ctx_t * ctx)
366 tls_disconnect_transport (ctx);
367 session_transport_closed_notify (&ctx->connection);
371 openssl_ctx_write_tls (tls_ctx_t *ctx, session_t *app_session,
372 transport_send_params_t *sp)
374 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
375 u32 deq_max, space, enq_buf;
380 ts = session_get_from_handle (ctx->tls_session_handle);
381 space = svm_fifo_max_enqueue_prod (ts->tx_fifo);
382 /* Leave a bit of extra space for tls ctrl data, if any needed */
383 space = clib_max ((int) space - TLSO_CTRL_BYTES, 0);
385 f = app_session->tx_fifo;
387 deq_max = svm_fifo_max_dequeue_cons (f);
388 deq_max = clib_min (deq_max, space);
392 deq_max = clib_min (deq_max, sp->max_burst_size);
394 /* Make sure tcp's tx fifo can actually buffer all bytes to be dequeued.
395 * If under memory pressure, tls's fifo segment might not be able to
396 * allocate the chunks needed. This also avoids errors from the underlying
397 * custom bio to the ssl infra which at times can get stuck. */
398 if (svm_fifo_provision_chunks (ts->tx_fifo, 0, 0, deq_max + TLSO_CTRL_BYTES))
401 wrote = openssl_write_from_fifo_into_ssl (f, oc->ssl, deq_max);
405 if (svm_fifo_needs_deq_ntf (f, wrote))
406 session_dequeue_notify (app_session);
410 if (PREDICT_FALSE (ctx->app_closed && BIO_ctrl_pending (oc->rbio) <= 0))
411 openssl_confirm_app_close (ctx);
413 /* Deschedule and wait for deq notification if fifo is almost full */
414 enq_buf = clib_min (svm_fifo_size (ts->tx_fifo) / 2, TLSO_MIN_ENQ_SPACE);
415 if (space < wrote + enq_buf)
417 svm_fifo_add_want_deq_ntf (ts->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
418 transport_connection_deschedule (&ctx->connection);
419 sp->flags |= TRANSPORT_SND_F_DESCHED;
422 /* Request tx reschedule of the app session */
423 app_session->flags |= SESSION_F_CUSTOM_TX;
429 openssl_ctx_write_dtls (tls_ctx_t *ctx, session_t *app_session,
430 transport_send_params_t *sp)
432 openssl_main_t *om = &openssl_main;
433 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
434 u32 read = 0, to_deq, dgram_sz, enq_max;
435 session_dgram_pre_hdr_t hdr;
440 us = session_get_from_handle (ctx->tls_session_handle);
441 to_deq = svm_fifo_max_dequeue_cons (app_session->tx_fifo);
442 buf = om->tx_bufs[ctx->c_thread_index];
446 /* Peeking only pre-header dgram because the session is connected */
447 rv = svm_fifo_peek (app_session->tx_fifo, 0, sizeof (hdr), (u8 *) &hdr);
448 ASSERT (rv == sizeof (hdr) && hdr.data_length < vec_len (buf));
449 ASSERT (to_deq >= hdr.data_length + SESSION_CONN_HDR_LEN);
451 dgram_sz = hdr.data_length + SESSION_CONN_HDR_LEN;
452 enq_max = dgram_sz + TLSO_CTRL_BYTES;
453 if (svm_fifo_max_enqueue_prod (us->tx_fifo) < enq_max ||
454 svm_fifo_provision_chunks (us->tx_fifo, 0, 0, enq_max))
456 svm_fifo_add_want_deq_ntf (us->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
457 transport_connection_deschedule (&ctx->connection);
458 sp->flags |= TRANSPORT_SND_F_DESCHED;
462 rv = svm_fifo_peek (app_session->tx_fifo, SESSION_CONN_HDR_LEN,
463 hdr.data_length, buf);
464 ASSERT (rv == hdr.data_length);
465 svm_fifo_dequeue_drop (app_session->tx_fifo, dgram_sz);
467 wrote = SSL_write (oc->ssl, buf, rv);
476 if (svm_fifo_needs_deq_ntf (app_session->tx_fifo, read))
477 session_dequeue_notify (app_session);
480 tls_add_vpp_q_tx_evt (us);
482 if (PREDICT_FALSE (ctx->app_closed &&
483 !svm_fifo_max_enqueue_prod (us->rx_fifo)))
484 openssl_confirm_app_close (ctx);
490 openssl_ctx_write (tls_ctx_t *ctx, session_t *app_session,
491 transport_send_params_t *sp)
493 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
494 return openssl_ctx_write_tls (ctx, app_session, sp);
496 return openssl_ctx_write_dtls (ctx, app_session, sp);
500 openssl_ctx_read_tls (tls_ctx_t *ctx, session_t *tls_session)
502 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
503 session_t *app_session;
507 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
509 if (openssl_ctx_handshake_rx (ctx, tls_session) < 0)
513 app_session = session_get_from_handle (ctx->app_session_handle);
514 f = app_session->rx_fifo;
516 read = openssl_read_from_ssl_into_fifo (f, oc->ssl);
518 /* If handshake just completed, session may still be in accepting state */
519 if (read && app_session->session_state >= SESSION_STATE_READY)
520 tls_notify_app_enqueue (ctx, app_session);
522 if ((SSL_pending (oc->ssl) > 0) ||
523 svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
524 tls_add_vpp_q_builtin_rx_evt (tls_session);
530 openssl_ctx_read_dtls (tls_ctx_t *ctx, session_t *us)
532 openssl_main_t *om = &openssl_main;
533 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
534 session_dgram_hdr_t hdr;
535 session_t *app_session;
540 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
542 u32 us_index = us->session_index;
543 if (openssl_ctx_handshake_rx (ctx, us) < 0)
545 /* Session pool might grow when allocating the app's session */
546 us = session_get (us_index, ctx->c_thread_index);
549 buf = om->rx_bufs[ctx->c_thread_index];
550 app_session = session_get_from_handle (ctx->app_session_handle);
551 svm_fifo_fill_chunk_list (app_session->rx_fifo);
553 while (svm_fifo_max_dequeue_cons (us->rx_fifo) > 0)
555 if (svm_fifo_max_enqueue_prod (app_session->rx_fifo) < DTLSO_MAX_DGRAM)
557 tls_add_vpp_q_builtin_rx_evt (us);
561 read = SSL_read (oc->ssl, buf, vec_len (buf));
562 if (PREDICT_FALSE (read <= 0))
565 tls_add_vpp_q_builtin_rx_evt (us);
570 hdr.data_length = read;
573 svm_fifo_seg_t segs[2] = { { (u8 *) &hdr, sizeof (hdr) },
576 rv = svm_fifo_enqueue_segments (app_session->rx_fifo, segs, 2,
577 0 /* allow partial */);
583 /* If handshake just completed, session may still be in accepting state */
584 if (app_session->session_state >= SESSION_STATE_READY)
585 tls_notify_app_enqueue (ctx, app_session);
591 openssl_ctx_read (tls_ctx_t *ctx, session_t *ts)
593 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
594 return openssl_ctx_read_tls (ctx, ts);
596 return openssl_ctx_read_dtls (ctx, ts);
600 openssl_ctx_init_client (tls_ctx_t * ctx)
602 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
603 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
604 openssl_main_t *om = &openssl_main;
605 const SSL_METHOD *method;
608 method = ctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_client_method () :
609 DTLS_client_method ();
612 TLS_DBG (1, "(D)TLS_method returned null");
616 oc->ssl_ctx = SSL_CTX_new (method);
617 if (oc->ssl_ctx == NULL)
619 TLS_DBG (1, "SSL_CTX_new returned null");
623 SSL_CTX_set_ecdh_auto (oc->ssl_ctx, 1);
624 SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
625 #ifdef HAVE_OPENSSL_ASYNC
627 SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ASYNC);
629 rv = SSL_CTX_set_cipher_list (oc->ssl_ctx, (const char *) om->ciphers);
632 TLS_DBG (1, "Couldn't set cipher");
636 SSL_CTX_set_options (oc->ssl_ctx, flags);
637 SSL_CTX_set_cert_store (oc->ssl_ctx, om->cert_store);
639 oc->ssl = SSL_new (oc->ssl_ctx);
642 TLS_DBG (1, "Couldn't initialize ssl struct");
646 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
648 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
649 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
653 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
654 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
657 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
658 SSL_set_connect_state (oc->ssl);
660 rv = SSL_set_tlsext_host_name (oc->ssl, ctx->srv_hostname);
663 TLS_DBG (1, "Couldn't set hostname");
668 * 2. Do the first steps in the handshake.
670 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
671 oc->openssl_ctx_index);
673 #ifdef HAVE_OPENSSL_ASYNC
674 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
675 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
679 rv = SSL_do_handshake (oc->ssl);
680 err = SSL_get_error (oc->ssl, rv);
681 #ifdef HAVE_OPENSSL_ASYNC
682 if (err == SSL_ERROR_WANT_ASYNC)
684 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
689 if (err != SSL_ERROR_WANT_WRITE)
693 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
694 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
699 openssl_start_listen (tls_ctx_t * lctx)
701 const SSL_METHOD *method;
708 openssl_listen_ctx_t *olc;
709 app_cert_key_pair_t *ckpair;
711 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
712 openssl_main_t *om = &openssl_main;
714 ckpair = app_cert_key_pair_get_if_valid (lctx->ckpair_index);
718 if (!ckpair->cert || !ckpair->key)
720 TLS_DBG (1, "tls cert and/or key not configured %d",
721 lctx->parent_app_wrk_index);
725 method = lctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_server_method () :
726 DTLS_server_method ();
727 ssl_ctx = SSL_CTX_new (method);
730 clib_warning ("Unable to create SSL context");
734 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
735 #ifdef HAVE_OPENSSL_ASYNC
738 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ASYNC);
739 SSL_CTX_set_async_callback (ssl_ctx, tls_async_openssl_callback);
742 SSL_CTX_set_options (ssl_ctx, flags);
743 SSL_CTX_set_ecdh_auto (ssl_ctx, 1);
745 rv = SSL_CTX_set_cipher_list (ssl_ctx, (const char *) om->ciphers);
748 TLS_DBG (1, "Couldn't set cipher");
752 /* use the default OpenSSL built-in DH parameters */
753 rv = SSL_CTX_set_dh_auto (ssl_ctx, 1);
756 TLS_DBG (1, "Couldn't set temp DH parameters");
761 * Set the key and cert
763 cert_bio = BIO_new (BIO_s_mem ());
766 clib_warning ("unable to allocate memory");
769 BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
770 srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
773 clib_warning ("unable to parse certificate");
776 rv = SSL_CTX_use_certificate (ssl_ctx, srvcert);
779 clib_warning ("unable to use SSL certificate");
785 cert_bio = BIO_new (BIO_s_mem ());
788 clib_warning ("unable to allocate memory");
791 BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
792 pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
795 clib_warning ("unable to parse pkey");
798 rv = SSL_CTX_use_PrivateKey (ssl_ctx, pkey);
801 clib_warning ("unable to use SSL PrivateKey");
807 olc_index = openssl_listen_ctx_alloc ();
808 olc = openssl_lctx_get (olc_index);
809 olc->ssl_ctx = ssl_ctx;
810 olc->srvcert = srvcert;
813 /* store SSL_CTX into TLS level structure */
814 lctx->tls_ssl_ctx = olc_index;
825 openssl_stop_listen (tls_ctx_t * lctx)
828 openssl_listen_ctx_t *olc;
830 olc_index = lctx->tls_ssl_ctx;
831 olc = openssl_lctx_get (olc_index);
833 X509_free (olc->srvcert);
834 EVP_PKEY_free (olc->pkey);
836 SSL_CTX_free (olc->ssl_ctx);
837 openssl_listen_ctx_free (olc);
843 openssl_ctx_init_server (tls_ctx_t * ctx)
845 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
846 u32 olc_index = ctx->tls_ssl_ctx;
847 openssl_listen_ctx_t *olc;
850 /* Start a new connection */
852 olc = openssl_lctx_get (olc_index);
853 oc->ssl = SSL_new (olc->ssl_ctx);
856 TLS_DBG (1, "Couldn't initialize ssl struct");
860 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
862 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
863 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
867 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
868 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
871 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
872 SSL_set_accept_state (oc->ssl);
874 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
875 oc->openssl_ctx_index);
877 #ifdef HAVE_OPENSSL_ASYNC
878 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
879 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
883 rv = SSL_do_handshake (oc->ssl);
884 err = SSL_get_error (oc->ssl, rv);
885 #ifdef HAVE_OPENSSL_ASYNC
886 if (err == SSL_ERROR_WANT_ASYNC)
888 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
893 if (err != SSL_ERROR_WANT_WRITE)
897 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
898 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
903 openssl_handshake_is_over (tls_ctx_t * ctx)
905 openssl_ctx_t *mc = (openssl_ctx_t *) ctx;
908 return SSL_is_init_finished (mc->ssl);
912 openssl_transport_close (tls_ctx_t * ctx)
914 #ifdef HAVE_OPENSSL_ASYNC
915 if (vpp_openssl_is_inflight (ctx))
919 if (!openssl_handshake_is_over (ctx))
921 openssl_handle_handshake_failure (ctx);
924 session_transport_closing_notify (&ctx->connection);
929 openssl_app_close (tls_ctx_t * ctx)
931 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
932 session_t *app_session;
934 /* Wait for all data to be written to tcp */
935 app_session = session_get_from_handle (ctx->app_session_handle);
936 if (BIO_ctrl_pending (oc->rbio) <= 0
937 && !svm_fifo_max_dequeue_cons (app_session->tx_fifo))
938 openssl_confirm_app_close (ctx);
944 const static tls_engine_vft_t openssl_engine = {
945 .ctx_alloc = openssl_ctx_alloc,
946 .ctx_alloc_w_thread = openssl_ctx_alloc_w_thread,
947 .ctx_free = openssl_ctx_free,
948 .ctx_attach = openssl_ctx_attach,
949 .ctx_detach = openssl_ctx_detach,
950 .ctx_get = openssl_ctx_get,
951 .ctx_get_w_thread = openssl_ctx_get_w_thread,
952 .ctx_init_server = openssl_ctx_init_server,
953 .ctx_init_client = openssl_ctx_init_client,
954 .ctx_write = openssl_ctx_write,
955 .ctx_read = openssl_ctx_read,
956 .ctx_handshake_is_over = openssl_handshake_is_over,
957 .ctx_start_listen = openssl_start_listen,
958 .ctx_stop_listen = openssl_stop_listen,
959 .ctx_transport_close = openssl_transport_close,
960 .ctx_app_close = openssl_app_close,
964 tls_init_ca_chain (void)
966 openssl_main_t *om = &openssl_main;
967 tls_main_t *tm = vnet_tls_get_main ();
972 if (access (tm->ca_cert_path, F_OK | R_OK) == -1)
974 clib_warning ("Could not initialize TLS CA certificates");
978 if (!(om->cert_store = X509_STORE_new ()))
980 clib_warning ("failed to create cert store");
984 #if OPENSSL_VERSION_NUMBER >= 0x30000000L
985 rv = X509_STORE_load_file (om->cert_store, tm->ca_cert_path);
987 rv = X509_STORE_load_locations (om->cert_store, tm->ca_cert_path, 0);
992 clib_warning ("failed to load ca certificate");
995 if (tm->use_test_cert_in_ca)
997 cert_bio = BIO_new (BIO_s_mem ());
998 BIO_write (cert_bio, test_srv_crt_rsa, test_srv_crt_rsa_len);
999 testcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
1002 clib_warning ("unable to parse certificate");
1005 X509_STORE_add_cert (om->cert_store, testcert);
1008 return (rv < 0 ? -1 : 0);
1012 tls_openssl_set_ciphers (char *ciphers)
1014 openssl_main_t *om = &openssl_main;
1022 vec_validate (om->ciphers, strlen (ciphers) - 1);
1023 for (i = 0; i < vec_len (om->ciphers); i++)
1025 om->ciphers[i] = toupper (ciphers[i]);
1032 static clib_error_t *
1033 tls_openssl_init (vlib_main_t * vm)
1035 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1036 openssl_main_t *om = &openssl_main;
1037 clib_error_t *error = 0;
1040 error = tls_openssl_api_init (vm);
1041 num_threads = 1 /* main thread */ + vtm->n_threads;
1043 SSL_library_init ();
1044 SSL_load_error_strings ();
1046 if (tls_init_ca_chain ())
1048 clib_warning ("failed to initialize TLS CA chain");
1052 vec_validate (om->ctx_pool, num_threads - 1);
1053 vec_validate (om->rx_bufs, num_threads - 1);
1054 vec_validate (om->tx_bufs, num_threads - 1);
1055 for (i = 0; i < num_threads; i++)
1057 vec_validate (om->rx_bufs[i], DTLSO_MAX_DGRAM);
1058 vec_validate (om->tx_bufs[i], DTLSO_MAX_DGRAM);
1060 tls_register_engine (&openssl_engine, CRYPTO_ENGINE_OPENSSL);
1062 om->engine_init = 0;
1064 /* default ciphers */
1065 tls_openssl_set_ciphers
1066 ("ALL:!ADH:!LOW:!EXP:!MD5:!RC4-SHA:!DES-CBC3-SHA:@STRENGTH");
1071 VLIB_INIT_FUNCTION (tls_openssl_init) =
1073 .runs_after = VLIB_INITS("tls_init"),
1077 #ifdef HAVE_OPENSSL_ASYNC
1078 static clib_error_t *
1079 tls_openssl_set_command_fn (vlib_main_t * vm, unformat_input_t * input,
1080 vlib_cli_command_t * cmd)
1082 openssl_main_t *om = &openssl_main;
1083 char *engine_name = NULL;
1084 char *engine_alg = NULL;
1085 char *ciphers = NULL;
1086 u8 engine_name_set = 0;
1089 /* By present, it is not allowed to configure engine again after running */
1090 if (om->engine_init)
1092 clib_warning ("engine has started!\n");
1093 return clib_error_return
1094 (0, "engine has started, and no config is accepted");
1097 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1099 if (unformat (input, "engine %s", &engine_name))
1101 engine_name_set = 1;
1103 else if (unformat (input, "async"))
1107 else if (unformat (input, "alg %s", &engine_alg))
1109 for (i = 0; i < strnlen (engine_alg, MAX_CRYPTO_LEN); i++)
1110 engine_alg[i] = toupper (engine_alg[i]);
1112 else if (unformat (input, "ciphers %s", &ciphers))
1114 tls_openssl_set_ciphers (ciphers);
1117 return clib_error_return (0, "failed: unknown input `%U'",
1118 format_unformat_error, input);
1121 /* reset parameters if engine is not configured */
1122 if (!engine_name_set)
1124 clib_warning ("No engine provided! \n");
1129 vnet_session_enable_disable (vm, 1);
1130 if (openssl_engine_register (engine_name, engine_alg, async) < 0)
1132 return clib_error_return (0, "Failed to register %s polling",
1137 vlib_cli_output (vm, "Successfully register engine %s\n",
1147 VLIB_CLI_COMMAND (tls_openssl_set_command, static) =
1149 .path = "tls openssl set",
1150 .short_help = "tls openssl set [engine <engine name>] [alg [algorithm] [async]",
1151 .function = tls_openssl_set_command_fn,
1157 VLIB_PLUGIN_REGISTER () = {
1158 .version = VPP_BUILD_VER,
1159 .description = "Transport Layer Security (TLS) Engine, OpenSSL Based",
1164 * fd.io coding-style-patch-verification: ON
1167 * eval: (c-set-style "gnu")