2 * decap.c : IPSec tunnel 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/interface.h>
22 #include <vnet/udp/udp.h>
24 #include <vnet/ipsec/ipsec.h>
25 #include <vnet/ipsec/ikev2.h>
26 #include <vnet/ipsec/esp.h>
27 #include <vnet/ipsec/ah.h>
30 ipsec_main_t ipsec_main;
33 ipsec_get_sa_index_by_sa_id (u32 sa_id)
35 ipsec_main_t *im = &ipsec_main;
36 uword *p = hash_get (im->sa_index_by_sa_id, sa_id);
44 ipsec_set_interface_spd (vlib_main_t * vm, u32 sw_if_index, u32 spd_id,
47 ipsec_main_t *im = &ipsec_main;
48 ip4_ipsec_config_t config;
53 p = hash_get (im->spd_index_by_spd_id, spd_id);
55 return VNET_API_ERROR_SYSCALL_ERROR_1; /* no such spd-id */
59 p = hash_get (im->spd_index_by_sw_if_index, sw_if_index);
61 return VNET_API_ERROR_SYSCALL_ERROR_1; /* spd already assigned */
65 hash_set (im->spd_index_by_sw_if_index, sw_if_index, spd_index);
69 hash_unset (im->spd_index_by_sw_if_index, sw_if_index);
72 clib_warning ("sw_if_index %u spd_id %u spd_index %u",
73 sw_if_index, spd_id, spd_index);
75 /* enable IPsec on TX */
76 vnet_feature_enable_disable ("ip4-output", "ipsec-output-ip4", sw_if_index,
78 vnet_feature_enable_disable ("ip6-output", "ipsec-output-ip6", sw_if_index,
81 /* enable IPsec on RX */
82 vnet_feature_enable_disable ("ip4-unicast", "ipsec-input-ip4", sw_if_index,
83 is_add, &config, sizeof (config));
84 vnet_feature_enable_disable ("ip6-unicast", "ipsec-input-ip6", sw_if_index,
85 is_add, &config, sizeof (config));
91 ipsec_add_del_spd (vlib_main_t * vm, u32 spd_id, int is_add)
93 ipsec_main_t *im = &ipsec_main;
98 p = hash_get (im->spd_index_by_spd_id, spd_id);
100 return VNET_API_ERROR_INVALID_VALUE;
102 return VNET_API_ERROR_INVALID_VALUE;
104 if (!is_add) /* delete */
107 spd = pool_elt_at_index (im->spds, spd_index);
109 return VNET_API_ERROR_INVALID_VALUE;
111 hash_foreach (k, v, im->spd_index_by_sw_if_index, ({
113 ipsec_set_interface_spd(vm, k, spd_id, 0);
116 hash_unset (im->spd_index_by_spd_id, spd_id);
117 pool_free (spd->policies);
118 vec_free (spd->ipv4_outbound_policies);
119 vec_free (spd->ipv6_outbound_policies);
120 vec_free (spd->ipv4_inbound_protect_policy_indices);
121 vec_free (spd->ipv4_inbound_policy_discard_and_bypass_indices);
122 pool_put (im->spds, spd);
124 else /* create new SPD */
126 pool_get (im->spds, spd);
127 memset (spd, 0, sizeof (*spd));
128 spd_index = spd - im->spds;
130 hash_set (im->spd_index_by_spd_id, spd_id, spd_index);
136 ipsec_spd_entry_sort (void *a1, void *a2)
140 ipsec_spd_t *spd = ipsec_main.spd_to_sort;
141 ipsec_policy_t *p1, *p2;
143 p1 = pool_elt_at_index (spd->policies, *id1);
144 p2 = pool_elt_at_index (spd->policies, *id2);
146 return p2->priority - p1->priority;
152 ipsec_add_del_policy (vlib_main_t * vm, ipsec_policy_t * policy, int is_add)
154 ipsec_main_t *im = &ipsec_main;
155 ipsec_spd_t *spd = 0;
160 clib_warning ("policy-id %u priority %d is_outbound %u", policy->id,
161 policy->priority, policy->is_outbound);
163 if (policy->policy == IPSEC_POLICY_ACTION_PROTECT)
165 p = hash_get (im->sa_index_by_sa_id, policy->sa_id);
167 return VNET_API_ERROR_SYSCALL_ERROR_1;
168 policy->sa_index = p[0];
171 p = hash_get (im->spd_index_by_spd_id, policy->id);
174 return VNET_API_ERROR_SYSCALL_ERROR_1;
177 spd = pool_elt_at_index (im->spds, spd_index);
179 return VNET_API_ERROR_SYSCALL_ERROR_1;
185 pool_get (spd->policies, vp);
186 clib_memcpy (vp, policy, sizeof (*vp));
187 policy_index = vp - spd->policies;
189 ipsec_main.spd_to_sort = spd;
191 if (policy->is_outbound)
195 vec_add1 (spd->ipv6_outbound_policies, policy_index);
196 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
197 vec_sort_with_function (spd->ipv6_outbound_policies,
198 ipsec_spd_entry_sort);
202 vec_add1 (spd->ipv4_outbound_policies, policy_index);
203 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
204 vec_sort_with_function (spd->ipv4_outbound_policies,
205 ipsec_spd_entry_sort);
212 if (policy->policy == IPSEC_POLICY_ACTION_PROTECT)
214 vec_add1 (spd->ipv6_inbound_protect_policy_indices,
216 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
217 vec_sort_with_function
218 (spd->ipv6_inbound_protect_policy_indices,
219 ipsec_spd_entry_sort);
224 (spd->ipv6_inbound_policy_discard_and_bypass_indices,
226 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
227 vec_sort_with_function
228 (spd->ipv6_inbound_policy_discard_and_bypass_indices,
229 ipsec_spd_entry_sort);
234 if (policy->policy == IPSEC_POLICY_ACTION_PROTECT)
236 vec_add1 (spd->ipv4_inbound_protect_policy_indices,
238 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
239 vec_sort_with_function
240 (spd->ipv4_inbound_protect_policy_indices,
241 ipsec_spd_entry_sort);
246 (spd->ipv4_inbound_policy_discard_and_bypass_indices,
248 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
249 vec_sort_with_function
250 (spd->ipv4_inbound_policy_discard_and_bypass_indices,
251 ipsec_spd_entry_sort);
256 ipsec_main.spd_to_sort = NULL;
262 pool_foreach_index(i, spd->policies, ({
263 vp = pool_elt_at_index(spd->policies, i);
264 if (vp->priority != policy->priority)
266 if (vp->is_outbound != policy->is_outbound)
268 if (vp->policy != policy->policy)
270 if (vp->sa_id != policy->sa_id)
272 if (vp->protocol != policy->protocol)
274 if (vp->lport.start != policy->lport.start)
276 if (vp->lport.stop != policy->lport.stop)
278 if (vp->rport.start != policy->rport.start)
280 if (vp->rport.stop != policy->rport.stop)
282 if (vp->is_ipv6 != policy->is_ipv6)
286 if (vp->laddr.start.ip6.as_u64[0] != policy->laddr.start.ip6.as_u64[0])
288 if (vp->laddr.start.ip6.as_u64[1] != policy->laddr.start.ip6.as_u64[1])
290 if (vp->laddr.stop.ip6.as_u64[0] != policy->laddr.stop.ip6.as_u64[0])
292 if (vp->laddr.stop.ip6.as_u64[1] != policy->laddr.stop.ip6.as_u64[1])
294 if (vp->raddr.start.ip6.as_u64[0] != policy->raddr.start.ip6.as_u64[0])
296 if (vp->raddr.start.ip6.as_u64[1] != policy->raddr.start.ip6.as_u64[1])
298 if (vp->raddr.stop.ip6.as_u64[0] != policy->raddr.stop.ip6.as_u64[0])
300 if (vp->laddr.stop.ip6.as_u64[1] != policy->laddr.stop.ip6.as_u64[1])
302 if (policy->is_outbound)
304 vec_foreach_index(j, spd->ipv6_outbound_policies) {
305 if (vec_elt(spd->ipv6_outbound_policies, j) == i) {
306 vec_del1 (spd->ipv6_outbound_policies, j);
313 if (policy->policy == IPSEC_POLICY_ACTION_PROTECT)
315 vec_foreach_index(j, spd->ipv6_inbound_protect_policy_indices) {
316 if (vec_elt(spd->ipv6_inbound_protect_policy_indices, j) == i) {
317 vec_del1 (spd->ipv6_inbound_protect_policy_indices, j);
324 vec_foreach_index(j, spd->ipv6_inbound_policy_discard_and_bypass_indices) {
325 if (vec_elt(spd->ipv6_inbound_policy_discard_and_bypass_indices, j) == i) {
326 vec_del1 (spd->ipv6_inbound_policy_discard_and_bypass_indices, j);
335 if (vp->laddr.start.ip4.as_u32 != policy->laddr.start.ip4.as_u32)
337 if (vp->laddr.stop.ip4.as_u32 != policy->laddr.stop.ip4.as_u32)
339 if (vp->raddr.start.ip4.as_u32 != policy->raddr.start.ip4.as_u32)
341 if (vp->raddr.stop.ip4.as_u32 != policy->raddr.stop.ip4.as_u32)
343 if (policy->is_outbound)
345 vec_foreach_index(j, spd->ipv4_outbound_policies) {
346 if (vec_elt(spd->ipv4_outbound_policies, j) == i) {
347 vec_del1 (spd->ipv4_outbound_policies, j);
354 if (policy->policy == IPSEC_POLICY_ACTION_PROTECT)
356 vec_foreach_index(j, spd->ipv4_inbound_protect_policy_indices) {
357 if (vec_elt(spd->ipv4_inbound_protect_policy_indices, j) == i) {
358 vec_del1 (spd->ipv4_inbound_protect_policy_indices, j);
365 vec_foreach_index(j, spd->ipv4_inbound_policy_discard_and_bypass_indices) {
366 if (vec_elt(spd->ipv4_inbound_policy_discard_and_bypass_indices, j) == i) {
367 vec_del1 (spd->ipv4_inbound_policy_discard_and_bypass_indices, j);
374 pool_put (spd->policies, vp);
384 ipsec_is_sa_used (u32 sa_index)
386 ipsec_main_t *im = &ipsec_main;
389 ipsec_tunnel_if_t *t;
392 pool_foreach(spd, im->spds, ({
393 pool_foreach(p, spd->policies, ({
394 if (p->policy == IPSEC_POLICY_ACTION_PROTECT)
396 if (p->sa_index == sa_index)
402 pool_foreach(t, im->tunnel_interfaces, ({
403 if (t->input_sa_index == sa_index)
405 if (t->output_sa_index == sa_index)
414 ipsec_add_del_sa (vlib_main_t * vm, ipsec_sa_t * new_sa, int is_add)
416 ipsec_main_t *im = &ipsec_main;
422 clib_warning ("id %u spi %u", new_sa->id, new_sa->spi);
424 p = hash_get (im->sa_index_by_sa_id, new_sa->id);
426 return VNET_API_ERROR_SYSCALL_ERROR_1; /* already exists */
428 return VNET_API_ERROR_SYSCALL_ERROR_1;
430 if (!is_add) /* delete */
433 sa = pool_elt_at_index (im->sad, sa_index);
434 if (ipsec_is_sa_used (sa_index))
436 clib_warning ("sa_id %u used in policy", sa->id);
437 return VNET_API_ERROR_SYSCALL_ERROR_1; /* sa used in policy */
439 hash_unset (im->sa_index_by_sa_id, sa->id);
440 if (im->cb.add_del_sa_sess_cb)
442 err = im->cb.add_del_sa_sess_cb (sa_index, 0);
444 return VNET_API_ERROR_SYSCALL_ERROR_1;
446 pool_put (im->sad, sa);
448 else /* create new SA */
450 pool_get (im->sad, sa);
451 clib_memcpy (sa, new_sa, sizeof (*sa));
452 sa_index = sa - im->sad;
453 hash_set (im->sa_index_by_sa_id, sa->id, sa_index);
454 if (im->cb.add_del_sa_sess_cb)
456 err = im->cb.add_del_sa_sess_cb (sa_index, 1);
458 return VNET_API_ERROR_SYSCALL_ERROR_1;
465 ipsec_set_sa_key (vlib_main_t * vm, ipsec_sa_t * sa_update)
467 ipsec_main_t *im = &ipsec_main;
473 p = hash_get (im->sa_index_by_sa_id, sa_update->id);
475 return VNET_API_ERROR_SYSCALL_ERROR_1; /* no such sa-id */
478 sa = pool_elt_at_index (im->sad, sa_index);
481 if (0 < sa_update->crypto_key_len)
483 clib_memcpy (sa->crypto_key, sa_update->crypto_key,
484 sa_update->crypto_key_len);
485 sa->crypto_key_len = sa_update->crypto_key_len;
489 if (0 < sa_update->integ_key_len)
491 clib_memcpy (sa->integ_key, sa_update->integ_key,
492 sa_update->integ_key_len);
493 sa->integ_key_len = sa_update->integ_key_len;
496 if (0 < sa_update->crypto_key_len || 0 < sa_update->integ_key_len)
498 if (im->cb.add_del_sa_sess_cb)
500 err = im->cb.add_del_sa_sess_cb (sa_index, 0);
502 return VNET_API_ERROR_SYSCALL_ERROR_1;
510 ipsec_rand_seed (void)
519 seed_data.time = time (NULL);
520 seed_data.pid = getpid ();
521 seed_data.p = (void *) &seed_data;
523 RAND_seed ((const void *) &seed_data, sizeof (seed_data));
526 static clib_error_t *
527 ipsec_check_support (ipsec_sa_t * sa)
529 if (sa->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128)
530 return clib_error_return (0, "unsupported aes-gcm-128 crypto-alg");
531 if (sa->integ_alg == IPSEC_INTEG_ALG_NONE)
532 return clib_error_return (0, "unsupported none integ-alg");
537 static clib_error_t *
538 ipsec_init (vlib_main_t * vm)
541 ipsec_main_t *im = &ipsec_main;
542 vlib_thread_main_t *tm = vlib_get_thread_main ();
547 memset (im, 0, sizeof (im[0]));
549 im->vnet_main = vnet_get_main ();
552 im->spd_index_by_spd_id = hash_create (0, sizeof (uword));
553 im->sa_index_by_sa_id = hash_create (0, sizeof (uword));
554 im->spd_index_by_sw_if_index = hash_create (0, sizeof (uword));
556 vec_validate_aligned (im->empty_buffers, tm->n_vlib_mains - 1,
557 CLIB_CACHE_LINE_BYTES);
559 node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
561 im->error_drop_node_index = node->index;
563 node = vlib_get_node_by_name (vm, (u8 *) "esp-encrypt");
565 im->esp_encrypt_node_index = node->index;
567 node = vlib_get_node_by_name (vm, (u8 *) "esp-decrypt");
569 im->esp_decrypt_node_index = node->index;
571 node = vlib_get_node_by_name (vm, (u8 *) "ah-encrypt");
573 im->ah_encrypt_node_index = node->index;
575 node = vlib_get_node_by_name (vm, (u8 *) "ah-decrypt");
577 im->ah_decrypt_node_index = node->index;
579 im->esp_encrypt_next_index = IPSEC_OUTPUT_NEXT_ESP_ENCRYPT;
580 im->esp_decrypt_next_index = IPSEC_INPUT_NEXT_ESP_DECRYPT;
581 im->ah_encrypt_next_index = IPSEC_OUTPUT_NEXT_AH_ENCRYPT;
582 im->ah_decrypt_next_index = IPSEC_INPUT_NEXT_AH_DECRYPT;
584 im->cb.check_support_cb = ipsec_check_support;
586 if ((error = vlib_call_init_function (vm, ipsec_cli_init)))
589 if ((error = vlib_call_init_function (vm, ipsec_tunnel_if_init)))
594 if ((error = ikev2_init (vm)))
600 VLIB_INIT_FUNCTION (ipsec_init);
603 * fd.io coding-style-patch-verification: ON
606 * eval: (c-set-style "gnu")