blob: 12f8eceb3433c65f811d8ba2ef006843c8a14d07 [file] [log] [blame]
Neale Ranns999c8ee2019-02-01 03:31:24 -08001/*
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 */
15
16#include <vnet/ipsec/ipsec.h>
Damjan Marionc59b9a22019-03-19 15:38:40 +010017#include <vnet/ipsec/esp.h>
Florin Corasb040f982020-10-20 14:59:43 -070018#include <vnet/udp/udp_local.h>
Neale Ranns8d7c5022019-02-06 01:41:05 -080019#include <vnet/fib/fib_table.h>
Neale Ranns1f50bf82019-07-16 15:28:52 +000020#include <vnet/fib/fib_entry_track.h>
Neale Rannsc87b66c2019-02-07 07:26:12 -080021#include <vnet/ipsec/ipsec_tun.h>
Neale Ranns999c8ee2019-02-01 03:31:24 -080022
Neale Rannseba31ec2019-02-17 18:04:27 +000023/**
24 * @brief
25 * SA packet & bytes counters
26 */
27vlib_combined_counter_main_t ipsec_sa_counters = {
28 .name = "SA",
29 .stat_segment_name = "/net/ipsec/sa",
30};
Neale Rannse11203e2021-09-21 12:34:19 +000031vlib_simple_counter_main_t ipsec_sa_lost_counters = {
32 .name = "SA-lost",
33 .stat_segment_name = "/net/ipsec/sa/lost",
34};
Neale Rannseba31ec2019-02-17 18:04:27 +000035
Neale Rannsc5fe57d2021-02-25 16:01:28 +000036ipsec_sa_t *ipsec_sa_pool;
Neale Rannseba31ec2019-02-17 18:04:27 +000037
Neale Ranns999c8ee2019-02-01 03:31:24 -080038static clib_error_t *
39ipsec_call_add_del_callbacks (ipsec_main_t * im, ipsec_sa_t * sa,
40 u32 sa_index, int is_add)
41{
42 ipsec_ah_backend_t *ab;
43 ipsec_esp_backend_t *eb;
44 switch (sa->protocol)
45 {
46 case IPSEC_PROTOCOL_AH:
47 ab = pool_elt_at_index (im->ah_backends, im->ah_current_backend);
48 if (ab->add_del_sa_sess_cb)
49 return ab->add_del_sa_sess_cb (sa_index, is_add);
50 break;
51 case IPSEC_PROTOCOL_ESP:
52 eb = pool_elt_at_index (im->esp_backends, im->esp_current_backend);
53 if (eb->add_del_sa_sess_cb)
54 return eb->add_del_sa_sess_cb (sa_index, is_add);
55 break;
56 }
57 return 0;
58}
59
Neale Ranns8d7c5022019-02-06 01:41:05 -080060void
61ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len)
62{
63 memset (key, 0, sizeof (*key));
64
65 if (len > sizeof (key->data))
66 key->len = sizeof (key->data);
67 else
68 key->len = len;
69
70 memcpy (key->data, data, key->len);
71}
72
73/**
74 * 'stack' (resolve the recursion for) the SA tunnel destination
75 */
Neale Rannse8915fc2019-04-23 20:57:55 -040076static void
Neale Ranns8d7c5022019-02-06 01:41:05 -080077ipsec_sa_stack (ipsec_sa_t * sa)
78{
Neale Rannsb4cfd552019-02-13 02:08:06 -080079 ipsec_main_t *im = &ipsec_main;
Neale Ranns8d7c5022019-02-06 01:41:05 -080080 dpo_id_t tmp = DPO_INVALID;
Neale Ranns8d7c5022019-02-06 01:41:05 -080081
Neale Ranns9ec846c2021-02-09 14:04:02 +000082 tunnel_contribute_forwarding (&sa->tunnel, &tmp);
Neale Ranns8d7c5022019-02-06 01:41:05 -080083
Neale Ranns72f2a3a2019-06-17 15:43:38 +000084 if (IPSEC_PROTOCOL_AH == sa->protocol)
85 dpo_stack_from_node ((ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
86 im->ah6_encrypt_node_index :
87 im->ah4_encrypt_node_index), &sa->dpo, &tmp);
88 else
89 dpo_stack_from_node ((ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ?
90 im->esp6_encrypt_node_index :
91 im->esp4_encrypt_node_index), &sa->dpo, &tmp);
Neale Rannsb4cfd552019-02-13 02:08:06 -080092 dpo_reset (&tmp);
Neale Ranns8d7c5022019-02-06 01:41:05 -080093}
94
Damjan Marionb966e8b2019-03-20 16:07:09 +010095void
96ipsec_sa_set_crypto_alg (ipsec_sa_t * sa, ipsec_crypto_alg_t crypto_alg)
97{
98 ipsec_main_t *im = &ipsec_main;
99 sa->crypto_alg = crypto_alg;
100 sa->crypto_iv_size = im->crypto_algs[crypto_alg].iv_size;
Christian Hoppsfb7e7ed2019-11-03 07:02:15 -0500101 sa->esp_block_align = clib_max (4, im->crypto_algs[crypto_alg].block_align);
Fan Zhangf5395782020-04-29 14:00:03 +0100102 sa->sync_op_data.crypto_enc_op_id = im->crypto_algs[crypto_alg].enc_op_id;
103 sa->sync_op_data.crypto_dec_op_id = im->crypto_algs[crypto_alg].dec_op_id;
Damjan Mariond1bed682019-04-24 15:20:35 +0200104 sa->crypto_calg = im->crypto_algs[crypto_alg].alg;
Damjan Marionb4fff3a2019-03-25 15:54:40 +0100105 ASSERT (sa->crypto_iv_size <= ESP_MAX_IV_SIZE);
Christian Hoppsfb7e7ed2019-11-03 07:02:15 -0500106 ASSERT (sa->esp_block_align <= ESP_MAX_BLOCK_SIZE);
Vladimir Ratnikovd7c030d2022-09-13 13:09:53 +0000107 if (IPSEC_CRYPTO_ALG_IS_GCM (crypto_alg) ||
108 IPSEC_CRYPTO_ALG_CTR_AEAD_OTHERS (crypto_alg))
Neale Ranns47feb112019-04-11 15:14:07 +0000109 {
110 sa->integ_icv_size = im->crypto_algs[crypto_alg].icv_size;
Benoît Ganne490b9272021-01-22 18:03:09 +0100111 ipsec_sa_set_IS_CTR (sa);
Neale Ranns47feb112019-04-11 15:14:07 +0000112 ipsec_sa_set_IS_AEAD (sa);
113 }
Benoît Ganne490b9272021-01-22 18:03:09 +0100114 else if (IPSEC_CRYPTO_ALG_IS_CTR (crypto_alg))
115 {
116 ipsec_sa_set_IS_CTR (sa);
117 }
Damjan Marionb966e8b2019-03-20 16:07:09 +0100118}
119
120void
121ipsec_sa_set_integ_alg (ipsec_sa_t * sa, ipsec_integ_alg_t integ_alg)
122{
123 ipsec_main_t *im = &ipsec_main;
124 sa->integ_alg = integ_alg;
Damjan Marion7c22ff72019-04-04 12:25:44 +0200125 sa->integ_icv_size = im->integ_algs[integ_alg].icv_size;
Fan Zhangf5395782020-04-29 14:00:03 +0100126 sa->sync_op_data.integ_op_id = im->integ_algs[integ_alg].op_id;
Damjan Mariond1bed682019-04-24 15:20:35 +0200127 sa->integ_calg = im->integ_algs[integ_alg].alg;
Damjan Marion7c22ff72019-04-04 12:25:44 +0200128 ASSERT (sa->integ_icv_size <= ESP_MAX_ICV_SIZE);
Damjan Marionb966e8b2019-03-20 16:07:09 +0100129}
130
Fan Zhangf5395782020-04-29 14:00:03 +0100131void
132ipsec_sa_set_async_op_ids (ipsec_sa_t * sa)
133{
134 /* *INDENT-OFF* */
135 if (ipsec_sa_is_set_USE_ESN (sa))
136 {
137#define _(n, s, k) \
138 if( sa->sync_op_data.crypto_enc_op_id == VNET_CRYPTO_OP_##n##_ENC ) \
139 sa->async_op_data.crypto_async_enc_op_id = \
140 VNET_CRYPTO_OP_##n##_TAG16_AAD12_ENC; \
141 if( sa->sync_op_data.crypto_dec_op_id == VNET_CRYPTO_OP_##n##_DEC ) \
142 sa->async_op_data.crypto_async_dec_op_id = \
143 VNET_CRYPTO_OP_##n##_TAG16_AAD12_DEC;
144 foreach_crypto_aead_alg
145#undef _
146 }
147 else
148 {
149#define _(n, s, k) \
150 if( sa->sync_op_data.crypto_enc_op_id == VNET_CRYPTO_OP_##n##_ENC ) \
151 sa->async_op_data.crypto_async_enc_op_id = \
152 VNET_CRYPTO_OP_##n##_TAG16_AAD8_ENC; \
153 if( sa->sync_op_data.crypto_dec_op_id == VNET_CRYPTO_OP_##n##_DEC ) \
154 sa->async_op_data.crypto_async_dec_op_id = \
155 VNET_CRYPTO_OP_##n##_TAG16_AAD8_DEC;
156 foreach_crypto_aead_alg
157#undef _
158 }
159
160#define _(c, h, s, k ,d) \
161 if( sa->sync_op_data.crypto_enc_op_id == VNET_CRYPTO_OP_##c##_ENC && \
162 sa->sync_op_data.integ_op_id == VNET_CRYPTO_OP_##h##_HMAC) \
163 sa->async_op_data.crypto_async_enc_op_id = \
164 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_ENC; \
165 if( sa->sync_op_data.crypto_dec_op_id == VNET_CRYPTO_OP_##c##_DEC && \
166 sa->sync_op_data.integ_op_id == VNET_CRYPTO_OP_##h##_HMAC) \
167 sa->async_op_data.crypto_async_dec_op_id = \
168 VNET_CRYPTO_OP_##c##_##h##_TAG##d##_DEC;
169 foreach_crypto_link_async_alg
170#undef _
171 /* *INDENT-ON* */
172}
173
Neale Ranns999c8ee2019-02-01 03:31:24 -0800174int
Arthur de Kerhor4117b242022-08-31 19:13:03 +0200175ipsec_sa_update (u32 id, u16 src_port, u16 dst_port, const tunnel_t *tun,
176 bool is_tun)
177{
178 ipsec_main_t *im = &ipsec_main;
179 ipsec_sa_t *sa;
180 u32 sa_index;
181 uword *p;
182 int rv;
183
184 p = hash_get (im->sa_index_by_sa_id, id);
185 if (!p)
186 return VNET_API_ERROR_NO_SUCH_ENTRY;
187
188 sa = ipsec_sa_get (p[0]);
189 sa_index = sa - ipsec_sa_pool;
190
191 if (is_tun && ipsec_sa_is_set_IS_TUNNEL (sa) &&
192 (ip_address_cmp (&tun->t_src, &sa->tunnel.t_src) != 0 ||
193 ip_address_cmp (&tun->t_dst, &sa->tunnel.t_dst) != 0))
194 {
195 /* if the source IP is updated for an inbound SA under a tunnel protect,
196 we need to update the tun_protect DB with the new src IP */
197 if (ipsec_sa_is_set_IS_INBOUND (sa) &&
198 ip_address_cmp (&tun->t_src, &sa->tunnel.t_src) != 0 &&
199 !ip46_address_is_zero (&tun->t_src.ip))
200 {
201 if (ip46_address_is_ip4 (&sa->tunnel.t_src.ip))
202 {
203 ipsec4_tunnel_kv_t old_key, new_key;
204 clib_bihash_kv_8_16_t res,
205 *bkey = (clib_bihash_kv_8_16_t *) &old_key;
206
207 ipsec4_tunnel_mk_key (&old_key, &sa->tunnel.t_src.ip.ip4,
208 clib_host_to_net_u32 (sa->spi));
209 ipsec4_tunnel_mk_key (&new_key, &tun->t_src.ip.ip4,
210 clib_host_to_net_u32 (sa->spi));
211
212 if (!clib_bihash_search_8_16 (&im->tun4_protect_by_key, bkey,
213 &res))
214 {
215 clib_bihash_add_del_8_16 (&im->tun4_protect_by_key, &res, 0);
216 res.key = new_key.key;
217 clib_bihash_add_del_8_16 (&im->tun4_protect_by_key, &res, 1);
218 }
219 }
220 else
221 {
222 ipsec6_tunnel_kv_t old_key = {
223 .key = {
224 .remote_ip = sa->tunnel.t_src.ip.ip6,
225 .spi = clib_host_to_net_u32 (sa->spi),
226 },
227 }, new_key = {
228 .key = {
229 .remote_ip = tun->t_src.ip.ip6,
230 .spi = clib_host_to_net_u32 (sa->spi),
231 }};
232 clib_bihash_kv_24_16_t res,
233 *bkey = (clib_bihash_kv_24_16_t *) &old_key;
234
235 if (!clib_bihash_search_24_16 (&im->tun6_protect_by_key, bkey,
236 &res))
237 {
238 clib_bihash_add_del_24_16 (&im->tun6_protect_by_key, &res,
239 0);
240 clib_memcpy (&res.key, &new_key.key, 3);
241 clib_bihash_add_del_24_16 (&im->tun6_protect_by_key, &res,
242 1);
243 }
244 }
245 }
246 tunnel_unresolve (&sa->tunnel);
247 tunnel_copy (tun, &sa->tunnel);
248 if (!ipsec_sa_is_set_IS_INBOUND (sa))
249 {
250 dpo_reset (&sa->dpo);
251
252 sa->tunnel_flags = sa->tunnel.t_encap_decap_flags;
253
254 rv = tunnel_resolve (&sa->tunnel, FIB_NODE_TYPE_IPSEC_SA, sa_index);
255
256 if (rv)
257 {
258 hash_unset (im->sa_index_by_sa_id, sa->id);
259 pool_put (ipsec_sa_pool, sa);
260 return rv;
261 }
262 ipsec_sa_stack (sa);
263 /* generate header templates */
264 if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
265 {
266 tunnel_build_v6_hdr (&sa->tunnel,
267 (ipsec_sa_is_set_UDP_ENCAP (sa) ?
268 IP_PROTOCOL_UDP :
269 IP_PROTOCOL_IPSEC_ESP),
270 &sa->ip6_hdr);
271 }
272 else
273 {
274 tunnel_build_v4_hdr (&sa->tunnel,
275 (ipsec_sa_is_set_UDP_ENCAP (sa) ?
276 IP_PROTOCOL_UDP :
277 IP_PROTOCOL_IPSEC_ESP),
278 &sa->ip4_hdr);
279 }
280 }
281 }
282
283 if (ipsec_sa_is_set_UDP_ENCAP (sa))
284 {
285 if (dst_port != IPSEC_UDP_PORT_NONE &&
286 dst_port != clib_net_to_host_u16 (sa->udp_hdr.dst_port))
287 {
288 if (ipsec_sa_is_set_IS_INBOUND (sa))
289 {
290 ipsec_unregister_udp_port (
291 clib_net_to_host_u16 (sa->udp_hdr.dst_port),
292 !ipsec_sa_is_set_IS_TUNNEL_V6 (sa));
293 ipsec_register_udp_port (dst_port,
294 !ipsec_sa_is_set_IS_TUNNEL_V6 (sa));
295 }
296 sa->udp_hdr.dst_port = clib_host_to_net_u16 (dst_port);
297 }
298 if (src_port != IPSEC_UDP_PORT_NONE &&
299 src_port != clib_net_to_host_u16 (sa->udp_hdr.src_port))
300 sa->udp_hdr.src_port = clib_host_to_net_u16 (src_port);
301 }
302 return (0);
303}
304
305int
Neale Ranns9ec846c2021-02-09 14:04:02 +0000306ipsec_sa_add_and_lock (u32 id, u32 spi, ipsec_protocol_t proto,
307 ipsec_crypto_alg_t crypto_alg, const ipsec_key_t *ck,
308 ipsec_integ_alg_t integ_alg, const ipsec_key_t *ik,
309 ipsec_sa_flags_t flags, u32 salt, u16 src_port,
310 u16 dst_port, const tunnel_t *tun, u32 *sa_out_index)
Neale Ranns8d7c5022019-02-06 01:41:05 -0800311{
Damjan Mariond1bed682019-04-24 15:20:35 +0200312 vlib_main_t *vm = vlib_get_main ();
Neale Ranns8d7c5022019-02-06 01:41:05 -0800313 ipsec_main_t *im = &ipsec_main;
314 clib_error_t *err;
315 ipsec_sa_t *sa;
316 u32 sa_index;
317 uword *p;
Neale Ranns9ec846c2021-02-09 14:04:02 +0000318 int rv;
Neale Ranns8d7c5022019-02-06 01:41:05 -0800319
320 p = hash_get (im->sa_index_by_sa_id, id);
321 if (p)
322 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
323
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000324 pool_get_aligned_zero (ipsec_sa_pool, sa, CLIB_CACHE_LINE_BYTES);
Neale Ranns8d7c5022019-02-06 01:41:05 -0800325
326 fib_node_init (&sa->node, FIB_NODE_TYPE_IPSEC_SA);
Neale Ranns495d7ff2019-07-12 09:15:26 +0000327 fib_node_lock (&sa->node);
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000328 sa_index = sa - ipsec_sa_pool;
Neale Ranns8d7c5022019-02-06 01:41:05 -0800329
Neale Rannseba31ec2019-02-17 18:04:27 +0000330 vlib_validate_combined_counter (&ipsec_sa_counters, sa_index);
331 vlib_zero_combined_counter (&ipsec_sa_counters, sa_index);
Neale Rannse11203e2021-09-21 12:34:19 +0000332 vlib_validate_simple_counter (&ipsec_sa_lost_counters, sa_index);
333 vlib_zero_simple_counter (&ipsec_sa_lost_counters, sa_index);
Neale Rannseba31ec2019-02-17 18:04:27 +0000334
Neale Ranns9ec846c2021-02-09 14:04:02 +0000335 tunnel_copy (tun, &sa->tunnel);
Neale Ranns8d7c5022019-02-06 01:41:05 -0800336 sa->id = id;
337 sa->spi = spi;
Neale Rannseba31ec2019-02-17 18:04:27 +0000338 sa->stat_index = sa_index;
Neale Ranns8d7c5022019-02-06 01:41:05 -0800339 sa->protocol = proto;
Neale Ranns2b5ba952019-04-02 10:15:40 +0000340 sa->flags = flags;
Neale Ranns47feb112019-04-11 15:14:07 +0000341 sa->salt = salt;
Neale Ranns1a52d372021-02-04 11:33:32 +0000342 sa->thread_index = (vlib_num_workers ()) ? ~0 : 0;
Filip Tehlarc41217a2019-10-18 17:51:06 +0000343 if (integ_alg != IPSEC_INTEG_ALG_NONE)
344 {
345 ipsec_sa_set_integ_alg (sa, integ_alg);
346 clib_memcpy (&sa->integ_key, ik, sizeof (sa->integ_key));
347 }
Neale Ranns47feb112019-04-11 15:14:07 +0000348 ipsec_sa_set_crypto_alg (sa, crypto_alg);
Fan Zhangf5395782020-04-29 14:00:03 +0100349 ipsec_sa_set_async_op_ids (sa);
350
Neale Ranns47feb112019-04-11 15:14:07 +0000351 clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
Neale Ranns8d7c5022019-02-06 01:41:05 -0800352
Damjan Mariond1bed682019-04-24 15:20:35 +0200353 sa->crypto_key_index = vnet_crypto_key_add (vm,
354 im->crypto_algs[crypto_alg].alg,
355 (u8 *) ck->data, ck->len);
Benoît Gannebe954442019-04-29 16:05:46 +0200356 if (~0 == sa->crypto_key_index)
Neale Rannse6be7022019-06-04 15:37:34 +0000357 {
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000358 pool_put (ipsec_sa_pool, sa);
Neale Rannse6be7022019-06-04 15:37:34 +0000359 return VNET_API_ERROR_KEY_LENGTH;
360 }
Benoît Gannebe954442019-04-29 16:05:46 +0200361
Filip Tehlarc41217a2019-10-18 17:51:06 +0000362 if (integ_alg != IPSEC_INTEG_ALG_NONE)
Neale Rannse6be7022019-06-04 15:37:34 +0000363 {
Filip Tehlarc41217a2019-10-18 17:51:06 +0000364 sa->integ_key_index = vnet_crypto_key_add (vm,
365 im->
366 integ_algs[integ_alg].alg,
367 (u8 *) ik->data, ik->len);
368 if (~0 == sa->integ_key_index)
369 {
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000370 pool_put (ipsec_sa_pool, sa);
Filip Tehlarc41217a2019-10-18 17:51:06 +0000371 return VNET_API_ERROR_KEY_LENGTH;
372 }
Neale Rannse6be7022019-06-04 15:37:34 +0000373 }
Damjan Mariond1bed682019-04-24 15:20:35 +0200374
Fan Zhangf5395782020-04-29 14:00:03 +0100375 if (sa->async_op_data.crypto_async_enc_op_id &&
376 !ipsec_sa_is_set_IS_AEAD (sa))
377 { //AES-CBC & HMAC
378 sa->async_op_data.linked_key_index =
379 vnet_crypto_key_add_linked (vm, sa->crypto_key_index,
380 sa->integ_key_index);
381 }
382
383 if (im->async_mode)
384 sa->crypto_op_data = sa->async_op_data.data;
385 else
Neale Rannsf16e9a52021-02-25 19:09:24 +0000386 {
387 if (ipsec_sa_is_set_IS_ASYNC (sa))
388 {
389 vnet_crypto_request_async_mode (1);
390 sa->crypto_op_data = sa->async_op_data.data;
391 }
392 else
393 sa->crypto_op_data = sa->sync_op_data.data;
394 }
Fan Zhangf5395782020-04-29 14:00:03 +0100395
Neale Ranns8d7c5022019-02-06 01:41:05 -0800396 err = ipsec_check_support_cb (im, sa);
397 if (err)
398 {
399 clib_warning ("%s", err->what);
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000400 pool_put (ipsec_sa_pool, sa);
Neale Ranns8d7c5022019-02-06 01:41:05 -0800401 return VNET_API_ERROR_UNIMPLEMENTED;
402 }
403
404 err = ipsec_call_add_del_callbacks (im, sa, sa_index, 1);
405 if (err)
406 {
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000407 pool_put (ipsec_sa_pool, sa);
Neale Ranns8d7c5022019-02-06 01:41:05 -0800408 return VNET_API_ERROR_SYSCALL_ERROR_1;
409 }
410
Neale Ranns53dd08c2021-06-24 15:41:03 +0000411 if (ipsec_sa_is_set_IS_TUNNEL (sa) &&
412 AF_IP6 == ip_addr_version (&tun->t_src))
413 ipsec_sa_set_IS_TUNNEL_V6 (sa);
414
Neale Ranns2b5ba952019-04-02 10:15:40 +0000415 if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
Neale Ranns8d7c5022019-02-06 01:41:05 -0800416 {
Neale Ranns9ec846c2021-02-09 14:04:02 +0000417 sa->tunnel_flags = sa->tunnel.t_encap_decap_flags;
418
419 rv = tunnel_resolve (&sa->tunnel, FIB_NODE_TYPE_IPSEC_SA, sa_index);
420
421 if (rv)
Neale Ranns8d7c5022019-02-06 01:41:05 -0800422 {
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000423 pool_put (ipsec_sa_pool, sa);
Neale Ranns9ec846c2021-02-09 14:04:02 +0000424 return rv;
Neale Ranns8d7c5022019-02-06 01:41:05 -0800425 }
Neale Ranns8d7c5022019-02-06 01:41:05 -0800426 ipsec_sa_stack (sa);
Damjan Marionc59b9a22019-03-19 15:38:40 +0100427
428 /* generate header templates */
Damjan Mariond709cbc2019-03-26 13:16:42 +0100429 if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
Damjan Marionc59b9a22019-03-19 15:38:40 +0100430 {
Neale Ranns9ec846c2021-02-09 14:04:02 +0000431 tunnel_build_v6_hdr (&sa->tunnel,
432 (ipsec_sa_is_set_UDP_ENCAP (sa) ?
433 IP_PROTOCOL_UDP :
434 IP_PROTOCOL_IPSEC_ESP),
435 &sa->ip6_hdr);
Damjan Marionc59b9a22019-03-19 15:38:40 +0100436 }
437 else
438 {
Neale Ranns9ec846c2021-02-09 14:04:02 +0000439 tunnel_build_v4_hdr (&sa->tunnel,
440 (ipsec_sa_is_set_UDP_ENCAP (sa) ?
441 IP_PROTOCOL_UDP :
442 IP_PROTOCOL_IPSEC_ESP),
443 &sa->ip4_hdr);
Damjan Marionc59b9a22019-03-19 15:38:40 +0100444 }
Neale Ranns8d7c5022019-02-06 01:41:05 -0800445 }
Damjan Marionc59b9a22019-03-19 15:38:40 +0100446
Damjan Mariond709cbc2019-03-26 13:16:42 +0100447 if (ipsec_sa_is_set_UDP_ENCAP (sa))
Damjan Marionc59b9a22019-03-19 15:38:40 +0100448 {
Filip Tehlare5d34912020-03-02 15:17:37 +0000449 if (dst_port == IPSEC_UDP_PORT_NONE)
Neale Rannsabc56602020-04-01 09:45:23 +0000450 sa->udp_hdr.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
Filip Tehlare5d34912020-03-02 15:17:37 +0000451 else
Neale Rannsabc56602020-04-01 09:45:23 +0000452 sa->udp_hdr.dst_port = clib_host_to_net_u16 (dst_port);
453
454 if (src_port == IPSEC_UDP_PORT_NONE)
455 sa->udp_hdr.src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
456 else
457 sa->udp_hdr.src_port = clib_host_to_net_u16 (src_port);
458
459 if (ipsec_sa_is_set_IS_INBOUND (sa))
Matthew Smith6f1eb482022-08-09 22:19:38 +0000460 ipsec_register_udp_port (clib_host_to_net_u16 (sa->udp_hdr.dst_port),
461 !ipsec_sa_is_set_IS_TUNNEL_V6 (sa));
Damjan Marionc59b9a22019-03-19 15:38:40 +0100462 }
463
Neale Ranns8d7c5022019-02-06 01:41:05 -0800464 hash_set (im->sa_index_by_sa_id, sa->id, sa_index);
465
466 if (sa_out_index)
467 *sa_out_index = sa_index;
468
469 return (0);
470}
471
Neale Ranns495d7ff2019-07-12 09:15:26 +0000472static void
473ipsec_sa_del (ipsec_sa_t * sa)
Neale Ranns999c8ee2019-02-01 03:31:24 -0800474{
Damjan Mariond1bed682019-04-24 15:20:35 +0200475 vlib_main_t *vm = vlib_get_main ();
Neale Ranns999c8ee2019-02-01 03:31:24 -0800476 ipsec_main_t *im = &ipsec_main;
Neale Ranns999c8ee2019-02-01 03:31:24 -0800477 u32 sa_index;
Neale Ranns999c8ee2019-02-01 03:31:24 -0800478
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000479 sa_index = sa - ipsec_sa_pool;
Neale Ranns8d7c5022019-02-06 01:41:05 -0800480 hash_unset (im->sa_index_by_sa_id, sa->id);
Neale Ranns9ec846c2021-02-09 14:04:02 +0000481 tunnel_unresolve (&sa->tunnel);
Neale Ranns495d7ff2019-07-12 09:15:26 +0000482
483 /* no recovery possible when deleting an SA */
484 (void) ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
Damjan Mariond709cbc2019-03-26 13:16:42 +0100485
Neale Rannsf16e9a52021-02-25 19:09:24 +0000486 if (ipsec_sa_is_set_IS_ASYNC (sa))
Benoît Ganneab412cd2023-01-03 18:35:04 +0100487 {
488 vnet_crypto_request_async_mode (0);
489 if (!ipsec_sa_is_set_IS_AEAD (sa))
490 vnet_crypto_key_del (vm, sa->async_op_data.linked_key_index);
491 }
492
Neale Rannsabc56602020-04-01 09:45:23 +0000493 if (ipsec_sa_is_set_UDP_ENCAP (sa) && ipsec_sa_is_set_IS_INBOUND (sa))
Matthew Smith6f1eb482022-08-09 22:19:38 +0000494 ipsec_unregister_udp_port (clib_net_to_host_u16 (sa->udp_hdr.dst_port),
495 !ipsec_sa_is_set_IS_TUNNEL_V6 (sa));
Neale Rannsabc56602020-04-01 09:45:23 +0000496
Neale Ranns2b5ba952019-04-02 10:15:40 +0000497 if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
Neale Ranns9ec846c2021-02-09 14:04:02 +0000498 dpo_reset (&sa->dpo);
Damjan Mariond1bed682019-04-24 15:20:35 +0200499 vnet_crypto_key_del (vm, sa->crypto_key_index);
Filip Tehlarc41217a2019-10-18 17:51:06 +0000500 if (sa->integ_alg != IPSEC_INTEG_ALG_NONE)
501 vnet_crypto_key_del (vm, sa->integ_key_index);
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000502 pool_put (ipsec_sa_pool, sa);
Neale Ranns495d7ff2019-07-12 09:15:26 +0000503}
504
505void
506ipsec_sa_unlock (index_t sai)
507{
Neale Ranns495d7ff2019-07-12 09:15:26 +0000508 ipsec_sa_t *sa;
509
510 if (INDEX_INVALID == sai)
511 return;
512
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000513 sa = ipsec_sa_get (sai);
Neale Ranns495d7ff2019-07-12 09:15:26 +0000514
515 fib_node_unlock (&sa->node);
516}
517
Neale Ranns12989b52019-09-26 16:20:19 +0000518void
519ipsec_sa_lock (index_t sai)
520{
Neale Ranns12989b52019-09-26 16:20:19 +0000521 ipsec_sa_t *sa;
522
523 if (INDEX_INVALID == sai)
524 return;
525
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000526 sa = ipsec_sa_get (sai);
Neale Ranns12989b52019-09-26 16:20:19 +0000527
528 fib_node_lock (&sa->node);
529}
530
Neale Ranns495d7ff2019-07-12 09:15:26 +0000531index_t
532ipsec_sa_find_and_lock (u32 id)
533{
534 ipsec_main_t *im = &ipsec_main;
535 ipsec_sa_t *sa;
536 uword *p;
537
538 p = hash_get (im->sa_index_by_sa_id, id);
539
540 if (!p)
541 return INDEX_INVALID;
542
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000543 sa = ipsec_sa_get (p[0]);
Neale Ranns495d7ff2019-07-12 09:15:26 +0000544
545 fib_node_lock (&sa->node);
546
547 return (p[0]);
548}
549
550int
551ipsec_sa_unlock_id (u32 id)
552{
553 ipsec_main_t *im = &ipsec_main;
554 uword *p;
555
556 p = hash_get (im->sa_index_by_sa_id, id);
557
558 if (!p)
559 return VNET_API_ERROR_NO_SUCH_ENTRY;
560
561 ipsec_sa_unlock (p[0]);
562
563 return (0);
Neale Ranns999c8ee2019-02-01 03:31:24 -0800564}
565
Neale Rannsc87b66c2019-02-07 07:26:12 -0800566void
567ipsec_sa_clear (index_t sai)
568{
569 vlib_zero_combined_counter (&ipsec_sa_counters, sai);
Neale Rannse11203e2021-09-21 12:34:19 +0000570 vlib_zero_simple_counter (&ipsec_sa_lost_counters, sai);
Neale Rannsc87b66c2019-02-07 07:26:12 -0800571}
572
Neale Rannsb4cfd552019-02-13 02:08:06 -0800573void
574ipsec_sa_walk (ipsec_sa_walk_cb_t cb, void *ctx)
575{
Neale Rannsb4cfd552019-02-13 02:08:06 -0800576 ipsec_sa_t *sa;
577
578 /* *INDENT-OFF* */
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000579 pool_foreach (sa, ipsec_sa_pool)
580 {
581 if (WALK_CONTINUE != cb (sa, ctx))
582 break;
583 }
Neale Rannsb4cfd552019-02-13 02:08:06 -0800584 /* *INDENT-ON* */
585}
586
Neale Ranns8d7c5022019-02-06 01:41:05 -0800587/**
588 * Function definition to get a FIB node from its index
589 */
590static fib_node_t *
591ipsec_sa_fib_node_get (fib_node_index_t index)
592{
Neale Ranns8d7c5022019-02-06 01:41:05 -0800593 ipsec_sa_t *sa;
594
Neale Rannsc5fe57d2021-02-25 16:01:28 +0000595 sa = ipsec_sa_get (index);
Neale Ranns8d7c5022019-02-06 01:41:05 -0800596
597 return (&sa->node);
598}
599
Neale Ranns495d7ff2019-07-12 09:15:26 +0000600static ipsec_sa_t *
601ipsec_sa_from_fib_node (fib_node_t * node)
602{
603 ASSERT (FIB_NODE_TYPE_IPSEC_SA == node->fn_type);
604 return ((ipsec_sa_t *) (((char *) node) -
605 STRUCT_OFFSET_OF (ipsec_sa_t, node)));
606
607}
608
Neale Ranns8d7c5022019-02-06 01:41:05 -0800609/**
610 * Function definition to inform the FIB node that its last lock has gone.
611 */
612static void
613ipsec_sa_last_lock_gone (fib_node_t * node)
614{
615 /*
616 * The ipsec SA is a root of the graph. As such
617 * it never has children and thus is never locked.
618 */
Neale Ranns495d7ff2019-07-12 09:15:26 +0000619 ipsec_sa_del (ipsec_sa_from_fib_node (node));
Neale Ranns8d7c5022019-02-06 01:41:05 -0800620}
621
622/**
623 * Function definition to backwalk a FIB node
624 */
625static fib_node_back_walk_rc_t
626ipsec_sa_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
627{
628 ipsec_sa_stack (ipsec_sa_from_fib_node (node));
629
630 return (FIB_NODE_BACK_WALK_CONTINUE);
631}
632
633/*
Neale Rannsc87b66c2019-02-07 07:26:12 -0800634 * Virtual function table registered by SAs
Neale Ranns8d7c5022019-02-06 01:41:05 -0800635 * for participation in the FIB object graph.
636 */
637const static fib_node_vft_t ipsec_sa_vft = {
638 .fnv_get = ipsec_sa_fib_node_get,
639 .fnv_last_lock = ipsec_sa_last_lock_gone,
640 .fnv_back_walk = ipsec_sa_back_walk,
641};
642
643/* force inclusion from application's main.c */
644clib_error_t *
645ipsec_sa_interface_init (vlib_main_t * vm)
646{
647 fib_node_register_type (FIB_NODE_TYPE_IPSEC_SA, &ipsec_sa_vft);
648
649 return 0;
650}
651
652VLIB_INIT_FUNCTION (ipsec_sa_interface_init);
653
Neale Ranns999c8ee2019-02-01 03:31:24 -0800654/*
655 * fd.io coding-style-patch-verification: ON
656 *
657 * Local Variables:
658 * eval: (c-set-style "gnu")
659 * End:
660 */