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>
32 #define MAX_CRYPTO_LEN 64
34 openssl_main_t openssl_main;
37 openssl_ctx_alloc_w_thread (u32 thread_index)
39 openssl_main_t *om = &openssl_main;
42 pool_get (om->ctx_pool[thread_index], ctx);
44 *ctx = clib_mem_alloc (sizeof (openssl_ctx_t));
46 clib_memset (*ctx, 0, sizeof (openssl_ctx_t));
47 (*ctx)->ctx.c_thread_index = thread_index;
48 (*ctx)->ctx.tls_ctx_engine = CRYPTO_ENGINE_OPENSSL;
49 (*ctx)->ctx.app_session_handle = SESSION_INVALID_HANDLE;
50 (*ctx)->openssl_ctx_index = ctx - om->ctx_pool[thread_index];
51 return ((*ctx)->openssl_ctx_index);
55 openssl_ctx_alloc (void)
57 return openssl_ctx_alloc_w_thread (vlib_get_thread_index ());
61 openssl_ctx_free (tls_ctx_t * ctx)
63 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
65 /* Cleanup ssl ctx unless migrated */
66 if (!ctx->is_migrated)
68 if (SSL_is_init_finished (oc->ssl) && !ctx->is_passive_close)
69 SSL_shutdown (oc->ssl);
72 vec_free (ctx->srv_hostname);
74 #ifdef HAVE_OPENSSL_ASYNC
75 openssl_evt_free (ctx->evt_index, ctx->c_thread_index);
79 pool_put_index (openssl_main.ctx_pool[ctx->c_thread_index],
80 oc->openssl_ctx_index);
84 openssl_ctx_detach (tls_ctx_t *ctx)
86 openssl_ctx_t *oc = (openssl_ctx_t *) ctx, *oc_copy;
88 oc_copy = clib_mem_alloc (sizeof (*oc_copy));
89 clib_memcpy (oc_copy, oc, sizeof (*oc));
95 openssl_ctx_attach (u32 thread_index, void *ctx_ptr)
97 openssl_main_t *om = &openssl_main;
101 pool_get (om->ctx_pool[thread_index], oc);
102 /* Free the old instance instead of looking for an empty spot */
107 (*oc)->openssl_ctx_index = oc - om->ctx_pool[thread_index];
108 (*oc)->ctx.c_thread_index = thread_index;
110 sh = (*oc)->ctx.tls_session_handle;
111 BIO_set_data ((*oc)->rbio, uword_to_pointer (sh, void *));
112 BIO_set_data ((*oc)->wbio, uword_to_pointer (sh, void *));
114 return ((*oc)->openssl_ctx_index);
118 openssl_ctx_get (u32 ctx_index)
121 ctx = pool_elt_at_index (openssl_main.ctx_pool[vlib_get_thread_index ()],
127 openssl_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
130 ctx = pool_elt_at_index (openssl_main.ctx_pool[thread_index], ctx_index);
135 openssl_listen_ctx_alloc (void)
137 openssl_main_t *om = &openssl_main;
138 openssl_listen_ctx_t *lctx;
140 pool_get (om->lctx_pool, lctx);
142 clib_memset (lctx, 0, sizeof (openssl_listen_ctx_t));
143 lctx->openssl_lctx_index = lctx - om->lctx_pool;
144 return lctx->openssl_lctx_index;
148 openssl_listen_ctx_free (openssl_listen_ctx_t * lctx)
150 pool_put_index (openssl_main.lctx_pool, lctx->openssl_lctx_index);
153 openssl_listen_ctx_t *
154 openssl_lctx_get (u32 lctx_index)
156 return pool_elt_at_index (openssl_main.lctx_pool, lctx_index);
159 #define ossl_check_err_is_fatal(_ssl, _rv) \
160 if (PREDICT_FALSE (_rv < 0 && SSL_get_error (_ssl, _rv) == SSL_ERROR_SSL)) \
164 openssl_read_from_ssl_into_fifo (svm_fifo_t * f, SSL * ssl)
166 int read, rv, n_fs, i;
167 const int n_segs = 2;
168 svm_fifo_seg_t fs[n_segs];
171 max_enq = svm_fifo_max_enqueue_prod (f);
175 n_fs = svm_fifo_provision_chunks (f, fs, n_segs, max_enq);
179 /* Return early if we can't read anything */
180 read = SSL_read (ssl, fs[0].data, fs[0].len);
183 ossl_check_err_is_fatal (ssl, read);
187 for (i = 1; i < n_fs; i++)
189 rv = SSL_read (ssl, fs[i].data, fs[i].len);
190 read += rv > 0 ? rv : 0;
192 if (rv < (int) fs[i].len)
194 ossl_check_err_is_fatal (ssl, rv);
199 svm_fifo_enqueue_nocopy (f, read);
205 openssl_write_from_fifo_into_ssl (svm_fifo_t *f, SSL *ssl, u32 max_len)
207 int wrote = 0, rv, i = 0, len;
209 svm_fifo_seg_t fs[n_segs];
211 len = svm_fifo_segments (f, 0, fs, &n_segs, max_len);
215 while (wrote < len && i < n_segs)
217 rv = SSL_write (ssl, fs[i].data, fs[i].len);
218 wrote += (rv > 0) ? rv : 0;
219 if (rv < (int) fs[i].len)
221 ossl_check_err_is_fatal (ssl, rv);
228 svm_fifo_dequeue_drop (f, wrote);
233 #ifdef HAVE_OPENSSL_ASYNC
235 openssl_check_async_status (tls_ctx_t * ctx, openssl_resume_handler * handler,
238 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
241 SSL_get_async_status (oc->ssl, &estatus);
242 if (estatus == ASYNC_STATUS_EAGAIN)
244 vpp_tls_async_update_event (ctx, 1);
248 vpp_tls_async_update_event (ctx, 0);
258 openssl_handle_handshake_failure (tls_ctx_t * ctx)
260 session_t *app_session;
262 if (SSL_is_server (((openssl_ctx_t *) ctx)->ssl))
265 * Cleanup pre-allocated app session and close transport
268 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index);
271 session_free (app_session);
272 ctx->no_app_session = 1;
273 ctx->c_s_index = SESSION_INVALID_INDEX;
274 tls_disconnect_transport (ctx);
280 * Also handles cleanup of the pre-allocated session
282 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
283 tls_disconnect_transport (ctx);
288 openssl_ctx_handshake_rx (tls_ctx_t * ctx, session_t * tls_session)
290 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
293 while (SSL_in_init (oc->ssl))
299 else if (!svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
302 rv = SSL_do_handshake (oc->ssl);
303 err = SSL_get_error (oc->ssl, rv);
305 #ifdef HAVE_OPENSSL_ASYNC
306 if (err == SSL_ERROR_WANT_ASYNC)
308 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
312 if (err == SSL_ERROR_SSL)
315 ERR_error_string (ERR_get_error (), buf);
316 clib_warning ("Err: %s", buf);
318 openssl_handle_handshake_failure (ctx);
322 if (err != SSL_ERROR_WANT_WRITE && err != SSL_ERROR_WANT_READ)
325 TLS_DBG (2, "tls state for %u is %s", oc->openssl_ctx_index,
326 SSL_state_string_long (oc->ssl));
328 if (SSL_in_init (oc->ssl))
334 if (!SSL_is_server (oc->ssl))
337 * Verify server certificate
339 if ((rv = SSL_get_verify_result (oc->ssl)) != X509_V_OK)
341 TLS_DBG (1, " failed verify: %s\n",
342 X509_verify_cert_error_string (rv));
345 * Presence of hostname enforces strict certificate verification
347 if (ctx->srv_hostname)
349 openssl_handle_handshake_failure (ctx);
353 tls_notify_app_connected (ctx, SESSION_E_NONE);
357 /* Need to check transport status */
358 if (ctx->is_passive_close)
360 openssl_handle_handshake_failure (ctx);
364 /* Accept failed, cleanup */
365 if (tls_notify_app_accept (ctx))
367 ctx->c_s_index = SESSION_INVALID_INDEX;
368 tls_disconnect_transport (ctx);
373 TLS_DBG (1, "Handshake for %u complete. TLS cipher is %s",
374 oc->openssl_ctx_index, SSL_get_cipher (oc->ssl));
379 openssl_confirm_app_close (tls_ctx_t * ctx)
381 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
382 SSL_shutdown (oc->ssl);
383 tls_disconnect_transport (ctx);
384 session_transport_closed_notify (&ctx->connection);
388 openssl_ctx_write_tls (tls_ctx_t *ctx, session_t *app_session,
389 transport_send_params_t *sp)
391 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
392 u32 deq_max, space, enq_buf;
397 ts = session_get_from_handle (ctx->tls_session_handle);
398 space = svm_fifo_max_enqueue_prod (ts->tx_fifo);
399 /* Leave a bit of extra space for tls ctrl data, if any needed */
400 space = clib_max ((int) space - TLSO_CTRL_BYTES, 0);
402 f = app_session->tx_fifo;
404 deq_max = svm_fifo_max_dequeue_cons (f);
405 deq_max = clib_min (deq_max, space);
409 deq_max = clib_min (deq_max, sp->max_burst_size);
411 /* Make sure tcp's tx fifo can actually buffer all bytes to be dequeued.
412 * If under memory pressure, tls's fifo segment might not be able to
413 * allocate the chunks needed. This also avoids errors from the underlying
414 * custom bio to the ssl infra which at times can get stuck. */
415 if (svm_fifo_provision_chunks (ts->tx_fifo, 0, 0, deq_max + TLSO_CTRL_BYTES))
418 wrote = openssl_write_from_fifo_into_ssl (f, oc->ssl, deq_max);
420 /* Unrecoverable protocol error. Reset connection */
421 if (PREDICT_FALSE (wrote < 0))
423 tls_notify_app_io_error (ctx);
430 if (svm_fifo_needs_deq_ntf (f, wrote))
431 session_dequeue_notify (app_session);
435 if (PREDICT_FALSE (ctx->app_closed && BIO_ctrl_pending (oc->rbio) <= 0))
436 openssl_confirm_app_close (ctx);
438 /* Deschedule and wait for deq notification if fifo is almost full */
439 enq_buf = clib_min (svm_fifo_size (ts->tx_fifo) / 2, TLSO_MIN_ENQ_SPACE);
440 if (space < wrote + enq_buf)
442 svm_fifo_add_want_deq_ntf (ts->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
443 transport_connection_deschedule (&ctx->connection);
444 sp->flags |= TRANSPORT_SND_F_DESCHED;
447 /* Request tx reschedule of the app session */
448 app_session->flags |= SESSION_F_CUSTOM_TX;
454 openssl_ctx_write_dtls (tls_ctx_t *ctx, session_t *app_session,
455 transport_send_params_t *sp)
457 openssl_main_t *om = &openssl_main;
458 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
459 u32 read = 0, to_deq, dgram_sz, enq_max;
460 session_dgram_pre_hdr_t hdr;
465 us = session_get_from_handle (ctx->tls_session_handle);
466 to_deq = svm_fifo_max_dequeue_cons (app_session->tx_fifo);
467 buf = om->tx_bufs[ctx->c_thread_index];
471 /* Peeking only pre-header dgram because the session is connected */
472 rv = svm_fifo_peek (app_session->tx_fifo, 0, sizeof (hdr), (u8 *) &hdr);
473 ASSERT (rv == sizeof (hdr) && hdr.data_length < vec_len (buf));
474 ASSERT (to_deq >= hdr.data_length + SESSION_CONN_HDR_LEN);
476 dgram_sz = hdr.data_length + SESSION_CONN_HDR_LEN;
477 enq_max = dgram_sz + TLSO_CTRL_BYTES;
478 if (svm_fifo_max_enqueue_prod (us->tx_fifo) < enq_max ||
479 svm_fifo_provision_chunks (us->tx_fifo, 0, 0, enq_max))
481 svm_fifo_add_want_deq_ntf (us->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
482 transport_connection_deschedule (&ctx->connection);
483 sp->flags |= TRANSPORT_SND_F_DESCHED;
487 rv = svm_fifo_peek (app_session->tx_fifo, SESSION_CONN_HDR_LEN,
488 hdr.data_length, buf);
489 ASSERT (rv == hdr.data_length);
490 svm_fifo_dequeue_drop (app_session->tx_fifo, dgram_sz);
492 wrote = SSL_write (oc->ssl, buf, rv);
501 if (svm_fifo_needs_deq_ntf (app_session->tx_fifo, read))
502 session_dequeue_notify (app_session);
505 tls_add_vpp_q_tx_evt (us);
507 if (PREDICT_FALSE (ctx->app_closed &&
508 !svm_fifo_max_enqueue_prod (us->rx_fifo)))
509 openssl_confirm_app_close (ctx);
515 openssl_ctx_write (tls_ctx_t *ctx, session_t *app_session,
516 transport_send_params_t *sp)
518 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
519 return openssl_ctx_write_tls (ctx, app_session, sp);
521 return openssl_ctx_write_dtls (ctx, app_session, sp);
525 openssl_ctx_read_tls (tls_ctx_t *ctx, session_t *tls_session)
527 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
528 session_t *app_session;
532 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
534 if (openssl_ctx_handshake_rx (ctx, tls_session) < 0)
538 app_session = session_get_from_handle (ctx->app_session_handle);
539 f = app_session->rx_fifo;
541 read = openssl_read_from_ssl_into_fifo (f, oc->ssl);
543 /* Unrecoverable protocol error. Reset connection */
544 if (PREDICT_FALSE (read < 0))
546 tls_notify_app_io_error (ctx);
550 /* If handshake just completed, session may still be in accepting state */
551 if (read && app_session->session_state >= SESSION_STATE_READY)
552 tls_notify_app_enqueue (ctx, app_session);
554 if ((SSL_pending (oc->ssl) > 0) ||
555 svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
556 tls_add_vpp_q_builtin_rx_evt (tls_session);
562 openssl_ctx_read_dtls (tls_ctx_t *ctx, session_t *us)
564 openssl_main_t *om = &openssl_main;
565 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
566 session_dgram_hdr_t hdr;
567 session_t *app_session;
572 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
574 u32 us_index = us->session_index;
575 if (openssl_ctx_handshake_rx (ctx, us) < 0)
577 /* Session pool might grow when allocating the app's session */
578 us = session_get (us_index, ctx->c_thread_index);
581 buf = om->rx_bufs[ctx->c_thread_index];
582 app_session = session_get_from_handle (ctx->app_session_handle);
583 svm_fifo_fill_chunk_list (app_session->rx_fifo);
585 while (svm_fifo_max_dequeue_cons (us->rx_fifo) > 0)
587 if (svm_fifo_max_enqueue_prod (app_session->rx_fifo) < DTLSO_MAX_DGRAM)
589 tls_add_vpp_q_builtin_rx_evt (us);
593 read = SSL_read (oc->ssl, buf, vec_len (buf));
594 if (PREDICT_FALSE (read <= 0))
597 tls_add_vpp_q_builtin_rx_evt (us);
602 hdr.data_length = read;
605 svm_fifo_seg_t segs[2] = { { (u8 *) &hdr, sizeof (hdr) },
608 rv = svm_fifo_enqueue_segments (app_session->rx_fifo, segs, 2,
609 0 /* allow partial */);
615 /* If handshake just completed, session may still be in accepting state */
616 if (app_session->session_state >= SESSION_STATE_READY)
617 tls_notify_app_enqueue (ctx, app_session);
623 openssl_ctx_read (tls_ctx_t *ctx, session_t *ts)
625 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
626 return openssl_ctx_read_tls (ctx, ts);
628 return openssl_ctx_read_dtls (ctx, ts);
632 openssl_set_ckpair (SSL *ssl_connection, u32 ckpair_index)
634 app_cert_key_pair_t *ckpair;
639 ckpair = app_cert_key_pair_get_if_valid (ckpair_index);
643 if (!ckpair->cert || !ckpair->key)
645 TLS_DBG (1, "tls cert and/or key not configured");
649 * Set the key and cert
651 cert_bio = BIO_new (BIO_s_mem ());
652 BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
653 srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
656 clib_warning ("unable to parse certificate");
659 SSL_use_certificate (ssl_connection, srvcert);
662 cert_bio = BIO_new (BIO_s_mem ());
663 BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
664 pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
667 clib_warning ("unable to parse pkey");
670 SSL_use_PrivateKey (ssl_connection, pkey);
672 TLS_DBG (1, "TLS client using ckpair index: %d", ckpair_index);
678 openssl_ctx_init_client (tls_ctx_t * ctx)
680 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
681 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
682 openssl_main_t *om = &openssl_main;
683 const SSL_METHOD *method;
686 method = ctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_client_method () :
687 DTLS_client_method ();
690 TLS_DBG (1, "(D)TLS_method returned null");
694 oc->ssl_ctx = SSL_CTX_new (method);
695 if (oc->ssl_ctx == NULL)
697 TLS_DBG (1, "SSL_CTX_new returned null");
701 SSL_CTX_set_ecdh_auto (oc->ssl_ctx, 1);
702 SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
703 #ifdef HAVE_OPENSSL_ASYNC
705 SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ASYNC);
707 rv = SSL_CTX_set_cipher_list (oc->ssl_ctx, (const char *) om->ciphers);
710 TLS_DBG (1, "Couldn't set cipher");
714 SSL_CTX_set_options (oc->ssl_ctx, flags);
715 SSL_CTX_set_cert_store (oc->ssl_ctx, om->cert_store);
717 oc->ssl = SSL_new (oc->ssl_ctx);
720 TLS_DBG (1, "Couldn't initialize ssl struct");
724 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
726 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
727 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
731 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
732 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
735 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
736 SSL_set_connect_state (oc->ssl);
738 rv = SSL_set_tlsext_host_name (oc->ssl, ctx->srv_hostname);
741 TLS_DBG (1, "Couldn't set hostname");
744 if (openssl_set_ckpair (oc->ssl, ctx->ckpair_index))
746 TLS_DBG (1, "Couldn't set client certificate-key pair");
750 * 2. Do the first steps in the handshake.
752 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
753 oc->openssl_ctx_index);
755 #ifdef HAVE_OPENSSL_ASYNC
756 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
757 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
761 rv = SSL_do_handshake (oc->ssl);
762 err = SSL_get_error (oc->ssl, rv);
763 #ifdef HAVE_OPENSSL_ASYNC
764 if (err == SSL_ERROR_WANT_ASYNC)
766 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
771 if (err != SSL_ERROR_WANT_WRITE)
775 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
776 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
781 openssl_start_listen (tls_ctx_t * lctx)
783 const SSL_METHOD *method;
790 openssl_listen_ctx_t *olc;
791 app_cert_key_pair_t *ckpair;
793 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
794 openssl_main_t *om = &openssl_main;
796 ckpair = app_cert_key_pair_get_if_valid (lctx->ckpair_index);
800 if (!ckpair->cert || !ckpair->key)
802 TLS_DBG (1, "tls cert and/or key not configured %d",
803 lctx->parent_app_wrk_index);
807 method = lctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_server_method () :
808 DTLS_server_method ();
809 ssl_ctx = SSL_CTX_new (method);
812 clib_warning ("Unable to create SSL context");
816 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
817 #ifdef HAVE_OPENSSL_ASYNC
820 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ASYNC);
821 SSL_CTX_set_async_callback (ssl_ctx, tls_async_openssl_callback);
824 SSL_CTX_set_options (ssl_ctx, flags);
825 SSL_CTX_set_ecdh_auto (ssl_ctx, 1);
827 rv = SSL_CTX_set_cipher_list (ssl_ctx, (const char *) om->ciphers);
830 TLS_DBG (1, "Couldn't set cipher");
834 /* use the default OpenSSL built-in DH parameters */
835 rv = SSL_CTX_set_dh_auto (ssl_ctx, 1);
838 TLS_DBG (1, "Couldn't set temp DH parameters");
843 * Set the key and cert
845 cert_bio = BIO_new (BIO_s_mem ());
848 clib_warning ("unable to allocate memory");
851 BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
852 srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
855 clib_warning ("unable to parse certificate");
858 rv = SSL_CTX_use_certificate (ssl_ctx, srvcert);
861 clib_warning ("unable to use SSL certificate");
867 cert_bio = BIO_new (BIO_s_mem ());
870 clib_warning ("unable to allocate memory");
873 BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
874 pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
877 clib_warning ("unable to parse pkey");
880 rv = SSL_CTX_use_PrivateKey (ssl_ctx, pkey);
883 clib_warning ("unable to use SSL PrivateKey");
889 olc_index = openssl_listen_ctx_alloc ();
890 olc = openssl_lctx_get (olc_index);
891 olc->ssl_ctx = ssl_ctx;
892 olc->srvcert = srvcert;
895 /* store SSL_CTX into TLS level structure */
896 lctx->tls_ssl_ctx = olc_index;
907 openssl_stop_listen (tls_ctx_t * lctx)
910 openssl_listen_ctx_t *olc;
912 olc_index = lctx->tls_ssl_ctx;
913 olc = openssl_lctx_get (olc_index);
915 X509_free (olc->srvcert);
916 EVP_PKEY_free (olc->pkey);
918 SSL_CTX_free (olc->ssl_ctx);
919 openssl_listen_ctx_free (olc);
925 openssl_ctx_init_server (tls_ctx_t * ctx)
927 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
928 u32 olc_index = ctx->tls_ssl_ctx;
929 openssl_listen_ctx_t *olc;
932 /* Start a new connection */
934 olc = openssl_lctx_get (olc_index);
935 oc->ssl = SSL_new (olc->ssl_ctx);
938 TLS_DBG (1, "Couldn't initialize ssl struct");
942 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
944 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
945 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
949 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
950 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
953 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
954 SSL_set_accept_state (oc->ssl);
956 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
957 oc->openssl_ctx_index);
959 #ifdef HAVE_OPENSSL_ASYNC
960 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
961 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
965 rv = SSL_do_handshake (oc->ssl);
966 err = SSL_get_error (oc->ssl, rv);
967 #ifdef HAVE_OPENSSL_ASYNC
968 if (err == SSL_ERROR_WANT_ASYNC)
970 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
975 if (err != SSL_ERROR_WANT_WRITE)
979 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
980 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
985 openssl_handshake_is_over (tls_ctx_t * ctx)
987 openssl_ctx_t *mc = (openssl_ctx_t *) ctx;
990 return SSL_is_init_finished (mc->ssl);
994 openssl_transport_close (tls_ctx_t * ctx)
996 #ifdef HAVE_OPENSSL_ASYNC
997 if (vpp_openssl_is_inflight (ctx))
1001 if (!openssl_handshake_is_over (ctx))
1003 openssl_handle_handshake_failure (ctx);
1006 session_transport_closing_notify (&ctx->connection);
1011 openssl_app_close (tls_ctx_t * ctx)
1013 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
1014 session_t *app_session;
1016 /* Wait for all data to be written to tcp */
1017 app_session = session_get_from_handle (ctx->app_session_handle);
1018 if (BIO_ctrl_pending (oc->rbio) <= 0
1019 && !svm_fifo_max_dequeue_cons (app_session->tx_fifo))
1020 openssl_confirm_app_close (ctx);
1022 ctx->app_closed = 1;
1027 tls_init_ca_chain (void)
1029 openssl_main_t *om = &openssl_main;
1030 tls_main_t *tm = vnet_tls_get_main ();
1035 if (access (tm->ca_cert_path, F_OK | R_OK) == -1)
1037 clib_warning ("Could not initialize TLS CA certificates");
1041 if (!(om->cert_store = X509_STORE_new ()))
1043 clib_warning ("failed to create cert store");
1047 #if OPENSSL_VERSION_NUMBER >= 0x30000000L
1048 rv = X509_STORE_load_file (om->cert_store, tm->ca_cert_path);
1050 rv = X509_STORE_load_locations (om->cert_store, tm->ca_cert_path, 0);
1055 clib_warning ("failed to load ca certificate");
1058 if (tm->use_test_cert_in_ca)
1060 cert_bio = BIO_new (BIO_s_mem ());
1061 BIO_write (cert_bio, test_srv_crt_rsa, test_srv_crt_rsa_len);
1062 testcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
1065 clib_warning ("unable to parse certificate");
1068 X509_STORE_add_cert (om->cert_store, testcert);
1071 return (rv < 0 ? -1 : 0);
1075 openssl_reinit_ca_chain (void)
1077 openssl_main_t *om = &openssl_main;
1079 /* Remove/free existing x509_store */
1082 X509_STORE_free (om->cert_store);
1084 return tls_init_ca_chain ();
1087 const static tls_engine_vft_t openssl_engine = {
1088 .ctx_alloc = openssl_ctx_alloc,
1089 .ctx_alloc_w_thread = openssl_ctx_alloc_w_thread,
1090 .ctx_free = openssl_ctx_free,
1091 .ctx_attach = openssl_ctx_attach,
1092 .ctx_detach = openssl_ctx_detach,
1093 .ctx_get = openssl_ctx_get,
1094 .ctx_get_w_thread = openssl_ctx_get_w_thread,
1095 .ctx_init_server = openssl_ctx_init_server,
1096 .ctx_init_client = openssl_ctx_init_client,
1097 .ctx_write = openssl_ctx_write,
1098 .ctx_read = openssl_ctx_read,
1099 .ctx_handshake_is_over = openssl_handshake_is_over,
1100 .ctx_start_listen = openssl_start_listen,
1101 .ctx_stop_listen = openssl_stop_listen,
1102 .ctx_transport_close = openssl_transport_close,
1103 .ctx_app_close = openssl_app_close,
1104 .ctx_reinit_cachain = openssl_reinit_ca_chain,
1108 tls_openssl_set_ciphers (char *ciphers)
1110 openssl_main_t *om = &openssl_main;
1118 vec_validate (om->ciphers, strlen (ciphers) - 1);
1119 for (i = 0; i < vec_len (om->ciphers); i++)
1121 om->ciphers[i] = toupper (ciphers[i]);
1128 static clib_error_t *
1129 tls_openssl_init (vlib_main_t * vm)
1131 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1132 openssl_main_t *om = &openssl_main;
1133 clib_error_t *error = 0;
1136 error = tls_openssl_api_init (vm);
1137 num_threads = 1 /* main thread */ + vtm->n_threads;
1139 SSL_library_init ();
1140 SSL_load_error_strings ();
1142 vec_validate (om->ctx_pool, num_threads - 1);
1143 vec_validate (om->rx_bufs, num_threads - 1);
1144 vec_validate (om->tx_bufs, num_threads - 1);
1145 for (i = 0; i < num_threads; i++)
1147 vec_validate (om->rx_bufs[i], DTLSO_MAX_DGRAM);
1148 vec_validate (om->tx_bufs[i], DTLSO_MAX_DGRAM);
1150 tls_register_engine (&openssl_engine, CRYPTO_ENGINE_OPENSSL);
1152 om->engine_init = 0;
1154 /* default ciphers */
1155 tls_openssl_set_ciphers
1156 ("ALL:!ADH:!LOW:!EXP:!MD5:!RC4-SHA:!DES-CBC3-SHA:@STRENGTH");
1158 if (tls_init_ca_chain ())
1160 clib_warning ("failed to initialize TLS CA chain");
1167 VLIB_INIT_FUNCTION (tls_openssl_init) =
1169 .runs_after = VLIB_INITS("tls_init"),
1173 #ifdef HAVE_OPENSSL_ASYNC
1174 static clib_error_t *
1175 tls_openssl_set_command_fn (vlib_main_t * vm, unformat_input_t * input,
1176 vlib_cli_command_t * cmd)
1178 openssl_main_t *om = &openssl_main;
1179 char *engine_name = NULL;
1180 char *engine_alg = NULL;
1181 char *ciphers = NULL;
1182 u8 engine_name_set = 0;
1185 /* By present, it is not allowed to configure engine again after running */
1186 if (om->engine_init)
1188 clib_warning ("engine has started!\n");
1189 return clib_error_return
1190 (0, "engine has started, and no config is accepted");
1193 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1195 if (unformat (input, "engine %s", &engine_name))
1197 engine_name_set = 1;
1199 else if (unformat (input, "async"))
1203 else if (unformat (input, "alg %s", &engine_alg))
1205 for (i = 0; i < strnlen (engine_alg, MAX_CRYPTO_LEN); i++)
1206 engine_alg[i] = toupper (engine_alg[i]);
1208 else if (unformat (input, "ciphers %s", &ciphers))
1210 tls_openssl_set_ciphers (ciphers);
1213 return clib_error_return (0, "failed: unknown input `%U'",
1214 format_unformat_error, input);
1217 /* reset parameters if engine is not configured */
1218 if (!engine_name_set)
1220 clib_warning ("No engine provided! \n");
1225 vnet_session_enable_disable (vm, 1);
1226 if (openssl_engine_register (engine_name, engine_alg, async) < 0)
1228 return clib_error_return (0, "Failed to register %s polling",
1233 vlib_cli_output (vm, "Successfully register engine %s\n",
1243 VLIB_CLI_COMMAND (tls_openssl_set_command, static) =
1245 .path = "tls openssl set",
1246 .short_help = "tls openssl set [engine <engine name>] [alg [algorithm] [async]",
1247 .function = tls_openssl_set_command_fn,
1253 VLIB_PLUGIN_REGISTER () = {
1254 .version = VPP_BUILD_VER,
1255 .description = "Transport Layer Security (TLS) Engine, OpenSSL Based",
1260 * fd.io coding-style-patch-verification: ON
1263 * eval: (c-set-style "gnu")