4 #include "tls_picotls.h"
5 #include "pico_vpp_crypto.h"
7 picotls_main_t picotls_main;
9 #define MAX_QUEUE 12000
10 #define PTLS_MAX_PLAINTEXT_RECORD_SIZE 16384
13 picotls_ctx_alloc (void)
15 u8 thread_id = vlib_get_thread_index ();
16 picotls_main_t *pm = &picotls_main;
19 pool_get (pm->ctx_pool[thread_id], ctx);
21 *ctx = clib_mem_alloc (sizeof (picotls_ctx_t));
23 clib_memset (*ctx, 0, sizeof (picotls_ctx_t));
24 (*ctx)->ctx.c_thread_index = thread_id;
25 (*ctx)->ctx.tls_ctx_engine = CRYPTO_ENGINE_PICOTLS;
26 (*ctx)->ctx.app_session_handle = SESSION_INVALID_HANDLE;
27 (*ctx)->ptls_ctx_idx = ctx - pm->ctx_pool[thread_id];
28 return (*ctx)->ptls_ctx_idx;
32 picotls_ctx_free (tls_ctx_t * ctx)
34 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
35 free (ptls_ctx->rx_content);
36 pool_put_index (picotls_main.ctx_pool[ctx->c_thread_index],
37 ptls_ctx->ptls_ctx_idx);
41 picotls_listen_ctx_alloc (void)
43 picotls_main_t *pm = &picotls_main;
44 picotls_listen_ctx_t *ptls_lctx;
46 pool_get (pm->lctx_pool, ptls_lctx);
48 clib_memset (ptls_lctx, 0, sizeof (picotls_listen_ctx_t));
49 ptls_lctx->ptls_lctx_index = ptls_lctx - pm->lctx_pool;
50 return ptls_lctx->ptls_lctx_index;
54 picotls_listen_ctx_free (picotls_listen_ctx_t * lctx)
56 pool_put_index (picotls_main.lctx_pool, lctx->ptls_lctx_index);
60 picotls_ctx_get (u32 ctx_index)
64 pool_elt_at_index (picotls_main.ctx_pool[vlib_get_thread_index ()],
69 picotls_listen_ctx_t *
70 picotls_lctx_get (u32 lctx_index)
72 return pool_elt_at_index (picotls_main.lctx_pool, lctx_index);
76 picotls_handshake_is_over (tls_ctx_t * ctx)
78 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
79 assert (ptls_ctx->tls);
80 return ptls_handshake_is_complete (ptls_ctx->tls);
84 picotls_try_handshake_write (picotls_ctx_t * ptls_ctx,
85 session_t * tls_session, ptls_buffer_t * buf)
94 f = tls_session->tx_fifo;
96 enq_max = svm_fifo_max_enqueue_prod (f);
100 enq_now = clib_min (svm_fifo_max_write_chunk (f), enq_max);
101 enq_now = clib_min (enq_now, buf_left);
102 write = svm_fifo_enqueue (f, enq_now, buf->base);
104 tls_add_vpp_q_tx_evt (tls_session);
109 picotls_start_listen (tls_ctx_t * lctx)
111 picotls_listen_ctx_t *ptls_lctx;
112 ptls_context_t *ptls_ctx;
114 app_cert_key_pair_t *ckpair;
115 static ptls_key_exchange_algorithm_t *key_exchange[] = {
116 #ifdef PTLS_OPENSSL_HAVE_X25519
117 &ptls_openssl_x25519,
119 #ifdef PTLS_OPENSSL_HAVE_SECP256r1
120 &ptls_openssl_secp256r1,
122 #ifdef PTLS_OPENSSL_HAVE_SECP384r1
123 &ptls_openssl_secp384r1,
125 #ifdef PTLS_OPENSSL_HAVE_SECP521r1
126 &ptls_openssl_secp521r1
130 ckpair = app_cert_key_pair_get_if_valid (lctx->ckpair_index);
131 if (!ckpair || !ckpair->cert || !ckpair->key)
133 TLS_DBG (1, "tls cert and/or key not configured %d",
134 lctx->parent_app_wrk_index);
138 ptls_lctx_idx = picotls_listen_ctx_alloc ();
139 ptls_lctx = picotls_lctx_get (ptls_lctx_idx);
140 ptls_ctx = malloc (sizeof (ptls_context_t));
141 ptls_lctx->ptls_ctx = ptls_ctx;
143 memset (ptls_ctx, 0, sizeof (ptls_context_t));
144 ptls_ctx->update_open_count = NULL;
147 * Process certificate & private key.
149 load_bio_certificate_chain (ptls_ctx, (char *) ckpair->cert);
150 load_bio_private_key (ptls_ctx, (char *) ckpair->key);
152 /* setup protocol related functions */
153 ptls_ctx->key_exchanges = key_exchange;
154 ptls_ctx->random_bytes = ptls_openssl_random_bytes;
155 ptls_ctx->cipher_suites = ptls_vpp_crypto_cipher_suites;
156 ptls_ctx->get_time = &ptls_get_time;
158 lctx->tls_ssl_ctx = ptls_lctx_idx;
164 picotls_stop_listen (tls_ctx_t * lctx)
167 picotls_listen_ctx_t *ptls_lctx;
169 ptls_lctx_index = lctx->tls_ssl_ctx;
170 ptls_lctx = picotls_lctx_get (ptls_lctx_index);
172 picotls_listen_ctx_free (ptls_lctx);
178 picotls_handle_handshake_failure (tls_ctx_t * ctx)
180 session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
181 ctx->no_app_session = 1;
182 ctx->c_s_index = SESSION_INVALID_INDEX;
183 tls_disconnect_transport (ctx);
187 picotls_confirm_app_close (tls_ctx_t * ctx)
189 tls_disconnect_transport (ctx);
190 session_transport_closed_notify (&ctx->connection);
194 picotls_transport_close (tls_ctx_t * ctx)
196 if (!picotls_handshake_is_over (ctx))
198 picotls_handle_handshake_failure (ctx);
201 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
202 ptls_free (ptls_ctx->tls);
203 session_transport_closed_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 * tls_session,
223 u8 * input, int input_len)
225 ptls_t *tls = ptls_ctx->tls;
227 int rv = PTLS_ERROR_IN_PROGRESS;
235 ptls_buffer_init (&buf, "", 0);
236 size_t consumed = input_len - off;
237 rv = ptls_handshake (tls, &buf, input + off, &consumed, NULL);
239 ptls_ctx->rx_offset += consumed;
240 if ((rv == 0 || rv == PTLS_ERROR_IN_PROGRESS) && buf.off != 0)
242 write = picotls_try_handshake_write (ptls_ctx, tls_session,
245 ptls_buffer_dispose (&buf);
247 while (rv == PTLS_ERROR_IN_PROGRESS && input_len != off);
249 while (rv == PTLS_ERROR_IN_PROGRESS);
255 picotls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
257 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
258 int from_tls_len = 0, to_app_len = 0, off, crypto_len, ret;
259 u32 deq_max, deq_now;
260 u32 enq_max, enq_now;
261 ptls_buffer_t _buf, *buf = &_buf;
262 svm_fifo_t *tls_rx_fifo, *app_rx_fifo;
263 session_t *app_session;
265 tls_rx_fifo = tls_session->rx_fifo;
267 if (!picotls_handshake_is_over (ctx))
269 deq_max = svm_fifo_max_dequeue_cons (tls_rx_fifo);
270 deq_now = clib_min (deq_max, svm_fifo_max_read_chunk (tls_rx_fifo));
274 off = svm_fifo_dequeue (tls_rx_fifo, deq_now, TLS_RX_LEN (ptls_ctx));
276 ptls_ctx->rx_len += off;
277 if (from_tls_len <= 0)
279 tls_add_vpp_q_builtin_rx_evt (tls_session);
282 if (from_tls_len < deq_max)
284 deq_now = clib_min (svm_fifo_max_read_chunk (tls_rx_fifo),
285 deq_max - from_tls_len);
286 off = svm_fifo_dequeue (tls_rx_fifo, deq_now,
287 TLS_RX_LEN (ptls_ctx));
289 ptls_ctx->rx_len += off;
291 picotls_do_handshake (ptls_ctx, tls_session, TLS_RX_OFFSET (ptls_ctx),
293 if (picotls_handshake_is_over (ctx))
294 tls_notify_app_accept (ctx);
297 if (!TLS_RX_IS_LEFT (ptls_ctx))
301 app_session = session_get_from_handle (ctx->app_session_handle);
302 app_rx_fifo = app_session->rx_fifo;
304 ptls_buffer_init (buf, "", 0);
306 if (!TLS_RX_IS_LEFT (ptls_ctx))
308 deq_max = svm_fifo_max_dequeue_cons (tls_rx_fifo);
312 deq_now = clib_min (deq_max, svm_fifo_max_read_chunk (tls_rx_fifo));
314 off = svm_fifo_dequeue (tls_rx_fifo, deq_now, TLS_RX_LEN (ptls_ctx));
316 ptls_ctx->rx_len += off;
318 if (from_tls_len < deq_max)
321 clib_min (svm_fifo_max_read_chunk (tls_rx_fifo),
322 deq_max - from_tls_len);
324 svm_fifo_dequeue (tls_rx_fifo, deq_now, TLS_RX_LEN (ptls_ctx));
326 ptls_ctx->rx_len += off;
329 if (from_tls_len < deq_max)
330 tls_add_vpp_q_builtin_rx_evt (tls_session);
335 enq_max = svm_fifo_max_enqueue_prod (app_rx_fifo);
338 tls_add_vpp_q_builtin_rx_evt (tls_session);
342 crypto_len = clib_min (enq_max, TLS_RX_LEFT_LEN (ptls_ctx));
347 size_t consumed = crypto_len - off;
349 ptls_receive (ptls_ctx->tls, buf,
350 TLS_RX_OFFSET (ptls_ctx), &consumed);
352 ptls_ctx->rx_offset += off;
354 while (ret == 0 && off < crypto_len);
358 enq_now = clib_min (buf->off, svm_fifo_max_write_chunk (app_rx_fifo));
359 to_app_len = svm_fifo_enqueue (app_rx_fifo, enq_now, buf->base);
360 if (to_app_len < buf->off)
363 clib_min (svm_fifo_max_write_chunk (app_rx_fifo),
364 buf->off - to_app_len);
366 svm_fifo_enqueue (app_rx_fifo, enq_now, buf->base + to_app_len);
368 if (ptls_ctx->rx_len != 0 && !TLS_RX_IS_LEFT (ptls_ctx))
370 ptls_ctx->rx_len = 0;
371 ptls_ctx->rx_offset = 0;
377 ptls_buffer_dispose (buf);
379 if (app_session->session_state >= SESSION_STATE_READY)
380 tls_notify_app_enqueue (ctx, app_session);
382 if (TLS_RX_IS_LEFT (ptls_ctx))
383 tls_add_vpp_q_builtin_rx_evt (tls_session);
389 picotls_content_process (ptls_t * tls, svm_fifo_t * src_fifo,
390 svm_fifo_t * dst_fifo, int content_len,
391 int total_record_overhead, int is_no_copy)
393 ptls_buffer_t _buf, *buf = &_buf;
394 int total_length = content_len + total_record_overhead;
398 ptls_buffer_init (buf, svm_fifo_tail (dst_fifo), total_length);
399 ptls_send (tls, buf, svm_fifo_head (src_fifo), content_len);
401 assert (!buf->is_allocated);
402 assert (buf->base == svm_fifo_tail (dst_fifo));
404 svm_fifo_dequeue_drop (src_fifo, content_len);
405 svm_fifo_enqueue_nocopy (dst_fifo, buf->off);
406 to_dst_len = buf->off;
410 uint8_t *buf_content = malloc (total_length);
411 ptls_buffer_init (buf, buf_content, total_length);
413 ptls_send (tls, buf, svm_fifo_head (src_fifo), content_len);
414 svm_fifo_dequeue_drop (src_fifo, content_len);
416 to_dst_len = svm_fifo_enqueue (dst_fifo, buf->off, buf->base);
417 if (to_dst_len < buf->off)
419 svm_fifo_enqueue (dst_fifo, buf->off - to_dst_len,
420 buf->base + to_dst_len);
421 ptls_buffer_dispose (buf);
427 picotls_ctx_write (tls_ctx_t * ctx, session_t * app_session)
429 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
430 u32 deq_max, deq_now;
431 u32 enq_max, enq_now;
432 int from_app_len = 0, to_tls_len = 0, is_nocopy = 0;
433 svm_fifo_t *tls_tx_fifo, *app_tx_fifo;
434 session_t *tls_session;
436 int record_overhead = ptls_get_record_overhead (ptls_ctx->tls);
437 int num_records, total_overhead;
439 tls_session = session_get_from_handle (ctx->tls_session_handle);
440 tls_tx_fifo = tls_session->tx_fifo;
441 app_tx_fifo = app_session->tx_fifo;
443 deq_max = svm_fifo_max_dequeue_cons (app_tx_fifo);
446 deq_now = clib_min (deq_max, svm_fifo_max_read_chunk (app_tx_fifo));
448 enq_max = svm_fifo_max_enqueue_prod (tls_tx_fifo);
450 /** There is no engough enqueue space for one record **/
451 if (enq_max < record_overhead)
453 tls_add_vpp_q_builtin_tx_evt (app_session);
457 enq_now = clib_min (enq_max, svm_fifo_max_write_chunk (tls_tx_fifo));
459 /** Allowed to execute no-copy crypto operation **/
460 if (enq_now > record_overhead)
463 from_app_len = clib_min (deq_now, enq_now);
465 ceil ((f64) from_app_len / PTLS_MAX_PLAINTEXT_RECORD_SIZE);
466 total_overhead = num_records * record_overhead;
467 if (from_app_len + total_overhead > enq_now)
468 from_app_len = enq_now - total_overhead;
474 from_app_len = clib_min (deq_now, enq_max);
476 ceil ((f64) from_app_len / PTLS_MAX_PLAINTEXT_RECORD_SIZE);
477 total_overhead = num_records * record_overhead;
478 if (from_app_len + total_overhead > enq_max)
479 from_app_len = enq_max - total_overhead;
484 picotls_content_process (ptls_ctx->tls, app_tx_fifo, tls_tx_fifo,
485 from_app_len, total_overhead, is_nocopy);
487 if (svm_fifo_needs_deq_ntf (app_tx_fifo, from_app_len))
488 session_dequeue_notify (app_session);
491 tls_add_vpp_q_tx_evt (tls_session);
493 if (from_app_len < deq_max)
494 tls_add_vpp_q_builtin_tx_evt (app_session);
497 picotls_app_close (ctx);
503 picotls_ctx_init_server (tls_ctx_t * ctx)
505 picotls_ctx_t *ptls_ctx = (picotls_ctx_t *) ctx;
506 u32 ptls_lctx_idx = ctx->tls_ssl_ctx;
507 picotls_listen_ctx_t *ptls_lctx;
509 ptls_lctx = picotls_lctx_get (ptls_lctx_idx);
510 ptls_ctx->tls = ptls_new (ptls_lctx->ptls_ctx, 1);
511 if (ptls_ctx->tls == NULL)
513 TLS_DBG (1, "Failed to initialize ptls_ssl structure");
517 ptls_ctx->rx_len = 0;
518 ptls_ctx->rx_offset = 0;
520 ptls_ctx->rx_content = malloc (MAX_QUEUE);
526 picotls_ctx_get_w_thread (u32 ctx_index, u8 thread_index)
529 ctx = pool_elt_at_index (picotls_main.ctx_pool[thread_index], ctx_index);
533 const static tls_engine_vft_t picotls_engine = {
534 .ctx_alloc = picotls_ctx_alloc,
535 .ctx_free = picotls_ctx_free,
536 .ctx_get = picotls_ctx_get,
537 .ctx_get_w_thread = picotls_ctx_get_w_thread,
538 .ctx_handshake_is_over = picotls_handshake_is_over,
539 .ctx_start_listen = picotls_start_listen,
540 .ctx_stop_listen = picotls_stop_listen,
541 .ctx_init_server = picotls_ctx_init_server,
542 .ctx_read = picotls_ctx_read,
543 .ctx_write = picotls_ctx_write,
544 .ctx_transport_close = picotls_transport_close,
545 .ctx_app_close = picotls_app_close,
548 static clib_error_t *
549 tls_picotls_init (vlib_main_t * vm)
551 vlib_thread_main_t *vtm = vlib_get_thread_main ();
552 picotls_main_t *pm = &picotls_main;
553 clib_error_t *error = 0;
556 num_threads = 1 + vtm->n_threads;
558 vec_validate (pm->ctx_pool, num_threads - 1);
560 tls_register_engine (&picotls_engine, CRYPTO_ENGINE_PICOTLS);
566 VLIB_INIT_FUNCTION (tls_picotls_init) = {
567 .runs_after = VLIB_INITS ("tls_init"),
572 VLIB_PLUGIN_REGISTER () = {
573 .version = VPP_BUILD_VER,
574 .description = "Transport Layer Security (TLS) Engine, Picotls Based",
579 * fd.io coding-style-patch-verification: ON
582 * eval: (c-set-style "gnu")