2 * esp_decrypt.c : IPSec ESP 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/ipsec_io.h>
25 #include <vnet/ipsec/ipsec_tun.h>
27 #define foreach_esp_decrypt_next \
28 _(DROP, "error-drop") \
29 _(IP4_INPUT, "ip4-input-no-checksum") \
30 _(IP6_INPUT, "ip6-input")
32 #define _(v, s) ESP_DECRYPT_NEXT_##v,
35 foreach_esp_decrypt_next
41 #define foreach_esp_decrypt_error \
42 _(RX_PKTS, "ESP pkts received") \
43 _(DECRYPTION_FAILED, "ESP decryption failed") \
44 _(INTEG_ERROR, "Integrity check failed") \
45 _(CRYPTO_ENGINE_ERROR, "crypto engine error (packet dropped)") \
46 _(REPLAY, "SA replayed packet") \
47 _(RUNT, "undersized packet") \
48 _(CHAINED_BUFFER, "chained buffers (packet dropped)") \
49 _(OVERSIZED_HEADER, "buffer with oversized header (dropped)") \
50 _(NO_TAIL_SPACE, "no enough buffer tail space (dropped)") \
51 _(TUN_NO_PROTO, "no tunnel protocol") \
56 #define _(sym,str) ESP_DECRYPT_ERROR_##sym,
57 foreach_esp_decrypt_error
60 } esp_decrypt_error_t;
62 static char *esp_decrypt_error_strings[] = {
63 #define _(sym,string) string,
64 foreach_esp_decrypt_error
73 ipsec_crypto_alg_t crypto_alg;
74 ipsec_integ_alg_t integ_alg;
75 } esp_decrypt_trace_t;
77 /* packet trace format function */
79 format_esp_decrypt_trace (u8 * s, va_list * args)
81 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
82 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
83 esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
87 "esp: crypto %U integrity %U pkt-seq %d sa-seq %u sa-seq-hi %u",
88 format_ipsec_crypto_alg, t->crypto_alg, format_ipsec_integ_alg,
89 t->integ_alg, t->seq, t->sa_seq, t->sa_seq_hi);
101 ipsec_sa_flags_t flags;
111 } esp_decrypt_packet_data_t;
113 STATIC_ASSERT_SIZEOF (esp_decrypt_packet_data_t, 3 * sizeof (u64));
115 #define ESP_ENCRYPT_PD_F_FD_TRANSPORT (1 << 2)
118 esp_decrypt_inline (vlib_main_t * vm,
119 vlib_node_runtime_t * node, vlib_frame_t * from_frame,
120 int is_ip6, int is_tun)
122 ipsec_main_t *im = &ipsec_main;
123 u32 thread_index = vm->thread_index;
124 u16 buffer_data_size = vlib_buffer_get_default_data_size (vm);
126 ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
127 u32 *from = vlib_frame_vector_args (from_frame);
128 u32 n, n_left = from_frame->n_vectors;
129 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
130 u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
131 esp_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
132 esp_decrypt_packet_data_t cpd = { };
133 u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
134 const u8 esp_sz = sizeof (esp_header_t);
137 vlib_get_buffers (vm, from, b, n_left);
138 vec_reset_length (ptd->crypto_ops);
139 vec_reset_length (ptd->integ_ops);
140 clib_memset_u16 (nexts, -1, n_left);
149 vlib_prefetch_buffer_header (b[2], LOAD);
150 p = vlib_buffer_get_current (b[1]);
151 CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
152 p -= CLIB_CACHE_LINE_BYTES;
153 CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
156 if (vlib_buffer_chain_linearize (vm, b[0]) != 1)
158 b[0]->error = node->errors[ESP_DECRYPT_ERROR_CHAINED_BUFFER];
159 next[0] = ESP_DECRYPT_NEXT_DROP;
163 if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
166 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
170 current_sa_bytes = current_sa_pkts = 0;
172 current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
173 sa0 = pool_elt_at_index (im->sad, current_sa_index);
174 cpd.icv_sz = sa0->integ_icv_size;
175 cpd.iv_sz = sa0->crypto_iv_size;
176 cpd.flags = sa0->flags;
177 cpd.sa_index = current_sa_index;
180 /* store packet data for next round for easier prefetch */
181 pd->sa_data = cpd.sa_data;
182 pd->current_data = b[0]->current_data;
183 pd->current_length = b[0]->current_length;
184 pd->hdr_sz = pd->current_data - vnet_buffer (b[0])->l3_hdr_offset;
185 payload = b[0]->data + pd->current_data;
186 pd->seq = clib_host_to_net_u32 (((esp_header_t *) payload)->seq);
188 /* we need 4 extra bytes for HMAC calculation when ESN are used */
189 if (ipsec_sa_is_set_USE_ESN (sa0) && pd->icv_sz &&
190 (pd->current_data + pd->current_length + 4 > buffer_data_size))
192 b[0]->error = node->errors[ESP_DECRYPT_ERROR_NO_TAIL_SPACE];
193 next[0] = ESP_DECRYPT_NEXT_DROP;
197 /* anti-reply check */
198 if (ipsec_sa_anti_replay_check (sa0, pd->seq))
200 b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
201 next[0] = ESP_DECRYPT_NEXT_DROP;
205 if (pd->current_length < cpd.icv_sz + esp_sz + cpd.iv_sz)
207 b[0]->error = node->errors[ESP_DECRYPT_ERROR_RUNT];
208 next[0] = ESP_DECRYPT_NEXT_DROP;
212 len = pd->current_length - cpd.icv_sz;
213 current_sa_pkts += 1;
214 current_sa_bytes += pd->current_length;
216 if (PREDICT_TRUE (sa0->integ_op_id != VNET_CRYPTO_OP_NONE))
218 vnet_crypto_op_t *op;
219 vec_add2_aligned (ptd->integ_ops, op, 1, CLIB_CACHE_LINE_BYTES);
221 vnet_crypto_op_init (op, sa0->integ_op_id);
222 op->key_index = sa0->integ_key_index;
224 op->flags = VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
225 op->user_data = b - bufs;
226 op->digest = payload + len;
227 op->digest_len = cpd.icv_sz;
229 if (ipsec_sa_is_set_USE_ESN (sa0))
231 /* shift ICV by 4 bytes to insert ESN */
232 u32 seq_hi = clib_host_to_net_u32 (sa0->seq_hi);
233 u8 tmp[ESP_MAX_ICV_SIZE], sz = sizeof (sa0->seq_hi);
234 clib_memcpy_fast (tmp, payload + len, ESP_MAX_ICV_SIZE);
235 clib_memcpy_fast (payload + len, &seq_hi, sz);
236 clib_memcpy_fast (payload + len + sz, tmp, ESP_MAX_ICV_SIZE);
245 if (sa0->crypto_enc_op_id != VNET_CRYPTO_OP_NONE)
247 vnet_crypto_op_t *op;
248 vec_add2_aligned (ptd->crypto_ops, op, 1, CLIB_CACHE_LINE_BYTES);
249 vnet_crypto_op_init (op, sa0->crypto_dec_op_id);
250 op->key_index = sa0->crypto_key_index;
253 if (ipsec_sa_is_set_IS_AEAD (sa0))
260 * construct the AAD and the nonce (Salt || IV) in a scratch
261 * space in front of the IP header.
263 scratch = payload - esp_sz;
264 esp0 = (esp_header_t *) (scratch);
266 scratch -= (sizeof (*aad) + pd->hdr_sz);
269 esp_aad_fill (op, esp0, sa0);
272 * we don't need to refer to the ESP header anymore so we
273 * can overwrite it with the salt and use the IV where it is
274 * to form the nonce = (Salt + IV)
276 op->iv -= sizeof (sa0->salt);
277 clib_memcpy_fast (op->iv, &sa0->salt, sizeof (sa0->salt));
279 op->tag = payload + len;
282 op->src = op->dst = payload += cpd.iv_sz;
283 op->len = len - cpd.iv_sz;
284 op->user_data = b - bufs;
295 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
296 current_sa_index, current_sa_pkts,
299 if ((n = vec_len (ptd->integ_ops)))
301 vnet_crypto_op_t *op = ptd->integ_ops;
302 n -= vnet_crypto_process_ops (vm, op, n);
305 ASSERT (op - ptd->integ_ops < vec_len (ptd->integ_ops));
306 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
308 u32 err, bi = op->user_data;
309 if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
310 err = ESP_DECRYPT_ERROR_INTEG_ERROR;
312 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
313 bufs[bi]->error = node->errors[err];
314 nexts[bi] = ESP_DECRYPT_NEXT_DROP;
320 if ((n = vec_len (ptd->crypto_ops)))
322 vnet_crypto_op_t *op = ptd->crypto_ops;
323 n -= vnet_crypto_process_ops (vm, op, n);
326 ASSERT (op - ptd->crypto_ops < vec_len (ptd->crypto_ops));
327 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
333 if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
334 err = ESP_DECRYPT_ERROR_DECRYPTION_FAILED;
336 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
338 bufs[bi]->error = node->errors[err];
339 nexts[bi] = ESP_DECRYPT_NEXT_DROP;
346 /* Post decryption ronud - adjust packet data start and length and next
349 n_left = from_frame->n_vectors;
356 const u8 tun_flags = IPSEC_SA_FLAG_IS_TUNNEL |
357 IPSEC_SA_FLAG_IS_TUNNEL_V6;
361 void *data = b[1]->data + pd[1].current_data;
363 /* buffer metadata */
364 vlib_prefetch_buffer_header (b[1], LOAD);
367 CLIB_PREFETCH (data + pd[1].current_length - pd[1].icv_sz - 2,
368 CLIB_CACHE_LINE_BYTES, LOAD);
371 CLIB_PREFETCH (data - CLIB_CACHE_LINE_BYTES,
372 CLIB_CACHE_LINE_BYTES * 2, LOAD);
375 if (next[0] < ESP_DECRYPT_N_NEXT)
378 sa0 = vec_elt_at_index (im->sad, pd->sa_index);
381 * redo the anti-reply check
382 * in this frame say we have sequence numbers, s, s+1, s+1, s+1
383 * and s and s+1 are in the window. When we did the anti-replay
384 * check above we did so against the state of the window (W),
385 * after packet s-1. So each of the packets in the sequence will be
387 * This time s will be cheked against Ws-1, s+1 chceked against Ws
388 * (i.e. the window state is updated/advnaced)
389 * so this time the successive s+! packet will be dropped.
390 * This is a consequence of batching the decrypts. If the
391 * check-dcrypt-advance process was done for each packet it would
392 * be fine. But we batch the decrypts because it's much more efficient
393 * to do so in SW and if we offload to HW and the process is async.
395 * You're probably thinking, but this means an attacker can send the
396 * above sequence and cause VPP to perform decrpyts that will fail,
397 * and that's true. But if the attacker can determine s (a valid
398 * sequence number in the window) which is non-trivial, it can generate
399 * a sequence s, s+1, s+2, s+3, ... s+n and nothing will prevent any
400 * implementation, sequential or batching, from decrypting these.
402 if (ipsec_sa_anti_replay_check (sa0, pd->seq))
404 b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
405 next[0] = ESP_DECRYPT_NEXT_DROP;
409 ipsec_sa_anti_replay_advance (sa0, pd->seq);
411 esp_footer_t *f = (esp_footer_t *) (b[0]->data + pd->current_data +
412 pd->current_length - sizeof (*f) -
414 u16 adv = pd->iv_sz + esp_sz;
415 u16 tail = sizeof (esp_footer_t) + f->pad_length + pd->icv_sz;
417 if ((pd->flags & tun_flags) == 0 && !is_tun) /* transport mode */
419 u8 udp_sz = (is_ip6 == 0 && pd->flags & IPSEC_SA_FLAG_UDP_ENCAP) ?
420 sizeof (udp_header_t) : 0;
421 u16 ip_hdr_sz = pd->hdr_sz - udp_sz;
422 u8 *old_ip = b[0]->data + pd->current_data - ip_hdr_sz - udp_sz;
423 u8 *ip = old_ip + adv + udp_sz;
425 if (is_ip6 && ip_hdr_sz > 64)
426 memmove (ip, old_ip, ip_hdr_sz);
428 clib_memcpy_le64 (ip, old_ip, ip_hdr_sz);
430 b[0]->current_data = pd->current_data + adv - ip_hdr_sz;
431 b[0]->current_length = pd->current_length + ip_hdr_sz - tail - adv;
435 ip6_header_t *ip6 = (ip6_header_t *) ip;
436 u16 len = clib_net_to_host_u16 (ip6->payload_length);
438 ip6->payload_length = clib_host_to_net_u16 (len);
439 ip6->protocol = f->next_header;
440 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
444 ip4_header_t *ip4 = (ip4_header_t *) ip;
445 ip_csum_t sum = ip4->checksum;
446 u16 len = clib_net_to_host_u16 (ip4->length);
447 len = clib_host_to_net_u16 (len - adv - tail - udp_sz);
448 sum = ip_csum_update (sum, ip4->protocol, f->next_header,
449 ip4_header_t, protocol);
450 sum = ip_csum_update (sum, ip4->length, len,
451 ip4_header_t, length);
452 ip4->checksum = ip_csum_fold (sum);
453 ip4->protocol = f->next_header;
455 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
460 if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
462 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
463 b[0]->current_data = pd->current_data + adv;
464 b[0]->current_length = pd->current_length - adv - tail;
466 else if (f->next_header == IP_PROTOCOL_IPV6)
468 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
469 b[0]->current_data = pd->current_data + adv;
470 b[0]->current_length = pd->current_length - adv - tail;
474 next[0] = ESP_DECRYPT_NEXT_DROP;
475 b[0]->error = node->errors[ESP_DECRYPT_ERROR_DECRYPTION_FAILED];
480 if (ipsec_sa_is_set_IS_PROTECT (sa0))
483 * Check that the reveal IP header matches that
484 * of the tunnel we are protecting
486 const ipsec_tun_protect_t *itp;
489 ipsec_tun_protect_get (vnet_buffer (b[0])->
490 ipsec.protect_index);
491 if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
493 const ip4_header_t *ip4;
495 ip4 = vlib_buffer_get_current (b[0]);
497 if (!ip46_address_is_equal_v4 (&itp->itp_tun.src,
498 &ip4->dst_address) ||
499 !ip46_address_is_equal_v4 (&itp->itp_tun.dst,
502 next[0] = ESP_DECRYPT_NEXT_DROP;
504 node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
507 else if (f->next_header == IP_PROTOCOL_IPV6)
509 const ip6_header_t *ip6;
511 ip6 = vlib_buffer_get_current (b[0]);
513 if (!ip46_address_is_equal_v6 (&itp->itp_tun.src,
514 &ip6->dst_address) ||
515 !ip46_address_is_equal_v6 (&itp->itp_tun.dst,
518 next[0] = ESP_DECRYPT_NEXT_DROP;
520 node->errors[ESP_DECRYPT_ERROR_TUN_NO_PROTO];
528 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
530 esp_decrypt_trace_t *tr;
531 tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
532 sa0 = pool_elt_at_index (im->sad,
533 vnet_buffer (b[0])->ipsec.sad_index);
534 tr->crypto_alg = sa0->crypto_alg;
535 tr->integ_alg = sa0->integ_alg;
537 tr->sa_seq = sa0->last_seq;
538 tr->sa_seq_hi = sa0->seq_hi;
548 n_left = from_frame->n_vectors;
549 vlib_node_increment_counter (vm, node->node_index,
550 ESP_DECRYPT_ERROR_RX_PKTS, n_left);
552 vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
558 VLIB_NODE_FN (esp4_decrypt_node) (vlib_main_t * vm,
559 vlib_node_runtime_t * node,
560 vlib_frame_t * from_frame)
562 return esp_decrypt_inline (vm, node, from_frame, 0, 0);
565 VLIB_NODE_FN (esp4_decrypt_tun_node) (vlib_main_t * vm,
566 vlib_node_runtime_t * node,
567 vlib_frame_t * from_frame)
569 return esp_decrypt_inline (vm, node, from_frame, 0, 1);
572 VLIB_NODE_FN (esp6_decrypt_node) (vlib_main_t * vm,
573 vlib_node_runtime_t * node,
574 vlib_frame_t * from_frame)
576 return esp_decrypt_inline (vm, node, from_frame, 1, 0);
579 VLIB_NODE_FN (esp6_decrypt_tun_node) (vlib_main_t * vm,
580 vlib_node_runtime_t * node,
581 vlib_frame_t * from_frame)
583 return esp_decrypt_inline (vm, node, from_frame, 1, 1);
587 VLIB_REGISTER_NODE (esp4_decrypt_node) = {
588 .name = "esp4-decrypt",
589 .vector_size = sizeof (u32),
590 .format_trace = format_esp_decrypt_trace,
591 .type = VLIB_NODE_TYPE_INTERNAL,
593 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
594 .error_strings = esp_decrypt_error_strings,
596 .n_next_nodes = ESP_DECRYPT_N_NEXT,
598 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
599 foreach_esp_decrypt_next
604 VLIB_REGISTER_NODE (esp6_decrypt_node) = {
605 .name = "esp6-decrypt",
606 .vector_size = sizeof (u32),
607 .format_trace = format_esp_decrypt_trace,
608 .type = VLIB_NODE_TYPE_INTERNAL,
610 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
611 .error_strings = esp_decrypt_error_strings,
613 .n_next_nodes = ESP_DECRYPT_N_NEXT,
615 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
616 foreach_esp_decrypt_next
621 VLIB_REGISTER_NODE (esp4_decrypt_tun_node) = {
622 .name = "esp4-decrypt-tun",
623 .vector_size = sizeof (u32),
624 .format_trace = format_esp_decrypt_trace,
625 .type = VLIB_NODE_TYPE_INTERNAL,
626 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
627 .error_strings = esp_decrypt_error_strings,
628 .sibling_of = "esp4-decrypt",
631 VLIB_REGISTER_NODE (esp6_decrypt_tun_node) = {
632 .name = "esp6-decrypt-tun",
633 .vector_size = sizeof (u32),
634 .format_trace = format_esp_decrypt_trace,
635 .type = VLIB_NODE_TYPE_INTERNAL,
636 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
637 .error_strings = esp_decrypt_error_strings,
638 .sibling_of = "esp6-decrypt",
643 * fd.io coding-style-patch-verification: ON
646 * eval: (c-set-style "gnu")