tls quic: improve error reporting
[vpp.git] / src / vnet / tls / tls.c
1 /*
2  * Copyright (c) 2018-2019 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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15
16 #include <vnet/session/application_interface.h>
17 #include <vppinfra/lock.h>
18 #include <vnet/tls/tls.h>
19
20 static tls_main_t tls_main;
21 static tls_engine_vft_t *tls_vfts;
22
23 #define TLS_INVALID_HANDLE      ~0
24 #define TLS_IDX_MASK            0x00FFFFFF
25 #define TLS_ENGINE_TYPE_SHIFT   29
26
27 void tls_disconnect (u32 ctx_handle, u32 thread_index);
28
29 void
30 tls_disconnect_transport (tls_ctx_t * ctx)
31 {
32   vnet_disconnect_args_t a = {
33     .handle = ctx->tls_session_handle,
34     .app_index = tls_main.app_index,
35   };
36
37   if (vnet_disconnect_session (&a))
38     clib_warning ("disconnect returned");
39 }
40
41 crypto_engine_type_t
42 tls_get_available_engine (void)
43 {
44   int i;
45   for (i = 0; i < vec_len (tls_vfts); i++)
46     {
47       if (tls_vfts[i].ctx_alloc)
48         return i;
49     }
50   return CRYPTO_ENGINE_NONE;
51 }
52
53 int
54 tls_add_vpp_q_rx_evt (session_t * s)
55 {
56   if (svm_fifo_set_event (s->rx_fifo))
57     session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_RX);
58   return 0;
59 }
60
61 int
62 tls_add_vpp_q_builtin_rx_evt (session_t * s)
63 {
64   if (svm_fifo_set_event (s->rx_fifo))
65     session_send_io_evt_to_thread (s->rx_fifo, SESSION_IO_EVT_BUILTIN_RX);
66   return 0;
67 }
68
69 int
70 tls_add_vpp_q_tx_evt (session_t * s)
71 {
72   if (svm_fifo_set_event (s->tx_fifo))
73     session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
74   return 0;
75 }
76
77 static inline int
78 tls_add_app_q_evt (app_worker_t * app, session_t * app_session)
79 {
80   return app_worker_lock_and_send_event (app, app_session, SESSION_IO_EVT_RX);
81 }
82
83 u32
84 tls_listener_ctx_alloc (void)
85 {
86   tls_main_t *tm = &tls_main;
87   tls_ctx_t *ctx;
88
89   pool_get (tm->listener_ctx_pool, ctx);
90   clib_memset (ctx, 0, sizeof (*ctx));
91   return ctx - tm->listener_ctx_pool;
92 }
93
94 void
95 tls_listener_ctx_free (tls_ctx_t * ctx)
96 {
97   if (CLIB_DEBUG)
98     memset (ctx, 0xfb, sizeof (*ctx));
99   pool_put (tls_main.listener_ctx_pool, ctx);
100 }
101
102 tls_ctx_t *
103 tls_listener_ctx_get (u32 ctx_index)
104 {
105   return pool_elt_at_index (tls_main.listener_ctx_pool, ctx_index);
106 }
107
108 u32
109 tls_listener_ctx_index (tls_ctx_t * ctx)
110 {
111   return (ctx - tls_main.listener_ctx_pool);
112 }
113
114 u32
115 tls_ctx_half_open_alloc (void)
116 {
117   tls_main_t *tm = &tls_main;
118   u8 will_expand = 0;
119   tls_ctx_t *ctx;
120   u32 ctx_index;
121
122   pool_get_aligned_will_expand (tm->half_open_ctx_pool, will_expand, 0);
123   if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
124     {
125       clib_rwlock_writer_lock (&tm->half_open_rwlock);
126       pool_get (tm->half_open_ctx_pool, ctx);
127       ctx_index = ctx - tm->half_open_ctx_pool;
128       clib_rwlock_writer_unlock (&tm->half_open_rwlock);
129     }
130   else
131     {
132       /* reader lock assumption: only main thread will call pool_get */
133       clib_rwlock_reader_lock (&tm->half_open_rwlock);
134       pool_get (tm->half_open_ctx_pool, ctx);
135       ctx_index = ctx - tm->half_open_ctx_pool;
136       clib_rwlock_reader_unlock (&tm->half_open_rwlock);
137     }
138   clib_memset (ctx, 0, sizeof (*ctx));
139   return ctx_index;
140 }
141
142 void
143 tls_ctx_half_open_free (u32 ho_index)
144 {
145   tls_main_t *tm = &tls_main;
146   clib_rwlock_writer_lock (&tm->half_open_rwlock);
147   pool_put_index (tls_main.half_open_ctx_pool, ho_index);
148   clib_rwlock_writer_unlock (&tm->half_open_rwlock);
149 }
150
151 tls_ctx_t *
152 tls_ctx_half_open_get (u32 ctx_index)
153 {
154   tls_main_t *tm = &tls_main;
155   clib_rwlock_reader_lock (&tm->half_open_rwlock);
156   return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
157 }
158
159 void
160 tls_ctx_half_open_reader_unlock ()
161 {
162   clib_rwlock_reader_unlock (&tls_main.half_open_rwlock);
163 }
164
165 u32
166 tls_ctx_half_open_index (tls_ctx_t * ctx)
167 {
168   return (ctx - tls_main.half_open_ctx_pool);
169 }
170
171 void
172 tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
173 {
174   app_worker_t *app_wrk;
175   app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
176   if (PREDICT_TRUE (app_wrk != 0))
177     tls_add_app_q_evt (app_wrk, app_session);
178 }
179
180 int
181 tls_notify_app_accept (tls_ctx_t * ctx)
182 {
183   session_t *app_listener, *app_session;
184   app_worker_t *app_wrk;
185   tls_ctx_t *lctx;
186   int rv;
187
188   lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
189   app_listener = listen_session_get_from_handle (lctx->app_session_handle);
190
191   app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
192   app_session->app_wrk_index = ctx->parent_app_wrk_index;
193   app_session->connection_index = ctx->tls_ctx_handle;
194   app_session->session_type = app_listener->session_type;
195   app_session->listener_handle = listen_session_get_handle (app_listener);
196   app_session->session_state = SESSION_STATE_ACCEPTING;
197
198   if ((rv = app_worker_init_accepted (app_session)))
199     {
200       TLS_DBG (1, "failed to allocate fifos");
201       session_free (app_session);
202       return rv;
203     }
204   ctx->app_session_handle = session_handle (app_session);
205   ctx->parent_app_wrk_index = app_session->app_wrk_index;
206   app_wrk = app_worker_get (app_session->app_wrk_index);
207   return app_worker_accept_notify (app_wrk, app_session);
208 }
209
210 int
211 tls_notify_app_connected (tls_ctx_t * ctx, session_error_t err)
212 {
213   session_t *app_session;
214   app_worker_t *app_wrk;
215
216   app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
217   if (!app_wrk)
218     {
219       tls_disconnect_transport (ctx);
220       return -1;
221     }
222
223   if (err)
224     {
225       /* Free app session pre-allocated when transport was established */
226       if (ctx->tls_type == TRANSPORT_PROTO_TLS)
227         session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
228       goto failed;
229     }
230
231   /* For DTLS the app session is not preallocated because the underlying udp
232    * session might migrate to a different worker during the handshake */
233   if (ctx->tls_type == TRANSPORT_PROTO_DTLS)
234     {
235       session_type_t st;
236       app_session = session_alloc (ctx->c_thread_index);
237       app_session->session_state = SESSION_STATE_CREATED;
238       ctx->c_s_index = app_session->session_index;
239       st =
240         session_type_from_proto_and_ip (TRANSPORT_PROTO_DTLS, ctx->tcp_is_ip4);
241       app_session->session_type = st;
242       app_session->connection_index = ctx->tls_ctx_handle;
243     }
244   else
245     {
246       app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
247     }
248
249   app_session->app_wrk_index = ctx->parent_app_wrk_index;
250
251   if ((err = app_worker_init_connected (app_wrk, app_session)))
252     goto failed;
253
254   app_session->session_state = SESSION_STATE_READY;
255   if (app_worker_connect_notify (app_wrk, app_session,
256                                  SESSION_E_NONE, ctx->parent_app_api_context))
257     {
258       TLS_DBG (1, "failed to notify app");
259       app_session->session_state = SESSION_STATE_CONNECTING;
260       tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
261       return -1;
262     }
263
264   ctx->app_session_handle = session_handle (app_session);
265
266   return 0;
267
268 failed:
269   ctx->no_app_session = 1;
270   tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
271   return app_worker_connect_notify (app_wrk, 0, err,
272                                     ctx->parent_app_api_context);
273 }
274
275 static inline void
276 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
277 {
278   *ctx_index = ctx_handle & TLS_IDX_MASK;
279   *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
280 }
281
282 static inline crypto_engine_type_t
283 tls_get_engine_type (crypto_engine_type_t requested,
284                      crypto_engine_type_t preferred)
285 {
286   if (requested != CRYPTO_ENGINE_NONE)
287     {
288       if (tls_vfts[requested].ctx_alloc)
289         return requested;
290       return CRYPTO_ENGINE_NONE;
291     }
292   if (!tls_vfts[preferred].ctx_alloc)
293     return tls_get_available_engine ();
294   return preferred;
295 }
296
297 static inline u32
298 tls_ctx_alloc (crypto_engine_type_t engine_type)
299 {
300   u32 ctx_index;
301   ctx_index = tls_vfts[engine_type].ctx_alloc ();
302   return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
303 }
304
305 static inline u32
306 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
307 {
308   u32 ctx_index;
309   ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
310   return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
311 }
312
313 static inline u32
314 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
315 {
316   u32 ctx_index;
317   ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
318   return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
319 }
320
321 static inline void *
322 tls_ctx_detach (tls_ctx_t *ctx)
323 {
324   return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
325 }
326
327 static inline tls_ctx_t *
328 tls_ctx_get (u32 ctx_handle)
329 {
330   u32 ctx_index, engine_type;
331   tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
332   return tls_vfts[engine_type].ctx_get (ctx_index);
333 }
334
335 static inline tls_ctx_t *
336 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
337 {
338   u32 ctx_index, engine_type;
339   tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
340   return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
341 }
342
343 static inline int
344 tls_ctx_init_server (tls_ctx_t * ctx)
345 {
346   return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
347 }
348
349 static inline int
350 tls_ctx_init_client (tls_ctx_t * ctx)
351 {
352   return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
353 }
354
355 static inline int
356 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
357                transport_send_params_t * sp)
358 {
359   u32 n_wrote;
360
361   sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
362   n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
363   sp->max_burst_size = n_wrote;
364   return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
365 }
366
367 static inline int
368 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
369 {
370   return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
371 }
372
373 static inline int
374 tls_ctx_transport_close (tls_ctx_t * ctx)
375 {
376   return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
377 }
378
379 static inline int
380 tls_ctx_app_close (tls_ctx_t * ctx)
381 {
382   return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
383 }
384
385 void
386 tls_ctx_free (tls_ctx_t * ctx)
387 {
388   tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
389 }
390
391 u8
392 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
393 {
394   return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
395 }
396
397 void
398 tls_session_reset_callback (session_t * s)
399 {
400   tls_ctx_t *ctx;
401   transport_connection_t *tc;
402   session_t *app_session;
403
404   ctx = tls_ctx_get (s->opaque);
405   ctx->is_passive_close = 1;
406   tc = &ctx->connection;
407   if (tls_ctx_handshake_is_over (ctx))
408     {
409       session_transport_reset_notify (tc);
410       session_transport_closed_notify (tc);
411       tls_disconnect_transport (ctx);
412     }
413   else
414     if ((app_session =
415          session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
416     {
417       session_free (app_session);
418       ctx->c_s_index = SESSION_INVALID_INDEX;
419       tls_disconnect_transport (ctx);
420     }
421 }
422
423 int
424 tls_add_segment_callback (u32 client_index, u64 segment_handle)
425 {
426   /* No-op for builtin */
427   return 0;
428 }
429
430 int
431 tls_del_segment_callback (u32 client_index, u64 segment_handle)
432 {
433   return 0;
434 }
435
436 void
437 tls_session_disconnect_callback (session_t * tls_session)
438 {
439   tls_ctx_t *ctx;
440
441   TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
442            tls_session->session_index);
443
444   ASSERT (tls_session->thread_index == vlib_get_thread_index ()
445           || vlib_thread_is_main_w_barrier ());
446
447   ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
448   ctx->is_passive_close = 1;
449   tls_ctx_transport_close (ctx);
450 }
451
452 int
453 tls_session_accept_callback (session_t * tls_session)
454 {
455   session_t *tls_listener, *app_session;
456   tls_ctx_t *lctx, *ctx;
457   u32 ctx_handle;
458
459   tls_listener =
460     listen_session_get_from_handle (tls_session->listener_handle);
461   lctx = tls_listener_ctx_get (tls_listener->opaque);
462
463   ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
464   ctx = tls_ctx_get (ctx_handle);
465   memcpy (ctx, lctx, sizeof (*lctx));
466   ctx->c_thread_index = vlib_get_thread_index ();
467   ctx->tls_ctx_handle = ctx_handle;
468   tls_session->session_state = SESSION_STATE_READY;
469   tls_session->opaque = ctx_handle;
470   ctx->tls_session_handle = session_handle (tls_session);
471   ctx->listener_ctx_index = tls_listener->opaque;
472   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
473   ctx->ckpair_index = lctx->ckpair_index;
474
475   /* Preallocate app session. Avoids allocating a session post handshake
476    * on tls_session rx and potentially invalidating the session pool */
477   app_session = session_alloc (ctx->c_thread_index);
478   app_session->session_state = SESSION_STATE_CREATED;
479   ctx->c_s_index = app_session->session_index;
480
481   TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
482            tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
483
484   return tls_ctx_init_server (ctx);
485 }
486
487 int
488 tls_app_rx_callback (session_t * tls_session)
489 {
490   tls_ctx_t *ctx;
491
492   /* DTLS session migrating, wait for next notification */
493   if (PREDICT_FALSE (tls_session->flags & SESSION_F_IS_MIGRATING))
494     return 0;
495
496   ctx = tls_ctx_get (tls_session->opaque);
497   tls_ctx_read (ctx, tls_session);
498   return 0;
499 }
500
501 int
502 tls_app_tx_callback (session_t * tls_session)
503 {
504   tls_ctx_t *ctx;
505
506   ctx = tls_ctx_get (tls_session->opaque);
507   transport_connection_reschedule (&ctx->connection);
508
509   return 0;
510 }
511
512 int
513 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
514                           session_t *tls_session, session_error_t err)
515 {
516   session_t *app_session;
517   tls_ctx_t *ho_ctx, *ctx;
518   session_type_t st;
519   u32 ctx_handle;
520
521   ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
522
523   if (err)
524     {
525       app_worker_t *app_wrk;
526       u32 api_context;
527       int rv = 0;
528
529       app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
530       if (app_wrk)
531         {
532           api_context = ho_ctx->parent_app_api_context;
533           app_worker_connect_notify (app_wrk, 0, err, api_context);
534         }
535       tls_ctx_half_open_reader_unlock ();
536       tls_ctx_half_open_free (ho_ctx_index);
537       return rv;
538     }
539
540   ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
541   ctx = tls_ctx_get (ctx_handle);
542   clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
543   tls_ctx_half_open_reader_unlock ();
544   tls_ctx_half_open_free (ho_ctx_index);
545
546   ctx->c_thread_index = vlib_get_thread_index ();
547   ctx->tls_ctx_handle = ctx_handle;
548   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
549
550   TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
551            ho_ctx_index, err, vlib_get_thread_index (),
552            (ctx) ? ctx_handle : ~0);
553
554   ctx->tls_session_handle = session_handle (tls_session);
555   tls_session->opaque = ctx_handle;
556   tls_session->session_state = SESSION_STATE_READY;
557
558   /* Preallocate app session. Avoids allocating a session post handshake
559    * on tls_session rx and potentially invalidating the session pool */
560   app_session = session_alloc (ctx->c_thread_index);
561   app_session->session_state = SESSION_STATE_CREATED;
562   ctx->c_s_index = app_session->session_index;
563   st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
564   app_session->session_type = st;
565   app_session->connection_index = ctx->tls_ctx_handle;
566
567   return tls_ctx_init_client (ctx);
568 }
569
570 int
571 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
572                            session_error_t err)
573 {
574   tls_ctx_t *ctx;
575
576   ctx = tls_ctx_get_w_thread (ctx_handle, 1 /* udp allocs on thread 1 */);
577
578   ctx->tls_session_handle = session_handle (us);
579   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
580   us->opaque = ctx_handle;
581
582   /* We don't preallocate the app session because the udp session might
583    * actually migrate to a different worker at the end of the handshake */
584
585   return tls_ctx_init_client (ctx);
586 }
587
588 int
589 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
590                                 session_t *tls_session, session_error_t err)
591 {
592   if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
593     return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
594                                      err);
595   else
596     return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
597                                       err);
598 }
599
600 static void
601 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
602 {
603   tls_ctx_t *ctx;
604
605   if (ntf == SESSION_CLEANUP_TRANSPORT)
606     {
607       /* Allow cleanup of tcp session */
608       if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
609         session_close (s);
610       return;
611     }
612
613   ctx = tls_ctx_get (s->opaque);
614   if (!ctx->no_app_session)
615     session_transport_delete_notify (&ctx->connection);
616   tls_ctx_free (ctx);
617 }
618
619 static void
620 dtls_migrate_udp (void *arg)
621 {
622   tls_ctx_t *ctx = (tls_ctx_t *) arg;
623   u32 ctx_handle, thread_index;
624   session_t *us;
625
626   thread_index = session_thread_from_handle (ctx->tls_session_handle);
627   ASSERT (thread_index == vlib_get_thread_index ());
628
629   ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
630   ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
631   ctx->tls_ctx_handle = ctx_handle;
632
633   us = session_get_from_handle (ctx->tls_session_handle);
634   us->opaque = ctx_handle;
635   us->flags &= ~SESSION_F_IS_MIGRATING;
636   if (svm_fifo_max_dequeue (us->tx_fifo))
637     session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
638 }
639
640 static void
641 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
642 {
643   u32 new_thread = session_thread_from_handle (new_sh);
644   tls_ctx_t *ctx;
645
646   /* Migrate dtls context to new thread */
647   ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
648   ctx->tls_session_handle = new_sh;
649   ctx = tls_ctx_detach (ctx);
650   ctx->is_migrated = 1;
651
652   session_send_rpc_evt_to_thread (new_thread, dtls_migrate_udp, (void *) ctx);
653 }
654
655 static session_cb_vft_t tls_app_cb_vft = {
656   .session_accept_callback = tls_session_accept_callback,
657   .session_disconnect_callback = tls_session_disconnect_callback,
658   .session_connected_callback = tls_session_connected_callback,
659   .session_reset_callback = tls_session_reset_callback,
660   .add_segment_callback = tls_add_segment_callback,
661   .del_segment_callback = tls_del_segment_callback,
662   .builtin_app_rx_callback = tls_app_rx_callback,
663   .builtin_app_tx_callback = tls_app_tx_callback,
664   .session_migrate_callback = dtls_session_migrate_callback,
665   .session_cleanup_callback = tls_app_session_cleanup,
666 };
667
668 int
669 tls_connect (transport_endpoint_cfg_t * tep)
670 {
671   vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
672   transport_endpt_crypto_cfg_t *ccfg;
673   crypto_engine_type_t engine_type;
674   session_endpoint_cfg_t *sep;
675   tls_main_t *tm = &tls_main;
676   app_worker_t *app_wrk;
677   application_t *app;
678   tls_ctx_t *ctx;
679   u32 ctx_index;
680   int rv;
681
682   sep = (session_endpoint_cfg_t *) tep;
683   if (!sep->ext_cfg)
684     return SESSION_E_NOEXTCFG;
685
686   app_wrk = app_worker_get (sep->app_wrk_index);
687   app = application_get (app_wrk->app_index);
688
689   ccfg = &sep->ext_cfg->crypto;
690   engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
691   if (engine_type == CRYPTO_ENGINE_NONE)
692     {
693       clib_warning ("No tls engine_type available");
694       return SESSION_E_NOCRYPTOENG;
695     }
696
697   ctx_index = tls_ctx_half_open_alloc ();
698   ctx = tls_ctx_half_open_get (ctx_index);
699   ctx->parent_app_wrk_index = sep->app_wrk_index;
700   ctx->parent_app_api_context = sep->opaque;
701   ctx->tcp_is_ip4 = sep->is_ip4;
702   ctx->tls_type = sep->transport_proto;
703   ctx->ckpair_index = ccfg->ckpair_index;
704   if (ccfg->hostname[0])
705     {
706       ctx->srv_hostname = format (0, "%s", ccfg->hostname);
707       vec_terminate_c_string (ctx->srv_hostname);
708     }
709   tls_ctx_half_open_reader_unlock ();
710
711   app_worker_alloc_connects_segment_manager (app_wrk);
712   ctx->tls_ctx_engine = engine_type;
713
714   clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
715   cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
716   cargs->app_index = tm->app_index;
717   cargs->api_context = ctx_index;
718   cargs->sep_ext.ns_index = app->ns_index;
719   if ((rv = vnet_connect (cargs)))
720     return rv;
721
722   TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
723   return 0;
724 }
725
726 void
727 tls_disconnect (u32 ctx_handle, u32 thread_index)
728 {
729   tls_ctx_t *ctx;
730
731   TLS_DBG (1, "Disconnecting %x", ctx_handle);
732
733   ctx = tls_ctx_get (ctx_handle);
734   tls_ctx_app_close (ctx);
735 }
736
737 u32
738 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
739 {
740   vnet_listen_args_t _bargs, *args = &_bargs;
741   transport_endpt_crypto_cfg_t *ccfg;
742   app_worker_t *app_wrk;
743   tls_main_t *tm = &tls_main;
744   session_handle_t tls_al_handle;
745   session_endpoint_cfg_t *sep;
746   session_t *tls_listener;
747   session_t *app_listener;
748   crypto_engine_type_t engine_type;
749   application_t *app;
750   app_listener_t *al;
751   tls_ctx_t *lctx;
752   u32 lctx_index;
753   int rv;
754
755   sep = (session_endpoint_cfg_t *) tep;
756   if (!sep->ext_cfg)
757     return SESSION_E_NOEXTCFG;
758
759   app_wrk = app_worker_get (sep->app_wrk_index);
760   app = application_get (app_wrk->app_index);
761
762   ccfg = &sep->ext_cfg->crypto;
763   engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
764   if (engine_type == CRYPTO_ENGINE_NONE)
765     {
766       clib_warning ("No tls engine_type available");
767       return SESSION_E_NOCRYPTOENG;
768     }
769
770   clib_memset (args, 0, sizeof (*args));
771   args->app_index = tm->app_index;
772   args->sep_ext = *sep;
773   args->sep_ext.ns_index = app->ns_index;
774   args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
775   if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
776     {
777       args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
778       args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
779     }
780   if ((rv = vnet_listen (args)))
781     return rv;
782
783   lctx_index = tls_listener_ctx_alloc ();
784   tls_al_handle = args->handle;
785   al = app_listener_get_w_handle (tls_al_handle);
786   tls_listener = app_listener_get_session (al);
787   tls_listener->opaque = lctx_index;
788
789   app_listener = listen_session_get (app_listener_index);
790
791   lctx = tls_listener_ctx_get (lctx_index);
792   lctx->parent_app_wrk_index = sep->app_wrk_index;
793   lctx->tls_session_handle = tls_al_handle;
794   lctx->app_session_handle = listen_session_get_handle (app_listener);
795   lctx->tcp_is_ip4 = sep->is_ip4;
796   lctx->tls_ctx_engine = engine_type;
797   lctx->tls_type = sep->transport_proto;
798   lctx->ckpair_index = ccfg->ckpair_index;
799
800   if (tls_vfts[engine_type].ctx_start_listen (lctx))
801     {
802       vnet_unlisten_args_t a = {
803         .handle = lctx->tls_session_handle,
804         .app_index = tls_main.app_index,
805         .wrk_map_index = 0
806       };
807       if ((vnet_unlisten (&a)))
808         clib_warning ("unlisten returned");
809       tls_listener_ctx_free (lctx);
810       lctx_index = SESSION_INVALID_INDEX;
811     }
812
813   TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
814            engine_type);
815   return lctx_index;
816 }
817
818 u32
819 tls_stop_listen (u32 lctx_index)
820 {
821   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
822   crypto_engine_type_t engine_type;
823   transport_connection_t *lc;
824   tls_ctx_t *lctx;
825   session_t *ls;
826   int rv;
827
828   lctx = tls_listener_ctx_get (lctx_index);
829
830   /* Cleanup listener from session lookup table */
831   ls = session_get_from_handle (lctx->tls_session_handle);
832   lc = session_get_transport (ls);
833
834   sep.fib_index = lc->fib_index;
835   sep.port = lc->lcl_port;
836   sep.is_ip4 = lc->is_ip4;
837   sep.transport_proto = lctx->tls_type;
838   clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
839   session_lookup_del_session_endpoint2 (&sep);
840
841   vnet_unlisten_args_t a = {
842     .handle = lctx->tls_session_handle,
843     .app_index = tls_main.app_index,
844     .wrk_map_index = 0          /* default wrk */
845   };
846   if ((rv = vnet_unlisten (&a)))
847     clib_warning ("unlisten returned %d", rv);
848
849   engine_type = lctx->tls_ctx_engine;
850   tls_vfts[engine_type].ctx_stop_listen (lctx);
851
852   tls_listener_ctx_free (lctx);
853   return 0;
854 }
855
856 transport_connection_t *
857 tls_connection_get (u32 ctx_index, u32 thread_index)
858 {
859   tls_ctx_t *ctx;
860   ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
861   return &ctx->connection;
862 }
863
864 transport_connection_t *
865 tls_listener_get (u32 listener_index)
866 {
867   tls_ctx_t *ctx;
868   ctx = tls_listener_ctx_get (listener_index);
869   return &ctx->connection;
870 }
871
872 int
873 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
874 {
875   session_t *app_session = (session_t *) session;
876   tls_ctx_t *ctx;
877
878   if (PREDICT_FALSE (app_session->session_state
879                      >= SESSION_STATE_TRANSPORT_CLOSED))
880     return 0;
881
882   sp->flags = 0;
883   ctx = tls_ctx_get (app_session->connection_index);
884   return tls_ctx_write (ctx, app_session, sp);
885 }
886
887 u8 *
888 format_tls_ctx (u8 * s, va_list * args)
889 {
890   u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
891   tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
892   char *proto;
893
894   proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
895   session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
896   tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
897   s =
898     format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
899             ctx->c_thread_index, ctx->c_s_index, proto,
900             ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
901
902   return s;
903 }
904
905 static u8 *
906 format_tls_listener_ctx (u8 * s, va_list * args)
907 {
908   session_t *tls_listener;
909   app_listener_t *al;
910   tls_ctx_t *ctx;
911   char *proto;
912
913   ctx = va_arg (*args, tls_ctx_t *);
914
915   proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
916   al = app_listener_get_w_handle (ctx->tls_session_handle);
917   tls_listener = app_listener_get_session (al);
918   s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
919               ctx->c_thread_index, ctx->c_s_index, proto,
920               ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
921               tls_listener->thread_index, tls_listener->session_index);
922
923   return s;
924 }
925
926 static u8 *
927 format_tls_ctx_state (u8 * s, va_list * args)
928 {
929   tls_ctx_t *ctx;
930   session_t *ts;
931
932   ctx = va_arg (*args, tls_ctx_t *);
933   ts = session_get (ctx->c_s_index, ctx->c_thread_index);
934   if (ts->session_state == SESSION_STATE_LISTENING)
935     s = format (s, "%s", "LISTEN");
936   else
937     {
938       if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
939         s = format (s, "%s", "CLOSED");
940       else if (ts->session_state == SESSION_STATE_APP_CLOSED)
941         s = format (s, "%s", "APP-CLOSED");
942       else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
943         s = format (s, "%s", "CLOSING");
944       else if (tls_ctx_handshake_is_over (ctx))
945         s = format (s, "%s", "ESTABLISHED");
946       else
947         s = format (s, "%s", "HANDSHAKE");
948     }
949
950   return s;
951 }
952
953 u8 *
954 format_tls_connection (u8 * s, va_list * args)
955 {
956   u32 ctx_index = va_arg (*args, u32);
957   u32 thread_index = va_arg (*args, u32);
958   u32 verbose = va_arg (*args, u32);
959   tls_ctx_t *ctx;
960
961   ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
962   if (!ctx)
963     return s;
964
965   s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
966   if (verbose)
967     {
968       s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
969                   ctx);
970       if (verbose > 1)
971         s = format (s, "\n");
972     }
973   return s;
974 }
975
976 u8 *
977 format_tls_listener (u8 * s, va_list * args)
978 {
979   u32 tc_index = va_arg (*args, u32);
980   u32 __clib_unused thread_index = va_arg (*args, u32);
981   u32 verbose = va_arg (*args, u32);
982   tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
983
984   s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
985   if (verbose)
986     s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
987   return s;
988 }
989
990 u8 *
991 format_tls_half_open (u8 * s, va_list * args)
992 {
993   u32 tc_index = va_arg (*args, u32);
994   u32 __clib_unused thread_index = va_arg (*args, u32);
995   tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
996   s = format (s, "[TLS] half-open app %u", ctx->parent_app_wrk_index);
997   tls_ctx_half_open_reader_unlock ();
998   return s;
999 }
1000
1001 static void
1002 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
1003                             transport_endpoint_t * tep, u8 is_lcl)
1004 {
1005   tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
1006   session_t *tcp_session;
1007
1008   tcp_session = session_get_from_handle (ctx->tls_session_handle);
1009   session_get_endpoint (tcp_session, tep, is_lcl);
1010 }
1011
1012 static void
1013 tls_transport_listener_endpoint_get (u32 ctx_handle,
1014                                      transport_endpoint_t * tep, u8 is_lcl)
1015 {
1016   session_t *tls_listener;
1017   app_listener_t *al;
1018   tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
1019
1020   al = app_listener_get_w_handle (ctx->tls_session_handle);
1021   tls_listener = app_listener_get_session (al);
1022   session_get_endpoint (tls_listener, tep, is_lcl);
1023 }
1024
1025 static clib_error_t *
1026 tls_enable (vlib_main_t * vm, u8 is_en)
1027 {
1028   u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
1029   vnet_app_detach_args_t _da, *da = &_da;
1030   vnet_app_attach_args_t _a, *a = &_a;
1031   u64 options[APP_OPTIONS_N_OPTIONS];
1032   tls_main_t *tm = &tls_main;
1033   u32 fifo_size = 128 << 12;
1034
1035   if (!is_en)
1036     {
1037       da->app_index = tm->app_index;
1038       da->api_client_index = APP_INVALID_INDEX;
1039       vnet_application_detach (da);
1040       return 0;
1041     }
1042
1043   first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
1044   fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1045
1046   clib_memset (a, 0, sizeof (*a));
1047   clib_memset (options, 0, sizeof (options));
1048
1049   a->session_cb_vft = &tls_app_cb_vft;
1050   a->api_client_index = APP_INVALID_INDEX;
1051   a->options = options;
1052   a->name = format (0, "tls");
1053   a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
1054   a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
1055   a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1056   a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1057   a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1058   a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1059   a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1060
1061   if (vnet_application_attach (a))
1062     {
1063       clib_warning ("failed to attach tls app");
1064       return clib_error_return (0, "failed to attach tls app");
1065     }
1066
1067   tm->app_index = a->app_index;
1068   vec_free (a->name);
1069
1070   return 0;
1071 }
1072
1073 static const transport_proto_vft_t tls_proto = {
1074   .enable = tls_enable,
1075   .connect = tls_connect,
1076   .close = tls_disconnect,
1077   .start_listen = tls_start_listen,
1078   .stop_listen = tls_stop_listen,
1079   .get_connection = tls_connection_get,
1080   .get_listener = tls_listener_get,
1081   .custom_tx = tls_custom_tx_callback,
1082   .format_connection = format_tls_connection,
1083   .format_half_open = format_tls_half_open,
1084   .format_listener = format_tls_listener,
1085   .get_transport_endpoint = tls_transport_endpoint_get,
1086   .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1087   .transport_options = {
1088     .name = "tls",
1089     .short_name = "J",
1090     .tx_type = TRANSPORT_TX_INTERNAL,
1091     .service_type = TRANSPORT_SERVICE_APP,
1092   },
1093 };
1094
1095 int
1096 dtls_connect (transport_endpoint_cfg_t *tep)
1097 {
1098   vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1099   transport_endpt_crypto_cfg_t *ccfg;
1100   crypto_engine_type_t engine_type;
1101   session_endpoint_cfg_t *sep;
1102   tls_main_t *tm = &tls_main;
1103   app_worker_t *app_wrk;
1104   application_t *app;
1105   tls_ctx_t *ctx;
1106   u32 ctx_handle;
1107   int rv;
1108
1109   sep = (session_endpoint_cfg_t *) tep;
1110   if (!sep->ext_cfg)
1111     return -1;
1112
1113   app_wrk = app_worker_get (sep->app_wrk_index);
1114   app = application_get (app_wrk->app_index);
1115
1116   ccfg = &sep->ext_cfg->crypto;
1117   engine_type = tls_get_engine_type (ccfg->crypto_engine, app->tls_engine);
1118   if (engine_type == CRYPTO_ENGINE_NONE)
1119     {
1120       clib_warning ("No tls engine_type available");
1121       return -1;
1122     }
1123
1124   ctx_handle = tls_ctx_alloc_w_thread (engine_type, 1 /* because of udp */);
1125   ctx = tls_ctx_get_w_thread (ctx_handle, 1);
1126   ctx->parent_app_wrk_index = sep->app_wrk_index;
1127   ctx->parent_app_api_context = sep->opaque;
1128   ctx->tcp_is_ip4 = sep->is_ip4;
1129   ctx->ckpair_index = ccfg->ckpair_index;
1130   ctx->tls_type = sep->transport_proto;
1131   ctx->tls_ctx_handle = ctx_handle;
1132   if (ccfg->hostname[0])
1133     {
1134       ctx->srv_hostname = format (0, "%s", ccfg->hostname);
1135       vec_terminate_c_string (ctx->srv_hostname);
1136     }
1137
1138   app_worker_alloc_connects_segment_manager (app_wrk);
1139   ctx->tls_ctx_engine = engine_type;
1140
1141   clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1142   cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1143   cargs->app_index = tm->app_index;
1144   cargs->api_context = ctx_handle;
1145   cargs->sep_ext.ns_index = app->ns_index;
1146   cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1147   if ((rv = vnet_connect (cargs)))
1148     return rv;
1149
1150   TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1151            engine_type);
1152   return 0;
1153 }
1154
1155 static void
1156 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1157 {
1158   /* No op */
1159 }
1160
1161 static const transport_proto_vft_t dtls_proto = {
1162   .enable = 0,
1163   .connect = dtls_connect,
1164   .close = tls_disconnect,
1165   .start_listen = tls_start_listen,
1166   .stop_listen = tls_stop_listen,
1167   .get_connection = tls_connection_get,
1168   .get_listener = tls_listener_get,
1169   .custom_tx = tls_custom_tx_callback,
1170   .cleanup = dtls_cleanup_callback,
1171   .format_connection = format_tls_connection,
1172   .format_half_open = format_tls_half_open,
1173   .format_listener = format_tls_listener,
1174   .get_transport_endpoint = tls_transport_endpoint_get,
1175   .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1176   .transport_options = {
1177     .name = "dtls",
1178     .short_name = "D",
1179     .tx_type = TRANSPORT_TX_INTERNAL,
1180     .service_type = TRANSPORT_SERVICE_APP,
1181   },
1182 };
1183
1184 void
1185 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1186 {
1187   vec_validate (tls_vfts, type);
1188   tls_vfts[type] = *vft;
1189 }
1190
1191 static clib_error_t *
1192 tls_init (vlib_main_t * vm)
1193 {
1194   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1195   tls_main_t *tm = &tls_main;
1196   u32 num_threads;
1197
1198   num_threads = 1 /* main thread */  + vtm->n_threads;
1199
1200   if (!tm->ca_cert_path)
1201     tm->ca_cert_path = TLS_CA_CERT_PATH;
1202
1203   clib_rwlock_init (&tm->half_open_rwlock);
1204
1205   vec_validate (tm->rx_bufs, num_threads - 1);
1206   vec_validate (tm->tx_bufs, num_threads - 1);
1207
1208   transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1209                                FIB_PROTOCOL_IP4, ~0);
1210   transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1211                                FIB_PROTOCOL_IP6, ~0);
1212
1213   transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1214                                FIB_PROTOCOL_IP4, ~0);
1215   transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1216                                FIB_PROTOCOL_IP6, ~0);
1217   return 0;
1218 }
1219
1220 VLIB_INIT_FUNCTION (tls_init);
1221
1222 static clib_error_t *
1223 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1224 {
1225   tls_main_t *tm = &tls_main;
1226   uword tmp;
1227   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1228     {
1229       if (unformat (input, "use-test-cert-in-ca"))
1230         tm->use_test_cert_in_ca = 1;
1231       else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1232         ;
1233       else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1234                          &tm->first_seg_size))
1235         ;
1236       else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1237         {
1238           if (tmp >= 0x100000000ULL)
1239             {
1240               return clib_error_return
1241                 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1242             }
1243           tm->fifo_size = tmp;
1244         }
1245       else
1246         return clib_error_return (0, "unknown input `%U'",
1247                                   format_unformat_error, input);
1248     }
1249   return 0;
1250 }
1251
1252 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
1253
1254 tls_main_t *
1255 vnet_tls_get_main (void)
1256 {
1257   return &tls_main;
1258 }
1259
1260 /*
1261  * fd.io coding-style-patch-verification: ON
1262  *
1263  * Local Variables:
1264  * eval: (c-set-style "gnu")
1265  * End:
1266  */