session tls: support tls descheduling
[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     goto failed;
225
226   app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
227   app_session->app_wrk_index = ctx->parent_app_wrk_index;
228   app_session->connection_index = ctx->tls_ctx_handle;
229   app_session->session_type =
230     session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
231
232   if ((err = app_worker_init_connected (app_wrk, app_session)))
233     goto failed;
234
235   app_session->session_state = SESSION_STATE_CONNECTING;
236   if (app_worker_connect_notify (app_wrk, app_session,
237                                  SESSION_E_NONE, ctx->parent_app_api_context))
238     {
239       TLS_DBG (1, "failed to notify app");
240       tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
241       return -1;
242     }
243
244   ctx->app_session_handle = session_handle (app_session);
245   app_session->session_state = SESSION_STATE_READY;
246
247   return 0;
248
249 failed:
250   /* Free app session pre-allocated when transport was established */
251   session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
252   ctx->no_app_session = 1;
253   tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
254   return app_worker_connect_notify (app_wrk, 0, err,
255                                     ctx->parent_app_api_context);
256 }
257
258 static inline void
259 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
260 {
261   *ctx_index = ctx_handle & TLS_IDX_MASK;
262   *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
263 }
264
265 static inline crypto_engine_type_t
266 tls_get_engine_type (crypto_engine_type_t preferred)
267 {
268   if (!tls_vfts[preferred].ctx_alloc)
269     return tls_get_available_engine ();
270   return preferred;
271 }
272
273 static inline u32
274 tls_ctx_alloc (crypto_engine_type_t engine_type)
275 {
276   u32 ctx_index;
277   ctx_index = tls_vfts[engine_type].ctx_alloc ();
278   return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
279 }
280
281 static inline tls_ctx_t *
282 tls_ctx_get (u32 ctx_handle)
283 {
284   u32 ctx_index, engine_type;
285   tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
286   return tls_vfts[engine_type].ctx_get (ctx_index);
287 }
288
289 static inline tls_ctx_t *
290 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
291 {
292   u32 ctx_index, engine_type;
293   tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
294   return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
295 }
296
297 static inline int
298 tls_ctx_init_server (tls_ctx_t * ctx)
299 {
300   return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
301 }
302
303 static inline int
304 tls_ctx_init_client (tls_ctx_t * ctx)
305 {
306   return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
307 }
308
309 static inline int
310 tls_ctx_write (tls_ctx_t * ctx, session_t * app_session,
311                transport_send_params_t * sp)
312 {
313   u32 n_wrote;
314
315   sp->max_burst_size = sp->max_burst_size * TRANSPORT_PACER_MIN_MSS;
316   n_wrote = tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session, sp);
317   return n_wrote > 0 ? clib_max (n_wrote / TRANSPORT_PACER_MIN_MSS, 1) : 0;
318 }
319
320 static inline int
321 tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
322 {
323   return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
324 }
325
326 static inline int
327 tls_ctx_transport_close (tls_ctx_t * ctx)
328 {
329   return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
330 }
331
332 static inline int
333 tls_ctx_app_close (tls_ctx_t * ctx)
334 {
335   return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
336 }
337
338 void
339 tls_ctx_free (tls_ctx_t * ctx)
340 {
341   tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
342 }
343
344 u8
345 tls_ctx_handshake_is_over (tls_ctx_t * ctx)
346 {
347   return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
348 }
349
350 void
351 tls_session_reset_callback (session_t * s)
352 {
353   tls_ctx_t *ctx;
354   transport_connection_t *tc;
355   session_t *app_session;
356
357   ctx = tls_ctx_get (s->opaque);
358   ctx->is_passive_close = 1;
359   tc = &ctx->connection;
360   if (tls_ctx_handshake_is_over (ctx))
361     {
362       session_transport_reset_notify (tc);
363       session_transport_closed_notify (tc);
364       tls_disconnect_transport (ctx);
365     }
366   else
367     if ((app_session =
368          session_get_if_valid (ctx->c_s_index, ctx->c_thread_index)))
369     {
370       session_free (app_session);
371       ctx->c_s_index = SESSION_INVALID_INDEX;
372       tls_disconnect_transport (ctx);
373     }
374 }
375
376 int
377 tls_add_segment_callback (u32 client_index, u64 segment_handle)
378 {
379   /* No-op for builtin */
380   return 0;
381 }
382
383 int
384 tls_del_segment_callback (u32 client_index, u64 segment_handle)
385 {
386   return 0;
387 }
388
389 void
390 tls_session_disconnect_callback (session_t * tls_session)
391 {
392   tls_ctx_t *ctx;
393
394   TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
395            tls_session->session_index);
396
397   ASSERT (tls_session->thread_index == vlib_get_thread_index ()
398           || vlib_thread_is_main_w_barrier ());
399
400   ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
401   ctx->is_passive_close = 1;
402   tls_ctx_transport_close (ctx);
403 }
404
405 int
406 tls_session_accept_callback (session_t * tls_session)
407 {
408   session_t *tls_listener, *app_session;
409   tls_ctx_t *lctx, *ctx;
410   u32 ctx_handle;
411
412   tls_listener =
413     listen_session_get_from_handle (tls_session->listener_handle);
414   lctx = tls_listener_ctx_get (tls_listener->opaque);
415
416   ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
417   ctx = tls_ctx_get (ctx_handle);
418   memcpy (ctx, lctx, sizeof (*lctx));
419   ctx->c_thread_index = vlib_get_thread_index ();
420   ctx->tls_ctx_handle = ctx_handle;
421   tls_session->session_state = SESSION_STATE_READY;
422   tls_session->opaque = ctx_handle;
423   ctx->tls_session_handle = session_handle (tls_session);
424   ctx->listener_ctx_index = tls_listener->opaque;
425   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
426   ctx->ckpair_index = lctx->ckpair_index;
427
428   /* Preallocate app session. Avoids allocating a session post handshake
429    * on tls_session rx and potentially invalidating the session pool */
430   app_session = session_alloc (ctx->c_thread_index);
431   app_session->session_state = SESSION_STATE_CREATED;
432   ctx->c_s_index = app_session->session_index;
433
434   TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
435            tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
436
437   return tls_ctx_init_server (ctx);
438 }
439
440 int
441 tls_app_rx_callback (session_t * tls_session)
442 {
443   tls_ctx_t *ctx;
444
445   ctx = tls_ctx_get (tls_session->opaque);
446   tls_ctx_read (ctx, tls_session);
447   return 0;
448 }
449
450 int
451 tls_app_tx_callback (session_t * tls_session)
452 {
453   tls_ctx_t *ctx;
454
455   ctx = tls_ctx_get (tls_session->opaque);
456   transport_connection_reschedule (&ctx->connection);
457
458   return 0;
459 }
460
461 int
462 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
463                                 session_t * tls_session, session_error_t err)
464 {
465   session_t *app_session;
466   tls_ctx_t *ho_ctx, *ctx;
467   u32 ctx_handle;
468
469   ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
470
471   if (err)
472     {
473       app_worker_t *app_wrk;
474       u32 api_context;
475       int rv = 0;
476
477       app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
478       if (app_wrk)
479         {
480           api_context = ho_ctx->c_s_index;
481           app_worker_connect_notify (app_wrk, 0, err, api_context);
482         }
483       tls_ctx_half_open_reader_unlock ();
484       tls_ctx_half_open_free (ho_ctx_index);
485       return rv;
486     }
487
488   ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
489   ctx = tls_ctx_get (ctx_handle);
490   clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
491   tls_ctx_half_open_reader_unlock ();
492   tls_ctx_half_open_free (ho_ctx_index);
493
494   ctx->c_thread_index = vlib_get_thread_index ();
495   ctx->tls_ctx_handle = ctx_handle;
496   ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
497
498   TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
499            ho_ctx_index, is_fail, vlib_get_thread_index (),
500            (ctx) ? ctx_handle : ~0);
501
502   ctx->tls_session_handle = session_handle (tls_session);
503   tls_session->opaque = ctx_handle;
504   tls_session->session_state = SESSION_STATE_READY;
505
506   /* Preallocate app session. Avoids allocating a session post handshake
507    * on tls_session rx and potentially invalidating the session pool */
508   app_session = session_alloc (ctx->c_thread_index);
509   app_session->session_state = SESSION_STATE_CREATED;
510   ctx->c_s_index = app_session->session_index;
511
512   return tls_ctx_init_client (ctx);
513 }
514
515 static void
516 tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
517 {
518   tls_ctx_t *ctx;
519
520   if (ntf == SESSION_CLEANUP_TRANSPORT)
521     return;
522
523   ctx = tls_ctx_get (s->opaque);
524   if (!ctx->no_app_session)
525     session_transport_delete_notify (&ctx->connection);
526   tls_ctx_free (ctx);
527 }
528
529 /* *INDENT-OFF* */
530 static session_cb_vft_t tls_app_cb_vft = {
531   .session_accept_callback = tls_session_accept_callback,
532   .session_disconnect_callback = tls_session_disconnect_callback,
533   .session_connected_callback = tls_session_connected_callback,
534   .session_reset_callback = tls_session_reset_callback,
535   .add_segment_callback = tls_add_segment_callback,
536   .del_segment_callback = tls_del_segment_callback,
537   .builtin_app_rx_callback = tls_app_rx_callback,
538   .builtin_app_tx_callback = tls_app_tx_callback,
539   .session_cleanup_callback = tls_app_session_cleanup,
540 };
541 /* *INDENT-ON* */
542
543 int
544 tls_connect (transport_endpoint_cfg_t * tep)
545 {
546   vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
547   session_endpoint_cfg_t *sep;
548   crypto_engine_type_t engine_type;
549   tls_main_t *tm = &tls_main;
550   app_worker_t *app_wrk;
551   application_t *app;
552   tls_ctx_t *ctx;
553   u32 ctx_index;
554   int rv;
555
556   sep = (session_endpoint_cfg_t *) tep;
557   app_wrk = app_worker_get (sep->app_wrk_index);
558   app = application_get (app_wrk->app_index);
559   engine_type = tls_get_engine_type (app->tls_engine);
560   if (engine_type == CRYPTO_ENGINE_NONE)
561     {
562       clib_warning ("No tls engine_type available");
563       return -1;
564     }
565
566   ctx_index = tls_ctx_half_open_alloc ();
567   ctx = tls_ctx_half_open_get (ctx_index);
568   ctx->parent_app_wrk_index = sep->app_wrk_index;
569   ctx->parent_app_api_context = sep->opaque;
570   ctx->tcp_is_ip4 = sep->is_ip4;
571   if (sep->hostname)
572     {
573       ctx->srv_hostname = format (0, "%v", sep->hostname);
574       vec_terminate_c_string (ctx->srv_hostname);
575     }
576   tls_ctx_half_open_reader_unlock ();
577
578   app_worker_alloc_connects_segment_manager (app_wrk);
579   ctx->tls_ctx_engine = engine_type;
580
581   clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
582   cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
583   cargs->app_index = tm->app_index;
584   cargs->api_context = ctx_index;
585   cargs->sep_ext.ns_index = app->ns_index;
586   if ((rv = vnet_connect (cargs)))
587     return rv;
588
589   TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
590   return 0;
591 }
592
593 void
594 tls_disconnect (u32 ctx_handle, u32 thread_index)
595 {
596   tls_ctx_t *ctx;
597
598   TLS_DBG (1, "Disconnecting %x", ctx_handle);
599
600   ctx = tls_ctx_get (ctx_handle);
601   tls_ctx_app_close (ctx);
602 }
603
604 u32
605 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
606 {
607   vnet_listen_args_t _bargs, *args = &_bargs;
608   app_worker_t *app_wrk;
609   tls_main_t *tm = &tls_main;
610   session_handle_t tls_al_handle;
611   session_endpoint_cfg_t *sep;
612   session_t *tls_listener;
613   session_t *app_listener;
614   crypto_engine_type_t engine_type;
615   application_t *app;
616   app_listener_t *al;
617   tls_ctx_t *lctx;
618   u32 lctx_index;
619
620   sep = (session_endpoint_cfg_t *) tep;
621   app_wrk = app_worker_get (sep->app_wrk_index);
622   app = application_get (app_wrk->app_index);
623   engine_type = tls_get_engine_type (app->tls_engine);
624   if (engine_type == CRYPTO_ENGINE_NONE)
625     {
626       clib_warning ("No tls engine_type available");
627       return -1;
628     }
629
630   clib_memset (args, 0, sizeof (*args));
631   args->app_index = tm->app_index;
632   args->sep_ext = *sep;
633   args->sep_ext.ns_index = app->ns_index;
634   args->sep_ext.transport_proto = TRANSPORT_PROTO_TCP;
635   if (vnet_listen (args))
636     return -1;
637
638   lctx_index = tls_listener_ctx_alloc ();
639   tls_al_handle = args->handle;
640   al = app_listener_get_w_handle (tls_al_handle);
641   tls_listener = app_listener_get_session (al);
642   tls_listener->opaque = lctx_index;
643
644   app_listener = listen_session_get (app_listener_index);
645
646   lctx = tls_listener_ctx_get (lctx_index);
647   lctx->parent_app_wrk_index = sep->app_wrk_index;
648   lctx->tls_session_handle = tls_al_handle;
649   lctx->app_session_handle = listen_session_get_handle (app_listener);
650   lctx->tcp_is_ip4 = sep->is_ip4;
651   lctx->tls_ctx_engine = engine_type;
652   lctx->ckpair_index = sep->ckpair_index;
653
654   if (tls_vfts[engine_type].ctx_start_listen (lctx))
655     {
656       vnet_unlisten_args_t a = {
657         .handle = lctx->tls_session_handle,
658         .app_index = tls_main.app_index,
659         .wrk_map_index = 0
660       };
661       if ((vnet_unlisten (&a)))
662         clib_warning ("unlisten returned");
663       tls_listener_ctx_free (lctx);
664       lctx_index = SESSION_INVALID_INDEX;
665     }
666
667   TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
668            engine_type);
669   return lctx_index;
670 }
671
672 u32
673 tls_stop_listen (u32 lctx_index)
674 {
675   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
676   crypto_engine_type_t engine_type;
677   transport_connection_t *lc;
678   tls_ctx_t *lctx;
679   session_t *ls;
680   int rv;
681
682   lctx = tls_listener_ctx_get (lctx_index);
683
684   /* Cleanup listener from session lookup table */
685   ls = session_get_from_handle (lctx->tls_session_handle);
686   lc = session_get_transport (ls);
687
688   sep.fib_index = lc->fib_index;
689   sep.port = lc->lcl_port;
690   sep.is_ip4 = lc->is_ip4;
691   sep.transport_proto = TRANSPORT_PROTO_TLS;
692   clib_memcpy (&sep.ip, &lc->lcl_ip, sizeof (lc->lcl_ip));
693   session_lookup_del_session_endpoint2 (&sep);
694
695   vnet_unlisten_args_t a = {
696     .handle = lctx->tls_session_handle,
697     .app_index = tls_main.app_index,
698     .wrk_map_index = 0          /* default wrk */
699   };
700   if ((rv = vnet_unlisten (&a)))
701     clib_warning ("unlisten returned %d", rv);
702
703   engine_type = lctx->tls_ctx_engine;
704   tls_vfts[engine_type].ctx_stop_listen (lctx);
705
706   tls_listener_ctx_free (lctx);
707   return 0;
708 }
709
710 transport_connection_t *
711 tls_connection_get (u32 ctx_index, u32 thread_index)
712 {
713   tls_ctx_t *ctx;
714   ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
715   return &ctx->connection;
716 }
717
718 transport_connection_t *
719 tls_listener_get (u32 listener_index)
720 {
721   tls_ctx_t *ctx;
722   ctx = tls_listener_ctx_get (listener_index);
723   return &ctx->connection;
724 }
725
726 int
727 tls_custom_tx_callback (void *session, transport_send_params_t * sp)
728 {
729   session_t *app_session = (session_t *) session;
730   tls_ctx_t *ctx;
731
732   if (PREDICT_FALSE (app_session->session_state
733                      >= SESSION_STATE_TRANSPORT_CLOSED))
734     return 0;
735
736   ctx = tls_ctx_get (app_session->connection_index);
737   return tls_ctx_write (ctx, app_session, sp);
738 }
739
740 u8 *
741 format_tls_ctx (u8 * s, va_list * args)
742 {
743   u32 tcp_si, tcp_ti, ctx_index, ctx_engine, app_si, app_ti;
744   tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
745
746   session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
747   tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
748   session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
749   s = format (s, "[%d:%d][TLS] app_wrk %u index %u engine %u tcp %d:%d",
750               app_ti, app_si, ctx->parent_app_wrk_index, ctx_index,
751               ctx_engine, tcp_ti, tcp_si);
752
753   return s;
754 }
755
756 static u8 *
757 format_tls_listener_ctx (u8 * s, va_list * args)
758 {
759   session_t *tls_listener;
760   app_listener_t *al;
761   u32 app_si, app_ti;
762   tls_ctx_t *ctx;
763
764   ctx = va_arg (*args, tls_ctx_t *);
765
766   al = app_listener_get_w_handle (ctx->tls_session_handle);
767   tls_listener = app_listener_get_session (al);
768   session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
769   s = format (s, "[%d:%d][TLS] app_wrk %u engine %u tcp %d:%d",
770               app_ti, app_si, ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
771               tls_listener->thread_index, tls_listener->session_index);
772
773   return s;
774 }
775
776 static u8 *
777 format_tls_ctx_state (u8 * s, va_list * args)
778 {
779   tls_ctx_t *ctx;
780   session_t *ts;
781
782   ctx = va_arg (*args, tls_ctx_t *);
783   ts = session_get_from_handle (ctx->app_session_handle);
784   if (ts->session_state == SESSION_STATE_LISTENING)
785     s = format (s, "%s", "LISTEN");
786   else if (tls_ctx_handshake_is_over (ctx))
787     s = format (s, "%s", "ESTABLISHED");
788   else
789     s = format (s, "%s", "HANDSHAKE");
790
791   return s;
792 }
793
794 u8 *
795 format_tls_connection (u8 * s, va_list * args)
796 {
797   u32 ctx_index = va_arg (*args, u32);
798   u32 thread_index = va_arg (*args, u32);
799   u32 verbose = va_arg (*args, u32);
800   tls_ctx_t *ctx;
801
802   ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
803   if (!ctx)
804     return s;
805
806   s = format (s, "%-50U", format_tls_ctx, ctx);
807   if (verbose)
808     {
809       s = format (s, "%-15U", format_tls_ctx_state, ctx);
810       if (verbose > 1)
811         s = format (s, "\n");
812     }
813   return s;
814 }
815
816 u8 *
817 format_tls_listener (u8 * s, va_list * args)
818 {
819   u32 tc_index = va_arg (*args, u32);
820   u32 __clib_unused thread_index = va_arg (*args, u32);
821   u32 verbose = va_arg (*args, u32);
822   tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
823
824   s = format (s, "%-50U", format_tls_listener_ctx, ctx);
825   if (verbose)
826     s = format (s, "%-15U", format_tls_ctx_state, ctx);
827   return s;
828 }
829
830 u8 *
831 format_tls_half_open (u8 * s, va_list * args)
832 {
833   u32 tc_index = va_arg (*args, u32);
834   u32 __clib_unused thread_index = va_arg (*args, u32);
835   tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
836   s = format (s, "[TLS] half-open app %u", ctx->parent_app_wrk_index);
837   tls_ctx_half_open_reader_unlock ();
838   return s;
839 }
840
841 static void
842 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
843                             transport_endpoint_t * tep, u8 is_lcl)
844 {
845   tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
846   session_t *tcp_session;
847
848   tcp_session = session_get_from_handle (ctx->tls_session_handle);
849   session_get_endpoint (tcp_session, tep, is_lcl);
850 }
851
852 static void
853 tls_transport_listener_endpoint_get (u32 ctx_handle,
854                                      transport_endpoint_t * tep, u8 is_lcl)
855 {
856   session_t *tls_listener;
857   app_listener_t *al;
858   tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
859
860   al = app_listener_get_w_handle (ctx->tls_session_handle);
861   tls_listener = app_listener_get_session (al);
862   session_get_endpoint (tls_listener, tep, is_lcl);
863 }
864
865 /* *INDENT-OFF* */
866 static const transport_proto_vft_t tls_proto = {
867   .connect = tls_connect,
868   .close = tls_disconnect,
869   .start_listen = tls_start_listen,
870   .stop_listen = tls_stop_listen,
871   .get_connection = tls_connection_get,
872   .get_listener = tls_listener_get,
873   .custom_tx = tls_custom_tx_callback,
874   .format_connection = format_tls_connection,
875   .format_half_open = format_tls_half_open,
876   .format_listener = format_tls_listener,
877   .get_transport_endpoint = tls_transport_endpoint_get,
878   .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
879   .transport_options = {
880     .name = "tls",
881     .short_name = "J",
882     .tx_type = TRANSPORT_TX_INTERNAL,
883     .service_type = TRANSPORT_SERVICE_APP,
884   },
885 };
886 /* *INDENT-ON* */
887
888 void
889 tls_register_engine (const tls_engine_vft_t * vft, crypto_engine_type_t type)
890 {
891   vec_validate (tls_vfts, type);
892   tls_vfts[type] = *vft;
893 }
894
895 static clib_error_t *
896 tls_init (vlib_main_t * vm)
897 {
898   u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
899   vlib_thread_main_t *vtm = vlib_get_thread_main ();
900   u32 num_threads, fifo_size = 128 << 12;
901   vnet_app_attach_args_t _a, *a = &_a;
902   u64 options[APP_OPTIONS_N_OPTIONS];
903   tls_main_t *tm = &tls_main;
904
905   first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
906   fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
907   num_threads = 1 /* main thread */  + vtm->n_threads;
908
909   clib_memset (a, 0, sizeof (*a));
910   clib_memset (options, 0, sizeof (options));
911
912   a->session_cb_vft = &tls_app_cb_vft;
913   a->api_client_index = APP_INVALID_INDEX;
914   a->options = options;
915   a->name = format (0, "tls");
916   a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
917   a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
918   a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
919   a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
920   a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
921   a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
922   a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
923
924   if (vnet_application_attach (a))
925     {
926       clib_warning ("failed to attach tls app");
927       return clib_error_return (0, "failed to attach tls app");
928     }
929
930   if (!tm->ca_cert_path)
931     tm->ca_cert_path = TLS_CA_CERT_PATH;
932
933   tm->app_index = a->app_index;
934   clib_rwlock_init (&tm->half_open_rwlock);
935
936   vec_validate (tm->rx_bufs, num_threads - 1);
937   vec_validate (tm->tx_bufs, num_threads - 1);
938
939   transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
940                                FIB_PROTOCOL_IP4, ~0);
941   transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
942                                FIB_PROTOCOL_IP6, ~0);
943   vec_free (a->name);
944   return 0;
945 }
946
947 VLIB_INIT_FUNCTION (tls_init);
948
949 static clib_error_t *
950 tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
951 {
952   tls_main_t *tm = &tls_main;
953   uword tmp;
954   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
955     {
956       if (unformat (input, "use-test-cert-in-ca"))
957         tm->use_test_cert_in_ca = 1;
958       else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
959         ;
960       else if (unformat (input, "first-segment-size %U", unformat_memory_size,
961                          &tm->first_seg_size))
962         ;
963       else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
964         {
965           if (tmp >= 0x100000000ULL)
966             {
967               return clib_error_return
968                 (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
969             }
970           tm->fifo_size = tmp;
971         }
972       else
973         return clib_error_return (0, "unknown input `%U'",
974                                   format_unformat_error, input);
975     }
976   return 0;
977 }
978
979 VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
980
981 tls_main_t *
982 vnet_tls_get_main (void)
983 {
984   return &tls_main;
985 }
986
987 /*
988  * fd.io coding-style-patch-verification: ON
989  *
990  * Local Variables:
991  * eval: (c-set-style "gnu")
992  * End:
993  */