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 * tls_session,
225 u8 * input, int input_len)
227 ptls_t *tls = ptls_ctx->tls;
229 int rv = PTLS_ERROR_IN_PROGRESS;
237 ptls_buffer_init (&buf, "", 0);
238 size_t consumed = input_len - off;
239 rv = ptls_handshake (tls, &buf, input + off, &consumed, NULL);
241 ptls_ctx->rx_offset += consumed;
242 if ((rv == 0 || rv == PTLS_ERROR_IN_PROGRESS) && buf.off != 0)
244 write = picotls_try_handshake_write (ptls_ctx, tls_session,
247 ptls_buffer_dispose (&buf);
249 while (rv == PTLS_ERROR_IN_PROGRESS && input_len != off);
251 while (rv == PTLS_ERROR_IN_PROGRESS);
257 picotls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
259 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
260 int from_tls_len = 0, off, crypto_len, ret;
261 u32 deq_max, deq_now;
263 ptls_buffer_t *buf = &ptls_ctx->read_buffer;
264 svm_fifo_t *tls_rx_fifo, *app_rx_fifo;
265 session_t *app_session;
267 tls_rx_fifo = tls_session->rx_fifo;
269 if (!picotls_handshake_is_over (ctx))
271 deq_max = svm_fifo_max_dequeue_cons (tls_rx_fifo);
275 vec_validate (ptls_ctx->rx_content, deq_max);
276 ptls_ctx->rx_offset = 0;
277 ptls_ctx->rx_len = 0;
279 off = svm_fifo_dequeue (tls_rx_fifo, deq_max, TLS_RX_LEN (ptls_ctx));
281 ptls_ctx->rx_len += off;
283 picotls_do_handshake (ptls_ctx, tls_session, TLS_RX_OFFSET (ptls_ctx),
285 if (picotls_handshake_is_over (ctx))
286 ret = ptls_is_server (ptls_ctx->tls) ?
287 tls_notify_app_accept (ctx) :
288 tls_notify_app_connected (ctx, SESSION_E_NONE);
291 if (!TLS_RX_IS_LEFT (ptls_ctx))
295 app_session = session_get_from_handle (ctx->app_session_handle);
296 app_rx_fifo = app_session->rx_fifo;
298 if (TLS_READ_IS_LEFT (ptls_ctx))
301 ptls_buffer_init (buf, "", 0);
302 ptls_ctx->read_buffer_offset = 0;
304 if (!TLS_RX_IS_LEFT (ptls_ctx))
306 deq_max = svm_fifo_max_dequeue_cons (tls_rx_fifo);
310 deq_now = clib_min (deq_max, svm_fifo_max_read_chunk (tls_rx_fifo));
312 if (PREDICT_FALSE (deq_now < deq_max))
315 svm_fifo_dequeue (tls_rx_fifo, deq_max, TLS_RX_LEN (ptls_ctx));
317 ptls_ctx->rx_len += off;
322 ptls_receive (ptls_ctx->tls, buf, svm_fifo_head (tls_rx_fifo),
323 (size_t *) & deq_now);
324 svm_fifo_dequeue_drop (tls_rx_fifo, deq_now);
331 enq_max = svm_fifo_max_enqueue_prod (app_rx_fifo);
335 crypto_len = clib_min (enq_max, TLS_RX_LEFT_LEN (ptls_ctx));
340 size_t consumed = crypto_len - off;
342 ptls_receive (ptls_ctx->tls, buf,
343 TLS_RX_OFFSET (ptls_ctx), &consumed);
345 ptls_ctx->rx_offset += off;
347 while (ret == 0 && off < crypto_len);
352 svm_fifo_enqueue (app_rx_fifo, TLS_READ_LEFT_LEN (ptls_ctx),
353 TLS_READ_OFFSET (ptls_ctx));
356 tls_add_vpp_q_builtin_rx_evt (tls_session);
360 ptls_ctx->read_buffer_offset += off;
361 if (!TLS_RX_IS_LEFT (ptls_ctx))
363 ptls_ctx->rx_len = 0;
364 ptls_ctx->rx_offset = 0;
368 ptls_buffer_dispose (buf);
370 if (app_session->session_state >= SESSION_STATE_READY)
371 tls_notify_app_enqueue (ctx, app_session);
373 if (TLS_RX_IS_LEFT (ptls_ctx) || TLS_READ_IS_LEFT (ptls_ctx)
374 || svm_fifo_max_dequeue (tls_rx_fifo))
375 tls_add_vpp_q_builtin_rx_evt (tls_session);
381 picotls_content_process (picotls_ctx_t * ptls_ctx, svm_fifo_t * src_fifo,
382 svm_fifo_t * dst_fifo, int content_len,
383 int total_record_overhead, int is_no_copy)
385 ptls_buffer_t *buf = &ptls_ctx->write_buffer;
386 int total_length = content_len + total_record_overhead;
390 ptls_buffer_init (buf, svm_fifo_tail (dst_fifo), total_length);
391 ptls_send (ptls_ctx->tls, buf, svm_fifo_head (src_fifo), content_len);
393 assert (!buf->is_allocated);
394 assert (buf->base == svm_fifo_tail (dst_fifo));
396 svm_fifo_dequeue_drop (src_fifo, content_len);
397 svm_fifo_enqueue_nocopy (dst_fifo, buf->off);
398 to_dst_len = buf->off;
402 assert (!TLS_WRITE_IS_LEFT (ptls_ctx));
403 vec_validate (ptls_ctx->write_content, total_length);
404 ptls_buffer_init (buf, ptls_ctx->write_content, total_length);
406 ptls_send (ptls_ctx->tls, buf, svm_fifo_head (src_fifo), content_len);
407 svm_fifo_dequeue_drop (src_fifo, content_len);
409 to_dst_len = svm_fifo_enqueue (dst_fifo, buf->off, buf->base);
411 ptls_ctx->write_buffer_offset += to_dst_len;
416 picotls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
417 transport_send_params_t * sp)
419 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
420 u32 deq_max, deq_now;
421 u32 enq_max, enq_now;
422 int from_app_len = 0, to_tls_len = 0, is_nocopy = 0;
423 svm_fifo_t *tls_tx_fifo, *app_tx_fifo;
424 session_t *tls_session;
426 int record_overhead = ptls_get_record_overhead (ptls_ctx->tls);
427 int num_records, total_overhead;
429 tls_session = session_get_from_handle (ctx->tls_session_handle);
430 tls_tx_fifo = tls_session->tx_fifo;
431 app_tx_fifo = app_session->tx_fifo;
433 if (PREDICT_FALSE (TLS_WRITE_IS_LEFT (ptls_ctx)))
435 enq_max = svm_fifo_max_enqueue_prod (tls_tx_fifo);
436 int to_write = clib_min (enq_max,
437 ptls_ctx->write_buffer.off -
438 ptls_ctx->write_buffer_offset);
440 svm_fifo_enqueue (tls_tx_fifo, to_write, TLS_WRITE_OFFSET (ptls_ctx));
443 app_session->flags |= SESSION_F_CUSTOM_TX;
446 ptls_ctx->write_buffer_offset += to_tls_len;
448 if (TLS_WRITE_IS_LEFT (ptls_ctx))
450 app_session->flags |= SESSION_F_CUSTOM_TX;
455 ptls_buffer_init (&ptls_ctx->write_buffer, "", 0);
456 ptls_ctx->write_buffer_offset = 0;
461 deq_max = svm_fifo_max_dequeue_cons (app_tx_fifo);
465 deq_now = clib_min (deq_max, sp->max_burst_size);
466 deq_now = clib_min (deq_now, svm_fifo_max_read_chunk (app_tx_fifo));
468 enq_max = svm_fifo_max_enqueue_prod (tls_tx_fifo);
469 /** There is no engough enqueue space for one record **/
470 if (enq_max <= record_overhead)
472 app_session->flags |= SESSION_F_CUSTOM_TX;
476 enq_now = clib_min (enq_max, svm_fifo_max_write_chunk (tls_tx_fifo));
478 /** Allowed to execute no-copy crypto operation **/
479 if (enq_now > record_overhead)
482 from_app_len = clib_min (deq_now, enq_now);
484 ceil ((f64) from_app_len / PTLS_MAX_PLAINTEXT_RECORD_SIZE);
485 total_overhead = num_records * record_overhead;
486 if (from_app_len + total_overhead > enq_now)
487 from_app_len = enq_now - total_overhead;
491 from_app_len = clib_min (deq_now, enq_max);
493 ceil ((f64) from_app_len / PTLS_MAX_PLAINTEXT_RECORD_SIZE);
494 total_overhead = num_records * record_overhead;
495 if (from_app_len + total_overhead > enq_max)
496 from_app_len = enq_max - total_overhead;
500 picotls_content_process (ptls_ctx, app_tx_fifo, tls_tx_fifo,
501 from_app_len, total_overhead, is_nocopy);
502 if (!TLS_WRITE_IS_LEFT (ptls_ctx))
504 ptls_ctx->write_buffer_offset = 0;
505 ptls_buffer_init (&ptls_ctx->write_buffer, "", 0);
508 if (svm_fifo_needs_deq_ntf (app_tx_fifo, from_app_len))
509 session_dequeue_notify (app_session);
512 tls_add_vpp_q_tx_evt (tls_session);
514 if (from_app_len < deq_max || TLS_WRITE_IS_LEFT (ptls_ctx))
515 app_session->flags |= SESSION_F_CUSTOM_TX;
518 picotls_app_close (ctx);
524 picotls_ctx_init_server (tls_ctx_t * ctx)
526 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
527 u32 ptls_lctx_idx = ctx->tls_ssl_ctx;
528 picotls_listen_ctx_t *ptls_lctx;
530 ptls_lctx = picotls_lctx_get (ptls_lctx_idx);
531 ptls_ctx->tls = ptls_new (ptls_lctx->ptls_ctx, 1);
532 if (ptls_ctx->tls == NULL)
534 TLS_DBG (1, "Failed to initialize ptls_ssl structure");
538 ptls_ctx->rx_len = 0;
539 ptls_ctx->rx_offset = 0;
541 ptls_ctx->write_buffer_offset = 0;
546 picotls_ctx_init_client (tls_ctx_t *ctx)
548 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
549 picotls_main_t *pm = &picotls_main;
550 ptls_context_t *client_ptls_ctx = pm->client_ptls_ctx;
551 ptls_handshake_properties_t hsprop = { { { { NULL } } } };
553 session_t *tls_session = session_get_from_handle (ctx->tls_session_handle);
554 ptls_buffer_t hs_buf;
556 ptls_ctx->tls = ptls_new (client_ptls_ctx, 0);
557 if (ptls_ctx->tls == NULL)
559 TLS_DBG (1, "Failed to initialize ptls_ssl structure");
563 ptls_ctx->rx_len = 0;
564 ptls_ctx->rx_offset = 0;
565 ptls_ctx->write_buffer_offset = 0;
567 ptls_buffer_init (&hs_buf, "", 0);
568 if (ptls_handshake (ptls_ctx->tls, &hs_buf, NULL, NULL, &hsprop) !=
569 PTLS_ERROR_IN_PROGRESS)
571 TLS_DBG (1, "Failed to initialize tls connection");
574 picotls_try_handshake_write (ptls_ctx, tls_session, &hs_buf);
576 ptls_buffer_dispose (&hs_buf);
582 picotls_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
585 ctx = pool_elt_at_index (picotls_main.ctx_pool[thread_index], ctx_index);
590 picotls_init_client_ptls_ctx (ptls_context_t **client_ptls_ctx)
592 *client_ptls_ctx = clib_mem_alloc (sizeof (ptls_context_t));
593 memset (*client_ptls_ctx, 0, sizeof (ptls_context_t));
595 (*client_ptls_ctx)->update_open_count = NULL;
596 (*client_ptls_ctx)->key_exchanges = default_key_exchange;
597 (*client_ptls_ctx)->random_bytes = ptls_openssl_random_bytes;
598 (*client_ptls_ctx)->cipher_suites = ptls_vpp_crypto_cipher_suites;
599 (*client_ptls_ctx)->get_time = &ptls_get_time;
604 const static tls_engine_vft_t picotls_engine = {
605 .ctx_alloc = picotls_ctx_alloc,
606 .ctx_free = picotls_ctx_free,
607 .ctx_get = picotls_ctx_get,
608 .ctx_get_w_thread = picotls_ctx_get_w_thread,
609 .ctx_handshake_is_over = picotls_handshake_is_over,
610 .ctx_start_listen = picotls_start_listen,
611 .ctx_stop_listen = picotls_stop_listen,
612 .ctx_init_server = picotls_ctx_init_server,
613 .ctx_init_client = picotls_ctx_init_client,
614 .ctx_read = picotls_ctx_read,
615 .ctx_write = picotls_ctx_write,
616 .ctx_transport_close = picotls_transport_close,
617 .ctx_app_close = picotls_app_close,
620 static clib_error_t *
621 tls_picotls_init (vlib_main_t * vm)
623 vlib_thread_main_t *vtm = vlib_get_thread_main ();
624 picotls_main_t *pm = &picotls_main;
625 clib_error_t *error = 0;
628 num_threads = 1 + vtm->n_threads;
630 vec_validate (pm->ctx_pool, num_threads - 1);
632 clib_rwlock_init (&picotls_main.crypto_keys_rw_lock);
634 tls_register_engine (&picotls_engine, CRYPTO_ENGINE_PICOTLS);
636 picotls_init_client_ptls_ctx (&pm->client_ptls_ctx);
642 VLIB_INIT_FUNCTION (tls_picotls_init) = {
643 .runs_after = VLIB_INITS ("tls_init"),
648 VLIB_PLUGIN_REGISTER () = {
649 .version = VPP_BUILD_VER,
650 .description = "Transport Layer Security (TLS) Engine, Picotls Based",
655 * fd.io coding-style-patch-verification: ON
658 * eval: (c-set-style "gnu")