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>
24 /* bitmap of Allocated IPSEC_ITF instances */
25 static uword *ipsec_itf_instances;
27 /* pool of interfaces */
28 static ipsec_itf_t *ipsec_itf_pool;
30 static u32 *ipsec_itf_index_by_sw_if_index;
33 ipsec_itf_find_by_sw_if_index (u32 sw_if_index)
35 if (vec_len (ipsec_itf_index_by_sw_if_index) <= sw_if_index)
37 u32 ti = ipsec_itf_index_by_sw_if_index[sw_if_index];
40 return pool_elt_at_index (ipsec_itf_pool, ti);
44 format_ipsec_itf_name (u8 * s, va_list * args)
46 u32 dev_instance = va_arg (*args, u32);
47 return format (s, "ipsec%d", dev_instance);
51 ipsec_itf_adj_unstack (adj_index_t ai)
53 adj_midchain_delegate_unstack (ai);
57 ipsec_itf_adj_stack (adj_index_t ai, u32 sai)
59 const vnet_hw_interface_t *hw;
61 hw = vnet_get_sup_hw_interface (vnet_get_main (), adj_get_sw_if_index (ai));
63 if (hw->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
67 sa = ipsec_sa_get (sai);
70 const fib_prefix_t dst = {
71 .fp_len = (ipsec_sa_is_set_IS_TUNNEL_V6(sa) ? 128 : 32),
72 .fp_proto = (ipsec_sa_is_set_IS_TUNNEL_V6(sa)?
75 .fp_addr = sa->tunnel_dst_addr,
79 adj_midchain_delegate_stack (ai, 0, &dst);
82 adj_midchain_delegate_unstack (ai);
86 ipsec_itf_adj_stack_cb (adj_index_t ai, void *arg)
88 ipsec_tun_protect_t *itp = arg;
90 ipsec_itf_adj_stack (ai, itp->itp_out_sa);
92 return (ADJ_WALK_RC_CONTINUE);
96 ipsec_itf_restack (index_t itpi, const ipsec_itf_t * itf)
98 ipsec_tun_protect_t *itp;
101 itp = ipsec_tun_protect_get (itpi);
104 * walk all the adjacencies on the interface and restack them
106 FOR_EACH_FIB_IP_PROTOCOL (proto)
108 adj_nbr_walk (itf->ii_sw_if_index, proto, ipsec_itf_adj_stack_cb, itp);
113 ipsec_tun_protect_walk_state_change (index_t itpi, void *arg)
115 const ipsec_itf_t *itf = arg;
117 ipsec_itf_restack (itpi, itf);
119 return (WALK_CONTINUE);
122 static clib_error_t *
123 ipsec_itf_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
125 vnet_hw_interface_t *hi;
129 hi = vnet_get_hw_interface (vnm, hw_if_index);
130 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP ?
131 VNET_HW_INTERFACE_FLAG_LINK_UP : 0);
132 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
134 itf = ipsec_itf_find_by_sw_if_index (hi->sw_if_index);
137 ipsec_tun_protect_walk_itf (itf->ii_sw_if_index,
138 ipsec_tun_protect_walk_state_change, itf);
144 ipsec_itf_tunnel_desc (u32 sw_if_index,
145 ip46_address_t * src, ip46_address_t * dst, u8 * is_l2)
147 ip46_address_reset (src);
148 ip46_address_reset (dst);
155 ipsec_itf_build_rewrite (void)
158 * passing the adj code a NULL rewrite means 'i don't have one cos
159 * t'other end is unresolved'. That's not the case here. For the ipsec
160 * tunnel there are just no bytes of encap to apply in the adj.
161 * So return a zero length rewrite. Encap will be added by a tunnel mode SA.
165 vec_validate (rewrite, 0);
166 vec_reset_length (rewrite);
172 ipsec_itf_build_rewrite_i (vnet_main_t * vnm,
174 vnet_link_t link_type, const void *dst_address)
176 return (ipsec_itf_build_rewrite ());
180 ipsec_itf_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
182 adj_nbr_midchain_update_rewrite
183 (ai, NULL, NULL, ADJ_FLAG_MIDCHAIN_IP_STACK, ipsec_itf_build_rewrite ());
187 VNET_DEVICE_CLASS (ipsec_itf_device_class) = {
188 .name = "IPSEC Tunnel",
189 .format_device_name = format_ipsec_itf_name,
190 .admin_up_down_function = ipsec_itf_admin_up_down,
191 .ip_tun_desc = ipsec_itf_tunnel_desc,
194 VNET_HW_INTERFACE_CLASS(ipsec_hw_interface_class) = {
196 .build_rewrite = ipsec_itf_build_rewrite_i,
197 .update_adjacency = ipsec_itf_update_adj,
198 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
203 * Maintain a bitmap of allocated ipsec_itf instance numbers.
205 #define IPSEC_ITF_MAX_INSTANCE (16 * 1024)
208 ipsec_itf_instance_alloc (u32 want)
211 * Check for dynamically allocated instance number.
217 bit = clib_bitmap_first_clear (ipsec_itf_instances);
218 if (bit >= IPSEC_ITF_MAX_INSTANCE)
222 ipsec_itf_instances = clib_bitmap_set (ipsec_itf_instances, bit, 1);
229 if (want >= IPSEC_ITF_MAX_INSTANCE)
237 if (clib_bitmap_get (ipsec_itf_instances, want))
243 * Grant allocation request.
245 ipsec_itf_instances = clib_bitmap_set (ipsec_itf_instances, want, 1);
251 ipsec_itf_instance_free (u32 instance)
253 if (instance >= IPSEC_ITF_MAX_INSTANCE)
258 if (clib_bitmap_get (ipsec_itf_instances, instance) == 0)
263 ipsec_itf_instances = clib_bitmap_set (ipsec_itf_instances, instance, 0);
268 ipsec_itf_create (u32 user_instance, tunnel_mode_t mode, u32 * sw_if_indexp)
270 vnet_main_t *vnm = vnet_get_main ();
271 u32 instance, hw_if_index;
272 vnet_hw_interface_t *hi;
273 ipsec_itf_t *ipsec_itf;
275 ASSERT (sw_if_indexp);
277 *sw_if_indexp = (u32) ~ 0;
279 if (mode != TUNNEL_MODE_P2P)
280 return VNET_API_ERROR_UNSUPPORTED;
283 * Allocate a ipsec_itf instance. Either select on dynamically
284 * or try to use the desired user_instance number.
286 instance = ipsec_itf_instance_alloc (user_instance);
288 return VNET_API_ERROR_INVALID_REGISTRATION;
290 pool_get (ipsec_itf_pool, ipsec_itf);
292 /* tunnel index (or instance) */
293 u32 t_idx = ipsec_itf - ipsec_itf_pool;
295 ipsec_itf->ii_mode = mode;
296 ipsec_itf->ii_user_instance = instance;
297 if (~0 == ipsec_itf->ii_user_instance)
298 ipsec_itf->ii_user_instance = t_idx;
300 hw_if_index = vnet_register_interface (vnm,
301 ipsec_itf_device_class.index,
303 ipsec_hw_interface_class.index,
306 hi = vnet_get_hw_interface (vnm, hw_if_index);
308 vec_validate_init_empty (ipsec_itf_index_by_sw_if_index, hi->sw_if_index,
310 ipsec_itf_index_by_sw_if_index[hi->sw_if_index] = t_idx;
312 ipsec_itf->ii_sw_if_index = *sw_if_indexp = hi->sw_if_index;
318 ipsec_itf_delete (u32 sw_if_index)
320 vnet_main_t *vnm = vnet_get_main ();
322 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
323 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
325 vnet_hw_interface_t *hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
326 if (hw == 0 || hw->dev_class_index != ipsec_itf_device_class.index)
327 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
329 ipsec_itf_t *ipsec_itf;
330 ipsec_itf = ipsec_itf_find_by_sw_if_index (sw_if_index);
331 if (NULL == ipsec_itf)
332 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
334 if (ipsec_itf_instance_free (hw->dev_instance) < 0)
335 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
337 vnet_delete_hw_interface (vnm, hw->hw_if_index);
338 pool_put (ipsec_itf_pool, ipsec_itf);
343 static clib_error_t *
344 ipsec_itf_create_cli (vlib_main_t * vm,
345 unformat_input_t * input, vlib_cli_command_t * cmd)
347 unformat_input_t _line_input, *line_input = &_line_input;
348 u32 instance, sw_if_index;
354 instance = sw_if_index = ~0;
355 mac_address_set_zero (&mac);
357 if (unformat_user (input, unformat_line_input, line_input))
359 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
361 if (unformat (line_input, "instance %d", &instance))
365 error = clib_error_return (0, "unknown input: %U",
366 format_unformat_error, line_input);
371 unformat_free (line_input);
377 rv = ipsec_itf_create (instance, TUNNEL_MODE_P2P, &sw_if_index);
380 return clib_error_return (0, "iPSec interface create failed");
382 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
388 * Create a IPSec interface.
391 * The following two command syntaxes are equivalent:
392 * @cliexcmd{ipsec itf create [instance <instance>]}
393 * Example of how to create a ipsec interface:
394 * @cliexcmd{ipsec itf create}
397 VLIB_CLI_COMMAND (ipsec_itf_create_command, static) = {
398 .path = "ipsec itf create",
399 .short_help = "ipsec itf create [instance <instance>]",
400 .function = ipsec_itf_create_cli,
404 static clib_error_t *
405 ipsec_itf_delete_cli (vlib_main_t * vm,
406 unformat_input_t * input, vlib_cli_command_t * cmd)
412 vnm = vnet_get_main ();
415 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
418 (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
424 if (~0 != sw_if_index)
426 rv = ipsec_itf_delete (sw_if_index);
429 return clib_error_return (0, "ipsec interface delete failed");
432 return clib_error_return (0, "no such interface: %U",
433 format_unformat_error, input);
439 * Delete a IPSEC_ITF interface.
442 * The following two command syntaxes are equivalent:
443 * @cliexcmd{ipsec itf delete <interface>}
444 * Example of how to create a ipsec_itf interface:
445 * @cliexcmd{ipsec itf delete ipsec0}
448 VLIB_CLI_COMMAND (ipsec_itf_delete_command, static) = {
449 .path = "ipsec itf delete",
450 .short_help = "ipsec itf delete <interface>",
451 .function = ipsec_itf_delete_cli,
457 * fd.io coding-style-patch-verification: ON
460 * eval: (c-set-style "gnu")