2 * ipsec_itf.c: IPSec dedicated interface type
4 * Copyright (c) 2020 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/ip/ip.h>
19 #include <vnet/ipsec/ipsec_itf.h>
20 #include <vnet/ipsec/ipsec_tun.h>
21 #include <vnet/ipsec/ipsec.h>
22 #include <vnet/adj/adj_midchain.h>
23 #include <vnet/ethernet/mac_address.h>
25 /* bitmap of Allocated IPSEC_ITF instances */
26 static uword *ipsec_itf_instances;
28 /* pool of interfaces */
29 static ipsec_itf_t *ipsec_itf_pool;
31 static u32 *ipsec_itf_index_by_sw_if_index;
34 ipsec_itf_get (index_t ii)
36 return (pool_elt_at_index (ipsec_itf_pool, ii));
40 ipsec_itf_find_by_sw_if_index (u32 sw_if_index)
42 if (vec_len (ipsec_itf_index_by_sw_if_index) <= sw_if_index)
44 u32 ti = ipsec_itf_index_by_sw_if_index[sw_if_index];
47 return pool_elt_at_index (ipsec_itf_pool, ti);
51 format_ipsec_itf_name (u8 * s, va_list * args)
53 u32 dev_instance = va_arg (*args, u32);
54 return format (s, "ipsec%d", dev_instance);
58 ipsec_itf_adj_unstack (adj_index_t ai)
60 adj_midchain_delegate_unstack (ai);
64 ipsec_itf_adj_stack (adj_index_t ai, u32 sai)
66 const vnet_hw_interface_t *hw;
68 hw = vnet_get_sup_hw_interface (vnet_get_main (), adj_get_sw_if_index (ai));
70 if (hw->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
74 sa = ipsec_sa_get (sai);
77 const fib_prefix_t dst = {
78 .fp_len = (ipsec_sa_is_set_IS_TUNNEL_V6(sa) ? 128 : 32),
79 .fp_proto = (ipsec_sa_is_set_IS_TUNNEL_V6(sa)?
82 .fp_addr = sa->tunnel_dst_addr,
86 adj_midchain_delegate_stack (ai, sa->tx_fib_index, &dst);
89 adj_midchain_delegate_unstack (ai);
93 ipsec_itf_adj_stack_cb (adj_index_t ai, void *arg)
95 ipsec_tun_protect_t *itp = arg;
97 ipsec_itf_adj_stack (ai, itp->itp_out_sa);
99 return (ADJ_WALK_RC_CONTINUE);
103 ipsec_itf_restack (index_t itpi, const ipsec_itf_t * itf)
105 ipsec_tun_protect_t *itp;
106 fib_protocol_t proto;
108 itp = ipsec_tun_protect_get (itpi);
111 * walk all the adjacencies on the interface and restack them
113 FOR_EACH_FIB_IP_PROTOCOL (proto)
115 adj_nbr_walk (itf->ii_sw_if_index, proto, ipsec_itf_adj_stack_cb, itp);
120 ipsec_tun_protect_walk_state_change (index_t itpi, void *arg)
122 const ipsec_itf_t *itf = arg;
124 ipsec_itf_restack (itpi, itf);
126 return (WALK_CONTINUE);
129 static clib_error_t *
130 ipsec_itf_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
132 vnet_hw_interface_t *hi;
136 hi = vnet_get_hw_interface (vnm, hw_if_index);
137 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP ?
138 VNET_HW_INTERFACE_FLAG_LINK_UP : 0);
139 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
141 itf = ipsec_itf_find_by_sw_if_index (hi->sw_if_index);
144 ipsec_tun_protect_walk_itf (itf->ii_sw_if_index,
145 ipsec_tun_protect_walk_state_change, itf);
151 ipsec_itf_tunnel_desc (u32 sw_if_index,
152 ip46_address_t * src, ip46_address_t * dst, u8 * is_l2)
154 ip46_address_reset (src);
155 ip46_address_reset (dst);
162 ipsec_itf_build_rewrite (void)
165 * passing the adj code a NULL rewrite means 'i don't have one cos
166 * t'other end is unresolved'. That's not the case here. For the ipsec
167 * tunnel there are just no bytes of encap to apply in the adj.
168 * So return a zero length rewrite. Encap will be added by a tunnel mode SA.
172 vec_validate (rewrite, 0);
173 vec_reset_length (rewrite);
179 ipsec_itf_build_rewrite_i (vnet_main_t * vnm,
181 vnet_link_t link_type, const void *dst_address)
183 return (ipsec_itf_build_rewrite ());
187 ipsec_itf_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
189 adj_nbr_midchain_update_rewrite
190 (ai, NULL, NULL, ADJ_FLAG_MIDCHAIN_IP_STACK, ipsec_itf_build_rewrite ());
194 VNET_DEVICE_CLASS (ipsec_itf_device_class) = {
195 .name = "IPSEC Tunnel",
196 .format_device_name = format_ipsec_itf_name,
197 .admin_up_down_function = ipsec_itf_admin_up_down,
198 .ip_tun_desc = ipsec_itf_tunnel_desc,
201 VNET_HW_INTERFACE_CLASS(ipsec_hw_interface_class) = {
203 .build_rewrite = ipsec_itf_build_rewrite_i,
204 .update_adjacency = ipsec_itf_update_adj,
205 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
207 VNET_HW_INTERFACE_CLASS(ipsec_p2mp_hw_interface_class) = {
209 .build_rewrite = ipsec_itf_build_rewrite_i,
210 .update_adjacency = ipsec_itf_update_adj,
211 .flags = VNET_HW_INTERFACE_CLASS_FLAG_NBMA,
216 * Maintain a bitmap of allocated ipsec_itf instance numbers.
218 #define IPSEC_ITF_MAX_INSTANCE (16 * 1024)
221 ipsec_itf_instance_alloc (u32 want)
224 * Check for dynamically allocated instance number.
230 bit = clib_bitmap_first_clear (ipsec_itf_instances);
231 if (bit >= IPSEC_ITF_MAX_INSTANCE)
235 ipsec_itf_instances = clib_bitmap_set (ipsec_itf_instances, bit, 1);
242 if (want >= IPSEC_ITF_MAX_INSTANCE)
250 if (clib_bitmap_get (ipsec_itf_instances, want))
256 * Grant allocation request.
258 ipsec_itf_instances = clib_bitmap_set (ipsec_itf_instances, want, 1);
264 ipsec_itf_instance_free (u32 instance)
266 if (instance >= IPSEC_ITF_MAX_INSTANCE)
271 if (clib_bitmap_get (ipsec_itf_instances, instance) == 0)
276 ipsec_itf_instances = clib_bitmap_set (ipsec_itf_instances, instance, 0);
281 ipsec_itf_create (u32 user_instance, tunnel_mode_t mode, u32 * sw_if_indexp)
283 vnet_main_t *vnm = vnet_get_main ();
284 u32 instance, hw_if_index;
285 vnet_hw_interface_t *hi;
286 ipsec_itf_t *ipsec_itf;
288 ASSERT (sw_if_indexp);
290 *sw_if_indexp = (u32) ~ 0;
293 * Allocate a ipsec_itf instance. Either select on dynamically
294 * or try to use the desired user_instance number.
296 instance = ipsec_itf_instance_alloc (user_instance);
298 return VNET_API_ERROR_INVALID_REGISTRATION;
300 pool_get (ipsec_itf_pool, ipsec_itf);
302 /* tunnel index (or instance) */
303 u32 t_idx = ipsec_itf - ipsec_itf_pool;
305 ipsec_itf->ii_mode = mode;
306 ipsec_itf->ii_user_instance = instance;
308 hw_if_index = vnet_register_interface (vnm,
309 ipsec_itf_device_class.index,
310 ipsec_itf->ii_user_instance,
311 (mode == TUNNEL_MODE_P2P ?
312 ipsec_hw_interface_class.index :
313 ipsec_p2mp_hw_interface_class.index),
316 hi = vnet_get_hw_interface (vnm, hw_if_index);
318 vec_validate_init_empty (ipsec_itf_index_by_sw_if_index, hi->sw_if_index,
320 ipsec_itf_index_by_sw_if_index[hi->sw_if_index] = t_idx;
322 ipsec_itf->ii_sw_if_index = *sw_if_indexp = hi->sw_if_index;
328 ipsec_itf_delete (u32 sw_if_index)
330 vnet_main_t *vnm = vnet_get_main ();
332 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
333 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
335 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
336 if (hw == 0 || hw->dev_class_index != ipsec_itf_device_class.index)
337 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
339 ipsec_itf_t *ipsec_itf;
340 ipsec_itf = ipsec_itf_find_by_sw_if_index (sw_if_index);
341 if (NULL == ipsec_itf)
342 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
344 if (ipsec_itf_instance_free (hw->dev_instance) < 0)
345 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
347 vnet_delete_hw_interface (vnm, hw->hw_if_index);
348 pool_put (ipsec_itf_pool, ipsec_itf);
353 static clib_error_t *
354 ipsec_itf_create_cli (vlib_main_t * vm,
355 unformat_input_t * input, vlib_cli_command_t * cmd)
357 unformat_input_t _line_input, *line_input = &_line_input;
358 u32 instance, sw_if_index;
364 instance = sw_if_index = ~0;
365 mac_address_set_zero (&mac);
367 if (unformat_user (input, unformat_line_input, line_input))
369 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
371 if (unformat (line_input, "instance %d", &instance))
375 error = clib_error_return (0, "unknown input: %U",
376 format_unformat_error, line_input);
381 unformat_free (line_input);
387 rv = ipsec_itf_create (instance, TUNNEL_MODE_P2P, &sw_if_index);
390 return clib_error_return (0, "iPSec interface create failed");
392 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
398 * Create a IPSec interface.
401 * The following two command syntaxes are equivalent:
402 * @cliexcmd{ipsec itf create [instance <instance>]}
403 * Example of how to create a ipsec interface:
404 * @cliexcmd{ipsec itf create}
407 VLIB_CLI_COMMAND (ipsec_itf_create_command, static) = {
408 .path = "ipsec itf create",
409 .short_help = "ipsec itf create [instance <instance>]",
410 .function = ipsec_itf_create_cli,
414 static clib_error_t *
415 ipsec_itf_delete_cli (vlib_main_t * vm,
416 unformat_input_t * input, vlib_cli_command_t * cmd)
422 vnm = vnet_get_main ();
425 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
428 (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
434 if (~0 != sw_if_index)
436 rv = ipsec_itf_delete (sw_if_index);
439 return clib_error_return (0, "ipsec interface delete failed");
442 return clib_error_return (0, "no such interface: %U",
443 format_unformat_error, input);
449 * Delete a IPSEC_ITF interface.
452 * The following two command syntaxes are equivalent:
453 * @cliexcmd{ipsec itf delete <interface>}
454 * Example of how to create a ipsec_itf interface:
455 * @cliexcmd{ipsec itf delete ipsec0}
458 VLIB_CLI_COMMAND (ipsec_itf_delete_command, static) = {
459 .path = "ipsec itf delete",
460 .short_help = "ipsec itf delete <interface>",
461 .function = ipsec_itf_delete_cli,
465 static clib_error_t *
466 ipsec_interface_show (vlib_main_t * vm,
467 unformat_input_t * input, vlib_cli_command_t * cmd)
472 pool_foreach_index (ii, ipsec_itf_pool,
474 vlib_cli_output (vm, "%U", format_ipsec_itf, ii);
482 * show IPSEC tunnel protection hash tables
485 VLIB_CLI_COMMAND (ipsec_interface_show_node, static) =
487 .path = "show ipsec interface",
488 .function = ipsec_interface_show,
489 .short_help = "show ipsec interface",
494 * fd.io coding-style-patch-verification: ON
497 * eval: (c-set-style "gnu")