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>
23 #include <vnet/ipsec/ipsec.h>
24 #include <vnet/ipsec/esp.h>
26 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
29 format_ipsec_name (u8 * s, va_list * args)
31 u32 dev_instance = va_arg (*args, u32);
32 ipsec_main_t *im = &ipsec_main;
33 ipsec_tunnel_if_t *t = im->tunnel_interfaces + dev_instance;
35 return format (s, "ipsec%d", t->show_instance);
38 /* Statistics (not really errors) */
39 #define foreach_ipsec_if_tx_error \
40 _(TX, "good packets transmitted")
42 static char *ipsec_if_tx_error_strings[] = {
43 #define _(sym,string) string,
44 foreach_ipsec_if_tx_error
50 #define _(sym,str) IPSEC_IF_OUTPUT_ERROR_##sym,
51 foreach_ipsec_if_tx_error
54 } ipsec_if_tx_error_t;
60 } ipsec_if_tx_trace_t;
63 format_ipsec_if_tx_trace (u8 * s, va_list * args)
65 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
66 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
67 ipsec_if_tx_trace_t *t = va_arg (*args, ipsec_if_tx_trace_t *);
69 s = format (s, "IPSec: spi %u seq %u", t->spi, t->seq);
74 ipsec_if_tx_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
75 vlib_frame_t * from_frame)
77 ipsec_main_t *im = &ipsec_main;
78 vnet_main_t *vnm = im->vnet_main;
79 vnet_interface_main_t *vim = &vnm->interface_main;
80 u32 *from, *to_next = 0, next_index;
81 u32 n_left_from, sw_if_index0, last_sw_if_index = ~0;
82 u32 thread_index = vm->thread_index;
83 u32 n_bytes = 0, n_packets = 0;
85 from = vlib_frame_vector_args (from_frame);
86 n_left_from = from_frame->n_vectors;
87 next_index = node->cached_next_index;
89 while (n_left_from > 0)
93 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
95 while (n_left_from > 0 && n_left_to_next > 0)
99 ipsec_tunnel_if_t *t0;
100 vnet_hw_interface_t *hi0;
102 bi0 = to_next[0] = from[0];
107 b0 = vlib_get_buffer (vm, bi0);
108 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
109 hi0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
110 t0 = pool_elt_at_index (im->tunnel_interfaces, hi0->dev_instance);
111 vnet_buffer (b0)->ipsec.sad_index = t0->output_sa_index;
112 next0 = IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT;
114 len0 = vlib_buffer_length_in_chain (vm, b0);
116 if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
123 vlib_increment_combined_counter (vim->combined_sw_if_counters +
124 VNET_INTERFACE_COUNTER_TX,
125 thread_index, sw_if_index0,
127 last_sw_if_index = sw_if_index0;
132 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
134 ipsec_if_tx_trace_t *tr =
135 vlib_add_trace (vm, node, b0, sizeof (*tr));
137 pool_elt_at_index (im->sad, t0->output_sa_index);
142 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
143 n_left_to_next, bi0, next0);
145 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
148 if (last_sw_if_index != ~0)
150 vlib_increment_combined_counter (vim->combined_sw_if_counters +
151 VNET_INTERFACE_COUNTER_TX,
153 last_sw_if_index, n_packets, n_bytes);
156 return from_frame->n_vectors;
160 static clib_error_t *
161 ipsec_admin_up_down_function (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
163 ipsec_main_t *im = &ipsec_main;
164 clib_error_t *err = 0;
165 ipsec_tunnel_if_t *t;
166 vnet_hw_interface_t *hi;
169 hi = vnet_get_hw_interface (vnm, hw_if_index);
170 t = pool_elt_at_index (im->tunnel_interfaces, hi->hw_instance);
172 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
174 sa = pool_elt_at_index (im->sad, t->input_sa_index);
176 err = ipsec_check_support_cb (im, sa);
180 err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 1);
184 sa = pool_elt_at_index (im->sad, t->output_sa_index);
186 err = ipsec_check_support_cb (im, sa);
190 err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 1);
194 vnet_hw_interface_set_flags (vnm, hw_if_index,
195 VNET_HW_INTERFACE_FLAG_LINK_UP);
199 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
200 sa = pool_elt_at_index (im->sad, t->input_sa_index);
201 err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 0);
204 sa = pool_elt_at_index (im->sad, t->output_sa_index);
205 err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 0);
210 return /* no error */ 0;
215 VNET_DEVICE_CLASS (ipsec_device_class, static) =
218 .format_device_name = format_ipsec_name,
219 .format_tx_trace = format_ipsec_if_tx_trace,
220 .tx_function = ipsec_if_tx_node_fn,
221 .tx_function_n_errors = IPSEC_IF_TX_N_ERROR,
222 .tx_function_error_strings = ipsec_if_tx_error_strings,
223 .admin_up_down_function = ipsec_admin_up_down_function,
228 VNET_HW_INTERFACE_CLASS (ipsec_hw_class) =
231 .build_rewrite = default_build_rewrite,
232 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
237 ipsec_add_del_tunnel_if_rpc_callback (ipsec_add_del_tunnel_args_t * a)
239 vnet_main_t *vnm = vnet_get_main ();
240 ASSERT (vlib_get_thread_index () == 0);
242 return ipsec_add_del_tunnel_if_internal (vnm, a, NULL);
246 ipsec_add_del_tunnel_if (ipsec_add_del_tunnel_args_t * args)
248 vl_api_rpc_call_main_thread (ipsec_add_del_tunnel_if_rpc_callback,
249 (u8 *) args, sizeof (*args));
254 ipsec_tun_mk_input_sa_id (u32 ti)
256 return (0x80000000 | ti);
260 ipsec_tun_mk_output_sa_id (u32 ti)
262 return (0xc0000000 | ti);
266 ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
267 ipsec_add_del_tunnel_args_t * args,
270 ipsec_tunnel_if_t *t;
271 ipsec_main_t *im = &ipsec_main;
272 vnet_hw_interface_t *hi = NULL;
273 u32 hw_if_index = ~0;
277 ipsec_key_t crypto_key, integ_key;
278 ipsec_sa_flags_t flags;
281 u64 key = (u64) args->remote_ip.ip4.as_u32 << 32 | (u64) args->remote_spi;
282 p = hash_get (im->ipsec_if_pool_index_by_key, key);
286 /* check if same src/dst pair exists */
288 return VNET_API_ERROR_INVALID_VALUE;
290 pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
291 clib_memset (t, 0, sizeof (*t));
293 dev_instance = t - im->tunnel_interfaces;
295 t->show_instance = args->show_instance;
297 t->show_instance = dev_instance;
299 if (hash_get (im->ipsec_if_real_dev_by_show_dev, t->show_instance))
301 pool_put (im->tunnel_interfaces, t);
302 return VNET_API_ERROR_INSTANCE_IN_USE;
305 hash_set (im->ipsec_if_real_dev_by_show_dev, t->show_instance,
308 flags = IPSEC_SA_FLAG_IS_TUNNEL;
310 flags |= IPSEC_SA_FLAG_UDP_ENCAP;
312 flags |= IPSEC_SA_FLAG_USE_EXTENDED_SEQ_NUM;
313 if (args->anti_replay)
314 flags |= IPSEC_SA_FLAG_USE_ANTI_REPLAY;
316 ipsec_mk_key (&crypto_key,
317 args->remote_crypto_key, args->remote_crypto_key_len);
318 ipsec_mk_key (&integ_key,
319 args->remote_integ_key, args->remote_integ_key_len);
321 rv = ipsec_sa_add (ipsec_tun_mk_input_sa_id (dev_instance),
331 &args->local_ip, &t->input_sa_index);
334 return VNET_API_ERROR_UNIMPLEMENTED;
336 ipsec_mk_key (&crypto_key,
337 args->local_crypto_key, args->local_crypto_key_len);
338 ipsec_mk_key (&integ_key,
339 args->local_integ_key, args->local_integ_key_len);
341 rv = ipsec_sa_add (ipsec_tun_mk_output_sa_id (dev_instance),
351 &args->remote_ip, &t->output_sa_index);
354 return VNET_API_ERROR_UNIMPLEMENTED;
356 hash_set (im->ipsec_if_pool_index_by_key, key,
357 t - im->tunnel_interfaces);
359 hw_if_index = vnet_register_interface (vnm, ipsec_device_class.index,
360 t - im->tunnel_interfaces,
361 ipsec_hw_class.index,
362 t - im->tunnel_interfaces);
364 hi = vnet_get_hw_interface (vnm, hw_if_index);
366 slot = vlib_node_add_next_with_slot
367 (vnm->vlib_main, hi->tx_node_index, im->esp4_encrypt_node_index,
368 IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT);
370 ASSERT (slot == IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT);
372 t->hw_if_index = hw_if_index;
374 vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
375 hi->sw_if_index, 1, 0, 0);
377 /*1st interface, register protocol */
378 if (pool_elts (im->tunnel_interfaces) == 1)
379 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
380 ipsec_if_input_node.index);
385 /* check if exists */
387 return VNET_API_ERROR_INVALID_VALUE;
389 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
390 hi = vnet_get_hw_interface (vnm, t->hw_if_index);
391 vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0); /* admin down */
393 vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
394 hi->sw_if_index, 0, 0, 0);
396 vnet_delete_hw_interface (vnm, t->hw_if_index);
398 hash_unset (im->ipsec_if_pool_index_by_key, key);
399 hash_unset (im->ipsec_if_real_dev_by_show_dev, t->show_instance);
401 pool_put (im->tunnel_interfaces, t);
403 /* delete input and output SA */
404 ipsec_sa_del (ipsec_tun_mk_input_sa_id (p[0]));
405 ipsec_sa_del (ipsec_tun_mk_output_sa_id (p[0]));
409 *sw_if_index = hi->sw_if_index;
415 ipsec_add_del_ipsec_gre_tunnel (vnet_main_t * vnm,
416 ipsec_add_del_ipsec_gre_tunnel_args_t * args)
418 ipsec_tunnel_if_t *t = 0;
419 ipsec_main_t *im = &ipsec_main;
425 p = hash_get (im->sa_index_by_sa_id, args->local_sa_id);
427 return VNET_API_ERROR_INVALID_VALUE;
430 p = hash_get (im->sa_index_by_sa_id, args->remote_sa_id);
432 return VNET_API_ERROR_INVALID_VALUE;
434 sa = pool_elt_at_index (im->sad, p[0]);
437 key = (u64) sa->tunnel_dst_addr.ip4.as_u32 << 32 | (u64) sa->spi;
439 key = (u64) args->remote_ip.as_u32 << 32 | (u64) sa->spi;
441 p = hash_get (im->ipsec_if_pool_index_by_key, key);
445 /* check if same src/dst pair exists */
447 return VNET_API_ERROR_INVALID_VALUE;
449 pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
450 clib_memset (t, 0, sizeof (*t));
452 t->input_sa_index = isa;
453 t->output_sa_index = osa;
455 hash_set (im->ipsec_if_pool_index_by_key, key,
456 t - im->tunnel_interfaces);
458 /*1st interface, register protocol */
459 if (pool_elts (im->tunnel_interfaces) == 1)
460 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
461 ipsec_if_input_node.index);
465 /* check if exists */
467 return VNET_API_ERROR_INVALID_VALUE;
469 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
470 hash_unset (im->ipsec_if_pool_index_by_key, key);
471 pool_put (im->tunnel_interfaces, t);
477 ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
478 ipsec_if_set_key_type_t type, u8 alg, u8 * key)
480 ipsec_main_t *im = &ipsec_main;
481 vnet_hw_interface_t *hi;
482 ipsec_tunnel_if_t *t;
485 hi = vnet_get_hw_interface (vnm, hw_if_index);
486 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
488 if (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
489 return VNET_API_ERROR_SYSCALL_ERROR_1;
491 if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO)
493 sa = pool_elt_at_index (im->sad, t->output_sa_index);
494 sa->crypto_alg = alg;
495 ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
497 else if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG)
499 sa = pool_elt_at_index (im->sad, t->output_sa_index);
501 ipsec_mk_key (&sa->integ_key, key, vec_len (key));
503 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO)
505 sa = pool_elt_at_index (im->sad, t->input_sa_index);
506 sa->crypto_alg = alg;
507 ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
509 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG)
511 sa = pool_elt_at_index (im->sad, t->input_sa_index);
513 ipsec_mk_key (&sa->integ_key, key, vec_len (key));
516 return VNET_API_ERROR_INVALID_VALUE;
523 ipsec_set_interface_sa (vnet_main_t * vnm, u32 hw_if_index, u32 sa_id,
526 ipsec_main_t *im = &ipsec_main;
527 vnet_hw_interface_t *hi;
528 ipsec_tunnel_if_t *t;
529 ipsec_sa_t *sa, *old_sa;
530 u32 sa_index, old_sa_index;
533 hi = vnet_get_hw_interface (vnm, hw_if_index);
534 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
536 sa_index = ipsec_get_sa_index_by_sa_id (sa_id);
539 clib_warning ("SA with ID %u not found", sa_id);
540 return VNET_API_ERROR_INVALID_VALUE;
543 if (ipsec_is_sa_used (sa_index))
545 clib_warning ("SA with ID %u is already in use", sa_id);
546 return VNET_API_ERROR_INVALID_VALUE;
549 sa = pool_elt_at_index (im->sad, sa_index);
550 if (sa->is_tunnel_ip6)
552 clib_warning ("IPsec interface not supported with IPv6 endpoints");
553 return VNET_API_ERROR_UNIMPLEMENTED;
560 old_sa_index = t->input_sa_index;
561 old_sa = pool_elt_at_index (im->sad, old_sa_index);
563 /* unset old inbound hash entry. packets should stop arriving */
565 (u64) old_sa->tunnel_src_addr.ip4.as_u32 << 32 | (u64) old_sa->spi;
566 p = hash_get (im->ipsec_if_pool_index_by_key, key);
568 hash_unset (im->ipsec_if_pool_index_by_key, key);
570 /* set new inbound SA, then set new hash entry */
571 t->input_sa_index = sa_index;
572 key = (u64) sa->tunnel_src_addr.ip4.as_u32 << 32 | (u64) sa->spi;
573 hash_set (im->ipsec_if_pool_index_by_key, key, hi->dev_instance);
577 old_sa_index = t->output_sa_index;
578 old_sa = pool_elt_at_index (im->sad, old_sa_index);
579 t->output_sa_index = sa_index;
582 /* remove sa_id to sa_index mapping on old SA */
583 if (ipsec_get_sa_index_by_sa_id (old_sa->id) == old_sa_index)
584 hash_unset (im->sa_index_by_sa_id, old_sa->id);
586 if (ipsec_add_del_sa_sess_cb (im, old_sa_index, 0))
588 clib_warning ("IPsec backend add/del callback returned error");
589 return VNET_API_ERROR_SYSCALL_ERROR_1;
591 pool_put (im->sad, old_sa);
598 ipsec_tunnel_if_init (vlib_main_t * vm)
600 ipsec_main_t *im = &ipsec_main;
602 im->ipsec_if_pool_index_by_key = hash_create (0, sizeof (uword));
603 im->ipsec_if_real_dev_by_show_dev = hash_create (0, sizeof (uword));
608 VLIB_INIT_FUNCTION (ipsec_tunnel_if_init);
612 * fd.io coding-style-patch-verification: ON
615 * eval: (c-set-style "gnu")