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.
16 #include <vnet/ipsec/ipsec.h>
17 #include <vnet/ipsec/esp.h>
18 #include <vnet/udp/udp_local.h>
19 #include <vnet/fib/fib_table.h>
20 #include <vnet/fib/fib_entry_track.h>
21 #include <vnet/ipsec/ipsec_tun.h>
25 * SA packet & bytes counters
27 vlib_combined_counter_main_t ipsec_sa_counters = {
29 .stat_segment_name = "/net/ipsec/sa",
31 vlib_simple_counter_main_t ipsec_sa_lost_counters = {
33 .stat_segment_name = "/net/ipsec/sa/lost",
36 ipsec_sa_t *ipsec_sa_pool;
39 ipsec_call_add_del_callbacks (ipsec_main_t * im, ipsec_sa_t * sa,
40 u32 sa_index, int is_add)
42 ipsec_ah_backend_t *ab;
43 ipsec_esp_backend_t *eb;
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);
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);
61 ipsec_mk_key (ipsec_key_t * key, const u8 * data, u8 len)
63 memset (key, 0, sizeof (*key));
65 if (len > sizeof (key->data))
66 key->len = sizeof (key->data);
70 memcpy (key->data, data, key->len);
74 * 'stack' (resolve the recursion for) the SA tunnel destination
77 ipsec_sa_stack (ipsec_sa_t * sa)
79 ipsec_main_t *im = &ipsec_main;
80 dpo_id_t tmp = DPO_INVALID;
82 tunnel_contribute_forwarding (&sa->tunnel, &tmp);
84 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);
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);
96 ipsec_sa_set_crypto_alg (ipsec_sa_t * sa, ipsec_crypto_alg_t crypto_alg)
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;
101 sa->esp_block_align = clib_max (4, im->crypto_algs[crypto_alg].block_align);
102 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;
104 sa->crypto_calg = im->crypto_algs[crypto_alg].alg;
105 ASSERT (sa->crypto_iv_size <= ESP_MAX_IV_SIZE);
106 ASSERT (sa->esp_block_align <= ESP_MAX_BLOCK_SIZE);
107 if (IPSEC_CRYPTO_ALG_IS_GCM (crypto_alg) ||
108 IPSEC_CRYPTO_ALG_CTR_AEAD_OTHERS (crypto_alg))
110 sa->integ_icv_size = im->crypto_algs[crypto_alg].icv_size;
111 ipsec_sa_set_IS_CTR (sa);
112 ipsec_sa_set_IS_AEAD (sa);
114 else if (IPSEC_CRYPTO_ALG_IS_CTR (crypto_alg))
116 ipsec_sa_set_IS_CTR (sa);
121 ipsec_sa_set_integ_alg (ipsec_sa_t * sa, ipsec_integ_alg_t integ_alg)
123 ipsec_main_t *im = &ipsec_main;
124 sa->integ_alg = integ_alg;
125 sa->integ_icv_size = im->integ_algs[integ_alg].icv_size;
126 sa->sync_op_data.integ_op_id = im->integ_algs[integ_alg].op_id;
127 sa->integ_calg = im->integ_algs[integ_alg].alg;
128 ASSERT (sa->integ_icv_size <= ESP_MAX_ICV_SIZE);
132 ipsec_sa_set_async_op_ids (ipsec_sa_t * sa)
135 if (ipsec_sa_is_set_USE_ESN (sa))
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
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
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
175 ipsec_sa_update (u32 id, u16 src_port, u16 dst_port, const tunnel_t *tun,
178 ipsec_main_t *im = &ipsec_main;
184 p = hash_get (im->sa_index_by_sa_id, id);
186 return VNET_API_ERROR_NO_SUCH_ENTRY;
188 sa = ipsec_sa_get (p[0]);
189 sa_index = sa - ipsec_sa_pool;
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))
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))
201 if (ip46_address_is_ip4 (&sa->tunnel.t_src.ip))
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;
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));
212 if (!clib_bihash_search_8_16 (&im->tun4_protect_by_key, bkey,
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);
222 ipsec6_tunnel_kv_t old_key = {
224 .remote_ip = sa->tunnel.t_src.ip.ip6,
225 .spi = clib_host_to_net_u32 (sa->spi),
229 .remote_ip = tun->t_src.ip.ip6,
230 .spi = clib_host_to_net_u32 (sa->spi),
232 clib_bihash_kv_24_16_t res,
233 *bkey = (clib_bihash_kv_24_16_t *) &old_key;
235 if (!clib_bihash_search_24_16 (&im->tun6_protect_by_key, bkey,
238 clib_bihash_add_del_24_16 (&im->tun6_protect_by_key, &res,
240 clib_memcpy (&res.key, &new_key.key, 3);
241 clib_bihash_add_del_24_16 (&im->tun6_protect_by_key, &res,
246 tunnel_unresolve (&sa->tunnel);
247 tunnel_copy (tun, &sa->tunnel);
248 if (!ipsec_sa_is_set_IS_INBOUND (sa))
250 dpo_reset (&sa->dpo);
252 sa->tunnel_flags = sa->tunnel.t_encap_decap_flags;
254 rv = tunnel_resolve (&sa->tunnel, FIB_NODE_TYPE_IPSEC_SA, sa_index);
258 hash_unset (im->sa_index_by_sa_id, sa->id);
259 pool_put (ipsec_sa_pool, sa);
263 /* generate header templates */
264 if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
266 tunnel_build_v6_hdr (&sa->tunnel,
267 (ipsec_sa_is_set_UDP_ENCAP (sa) ?
269 IP_PROTOCOL_IPSEC_ESP),
274 tunnel_build_v4_hdr (&sa->tunnel,
275 (ipsec_sa_is_set_UDP_ENCAP (sa) ?
277 IP_PROTOCOL_IPSEC_ESP),
283 if (ipsec_sa_is_set_UDP_ENCAP (sa))
285 if (dst_port != IPSEC_UDP_PORT_NONE &&
286 dst_port != clib_net_to_host_u16 (sa->udp_hdr.dst_port))
288 if (ipsec_sa_is_set_IS_INBOUND (sa))
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));
296 sa->udp_hdr.dst_port = clib_host_to_net_u16 (dst_port);
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);
306 ipsec_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)
312 vlib_main_t *vm = vlib_get_main ();
313 ipsec_main_t *im = &ipsec_main;
320 p = hash_get (im->sa_index_by_sa_id, id);
322 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
324 pool_get_aligned_zero (ipsec_sa_pool, sa, CLIB_CACHE_LINE_BYTES);
326 fib_node_init (&sa->node, FIB_NODE_TYPE_IPSEC_SA);
327 fib_node_lock (&sa->node);
328 sa_index = sa - ipsec_sa_pool;
330 vlib_validate_combined_counter (&ipsec_sa_counters, sa_index);
331 vlib_zero_combined_counter (&ipsec_sa_counters, sa_index);
332 vlib_validate_simple_counter (&ipsec_sa_lost_counters, sa_index);
333 vlib_zero_simple_counter (&ipsec_sa_lost_counters, sa_index);
335 tunnel_copy (tun, &sa->tunnel);
338 sa->stat_index = sa_index;
339 sa->protocol = proto;
342 sa->thread_index = (vlib_num_workers ()) ? ~0 : 0;
343 if (integ_alg != IPSEC_INTEG_ALG_NONE)
345 ipsec_sa_set_integ_alg (sa, integ_alg);
346 clib_memcpy (&sa->integ_key, ik, sizeof (sa->integ_key));
348 ipsec_sa_set_crypto_alg (sa, crypto_alg);
349 ipsec_sa_set_async_op_ids (sa);
351 clib_memcpy (&sa->crypto_key, ck, sizeof (sa->crypto_key));
353 sa->crypto_key_index = vnet_crypto_key_add (vm,
354 im->crypto_algs[crypto_alg].alg,
355 (u8 *) ck->data, ck->len);
356 if (~0 == sa->crypto_key_index)
358 pool_put (ipsec_sa_pool, sa);
359 return VNET_API_ERROR_KEY_LENGTH;
362 if (integ_alg != IPSEC_INTEG_ALG_NONE)
364 sa->integ_key_index = vnet_crypto_key_add (vm,
366 integ_algs[integ_alg].alg,
367 (u8 *) ik->data, ik->len);
368 if (~0 == sa->integ_key_index)
370 pool_put (ipsec_sa_pool, sa);
371 return VNET_API_ERROR_KEY_LENGTH;
375 if (sa->async_op_data.crypto_async_enc_op_id &&
376 !ipsec_sa_is_set_IS_AEAD (sa))
378 sa->async_op_data.linked_key_index =
379 vnet_crypto_key_add_linked (vm, sa->crypto_key_index,
380 sa->integ_key_index);
384 sa->crypto_op_data = sa->async_op_data.data;
387 if (ipsec_sa_is_set_IS_ASYNC (sa))
389 vnet_crypto_request_async_mode (1);
390 sa->crypto_op_data = sa->async_op_data.data;
393 sa->crypto_op_data = sa->sync_op_data.data;
396 err = ipsec_check_support_cb (im, sa);
399 clib_warning ("%s", err->what);
400 pool_put (ipsec_sa_pool, sa);
401 return VNET_API_ERROR_UNIMPLEMENTED;
404 err = ipsec_call_add_del_callbacks (im, sa, sa_index, 1);
407 pool_put (ipsec_sa_pool, sa);
408 return VNET_API_ERROR_SYSCALL_ERROR_1;
411 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);
415 if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
417 sa->tunnel_flags = sa->tunnel.t_encap_decap_flags;
419 rv = tunnel_resolve (&sa->tunnel, FIB_NODE_TYPE_IPSEC_SA, sa_index);
423 pool_put (ipsec_sa_pool, sa);
428 /* generate header templates */
429 if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
431 tunnel_build_v6_hdr (&sa->tunnel,
432 (ipsec_sa_is_set_UDP_ENCAP (sa) ?
434 IP_PROTOCOL_IPSEC_ESP),
439 tunnel_build_v4_hdr (&sa->tunnel,
440 (ipsec_sa_is_set_UDP_ENCAP (sa) ?
442 IP_PROTOCOL_IPSEC_ESP),
447 if (ipsec_sa_is_set_UDP_ENCAP (sa))
449 if (dst_port == IPSEC_UDP_PORT_NONE)
450 sa->udp_hdr.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
452 sa->udp_hdr.dst_port = clib_host_to_net_u16 (dst_port);
454 if (src_port == IPSEC_UDP_PORT_NONE)
455 sa->udp_hdr.src_port = clib_host_to_net_u16 (UDP_DST_PORT_ipsec);
457 sa->udp_hdr.src_port = clib_host_to_net_u16 (src_port);
459 if (ipsec_sa_is_set_IS_INBOUND (sa))
460 ipsec_register_udp_port (clib_host_to_net_u16 (sa->udp_hdr.dst_port),
461 !ipsec_sa_is_set_IS_TUNNEL_V6 (sa));
464 hash_set (im->sa_index_by_sa_id, sa->id, sa_index);
467 *sa_out_index = sa_index;
473 ipsec_sa_del (ipsec_sa_t * sa)
475 vlib_main_t *vm = vlib_get_main ();
476 ipsec_main_t *im = &ipsec_main;
479 sa_index = sa - ipsec_sa_pool;
480 hash_unset (im->sa_index_by_sa_id, sa->id);
481 tunnel_unresolve (&sa->tunnel);
483 /* no recovery possible when deleting an SA */
484 (void) ipsec_call_add_del_callbacks (im, sa, sa_index, 0);
486 if (ipsec_sa_is_set_IS_ASYNC (sa))
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);
493 if (ipsec_sa_is_set_UDP_ENCAP (sa) && ipsec_sa_is_set_IS_INBOUND (sa))
494 ipsec_unregister_udp_port (clib_net_to_host_u16 (sa->udp_hdr.dst_port),
495 !ipsec_sa_is_set_IS_TUNNEL_V6 (sa));
497 if (ipsec_sa_is_set_IS_TUNNEL (sa) && !ipsec_sa_is_set_IS_INBOUND (sa))
498 dpo_reset (&sa->dpo);
499 vnet_crypto_key_del (vm, sa->crypto_key_index);
500 if (sa->integ_alg != IPSEC_INTEG_ALG_NONE)
501 vnet_crypto_key_del (vm, sa->integ_key_index);
502 pool_put (ipsec_sa_pool, sa);
506 ipsec_sa_unlock (index_t sai)
510 if (INDEX_INVALID == sai)
513 sa = ipsec_sa_get (sai);
515 fib_node_unlock (&sa->node);
519 ipsec_sa_lock (index_t sai)
523 if (INDEX_INVALID == sai)
526 sa = ipsec_sa_get (sai);
528 fib_node_lock (&sa->node);
532 ipsec_sa_find_and_lock (u32 id)
534 ipsec_main_t *im = &ipsec_main;
538 p = hash_get (im->sa_index_by_sa_id, id);
541 return INDEX_INVALID;
543 sa = ipsec_sa_get (p[0]);
545 fib_node_lock (&sa->node);
551 ipsec_sa_unlock_id (u32 id)
553 ipsec_main_t *im = &ipsec_main;
556 p = hash_get (im->sa_index_by_sa_id, id);
559 return VNET_API_ERROR_NO_SUCH_ENTRY;
561 ipsec_sa_unlock (p[0]);
567 ipsec_sa_clear (index_t sai)
569 vlib_zero_combined_counter (&ipsec_sa_counters, sai);
570 vlib_zero_simple_counter (&ipsec_sa_lost_counters, sai);
574 ipsec_sa_walk (ipsec_sa_walk_cb_t cb, void *ctx)
579 pool_foreach (sa, ipsec_sa_pool)
581 if (WALK_CONTINUE != cb (sa, ctx))
588 * Function definition to get a FIB node from its index
591 ipsec_sa_fib_node_get (fib_node_index_t index)
595 sa = ipsec_sa_get (index);
601 ipsec_sa_from_fib_node (fib_node_t * node)
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)));
610 * Function definition to inform the FIB node that its last lock has gone.
613 ipsec_sa_last_lock_gone (fib_node_t * node)
616 * The ipsec SA is a root of the graph. As such
617 * it never has children and thus is never locked.
619 ipsec_sa_del (ipsec_sa_from_fib_node (node));
623 * Function definition to backwalk a FIB node
625 static fib_node_back_walk_rc_t
626 ipsec_sa_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
628 ipsec_sa_stack (ipsec_sa_from_fib_node (node));
630 return (FIB_NODE_BACK_WALK_CONTINUE);
634 * Virtual function table registered by SAs
635 * for participation in the FIB object graph.
637 const 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,
643 /* force inclusion from application's main.c */
645 ipsec_sa_interface_init (vlib_main_t * vm)
647 fib_node_register_type (FIB_NODE_TYPE_IPSEC_SA, &ipsec_sa_vft);
652 VLIB_INIT_FUNCTION (ipsec_sa_interface_init);
655 * fd.io coding-style-patch-verification: ON
658 * eval: (c-set-style "gnu")