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 if (SSL_is_init_finished (oc->ssl) && !ctx->is_passive_close)
65 SSL_shutdown (oc->ssl);
69 #ifdef HAVE_OPENSSL_ASYNC
70 openssl_evt_free (ctx->evt_index, ctx->c_thread_index);
72 vec_free (ctx->srv_hostname);
73 pool_put_index (openssl_main.ctx_pool[ctx->c_thread_index],
74 oc->openssl_ctx_index);
78 openssl_ctx_detach (tls_ctx_t *ctx)
80 openssl_ctx_t *oc = (openssl_ctx_t *) ctx, *oc_copy;
82 oc_copy = clib_mem_alloc (sizeof (*oc_copy));
83 clib_memcpy (oc_copy, oc, sizeof (*oc));
89 openssl_ctx_attach (u32 thread_index, void *ctx_ptr)
91 openssl_main_t *om = &openssl_main;
95 pool_get (om->ctx_pool[thread_index], oc);
96 /* Free the old instance instead of looking for an empty spot */
101 (*oc)->openssl_ctx_index = oc - om->ctx_pool[thread_index];
102 (*oc)->ctx.c_thread_index = thread_index;
104 sh = (*oc)->ctx.tls_session_handle;
105 BIO_set_data ((*oc)->rbio, uword_to_pointer (sh, void *));
106 BIO_set_data ((*oc)->wbio, uword_to_pointer (sh, void *));
108 return ((*oc)->openssl_ctx_index);
112 openssl_ctx_get (u32 ctx_index)
115 ctx = pool_elt_at_index (openssl_main.ctx_pool[vlib_get_thread_index ()],
121 openssl_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
124 ctx = pool_elt_at_index (openssl_main.ctx_pool[thread_index], ctx_index);
129 openssl_listen_ctx_alloc (void)
131 openssl_main_t *om = &openssl_main;
132 openssl_listen_ctx_t *lctx;
134 pool_get (om->lctx_pool, lctx);
136 clib_memset (lctx, 0, sizeof (openssl_listen_ctx_t));
137 lctx->openssl_lctx_index = lctx - om->lctx_pool;
138 return lctx->openssl_lctx_index;
142 openssl_listen_ctx_free (openssl_listen_ctx_t * lctx)
144 pool_put_index (openssl_main.lctx_pool, lctx->openssl_lctx_index);
147 openssl_listen_ctx_t *
148 openssl_lctx_get (u32 lctx_index)
150 return pool_elt_at_index (openssl_main.lctx_pool, lctx_index);
154 openssl_read_from_ssl_into_fifo (svm_fifo_t * f, SSL * ssl)
156 int read, rv, n_fs, i;
157 const int n_segs = 2;
158 svm_fifo_seg_t fs[n_segs];
161 max_enq = svm_fifo_max_enqueue_prod (f);
162 n_fs = svm_fifo_provision_chunks (f, fs, n_segs, max_enq);
166 /* Return early if we can't read anything */
167 read = SSL_read (ssl, fs[0].data, fs[0].len);
171 for (i = 1; i < n_fs; i++)
173 rv = SSL_read (ssl, fs[i].data, fs[i].len);
174 read += rv > 0 ? rv : 0;
180 svm_fifo_enqueue_nocopy (f, read);
186 openssl_write_from_fifo_into_ssl (svm_fifo_t *f, SSL *ssl, u32 max_len)
188 int wrote = 0, rv, i = 0, len;
189 const int n_segs = 2;
190 svm_fifo_seg_t fs[n_segs];
192 len = svm_fifo_segments (f, 0, fs, n_segs, max_len);
196 while (wrote < len && i < n_segs)
198 rv = SSL_write (ssl, fs[i].data, fs[i].len);
199 wrote += (rv > 0) ? rv : 0;
206 svm_fifo_dequeue_drop (f, wrote);
211 #ifdef HAVE_OPENSSL_ASYNC
213 openssl_check_async_status (tls_ctx_t * ctx, openssl_resume_handler * handler,
216 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
219 SSL_get_async_status (oc->ssl, &estatus);
220 if (estatus == ASYNC_STATUS_EAGAIN)
222 vpp_tls_async_update_event (ctx, 1);
226 vpp_tls_async_update_event (ctx, 0);
236 openssl_handle_handshake_failure (tls_ctx_t * ctx)
238 session_t *app_session;
240 if (SSL_is_server (((openssl_ctx_t *) ctx)->ssl))
243 * Cleanup pre-allocated app session and close transport
246 session_get_if_valid (ctx->c_s_index, ctx->c_thread_index);
249 session_free (app_session);
250 ctx->no_app_session = 1;
251 ctx->c_s_index = SESSION_INVALID_INDEX;
252 tls_disconnect_transport (ctx);
258 * Also handles cleanup of the pre-allocated session
260 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
265 openssl_ctx_handshake_rx (tls_ctx_t * ctx, session_t * tls_session)
267 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
270 while (SSL_in_init (oc->ssl))
276 else if (!svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
279 rv = SSL_do_handshake (oc->ssl);
280 err = SSL_get_error (oc->ssl, rv);
282 #ifdef HAVE_OPENSSL_ASYNC
283 if (err == SSL_ERROR_WANT_ASYNC)
285 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
289 if (err == SSL_ERROR_SSL)
292 ERR_error_string (ERR_get_error (), buf);
293 clib_warning ("Err: %s", buf);
295 openssl_handle_handshake_failure (ctx);
299 if (err != SSL_ERROR_WANT_WRITE && err != SSL_ERROR_WANT_READ)
302 TLS_DBG (2, "tls state for %u is %s", oc->openssl_ctx_index,
303 SSL_state_string_long (oc->ssl));
305 if (SSL_in_init (oc->ssl))
311 if (!SSL_is_server (oc->ssl))
314 * Verify server certificate
316 if ((rv = SSL_get_verify_result (oc->ssl)) != X509_V_OK)
318 TLS_DBG (1, " failed verify: %s\n",
319 X509_verify_cert_error_string (rv));
322 * Presence of hostname enforces strict certificate verification
324 if (ctx->srv_hostname)
326 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
330 tls_notify_app_connected (ctx, SESSION_E_NONE);
334 /* Need to check transport status */
335 if (ctx->is_passive_close)
336 openssl_handle_handshake_failure (ctx);
338 tls_notify_app_accept (ctx);
341 TLS_DBG (1, "Handshake for %u complete. TLS cipher is %s",
342 oc->openssl_ctx_index, SSL_get_cipher (oc->ssl));
347 openssl_confirm_app_close (tls_ctx_t * ctx)
349 tls_disconnect_transport (ctx);
350 session_transport_closed_notify (&ctx->connection);
354 openssl_ctx_write_tls (tls_ctx_t *ctx, session_t *app_session,
355 transport_send_params_t *sp)
357 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
358 u32 deq_max, space, enq_buf;
363 ts = session_get_from_handle (ctx->tls_session_handle);
364 space = svm_fifo_max_enqueue_prod (ts->tx_fifo);
365 /* Leave a bit of extra space for tls ctrl data, if any needed */
366 space = clib_max ((int) space - TLSO_CTRL_BYTES, 0);
368 f = app_session->tx_fifo;
370 deq_max = svm_fifo_max_dequeue_cons (f);
371 deq_max = clib_min (deq_max, space);
375 deq_max = clib_min (deq_max, sp->max_burst_size);
377 wrote = openssl_write_from_fifo_into_ssl (f, oc->ssl, deq_max);
381 if (svm_fifo_needs_deq_ntf (f, wrote))
382 session_dequeue_notify (app_session);
386 /* Deschedule and wait for deq notification if fifo is almost full */
387 enq_buf = clib_min (svm_fifo_size (ts->tx_fifo) / 2, TLSO_MIN_ENQ_SPACE);
388 if (space < wrote + enq_buf)
390 svm_fifo_add_want_deq_ntf (ts->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
391 transport_connection_deschedule (&ctx->connection);
392 sp->flags |= TRANSPORT_SND_F_DESCHED;
395 /* Request tx reschedule of the app session */
396 app_session->flags |= SESSION_F_CUSTOM_TX;
402 openssl_ctx_write_dtls (tls_ctx_t *ctx, session_t *app_session,
403 transport_send_params_t *sp)
405 openssl_main_t *om = &openssl_main;
406 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
407 session_dgram_pre_hdr_t hdr;
410 u32 read = 0, to_deq, dgram_sz;
413 us = session_get_from_handle (ctx->tls_session_handle);
414 to_deq = svm_fifo_max_dequeue_cons (app_session->tx_fifo);
415 buf = om->tx_bufs[ctx->c_thread_index];
419 /* Peeking only pre-header dgram because the session is connected */
420 rv = svm_fifo_peek (app_session->tx_fifo, 0, sizeof (hdr), (u8 *) &hdr);
421 ASSERT (rv == sizeof (hdr) && hdr.data_length < vec_len (buf));
422 ASSERT (to_deq >= hdr.data_length + SESSION_CONN_HDR_LEN);
424 dgram_sz = hdr.data_length + SESSION_CONN_HDR_LEN;
425 if (svm_fifo_max_enqueue_prod (us->tx_fifo) < dgram_sz + TLSO_CTRL_BYTES)
427 svm_fifo_add_want_deq_ntf (us->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
428 transport_connection_deschedule (&ctx->connection);
429 sp->flags |= TRANSPORT_SND_F_DESCHED;
433 rv = svm_fifo_peek (app_session->tx_fifo, SESSION_CONN_HDR_LEN,
434 hdr.data_length, buf);
435 ASSERT (rv == hdr.data_length);
436 svm_fifo_dequeue_drop (app_session->tx_fifo, dgram_sz);
438 wrote = SSL_write (oc->ssl, buf, rv);
447 if (svm_fifo_needs_deq_ntf (app_session->tx_fifo, read))
448 session_dequeue_notify (app_session);
451 tls_add_vpp_q_tx_evt (us);
453 if (PREDICT_FALSE (ctx->app_closed &&
454 !svm_fifo_max_enqueue_prod (us->rx_fifo)))
455 openssl_confirm_app_close (ctx);
461 openssl_ctx_write (tls_ctx_t *ctx, session_t *app_session,
462 transport_send_params_t *sp)
464 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
465 return openssl_ctx_write_tls (ctx, app_session, sp);
467 return openssl_ctx_write_dtls (ctx, app_session, sp);
471 openssl_ctx_read_tls (tls_ctx_t *ctx, session_t *tls_session)
473 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
474 session_t *app_session;
478 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
480 if (openssl_ctx_handshake_rx (ctx, tls_session) < 0)
484 app_session = session_get_from_handle (ctx->app_session_handle);
485 f = app_session->rx_fifo;
487 read = openssl_read_from_ssl_into_fifo (f, oc->ssl);
489 /* If handshake just completed, session may still be in accepting state */
490 if (read && app_session->session_state >= SESSION_STATE_READY)
491 tls_notify_app_enqueue (ctx, app_session);
493 if (SSL_pending (oc->ssl) > 0)
494 tls_add_vpp_q_builtin_rx_evt (tls_session);
500 openssl_ctx_read_dtls (tls_ctx_t *ctx, session_t *us)
502 openssl_main_t *om = &openssl_main;
503 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
504 session_dgram_hdr_t hdr;
505 session_t *app_session;
510 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
512 u32 us_index = us->session_index;
513 if (openssl_ctx_handshake_rx (ctx, us) < 0)
515 /* Session pool might grow when allocating the app's session */
516 us = session_get (us_index, ctx->c_thread_index);
519 buf = om->rx_bufs[ctx->c_thread_index];
520 app_session = session_get_from_handle (ctx->app_session_handle);
521 svm_fifo_fill_chunk_list (app_session->rx_fifo);
523 while (svm_fifo_max_dequeue_cons (us->rx_fifo) > 0)
525 if (svm_fifo_max_enqueue_prod (app_session->rx_fifo) < DTLSO_MAX_DGRAM)
527 tls_add_vpp_q_builtin_rx_evt (us);
531 read = SSL_read (oc->ssl, buf, vec_len (buf));
532 if (PREDICT_FALSE (read <= 0))
535 tls_add_vpp_q_builtin_rx_evt (us);
540 hdr.data_length = read;
543 svm_fifo_seg_t segs[2] = { { (u8 *) &hdr, sizeof (hdr) },
546 rv = svm_fifo_enqueue_segments (app_session->rx_fifo, segs, 2,
547 0 /* allow partial */);
553 /* If handshake just completed, session may still be in accepting state */
554 if (app_session->session_state >= SESSION_STATE_READY)
555 tls_notify_app_enqueue (ctx, app_session);
561 openssl_ctx_read (tls_ctx_t *ctx, session_t *ts)
563 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
564 return openssl_ctx_read_tls (ctx, ts);
566 return openssl_ctx_read_dtls (ctx, ts);
570 openssl_ctx_init_client (tls_ctx_t * ctx)
572 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
573 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
574 openssl_main_t *om = &openssl_main;
575 const SSL_METHOD *method;
578 method = ctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_client_method () :
579 DTLS_client_method ();
582 TLS_DBG (1, "(D)TLS_method returned null");
586 oc->ssl_ctx = SSL_CTX_new (method);
587 if (oc->ssl_ctx == NULL)
589 TLS_DBG (1, "SSL_CTX_new returned null");
593 SSL_CTX_set_ecdh_auto (oc->ssl_ctx, 1);
594 SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
595 #ifdef HAVE_OPENSSL_ASYNC
597 SSL_CTX_set_mode (oc->ssl_ctx, SSL_MODE_ASYNC);
599 rv = SSL_CTX_set_cipher_list (oc->ssl_ctx, (const char *) om->ciphers);
602 TLS_DBG (1, "Couldn't set cipher");
606 SSL_CTX_set_options (oc->ssl_ctx, flags);
607 SSL_CTX_set_cert_store (oc->ssl_ctx, om->cert_store);
609 oc->ssl = SSL_new (oc->ssl_ctx);
612 TLS_DBG (1, "Couldn't initialize ssl struct");
616 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
618 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
619 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
623 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
624 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
627 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
628 SSL_set_connect_state (oc->ssl);
630 rv = SSL_set_tlsext_host_name (oc->ssl, ctx->srv_hostname);
633 TLS_DBG (1, "Couldn't set hostname");
638 * 2. Do the first steps in the handshake.
640 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
641 oc->openssl_ctx_index);
643 #ifdef HAVE_OPENSSL_ASYNC
644 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
645 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
649 rv = SSL_do_handshake (oc->ssl);
650 err = SSL_get_error (oc->ssl, rv);
651 #ifdef HAVE_OPENSSL_ASYNC
652 if (err == SSL_ERROR_WANT_ASYNC)
654 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
659 if (err != SSL_ERROR_WANT_WRITE)
663 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
664 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
669 openssl_start_listen (tls_ctx_t * lctx)
671 const SSL_METHOD *method;
678 openssl_listen_ctx_t *olc;
679 app_cert_key_pair_t *ckpair;
681 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
682 openssl_main_t *om = &openssl_main;
684 ckpair = app_cert_key_pair_get_if_valid (lctx->ckpair_index);
688 if (!ckpair->cert || !ckpair->key)
690 TLS_DBG (1, "tls cert and/or key not configured %d",
691 lctx->parent_app_wrk_index);
695 method = lctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_server_method () :
696 DTLS_server_method ();
697 ssl_ctx = SSL_CTX_new (method);
700 clib_warning ("Unable to create SSL context");
704 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
705 #ifdef HAVE_OPENSSL_ASYNC
708 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ASYNC);
709 SSL_CTX_set_async_callback (ssl_ctx, tls_async_openssl_callback);
712 SSL_CTX_set_options (ssl_ctx, flags);
713 SSL_CTX_set_ecdh_auto (ssl_ctx, 1);
715 rv = SSL_CTX_set_cipher_list (ssl_ctx, (const char *) om->ciphers);
718 TLS_DBG (1, "Couldn't set cipher");
723 * Set the key and cert
725 cert_bio = BIO_new (BIO_s_mem ());
726 BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
727 srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
730 clib_warning ("unable to parse certificate");
733 SSL_CTX_use_certificate (ssl_ctx, srvcert);
736 cert_bio = BIO_new (BIO_s_mem ());
737 BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
738 pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
741 clib_warning ("unable to parse pkey");
744 SSL_CTX_use_PrivateKey (ssl_ctx, pkey);
747 olc_index = openssl_listen_ctx_alloc ();
748 olc = openssl_lctx_get (olc_index);
749 olc->ssl_ctx = ssl_ctx;
750 olc->srvcert = srvcert;
753 /* store SSL_CTX into TLS level structure */
754 lctx->tls_ssl_ctx = olc_index;
761 openssl_stop_listen (tls_ctx_t * lctx)
764 openssl_listen_ctx_t *olc;
766 olc_index = lctx->tls_ssl_ctx;
767 olc = openssl_lctx_get (olc_index);
769 X509_free (olc->srvcert);
770 EVP_PKEY_free (olc->pkey);
772 SSL_CTX_free (olc->ssl_ctx);
773 openssl_listen_ctx_free (olc);
779 openssl_ctx_init_server (tls_ctx_t * ctx)
781 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
782 u32 olc_index = ctx->tls_ssl_ctx;
783 openssl_listen_ctx_t *olc;
786 /* Start a new connection */
788 olc = openssl_lctx_get (olc_index);
789 oc->ssl = SSL_new (olc->ssl_ctx);
792 TLS_DBG (1, "Couldn't initialize ssl struct");
796 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
798 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
799 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
803 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
804 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
807 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
808 SSL_set_accept_state (oc->ssl);
810 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
811 oc->openssl_ctx_index);
813 #ifdef HAVE_OPENSSL_ASYNC
814 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
815 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
819 rv = SSL_do_handshake (oc->ssl);
820 err = SSL_get_error (oc->ssl, rv);
821 #ifdef HAVE_OPENSSL_ASYNC
822 if (err == SSL_ERROR_WANT_ASYNC)
824 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
829 if (err != SSL_ERROR_WANT_WRITE)
833 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
834 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
839 openssl_handshake_is_over (tls_ctx_t * ctx)
841 openssl_ctx_t *mc = (openssl_ctx_t *) ctx;
844 return SSL_is_init_finished (mc->ssl);
848 openssl_transport_close (tls_ctx_t * ctx)
850 #ifdef HAVE_OPENSSL_ASYNC
851 if (vpp_openssl_is_inflight (ctx))
855 if (!openssl_handshake_is_over (ctx))
857 openssl_handle_handshake_failure (ctx);
860 session_transport_closing_notify (&ctx->connection);
865 openssl_app_close (tls_ctx_t * ctx)
867 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
868 session_t *app_session;
870 /* Wait for all data to be written to tcp */
871 app_session = session_get_from_handle (ctx->app_session_handle);
872 if (BIO_ctrl_pending (oc->rbio) <= 0
873 && !svm_fifo_max_dequeue_cons (app_session->tx_fifo))
874 openssl_confirm_app_close (ctx);
880 const static tls_engine_vft_t openssl_engine = {
881 .ctx_alloc = openssl_ctx_alloc,
882 .ctx_alloc_w_thread = openssl_ctx_alloc_w_thread,
883 .ctx_free = openssl_ctx_free,
884 .ctx_attach = openssl_ctx_attach,
885 .ctx_detach = openssl_ctx_detach,
886 .ctx_get = openssl_ctx_get,
887 .ctx_get_w_thread = openssl_ctx_get_w_thread,
888 .ctx_init_server = openssl_ctx_init_server,
889 .ctx_init_client = openssl_ctx_init_client,
890 .ctx_write = openssl_ctx_write,
891 .ctx_read = openssl_ctx_read,
892 .ctx_handshake_is_over = openssl_handshake_is_over,
893 .ctx_start_listen = openssl_start_listen,
894 .ctx_stop_listen = openssl_stop_listen,
895 .ctx_transport_close = openssl_transport_close,
896 .ctx_app_close = openssl_app_close,
900 tls_init_ca_chain (void)
902 openssl_main_t *om = &openssl_main;
903 tls_main_t *tm = vnet_tls_get_main ();
908 if (access (tm->ca_cert_path, F_OK | R_OK) == -1)
910 clib_warning ("Could not initialize TLS CA certificates");
914 if (!(om->cert_store = X509_STORE_new ()))
916 clib_warning ("failed to create cert store");
920 #if OPENSSL_VERSION_NUMBER >= 0x30000000L
921 rv = X509_STORE_load_file (om->cert_store, tm->ca_cert_path);
923 rv = X509_STORE_load_locations (om->cert_store, tm->ca_cert_path, 0);
928 clib_warning ("failed to load ca certificate");
931 if (tm->use_test_cert_in_ca)
933 cert_bio = BIO_new (BIO_s_mem ());
934 BIO_write (cert_bio, test_srv_crt_rsa, test_srv_crt_rsa_len);
935 testcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
938 clib_warning ("unable to parse certificate");
941 X509_STORE_add_cert (om->cert_store, testcert);
944 return (rv < 0 ? -1 : 0);
948 tls_openssl_set_ciphers (char *ciphers)
950 openssl_main_t *om = &openssl_main;
958 vec_validate (om->ciphers, strlen (ciphers) - 1);
959 for (i = 0; i < vec_len (om->ciphers); i++)
961 om->ciphers[i] = toupper (ciphers[i]);
968 static clib_error_t *
969 tls_openssl_init (vlib_main_t * vm)
971 vlib_thread_main_t *vtm = vlib_get_thread_main ();
972 openssl_main_t *om = &openssl_main;
973 clib_error_t *error = 0;
976 error = tls_openssl_api_init (vm);
977 num_threads = 1 /* main thread */ + vtm->n_threads;
980 SSL_load_error_strings ();
982 if (tls_init_ca_chain ())
984 clib_warning ("failed to initialize TLS CA chain");
988 vec_validate (om->ctx_pool, num_threads - 1);
989 vec_validate (om->rx_bufs, num_threads - 1);
990 vec_validate (om->tx_bufs, num_threads - 1);
991 for (i = 0; i < num_threads; i++)
993 vec_validate (om->rx_bufs[i], DTLSO_MAX_DGRAM);
994 vec_validate (om->tx_bufs[i], DTLSO_MAX_DGRAM);
996 tls_register_engine (&openssl_engine, CRYPTO_ENGINE_OPENSSL);
1000 /* default ciphers */
1001 tls_openssl_set_ciphers
1002 ("ALL:!ADH:!LOW:!EXP:!MD5:!RC4-SHA:!DES-CBC3-SHA:@STRENGTH");
1007 VLIB_INIT_FUNCTION (tls_openssl_init) =
1009 .runs_after = VLIB_INITS("tls_init"),
1013 #ifdef HAVE_OPENSSL_ASYNC
1014 static clib_error_t *
1015 tls_openssl_set_command_fn (vlib_main_t * vm, unformat_input_t * input,
1016 vlib_cli_command_t * cmd)
1018 openssl_main_t *om = &openssl_main;
1019 char *engine_name = NULL;
1020 char *engine_alg = NULL;
1021 char *ciphers = NULL;
1022 u8 engine_name_set = 0;
1025 /* By present, it is not allowed to configure engine again after running */
1026 if (om->engine_init)
1028 clib_warning ("engine has started!\n");
1029 return clib_error_return
1030 (0, "engine has started, and no config is accepted");
1033 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1035 if (unformat (input, "engine %s", &engine_name))
1037 engine_name_set = 1;
1039 else if (unformat (input, "async"))
1043 else if (unformat (input, "alg %s", &engine_alg))
1045 for (i = 0; i < strnlen (engine_alg, MAX_CRYPTO_LEN); i++)
1046 engine_alg[i] = toupper (engine_alg[i]);
1048 else if (unformat (input, "ciphers %s", &ciphers))
1050 tls_openssl_set_ciphers (ciphers);
1053 return clib_error_return (0, "failed: unknown input `%U'",
1054 format_unformat_error, input);
1057 /* reset parameters if engine is not configured */
1058 if (!engine_name_set)
1060 clib_warning ("No engine provided! \n");
1065 vnet_session_enable_disable (vm, 1);
1066 if (openssl_engine_register (engine_name, engine_alg, async) < 0)
1068 return clib_error_return (0, "Failed to register %s polling",
1073 vlib_cli_output (vm, "Successfully register engine %s\n",
1083 VLIB_CLI_COMMAND (tls_openssl_set_command, static) =
1085 .path = "tls openssl set",
1086 .short_help = "tls openssl set [engine <engine name>] [alg [algorithm] [async]",
1087 .function = tls_openssl_set_command_fn,
1093 VLIB_PLUGIN_REGISTER () = {
1094 .version = VPP_BUILD_VER,
1095 .description = "Transport Layer Security (TLS) Engine, OpenSSL Based",
1100 * fd.io coding-style-patch-verification: ON
1103 * eval: (c-set-style "gnu")