2 * ipsec_tun_protect_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>
26 #include <vnet/ipsec/ipsec_tun.h>
27 #include <vnet/ipsec/ipsec.api_enum.h>
28 #include <vnet/ip/ip4_input.h>
30 typedef vl_counter_ipsec_tun_enum_t ipsec_tun_protect_input_error_t;
32 typedef enum ipsec_tun_next_t_
34 #define _(v, s) IPSEC_TUN_PROTECT_NEXT_##v,
35 foreach_ipsec_input_next
37 IPSEC_TUN_PROTECT_N_NEXT,
44 ipsec4_tunnel_kv_t kv4;
45 ipsec6_tunnel_kv_t kv6;
49 } ipsec_tun_protect_input_trace_t;
52 format_ipsec_tun_protect_input_trace (u8 * s, va_list * args)
54 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
55 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
56 ipsec_tun_protect_input_trace_t *t =
57 va_arg (*args, ipsec_tun_protect_input_trace_t *);
60 s = format (s, "IPSec: %U seq %u",
61 format_ipsec6_tunnel_kv, &t->kv6, t->seq);
63 s = format (s, "IPSec: %U seq %u sa %d",
64 format_ipsec4_tunnel_kv, &t->kv4, t->seq);
69 ipsec_ip4_if_no_tunnel (vlib_node_runtime_t * node,
71 const esp_header_t * esp, const ip4_header_t * ip4)
73 if (PREDICT_FALSE (0 == esp->spi))
75 b->error = node->errors[IPSEC_TUN_ERROR_SPI_0];
76 b->punt_reason = ipsec_punt_reason[(ip4->protocol == IP_PROTOCOL_UDP ?
77 IPSEC_PUNT_IP4_SPI_UDP_0 :
78 IPSEC_PUNT_IP4_NO_SUCH_TUNNEL)];
82 b->error = node->errors[IPSEC_TUN_ERROR_NO_TUNNEL];
83 b->punt_reason = ipsec_punt_reason[IPSEC_PUNT_IP4_NO_SUCH_TUNNEL];
85 return VNET_DEVICE_INPUT_NEXT_PUNT;
89 ipsec_ip6_if_no_tunnel (vlib_node_runtime_t *node, vlib_buffer_t *b,
90 const esp_header_t *esp, const ip6_header_t *ip6)
92 if (PREDICT_FALSE (0 == esp->spi))
94 b->error = node->errors[IPSEC_TUN_ERROR_SPI_0];
95 b->punt_reason = ipsec_punt_reason[(ip6->protocol == IP_PROTOCOL_UDP ?
96 IPSEC_PUNT_IP6_SPI_UDP_0 :
97 IPSEC_PUNT_IP6_NO_SUCH_TUNNEL)];
101 b->error = node->errors[IPSEC_TUN_ERROR_NO_TUNNEL];
102 b->punt_reason = ipsec_punt_reason[IPSEC_PUNT_IP6_NO_SUCH_TUNNEL];
105 return VNET_DEVICE_INPUT_NEXT_PUNT;
109 ipsec_tun_protect_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
110 vlib_frame_t * from_frame, int is_ip6)
112 ipsec_main_t *im = &ipsec_main;
113 vnet_main_t *vnm = im->vnet_main;
114 vnet_interface_main_t *vim = &vnm->interface_main;
116 int is_trace = node->flags & VLIB_NODE_FLAG_TRACE;
117 u32 thread_index = vm->thread_index;
119 u32 n_left_from, *from;
120 u16 nexts[VLIB_FRAME_SIZE], *next;
121 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
123 from = vlib_frame_vector_args (from_frame);
124 n_left_from = from_frame->n_vectors;
126 vlib_get_buffers (vm, from, bufs, n_left_from);
131 nexts, is_ip6 ? im->esp6_decrypt_next_index : im->esp4_decrypt_next_index,
134 u64 n_bytes = 0, n_packets = 0;
135 u32 n_disabled = 0, n_no_tunnel = 0;
137 u32 last_sw_if_index = ~0;
138 ipsec_tun_lkup_result_t last_result = {
141 ipsec4_tunnel_kv_t last_key4;
142 ipsec6_tunnel_kv_t last_key6;
143 ipsec_tun_lkup_result_t itr0;
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));
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 > 0)
158 u32 sw_if_index0, len0, hdr_sz0;
159 clib_bihash_kv_24_16_t bkey60 = { 0 };
160 clib_bihash_kv_8_16_t bkey40 = { 0 };
161 ipsec4_tunnel_kv_t *key40;
162 ipsec6_tunnel_kv_t *key60;
169 (ip4_header_t *) (b[0]->data + vnet_buffer (b[0])->l3_hdr_offset);
171 key60 = (ipsec6_tunnel_kv_t *) & bkey60;
172 key40 = (ipsec4_tunnel_kv_t *) & bkey40;
176 ip60 = (ip6_header_t *) ip40;
177 if (ip60->protocol == IP_PROTOCOL_UDP)
179 /* NAT UDP port 4500 case, don't advance any more */
180 esp0 = (esp_header_t *) ((u8 *) ip60 + sizeof (ip6_header_t) +
181 sizeof (udp_header_t));
183 buf_rewind0 = sizeof (ip6_header_t) + sizeof (udp_header_t);
185 const udp_header_t *udp0 =
186 (udp_header_t *) ((u8 *) ip60 + sizeof (ip6_header_t));
188 /* length 9 = sizeof(udp_header) + 1 byte of special SPI */
189 if (clib_net_to_host_u16 (udp0->length) == 9 &&
190 esp0->spi_bytes[0] == 0xff)
192 b[0]->error = node->errors[IPSEC_TUN_ERROR_NAT_KEEPALIVE];
194 next[0] = VNET_DEVICE_INPUT_NEXT_IP6_DROP;
197 vlib_buffer_advance (b[0], -buf_rewind0);
203 esp0 = (esp_header_t *) (ip60 + 1);
204 buf_rewind0 = hdr_sz0 = sizeof (ip6_header_t);
209 if (ip40->protocol == IP_PROTOCOL_UDP)
211 /* NAT UDP port 4500 case, don't advance any more */
213 (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40) +
214 sizeof (udp_header_t));
216 buf_rewind0 = ip4_header_bytes (ip40) + sizeof (udp_header_t);
218 const udp_header_t *udp0 =
219 (udp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40));
221 /* length 9 = sizeof(udp_header) + 1 byte of special SPI */
222 if (clib_net_to_host_u16 (udp0->length) == 9 &&
223 esp0->spi_bytes[0] == 0xff)
225 b[0]->error = node->errors[IPSEC_TUN_ERROR_NAT_KEEPALIVE];
227 next[0] = VNET_DEVICE_INPUT_NEXT_IP4_DROP;
230 vlib_buffer_advance (b[0], -buf_rewind0);
236 esp0 = (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40));
237 buf_rewind0 = hdr_sz0 = ip4_header_bytes (ip40);
241 /* stats for the tunnel include all the data after the IP header
242 just like a norml IP-IP tunnel */
243 vlib_buffer_advance (b[0], hdr_sz0);
244 len0 = vlib_buffer_length_in_chain (vm, b[0]);
246 if (len0 < sizeof (esp_header_t))
248 b[0]->error = node->errors[IPSEC_TUN_ERROR_TOO_SHORT];
250 next[0] = is_ip6 ? VNET_DEVICE_INPUT_NEXT_IP6_DROP :
251 VNET_DEVICE_INPUT_NEXT_IP4_DROP;
252 vlib_buffer_advance (b[0], -buf_rewind0);
258 key60->key.remote_ip = ip60->src_address;
259 key60->key.spi = esp0->spi;
260 key60->key.__pad = 0;
262 if (memcmp (key60, &last_key6, sizeof (last_key6)) == 0)
264 clib_memcpy_fast (&itr0, &last_result, sizeof (itr0));
269 clib_bihash_search_inline_24_16 (&im->tun6_protect_by_key,
273 clib_memcpy_fast (&itr0, &bkey60.value, sizeof (itr0));
274 clib_memcpy_fast (&last_result, &bkey60.value,
275 sizeof (last_result));
276 clib_memcpy_fast (&last_key6, key60, sizeof (last_key6));
280 next[0] = ipsec_ip6_if_no_tunnel (node, b[0], esp0, ip60);
281 vlib_buffer_advance (b[0], -buf_rewind0);
289 ipsec4_tunnel_mk_key (key40, &ip40->src_address, esp0->spi);
291 if (key40->key == last_key4.key)
293 clib_memcpy_fast (&itr0, &last_result, sizeof (itr0));
298 clib_bihash_search_inline_8_16 (&im->tun4_protect_by_key,
302 clib_memcpy_fast (&itr0, &bkey40.value, sizeof (itr0));
303 clib_memcpy_fast (&last_result, &bkey40.value,
304 sizeof (last_result));
305 last_key4.key = key40->key;
309 next[0] = ipsec_ip4_if_no_tunnel (node, b[0], esp0, ip40);
310 vlib_buffer_advance (b[0], -buf_rewind0);
317 vnet_buffer (b[0])->ipsec.sad_index = itr0.sa_index;
318 vnet_buffer (b[0])->ipsec.protect_index = itr0.tun_index;
320 sw_if_index0 = itr0.sw_if_index;
321 vnet_buffer (b[0])->sw_if_index[VLIB_RX] = sw_if_index0;
323 if (PREDICT_FALSE (!vnet_sw_interface_is_admin_up (vnm, sw_if_index0)))
325 vlib_increment_combined_counter
326 (drop_counter, thread_index, sw_if_index0, 1, len0);
328 b[0]->error = node->errors[IPSEC_TUN_ERROR_DISABLED];
329 next[0] = is_ip6 ? VNET_DEVICE_INPUT_NEXT_IP6_DROP :
330 VNET_DEVICE_INPUT_NEXT_IP4_DROP;
335 if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
342 if (n_packets && !(itr0.flags & IPSEC_PROTECT_ENCAPED))
344 vlib_increment_combined_counter
345 (rx_counter, thread_index, last_sw_if_index,
349 last_sw_if_index = sw_if_index0;
354 //IPSEC_TUN_PROTECT_NEXT_DECRYPT;
355 next[0] = is_ip6 ? im->esp6_decrypt_tun_next_index :
356 im->esp4_decrypt_tun_next_index;
358 if (itr0.flags & IPSEC_PROTECT_FEAT)
361 u8 arc = feature_main.device_input_feature_arc_index;
364 vnet_feature_arc_start (arc, sw_if_index0, &next32, b[0]);
369 if (PREDICT_FALSE (is_trace))
371 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
373 ipsec_tun_protect_input_trace_t *tr =
374 vlib_add_trace (vm, node, b[0], sizeof (*tr));
376 clib_memcpy (&tr->kv6, &bkey60, sizeof (tr->kv6));
378 clib_memcpy (&tr->kv4, &bkey40, sizeof (tr->kv4));
380 tr->seq = (len0 >= sizeof (*esp0) ?
381 clib_host_to_net_u32 (esp0->seq) : ~0);
391 if (n_packets && !(itr0.flags & IPSEC_PROTECT_ENCAPED))
392 vlib_increment_combined_counter (rx_counter,
394 last_sw_if_index, n_packets, n_bytes);
396 vlib_node_increment_counter (vm, node->node_index, IPSEC_TUN_ERROR_RX,
397 from_frame->n_vectors -
398 (n_disabled + n_no_tunnel));
399 vlib_node_increment_counter (vm, node->node_index, IPSEC_TUN_ERROR_NO_TUNNEL,
402 vlib_buffer_enqueue_to_next (vm, node, from, nexts, from_frame->n_vectors);
404 return from_frame->n_vectors;
407 VLIB_NODE_FN (ipsec4_tun_input_node) (vlib_main_t * vm,
408 vlib_node_runtime_t * node,
409 vlib_frame_t * from_frame)
411 return ipsec_tun_protect_input_inline (vm, node, from_frame, 0);
414 VLIB_REGISTER_NODE (ipsec4_tun_input_node) = {
415 .name = "ipsec4-tun-input",
416 .vector_size = sizeof (u32),
417 .format_trace = format_ipsec_tun_protect_input_trace,
418 .type = VLIB_NODE_TYPE_INTERNAL,
419 .n_errors = IPSEC_TUN_N_ERROR,
420 .error_counters = ipsec_tun_error_counters,
421 .sibling_of = "device-input",
424 VLIB_NODE_FN (ipsec6_tun_input_node) (vlib_main_t * vm,
425 vlib_node_runtime_t * node,
426 vlib_frame_t * from_frame)
428 return ipsec_tun_protect_input_inline (vm, node, from_frame, 1);
431 VLIB_REGISTER_NODE (ipsec6_tun_input_node) = {
432 .name = "ipsec6-tun-input",
433 .vector_size = sizeof (u32),
434 .format_trace = format_ipsec_tun_protect_input_trace,
435 .type = VLIB_NODE_TYPE_INTERNAL,
436 .n_errors = IPSEC_TUN_N_ERROR,
437 .error_counters = ipsec_tun_error_counters,
438 .sibling_of = "device-input",
442 * fd.io coding-style-patch-verification: ON
445 * eval: (c-set-style "gnu")