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/ip/ip4_input.h>
29 /* Statistics (not really errors) */
30 #define foreach_ipsec_tun_protect_input_error \
31 _(RX, "good packets received") \
32 _(DISABLED, "ipsec packets received on disabled interface") \
33 _(NO_TUNNEL, "no matching tunnel") \
34 _(TUNNEL_MISMATCH, "SPI-tunnel mismatch") \
35 _(NAT_KEEPALIVE, "NAT Keepalive") \
36 _(TOO_SHORT, "Too Short") \
39 static char *ipsec_tun_protect_input_error_strings[] = {
40 #define _(sym,string) string,
41 foreach_ipsec_tun_protect_input_error
47 #define _(sym,str) IPSEC_TUN_PROTECT_INPUT_ERROR_##sym,
48 foreach_ipsec_tun_protect_input_error
50 IPSEC_TUN_PROTECT_INPUT_N_ERROR,
51 } ipsec_tun_protect_input_error_t;
53 typedef enum ipsec_tun_next_t_
55 #define _(v, s) IPSEC_TUN_PROTECT_NEXT_##v,
56 foreach_ipsec_input_next
58 IPSEC_TUN_PROTECT_NEXT_DECRYPT,
59 IPSEC_TUN_PROTECT_N_NEXT,
66 ipsec4_tunnel_key_t key4;
67 ipsec6_tunnel_key_t key6;
71 } ipsec_tun_protect_input_trace_t;
74 format_ipsec_tun_protect_input_trace (u8 * s, va_list * args)
76 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
77 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
78 ipsec_tun_protect_input_trace_t *t =
79 va_arg (*args, ipsec_tun_protect_input_trace_t *);
82 s = format (s, "IPSec: %U seq %u",
83 format_ipsec6_tunnel_key, &t->key6, t->seq);
85 s = format (s, "IPSec: %U seq %u",
86 format_ipsec4_tunnel_key, &t->key4, t->seq);
91 ipsec_ip4_if_no_tunnel (vlib_node_runtime_t * node,
93 const esp_header_t * esp, const ip4_header_t * ip4)
95 if (PREDICT_FALSE (0 == esp->spi))
97 b->error = node->errors[IPSEC_TUN_PROTECT_INPUT_ERROR_SPI_0];
98 b->punt_reason = ipsec_punt_reason[(ip4->protocol == IP_PROTOCOL_UDP ?
99 IPSEC_PUNT_IP4_SPI_UDP_0 :
100 IPSEC_PUNT_IP4_NO_SUCH_TUNNEL)];
104 b->error = node->errors[IPSEC_TUN_PROTECT_INPUT_ERROR_NO_TUNNEL];
105 b->punt_reason = ipsec_punt_reason[IPSEC_PUNT_IP4_NO_SUCH_TUNNEL];
107 return IPSEC_INPUT_NEXT_PUNT;
111 ipsec_ip6_if_no_tunnel (vlib_node_runtime_t * node,
112 vlib_buffer_t * b, const esp_header_t * esp)
114 b->error = node->errors[IPSEC_TUN_PROTECT_INPUT_ERROR_NO_TUNNEL];
115 b->punt_reason = ipsec_punt_reason[IPSEC_PUNT_IP6_NO_SUCH_TUNNEL];
117 return (IPSEC_INPUT_NEXT_PUNT);
121 ipsec_tun_protect_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
122 vlib_frame_t * from_frame, int is_ip6)
124 ipsec_main_t *im = &ipsec_main;
125 vnet_main_t *vnm = im->vnet_main;
126 vnet_interface_main_t *vim = &vnm->interface_main;
128 int is_trace = node->flags & VLIB_NODE_FLAG_TRACE;
129 u32 thread_index = vm->thread_index;
131 u32 n_left_from, *from;
132 u16 nexts[VLIB_FRAME_SIZE], *next;
133 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b;
135 from = vlib_frame_vector_args (from_frame);
136 n_left_from = from_frame->n_vectors;
138 vlib_get_buffers (vm, from, bufs, n_left_from);
142 clib_memset_u16 (nexts, im->esp4_decrypt_next_index, n_left_from);
144 u64 n_bytes = 0, n_packets = 0;
145 u32 n_disabled = 0, n_no_tunnel = 0;
147 u32 last_sw_if_index = ~0;
148 ipsec_tun_lkup_result_t last_result = {
151 ipsec4_tunnel_key_t last_key4;
152 ipsec6_tunnel_key_t last_key6;
154 vlib_combined_counter_main_t *rx_counter;
155 vlib_combined_counter_main_t *drop_counter;
156 ipsec_tun_protect_t *itp0;
159 clib_memset (&last_key6, 0xff, sizeof (last_key6));
161 last_key4.as_u64 = ~0;
163 rx_counter = vim->combined_sw_if_counters + VNET_INTERFACE_COUNTER_RX;
164 drop_counter = vim->combined_sw_if_counters + VNET_INTERFACE_COUNTER_DROP;
166 while (n_left_from > 0)
168 u32 sw_if_index0, len0, hdr_sz0;
169 ipsec_tun_lkup_result_t itr0;
170 ipsec4_tunnel_key_t key40;
171 ipsec6_tunnel_key_t key60;
178 (ip4_header_t *) (b[0]->data + vnet_buffer (b[0])->l3_hdr_offset);
182 ip60 = (ip6_header_t *) ip40;
183 esp0 = (esp_header_t *) (ip60 + 1);
184 hdr_sz0 = sizeof (ip6_header_t);
188 /* NAT UDP port 4500 case, don't advance any more */
189 if (ip40->protocol == IP_PROTOCOL_UDP)
192 (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40) +
193 sizeof (udp_header_t));
195 buf_rewind0 = ip4_header_bytes (ip40) + sizeof (udp_header_t);
199 esp0 = (esp_header_t *) ((u8 *) ip40 + ip4_header_bytes (ip40));
200 buf_rewind0 = hdr_sz0 = ip4_header_bytes (ip40);
204 /* stats for the tunnel include all the data after the IP header
205 just like a norml IP-IP tunnel */
206 vlib_buffer_advance (b[0], hdr_sz0);
207 len0 = vlib_buffer_length_in_chain (vm, b[0]);
209 if (len0 < sizeof (esp_header_t))
211 if (esp0->spi_bytes[0] == 0xff)
213 node->errors[IPSEC_TUN_PROTECT_INPUT_ERROR_NAT_KEEPALIVE];
216 node->errors[IPSEC_TUN_PROTECT_INPUT_ERROR_TOO_SHORT];
218 next[0] = IPSEC_INPUT_NEXT_DROP;
224 key60.remote_ip = ip60->src_address;
225 key60.spi = esp0->spi;
227 if (memcmp (&key60, &last_key6, sizeof (last_key6)) == 0)
233 uword *p = hash_get_mem (im->tun6_protect_by_key, &key60);
238 clib_memcpy_fast (&last_key6, &key60, sizeof (key60));
242 next[0] = ipsec_ip6_if_no_tunnel (node, b[0], esp0);
250 key40.remote_ip = ip40->src_address;
251 key40.spi = esp0->spi;
253 if (key40.as_u64 == last_key4.as_u64)
259 uword *p = hash_get (im->tun4_protect_by_key, key40.as_u64);
264 last_key4.as_u64 = key40.as_u64;
268 next[0] = ipsec_ip4_if_no_tunnel (node, b[0], esp0, ip40);
269 vlib_buffer_advance (b[0], -buf_rewind0);
276 itp0 = pool_elt_at_index (ipsec_protect_pool, itr0.tun_index);
277 vnet_buffer (b[0])->ipsec.sad_index = itr0.sa_index;
278 vnet_buffer (b[0])->ipsec.protect_index = itr0.tun_index;
280 sw_if_index0 = itp0->itp_sw_if_index;
281 vnet_buffer (b[0])->sw_if_index[VLIB_RX] = sw_if_index0;
283 if (PREDICT_FALSE (!vnet_sw_interface_is_admin_up (vnm, sw_if_index0)))
285 vlib_increment_combined_counter
286 (drop_counter, thread_index, sw_if_index0, 1, len0);
288 b[0]->error = node->errors[IPSEC_TUN_PROTECT_INPUT_ERROR_DISABLED];
289 next[0] = IPSEC_INPUT_NEXT_DROP;
294 if (PREDICT_TRUE (sw_if_index0 == last_sw_if_index))
301 if (n_packets && !(itp0->itp_flags & IPSEC_PROTECT_ENCAPED))
303 vlib_increment_combined_counter
304 (rx_counter, thread_index, last_sw_if_index,
308 last_sw_if_index = sw_if_index0;
314 * compare the packet's outer IP headers to that of the tunnels
319 (!ip46_address_is_equal_v6
320 (&itp0->itp_crypto.dst, &ip60->src_address)
321 || !ip46_address_is_equal_v6 (&itp0->itp_crypto.src,
322 &ip60->dst_address)))
326 [IPSEC_TUN_PROTECT_INPUT_ERROR_TUNNEL_MISMATCH];
327 next[0] = IPSEC_INPUT_NEXT_DROP;
334 (!ip46_address_is_equal_v4
335 (&itp0->itp_crypto.dst, &ip40->src_address)
336 || !ip46_address_is_equal_v4 (&itp0->itp_crypto.src,
337 &ip40->dst_address)))
341 [IPSEC_TUN_PROTECT_INPUT_ERROR_TUNNEL_MISMATCH];
342 next[0] = IPSEC_INPUT_NEXT_DROP;
348 * There are two encap possibilities
349 * 1) the tunnel and ths SA are prodiving encap, i.e. it's
350 * MAC | SA-IP | TUN-IP | ESP | PAYLOAD
351 * implying the SA is in tunnel mode (on a tunnel interface)
352 * 2) only the tunnel provides encap
353 * MAC | TUN-IP | ESP | PAYLOAD
354 * implying the SA is in transport mode.
356 * For 2) we need only strip the tunnel encap and we're good.
357 * since the tunnel and crypto ecnap (int the tun=protect
358 * object) are the same and we verified above that these match
359 * for 1) we need to strip the SA-IP outer headers, to
360 * reveal the tunnel IP and then check that this matches
361 * the configured tunnel. this we can;t do here since it
362 * involves a lookup in the per-tunnel-type DB - so ship
363 * the packet to the tunnel-types provided node to do that
365 next[0] = IPSEC_TUN_PROTECT_NEXT_DECRYPT;
368 if (PREDICT_FALSE (is_trace))
370 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
372 ipsec_tun_protect_input_trace_t *tr =
373 vlib_add_trace (vm, node, b[0], sizeof (*tr));
375 clib_memcpy (&tr->key6, &key60, sizeof (tr->key6));
377 clib_memcpy (&tr->key4, &key40, sizeof (tr->key4));
381 sizeof (*esp0) ? clib_host_to_net_u32 (esp0->seq) : ~0;
391 if (n_packets && !(itp0->itp_flags & IPSEC_PROTECT_ENCAPED))
393 vlib_increment_combined_counter (rx_counter,
395 last_sw_if_index, n_packets, n_bytes);
398 vlib_node_increment_counter (vm, node->node_index,
399 IPSEC_TUN_PROTECT_INPUT_ERROR_RX,
400 from_frame->n_vectors - (n_disabled +
403 vlib_buffer_enqueue_to_next (vm, node, from, nexts, from_frame->n_vectors);
405 return from_frame->n_vectors;
408 VLIB_NODE_FN (ipsec4_tun_input_node) (vlib_main_t * vm,
409 vlib_node_runtime_t * node,
410 vlib_frame_t * from_frame)
412 return ipsec_tun_protect_input_inline (vm, node, from_frame,
417 VLIB_REGISTER_NODE (ipsec4_tun_input_node) = {
418 .name = "ipsec4-tun-input",
419 .vector_size = sizeof (u32),
420 .format_trace = format_ipsec_tun_protect_input_trace,
421 .type = VLIB_NODE_TYPE_INTERNAL,
422 .n_errors = ARRAY_LEN(ipsec_tun_protect_input_error_strings),
423 .error_strings = ipsec_tun_protect_input_error_strings,
424 .n_next_nodes = IPSEC_TUN_PROTECT_N_NEXT,
426 [IPSEC_TUN_PROTECT_NEXT_DROP] = "ip4-drop",
427 [IPSEC_TUN_PROTECT_NEXT_PUNT] = "punt-dispatch",
428 [IPSEC_TUN_PROTECT_NEXT_DECRYPT] = "esp4-decrypt-tun",
433 VLIB_NODE_FN (ipsec6_tun_input_node) (vlib_main_t * vm,
434 vlib_node_runtime_t * node,
435 vlib_frame_t * from_frame)
437 return ipsec_tun_protect_input_inline (vm, node, from_frame,
442 VLIB_REGISTER_NODE (ipsec6_tun_input_node) = {
443 .name = "ipsec6-tun-input",
444 .vector_size = sizeof (u32),
445 .format_trace = format_ipsec_tun_protect_input_trace,
446 .type = VLIB_NODE_TYPE_INTERNAL,
447 .n_errors = ARRAY_LEN(ipsec_tun_protect_input_error_strings),
448 .error_strings = ipsec_tun_protect_input_error_strings,
449 .n_next_nodes = IPSEC_TUN_PROTECT_N_NEXT,
451 [IPSEC_TUN_PROTECT_NEXT_DROP] = "ip6-drop",
452 [IPSEC_TUN_PROTECT_NEXT_PUNT] = "punt-dispatch",
453 [IPSEC_TUN_PROTECT_NEXT_DECRYPT] = "esp6-decrypt-tun",
459 * fd.io coding-style-patch-verification: ON
462 * eval: (c-set-style "gnu")