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
52 } ipsec_output_trace_t;
54 /* packet trace format function */
56 format_ipsec_output_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_output_trace_t *t = va_arg (*args, ipsec_output_trace_t *);
62 s = format (s, "spd %u policy %d", t->spd_id, t->policy_id);
67 always_inline ipsec_policy_t *
68 ipsec_output_policy_match (ipsec_spd_t * spd, u8 pr, u32 la, u32 ra, u16 lp,
71 ipsec_main_t *im = &ipsec_main;
78 vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP4_OUTBOUND])
80 p = pool_elt_at_index (im->policies, *i);
81 if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
84 if (ra < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
87 if (ra > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
90 if (la < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
93 if (la > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
97 ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
98 && (pr != IP_PROTOCOL_SCTP)))
101 if (lp < p->lport.start)
104 if (lp > p->lport.stop)
107 if (rp < p->rport.start)
110 if (rp > p->rport.stop)
119 ip6_addr_match_range (ip6_address_t * a, ip6_address_t * la,
122 if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
123 (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
128 always_inline ipsec_policy_t *
129 ipsec6_output_policy_match (ipsec_spd_t * spd,
131 ip6_address_t * ra, u16 lp, u16 rp, u8 pr)
133 ipsec_main_t *im = &ipsec_main;
140 vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP6_OUTBOUND])
142 p = pool_elt_at_index (im->policies, *i);
143 if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
146 if (!ip6_addr_match_range (ra, &p->raddr.start.ip6, &p->raddr.stop.ip6))
149 if (!ip6_addr_match_range (la, &p->laddr.start.ip6, &p->laddr.stop.ip6))
153 ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
154 && (pr != IP_PROTOCOL_SCTP)))
157 if (lp < p->lport.start)
160 if (lp > p->lport.stop)
163 if (rp < p->rport.start)
166 if (rp > p->rport.stop)
176 ipsec_output_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
177 vlib_frame_t * from_frame, int is_ipv6)
179 ipsec_main_t *im = &ipsec_main;
181 u32 *from, *to_next = 0, thread_index;
182 u32 n_left_from, sw_if_index0, last_sw_if_index = (u32) ~ 0;
183 u32 next_node_index = (u32) ~ 0, last_next_node_index = (u32) ~ 0;
186 ipsec_spd_t *spd0 = 0;
188 u64 nc_protect = 0, nc_bypass = 0, nc_discard = 0, nc_nomatch = 0;
190 from = vlib_frame_vector_args (from_frame);
191 n_left_from = from_frame->n_vectors;
192 thread_index = vm->thread_index;
194 while (n_left_from > 0)
200 ip6_header_t *ip6_0 = 0;
207 b0 = vlib_get_buffer (vm, bi0);
208 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
209 iph_offset = vnet_buffer (b0)->ip.save_rewrite_length;
210 ip0 = (ip4_header_t *) ((u8 *) vlib_buffer_get_current (b0)
213 /* lookup for SPD only if sw_if_index is changed */
214 if (PREDICT_FALSE (last_sw_if_index != sw_if_index0))
216 uword *p = hash_get (im->spd_index_by_sw_if_index, sw_if_index0);
219 spd0 = pool_elt_at_index (im->spds, spd_index0);
220 last_sw_if_index = sw_if_index0;
225 ip6_0 = (ip6_header_t *) ((u8 *) vlib_buffer_get_current (b0)
228 udp0 = ip6_next_header (ip6_0);
231 ("packet received from %U port %u to %U port %u spd_id %u",
232 format_ip6_address, &ip6_0->src_address,
233 clib_net_to_host_u16 (udp0->src_port), format_ip6_address,
234 &ip6_0->dst_address, clib_net_to_host_u16 (udp0->dst_port),
238 p0 = ipsec6_output_policy_match (spd0,
244 (udp0->dst_port), ip6_0->protocol);
248 udp0 = (udp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
251 clib_warning ("packet received from %U to %U port %u",
252 format_ip4_address, ip0->src_address.as_u8,
253 format_ip4_address, ip0->dst_address.as_u8,
254 clib_net_to_host_u16 (udp0->dst_port));
255 clib_warning ("sw_if_index0 %u spd_index0 %u spd_id %u",
256 sw_if_index0, spd_index0, spd0->id);
259 p0 = ipsec_output_policy_match (spd0, ip0->protocol,
261 (ip0->src_address.as_u32),
263 (ip0->dst_address.as_u32),
269 tcp0 = (void *) udp0;
271 if (PREDICT_TRUE (p0 != NULL))
273 pi0 = p0 - im->policies;
275 vlib_prefetch_combined_counter (&ipsec_spd_policy_counters,
280 bytes0 = clib_net_to_host_u16 (ip6_0->payload_length);
281 bytes0 += sizeof (ip6_header_t);
285 bytes0 = clib_net_to_host_u16 (ip0->length);
288 if (p0->policy == IPSEC_POLICY_ACTION_PROTECT)
292 sa = pool_elt_at_index (im->sad, p0->sa_index);
293 if (sa->protocol == IPSEC_PROTOCOL_ESP)
295 next_node_index = im->esp6_encrypt_node_index;
297 next_node_index = im->esp4_encrypt_node_index;
299 next_node_index = im->ah6_encrypt_node_index;
301 next_node_index = im->ah4_encrypt_node_index;
302 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
307 (b0->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM))
310 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6_0,
312 b0->flags &= ~VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
315 (b0->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))
318 ip6_tcp_udp_icmp_compute_checksum (vm, b0, ip6_0,
320 b0->flags &= ~VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
325 if (b0->flags & VNET_BUFFER_F_OFFLOAD_IP_CKSUM)
327 ip0->checksum = ip4_header_checksum (ip0);
328 b0->flags &= ~VNET_BUFFER_F_OFFLOAD_IP_CKSUM;
331 (b0->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM))
334 ip4_tcp_udp_compute_checksum (vm, b0, ip0);
335 b0->flags &= ~VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
338 (b0->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))
341 ip4_tcp_udp_compute_checksum (vm, b0, ip0);
342 b0->flags &= ~VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
345 vlib_buffer_advance (b0, iph_offset);
347 else if (p0->policy == IPSEC_POLICY_ACTION_BYPASS)
350 next_node_index = get_next_output_feature_node_index (b0, node);
355 next_node_index = im->error_drop_node_index;
357 vlib_increment_combined_counter
358 (&ipsec_spd_policy_counters, thread_index, pi0, 1, bytes0);
364 next_node_index = im->error_drop_node_index;
370 if (PREDICT_FALSE ((last_next_node_index != next_node_index) || f == 0))
372 /* if this is not 1st frame */
374 vlib_put_frame_to_node (vm, last_next_node_index, f);
376 last_next_node_index = next_node_index;
378 f = vlib_get_frame_to_node (vm, next_node_index);
380 /* frame->frame_flags, copy it from node */
381 /* Copy trace flag from next_frame and from runtime. */
382 f->frame_flags |= node->flags & VLIB_NODE_FLAG_TRACE;
384 to_next = vlib_frame_vector_args (f);
391 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE) &&
392 PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
394 ipsec_output_trace_t *tr =
395 vlib_add_trace (vm, node, b0, sizeof (*tr));
397 tr->spd_id = spd0->id;
402 vlib_put_frame_to_node (vm, next_node_index, f);
403 vlib_node_increment_counter (vm, node->node_index,
404 IPSEC_OUTPUT_ERROR_POLICY_PROTECT, nc_protect);
405 vlib_node_increment_counter (vm, node->node_index,
406 IPSEC_OUTPUT_ERROR_POLICY_BYPASS, nc_bypass);
407 vlib_node_increment_counter (vm, node->node_index,
408 IPSEC_OUTPUT_ERROR_POLICY_DISCARD, nc_discard);
409 vlib_node_increment_counter (vm, node->node_index,
410 IPSEC_OUTPUT_ERROR_POLICY_NO_MATCH,
412 return from_frame->n_vectors;
415 VLIB_NODE_FN (ipsec4_output_node) (vlib_main_t * vm,
416 vlib_node_runtime_t * node,
417 vlib_frame_t * frame)
419 return ipsec_output_inline (vm, node, frame, 0);
423 VLIB_REGISTER_NODE (ipsec4_output_node) = {
424 .name = "ipsec4-output-feature",
425 .vector_size = sizeof (u32),
426 .format_trace = format_ipsec_output_trace,
427 .type = VLIB_NODE_TYPE_INTERNAL,
429 .n_errors = ARRAY_LEN(ipsec_output_error_strings),
430 .error_strings = ipsec_output_error_strings,
432 .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
434 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
435 foreach_ipsec_output_next
441 VLIB_NODE_FN (ipsec6_output_node) (vlib_main_t * vm,
442 vlib_node_runtime_t * node,
443 vlib_frame_t * frame)
445 return ipsec_output_inline (vm, node, frame, 1);
449 VLIB_REGISTER_NODE (ipsec6_output_node) = {
450 .name = "ipsec6-output-feature",
451 .vector_size = sizeof (u32),
452 .format_trace = format_ipsec_output_trace,
453 .type = VLIB_NODE_TYPE_INTERNAL,
455 .n_errors = ARRAY_LEN(ipsec_output_error_strings),
456 .error_strings = ipsec_output_error_strings,
458 .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
460 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
461 foreach_ipsec_output_next
467 #else /* IPSEC > 1 */
469 /* Dummy ipsec output node, in case when IPSec is disabled */
472 ipsec_output_node_fn (vlib_main_t * vm,
473 vlib_node_runtime_t * node, vlib_frame_t * frame)
475 clib_warning ("IPSec disabled");
480 VLIB_REGISTER_NODE (ipsec4_output_node) = {
481 .vector_size = sizeof (u32),
482 .function = ipsec_output_node_fn,
483 .name = "ipsec4-output-feature",
486 VLIB_REGISTER_NODE (ipsec6_output_node) = {
487 .vector_size = sizeof (u32),
488 .function = ipsec_output_node_fn,
489 .name = "ipsec6-output-feature",
495 * fd.io coding-style-patch-verification: ON
498 * eval: (c-set-style "gnu")