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 vec_free (ptls_ctx->write_content);
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 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
204 ptls_free (ptls_ctx->tls);
205 session_transport_closing_notify (&ctx->connection);
210 picotls_app_close (tls_ctx_t * ctx)
212 session_t *app_session;
214 app_session = session_get_from_handle (ctx->app_session_handle);
215 if (!svm_fifo_max_dequeue_cons (app_session->tx_fifo))
216 picotls_confirm_app_close (ctx);
224 picotls_do_handshake (picotls_ctx_t *ptls_ctx, session_t *tcp_session)
226 int rv = PTLS_ERROR_IN_PROGRESS, write = 0, i = 0, read = 0, len;
227 svm_fifo_t *tcp_rx_fifo = tcp_session->rx_fifo;
228 ptls_buffer_t *buf = &ptls_ctx->read_buffer;
229 const int n_segs = 2, max_len = 16384;
230 ptls_t *tls = ptls_ctx->tls;
231 svm_fifo_seg_t fs[n_segs];
234 ptls_buffer_init (buf, "", 0);
236 len = svm_fifo_segments (tcp_rx_fifo, 0, fs, n_segs, max_len);
240 while (read < len && i < n_segs)
243 rv = ptls_handshake (tls, buf, fs[i].data, &deq_now, NULL);
245 write += picotls_try_handshake_write (ptls_ctx, tcp_session, buf);
248 if (!(rv == 0 || rv == PTLS_ERROR_IN_PROGRESS))
250 clib_error ("unexpected error %u", rv);
257 if (deq_now < fs[i].len)
259 fs[i].data += deq_now;
260 fs[i].len -= deq_now;
267 svm_fifo_dequeue_drop (tcp_rx_fifo, read);
269 ptls_buffer_dispose (buf);
275 picotls_ctx_read (tls_ctx_t *ctx, session_t *tcp_session)
277 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
278 ptls_buffer_t *buf = &ptls_ctx->read_buffer;
279 int off = 0, ret, i = 0, read = 0, len;
280 const int n_segs = 4, max_len = 32768;
281 svm_fifo_t *tcp_rx_fifo, *app_rx_fifo;
282 svm_fifo_seg_t fs[n_segs];
283 session_t *app_session;
286 if (PREDICT_FALSE (!ptls_handshake_is_complete (ptls_ctx->tls)))
288 picotls_do_handshake (ptls_ctx, tcp_session);
289 if (picotls_handshake_is_over (ctx))
291 if (ptls_is_server (ptls_ctx->tls))
293 if (tls_notify_app_accept (ctx))
295 ctx->c_s_index = SESSION_INVALID_INDEX;
296 tls_disconnect_transport (ctx);
302 tls_notify_app_connected (ctx, SESSION_E_NONE);
306 if (!svm_fifo_max_dequeue (tcp_session->rx_fifo))
310 tcp_rx_fifo = tcp_session->rx_fifo;
311 app_session = session_get_from_handle (ctx->app_session_handle);
312 app_rx_fifo = app_session->rx_fifo;
314 if (TLS_READ_IS_LEFT (ptls_ctx))
317 len = svm_fifo_segments (tcp_rx_fifo, 0, fs, n_segs, max_len);
321 ptls_buffer_init (buf, "", 0);
322 ptls_ctx->read_buffer_offset = 0;
324 while (read < len && i < n_segs)
327 ret = ptls_receive (ptls_ctx->tls, buf, fs[i].data, &deq_now);
328 ASSERT (ret == 0 || ret == PTLS_ERROR_IN_PROGRESS);
330 if (deq_now < fs[i].len)
332 fs[i].data += deq_now;
333 fs[i].len -= deq_now;
340 svm_fifo_dequeue_drop (tcp_rx_fifo, read);
342 if (!TLS_READ_LEFT_LEN (ptls_ctx))
344 ptls_buffer_dispose (buf);
350 len = TLS_READ_LEFT_LEN (ptls_ctx);
351 off = svm_fifo_enqueue (app_rx_fifo, len, TLS_READ_OFFSET (ptls_ctx));
359 ptls_ctx->read_buffer_offset += off;
363 ptls_buffer_dispose (buf);
366 if (app_session->session_state >= SESSION_STATE_READY)
367 tls_notify_app_enqueue (ctx, app_session);
371 if (TLS_READ_IS_LEFT (ptls_ctx) || svm_fifo_max_dequeue (tcp_rx_fifo))
372 tls_add_vpp_q_builtin_rx_evt (tcp_session);
378 picotls_content_process (picotls_ctx_t * ptls_ctx, svm_fifo_t * src_fifo,
379 svm_fifo_t * dst_fifo, int content_len,
380 int total_record_overhead, int is_no_copy)
382 ptls_buffer_t *buf = &ptls_ctx->write_buffer;
383 int total_length = content_len + total_record_overhead;
387 ptls_buffer_init (buf, svm_fifo_tail (dst_fifo), total_length);
388 ptls_send (ptls_ctx->tls, buf, svm_fifo_head (src_fifo), content_len);
390 assert (!buf->is_allocated);
391 assert (buf->base == svm_fifo_tail (dst_fifo));
393 svm_fifo_dequeue_drop (src_fifo, content_len);
394 svm_fifo_enqueue_nocopy (dst_fifo, buf->off);
395 to_dst_len = buf->off;
399 assert (!TLS_WRITE_IS_LEFT (ptls_ctx));
400 vec_validate (ptls_ctx->write_content, total_length);
401 ptls_buffer_init (buf, ptls_ctx->write_content, total_length);
403 ptls_send (ptls_ctx->tls, buf, svm_fifo_head (src_fifo), content_len);
404 svm_fifo_dequeue_drop (src_fifo, content_len);
406 to_dst_len = svm_fifo_enqueue (dst_fifo, buf->off, buf->base);
408 ptls_ctx->write_buffer_offset += to_dst_len;
413 picotls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
414 transport_send_params_t * sp)
416 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
417 u32 deq_max, deq_now;
418 u32 enq_max, enq_now;
419 int from_app_len = 0, to_tls_len = 0, is_nocopy = 0;
420 svm_fifo_t *tls_tx_fifo, *app_tx_fifo;
421 session_t *tls_session;
423 int record_overhead = ptls_get_record_overhead (ptls_ctx->tls);
424 int num_records, total_overhead;
426 tls_session = session_get_from_handle (ctx->tls_session_handle);
427 tls_tx_fifo = tls_session->tx_fifo;
428 app_tx_fifo = app_session->tx_fifo;
430 if (PREDICT_FALSE (TLS_WRITE_IS_LEFT (ptls_ctx)))
432 enq_max = svm_fifo_max_enqueue_prod (tls_tx_fifo);
433 int to_write = clib_min (enq_max,
434 ptls_ctx->write_buffer.off -
435 ptls_ctx->write_buffer_offset);
437 svm_fifo_enqueue (tls_tx_fifo, to_write, TLS_WRITE_OFFSET (ptls_ctx));
440 app_session->flags |= SESSION_F_CUSTOM_TX;
443 ptls_ctx->write_buffer_offset += to_tls_len;
445 if (TLS_WRITE_IS_LEFT (ptls_ctx))
447 app_session->flags |= SESSION_F_CUSTOM_TX;
452 ptls_buffer_init (&ptls_ctx->write_buffer, "", 0);
453 ptls_ctx->write_buffer_offset = 0;
457 deq_max = svm_fifo_max_dequeue_cons (app_tx_fifo);
461 deq_now = clib_min (deq_max, sp->max_burst_size);
462 deq_now = clib_min (deq_now, svm_fifo_max_read_chunk (app_tx_fifo));
464 enq_max = svm_fifo_max_enqueue_prod (tls_tx_fifo);
465 /** There is no engough enqueue space for one record **/
466 if (enq_max <= record_overhead)
468 app_session->flags |= SESSION_F_CUSTOM_TX;
472 enq_now = clib_min (enq_max, svm_fifo_max_write_chunk (tls_tx_fifo));
474 /** Allowed to execute no-copy crypto operation **/
475 if (enq_now > record_overhead)
478 from_app_len = clib_min (deq_now, enq_now);
480 ceil ((f64) from_app_len / PTLS_MAX_PLAINTEXT_RECORD_SIZE);
481 total_overhead = num_records * record_overhead;
482 if (from_app_len + total_overhead > enq_now)
483 from_app_len = enq_now - total_overhead;
487 from_app_len = clib_min (deq_now, enq_max);
489 ceil ((f64) from_app_len / PTLS_MAX_PLAINTEXT_RECORD_SIZE);
490 total_overhead = num_records * record_overhead;
491 if (from_app_len + total_overhead > enq_max)
492 from_app_len = enq_max - total_overhead;
496 picotls_content_process (ptls_ctx, app_tx_fifo, tls_tx_fifo,
497 from_app_len, total_overhead, is_nocopy);
498 if (!TLS_WRITE_IS_LEFT (ptls_ctx))
500 ptls_ctx->write_buffer_offset = 0;
501 ptls_buffer_init (&ptls_ctx->write_buffer, "", 0);
504 if (svm_fifo_needs_deq_ntf (app_tx_fifo, from_app_len))
505 session_dequeue_notify (app_session);
508 tls_add_vpp_q_tx_evt (tls_session);
510 if (from_app_len < deq_max || TLS_WRITE_IS_LEFT (ptls_ctx))
511 app_session->flags |= SESSION_F_CUSTOM_TX;
514 picotls_app_close (ctx);
520 picotls_ctx_init_server (tls_ctx_t * ctx)
522 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
523 u32 ptls_lctx_idx = ctx->tls_ssl_ctx;
524 picotls_listen_ctx_t *ptls_lctx;
526 ptls_lctx = picotls_lctx_get (ptls_lctx_idx);
527 ptls_ctx->tls = ptls_new (ptls_lctx->ptls_ctx, 1);
528 if (ptls_ctx->tls == NULL)
530 TLS_DBG (1, "Failed to initialize ptls_ssl structure");
534 ptls_ctx->rx_len = 0;
535 ptls_ctx->rx_offset = 0;
537 ptls_ctx->write_buffer_offset = 0;
542 picotls_ctx_init_client (tls_ctx_t *ctx)
544 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
545 picotls_main_t *pm = &picotls_main;
546 ptls_context_t *client_ptls_ctx = pm->client_ptls_ctx;
547 ptls_handshake_properties_t hsprop = { { { { NULL } } } };
549 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
550 ptls_buffer_t hs_buf;
552 ptls_ctx->tls = ptls_new (client_ptls_ctx, 0);
553 if (ptls_ctx->tls == NULL)
555 TLS_DBG (1, "Failed to initialize ptls_ssl structure");
559 ptls_ctx->rx_len = 0;
560 ptls_ctx->rx_offset = 0;
561 ptls_ctx->write_buffer_offset = 0;
563 ptls_buffer_init (&hs_buf, "", 0);
564 if (ptls_handshake (ptls_ctx->tls, &hs_buf, NULL, NULL, &hsprop) !=
565 PTLS_ERROR_IN_PROGRESS)
567 TLS_DBG (1, "Failed to initialize tls connection");
570 picotls_try_handshake_write (ptls_ctx, tls_session, &hs_buf);
572 ptls_buffer_dispose (&hs_buf);
578 picotls_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
581 ctx = pool_elt_at_index (picotls_main.ctx_pool[thread_index], ctx_index);
586 picotls_init_client_ptls_ctx (ptls_context_t **client_ptls_ctx)
588 *client_ptls_ctx = clib_mem_alloc (sizeof (ptls_context_t));
589 memset (*client_ptls_ctx, 0, sizeof (ptls_context_t));
591 (*client_ptls_ctx)->update_open_count = NULL;
592 (*client_ptls_ctx)->key_exchanges = default_key_exchange;
593 (*client_ptls_ctx)->random_bytes = ptls_openssl_random_bytes;
594 (*client_ptls_ctx)->cipher_suites = ptls_vpp_crypto_cipher_suites;
595 (*client_ptls_ctx)->get_time = &ptls_get_time;
600 const static tls_engine_vft_t picotls_engine = {
601 .ctx_alloc = picotls_ctx_alloc,
602 .ctx_free = picotls_ctx_free,
603 .ctx_get = picotls_ctx_get,
604 .ctx_get_w_thread = picotls_ctx_get_w_thread,
605 .ctx_handshake_is_over = picotls_handshake_is_over,
606 .ctx_start_listen = picotls_start_listen,
607 .ctx_stop_listen = picotls_stop_listen,
608 .ctx_init_server = picotls_ctx_init_server,
609 .ctx_init_client = picotls_ctx_init_client,
610 .ctx_read = picotls_ctx_read,
611 .ctx_write = picotls_ctx_write,
612 .ctx_transport_close = picotls_transport_close,
613 .ctx_app_close = picotls_app_close,
616 static clib_error_t *
617 tls_picotls_init (vlib_main_t * vm)
619 vlib_thread_main_t *vtm = vlib_get_thread_main ();
620 picotls_main_t *pm = &picotls_main;
621 clib_error_t *error = 0;
624 num_threads = 1 + vtm->n_threads;
626 vec_validate (pm->ctx_pool, num_threads - 1);
628 clib_rwlock_init (&picotls_main.crypto_keys_rw_lock);
630 tls_register_engine (&picotls_engine, CRYPTO_ENGINE_PICOTLS);
632 picotls_init_client_ptls_ctx (&pm->client_ptls_ctx);
638 VLIB_INIT_FUNCTION (tls_picotls_init) = {
639 .runs_after = VLIB_INITS ("tls_init"),
644 VLIB_PLUGIN_REGISTER () = {
645 .version = VPP_BUILD_VER,
646 .description = "Transport Layer Security (TLS) Engine, Picotls Based",
651 * fd.io coding-style-patch-verification: ON
654 * eval: (c-set-style "gnu")