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>
22 #include <vnet/ipsec/ipsec.h>
23 #include <vnet/ipsec/esp.h>
25 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
28 format_ipsec_name (u8 * s, va_list * args)
30 u32 dev_instance = va_arg (*args, u32);
31 ipsec_main_t *im = &ipsec_main;
32 ipsec_tunnel_if_t *t = im->tunnel_interfaces + dev_instance;
34 return format (s, "ipsec%d", t->show_instance);
37 /* Statistics (not really errors) */
38 #define foreach_ipsec_if_tx_error \
39 _(TX, "good packets transmitted")
41 static char *ipsec_if_tx_error_strings[] = {
42 #define _(sym,string) string,
43 foreach_ipsec_if_tx_error
49 #define _(sym,str) IPSEC_IF_OUTPUT_ERROR_##sym,
50 foreach_ipsec_if_tx_error
53 } ipsec_if_tx_error_t;
59 } ipsec_if_tx_trace_t;
62 format_ipsec_if_tx_trace (u8 * s, va_list * args)
64 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
65 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
66 ipsec_if_tx_trace_t *t = va_arg (*args, ipsec_if_tx_trace_t *);
68 s = format (s, "IPSec: spi %u seq %u", t->spi, t->seq);
73 ipsec_if_tx_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
74 vlib_frame_t * from_frame)
76 ipsec_main_t *im = &ipsec_main;
77 vnet_main_t *vnm = im->vnet_main;
78 vnet_interface_main_t *vim = &vnm->interface_main;
79 u32 *from, *to_next = 0, next_index;
80 u32 n_left_from, sw_if_index0, last_sw_if_index = ~0;
81 u32 thread_index = vm->thread_index;
82 u32 n_bytes = 0, n_packets = 0;
84 from = vlib_frame_vector_args (from_frame);
85 n_left_from = from_frame->n_vectors;
86 next_index = node->cached_next_index;
88 while (n_left_from > 0)
92 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
94 while (n_left_from > 0 && n_left_to_next > 0)
98 ipsec_tunnel_if_t *t0;
99 vnet_hw_interface_t *hi0;
101 bi0 = to_next[0] = from[0];
106 b0 = vlib_get_buffer (vm, bi0);
107 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
108 hi0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
109 t0 = pool_elt_at_index (im->tunnel_interfaces, hi0->dev_instance);
110 vnet_buffer (b0)->ipsec.sad_index = t0->output_sa_index;
111 next0 = IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT;
113 len0 = vlib_buffer_length_in_chain (vm, b0);
115 if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
122 vlib_increment_combined_counter (vim->combined_sw_if_counters +
123 VNET_INTERFACE_COUNTER_TX,
124 thread_index, sw_if_index0,
126 last_sw_if_index = sw_if_index0;
131 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
133 ipsec_if_tx_trace_t *tr =
134 vlib_add_trace (vm, node, b0, sizeof (*tr));
136 pool_elt_at_index (im->sad, t0->output_sa_index);
141 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
142 n_left_to_next, bi0, next0);
144 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
147 if (last_sw_if_index != ~0)
149 vlib_increment_combined_counter (vim->combined_sw_if_counters +
150 VNET_INTERFACE_COUNTER_TX,
152 last_sw_if_index, n_packets, n_bytes);
155 return from_frame->n_vectors;
159 static clib_error_t *
160 ipsec_admin_up_down_function (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
162 ipsec_main_t *im = &ipsec_main;
163 clib_error_t *err = 0;
164 ipsec_tunnel_if_t *t;
165 vnet_hw_interface_t *hi;
168 hi = vnet_get_hw_interface (vnm, hw_if_index);
169 t = pool_elt_at_index (im->tunnel_interfaces, hi->hw_instance);
171 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
173 sa = pool_elt_at_index (im->sad, t->input_sa_index);
175 err = ipsec_check_support_cb (im, sa);
179 err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 1);
183 sa = pool_elt_at_index (im->sad, t->output_sa_index);
185 err = ipsec_check_support_cb (im, sa);
189 err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 1);
193 vnet_hw_interface_set_flags (vnm, hw_if_index,
194 VNET_HW_INTERFACE_FLAG_LINK_UP);
198 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
199 sa = pool_elt_at_index (im->sad, t->input_sa_index);
200 err = ipsec_add_del_sa_sess_cb (im, t->input_sa_index, 0);
203 sa = pool_elt_at_index (im->sad, t->output_sa_index);
204 err = ipsec_add_del_sa_sess_cb (im, t->output_sa_index, 0);
209 return /* no error */ 0;
214 VNET_DEVICE_CLASS (ipsec_device_class, static) =
217 .format_device_name = format_ipsec_name,
218 .format_tx_trace = format_ipsec_if_tx_trace,
219 .tx_function = ipsec_if_tx_node_fn,
220 .tx_function_n_errors = IPSEC_IF_TX_N_ERROR,
221 .tx_function_error_strings = ipsec_if_tx_error_strings,
222 .admin_up_down_function = ipsec_admin_up_down_function,
227 VNET_HW_INTERFACE_CLASS (ipsec_hw_class) =
230 .build_rewrite = default_build_rewrite,
231 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
236 ipsec_add_del_tunnel_if_rpc_callback (ipsec_add_del_tunnel_args_t * a)
238 vnet_main_t *vnm = vnet_get_main ();
239 ASSERT (vlib_get_thread_index () == 0);
241 return ipsec_add_del_tunnel_if_internal (vnm, a, NULL);
245 ipsec_add_del_tunnel_if (ipsec_add_del_tunnel_args_t * args)
247 vl_api_rpc_call_main_thread (ipsec_add_del_tunnel_if_rpc_callback,
248 (u8 *) args, sizeof (*args));
253 ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
254 ipsec_add_del_tunnel_args_t * args,
257 ipsec_tunnel_if_t *t;
258 ipsec_main_t *im = &ipsec_main;
259 vnet_hw_interface_t *hi = NULL;
260 u32 hw_if_index = ~0;
266 u64 key = (u64) args->remote_ip.as_u32 << 32 | (u64) args->remote_spi;
267 p = hash_get (im->ipsec_if_pool_index_by_key, key);
271 /* check if same src/dst pair exists */
273 return VNET_API_ERROR_INVALID_VALUE;
275 pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
276 clib_memset (t, 0, sizeof (*t));
278 dev_instance = t - im->tunnel_interfaces;
280 t->show_instance = args->show_instance;
282 t->show_instance = dev_instance;
284 if (hash_get (im->ipsec_if_real_dev_by_show_dev, t->show_instance))
286 pool_put (im->tunnel_interfaces, t);
287 return VNET_API_ERROR_INSTANCE_IN_USE;
290 hash_set (im->ipsec_if_real_dev_by_show_dev, t->show_instance,
293 pool_get (im->sad, sa);
294 clib_memset (sa, 0, sizeof (*sa));
295 t->input_sa_index = sa - im->sad;
296 sa->spi = args->remote_spi;
297 sa->tunnel_src_addr.ip4.as_u32 = args->remote_ip.as_u32;
298 sa->tunnel_dst_addr.ip4.as_u32 = args->local_ip.as_u32;
300 sa->use_esn = args->esn;
301 sa->use_anti_replay = args->anti_replay;
302 sa->integ_alg = args->integ_alg;
303 sa->udp_encap = args->udp_encap;
304 if (args->remote_integ_key_len <= sizeof (args->remote_integ_key))
306 sa->integ_key_len = args->remote_integ_key_len;
307 clib_memcpy (sa->integ_key, args->remote_integ_key,
308 args->remote_integ_key_len);
310 sa->crypto_alg = args->crypto_alg;
311 if (args->remote_crypto_key_len <= sizeof (args->remote_crypto_key))
313 sa->crypto_key_len = args->remote_crypto_key_len;
314 clib_memcpy (sa->crypto_key, args->remote_crypto_key,
315 args->remote_crypto_key_len);
318 pool_get (im->sad, sa);
319 clib_memset (sa, 0, sizeof (*sa));
320 t->output_sa_index = sa - im->sad;
321 sa->spi = args->local_spi;
322 sa->tunnel_src_addr.ip4.as_u32 = args->local_ip.as_u32;
323 sa->tunnel_dst_addr.ip4.as_u32 = args->remote_ip.as_u32;
325 sa->use_esn = args->esn;
326 sa->use_anti_replay = args->anti_replay;
327 sa->integ_alg = args->integ_alg;
328 sa->udp_encap = args->udp_encap;
329 if (args->local_integ_key_len <= sizeof (args->local_integ_key))
331 sa->integ_key_len = args->local_integ_key_len;
332 clib_memcpy (sa->integ_key, args->local_integ_key,
333 args->local_integ_key_len);
335 sa->crypto_alg = args->crypto_alg;
336 if (args->local_crypto_key_len <= sizeof (args->local_crypto_key))
338 sa->crypto_key_len = args->local_crypto_key_len;
339 clib_memcpy (sa->crypto_key, args->local_crypto_key,
340 args->local_crypto_key_len);
343 hash_set (im->ipsec_if_pool_index_by_key, key,
344 t - im->tunnel_interfaces);
346 hw_if_index = vnet_register_interface (vnm, ipsec_device_class.index,
347 t - im->tunnel_interfaces,
348 ipsec_hw_class.index,
349 t - im->tunnel_interfaces);
351 hi = vnet_get_hw_interface (vnm, hw_if_index);
353 slot = vlib_node_add_next_with_slot
354 (vnm->vlib_main, hi->tx_node_index, im->esp4_encrypt_node_index,
355 IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT);
357 ASSERT (slot == IPSEC_OUTPUT_NEXT_ESP4_ENCRYPT);
359 t->hw_if_index = hw_if_index;
361 vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
362 hi->sw_if_index, 1, 0, 0);
364 /*1st interface, register protocol */
365 if (pool_elts (im->tunnel_interfaces) == 1)
366 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
367 ipsec_if_input_node.index);
372 /* check if exists */
374 return VNET_API_ERROR_INVALID_VALUE;
376 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
377 hi = vnet_get_hw_interface (vnm, t->hw_if_index);
378 vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0); /* admin down */
380 vnet_feature_enable_disable ("interface-output", "ipsec-if-output",
381 hi->sw_if_index, 0, 0, 0);
383 vnet_delete_hw_interface (vnm, t->hw_if_index);
385 /* delete input and output SA */
387 sa = pool_elt_at_index (im->sad, t->input_sa_index);
388 pool_put (im->sad, sa);
390 sa = pool_elt_at_index (im->sad, t->output_sa_index);
391 pool_put (im->sad, sa);
393 hash_unset (im->ipsec_if_pool_index_by_key, key);
394 hash_unset (im->ipsec_if_real_dev_by_show_dev, t->show_instance);
396 pool_put (im->tunnel_interfaces, t);
400 *sw_if_index = hi->sw_if_index;
406 ipsec_add_del_ipsec_gre_tunnel (vnet_main_t * vnm,
407 ipsec_add_del_ipsec_gre_tunnel_args_t * args)
409 ipsec_tunnel_if_t *t = 0;
410 ipsec_main_t *im = &ipsec_main;
416 p = hash_get (im->sa_index_by_sa_id, args->local_sa_id);
418 return VNET_API_ERROR_INVALID_VALUE;
421 p = hash_get (im->sa_index_by_sa_id, args->remote_sa_id);
423 return VNET_API_ERROR_INVALID_VALUE;
425 sa = pool_elt_at_index (im->sad, p[0]);
428 key = (u64) sa->tunnel_dst_addr.ip4.as_u32 << 32 | (u64) sa->spi;
430 key = (u64) args->remote_ip.as_u32 << 32 | (u64) sa->spi;
432 p = hash_get (im->ipsec_if_pool_index_by_key, key);
436 /* check if same src/dst pair exists */
438 return VNET_API_ERROR_INVALID_VALUE;
440 pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
441 clib_memset (t, 0, sizeof (*t));
443 t->input_sa_index = isa;
444 t->output_sa_index = osa;
446 hash_set (im->ipsec_if_pool_index_by_key, key,
447 t - im->tunnel_interfaces);
449 /*1st interface, register protocol */
450 if (pool_elts (im->tunnel_interfaces) == 1)
451 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
452 ipsec_if_input_node.index);
456 /* check if exists */
458 return VNET_API_ERROR_INVALID_VALUE;
460 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
461 hash_unset (im->ipsec_if_pool_index_by_key, key);
462 pool_put (im->tunnel_interfaces, t);
468 ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
469 ipsec_if_set_key_type_t type, u8 alg, u8 * key)
471 ipsec_main_t *im = &ipsec_main;
472 vnet_hw_interface_t *hi;
473 ipsec_tunnel_if_t *t;
476 hi = vnet_get_hw_interface (vnm, hw_if_index);
477 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
479 if (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
480 return VNET_API_ERROR_SYSCALL_ERROR_1;
482 if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO)
484 sa = pool_elt_at_index (im->sad, t->output_sa_index);
485 sa->crypto_alg = alg;
486 sa->crypto_key_len = vec_len (key);
487 clib_memcpy (sa->crypto_key, key, vec_len (key));
489 else if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG)
491 sa = pool_elt_at_index (im->sad, t->output_sa_index);
493 sa->integ_key_len = vec_len (key);
494 clib_memcpy (sa->integ_key, key, vec_len (key));
496 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO)
498 sa = pool_elt_at_index (im->sad, t->input_sa_index);
499 sa->crypto_alg = alg;
500 sa->crypto_key_len = vec_len (key);
501 clib_memcpy (sa->crypto_key, key, vec_len (key));
503 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG)
505 sa = pool_elt_at_index (im->sad, t->input_sa_index);
507 sa->integ_key_len = vec_len (key);
508 clib_memcpy (sa->integ_key, key, vec_len (key));
511 return VNET_API_ERROR_INVALID_VALUE;
518 ipsec_set_interface_sa (vnet_main_t * vnm, u32 hw_if_index, u32 sa_id,
521 ipsec_main_t *im = &ipsec_main;
522 vnet_hw_interface_t *hi;
523 ipsec_tunnel_if_t *t;
524 ipsec_sa_t *sa, *old_sa;
525 u32 sa_index, old_sa_index;
528 hi = vnet_get_hw_interface (vnm, hw_if_index);
529 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
531 sa_index = ipsec_get_sa_index_by_sa_id (sa_id);
534 clib_warning ("SA with ID %u not found", sa_id);
535 return VNET_API_ERROR_INVALID_VALUE;
538 if (ipsec_is_sa_used (sa_index))
540 clib_warning ("SA with ID %u is already in use", sa_id);
541 return VNET_API_ERROR_INVALID_VALUE;
544 sa = pool_elt_at_index (im->sad, sa_index);
545 if (sa->is_tunnel_ip6)
547 clib_warning ("IPsec interface not supported with IPv6 endpoints");
548 return VNET_API_ERROR_UNIMPLEMENTED;
555 old_sa_index = t->input_sa_index;
556 old_sa = pool_elt_at_index (im->sad, old_sa_index);
558 /* unset old inbound hash entry. packets should stop arriving */
560 (u64) old_sa->tunnel_src_addr.ip4.as_u32 << 32 | (u64) old_sa->spi;
561 p = hash_get (im->ipsec_if_pool_index_by_key, key);
563 hash_unset (im->ipsec_if_pool_index_by_key, key);
565 /* set new inbound SA, then set new hash entry */
566 t->input_sa_index = sa_index;
567 key = (u64) sa->tunnel_src_addr.ip4.as_u32 << 32 | (u64) sa->spi;
568 hash_set (im->ipsec_if_pool_index_by_key, key, hi->dev_instance);
572 old_sa_index = t->output_sa_index;
573 old_sa = pool_elt_at_index (im->sad, old_sa_index);
574 t->output_sa_index = sa_index;
577 /* remove sa_id to sa_index mapping on old SA */
578 if (ipsec_get_sa_index_by_sa_id (old_sa->id) == old_sa_index)
579 hash_unset (im->sa_index_by_sa_id, old_sa->id);
581 if (!ipsec_add_del_sa_sess_cb (im, old_sa_index, 0))
583 clib_warning ("IPsec backend add/del callback returned error");
584 return VNET_API_ERROR_SYSCALL_ERROR_1;
586 pool_put (im->sad, old_sa);
593 ipsec_tunnel_if_init (vlib_main_t * vm)
595 ipsec_main_t *im = &ipsec_main;
597 im->ipsec_if_pool_index_by_key = hash_create (0, sizeof (uword));
598 im->ipsec_if_real_dev_by_show_dev = hash_create (0, sizeof (uword));
603 VLIB_INIT_FUNCTION (ipsec_tunnel_if_init);
607 * fd.io coding-style-patch-verification: ON
610 * eval: (c-set-style "gnu")