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)")
55 #define _(sym,str) ESP_DECRYPT_ERROR_##sym,
56 foreach_esp_decrypt_error
59 } esp_decrypt_error_t;
61 static char *esp_decrypt_error_strings[] = {
62 #define _(sym,string) string,
63 foreach_esp_decrypt_error
70 ipsec_crypto_alg_t crypto_alg;
71 ipsec_integ_alg_t integ_alg;
72 } esp_decrypt_trace_t;
74 /* packet trace format function */
76 format_esp_decrypt_trace (u8 * s, va_list * args)
78 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
79 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
80 esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
82 s = format (s, "esp: crypto %U integrity %U seq %u",
83 format_ipsec_crypto_alg, t->crypto_alg,
84 format_ipsec_integ_alg, t->integ_alg, t->seq);
96 ipsec_sa_flags_t flags;
105 } esp_decrypt_packet_data_t;
107 STATIC_ASSERT_SIZEOF (esp_decrypt_packet_data_t, 2 * sizeof (u64));
109 #define ESP_ENCRYPT_PD_F_FD_TRANSPORT (1 << 2)
112 esp_decrypt_inline (vlib_main_t * vm,
113 vlib_node_runtime_t * node, vlib_frame_t * from_frame,
114 int is_ip6, int is_tun)
116 ipsec_main_t *im = &ipsec_main;
117 u32 thread_index = vm->thread_index;
118 u16 buffer_data_size = vlib_buffer_get_default_data_size (vm);
120 ipsec_per_thread_data_t *ptd = vec_elt_at_index (im->ptd, thread_index);
121 u32 *from = vlib_frame_vector_args (from_frame);
122 u32 n, n_left = from_frame->n_vectors;
123 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
124 u16 nexts[VLIB_FRAME_SIZE], *next = nexts;
125 esp_decrypt_packet_data_t pkt_data[VLIB_FRAME_SIZE], *pd = pkt_data;
126 esp_decrypt_packet_data_t cpd = { };
127 u32 current_sa_index = ~0, current_sa_bytes = 0, current_sa_pkts = 0;
128 const u8 esp_sz = sizeof (esp_header_t);
131 vlib_get_buffers (vm, from, b, n_left);
132 vec_reset_length (ptd->crypto_ops);
133 vec_reset_length (ptd->integ_ops);
134 clib_memset_u16 (nexts, -1, n_left);
143 vlib_prefetch_buffer_header (b[2], LOAD);
144 p = vlib_buffer_get_current (b[1]);
145 CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
146 p -= CLIB_CACHE_LINE_BYTES;
147 CLIB_PREFETCH (p, CLIB_CACHE_LINE_BYTES, LOAD);
150 if (vlib_buffer_chain_linearize (vm, b[0]) != 1)
152 b[0]->error = node->errors[ESP_DECRYPT_ERROR_CHAINED_BUFFER];
153 next[0] = ESP_DECRYPT_NEXT_DROP;
157 if (vnet_buffer (b[0])->ipsec.sad_index != current_sa_index)
160 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
164 current_sa_bytes = current_sa_pkts = 0;
166 current_sa_index = vnet_buffer (b[0])->ipsec.sad_index;
167 sa0 = pool_elt_at_index (im->sad, current_sa_index);
168 cpd.icv_sz = sa0->integ_icv_size;
169 cpd.iv_sz = sa0->crypto_iv_size;
170 cpd.flags = sa0->flags;
171 cpd.sa_index = current_sa_index;
174 /* store packet data for next round for easier prefetch */
175 pd->sa_data = cpd.sa_data;
176 pd->current_data = b[0]->current_data;
177 pd->current_length = b[0]->current_length;
178 pd->hdr_sz = pd->current_data - vnet_buffer (b[0])->l3_hdr_offset;
179 payload = b[0]->data + pd->current_data;
181 /* we need 4 extra bytes for HMAC calculation when ESN are used */
182 if (ipsec_sa_is_set_USE_ESN (sa0) && pd->icv_sz &&
183 (pd->current_data + pd->current_length + 4 > buffer_data_size))
185 b[0]->error = node->errors[ESP_DECRYPT_ERROR_NO_TAIL_SPACE];
186 next[0] = ESP_DECRYPT_NEXT_DROP;
190 /* anti-reply check */
191 if (ipsec_sa_anti_replay_check (sa0, &((esp_header_t *) payload)->seq))
193 b[0]->error = node->errors[ESP_DECRYPT_ERROR_REPLAY];
194 next[0] = ESP_DECRYPT_NEXT_DROP;
198 if (pd->current_length < cpd.icv_sz + esp_sz + cpd.iv_sz)
200 b[0]->error = node->errors[ESP_DECRYPT_ERROR_RUNT];
201 next[0] = ESP_DECRYPT_NEXT_DROP;
205 len = pd->current_length - cpd.icv_sz;
206 current_sa_pkts += 1;
207 current_sa_bytes += pd->current_length;
209 if (PREDICT_TRUE (sa0->integ_op_id != VNET_CRYPTO_OP_NONE))
211 vnet_crypto_op_t *op;
212 vec_add2_aligned (ptd->integ_ops, op, 1, CLIB_CACHE_LINE_BYTES);
214 vnet_crypto_op_init (op, sa0->integ_op_id);
215 op->key_index = sa0->integ_key_index;
217 op->flags = VNET_CRYPTO_OP_FLAG_HMAC_CHECK;
218 op->user_data = b - bufs;
219 op->digest = payload + len;
220 op->digest_len = cpd.icv_sz;
222 if (ipsec_sa_is_set_USE_ESN (sa0))
224 /* shift ICV for 4 bytes to insert ESN */
225 u8 tmp[ESP_MAX_ICV_SIZE], sz = sizeof (sa0->seq_hi);
226 clib_memcpy_fast (tmp, payload + len, ESP_MAX_ICV_SIZE);
227 clib_memcpy_fast (payload + len, &sa0->seq_hi, sz);
228 clib_memcpy_fast (payload + len + sz, tmp, ESP_MAX_ICV_SIZE);
237 if (sa0->crypto_enc_op_id != VNET_CRYPTO_OP_NONE)
239 vnet_crypto_op_t *op;
240 vec_add2_aligned (ptd->crypto_ops, op, 1, CLIB_CACHE_LINE_BYTES);
241 vnet_crypto_op_init (op, sa0->crypto_dec_op_id);
242 op->key_index = sa0->crypto_key_index;
245 if (ipsec_sa_is_set_IS_AEAD (sa0))
252 * construct the AAD and the nonce (Salt || IV) in a scratch
253 * space in front of the IP header.
255 scratch = payload - esp_sz;
256 esp0 = (esp_header_t *) (scratch);
258 scratch -= (sizeof (*aad) + pd->hdr_sz);
261 esp_aad_fill (op, esp0, sa0);
264 * we don't need to refer to the ESP header anymore so we
265 * can overwrite it with the salt and use the IV where it is
266 * to form the nonce = (Salt + IV)
268 op->iv -= sizeof (sa0->salt);
269 clib_memcpy_fast (op->iv, &sa0->salt, sizeof (sa0->salt));
271 op->tag = payload + len;
274 op->src = op->dst = payload += cpd.iv_sz;
275 op->len = len - cpd.iv_sz;
276 op->user_data = b - bufs;
287 vlib_increment_combined_counter (&ipsec_sa_counters, thread_index,
288 current_sa_index, current_sa_pkts,
291 if ((n = vec_len (ptd->integ_ops)))
293 vnet_crypto_op_t *op = ptd->integ_ops;
294 n -= vnet_crypto_process_ops (vm, op, n);
297 ASSERT (op - ptd->integ_ops < vec_len (ptd->integ_ops));
298 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
300 u32 err, bi = op->user_data;
301 if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
302 err = ESP_DECRYPT_ERROR_INTEG_ERROR;
304 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
305 bufs[bi]->error = node->errors[err];
306 nexts[bi] = ESP_DECRYPT_NEXT_DROP;
312 if ((n = vec_len (ptd->crypto_ops)))
314 vnet_crypto_op_t *op = ptd->crypto_ops;
315 n -= vnet_crypto_process_ops (vm, op, n);
318 ASSERT (op - ptd->crypto_ops < vec_len (ptd->crypto_ops));
319 if (op->status != VNET_CRYPTO_OP_STATUS_COMPLETED)
325 if (op->status == VNET_CRYPTO_OP_STATUS_FAIL_BAD_HMAC)
326 err = ESP_DECRYPT_ERROR_DECRYPTION_FAILED;
328 err = ESP_DECRYPT_ERROR_CRYPTO_ENGINE_ERROR;
330 bufs[bi]->error = node->errors[err];
331 nexts[bi] = ESP_DECRYPT_NEXT_DROP;
338 /* Post decryption ronud - adjust packet data start and length and next
341 n_left = from_frame->n_vectors;
348 const u8 tun_flags = IPSEC_SA_FLAG_IS_TUNNEL |
349 IPSEC_SA_FLAG_IS_TUNNEL_V6;
353 void *data = b[1]->data + pd[1].current_data;
355 /* buffer metadata */
356 vlib_prefetch_buffer_header (b[1], LOAD);
359 CLIB_PREFETCH (data + pd[1].current_length - pd[1].icv_sz - 2,
360 CLIB_CACHE_LINE_BYTES, LOAD);
363 CLIB_PREFETCH (data - CLIB_CACHE_LINE_BYTES,
364 CLIB_CACHE_LINE_BYTES * 2, LOAD);
367 if (next[0] < ESP_DECRYPT_N_NEXT)
370 sa0 = vec_elt_at_index (im->sad, pd->sa_index);
371 u8 *payload = b[0]->data + pd->current_data;
373 ipsec_sa_anti_replay_advance (sa0, ((esp_header_t *) payload)->seq);
375 esp_footer_t *f = (esp_footer_t *) (b[0]->data + pd->current_data +
376 pd->current_length - sizeof (*f) -
378 u16 adv = pd->iv_sz + esp_sz;
379 u16 tail = sizeof (esp_footer_t) + f->pad_length + pd->icv_sz;
381 if ((pd->flags & tun_flags) == 0 && !is_tun) /* transport mode */
383 u8 udp_sz = (is_ip6 == 0 && pd->flags & IPSEC_SA_FLAG_UDP_ENCAP) ?
384 sizeof (udp_header_t) : 0;
385 u16 ip_hdr_sz = pd->hdr_sz - udp_sz;
386 u8 *old_ip = b[0]->data + pd->current_data - ip_hdr_sz - udp_sz;
387 u8 *ip = old_ip + adv + udp_sz;
389 if (is_ip6 && ip_hdr_sz > 64)
390 memmove (ip, old_ip, ip_hdr_sz);
392 clib_memcpy_le64 (ip, old_ip, ip_hdr_sz);
394 b[0]->current_data = pd->current_data + adv - ip_hdr_sz;
395 b[0]->current_length = pd->current_length + ip_hdr_sz - tail - adv;
399 ip6_header_t *ip6 = (ip6_header_t *) ip;
400 u16 len = clib_net_to_host_u16 (ip6->payload_length);
402 ip6->payload_length = clib_host_to_net_u16 (len);
403 ip6->protocol = f->next_header;
404 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
408 ip4_header_t *ip4 = (ip4_header_t *) ip;
409 ip_csum_t sum = ip4->checksum;
410 u16 len = clib_net_to_host_u16 (ip4->length);
411 len = clib_host_to_net_u16 (len - adv - tail - udp_sz);
412 sum = ip_csum_update (sum, ip4->protocol, f->next_header,
413 ip4_header_t, protocol);
414 sum = ip_csum_update (sum, ip4->length, len,
415 ip4_header_t, length);
416 ip4->checksum = ip_csum_fold (sum);
417 ip4->protocol = f->next_header;
419 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
424 if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
426 next[0] = ESP_DECRYPT_NEXT_IP4_INPUT;
427 b[0]->current_data = pd->current_data + adv;
428 b[0]->current_length = pd->current_length - adv - tail;
430 else if (f->next_header == IP_PROTOCOL_IPV6)
432 next[0] = ESP_DECRYPT_NEXT_IP6_INPUT;
433 b[0]->current_data = pd->current_data + adv;
434 b[0]->current_length = pd->current_length - adv - tail;
438 next[0] = ESP_DECRYPT_NEXT_DROP;
439 b[0]->error = node->errors[ESP_DECRYPT_ERROR_DECRYPTION_FAILED];
444 if (ipsec_sa_is_set_IS_PROTECT (sa0))
447 * Check that the reveal IP header matches that
448 * of the tunnel we are protecting
450 const ipsec_tun_protect_t *itp;
453 ipsec_tun_protect_get (vnet_buffer (b[0])->
454 ipsec.protect_index);
455 if (PREDICT_TRUE (f->next_header == IP_PROTOCOL_IP_IN_IP))
457 const ip4_header_t *ip4;
459 ip4 = vlib_buffer_get_current (b[0]);
461 if (!ip46_address_is_equal_v4 (&itp->itp_tun.src,
462 &ip4->dst_address) ||
463 !ip46_address_is_equal_v4 (&itp->itp_tun.dst,
465 next[0] = ESP_DECRYPT_NEXT_DROP;
468 else if (f->next_header == IP_PROTOCOL_IPV6)
470 const ip6_header_t *ip6;
472 ip6 = vlib_buffer_get_current (b[0]);
474 if (!ip46_address_is_equal_v6 (&itp->itp_tun.src,
475 &ip6->dst_address) ||
476 !ip46_address_is_equal_v6 (&itp->itp_tun.dst,
478 next[0] = ESP_DECRYPT_NEXT_DROP;
485 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
487 esp_decrypt_trace_t *tr;
488 u8 *payload = b[0]->data + pd->current_data;
489 tr = vlib_add_trace (vm, node, b[0], sizeof (*tr));
490 sa0 = pool_elt_at_index (im->sad,
491 vnet_buffer (b[0])->ipsec.sad_index);
492 tr->crypto_alg = sa0->crypto_alg;
493 tr->integ_alg = sa0->integ_alg;
494 tr->seq = clib_host_to_net_u32 (((esp_header_t *) payload)->seq);
504 n_left = from_frame->n_vectors;
505 vlib_node_increment_counter (vm, node->node_index,
506 ESP_DECRYPT_ERROR_RX_PKTS, n_left);
508 vlib_buffer_enqueue_to_next (vm, node, from, nexts, n_left);
514 VLIB_NODE_FN (esp4_decrypt_node) (vlib_main_t * vm,
515 vlib_node_runtime_t * node,
516 vlib_frame_t * from_frame)
518 return esp_decrypt_inline (vm, node, from_frame, 0, 0);
521 VLIB_NODE_FN (esp4_decrypt_tun_node) (vlib_main_t * vm,
522 vlib_node_runtime_t * node,
523 vlib_frame_t * from_frame)
525 return esp_decrypt_inline (vm, node, from_frame, 0, 1);
528 VLIB_NODE_FN (esp6_decrypt_node) (vlib_main_t * vm,
529 vlib_node_runtime_t * node,
530 vlib_frame_t * from_frame)
532 return esp_decrypt_inline (vm, node, from_frame, 1, 0);
535 VLIB_NODE_FN (esp6_decrypt_tun_node) (vlib_main_t * vm,
536 vlib_node_runtime_t * node,
537 vlib_frame_t * from_frame)
539 return esp_decrypt_inline (vm, node, from_frame, 1, 1);
543 VLIB_REGISTER_NODE (esp4_decrypt_node) = {
544 .name = "esp4-decrypt",
545 .vector_size = sizeof (u32),
546 .format_trace = format_esp_decrypt_trace,
547 .type = VLIB_NODE_TYPE_INTERNAL,
549 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
550 .error_strings = esp_decrypt_error_strings,
552 .n_next_nodes = ESP_DECRYPT_N_NEXT,
554 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
555 foreach_esp_decrypt_next
560 VLIB_REGISTER_NODE (esp6_decrypt_node) = {
561 .name = "esp6-decrypt",
562 .vector_size = sizeof (u32),
563 .format_trace = format_esp_decrypt_trace,
564 .type = VLIB_NODE_TYPE_INTERNAL,
566 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
567 .error_strings = esp_decrypt_error_strings,
569 .n_next_nodes = ESP_DECRYPT_N_NEXT,
571 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
572 foreach_esp_decrypt_next
577 VLIB_REGISTER_NODE (esp4_decrypt_tun_node) = {
578 .name = "esp4-decrypt-tun",
579 .vector_size = sizeof (u32),
580 .format_trace = format_esp_decrypt_trace,
581 .type = VLIB_NODE_TYPE_INTERNAL,
583 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
584 .error_strings = esp_decrypt_error_strings,
586 .n_next_nodes = ESP_DECRYPT_N_NEXT,
588 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
589 foreach_esp_decrypt_next
594 VLIB_REGISTER_NODE (esp6_decrypt_tun_node) = {
595 .name = "esp6-decrypt-tun",
596 .vector_size = sizeof (u32),
597 .format_trace = format_esp_decrypt_trace,
598 .type = VLIB_NODE_TYPE_INTERNAL,
600 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
601 .error_strings = esp_decrypt_error_strings,
603 .n_next_nodes = ESP_DECRYPT_N_NEXT,
605 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
606 foreach_esp_decrypt_next
613 * fd.io coding-style-patch-verification: ON
616 * eval: (c-set-style "gnu")