3 #include <tlspicotls/certs.h>
4 #include <tlspicotls/tls_picotls.h>
5 #include <tlspicotls/pico_vpp_crypto.h>
7 picotls_main_t picotls_main;
9 #define MAX_QUEUE 12000
10 #define PTLS_MAX_PLAINTEXT_RECORD_SIZE 16384
12 static ptls_key_exchange_algorithm_t *default_key_exchange[] = {
13 #ifdef PTLS_OPENSSL_HAVE_X25519
16 #ifdef PTLS_OPENSSL_HAVE_SECP256R1
17 &ptls_openssl_secp256r1,
19 #ifdef PTLS_OPENSSL_HAVE_SECP384R1
20 &ptls_openssl_secp384r1,
22 #ifdef PTLS_OPENSSL_HAVE_SECP521R1
23 &ptls_openssl_secp521r1
28 picotls_ctx_alloc (void)
30 u8 thread_id = vlib_get_thread_index ();
31 picotls_main_t *pm = &picotls_main;
34 pool_get (pm->ctx_pool[thread_id], ctx);
36 *ctx = clib_mem_alloc (sizeof (picotls_ctx_t));
38 clib_memset (*ctx, 0, sizeof (picotls_ctx_t));
39 (*ctx)->ctx.c_thread_index = thread_id;
40 (*ctx)->ctx.tls_ctx_engine = CRYPTO_ENGINE_PICOTLS;
41 (*ctx)->ctx.app_session_handle = SESSION_INVALID_HANDLE;
42 (*ctx)->ptls_ctx_idx = ctx - pm->ctx_pool[thread_id];
43 return (*ctx)->ptls_ctx_idx;
47 picotls_ctx_free (tls_ctx_t * ctx)
49 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
50 vec_free (ptls_ctx->rx_content);
51 ptls_free (ptls_ctx->tls);
52 pool_put_index (picotls_main.ctx_pool[ctx->c_thread_index],
53 ptls_ctx->ptls_ctx_idx);
57 picotls_listen_ctx_alloc (void)
59 picotls_main_t *pm = &picotls_main;
60 picotls_listen_ctx_t *ptls_lctx;
62 pool_get (pm->lctx_pool, ptls_lctx);
64 clib_memset (ptls_lctx, 0, sizeof (picotls_listen_ctx_t));
65 ptls_lctx->ptls_lctx_index = ptls_lctx - pm->lctx_pool;
66 return ptls_lctx->ptls_lctx_index;
70 picotls_listen_ctx_free (picotls_listen_ctx_t * lctx)
72 pool_put_index (picotls_main.lctx_pool, lctx->ptls_lctx_index);
76 picotls_ctx_get (u32 ctx_index)
80 pool_elt_at_index (picotls_main.ctx_pool[vlib_get_thread_index ()],
85 picotls_listen_ctx_t *
86 picotls_lctx_get (u32 lctx_index)
88 return pool_elt_at_index (picotls_main.lctx_pool, lctx_index);
92 picotls_handshake_is_over (tls_ctx_t * ctx)
94 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
95 assert (ptls_ctx->tls);
96 return ptls_handshake_is_complete (ptls_ctx->tls);
100 picotls_try_handshake_write (picotls_ctx_t * ptls_ctx,
101 session_t * tls_session, ptls_buffer_t * buf)
103 u32 enq_max, enq_now;
110 f = tls_session->tx_fifo;
112 enq_max = svm_fifo_max_enqueue_prod (f);
116 enq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max);
117 enq_now = clib_min (enq_now, buf_left);
118 write = svm_fifo_enqueue (f, enq_now, buf->base);
120 tls_add_vpp_q_tx_evt (tls_session);
125 picotls_start_listen (tls_ctx_t * lctx)
127 picotls_listen_ctx_t *ptls_lctx;
128 ptls_context_t *ptls_ctx;
130 app_cert_key_pair_t *ckpair;
132 ckpair = app_cert_key_pair_get_if_valid (lctx->ckpair_index);
133 if (!ckpair || !ckpair->cert || !ckpair->key)
135 TLS_DBG (1, "tls cert and/or key not configured %d",
136 lctx->parent_app_wrk_index);
140 ptls_lctx_idx = picotls_listen_ctx_alloc ();
141 ptls_lctx = picotls_lctx_get (ptls_lctx_idx);
142 ptls_ctx = malloc (sizeof (ptls_context_t));
143 ptls_lctx->ptls_ctx = ptls_ctx;
145 memset (ptls_ctx, 0, sizeof (ptls_context_t));
146 ptls_ctx->update_open_count = NULL;
149 * Process certificate & private key.
151 load_bio_certificate_chain (ptls_ctx, (char *) ckpair->cert);
152 load_bio_private_key (ptls_ctx, (char *) ckpair->key);
154 /* setup protocol related functions */
155 ptls_ctx->key_exchanges = default_key_exchange;
156 ptls_ctx->random_bytes = ptls_openssl_random_bytes;
157 ptls_ctx->cipher_suites = ptls_vpp_crypto_cipher_suites;
158 ptls_ctx->get_time = &ptls_get_time;
160 lctx->tls_ssl_ctx = ptls_lctx_idx;
166 picotls_stop_listen (tls_ctx_t * lctx)
169 picotls_listen_ctx_t *ptls_lctx;
171 ptls_lctx_index = lctx->tls_ssl_ctx;
172 ptls_lctx = picotls_lctx_get (ptls_lctx_index);
174 picotls_listen_ctx_free (ptls_lctx);
180 picotls_handle_handshake_failure (tls_ctx_t * ctx)
182 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
183 ctx->no_app_session = 1;
184 ctx->c_s_index = SESSION_INVALID_INDEX;
185 tls_disconnect_transport (ctx);
189 picotls_confirm_app_close (tls_ctx_t * ctx)
191 tls_disconnect_transport (ctx);
192 session_transport_closed_notify (&ctx->connection);
196 picotls_transport_close (tls_ctx_t * ctx)
198 if (!picotls_handshake_is_over (ctx))
200 picotls_handle_handshake_failure (ctx);
203 session_transport_closing_notify (&ctx->connection);
208 picotls_app_close (tls_ctx_t * ctx)
210 session_t *app_session;
212 app_session = session_get_from_handle (ctx->app_session_handle);
213 if (!svm_fifo_max_dequeue_cons (app_session->tx_fifo))
214 picotls_confirm_app_close (ctx);
222 picotls_do_handshake (picotls_ctx_t *ptls_ctx, session_t *tcp_session)
224 int rv = PTLS_ERROR_IN_PROGRESS, write = 0, i = 0, read = 0, len;
225 svm_fifo_t *tcp_rx_fifo = tcp_session->rx_fifo;
226 ptls_buffer_t *buf = &ptls_ctx->read_buffer;
227 u32 n_segs = 2, max_len = 16384;
228 ptls_t *tls = ptls_ctx->tls;
229 svm_fifo_seg_t fs[n_segs];
232 ptls_buffer_init (buf, "", 0);
234 len = svm_fifo_segments (tcp_rx_fifo, 0, fs, &n_segs, max_len);
238 while (read < len && i < n_segs)
241 rv = ptls_handshake (tls, buf, fs[i].data, &deq_now, NULL);
243 write += picotls_try_handshake_write (ptls_ctx, tcp_session, buf);
246 if (!(rv == 0 || rv == PTLS_ERROR_IN_PROGRESS))
248 clib_error ("unexpected error %u", rv);
255 if (deq_now < fs[i].len)
257 fs[i].data += deq_now;
258 fs[i].len -= deq_now;
265 svm_fifo_dequeue_drop (tcp_rx_fifo, read);
267 ptls_buffer_dispose (buf);
273 ptls_copy_buf_to_fs (ptls_buffer_t *buf, u32 to_copy, svm_fifo_seg_t *fs,
274 u32 *fs_idx, u32 max_fs)
280 if (fs[idx].len <= to_copy)
282 clib_memcpy_fast (fs[idx].data, buf->base + (buf->off - to_copy),
284 to_copy -= fs[idx].len;
286 /* no more space in the app's rx fifo */
292 clib_memcpy_fast (fs[idx].data, buf->base + (buf->off - to_copy),
294 fs[idx].len -= to_copy;
295 fs[idx].data += to_copy;
306 ptls_tcp_to_app_write (picotls_ctx_t *ptls_ctx, svm_fifo_t *app_rx_fifo,
307 svm_fifo_t *tcp_rx_fifo)
309 u32 ai = 0, thread_index, min_buf_len, to_copy, left, wrote = 0;
310 ptls_buffer_t *buf = &ptls_ctx->read_buffer;
311 int ret, i = 0, read = 0, tcp_len, n_fs_app;
312 u32 n_segs = 4, max_len = 1 << 16;
313 svm_fifo_seg_t tcp_fs[n_segs], app_fs[n_segs];
314 picotls_main_t *pm = &picotls_main;
318 thread_index = ptls_ctx->ctx.c_thread_index;
320 n_fs_app = svm_fifo_provision_chunks (app_rx_fifo, app_fs, n_segs, max_len);
324 tcp_len = svm_fifo_segments (tcp_rx_fifo, 0, tcp_fs, &n_segs, max_len);
328 if (ptls_ctx->read_buffer_offset)
330 to_copy = buf->off - ptls_ctx->read_buffer_offset;
331 left = ptls_copy_buf_to_fs (buf, to_copy, app_fs, &ai, n_fs_app);
332 wrote += to_copy - left;
335 ptls_ctx->read_buffer_offset = buf->off - left;
338 ptls_ctx->read_buffer_offset = 0;
341 while (ai < n_fs_app && read < tcp_len)
343 deq_now = clib_min (tcp_fs[i].len, tcp_len - read);
344 min_buf_len = deq_now + (16 << 10);
345 is_nocopy = app_fs[ai].len < min_buf_len ? 0 : 1;
348 ptls_buffer_init (buf, app_fs[ai].data, app_fs[ai].len);
349 ret = ptls_receive (ptls_ctx->tls, buf, tcp_fs[i].data, &deq_now);
350 assert (ret == 0 || ret == PTLS_ERROR_IN_PROGRESS);
353 if (buf->off == app_fs[ai].len)
359 app_fs[ai].len -= buf->off;
360 app_fs[ai].data += buf->off;
365 vec_validate (pm->rx_bufs[thread_index], min_buf_len);
366 ptls_buffer_init (buf, pm->rx_bufs[thread_index], min_buf_len);
367 ret = ptls_receive (ptls_ctx->tls, buf, tcp_fs[i].data, &deq_now);
368 assert (ret == 0 || ret == PTLS_ERROR_IN_PROGRESS);
370 left = ptls_copy_buf_to_fs (buf, buf->off, app_fs, &ai, n_fs_app);
373 ptls_ctx->read_buffer_offset = 0;
378 ptls_ctx->read_buffer_offset = buf->off - left;
379 wrote += ptls_ctx->read_buffer_offset;
383 assert (deq_now <= tcp_fs[i].len);
385 if (deq_now < tcp_fs[i].len)
387 tcp_fs[i].data += deq_now;
388 tcp_fs[i].len -= deq_now;
398 svm_fifo_dequeue_drop (tcp_rx_fifo, read);
399 if (svm_fifo_needs_deq_ntf (tcp_rx_fifo, read))
401 svm_fifo_clear_deq_ntf (tcp_rx_fifo);
402 session_send_io_evt_to_thread (tcp_rx_fifo, SESSION_IO_EVT_RX);
407 svm_fifo_enqueue_nocopy (app_rx_fifo, wrote);
413 picotls_ctx_read (tls_ctx_t *ctx, session_t *tcp_session)
415 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
416 svm_fifo_t *tcp_rx_fifo;
417 session_t *app_session;
420 if (PREDICT_FALSE (!ptls_handshake_is_complete (ptls_ctx->tls)))
422 picotls_do_handshake (ptls_ctx, tcp_session);
423 if (picotls_handshake_is_over (ctx))
425 if (ptls_is_server (ptls_ctx->tls))
427 if (tls_notify_app_accept (ctx))
429 ctx->c_s_index = SESSION_INVALID_INDEX;
430 tls_disconnect_transport (ctx);
436 tls_notify_app_connected (ctx, SESSION_E_NONE);
440 if (!svm_fifo_max_dequeue (tcp_session->rx_fifo))
444 tcp_rx_fifo = tcp_session->rx_fifo;
445 app_session = session_get_from_handle (ctx->app_session_handle);
446 wrote = ptls_tcp_to_app_write (ptls_ctx, app_session->rx_fifo, tcp_rx_fifo);
448 if (wrote && app_session->session_state >= SESSION_STATE_READY)
449 tls_notify_app_enqueue (ctx, app_session);
451 if (ptls_ctx->read_buffer_offset || svm_fifo_max_dequeue (tcp_rx_fifo))
452 tls_add_vpp_q_builtin_rx_evt (tcp_session);
458 ptls_compute_deq_len (picotls_ctx_t *ptls_ctx, u32 dst_chunk, u32 src_chunk,
459 u32 dst_space, u8 *is_nocopy)
461 int record_overhead = ptls_get_record_overhead (ptls_ctx->tls);
463 u32 deq_len, total_overhead;
465 if (dst_chunk >= clib_min (8192, src_chunk + record_overhead))
468 deq_len = clib_min (src_chunk, dst_chunk);
469 num_records = ceil ((f64) deq_len / PTLS_MAX_PLAINTEXT_RECORD_SIZE);
470 total_overhead = num_records * record_overhead;
471 if (deq_len + total_overhead > dst_chunk)
472 deq_len = dst_chunk - total_overhead;
476 deq_len = clib_min (src_chunk, dst_space);
477 num_records = ceil ((f64) deq_len / PTLS_MAX_PLAINTEXT_RECORD_SIZE);
478 total_overhead = num_records * record_overhead;
479 if (deq_len + total_overhead > dst_space)
480 deq_len = dst_space - total_overhead;
487 ptls_app_to_tcp_write (picotls_ctx_t *ptls_ctx, session_t *app_session,
488 svm_fifo_t *tcp_tx_fifo, u32 max_len)
490 u32 wrote = 0, max_enq, thread_index, app_buf_len, left, ti = 0;
491 int read = 0, rv, i = 0, len, n_tcp_segs = 4, deq_len;
492 u32 n_app_segs = 2, min_chunk = 2048;
493 svm_fifo_seg_t app_fs[n_app_segs], tcp_fs[n_tcp_segs];
494 picotls_main_t *pm = &picotls_main;
495 ptls_buffer_t _buf, *buf = &_buf;
496 svm_fifo_t *app_tx_fifo;
497 u8 is_nocopy, *app_buf;
500 thread_index = app_session->thread_index;
501 app_tx_fifo = app_session->tx_fifo;
503 len = svm_fifo_segments (app_tx_fifo, 0, app_fs, &n_app_segs, max_len);
507 n_tcp_segs = svm_fifo_provision_chunks (tcp_tx_fifo, tcp_fs, n_tcp_segs,
512 while ((left = len - read) && ti < n_tcp_segs)
514 /* If we wrote something and are left with few bytes, postpone write
515 * as we may be able to encrypt a bigger chunk next time */
516 if (wrote && left < min_chunk)
519 /* Avoid short records if possible */
520 if (app_fs[i].len < min_chunk && min_chunk < left)
522 app_buf_len = app_fs[i].len + app_fs[i + 1].len;
523 app_buf = pm->rx_bufs[thread_index];
524 vec_validate (pm->rx_bufs[thread_index], app_buf_len);
525 clib_memcpy_fast (pm->rx_bufs[thread_index], app_fs[i].data,
527 clib_memcpy_fast (pm->rx_bufs[thread_index] + app_fs[i].len,
528 app_fs[i + 1].data, app_buf_len - app_fs[i].len);
529 first_chunk_len = app_fs[i].len;
534 app_buf = app_fs[i].data;
535 app_buf_len = app_fs[i].len;
540 max_enq = tcp_fs[ti].len;
541 max_enq += ti < (n_tcp_segs - 1) ? tcp_fs[ti + 1].len : 0;
543 deq_len = ptls_compute_deq_len (ptls_ctx, tcp_fs[ti].len, app_buf_len,
544 max_enq, &is_nocopy);
547 ptls_buffer_init (buf, tcp_fs[ti].data, tcp_fs[ti].len);
548 rv = ptls_send (ptls_ctx->tls, buf, app_buf, deq_len);
553 tcp_fs[ti].len -= buf->off;
554 tcp_fs[ti].data += buf->off;
560 vec_validate (pm->tx_bufs[thread_index], max_enq);
561 ptls_buffer_init (buf, pm->tx_bufs[thread_index], max_enq);
562 rv = ptls_send (ptls_ctx->tls, buf, app_buf, deq_len);
567 left = ptls_copy_buf_to_fs (buf, buf->off, tcp_fs, &ti, n_tcp_segs);
572 ASSERT (deq_len >= first_chunk_len);
574 if (deq_len == app_buf_len)
580 app_fs[i].len -= deq_len - first_chunk_len;
581 app_fs[i].data += deq_len - first_chunk_len;
587 svm_fifo_dequeue_drop (app_tx_fifo, read);
588 if (svm_fifo_needs_deq_ntf (app_tx_fifo, read))
589 session_dequeue_notify (app_session);
594 svm_fifo_enqueue_nocopy (tcp_tx_fifo, wrote);
595 if (svm_fifo_set_event (tcp_tx_fifo))
596 session_send_io_evt_to_thread (tcp_tx_fifo, SESSION_IO_EVT_TX);
603 picotls_ctx_write (tls_ctx_t *ctx, session_t *app_session,
604 transport_send_params_t *sp)
606 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
607 u32 deq_max, deq_now, enq_max, enq_buf, wrote = 0;
608 svm_fifo_t *tcp_tx_fifo;
609 session_t *tcp_session;
611 tcp_session = session_get_from_handle (ctx->tls_session_handle);
612 tcp_tx_fifo = tcp_session->tx_fifo;
614 enq_max = svm_fifo_max_enqueue_prod (tcp_tx_fifo);
618 deq_max = svm_fifo_max_dequeue_cons (app_session->tx_fifo);
619 deq_max = clib_min (deq_max, enq_max);
623 deq_now = clib_min (deq_max, sp->max_burst_size);
624 wrote = ptls_app_to_tcp_write (ptls_ctx, app_session, tcp_tx_fifo, deq_now);
629 picotls_app_close (ctx);
631 /* Deschedule and wait for deq notification if fifo is almost full */
632 enq_buf = clib_min (svm_fifo_size (tcp_tx_fifo) / 2, TLSP_MIN_ENQ_SPACE);
633 if (enq_max < wrote + enq_buf)
635 svm_fifo_add_want_deq_ntf (tcp_tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
636 transport_connection_deschedule (&ctx->connection);
637 sp->flags |= TRANSPORT_SND_F_DESCHED;
640 /* Request tx reschedule of the app session */
641 app_session->flags |= SESSION_F_CUSTOM_TX;
647 picotls_ctx_init_server (tls_ctx_t * ctx)
649 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
650 u32 ptls_lctx_idx = ctx->tls_ssl_ctx;
651 picotls_listen_ctx_t *ptls_lctx;
653 ptls_lctx = picotls_lctx_get (ptls_lctx_idx);
654 ptls_ctx->tls = ptls_new (ptls_lctx->ptls_ctx, 1);
655 if (ptls_ctx->tls == NULL)
657 TLS_DBG (1, "Failed to initialize ptls_ssl structure");
661 ptls_ctx->rx_len = 0;
662 ptls_ctx->rx_offset = 0;
668 picotls_ctx_init_client (tls_ctx_t *ctx)
670 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
671 picotls_main_t *pm = &picotls_main;
672 ptls_context_t *client_ptls_ctx = pm->client_ptls_ctx;
673 ptls_handshake_properties_t hsprop = { { { { NULL } } } };
675 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
676 ptls_buffer_t hs_buf;
678 ptls_ctx->tls = ptls_new (client_ptls_ctx, 0);
679 if (ptls_ctx->tls == NULL)
681 TLS_DBG (1, "Failed to initialize ptls_ssl structure");
685 ptls_ctx->rx_len = 0;
686 ptls_ctx->rx_offset = 0;
688 ptls_buffer_init (&hs_buf, "", 0);
689 if (ptls_handshake (ptls_ctx->tls, &hs_buf, NULL, NULL, &hsprop) !=
690 PTLS_ERROR_IN_PROGRESS)
692 TLS_DBG (1, "Failed to initialize tls connection");
695 picotls_try_handshake_write (ptls_ctx, tls_session, &hs_buf);
697 ptls_buffer_dispose (&hs_buf);
703 picotls_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
706 ctx = pool_elt_at_index (picotls_main.ctx_pool[thread_index], ctx_index);
711 picotls_init_client_ptls_ctx (ptls_context_t **client_ptls_ctx)
713 *client_ptls_ctx = clib_mem_alloc (sizeof (ptls_context_t));
714 memset (*client_ptls_ctx, 0, sizeof (ptls_context_t));
716 (*client_ptls_ctx)->update_open_count = NULL;
717 (*client_ptls_ctx)->key_exchanges = default_key_exchange;
718 (*client_ptls_ctx)->random_bytes = ptls_openssl_random_bytes;
719 (*client_ptls_ctx)->cipher_suites = ptls_vpp_crypto_cipher_suites;
720 (*client_ptls_ctx)->get_time = &ptls_get_time;
725 const static tls_engine_vft_t picotls_engine = {
726 .ctx_alloc = picotls_ctx_alloc,
727 .ctx_free = picotls_ctx_free,
728 .ctx_get = picotls_ctx_get,
729 .ctx_get_w_thread = picotls_ctx_get_w_thread,
730 .ctx_handshake_is_over = picotls_handshake_is_over,
731 .ctx_start_listen = picotls_start_listen,
732 .ctx_stop_listen = picotls_stop_listen,
733 .ctx_init_server = picotls_ctx_init_server,
734 .ctx_init_client = picotls_ctx_init_client,
735 .ctx_read = picotls_ctx_read,
736 .ctx_write = picotls_ctx_write,
737 .ctx_transport_close = picotls_transport_close,
738 .ctx_app_close = picotls_app_close,
741 static clib_error_t *
742 tls_picotls_init (vlib_main_t * vm)
744 vlib_thread_main_t *vtm = vlib_get_thread_main ();
745 picotls_main_t *pm = &picotls_main;
746 clib_error_t *error = 0;
749 num_threads = 1 + vtm->n_threads;
751 vec_validate (pm->ctx_pool, num_threads - 1);
752 vec_validate (pm->rx_bufs, num_threads - 1);
753 vec_validate (pm->tx_bufs, num_threads - 1);
755 clib_rwlock_init (&picotls_main.crypto_keys_rw_lock);
757 tls_register_engine (&picotls_engine, CRYPTO_ENGINE_PICOTLS);
759 picotls_init_client_ptls_ctx (&pm->client_ptls_ctx);
765 VLIB_INIT_FUNCTION (tls_picotls_init) = {
766 .runs_after = VLIB_INITS ("tls_init"),
771 VLIB_PLUGIN_REGISTER () = {
772 .version = VPP_BUILD_VER,
773 .description = "Transport Layer Security (TLS) Engine, Picotls Based",
778 * fd.io coding-style-patch-verification: ON
781 * eval: (c-set-style "gnu")