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>
26 #include <vnet/ipsec/ipsec_io.h>
28 #define foreach_ipsec_input_error \
29 _(RX_PKTS, "IPSec pkts received") \
30 _(RX_POLICY_MATCH, "IPSec policy match") \
31 _(RX_POLICY_NO_MATCH, "IPSec policy not matched") \
32 _(RX_POLICY_BYPASS, "IPSec policy bypass") \
33 _(RX_POLICY_DISCARD, "IPSec policy discard")
37 #define _(sym,str) IPSEC_INPUT_ERROR_##sym,
38 foreach_ipsec_input_error
41 } ipsec_input_error_t;
43 static char *ipsec_input_error_strings[] = {
44 #define _(sym,string) string,
45 foreach_ipsec_input_error
57 } ipsec_input_trace_t;
59 /* packet trace format function */
61 format_ipsec_input_trace (u8 * s, va_list * args)
63 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
64 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
65 ipsec_input_trace_t *t = va_arg (*args, ipsec_input_trace_t *);
67 s = format (s, "%U: sa_id %u spd %u policy %d spi %u (0x%08x) seq %u",
68 format_ip_protocol, t->proto, t->sa_id,
69 t->spd, t->policy_index, t->spi, t->spi, t->seq);
74 always_inline ipsec_policy_t *
75 ipsec_input_policy_match (ipsec_spd_t * spd, u32 sa, u32 da,
76 ipsec_spd_policy_type_t policy_type)
78 ipsec_main_t *im = &ipsec_main;
82 vec_foreach (i, spd->policies[policy_type])
84 p = pool_elt_at_index (im->policies, *i);
86 if (da < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
89 if (da > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
92 if (sa < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
95 if (sa > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
103 always_inline ipsec_policy_t *
104 ipsec_input_protect_policy_match (ipsec_spd_t * spd, u32 sa, u32 da, u32 spi)
106 ipsec_main_t *im = &ipsec_main;
111 vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP4_INBOUND_PROTECT])
113 p = pool_elt_at_index (im->policies, *i);
114 s = ipsec_sa_get (p->sa_index);
119 if (ipsec_sa_is_set_IS_TUNNEL (s))
121 if (da != clib_net_to_host_u32 (s->tunnel.t_dst.ip.ip4.as_u32))
124 if (sa != clib_net_to_host_u32 (s->tunnel.t_src.ip.ip4.as_u32))
130 if (da < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
133 if (da > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
136 if (sa < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
139 if (sa > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
148 ip6_addr_match_range (ip6_address_t * a, ip6_address_t * la,
151 if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
152 (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
157 always_inline ipsec_policy_t *
158 ipsec6_input_protect_policy_match (ipsec_spd_t * spd,
160 ip6_address_t * da, u32 spi)
162 ipsec_main_t *im = &ipsec_main;
167 vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP6_INBOUND_PROTECT])
169 p = pool_elt_at_index (im->policies, *i);
170 s = ipsec_sa_get (p->sa_index);
175 if (ipsec_sa_is_set_IS_TUNNEL (s))
177 if (!ip6_address_is_equal (sa, &s->tunnel.t_src.ip.ip6))
180 if (!ip6_address_is_equal (da, &s->tunnel.t_dst.ip.ip6))
186 if (!ip6_addr_match_range (sa, &p->raddr.start.ip6, &p->raddr.stop.ip6))
189 if (!ip6_addr_match_range (da, &p->laddr.start.ip6, &p->laddr.stop.ip6))
197 extern vlib_node_registration_t ipsec4_input_node;
199 VLIB_NODE_FN (ipsec4_input_node) (vlib_main_t * vm,
200 vlib_node_runtime_t * node,
201 vlib_frame_t * frame)
203 u32 n_left_from, *from, thread_index;
204 ipsec_main_t *im = &ipsec_main;
205 u64 ipsec_unprocessed = 0, ipsec_matched = 0;
206 u64 ipsec_dropped = 0, ipsec_bypassed = 0;
207 vlib_buffer_t *bufs[VLIB_FRAME_SIZE];
208 vlib_buffer_t **b = bufs;
209 u16 nexts[VLIB_FRAME_SIZE], *next;
211 from = vlib_frame_vector_args (frame);
212 n_left_from = frame->n_vectors;
214 vlib_get_buffers (vm, from, bufs, n_left_from);
215 thread_index = vm->thread_index;
218 while (n_left_from > 0)
222 esp_header_t *esp0 = NULL;
224 ip4_ipsec_config_t *c0;
226 ipsec_policy_t *p0 = NULL;
231 vlib_prefetch_buffer_data (b[1], LOAD);
234 b[0]->flags |= VNET_BUFFER_F_IS_IP4;
235 b[0]->flags &= ~VNET_BUFFER_F_IS_IP6;
236 c0 = vnet_feature_next_with_data (&next32, b[0], sizeof (c0[0]));
237 next[0] = (u16) next32;
239 spd0 = pool_elt_at_index (im->spds, c0->spd_index);
241 ip0 = vlib_buffer_get_current (b[0]);
244 (ip0->protocol == IP_PROTOCOL_IPSEC_ESP
245 || ip0->protocol == IP_PROTOCOL_UDP))
248 esp0 = (esp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
249 if (PREDICT_FALSE (ip0->protocol == IP_PROTOCOL_UDP))
251 /* FIXME Skip, if not a UDP encapsulated packet */
252 esp0 = (esp_header_t *) ((u8 *) esp0 + sizeof (udp_header_t));
255 p0 = ipsec_input_protect_policy_match (spd0,
257 (ip0->src_address.as_u32),
259 (ip0->dst_address.as_u32),
264 vlib_buffer_has_space (b[0],
265 (clib_address_t) (esp0 + 1) -
266 (clib_address_t) ip0);
268 if (PREDICT_TRUE ((p0 != NULL) & (has_space0)))
272 pi0 = p0 - im->policies;
273 vlib_increment_combined_counter
274 (&ipsec_spd_policy_counters,
275 thread_index, pi0, 1, clib_net_to_host_u16 (ip0->length));
277 vnet_buffer (b[0])->ipsec.sad_index = p0->sa_index;
278 next[0] = im->esp4_decrypt_next_index;
279 vlib_buffer_advance (b[0], ((u8 *) esp0 - (u8 *) ip0));
288 p0 = ipsec_input_policy_match (spd0,
290 (ip0->src_address.as_u32),
292 (ip0->dst_address.as_u32),
293 IPSEC_SPD_POLICY_IP4_INBOUND_BYPASS);
294 if (PREDICT_TRUE ((p0 != NULL)))
298 pi0 = p0 - im->policies;
299 vlib_increment_combined_counter (
300 &ipsec_spd_policy_counters, thread_index, pi0, 1,
301 clib_net_to_host_u16 (ip0->length));
311 p0 = ipsec_input_policy_match (spd0,
313 (ip0->src_address.as_u32),
315 (ip0->dst_address.as_u32),
316 IPSEC_SPD_POLICY_IP4_INBOUND_DISCARD);
317 if (PREDICT_TRUE ((p0 != NULL)))
321 pi0 = p0 - im->policies;
322 vlib_increment_combined_counter (
323 &ipsec_spd_policy_counters, thread_index, pi0, 1,
324 clib_net_to_host_u16 (ip0->length));
326 next[0] = IPSEC_INPUT_NEXT_DROP;
335 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE) &&
336 PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
338 ipsec_input_trace_t *tr =
339 vlib_add_trace (vm, node, b[0], sizeof (*tr));
341 tr->proto = ip0->protocol;
342 tr->sa_id = p0 ? p0->sa_id : ~0;
343 tr->spi = has_space0 ? clib_net_to_host_u32 (esp0->spi) : ~0;
344 tr->seq = has_space0 ? clib_net_to_host_u32 (esp0->seq) : ~0;
346 tr->policy_index = pi0;
349 else if (ip0->protocol == IP_PROTOCOL_IPSEC_AH)
351 ah0 = (ah_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
352 p0 = ipsec_input_protect_policy_match (spd0,
354 (ip0->src_address.as_u32),
356 (ip0->dst_address.as_u32),
361 vlib_buffer_has_space (b[0],
362 (clib_address_t) (ah0 + 1) -
363 (clib_address_t) ip0);
365 if (PREDICT_TRUE ((p0 != NULL) & (has_space0)))
369 pi0 = p0 - im->policies;
370 vlib_increment_combined_counter
371 (&ipsec_spd_policy_counters,
372 thread_index, pi0, 1, clib_net_to_host_u16 (ip0->length));
374 vnet_buffer (b[0])->ipsec.sad_index = p0->sa_index;
375 next[0] = im->ah4_decrypt_next_index;
384 p0 = ipsec_input_policy_match (spd0,
386 (ip0->src_address.as_u32),
388 (ip0->dst_address.as_u32),
389 IPSEC_SPD_POLICY_IP4_INBOUND_BYPASS);
390 if (PREDICT_TRUE ((p0 != NULL)))
394 pi0 = p0 - im->policies;
395 vlib_increment_combined_counter (
396 &ipsec_spd_policy_counters, thread_index, pi0, 1,
397 clib_net_to_host_u16 (ip0->length));
407 p0 = ipsec_input_policy_match (spd0,
409 (ip0->src_address.as_u32),
411 (ip0->dst_address.as_u32),
412 IPSEC_SPD_POLICY_IP4_INBOUND_DISCARD);
413 if (PREDICT_TRUE ((p0 != NULL)))
417 pi0 = p0 - im->policies;
418 vlib_increment_combined_counter (
419 &ipsec_spd_policy_counters, thread_index, pi0, 1,
420 clib_net_to_host_u16 (ip0->length));
422 next[0] = IPSEC_INPUT_NEXT_DROP;
431 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE) &&
432 PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
434 ipsec_input_trace_t *tr =
435 vlib_add_trace (vm, node, b[0], sizeof (*tr));
437 tr->proto = ip0->protocol;
438 tr->sa_id = p0 ? p0->sa_id : ~0;
439 tr->spi = has_space0 ? clib_net_to_host_u32 (ah0->spi) : ~0;
440 tr->seq = has_space0 ? clib_net_to_host_u32 (ah0->seq_no) : ~0;
442 tr->policy_index = pi0;
447 ipsec_unprocessed += 1;
454 vlib_buffer_enqueue_to_next (vm, node, from, nexts, frame->n_vectors);
456 vlib_node_increment_counter (vm, ipsec4_input_node.index,
457 IPSEC_INPUT_ERROR_RX_PKTS, frame->n_vectors);
459 vlib_node_increment_counter (vm, ipsec4_input_node.index,
460 IPSEC_INPUT_ERROR_RX_POLICY_MATCH,
463 vlib_node_increment_counter (vm, ipsec4_input_node.index,
464 IPSEC_INPUT_ERROR_RX_POLICY_NO_MATCH,
467 vlib_node_increment_counter (vm, ipsec4_input_node.index,
468 IPSEC_INPUT_ERROR_RX_POLICY_DISCARD,
471 vlib_node_increment_counter (vm, ipsec4_input_node.index,
472 IPSEC_INPUT_ERROR_RX_POLICY_BYPASS,
475 return frame->n_vectors;
480 VLIB_REGISTER_NODE (ipsec4_input_node) = {
481 .name = "ipsec4-input-feature",
482 .vector_size = sizeof (u32),
483 .format_trace = format_ipsec_input_trace,
484 .type = VLIB_NODE_TYPE_INTERNAL,
485 .n_errors = ARRAY_LEN(ipsec_input_error_strings),
486 .error_strings = ipsec_input_error_strings,
487 .n_next_nodes = IPSEC_INPUT_N_NEXT,
489 #define _(s,n) [IPSEC_INPUT_NEXT_##s] = n,
490 foreach_ipsec_input_next
496 extern vlib_node_registration_t ipsec6_input_node;
499 VLIB_NODE_FN (ipsec6_input_node) (vlib_main_t * vm,
500 vlib_node_runtime_t * node,
501 vlib_frame_t * from_frame)
503 u32 n_left_from, *from, next_index, *to_next, thread_index;
504 ipsec_main_t *im = &ipsec_main;
505 u32 ipsec_unprocessed = 0;
506 u32 ipsec_matched = 0;
508 from = vlib_frame_vector_args (from_frame);
509 n_left_from = from_frame->n_vectors;
510 thread_index = vm->thread_index;
512 next_index = node->cached_next_index;
514 while (n_left_from > 0)
518 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
520 while (n_left_from > 0 && n_left_to_next > 0)
526 ip4_ipsec_config_t *c0;
528 ipsec_policy_t *p0 = 0;
530 u32 header_size = sizeof (ip0[0]);
532 bi0 = to_next[0] = from[0];
538 b0 = vlib_get_buffer (vm, bi0);
539 b0->flags |= VNET_BUFFER_F_IS_IP6;
540 b0->flags &= ~VNET_BUFFER_F_IS_IP4;
541 c0 = vnet_feature_next_with_data (&next0, b0, sizeof (c0[0]));
543 spd0 = pool_elt_at_index (im->spds, c0->spd_index);
545 ip0 = vlib_buffer_get_current (b0);
546 esp0 = (esp_header_t *) ((u8 *) ip0 + header_size);
547 ah0 = (ah_header_t *) ((u8 *) ip0 + header_size);
549 if (PREDICT_TRUE (ip0->protocol == IP_PROTOCOL_IPSEC_ESP))
553 ("packet received from %U to %U spi %u size %u spd_id %u",
554 format_ip6_address, &ip0->src_address, format_ip6_address,
555 &ip0->dst_address, clib_net_to_host_u32 (esp0->spi),
556 clib_net_to_host_u16 (ip0->payload_length) + header_size,
559 p0 = ipsec6_input_protect_policy_match (spd0,
565 if (PREDICT_TRUE (p0 != 0))
569 pi0 = p0 - im->policies;
570 vlib_increment_combined_counter
571 (&ipsec_spd_policy_counters,
572 thread_index, pi0, 1,
573 clib_net_to_host_u16 (ip0->payload_length) +
576 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
577 next0 = im->esp6_decrypt_next_index;
578 vlib_buffer_advance (b0, header_size);
586 else if (ip0->protocol == IP_PROTOCOL_IPSEC_AH)
588 p0 = ipsec6_input_protect_policy_match (spd0,
594 if (PREDICT_TRUE (p0 != 0))
597 pi0 = p0 - im->policies;
598 vlib_increment_combined_counter
599 (&ipsec_spd_policy_counters,
600 thread_index, pi0, 1,
601 clib_net_to_host_u16 (ip0->payload_length) +
604 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
605 next0 = im->ah6_decrypt_next_index;
615 ipsec_unprocessed += 1;
619 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE) &&
620 PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
622 ipsec_input_trace_t *tr =
623 vlib_add_trace (vm, node, b0, sizeof (*tr));
626 tr->sa_id = p0->sa_id;
627 tr->proto = ip0->protocol;
628 tr->spi = clib_net_to_host_u32 (esp0->spi);
629 tr->seq = clib_net_to_host_u32 (esp0->seq);
633 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
634 n_left_to_next, bi0, next0);
636 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
639 vlib_node_increment_counter (vm, ipsec6_input_node.index,
640 IPSEC_INPUT_ERROR_RX_PKTS,
641 from_frame->n_vectors - ipsec_unprocessed);
643 vlib_node_increment_counter (vm, ipsec6_input_node.index,
644 IPSEC_INPUT_ERROR_RX_POLICY_MATCH,
647 return from_frame->n_vectors;
652 VLIB_REGISTER_NODE (ipsec6_input_node) = {
653 .name = "ipsec6-input-feature",
654 .vector_size = sizeof (u32),
655 .format_trace = format_ipsec_input_trace,
656 .type = VLIB_NODE_TYPE_INTERNAL,
657 .n_errors = ARRAY_LEN(ipsec_input_error_strings),
658 .error_strings = ipsec_input_error_strings,
659 .n_next_nodes = IPSEC_INPUT_N_NEXT,
661 #define _(s,n) [IPSEC_INPUT_NEXT_##s] = n,
662 foreach_ipsec_input_next
669 * fd.io coding-style-patch-verification: ON
672 * eval: (c-set-style "gnu")