2 * decap.c : IPSec tunnel decapsulation
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/feature/feature.h>
23 #include <vnet/ipsec/ipsec.h>
24 #include <vnet/ipsec/esp.h>
25 #include <vnet/ipsec/ah.h>
27 #define foreach_ipsec_input_error \
28 _(RX_PKTS, "IPSEC pkts received") \
29 _(DECRYPTION_FAILED, "IPSEC decryption failed")
33 #define _(sym,str) IPSEC_INPUT_ERROR_##sym,
34 foreach_ipsec_input_error
37 } ipsec_input_error_t;
39 static char *ipsec_input_error_strings[] = {
40 #define _(sym,string) string,
41 foreach_ipsec_input_error
53 } ipsec_input_trace_t;
55 /* packet trace format function */
57 format_ipsec_input_trace (u8 * s, va_list * args)
59 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
60 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
61 ipsec_input_trace_t *t = va_arg (*args, ipsec_input_trace_t *);
63 s = format (s, "%U: sa_id %u spd %u policy %d spi %u seq %u",
64 format_ip_protocol, t->proto, t->sa_id,
65 t->spd, t->policy_index, t->spi, t->seq);
70 always_inline ipsec_policy_t *
71 ipsec_input_protect_policy_match (ipsec_spd_t * spd, u32 sa, u32 da, u32 spi)
73 ipsec_main_t *im = &ipsec_main;
78 vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP4_INBOUND_PROTECT])
80 p = pool_elt_at_index (im->policies, *i);
81 s = pool_elt_at_index (im->sad, p->sa_index);
88 if (da != clib_net_to_host_u32 (s->tunnel_dst_addr.ip4.as_u32))
91 if (sa != clib_net_to_host_u32 (s->tunnel_src_addr.ip4.as_u32))
97 if (da < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
100 if (da > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
103 if (sa < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
106 if (sa > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
115 ip6_addr_match_range (ip6_address_t * a, ip6_address_t * la,
118 if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
119 (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
124 always_inline ipsec_policy_t *
125 ipsec6_input_protect_policy_match (ipsec_spd_t * spd,
127 ip6_address_t * da, u32 spi)
129 ipsec_main_t *im = &ipsec_main;
134 vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP6_INBOUND_PROTECT])
136 p = pool_elt_at_index (im->policies, *i);
137 s = pool_elt_at_index (im->sad, p->sa_index);
144 if (!ip6_address_is_equal (sa, &s->tunnel_src_addr.ip6))
147 if (!ip6_address_is_equal (da, &s->tunnel_dst_addr.ip6))
153 if (!ip6_addr_match_range (sa, &p->raddr.start.ip6, &p->raddr.stop.ip6))
156 if (!ip6_addr_match_range (da, &p->laddr.start.ip6, &p->laddr.stop.ip6))
164 static vlib_node_registration_t ipsec4_input_node;
166 VLIB_NODE_FN (ipsec4_input_node) (vlib_main_t * vm,
167 vlib_node_runtime_t * node,
168 vlib_frame_t * from_frame)
170 u32 n_left_from, *from, next_index, *to_next, thread_index;
171 ipsec_main_t *im = &ipsec_main;
173 from = vlib_frame_vector_args (from_frame);
174 n_left_from = from_frame->n_vectors;
175 thread_index = vm->thread_index;
177 next_index = node->cached_next_index;
179 while (n_left_from > 0)
183 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
185 while (n_left_from > 0 && n_left_to_next > 0)
192 ip4_ipsec_config_t *c0;
194 ipsec_policy_t *p0 = 0;
196 bi0 = to_next[0] = from[0];
202 b0 = vlib_get_buffer (vm, bi0);
203 b0->flags |= VNET_BUFFER_F_IS_IP4;
204 b0->flags &= ~VNET_BUFFER_F_IS_IP6;
205 c0 = vnet_feature_next_with_data (&next0, b0, sizeof (c0[0]));
207 spd0 = pool_elt_at_index (im->spds, c0->spd_index);
209 ip0 = vlib_buffer_get_current (b0);
212 (ip0->protocol == IP_PROTOCOL_IPSEC_ESP
213 || ip0->protocol == IP_PROTOCOL_UDP))
217 ("packet received from %U to %U spi %u size %u spd_id %u",
218 format_ip4_address, ip0->src_address.as_u8,
219 format_ip4_address, ip0->dst_address.as_u8,
220 clib_net_to_host_u32 (esp0->spi),
221 clib_net_to_host_u16 (ip0->length), spd0->id);
224 esp0 = (esp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
225 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_UDP))
228 (esp_header_t *) ((u8 *) esp0 + sizeof (udp_header_t));
230 /* FIXME TODO missing check whether there is enough data inside
231 * IP/UDP to contain ESP header & stuff ? */
232 p0 = ipsec_input_protect_policy_match (spd0,
242 if (PREDICT_TRUE (p0 != NULL))
244 pi0 = p0 - im->policies;
245 vlib_increment_combined_counter
246 (&ipsec_spd_policy_counters,
247 thread_index, pi0, 1,
248 clib_net_to_host_u16 (ip0->length));
250 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
251 vnet_buffer (b0)->ipsec.flags = 0;
252 next0 = im->esp4_decrypt_next_index;
253 vlib_buffer_advance (b0, ((u8 *) esp0 - (u8 *) ip0));
261 /* FIXME bypass and discard */
263 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE) &&
264 PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
266 ipsec_input_trace_t *tr =
267 vlib_add_trace (vm, node, b0, sizeof (*tr));
269 tr->proto = ip0->protocol;
271 tr->sa_id = p0->sa_id;
272 tr->spi = clib_net_to_host_u32 (esp0->spi);
273 tr->seq = clib_net_to_host_u32 (esp0->seq);
275 tr->policy_index = pi0;
279 if (PREDICT_TRUE (ip0->protocol == IP_PROTOCOL_IPSEC_AH))
281 ah0 = (ah_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
282 p0 = ipsec_input_protect_policy_match (spd0,
292 if (PREDICT_TRUE (p0 != 0))
294 pi0 = p0 - im->policies;
295 vlib_increment_combined_counter
296 (&ipsec_spd_policy_counters,
297 thread_index, pi0, 1,
298 clib_net_to_host_u16 (ip0->length));
299 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
300 vnet_buffer (b0)->ipsec.flags = 0;
301 next0 = im->ah4_decrypt_next_index;
308 /* FIXME bypass and discard */
310 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE) &&
311 PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
313 ipsec_input_trace_t *tr =
314 vlib_add_trace (vm, node, b0, sizeof (*tr));
316 tr->proto = ip0->protocol;
318 tr->sa_id = p0->sa_id;
319 tr->spi = clib_net_to_host_u32 (ah0->spi);
320 tr->seq = clib_net_to_host_u32 (ah0->seq_no);
322 tr->policy_index = pi0;
326 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
327 to_next, n_left_to_next, bi0,
330 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
332 vlib_node_increment_counter (vm, ipsec4_input_node.index,
333 IPSEC_INPUT_ERROR_RX_PKTS,
334 from_frame->n_vectors);
336 return from_frame->n_vectors;
341 VLIB_REGISTER_NODE (ipsec4_input_node,static) = {
342 .name = "ipsec4-input-feature",
343 .vector_size = sizeof (u32),
344 .format_trace = format_ipsec_input_trace,
345 .type = VLIB_NODE_TYPE_INTERNAL,
347 .n_errors = ARRAY_LEN(ipsec_input_error_strings),
348 .error_strings = ipsec_input_error_strings,
350 .n_next_nodes = IPSEC_INPUT_N_NEXT,
352 #define _(s,n) [IPSEC_INPUT_NEXT_##s] = n,
353 foreach_ipsec_input_next
359 static vlib_node_registration_t ipsec6_input_node;
362 VLIB_NODE_FN (ipsec6_input_node) (vlib_main_t * vm,
363 vlib_node_runtime_t * node,
364 vlib_frame_t * from_frame)
366 u32 n_left_from, *from, next_index, *to_next, thread_index;
367 ipsec_main_t *im = &ipsec_main;
369 from = vlib_frame_vector_args (from_frame);
370 n_left_from = from_frame->n_vectors;
371 thread_index = vm->thread_index;
373 next_index = node->cached_next_index;
375 while (n_left_from > 0)
379 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
381 while (n_left_from > 0 && n_left_to_next > 0)
387 ip4_ipsec_config_t *c0;
389 ipsec_policy_t *p0 = 0;
391 u32 header_size = sizeof (ip0[0]);
393 bi0 = to_next[0] = from[0];
399 b0 = vlib_get_buffer (vm, bi0);
400 b0->flags |= VNET_BUFFER_F_IS_IP6;
401 b0->flags &= ~VNET_BUFFER_F_IS_IP4;
402 c0 = vnet_feature_next_with_data (&next0, b0, sizeof (c0[0]));
404 spd0 = pool_elt_at_index (im->spds, c0->spd_index);
406 ip0 = vlib_buffer_get_current (b0);
407 esp0 = (esp_header_t *) ((u8 *) ip0 + header_size);
408 ah0 = (ah_header_t *) ((u8 *) ip0 + header_size);
410 if (PREDICT_TRUE (ip0->protocol == IP_PROTOCOL_IPSEC_ESP))
414 ("packet received from %U to %U spi %u size %u spd_id %u",
415 format_ip6_address, &ip0->src_address, format_ip6_address,
416 &ip0->dst_address, clib_net_to_host_u32 (esp0->spi),
417 clib_net_to_host_u16 (ip0->payload_length) + header_size,
420 p0 = ipsec6_input_protect_policy_match (spd0,
426 if (PREDICT_TRUE (p0 != 0))
428 pi0 = p0 - im->policies;
429 vlib_increment_combined_counter
430 (&ipsec_spd_policy_counters,
431 thread_index, pi0, 1,
432 clib_net_to_host_u16 (ip0->payload_length) +
434 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
435 vnet_buffer (b0)->ipsec.flags = 0;
436 next0 = im->esp6_decrypt_next_index;
437 vlib_buffer_advance (b0, header_size);
445 else if (ip0->protocol == IP_PROTOCOL_IPSEC_AH)
447 p0 = ipsec6_input_protect_policy_match (spd0,
453 if (PREDICT_TRUE (p0 != 0))
455 pi0 = p0 - im->policies;
456 vlib_increment_combined_counter
457 (&ipsec_spd_policy_counters,
458 thread_index, pi0, 1,
459 clib_net_to_host_u16 (ip0->payload_length) +
461 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
462 vnet_buffer (b0)->ipsec.flags = 0;
463 next0 = im->ah6_decrypt_next_index;
473 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE) &&
474 PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
476 ipsec_input_trace_t *tr =
477 vlib_add_trace (vm, node, b0, sizeof (*tr));
480 tr->sa_id = p0->sa_id;
481 tr->proto = ip0->protocol;
482 tr->spi = clib_net_to_host_u32 (esp0->spi);
483 tr->seq = clib_net_to_host_u32 (esp0->seq);
487 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
488 n_left_to_next, bi0, next0);
490 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
492 vlib_node_increment_counter (vm, ipsec6_input_node.index,
493 IPSEC_INPUT_ERROR_RX_PKTS,
494 from_frame->n_vectors);
496 return from_frame->n_vectors;
501 VLIB_REGISTER_NODE (ipsec6_input_node,static) = {
502 .name = "ipsec6-input-feature",
503 .vector_size = sizeof (u32),
504 .format_trace = format_ipsec_input_trace,
505 .type = VLIB_NODE_TYPE_INTERNAL,
507 .n_errors = ARRAY_LEN(ipsec_input_error_strings),
508 .error_strings = ipsec_input_error_strings,
510 .sibling_of = "ipsec4-input-feature",
515 * fd.io coding-style-patch-verification: ON
518 * eval: (c-set-style "gnu")