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->flags & TLS_CONN_F_MIGRATED))
70 if (SSL_is_init_finished (oc->ssl) &&
71 !(ctx->flags & TLS_CONN_F_PASSIVE_CLOSE))
72 SSL_shutdown (oc->ssl);
75 vec_free (ctx->srv_hostname);
76 SSL_CTX_free (oc->client_ssl_ctx);
77 #ifdef HAVE_OPENSSL_ASYNC
78 openssl_evt_free (ctx->evt_index, ctx->c_thread_index);
82 pool_put_index (openssl_main.ctx_pool[ctx->c_thread_index],
83 oc->openssl_ctx_index);
87 openssl_ctx_detach (tls_ctx_t *ctx)
89 openssl_ctx_t *oc = (openssl_ctx_t *) ctx, *oc_copy;
91 oc_copy = clib_mem_alloc (sizeof (*oc_copy));
92 clib_memcpy (oc_copy, oc, sizeof (*oc));
98 openssl_ctx_attach (u32 thread_index, void *ctx_ptr)
100 openssl_main_t *om = &openssl_main;
104 pool_get_aligned_safe (om->ctx_pool[thread_index], oc, 0);
105 /* Free the old instance instead of looking for an empty spot */
110 (*oc)->openssl_ctx_index = oc - om->ctx_pool[thread_index];
111 (*oc)->ctx.c_thread_index = thread_index;
113 sh = (*oc)->ctx.tls_session_handle;
114 BIO_set_data ((*oc)->rbio, uword_to_pointer (sh, void *));
115 BIO_set_data ((*oc)->wbio, uword_to_pointer (sh, void *));
117 return ((*oc)->openssl_ctx_index);
121 openssl_ctx_get (u32 ctx_index)
124 ctx = pool_elt_at_index (openssl_main.ctx_pool[vlib_get_thread_index ()],
130 openssl_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
133 ctx = pool_elt_at_index (openssl_main.ctx_pool[thread_index], ctx_index);
138 openssl_listen_ctx_alloc (void)
140 openssl_main_t *om = &openssl_main;
141 openssl_listen_ctx_t *lctx;
143 pool_get (om->lctx_pool, lctx);
145 clib_memset (lctx, 0, sizeof (openssl_listen_ctx_t));
146 lctx->openssl_lctx_index = lctx - om->lctx_pool;
147 return lctx->openssl_lctx_index;
151 openssl_listen_ctx_free (openssl_listen_ctx_t * lctx)
153 pool_put_index (openssl_main.lctx_pool, lctx->openssl_lctx_index);
156 openssl_listen_ctx_t *
157 openssl_lctx_get (u32 lctx_index)
159 return pool_elt_at_index (openssl_main.lctx_pool, lctx_index);
162 #define ossl_check_err_is_fatal(_ssl, _rv) \
163 if (PREDICT_FALSE (_rv < 0 && SSL_get_error (_ssl, _rv) == SSL_ERROR_SSL)) \
167 openssl_read_from_ssl_into_fifo (svm_fifo_t *f, SSL *ssl, u32 max_len)
169 int read, rv, n_fs, i;
170 const int n_segs = 2;
171 svm_fifo_seg_t fs[n_segs];
174 max_enq = svm_fifo_max_enqueue_prod (f);
178 max_enq = clib_min (max_len, max_enq);
179 n_fs = svm_fifo_provision_chunks (f, fs, n_segs, max_enq);
183 /* Return early if we can't read anything */
184 read = SSL_read (ssl, fs[0].data, fs[0].len);
187 ossl_check_err_is_fatal (ssl, read);
191 if (read == (int) fs[0].len)
193 for (i = 1; i < n_fs; i++)
195 rv = SSL_read (ssl, fs[i].data, fs[i].len);
196 read += rv > 0 ? rv : 0;
198 if (rv < (int) fs[i].len)
200 ossl_check_err_is_fatal (ssl, rv);
205 svm_fifo_enqueue_nocopy (f, read);
211 openssl_write_from_fifo_into_ssl (svm_fifo_t *f, SSL *ssl, u32 max_len)
213 int wrote = 0, rv, i = 0, len;
215 svm_fifo_seg_t fs[n_segs];
217 len = svm_fifo_segments (f, 0, fs, &n_segs, max_len);
221 while (wrote < len && i < n_segs)
223 rv = SSL_write (ssl, fs[i].data, fs[i].len);
224 wrote += (rv > 0) ? rv : 0;
225 if (rv < (int) fs[i].len)
227 ossl_check_err_is_fatal (ssl, rv);
234 svm_fifo_dequeue_drop (f, wrote);
239 #ifdef HAVE_OPENSSL_ASYNC
241 openssl_check_async_status (tls_ctx_t * ctx, openssl_resume_handler * handler,
244 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
247 SSL_get_async_status (oc->ssl, &estatus);
248 if (estatus == ASYNC_STATUS_EAGAIN)
250 vpp_tls_async_update_event (ctx, 1);
254 vpp_tls_async_update_event (ctx, 0);
264 openssl_handle_handshake_failure (tls_ctx_t * ctx)
266 /* Failed to renegotiate handshake */
267 if (ctx->flags & TLS_CONN_F_HS_DONE)
269 tls_notify_app_io_error (ctx);
270 tls_disconnect_transport (ctx);
274 if (SSL_is_server (((openssl_ctx_t *) ctx)->ssl))
276 ctx->flags |= TLS_CONN_F_NO_APP_SESSION;
277 tls_disconnect_transport (ctx);
282 * Also handles cleanup of the pre-allocated session
284 tls_notify_app_connected (ctx, SESSION_E_TLS_HANDSHAKE);
285 tls_disconnect_transport (ctx);
290 openssl_ctx_handshake_rx (tls_ctx_t * ctx, session_t * tls_session)
292 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
295 while (SSL_in_init (oc->ssl))
297 if (ctx->flags & TLS_CONN_F_RESUME)
299 ctx->flags &= ~TLS_CONN_F_RESUME;
301 else if (!svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
304 rv = SSL_do_handshake (oc->ssl);
305 err = SSL_get_error (oc->ssl, rv);
307 #ifdef HAVE_OPENSSL_ASYNC
308 if (err == SSL_ERROR_WANT_ASYNC)
310 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
314 if (err == SSL_ERROR_SSL)
317 ERR_error_string (ERR_get_error (), buf);
318 clib_warning ("Err: %s", buf);
320 openssl_handle_handshake_failure (ctx);
324 if (err != SSL_ERROR_WANT_WRITE && err != SSL_ERROR_WANT_READ)
327 TLS_DBG (2, "tls state for %u is %s", oc->openssl_ctx_index,
328 SSL_state_string_long (oc->ssl));
330 if (SSL_in_init (oc->ssl))
333 /* Renegotiated handshake, app must not be notified */
334 if (PREDICT_FALSE (ctx->flags & TLS_CONN_F_HS_DONE))
340 if (!SSL_is_server (oc->ssl))
343 * Verify server certificate
345 if ((rv = SSL_get_verify_result (oc->ssl)) != X509_V_OK)
347 TLS_DBG (1, " failed verify: %s\n",
348 X509_verify_cert_error_string (rv));
351 * Presence of hostname enforces strict certificate verification
353 if (ctx->srv_hostname)
355 openssl_handle_handshake_failure (ctx);
359 if (tls_notify_app_connected (ctx, SESSION_E_NONE))
361 tls_disconnect_transport (ctx);
367 /* Need to check transport status */
368 if (ctx->flags & TLS_CONN_F_PASSIVE_CLOSE)
370 openssl_handle_handshake_failure (ctx);
374 /* Accept failed, cleanup */
375 if (tls_notify_app_accept (ctx))
377 ctx->c_s_index = SESSION_INVALID_INDEX;
378 tls_disconnect_transport (ctx);
382 ctx->flags |= TLS_CONN_F_HS_DONE;
383 TLS_DBG (1, "Handshake for %u complete. TLS cipher is %s",
384 oc->openssl_ctx_index, SSL_get_cipher (oc->ssl));
389 openssl_confirm_app_close (tls_ctx_t * ctx)
391 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
392 SSL_shutdown (oc->ssl);
393 tls_disconnect_transport (ctx);
394 session_transport_closed_notify (&ctx->connection);
398 openssl_ctx_write_tls (tls_ctx_t *ctx, session_t *app_session,
399 transport_send_params_t *sp)
401 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
402 u32 deq_max, space, enq_buf;
407 ts = session_get_from_handle (ctx->tls_session_handle);
408 space = svm_fifo_max_enqueue_prod (ts->tx_fifo);
409 /* Leave a bit of extra space for tls ctrl data, if any needed */
410 space = clib_max ((int) space - TLSO_CTRL_BYTES, 0);
412 f = app_session->tx_fifo;
414 deq_max = svm_fifo_max_dequeue_cons (f);
415 deq_max = clib_min (deq_max, space);
419 deq_max = clib_min (deq_max, sp->max_burst_size);
421 /* Make sure tcp's tx fifo can actually buffer all bytes to be dequeued.
422 * If under memory pressure, tls's fifo segment might not be able to
423 * allocate the chunks needed. This also avoids errors from the underlying
424 * custom bio to the ssl infra which at times can get stuck. */
425 if (svm_fifo_provision_chunks (ts->tx_fifo, 0, 0, deq_max + TLSO_CTRL_BYTES))
428 wrote = openssl_write_from_fifo_into_ssl (f, oc->ssl, deq_max);
430 /* Unrecoverable protocol error. Reset connection */
431 if (PREDICT_FALSE (wrote < 0))
433 tls_notify_app_io_error (ctx);
440 if (svm_fifo_needs_deq_ntf (f, wrote))
441 session_dequeue_notify (app_session);
445 if (PREDICT_FALSE ((ctx->flags & TLS_CONN_F_APP_CLOSED) &&
446 BIO_ctrl_pending (oc->rbio) <= 0))
447 openssl_confirm_app_close (ctx);
449 /* Deschedule and wait for deq notification if fifo is almost full */
450 enq_buf = clib_min (svm_fifo_size (ts->tx_fifo) / 2, TLSO_MIN_ENQ_SPACE);
451 if (space < wrote + enq_buf)
453 svm_fifo_add_want_deq_ntf (ts->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
454 transport_connection_deschedule (&ctx->connection);
455 sp->flags |= TRANSPORT_SND_F_DESCHED;
459 /* Request tx reschedule of the app session */
461 app_session->flags |= SESSION_F_CUSTOM_TX;
468 openssl_ctx_write_dtls (tls_ctx_t *ctx, session_t *app_session,
469 transport_send_params_t *sp)
471 openssl_main_t *om = &openssl_main;
472 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
473 u32 read = 0, to_deq, dgram_sz, enq_max;
474 session_dgram_pre_hdr_t hdr;
479 us = session_get_from_handle (ctx->tls_session_handle);
480 to_deq = svm_fifo_max_dequeue_cons (app_session->tx_fifo);
481 buf = om->tx_bufs[ctx->c_thread_index];
485 /* Peeking only pre-header dgram because the session is connected */
486 rv = svm_fifo_peek (app_session->tx_fifo, 0, sizeof (hdr), (u8 *) &hdr);
487 ASSERT (rv == sizeof (hdr) && hdr.data_length < vec_len (buf));
488 ASSERT (to_deq >= hdr.data_length + SESSION_CONN_HDR_LEN);
490 dgram_sz = hdr.data_length + SESSION_CONN_HDR_LEN;
491 enq_max = dgram_sz + TLSO_CTRL_BYTES;
492 if (svm_fifo_max_enqueue_prod (us->tx_fifo) < enq_max ||
493 svm_fifo_provision_chunks (us->tx_fifo, 0, 0, enq_max))
495 svm_fifo_add_want_deq_ntf (us->tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
496 transport_connection_deschedule (&ctx->connection);
497 sp->flags |= TRANSPORT_SND_F_DESCHED;
501 rv = svm_fifo_peek (app_session->tx_fifo, SESSION_CONN_HDR_LEN,
502 hdr.data_length, buf);
503 ASSERT (rv == hdr.data_length);
504 svm_fifo_dequeue_drop (app_session->tx_fifo, dgram_sz);
506 wrote = SSL_write (oc->ssl, buf, rv);
515 if (svm_fifo_needs_deq_ntf (app_session->tx_fifo, read))
516 session_dequeue_notify (app_session);
519 tls_add_vpp_q_tx_evt (us);
521 if (PREDICT_FALSE ((ctx->flags & TLS_CONN_F_APP_CLOSED) &&
522 !svm_fifo_max_enqueue_prod (us->rx_fifo)))
523 openssl_confirm_app_close (ctx);
529 openssl_ctx_write (tls_ctx_t *ctx, session_t *app_session,
530 transport_send_params_t *sp)
532 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
533 return openssl_ctx_write_tls (ctx, app_session, sp);
535 return openssl_ctx_write_dtls (ctx, app_session, sp);
539 openssl_ctx_read_tls (tls_ctx_t *ctx, session_t *tls_session)
541 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
542 const u32 max_len = 128 << 10;
543 session_t *app_session;
547 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
549 if (openssl_ctx_handshake_rx (ctx, tls_session) < 0)
552 /* Application might force a session pool realloc on accept */
553 tls_session = session_get_from_handle (ctx->tls_session_handle);
556 app_session = session_get_from_handle (ctx->app_session_handle);
557 f = app_session->rx_fifo;
559 read = openssl_read_from_ssl_into_fifo (f, oc->ssl, max_len);
561 /* Unrecoverable protocol error. Reset connection */
562 if (PREDICT_FALSE (read < 0))
564 tls_notify_app_io_error (ctx);
569 tls_notify_app_enqueue (ctx, app_session);
571 if ((SSL_pending (oc->ssl) > 0) ||
572 svm_fifo_max_dequeue_cons (tls_session->rx_fifo))
573 tls_add_vpp_q_builtin_rx_evt (tls_session);
579 openssl_ctx_read_dtls (tls_ctx_t *ctx, session_t *us)
581 openssl_main_t *om = &openssl_main;
582 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
583 session_dgram_hdr_t hdr;
584 session_t *app_session;
589 if (PREDICT_FALSE (SSL_in_init (oc->ssl)))
591 u32 us_index = us->session_index;
592 if (openssl_ctx_handshake_rx (ctx, us) < 0)
594 /* Session pool might grow when allocating the app's session */
595 us = session_get (us_index, ctx->c_thread_index);
598 buf = om->rx_bufs[ctx->c_thread_index];
599 app_session = session_get_from_handle (ctx->app_session_handle);
600 svm_fifo_fill_chunk_list (app_session->rx_fifo);
602 while (svm_fifo_max_dequeue_cons (us->rx_fifo) > 0)
604 if (svm_fifo_max_enqueue_prod (app_session->rx_fifo) < DTLSO_MAX_DGRAM)
606 tls_add_vpp_q_builtin_rx_evt (us);
610 read = SSL_read (oc->ssl, buf, vec_len (buf));
611 if (PREDICT_FALSE (read <= 0))
614 tls_add_vpp_q_builtin_rx_evt (us);
619 hdr.data_length = read;
622 svm_fifo_seg_t segs[2] = { { (u8 *) &hdr, sizeof (hdr) },
625 rv = svm_fifo_enqueue_segments (app_session->rx_fifo, segs, 2,
626 0 /* allow partial */);
632 /* If handshake just completed, session may still be in accepting state */
633 if (app_session->session_state >= SESSION_STATE_READY)
634 tls_notify_app_enqueue (ctx, app_session);
640 openssl_ctx_read (tls_ctx_t *ctx, session_t *ts)
642 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
643 return openssl_ctx_read_tls (ctx, ts);
645 return openssl_ctx_read_dtls (ctx, ts);
649 openssl_set_ckpair (SSL *ssl, u32 ckpair_index)
651 app_cert_key_pair_t *ckpair;
656 /* Configure a ckpair index only if non-default/test provided */
657 if (ckpair_index == 0)
660 ckpair = app_cert_key_pair_get_if_valid (ckpair_index);
664 if (!ckpair->cert || !ckpair->key)
666 TLS_DBG (1, "tls cert and/or key not configured");
670 * Set the key and cert
672 cert_bio = BIO_new (BIO_s_mem ());
673 BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
674 srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
677 clib_warning ("unable to parse certificate");
680 SSL_use_certificate (ssl, srvcert);
683 cert_bio = BIO_new (BIO_s_mem ());
684 BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
685 pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
688 clib_warning ("unable to parse pkey");
691 SSL_use_PrivateKey (ssl, pkey);
693 TLS_DBG (1, "TLS client using ckpair index: %d", ckpair_index);
698 openssl_client_init_verify (SSL *ssl, const char *srv_hostname,
699 int set_hostname_verification,
700 int set_hostname_strict_check)
702 if (set_hostname_verification)
704 X509_VERIFY_PARAM *param = SSL_get0_param (ssl);
707 TLS_DBG (1, "Couldn't fetch SSL param");
711 if (set_hostname_strict_check)
712 X509_VERIFY_PARAM_set_hostflags (param,
713 X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS);
715 if (!X509_VERIFY_PARAM_set1_host (param, srv_hostname, 0))
717 TLS_DBG (1, "Couldn't set hostname for verification");
720 SSL_set_verify (ssl, SSL_VERIFY_PEER, 0);
722 if (!SSL_set_tlsext_host_name (ssl, srv_hostname))
724 TLS_DBG (1, "Couldn't set hostname");
731 openssl_ctx_init_client (tls_ctx_t * ctx)
733 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
734 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
735 openssl_main_t *om = &openssl_main;
736 const SSL_METHOD *method;
739 method = ctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_client_method () :
740 DTLS_client_method ();
743 TLS_DBG (1, "(D)TLS_method returned null");
747 oc->client_ssl_ctx = SSL_CTX_new (method);
748 if (oc->client_ssl_ctx == NULL)
750 TLS_DBG (1, "SSL_CTX_new returned null");
754 SSL_CTX_set_ecdh_auto (oc->client_ssl_ctx, 1);
755 SSL_CTX_set_mode (oc->client_ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
756 #ifdef HAVE_OPENSSL_ASYNC
758 SSL_CTX_set_mode (oc->client_ssl_ctx, SSL_MODE_ASYNC);
761 SSL_CTX_set_cipher_list (oc->client_ssl_ctx, (const char *) om->ciphers);
764 TLS_DBG (1, "Couldn't set cipher");
768 SSL_CTX_set_options (oc->client_ssl_ctx, flags);
769 SSL_CTX_set1_cert_store (oc->client_ssl_ctx, om->cert_store);
771 oc->ssl = SSL_new (oc->client_ssl_ctx);
774 TLS_DBG (1, "Couldn't initialize ssl struct");
778 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
780 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
781 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
785 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
786 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
789 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
790 SSL_set_connect_state (oc->ssl);
792 /* Hostname validation and strict check by name are disabled by default */
793 rv = openssl_client_init_verify (oc->ssl, (const char *) ctx->srv_hostname,
797 TLS_DBG (1, "ERROR:verify init failed:%d", rv);
800 if (openssl_set_ckpair (oc->ssl, ctx->ckpair_index))
802 TLS_DBG (1, "Couldn't set client certificate-key pair");
806 * 2. Do the first steps in the handshake.
808 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
809 oc->openssl_ctx_index);
811 #ifdef HAVE_OPENSSL_ASYNC
812 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
813 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
817 rv = SSL_do_handshake (oc->ssl);
818 err = SSL_get_error (oc->ssl, rv);
819 #ifdef HAVE_OPENSSL_ASYNC
820 if (err == SSL_ERROR_WANT_ASYNC)
822 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
827 if (err != SSL_ERROR_WANT_WRITE)
831 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
832 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
837 openssl_start_listen (tls_ctx_t * lctx)
839 const SSL_METHOD *method;
846 openssl_listen_ctx_t *olc;
847 app_cert_key_pair_t *ckpair;
849 long flags = SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3 | SSL_OP_NO_COMPRESSION;
850 openssl_main_t *om = &openssl_main;
852 ckpair = app_cert_key_pair_get_if_valid (lctx->ckpair_index);
856 if (!ckpair->cert || !ckpair->key)
858 TLS_DBG (1, "tls cert and/or key not configured %d",
859 lctx->parent_app_wrk_index);
863 method = lctx->tls_type == TRANSPORT_PROTO_TLS ? SSLv23_server_method () :
864 DTLS_server_method ();
865 ssl_ctx = SSL_CTX_new (method);
868 clib_warning ("Unable to create SSL context");
872 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ENABLE_PARTIAL_WRITE);
873 #ifdef HAVE_OPENSSL_ASYNC
876 SSL_CTX_set_mode (ssl_ctx, SSL_MODE_ASYNC);
877 SSL_CTX_set_async_callback (ssl_ctx, tls_async_openssl_callback);
880 SSL_CTX_set_options (ssl_ctx, flags);
881 SSL_CTX_set_ecdh_auto (ssl_ctx, 1);
883 rv = SSL_CTX_set_cipher_list (ssl_ctx, (const char *) om->ciphers);
886 TLS_DBG (1, "Couldn't set cipher");
890 /* use the default OpenSSL built-in DH parameters */
891 rv = SSL_CTX_set_dh_auto (ssl_ctx, 1);
894 TLS_DBG (1, "Couldn't set temp DH parameters");
899 * Set the key and cert
901 cert_bio = BIO_new (BIO_s_mem ());
904 clib_warning ("unable to allocate memory");
907 BIO_write (cert_bio, ckpair->cert, vec_len (ckpair->cert));
908 srvcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
911 clib_warning ("unable to parse certificate");
914 rv = SSL_CTX_use_certificate (ssl_ctx, srvcert);
917 clib_warning ("unable to use SSL certificate");
923 cert_bio = BIO_new (BIO_s_mem ());
926 clib_warning ("unable to allocate memory");
929 BIO_write (cert_bio, ckpair->key, vec_len (ckpair->key));
930 pkey = PEM_read_bio_PrivateKey (cert_bio, NULL, NULL, NULL);
933 clib_warning ("unable to parse pkey");
936 rv = SSL_CTX_use_PrivateKey (ssl_ctx, pkey);
939 clib_warning ("unable to use SSL PrivateKey");
945 olc_index = openssl_listen_ctx_alloc ();
946 olc = openssl_lctx_get (olc_index);
947 olc->ssl_ctx = ssl_ctx;
948 olc->srvcert = srvcert;
951 /* store SSL_CTX into TLS level structure */
952 lctx->tls_ssl_ctx = olc_index;
963 openssl_stop_listen (tls_ctx_t * lctx)
966 openssl_listen_ctx_t *olc;
968 olc_index = lctx->tls_ssl_ctx;
969 olc = openssl_lctx_get (olc_index);
971 X509_free (olc->srvcert);
972 EVP_PKEY_free (olc->pkey);
974 SSL_CTX_free (olc->ssl_ctx);
975 openssl_listen_ctx_free (olc);
981 openssl_ctx_init_server (tls_ctx_t * ctx)
983 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
984 u32 olc_index = ctx->tls_ssl_ctx;
985 openssl_listen_ctx_t *olc;
988 /* Start a new connection */
990 olc = openssl_lctx_get (olc_index);
991 oc->ssl = SSL_new (olc->ssl_ctx);
994 TLS_DBG (1, "Couldn't initialize ssl struct");
998 if (ctx->tls_type == TRANSPORT_PROTO_TLS)
1000 oc->rbio = BIO_new_tls (ctx->tls_session_handle);
1001 oc->wbio = BIO_new_tls (ctx->tls_session_handle);
1005 oc->rbio = BIO_new_dtls (ctx->tls_session_handle);
1006 oc->wbio = BIO_new_dtls (ctx->tls_session_handle);
1009 SSL_set_bio (oc->ssl, oc->wbio, oc->rbio);
1010 SSL_set_accept_state (oc->ssl);
1012 TLS_DBG (1, "Initiating handshake for [%u]%u", ctx->c_thread_index,
1013 oc->openssl_ctx_index);
1015 #ifdef HAVE_OPENSSL_ASYNC
1016 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
1017 vpp_tls_async_init_event (ctx, openssl_ctx_handshake_rx, tls_session);
1021 rv = SSL_do_handshake (oc->ssl);
1022 err = SSL_get_error (oc->ssl, rv);
1023 #ifdef HAVE_OPENSSL_ASYNC
1024 if (err == SSL_ERROR_WANT_ASYNC)
1026 openssl_check_async_status (ctx, openssl_ctx_handshake_rx,
1031 if (err != SSL_ERROR_WANT_WRITE)
1035 TLS_DBG (2, "tls state for [%u]%u is su", ctx->c_thread_index,
1036 oc->openssl_ctx_index, SSL_state_string_long (oc->ssl));
1041 openssl_handshake_is_over (tls_ctx_t * ctx)
1043 openssl_ctx_t *mc = (openssl_ctx_t *) ctx;
1046 return SSL_is_init_finished (mc->ssl);
1050 openssl_transport_close (tls_ctx_t * ctx)
1052 #ifdef HAVE_OPENSSL_ASYNC
1053 if (vpp_openssl_is_inflight (ctx))
1057 if (!openssl_handshake_is_over (ctx))
1059 openssl_handle_handshake_failure (ctx);
1062 session_transport_closing_notify (&ctx->connection);
1067 openssl_transport_reset (tls_ctx_t *ctx)
1069 if (!openssl_handshake_is_over (ctx))
1071 openssl_handle_handshake_failure (ctx);
1075 session_transport_reset_notify (&ctx->connection);
1076 session_transport_closed_notify (&ctx->connection);
1077 tls_disconnect_transport (ctx);
1083 openssl_app_close (tls_ctx_t * ctx)
1085 openssl_ctx_t *oc = (openssl_ctx_t *) ctx;
1086 session_t *app_session;
1088 /* Wait for all data to be written to tcp */
1089 app_session = session_get_from_handle (ctx->app_session_handle);
1090 if (BIO_ctrl_pending (oc->rbio) <= 0
1091 && !svm_fifo_max_dequeue_cons (app_session->tx_fifo))
1092 openssl_confirm_app_close (ctx);
1097 tls_init_ca_chain (void)
1099 openssl_main_t *om = &openssl_main;
1100 tls_main_t *tm = vnet_tls_get_main ();
1105 if (access (tm->ca_cert_path, F_OK | R_OK) == -1)
1107 clib_warning ("Could not initialize TLS CA certificates");
1111 if (!(om->cert_store = X509_STORE_new ()))
1113 clib_warning ("failed to create cert store");
1117 #if OPENSSL_VERSION_NUMBER >= 0x30000000L
1118 rv = X509_STORE_load_file (om->cert_store, tm->ca_cert_path);
1120 rv = X509_STORE_load_locations (om->cert_store, tm->ca_cert_path, 0);
1125 clib_warning ("failed to load ca certificate");
1128 if (tm->use_test_cert_in_ca)
1130 cert_bio = BIO_new (BIO_s_mem ());
1131 BIO_write (cert_bio, test_srv_crt_rsa, test_srv_crt_rsa_len);
1132 testcert = PEM_read_bio_X509 (cert_bio, NULL, NULL, NULL);
1135 clib_warning ("unable to parse certificate");
1138 X509_STORE_add_cert (om->cert_store, testcert);
1141 return (rv < 0 ? -1 : 0);
1145 openssl_reinit_ca_chain (void)
1147 openssl_main_t *om = &openssl_main;
1149 /* Remove/free existing x509_store */
1152 X509_STORE_free (om->cert_store);
1154 return tls_init_ca_chain ();
1157 const static tls_engine_vft_t openssl_engine = {
1158 .ctx_alloc = openssl_ctx_alloc,
1159 .ctx_alloc_w_thread = openssl_ctx_alloc_w_thread,
1160 .ctx_free = openssl_ctx_free,
1161 .ctx_attach = openssl_ctx_attach,
1162 .ctx_detach = openssl_ctx_detach,
1163 .ctx_get = openssl_ctx_get,
1164 .ctx_get_w_thread = openssl_ctx_get_w_thread,
1165 .ctx_init_server = openssl_ctx_init_server,
1166 .ctx_init_client = openssl_ctx_init_client,
1167 .ctx_write = openssl_ctx_write,
1168 .ctx_read = openssl_ctx_read,
1169 .ctx_handshake_is_over = openssl_handshake_is_over,
1170 .ctx_start_listen = openssl_start_listen,
1171 .ctx_stop_listen = openssl_stop_listen,
1172 .ctx_transport_close = openssl_transport_close,
1173 .ctx_transport_reset = openssl_transport_reset,
1174 .ctx_app_close = openssl_app_close,
1175 .ctx_reinit_cachain = openssl_reinit_ca_chain,
1179 tls_openssl_set_ciphers (char *ciphers)
1181 openssl_main_t *om = &openssl_main;
1188 vec_validate_init_c_string (om->ciphers, ciphers, strlen (ciphers));
1194 static clib_error_t *
1195 tls_openssl_init (vlib_main_t * vm)
1197 vlib_thread_main_t *vtm = vlib_get_thread_main ();
1198 openssl_main_t *om = &openssl_main;
1199 clib_error_t *error = 0;
1202 error = tls_openssl_api_init (vm);
1203 num_threads = 1 /* main thread */ + vtm->n_threads;
1205 SSL_library_init ();
1206 SSL_load_error_strings ();
1208 vec_validate (om->ctx_pool, num_threads - 1);
1209 vec_validate (om->rx_bufs, num_threads - 1);
1210 vec_validate (om->tx_bufs, num_threads - 1);
1211 for (i = 0; i < num_threads; i++)
1213 vec_validate (om->rx_bufs[i], DTLSO_MAX_DGRAM);
1214 vec_validate (om->tx_bufs[i], DTLSO_MAX_DGRAM);
1216 tls_register_engine (&openssl_engine, CRYPTO_ENGINE_OPENSSL);
1218 om->engine_init = 0;
1220 /* default ciphers */
1221 tls_openssl_set_ciphers
1222 ("ALL:!ADH:!LOW:!EXP:!MD5:!RC4-SHA:!DES-CBC3-SHA:@STRENGTH");
1224 if (tls_init_ca_chain ())
1226 clib_warning ("failed to initialize TLS CA chain");
1232 VLIB_INIT_FUNCTION (tls_openssl_init) =
1234 .runs_after = VLIB_INITS("tls_init"),
1237 #ifdef HAVE_OPENSSL_ASYNC
1238 static clib_error_t *
1239 tls_openssl_set_command_fn (vlib_main_t * vm, unformat_input_t * input,
1240 vlib_cli_command_t * cmd)
1242 openssl_main_t *om = &openssl_main;
1243 char *engine_name = NULL;
1244 char *engine_alg = NULL;
1245 char *ciphers = NULL;
1246 u8 engine_name_set = 0;
1249 /* By present, it is not allowed to configure engine again after running */
1250 if (om->engine_init)
1252 clib_warning ("engine has started!\n");
1253 return clib_error_return
1254 (0, "engine has started, and no config is accepted");
1257 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1259 if (unformat (input, "engine %s", &engine_name))
1261 engine_name_set = 1;
1263 else if (unformat (input, "async"))
1267 else if (unformat (input, "alg %s", &engine_alg))
1269 for (i = 0; i < strnlen (engine_alg, MAX_CRYPTO_LEN); i++)
1270 engine_alg[i] = toupper (engine_alg[i]);
1272 else if (unformat (input, "ciphers %s", &ciphers))
1274 tls_openssl_set_ciphers (ciphers);
1277 return clib_error_return (0, "failed: unknown input `%U'",
1278 format_unformat_error, input);
1281 /* reset parameters if engine is not configured */
1282 if (!engine_name_set)
1284 clib_warning ("No engine provided! \n");
1289 vnet_session_enable_disable (vm, 1);
1290 if (openssl_engine_register (engine_name, engine_alg, async) < 0)
1292 return clib_error_return (0, "Failed to register %s polling",
1297 vlib_cli_output (vm, "Successfully register engine %s\n",
1306 VLIB_CLI_COMMAND (tls_openssl_set_command, static) =
1308 .path = "tls openssl set",
1309 .short_help = "tls openssl set [engine <engine name>] [alg [algorithm] [async]",
1310 .function = tls_openssl_set_command_fn,
1314 VLIB_PLUGIN_REGISTER () = {
1315 .version = VPP_BUILD_VER,
1316 .description = "Transport Layer Security (TLS) Engine, OpenSSL Based",
1320 * fd.io coding-style-patch-verification: ON
1323 * eval: (c-set-style "gnu")