tls: dtls initial implementation
[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 preferred)
284 {
285   if (!tls_vfts[preferred].ctx_alloc)
286     return tls_get_available_engine ();
287   return preferred;
288 }
289
290 static inline u32
291 tls_ctx_alloc (crypto_engine_type_t engine_type)
292 {
293   u32 ctx_index;
294   ctx_index = tls_vfts[engine_type].ctx_alloc ();
295   return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
296 }
297
298 static inline u32
299 tls_ctx_alloc_w_thread (crypto_engine_type_t engine_type, u32 thread_index)
300 {
301   u32 ctx_index;
302   ctx_index = tls_vfts[engine_type].ctx_alloc_w_thread (thread_index);
303   return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
304 }
305
306 static inline u32
307 tls_ctx_attach (crypto_engine_type_t engine_type, u32 thread_index, void *ctx)
308 {
309   u32 ctx_index;
310   ctx_index = tls_vfts[engine_type].ctx_attach (thread_index, ctx);
311   return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
312 }
313
314 static inline void *
315 tls_ctx_detach (tls_ctx_t *ctx)
316 {
317   return tls_vfts[ctx->tls_ctx_engine].ctx_detach (ctx);
318 }
319
320 static inline tls_ctx_t *
321 tls_ctx_get (u32 ctx_handle)
322 {
323   u32 ctx_index, engine_type;
324   tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
325   return tls_vfts[engine_type].ctx_get (ctx_index);
326 }
327
328 static inline tls_ctx_t *
329 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
330 {
331   u32 ctx_index, engine_type;
332   tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
333   return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
334 }
335
336 static inline int
337 tls_ctx_init_server (tls_ctx_t * ctx)
338 {
339   return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
340 }
341
342 static inline int
343 tls_ctx_init_client (tls_ctx_t * ctx)
344 {
345   return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
346 }
347
348 static inline int
349 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
350                transport_send_params_t * sp)
351 {
352   u32 n_wrote;
353
354   sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
355   n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
356   return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
357 }
358
359 static inline int
360 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
361 {
362   return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
363 }
364
365 static inline int
366 tls_ctx_transport_close (tls_ctx_t * ctx)
367 {
368   return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
369 }
370
371 static inline int
372 tls_ctx_app_close (tls_ctx_t * ctx)
373 {
374   return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
375 }
376
377 void
378 tls_ctx_free (tls_ctx_t * ctx)
379 {
380   tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
381 }
382
383 u8
384 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
385 {
386   return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
387 }
388
389 void
390 tls_session_reset_callback (session_t * s)
391 {
392   tls_ctx_t *ctx;
393   transport_connection_t *tc;
394   session_t *app_session;
395
396   ctx = tls_ctx_get (s->opaque);
397   ctx->is_passive_close = 1;
398   tc = &ctx->connection;
399   if (tls_ctx_handshake_is_over (ctx))
400     {
401       session_transport_reset_notify (tc);
402       session_transport_closed_notify (tc);
403       tls_disconnect_transport (ctx);
404     }
405   else
406     if ((app_session =
407          session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
408     {
409       session_free (app_session);
410       ctx->c_s_index = SESSION_INVALID_INDEX;
411       tls_disconnect_transport (ctx);
412     }
413 }
414
415 int
416 tls_add_segment_callback (u32 client_index, u64 segment_handle)
417 {
418   /* No-op for builtin */
419   return 0;
420 }
421
422 int
423 tls_del_segment_callback (u32 client_index, u64 segment_handle)
424 {
425   return 0;
426 }
427
428 void
429 tls_session_disconnect_callback (session_t * tls_session)
430 {
431   tls_ctx_t *ctx;
432
433   TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
434            tls_session->session_index);
435
436   ASSERT (tls_session->thread_index == vlib_get_thread_index ()
437           || vlib_thread_is_main_w_barrier ());
438
439   ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
440   ctx->is_passive_close = 1;
441   tls_ctx_transport_close (ctx);
442 }
443
444 int
445 tls_session_accept_callback (session_t * tls_session)
446 {
447   session_t *tls_listener, *app_session;
448   tls_ctx_t *lctx, *ctx;
449   u32 ctx_handle;
450
451   tls_listener =
452     listen_session_get_from_handle (tls_session->listener_handle);
453   lctx = tls_listener_ctx_get (tls_listener->opaque);
454
455   ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
456   ctx = tls_ctx_get (ctx_handle);
457   memcpy (ctx, lctx, sizeof (*lctx));
458   ctx->c_thread_index = vlib_get_thread_index ();
459   ctx->tls_ctx_handle = ctx_handle;
460   tls_session->session_state = SESSION_STATE_READY;
461   tls_session->opaque = ctx_handle;
462   ctx->tls_session_handle = session_handle (tls_session);
463   ctx->listener_ctx_index = tls_listener->opaque;
464   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
465   ctx->ckpair_index = lctx->ckpair_index;
466
467   /* Preallocate app session. Avoids allocating a session post handshake
468    * on tls_session rx and potentially invalidating the session pool */
469   app_session = session_alloc (ctx->c_thread_index);
470   app_session->session_state = SESSION_STATE_CREATED;
471   ctx->c_s_index = app_session->session_index;
472
473   TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
474            tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
475
476   return tls_ctx_init_server (ctx);
477 }
478
479 int
480 tls_app_rx_callback (session_t * tls_session)
481 {
482   tls_ctx_t *ctx;
483
484   /* DTLS session migrating, wait for next notification */
485   if (PREDICT_FALSE (tls_session->flags & SESSION_F_IS_MIGRATING))
486     return 0;
487
488   ctx = tls_ctx_get (tls_session->opaque);
489   tls_ctx_read (ctx, tls_session);
490   return 0;
491 }
492
493 int
494 tls_app_tx_callback (session_t * tls_session)
495 {
496   tls_ctx_t *ctx;
497
498   ctx = tls_ctx_get (tls_session->opaque);
499   transport_connection_reschedule (&ctx->connection);
500
501   return 0;
502 }
503
504 int
505 tls_session_connected_cb (u32 tls_app_index, u32 ho_ctx_index,
506                           session_t *tls_session, session_error_t err)
507 {
508   session_t *app_session;
509   tls_ctx_t *ho_ctx, *ctx;
510   session_type_t st;
511   u32 ctx_handle;
512
513   ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
514
515   if (err)
516     {
517       app_worker_t *app_wrk;
518       u32 api_context;
519       int rv = 0;
520
521       app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
522       if (app_wrk)
523         {
524           api_context = ho_ctx->c_s_index;
525           app_worker_connect_notify (app_wrk, 0, err, api_context);
526         }
527       tls_ctx_half_open_reader_unlock ();
528       tls_ctx_half_open_free (ho_ctx_index);
529       return rv;
530     }
531
532   ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
533   ctx = tls_ctx_get (ctx_handle);
534   clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
535   tls_ctx_half_open_reader_unlock ();
536   tls_ctx_half_open_free (ho_ctx_index);
537
538   ctx->c_thread_index = vlib_get_thread_index ();
539   ctx->tls_ctx_handle = ctx_handle;
540   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
541
542   TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
543            ho_ctx_index, err, vlib_get_thread_index (),
544            (ctx) ? ctx_handle : ~0);
545
546   ctx->tls_session_handle = session_handle (tls_session);
547   tls_session->opaque = ctx_handle;
548   tls_session->session_state = SESSION_STATE_READY;
549
550   /* Preallocate app session. Avoids allocating a session post handshake
551    * on tls_session rx and potentially invalidating the session pool */
552   app_session = session_alloc (ctx->c_thread_index);
553   app_session->session_state = SESSION_STATE_CREATED;
554   ctx->c_s_index = app_session->session_index;
555   st = session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
556   app_session->session_type = st;
557   app_session->connection_index = ctx->tls_ctx_handle;
558
559   return tls_ctx_init_client (ctx);
560 }
561
562 int
563 dtls_session_connected_cb (u32 app_wrk_index, u32 ctx_handle, session_t *us,
564                            session_error_t err)
565 {
566   tls_ctx_t *ctx;
567
568   ctx = tls_ctx_get_w_thread (ctx_handle, 1 /* udp allocs on thread 1 */);
569
570   ctx->tls_session_handle = session_handle (us);
571   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
572   us->opaque = ctx_handle;
573
574   /* We don't preallocate the app session because the udp session might
575    * actually migrate to a different worker at the end of the handshake */
576
577   return tls_ctx_init_client (ctx);
578 }
579
580 int
581 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
582                                 session_t *tls_session, session_error_t err)
583 {
584   if (session_get_transport_proto (tls_session) == TRANSPORT_PROTO_TCP)
585     return tls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
586                                      err);
587   else
588     return dtls_session_connected_cb (tls_app_index, ho_ctx_index, tls_session,
589                                       err);
590 }
591
592 static void
593 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
594 {
595   tls_ctx_t *ctx;
596
597   if (ntf == SESSION_CLEANUP_TRANSPORT)
598     {
599       /* Allow cleanup of tcp session */
600       if (s->session_state == SESSION_STATE_TRANSPORT_DELETED)
601         session_close (s);
602       return;
603     }
604
605   ctx = tls_ctx_get (s->opaque);
606   if (!ctx->no_app_session)
607     session_transport_delete_notify (&ctx->connection);
608   tls_ctx_free (ctx);
609 }
610
611 static void
612 dtls_migrate_udp (void *arg)
613 {
614   tls_ctx_t *ctx = (tls_ctx_t *) arg;
615   u32 ctx_handle, thread_index;
616   session_t *us;
617
618   thread_index = session_thread_from_handle (ctx->tls_session_handle);
619   ASSERT (thread_index == vlib_get_thread_index ());
620
621   ctx_handle = tls_ctx_attach (ctx->tls_ctx_engine, thread_index, ctx);
622   ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
623   ctx->tls_ctx_handle = ctx_handle;
624
625   us = session_get_from_handle (ctx->tls_session_handle);
626   us->opaque = ctx_handle;
627   us->flags &= ~SESSION_F_IS_MIGRATING;
628   if (svm_fifo_max_dequeue (us->tx_fifo))
629     session_send_io_evt_to_thread (us->tx_fifo, SESSION_IO_EVT_TX);
630 }
631
632 static void
633 dtls_session_migrate_callback (session_t *us, session_handle_t new_sh)
634 {
635   u32 new_thread = session_thread_from_handle (new_sh);
636   tls_ctx_t *ctx;
637
638   /* Migrate dtls context to new thread */
639   ctx = tls_ctx_get_w_thread (us->opaque, us->thread_index);
640   ctx->tls_session_handle = new_sh;
641   ctx = tls_ctx_detach (ctx);
642   ctx->is_migrated = 1;
643
644   session_send_rpc_evt_to_thread (new_thread, dtls_migrate_udp, (void *) ctx);
645 }
646
647 static session_cb_vft_t tls_app_cb_vft = {
648   .session_accept_callback = tls_session_accept_callback,
649   .session_disconnect_callback = tls_session_disconnect_callback,
650   .session_connected_callback = tls_session_connected_callback,
651   .session_reset_callback = tls_session_reset_callback,
652   .add_segment_callback = tls_add_segment_callback,
653   .del_segment_callback = tls_del_segment_callback,
654   .builtin_app_rx_callback = tls_app_rx_callback,
655   .builtin_app_tx_callback = tls_app_tx_callback,
656   .session_migrate_callback = dtls_session_migrate_callback,
657   .session_cleanup_callback = tls_app_session_cleanup,
658 };
659
660 int
661 tls_connect (transport_endpoint_cfg_t * tep)
662 {
663   vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
664   crypto_engine_type_t engine_type;
665   session_endpoint_cfg_t *sep;
666   tls_main_t *tm = &tls_main;
667   app_worker_t *app_wrk;
668   application_t *app;
669   tls_ctx_t *ctx;
670   u32 ctx_index;
671   int rv;
672
673   sep = (session_endpoint_cfg_t *) tep;
674   app_wrk = app_worker_get (sep->app_wrk_index);
675   app = application_get (app_wrk->app_index);
676   engine_type = tls_get_engine_type (app->tls_engine);
677   if (engine_type == CRYPTO_ENGINE_NONE)
678     {
679       clib_warning ("No tls engine_type available");
680       return -1;
681     }
682
683   ctx_index = tls_ctx_half_open_alloc ();
684   ctx = tls_ctx_half_open_get (ctx_index);
685   ctx->parent_app_wrk_index = sep->app_wrk_index;
686   ctx->parent_app_api_context = sep->opaque;
687   ctx->tcp_is_ip4 = sep->is_ip4;
688   ctx->ckpair_index = sep->ckpair_index;
689   ctx->tls_type = sep->transport_proto;
690   if (sep->hostname)
691     {
692       ctx->srv_hostname = format (0, "%v", sep->hostname);
693       vec_terminate_c_string (ctx->srv_hostname);
694     }
695   tls_ctx_half_open_reader_unlock ();
696
697   app_worker_alloc_connects_segment_manager (app_wrk);
698   ctx->tls_ctx_engine = engine_type;
699
700   clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
701   cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
702   cargs->app_index = tm->app_index;
703   cargs->api_context = ctx_index;
704   cargs->sep_ext.ns_index = app->ns_index;
705   if ((rv = vnet_connect (cargs)))
706     return rv;
707
708   TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
709   return 0;
710 }
711
712 void
713 tls_disconnect (u32 ctx_handle, u32 thread_index)
714 {
715   tls_ctx_t *ctx;
716
717   TLS_DBG (1, "Disconnecting %x", ctx_handle);
718
719   ctx = tls_ctx_get (ctx_handle);
720   tls_ctx_app_close (ctx);
721 }
722
723 u32
724 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
725 {
726   vnet_listen_args_t _bargs, *args = &_bargs;
727   app_worker_t *app_wrk;
728   tls_main_t *tm = &tls_main;
729   session_handle_t tls_al_handle;
730   session_endpoint_cfg_t *sep;
731   session_t *tls_listener;
732   session_t *app_listener;
733   crypto_engine_type_t engine_type;
734   application_t *app;
735   app_listener_t *al;
736   tls_ctx_t *lctx;
737   u32 lctx_index;
738
739   sep = (session_endpoint_cfg_t *) tep;
740   app_wrk = app_worker_get (sep->app_wrk_index);
741   app = application_get (app_wrk->app_index);
742   engine_type = tls_get_engine_type (app->tls_engine);
743   if (engine_type == CRYPTO_ENGINE_NONE)
744     {
745       clib_warning ("No tls engine_type available");
746       return -1;
747     }
748
749   clib_memset (args, 0, sizeof (*args));
750   args->app_index = tm->app_index;
751   args->sep_ext = *sep;
752   args->sep_ext.ns_index = app->ns_index;
753   args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
754   if (sep->transport_proto == TRANSPORT_PROTO_DTLS)
755     {
756       args->sep_ext.transport_proto = TRANSPORT_PROTO_UDP;
757       args->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
758     }
759   if (vnet_listen (args))
760     return -1;
761
762   lctx_index = tls_listener_ctx_alloc ();
763   tls_al_handle = args->handle;
764   al = app_listener_get_w_handle (tls_al_handle);
765   tls_listener = app_listener_get_session (al);
766   tls_listener->opaque = lctx_index;
767
768   app_listener = listen_session_get (app_listener_index);
769
770   lctx = tls_listener_ctx_get (lctx_index);
771   lctx->parent_app_wrk_index = sep->app_wrk_index;
772   lctx->tls_session_handle = tls_al_handle;
773   lctx->app_session_handle = listen_session_get_handle (app_listener);
774   lctx->tcp_is_ip4 = sep->is_ip4;
775   lctx->tls_ctx_engine = engine_type;
776   lctx->ckpair_index = sep->ckpair_index;
777   lctx->tls_type = sep->transport_proto;
778
779   if (tls_vfts[engine_type].ctx_start_listen (lctx))
780     {
781       vnet_unlisten_args_t a = {
782         .handle = lctx->tls_session_handle,
783         .app_index = tls_main.app_index,
784         .wrk_map_index = 0
785       };
786       if ((vnet_unlisten (&a)))
787         clib_warning ("unlisten returned");
788       tls_listener_ctx_free (lctx);
789       lctx_index = SESSION_INVALID_INDEX;
790     }
791
792   TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
793            engine_type);
794   return lctx_index;
795 }
796
797 u32
798 tls_stop_listen (u32 lctx_index)
799 {
800   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
801   crypto_engine_type_t engine_type;
802   transport_connection_t *lc;
803   tls_ctx_t *lctx;
804   session_t *ls;
805   int rv;
806
807   lctx = tls_listener_ctx_get (lctx_index);
808
809   /* Cleanup listener from session lookup table */
810   ls = session_get_from_handle (lctx->tls_session_handle);
811   lc = session_get_transport (ls);
812
813   sep.fib_index = lc->fib_index;
814   sep.port = lc->lcl_port;
815   sep.is_ip4 = lc->is_ip4;
816   sep.transport_proto = lctx->tls_type;
817   clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
818   session_lookup_del_session_endpoint2 (&sep);
819
820   vnet_unlisten_args_t a = {
821     .handle = lctx->tls_session_handle,
822     .app_index = tls_main.app_index,
823     .wrk_map_index = 0          /* default wrk */
824   };
825   if ((rv = vnet_unlisten (&a)))
826     clib_warning ("unlisten returned %d", rv);
827
828   engine_type = lctx->tls_ctx_engine;
829   tls_vfts[engine_type].ctx_stop_listen (lctx);
830
831   tls_listener_ctx_free (lctx);
832   return 0;
833 }
834
835 transport_connection_t *
836 tls_connection_get (u32 ctx_index, u32 thread_index)
837 {
838   tls_ctx_t *ctx;
839   ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
840   return &ctx->connection;
841 }
842
843 transport_connection_t *
844 tls_listener_get (u32 listener_index)
845 {
846   tls_ctx_t *ctx;
847   ctx = tls_listener_ctx_get (listener_index);
848   return &ctx->connection;
849 }
850
851 int
852 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
853 {
854   session_t *app_session = (session_t *) session;
855   tls_ctx_t *ctx;
856
857   if (PREDICT_FALSE (app_session->session_state
858                      >= SESSION_STATE_TRANSPORT_CLOSED))
859     return 0;
860
861   sp->flags = 0;
862   ctx = tls_ctx_get (app_session->connection_index);
863   return tls_ctx_write (ctx, app_session, sp);
864 }
865
866 u8 *
867 format_tls_ctx (u8 * s, va_list * args)
868 {
869   u32 tcp_si, tcp_ti, ctx_index, ctx_engine;
870   tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
871   char *proto;
872
873   proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
874   session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
875   tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
876   s =
877     format (s, "[%d:%d][%s] app_wrk %u index %u engine %u ts %d:%d",
878             ctx->c_thread_index, ctx->c_s_index, proto,
879             ctx->parent_app_wrk_index, ctx_index, ctx_engine, tcp_ti, tcp_si);
880
881   return s;
882 }
883
884 static u8 *
885 format_tls_listener_ctx (u8 * s, va_list * args)
886 {
887   session_t *tls_listener;
888   app_listener_t *al;
889   tls_ctx_t *ctx;
890   char *proto;
891
892   ctx = va_arg (*args, tls_ctx_t *);
893
894   proto = ctx->tls_type == TRANSPORT_PROTO_TLS ? "TLS" : "DTLS";
895   al = app_listener_get_w_handle (ctx->tls_session_handle);
896   tls_listener = app_listener_get_session (al);
897   s = format (s, "[%d:%d][%s] app_wrk %u engine %u ts %d:%d",
898               ctx->c_thread_index, ctx->c_s_index, proto,
899               ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
900               tls_listener->thread_index, tls_listener->session_index);
901
902   return s;
903 }
904
905 static u8 *
906 format_tls_ctx_state (u8 * s, va_list * args)
907 {
908   tls_ctx_t *ctx;
909   session_t *ts;
910
911   ctx = va_arg (*args, tls_ctx_t *);
912   ts = session_get (ctx->c_s_index, ctx->c_thread_index);
913   if (ts->session_state == SESSION_STATE_LISTENING)
914     s = format (s, "%s", "LISTEN");
915   else
916     {
917       if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSED)
918         s = format (s, "%s", "CLOSED");
919       else if (ts->session_state == SESSION_STATE_APP_CLOSED)
920         s = format (s, "%s", "APP-CLOSED");
921       else if (ts->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
922         s = format (s, "%s", "CLOSING");
923       else if (tls_ctx_handshake_is_over (ctx))
924         s = format (s, "%s", "ESTABLISHED");
925       else
926         s = format (s, "%s", "HANDSHAKE");
927     }
928
929   return s;
930 }
931
932 u8 *
933 format_tls_connection (u8 * s, va_list * args)
934 {
935   u32 ctx_index = va_arg (*args, u32);
936   u32 thread_index = va_arg (*args, u32);
937   u32 verbose = va_arg (*args, u32);
938   tls_ctx_t *ctx;
939
940   ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
941   if (!ctx)
942     return s;
943
944   s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_ctx, ctx);
945   if (verbose)
946     {
947       s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state,
948                   ctx);
949       if (verbose > 1)
950         s = format (s, "\n");
951     }
952   return s;
953 }
954
955 u8 *
956 format_tls_listener (u8 * s, va_list * args)
957 {
958   u32 tc_index = va_arg (*args, u32);
959   u32 __clib_unused thread_index = va_arg (*args, u32);
960   u32 verbose = va_arg (*args, u32);
961   tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
962
963   s = format (s, "%-" SESSION_CLI_ID_LEN "U", format_tls_listener_ctx, ctx);
964   if (verbose)
965     s = format (s, "%-" SESSION_CLI_STATE_LEN "U", format_tls_ctx_state, ctx);
966   return s;
967 }
968
969 u8 *
970 format_tls_half_open (u8 * s, va_list * args)
971 {
972   u32 tc_index = va_arg (*args, u32);
973   u32 __clib_unused thread_index = va_arg (*args, u32);
974   tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
975   s = format (s, "[TLS] half-open app %u", ctx->parent_app_wrk_index);
976   tls_ctx_half_open_reader_unlock ();
977   return s;
978 }
979
980 static void
981 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
982                             transport_endpoint_t * tep, u8 is_lcl)
983 {
984   tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
985   session_t *tcp_session;
986
987   tcp_session = session_get_from_handle (ctx->tls_session_handle);
988   session_get_endpoint (tcp_session, tep, is_lcl);
989 }
990
991 static void
992 tls_transport_listener_endpoint_get (u32 ctx_handle,
993                                      transport_endpoint_t * tep, u8 is_lcl)
994 {
995   session_t *tls_listener;
996   app_listener_t *al;
997   tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
998
999   al = app_listener_get_w_handle (ctx->tls_session_handle);
1000   tls_listener = app_listener_get_session (al);
1001   session_get_endpoint (tls_listener, tep, is_lcl);
1002 }
1003
1004 static clib_error_t *
1005 tls_enable (vlib_main_t * vm, u8 is_en)
1006 {
1007   u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
1008   vnet_app_detach_args_t _da, *da = &_da;
1009   vnet_app_attach_args_t _a, *a = &_a;
1010   u64 options[APP_OPTIONS_N_OPTIONS];
1011   tls_main_t *tm = &tls_main;
1012   u32 fifo_size = 128 << 12;
1013
1014   if (!is_en)
1015     {
1016       da->app_index = tm->app_index;
1017       da->api_client_index = APP_INVALID_INDEX;
1018       vnet_application_detach (da);
1019       return 0;
1020     }
1021
1022   first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
1023   fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
1024
1025   clib_memset (a, 0, sizeof (*a));
1026   clib_memset (options, 0, sizeof (options));
1027
1028   a->session_cb_vft = &tls_app_cb_vft;
1029   a->api_client_index = APP_INVALID_INDEX;
1030   a->options = options;
1031   a->name = format (0, "tls");
1032   a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
1033   a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
1034   a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
1035   a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
1036   a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
1037   a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1038   a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
1039
1040   if (vnet_application_attach (a))
1041     {
1042       clib_warning ("failed to attach tls app");
1043       return clib_error_return (0, "failed to attach tls app");
1044     }
1045
1046   tm->app_index = a->app_index;
1047   vec_free (a->name);
1048
1049   return 0;
1050 }
1051
1052 static const transport_proto_vft_t tls_proto = {
1053   .enable = tls_enable,
1054   .connect = tls_connect,
1055   .close = tls_disconnect,
1056   .start_listen = tls_start_listen,
1057   .stop_listen = tls_stop_listen,
1058   .get_connection = tls_connection_get,
1059   .get_listener = tls_listener_get,
1060   .custom_tx = tls_custom_tx_callback,
1061   .format_connection = format_tls_connection,
1062   .format_half_open = format_tls_half_open,
1063   .format_listener = format_tls_listener,
1064   .get_transport_endpoint = tls_transport_endpoint_get,
1065   .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1066   .transport_options = {
1067     .name = "tls",
1068     .short_name = "J",
1069     .tx_type = TRANSPORT_TX_INTERNAL,
1070     .service_type = TRANSPORT_SERVICE_APP,
1071   },
1072 };
1073
1074 int
1075 dtls_connect (transport_endpoint_cfg_t *tep)
1076 {
1077   vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
1078   crypto_engine_type_t engine_type;
1079   session_endpoint_cfg_t *sep;
1080   tls_main_t *tm = &tls_main;
1081   app_worker_t *app_wrk;
1082   application_t *app;
1083   tls_ctx_t *ctx;
1084   u32 ctx_handle;
1085   int rv;
1086
1087   sep = (session_endpoint_cfg_t *) tep;
1088   app_wrk = app_worker_get (sep->app_wrk_index);
1089   app = application_get (app_wrk->app_index);
1090   engine_type = tls_get_engine_type (app->tls_engine);
1091   if (engine_type == CRYPTO_ENGINE_NONE)
1092     {
1093       clib_warning ("No tls engine_type available");
1094       return -1;
1095     }
1096
1097   ctx_handle = tls_ctx_alloc_w_thread (engine_type, 1 /* because of udp */);
1098   ctx = tls_ctx_get_w_thread (ctx_handle, 1);
1099   ctx->parent_app_wrk_index = sep->app_wrk_index;
1100   ctx->parent_app_api_context = sep->opaque;
1101   ctx->tcp_is_ip4 = sep->is_ip4;
1102   ctx->ckpair_index = sep->ckpair_index;
1103   ctx->tls_type = sep->transport_proto;
1104   ctx->tls_ctx_handle = ctx_handle;
1105   if (sep->hostname)
1106     {
1107       ctx->srv_hostname = format (0, "%v", sep->hostname);
1108       vec_terminate_c_string (ctx->srv_hostname);
1109     }
1110
1111   app_worker_alloc_connects_segment_manager (app_wrk);
1112   ctx->tls_ctx_engine = engine_type;
1113
1114   clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
1115   cargs->sep.transport_proto = TRANSPORT_PROTO_UDP;
1116   cargs->app_index = tm->app_index;
1117   cargs->api_context = ctx_handle;
1118   cargs->sep_ext.ns_index = app->ns_index;
1119   cargs->sep_ext.transport_flags = TRANSPORT_CFG_F_CONNECTED;
1120   if ((rv = vnet_connect (cargs)))
1121     return rv;
1122
1123   TLS_DBG (1, "New DTLS connect request %x engine %d", ctx_handle,
1124            engine_type);
1125   return 0;
1126 }
1127
1128 static void
1129 dtls_cleanup_callback (u32 ctx_index, u32 thread_index)
1130 {
1131   /* No op */
1132 }
1133
1134 static const transport_proto_vft_t dtls_proto = {
1135   .enable = 0,
1136   .connect = dtls_connect,
1137   .close = tls_disconnect,
1138   .start_listen = tls_start_listen,
1139   .stop_listen = tls_stop_listen,
1140   .get_connection = tls_connection_get,
1141   .get_listener = tls_listener_get,
1142   .custom_tx = tls_custom_tx_callback,
1143   .cleanup = dtls_cleanup_callback,
1144   .format_connection = format_tls_connection,
1145   .format_half_open = format_tls_half_open,
1146   .format_listener = format_tls_listener,
1147   .get_transport_endpoint = tls_transport_endpoint_get,
1148   .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
1149   .transport_options = {
1150     .name = "dtls",
1151     .short_name = "D",
1152     .tx_type = TRANSPORT_TX_INTERNAL,
1153     .service_type = TRANSPORT_SERVICE_APP,
1154   },
1155 };
1156
1157 void
1158 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
1159 {
1160   vec_validate (tls_vfts, type);
1161   tls_vfts[type] = *vft;
1162 }
1163
1164 static clib_error_t *
1165 tls_init (vlib_main_t * vm)
1166 {
1167   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1168   tls_main_t *tm = &tls_main;
1169   u32 num_threads;
1170
1171   num_threads = 1 /* main thread */  + vtm->n_threads;
1172
1173   if (!tm->ca_cert_path)
1174     tm->ca_cert_path = TLS_CA_CERT_PATH;
1175
1176   clib_rwlock_init (&tm->half_open_rwlock);
1177
1178   vec_validate (tm->rx_bufs, num_threads - 1);
1179   vec_validate (tm->tx_bufs, num_threads - 1);
1180
1181   transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1182                                FIB_PROTOCOL_IP4, ~0);
1183   transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
1184                                FIB_PROTOCOL_IP6, ~0);
1185
1186   transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1187                                FIB_PROTOCOL_IP4, ~0);
1188   transport_register_protocol (TRANSPORT_PROTO_DTLS, &dtls_proto,
1189                                FIB_PROTOCOL_IP6, ~0);
1190   return 0;
1191 }
1192
1193 VLIB_INIT_FUNCTION (tls_init);
1194
1195 static clib_error_t *
1196 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
1197 {
1198   tls_main_t *tm = &tls_main;
1199   uword tmp;
1200   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1201     {
1202       if (unformat (input, "use-test-cert-in-ca"))
1203         tm->use_test_cert_in_ca = 1;
1204       else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
1205         ;
1206       else if (unformat (input, "first-segment-size %U", unformat_memory_size,
1207                          &tm->first_seg_size))
1208         ;
1209       else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
1210         {
1211           if (tmp >= 0x100000000ULL)
1212             {
1213               return clib_error_return
1214                 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
1215             }
1216           tm->fifo_size = tmp;
1217         }
1218       else
1219         return clib_error_return (0, "unknown input `%U'",
1220                                   format_unformat_error, input);
1221     }
1222   return 0;
1223 }
1224
1225 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
1226
1227 tls_main_t *
1228 vnet_tls_get_main (void)
1229 {
1230   return &tls_main;
1231 }
1232
1233 /*
1234  * fd.io coding-style-patch-verification: ON
1235  *
1236  * Local Variables:
1237  * eval: (c-set-style "gnu")
1238  * End:
1239  */