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>
23 #include <vnet/ipsec/ipsec_io.h>
27 #define foreach_ipsec_output_error \
28 _(RX_PKTS, "IPSec pkts received") \
29 _(POLICY_DISCARD, "IPSec policy discard") \
30 _(POLICY_NO_MATCH, "IPSec policy (no match)") \
31 _(POLICY_PROTECT, "IPSec policy protect") \
32 _(POLICY_BYPASS, "IPSec policy bypass") \
33 _(ENCAPS_FAILED, "IPSec encapsulation failed")
37 #define _(sym,str) IPSEC_OUTPUT_ERROR_##sym,
38 foreach_ipsec_output_error
41 } ipsec_output_error_t;
43 static char *ipsec_output_error_strings[] = {
44 #define _(sym,string) string,
45 foreach_ipsec_output_error
53 } ipsec_output_trace_t;
55 /* packet trace format function */
57 format_ipsec_output_trace (u8 * s, va_list * args)
59 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
60 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
61 ipsec_output_trace_t *t = va_arg (*args, ipsec_output_trace_t *);
63 s = format (s, "spd %u policy %d", t->spd_id, t->policy_id);
68 always_inline ipsec_policy_t *
69 ipsec_output_policy_match (ipsec_spd_t * spd, u8 pr, u32 la, u32 ra, u16 lp,
72 ipsec_main_t *im = &ipsec_main;
79 vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP4_OUTBOUND])
81 p = pool_elt_at_index (im->policies, *i);
82 if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
85 if (ra < clib_net_to_host_u32 (p->raddr.start.ip4.as_u32))
88 if (ra > clib_net_to_host_u32 (p->raddr.stop.ip4.as_u32))
91 if (la < clib_net_to_host_u32 (p->laddr.start.ip4.as_u32))
94 if (la > clib_net_to_host_u32 (p->laddr.stop.ip4.as_u32))
98 ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
99 && (pr != IP_PROTOCOL_SCTP)))
102 if (lp < p->lport.start)
105 if (lp > p->lport.stop)
108 if (rp < p->rport.start)
111 if (rp > p->rport.stop)
120 ip6_addr_match_range (ip6_address_t * a, ip6_address_t * la,
123 if ((memcmp (a->as_u64, la->as_u64, 2 * sizeof (u64)) >= 0) &&
124 (memcmp (a->as_u64, ua->as_u64, 2 * sizeof (u64)) <= 0))
129 always_inline ipsec_policy_t *
130 ipsec6_output_policy_match (ipsec_spd_t * spd,
132 ip6_address_t * ra, u16 lp, u16 rp, u8 pr)
134 ipsec_main_t *im = &ipsec_main;
141 vec_foreach (i, spd->policies[IPSEC_SPD_POLICY_IP6_OUTBOUND])
143 p = pool_elt_at_index (im->policies, *i);
144 if (PREDICT_FALSE (p->protocol && (p->protocol != pr)))
147 if (!ip6_addr_match_range (ra, &p->raddr.start.ip6, &p->raddr.stop.ip6))
150 if (!ip6_addr_match_range (la, &p->laddr.start.ip6, &p->laddr.stop.ip6))
154 ((pr != IP_PROTOCOL_TCP) && (pr != IP_PROTOCOL_UDP)
155 && (pr != IP_PROTOCOL_SCTP)))
158 if (lp < p->lport.start)
161 if (lp > p->lport.stop)
164 if (rp < p->rport.start)
167 if (rp > p->rport.stop)
177 ipsec_output_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
178 vlib_frame_t * from_frame, int is_ipv6)
180 ipsec_main_t *im = &ipsec_main;
182 u32 *from, *to_next = 0, thread_index;
183 u32 n_left_from, sw_if_index0, last_sw_if_index = (u32) ~ 0;
184 u32 next_node_index = (u32) ~ 0, last_next_node_index = (u32) ~ 0;
187 ipsec_spd_t *spd0 = 0;
189 u64 nc_protect = 0, nc_bypass = 0, nc_discard = 0, nc_nomatch = 0;
191 from = vlib_frame_vector_args (from_frame);
192 n_left_from = from_frame->n_vectors;
193 thread_index = vm->thread_index;
195 while (n_left_from > 0)
198 vlib_buffer_t *b0, *b1;
201 ip6_header_t *ip6_0 = 0;
208 b0 = vlib_get_buffer (vm, bi0);
212 b1 = vlib_get_buffer (vm, bi1);
213 CLIB_PREFETCH (b1, CLIB_CACHE_LINE_BYTES * 2, STORE);
214 vlib_prefetch_buffer_data (b1, LOAD);
216 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
217 iph_offset = vnet_buffer (b0)->ip.save_rewrite_length;
218 ip0 = (ip4_header_t *) ((u8 *) vlib_buffer_get_current (b0)
221 /* lookup for SPD only if sw_if_index is changed */
222 if (PREDICT_FALSE (last_sw_if_index != sw_if_index0))
224 uword *p = hash_get (im->spd_index_by_sw_if_index, sw_if_index0);
227 spd0 = pool_elt_at_index (im->spds, spd_index0);
228 last_sw_if_index = sw_if_index0;
233 ip6_0 = (ip6_header_t *) ((u8 *) vlib_buffer_get_current (b0)
236 udp0 = ip6_next_header (ip6_0);
239 ("packet received from %U port %u to %U port %u spd_id %u",
240 format_ip6_address, &ip6_0->src_address,
241 clib_net_to_host_u16 (udp0->src_port), format_ip6_address,
242 &ip6_0->dst_address, clib_net_to_host_u16 (udp0->dst_port),
246 p0 = ipsec6_output_policy_match (spd0,
252 (udp0->dst_port), ip6_0->protocol);
256 udp0 = (udp_header_t *) ((u8 *) ip0 + ip4_header_bytes (ip0));
259 clib_warning ("packet received from %U to %U port %u",
260 format_ip4_address, ip0->src_address.as_u8,
261 format_ip4_address, ip0->dst_address.as_u8,
262 clib_net_to_host_u16 (udp0->dst_port));
263 clib_warning ("sw_if_index0 %u spd_index0 %u spd_id %u",
264 sw_if_index0, spd_index0, spd0->id);
267 p0 = ipsec_output_policy_match (spd0, ip0->protocol,
269 (ip0->src_address.as_u32),
271 (ip0->dst_address.as_u32),
277 tcp0 = (void *) udp0;
279 if (PREDICT_TRUE (p0 != NULL))
281 pi0 = p0 - im->policies;
283 vlib_prefetch_combined_counter (&ipsec_spd_policy_counters,
288 bytes0 = clib_net_to_host_u16 (ip6_0->payload_length);
289 bytes0 += sizeof (ip6_header_t);
293 bytes0 = clib_net_to_host_u16 (ip0->length);
296 if (p0->policy == IPSEC_POLICY_ACTION_PROTECT)
300 sa = pool_elt_at_index (im->sad, p0->sa_index);
301 if (sa->protocol == IPSEC_PROTOCOL_ESP)
303 next_node_index = im->esp6_encrypt_node_index;
305 next_node_index = im->esp4_encrypt_node_index;
307 next_node_index = im->ah6_encrypt_node_index;
309 next_node_index = im->ah4_encrypt_node_index;
310 vnet_buffer (b0)->ipsec.sad_index = p0->sa_index;
312 if (PREDICT_FALSE (b0->flags & VNET_BUFFER_F_OFFLOAD))
314 u32 oflags = vnet_buffer2 (b0)->oflags;
317 * Clearing offload flags before checksum is computed
318 * It guarantees the cache hit!
320 vnet_buffer_offload_flags_clear (b0, oflags);
324 if (PREDICT_FALSE (oflags &
325 VNET_BUFFER_OFFLOAD_F_TCP_CKSUM))
327 tcp0->checksum = ip6_tcp_udp_icmp_compute_checksum (
328 vm, b0, ip6_0, &bogus);
330 if (PREDICT_FALSE (oflags &
331 VNET_BUFFER_OFFLOAD_F_UDP_CKSUM))
333 udp0->checksum = ip6_tcp_udp_icmp_compute_checksum (
334 vm, b0, ip6_0, &bogus);
339 if (PREDICT_FALSE (oflags &
340 VNET_BUFFER_OFFLOAD_F_IP_CKSUM))
342 ip0->checksum = ip4_header_checksum (ip0);
344 if (PREDICT_FALSE (oflags &
345 VNET_BUFFER_OFFLOAD_F_TCP_CKSUM))
348 ip4_tcp_udp_compute_checksum (vm, b0, ip0);
350 if (PREDICT_FALSE (oflags &
351 VNET_BUFFER_OFFLOAD_F_UDP_CKSUM))
354 ip4_tcp_udp_compute_checksum (vm, b0, ip0);
358 vlib_buffer_advance (b0, iph_offset);
360 else if (p0->policy == IPSEC_POLICY_ACTION_BYPASS)
363 next_node_index = get_next_output_feature_node_index (b0, node);
368 next_node_index = im->error_drop_node_index;
370 vlib_increment_combined_counter
371 (&ipsec_spd_policy_counters, thread_index, pi0, 1, bytes0);
377 next_node_index = im->error_drop_node_index;
383 if (PREDICT_FALSE ((last_next_node_index != next_node_index) || f == 0))
385 /* if this is not 1st frame */
387 vlib_put_frame_to_node (vm, last_next_node_index, f);
389 last_next_node_index = next_node_index;
391 f = vlib_get_frame_to_node (vm, next_node_index);
393 /* frame->frame_flags, copy it from node */
394 /* Copy trace flag from next_frame and from runtime. */
395 f->frame_flags |= node->flags & VLIB_NODE_FLAG_TRACE;
397 to_next = vlib_frame_vector_args (f);
404 if (PREDICT_FALSE (node->flags & VLIB_NODE_FLAG_TRACE) &&
405 PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
407 ipsec_output_trace_t *tr =
408 vlib_add_trace (vm, node, b0, sizeof (*tr));
410 tr->spd_id = spd0->id;
415 vlib_put_frame_to_node (vm, next_node_index, f);
416 vlib_node_increment_counter (vm, node->node_index,
417 IPSEC_OUTPUT_ERROR_POLICY_PROTECT, nc_protect);
418 vlib_node_increment_counter (vm, node->node_index,
419 IPSEC_OUTPUT_ERROR_POLICY_BYPASS, nc_bypass);
420 vlib_node_increment_counter (vm, node->node_index,
421 IPSEC_OUTPUT_ERROR_POLICY_DISCARD, nc_discard);
422 vlib_node_increment_counter (vm, node->node_index,
423 IPSEC_OUTPUT_ERROR_POLICY_NO_MATCH,
425 return from_frame->n_vectors;
428 VLIB_NODE_FN (ipsec4_output_node) (vlib_main_t * vm,
429 vlib_node_runtime_t * node,
430 vlib_frame_t * frame)
432 return ipsec_output_inline (vm, node, frame, 0);
436 VLIB_REGISTER_NODE (ipsec4_output_node) = {
437 .name = "ipsec4-output-feature",
438 .vector_size = sizeof (u32),
439 .format_trace = format_ipsec_output_trace,
440 .type = VLIB_NODE_TYPE_INTERNAL,
442 .n_errors = ARRAY_LEN(ipsec_output_error_strings),
443 .error_strings = ipsec_output_error_strings,
445 .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
447 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
448 foreach_ipsec_output_next
454 VLIB_NODE_FN (ipsec6_output_node) (vlib_main_t * vm,
455 vlib_node_runtime_t * node,
456 vlib_frame_t * frame)
458 return ipsec_output_inline (vm, node, frame, 1);
462 VLIB_REGISTER_NODE (ipsec6_output_node) = {
463 .name = "ipsec6-output-feature",
464 .vector_size = sizeof (u32),
465 .format_trace = format_ipsec_output_trace,
466 .type = VLIB_NODE_TYPE_INTERNAL,
468 .n_errors = ARRAY_LEN(ipsec_output_error_strings),
469 .error_strings = ipsec_output_error_strings,
471 .n_next_nodes = IPSEC_OUTPUT_N_NEXT,
473 #define _(s,n) [IPSEC_OUTPUT_NEXT_##s] = n,
474 foreach_ipsec_output_next
480 #else /* IPSEC > 1 */
482 /* Dummy ipsec output node, in case when IPSec is disabled */
485 ipsec_output_node_fn (vlib_main_t * vm,
486 vlib_node_runtime_t * node, vlib_frame_t * frame)
492 VLIB_REGISTER_NODE (ipsec4_output_node) = {
493 .vector_size = sizeof (u32),
494 .function = ipsec_output_node_fn,
495 .name = "ipsec4-output-feature",
498 VLIB_REGISTER_NODE (ipsec6_output_node) = {
499 .vector_size = sizeof (u32),
500 .function = ipsec_output_node_fn,
501 .name = "ipsec6-output-feature",
507 * fd.io coding-style-patch-verification: ON
510 * eval: (c-set-style "gnu")