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") \
32 _(NAT_KEEPALIVE, "NAT Keepalive") \
33 _(TOO_SHORT, "Too Short") \
36 static char *ipsec_if_input_error_strings[] = {
37 #define _(sym,string) string,
38 foreach_ipsec_if_input_error
44 #define _(sym,str) IPSEC_IF_INPUT_ERROR_##sym,
45 foreach_ipsec_if_input_error
47 IPSEC_IF_INPUT_N_ERROR,
48 } ipsec_if_input_error_t;
55 ipsec4_tunnel_key_t key4;
56 ipsec6_tunnel_key_t key6;
60 } ipsec_if_input_trace_t;
63 format_ipsec_if_input_trace (u8 * s, va_list * args)
65 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
66 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
67 ipsec_if_input_trace_t *t = va_arg (*args, ipsec_if_input_trace_t *);
70 s = format (s, "IPSec: %U seq %u",
71 format_ipsec6_tunnel_key, &t->key6, t->seq);
73 s = format (s, "IPSec: %U seq %u",
74 format_ipsec4_tunnel_key, &t->key4, t->seq);
79 ipsec_ip4_if_no_tunnel (vlib_node_runtime_t * node,
81 const esp_header_t * esp,
82 const ip4_header_t * ip4, u16 offset)
84 if (PREDICT_FALSE (0 == esp->spi))
86 b->error = node->errors[IPSEC_IF_INPUT_ERROR_SPI_0];
88 ipsec_punt_reason[(ip4->protocol == IP_PROTOCOL_UDP ?
89 IPSEC_PUNT_IP4_SPI_UDP_0 :
90 IPSEC_PUNT_IP4_NO_SUCH_TUNNEL)];
94 b->error = node->errors[IPSEC_IF_INPUT_ERROR_NO_TUNNEL];
95 b->punt_reason = ipsec_punt_reason[IPSEC_PUNT_IP4_NO_SUCH_TUNNEL];
97 vlib_buffer_advance (b, -offset);
98 return IPSEC_INPUT_NEXT_PUNT;
102 ipsec_ip6_if_no_tunnel (vlib_node_runtime_t * node,
104 const esp_header_t * esp, u16 offset)
106 b->error = node->errors[IPSEC_IF_INPUT_ERROR_NO_TUNNEL];
107 b->punt_reason = ipsec_punt_reason[IPSEC_PUNT_IP6_NO_SUCH_TUNNEL];
109 vlib_buffer_advance (b, -offset);
110 return (IPSEC_INPUT_NEXT_PUNT);
114 ipsec_if_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
115 vlib_frame_t * from_frame, int is_ip6)
117 ipsec_main_t *im = &ipsec_main;
118 vnet_main_t *vnm = im->vnet_main;
119 vnet_interface_main_t *vim = &vnm->interface_main;
121 int is_trace = node->flags & VLIB_NODE_FLAG_TRACE;
122 u32 thread_index = vm->thread_index;
124 u32 n_left_from, *from;
125 u16 nexts[VLIB_FRAME_SIZE], *next;
126 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
128 from = vlib_frame_vector_args (from_frame);
129 n_left_from = from_frame->n_vectors;
131 vlib_get_buffers (vm, from, bufs, n_left_from);
135 clib_memset_u16 (nexts, im->esp4_decrypt_next_index, n_left_from);
137 u64 n_bytes = 0, n_packets = 0;
138 u32 n_disabled = 0, n_no_tunnel = 0;
140 u32 last_sw_if_index = ~0;
141 u32 last_tunnel_id = ~0;
142 ipsec4_tunnel_key_t last_key4;
143 ipsec6_tunnel_key_t last_key6;
145 vlib_combined_counter_main_t *rx_counter;
146 vlib_combined_counter_main_t *drop_counter;
149 clib_memset (&last_key6, 0xff, sizeof (last_key6));
151 last_key4.as_u64 = ~0;
153 rx_counter = vim->combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX;
154 drop_counter = vim->combined_sw_if_counters + VNET_INTERFACE_COUNTER_DROP;
156 while (n_left_from >= 2)
158 u32 sw_if_index0, sw_if_index1;
159 ip4_header_t *ip40, *ip41;
160 ip6_header_t *ip60, *ip61;
161 esp_header_t *esp0, *esp1;
163 u16 buf_adv0, buf_adv1;
164 u16 buf_rewind0, buf_rewind1;
166 ipsec_tunnel_if_t *t0, *t1;
167 ipsec4_tunnel_key_t key40, key41;
168 ipsec6_tunnel_key_t key60, key61;
170 if (n_left_from >= 4)
172 CLIB_PREFETCH (b[2], CLIB_CACHE_LINE_BYTES, STORE);
173 CLIB_PREFETCH (b[2]->data, CLIB_CACHE_LINE_BYTES, LOAD);
174 CLIB_PREFETCH (b[3], CLIB_CACHE_LINE_BYTES, STORE);
175 CLIB_PREFETCH (b[3]->data, CLIB_CACHE_LINE_BYTES, LOAD);
179 (ip4_header_t *) (b[0]->data + vnet_buffer (b[0])->l3_hdr_offset);
181 (ip4_header_t *) (b[1]->data + vnet_buffer (b[1])->l3_hdr_offset);
185 ip60 = (ip6_header_t *) ip40;
186 ip61 = (ip6_header_t *) ip41;
187 esp0 = (esp_header_t *) ((u8 *) ip60 + sizeof (ip6_header_t));
188 esp1 = (esp_header_t *) ((u8 *) ip61 + sizeof (ip6_header_t));
189 buf_adv0 = sizeof (ip6_header_t);
190 buf_adv1 = sizeof (ip6_header_t);
194 /* NAT UDP port 4500 case, don't advance any more */
195 if (ip40->protocol == IP_PROTOCOL_UDP)
198 (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40) +
199 sizeof (udp_header_t));
201 buf_rewind0 = ip4_header_bytes (ip40) + sizeof (udp_header_t);
205 esp0 = (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40));
206 buf_rewind0 = buf_adv0 = ip4_header_bytes (ip40);
208 /* NAT UDP port 4500 case, don't advance any more */
209 if (ip41->protocol == IP_PROTOCOL_UDP)
212 (esp_header_t *) ((u8 *) ip41 + ip4_header_bytes (ip41) +
213 sizeof (udp_header_t));
215 buf_rewind1 = ip4_header_bytes (ip41) + sizeof (udp_header_t);
219 esp1 = (esp_header_t *) ((u8 *) ip41 + ip4_header_bytes (ip41));
220 buf_rewind1 = buf_adv1 = ip4_header_bytes (ip41);
224 vlib_buffer_advance (b[0], buf_adv0);
225 vlib_buffer_advance (b[1], buf_adv1);
227 len0 = vlib_buffer_length_in_chain (vm, b[0]);
228 len1 = vlib_buffer_length_in_chain (vm, b[1]);
230 /* If the packet is too short to contain an SPI, then maybe
231 * it's a keep alive */
232 if (len0 < sizeof (esp_header_t))
234 if (esp0->spi_bytes[0] == 0xff)
235 b[0]->error = node->errors[IPSEC_IF_INPUT_ERROR_NAT_KEEPALIVE];
237 b[0]->error = node->errors[IPSEC_IF_INPUT_ERROR_TOO_SHORT];
239 next[0] = IPSEC_INPUT_NEXT_DROP;
245 key60.remote_ip = ip60->src_address;
246 key60.spi = esp0->spi;
248 if (memcmp (&key60, &last_key6, sizeof (last_key6)) == 0)
250 tid0 = last_tunnel_id;
255 hash_get_mem (im->ipsec6_if_pool_index_by_key, &key60);
259 last_tunnel_id = tid0;
260 clib_memcpy_fast (&last_key6, &key60, sizeof (key60));
265 ipsec_ip6_if_no_tunnel (node, b[0], esp0, buf_adv0);
273 key40.remote_ip = ip40->src_address;
274 key40.spi = esp0->spi;
276 if (key40.as_u64 == last_key4.as_u64)
278 tid0 = last_tunnel_id;
283 hash_get (im->ipsec4_if_pool_index_by_key, key40.as_u64);
287 last_tunnel_id = tid0;
288 last_key4.as_u64 = key40.as_u64;
293 ipsec_ip4_if_no_tunnel (node, b[0], esp0, ip40,
301 t0 = pool_elt_at_index (im->tunnel_interfaces, tid0);
302 vnet_buffer (b[0])->ipsec.sad_index = t0->input_sa_index;
304 if (PREDICT_TRUE (t0->hw_if_index != ~0))
306 sw_if_index0 = t0->sw_if_index;
307 vnet_buffer (b[0])->sw_if_index[VLIB_RX] = sw_if_index0;
309 if (PREDICT_FALSE (!(t0->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)))
311 vlib_increment_combined_counter
312 (drop_counter, thread_index, sw_if_index0, 1, len0);
314 b[0]->error = node->errors[IPSEC_IF_INPUT_ERROR_DISABLED];
315 next[0] = IPSEC_INPUT_NEXT_DROP;
319 if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
328 vlib_increment_combined_counter
329 (rx_counter, thread_index, last_sw_if_index,
333 last_sw_if_index = sw_if_index0;
341 if (len1 < sizeof (esp_header_t))
343 if (esp0->spi_bytes[0] == 0xff)
344 b[1]->error = node->errors[IPSEC_IF_INPUT_ERROR_NAT_KEEPALIVE];
346 b[1]->error = node->errors[IPSEC_IF_INPUT_ERROR_TOO_SHORT];
348 next[1] = IPSEC_INPUT_NEXT_DROP;
354 key61.remote_ip = ip61->src_address;
355 key61.spi = esp1->spi;
357 if (memcmp (&key61, &last_key6, sizeof (last_key6)) == 0)
359 tid1 = last_tunnel_id;
364 hash_get_mem (im->ipsec6_if_pool_index_by_key, &key61);
368 last_tunnel_id = tid1;
369 clib_memcpy_fast (&last_key6, &key61, sizeof (key61));
374 ipsec_ip6_if_no_tunnel (node, b[1], esp1, buf_adv1);
382 key41.remote_ip = ip41->src_address;
383 key41.spi = esp1->spi;
385 if (key41.as_u64 == last_key4.as_u64)
387 tid1 = last_tunnel_id;
392 hash_get (im->ipsec4_if_pool_index_by_key, key41.as_u64);
396 last_tunnel_id = tid1;
397 last_key4.as_u64 = key41.as_u64;
402 ipsec_ip4_if_no_tunnel (node, b[1], esp1, ip41,
410 t1 = pool_elt_at_index (im->tunnel_interfaces, tid1);
411 vnet_buffer (b[1])->ipsec.sad_index = t1->input_sa_index;
413 if (PREDICT_TRUE (t1->hw_if_index != ~0))
415 sw_if_index1 = t1->sw_if_index;
416 vnet_buffer (b[1])->sw_if_index[VLIB_RX] = sw_if_index1;
418 if (PREDICT_FALSE (!(t1->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)))
420 vlib_increment_combined_counter
421 (drop_counter, thread_index, sw_if_index1, 1, len1);
423 b[1]->error = node->errors[IPSEC_IF_INPUT_ERROR_DISABLED];
424 next[1] = IPSEC_INPUT_NEXT_DROP;
428 if (PREDICT_TRUE (sw_if_index1 == last_sw_if_index))
437 vlib_increment_combined_counter
438 (rx_counter, thread_index, last_sw_if_index,
442 last_sw_if_index = sw_if_index1;
449 if (PREDICT_FALSE (is_trace))
451 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
453 ipsec_if_input_trace_t *tr =
454 vlib_add_trace (vm, node, b[0], sizeof (*tr));
456 clib_memcpy (&tr->key6, &key60, sizeof (tr->key6));
458 clib_memcpy (&tr->key4, &key40, sizeof (tr->key4));
460 tr->seq = clib_host_to_net_u32 (esp0->seq);
462 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
464 ipsec_if_input_trace_t *tr =
465 vlib_add_trace (vm, node, b[1], sizeof (*tr));
467 clib_memcpy (&tr->key6, &key61, sizeof (tr->key6));
469 clib_memcpy (&tr->key4, &key41, sizeof (tr->key4));
471 tr->seq = clib_host_to_net_u32 (esp1->seq);
480 while (n_left_from > 0)
487 u16 buf_adv0, buf_rewind0;
489 ipsec_tunnel_if_t *t0;
490 ipsec4_tunnel_key_t key40;
491 ipsec6_tunnel_key_t key60;
494 (ip4_header_t *) (b[0]->data + vnet_buffer (b[0])->l3_hdr_offset);
498 ip60 = (ip6_header_t *) ip40;
499 esp0 = (esp_header_t *) ((u8 *) ip60 + sizeof (ip6_header_t));
500 buf_adv0 = sizeof (ip6_header_t);
504 /* NAT UDP port 4500 case, don't advance any more */
505 if (ip40->protocol == IP_PROTOCOL_UDP)
508 (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40) +
509 sizeof (udp_header_t));
511 buf_rewind0 = ip4_header_bytes (ip40) + sizeof (udp_header_t);
515 esp0 = (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40));
516 buf_rewind0 = buf_adv0 = ip4_header_bytes (ip40);
520 /* stats for the tunnel include all the data after the IP header
521 just like a norml IP-IP tunnel */
522 vlib_buffer_advance (b[0], buf_adv0);
523 len0 = vlib_buffer_length_in_chain (vm, b[0]);
525 if (len0 < sizeof (esp_header_t))
527 if (esp0->spi_bytes[0] == 0xff)
528 b[0]->error = node->errors[IPSEC_IF_INPUT_ERROR_NAT_KEEPALIVE];
530 b[0]->error = node->errors[IPSEC_IF_INPUT_ERROR_TOO_SHORT];
532 next[0] = IPSEC_INPUT_NEXT_DROP;
538 key60.remote_ip = ip60->src_address;
539 key60.spi = esp0->spi;
541 if (memcmp (&key60, &last_key6, sizeof (last_key6)) == 0)
543 tid0 = last_tunnel_id;
548 hash_get_mem (im->ipsec6_if_pool_index_by_key, &key60);
552 last_tunnel_id = tid0;
553 clib_memcpy_fast (&last_key6, &key60, sizeof (key60));
558 ipsec_ip6_if_no_tunnel (node, b[0], esp0, buf_adv0);
566 key40.remote_ip = ip40->src_address;
567 key40.spi = esp0->spi;
569 if (key40.as_u64 == last_key4.as_u64)
571 tid0 = last_tunnel_id;
576 hash_get (im->ipsec4_if_pool_index_by_key, key40.as_u64);
580 last_tunnel_id = tid0;
581 last_key4.as_u64 = key40.as_u64;
586 ipsec_ip4_if_no_tunnel (node, b[0], esp0, ip40,
594 t0 = pool_elt_at_index (im->tunnel_interfaces, tid0);
595 vnet_buffer (b[0])->ipsec.sad_index = t0->input_sa_index;
597 if (PREDICT_TRUE (t0->hw_if_index != ~0))
599 sw_if_index0 = t0->sw_if_index;
600 vnet_buffer (b[0])->sw_if_index[VLIB_RX] = sw_if_index0;
602 if (PREDICT_FALSE (!(t0->flags & VNET_HW_INTERFACE_FLAG_LINK_UP)))
604 vlib_increment_combined_counter
605 (drop_counter, thread_index, sw_if_index0, 1, len0);
607 b[0]->error = node->errors[IPSEC_IF_INPUT_ERROR_DISABLED];
608 next[0] = IPSEC_INPUT_NEXT_DROP;
612 if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
621 vlib_increment_combined_counter
622 (rx_counter, thread_index, last_sw_if_index,
626 last_sw_if_index = sw_if_index0;
633 if (PREDICT_FALSE (is_trace))
635 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
637 ipsec_if_input_trace_t *tr =
638 vlib_add_trace (vm, node, b[0], sizeof (*tr));
640 clib_memcpy (&tr->key6, &key60, sizeof (tr->key6));
642 clib_memcpy (&tr->key4, &key40, sizeof (tr->key4));
644 tr->seq = clib_host_to_net_u32 (esp0->seq);
656 vlib_increment_combined_counter (rx_counter,
658 last_sw_if_index, n_packets, n_bytes);
661 vlib_node_increment_counter (vm, node->node_index,
662 IPSEC_IF_INPUT_ERROR_RX,
663 from_frame->n_vectors - (n_disabled +
666 vlib_buffer_enqueue_to_next (vm, node, from, nexts, from_frame->n_vectors);
668 return from_frame->n_vectors;
671 VLIB_NODE_FN (ipsec4_if_input_node) (vlib_main_t * vm,
672 vlib_node_runtime_t * node,
673 vlib_frame_t * from_frame)
675 return ipsec_if_input_inline (vm, node, from_frame, 0 /* is_ip6 */ );
679 VLIB_REGISTER_NODE (ipsec4_if_input_node) = {
680 .name = "ipsec4-if-input",
681 .vector_size = sizeof (u32),
682 .format_trace = format_ipsec_if_input_trace,
683 .type = VLIB_NODE_TYPE_INTERNAL,
684 .n_errors = ARRAY_LEN(ipsec_if_input_error_strings),
685 .error_strings = ipsec_if_input_error_strings,
686 .sibling_of = "ipsec4-input-feature",
690 VLIB_NODE_FN (ipsec6_if_input_node) (vlib_main_t * vm,
691 vlib_node_runtime_t * node,
692 vlib_frame_t * from_frame)
694 return ipsec_if_input_inline (vm, node, from_frame, 1 /* is_ip6 */ );
698 VLIB_REGISTER_NODE (ipsec6_if_input_node) = {
699 .name = "ipsec6-if-input",
700 .vector_size = sizeof (u32),
701 .format_trace = format_ipsec_if_input_trace,
702 .type = VLIB_NODE_TYPE_INTERNAL,
703 .n_errors = ARRAY_LEN(ipsec_if_input_error_strings),
704 .error_strings = ipsec_if_input_error_strings,
705 .sibling_of = "ipsec6-input-feature",
710 * fd.io coding-style-patch-verification: ON
713 * eval: (c-set-style "gnu")