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>
24 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
27 format_ipsec_name (u8 * s, va_list * args)
29 u32 dev_instance = va_arg (*args, u32);
30 return format (s, "ipsec%d", dev_instance);
34 dummy_interface_tx (vlib_main_t * vm,
35 vlib_node_runtime_t * node, vlib_frame_t * frame)
37 clib_warning ("you shouldn't be here, leaking buffers...");
38 return frame->n_vectors;
41 VNET_DEVICE_CLASS (ipsec_device_class, static) =
43 .name = "IPSec",.format_device_name = format_ipsec_name,.format_tx_trace =
44 format_ipsec_if_output_trace,.tx_function = dummy_interface_tx,};
47 dummy_set_rewrite (vnet_main_t * vnm,
50 void *dst_address, void *rewrite, uword max_rewrite_bytes)
55 VNET_HW_INTERFACE_CLASS (ipsec_hw_class) =
57 .name = "IPSec",.set_rewrite = dummy_set_rewrite,};
61 ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
62 ipsec_add_del_tunnel_args_t * args);
65 ipsec_add_del_tunnel_if_rpc_callback (ipsec_add_del_tunnel_args_t * a)
67 vnet_main_t *vnm = vnet_get_main ();
68 ASSERT (os_get_cpu_number () == 0);
70 return ipsec_add_del_tunnel_if_internal (vnm, a);
74 ipsec_add_del_tunnel_if (ipsec_add_del_tunnel_args_t * args)
76 vl_api_rpc_call_main_thread (ipsec_add_del_tunnel_if_rpc_callback,
77 (u8 *) args, sizeof (*args));
82 ipsec_add_del_tunnel_if_internal (vnet_main_t * vnm,
83 ipsec_add_del_tunnel_args_t * args)
86 ipsec_main_t *im = &ipsec_main;
87 vnet_hw_interface_t *hi;
92 u64 key = (u64) args->remote_ip.as_u32 << 32 | (u64) args->remote_spi;
93 p = hash_get (im->ipsec_if_pool_index_by_key, key);
97 /* check if same src/dst pair exists */
99 return VNET_API_ERROR_INVALID_VALUE;
101 pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
102 memset (t, 0, sizeof (*t));
104 pool_get (im->sad, sa);
105 memset (sa, 0, sizeof (*sa));
106 t->input_sa_index = sa - im->sad;
107 sa->spi = args->remote_spi;
108 sa->tunnel_src_addr.ip4.as_u32 = args->remote_ip.as_u32;
109 sa->tunnel_dst_addr.ip4.as_u32 = args->local_ip.as_u32;
111 sa->use_esn = args->esn;
112 sa->use_anti_replay = args->anti_replay;
113 sa->integ_alg = args->integ_alg;
114 if (args->remote_integ_key_len <= sizeof (args->remote_integ_key))
116 sa->integ_key_len = args->remote_integ_key_len;
117 clib_memcpy (sa->integ_key, args->remote_integ_key,
118 args->remote_integ_key_len);
120 sa->crypto_alg = args->crypto_alg;
121 if (args->remote_crypto_key_len <= sizeof (args->remote_crypto_key))
123 sa->crypto_key_len = args->remote_crypto_key_len;
124 clib_memcpy (sa->crypto_key, args->remote_crypto_key,
125 args->remote_crypto_key_len);
128 pool_get (im->sad, sa);
129 memset (sa, 0, sizeof (*sa));
130 t->output_sa_index = sa - im->sad;
131 sa->spi = args->local_spi;
132 sa->tunnel_src_addr.ip4.as_u32 = args->local_ip.as_u32;
133 sa->tunnel_dst_addr.ip4.as_u32 = args->remote_ip.as_u32;
136 sa->use_esn = args->esn;
137 sa->use_anti_replay = args->anti_replay;
138 sa->integ_alg = args->integ_alg;
139 if (args->local_integ_key_len <= sizeof (args->local_integ_key))
141 sa->integ_key_len = args->local_integ_key_len;
142 clib_memcpy (sa->integ_key, args->local_integ_key,
143 args->local_integ_key_len);
145 sa->crypto_alg = args->crypto_alg;
146 if (args->local_crypto_key_len <= sizeof (args->local_crypto_key))
148 sa->crypto_key_len = args->local_crypto_key_len;
149 clib_memcpy (sa->crypto_key, args->local_crypto_key,
150 args->local_crypto_key_len);
153 hash_set (im->ipsec_if_pool_index_by_key, key,
154 t - im->tunnel_interfaces);
156 if (vec_len (im->free_tunnel_if_indices) > 0)
159 im->free_tunnel_if_indices[vec_len (im->free_tunnel_if_indices) -
161 _vec_len (im->free_tunnel_if_indices) -= 1;
166 vnet_register_interface (vnm, ipsec_device_class.index,
167 t - im->tunnel_interfaces,
168 ipsec_hw_class.index,
169 t - im->tunnel_interfaces);
171 hi = vnet_get_hw_interface (vnm, hw_if_index);
172 hi->output_node_index = ipsec_if_output_node.index;
174 t->hw_if_index = hw_if_index;
176 /*1st interface, register protocol */
177 if (pool_elts (im->tunnel_interfaces) == 1)
178 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
179 ipsec_if_input_node.index);
185 /* check if exists */
187 return VNET_API_ERROR_INVALID_VALUE;
189 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
190 hi = vnet_get_hw_interface (vnm, t->hw_if_index);
191 vnet_sw_interface_set_flags (vnm, hi->sw_if_index, 0); /* admin down */
192 vec_add1 (im->free_tunnel_if_indices, t->hw_if_index);
194 /* delete input and output SA */
195 sa = pool_elt_at_index (im->sad, t->input_sa_index);
196 pool_put (im->sad, sa);
197 sa = pool_elt_at_index (im->sad, t->output_sa_index);
198 pool_put (im->sad, sa);
200 hash_unset (im->ipsec_if_pool_index_by_key, key);
201 pool_put (im->tunnel_interfaces, t);
207 ipsec_add_del_ipsec_gre_tunnel (vnet_main_t * vnm,
208 ipsec_add_del_ipsec_gre_tunnel_args_t * args)
210 ipsec_tunnel_if_t *t = 0;
211 ipsec_main_t *im = &ipsec_main;
217 p = hash_get (im->sa_index_by_sa_id, args->local_sa_id);
219 return VNET_API_ERROR_INVALID_VALUE;
222 p = hash_get (im->sa_index_by_sa_id, args->remote_sa_id);
224 return VNET_API_ERROR_INVALID_VALUE;
226 sa = pool_elt_at_index (im->sad, p[0]);
229 key = (u64) sa->tunnel_dst_addr.ip4.as_u32 << 32 | (u64) sa->spi;
231 key = (u64) args->remote_ip.as_u32 << 32 | (u64) sa->spi;
233 p = hash_get (im->ipsec_if_pool_index_by_key, key);
237 /* check if same src/dst pair exists */
239 return VNET_API_ERROR_INVALID_VALUE;
241 pool_get_aligned (im->tunnel_interfaces, t, CLIB_CACHE_LINE_BYTES);
242 memset (t, 0, sizeof (*t));
244 t->input_sa_index = isa;
245 t->output_sa_index = osa;
247 hash_set (im->ipsec_if_pool_index_by_key, key,
248 t - im->tunnel_interfaces);
250 /*1st interface, register protocol */
251 if (pool_elts (im->tunnel_interfaces) == 1)
252 ip4_register_protocol (IP_PROTOCOL_IPSEC_ESP,
253 ipsec_if_input_node.index);
257 /* check if exists */
259 return VNET_API_ERROR_INVALID_VALUE;
261 t = pool_elt_at_index (im->tunnel_interfaces, p[0]);
262 hash_unset (im->ipsec_if_pool_index_by_key, key);
263 pool_put (im->tunnel_interfaces, t);
269 ipsec_set_interface_key (vnet_main_t * vnm, u32 hw_if_index,
270 ipsec_if_set_key_type_t type, u8 alg, u8 * key)
272 ipsec_main_t *im = &ipsec_main;
273 vnet_hw_interface_t *hi;
274 ipsec_tunnel_if_t *t;
277 hi = vnet_get_hw_interface (vnm, hw_if_index);
278 t = pool_elt_at_index (im->tunnel_interfaces, hi->dev_instance);
280 if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_CRYPTO)
282 sa = pool_elt_at_index (im->sad, t->output_sa_index);
283 sa->crypto_alg = alg;
284 sa->crypto_key_len = vec_len (key);
285 clib_memcpy (sa->crypto_key, key, vec_len (key));
287 else if (type == IPSEC_IF_SET_KEY_TYPE_LOCAL_INTEG)
289 sa = pool_elt_at_index (im->sad, t->output_sa_index);
291 sa->integ_key_len = vec_len (key);
292 clib_memcpy (sa->integ_key, key, vec_len (key));
294 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_CRYPTO)
296 sa = pool_elt_at_index (im->sad, t->input_sa_index);
297 sa->crypto_alg = alg;
298 sa->crypto_key_len = vec_len (key);
299 clib_memcpy (sa->crypto_key, key, vec_len (key));
301 else if (type == IPSEC_IF_SET_KEY_TYPE_REMOTE_INTEG)
303 sa = pool_elt_at_index (im->sad, t->input_sa_index);
305 sa->integ_key_len = vec_len (key);
306 clib_memcpy (sa->integ_key, key, vec_len (key));
309 return VNET_API_ERROR_INVALID_VALUE;
316 ipsec_tunnel_if_init (vlib_main_t * vm)
318 ipsec_main_t *im = &ipsec_main;
320 im->ipsec_if_pool_index_by_key = hash_create (0, sizeof (uword));
325 VLIB_INIT_FUNCTION (ipsec_tunnel_if_init);
329 * fd.io coding-style-patch-verification: ON
332 * eval: (c-set-style "gnu")