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
51 } ipsec_input_trace_t;
53 /* packet trace format function */
55 format_ipsec_input_trace (u8 * s, va_list * args)
57 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
58 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
59 ipsec_input_trace_t *t = va_arg (*args, ipsec_input_trace_t *);
61 if (t->spi == 0 && t->seq == 0)
63 s = format (s, "esp: no esp packet");
70 format (s, "esp: sa_id %u spd %u spi %u seq %u", t->sa_id, t->spd,
76 format (s, "esp: no sa spd %u spi %u seq %u", t->spd, t->spi, t->seq);
81 always_inline ipsec_policy_t *
82 ipsec_input_protect_policy_match (ipsec_spd_t * spd, u32 sa, u32 da, u32 spi)
84 ipsec_main_t *im = &ipsec_main;
89 vec_foreach (i, spd->ipv4_inbound_protect_policy_indices)
91 p = pool_elt_at_index (spd->policies, *i);
92 s = pool_elt_at_index (im->sad, p->sa_index);
99 if (da != clib_net_to_host_u32 (s->tunnel_dst_addr.ip4.as_u32))
102 if (sa != clib_net_to_host_u32 (s->tunnel_src_addr.ip4.as_u32))
108 if (da < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
111 if (da > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
114 if (sa < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
117 if (sa > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
126 ip6_addr_match_range (ip6_address_t * a, ip6_address_t * la,
129 if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
130 (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
135 always_inline ipsec_policy_t *
136 ipsec6_input_protect_policy_match (ipsec_spd_t * spd,
138 ip6_address_t * da, u32 spi)
140 ipsec_main_t *im = &ipsec_main;
145 vec_foreach (i, spd->ipv6_inbound_protect_policy_indices)
147 p = pool_elt_at_index (spd->policies, *i);
148 s = pool_elt_at_index (im->sad, p->sa_index);
155 if (!ip6_address_is_equal (sa, &s->tunnel_src_addr.ip6))
158 if (!ip6_address_is_equal (da, &s->tunnel_dst_addr.ip6))
164 if (!ip6_addr_match_range (sa, &p->raddr.start.ip6, &p->raddr.stop.ip6))
167 if (!ip6_addr_match_range (da, &p->laddr.start.ip6, &p->laddr.stop.ip6))
175 static vlib_node_registration_t ipsec4_input_node;
177 VLIB_NODE_FN (ipsec4_input_node) (vlib_main_t * vm,
178 vlib_node_runtime_t * node,
179 vlib_frame_t * from_frame)
181 u32 n_left_from, *from, next_index, *to_next;
182 ipsec_main_t *im = &ipsec_main;
184 from = vlib_frame_vector_args (from_frame);
185 n_left_from = from_frame->n_vectors;
187 next_index = node->cached_next_index;
189 while (n_left_from > 0)
193 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
195 while (n_left_from > 0 && n_left_to_next > 0)
202 ip4_ipsec_config_t *c0;
204 ipsec_policy_t *p0 = 0;
206 bi0 = to_next[0] = from[0];
212 b0 = vlib_get_buffer (vm, bi0);
213 b0->flags |= VNET_BUFFER_F_IS_IP4;
214 b0->flags &= ~VNET_BUFFER_F_IS_IP6;
215 c0 = vnet_feature_next_with_data (&next0, b0, sizeof (c0[0]));
217 spd0 = pool_elt_at_index (im->spds, c0->spd_index);
219 ip0 = vlib_buffer_get_current (b0);
222 (ip0->protocol == IP_PROTOCOL_IPSEC_ESP
223 || ip0->protocol == IP_PROTOCOL_UDP))
227 ("packet received from %U to %U spi %u size %u spd_id %u",
228 format_ip4_address, ip0->src_address.as_u8,
229 format_ip4_address, ip0->dst_address.as_u8,
230 clib_net_to_host_u32 (esp0->spi),
231 clib_net_to_host_u16 (ip0->length), spd0->id);
234 esp0 = (esp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
235 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_UDP))
238 (esp_header_t *) ((u8 *) esp0 + sizeof (udp_header_t));
240 /* FIXME TODO missing check whether there is enough data inside
241 * IP/UDP to contain ESP header & stuff ? */
242 p0 = ipsec_input_protect_policy_match (spd0,
252 if (PREDICT_TRUE (p0 != 0))
254 p0->counter.packets++;
255 p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
256 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
257 vnet_buffer (b0)->ipsec.flags = 0;
258 next0 = im->esp4_decrypt_next_index;
259 vlib_buffer_advance (b0, ((u8 *) esp0 - (u8 *) ip0));
263 /* FIXME bypass and discard */
265 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
267 ipsec_input_trace_t *tr =
268 vlib_add_trace (vm, node, b0, sizeof (*tr));
269 if (ip0->protocol == IP_PROTOCOL_IPSEC_ESP ||
270 ip0->protocol == IP_PROTOCOL_UDP)
273 tr->sa_id = p0->sa_id;
274 tr->spi = clib_host_to_net_u32 (esp0->spi);
275 tr->seq = clib_host_to_net_u32 (esp0->seq);
283 if (PREDICT_TRUE (ip0->protocol == IP_PROTOCOL_IPSEC_AH))
285 ah0 = (ah_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
286 p0 = ipsec_input_protect_policy_match (spd0,
296 if (PREDICT_TRUE (p0 != 0))
298 p0->counter.packets++;
299 p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
300 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
301 vnet_buffer (b0)->ipsec.flags = 0;
302 next0 = im->ah4_decrypt_next_index;
305 /* FIXME bypass and discard */
307 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
309 ipsec_input_trace_t *tr =
310 vlib_add_trace (vm, node, b0, sizeof (*tr));
311 if (ip0->protocol == IP_PROTOCOL_IPSEC_ESP)
314 tr->sa_id = p0->sa_id;
315 tr->spi = clib_host_to_net_u32 (ah0->spi);
316 tr->seq = clib_host_to_net_u32 (ah0->seq_no);
322 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
323 to_next, n_left_to_next, bi0,
326 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
328 vlib_node_increment_counter (vm, ipsec4_input_node.index,
329 IPSEC_INPUT_ERROR_RX_PKTS,
330 from_frame->n_vectors);
332 return from_frame->n_vectors;
337 VLIB_REGISTER_NODE (ipsec4_input_node,static) = {
338 .name = "ipsec4-input-feature",
339 .vector_size = sizeof (u32),
340 .format_trace = format_ipsec_input_trace,
341 .type = VLIB_NODE_TYPE_INTERNAL,
343 .n_errors = ARRAY_LEN(ipsec_input_error_strings),
344 .error_strings = ipsec_input_error_strings,
346 .n_next_nodes = IPSEC_INPUT_N_NEXT,
348 #define _(s,n) [IPSEC_INPUT_NEXT_##s] = n,
349 foreach_ipsec_input_next
355 static vlib_node_registration_t ipsec6_input_node;
358 VLIB_NODE_FN (ipsec6_input_node) (vlib_main_t * vm,
359 vlib_node_runtime_t * node,
360 vlib_frame_t * from_frame)
362 u32 n_left_from, *from, next_index, *to_next;
363 ipsec_main_t *im = &ipsec_main;
365 from = vlib_frame_vector_args (from_frame);
366 n_left_from = from_frame->n_vectors;
368 next_index = node->cached_next_index;
370 while (n_left_from > 0)
374 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
376 while (n_left_from > 0 && n_left_to_next > 0)
382 ip4_ipsec_config_t *c0;
384 ipsec_policy_t *p0 = 0;
386 u32 header_size = sizeof (ip0[0]);
388 bi0 = to_next[0] = from[0];
394 b0 = vlib_get_buffer (vm, bi0);
395 b0->flags |= VNET_BUFFER_F_IS_IP6;
396 b0->flags &= ~VNET_BUFFER_F_IS_IP4;
397 c0 = vnet_feature_next_with_data (&next0, b0, sizeof (c0[0]));
399 spd0 = pool_elt_at_index (im->spds, c0->spd_index);
401 ip0 = vlib_buffer_get_current (b0);
402 esp0 = (esp_header_t *) ((u8 *) ip0 + header_size);
403 ah0 = (ah_header_t *) ((u8 *) ip0 + header_size);
405 if (PREDICT_TRUE (ip0->protocol == IP_PROTOCOL_IPSEC_ESP))
409 ("packet received from %U to %U spi %u size %u spd_id %u",
410 format_ip6_address, &ip0->src_address, format_ip6_address,
411 &ip0->dst_address, clib_net_to_host_u32 (esp0->spi),
412 clib_net_to_host_u16 (ip0->payload_length) + header_size,
415 p0 = ipsec6_input_protect_policy_match (spd0,
421 if (PREDICT_TRUE (p0 != 0))
423 p0->counter.packets++;
425 clib_net_to_host_u16 (ip0->payload_length);
426 p0->counter.bytes += header_size;
427 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
428 vnet_buffer (b0)->ipsec.flags = 0;
429 next0 = im->esp6_decrypt_next_index;
430 vlib_buffer_advance (b0, header_size);
434 else if (ip0->protocol == IP_PROTOCOL_IPSEC_AH)
436 p0 = ipsec6_input_protect_policy_match (spd0,
442 if (PREDICT_TRUE (p0 != 0))
444 p0->counter.packets++;
446 clib_net_to_host_u16 (ip0->payload_length);
447 p0->counter.bytes += header_size;
448 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
449 vnet_buffer (b0)->ipsec.flags = 0;
450 next0 = im->ah6_decrypt_next_index;
456 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
458 ipsec_input_trace_t *tr =
459 vlib_add_trace (vm, node, b0, sizeof (*tr));
460 if (ip0->protocol == IP_PROTOCOL_IPSEC_ESP)
463 tr->sa_id = p0->sa_id;
464 tr->spi = clib_host_to_net_u32 (esp0->spi);
465 tr->seq = clib_host_to_net_u32 (esp0->seq);
470 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
471 n_left_to_next, bi0, next0);
473 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
475 vlib_node_increment_counter (vm, ipsec6_input_node.index,
476 IPSEC_INPUT_ERROR_RX_PKTS,
477 from_frame->n_vectors);
479 return from_frame->n_vectors;
484 VLIB_REGISTER_NODE (ipsec6_input_node,static) = {
485 .name = "ipsec6-input-feature",
486 .vector_size = sizeof (u32),
487 .format_trace = format_ipsec_input_trace,
488 .type = VLIB_NODE_TYPE_INTERNAL,
490 .n_errors = ARRAY_LEN(ipsec_input_error_strings),
491 .error_strings = ipsec_input_error_strings,
493 .sibling_of = "ipsec4-input-feature",
498 * fd.io coding-style-patch-verification: ON
501 * eval: (c-set-style "gnu")