2 * Copyright (c) 2018 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #include <vnet/session/application_interface.h>
18 #include <vppinfra/lock.h>
20 #ifndef SRC_VNET_TLS_TLS_H_
21 #define SRC_VNET_TLS_TLS_H_
24 #define TLS_DEBUG_LEVEL_CLIENT 0
25 #define TLS_DEBUG_LEVEL_SERVER 0
27 #define TLS_CHUNK_SIZE (1 << 14)
28 #define TLS_CA_CERT_PATH "/etc/ssl/certs/ca-certificates.crt"
31 #define TLS_DBG(_lvl, _fmt, _args...) \
32 if (_lvl <= TLS_DEBUG) \
33 clib_warning (_fmt, ##_args)
35 #define TLS_DBG(_lvl, _fmt, _args...)
39 typedef CLIB_PACKED (struct tls_cxt_id_
42 session_handle_t app_session_handle;
43 session_handle_t tls_session_handle;
45 u32 listener_ctx_index;
51 STATIC_ASSERT (sizeof (tls_ctx_id_t) <= 42, "ctx id must be less than 42");
53 typedef struct tls_ctx_
57 transport_connection_t connection;
58 tls_ctx_id_t c_tls_ctx_id;
60 #define parent_app_index c_tls_ctx_id.parent_app_index
61 #define app_session_handle c_tls_ctx_id.app_session_handle
62 #define tls_session_handle c_tls_ctx_id.tls_session_handle
63 #define listener_ctx_index c_tls_ctx_id.listener_ctx_index
64 #define tcp_is_ip4 c_tls_ctx_id.tcp_is_ip4
65 #define tls_ctx_engine c_tls_ctx_id.tls_engine_id
66 #define tls_ssl_ctx c_tls_ctx_id.ssl_ctx
67 #define tls_ctx_handle c_c_index
68 /* Temporary storage for session open opaque. Overwritten once
69 * underlying tcp connection is established */
70 #define parent_app_api_context c_s_index
77 typedef struct tls_main_
80 tls_ctx_t *listener_ctx_pool;
81 tls_ctx_t *half_open_ctx_pool;
82 clib_rwlock_t half_open_rwlock;
89 u8 use_test_cert_in_ca;
93 typedef struct tls_engine_vft_
95 u32 (*ctx_alloc) (void);
96 void (*ctx_free) (tls_ctx_t * ctx);
97 tls_ctx_t *(*ctx_get) (u32 ctx_index);
98 tls_ctx_t *(*ctx_get_w_thread) (u32 ctx_index, u8 thread_index);
99 int (*ctx_init_client) (tls_ctx_t * ctx);
100 int (*ctx_init_server) (tls_ctx_t * ctx);
101 int (*ctx_read) (tls_ctx_t * ctx, stream_session_t * tls_session);
102 int (*ctx_write) (tls_ctx_t * ctx, stream_session_t * app_session);
103 u8 (*ctx_handshake_is_over) (tls_ctx_t * ctx);
104 int (*ctx_start_listen) (tls_ctx_t * ctx);
105 int (*ctx_stop_listen) (tls_ctx_t * ctx);
108 typedef enum tls_engine_type_
116 tls_main_t *vnet_tls_get_main (void);
117 void tls_register_engine (const tls_engine_vft_t * vft,
118 tls_engine_type_t type);
119 int tls_add_vpp_q_rx_evt (stream_session_t * s);
120 int tls_add_vpp_q_tx_evt (stream_session_t * s);
121 int tls_add_vpp_q_builtin_tx_evt (stream_session_t * s);
122 int tls_add_vpp_q_builtin_rx_evt (stream_session_t * s);
123 int tls_notify_app_accept (tls_ctx_t * ctx);
124 int tls_notify_app_connected (tls_ctx_t * ctx, u8 is_failed);
125 void tls_notify_app_enqueue (tls_ctx_t * ctx, stream_session_t * app_session);
126 #endif /* SRC_VNET_TLS_TLS_H_ */
128 * fd.io coding-style-patch-verification: ON
131 * eval: (c-set-style "gnu")