blob: fc7b6cd245484e761b84c00bf6772cd15755c980 [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{
Zachary Leaf7cd35f52021-06-25 08:11:15 -050039 u64 key[2]; // 16 bytes
Govindarajan Mohandoss6d7dfcb2021-03-19 19:20:49 +000040 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
Zachary Leaf7cd35f52021-06-25 08:11:15 -050057typedef union
58{
59 struct
60 {
61 ip4_address_t ip4_src_addr;
62 ip4_address_t ip4_dest_addr;
63 ipsec_spd_policy_type_t policy_type;
64 u8 pad[4];
65 }; // 16 bytes total
66 ipsec4_hash_kv_16_8_t kv_16_8;
67} ipsec4_inbound_spd_tuple_t;
68
Govindarajan Mohandoss6d7dfcb2021-03-19 19:20:49 +000069typedef struct
70{
Klement Sekerab4d30532018-11-08 13:00:02 +010071 u8 *name;
72 /* add/del callback */
73 add_del_sa_sess_cb_t add_del_sa_sess_cb;
74 /* check support function */
75 check_support_cb_t check_support_cb;
76 u32 ah4_encrypt_node_index;
77 u32 ah4_decrypt_node_index;
78 u32 ah4_encrypt_next_index;
79 u32 ah4_decrypt_next_index;
80 u32 ah6_encrypt_node_index;
81 u32 ah6_decrypt_node_index;
82 u32 ah6_encrypt_next_index;
83 u32 ah6_decrypt_next_index;
84} ipsec_ah_backend_t;
85
86typedef struct
87{
88 u8 *name;
89 /* add/del callback */
90 add_del_sa_sess_cb_t add_del_sa_sess_cb;
91 /* check support function */
92 check_support_cb_t check_support_cb;
Fan Zhangf5395782020-04-29 14:00:03 +010093 /* enable or disable function */
94 enable_disable_cb_t enable_disable_cb;
Klement Sekerab4d30532018-11-08 13:00:02 +010095 u32 esp4_encrypt_node_index;
96 u32 esp4_decrypt_node_index;
97 u32 esp4_encrypt_next_index;
98 u32 esp4_decrypt_next_index;
99 u32 esp6_encrypt_node_index;
100 u32 esp6_decrypt_node_index;
101 u32 esp6_encrypt_next_index;
102 u32 esp6_decrypt_next_index;
Neale Ranns7ec120e2020-01-21 04:58:02 +0000103 u32 esp4_decrypt_tun_node_index;
104 u32 esp4_decrypt_tun_next_index;
Neale Ranns4ec36c52020-03-31 09:21:29 -0400105 u32 esp4_encrypt_tun_node_index;
Neale Ranns7ec120e2020-01-21 04:58:02 +0000106 u32 esp6_decrypt_tun_node_index;
107 u32 esp6_decrypt_tun_next_index;
Neale Ranns4ec36c52020-03-31 09:21:29 -0400108 u32 esp6_encrypt_tun_node_index;
Neale Ranns4a58e492020-12-21 13:19:10 +0000109 u32 esp_mpls_encrypt_tun_node_index;
Klement Sekerab4d30532018-11-08 13:00:02 +0100110} ipsec_esp_backend_t;
Sergio Gonzalez Monroyd04b60b2017-01-20 15:35:23 +0000111
112typedef struct
113{
Damjan Marion060bfb92019-03-29 13:47:54 +0100114 vnet_crypto_op_id_t enc_op_id;
115 vnet_crypto_op_id_t dec_op_id;
Damjan Mariond1bed682019-04-24 15:20:35 +0200116 vnet_crypto_alg_t alg;
Klement Sekera4f10db32018-11-12 14:32:19 +0100117 u8 iv_size;
Christian Hoppsfb7e7ed2019-11-03 07:02:15 -0500118 u8 block_align;
Neale Ranns47feb112019-04-11 15:14:07 +0000119 u8 icv_size;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100120} ipsec_main_crypto_alg_t;
Klement Sekera4f10db32018-11-12 14:32:19 +0100121
122typedef struct
123{
Damjan Marion060bfb92019-03-29 13:47:54 +0100124 vnet_crypto_op_id_t op_id;
Damjan Mariond1bed682019-04-24 15:20:35 +0200125 vnet_crypto_alg_t alg;
Damjan Marion7c22ff72019-04-04 12:25:44 +0200126 u8 icv_size;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100127} ipsec_main_integ_alg_t;
Klement Sekera4f10db32018-11-12 14:32:19 +0100128
129typedef struct
130{
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000131 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Damjan Marionc59b9a22019-03-19 15:38:40 +0100132 vnet_crypto_op_t *crypto_ops;
133 vnet_crypto_op_t *integ_ops;
Filip Tehlarefcad1a2020-02-04 09:36:04 +0000134 vnet_crypto_op_t *chained_crypto_ops;
135 vnet_crypto_op_t *chained_integ_ops;
136 vnet_crypto_op_chunk_t *chunks;
Neale Rannsfc811342021-02-26 10:35:33 +0000137 vnet_crypto_async_frame_t **async_frames;
Damjan Marionc59b9a22019-03-19 15:38:40 +0100138} ipsec_per_thread_data_t;
139
140typedef struct
141{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700142 /* pool of tunnel instances */
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700143 ipsec_spd_t *spds;
Neale Rannsa09c1ff2019-02-04 01:10:30 -0800144 /* pool of policies */
145 ipsec_policy_t *policies;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700146
Piotr Bronowski86f82082022-07-08 12:45:05 +0000147 u32 ipv4_fp_spd_is_enabled;
148 u32 ipv6_fp_spd_is_enabled;
149
Piotr Bronowski04643102022-05-10 13:18:22 +0000150 ipsec_fp_mask_type_entry_t *fp_mask_types;
151 u32 fp_lookup_hash_buckets; /* number of buckets should be power of two */
152
Neale Rannsabc56602020-04-01 09:45:23 +0000153 /* hash tables of UDP port registrations */
154 uword *udp_port_registrations;
155
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700156 uword *tunnel_index_by_key;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700157
BenoƮt Ganne98ca76a2022-04-11 18:51:25 +0200158 /* next_header protocol registration */
159 u16 *next_header_registrations;
160
Ed Warnickecb9cada2015-12-08 15:45:58 -0700161 /* convenience */
162 vlib_main_t *vlib_main;
163 vnet_main_t *vnet_main;
164
Ed Warnickecb9cada2015-12-08 15:45:58 -0700165 /* hashes */
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700166 uword *spd_index_by_spd_id;
167 uword *spd_index_by_sw_if_index;
168 uword *sa_index_by_sa_id;
Kingwel Xie1ba5bc82019-03-20 07:21:58 -0400169 uword *ipsec4_if_pool_index_by_key;
170 uword *ipsec6_if_pool_index_by_key;
Matthew Smith8e1039a2018-04-12 07:32:56 -0500171 uword *ipsec_if_real_dev_by_show_dev;
Neale Ranns25edf142019-03-22 08:12:48 +0000172 uword *ipsec_if_by_sw_if_index;
Neale Ranns7b4e52f2020-05-24 16:17:50 +0000173
Govindarajan Mohandoss6d7dfcb2021-03-19 19:20:49 +0000174 ipsec4_hash_kv_16_8_t *ipsec4_out_spd_hash_tbl;
Zachary Leaf7cd35f52021-06-25 08:11:15 -0500175 ipsec4_hash_kv_16_8_t *ipsec4_in_spd_hash_tbl;
Neale Ranns302b25a2020-10-19 13:23:33 +0000176 clib_bihash_8_16_t tun4_protect_by_key;
177 clib_bihash_24_16_t tun6_protect_by_key;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700178
Paul Vinciguerrabdc0e6b2018-09-22 05:32:50 -0700179 /* node indices */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700180 u32 error_drop_node_index;
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200181 u32 esp4_encrypt_node_index;
182 u32 esp4_decrypt_node_index;
Neale Ranns7ec120e2020-01-21 04:58:02 +0000183 u32 esp4_decrypt_tun_node_index;
Neale Ranns4ec36c52020-03-31 09:21:29 -0400184 u32 esp4_encrypt_tun_node_index;
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200185 u32 ah4_encrypt_node_index;
186 u32 ah4_decrypt_node_index;
187 u32 esp6_encrypt_node_index;
188 u32 esp6_decrypt_node_index;
Neale Ranns7ec120e2020-01-21 04:58:02 +0000189 u32 esp6_decrypt_tun_node_index;
Neale Ranns4ec36c52020-03-31 09:21:29 -0400190 u32 esp6_encrypt_tun_node_index;
Neale Ranns4a58e492020-12-21 13:19:10 +0000191 u32 esp_mpls_encrypt_tun_node_index;
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200192 u32 ah6_encrypt_node_index;
193 u32 ah6_decrypt_node_index;
Paul Vinciguerrabdc0e6b2018-09-22 05:32:50 -0700194 /* next node indices */
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200195 u32 esp4_encrypt_next_index;
196 u32 esp4_decrypt_next_index;
Neale Ranns7ec120e2020-01-21 04:58:02 +0000197 u32 esp4_decrypt_tun_next_index;
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200198 u32 ah4_encrypt_next_index;
199 u32 ah4_decrypt_next_index;
200 u32 esp6_encrypt_next_index;
201 u32 esp6_decrypt_next_index;
Neale Ranns7ec120e2020-01-21 04:58:02 +0000202 u32 esp6_decrypt_tun_next_index;
Klement Sekerabe5a5dd2018-10-09 16:05:48 +0200203 u32 ah6_encrypt_next_index;
204 u32 ah6_decrypt_next_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700205
Klement Sekerab4d30532018-11-08 13:00:02 +0100206 /* pool of ah backends */
207 ipsec_ah_backend_t *ah_backends;
208 /* pool of esp backends */
209 ipsec_esp_backend_t *esp_backends;
210 /* index of current ah backend */
211 u32 ah_current_backend;
212 /* index of current esp backend */
213 u32 esp_current_backend;
214 /* index of default ah backend */
215 u32 ah_default_backend;
216 /* index of default esp backend */
217 u32 esp_default_backend;
Damjan Marion91f17dc2019-03-18 18:59:25 +0100218
219 /* crypto alg data */
220 ipsec_main_crypto_alg_t *crypto_algs;
221
222 /* crypto integ data */
223 ipsec_main_integ_alg_t *integ_algs;
Damjan Marionc59b9a22019-03-19 15:38:40 +0100224
225 /* per-thread data */
226 ipsec_per_thread_data_t *ptd;
Neale Rannsf62a8c02019-04-02 08:13:33 +0000227
228 /** Worker handoff */
229 u32 ah4_enc_fq_index;
230 u32 ah4_dec_fq_index;
231 u32 ah6_enc_fq_index;
232 u32 ah6_dec_fq_index;
233
234 u32 esp4_enc_fq_index;
235 u32 esp4_dec_fq_index;
236 u32 esp6_enc_fq_index;
237 u32 esp6_dec_fq_index;
238 u32 esp4_enc_tun_fq_index;
239 u32 esp6_enc_tun_fq_index;
Neale Ranns4a58e492020-12-21 13:19:10 +0000240 u32 esp_mpls_enc_tun_fq_index;
Neale Rannsf62a8c02019-04-02 08:13:33 +0000241 u32 esp4_dec_tun_fq_index;
242 u32 esp6_dec_tun_fq_index;
Fan Zhangf5395782020-04-29 14:00:03 +0100243
Govindarajan Mohandoss6d7dfcb2021-03-19 19:20:49 +0000244 /* Number of buckets for flow cache */
245 u32 ipsec4_out_spd_hash_num_buckets;
246 u32 ipsec4_out_spd_flow_cache_entries;
247 u32 epoch_count;
Zachary Leaf7cd35f52021-06-25 08:11:15 -0500248 u8 output_flow_cache_flag;
249
250 u32 ipsec4_in_spd_hash_num_buckets;
251 u32 ipsec4_in_spd_flow_cache_entries;
252 u32 input_epoch_count;
253 u8 input_flow_cache_flag;
254
Fan Zhangf5395782020-04-29 14:00:03 +0100255 u8 async_mode;
Filip Tehlarc73f3292021-06-22 08:21:31 +0000256 u16 msg_id_base;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700257} ipsec_main_t;
258
Neale Rannsb294f102019-04-03 13:17:50 +0000259typedef enum ipsec_format_flags_t_
260{
261 IPSEC_FORMAT_BRIEF = 0,
262 IPSEC_FORMAT_DETAIL = (1 << 0),
Christian E. Hopps01d61e72019-09-27 14:43:22 -0400263 IPSEC_FORMAT_INSECURE = (1 << 1),
Neale Rannsb294f102019-04-03 13:17:50 +0000264} ipsec_format_flags_t;
265
Dave Wallace71612d62017-10-24 01:32:41 -0400266extern ipsec_main_t ipsec_main;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700267
Klement Sekerab4d30532018-11-08 13:00:02 +0100268clib_error_t *ipsec_add_del_sa_sess_cb (ipsec_main_t * im, u32 sa_index,
269 u8 is_add);
270
271clib_error_t *ipsec_check_support_cb (ipsec_main_t * im, ipsec_sa_t * sa);
272
Neale Rannsabc56602020-04-01 09:45:23 +0000273extern vlib_node_registration_t ipsec4_tun_input_node;
274extern vlib_node_registration_t ipsec6_tun_input_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700275
Ed Warnickecb9cada2015-12-08 15:45:58 -0700276/*
277 * functions
278 */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700279
Ed Warnickecb9cada2015-12-08 15:45:58 -0700280/*
281 * inline functions
282 */
283
Matus Fabian08a6f012016-11-15 06:08:51 -0800284static_always_inline u32
285get_next_output_feature_node_index (vlib_buffer_t * b,
286 vlib_node_runtime_t * nr)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700287{
Matus Fabian08a6f012016-11-15 06:08:51 -0800288 u32 next;
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700289 vlib_main_t *vm = vlib_get_main ();
Matus Fabian08a6f012016-11-15 06:08:51 -0800290 vlib_node_t *node = vlib_get_node (vm, nr->node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700291
Damjan Marion7d98a122018-07-19 20:42:08 +0200292 vnet_feature_next (&next, b);
Matus Fabian08a6f012016-11-15 06:08:51 -0800293 return node->next_nodes[next];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700294}
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700295
Govindarajan Mohandoss6d7dfcb2021-03-19 19:20:49 +0000296static_always_inline u64
297ipsec4_hash_16_8 (ipsec4_hash_kv_16_8_t *v)
298{
299#ifdef clib_crc32c_uses_intrinsics
300 return clib_crc32c ((u8 *) v->key, 16);
301#else
302 u64 tmp = v->key[0] ^ v->key[1];
303 return clib_xxhash (tmp);
304#endif
305}
306
307static_always_inline int
308ipsec4_hash_key_compare_16_8 (u64 *a, u64 *b)
309{
310#if defined(CLIB_HAVE_VEC128) && defined(CLIB_HAVE_VEC128_UNALIGNED_LOAD_STORE)
311 u64x2 v;
312 v = u64x2_load_unaligned (a) ^ u64x2_load_unaligned (b);
313 return u64x2_is_all_zero (v);
314#else
315 return ((a[0] ^ b[0]) | (a[1] ^ b[1])) == 0;
316#endif
317}
318
319/* clib_spinlock_lock is not used to save another memory indirection */
320static_always_inline void
321ipsec_spinlock_lock (i32 *lock)
322{
323 i32 free = 0;
324 while (!clib_atomic_cmp_and_swap_acq_relax_n (lock, &free, 1, 0))
325 {
326 /* atomic load limits number of compare_exchange executions */
327 while (clib_atomic_load_relax_n (lock))
328 CLIB_PAUSE ();
329 /* on failure, compare_exchange writes lock into free */
330 free = 0;
331 }
332}
333
334static_always_inline void
335ipsec_spinlock_unlock (i32 *lock)
336{
337 /* Make sure all reads/writes are complete before releasing the lock */
338 clib_atomic_release (lock);
339}
340
Klement Sekerab4d30532018-11-08 13:00:02 +0100341u32 ipsec_register_ah_backend (vlib_main_t * vm, ipsec_main_t * im,
342 const char *name,
343 const char *ah4_encrypt_node_name,
344 const char *ah4_decrypt_node_name,
345 const char *ah6_encrypt_node_name,
346 const char *ah6_decrypt_node_name,
347 check_support_cb_t ah_check_support_cb,
348 add_del_sa_sess_cb_t ah_add_del_sa_sess_cb);
349
Neale Ranns4a58e492020-12-21 13:19:10 +0000350u32 ipsec_register_esp_backend (
351 vlib_main_t *vm, ipsec_main_t *im, const char *name,
352 const char *esp4_encrypt_node_name, const char *esp4_encrypt_tun_node_name,
353 const char *esp4_decrypt_node_name, const char *esp4_decrypt_tun_node_name,
354 const char *esp6_encrypt_node_name, const char *esp6_encrypt_tun_node_name,
355 const char *esp6_decrypt_node_name, const char *esp6_decrypt_tun_node_name,
356 const char *esp_mpls_encrypt_tun_node_name,
357 check_support_cb_t esp_check_support_cb,
358 add_del_sa_sess_cb_t esp_add_del_sa_sess_cb,
359 enable_disable_cb_t enable_disable_cb);
Klement Sekerab4d30532018-11-08 13:00:02 +0100360
361int ipsec_select_ah_backend (ipsec_main_t * im, u32 ah_backend_idx);
362int ipsec_select_esp_backend (ipsec_main_t * im, u32 esp_backend_idx);
Neale Ranns25edf142019-03-22 08:12:48 +0000363
Neale Rannse8915fc2019-04-23 20:57:55 -0400364clib_error_t *ipsec_rsc_in_use (ipsec_main_t * im);
Neale Ranns4ec36c52020-03-31 09:21:29 -0400365void ipsec_set_async_mode (u32 is_enabled);
Neale Rannse8915fc2019-04-23 20:57:55 -0400366
Neale Rannsabc56602020-04-01 09:45:23 +0000367extern void ipsec_register_udp_port (u16 udp_port);
368extern void ipsec_unregister_udp_port (u16 udp_port);
369
BenoƮt Ganne98ca76a2022-04-11 18:51:25 +0200370extern clib_error_t *ipsec_register_next_header (vlib_main_t *vm,
371 u8 next_header,
372 const char *next_node);
373
Sergio Gonzalez Monroya10f62b2016-11-25 13:36:12 +0000374#endif /* __IPSEC_H__ */
375
Keith Burns (alagalah)166a9d42016-08-06 11:00:56 -0700376/*
377 * fd.io coding-style-patch-verification: ON
378 *
379 * Local Variables:
380 * eval: (c-set-style "gnu")
381 * End:
382 */