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);
73 always_inline ipsec_tunnel_if_t *
74 ipsec_tun_get_by_sw_if_index (u32 sw_if_index)
76 ipsec_main_t *im = &ipsec_main;
79 ti = im->ipsec_if_by_sw_if_index[sw_if_index];
81 return (pool_elt_at_index (im->tunnel_interfaces, ti));
85 ipsec_if_tx_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
86 vlib_frame_t * from_frame)
88 ipsec_main_t *im = &ipsec_main;
89 vnet_main_t *vnm = im->vnet_main;
90 vnet_interface_main_t *vim = &vnm->interface_main;
91 u32 *from, *to_next = 0, next_index;
92 u32 n_left_from, sw_if_index0, last_sw_if_index = ~0;
93 u32 thread_index = vm->thread_index;
94 u32 n_bytes = 0, n_packets = 0;
96 from = vlib_frame_vector_args (from_frame);
97 n_left_from = from_frame->n_vectors;
98 next_index = node->cached_next_index;
100 while (n_left_from > 0)
104 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
106 while (n_left_from > 0 && n_left_to_next > 0)
108 const ipsec_tunnel_if_t *t0;
109 u32 bi0, next0, len0;
112 bi0 = to_next[0] = from[0];
117 b0 = vlib_get_buffer (vm, bi0);
118 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
119 t0 = ipsec_tun_get_by_sw_if_index (sw_if_index0);
120 vnet_buffer (b0)->ipsec.sad_index = t0->output_sa_index;
122 /* 0, tx-node next[0] was added by vlib_node_add_next_with_slot */
125 len0 = vlib_buffer_length_in_chain (vm, b0);
127 if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
134 vlib_increment_combined_counter (vim->combined_sw_if_counters +
135 VNET_INTERFACE_COUNTER_TX,
136 thread_index, sw_if_index0,
138 last_sw_if_index = sw_if_index0;
143 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
145 ipsec_if_tx_trace_t *tr =
146 vlib_add_trace (vm, node, b0, sizeof (*tr));
148 pool_elt_at_index (im->sad, t0->output_sa_index);
153 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
154 n_left_to_next, bi0, next0);
156 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
159 if (last_sw_if_index != ~0)
161 vlib_increment_combined_counter (vim->combined_sw_if_counters +
162 VNET_INTERFACE_COUNTER_TX,
164 last_sw_if_index, n_packets, n_bytes);
167 return from_frame->n_vectors;
171 static clib_error_t *
172 ipsec_admin_up_down_function (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
174 ipsec_main_t *im = &ipsec_main;
175 clib_error_t *err = 0;
176 ipsec_tunnel_if_t *t;
177 vnet_hw_interface_t *hi;
180 hi = vnet_get_hw_interface (vnm, hw_if_index);
181 t = pool_elt_at_index (im->tunnel_interfaces, hi->hw_instance);
184 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
186 sa = pool_elt_at_index (im->sad, t->input_sa_index);
188 err = ipsec_check_support_cb (im, sa);
192 err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 1);
196 sa = pool_elt_at_index (im->sad, t->output_sa_index);
198 err = ipsec_check_support_cb (im, sa);
202 err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 1);
206 vnet_hw_interface_set_flags (vnm, hw_if_index,
207 VNET_HW_INTERFACE_FLAG_LINK_UP);
211 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
212 sa = pool_elt_at_index (im->sad, t->input_sa_index);
213 err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 0);
216 sa = pool_elt_at_index (im->sad, t->output_sa_index);
217 err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 0);
222 return /* no error */ 0;
227 VNET_DEVICE_CLASS (ipsec_device_class, static) =
230 .format_device_name = format_ipsec_name,
231 .format_tx_trace = format_ipsec_if_tx_trace,
232 .tx_function = ipsec_if_tx_node_fn,
233 .tx_function_n_errors = IPSEC_IF_TX_N_ERROR,
234 .tx_function_error_strings = ipsec_if_tx_error_strings,
235 .admin_up_down_function = ipsec_admin_up_down_function,
240 VNET_HW_INTERFACE_CLASS (ipsec_hw_class) =
243 .build_rewrite = default_build_rewrite,
244 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
249 ipsec_add_del_tunnel_if_rpc_callback (ipsec_add_del_tunnel_args_t * a)
251 vnet_main_t *vnm = vnet_get_main ();
252 ASSERT (vlib_get_thread_index () == 0);
254 return ipsec_add_del_tunnel_if_internal (vnm, a, NULL);
258 ipsec_add_del_tunnel_if (ipsec_add_del_tunnel_args_t * args)
260 vl_api_rpc_call_main_thread (ipsec_add_del_tunnel_if_rpc_callback,
261 (u8 *) args, sizeof (*args));
266 ipsec_tun_mk_input_sa_id (u32 ti)
268 return (0x80000000 | ti);
272 ipsec_tun_mk_output_sa_id (u32 ti)
274 return (0xc0000000 | ti);
278 ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
279 ipsec_add_del_tunnel_args_t * args,
282 ipsec_tunnel_if_t *t;
283 ipsec_main_t *im = &ipsec_main;
284 vnet_hw_interface_t *hi = NULL;
285 u32 hw_if_index = ~0;
289 ipsec_key_t crypto_key, integ_key;
290 ipsec_sa_flags_t flags;
293 u64 key = ((u64) args->remote_ip.ip4.as_u32 << 32 |
294 (u64) clib_host_to_net_u32 (args->remote_spi));
295 p = hash_get (im->ipsec_if_pool_index_by_key, key);
299 /* check if same src/dst pair exists */
301 return VNET_API_ERROR_INVALID_VALUE;
303 pool_get_aligned_zero (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
305 dev_instance = t - im->tunnel_interfaces;
307 t->show_instance = args->show_instance;
309 t->show_instance = dev_instance;
311 if (hash_get (im->ipsec_if_real_dev_by_show_dev, t->show_instance))
313 pool_put (im->tunnel_interfaces, t);
314 return VNET_API_ERROR_INSTANCE_IN_USE;
317 hash_set (im->ipsec_if_real_dev_by_show_dev, t->show_instance,
320 flags = IPSEC_SA_FLAG_IS_TUNNEL;
322 flags |= IPSEC_SA_FLAG_UDP_ENCAP;
324 flags |= IPSEC_SA_FLAG_USE_EXTENDED_SEQ_NUM;
325 if (args->anti_replay)
326 flags |= IPSEC_SA_FLAG_USE_ANTI_REPLAY;
328 ipsec_mk_key (&crypto_key,
329 args->remote_crypto_key, args->remote_crypto_key_len);
330 ipsec_mk_key (&integ_key,
331 args->remote_integ_key, args->remote_integ_key_len);
333 rv = ipsec_sa_add (ipsec_tun_mk_input_sa_id (dev_instance),
343 &args->local_ip, &t->input_sa_index);
346 return VNET_API_ERROR_UNIMPLEMENTED;
348 ipsec_mk_key (&crypto_key,
349 args->local_crypto_key, args->local_crypto_key_len);
350 ipsec_mk_key (&integ_key,
351 args->local_integ_key, args->local_integ_key_len);
353 rv = ipsec_sa_add (ipsec_tun_mk_output_sa_id (dev_instance),
363 &args->remote_ip, &t->output_sa_index);
366 return VNET_API_ERROR_UNIMPLEMENTED;
368 hash_set (im->ipsec_if_pool_index_by_key, key,
369 t - im->tunnel_interfaces);
371 hw_if_index = vnet_register_interface (vnm, ipsec_device_class.index,
372 t - im->tunnel_interfaces,
373 ipsec_hw_class.index,
374 t - im->tunnel_interfaces);
376 hi = vnet_get_hw_interface (vnm, hw_if_index);
377 /* add esp4 as the next-node-index of this tx-node */
379 slot = vlib_node_add_next_with_slot
380 (vnm->vlib_main, hi->tx_node_index, im->esp4_encrypt_node_index, 0);
384 t->hw_if_index = hw_if_index;
385 t->sw_if_index = hi->sw_if_index;
387 vec_validate_init_empty (im->ipsec_if_by_sw_if_index,
389 im->ipsec_if_by_sw_if_index[t->sw_if_index] = t - im->tunnel_interfaces;
391 vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
392 hi->sw_if_index, 1, 0, 0);
394 /*1st interface, register protocol */
395 if (pool_elts (im->tunnel_interfaces) == 1)
396 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
397 ipsec_if_input_node.index);
402 /* check if exists */
404 return VNET_API_ERROR_INVALID_VALUE;
406 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
407 hi = vnet_get_hw_interface (vnm, t->hw_if_index);
408 vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0); /* admin down */
410 vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
411 hi->sw_if_index, 0, 0, 0);
413 vnet_delete_hw_interface (vnm, t->hw_if_index);
415 hash_unset (im->ipsec_if_pool_index_by_key, key);
416 hash_unset (im->ipsec_if_real_dev_by_show_dev, t->show_instance);
417 im->ipsec_if_by_sw_if_index[t->sw_if_index] = ~0;
419 pool_put (im->tunnel_interfaces, t);
421 /* delete input and output SA */
422 ipsec_sa_del (ipsec_tun_mk_input_sa_id (p[0]));
423 ipsec_sa_del (ipsec_tun_mk_output_sa_id (p[0]));
427 *sw_if_index = hi->sw_if_index;
433 ipsec_add_del_ipsec_gre_tunnel (vnet_main_t * vnm,
434 ipsec_add_del_ipsec_gre_tunnel_args_t * args)
436 ipsec_tunnel_if_t *t = 0;
437 ipsec_main_t *im = &ipsec_main;
443 p = hash_get (im->sa_index_by_sa_id, args->local_sa_id);
445 return VNET_API_ERROR_INVALID_VALUE;
448 p = hash_get (im->sa_index_by_sa_id, args->remote_sa_id);
450 return VNET_API_ERROR_INVALID_VALUE;
452 sa = pool_elt_at_index (im->sad, p[0]);
455 key = ((u64) sa->tunnel_dst_addr.ip4.as_u32 << 32 |
456 (u64) clib_host_to_net_u32 (sa->spi));
458 key = ((u64) args->remote_ip.as_u32 << 32 |
459 (u64) clib_host_to_net_u32 (sa->spi));
461 p = hash_get (im->ipsec_if_pool_index_by_key, key);
465 /* check if same src/dst pair exists */
467 return VNET_API_ERROR_INVALID_VALUE;
469 pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
470 clib_memset (t, 0, sizeof (*t));
472 t->input_sa_index = isa;
473 t->output_sa_index = osa;
475 hash_set (im->ipsec_if_pool_index_by_key, key,
476 t - im->tunnel_interfaces);
478 /*1st interface, register protocol */
479 if (pool_elts (im->tunnel_interfaces) == 1)
480 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
481 ipsec_if_input_node.index);
485 /* check if exists */
487 return VNET_API_ERROR_INVALID_VALUE;
489 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
490 hash_unset (im->ipsec_if_pool_index_by_key, key);
491 pool_put (im->tunnel_interfaces, t);
497 ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
498 ipsec_if_set_key_type_t type, u8 alg, u8 * key)
500 ipsec_main_t *im = &ipsec_main;
501 vnet_hw_interface_t *hi;
502 ipsec_tunnel_if_t *t;
505 hi = vnet_get_hw_interface (vnm, hw_if_index);
506 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
508 if (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
509 return VNET_API_ERROR_SYSCALL_ERROR_1;
511 if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO)
513 sa = pool_elt_at_index (im->sad, t->output_sa_index);
514 sa->crypto_alg = alg;
515 ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
517 else if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG)
519 sa = pool_elt_at_index (im->sad, t->output_sa_index);
521 ipsec_mk_key (&sa->integ_key, key, vec_len (key));
523 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO)
525 sa = pool_elt_at_index (im->sad, t->input_sa_index);
526 sa->crypto_alg = alg;
527 ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
529 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG)
531 sa = pool_elt_at_index (im->sad, t->input_sa_index);
533 ipsec_mk_key (&sa->integ_key, key, vec_len (key));
536 return VNET_API_ERROR_INVALID_VALUE;
543 ipsec_set_interface_sa (vnet_main_t * vnm, u32 hw_if_index, u32 sa_id,
546 ipsec_main_t *im = &ipsec_main;
547 vnet_hw_interface_t *hi;
548 ipsec_tunnel_if_t *t;
549 ipsec_sa_t *sa, *old_sa;
550 u32 sa_index, old_sa_index;
553 hi = vnet_get_hw_interface (vnm, hw_if_index);
554 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
556 sa_index = ipsec_get_sa_index_by_sa_id (sa_id);
559 clib_warning ("SA with ID %u not found", sa_id);
560 return VNET_API_ERROR_INVALID_VALUE;
563 if (ipsec_is_sa_used (sa_index))
565 clib_warning ("SA with ID %u is already in use", sa_id);
566 return VNET_API_ERROR_INVALID_VALUE;
569 sa = pool_elt_at_index (im->sad, sa_index);
570 if (sa->is_tunnel_ip6)
572 clib_warning ("IPsec interface not supported with IPv6 endpoints");
573 return VNET_API_ERROR_UNIMPLEMENTED;
580 old_sa_index = t->input_sa_index;
581 old_sa = pool_elt_at_index (im->sad, old_sa_index);
583 /* unset old inbound hash entry. packets should stop arriving */
584 key = ((u64) old_sa->tunnel_src_addr.ip4.as_u32 << 32 |
585 (u64) clib_host_to_net_u32 (old_sa->spi));
586 p = hash_get (im->ipsec_if_pool_index_by_key, key);
588 hash_unset (im->ipsec_if_pool_index_by_key, key);
590 /* set new inbound SA, then set new hash entry */
591 t->input_sa_index = sa_index;
592 key = ((u64) sa->tunnel_src_addr.ip4.as_u32 << 32 |
593 (u64) clib_host_to_net_u32 (sa->spi));
594 hash_set (im->ipsec_if_pool_index_by_key, key, hi->dev_instance);
598 old_sa_index = t->output_sa_index;
599 old_sa = pool_elt_at_index (im->sad, old_sa_index);
600 t->output_sa_index = sa_index;
603 /* remove sa_id to sa_index mapping on old SA */
604 if (ipsec_get_sa_index_by_sa_id (old_sa->id) == old_sa_index)
605 hash_unset (im->sa_index_by_sa_id, old_sa->id);
607 if (ipsec_add_del_sa_sess_cb (im, old_sa_index, 0))
609 clib_warning ("IPsec backend add/del callback returned error");
610 return VNET_API_ERROR_SYSCALL_ERROR_1;
612 pool_put (im->sad, old_sa);
618 ipsec_tunnel_if_init (vlib_main_t * vm)
620 ipsec_main_t *im = &ipsec_main;
622 im->ipsec_if_pool_index_by_key = hash_create (0, sizeof (uword));
623 im->ipsec_if_real_dev_by_show_dev = hash_create (0, sizeof (uword));
628 VLIB_INIT_FUNCTION (ipsec_tunnel_if_init);
632 * fd.io coding-style-patch-verification: ON
635 * eval: (c-set-style "gnu")