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>
23 #include <vnet/ipsec/ipsec.h>
24 #include <vnet/ipsec/ikev2.h>
25 #include <vnet/ipsec/esp.h>
28 ipsec_get_sa_index_by_sa_id (u32 sa_id)
30 ipsec_main_t *im = &ipsec_main;
31 uword *p = hash_get (im->sa_index_by_sa_id, sa_id);
39 ipsec_set_interface_spd (vlib_main_t * vm, u32 sw_if_index, u32 spd_id,
42 ipsec_main_t *im = &ipsec_main;
43 ip4_ipsec_config_t config;
48 p = hash_get (im->spd_index_by_spd_id, spd_id);
50 return VNET_API_ERROR_SYSCALL_ERROR_1; /* no such spd-id */
54 p = hash_get (im->spd_index_by_sw_if_index, sw_if_index);
56 return VNET_API_ERROR_SYSCALL_ERROR_1; /* spd already assigned */
60 hash_set (im->spd_index_by_sw_if_index, sw_if_index, spd_index);
64 hash_unset (im->spd_index_by_sw_if_index, sw_if_index);
67 clib_warning ("sw_if_index %u spd_id %u spd_index %u",
68 sw_if_index, spd_id, spd_index);
70 /* enable IPsec on TX */
71 vnet_feature_enable_disable ("ip4-output", "ipsec-output-ip4", sw_if_index,
73 vnet_feature_enable_disable ("ip6-output", "ipsec-output-ip6", sw_if_index,
76 /* enable IPsec on RX */
77 vnet_feature_enable_disable ("ip4-unicast", "ipsec-input-ip4", sw_if_index,
78 is_add, &config, sizeof (config));
79 vnet_feature_enable_disable ("ip6-unicast", "ipsec-input-ip6", sw_if_index,
80 is_add, &config, sizeof (config));
86 ipsec_add_del_spd (vlib_main_t * vm, u32 spd_id, int is_add)
88 ipsec_main_t *im = &ipsec_main;
93 p = hash_get (im->spd_index_by_spd_id, spd_id);
95 return VNET_API_ERROR_INVALID_VALUE;
97 return VNET_API_ERROR_INVALID_VALUE;
99 if (!is_add) /* delete */
102 spd = pool_elt_at_index (im->spds, spd_index);
104 return VNET_API_ERROR_INVALID_VALUE;
106 hash_foreach (k, v, im->spd_index_by_sw_if_index, ({
108 ipsec_set_interface_spd(vm, k, spd_id, 0);
111 hash_unset (im->spd_index_by_spd_id, spd_id);
112 pool_free (spd->policies);
113 vec_free (spd->ipv4_outbound_policies);
114 vec_free (spd->ipv6_outbound_policies);
115 vec_free (spd->ipv4_inbound_protect_policy_indices);
116 vec_free (spd->ipv4_inbound_policy_discard_and_bypass_indices);
117 pool_put (im->spds, spd);
119 else /* create new SPD */
121 pool_get (im->spds, spd);
122 memset (spd, 0, sizeof (*spd));
123 spd_index = spd - im->spds;
125 hash_set (im->spd_index_by_spd_id, spd_id, spd_index);
131 ipsec_spd_entry_sort (void *a1, void *a2)
133 ipsec_main_t *im = &ipsec_main;
137 ipsec_policy_t *p1, *p2;
140 pool_foreach (spd, im->spds, ({
141 p1 = pool_elt_at_index(spd->policies, *id1);
142 p2 = pool_elt_at_index(spd->policies, *id2);
144 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 if (policy->is_outbound)
193 vec_add1 (spd->ipv6_outbound_policies, policy_index);
194 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
195 vec_sort_with_function (spd->ipv6_outbound_policies,
196 ipsec_spd_entry_sort);
200 vec_add1 (spd->ipv4_outbound_policies, policy_index);
201 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
202 vec_sort_with_function (spd->ipv4_outbound_policies,
203 ipsec_spd_entry_sort);
210 if (policy->policy == IPSEC_POLICY_ACTION_PROTECT)
212 vec_add1 (spd->ipv6_inbound_protect_policy_indices,
214 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
215 vec_sort_with_function
216 (spd->ipv6_inbound_protect_policy_indices,
217 ipsec_spd_entry_sort);
222 (spd->ipv6_inbound_policy_discard_and_bypass_indices,
224 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
225 vec_sort_with_function
226 (spd->ipv6_inbound_policy_discard_and_bypass_indices,
227 ipsec_spd_entry_sort);
232 if (policy->policy == IPSEC_POLICY_ACTION_PROTECT)
234 vec_add1 (spd->ipv4_inbound_protect_policy_indices,
236 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
237 vec_sort_with_function
238 (spd->ipv4_inbound_protect_policy_indices,
239 ipsec_spd_entry_sort);
244 (spd->ipv4_inbound_policy_discard_and_bypass_indices,
246 clib_memcpy (vp, policy, sizeof (ipsec_policy_t));
247 vec_sort_with_function
248 (spd->ipv4_inbound_policy_discard_and_bypass_indices,
249 ipsec_spd_entry_sort);
259 pool_foreach_index(i, spd->policies, ({
260 vp = pool_elt_at_index(spd->policies, i);
261 if (vp->priority != policy->priority)
263 if (vp->is_outbound != policy->is_outbound)
265 if (vp->policy != policy->policy)
267 if (vp->sa_id != policy->sa_id)
269 if (vp->protocol != policy->protocol)
271 if (vp->lport.start != policy->lport.start)
273 if (vp->lport.stop != policy->lport.stop)
275 if (vp->rport.start != policy->rport.start)
277 if (vp->rport.stop != policy->rport.stop)
279 if (vp->is_ipv6 != policy->is_ipv6)
283 if (vp->laddr.start.ip6.as_u64[0] != policy->laddr.start.ip6.as_u64[0])
285 if (vp->laddr.start.ip6.as_u64[1] != policy->laddr.start.ip6.as_u64[1])
287 if (vp->laddr.stop.ip6.as_u64[0] != policy->laddr.stop.ip6.as_u64[0])
289 if (vp->laddr.stop.ip6.as_u64[1] != policy->laddr.stop.ip6.as_u64[1])
291 if (vp->raddr.start.ip6.as_u64[0] != policy->raddr.start.ip6.as_u64[0])
293 if (vp->raddr.start.ip6.as_u64[1] != policy->raddr.start.ip6.as_u64[1])
295 if (vp->raddr.stop.ip6.as_u64[0] != policy->raddr.stop.ip6.as_u64[0])
297 if (vp->laddr.stop.ip6.as_u64[1] != policy->laddr.stop.ip6.as_u64[1])
299 if (policy->is_outbound)
301 vec_foreach_index(j, spd->ipv6_outbound_policies) {
302 if (vec_elt(spd->ipv6_outbound_policies, j) == i) {
303 vec_del1 (spd->ipv6_outbound_policies, j);
310 if (policy->policy == IPSEC_POLICY_ACTION_PROTECT)
312 vec_foreach_index(j, spd->ipv6_inbound_protect_policy_indices) {
313 if (vec_elt(spd->ipv6_inbound_protect_policy_indices, j) == i) {
314 vec_del1 (spd->ipv6_inbound_protect_policy_indices, j);
321 vec_foreach_index(j, spd->ipv6_inbound_policy_discard_and_bypass_indices) {
322 if (vec_elt(spd->ipv6_inbound_policy_discard_and_bypass_indices, j) == i) {
323 vec_del1 (spd->ipv6_inbound_policy_discard_and_bypass_indices, j);
332 if (vp->laddr.start.ip4.as_u32 != policy->laddr.start.ip4.as_u32)
334 if (vp->laddr.stop.ip4.as_u32 != policy->laddr.stop.ip4.as_u32)
336 if (vp->raddr.start.ip4.as_u32 != policy->raddr.start.ip4.as_u32)
338 if (vp->raddr.stop.ip4.as_u32 != policy->raddr.stop.ip4.as_u32)
340 if (policy->is_outbound)
342 vec_foreach_index(j, spd->ipv4_outbound_policies) {
343 if (vec_elt(spd->ipv4_outbound_policies, j) == i) {
344 vec_del1 (spd->ipv4_outbound_policies, j);
351 if (policy->policy == IPSEC_POLICY_ACTION_PROTECT)
353 vec_foreach_index(j, spd->ipv4_inbound_protect_policy_indices) {
354 if (vec_elt(spd->ipv4_inbound_protect_policy_indices, j) == i) {
355 vec_del1 (spd->ipv4_inbound_protect_policy_indices, j);
362 vec_foreach_index(j, spd->ipv4_inbound_policy_discard_and_bypass_indices) {
363 if (vec_elt(spd->ipv4_inbound_policy_discard_and_bypass_indices, j) == i) {
364 vec_del1 (spd->ipv4_inbound_policy_discard_and_bypass_indices, j);
370 pool_put (spd->policies, vp);
381 ipsec_is_sa_used (u32 sa_index)
383 ipsec_main_t *im = &ipsec_main;
386 ipsec_tunnel_if_t *t;
389 pool_foreach(spd, im->spds, ({
390 pool_foreach(p, spd->policies, ({
391 if (p->policy == IPSEC_POLICY_ACTION_PROTECT)
393 if (p->sa_index == sa_index)
399 pool_foreach(t, im->tunnel_interfaces, ({
400 if (t->input_sa_index == sa_index)
402 if (t->output_sa_index == sa_index)
411 ipsec_add_del_sa (vlib_main_t * vm, ipsec_sa_t * new_sa, int is_add)
413 ipsec_main_t *im = &ipsec_main;
418 clib_warning ("id %u spi %u", new_sa->id, new_sa->spi);
420 p = hash_get (im->sa_index_by_sa_id, new_sa->id);
422 return VNET_API_ERROR_SYSCALL_ERROR_1; /* already exists */
424 return VNET_API_ERROR_SYSCALL_ERROR_1;
426 if (!is_add) /* delete */
429 sa = pool_elt_at_index (im->sad, sa_index);
430 if (ipsec_is_sa_used (sa_index))
432 clib_warning ("sa_id %u used in policy", sa->id);
433 return VNET_API_ERROR_SYSCALL_ERROR_1; /* sa used in policy */
435 hash_unset (im->sa_index_by_sa_id, sa->id);
436 if (im->cb.add_del_sa_sess_cb &&
437 im->cb.add_del_sa_sess_cb (sa_index, is_add) < 0)
438 return VNET_API_ERROR_SYSCALL_ERROR_1;
439 pool_put (im->sad, sa);
441 else /* create new SA */
443 pool_get (im->sad, sa);
444 clib_memcpy (sa, new_sa, sizeof (*sa));
445 sa_index = sa - im->sad;
446 hash_set (im->sa_index_by_sa_id, sa->id, sa_index);
447 if (im->cb.add_del_sa_sess_cb &&
448 im->cb.add_del_sa_sess_cb (sa_index, is_add) < 0)
449 return VNET_API_ERROR_SYSCALL_ERROR_1;
455 ipsec_set_sa_key (vlib_main_t * vm, ipsec_sa_t * sa_update)
457 ipsec_main_t *im = &ipsec_main;
462 p = hash_get (im->sa_index_by_sa_id, sa_update->id);
464 return VNET_API_ERROR_SYSCALL_ERROR_1; /* no such sa-id */
467 sa = pool_elt_at_index (im->sad, sa_index);
470 if (0 < sa_update->crypto_key_len)
472 clib_memcpy (sa->crypto_key, sa_update->crypto_key,
473 sa_update->crypto_key_len);
474 sa->crypto_key_len = sa_update->crypto_key_len;
478 if (0 < sa_update->integ_key_len)
480 clib_memcpy (sa->integ_key, sa_update->integ_key,
481 sa_update->integ_key_len);
482 sa->integ_key_len = sa_update->integ_key_len;
485 if (sa->crypto_key_len + sa->integ_key_len > 0)
487 if (im->cb.add_del_sa_sess_cb &&
488 im->cb.add_del_sa_sess_cb (sa_index, 0) < 0)
489 return VNET_API_ERROR_SYSCALL_ERROR_1;
496 ipsec_rand_seed (void)
505 seed_data.time = time (NULL);
506 seed_data.pid = getpid ();
507 seed_data.p = (void *) &seed_data;
509 RAND_seed ((const void *) &seed_data, sizeof (seed_data));
512 static clib_error_t *
513 ipsec_check_support (ipsec_sa_t * sa)
515 if (sa->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128)
516 return clib_error_return (0, "unsupported aes-gcm-128 crypto-alg");
517 if (sa->integ_alg == IPSEC_INTEG_ALG_NONE)
518 return clib_error_return (0, "unsupported none integ-alg");
519 if (sa->integ_alg == IPSEC_INTEG_ALG_AES_GCM_128)
520 return clib_error_return (0, "unsupported aes-gcm-128 integ-alg");
525 static clib_error_t *
526 ipsec_init (vlib_main_t * vm)
529 ipsec_main_t *im = &ipsec_main;
530 vlib_thread_main_t *tm = vlib_get_thread_main ();
535 memset (im, 0, sizeof (im[0]));
537 im->vnet_main = vnet_get_main ();
540 im->spd_index_by_spd_id = hash_create (0, sizeof (uword));
541 im->sa_index_by_sa_id = hash_create (0, sizeof (uword));
542 im->spd_index_by_sw_if_index = hash_create (0, sizeof (uword));
544 vec_validate_aligned (im->empty_buffers, tm->n_vlib_mains - 1,
545 CLIB_CACHE_LINE_BYTES);
547 node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
549 im->error_drop_node_index = node->index;
551 node = vlib_get_node_by_name (vm, (u8 *) "esp-encrypt");
553 im->esp_encrypt_node_index = node->index;
555 node = vlib_get_node_by_name (vm, (u8 *) "esp-decrypt");
557 im->esp_decrypt_node_index = node->index;
559 im->esp_encrypt_next_index = IPSEC_OUTPUT_NEXT_ESP_ENCRYPT;
560 im->esp_decrypt_next_index = IPSEC_INPUT_NEXT_ESP_DECRYPT;
562 im->cb.check_support_cb = ipsec_check_support;
564 if ((error = vlib_call_init_function (vm, ipsec_cli_init)))
567 if ((error = vlib_call_init_function (vm, ipsec_tunnel_if_init)))
572 if ((error = ikev2_init (vm)))
578 VLIB_INIT_FUNCTION (ipsec_init);
581 * fd.io coding-style-patch-verification: ON
584 * eval: (c-set-style "gnu")