2 * ah_decrypt.c : IPSec AH decrypt 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/ah.h>
25 #include <vnet/ipsec/ipsec_io.h>
26 #include <vnet/ipsec/ipsec.api_enum.h>
28 #define foreach_ah_decrypt_next \
29 _(DROP, "error-drop") \
30 _(IP4_INPUT, "ip4-input") \
31 _(IP6_INPUT, "ip6-input") \
34 #define _(v, s) AH_DECRYPT_NEXT_##v,
37 foreach_ah_decrypt_next
44 ipsec_integ_alg_t integ_alg;
48 /* packet trace format function */
50 format_ah_decrypt_trace (u8 * s, va_list * args)
52 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
53 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
54 ah_decrypt_trace_t *t = va_arg (*args, ah_decrypt_trace_t *);
56 s = format (s, "ah: integrity %U seq-num %d",
57 format_ipsec_integ_alg, t->integ_alg, t->seq_num);
69 u32 ip_version_traffic_class_and_flow_label;
86 } ah_decrypt_packet_data_t;
88 static_always_inline void
89 ah_process_ops (vlib_main_t * vm, vlib_node_runtime_t * node,
90 vnet_crypto_op_t * ops, vlib_buffer_t * b[], u16 * nexts)
92 u32 n_fail, n_ops = vec_len (ops);
93 vnet_crypto_op_t *op = ops;
98 n_fail = n_ops - vnet_crypto_process_ops (vm, op, n_ops);
102 ASSERT (op - ops < n_ops);
104 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
106 u32 bi = op->user_data;
107 b[bi]->error = node->errors[AH_DECRYPT_ERROR_INTEG_ERROR];
108 nexts[bi] = AH_DECRYPT_NEXT_DROP;
116 ah_decrypt_inline (vlib_main_t * vm,
117 vlib_node_runtime_t * node, vlib_frame_t * from_frame,
121 u32 thread_index = vm->thread_index;
122 u16 buffer_data_size = vlib_buffer_get_default_data_size (vm);
123 ah_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
124 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
125 u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
126 ipsec_main_t *im = &ipsec_main;
127 ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
128 from = vlib_frame_vector_args (from_frame);
129 n_left = from_frame->n_vectors;
131 u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
133 clib_memset (pkt_data, 0, VLIB_FRAME_SIZE * sizeof (pkt_data[0]));
134 vlib_get_buffers (vm, from, b, n_left);
135 clib_memset_u16 (nexts, -1, n_left);
136 vec_reset_length (ptd->integ_ops);
144 if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
146 if (current_sa_index != ~0)
147 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
151 current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
152 sa0 = ipsec_sa_get (current_sa_index);
154 current_sa_bytes = current_sa_pkts = 0;
155 vlib_prefetch_combined_counter (&ipsec_sa_counters,
156 thread_index, current_sa_index);
159 if (PREDICT_FALSE (~0 == sa0->thread_index))
161 /* this is the first packet to use this SA, claim the SA
162 * for this thread. this could happen simultaneously on
164 clib_atomic_cmp_and_swap (&sa0->thread_index, ~0,
165 ipsec_sa_assign_thread (thread_index));
168 if (PREDICT_TRUE (thread_index != sa0->thread_index))
170 vnet_buffer (b[0])->ipsec.thread_index = sa0->thread_index;
171 next[0] = AH_DECRYPT_NEXT_HANDOFF;
175 pd->sa_index = current_sa_index;
177 ih4 = vlib_buffer_get_current (b[0]);
178 ih6 = vlib_buffer_get_current (b[0]);
179 pd->current_data = b[0]->current_data;
183 ip6_ext_header_t *prev = NULL;
185 ip6_ext_header_find (vm, b[0], ih6, IP_PROTOCOL_IPSEC_AH, &prev);
186 pd->ip_hdr_size = sizeof (ip6_header_t);
187 ASSERT ((u8 *) ah0 - (u8 *) ih6 == pd->ip_hdr_size);
191 if (ip4_is_fragment (ih4))
193 b[0]->error = node->errors[AH_DECRYPT_ERROR_DROP_FRAGMENTS];
194 next[0] = AH_DECRYPT_NEXT_DROP;
197 pd->ip_hdr_size = ip4_header_bytes (ih4);
198 ah0 = (ah_header_t *) ((u8 *) ih4 + pd->ip_hdr_size);
201 pd->seq = clib_host_to_net_u32 (ah0->seq_no);
203 /* anti-replay check */
204 if (ipsec_sa_anti_replay_and_sn_advance (sa0, pd->seq, ~0, false,
207 b[0]->error = node->errors[AH_DECRYPT_ERROR_REPLAY];
208 next[0] = AH_DECRYPT_NEXT_DROP;
212 current_sa_bytes += b[0]->current_length;
213 current_sa_pkts += 1;
215 pd->icv_size = sa0->integ_icv_size;
216 pd->nexthdr_cached = ah0->nexthdr;
217 if (PREDICT_TRUE (sa0->integ_alg != IPSEC_INTEG_ALG_NONE))
219 if (PREDICT_FALSE (ipsec_sa_is_set_USE_ESN (sa0) &&
220 pd->current_data + b[0]->current_length
221 + sizeof (u32) > buffer_data_size))
223 b[0]->error = node->errors[AH_DECRYPT_ERROR_NO_TAIL_SPACE];
224 next[0] = AH_DECRYPT_NEXT_DROP;
228 vnet_crypto_op_t *op;
229 vec_add2_aligned (ptd->integ_ops, op, 1, CLIB_CACHE_LINE_BYTES);
230 vnet_crypto_op_init (op, sa0->integ_op_id);
232 op->src = (u8 *) ih4;
233 op->len = b[0]->current_length;
234 op->digest = (u8 *) ih4 - pd->icv_size;
235 op->flags = VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
236 op->digest_len = pd->icv_size;
237 op->key_index = sa0->integ_key_index;
238 op->user_data = b - bufs;
239 if (ipsec_sa_is_set_USE_ESN (sa0))
241 u32 seq_hi = clib_host_to_net_u32 (pd->seq_hi);
243 op->len += sizeof (seq_hi);
244 clib_memcpy (op->src + b[0]->current_length, &seq_hi,
247 clib_memcpy (op->digest, ah0->auth_data, pd->icv_size);
248 clib_memset (ah0->auth_data, 0, pd->icv_size);
252 pd->ip_version_traffic_class_and_flow_label =
253 ih6->ip_version_traffic_class_and_flow_label;
254 pd->hop_limit = ih6->hop_limit;
255 ih6->ip_version_traffic_class_and_flow_label = 0x60;
257 pd->nexthdr = ah0->nexthdr;
258 pd->icv_padding_len =
259 ah_calc_icv_padding_len (pd->icv_size, 1 /* is_ipv6 */ );
268 pd->icv_padding_len =
269 ah_calc_icv_padding_len (pd->icv_size, 0 /* is_ipv6 */ );
280 n_left = from_frame->n_vectors;
285 vlib_node_increment_counter (vm, node->node_index, AH_DECRYPT_ERROR_RX_PKTS,
287 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
288 current_sa_index, current_sa_pkts,
291 ah_process_ops (vm, node, ptd->integ_ops, bufs, nexts);
299 if (next[0] < AH_DECRYPT_N_NEXT)
302 sa0 = ipsec_sa_get (pd->sa_index);
304 if (PREDICT_TRUE (sa0->integ_alg != IPSEC_INTEG_ALG_NONE))
306 /* redo the anti-reply check. see esp_decrypt for details */
307 if (ipsec_sa_anti_replay_and_sn_advance (sa0, pd->seq, pd->seq_hi,
310 b[0]->error = node->errors[AH_DECRYPT_ERROR_REPLAY];
311 next[0] = AH_DECRYPT_NEXT_DROP;
314 n_lost = ipsec_sa_anti_replay_advance (sa0, thread_index, pd->seq,
316 vlib_prefetch_simple_counter (&ipsec_sa_lost_counters, thread_index,
320 u16 ah_hdr_len = sizeof (ah_header_t) + pd->icv_size
321 + pd->icv_padding_len;
322 vlib_buffer_advance (b[0], pd->ip_hdr_size + ah_hdr_len);
323 b[0]->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
325 if (PREDICT_TRUE (ipsec_sa_is_set_IS_TUNNEL (sa0)))
327 if (PREDICT_TRUE (pd->nexthdr_cached == IP_PROTOCOL_IP_IN_IP))
328 next[0] = AH_DECRYPT_NEXT_IP4_INPUT;
329 else if (pd->nexthdr_cached == IP_PROTOCOL_IPV6)
330 next[0] = AH_DECRYPT_NEXT_IP6_INPUT;
333 b[0]->error = node->errors[AH_DECRYPT_ERROR_DECRYPTION_FAILED];
334 next[0] = AH_DECRYPT_NEXT_DROP;
339 { /* transport mode */
342 vlib_buffer_advance (b[0], -sizeof (ip6_header_t));
343 oh6 = vlib_buffer_get_current (b[0]);
344 if (ah_hdr_len >= sizeof (ip6_header_t))
345 clib_memcpy (oh6, b[0]->data + pd->current_data,
346 sizeof (ip6_header_t));
348 memmove (oh6, b[0]->data + pd->current_data,
349 sizeof (ip6_header_t));
351 next[0] = AH_DECRYPT_NEXT_IP6_INPUT;
352 oh6->protocol = pd->nexthdr;
353 oh6->hop_limit = pd->hop_limit;
354 oh6->ip_version_traffic_class_and_flow_label =
355 pd->ip_version_traffic_class_and_flow_label;
356 oh6->payload_length =
357 clib_host_to_net_u16 (vlib_buffer_length_in_chain
358 (vm, b[0]) - sizeof (ip6_header_t));
362 vlib_buffer_advance (b[0], -sizeof (ip4_header_t));
363 oh4 = vlib_buffer_get_current (b[0]);
364 if (ah_hdr_len >= sizeof (ip4_header_t))
365 clib_memcpy (oh4, b[0]->data + pd->current_data,
366 sizeof (ip4_header_t));
368 memmove (oh4, b[0]->data + pd->current_data,
369 sizeof (ip4_header_t));
371 next[0] = AH_DECRYPT_NEXT_IP4_INPUT;
372 oh4->ip_version_and_header_length = 0x45;
373 oh4->fragment_id = 0;
374 oh4->flags_and_fragment_offset = 0;
375 oh4->protocol = pd->nexthdr_cached;
377 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b[0]));
380 oh4->checksum = ip4_header_checksum (oh4);
384 if (PREDICT_FALSE (n_lost))
385 vlib_increment_simple_counter (&ipsec_sa_lost_counters, thread_index,
386 pd->sa_index, n_lost);
388 vnet_buffer (b[0])->sw_if_index[VLIB_TX] = (u32) ~ 0;
390 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
392 sa0 = ipsec_sa_get (vnet_buffer (b[0])->ipsec.sad_index);
393 ah_decrypt_trace_t *tr =
394 vlib_add_trace (vm, node, b[0], sizeof (*tr));
395 tr->integ_alg = sa0->integ_alg;
396 tr->seq_num = pd->seq;
405 n_left = from_frame->n_vectors;
406 vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
411 VLIB_NODE_FN (ah4_decrypt_node) (vlib_main_t * vm,
412 vlib_node_runtime_t * node,
413 vlib_frame_t * from_frame)
415 return ah_decrypt_inline (vm, node, from_frame, 0 /* is_ip6 */ );
419 VLIB_REGISTER_NODE (ah4_decrypt_node) = {
420 .name = "ah4-decrypt",
421 .vector_size = sizeof (u32),
422 .format_trace = format_ah_decrypt_trace,
423 .type = VLIB_NODE_TYPE_INTERNAL,
425 .n_errors = AH_DECRYPT_N_ERROR,
426 .error_counters = ah_decrypt_error_counters,
428 .n_next_nodes = AH_DECRYPT_N_NEXT,
430 [AH_DECRYPT_NEXT_DROP] = "ip4-drop",
431 [AH_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
432 [AH_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
433 [AH_DECRYPT_NEXT_HANDOFF] = "ah4-decrypt-handoff",
438 VLIB_NODE_FN (ah6_decrypt_node) (vlib_main_t * vm,
439 vlib_node_runtime_t * node,
440 vlib_frame_t * from_frame)
442 return ah_decrypt_inline (vm, node, from_frame, 1 /* is_ip6 */ );
446 VLIB_REGISTER_NODE (ah6_decrypt_node) = {
447 .name = "ah6-decrypt",
448 .vector_size = sizeof (u32),
449 .format_trace = format_ah_decrypt_trace,
450 .type = VLIB_NODE_TYPE_INTERNAL,
452 .n_errors = AH_DECRYPT_N_ERROR,
453 .error_counters = ah_decrypt_error_counters,
455 .n_next_nodes = AH_DECRYPT_N_NEXT,
457 [AH_DECRYPT_NEXT_DROP] = "ip6-drop",
458 [AH_DECRYPT_NEXT_IP4_INPUT] = "ip4-input-no-checksum",
459 [AH_DECRYPT_NEXT_IP6_INPUT] = "ip6-input",
460 [AH_DECRYPT_NEXT_HANDOFF] = "ah6-decrypt-handoff",
465 #ifndef CLIB_MARCH_VARIANT
467 static clib_error_t *
468 ah_decrypt_init (vlib_main_t *vm)
470 ipsec_main_t *im = &ipsec_main;
472 im->ah4_dec_fq_index =
473 vlib_frame_queue_main_init (ah4_decrypt_node.index, 0);
474 im->ah6_dec_fq_index =
475 vlib_frame_queue_main_init (ah6_decrypt_node.index, 0);
480 VLIB_INIT_FUNCTION (ah_decrypt_init);
485 * fd.io coding-style-patch-verification: ON
488 * eval: (c-set-style "gnu")