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;
113 /* 0, tx-node next[0] was added by vlib_node_add_next_with_slot */
116 len0 = vlib_buffer_length_in_chain (vm, b0);
118 if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
125 vlib_increment_combined_counter (vim->combined_sw_if_counters +
126 VNET_INTERFACE_COUNTER_TX,
127 thread_index, sw_if_index0,
129 last_sw_if_index = sw_if_index0;
134 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
136 ipsec_if_tx_trace_t *tr =
137 vlib_add_trace (vm, node, b0, sizeof (*tr));
139 pool_elt_at_index (im->sad, t0->output_sa_index);
144 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
145 n_left_to_next, bi0, next0);
147 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
150 if (last_sw_if_index != ~0)
152 vlib_increment_combined_counter (vim->combined_sw_if_counters +
153 VNET_INTERFACE_COUNTER_TX,
155 last_sw_if_index, n_packets, n_bytes);
158 return from_frame->n_vectors;
162 static clib_error_t *
163 ipsec_admin_up_down_function (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
165 ipsec_main_t *im = &ipsec_main;
166 clib_error_t *err = 0;
167 ipsec_tunnel_if_t *t;
168 vnet_hw_interface_t *hi;
171 hi = vnet_get_hw_interface (vnm, hw_if_index);
172 t = pool_elt_at_index (im->tunnel_interfaces, hi->hw_instance);
174 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
176 sa = pool_elt_at_index (im->sad, t->input_sa_index);
178 err = ipsec_check_support_cb (im, sa);
182 err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 1);
186 sa = pool_elt_at_index (im->sad, t->output_sa_index);
188 err = ipsec_check_support_cb (im, sa);
192 err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 1);
196 vnet_hw_interface_set_flags (vnm, hw_if_index,
197 VNET_HW_INTERFACE_FLAG_LINK_UP);
201 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
202 sa = pool_elt_at_index (im->sad, t->input_sa_index);
203 err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 0);
206 sa = pool_elt_at_index (im->sad, t->output_sa_index);
207 err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 0);
212 return /* no error */ 0;
217 VNET_DEVICE_CLASS (ipsec_device_class, static) =
220 .format_device_name = format_ipsec_name,
221 .format_tx_trace = format_ipsec_if_tx_trace,
222 .tx_function = ipsec_if_tx_node_fn,
223 .tx_function_n_errors = IPSEC_IF_TX_N_ERROR,
224 .tx_function_error_strings = ipsec_if_tx_error_strings,
225 .admin_up_down_function = ipsec_admin_up_down_function,
230 VNET_HW_INTERFACE_CLASS (ipsec_hw_class) =
233 .build_rewrite = default_build_rewrite,
234 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
239 ipsec_add_del_tunnel_if_rpc_callback (ipsec_add_del_tunnel_args_t * a)
241 vnet_main_t *vnm = vnet_get_main ();
242 ASSERT (vlib_get_thread_index () == 0);
244 return ipsec_add_del_tunnel_if_internal (vnm, a, NULL);
248 ipsec_add_del_tunnel_if (ipsec_add_del_tunnel_args_t * args)
250 vl_api_rpc_call_main_thread (ipsec_add_del_tunnel_if_rpc_callback,
251 (u8 *) args, sizeof (*args));
256 ipsec_tun_mk_input_sa_id (u32 ti)
258 return (0x80000000 | ti);
262 ipsec_tun_mk_output_sa_id (u32 ti)
264 return (0xc0000000 | ti);
268 ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
269 ipsec_add_del_tunnel_args_t * args,
272 ipsec_tunnel_if_t *t;
273 ipsec_main_t *im = &ipsec_main;
274 vnet_hw_interface_t *hi = NULL;
275 u32 hw_if_index = ~0;
279 ipsec_key_t crypto_key, integ_key;
280 ipsec_sa_flags_t flags;
283 u64 key = ((u64) args->remote_ip.ip4.as_u32 << 32 |
284 (u64) clib_host_to_net_u32 (args->remote_spi));
285 p = hash_get (im->ipsec_if_pool_index_by_key, key);
289 /* check if same src/dst pair exists */
291 return VNET_API_ERROR_INVALID_VALUE;
293 pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
294 clib_memset (t, 0, sizeof (*t));
296 dev_instance = t - im->tunnel_interfaces;
298 t->show_instance = args->show_instance;
300 t->show_instance = dev_instance;
302 if (hash_get (im->ipsec_if_real_dev_by_show_dev, t->show_instance))
304 pool_put (im->tunnel_interfaces, t);
305 return VNET_API_ERROR_INSTANCE_IN_USE;
308 hash_set (im->ipsec_if_real_dev_by_show_dev, t->show_instance,
311 flags = IPSEC_SA_FLAG_IS_TUNNEL;
313 flags |= IPSEC_SA_FLAG_UDP_ENCAP;
315 flags |= IPSEC_SA_FLAG_USE_EXTENDED_SEQ_NUM;
316 if (args->anti_replay)
317 flags |= IPSEC_SA_FLAG_USE_ANTI_REPLAY;
319 ipsec_mk_key (&crypto_key,
320 args->remote_crypto_key, args->remote_crypto_key_len);
321 ipsec_mk_key (&integ_key,
322 args->remote_integ_key, args->remote_integ_key_len);
324 rv = ipsec_sa_add (ipsec_tun_mk_input_sa_id (dev_instance),
334 &args->local_ip, &t->input_sa_index);
337 return VNET_API_ERROR_UNIMPLEMENTED;
339 ipsec_mk_key (&crypto_key,
340 args->local_crypto_key, args->local_crypto_key_len);
341 ipsec_mk_key (&integ_key,
342 args->local_integ_key, args->local_integ_key_len);
344 rv = ipsec_sa_add (ipsec_tun_mk_output_sa_id (dev_instance),
354 &args->remote_ip, &t->output_sa_index);
357 return VNET_API_ERROR_UNIMPLEMENTED;
359 hash_set (im->ipsec_if_pool_index_by_key, key,
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);
368 /* add esp4 as the next-node-index of this tx-node */
370 slot = vlib_node_add_next_with_slot
371 (vnm->vlib_main, hi->tx_node_index, im->esp4_encrypt_node_index, 0);
375 t->hw_if_index = hw_if_index;
377 vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
378 hi->sw_if_index, 1, 0, 0);
380 /*1st interface, register protocol */
381 if (pool_elts (im->tunnel_interfaces) == 1)
382 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
383 ipsec_if_input_node.index);
388 /* check if exists */
390 return VNET_API_ERROR_INVALID_VALUE;
392 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
393 hi = vnet_get_hw_interface (vnm, t->hw_if_index);
394 vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0); /* admin down */
396 vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
397 hi->sw_if_index, 0, 0, 0);
399 vnet_delete_hw_interface (vnm, t->hw_if_index);
401 hash_unset (im->ipsec_if_pool_index_by_key, key);
402 hash_unset (im->ipsec_if_real_dev_by_show_dev, t->show_instance);
404 pool_put (im->tunnel_interfaces, t);
406 /* delete input and output SA */
407 ipsec_sa_del (ipsec_tun_mk_input_sa_id (p[0]));
408 ipsec_sa_del (ipsec_tun_mk_output_sa_id (p[0]));
412 *sw_if_index = hi->sw_if_index;
418 ipsec_add_del_ipsec_gre_tunnel (vnet_main_t * vnm,
419 ipsec_add_del_ipsec_gre_tunnel_args_t * args)
421 ipsec_tunnel_if_t *t = 0;
422 ipsec_main_t *im = &ipsec_main;
428 p = hash_get (im->sa_index_by_sa_id, args->local_sa_id);
430 return VNET_API_ERROR_INVALID_VALUE;
433 p = hash_get (im->sa_index_by_sa_id, args->remote_sa_id);
435 return VNET_API_ERROR_INVALID_VALUE;
437 sa = pool_elt_at_index (im->sad, p[0]);
440 key = ((u64) sa->tunnel_dst_addr.ip4.as_u32 << 32 |
441 (u64) clib_host_to_net_u32 (sa->spi));
443 key = ((u64) args->remote_ip.as_u32 << 32 |
444 (u64) clib_host_to_net_u32 (sa->spi));
446 p = hash_get (im->ipsec_if_pool_index_by_key, key);
450 /* check if same src/dst pair exists */
452 return VNET_API_ERROR_INVALID_VALUE;
454 pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
455 clib_memset (t, 0, sizeof (*t));
457 t->input_sa_index = isa;
458 t->output_sa_index = osa;
460 hash_set (im->ipsec_if_pool_index_by_key, key,
461 t - im->tunnel_interfaces);
463 /*1st interface, register protocol */
464 if (pool_elts (im->tunnel_interfaces) == 1)
465 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
466 ipsec_if_input_node.index);
470 /* check if exists */
472 return VNET_API_ERROR_INVALID_VALUE;
474 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
475 hash_unset (im->ipsec_if_pool_index_by_key, key);
476 pool_put (im->tunnel_interfaces, t);
482 ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
483 ipsec_if_set_key_type_t type, u8 alg, u8 * key)
485 ipsec_main_t *im = &ipsec_main;
486 vnet_hw_interface_t *hi;
487 ipsec_tunnel_if_t *t;
490 hi = vnet_get_hw_interface (vnm, hw_if_index);
491 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
493 if (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
494 return VNET_API_ERROR_SYSCALL_ERROR_1;
496 if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO)
498 sa = pool_elt_at_index (im->sad, t->output_sa_index);
499 sa->crypto_alg = alg;
500 ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
502 else if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG)
504 sa = pool_elt_at_index (im->sad, t->output_sa_index);
506 ipsec_mk_key (&sa->integ_key, key, vec_len (key));
508 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO)
510 sa = pool_elt_at_index (im->sad, t->input_sa_index);
511 sa->crypto_alg = alg;
512 ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
514 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG)
516 sa = pool_elt_at_index (im->sad, t->input_sa_index);
518 ipsec_mk_key (&sa->integ_key, key, vec_len (key));
521 return VNET_API_ERROR_INVALID_VALUE;
528 ipsec_set_interface_sa (vnet_main_t * vnm, u32 hw_if_index, u32 sa_id,
531 ipsec_main_t *im = &ipsec_main;
532 vnet_hw_interface_t *hi;
533 ipsec_tunnel_if_t *t;
534 ipsec_sa_t *sa, *old_sa;
535 u32 sa_index, old_sa_index;
538 hi = vnet_get_hw_interface (vnm, hw_if_index);
539 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
541 sa_index = ipsec_get_sa_index_by_sa_id (sa_id);
544 clib_warning ("SA with ID %u not found", sa_id);
545 return VNET_API_ERROR_INVALID_VALUE;
548 if (ipsec_is_sa_used (sa_index))
550 clib_warning ("SA with ID %u is already in use", sa_id);
551 return VNET_API_ERROR_INVALID_VALUE;
554 sa = pool_elt_at_index (im->sad, sa_index);
555 if (sa->is_tunnel_ip6)
557 clib_warning ("IPsec interface not supported with IPv6 endpoints");
558 return VNET_API_ERROR_UNIMPLEMENTED;
565 old_sa_index = t->input_sa_index;
566 old_sa = pool_elt_at_index (im->sad, old_sa_index);
568 /* unset old inbound hash entry. packets should stop arriving */
569 key = ((u64) old_sa->tunnel_src_addr.ip4.as_u32 << 32 |
570 (u64) clib_host_to_net_u32 (old_sa->spi));
571 p = hash_get (im->ipsec_if_pool_index_by_key, key);
573 hash_unset (im->ipsec_if_pool_index_by_key, key);
575 /* set new inbound SA, then set new hash entry */
576 t->input_sa_index = sa_index;
577 key = ((u64) sa->tunnel_src_addr.ip4.as_u32 << 32 |
578 (u64) clib_host_to_net_u32 (sa->spi));
579 hash_set (im->ipsec_if_pool_index_by_key, key, hi->dev_instance);
583 old_sa_index = t->output_sa_index;
584 old_sa = pool_elt_at_index (im->sad, old_sa_index);
585 t->output_sa_index = sa_index;
588 /* remove sa_id to sa_index mapping on old SA */
589 if (ipsec_get_sa_index_by_sa_id (old_sa->id) == old_sa_index)
590 hash_unset (im->sa_index_by_sa_id, old_sa->id);
592 if (ipsec_add_del_sa_sess_cb (im, old_sa_index, 0))
594 clib_warning ("IPsec backend add/del callback returned error");
595 return VNET_API_ERROR_SYSCALL_ERROR_1;
597 pool_put (im->sad, old_sa);
604 ipsec_tunnel_if_init (vlib_main_t * vm)
606 ipsec_main_t *im = &ipsec_main;
608 im->ipsec_if_pool_index_by_key = hash_create (0, sizeof (uword));
609 im->ipsec_if_real_dev_by_show_dev = hash_create (0, sizeof (uword));
614 VLIB_INIT_FUNCTION (ipsec_tunnel_if_init);
618 * fd.io coding-style-patch-verification: ON
621 * eval: (c-set-style "gnu")