2 * esp_decrypt.c : IPSec ESP Decrypt node using DPDK Cryptodev
4 * Copyright (c) 2017 Intel 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 opy 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 <dpdk/ipsec/ipsec.h>
25 #include <dpdk/device/dpdk.h>
26 #include <dpdk/device/dpdk_priv.h>
28 #define foreach_esp_decrypt_next \
29 _(DROP, "error-drop") \
30 _(IP4_INPUT, "ip4-input-no-checksum") \
31 _(IP6_INPUT, "ip6-input")
33 #define _(v, s) ESP_DECRYPT_NEXT_##v,
35 foreach_esp_decrypt_next
40 #define foreach_esp_decrypt_error \
41 _(RX_PKTS, "ESP pkts received") \
42 _(DECRYPTION_FAILED, "ESP decryption failed") \
43 _(REPLAY, "SA replayed packet") \
44 _(NOT_IP, "Not IP packet (dropped)") \
45 _(ENQ_FAIL, "Enqueue failed (buffer full)") \
46 _(DISCARD, "Not enough crypto operations, discarding frame") \
47 _(BAD_LEN, "Invalid ciphertext length") \
48 _(SESSION, "Failed to get crypto session") \
49 _(NOSUP, "Cipher/Auth not supported")
53 #define _(sym,str) ESP_DECRYPT_ERROR_##sym,
54 foreach_esp_decrypt_error
57 } esp_decrypt_error_t;
59 static char * esp_decrypt_error_strings[] = {
60 #define _(sym,string) string,
61 foreach_esp_decrypt_error
65 extern vlib_node_registration_t dpdk_esp4_decrypt_node;
66 extern vlib_node_registration_t dpdk_esp6_decrypt_node;
69 ipsec_crypto_alg_t crypto_alg;
70 ipsec_integ_alg_t integ_alg;
72 } esp_decrypt_trace_t;
74 /* packet trace format function */
75 static u8 * format_esp_decrypt_trace (u8 * s, va_list * args)
77 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
78 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
79 esp_decrypt_trace_t * t = va_arg (*args, esp_decrypt_trace_t *);
80 u32 indent = format_get_indent (s);
82 s = format (s, "cipher %U auth %U\n",
83 format_ipsec_crypto_alg, t->crypto_alg,
84 format_ipsec_integ_alg, t->integ_alg);
85 s = format (s, "%U%U",
86 format_white_space, indent,
87 format_esp_header, t->packet_data);
92 dpdk_esp_decrypt_inline (vlib_main_t * vm,
93 vlib_node_runtime_t * node,
94 vlib_frame_t * from_frame,
97 u32 n_left_from, *from, *to_next, next_index;
98 ipsec_main_t *im = &ipsec_main;
99 u32 thread_idx = vlib_get_thread_index();
100 dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
101 crypto_resource_t *res = 0;
103 crypto_alg_t *cipher_alg = 0, *auth_alg = 0;
104 struct rte_cryptodev_sym_session *session = 0;
105 u32 ret, last_sa_index = ~0;
106 u8 numa = rte_socket_id ();
108 crypto_worker_main_t *cwm =
109 vec_elt_at_index (dcm->workers_main, thread_idx);
110 struct rte_crypto_op **ops = cwm->ops;
112 from = vlib_frame_vector_args (from_frame);
113 n_left_from = from_frame->n_vectors;
115 ret = crypto_alloc_ops (numa, ops, n_left_from);
119 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
120 ESP_DECRYPT_ERROR_DISCARD, 1);
122 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
123 ESP_DECRYPT_ERROR_DISCARD, 1);
124 /* Discard whole frame */
128 next_index = ESP_DECRYPT_NEXT_DROP;
130 while (n_left_from > 0)
134 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
136 while (n_left_from > 0 && n_left_to_next > 0)
139 u32 bi0, sa_index0, seq, iv_size;
143 struct rte_mbuf *mb0;
144 struct rte_crypto_op *op;
151 b0 = vlib_get_buffer (vm, bi0);
152 mb0 = rte_mbuf_from_vlib_buffer(b0);
153 esp0 = vlib_buffer_get_current (b0);
156 CLIB_PREFETCH (esp0, sizeof (esp0[0]) + 16, LOAD);
158 CLIB_PREFETCH (mb0, CLIB_CACHE_LINE_BYTES, STORE);
162 ASSERT (op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED);
164 dpdk_op_priv_t *priv = crypto_op_get_priv (op);
167 sizeof (op[0]) + sizeof (op[0].sym[0]) + sizeof (priv[0]);
168 CLIB_PREFETCH (op, op_len, STORE);
170 sa_index0 = vnet_buffer(b0)->ipsec.sad_index;
172 if (sa_index0 != last_sa_index)
174 sa0 = pool_elt_at_index (im->sad, sa_index0);
176 cipher_alg = vec_elt_at_index (dcm->cipher_algs, sa0->crypto_alg);
177 auth_alg = vec_elt_at_index (dcm->auth_algs, sa0->integ_alg);
179 is_aead = (cipher_alg->type == RTE_CRYPTO_SYM_XFORM_AEAD);
181 auth_alg = cipher_alg;
183 res_idx = get_resource (cwm, sa0);
185 if (PREDICT_FALSE (res_idx == (u16) ~0))
187 clib_warning ("unsupported SA by thread index %u", thread_idx);
189 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
190 ESP_DECRYPT_ERROR_NOSUP, 1);
192 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
193 ESP_DECRYPT_ERROR_NOSUP, 1);
199 res = vec_elt_at_index (dcm->resource, res_idx);
201 error = crypto_get_session (&session, sa_index0, res, cwm, 0);
202 if (PREDICT_FALSE (error || !session))
204 clib_warning ("failed to get crypto session");
206 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
207 ESP_DECRYPT_ERROR_SESSION, 1);
209 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
210 ESP_DECRYPT_ERROR_SESSION, 1);
217 last_sa_index = sa_index0;
220 /* anti-replay check */
221 if (sa0->use_anti_replay)
225 seq = clib_net_to_host_u32 (esp0->seq);
227 if (PREDICT_TRUE(sa0->use_esn))
228 rv = esp_replay_check_esn (sa0, seq);
230 rv = esp_replay_check (sa0, seq);
232 if (PREDICT_FALSE (rv))
234 clib_warning ("failed anti-replay check");
236 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
237 ESP_DECRYPT_ERROR_REPLAY, 1);
239 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
240 ESP_DECRYPT_ERROR_REPLAY, 1);
249 priv->next = DPDK_CRYPTO_INPUT_NEXT_DECRYPT6_POST;
251 priv->next = DPDK_CRYPTO_INPUT_NEXT_DECRYPT4_POST;
253 /* FIXME multi-seg */
254 sa0->total_data_size += b0->current_length;
256 res->ops[res->n_ops] = op;
257 res->bi[res->n_ops] = bi0;
260 /* Convert vlib buffer to mbuf */
261 mb0->data_len = b0->current_length;
262 mb0->pkt_len = b0->current_length;
263 mb0->data_off = RTE_PKTMBUF_HEADROOM + b0->current_data;
265 trunc_size = auth_alg->trunc_size;
266 iv_size = cipher_alg->iv_len;
268 /* Outer IP header has already been stripped */
270 b0->current_length - sizeof (esp_header_t) - iv_size - trunc_size;
272 ASSERT (payload_len >= 4);
274 if (payload_len & (cipher_alg->boundary - 1))
276 clib_warning ("payload %u not multiple of %d\n",
277 payload_len, cipher_alg->boundary);
279 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
280 ESP_DECRYPT_ERROR_BAD_LEN, 1);
282 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
283 ESP_DECRYPT_ERROR_BAD_LEN, 1);
291 u32 cipher_off, cipher_len;
295 u8 *iv = (u8 *) (esp0 + 1);
297 dpdk_gcm_cnt_blk *icb = &priv->cb;
299 cipher_off = sizeof (esp_header_t) + iv_size;
300 cipher_len = payload_len;
302 u8 *digest = vlib_buffer_get_tail (b0) - trunc_size;
304 mb0->buf_physaddr + digest - ((u8 *) mb0->buf_addr);
306 if (!is_aead && cipher_alg->alg == RTE_CRYPTO_CIPHER_AES_CBC)
307 clib_memcpy_fast(icb, iv, 16);
310 u32 *_iv = (u32 *) iv;
312 crypto_set_icb (icb, sa0->salt, _iv[0], _iv[1]);
318 u32 * _aad = (u32 *) aad;
319 clib_memcpy_fast (aad, esp0, 8);
321 /* _aad[3] should always be 0 */
322 if (PREDICT_FALSE (sa0->use_esn))
323 _aad[2] = clib_host_to_net_u32 (sa0->seq_hi);
329 auth_len = sizeof(esp_header_t) + iv_size + payload_len;
333 clib_memcpy_fast (priv->icv, digest, trunc_size);
334 u32 *_digest = (u32 *) digest;
335 _digest[0] = clib_host_to_net_u32 (sa0->seq_hi);
336 auth_len += sizeof(sa0->seq_hi);
340 op->phys_addr + (uintptr_t) priv->icv - (uintptr_t) op;
344 crypto_op_setup (is_aead, mb0, op, session, cipher_off, cipher_len,
345 0, auth_len, aad, digest, digest_paddr);
347 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
349 esp_decrypt_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
350 tr->crypto_alg = sa0->crypto_alg;
351 tr->integ_alg = sa0->integ_alg;
352 clib_memcpy_fast (tr->packet_data, vlib_buffer_get_current (b0),
353 sizeof (esp_header_t));
356 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
360 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
361 ESP_DECRYPT_ERROR_RX_PKTS,
362 from_frame->n_vectors);
364 crypto_enqueue_ops (vm, cwm, 0, dpdk_esp6_decrypt_node.index,
365 ESP_DECRYPT_ERROR_ENQ_FAIL, numa);
369 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
370 ESP_DECRYPT_ERROR_RX_PKTS,
371 from_frame->n_vectors);
373 crypto_enqueue_ops (vm, cwm, 0, dpdk_esp4_decrypt_node.index,
374 ESP_DECRYPT_ERROR_ENQ_FAIL, numa);
377 crypto_free_ops (numa, ops, cwm->ops + from_frame->n_vectors - ops);
379 return from_frame->n_vectors;
382 VLIB_NODE_FN(dpdk_esp4_decrypt_node) (vlib_main_t * vm,
383 vlib_node_runtime_t * node,
384 vlib_frame_t * from_frame)
386 return dpdk_esp_decrypt_inline(vm, node, from_frame, 0 /*is_ip6*/);
390 VLIB_REGISTER_NODE (dpdk_esp4_decrypt_node) = {
391 .name = "dpdk-esp4-decrypt",
392 .vector_size = sizeof (u32),
393 .format_trace = format_esp_decrypt_trace,
394 .type = VLIB_NODE_TYPE_INTERNAL,
396 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
397 .error_strings = esp_decrypt_error_strings,
399 .n_next_nodes = ESP_DECRYPT_N_NEXT,
401 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
402 foreach_esp_decrypt_next
408 VLIB_NODE_FN(dpdk_esp6_decrypt_node) (vlib_main_t * vm,
409 vlib_node_runtime_t * node,
410 vlib_frame_t * from_frame)
412 return dpdk_esp_decrypt_inline(vm, node, from_frame, 1 /*is_ip6*/);
416 VLIB_REGISTER_NODE (dpdk_esp6_decrypt_node) = {
417 .name = "dpdk-esp6-decrypt",
418 .vector_size = sizeof (u32),
419 .format_trace = format_esp_decrypt_trace,
420 .type = VLIB_NODE_TYPE_INTERNAL,
422 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
423 .error_strings = esp_decrypt_error_strings,
425 .n_next_nodes = ESP_DECRYPT_N_NEXT,
427 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
428 foreach_esp_decrypt_next
438 #define foreach_esp_decrypt_post_error \
439 _(PKTS, "ESP post pkts")
442 #define _(sym,str) ESP_DECRYPT_POST_ERROR_##sym,
443 foreach_esp_decrypt_post_error
445 ESP_DECRYPT_POST_N_ERROR,
446 } esp_decrypt_post_error_t;
448 static char * esp_decrypt_post_error_strings[] = {
449 #define _(sym,string) string,
450 foreach_esp_decrypt_post_error
454 extern vlib_node_registration_t dpdk_esp4_decrypt_post_node;
455 extern vlib_node_registration_t dpdk_esp6_decrypt_post_node;
457 static u8 * format_esp_decrypt_post_trace (u8 * s, va_list * args)
459 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
460 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
461 esp_decrypt_trace_t * t = va_arg (*args, esp_decrypt_trace_t *);
462 u32 indent = format_get_indent (s);
464 s = format (s, "cipher %U auth %U\n",
465 format_ipsec_crypto_alg, t->crypto_alg,
466 format_ipsec_integ_alg, t->integ_alg);
468 ip4_header_t *ih4 = (ip4_header_t *) t->packet_data;
469 if ((ih4->ip_version_and_header_length & 0xF0) == 0x60)
470 s = format (s, "%U%U", format_white_space, indent, format_ip6_header, ih4);
472 s = format (s, "%U%U", format_white_space, indent, format_ip4_header, ih4);
478 dpdk_esp_decrypt_post_inline (vlib_main_t * vm,
479 vlib_node_runtime_t * node,
480 vlib_frame_t * from_frame,
483 u32 n_left_from, *from, *to_next = 0, next_index;
486 ipsec_main_t *im = &ipsec_main;
487 dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
489 from = vlib_frame_vector_args (from_frame);
490 n_left_from = from_frame->n_vectors;
492 next_index = node->cached_next_index;
494 while (n_left_from > 0)
498 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
500 while (n_left_from > 0 && n_left_to_next > 0)
503 u32 bi0, iv_size, next0;
504 vlib_buffer_t * b0 = 0;
505 ip4_header_t *ih4 = 0, *oh4 = 0;
506 ip6_header_t *ih6 = 0, *oh6 = 0;
507 crypto_alg_t *cipher_alg, *auth_alg;
509 u8 trunc_size, is_aead;
510 u16 udp_encap_adv = 0;
512 next0 = ESP_DECRYPT_NEXT_DROP;
519 b0 = vlib_get_buffer (vm, bi0);
520 esp0 = vlib_buffer_get_current (b0);
522 sa_index0 = vnet_buffer(b0)->ipsec.sad_index;
523 sa0 = pool_elt_at_index (im->sad, sa_index0);
528 cipher_alg = vec_elt_at_index (dcm->cipher_algs, sa0->crypto_alg);
529 auth_alg = vec_elt_at_index (dcm->auth_algs, sa0->integ_alg);
530 is_aead = cipher_alg->type == RTE_CRYPTO_SYM_XFORM_AEAD;
532 auth_alg = cipher_alg;
534 trunc_size = auth_alg->trunc_size;
536 iv_size = cipher_alg->iv_len;
538 if (sa0->use_anti_replay)
541 seq = clib_host_to_net_u32(esp0->seq);
542 if (PREDICT_TRUE(sa0->use_esn))
543 esp_replay_advance_esn(sa0, seq);
545 esp_replay_advance(sa0, seq);
548 /* if UDP encapsulation is used adjust the address of the IP header */
549 if (sa0->udp_encap && (b0->flags & VNET_BUFFER_F_IS_IP4))
551 udp_encap_adv = sizeof (udp_header_t);
554 if (b0->flags & VNET_BUFFER_F_IS_IP4)
555 ih4 = (ip4_header_t *)
556 ((u8 *) esp0 - udp_encap_adv - sizeof (ip4_header_t));
559 (ip4_header_t *) ((u8 *) esp0 - sizeof (ip6_header_t));
561 vlib_buffer_advance (b0, sizeof (esp_header_t) + iv_size);
563 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
564 f0 = (esp_footer_t *) (vlib_buffer_get_tail (b0) - trunc_size - 2);
565 b0->current_length -= (f0->pad_length + trunc_size + 2);
568 const u8 *padding = vlib_buffer_get_tail (b0);
569 if (PREDICT_FALSE (memcmp (padding, pad_data, f0->pad_length)))
571 clib_warning("bad padding");
572 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
573 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
580 if (f0->next_header == IP_PROTOCOL_IP_IN_IP)
581 next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
582 else if (sa0->is_tunnel_ip6 && f0->next_header == IP_PROTOCOL_IPV6)
583 next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
586 clib_warning("next header: 0x%x", f0->next_header);
588 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
589 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
592 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
593 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
598 else /* transport mode */
600 if ((ih4->ip_version_and_header_length & 0xF0) == 0x40)
602 u16 ih4_len = ip4_header_bytes (ih4);
603 vlib_buffer_advance (b0, - ih4_len - udp_encap_adv);
604 next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
607 oh4 = vlib_buffer_get_current (b0);
608 memmove(oh4, ih4, ih4_len);
609 oh4->protocol = f0->next_header;
610 oh4->length = clib_host_to_net_u16 (b0->current_length);
611 oh4->checksum = ip4_header_checksum(oh4);
614 else if ((ih4->ip_version_and_header_length & 0xF0) == 0x60)
616 ih6 = (ip6_header_t *) ih4;
617 vlib_buffer_advance (b0, -sizeof(ip6_header_t));
618 oh6 = vlib_buffer_get_current (b0);
619 memmove(oh6, ih6, sizeof(ip6_header_t));
621 next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
622 oh6->protocol = f0->next_header;
623 u16 len = b0->current_length - sizeof (ip6_header_t);
624 oh6->payload_length = clib_host_to_net_u16 (len);
628 clib_warning("next header: 0x%x", f0->next_header);
630 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
631 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
634 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
635 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
641 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32)~0;
644 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
646 esp_decrypt_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
647 tr->crypto_alg = sa0->crypto_alg;
648 tr->integ_alg = sa0->integ_alg;
649 ih4 = vlib_buffer_get_current (b0);
650 clib_memcpy_fast (tr->packet_data, ih4, sizeof (ip6_header_t));
653 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
654 to_next, n_left_to_next, bi0, next0);
656 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
660 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_post_node.index,
661 ESP_DECRYPT_POST_ERROR_PKTS,
662 from_frame->n_vectors);
664 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_post_node.index,
665 ESP_DECRYPT_POST_ERROR_PKTS,
666 from_frame->n_vectors);
668 return from_frame->n_vectors;
671 VLIB_NODE_FN(dpdk_esp4_decrypt_post_node) (vlib_main_t * vm,
672 vlib_node_runtime_t * node,
673 vlib_frame_t * from_frame)
674 {return dpdk_esp_decrypt_post_inline(vm, node, from_frame, 0/*is_ip6*/);}
677 VLIB_REGISTER_NODE (dpdk_esp4_decrypt_post_node) = {
678 .name = "dpdk-esp4-decrypt-post",
679 .vector_size = sizeof (u32),
680 .format_trace = format_esp_decrypt_post_trace,
681 .type = VLIB_NODE_TYPE_INTERNAL,
683 .n_errors = ARRAY_LEN(esp_decrypt_post_error_strings),
684 .error_strings = esp_decrypt_post_error_strings,
686 .n_next_nodes = ESP_DECRYPT_N_NEXT,
688 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
689 foreach_esp_decrypt_next
695 VLIB_NODE_FN(dpdk_esp6_decrypt_post_node) (vlib_main_t * vm,
696 vlib_node_runtime_t * node,
697 vlib_frame_t * from_frame)
699 return dpdk_esp_decrypt_post_inline(vm, node, from_frame, 0/*is_ip6*/);
703 VLIB_REGISTER_NODE (dpdk_esp6_decrypt_post_node) = {
704 .name = "dpdk-esp6-decrypt-post",
705 .vector_size = sizeof (u32),
706 .format_trace = format_esp_decrypt_post_trace,
707 .type = VLIB_NODE_TYPE_INTERNAL,
709 .n_errors = ARRAY_LEN(esp_decrypt_post_error_strings),
710 .error_strings = esp_decrypt_post_error_strings,
712 .n_next_nodes = ESP_DECRYPT_N_NEXT,
714 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
715 foreach_esp_decrypt_next