tls.c revision 79f89537
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
20static tls_main_t tls_main;
21static 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
27void tls_disconnect (u32 ctx_handle, u32 thread_index);
28
29void
30tls_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
41tls_engine_type_t
42tls_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 TLS_ENGINE_NONE;
51}
52
53int
54tls_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
61int
62tls_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
69int
70tls_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
77int
78tls_add_vpp_q_builtin_tx_evt (session_t * s)
79{
80  if (svm_fifo_set_event (s->tx_fifo))
81    session_send_io_evt_to_thread_custom (s, s->thread_index,
82					  SESSION_IO_EVT_BUILTIN_TX);
83  return 0;
84}
85
86static inline int
87tls_add_app_q_evt (app_worker_t * app, session_t * app_session)
88{
89  return app_worker_lock_and_send_event (app, app_session, SESSION_IO_EVT_RX);
90}
91
92u32
93tls_listener_ctx_alloc (void)
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
103void
104tls_listener_ctx_free (tls_ctx_t * ctx)
105{
106  if (CLIB_DEBUG)
107    memset (ctx, 0xfb, sizeof (*ctx));
108  pool_put (tls_main.listener_ctx_pool, ctx);
109}
110
111tls_ctx_t *
112tls_listener_ctx_get (u32 ctx_index)
113{
114  return pool_elt_at_index (tls_main.listener_ctx_pool, ctx_index);
115}
116
117u32
118tls_listener_ctx_index (tls_ctx_t * ctx)
119{
120  return (ctx - tls_main.listener_ctx_pool);
121}
122
123u32
124tls_ctx_half_open_alloc (void)
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    {
134      clib_rwlock_writer_lock (&tm->half_open_rwlock);
135      pool_get (tm->half_open_ctx_pool, ctx);
136      ctx_index = ctx - tm->half_open_ctx_pool;
137      clib_rwlock_writer_unlock (&tm->half_open_rwlock);
138    }
139  else
140    {
141      /* reader lock assumption: only main thread will call pool_get */
142      clib_rwlock_reader_lock (&tm->half_open_rwlock);
143      pool_get (tm->half_open_ctx_pool, ctx);
144      ctx_index = ctx - tm->half_open_ctx_pool;
145      clib_rwlock_reader_unlock (&tm->half_open_rwlock);
146    }
147  clib_memset (ctx, 0, sizeof (*ctx));
148  return ctx_index;
149}
150
151void
152tls_ctx_half_open_free (u32 ho_index)
153{
154  tls_main_t *tm = &tls_main;
155  clib_rwlock_writer_lock (&tm->half_open_rwlock);
156  pool_put_index (tls_main.half_open_ctx_pool, ho_index);
157  clib_rwlock_writer_unlock (&tm->half_open_rwlock);
158}
159
160tls_ctx_t *
161tls_ctx_half_open_get (u32 ctx_index)
162{
163  tls_main_t *tm = &tls_main;
164  clib_rwlock_reader_lock (&tm->half_open_rwlock);
165  return pool_elt_at_index (tm->half_open_ctx_pool, ctx_index);
166}
167
168void
169tls_ctx_half_open_reader_unlock ()
170{
171  clib_rwlock_reader_unlock (&tls_main.half_open_rwlock);
172}
173
174u32
175tls_ctx_half_open_index (tls_ctx_t * ctx)
176{
177  return (ctx - tls_main.half_open_ctx_pool);
178}
179
180void
181tls_notify_app_enqueue (tls_ctx_t * ctx, session_t * app_session)
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
189int
190tls_notify_app_accept (tls_ctx_t * ctx)
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);
214  session_lookup_add_connection (&ctx->connection,
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
221int
222tls_notify_app_connected (tls_ctx_t * ctx, u8 is_failed)
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    {
230      tls_disconnect_transport (ctx);
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;
257  session_lookup_add_connection (&ctx->connection,
258				 session_handle (app_session));
259
260  return 0;
261
262failed:
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
270static inline void
271tls_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
277static inline tls_engine_type_t
278tls_get_engine_type (tls_engine_type_t preferred)
279{
280  if (!tls_vfts[preferred].ctx_alloc)
281    return tls_get_available_engine ();
282  return preferred;
283}
284
285static inline u32
286tls_ctx_alloc (tls_engine_type_t engine_type)
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
293static inline tls_ctx_t *
294tls_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
301static inline tls_ctx_t *
302tls_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
309static inline int
310tls_ctx_init_server (tls_ctx_t * ctx)
311{
312  return tls_vfts[ctx->tls_ctx_engine].ctx_init_server (ctx);
313}
314
315static inline int
316tls_ctx_init_client (tls_ctx_t * ctx)
317{
318  return tls_vfts[ctx->tls_ctx_engine].ctx_init_client (ctx);
319}
320
321static inline int
322tls_ctx_write (tls_ctx_t * ctx, session_t * app_session)
323{
324  return tls_vfts[ctx->tls_ctx_engine].ctx_write (ctx, app_session);
325}
326
327static inline int
328tls_ctx_read (tls_ctx_t * ctx, session_t * tls_session)
329{
330  return tls_vfts[ctx->tls_ctx_engine].ctx_read (ctx, tls_session);
331}
332
333static inline int
334tls_ctx_transport_close (tls_ctx_t * ctx)
335{
336  return tls_vfts[ctx->tls_ctx_engine].ctx_transport_close (ctx);
337}
338
339static inline int
340tls_ctx_app_close (tls_ctx_t * ctx)
341{
342  return tls_vfts[ctx->tls_ctx_engine].ctx_app_close (ctx);
343}
344
345void
346tls_ctx_free (tls_ctx_t * ctx)
347{
348  tls_vfts[ctx->tls_ctx_engine].ctx_free (ctx);
349}
350
351u8
352tls_ctx_handshake_is_over (tls_ctx_t * ctx)
353{
354  return tls_vfts[ctx->tls_ctx_engine].ctx_handshake_is_over (ctx);
355}
356
357void
358tls_session_reset_callback (session_t * s)
359{
360  tls_ctx_t *ctx;
361
362  ctx = tls_ctx_get (s->opaque);
363  session_transport_reset_notify (&ctx->connection);
364  session_transport_closed_notify (&ctx->connection);
365  tls_disconnect_transport (ctx);
366}
367
368int
369tls_add_segment_callback (u32 client_index, u64 segment_handle)
370{
371  /* No-op for builtin */
372  return 0;
373}
374
375int
376tls_del_segment_callback (u32 client_index, u64 segment_handle)
377{
378  return 0;
379}
380
381void
382tls_session_disconnect_callback (session_t * tls_session)
383{
384  tls_ctx_t *ctx;
385
386  TLS_DBG (1, "TCP disconnecting handle %x session %u", tls_session->opaque,
387	   tls_session->session_index);
388
389  ctx = tls_ctx_get (tls_session->opaque);
390  ctx->is_passive_close = 1;
391  tls_ctx_transport_close (ctx);
392}
393
394int
395tls_session_accept_callback (session_t * tls_session)
396{
397  session_t *tls_listener, *app_session;
398  tls_ctx_t *lctx, *ctx;
399  u32 ctx_handle;
400
401  tls_listener =
402    listen_session_get_from_handle (tls_session->listener_handle);
403  lctx = tls_listener_ctx_get (tls_listener->opaque);
404
405  ctx_handle = tls_ctx_alloc (lctx->tls_ctx_engine);
406  ctx = tls_ctx_get (ctx_handle);
407  memcpy (ctx, lctx, sizeof (*lctx));
408  ctx->c_thread_index = vlib_get_thread_index ();
409  ctx->tls_ctx_handle = ctx_handle;
410  tls_session->session_state = SESSION_STATE_READY;
411  tls_session->opaque = ctx_handle;
412  ctx->tls_session_handle = session_handle (tls_session);
413  ctx->listener_ctx_index = tls_listener->opaque;
414  ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
415  ctx->ckpair_index = lctx->ckpair_index;
416
417  /* Preallocate app session. Avoids allocating a session post handshake
418   * on tls_session rx and potentially invalidating the session pool */
419  app_session = session_alloc (ctx->c_thread_index);
420  app_session->session_state = SESSION_STATE_CLOSED;
421  ctx->c_s_index = app_session->session_index;
422
423  TLS_DBG (1, "Accept on listener %u new connection [%u]%x",
424	   tls_listener->opaque, vlib_get_thread_index (), ctx_handle);
425
426  return tls_ctx_init_server (ctx);
427}
428
429int
430tls_app_rx_callback (session_t * tls_session)
431{
432  tls_ctx_t *ctx;
433
434  ctx = tls_ctx_get (tls_session->opaque);
435  tls_ctx_read (ctx, tls_session);
436  return 0;
437}
438
439int
440tls_session_connected_callback (u32 tls_app_index, u32 ho_ctx_index,
441				session_t * tls_session, u8 is_fail)
442{
443  session_t *app_session;
444  tls_ctx_t *ho_ctx, *ctx;
445  u32 ctx_handle;
446
447  ho_ctx = tls_ctx_half_open_get (ho_ctx_index);
448
449  if (is_fail)
450    {
451      app_worker_t *app_wrk;
452      u32 api_context;
453      int rv = 0;
454
455      app_wrk = app_worker_get_if_valid (ho_ctx->parent_app_wrk_index);
456      if (app_wrk)
457	{
458	  api_context = ho_ctx->c_s_index;
459	  app_worker_connect_notify (app_wrk, 0, api_context);
460	}
461      tls_ctx_half_open_reader_unlock ();
462      tls_ctx_half_open_free (ho_ctx_index);
463      return rv;
464    }
465
466  ctx_handle = tls_ctx_alloc (ho_ctx->tls_ctx_engine);
467  ctx = tls_ctx_get (ctx_handle);
468  clib_memcpy_fast (ctx, ho_ctx, sizeof (*ctx));
469  tls_ctx_half_open_reader_unlock ();
470  tls_ctx_half_open_free (ho_ctx_index);
471
472  ctx->c_thread_index = vlib_get_thread_index ();
473  ctx->tls_ctx_handle = ctx_handle;
474  ctx->c_flags |= TRANSPORT_CONNECTION_F_NO_LOOKUP;
475
476  TLS_DBG (1, "TCP connect for %u returned %u. New connection [%u]%x",
477	   ho_ctx_index, is_fail, vlib_get_thread_index (),
478	   (ctx) ? ctx_handle : ~0);
479
480  ctx->tls_session_handle = session_handle (tls_session);
481  tls_session->opaque = ctx_handle;
482  tls_session->session_state = SESSION_STATE_READY;
483
484  /* Preallocate app session. Avoids allocating a session post handshake
485   * on tls_session rx and potentially invalidating the session pool */
486  app_session = session_alloc (ctx->c_thread_index);
487  app_session->session_state = SESSION_STATE_CLOSED;
488  ctx->c_s_index = app_session->session_index;
489
490  return tls_ctx_init_client (ctx);
491}
492
493static void
494tls_app_session_cleanup (session_t * s, session_cleanup_ntf_t ntf)
495{
496  tls_ctx_t *ctx;
497
498  if (ntf == SESSION_CLEANUP_TRANSPORT)
499    return;
500
501  ctx = tls_ctx_get (s->opaque);
502  if (!ctx->no_app_session)
503    session_transport_delete_notify (&ctx->connection);
504  tls_ctx_free (ctx);
505}
506
507/* *INDENT-OFF* */
508static session_cb_vft_t tls_app_cb_vft = {
509  .session_accept_callback = tls_session_accept_callback,
510  .session_disconnect_callback = tls_session_disconnect_callback,
511  .session_connected_callback = tls_session_connected_callback,
512  .session_reset_callback = tls_session_reset_callback,
513  .add_segment_callback = tls_add_segment_callback,
514  .del_segment_callback = tls_del_segment_callback,
515  .builtin_app_rx_callback = tls_app_rx_callback,
516  .session_cleanup_callback = tls_app_session_cleanup,
517};
518/* *INDENT-ON* */
519
520int
521tls_connect (transport_endpoint_cfg_t * tep)
522{
523  vnet_connect_args_t _cargs = { {}, }, *cargs = &_cargs;
524  session_endpoint_cfg_t *sep;
525  tls_engine_type_t engine_type;
526  tls_main_t *tm = &tls_main;
527  app_worker_t *app_wrk;
528  application_t *app;
529  tls_ctx_t *ctx;
530  u32 ctx_index;
531  int rv;
532
533  sep = (session_endpoint_cfg_t *) tep;
534  app_wrk = app_worker_get (sep->app_wrk_index);
535  app = application_get (app_wrk->app_index);
536  engine_type = tls_get_engine_type (app->tls_engine);
537  if (engine_type == TLS_ENGINE_NONE)
538    {
539      clib_warning ("No tls engine_type available");
540      return -1;
541    }
542
543  ctx_index = tls_ctx_half_open_alloc ();
544  ctx = tls_ctx_half_open_get (ctx_index);
545  ctx->parent_app_wrk_index = sep->app_wrk_index;
546  ctx->parent_app_api_context = sep->opaque;
547  ctx->tcp_is_ip4 = sep->is_ip4;
548  if (sep->hostname)
549    {
550      ctx->srv_hostname = format (0, "%v", sep->hostname);
551      vec_terminate_c_string (ctx->srv_hostname);
552    }
553  tls_ctx_half_open_reader_unlock ();
554
555  app_worker_alloc_connects_segment_manager (app_wrk);
556  ctx->tls_ctx_engine = engine_type;
557
558  clib_memcpy_fast (&cargs->sep, sep, sizeof (session_endpoint_t));
559  cargs->sep.transport_proto = TRANSPORT_PROTO_TCP;
560  cargs->app_index = tm->app_index;
561  cargs->api_context = ctx_index;
562  cargs->sep_ext.ns_index = app->ns_index;
563  if ((rv = vnet_connect (cargs)))
564    return rv;
565
566  TLS_DBG (1, "New connect request %u engine %d", ctx_index, engine_type);
567  return 0;
568}
569
570void
571tls_disconnect (u32 ctx_handle, u32 thread_index)
572{
573  tls_ctx_t *ctx;
574
575  TLS_DBG (1, "Disconnecting %x", ctx_handle);
576
577  ctx = tls_ctx_get (ctx_handle);
578  tls_ctx_app_close (ctx);
579}
580
581u32
582tls_start_listen (u32 app_listener_index, transport_endpoint_t * tep)
583{
584  vnet_listen_args_t _bargs, *args = &_bargs;
585  app_worker_t *app_wrk;
586  tls_main_t *tm = &tls_main;
587  session_handle_t tls_al_handle;
588  session_endpoint_cfg_t *sep;
589  session_t *tls_listener;
590  session_t *app_listener;
591  tls_engine_type_t engine_type;
592  application_t *app;
593  app_listener_t *al;
594  tls_ctx_t *lctx;
595  u32 lctx_index;
596
597  sep = (session_endpoint_cfg_t *) tep;
598  app_wrk = app_worker_get (sep->app_wrk_index);
599  app = application_get (app_wrk->app_index);
600  engine_type = tls_get_engine_type (app->tls_engine);
601  if (engine_type == TLS_ENGINE_NONE)
602    {
603      clib_warning ("No tls engine_type available");
604      return -1;
605    }
606
607  sep->transport_proto = TRANSPORT_PROTO_TCP;
608  clib_memset (args, 0, sizeof (*args));
609  args->app_index = tm->app_index;
610  args->sep_ext = *sep;
611  args->sep_ext.ns_index = app->ns_index;
612  if (vnet_listen (args))
613    return -1;
614
615  lctx_index = tls_listener_ctx_alloc ();
616  tls_al_handle = args->handle;
617  al = app_listener_get_w_handle (tls_al_handle);
618  tls_listener = app_listener_get_session (al);
619  tls_listener->opaque = lctx_index;
620
621  app_listener = listen_session_get (app_listener_index);
622
623  lctx = tls_listener_ctx_get (lctx_index);
624  lctx->parent_app_wrk_index = sep->app_wrk_index;
625  lctx->tls_session_handle = tls_al_handle;
626  lctx->app_session_handle = listen_session_get_handle (app_listener);
627  lctx->tcp_is_ip4 = sep->is_ip4;
628  lctx->tls_ctx_engine = engine_type;
629  lctx->ckpair_index = sep->ckpair_index;
630
631  if (tls_vfts[engine_type].ctx_start_listen (lctx))
632    {
633      vnet_unlisten_args_t a = {
634	.handle = lctx->tls_session_handle,
635	.app_index = tls_main.app_index,
636	.wrk_map_index = 0
637      };
638      if ((vnet_unlisten (&a)))
639	clib_warning ("unlisten returned");
640      tls_listener_ctx_free (lctx);
641      lctx_index = SESSION_INVALID_INDEX;
642    }
643
644  TLS_DBG (1, "Started listening %d, engine type %d", lctx_index,
645	   engine_type);
646  return lctx_index;
647}
648
649u32
650tls_stop_listen (u32 lctx_index)
651{
652  tls_engine_type_t engine_type;
653  tls_ctx_t *lctx;
654  int rv;
655
656  lctx = tls_listener_ctx_get (lctx_index);
657  vnet_unlisten_args_t a = {
658    .handle = lctx->tls_session_handle,
659    .app_index = tls_main.app_index,
660    .wrk_map_index = 0		/* default wrk */
661  };
662  if ((rv = vnet_unlisten (&a)))
663    clib_warning ("unlisten returned %d", rv);
664
665  engine_type = lctx->tls_ctx_engine;
666  tls_vfts[engine_type].ctx_stop_listen (lctx);
667
668  tls_listener_ctx_free (lctx);
669  return 0;
670}
671
672transport_connection_t *
673tls_connection_get (u32 ctx_index, u32 thread_index)
674{
675  tls_ctx_t *ctx;
676  ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
677  return &ctx->connection;
678}
679
680transport_connection_t *
681tls_listener_get (u32 listener_index)
682{
683  tls_ctx_t *ctx;
684  ctx = tls_listener_ctx_get (listener_index);
685  return &ctx->connection;
686}
687
688int
689tls_custom_tx_callback (void *session, u32 max_burst_size)
690{
691  session_t *app_session = (session_t *) session;
692  tls_ctx_t *ctx;
693
694  if (PREDICT_FALSE (app_session->session_state
695		     >= SESSION_STATE_TRANSPORT_CLOSED))
696    return 0;
697
698  ctx = tls_ctx_get (app_session->connection_index);
699  tls_ctx_write (ctx, app_session);
700  return 0;
701}
702
703u8 *
704format_tls_ctx (u8 * s, va_list * args)
705{
706  u32 tcp_si, tcp_ti, ctx_index, ctx_engine, app_si, app_ti;
707  tls_ctx_t *ctx = va_arg (*args, tls_ctx_t *);
708
709  session_parse_handle (ctx->tls_session_handle, &tcp_si, &tcp_ti);
710  tls_ctx_parse_handle (ctx->tls_ctx_handle, &ctx_index, &ctx_engine);
711  session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
712  s = format (s, "[%d:%d][TLS] app_wrk %u index %u engine %u tcp %d:%d",
713	      app_ti, app_si, ctx->parent_app_wrk_index, ctx_index,
714	      ctx_engine, tcp_ti, tcp_si);
715
716  return s;
717}
718
719u8 *
720format_tls_connection (u8 * s, va_list * args)
721{
722  u32 ctx_index = va_arg (*args, u32);
723  u32 thread_index = va_arg (*args, u32);
724  u32 verbose = va_arg (*args, u32);
725  tls_ctx_t *ctx;
726
727  ctx = tls_ctx_get_w_thread (ctx_index, thread_index);
728  if (!ctx)
729    return s;
730
731  s = format (s, "%-50U", format_tls_ctx, ctx);
732  if (verbose)
733    {
734      session_t *ts;
735      ts = session_get_from_handle (ctx->app_session_handle);
736      s = format (s, "state: %-7u", ts->session_state);
737      if (verbose > 1)
738	s = format (s, "\n");
739    }
740  return s;
741}
742
743u8 *
744format_tls_listener (u8 * s, va_list * args)
745{
746  u32 tc_index = va_arg (*args, u32);
747  u32 __clib_unused thread_index = va_arg (*args, u32);
748  u32 __clib_unused verbose = va_arg (*args, u32);
749  tls_ctx_t *ctx = tls_listener_ctx_get (tc_index);
750  session_t *tls_listener;
751  app_listener_t *al;
752  u32 app_si, app_ti;
753
754  al = app_listener_get_w_handle (ctx->tls_session_handle);
755  tls_listener = app_listener_get_session (al);
756  session_parse_handle (ctx->app_session_handle, &app_si, &app_ti);
757  s = format (s, "[%d:%d][TLS] app_wrk %u engine %u tcp %d:%d",
758	      app_ti, app_si, ctx->parent_app_wrk_index, ctx->tls_ctx_engine,
759	      tls_listener->thread_index, tls_listener->session_index);
760  return s;
761}
762
763u8 *
764format_tls_half_open (u8 * s, va_list * args)
765{
766  u32 tc_index = va_arg (*args, u32);
767  u32 __clib_unused thread_index = va_arg (*args, u32);
768  tls_ctx_t *ctx = tls_ctx_half_open_get (tc_index);
769  s = format (s, "[TLS] half-open app %u", ctx->parent_app_wrk_index);
770  tls_ctx_half_open_reader_unlock ();
771  return s;
772}
773
774static void
775tls_transport_endpoint_get (u32 ctx_handle, u32 thread_index,
776			    transport_endpoint_t * tep, u8 is_lcl)
777{
778  tls_ctx_t *ctx = tls_ctx_get_w_thread (ctx_handle, thread_index);
779  session_t *tcp_session;
780
781  tcp_session = session_get_from_handle (ctx->tls_session_handle);
782  session_get_endpoint (tcp_session, tep, is_lcl);
783}
784
785static void
786tls_transport_listener_endpoint_get (u32 ctx_handle,
787				     transport_endpoint_t * tep, u8 is_lcl)
788{
789  session_t *tls_listener;
790  app_listener_t *al;
791  tls_ctx_t *ctx = tls_listener_ctx_get (ctx_handle);
792
793  al = app_listener_get_w_handle (ctx->tls_session_handle);
794  tls_listener = app_listener_get_session (al);
795  session_get_endpoint (tls_listener, tep, is_lcl);
796}
797
798/* *INDENT-OFF* */
799static const transport_proto_vft_t tls_proto = {
800  .connect = tls_connect,
801  .close = tls_disconnect,
802  .start_listen = tls_start_listen,
803  .stop_listen = tls_stop_listen,
804  .get_connection = tls_connection_get,
805  .get_listener = tls_listener_get,
806  .custom_tx = tls_custom_tx_callback,
807  .format_connection = format_tls_connection,
808  .format_half_open = format_tls_half_open,
809  .format_listener = format_tls_listener,
810  .get_transport_endpoint = tls_transport_endpoint_get,
811  .get_transport_listener_endpoint = tls_transport_listener_endpoint_get,
812  .transport_options = {
813    .tx_type = TRANSPORT_TX_INTERNAL,
814    .service_type = TRANSPORT_SERVICE_APP,
815  },
816};
817/* *INDENT-ON* */
818
819void
820tls_register_engine (const tls_engine_vft_t * vft, tls_engine_type_t type)
821{
822  vec_validate (tls_vfts, type);
823  tls_vfts[type] = *vft;
824}
825
826static clib_error_t *
827tls_init (vlib_main_t * vm)
828{
829  u32 add_segment_size = 256 << 20, first_seg_size = 32 << 20;
830  vlib_thread_main_t *vtm = vlib_get_thread_main ();
831  u32 num_threads, fifo_size = 128 << 10;
832  vnet_app_attach_args_t _a, *a = &_a;
833  u64 options[APP_OPTIONS_N_OPTIONS];
834  tls_main_t *tm = &tls_main;
835
836  first_seg_size = tm->first_seg_size ? tm->first_seg_size : first_seg_size;
837  fifo_size = tm->fifo_size ? tm->fifo_size : fifo_size;
838  num_threads = 1 /* main thread */  + vtm->n_threads;
839
840  clib_memset (a, 0, sizeof (*a));
841  clib_memset (options, 0, sizeof (options));
842
843  a->session_cb_vft = &tls_app_cb_vft;
844  a->api_client_index = APP_INVALID_INDEX;
845  a->options = options;
846  a->name = format (0, "tls");
847  a->options[APP_OPTIONS_SEGMENT_SIZE] = first_seg_size;
848  a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = add_segment_size;
849  a->options[APP_OPTIONS_RX_FIFO_SIZE] = fifo_size;
850  a->options[APP_OPTIONS_TX_FIFO_SIZE] = fifo_size;
851  a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
852  a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
853  a->options[APP_OPTIONS_FLAGS] |= APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
854
855  if (vnet_application_attach (a))
856    {
857      clib_warning ("failed to attach tls app");
858      return clib_error_return (0, "failed to attach tls app");
859    }
860
861  if (!tm->ca_cert_path)
862    tm->ca_cert_path = TLS_CA_CERT_PATH;
863
864  tm->app_index = a->app_index;
865  clib_rwlock_init (&tm->half_open_rwlock);
866
867  vec_validate (tm->rx_bufs, num_threads - 1);
868  vec_validate (tm->tx_bufs, num_threads - 1);
869
870  transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
871			       FIB_PROTOCOL_IP4, ~0);
872  transport_register_protocol (TRANSPORT_PROTO_TLS, &tls_proto,
873			       FIB_PROTOCOL_IP6, ~0);
874  vec_free (a->name);
875  return 0;
876}
877
878VLIB_INIT_FUNCTION (tls_init);
879
880static clib_error_t *
881tls_config_fn (vlib_main_t * vm, unformat_input_t * input)
882{
883  tls_main_t *tm = &tls_main;
884  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
885    {
886      if (unformat (input, "use-test-cert-in-ca"))
887	tm->use_test_cert_in_ca = 1;
888      else if (unformat (input, "ca-cert-path %s", &tm->ca_cert_path))
889	;
890      else if (unformat (input, "first-segment-size %U", unformat_memory_size,
891			 &tm->first_seg_size))
892	;
893      else if (unformat (input, "fifo-size %U", unformat_memory_size,
894			 &tm->fifo_size))
895	;
896      else
897	return clib_error_return (0, "unknown input `%U'",
898				  format_unformat_error, input);
899    }
900  return 0;
901}
902
903VLIB_EARLY_CONFIG_FUNCTION (tls_config_fn, "tls");
904
905tls_main_t *
906vnet_tls_get_main (void)
907{
908  return &tls_main;
909}
910
911/*
912 * fd.io coding-style-patch-verification: ON
913 *
914 * Local Variables:
915 * eval: (c-set-style "gnu")
916 * End:
917 */
918