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>
22 #include <vnet/udp/udp.h>
24 #include <vnet/ipsec/ipsec.h>
25 #include <vnet/ipsec/esp.h>
27 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
30 format_ipsec_name (u8 * s, va_list * args)
32 u32 dev_instance = va_arg (*args, u32);
33 ipsec_main_t *im = &ipsec_main;
34 ipsec_tunnel_if_t *t = im->tunnel_interfaces + dev_instance;
36 return format (s, "ipsec%d", t->show_instance);
39 /* Statistics (not really errors) */
40 #define foreach_ipsec_if_tx_error \
41 _(TX, "good packets transmitted")
43 static char *ipsec_if_tx_error_strings[] = {
44 #define _(sym,string) string,
45 foreach_ipsec_if_tx_error
51 #define _(sym,str) IPSEC_IF_OUTPUT_ERROR_##sym,
52 foreach_ipsec_if_tx_error
55 } ipsec_if_tx_error_t;
61 } ipsec_if_tx_trace_t;
64 format_ipsec_if_tx_trace (u8 * s, va_list * args)
66 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
67 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
68 ipsec_if_tx_trace_t *t = va_arg (*args, ipsec_if_tx_trace_t *);
70 s = format (s, "IPSec: spi %u seq %u", t->spi, t->seq);
75 ipsec_output_trace (vlib_main_t * vm,
76 vlib_node_runtime_t * node,
77 vlib_frame_t * frame, const ipsec_tunnel_if_t * t0)
79 ipsec_main_t *im = &ipsec_main;
82 n_left = frame->n_vectors;
83 from = vlib_frame_vector_args (frame);
89 b0 = vlib_get_buffer (vm, from[0]);
91 if (b0->flags & VLIB_BUFFER_IS_TRACED)
93 ipsec_if_tx_trace_t *tr =
94 vlib_add_trace (vm, node, b0, sizeof (*tr));
95 ipsec_sa_t *sa0 = pool_elt_at_index (im->sad, t0->output_sa_index);
105 VNET_DEVICE_CLASS_TX_FN (ipsec_device_class) (vlib_main_t * vm,
106 vlib_node_runtime_t * node,
107 vlib_frame_t * frame)
109 ipsec_main_t *im = &ipsec_main;
111 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
112 const ipsec_tunnel_if_t *t0;
113 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
114 u16 nexts[VLIB_FRAME_SIZE];
116 from = vlib_frame_vector_args (frame);
117 t0 = pool_elt_at_index (im->tunnel_interfaces, rd->dev_instance);
118 n_left = frame->n_vectors;
121 /* All going to encrypt */
122 clib_memset (nexts, 0, sizeof (nexts));
124 if (node->flags & VLIB_NODE_FLAG_TRACE)
125 ipsec_output_trace (vm, node, frame, t0);
127 vlib_get_buffers (vm, from, bufs, n_left);
131 /* Prefetch the buffer header for the N+2 loop iteration */
132 vlib_prefetch_buffer_header (b[4], STORE);
133 vlib_prefetch_buffer_header (b[5], STORE);
134 vlib_prefetch_buffer_header (b[6], STORE);
135 vlib_prefetch_buffer_header (b[7], STORE);
137 vnet_buffer (b[0])->ipsec.sad_index = t0->output_sa_index;
138 vnet_buffer (b[1])->ipsec.sad_index = t0->output_sa_index;
139 vnet_buffer (b[2])->ipsec.sad_index = t0->output_sa_index;
140 vnet_buffer (b[3])->ipsec.sad_index = t0->output_sa_index;
147 vnet_buffer (b[0])->ipsec.sad_index = t0->output_sa_index;
153 vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
155 return 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);
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) =
218 .format_device_name = format_ipsec_name,
219 .format_tx_trace = format_ipsec_if_tx_trace,
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_tun_mk_input_sa_id (u32 ti)
255 return (0x80000000 | ti);
259 ipsec_tun_mk_output_sa_id (u32 ti)
261 return (0xc0000000 | ti);
265 ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
266 ipsec_add_del_tunnel_args_t * args,
269 ipsec_tunnel_if_t *t;
270 ipsec_main_t *im = &ipsec_main;
271 vnet_hw_interface_t *hi = NULL;
272 u32 hw_if_index = ~0;
275 ipsec_key_t crypto_key, integ_key;
276 ipsec_sa_flags_t flags;
278 int is_ip6 = args->is_ip6;
279 ipsec4_tunnel_key_t key4;
280 ipsec6_tunnel_key_t key6;
284 key4.remote_ip = args->remote_ip.ip4.as_u32;
285 key4.spi = clib_host_to_net_u32 (args->remote_spi);
286 p = hash_get (im->ipsec4_if_pool_index_by_key, key4.as_u64);
290 key6.remote_ip = args->remote_ip.ip6;
291 key6.spi = clib_host_to_net_u32 (args->remote_spi);
292 p = hash_get_mem (im->ipsec6_if_pool_index_by_key, &key6);
297 /* check if same src/dst pair exists */
299 return VNET_API_ERROR_INVALID_VALUE;
301 pool_get_aligned_zero (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
303 dev_instance = t - im->tunnel_interfaces;
305 t->show_instance = args->show_instance;
307 t->show_instance = dev_instance;
309 if (hash_get (im->ipsec_if_real_dev_by_show_dev, t->show_instance))
311 pool_put (im->tunnel_interfaces, t);
312 return VNET_API_ERROR_INSTANCE_IN_USE;
315 hash_set (im->ipsec_if_real_dev_by_show_dev, t->show_instance,
318 flags = IPSEC_SA_FLAG_IS_TUNNEL;
320 flags |= IPSEC_SA_FLAG_IS_TUNNEL_V6;
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;
370 hash_set_mem_alloc (&im->ipsec6_if_pool_index_by_key, &key6,
371 t - im->tunnel_interfaces);
373 hash_set (im->ipsec4_if_pool_index_by_key, key4.as_u64,
374 t - im->tunnel_interfaces);
376 hw_if_index = vnet_register_interface (vnm, ipsec_device_class.index,
377 t - im->tunnel_interfaces,
378 ipsec_hw_class.index,
379 t - im->tunnel_interfaces);
381 hi = vnet_get_hw_interface (vnm, hw_if_index);
383 /* add esp4/6 as the next-node-index of this tx-node */
384 uword slot = vlib_node_add_next_with_slot
385 (vnm->vlib_main, hi->tx_node_index,
386 is_ip6 ? im->esp6_encrypt_node_index : im->esp4_encrypt_node_index,
391 t->hw_if_index = hw_if_index;
392 t->sw_if_index = hi->sw_if_index;
394 vnet_feature_enable_disable ("interface-output",
395 args->is_ip6 ? "ipsec6-if-output" :
396 "ipsec4-if-output", hi->sw_if_index, 1, 0,
398 /*1st interface, register protocol */
399 if (pool_elts (im->tunnel_interfaces) == 1)
401 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
402 ipsec4_if_input_node.index);
403 ip6_register_protocol (IP_PROTOCOL_IPSEC_ESP,
404 ipsec6_if_input_node.index);
412 /* check if exists */
414 return VNET_API_ERROR_INVALID_VALUE;
417 t = pool_elt_at_index (im->tunnel_interfaces, ti);
418 hi = vnet_get_hw_interface (vnm, t->hw_if_index);
419 vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0); /* admin down */
421 vnet_feature_enable_disable ("interface-output",
422 args->is_ip6 ? "ipsec6-if-output" :
423 "ipsec4-if-output", hi->sw_if_index, 0, 0,
425 vnet_delete_hw_interface (vnm, t->hw_if_index);
428 hash_unset_mem_free (&im->ipsec6_if_pool_index_by_key, &key6);
430 hash_unset (im->ipsec4_if_pool_index_by_key, key4.as_u64);
432 hash_unset (im->ipsec_if_real_dev_by_show_dev, t->show_instance);
434 pool_put (im->tunnel_interfaces, t);
436 /* delete input and output SA */
437 ipsec_sa_del (ipsec_tun_mk_input_sa_id (ti));
438 ipsec_sa_del (ipsec_tun_mk_output_sa_id (ti));
442 *sw_if_index = hi->sw_if_index;
448 ipsec_add_del_ipsec_gre_tunnel (vnet_main_t * vnm,
449 ipsec_add_del_ipsec_gre_tunnel_args_t * args)
451 ipsec_tunnel_if_t *t = 0;
452 ipsec_main_t *im = &ipsec_main;
455 ipsec4_tunnel_key_t key;
458 p = hash_get (im->sa_index_by_sa_id, args->local_sa_id);
460 return VNET_API_ERROR_INVALID_VALUE;
463 p = hash_get (im->sa_index_by_sa_id, args->remote_sa_id);
465 return VNET_API_ERROR_INVALID_VALUE;
467 sa = pool_elt_at_index (im->sad, p[0]);
471 key.remote_ip = sa->tunnel_dst_addr.ip4.as_u32;
472 key.spi = clib_host_to_net_u32 (sa->spi);
476 key.remote_ip = args->remote_ip.as_u32;
477 key.spi = clib_host_to_net_u32 (sa->spi);
480 p = hash_get (im->ipsec4_if_pool_index_by_key, key.as_u64);
484 /* check if same src/dst pair exists */
486 return VNET_API_ERROR_INVALID_VALUE;
488 pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
489 clib_memset (t, 0, sizeof (*t));
491 t->input_sa_index = isa;
492 t->output_sa_index = osa;
494 hash_set (im->ipsec4_if_pool_index_by_key, key.as_u64,
495 t - im->tunnel_interfaces);
497 /*1st interface, register protocol */
498 if (pool_elts (im->tunnel_interfaces) == 1)
500 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
501 ipsec4_if_input_node.index);
504 ip6_register_protocol (IP_PROTOCOL_IPSEC_ESP,
505 ipsec6_if_input_node.index);
511 /* check if exists */
513 return VNET_API_ERROR_INVALID_VALUE;
515 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
516 hash_unset (im->ipsec4_if_pool_index_by_key, key.as_u64);
517 pool_put (im->tunnel_interfaces, t);
523 ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
524 ipsec_if_set_key_type_t type, u8 alg, u8 * key)
526 ipsec_main_t *im = &ipsec_main;
527 vnet_hw_interface_t *hi;
528 ipsec_tunnel_if_t *t;
531 hi = vnet_get_hw_interface (vnm, hw_if_index);
532 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
534 if (hi->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
535 return VNET_API_ERROR_SYSCALL_ERROR_1;
537 if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO)
539 sa = pool_elt_at_index (im->sad, t->output_sa_index);
540 ipsec_sa_set_crypto_alg (sa, alg);
541 ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
543 else if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG)
545 sa = pool_elt_at_index (im->sad, t->output_sa_index);
546 ipsec_sa_set_integ_alg (sa, alg);
547 ipsec_mk_key (&sa->integ_key, key, vec_len (key));
549 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO)
551 sa = pool_elt_at_index (im->sad, t->input_sa_index);
552 ipsec_sa_set_crypto_alg (sa, alg);
553 ipsec_mk_key (&sa->crypto_key, key, vec_len (key));
555 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG)
557 sa = pool_elt_at_index (im->sad, t->input_sa_index);
558 ipsec_sa_set_integ_alg (sa, alg);
559 ipsec_mk_key (&sa->integ_key, key, vec_len (key));
562 return VNET_API_ERROR_INVALID_VALUE;
569 ipsec_set_interface_sa (vnet_main_t * vnm, u32 hw_if_index, u32 sa_id,
572 ipsec_main_t *im = &ipsec_main;
573 vnet_hw_interface_t *hi;
574 ipsec_tunnel_if_t *t;
575 ipsec_sa_t *sa, *old_sa;
576 u32 sa_index, old_sa_index;
579 hi = vnet_get_hw_interface (vnm, hw_if_index);
580 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
582 sa_index = ipsec_get_sa_index_by_sa_id (sa_id);
585 clib_warning ("SA with ID %u not found", sa_id);
586 return VNET_API_ERROR_INVALID_VALUE;
589 if (ipsec_is_sa_used (sa_index))
591 clib_warning ("SA with ID %u is already in use", sa_id);
592 return VNET_API_ERROR_INVALID_VALUE;
595 sa = pool_elt_at_index (im->sad, sa_index);
599 old_sa_index = t->input_sa_index;
600 old_sa = pool_elt_at_index (im->sad, old_sa_index);
602 if (sa->is_tunnel_ip6 ^ old_sa->is_tunnel_ip6)
604 clib_warning ("IPsec interface SA endpoints type can't be changed");
605 return VNET_API_ERROR_INVALID_VALUE;
608 if (sa->is_tunnel_ip6)
610 ipsec6_tunnel_key_t key;
612 /* unset old inbound hash entry. packets should stop arriving */
613 key.remote_ip = old_sa->tunnel_src_addr.ip6;
614 key.spi = clib_host_to_net_u32 (old_sa->spi);
616 p = hash_get_mem (im->ipsec6_if_pool_index_by_key, &key);
618 hash_unset_mem_free (&im->ipsec6_if_pool_index_by_key, &key);
620 /* set new inbound SA, then set new hash entry */
621 t->input_sa_index = sa_index;
622 key.remote_ip = sa->tunnel_src_addr.ip6;
623 key.spi = clib_host_to_net_u32 (sa->spi);
625 hash_set_mem_alloc (&im->ipsec6_if_pool_index_by_key, &key,
630 ipsec4_tunnel_key_t key;
632 /* unset old inbound hash entry. packets should stop arriving */
633 key.remote_ip = old_sa->tunnel_src_addr.ip4.as_u32;
634 key.spi = clib_host_to_net_u32 (old_sa->spi);
636 p = hash_get (im->ipsec4_if_pool_index_by_key, key.as_u64);
638 hash_unset (im->ipsec4_if_pool_index_by_key, key.as_u64);
640 /* set new inbound SA, then set new hash entry */
641 t->input_sa_index = sa_index;
642 key.remote_ip = sa->tunnel_src_addr.ip4.as_u32;
643 key.spi = clib_host_to_net_u32 (sa->spi);
645 hash_set (im->ipsec4_if_pool_index_by_key, key.as_u64,
651 old_sa_index = t->output_sa_index;
652 old_sa = pool_elt_at_index (im->sad, old_sa_index);
654 if (sa->is_tunnel_ip6 ^ old_sa->is_tunnel_ip6)
656 clib_warning ("IPsec interface SA endpoints type can't be changed");
657 return VNET_API_ERROR_INVALID_VALUE;
660 t->output_sa_index = sa_index;
663 /* remove sa_id to sa_index mapping on old SA */
664 if (ipsec_get_sa_index_by_sa_id (old_sa->id) == old_sa_index)
665 hash_unset (im->sa_index_by_sa_id, old_sa->id);
667 if (ipsec_add_del_sa_sess_cb (im, old_sa_index, 0))
669 clib_warning ("IPsec backend add/del callback returned error");
670 return VNET_API_ERROR_SYSCALL_ERROR_1;
672 pool_put (im->sad, old_sa);
679 ipsec_tunnel_if_init (vlib_main_t * vm)
681 ipsec_main_t *im = &ipsec_main;
683 /* initialize the ipsec-if ip4 hash */
684 im->ipsec4_if_pool_index_by_key =
685 hash_create (0, sizeof (ipsec4_tunnel_key_t));
686 /* initialize the ipsec-if ip6 hash */
687 im->ipsec6_if_pool_index_by_key = hash_create_mem (0,
689 (ipsec6_tunnel_key_t),
691 im->ipsec_if_real_dev_by_show_dev = hash_create (0, sizeof (uword));
693 udp_register_dst_port (vm, UDP_DST_PORT_ipsec, ipsec4_if_input_node.index,
698 VLIB_INIT_FUNCTION (ipsec_tunnel_if_init);
702 * fd.io coding-style-patch-verification: ON
705 * eval: (c-set-style "gnu")