blob: 968d377cea004e035baae7eb562dade7b967531b [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
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:
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 */
Sergio Gonzalez Monroya10f62b2016-11-25 13:36:12 +000015#ifndef __IPSEC_H__
16#define __IPSEC_H__
17
Sergio Gonzalez Monroydb93cd92017-08-26 15:22:05 +010018#include <vnet/ip/ip.h>
Damjan Marion91f17dc2019-03-18 18:59:25 +010019#include <vnet/crypto/crypto.h>
Sergio Gonzalez Monroydb93cd92017-08-26 15:22:05 +010020#include <vnet/feature/feature.h>
21
Klement Sekera4f10db32018-11-12 14:32:19 +010022#include <vppinfra/types.h>
23#include <vppinfra/cache.h>
24
Neale Ranns999c8ee2019-02-01 03:31:24 -080025#include <vnet/ipsec/ipsec_spd.h>
26#include <vnet/ipsec/ipsec_spd_policy.h>
27#include <vnet/ipsec/ipsec_sa.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070028
Neale Ranns302b25a2020-10-19 13:23:33 +000029#include <vppinfra/bihash_8_16.h>
Neale Ranns7b4e52f2020-05-24 16:17:50 +000030
Neale Ranns302b25a2020-10-19 13:23:33 +000031#include <vppinfra/bihash_24_16.h>
Neale Ranns7b4e52f2020-05-24 16:17:50 +000032
Klement Sekerab4d30532018-11-08 13:00:02 +010033typedef clib_error_t *(*add_del_sa_sess_cb_t) (u32 sa_index, u8 is_add);
34typedef clib_error_t *(*check_support_cb_t) (ipsec_sa_t * sa);
Fan Zhangf5395782020-04-29 14:00:03 +010035typedef clib_error_t *(*enable_disable_cb_t) (int is_enable);
Klement Sekerab4d30532018-11-08 13:00:02 +010036
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -070037typedef struct
38{
Govindarajan Mohandoss6d7dfcb2021-03-19 19:20:49 +000039 u64 key[2];
40 u64 value;
41 i32 bucket_lock;
42 u32 un_used;
43} ipsec4_hash_kv_16_8_t;
44
45typedef union
46{
47 struct
48 {
49 ip4_address_t ip4_addr[2];
50 u16 port[2];
51 u8 proto;
52 u8 pad[3];
53 };
54 ipsec4_hash_kv_16_8_t kv_16_8;
55} ipsec4_spd_5tuple_t;
56
57typedef struct
58{
Klement Sekerab4d30532018-11-08 13:00:02 +010059 u8 *name;
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;
72} ipsec_ah_backend_t;
73
74typedef struct
75{
76 u8 *name;
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;
Fan Zhangf5395782020-04-29 14:00:03 +010081 /* enable or disable function */
82 enable_disable_cb_t enable_disable_cb;
Klement Sekerab4d30532018-11-08 13:00:02 +010083 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;
Neale Ranns7ec120e2020-01-21 04:58:02 +000091 u32 esp4_decrypt_tun_node_index;
92 u32 esp4_decrypt_tun_next_index;
Neale Ranns4ec36c52020-03-31 09:21:29 -040093 u32 esp4_encrypt_tun_node_index;
Neale Ranns7ec120e2020-01-21 04:58:02 +000094 u32 esp6_decrypt_tun_node_index;
95 u32 esp6_decrypt_tun_next_index;
Neale Ranns4ec36c52020-03-31 09:21:29 -040096 u32 esp6_encrypt_tun_node_index;
Neale Ranns4a58e492020-12-21 13:19:10 +000097 u32 esp_mpls_encrypt_tun_node_index;
Klement Sekerab4d30532018-11-08 13:00:02 +010098} ipsec_esp_backend_t;
Sergio Gonzalez Monroyd04b60b2017-01-20 15:35:23 +000099
100typedef struct
101{
Damjan Marion060bfb92019-03-29 13:47:54 +0100102 vnet_crypto_op_id_t enc_op_id;
103 vnet_crypto_op_id_t dec_op_id;
Damjan Mariond1bed682019-04-24 15:20:35 +0200104 vnet_crypto_alg_t alg;
Klement Sekera4f10db32018-11-12 14:32:19 +0100105 u8 iv_size;
Christian Hoppsfb7e7ed2019-11-03 07:02:15 -0500106 u8 block_align;
Neale Ranns47feb112019-04-11 15:14:07 +0000107 u8 icv_size;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100108} ipsec_main_crypto_alg_t;
Klement Sekera4f10db32018-11-12 14:32:19 +0100109
110typedef struct
111{
Damjan Marion060bfb92019-03-29 13:47:54 +0100112 vnet_crypto_op_id_t op_id;
Damjan Mariond1bed682019-04-24 15:20:35 +0200113 vnet_crypto_alg_t alg;
Damjan Marion7c22ff72019-04-04 12:25:44 +0200114 u8 icv_size;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100115} ipsec_main_integ_alg_t;
Klement Sekera4f10db32018-11-12 14:32:19 +0100116
117typedef struct
118{
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000119 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marionc59b9a22019-03-19 15:38:40 +0100120 vnet_crypto_op_t *crypto_ops;
121 vnet_crypto_op_t *integ_ops;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000122 vnet_crypto_op_t *chained_crypto_ops;
123 vnet_crypto_op_t *chained_integ_ops;
124 vnet_crypto_op_chunk_t *chunks;
Neale Rannsfc811342021-02-26 10:35:33 +0000125 vnet_crypto_async_frame_t **async_frames;
Damjan Marionc59b9a22019-03-19 15:38:40 +0100126} ipsec_per_thread_data_t;
127
128typedef struct
129{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700130 /* pool of tunnel instances */
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700131 ipsec_spd_t *spds;
Neale Rannsa09c1ff2019-02-04 01:10:30 -0800132 /* pool of policies */
133 ipsec_policy_t *policies;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700134
Neale Rannsabc56602020-04-01 09:45:23 +0000135 /* hash tables of UDP port registrations */
136 uword *udp_port_registrations;
137
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700138 uword *tunnel_index_by_key;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700139
140 /* convenience */
141 vlib_main_t *vlib_main;
142 vnet_main_t *vnet_main;
143
Ed Warnickecb9cada2015-12-08 15:45:58 -0700144 /* hashes */
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700145 uword *spd_index_by_spd_id;
146 uword *spd_index_by_sw_if_index;
147 uword *sa_index_by_sa_id;
Kingwel Xie1ba5bc82019-03-20 07:21:58 -0400148 uword *ipsec4_if_pool_index_by_key;
149 uword *ipsec6_if_pool_index_by_key;
Matthew Smith8e1039a2018-04-12 07:32:56 -0500150 uword *ipsec_if_real_dev_by_show_dev;
Neale Ranns25edf142019-03-22 08:12:48 +0000151 uword *ipsec_if_by_sw_if_index;
Neale Ranns7b4e52f2020-05-24 16:17:50 +0000152
Govindarajan Mohandoss6d7dfcb2021-03-19 19:20:49 +0000153 ipsec4_hash_kv_16_8_t *ipsec4_out_spd_hash_tbl;
Neale Ranns302b25a2020-10-19 13:23:33 +0000154 clib_bihash_8_16_t tun4_protect_by_key;
155 clib_bihash_24_16_t tun6_protect_by_key;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700156
Paul Vinciguerrabdc0e6b2018-09-22 05:32:50 -0700157 /* node indices */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700158 u32 error_drop_node_index;
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200159 u32 esp4_encrypt_node_index;
160 u32 esp4_decrypt_node_index;
Neale Ranns7ec120e2020-01-21 04:58:02 +0000161 u32 esp4_decrypt_tun_node_index;
Neale Ranns4ec36c52020-03-31 09:21:29 -0400162 u32 esp4_encrypt_tun_node_index;
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200163 u32 ah4_encrypt_node_index;
164 u32 ah4_decrypt_node_index;
165 u32 esp6_encrypt_node_index;
166 u32 esp6_decrypt_node_index;
Neale Ranns7ec120e2020-01-21 04:58:02 +0000167 u32 esp6_decrypt_tun_node_index;
Neale Ranns4ec36c52020-03-31 09:21:29 -0400168 u32 esp6_encrypt_tun_node_index;
Neale Ranns4a58e492020-12-21 13:19:10 +0000169 u32 esp_mpls_encrypt_tun_node_index;
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200170 u32 ah6_encrypt_node_index;
171 u32 ah6_decrypt_node_index;
Paul Vinciguerrabdc0e6b2018-09-22 05:32:50 -0700172 /* next node indices */
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200173 u32 esp4_encrypt_next_index;
174 u32 esp4_decrypt_next_index;
Neale Ranns7ec120e2020-01-21 04:58:02 +0000175 u32 esp4_decrypt_tun_next_index;
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200176 u32 ah4_encrypt_next_index;
177 u32 ah4_decrypt_next_index;
178 u32 esp6_encrypt_next_index;
179 u32 esp6_decrypt_next_index;
Neale Ranns7ec120e2020-01-21 04:58:02 +0000180 u32 esp6_decrypt_tun_next_index;
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200181 u32 ah6_encrypt_next_index;
182 u32 ah6_decrypt_next_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700183
Matthew Smith401aedf2019-07-08 14:45:04 -0500184 /* tun nodes to drop packets when no crypto alg set on outbound SA */
Neale Ranns4ec36c52020-03-31 09:21:29 -0400185 u32 esp4_no_crypto_tun_node_index;
186 u32 esp6_no_crypto_tun_node_index;
187
188 /* tun nodes for encrypt on L2 interfaces */
189 u32 esp4_encrypt_l2_tun_node_index;
190 u32 esp6_encrypt_l2_tun_node_index;
Matthew Smith401aedf2019-07-08 14:45:04 -0500191
Klement Sekerab4d30532018-11-08 13:00:02 +0100192 /* pool of ah backends */
193 ipsec_ah_backend_t *ah_backends;
194 /* pool of esp backends */
195 ipsec_esp_backend_t *esp_backends;
196 /* index of current ah backend */
197 u32 ah_current_backend;
198 /* index of current esp backend */
199 u32 esp_current_backend;
200 /* index of default ah backend */
201 u32 ah_default_backend;
202 /* index of default esp backend */
203 u32 esp_default_backend;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100204
205 /* crypto alg data */
206 ipsec_main_crypto_alg_t *crypto_algs;
207
208 /* crypto integ data */
209 ipsec_main_integ_alg_t *integ_algs;
Damjan Marionc59b9a22019-03-19 15:38:40 +0100210
211 /* per-thread data */
212 ipsec_per_thread_data_t *ptd;
Neale Rannsf62a8c02019-04-02 08:13:33 +0000213
214 /** Worker handoff */
215 u32 ah4_enc_fq_index;
216 u32 ah4_dec_fq_index;
217 u32 ah6_enc_fq_index;
218 u32 ah6_dec_fq_index;
219
220 u32 esp4_enc_fq_index;
221 u32 esp4_dec_fq_index;
222 u32 esp6_enc_fq_index;
223 u32 esp6_dec_fq_index;
224 u32 esp4_enc_tun_fq_index;
225 u32 esp6_enc_tun_fq_index;
Neale Ranns4a58e492020-12-21 13:19:10 +0000226 u32 esp_mpls_enc_tun_fq_index;
Neale Rannsf62a8c02019-04-02 08:13:33 +0000227 u32 esp4_dec_tun_fq_index;
228 u32 esp6_dec_tun_fq_index;
Fan Zhangf5395782020-04-29 14:00:03 +0100229
Govindarajan Mohandoss6d7dfcb2021-03-19 19:20:49 +0000230 /* Number of buckets for flow cache */
231 u32 ipsec4_out_spd_hash_num_buckets;
232 u32 ipsec4_out_spd_flow_cache_entries;
233 u32 epoch_count;
Fan Zhangf5395782020-04-29 14:00:03 +0100234 u8 async_mode;
Filip Tehlarc73f3292021-06-22 08:21:31 +0000235 u16 msg_id_base;
Govindarajan Mohandoss6d7dfcb2021-03-19 19:20:49 +0000236 u8 flow_cache_flag;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700237} ipsec_main_t;
238
Neale Rannsb294f102019-04-03 13:17:50 +0000239typedef enum ipsec_format_flags_t_
240{
241 IPSEC_FORMAT_BRIEF = 0,
242 IPSEC_FORMAT_DETAIL = (1 << 0),
Christian E. Hopps01d61e72019-09-27 14:43:22 -0400243 IPSEC_FORMAT_INSECURE = (1 << 1),
Neale Rannsb294f102019-04-03 13:17:50 +0000244} ipsec_format_flags_t;
245
Dave Wallace71612d62017-10-24 01:32:41 -0400246extern ipsec_main_t ipsec_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700247
Klement Sekerab4d30532018-11-08 13:00:02 +0100248clib_error_t *ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index,
249 u8 is_add);
250
251clib_error_t *ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa);
252
Neale Rannsabc56602020-04-01 09:45:23 +0000253extern vlib_node_registration_t ipsec4_tun_input_node;
254extern vlib_node_registration_t ipsec6_tun_input_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700255
Ed Warnickecb9cada2015-12-08 15:45:58 -0700256/*
257 * functions
258 */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700259
Ed Warnickecb9cada2015-12-08 15:45:58 -0700260/*
261 * inline functions
262 */
263
Matus Fabian08a6f012016-11-15 06:08:51 -0800264static_always_inline u32
265get_next_output_feature_node_index (vlib_buffer_t * b,
266 vlib_node_runtime_t * nr)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700267{
Matus Fabian08a6f012016-11-15 06:08:51 -0800268 u32 next;
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700269 vlib_main_t *vm = vlib_get_main ();
Matus Fabian08a6f012016-11-15 06:08:51 -0800270 vlib_node_t *node = vlib_get_node (vm, nr->node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700271
Damjan Marion7d98a122018-07-19 20:42:08 +0200272 vnet_feature_next (&next, b);
Matus Fabian08a6f012016-11-15 06:08:51 -0800273 return node->next_nodes[next];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700274}
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700275
Govindarajan Mohandoss6d7dfcb2021-03-19 19:20:49 +0000276static_always_inline u64
277ipsec4_hash_16_8 (ipsec4_hash_kv_16_8_t *v)
278{
279#ifdef clib_crc32c_uses_intrinsics
280 return clib_crc32c ((u8 *) v->key, 16);
281#else
282 u64 tmp = v->key[0] ^ v->key[1];
283 return clib_xxhash (tmp);
284#endif
285}
286
287static_always_inline int
288ipsec4_hash_key_compare_16_8 (u64 *a, u64 *b)
289{
290#if defined(CLIB_HAVE_VEC128) && defined(CLIB_HAVE_VEC128_UNALIGNED_LOAD_STORE)
291 u64x2 v;
292 v = u64x2_load_unaligned (a) ^ u64x2_load_unaligned (b);
293 return u64x2_is_all_zero (v);
294#else
295 return ((a[0] ^ b[0]) | (a[1] ^ b[1])) == 0;
296#endif
297}
298
299/* clib_spinlock_lock is not used to save another memory indirection */
300static_always_inline void
301ipsec_spinlock_lock (i32 *lock)
302{
303 i32 free = 0;
304 while (!clib_atomic_cmp_and_swap_acq_relax_n (lock, &free, 1, 0))
305 {
306 /* atomic load limits number of compare_exchange executions */
307 while (clib_atomic_load_relax_n (lock))
308 CLIB_PAUSE ();
309 /* on failure, compare_exchange writes lock into free */
310 free = 0;
311 }
312}
313
314static_always_inline void
315ipsec_spinlock_unlock (i32 *lock)
316{
317 /* Make sure all reads/writes are complete before releasing the lock */
318 clib_atomic_release (lock);
319}
320
Klement Sekerab4d30532018-11-08 13:00:02 +0100321u32 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
322 const char *name,
323 const char *ah4_encrypt_node_name,
324 const char *ah4_decrypt_node_name,
325 const char *ah6_encrypt_node_name,
326 const char *ah6_decrypt_node_name,
327 check_support_cb_t ah_check_support_cb,
328 add_del_sa_sess_cb_t ah_add_del_sa_sess_cb);
329
Neale Ranns4a58e492020-12-21 13:19:10 +0000330u32 ipsec_register_esp_backend (
331 vlib_main_t *vm, ipsec_main_t *im, const char *name,
332 const char *esp4_encrypt_node_name, const char *esp4_encrypt_tun_node_name,
333 const char *esp4_decrypt_node_name, const char *esp4_decrypt_tun_node_name,
334 const char *esp6_encrypt_node_name, const char *esp6_encrypt_tun_node_name,
335 const char *esp6_decrypt_node_name, const char *esp6_decrypt_tun_node_name,
336 const char *esp_mpls_encrypt_tun_node_name,
337 check_support_cb_t esp_check_support_cb,
338 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb,
339 enable_disable_cb_t enable_disable_cb);
Klement Sekerab4d30532018-11-08 13:00:02 +0100340
341int ipsec_select_ah_backend (ipsec_main_t * im, u32 ah_backend_idx);
342int ipsec_select_esp_backend (ipsec_main_t * im, u32 esp_backend_idx);
Neale Ranns25edf142019-03-22 08:12:48 +0000343
Neale Rannse8915fc2019-04-23 20:57:55 -0400344clib_error_t *ipsec_rsc_in_use (ipsec_main_t * im);
Neale Ranns4ec36c52020-03-31 09:21:29 -0400345void ipsec_set_async_mode (u32 is_enabled);
Neale Rannse8915fc2019-04-23 20:57:55 -0400346
Neale Rannsabc56602020-04-01 09:45:23 +0000347extern void ipsec_register_udp_port (u16 udp_port);
348extern void ipsec_unregister_udp_port (u16 udp_port);
349
Sergio Gonzalez Monroya10f62b2016-11-25 13:36:12 +0000350#endif /* __IPSEC_H__ */
351
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700352/*
353 * fd.io coding-style-patch-verification: ON
354 *
355 * Local Variables:
356 * eval: (c-set-style "gnu")
357 * End:
358 */