2 * ipsec_output.c : IPSec output 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>
26 #define foreach_ipsec_output_error \
27 _(RX_PKTS, "IPSec pkts received") \
28 _(POLICY_DISCARD, "IPSec policy discard") \
29 _(POLICY_NO_MATCH, "IPSec policy (no match)") \
30 _(POLICY_PROTECT, "IPSec policy protect") \
31 _(POLICY_BYPASS, "IPSec policy bypass") \
32 _(ENCAPS_FAILED, "IPSec encapsulation failed")
36 #define _(sym,str) IPSEC_OUTPUT_ERROR_##sym,
37 foreach_ipsec_output_error
40 } ipsec_output_error_t;
42 static char *ipsec_output_error_strings[] = {
43 #define _(sym,string) string,
44 foreach_ipsec_output_error
48 static vlib_node_registration_t ipsec_output_ip4_node;
49 static vlib_node_registration_t ipsec_output_ip6_node;
54 } ipsec_output_trace_t;
56 /* packet trace format function */
58 format_ipsec_output_trace (u8 * s, va_list * args)
60 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
61 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
62 ipsec_output_trace_t *t = va_arg (*args, ipsec_output_trace_t *);
66 s = format (s, "spd %u ", t->spd_id);
70 s = format (s, "no spd");
75 always_inline ipsec_policy_t *
76 ipsec_output_policy_match (ipsec_spd_t * spd, u8 pr, u32 la, u32 ra, u16 lp,
85 vec_foreach (i, spd->ipv4_outbound_policies)
87 p = pool_elt_at_index (spd->policies, *i);
88 if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
91 if (ra < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
94 if (ra > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
97 if (la < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
100 if (la > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
104 ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
105 && (pr != IP_PROTOCOL_SCTP)))
108 if (lp < p->lport.start)
111 if (lp > p->lport.stop)
114 if (rp < p->rport.start)
117 if (rp > p->rport.stop)
126 ip6_addr_match_range (ip6_address_t * a, ip6_address_t * la,
129 if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
130 (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
135 always_inline ipsec_policy_t *
136 ipsec_output_ip6_policy_match (ipsec_spd_t * spd,
138 ip6_address_t * ra, u16 lp, u16 rp, u8 pr)
146 vec_foreach (i, spd->ipv6_outbound_policies)
148 p = pool_elt_at_index (spd->policies, *i);
149 if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
152 if (!ip6_addr_match_range (ra, &p->raddr.start.ip6, &p->raddr.stop.ip6))
155 if (!ip6_addr_match_range (la, &p->laddr.start.ip6, &p->laddr.stop.ip6))
159 ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
160 && (pr != IP_PROTOCOL_SCTP)))
163 if (lp < p->lport.start)
166 if (lp > p->lport.stop)
169 if (rp < p->rport.start)
172 if (rp > p->rport.stop)
182 ipsec_output_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
183 vlib_frame_t * from_frame, int is_ipv6)
185 ipsec_main_t *im = &ipsec_main;
187 u32 *from, *to_next = 0;
188 u32 n_left_from, sw_if_index0, last_sw_if_index = (u32) ~ 0;
189 u32 next_node_index = (u32) ~ 0, last_next_node_index = (u32) ~ 0;
192 ipsec_spd_t *spd0 = 0;
194 u64 nc_protect = 0, nc_bypass = 0, nc_discard = 0, nc_nomatch = 0;
196 from = vlib_frame_vector_args (from_frame);
197 n_left_from = from_frame->n_vectors;
199 while (n_left_from > 0)
205 ip6_header_t *ip6_0 = 0;
211 b0 = vlib_get_buffer (vm, bi0);
212 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
213 iph_offset = vnet_buffer (b0)->ip.save_rewrite_length;
214 ip0 = (ip4_header_t *) ((u8 *) vlib_buffer_get_current (b0)
217 /* lookup for SPD only if sw_if_index is changed */
218 if (PREDICT_FALSE (last_sw_if_index != sw_if_index0))
220 uword *p = hash_get (im->spd_index_by_sw_if_index, sw_if_index0);
223 spd0 = pool_elt_at_index (im->spds, spd_index0);
224 last_sw_if_index = sw_if_index0;
229 ip6_0 = (ip6_header_t *) ((u8 *) vlib_buffer_get_current (b0)
232 udp0 = ip6_next_header (ip6_0);
235 ("packet received from %U port %u to %U port %u spd_id %u",
236 format_ip6_address, &ip6_0->src_address,
237 clib_net_to_host_u16 (udp0->src_port), format_ip6_address,
238 &ip6_0->dst_address, clib_net_to_host_u16 (udp0->dst_port),
242 p0 = ipsec_output_ip6_policy_match (spd0,
253 udp0 = (udp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
256 clib_warning ("packet received from %U to %U port %u",
257 format_ip4_address, ip0->src_address.as_u8,
258 format_ip4_address, ip0->dst_address.as_u8,
259 clib_net_to_host_u16 (udp0->dst_port));
260 clib_warning ("sw_if_index0 %u spd_index0 %u spd_id %u",
261 sw_if_index0, spd_index0, spd0->id);
264 p0 = ipsec_output_policy_match (spd0, ip0->protocol,
266 (ip0->src_address.as_u32),
268 (ip0->dst_address.as_u32),
274 tcp0 = (void *) udp0;
276 if (PREDICT_TRUE (p0 != NULL))
278 if (p0->policy == IPSEC_POLICY_ACTION_PROTECT)
282 sa = pool_elt_at_index (im->sad, p0->sa_index);
283 if (sa->protocol == IPSEC_PROTOCOL_ESP)
284 next_node_index = im->esp_encrypt_node_index;
286 next_node_index = im->ah_encrypt_node_index;
287 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
288 p0->counter.packets++;
292 clib_net_to_host_u16 (ip6_0->payload_length);
293 p0->counter.bytes += sizeof (ip6_header_t);
295 (b0->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM))
298 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6_0,
300 b0->flags &= ~VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
303 (b0->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))
306 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6_0,
308 b0->flags &= ~VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
313 p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
314 if (b0->flags & VNET_BUFFER_F_OFFLOAD_IP_CKSUM)
316 ip0->checksum = ip4_header_checksum (ip0);
317 b0->flags &= ~VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
320 (b0->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM))
323 ip4_tcp_udp_compute_checksum (vm, b0, ip0);
324 b0->flags &= ~VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
327 (b0->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))
330 ip4_tcp_udp_compute_checksum (vm, b0, ip0);
331 b0->flags &= ~VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
334 vlib_buffer_advance (b0, iph_offset);
336 else if (p0->policy == IPSEC_POLICY_ACTION_BYPASS)
339 next_node_index = get_next_output_feature_node_index (b0, node);
340 p0->counter.packets++;
344 clib_net_to_host_u16 (ip6_0->payload_length);
345 p0->counter.bytes += sizeof (ip6_header_t);
349 p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
355 p0->counter.packets++;
359 clib_net_to_host_u16 (ip6_0->payload_length);
360 p0->counter.bytes += sizeof (ip6_header_t);
364 p0->counter.bytes += clib_net_to_host_u16 (ip0->length);
366 next_node_index = im->error_drop_node_index;
372 next_node_index = im->error_drop_node_index;
378 if (PREDICT_FALSE ((last_next_node_index != next_node_index) || f == 0))
380 /* if this is not 1st frame */
382 vlib_put_frame_to_node (vm, last_next_node_index, f);
384 last_next_node_index = next_node_index;
386 f = vlib_get_frame_to_node (vm, next_node_index);
387 to_next = vlib_frame_vector_args (f);
394 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
396 ipsec_output_trace_t *tr =
397 vlib_add_trace (vm, node, b0, sizeof (*tr));
399 tr->spd_id = spd0->id;
403 vlib_put_frame_to_node (vm, next_node_index, f);
404 vlib_node_increment_counter (vm, node->node_index,
405 IPSEC_OUTPUT_ERROR_POLICY_PROTECT, nc_protect);
406 vlib_node_increment_counter (vm, node->node_index,
407 IPSEC_OUTPUT_ERROR_POLICY_BYPASS, nc_bypass);
408 vlib_node_increment_counter (vm, node->node_index,
409 IPSEC_OUTPUT_ERROR_POLICY_DISCARD, nc_discard);
410 vlib_node_increment_counter (vm, node->node_index,
411 IPSEC_OUTPUT_ERROR_POLICY_NO_MATCH,
413 return from_frame->n_vectors;
417 ipsec_output_ip4_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
418 vlib_frame_t * frame)
420 return ipsec_output_inline (vm, node, frame, 0);
424 VLIB_REGISTER_NODE (ipsec_output_ip4_node,static) = {
425 .function = ipsec_output_ip4_node_fn,
426 .name = "ipsec-output-ip4",
427 .vector_size = sizeof (u32),
428 .format_trace = format_ipsec_output_trace,
429 .type = VLIB_NODE_TYPE_INTERNAL,
431 .n_errors = ARRAY_LEN(ipsec_output_error_strings),
432 .error_strings = ipsec_output_error_strings,
434 .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
436 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
437 foreach_ipsec_output_next
443 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_output_ip4_node, ipsec_output_ip4_node_fn)
445 ipsec_output_ip6_node_fn (vlib_main_t * vm, vlib_node_runtime_t * node,
446 vlib_frame_t * frame)
448 return ipsec_output_inline (vm, node, frame, 1);
452 VLIB_REGISTER_NODE (ipsec_output_ip6_node,static) = {
453 .function = ipsec_output_ip6_node_fn,
454 .name = "ipsec-output-ip6",
455 .vector_size = sizeof (u32),
456 .format_trace = format_ipsec_output_trace,
457 .type = VLIB_NODE_TYPE_INTERNAL,
459 .n_errors = ARRAY_LEN(ipsec_output_error_strings),
460 .error_strings = ipsec_output_error_strings,
462 .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
464 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
465 foreach_ipsec_output_next
471 VLIB_NODE_FUNCTION_MULTIARCH (ipsec_output_ip6_node, ipsec_output_ip6_node_fn)
472 #else /* IPSEC > 1 */
474 /* Dummy ipsec output node, in case when IPSec is disabled */
477 ipsec_output_node_fn (vlib_main_t * vm,
478 vlib_node_runtime_t * node, vlib_frame_t * frame)
480 clib_warning ("IPSec disabled");
485 VLIB_REGISTER_NODE (ipsec_output_node) = {
486 .vector_size = sizeof (u32),
487 .function = ipsec_output_node_fn,
488 .name = "ipsec-output-ip4",
491 VLIB_REGISTER_NODE (ipsec_output_node) = {
492 .vector_size = sizeof (u32),
493 .function = ipsec_output_node_fn,
494 .name = "ipsec-output-ip6",
500 * fd.io coding-style-patch-verification: ON
503 * eval: (c-set-style "gnu")