FD.io VPP  v19.08.1-401-g8e4ed521a
Vector Packet Processing
tls.c
Go to the documentation of this file.
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 
17 #include <vppinfra/lock.h>
18 #include <vnet/tls/tls.h>
19 
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
31 {
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 
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 TLS_ENGINE_NONE;
51 }
52 
53 int
55 {
56  if (svm_fifo_set_event (s->rx_fifo))
58  return 0;
59 }
60 
61 int
63 {
64  if (svm_fifo_set_event (s->rx_fifo))
66  return 0;
67 }
68 
69 int
71 {
72  if (svm_fifo_set_event (s->tx_fifo))
74  return 0;
75 }
76 
77 int
79 {
80  if (svm_fifo_set_event (s->tx_fifo))
83  return 0;
84 }
85 
86 static inline int
88 {
89  return app_worker_lock_and_send_event (app, app_session, SESSION_IO_EVT_RX);
90 }
91 
92 u32
94 {
95  tls_main_t *tm = &tls_main;
96  tls_ctx_t *ctx;
97 
98  pool_get (tm->listener_ctx_pool, ctx);
99  clib_memset (ctx, 0, sizeof (*ctx));
100  return ctx - tm->listener_ctx_pool;
101 }
102 
103 void
105 {
106  if (CLIB_DEBUG)
107  memset (ctx, 0xfb, sizeof (*ctx));
108  pool_put (tls_main.listener_ctx_pool, ctx);
109 }
110 
111 tls_ctx_t *
113 {
114  return pool_elt_at_index (tls_main.listener_ctx_pool, ctx_index);
115 }
116 
117 u32
119 {
120  return (ctx - tls_main.listener_ctx_pool);
121 }
122 
123 u32
125 {
126  tls_main_t *tm = &tls_main;
127  u8 will_expand = 0;
128  tls_ctx_t *ctx;
129  u32 ctx_index;
130 
131  pool_get_aligned_will_expand (tm->half_open_ctx_pool, will_expand, 0);
132  if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
133  {
135  pool_get (tm->half_open_ctx_pool, ctx);
136  ctx_index = ctx - tm->half_open_ctx_pool;
138  }
139  else
140  {
141  /* reader lock assumption: only main thread will call pool_get */
143  pool_get (tm->half_open_ctx_pool, ctx);
144  ctx_index = ctx - tm->half_open_ctx_pool;
146  }
147  clib_memset (ctx, 0, sizeof (*ctx));
148  return ctx_index;
149 }
150 
151 void
153 {
154  tls_main_t *tm = &tls_main;
156  pool_put_index (tls_main.half_open_ctx_pool, ho_index);
158 }
159 
160 tls_ctx_t *
162 {
163  tls_main_t *tm = &tls_main;
165  return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
166 }
167 
168 void
170 {
172 }
173 
174 u32
176 {
177  return (ctx - tls_main.half_open_ctx_pool);
178 }
179 
180 void
182 {
183  app_worker_t *app_wrk;
184  app_wrk = app_worker_get_if_valid (app_session->app_wrk_index);
185  if (PREDICT_TRUE (app_wrk != 0))
186  tls_add_app_q_evt (app_wrk, app_session);
187 }
188 
189 int
191 {
192  session_t *app_listener, *app_session;
193  app_worker_t *app_wrk;
194  tls_ctx_t *lctx;
195  int rv;
196 
197  lctx = tls_listener_ctx_get (ctx->listener_ctx_index);
198  app_listener = listen_session_get_from_handle (lctx->app_session_handle);
199 
200  app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
201  app_session->app_wrk_index = ctx->parent_app_wrk_index;
202  app_session->connection_index = ctx->tls_ctx_handle;
203  app_session->session_type = app_listener->session_type;
204  app_session->listener_handle = listen_session_get_handle (app_listener);
205  app_session->session_state = SESSION_STATE_ACCEPTING;
206 
207  if ((rv = app_worker_init_accepted (app_session)))
208  {
209  TLS_DBG (1, "failed to allocate fifos");
210  session_free (app_session);
211  return rv;
212  }
213  ctx->app_session_handle = session_handle (app_session);
215  session_handle (app_session));
216  ctx->parent_app_wrk_index = app_session->app_wrk_index;
217  app_wrk = app_worker_get (app_session->app_wrk_index);
218  return app_worker_accept_notify (app_wrk, app_session);
219 }
220 
221 int
223 {
224  session_t *app_session;
225  app_worker_t *app_wrk;
226 
227  app_wrk = app_worker_get_if_valid (ctx->parent_app_wrk_index);
228  if (!app_wrk)
229  {
231  return -1;
232  }
233 
234  if (is_failed)
235  goto failed;
236 
237  app_session = session_get (ctx->c_s_index, ctx->c_thread_index);
238  app_session->app_wrk_index = ctx->parent_app_wrk_index;
239  app_session->connection_index = ctx->tls_ctx_handle;
240  app_session->session_type =
241  session_type_from_proto_and_ip (TRANSPORT_PROTO_TLS, ctx->tcp_is_ip4);
242 
243  if (app_worker_init_connected (app_wrk, app_session))
244  goto failed;
245 
246  app_session->session_state = SESSION_STATE_CONNECTING;
247  if (app_worker_connect_notify (app_wrk, app_session,
248  ctx->parent_app_api_context))
249  {
250  TLS_DBG (1, "failed to notify app");
251  tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
252  return -1;
253  }
254 
255  ctx->app_session_handle = session_handle (app_session);
256  app_session->session_state = SESSION_STATE_READY;
258  session_handle (app_session));
259 
260  return 0;
261 
262 failed:
263  /* Free app session pre-allocated when transport was established */
264  session_free (session_get (ctx->c_s_index, ctx->c_thread_index));
265  ctx->no_app_session = 1;
266  tls_disconnect (ctx->tls_ctx_handle, vlib_get_thread_index ());
267  return app_worker_connect_notify (app_wrk, 0, ctx->parent_app_api_context);
268 }
269 
270 static inline void
271 tls_ctx_parse_handle (u32 ctx_handle, u32 * ctx_index, u32 * engine_type)
272 {
273  *ctx_index = ctx_handle & TLS_IDX_MASK;
274  *engine_type = ctx_handle >> TLS_ENGINE_TYPE_SHIFT;
275 }
276 
277 static inline tls_engine_type_t
279 {
280  if (!tls_vfts[preferred].ctx_alloc)
281  return tls_get_available_engine ();
282  return preferred;
283 }
284 
285 static inline u32
287 {
288  u32 ctx_index;
289  ctx_index = tls_vfts[engine_type].ctx_alloc ();
290  return (((u32) engine_type << TLS_ENGINE_TYPE_SHIFT) | ctx_index);
291 }
292 
293 static inline tls_ctx_t *
294 tls_ctx_get (u32 ctx_handle)
295 {
296  u32 ctx_index, engine_type;
297  tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
298  return tls_vfts[engine_type].ctx_get (ctx_index);
299 }
300 
301 static inline tls_ctx_t *
302 tls_ctx_get_w_thread (u32 ctx_handle, u8 thread_index)
303 {
304  u32 ctx_index, engine_type;
305  tls_ctx_parse_handle (ctx_handle, &ctx_index, &engine_type);
306  return tls_vfts[engine_type].ctx_get_w_thread (ctx_index, thread_index);
307 }
308 
309 static inline int
311 {
312  return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
313 }
314 
315 static inline int
317 {
318  return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
319 }
320 
321 static inline int
323 {
324  return tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session);
325 }
326 
327 static inline int
329 {
330  return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
331 }
332 
333 static inline int
335 {
336  return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
337 }
338 
339 static inline int
341 {
342  return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
343 }
344 
345 void
347 {
348  tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
349 }
350 
351 u8
353 {
354  return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
355 }
356 
357 void
359 {
360  tls_ctx_t *ctx;
362  session_t *app_session;
363 
364  ctx = tls_ctx_get (s->opaque);
365  tc = &ctx->connection;
366  if (tls_ctx_handshake_is_over (ctx))
367  {
370  }
371  else if ((app_session = session_get (tc->s_index, tc->thread_index)))
372  session_free (app_session);
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
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 ()
399 
400  ctx = tls_ctx_get_w_thread (tls_session->opaque, tls_session->thread_index);
401  ctx->is_passive_close = 1;
403 }
404 
405 int
407 {
408  session_t *tls_listener, *app_session;
409  tls_ctx_t *lctx, *ctx;
410  u32 ctx_handle;
411 
412  tls_listener =
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 
427  /* Preallocate app session. Avoids allocating a session post handshake
428  * on tls_session rx and potentially invalidating the session pool */
429  app_session = session_alloc (ctx->c_thread_index);
430  app_session->session_state = SESSION_STATE_CREATED;
431  ctx->c_s_index = app_session->session_index;
432 
433  TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
434  tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
435 
436  return tls_ctx_init_server (ctx);
437 }
438 
439 int
441 {
442  tls_ctx_t *ctx;
443 
444  ctx = tls_ctx_get (tls_session->opaque);
445  tls_ctx_read (ctx, tls_session);
446  return 0;
447 }
448 
449 int
450 tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
451  session_t * tls_session, u8 is_fail)
452 {
453  session_t *app_session;
454  tls_ctx_t *ho_ctx, *ctx;
455  u32 ctx_handle;
456 
457  ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
458 
459  if (is_fail)
460  {
461  app_worker_t *app_wrk;
462  u32 api_context;
463  int rv = 0;
464 
465  app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
466  if (app_wrk)
467  {
468  api_context = ho_ctx->c_s_index;
469  app_worker_connect_notify (app_wrk, 0, api_context);
470  }
472  tls_ctx_half_open_free (ho_ctx_index);
473  return rv;
474  }
475 
476  ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
477  ctx = tls_ctx_get (ctx_handle);
478  clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
480  tls_ctx_half_open_free (ho_ctx_index);
481 
482  ctx->c_thread_index = vlib_get_thread_index ();
483  ctx->tls_ctx_handle = ctx_handle;
484  ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
485 
486  TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
487  ho_ctx_index, is_fail, vlib_get_thread_index (),
488  (ctx) ? ctx_handle : ~0);
489 
490  ctx->tls_session_handle = session_handle (tls_session);
491  tls_session->opaque = ctx_handle;
492  tls_session->session_state = SESSION_STATE_READY;
493 
494  /* Preallocate app session. Avoids allocating a session post handshake
495  * on tls_session rx and potentially invalidating the session pool */
496  app_session = session_alloc (ctx->c_thread_index);
497  app_session->session_state = SESSION_STATE_CREATED;
498  ctx->c_s_index = app_session->session_index;
499 
500  return tls_ctx_init_client (ctx);
501 }
502 
503 static void
505 {
506  tls_ctx_t *ctx;
507 
508  if (ntf == SESSION_CLEANUP_TRANSPORT)
509  return;
510 
511  ctx = tls_ctx_get (s->opaque);
512  if (!ctx->no_app_session)
514  tls_ctx_free (ctx);
515 }
516 
517 /* *INDENT-OFF* */
519  .session_accept_callback = tls_session_accept_callback,
520  .session_disconnect_callback = tls_session_disconnect_callback,
521  .session_connected_callback = tls_session_connected_callback,
522  .session_reset_callback = tls_session_reset_callback,
523  .add_segment_callback = tls_add_segment_callback,
524  .del_segment_callback = tls_del_segment_callback,
525  .builtin_app_rx_callback = tls_app_rx_callback,
526  .session_cleanup_callback = tls_app_session_cleanup,
527 };
528 /* *INDENT-ON* */
529 
530 int
532 {
533  vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
535  tls_engine_type_t engine_type;
536  tls_main_t *tm = &tls_main;
537  app_worker_t *app_wrk;
538  application_t *app;
539  tls_ctx_t *ctx;
540  u32 ctx_index;
541  int rv;
542 
543  sep = (session_endpoint_cfg_t *) tep;
544  app_wrk = app_worker_get (sep->app_wrk_index);
545  app = application_get (app_wrk->app_index);
546  engine_type = tls_get_engine_type (app->tls_engine);
547  if (engine_type == TLS_ENGINE_NONE)
548  {
549  clib_warning ("No tls engine_type available");
550  return -1;
551  }
552 
553  ctx_index = tls_ctx_half_open_alloc ();
554  ctx = tls_ctx_half_open_get (ctx_index);
555  ctx->parent_app_wrk_index = sep->app_wrk_index;
556  ctx->parent_app_api_context = sep->opaque;
557  ctx->tcp_is_ip4 = sep->is_ip4;
558  if (sep->hostname)
559  {
560  ctx->srv_hostname = format (0, "%v", sep->hostname);
562  }
564 
566  ctx->tls_ctx_engine = engine_type;
567 
568  clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
569  cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
570  cargs->app_index = tm->app_index;
571  cargs->api_context = ctx_index;
572  cargs->sep_ext.ns_index = app->ns_index;
573  if ((rv = vnet_connect (cargs)))
574  return rv;
575 
576  TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
577  return 0;
578 }
579 
580 void
581 tls_disconnect (u32 ctx_handle, u32 thread_index)
582 {
583  tls_ctx_t *ctx;
584 
585  TLS_DBG (1, "Disconnecting %x", ctx_handle);
586 
587  ctx = tls_ctx_get (ctx_handle);
588  tls_ctx_app_close (ctx);
589 }
590 
591 u32
592 tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
593 {
594  vnet_listen_args_t _bargs, *args = &_bargs;
595  app_worker_t *app_wrk;
596  tls_main_t *tm = &tls_main;
597  session_handle_t tls_al_handle;
599  session_t *tls_listener;
600  session_t *app_listener;
601  tls_engine_type_t engine_type;
602  application_t *app;
603  app_listener_t *al;
604  tls_ctx_t *lctx;
605  u32 lctx_index;
606 
607  sep = (session_endpoint_cfg_t *) tep;
608  app_wrk = app_worker_get (sep->app_wrk_index);
609  app = application_get (app_wrk->app_index);
610  engine_type = tls_get_engine_type (app->tls_engine);
611  if (engine_type == TLS_ENGINE_NONE)
612  {
613  clib_warning ("No tls engine_type available");
614  return -1;
615  }
616 
617  sep->transport_proto = TRANSPORT_PROTO_TCP;
618  clib_memset (args, 0, sizeof (*args));
619  args->app_index = tm->app_index;
620  args->sep_ext = *sep;
621  args->sep_ext.ns_index = app->ns_index;
622  if (vnet_listen (args))
623  return -1;
624 
625  lctx_index = tls_listener_ctx_alloc ();
626  tls_al_handle = args->handle;
627  al = app_listener_get_w_handle (tls_al_handle);
628  tls_listener = app_listener_get_session (al);
629  tls_listener->opaque = lctx_index;
630 
631  app_listener = listen_session_get (app_listener_index);
632 
633  lctx = tls_listener_ctx_get (lctx_index);
634  lctx->parent_app_wrk_index = sep->app_wrk_index;
635  lctx->tls_session_handle = tls_al_handle;
636  lctx->app_session_handle = listen_session_get_handle (app_listener);
637  lctx->tcp_is_ip4 = sep->is_ip4;
638  lctx->tls_ctx_engine = engine_type;
639 
640  if (tls_vfts[engine_type].ctx_start_listen (lctx))
641  {
643  .handle = lctx->tls_session_handle,
644  .app_index = tls_main.app_index,
645  .wrk_map_index = 0
646  };
647  if ((vnet_unlisten (&a)))
648  clib_warning ("unlisten returned");
649  tls_listener_ctx_free (lctx);
650  lctx_index = SESSION_INVALID_INDEX;
651  }
652 
653  TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
654  engine_type);
655  return lctx_index;
656 }
657 
658 u32
659 tls_stop_listen (u32 lctx_index)
660 {
661  tls_engine_type_t engine_type;
662  tls_ctx_t *lctx;
663  int rv;
664 
665  lctx = tls_listener_ctx_get (lctx_index);
667  .handle = lctx->tls_session_handle,
668  .app_index = tls_main.app_index,
669  .wrk_map_index = 0 /* default wrk */
670  };
671  if ((rv = vnet_unlisten (&a)))
672  clib_warning ("unlisten returned %d", rv);
673 
674  engine_type = lctx->tls_ctx_engine;
675  tls_vfts[engine_type].ctx_stop_listen (lctx);
676 
677  tls_listener_ctx_free (lctx);
678  return 0;
679 }
680 
682 tls_connection_get (u32 ctx_index, u32 thread_index)
683 {
684  tls_ctx_t *ctx;
685  ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
686  return &ctx->connection;
687 }
688 
690 tls_listener_get (u32 listener_index)
691 {
692  tls_ctx_t *ctx;
693  ctx = tls_listener_ctx_get (listener_index);
694  return &ctx->connection;
695 }
696 
697 int
698 tls_custom_tx_callback (void *session, u32 max_burst_size)
699 {
700  session_t *app_session = (session_t *) session;
701  tls_ctx_t *ctx;
702 
703  if (PREDICT_FALSE (app_session->session_state
704  >= SESSION_STATE_TRANSPORT_CLOSED))
705  return 0;
706 
707  ctx = tls_ctx_get (app_session->connection_index);
708  tls_ctx_write (ctx, app_session);
709  return 0;
710 }
711 
712 u8 *
713 format_tls_ctx (u8 * s, va_list * args)
714 {
715  u32 tcp_si, tcp_ti, ctx_index, ctx_engine, app_si, app_ti;
716  tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
717 
718  session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
719  tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
720  session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
721  s = format (s, "[%d:%d][TLS] app_wrk %u index %u engine %u tcp %d:%d",
722  app_ti, app_si, ctx->parent_app_wrk_index, ctx_index,
723  ctx_engine, tcp_ti, tcp_si);
724 
725  return s;
726 }
727 
728 u8 *
729 format_tls_connection (u8 * s, va_list * args)
730 {
731  u32 ctx_index = va_arg (*args, u32);
732  u32 thread_index = va_arg (*args, u32);
733  u32 verbose = va_arg (*args, u32);
734  tls_ctx_t *ctx;
735 
736  ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
737  if (!ctx)
738  return s;
739 
740  s = format (s, "%-50U", format_tls_ctx, ctx);
741  if (verbose)
742  {
743  session_t *ts;
744  ts = session_get_from_handle (ctx->app_session_handle);
745  s = format (s, "state: %-7u", ts->session_state);
746  if (verbose > 1)
747  s = format (s, "\n");
748  }
749  return s;
750 }
751 
752 u8 *
753 format_tls_listener (u8 * s, va_list * args)
754 {
755  u32 tc_index = va_arg (*args, u32);
756  u32 __clib_unused thread_index = va_arg (*args, u32);
757  u32 __clib_unused verbose = va_arg (*args, u32);
758  tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
759  session_t *tls_listener;
760  app_listener_t *al;
761  u32 app_si, app_ti;
762 
763  al = app_listener_get_w_handle (ctx->tls_session_handle);
764  tls_listener = app_listener_get_session (al);
765  session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
766  s = format (s, "[%d:%d][TLS] app_wrk %u engine %u tcp %d:%d",
767  app_ti, app_si, ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
768  tls_listener->thread_index, tls_listener->session_index);
769  return s;
770 }
771 
772 u8 *
773 format_tls_half_open (u8 * s, va_list * args)
774 {
775  u32 tc_index = va_arg (*args, u32);
776  u32 __clib_unused thread_index = va_arg (*args, u32);
777  tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
778  s = format (s, "[TLS] half-open app %u", ctx->parent_app_wrk_index);
780  return s;
781 }
782 
783 static void
784 tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
785  transport_endpoint_t * tep, u8 is_lcl)
786 {
787  tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
788  session_t *tcp_session;
789 
790  tcp_session = session_get_from_handle (ctx->tls_session_handle);
791  session_get_endpoint (tcp_session, tep, is_lcl);
792 }
793 
794 static void
796  transport_endpoint_t * tep, u8 is_lcl)
797 {
798  session_t *tls_listener;
799  app_listener_t *al;
800  tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
801 
802  al = app_listener_get_w_handle (ctx->tls_session_handle);
803  tls_listener = app_listener_get_session (al);
804  session_get_endpoint (tls_listener, tep, is_lcl);
805 }
806 
807 /* *INDENT-OFF* */
809  .connect = tls_connect,
810  .close = tls_disconnect,
811  .start_listen = tls_start_listen,
812  .stop_listen = tls_stop_listen,
813  .get_connection = tls_connection_get,
814  .get_listener = tls_listener_get,
815  .custom_tx = tls_custom_tx_callback,
816  .format_connection = format_tls_connection,
817  .format_half_open = format_tls_half_open,
818  .format_listener = format_tls_listener,
819  .get_transport_endpoint = tls_transport_endpoint_get,
820  .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
821  .transport_options = {
822  .tx_type = TRANSPORT_TX_INTERNAL,
823  .service_type = TRANSPORT_SERVICE_APP,
824  },
825 };
826 /* *INDENT-ON* */
827 
828 void
830 {
831  vec_validate (tls_vfts, type);
832  tls_vfts[type] = *vft;
833 }
834 
835 static clib_error_t *
837 {
838  u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
840  u32 num_threads, fifo_size = 128 << 10;
841  vnet_app_attach_args_t _a, *a = &_a;
843  tls_main_t *tm = &tls_main;
844 
845  first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
846  fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
847  num_threads = 1 /* main thread */ + vtm->n_threads;
848 
849  clib_memset (a, 0, sizeof (*a));
850  clib_memset (options, 0, sizeof (options));
851 
852  a->session_cb_vft = &tls_app_cb_vft;
853  a->api_client_index = APP_INVALID_INDEX;
854  a->options = options;
855  a->name = format (0, "tls");
856  a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
857  a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
858  a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
859  a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
860  a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
861  a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
862  a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
863 
864  if (vnet_application_attach (a))
865  {
866  clib_warning ("failed to attach tls app");
867  return clib_error_return (0, "failed to attach tls app");
868  }
869 
870  if (!tm->ca_cert_path)
872 
873  tm->app_index = a->app_index;
875 
876  vec_validate (tm->rx_bufs, num_threads - 1);
877  vec_validate (tm->tx_bufs, num_threads - 1);
878 
879  transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
880  FIB_PROTOCOL_IP4, ~0);
881  transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
882  FIB_PROTOCOL_IP6, ~0);
883  vec_free (a->name);
884  return 0;
885 }
886 
888 
889 static clib_error_t *
891 {
892  tls_main_t *tm = &tls_main;
893  uword tmp;
895  {
896  if (unformat (input, "use-test-cert-in-ca"))
897  tm->use_test_cert_in_ca = 1;
898  else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
899  ;
900  else if (unformat (input, "first-segment-size %U", unformat_memory_size,
901  &tm->first_seg_size))
902  ;
903  else if (unformat (input, "fifo-size %U", unformat_memory_size, &tmp))
904  {
905  if (tmp >= 0x100000000ULL)
906  {
907  return clib_error_return
908  (0, "fifo-size %llu (0x%llx) too large", tmp, tmp);
909  }
910  tm->fifo_size = tmp;
911  }
912  else
913  return clib_error_return (0, "unknown input `%U'",
914  format_unformat_error, input);
915  }
916  return 0;
917 }
918 
920 
921 tls_main_t *
923 {
924  return &tls_main;
925 }
926 
927 /*
928  * fd.io coding-style-patch-verification: ON
929  *
930  * Local Variables:
931  * eval: (c-set-style "gnu")
932  * End:
933  */
tls_main_t * vnet_tls_get_main(void)
Definition: tls.c:922
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:439
static void clib_rwlock_reader_lock(clib_rwlock_t *p)
Definition: lock.h:150
int app_worker_lock_and_send_event(app_worker_t *app, session_t *s, u8 evt_type)
Send event to application.
u32 connection_index
Index of the transport connection associated to the session.
static tls_main_t tls_main
Definition: tls.c:20
int app_worker_init_accepted(session_t *s)
static tls_engine_type_t tls_get_engine_type(tls_engine_type_t preferred)
Definition: tls.c:278
session_type_t session_type
Type built from transport and network protocol types.
a
Definition: bitmap.h:538
static const transport_proto_vft_t tls_proto
Definition: tls.c:808
static void clib_rwlock_writer_lock(clib_rwlock_t *p)
Definition: lock.h:173
void tls_disconnect_transport(tls_ctx_t *ctx)
Definition: tls.c:30
svm_fifo_t * tx_fifo
#define TLS_ENGINE_TYPE_SHIFT
Definition: tls.c:25
u32 ns_index
Namespace the application belongs to.
Definition: application.h:107
struct _vnet_connect_args vnet_connect_args_t
u8 no_app_session
Definition: tls.h:80
struct _vnet_unlisten_args_t vnet_unlisten_args_t
u32 tls_ctx_half_open_alloc(void)
Definition: tls.c:124
#define PREDICT_TRUE(x)
Definition: clib.h:112
u32 tls_listener_ctx_alloc(void)
Definition: tls.c:93
void tls_session_reset_callback(session_t *s)
Definition: tls.c:358
u32 session_index
Index in thread pool where session was allocated.
clib_rwlock_t half_open_rwlock
Definition: tls.h:89
unsigned long u64
Definition: types.h:89
char * ca_cert_path
Definition: tls.h:97
int(* ctx_init_server)(tls_ctx_t *ctx)
Definition: tls.h:109
#define clib_memcpy_fast(a, b, c)
Definition: string.h:81
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
void session_transport_delete_notify(transport_connection_t *tc)
Notification from transport that connection is being deleted.
Definition: session.c:878
svm_fifo_t * rx_fifo
Pointers to rx/tx buffers.
int tls_add_vpp_q_builtin_rx_evt(session_t *s)
Definition: tls.c:62
static clib_error_t * tls_config_fn(vlib_main_t *vm, unformat_input_t *input)
Definition: tls.c:890
static session_t * listen_session_get_from_handle(session_handle_t handle)
Definition: session.h:544
#define pool_get_aligned_will_expand(P, YESNO, A)
See if pool_get will expand the pool or not.
Definition: pool.h:242
#define vec_terminate_c_string(V)
(If necessary) NULL terminate a vector containing a c-string.
Definition: vec.h:1014
tls_ctx_t *(* ctx_get_w_thread)(u32 ctx_index, u8 thread_index)
Definition: tls.h:107
void session_transport_reset_notify(transport_connection_t *tc)
Notify application that connection has been reset.
Definition: session.c:979
u8 * format_tls_connection(u8 *s, va_list *args)
Definition: tls.c:729
int i
void(* ctx_free)(tls_ctx_t *ctx)
Definition: tls.h:105
int(* ctx_init_client)(tls_ctx_t *ctx)
Definition: tls.h:108
u8 use_test_cert_in_ca
Definition: tls.h:96
transport_connection_t * tls_connection_get(u32 ctx_index, u32 thread_index)
Definition: tls.c:682
void tls_session_disconnect_callback(session_t *tls_session)
Definition: tls.c:390
static session_t * session_get(u32 si, u32 thread_index)
Definition: session.h:293
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
int vnet_unlisten(vnet_unlisten_args_t *a)
Definition: application.c:1039
int tls_app_rx_callback(session_t *tls_session)
Definition: tls.c:440
int(* ctx_read)(tls_ctx_t *ctx, session_t *tls_session)
Definition: tls.h:110
static int tls_ctx_read(tls_ctx_t *ctx, session_t *tls_session)
Definition: tls.c:328
#define pool_get(P, E)
Allocate an object E from a pool P (unspecified alignment).
Definition: pool.h:236
static tls_ctx_t * tls_ctx_get_w_thread(u32 ctx_handle, u8 thread_index)
Definition: tls.c:302
static void session_parse_handle(session_handle_t handle, u32 *index, u32 *thread_index)
unsigned char u8
Definition: types.h:56
struct _vnet_bind_args_t vnet_listen_args_t
static session_handle_t session_handle(session_t *s)
void session_get_endpoint(session_t *s, transport_endpoint_t *tep, u8 is_lcl)
Definition: session.c:1470
u32 app_index
Definition: tls.h:86
static int tls_ctx_transport_close(tls_ctx_t *ctx)
Definition: tls.c:334
void tls_listener_ctx_free(tls_ctx_t *ctx)
Definition: tls.c:104
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:173
struct _vnet_disconnect_args_t vnet_disconnect_args_t
u8 * format_tls_listener(u8 *s, va_list *args)
Definition: tls.c:753
static tls_engine_vft_t * tls_vfts
Definition: tls.c:21
u8 is_passive_close
Definition: tls.h:77
#define clib_error_return(e, args...)
Definition: error.h:99
static void tls_ctx_parse_handle(u32 ctx_handle, u32 *ctx_index, u32 *engine_type)
Definition: tls.c:271
int tls_del_segment_callback(u32 client_index, u64 segment_handle)
Definition: tls.c:384
unsigned int u32
Definition: types.h:88
int session_send_io_evt_to_thread(svm_fifo_t *f, session_evt_type_t evt_type)
Definition: session.c:79
tls_ctx_t *(* ctx_get)(u32 ctx_index)
Definition: tls.h:106
int tls_add_vpp_q_builtin_tx_evt(session_t *s)
Definition: tls.c:78
u8 tls_engine
Preferred tls engine.
Definition: application.h:125
struct _vnet_app_attach_args_t vnet_app_attach_args_t
struct _transport_proto_vft transport_proto_vft_t
struct _session_endpoint_cfg session_endpoint_cfg_t
vl_api_fib_path_type_t type
Definition: fib_types.api:123
static session_type_t session_type_from_proto_and_ip(transport_proto_t proto, u8 is_ip4)
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:514
static void clib_rwlock_init(clib_rwlock_t *p)
Definition: lock.h:133
#define TLS_IDX_MASK
Definition: tls.c:24
u32 tls_listener_ctx_index(tls_ctx_t *ctx)
Definition: tls.c:118
static void clib_rwlock_reader_unlock(clib_rwlock_t *p)
Definition: lock.h:165
int app_worker_accept_notify(app_worker_t *app_wrk, session_t *s)
static session_t * session_get_from_handle(session_handle_t handle)
Definition: session.h:313
session_t * app_listener_get_session(app_listener_t *al)
Definition: application.c:272
static int tls_add_app_q_evt(app_worker_t *app, session_t *app_session)
Definition: tls.c:87
static void tls_transport_listener_endpoint_get(u32 ctx_handle, transport_endpoint_t *tep, u8 is_lcl)
Definition: tls.c:795
u8(* ctx_handshake_is_over)(tls_ctx_t *ctx)
Definition: tls.h:112
long ctx[MAX_CONNS]
Definition: main.c:144
void tls_ctx_half_open_reader_unlock()
Definition: tls.c:169
struct _unformat_input_t unformat_input_t
Definition: tls.h:84
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:286
int tls_session_accept_callback(session_t *tls_session)
Definition: tls.c:406
#define APP_INVALID_INDEX
Definition: application.h:167
int tls_notify_app_connected(tls_ctx_t *ctx, u8 is_failed)
Definition: tls.c:222
#define PREDICT_FALSE(x)
Definition: clib.h:111
u64 first_seg_size
Definition: tls.h:98
static void tls_transport_endpoint_get(u32 ctx_handle, u32 thread_index, transport_endpoint_t *tep, u8 is_lcl)
Definition: tls.c:784
app_worker_t * app_worker_get_if_valid(u32 wrk_index)
#define SESSION_INVALID_INDEX
Definition: session_types.h:22
u8 tls_ctx_handshake_is_over(tls_ctx_t *ctx)
Definition: tls.c:352
Definition: tls.h:58
u32(* ctx_alloc)(void)
Definition: tls.h:104
static u64 listen_session_get_handle(session_t *s)
Definition: session.h:536
u32 fifo_size
Definition: tls.h:99
int(* ctx_write)(tls_ctx_t *ctx, session_t *app_session)
Definition: tls.h:111
int vnet_application_attach(vnet_app_attach_args_t *a)
Attach application to vpp.
Definition: application.c:809
static int tls_ctx_app_close(tls_ctx_t *ctx)
Definition: tls.c:340
static void clib_rwlock_writer_unlock(clib_rwlock_t *p)
Definition: lock.h:187
static u8 svm_fifo_set_event(svm_fifo_t *f)
Set fifo event flag.
Definition: svm_fifo.h:748
u8 * format_tls_ctx(u8 *s, va_list *args)
Definition: tls.c:713
app transport service
#define VLIB_EARLY_CONFIG_FUNCTION(x, n,...)
Definition: init.h:226
#define UNFORMAT_END_OF_INPUT
Definition: format.h:145
u8 ** rx_bufs
Definition: tls.h:90
session_handle_t listener_handle
Parent listener session index if the result of an accept.
tls_engine_type_t tls_get_available_engine(void)
Definition: tls.c:42
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:213
void tls_disconnect(u32 ctx_handle, u32 thread_index)
Definition: tls.c:581
vlib_main_t * vm
Definition: buffer.c:323
transport_connection_t * tls_listener_get(u32 listener_index)
Definition: tls.c:690
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
void session_free(session_t *s)
Definition: session.c:195
static int tls_ctx_write(tls_ctx_t *ctx, session_t *app_session)
Definition: tls.c:322
#define clib_warning(format, args...)
Definition: error.h:59
struct _stream_session_cb_vft session_cb_vft_t
Don&#39;t register connection in lookup Does not apply to local apps and transports using the network lay...
int tls_add_vpp_q_tx_evt(session_t *s)
Definition: tls.c:70
struct _transport_connection transport_connection_t
transport_connection_t connection
Definition: tls.h:62
static int tls_ctx_init_client(tls_ctx_t *ctx)
Definition: tls.c:316
int app_worker_init_connected(app_worker_t *app_wrk, session_t *s)
void tls_register_engine(const tls_engine_vft_t *vft, tls_engine_type_t type)
Definition: tls.c:829
static u8 vlib_thread_is_main_w_barrier(void)
Definition: threads.h:512
application_t * application_get(u32 app_index)
Definition: application.c:418
void transport_register_protocol(transport_proto_t transport_proto, const transport_proto_vft_t *vft, fib_protocol_t fib_proto, u32 output_node)
Register transport virtual function table.
Definition: transport.c:210
static tls_ctx_t * tls_ctx_get(u32 ctx_handle)
Definition: tls.c:294
int tls_add_segment_callback(u32 client_index, u64 segment_handle)
Definition: tls.c:377
int tls_connect(transport_endpoint_cfg_t *tep)
Definition: tls.c:531
static int tls_ctx_init_server(tls_ctx_t *ctx)
Definition: tls.c:310
apps acting as transports
app_listener_t * app_listener_get_w_handle(session_handle_t handle)
Get app listener for listener session handle.
Definition: application.c:88
#define pool_put_index(p, i)
Free pool element with given index.
Definition: pool.h:311
#define ASSERT(truth)
int tls_custom_tx_callback(void *session, u32 max_burst_size)
Definition: tls.c:698
int(* ctx_stop_listen)(tls_ctx_t *ctx)
Definition: tls.h:114
int vnet_listen(vnet_listen_args_t *a)
Definition: application.c:947
tls_ctx_t * tls_listener_ctx_get(u32 ctx_index)
Definition: tls.c:112
int vnet_connect(vnet_connect_args_t *a)
Definition: application.c:1001
tls_ctx_t * half_open_ctx_pool
Definition: tls.h:88
u8 thread_index
Index of the thread that allocated the session.
session_t * session_alloc(u32 thread_index)
Definition: session.c:169
u8 ** tx_bufs
Definition: tls.h:91
u32 tls_stop_listen(u32 lctx_index)
Definition: tls.c:659
int(* ctx_app_close)(tls_ctx_t *ctx)
Definition: tls.h:116
static void tls_app_session_cleanup(session_t *s, session_cleanup_ntf_t ntf)
Definition: tls.c:504
app_worker_t * app_worker_get(u32 wrk_index)
void tls_ctx_free(tls_ctx_t *ctx)
Definition: tls.c:346
u64 session_handle_t
u32 tls_ctx_half_open_index(tls_ctx_t *ctx)
Definition: tls.c:175
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
volatile u8 session_state
State in session layer state machine.
int tls_add_vpp_q_rx_evt(session_t *s)
Definition: tls.c:54
void session_transport_closed_notify(transport_connection_t *tc)
Notification from transport that it is closed.
Definition: session.c:944
u32 opaque
Opaque, for general use.
u64 uword
Definition: types.h:112
int app_worker_alloc_connects_segment_manager(app_worker_t *app)
int vnet_disconnect_session(vnet_disconnect_args_t *a)
Definition: application.c:1070
session_cleanup_ntf_t
u8 * srv_hostname
Definition: tls.h:81
int session_send_io_evt_to_thread_custom(void *data, u32 thread_index, session_evt_type_t evt_type)
Definition: session.c:86
unformat_function_t unformat_memory_size
Definition: format.h:296
int tls_notify_app_accept(tls_ctx_t *ctx)
Definition: tls.c:190
u32 app_index
Index of owning app.
Definition: application.h:43
int session_lookup_add_connection(transport_connection_t *tc, u64 value)
Add transport connection to a session table.
void tls_notify_app_enqueue(tls_ctx_t *ctx, session_t *app_session)
Definition: tls.c:181
static struct option options[]
Definition: main.c:52
void tls_ctx_half_open_free(u32 ho_index)
Definition: tls.c:152
u8 * format_unformat_error(u8 *s, va_list *va)
Definition: unformat.c:91
static vlib_thread_main_t * vlib_get_thread_main()
Definition: global_funcs.h:32
static u32 vlib_num_workers()
Definition: threads.h:367
static u32 tls_ctx_alloc(tls_engine_type_t engine_type)
Definition: tls.c:286
u32 app_wrk_index
Index of the app worker that owns the session.
#define TLS_CA_CERT_PATH
Definition: tls.h:29
struct _session_endpoint session_endpoint_t
enum tls_engine_type_ tls_engine_type_t
u8 * format_tls_half_open(u8 *s, va_list *args)
Definition: tls.c:773
int(* ctx_transport_close)(tls_ctx_t *ctx)
Definition: tls.h:115
static clib_error_t * tls_init(vlib_main_t *vm)
Definition: tls.c:836
static session_cb_vft_t tls_app_cb_vft
Definition: tls.c:518
int app_worker_connect_notify(app_worker_t *app_wrk, session_t *s, u32 opaque)
#define TLS_DBG(_lvl, _fmt, _args...)
Definition: tls.h:36
u32 tls_start_listen(u32 app_listener_index, transport_endpoint_t *tep)
Definition: tls.c:592
tls_ctx_t * listener_ctx_pool
Definition: tls.h:87
int tls_session_connected_callback(u32 tls_app_index, u32 ho_ctx_index, session_t *tls_session, u8 is_fail)
Definition: tls.c:450
static session_t * listen_session_get(u32 ls_index)
Definition: session.h:567
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
tls_ctx_t * tls_ctx_half_open_get(u32 ctx_index)
Definition: tls.c:161
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:171