2 * ipsec_if_in.c : IPSec interface input node
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>
22 #include <vnet/ipsec/ipsec.h>
23 #include <vnet/ipsec/esp.h>
24 #include <vnet/ipsec/ipsec_io.h>
25 #include <vnet/ipsec/ipsec_punt.h>
27 /* Statistics (not really errors) */
28 #define foreach_ipsec_if_input_error \
29 _(RX, "good packets received") \
30 _(DISABLED, "ipsec packets received on disabled interface") \
31 _(NO_TUNNEL, "no matching tunnel") \
34 static char *ipsec_if_input_error_strings[] = {
35 #define _(sym,string) string,
36 foreach_ipsec_if_input_error
42 #define _(sym,str) IPSEC_IF_INPUT_ERROR_##sym,
43 foreach_ipsec_if_input_error
45 IPSEC_IF_INPUT_N_ERROR,
46 } ipsec_if_input_error_t;
53 } ipsec_if_input_trace_t;
56 format_ipsec_if_input_trace (u8 * s, va_list * args)
58 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
59 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
60 ipsec_if_input_trace_t *t = va_arg (*args, ipsec_if_input_trace_t *);
62 s = format (s, "IPSec: spi %u seq %u", t->spi, t->seq);
67 ipsec_ip4_if_no_tunnel (vlib_node_runtime_t * node,
69 const esp_header_t * esp,
70 const ip4_header_t * ip4, u16 offset)
72 if (PREDICT_FALSE (0 == esp->spi))
74 b->error = node->errors[IPSEC_IF_INPUT_ERROR_SPI_0];
76 ipsec_punt_reason[(ip4->protocol == IP_PROTOCOL_UDP ?
77 IPSEC_PUNT_IP4_SPI_UDP_0 : IPSEC_PUNT_IP4_SPI_0)];
81 b->error = node->errors[IPSEC_IF_INPUT_ERROR_NO_TUNNEL];
82 b->punt_reason = ipsec_punt_reason[IPSEC_PUNT_IP4_NO_SUCH_TUNNEL];
84 vlib_buffer_advance (b, -offset);
85 return IPSEC_INPUT_NEXT_PUNT;
89 ipsec_ip6_if_no_tunnel (vlib_node_runtime_t * node,
91 const esp_header_t * esp, u16 offset)
93 if (PREDICT_FALSE (0 == esp->spi))
95 b->error = node->errors[IPSEC_IF_INPUT_ERROR_NO_TUNNEL];
96 b->punt_reason = ipsec_punt_reason[IPSEC_PUNT_IP6_SPI_0];
100 b->error = node->errors[IPSEC_IF_INPUT_ERROR_NO_TUNNEL];
101 b->punt_reason = ipsec_punt_reason[IPSEC_PUNT_IP6_NO_SUCH_TUNNEL];
103 vlib_buffer_advance (b, -offset);
104 return (IPSEC_INPUT_NEXT_PUNT);
108 ipsec_if_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
109 vlib_frame_t * from_frame, int is_ip6)
111 ipsec_main_t *im = &ipsec_main;
112 vnet_main_t *vnm = im->vnet_main;
113 vnet_interface_main_t *vim = &vnm->interface_main;
115 int is_trace = node->flags & VLIB_NODE_FLAG_TRACE;
116 u32 thread_index = vm->thread_index;
118 u32 n_left_from, *from;
119 u16 nexts[VLIB_FRAME_SIZE], *next;
120 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
122 from = vlib_frame_vector_args (from_frame);
123 n_left_from = from_frame->n_vectors;
125 vlib_get_buffers (vm, from, bufs, n_left_from);
129 clib_memset_u16 (nexts, im->esp4_decrypt_next_index, n_left_from);
131 u64 n_bytes = 0, n_packets = 0;
132 u32 n_disabled = 0, n_no_tunnel = 0;
134 u32 last_sw_if_index = ~0;
135 u32 last_tunnel_id = ~0;
136 ipsec4_tunnel_key_t last_key4;
137 ipsec6_tunnel_key_t last_key6;
139 vlib_combined_counter_main_t *rx_counter;
140 vlib_combined_counter_main_t *drop_counter;
143 clib_memset (&last_key6, 0xff, sizeof (last_key6));
145 last_key4.as_u64 = ~0;
147 rx_counter = vim->combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX;
148 drop_counter = vim->combined_sw_if_counters + VNET_INTERFACE_COUNTER_DROP;
150 while (n_left_from >= 2)
152 u32 sw_if_index0, sw_if_index1;
153 ip4_header_t *ip40, *ip41;
154 ip6_header_t *ip60, *ip61;
155 esp_header_t *esp0, *esp1;
157 u16 buf_adv0, buf_adv1;
159 ipsec_tunnel_if_t *t0, *t1;
160 ipsec4_tunnel_key_t key40, key41;
161 ipsec6_tunnel_key_t key60, key61;
163 if (n_left_from >= 4)
165 CLIB_PREFETCH (b[2], CLIB_CACHE_LINE_BYTES, STORE);
166 CLIB_PREFETCH (b[2]->data, CLIB_CACHE_LINE_BYTES, LOAD);
167 CLIB_PREFETCH (b[3], CLIB_CACHE_LINE_BYTES, STORE);
168 CLIB_PREFETCH (b[3]->data, CLIB_CACHE_LINE_BYTES, LOAD);
172 (ip4_header_t *) (b[0]->data + vnet_buffer (b[0])->l3_hdr_offset);
174 (ip4_header_t *) (b[1]->data + vnet_buffer (b[1])->l3_hdr_offset);
178 ip60 = (ip6_header_t *) ip40;
179 ip61 = (ip6_header_t *) ip41;
180 esp0 = (esp_header_t *) ((u8 *) ip60 + sizeof (ip6_header_t));
181 esp1 = (esp_header_t *) ((u8 *) ip61 + sizeof (ip6_header_t));
182 buf_adv0 = sizeof (ip6_header_t);
183 buf_adv1 = sizeof (ip6_header_t);
187 /* NAT UDP port 4500 case, don't advance any more */
188 if (ip40->protocol == IP_PROTOCOL_UDP)
191 (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40) +
192 sizeof (udp_header_t));
197 esp0 = (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40));
198 buf_adv0 = ip4_header_bytes (ip40);
200 /* NAT UDP port 4500 case, don't advance any more */
201 if (ip41->protocol == IP_PROTOCOL_UDP)
204 (esp_header_t *) ((u8 *) ip41 + ip4_header_bytes (ip41) +
205 sizeof (udp_header_t));
210 esp1 = (esp_header_t *) ((u8 *) ip41 + ip4_header_bytes (ip41));
211 buf_adv1 = ip4_header_bytes (ip41);
215 vlib_buffer_advance (b[0], buf_adv0);
216 vlib_buffer_advance (b[1], buf_adv1);
218 len0 = vlib_buffer_length_in_chain (vm, b[0]);
219 len1 = vlib_buffer_length_in_chain (vm, b[1]);
223 key60.remote_ip = ip60->src_address;
224 key60.spi = esp0->spi;
226 if (memcmp (&key60, &last_key6, sizeof (last_key6)) == 0)
228 tid0 = last_tunnel_id;
233 hash_get_mem (im->ipsec6_if_pool_index_by_key, &key60);
237 last_tunnel_id = tid0;
238 clib_memcpy_fast (&last_key6, &key60, sizeof (key60));
243 ipsec_ip6_if_no_tunnel (node, b[0], esp0, buf_adv0);
251 key40.remote_ip = ip40->src_address.as_u32;
252 key40.spi = esp0->spi;
254 if (key40.as_u64 == last_key4.as_u64)
256 tid0 = last_tunnel_id;
261 hash_get (im->ipsec4_if_pool_index_by_key, key40.as_u64);
265 last_tunnel_id = tid0;
266 last_key4.as_u64 = key40.as_u64;
271 ipsec_ip4_if_no_tunnel (node, b[0], esp0, ip40, buf_adv0);
278 t0 = pool_elt_at_index (im->tunnel_interfaces, tid0);
279 vnet_buffer (b[0])->ipsec.sad_index = t0->input_sa_index;
281 if (PREDICT_TRUE (t0->hw_if_index != ~0))
283 sw_if_index0 = t0->sw_if_index;
284 vnet_buffer (b[0])->sw_if_index[VLIB_RX] = sw_if_index0;
286 if (PREDICT_FALSE (!(t0->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)))
288 vlib_increment_combined_counter
289 (drop_counter, thread_index, sw_if_index0, 1, len0);
291 b[0]->error = node->errors[IPSEC_IF_INPUT_ERROR_DISABLED];
292 next[0] = IPSEC_INPUT_NEXT_DROP;
296 if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
305 vlib_increment_combined_counter
306 (rx_counter, thread_index, last_sw_if_index,
310 last_sw_if_index = sw_if_index0;
319 key61.remote_ip = ip61->src_address;
320 key61.spi = esp1->spi;
322 if (memcmp (&key61, &last_key6, sizeof (last_key6)) == 0)
324 tid1 = last_tunnel_id;
329 hash_get_mem (im->ipsec6_if_pool_index_by_key, &key61);
333 last_tunnel_id = tid1;
334 clib_memcpy_fast (&last_key6, &key61, sizeof (key61));
339 ipsec_ip6_if_no_tunnel (node, b[1], esp1, buf_adv1);
347 key41.remote_ip = ip41->src_address.as_u32;
348 key41.spi = esp1->spi;
350 if (key41.as_u64 == last_key4.as_u64)
352 tid1 = last_tunnel_id;
357 hash_get (im->ipsec4_if_pool_index_by_key, key41.as_u64);
361 last_tunnel_id = tid1;
362 last_key4.as_u64 = key41.as_u64;
367 ipsec_ip4_if_no_tunnel (node, b[1], esp1, ip41, buf_adv1);
374 t1 = pool_elt_at_index (im->tunnel_interfaces, tid1);
375 vnet_buffer (b[1])->ipsec.sad_index = t1->input_sa_index;
377 if (PREDICT_TRUE (t1->hw_if_index != ~0))
379 sw_if_index1 = t1->sw_if_index;
380 vnet_buffer (b[1])->sw_if_index[VLIB_RX] = sw_if_index1;
382 if (PREDICT_FALSE (!(t1->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)))
384 vlib_increment_combined_counter
385 (drop_counter, thread_index, sw_if_index1, 1, len1);
387 b[1]->error = node->errors[IPSEC_IF_INPUT_ERROR_DISABLED];
388 next[1] = IPSEC_INPUT_NEXT_DROP;
392 if (PREDICT_TRUE (sw_if_index1 == last_sw_if_index))
401 vlib_increment_combined_counter
402 (rx_counter, thread_index, last_sw_if_index,
406 last_sw_if_index = sw_if_index1;
413 if (PREDICT_FALSE (is_trace))
415 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
417 ipsec_if_input_trace_t *tr =
418 vlib_add_trace (vm, node, b[0], sizeof (*tr));
419 tr->spi = clib_host_to_net_u32 (esp0->spi);
420 tr->seq = clib_host_to_net_u32 (esp0->seq);
422 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
424 ipsec_if_input_trace_t *tr =
425 vlib_add_trace (vm, node, b[1], sizeof (*tr));
426 tr->spi = clib_host_to_net_u32 (esp1->spi);
427 tr->seq = clib_host_to_net_u32 (esp1->seq);
436 while (n_left_from > 0)
445 ipsec_tunnel_if_t *t0;
446 ipsec4_tunnel_key_t key40;
447 ipsec6_tunnel_key_t key60;
450 (ip4_header_t *) (b[0]->data + vnet_buffer (b[0])->l3_hdr_offset);
454 ip60 = (ip6_header_t *) ip40;
455 esp0 = (esp_header_t *) ((u8 *) ip60 + sizeof (ip6_header_t));
456 buf_adv0 = sizeof (ip6_header_t);
460 /* NAT UDP port 4500 case, don't advance any more */
461 if (ip40->protocol == IP_PROTOCOL_UDP)
464 (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40) +
465 sizeof (udp_header_t));
470 esp0 = (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40));
471 buf_adv0 = ip4_header_bytes (ip40);
475 /* stats for the tunnel include all the data after the IP header
476 just like a norml IP-IP tunnel */
477 vlib_buffer_advance (b[0], buf_adv0);
478 len0 = vlib_buffer_length_in_chain (vm, b[0]);
482 key60.remote_ip = ip60->src_address;
483 key60.spi = esp0->spi;
485 if (memcmp (&key60, &last_key6, sizeof (last_key6)) == 0)
487 tid0 = last_tunnel_id;
492 hash_get_mem (im->ipsec6_if_pool_index_by_key, &key60);
496 last_tunnel_id = tid0;
497 clib_memcpy_fast (&last_key6, &key60, sizeof (key60));
502 ipsec_ip6_if_no_tunnel (node, b[0], esp0, buf_adv0);
510 key40.remote_ip = ip40->src_address.as_u32;
511 key40.spi = esp0->spi;
513 if (key40.as_u64 == last_key4.as_u64)
515 tid0 = last_tunnel_id;
520 hash_get (im->ipsec4_if_pool_index_by_key, key40.as_u64);
524 last_tunnel_id = tid0;
525 last_key4.as_u64 = key40.as_u64;
530 ipsec_ip4_if_no_tunnel (node, b[0], esp0, ip40, buf_adv0);
537 t0 = pool_elt_at_index (im->tunnel_interfaces, tid0);
538 vnet_buffer (b[0])->ipsec.sad_index = t0->input_sa_index;
540 if (PREDICT_TRUE (t0->hw_if_index != ~0))
542 sw_if_index0 = t0->sw_if_index;
543 vnet_buffer (b[0])->sw_if_index[VLIB_RX] = sw_if_index0;
545 if (PREDICT_FALSE (!(t0->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)))
547 vlib_increment_combined_counter
548 (drop_counter, thread_index, sw_if_index0, 1, len0);
550 b[0]->error = node->errors[IPSEC_IF_INPUT_ERROR_DISABLED];
551 next[0] = IPSEC_INPUT_NEXT_DROP;
555 if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
564 vlib_increment_combined_counter
565 (rx_counter, thread_index, last_sw_if_index,
569 last_sw_if_index = sw_if_index0;
576 if (PREDICT_FALSE (is_trace))
578 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
580 ipsec_if_input_trace_t *tr =
581 vlib_add_trace (vm, node, b[0], sizeof (*tr));
582 tr->spi = clib_host_to_net_u32 (esp0->spi);
583 tr->seq = clib_host_to_net_u32 (esp0->seq);
595 vlib_increment_combined_counter (rx_counter,
597 last_sw_if_index, n_packets, n_bytes);
600 vlib_node_increment_counter (vm, node->node_index,
601 IPSEC_IF_INPUT_ERROR_RX,
602 from_frame->n_vectors - (n_disabled +
605 vlib_buffer_enqueue_to_next (vm, node, from, nexts, from_frame->n_vectors);
607 return from_frame->n_vectors;
610 VLIB_NODE_FN (ipsec4_if_input_node) (vlib_main_t * vm,
611 vlib_node_runtime_t * node,
612 vlib_frame_t * from_frame)
614 return ipsec_if_input_inline (vm, node, from_frame, 0 /* is_ip6 */ );
618 VLIB_REGISTER_NODE (ipsec4_if_input_node) = {
619 .name = "ipsec4-if-input",
620 .vector_size = sizeof (u32),
621 .format_trace = format_ipsec_if_input_trace,
622 .type = VLIB_NODE_TYPE_INTERNAL,
623 .n_errors = ARRAY_LEN(ipsec_if_input_error_strings),
624 .error_strings = ipsec_if_input_error_strings,
625 .sibling_of = "ipsec4-input-feature",
629 VLIB_NODE_FN (ipsec6_if_input_node) (vlib_main_t * vm,
630 vlib_node_runtime_t * node,
631 vlib_frame_t * from_frame)
633 return ipsec_if_input_inline (vm, node, from_frame, 1 /* is_ip6 */ );
637 VLIB_REGISTER_NODE (ipsec6_if_input_node) = {
638 .name = "ipsec6-if-input",
639 .vector_size = sizeof (u32),
640 .format_trace = format_ipsec_if_input_trace,
641 .type = VLIB_NODE_TYPE_INTERNAL,
642 .n_errors = ARRAY_LEN(ipsec_if_input_error_strings),
643 .error_strings = ipsec_if_input_error_strings,
644 .sibling_of = "ipsec6-input-feature",
649 * fd.io coding-style-patch-verification: ON
652 * eval: (c-set-style "gnu")