2 * Copyright (c) 2015 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.
18 #include <vnet/ip/ip.h>
19 #include <vnet/crypto/crypto.h>
20 #include <vnet/feature/feature.h>
22 #include <vppinfra/types.h>
23 #include <vppinfra/cache.h>
25 #include <vnet/ipsec/ipsec_spd.h>
26 #include <vnet/ipsec/ipsec_spd_policy.h>
27 #include <vnet/ipsec/ipsec_sa.h>
29 #include <vppinfra/bihash_8_16.h>
31 #include <vppinfra/bihash_24_16.h>
33 typedef clib_error_t *(*add_del_sa_sess_cb_t) (u32 sa_index, u8 is_add);
34 typedef clib_error_t *(*check_support_cb_t) (ipsec_sa_t * sa);
35 typedef clib_error_t *(*enable_disable_cb_t) (int is_enable);
40 /* add/del callback */
41 add_del_sa_sess_cb_t add_del_sa_sess_cb;
42 /* check support function */
43 check_support_cb_t check_support_cb;
44 u32 ah4_encrypt_node_index;
45 u32 ah4_decrypt_node_index;
46 u32 ah4_encrypt_next_index;
47 u32 ah4_decrypt_next_index;
48 u32 ah6_encrypt_node_index;
49 u32 ah6_decrypt_node_index;
50 u32 ah6_encrypt_next_index;
51 u32 ah6_decrypt_next_index;
57 /* add/del callback */
58 add_del_sa_sess_cb_t add_del_sa_sess_cb;
59 /* check support function */
60 check_support_cb_t check_support_cb;
61 /* enable or disable function */
62 enable_disable_cb_t enable_disable_cb;
63 u32 esp4_encrypt_node_index;
64 u32 esp4_decrypt_node_index;
65 u32 esp4_encrypt_next_index;
66 u32 esp4_decrypt_next_index;
67 u32 esp6_encrypt_node_index;
68 u32 esp6_decrypt_node_index;
69 u32 esp6_encrypt_next_index;
70 u32 esp6_decrypt_next_index;
71 u32 esp4_decrypt_tun_node_index;
72 u32 esp4_decrypt_tun_next_index;
73 u32 esp4_encrypt_tun_node_index;
74 u32 esp6_decrypt_tun_node_index;
75 u32 esp6_decrypt_tun_next_index;
76 u32 esp6_encrypt_tun_node_index;
77 u32 esp_mpls_encrypt_tun_node_index;
78 } ipsec_esp_backend_t;
82 vnet_crypto_op_id_t enc_op_id;
83 vnet_crypto_op_id_t dec_op_id;
84 vnet_crypto_alg_t alg;
88 } ipsec_main_crypto_alg_t;
92 vnet_crypto_op_id_t op_id;
93 vnet_crypto_alg_t alg;
95 } ipsec_main_integ_alg_t;
99 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
100 vnet_crypto_op_t *crypto_ops;
101 vnet_crypto_op_t *integ_ops;
102 vnet_crypto_op_t *chained_crypto_ops;
103 vnet_crypto_op_t *chained_integ_ops;
104 vnet_crypto_op_chunk_t *chunks;
105 } ipsec_per_thread_data_t;
109 /* pool of tunnel instances */
111 /* Pool of security associations */
113 /* pool of policies */
114 ipsec_policy_t *policies;
116 /* hash tables of UDP port registrations */
117 uword *udp_port_registrations;
119 uword *tunnel_index_by_key;
122 vlib_main_t *vlib_main;
123 vnet_main_t *vnet_main;
126 uword *spd_index_by_spd_id;
127 uword *spd_index_by_sw_if_index;
128 uword *sa_index_by_sa_id;
129 uword *ipsec4_if_pool_index_by_key;
130 uword *ipsec6_if_pool_index_by_key;
131 uword *ipsec_if_real_dev_by_show_dev;
132 uword *ipsec_if_by_sw_if_index;
134 clib_bihash_8_16_t tun4_protect_by_key;
135 clib_bihash_24_16_t tun6_protect_by_key;
138 u32 error_drop_node_index;
139 u32 esp4_encrypt_node_index;
140 u32 esp4_decrypt_node_index;
141 u32 esp4_decrypt_tun_node_index;
142 u32 esp4_encrypt_tun_node_index;
143 u32 ah4_encrypt_node_index;
144 u32 ah4_decrypt_node_index;
145 u32 esp6_encrypt_node_index;
146 u32 esp6_decrypt_node_index;
147 u32 esp6_decrypt_tun_node_index;
148 u32 esp6_encrypt_tun_node_index;
149 u32 esp_mpls_encrypt_tun_node_index;
150 u32 ah6_encrypt_node_index;
151 u32 ah6_decrypt_node_index;
152 /* next node indices */
153 u32 esp4_encrypt_next_index;
154 u32 esp4_decrypt_next_index;
155 u32 esp4_decrypt_tun_next_index;
156 u32 ah4_encrypt_next_index;
157 u32 ah4_decrypt_next_index;
158 u32 esp6_encrypt_next_index;
159 u32 esp6_decrypt_next_index;
160 u32 esp6_decrypt_tun_next_index;
161 u32 ah6_encrypt_next_index;
162 u32 ah6_decrypt_next_index;
164 /* tun nodes to drop packets when no crypto alg set on outbound SA */
165 u32 esp4_no_crypto_tun_node_index;
166 u32 esp6_no_crypto_tun_node_index;
168 /* tun nodes for encrypt on L2 interfaces */
169 u32 esp4_encrypt_l2_tun_node_index;
170 u32 esp6_encrypt_l2_tun_node_index;
172 /* pool of ah backends */
173 ipsec_ah_backend_t *ah_backends;
174 /* pool of esp backends */
175 ipsec_esp_backend_t *esp_backends;
176 /* index of current ah backend */
177 u32 ah_current_backend;
178 /* index of current esp backend */
179 u32 esp_current_backend;
180 /* index of default ah backend */
181 u32 ah_default_backend;
182 /* index of default esp backend */
183 u32 esp_default_backend;
185 /* crypto alg data */
186 ipsec_main_crypto_alg_t *crypto_algs;
188 /* crypto integ data */
189 ipsec_main_integ_alg_t *integ_algs;
191 /* per-thread data */
192 ipsec_per_thread_data_t *ptd;
194 /** Worker handoff */
195 u32 ah4_enc_fq_index;
196 u32 ah4_dec_fq_index;
197 u32 ah6_enc_fq_index;
198 u32 ah6_dec_fq_index;
200 u32 esp4_enc_fq_index;
201 u32 esp4_dec_fq_index;
202 u32 esp6_enc_fq_index;
203 u32 esp6_dec_fq_index;
204 u32 esp4_enc_tun_fq_index;
205 u32 esp6_enc_tun_fq_index;
206 u32 esp_mpls_enc_tun_fq_index;
207 u32 esp4_dec_tun_fq_index;
208 u32 esp6_dec_tun_fq_index;
213 typedef enum ipsec_format_flags_t_
215 IPSEC_FORMAT_BRIEF = 0,
216 IPSEC_FORMAT_DETAIL = (1 << 0),
217 IPSEC_FORMAT_INSECURE = (1 << 1),
218 } ipsec_format_flags_t;
220 extern ipsec_main_t ipsec_main;
222 clib_error_t *ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index,
225 clib_error_t *ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa);
227 extern vlib_node_registration_t ah4_encrypt_node;
228 extern vlib_node_registration_t ah4_decrypt_node;
229 extern vlib_node_registration_t ah6_encrypt_node;
230 extern vlib_node_registration_t ah6_decrypt_node;
231 extern vlib_node_registration_t esp4_encrypt_node;
232 extern vlib_node_registration_t esp4_decrypt_node;
233 extern vlib_node_registration_t esp6_encrypt_node;
234 extern vlib_node_registration_t esp6_decrypt_node;
235 extern vlib_node_registration_t esp4_encrypt_tun_node;
236 extern vlib_node_registration_t esp6_encrypt_tun_node;
237 extern vlib_node_registration_t esp_mpls_encrypt_tun_node;
238 extern vlib_node_registration_t esp4_decrypt_tun_node;
239 extern vlib_node_registration_t esp6_decrypt_tun_node;
240 extern vlib_node_registration_t ipsec4_tun_input_node;
241 extern vlib_node_registration_t ipsec6_tun_input_node;
246 u8 *format_ipsec_replay_window (u8 * s, va_list * args);
252 static_always_inline u32
253 get_next_output_feature_node_index (vlib_buffer_t * b,
254 vlib_node_runtime_t * nr)
257 vlib_main_t *vm = vlib_get_main ();
258 vlib_node_t *node = vlib_get_node (vm, nr->node_index);
260 vnet_feature_next (&next, b);
261 return node->next_nodes[next];
264 u32 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
266 const char *ah4_encrypt_node_name,
267 const char *ah4_decrypt_node_name,
268 const char *ah6_encrypt_node_name,
269 const char *ah6_decrypt_node_name,
270 check_support_cb_t ah_check_support_cb,
271 add_del_sa_sess_cb_t ah_add_del_sa_sess_cb);
273 u32 ipsec_register_esp_backend (
274 vlib_main_t *vm, ipsec_main_t *im, const char *name,
275 const char *esp4_encrypt_node_name, const char *esp4_encrypt_tun_node_name,
276 const char *esp4_decrypt_node_name, const char *esp4_decrypt_tun_node_name,
277 const char *esp6_encrypt_node_name, const char *esp6_encrypt_tun_node_name,
278 const char *esp6_decrypt_node_name, const char *esp6_decrypt_tun_node_name,
279 const char *esp_mpls_encrypt_tun_node_name,
280 check_support_cb_t esp_check_support_cb,
281 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb,
282 enable_disable_cb_t enable_disable_cb);
284 int ipsec_select_ah_backend (ipsec_main_t * im, u32 ah_backend_idx);
285 int ipsec_select_esp_backend (ipsec_main_t * im, u32 esp_backend_idx);
287 clib_error_t *ipsec_rsc_in_use (ipsec_main_t * im);
288 void ipsec_set_async_mode (u32 is_enabled);
290 always_inline ipsec_sa_t *
291 ipsec_sa_get (u32 sa_index)
293 return (pool_elt_at_index (ipsec_main.sad, sa_index));
296 void ipsec_add_feature (const char *arc_name, const char *node_name,
297 u32 * out_feature_index);
299 void ipsec_set_async_mode (u32 is_enabled);
300 extern void ipsec_register_udp_port (u16 udp_port);
301 extern void ipsec_unregister_udp_port (u16 udp_port);
303 #endif /* __IPSEC_H__ */
306 * fd.io coding-style-patch-verification: ON
309 * eval: (c-set-style "gnu")