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);
43 } ipsec4_hash_kv_16_8_t;
49 ip4_address_t ip4_addr[2];
54 ipsec4_hash_kv_16_8_t kv_16_8;
55 } ipsec4_spd_5tuple_t;
60 /* add/del callback */
61 add_del_sa_sess_cb_t add_del_sa_sess_cb;
62 /* check support function */
63 check_support_cb_t check_support_cb;
64 u32 ah4_encrypt_node_index;
65 u32 ah4_decrypt_node_index;
66 u32 ah4_encrypt_next_index;
67 u32 ah4_decrypt_next_index;
68 u32 ah6_encrypt_node_index;
69 u32 ah6_decrypt_node_index;
70 u32 ah6_encrypt_next_index;
71 u32 ah6_decrypt_next_index;
77 /* add/del callback */
78 add_del_sa_sess_cb_t add_del_sa_sess_cb;
79 /* check support function */
80 check_support_cb_t check_support_cb;
81 /* enable or disable function */
82 enable_disable_cb_t enable_disable_cb;
83 u32 esp4_encrypt_node_index;
84 u32 esp4_decrypt_node_index;
85 u32 esp4_encrypt_next_index;
86 u32 esp4_decrypt_next_index;
87 u32 esp6_encrypt_node_index;
88 u32 esp6_decrypt_node_index;
89 u32 esp6_encrypt_next_index;
90 u32 esp6_decrypt_next_index;
91 u32 esp4_decrypt_tun_node_index;
92 u32 esp4_decrypt_tun_next_index;
93 u32 esp4_encrypt_tun_node_index;
94 u32 esp6_decrypt_tun_node_index;
95 u32 esp6_decrypt_tun_next_index;
96 u32 esp6_encrypt_tun_node_index;
97 u32 esp_mpls_encrypt_tun_node_index;
98 } ipsec_esp_backend_t;
102 vnet_crypto_op_id_t enc_op_id;
103 vnet_crypto_op_id_t dec_op_id;
104 vnet_crypto_alg_t alg;
108 } ipsec_main_crypto_alg_t;
112 vnet_crypto_op_id_t op_id;
113 vnet_crypto_alg_t alg;
115 } ipsec_main_integ_alg_t;
119 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
120 vnet_crypto_op_t *crypto_ops;
121 vnet_crypto_op_t *integ_ops;
122 vnet_crypto_op_t *chained_crypto_ops;
123 vnet_crypto_op_t *chained_integ_ops;
124 vnet_crypto_op_chunk_t *chunks;
125 vnet_crypto_async_frame_t **async_frames;
126 } ipsec_per_thread_data_t;
130 /* pool of tunnel instances */
132 /* pool of policies */
133 ipsec_policy_t *policies;
135 /* hash tables of UDP port registrations */
136 uword *udp_port_registrations;
138 uword *tunnel_index_by_key;
141 vlib_main_t *vlib_main;
142 vnet_main_t *vnet_main;
145 uword *spd_index_by_spd_id;
146 uword *spd_index_by_sw_if_index;
147 uword *sa_index_by_sa_id;
148 uword *ipsec4_if_pool_index_by_key;
149 uword *ipsec6_if_pool_index_by_key;
150 uword *ipsec_if_real_dev_by_show_dev;
151 uword *ipsec_if_by_sw_if_index;
153 ipsec4_hash_kv_16_8_t *ipsec4_out_spd_hash_tbl;
154 clib_bihash_8_16_t tun4_protect_by_key;
155 clib_bihash_24_16_t tun6_protect_by_key;
158 u32 error_drop_node_index;
159 u32 esp4_encrypt_node_index;
160 u32 esp4_decrypt_node_index;
161 u32 esp4_decrypt_tun_node_index;
162 u32 esp4_encrypt_tun_node_index;
163 u32 ah4_encrypt_node_index;
164 u32 ah4_decrypt_node_index;
165 u32 esp6_encrypt_node_index;
166 u32 esp6_decrypt_node_index;
167 u32 esp6_decrypt_tun_node_index;
168 u32 esp6_encrypt_tun_node_index;
169 u32 esp_mpls_encrypt_tun_node_index;
170 u32 ah6_encrypt_node_index;
171 u32 ah6_decrypt_node_index;
172 /* next node indices */
173 u32 esp4_encrypt_next_index;
174 u32 esp4_decrypt_next_index;
175 u32 esp4_decrypt_tun_next_index;
176 u32 ah4_encrypt_next_index;
177 u32 ah4_decrypt_next_index;
178 u32 esp6_encrypt_next_index;
179 u32 esp6_decrypt_next_index;
180 u32 esp6_decrypt_tun_next_index;
181 u32 ah6_encrypt_next_index;
182 u32 ah6_decrypt_next_index;
184 /* pool of ah backends */
185 ipsec_ah_backend_t *ah_backends;
186 /* pool of esp backends */
187 ipsec_esp_backend_t *esp_backends;
188 /* index of current ah backend */
189 u32 ah_current_backend;
190 /* index of current esp backend */
191 u32 esp_current_backend;
192 /* index of default ah backend */
193 u32 ah_default_backend;
194 /* index of default esp backend */
195 u32 esp_default_backend;
197 /* crypto alg data */
198 ipsec_main_crypto_alg_t *crypto_algs;
200 /* crypto integ data */
201 ipsec_main_integ_alg_t *integ_algs;
203 /* per-thread data */
204 ipsec_per_thread_data_t *ptd;
206 /** Worker handoff */
207 u32 ah4_enc_fq_index;
208 u32 ah4_dec_fq_index;
209 u32 ah6_enc_fq_index;
210 u32 ah6_dec_fq_index;
212 u32 esp4_enc_fq_index;
213 u32 esp4_dec_fq_index;
214 u32 esp6_enc_fq_index;
215 u32 esp6_dec_fq_index;
216 u32 esp4_enc_tun_fq_index;
217 u32 esp6_enc_tun_fq_index;
218 u32 esp_mpls_enc_tun_fq_index;
219 u32 esp4_dec_tun_fq_index;
220 u32 esp6_dec_tun_fq_index;
222 /* Number of buckets for flow cache */
223 u32 ipsec4_out_spd_hash_num_buckets;
224 u32 ipsec4_out_spd_flow_cache_entries;
231 typedef enum ipsec_format_flags_t_
233 IPSEC_FORMAT_BRIEF = 0,
234 IPSEC_FORMAT_DETAIL = (1 << 0),
235 IPSEC_FORMAT_INSECURE = (1 << 1),
236 } ipsec_format_flags_t;
238 extern ipsec_main_t ipsec_main;
240 clib_error_t *ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index,
243 clib_error_t *ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa);
245 extern vlib_node_registration_t ipsec4_tun_input_node;
246 extern vlib_node_registration_t ipsec6_tun_input_node;
256 static_always_inline u32
257 get_next_output_feature_node_index (vlib_buffer_t * b,
258 vlib_node_runtime_t * nr)
261 vlib_main_t *vm = vlib_get_main ();
262 vlib_node_t *node = vlib_get_node (vm, nr->node_index);
264 vnet_feature_next (&next, b);
265 return node->next_nodes[next];
268 static_always_inline u64
269 ipsec4_hash_16_8 (ipsec4_hash_kv_16_8_t *v)
271 #ifdef clib_crc32c_uses_intrinsics
272 return clib_crc32c ((u8 *) v->key, 16);
274 u64 tmp = v->key[0] ^ v->key[1];
275 return clib_xxhash (tmp);
279 static_always_inline int
280 ipsec4_hash_key_compare_16_8 (u64 *a, u64 *b)
282 #if defined(CLIB_HAVE_VEC128) && defined(CLIB_HAVE_VEC128_UNALIGNED_LOAD_STORE)
284 v = u64x2_load_unaligned (a) ^ u64x2_load_unaligned (b);
285 return u64x2_is_all_zero (v);
287 return ((a[0] ^ b[0]) | (a[1] ^ b[1])) == 0;
291 /* clib_spinlock_lock is not used to save another memory indirection */
292 static_always_inline void
293 ipsec_spinlock_lock (i32 *lock)
296 while (!clib_atomic_cmp_and_swap_acq_relax_n (lock, &free, 1, 0))
298 /* atomic load limits number of compare_exchange executions */
299 while (clib_atomic_load_relax_n (lock))
301 /* on failure, compare_exchange writes lock into free */
306 static_always_inline void
307 ipsec_spinlock_unlock (i32 *lock)
309 /* Make sure all reads/writes are complete before releasing the lock */
310 clib_atomic_release (lock);
313 u32 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
315 const char *ah4_encrypt_node_name,
316 const char *ah4_decrypt_node_name,
317 const char *ah6_encrypt_node_name,
318 const char *ah6_decrypt_node_name,
319 check_support_cb_t ah_check_support_cb,
320 add_del_sa_sess_cb_t ah_add_del_sa_sess_cb);
322 u32 ipsec_register_esp_backend (
323 vlib_main_t *vm, ipsec_main_t *im, const char *name,
324 const char *esp4_encrypt_node_name, const char *esp4_encrypt_tun_node_name,
325 const char *esp4_decrypt_node_name, const char *esp4_decrypt_tun_node_name,
326 const char *esp6_encrypt_node_name, const char *esp6_encrypt_tun_node_name,
327 const char *esp6_decrypt_node_name, const char *esp6_decrypt_tun_node_name,
328 const char *esp_mpls_encrypt_tun_node_name,
329 check_support_cb_t esp_check_support_cb,
330 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb,
331 enable_disable_cb_t enable_disable_cb);
333 int ipsec_select_ah_backend (ipsec_main_t * im, u32 ah_backend_idx);
334 int ipsec_select_esp_backend (ipsec_main_t * im, u32 esp_backend_idx);
336 clib_error_t *ipsec_rsc_in_use (ipsec_main_t * im);
337 void ipsec_set_async_mode (u32 is_enabled);
339 extern void ipsec_register_udp_port (u16 udp_port);
340 extern void ipsec_unregister_udp_port (u16 udp_port);
342 #endif /* __IPSEC_H__ */
345 * fd.io coding-style-patch-verification: ON
348 * eval: (c-set-style "gnu")