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>
27 #define ESP_NODE "dpdk-esp-decrypt"
29 #define ESP_NODE "esp-decrypt"
32 #define foreach_ipsec_input_next \
33 _(DROP, "error-drop") \
34 _(ESP_DECRYPT, ESP_NODE)
36 #define _(v, s) IPSEC_INPUT_NEXT_##v,
39 foreach_ipsec_input_next
45 #define foreach_ipsec_input_error \
46 _(RX_PKTS, "IPSEC pkts received") \
47 _(DECRYPTION_FAILED, "IPSEC decryption failed")
52 #define _(sym,str) IPSEC_INPUT_ERROR_##sym,
53 foreach_ipsec_input_error
56 } ipsec_input_error_t;
58 static char *ipsec_input_error_strings[] = {
59 #define _(sym,string) string,
60 foreach_ipsec_input_error
69 } ipsec_input_trace_t;
71 /* packet trace format function */
73 format_ipsec_input_trace (u8 * s, va_list * args)
75 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
76 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
77 ipsec_input_trace_t *t = va_arg (*args, ipsec_input_trace_t *);
79 if (t->spi == 0 && t->seq == 0)
81 s = format (s, "esp: no esp packet");
87 s = format (s, "esp: sa_id %u spi %u seq %u", t->sa_id, t->spi, t->seq);
91 s = format (s, "esp: no sa spi %u seq %u", t->spi, t->seq);
96 always_inline ipsec_policy_t *
97 ipsec_input_protect_policy_match (ipsec_spd_t * spd, u32 sa, u32 da, u32 spi)
99 ipsec_main_t *im = &ipsec_main;
104 vec_foreach (i, spd->ipv4_inbound_protect_policy_indices)
106 p = pool_elt_at_index (spd->policies, *i);
107 s = pool_elt_at_index (im->sad, p->sa_index);
114 if (da != clib_net_to_host_u32 (s->tunnel_dst_addr.ip4.as_u32))
117 if (sa != clib_net_to_host_u32 (s->tunnel_src_addr.ip4.as_u32))
123 if (da < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
126 if (da > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
129 if (sa < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
132 if (sa > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
141 ip6_addr_match_range (ip6_address_t * a, ip6_address_t * la,
144 if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
145 (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
150 always_inline ipsec_policy_t *
151 ipsec_input_ip6_protect_policy_match (ipsec_spd_t * spd,
153 ip6_address_t * da, u32 spi)
155 ipsec_main_t *im = &ipsec_main;
160 vec_foreach (i, spd->ipv6_inbound_protect_policy_indices)
162 p = pool_elt_at_index (spd->policies, *i);
163 s = pool_elt_at_index (im->sad, p->sa_index);
170 if (!ip6_address_is_equal (sa, &s->tunnel_src_addr.ip6))
173 if (!ip6_address_is_equal (da, &s->tunnel_dst_addr.ip6))
179 if (!ip6_addr_match_range (sa, &p->raddr.start.ip6, &p->raddr.stop.ip6))
182 if (!ip6_addr_match_range (da, &p->laddr.start.ip6, &p->laddr.stop.ip6))
190 static vlib_node_registration_t ipsec_input_ip4_node;
193 ipsec_input_ip4_node_fn (vlib_main_t * vm,
194 vlib_node_runtime_t * node,
195 vlib_frame_t * from_frame)
197 u32 n_left_from, *from, next_index, *to_next;
198 ipsec_main_t *im = &ipsec_main;
200 from = vlib_frame_vector_args (from_frame);
201 n_left_from = from_frame->n_vectors;
203 next_index = node->cached_next_index;
205 while (n_left_from > 0)
209 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
211 while (n_left_from > 0 && n_left_to_next > 0)
217 ip4_ipsec_config_t *c0;
219 ipsec_policy_t *p0 = 0;
221 bi0 = to_next[0] = from[0];
227 b0 = vlib_get_buffer (vm, bi0);
229 vnet_feature_next_with_data (vnet_buffer (b0)->sw_if_index
230 [VLIB_RX], &next0, b0,
233 spd0 = pool_elt_at_index (im->spds, c0->spd_index);
235 ip0 = vlib_buffer_get_current (b0);
236 esp0 = (esp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
238 if (PREDICT_TRUE (ip0->protocol == IP_PROTOCOL_IPSEC_ESP))
242 ("packet received from %U to %U spi %u size %u spd_id %u",
243 format_ip4_address, ip0->src_address.as_u8,
244 format_ip4_address, ip0->dst_address.as_u8,
245 clib_net_to_host_u32 (esp0->spi),
246 clib_net_to_host_u16 (ip0->length), spd0->id);
249 p0 = ipsec_input_protect_policy_match (spd0,
259 if (PREDICT_TRUE (p0 != 0))
261 p0->counter.packets++;
262 p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
263 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
264 vnet_buffer (b0)->ipsec.flags = 0;
265 next0 = IPSEC_INPUT_NEXT_ESP_DECRYPT;
266 vlib_buffer_advance (b0, ip4_header_bytes (ip0));
271 /* FIXME bypass and discard */
274 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
276 ipsec_input_trace_t *tr =
277 vlib_add_trace (vm, node, b0, sizeof (*tr));
278 if (ip0->protocol == IP_PROTOCOL_IPSEC_ESP)
281 tr->sa_id = p0->sa_id;
282 tr->spi = clib_host_to_net_u32 (esp0->spi);
283 tr->seq = clib_host_to_net_u32 (esp0->seq);
287 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
288 to_next, n_left_to_next, bi0,
291 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
293 vlib_node_increment_counter (vm, ipsec_input_ip4_node.index,
294 IPSEC_INPUT_ERROR_RX_PKTS,
295 from_frame->n_vectors);
297 return from_frame->n_vectors;
302 VLIB_REGISTER_NODE (ipsec_input_ip4_node,static) = {
303 .function = ipsec_input_ip4_node_fn,
304 .name = "ipsec-input-ip4",
305 .vector_size = sizeof (u32),
306 .format_trace = format_ipsec_input_trace,
307 .type = VLIB_NODE_TYPE_INTERNAL,
309 .n_errors = ARRAY_LEN(ipsec_input_error_strings),
310 .error_strings = ipsec_input_error_strings,
312 .n_next_nodes = IPSEC_INPUT_N_NEXT,
314 #define _(s,n) [IPSEC_INPUT_NEXT_##s] = n,
315 foreach_ipsec_input_next
321 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_input_ip4_node, ipsec_input_ip4_node_fn)
322 static vlib_node_registration_t ipsec_input_ip6_node;
325 ipsec_input_ip6_node_fn (vlib_main_t * vm,
326 vlib_node_runtime_t * node,
327 vlib_frame_t * from_frame)
329 u32 n_left_from, *from, next_index, *to_next;
330 ipsec_main_t *im = &ipsec_main;
332 from = vlib_frame_vector_args (from_frame);
333 n_left_from = from_frame->n_vectors;
335 next_index = node->cached_next_index;
337 while (n_left_from > 0)
341 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
343 while (n_left_from > 0 && n_left_to_next > 0)
349 ip4_ipsec_config_t *c0;
351 ipsec_policy_t *p0 = 0;
352 u32 header_size = sizeof (ip0[0]);
354 bi0 = to_next[0] = from[0];
360 b0 = vlib_get_buffer (vm, bi0);
362 vnet_feature_next_with_data (vnet_buffer (b0)->sw_if_index
363 [VLIB_RX], &next0, b0,
366 spd0 = pool_elt_at_index (im->spds, c0->spd_index);
368 ip0 = vlib_buffer_get_current (b0);
369 esp0 = (esp_header_t *) ((u8 *) ip0 + header_size);
371 if (PREDICT_TRUE (ip0->protocol == IP_PROTOCOL_IPSEC_ESP))
375 ("packet received from %U to %U spi %u size %u spd_id %u",
376 format_ip6_address, &ip0->src_address, format_ip6_address,
377 &ip0->dst_address, clib_net_to_host_u32 (esp0->spi),
378 clib_net_to_host_u16 (ip0->payload_length) + header_size,
381 p0 = ipsec_input_ip6_protect_policy_match (spd0,
387 if (PREDICT_TRUE (p0 != 0))
389 p0->counter.packets++;
391 clib_net_to_host_u16 (ip0->payload_length);
392 p0->counter.bytes += header_size;
393 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
394 vnet_buffer (b0)->ipsec.flags = 0;
395 next0 = IPSEC_INPUT_NEXT_ESP_DECRYPT;
396 vlib_buffer_advance (b0, header_size);
402 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
404 ipsec_input_trace_t *tr =
405 vlib_add_trace (vm, node, b0, sizeof (*tr));
406 if (ip0->protocol == IP_PROTOCOL_IPSEC_ESP)
409 tr->sa_id = p0->sa_id;
410 tr->spi = clib_host_to_net_u32 (esp0->spi);
411 tr->seq = clib_host_to_net_u32 (esp0->seq);
415 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
416 n_left_to_next, bi0, next0);
418 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
420 vlib_node_increment_counter (vm, ipsec_input_ip6_node.index,
421 IPSEC_INPUT_ERROR_RX_PKTS,
422 from_frame->n_vectors);
424 return from_frame->n_vectors;
429 VLIB_REGISTER_NODE (ipsec_input_ip6_node,static) = {
430 .function = ipsec_input_ip6_node_fn,
431 .name = "ipsec-input-ip6",
432 .vector_size = sizeof (u32),
433 .format_trace = format_ipsec_input_trace,
434 .type = VLIB_NODE_TYPE_INTERNAL,
436 .n_errors = ARRAY_LEN(ipsec_input_error_strings),
437 .error_strings = ipsec_input_error_strings,
439 .n_next_nodes = IPSEC_INPUT_N_NEXT,
441 #define _(s,n) [IPSEC_INPUT_NEXT_##s] = n,
442 foreach_ipsec_input_next
448 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_input_ip6_node, ipsec_input_ip6_node_fn)
450 * fd.io coding-style-patch-verification: ON
453 * eval: (c-set-style "gnu")