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>
26 #define foreach_ipsec_input_error \
27 _(RX_PKTS, "IPSEC pkts received") \
28 _(DECRYPTION_FAILED, "IPSEC decryption failed")
32 #define _(sym,str) IPSEC_INPUT_ERROR_##sym,
33 foreach_ipsec_input_error
36 } ipsec_input_error_t;
38 static char *ipsec_input_error_strings[] = {
39 #define _(sym,string) string,
40 foreach_ipsec_input_error
49 } ipsec_input_trace_t;
51 /* packet trace format function */
53 format_ipsec_input_trace (u8 * s, va_list * args)
55 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
56 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
57 ipsec_input_trace_t *t = va_arg (*args, ipsec_input_trace_t *);
59 if (t->spi == 0 && t->seq == 0)
61 s = format (s, "esp: no esp packet");
67 s = format (s, "esp: sa_id %u spi %u seq %u", t->sa_id, t->spi, t->seq);
71 s = format (s, "esp: no sa spi %u seq %u", t->spi, t->seq);
76 always_inline ipsec_policy_t *
77 ipsec_input_protect_policy_match (ipsec_spd_t * spd, u32 sa, u32 da, u32 spi)
79 ipsec_main_t *im = &ipsec_main;
84 vec_foreach (i, spd->ipv4_inbound_protect_policy_indices)
86 p = pool_elt_at_index (spd->policies, *i);
87 s = pool_elt_at_index (im->sad, p->sa_index);
94 if (da != clib_net_to_host_u32 (s->tunnel_dst_addr.ip4.as_u32))
97 if (sa != clib_net_to_host_u32 (s->tunnel_src_addr.ip4.as_u32))
103 if (da < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
106 if (da > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
109 if (sa < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
112 if (sa > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
121 ip6_addr_match_range (ip6_address_t * a, ip6_address_t * la,
124 if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
125 (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
130 always_inline ipsec_policy_t *
131 ipsec_input_ip6_protect_policy_match (ipsec_spd_t * spd,
133 ip6_address_t * da, u32 spi)
135 ipsec_main_t *im = &ipsec_main;
140 vec_foreach (i, spd->ipv6_inbound_protect_policy_indices)
142 p = pool_elt_at_index (spd->policies, *i);
143 s = pool_elt_at_index (im->sad, p->sa_index);
150 if (!ip6_address_is_equal (sa, &s->tunnel_src_addr.ip6))
153 if (!ip6_address_is_equal (da, &s->tunnel_dst_addr.ip6))
159 if (!ip6_addr_match_range (sa, &p->raddr.start.ip6, &p->raddr.stop.ip6))
162 if (!ip6_addr_match_range (da, &p->laddr.start.ip6, &p->laddr.stop.ip6))
170 static vlib_node_registration_t ipsec_input_ip4_node;
173 ipsec_input_ip4_node_fn (vlib_main_t * vm,
174 vlib_node_runtime_t * node,
175 vlib_frame_t * from_frame)
177 u32 n_left_from, *from, next_index, *to_next;
178 ipsec_main_t *im = &ipsec_main;
180 from = vlib_frame_vector_args (from_frame);
181 n_left_from = from_frame->n_vectors;
183 next_index = node->cached_next_index;
185 while (n_left_from > 0)
189 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
191 while (n_left_from > 0 && n_left_to_next > 0)
197 ip4_ipsec_config_t *c0;
199 ipsec_policy_t *p0 = 0;
201 bi0 = to_next[0] = from[0];
207 b0 = vlib_get_buffer (vm, bi0);
209 vnet_feature_next_with_data (vnet_buffer (b0)->sw_if_index
210 [VLIB_RX], &next0, b0,
213 spd0 = pool_elt_at_index (im->spds, c0->spd_index);
215 ip0 = vlib_buffer_get_current (b0);
216 esp0 = (esp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
218 if (PREDICT_TRUE (ip0->protocol == IP_PROTOCOL_IPSEC_ESP))
222 ("packet received from %U to %U spi %u size %u spd_id %u",
223 format_ip4_address, ip0->src_address.as_u8,
224 format_ip4_address, ip0->dst_address.as_u8,
225 clib_net_to_host_u32 (esp0->spi),
226 clib_net_to_host_u16 (ip0->length), spd0->id);
229 p0 = ipsec_input_protect_policy_match (spd0,
239 if (PREDICT_TRUE (p0 != 0))
241 p0->counter.packets++;
242 p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
243 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
244 vnet_buffer (b0)->ipsec.flags = 0;
245 next0 = im->esp_decrypt_next_index;
246 vlib_buffer_advance (b0, ip4_header_bytes (ip0));
251 /* FIXME bypass and discard */
254 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
256 ipsec_input_trace_t *tr =
257 vlib_add_trace (vm, node, b0, sizeof (*tr));
258 if (ip0->protocol == IP_PROTOCOL_IPSEC_ESP)
261 tr->sa_id = p0->sa_id;
262 tr->spi = clib_host_to_net_u32 (esp0->spi);
263 tr->seq = clib_host_to_net_u32 (esp0->seq);
267 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
268 to_next, n_left_to_next, bi0,
271 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
273 vlib_node_increment_counter (vm, ipsec_input_ip4_node.index,
274 IPSEC_INPUT_ERROR_RX_PKTS,
275 from_frame->n_vectors);
277 return from_frame->n_vectors;
282 VLIB_REGISTER_NODE (ipsec_input_ip4_node,static) = {
283 .function = ipsec_input_ip4_node_fn,
284 .name = "ipsec-input-ip4",
285 .vector_size = sizeof (u32),
286 .format_trace = format_ipsec_input_trace,
287 .type = VLIB_NODE_TYPE_INTERNAL,
289 .n_errors = ARRAY_LEN(ipsec_input_error_strings),
290 .error_strings = ipsec_input_error_strings,
292 .n_next_nodes = IPSEC_INPUT_N_NEXT,
294 #define _(s,n) [IPSEC_INPUT_NEXT_##s] = n,
295 foreach_ipsec_input_next
301 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_input_ip4_node, ipsec_input_ip4_node_fn)
302 static vlib_node_registration_t ipsec_input_ip6_node;
305 ipsec_input_ip6_node_fn (vlib_main_t * vm,
306 vlib_node_runtime_t * node,
307 vlib_frame_t * from_frame)
309 u32 n_left_from, *from, next_index, *to_next;
310 ipsec_main_t *im = &ipsec_main;
312 from = vlib_frame_vector_args (from_frame);
313 n_left_from = from_frame->n_vectors;
315 next_index = node->cached_next_index;
317 while (n_left_from > 0)
321 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
323 while (n_left_from > 0 && n_left_to_next > 0)
329 ip4_ipsec_config_t *c0;
331 ipsec_policy_t *p0 = 0;
332 u32 header_size = sizeof (ip0[0]);
334 bi0 = to_next[0] = from[0];
340 b0 = vlib_get_buffer (vm, bi0);
342 vnet_feature_next_with_data (vnet_buffer (b0)->sw_if_index
343 [VLIB_RX], &next0, b0,
346 spd0 = pool_elt_at_index (im->spds, c0->spd_index);
348 ip0 = vlib_buffer_get_current (b0);
349 esp0 = (esp_header_t *) ((u8 *) ip0 + header_size);
351 if (PREDICT_TRUE (ip0->protocol == IP_PROTOCOL_IPSEC_ESP))
355 ("packet received from %U to %U spi %u size %u spd_id %u",
356 format_ip6_address, &ip0->src_address, format_ip6_address,
357 &ip0->dst_address, clib_net_to_host_u32 (esp0->spi),
358 clib_net_to_host_u16 (ip0->payload_length) + header_size,
361 p0 = ipsec_input_ip6_protect_policy_match (spd0,
367 if (PREDICT_TRUE (p0 != 0))
369 p0->counter.packets++;
371 clib_net_to_host_u16 (ip0->payload_length);
372 p0->counter.bytes += header_size;
373 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
374 vnet_buffer (b0)->ipsec.flags = 0;
375 next0 = im->esp_decrypt_next_index;
376 vlib_buffer_advance (b0, header_size);
382 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
384 ipsec_input_trace_t *tr =
385 vlib_add_trace (vm, node, b0, sizeof (*tr));
386 if (ip0->protocol == IP_PROTOCOL_IPSEC_ESP)
389 tr->sa_id = p0->sa_id;
390 tr->spi = clib_host_to_net_u32 (esp0->spi);
391 tr->seq = clib_host_to_net_u32 (esp0->seq);
395 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
396 n_left_to_next, bi0, next0);
398 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
400 vlib_node_increment_counter (vm, ipsec_input_ip6_node.index,
401 IPSEC_INPUT_ERROR_RX_PKTS,
402 from_frame->n_vectors);
404 return from_frame->n_vectors;
409 VLIB_REGISTER_NODE (ipsec_input_ip6_node,static) = {
410 .function = ipsec_input_ip6_node_fn,
411 .name = "ipsec-input-ip6",
412 .vector_size = sizeof (u32),
413 .format_trace = format_ipsec_input_trace,
414 .type = VLIB_NODE_TYPE_INTERNAL,
416 .n_errors = ARRAY_LEN(ipsec_input_error_strings),
417 .error_strings = ipsec_input_error_strings,
419 .sibling_of = "ipsec-input-ip4",
423 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_input_ip6_node, ipsec_input_ip6_node_fn)
425 * fd.io coding-style-patch-verification: ON
428 * eval: (c-set-style "gnu")