2 * ipsec_if.c : IPSec interface support
4 * Copyright (c) 2015 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vnet/vnet.h>
19 #include <vnet/api_errno.h>
20 #include <vnet/ip/ip.h>
21 #include <vnet/fib/fib.h>
22 #include <vnet/udp/udp.h>
23 #include <vnet/adj/adj_midchain.h>
25 #include <vnet/ipsec/ipsec.h>
26 #include <vnet/ipsec/esp.h>
28 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
31 format_ipsec_name (u8 * s, va_list * args)
33 u32 dev_instance = va_arg (*args, u32);
34 ipsec_main_t *im = &ipsec_main;
35 ipsec_tunnel_if_t *t = im->tunnel_interfaces + dev_instance;
37 return format (s, "ipsec%d", t->show_instance);
40 /* Statistics (not really errors) */
41 #define foreach_ipsec_if_tx_error \
42 _(TX, "good packets transmitted")
45 ipsec_if_tunnel_stack (adj_index_t ai)
47 ipsec_main_t *ipm = &ipsec_main;
48 ipsec_tunnel_if_t *it;
53 sw_if_index = adj->rewrite_header.sw_if_index;
55 if ((vec_len (ipm->ipsec_if_by_sw_if_index) <= sw_if_index) ||
56 (~0 == ipm->ipsec_if_by_sw_if_index[sw_if_index]))
59 it = pool_elt_at_index (ipm->tunnel_interfaces,
60 ipm->ipsec_if_by_sw_if_index[sw_if_index]);
62 if (!vnet_hw_interface_is_link_up (vnet_get_main (), it->hw_if_index))
64 adj_midchain_delegate_unstack (ai);
70 sa = ipsec_sa_get (it->output_sa_index);
74 .fp_addr = sa->tunnel_dst_addr,
75 .fp_len = (ipsec_sa_is_set_IS_TUNNEL_V6(sa) ? 128 : 32),
76 .fp_proto = (ipsec_sa_is_set_IS_TUNNEL_V6(sa) ?
82 adj_midchain_delegate_stack (ai, sa->tx_fib_index, &pfx);
87 * @brief Call back when restacking all adjacencies on a GRE interface
90 ipsec_if_adj_walk_cb (adj_index_t ai, void *ctx)
92 ipsec_if_tunnel_stack (ai);
94 return (ADJ_WALK_RC_CONTINUE);
98 ipsec_if_tunnel_restack (ipsec_tunnel_if_t * it)
100 fib_protocol_t proto;
103 * walk all the adjacencies on th GRE interface and restack them
105 FOR_EACH_FIB_IP_PROTOCOL (proto)
107 adj_nbr_walk (it->sw_if_index, proto, ipsec_if_adj_walk_cb, NULL);
111 static clib_error_t *
112 ipsec_admin_up_down_function (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
114 ipsec_main_t *im = &ipsec_main;
115 clib_error_t *err = 0;
116 ipsec_tunnel_if_t *t;
117 vnet_hw_interface_t *hi;
120 hi = vnet_get_hw_interface (vnm, hw_if_index);
121 t = pool_elt_at_index (im->tunnel_interfaces, hi->hw_instance);
124 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
126 sa = pool_elt_at_index (im->sad, t->input_sa_index);
128 err = ipsec_check_support_cb (im, sa);
132 err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 1);
136 sa = pool_elt_at_index (im->sad, t->output_sa_index);
138 err = ipsec_check_support_cb (im, sa);
142 err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 1);
146 vnet_hw_interface_set_flags (vnm, hw_if_index,
147 VNET_HW_INTERFACE_FLAG_LINK_UP);
151 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
152 sa = pool_elt_at_index (im->sad, t->input_sa_index);
153 err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 0);
156 sa = pool_elt_at_index (im->sad, t->output_sa_index);
157 err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 0);
162 ipsec_if_tunnel_restack (t);
168 ipsec_if_build_rewrite (vnet_main_t * vnm,
170 vnet_link_t link_type, const void *dst_address)
176 ipsec_if_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
178 adj_nbr_midchain_update_rewrite
179 (ai, NULL, NULL, ADJ_FLAG_MIDCHAIN_IP_STACK,
180 ipsec_if_build_rewrite (vnm, sw_if_index, adj_get_link_type (ai), NULL));
182 ipsec_if_tunnel_stack (ai);
186 VNET_DEVICE_CLASS (ipsec_device_class) =
189 .format_device_name = format_ipsec_name,
190 .admin_up_down_function = ipsec_admin_up_down_function,
195 VNET_HW_INTERFACE_CLASS (ipsec_hw_class) =
198 .build_rewrite = default_build_rewrite,
199 .update_adjacency = ipsec_if_update_adj,
200 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
205 ipsec_add_del_tunnel_if_rpc_callback (ipsec_add_del_tunnel_args_t * a)
207 vnet_main_t *vnm = vnet_get_main ();
208 ASSERT (vlib_get_thread_index () == 0);
210 return ipsec_add_del_tunnel_if_internal (vnm, a, NULL);
214 ipsec_add_del_tunnel_if (ipsec_add_del_tunnel_args_t * args)
216 vl_api_rpc_call_main_thread (ipsec_add_del_tunnel_if_rpc_callback,
217 (u8 *) args, sizeof (*args));
222 ipsec_tun_mk_input_sa_id (u32 ti)
224 return (0x80000000 | ti);
228 ipsec_tun_mk_output_sa_id (u32 ti)
230 return (0xc0000000 | ti);
234 ipsec_tunnel_feature_set (ipsec_tunnel_if_t * t, u8 enable)
236 vnet_feature_enable_disable ("ip4-output",
238 t->sw_if_index, enable,
240 sizeof (t->output_sa_index));
241 vnet_feature_enable_disable ("ip6-output",
243 t->sw_if_index, enable,
245 sizeof (t->output_sa_index));
249 ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
250 ipsec_add_del_tunnel_args_t * args,
253 ipsec_tunnel_if_t *t;
254 ipsec_main_t *im = &ipsec_main;
255 vnet_hw_interface_t *hi = NULL;
256 u32 hw_if_index = ~0;
259 ipsec_key_t crypto_key, integ_key;
260 ipsec_sa_flags_t flags;
262 int is_ip6 = args->is_ip6;
263 ipsec4_tunnel_key_t key4;
264 ipsec6_tunnel_key_t key6;
268 key4.remote_ip = args->remote_ip.ip4.as_u32;
269 key4.spi = clib_host_to_net_u32 (args->remote_spi);
270 p = hash_get (im->ipsec4_if_pool_index_by_key, key4.as_u64);
274 key6.remote_ip = args->remote_ip.ip6;
275 key6.spi = clib_host_to_net_u32 (args->remote_spi);
276 p = hash_get_mem (im->ipsec6_if_pool_index_by_key, &key6);
281 /* check if same src/dst pair exists */
283 return VNET_API_ERROR_INVALID_VALUE;
285 pool_get_aligned_zero (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
287 dev_instance = t - im->tunnel_interfaces;
289 t->show_instance = args->show_instance;
291 t->show_instance = dev_instance;
293 if (hash_get (im->ipsec_if_real_dev_by_show_dev, t->show_instance))
295 pool_put (im->tunnel_interfaces, t);
296 return VNET_API_ERROR_INSTANCE_IN_USE;
299 hash_set (im->ipsec_if_real_dev_by_show_dev, t->show_instance,
302 flags = IPSEC_SA_FLAG_IS_TUNNEL;
304 flags |= IPSEC_SA_FLAG_IS_TUNNEL_V6;
306 flags |= IPSEC_SA_FLAG_UDP_ENCAP;
308 flags |= IPSEC_SA_FLAG_USE_ESN;
309 if (args->anti_replay)
310 flags |= IPSEC_SA_FLAG_USE_ANTI_REPLAY;
312 ipsec_mk_key (&crypto_key,
313 args->remote_crypto_key, args->remote_crypto_key_len);
314 ipsec_mk_key (&integ_key,
315 args->remote_integ_key, args->remote_integ_key_len);
317 rv = ipsec_sa_add (ipsec_tun_mk_input_sa_id (dev_instance),
324 (flags | IPSEC_SA_FLAG_IS_INBOUND),
328 &args->local_ip, &t->input_sa_index);
331 return VNET_API_ERROR_INVALID_SRC_ADDRESS;
333 ipsec_mk_key (&crypto_key,
334 args->local_crypto_key, args->local_crypto_key_len);
335 ipsec_mk_key (&integ_key,
336 args->local_integ_key, args->local_integ_key_len);
338 rv = ipsec_sa_add (ipsec_tun_mk_output_sa_id (dev_instance),
349 &args->remote_ip, &t->output_sa_index);
352 return VNET_API_ERROR_INVALID_DST_ADDRESS;
356 hash_set_mem_alloc (&im->ipsec6_if_pool_index_by_key, &key6,
357 t - im->tunnel_interfaces);
359 hash_set (im->ipsec4_if_pool_index_by_key, key4.as_u64,
360 t - im->tunnel_interfaces);
362 hw_if_index = vnet_register_interface (vnm, ipsec_device_class.index,
363 t - im->tunnel_interfaces,
364 ipsec_hw_class.index,
365 t - im->tunnel_interfaces);
367 hi = vnet_get_hw_interface (vnm, hw_if_index);
369 t->hw_if_index = hw_if_index;
370 t->sw_if_index = hi->sw_if_index;
372 /* Standard default jumbo MTU. */
373 vnet_sw_interface_set_mtu (vnm, t->sw_if_index, 9000);
375 /* Add the new tunnel to the DB of tunnels per sw_if_index ... */
376 vec_validate_init_empty (im->ipsec_if_by_sw_if_index, t->sw_if_index,
378 im->ipsec_if_by_sw_if_index[t->sw_if_index] = dev_instance;
380 ipsec_tunnel_feature_set (t, 1);
382 /*1st interface, register protocol */
383 if (pool_elts (im->tunnel_interfaces) == 1)
385 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
386 ipsec4_if_input_node.index);
387 ip6_register_protocol (IP_PROTOCOL_IPSEC_ESP,
388 ipsec6_if_input_node.index);
396 /* check if exists */
398 return VNET_API_ERROR_INVALID_VALUE;
401 t = pool_elt_at_index (im->tunnel_interfaces, ti);
402 hi = vnet_get_hw_interface (vnm, t->hw_if_index);
403 vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0); /* admin down */
405 ipsec_tunnel_feature_set (t, 0);
406 vnet_delete_hw_interface (vnm, t->hw_if_index);
409 hash_unset_mem_free (&im->ipsec6_if_pool_index_by_key, &key6);
411 hash_unset (im->ipsec4_if_pool_index_by_key, key4.as_u64);
413 hash_unset (im->ipsec_if_real_dev_by_show_dev, t->show_instance);
414 im->ipsec_if_by_sw_if_index[t->sw_if_index] = ~0;
416 pool_put (im->tunnel_interfaces, t);
418 /* delete input and output SA */
419 ipsec_sa_del (ipsec_tun_mk_input_sa_id (ti));
420 ipsec_sa_del (ipsec_tun_mk_output_sa_id (ti));
424 *sw_if_index = hi->sw_if_index;
430 ipsec_add_del_ipsec_gre_tunnel (vnet_main_t * vnm,
431 const ipsec_gre_tunnel_add_del_args_t * args)
433 ipsec_tunnel_if_t *t = 0;
434 ipsec_main_t *im = &ipsec_main;
437 ipsec4_tunnel_key_t key;
440 p = hash_get (im->sa_index_by_sa_id, args->local_sa_id);
442 return VNET_API_ERROR_INVALID_VALUE;
444 sa = pool_elt_at_index (im->sad, p[0]);
445 ipsec_sa_set_IS_GRE (sa);
447 p = hash_get (im->sa_index_by_sa_id, args->remote_sa_id);
449 return VNET_API_ERROR_INVALID_VALUE;
451 sa = pool_elt_at_index (im->sad, p[0]);
452 ipsec_sa_set_IS_GRE (sa);
454 /* we form the key from the input/remote SA whose tunnel is srouce
455 * at the remote end */
456 if (ipsec_sa_is_set_IS_TUNNEL (sa))
458 key.remote_ip = sa->tunnel_src_addr.ip4.as_u32;
459 key.spi = clib_host_to_net_u32 (sa->spi);
463 key.remote_ip = args->src.as_u32;
464 key.spi = clib_host_to_net_u32 (sa->spi);
467 p = hash_get (im->ipsec4_if_pool_index_by_key, key.as_u64);
471 /* check if same src/dst pair exists */
473 return VNET_API_ERROR_INVALID_VALUE;
475 pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
476 clib_memset (t, 0, sizeof (*t));
478 t->input_sa_index = isa;
479 t->output_sa_index = osa;
481 hash_set (im->ipsec4_if_pool_index_by_key, key.as_u64,
482 t - im->tunnel_interfaces);
484 /*1st interface, register protocol */
485 if (pool_elts (im->tunnel_interfaces) == 1)
487 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
488 ipsec4_if_input_node.index);
491 ip6_register_protocol (IP_PROTOCOL_IPSEC_ESP,
492 ipsec6_if_input_node.index);
498 /* check if exists */
500 return VNET_API_ERROR_INVALID_VALUE;
502 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
503 hash_unset (im->ipsec4_if_pool_index_by_key, key.as_u64);
504 pool_put (im->tunnel_interfaces, t);
510 ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
511 ipsec_if_set_key_type_t type, u8 alg, u8 * key)
513 vlib_main_t *vm = vlib_get_main ();
514 ipsec_main_t *im = &ipsec_main;
515 vnet_hw_interface_t *hi;
516 ipsec_tunnel_if_t *t;
519 hi = vnet_get_hw_interface (vnm, hw_if_index);
520 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
522 if (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
523 return VNET_API_ERROR_SYSCALL_ERROR_1;
525 if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO)
527 sa = pool_elt_at_index (im->sad, t->output_sa_index);
528 ipsec_sa_set_crypto_alg (sa, alg);
529 ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
530 sa->crypto_calg = im->crypto_algs[alg].alg;
531 vnet_crypto_key_modify (vm, sa->crypto_key_index, sa->crypto_calg,
534 else if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG)
536 sa = pool_elt_at_index (im->sad, t->output_sa_index);
537 ipsec_sa_set_integ_alg (sa, alg);
538 ipsec_mk_key (&sa->integ_key, key, vec_len (key));
539 sa->integ_calg = im->integ_algs[alg].alg;
540 vnet_crypto_key_modify (vm, sa->integ_key_index, sa->integ_calg,
543 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO)
545 sa = pool_elt_at_index (im->sad, t->input_sa_index);
546 ipsec_sa_set_crypto_alg (sa, alg);
547 ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
548 sa->crypto_calg = im->crypto_algs[alg].alg;
549 vnet_crypto_key_modify (vm, sa->crypto_key_index, sa->crypto_calg,
552 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG)
554 sa = pool_elt_at_index (im->sad, t->input_sa_index);
555 ipsec_sa_set_integ_alg (sa, alg);
556 ipsec_mk_key (&sa->integ_key, key, vec_len (key));
557 sa->integ_calg = im->integ_algs[alg].alg;
558 vnet_crypto_key_modify (vm, sa->integ_key_index, sa->integ_calg,
562 return VNET_API_ERROR_INVALID_VALUE;
569 ipsec_set_interface_sa (vnet_main_t * vnm, u32 hw_if_index, u32 sa_id,
572 ipsec_main_t *im = &ipsec_main;
573 vnet_hw_interface_t *hi;
574 ipsec_tunnel_if_t *t;
575 ipsec_sa_t *sa, *old_sa;
576 u32 sa_index, old_sa_index;
579 hi = vnet_get_hw_interface (vnm, hw_if_index);
580 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
582 sa_index = ipsec_get_sa_index_by_sa_id (sa_id);
585 clib_warning ("SA with ID %u not found", sa_id);
586 return VNET_API_ERROR_INVALID_VALUE;
589 if (ipsec_is_sa_used (sa_index))
591 clib_warning ("SA with ID %u is already in use", sa_id);
592 return VNET_API_ERROR_INVALID_VALUE;
595 sa = pool_elt_at_index (im->sad, sa_index);
599 old_sa_index = t->input_sa_index;
600 old_sa = pool_elt_at_index (im->sad, old_sa_index);
602 if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ^
603 ipsec_sa_is_set_IS_TUNNEL_V6 (old_sa))
605 clib_warning ("IPsec interface SA endpoints type can't be changed");
606 return VNET_API_ERROR_INVALID_VALUE;
609 if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa))
611 ipsec6_tunnel_key_t key;
613 /* unset old inbound hash entry. packets should stop arriving */
614 key.remote_ip = old_sa->tunnel_src_addr.ip6;
615 key.spi = clib_host_to_net_u32 (old_sa->spi);
617 p = hash_get_mem (im->ipsec6_if_pool_index_by_key, &key);
619 hash_unset_mem_free (&im->ipsec6_if_pool_index_by_key, &key);
621 /* set new inbound SA, then set new hash entry */
622 t->input_sa_index = sa_index;
623 key.remote_ip = sa->tunnel_src_addr.ip6;
624 key.spi = clib_host_to_net_u32 (sa->spi);
626 hash_set_mem_alloc (&im->ipsec6_if_pool_index_by_key, &key,
631 ipsec4_tunnel_key_t key;
633 /* unset old inbound hash entry. packets should stop arriving */
634 key.remote_ip = old_sa->tunnel_src_addr.ip4.as_u32;
635 key.spi = clib_host_to_net_u32 (old_sa->spi);
637 p = hash_get (im->ipsec4_if_pool_index_by_key, key.as_u64);
639 hash_unset (im->ipsec4_if_pool_index_by_key, key.as_u64);
641 /* set new inbound SA, then set new hash entry */
642 t->input_sa_index = sa_index;
643 key.remote_ip = sa->tunnel_src_addr.ip4.as_u32;
644 key.spi = clib_host_to_net_u32 (sa->spi);
646 hash_set (im->ipsec4_if_pool_index_by_key, key.as_u64,
652 old_sa_index = t->output_sa_index;
653 old_sa = pool_elt_at_index (im->sad, old_sa_index);
655 if (ipsec_sa_is_set_IS_TUNNEL_V6 (sa) ^
656 ipsec_sa_is_set_IS_TUNNEL_V6 (old_sa))
658 clib_warning ("IPsec interface SA endpoints type can't be changed");
659 return VNET_API_ERROR_INVALID_VALUE;
663 * re-enable the feature to get the new SA in
664 * the workers are stopped so no packets are sent in the clear
666 ipsec_tunnel_feature_set (t, 0);
667 t->output_sa_index = sa_index;
668 ipsec_tunnel_feature_set (t, 1);
671 /* remove sa_id to sa_index mapping on old SA */
672 if (ipsec_get_sa_index_by_sa_id (old_sa->id) == old_sa_index)
673 hash_unset (im->sa_index_by_sa_id, old_sa->id);
675 if (ipsec_add_del_sa_sess_cb (im, old_sa_index, 0))
677 clib_warning ("IPsec backend add/del callback returned error");
678 return VNET_API_ERROR_SYSCALL_ERROR_1;
680 ipsec_sa_del (old_sa->id);
687 ipsec_tunnel_if_init (vlib_main_t * vm)
689 ipsec_main_t *im = &ipsec_main;
691 /* initialize the ipsec-if ip4 hash */
692 im->ipsec4_if_pool_index_by_key =
693 hash_create (0, sizeof (ipsec4_tunnel_key_t));
694 /* initialize the ipsec-if ip6 hash */
695 im->ipsec6_if_pool_index_by_key = hash_create_mem (0,
697 (ipsec6_tunnel_key_t),
699 im->ipsec_if_real_dev_by_show_dev = hash_create (0, sizeof (uword));
701 udp_register_dst_port (vm, UDP_DST_PORT_ipsec, ipsec4_if_input_node.index,
706 VLIB_INIT_FUNCTION (ipsec_tunnel_if_init);
710 * fd.io coding-style-patch-verification: ON
713 * eval: (c-set-style "gnu")