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/buffer.h>
25 #include <dpdk/ipsec/ipsec.h>
26 #include <dpdk/device/dpdk.h>
27 #include <dpdk/device/dpdk_priv.h>
29 #define foreach_esp_decrypt_next \
30 _(DROP, "error-drop") \
31 _(IP4_INPUT, "ip4-input-no-checksum") \
32 _(IP6_INPUT, "ip6-input")
34 #define _(v, s) ESP_DECRYPT_NEXT_##v,
37 foreach_esp_decrypt_next
42 #define foreach_esp_decrypt_error \
43 _(RX_PKTS, "ESP pkts received") \
44 _(DECRYPTION_FAILED, "ESP decryption failed") \
45 _(REPLAY, "SA replayed packet") \
46 _(NOT_IP, "Not IP packet (dropped)") \
47 _(ENQ_FAIL, "Enqueue failed (buffer full)") \
48 _(DISCARD, "Not enough crypto operations, discarding frame") \
49 _(BAD_LEN, "Invalid ciphertext length") \
50 _(SESSION, "Failed to get crypto session") \
51 _(NOSUP, "Cipher/Auth not supported")
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
68 extern vlib_node_registration_t dpdk_esp4_decrypt_node;
69 extern vlib_node_registration_t dpdk_esp6_decrypt_node;
73 ipsec_crypto_alg_t crypto_alg;
74 ipsec_integ_alg_t integ_alg;
76 } esp_decrypt_trace_t;
78 /* packet trace format function */
80 format_esp_decrypt_trace (u8 * s, va_list * args)
82 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
83 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
84 esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
85 u32 indent = format_get_indent (s);
87 s = format (s, "cipher %U auth %U\n",
88 format_ipsec_crypto_alg, t->crypto_alg,
89 format_ipsec_integ_alg, t->integ_alg);
90 s = format (s, "%U%U",
91 format_white_space, indent, format_esp_header, t->packet_data);
96 dpdk_esp_decrypt_inline (vlib_main_t * vm,
97 vlib_node_runtime_t * node,
98 vlib_frame_t * from_frame, int is_ip6)
100 u32 n_left_from, *from, *to_next, next_index;
101 ipsec_main_t *im = &ipsec_main;
102 u32 thread_idx = vlib_get_thread_index ();
103 dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
104 crypto_resource_t *res = 0;
106 crypto_alg_t *cipher_alg = 0, *auth_alg = 0;
107 struct rte_cryptodev_sym_session *session = 0;
108 u32 ret, last_sa_index = ~0;
109 u8 numa = rte_socket_id ();
111 crypto_worker_main_t *cwm =
112 vec_elt_at_index (dcm->workers_main, thread_idx);
113 struct rte_crypto_op **ops = cwm->ops;
115 from = vlib_frame_vector_args (from_frame);
116 n_left_from = from_frame->n_vectors;
118 ret = crypto_alloc_ops (numa, ops, n_left_from);
122 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
123 ESP_DECRYPT_ERROR_DISCARD, 1);
125 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
126 ESP_DECRYPT_ERROR_DISCARD, 1);
127 /* Discard whole frame */
131 next_index = ESP_DECRYPT_NEXT_DROP;
133 while (n_left_from > 0)
137 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
139 while (n_left_from > 0 && n_left_to_next > 0)
142 u32 bi0, sa_index0, seq, iv_size;
146 struct rte_mbuf *mb0;
147 struct rte_crypto_op *op;
154 b0 = vlib_get_buffer (vm, bi0);
155 mb0 = rte_mbuf_from_vlib_buffer (b0);
156 esp0 = vlib_buffer_get_current (b0);
159 CLIB_PREFETCH (esp0, sizeof (esp0[0]) + 16, LOAD);
161 CLIB_PREFETCH (mb0, CLIB_CACHE_LINE_BYTES, STORE);
165 ASSERT (op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED);
167 dpdk_op_priv_t *priv = crypto_op_get_priv (op);
170 sizeof (op[0]) + sizeof (op[0].sym[0]) + sizeof (priv[0]);
171 CLIB_PREFETCH (op, op_len, STORE);
173 sa_index0 = vnet_buffer (b0)->ipsec.sad_index;
175 if (sa_index0 != last_sa_index)
177 sa0 = pool_elt_at_index (im->sad, sa_index0);
180 vec_elt_at_index (dcm->cipher_algs, sa0->crypto_alg);
181 auth_alg = vec_elt_at_index (dcm->auth_algs, sa0->integ_alg);
183 is_aead = (cipher_alg->type == RTE_CRYPTO_SYM_XFORM_AEAD);
185 auth_alg = cipher_alg;
187 res_idx = get_resource (cwm, sa0);
189 if (PREDICT_FALSE (res_idx == (u16) ~ 0))
191 clib_warning ("unsupported SA by thread index %u",
194 vlib_node_increment_counter (vm,
195 dpdk_esp6_decrypt_node.index,
196 ESP_DECRYPT_ERROR_NOSUP, 1);
198 vlib_node_increment_counter (vm,
199 dpdk_esp4_decrypt_node.index,
200 ESP_DECRYPT_ERROR_NOSUP, 1);
206 res = vec_elt_at_index (dcm->resource, res_idx);
208 error = crypto_get_session (&session, sa_index0, res, cwm, 0);
209 if (PREDICT_FALSE (error || !session))
211 clib_warning ("failed to get crypto session");
213 vlib_node_increment_counter (vm,
214 dpdk_esp6_decrypt_node.index,
215 ESP_DECRYPT_ERROR_SESSION,
218 vlib_node_increment_counter (vm,
219 dpdk_esp4_decrypt_node.index,
220 ESP_DECRYPT_ERROR_SESSION,
228 last_sa_index = sa_index0;
231 /* anti-replay check */
232 if (sa0->use_anti_replay)
236 seq = clib_net_to_host_u32 (esp0->seq);
238 if (PREDICT_TRUE (sa0->use_esn))
239 rv = esp_replay_check_esn (sa0, seq);
241 rv = esp_replay_check (sa0, seq);
243 if (PREDICT_FALSE (rv))
245 clib_warning ("failed anti-replay check");
247 vlib_node_increment_counter (vm,
248 dpdk_esp6_decrypt_node.index,
249 ESP_DECRYPT_ERROR_REPLAY, 1);
251 vlib_node_increment_counter (vm,
252 dpdk_esp4_decrypt_node.index,
253 ESP_DECRYPT_ERROR_REPLAY, 1);
262 priv->next = DPDK_CRYPTO_INPUT_NEXT_DECRYPT6_POST;
264 priv->next = DPDK_CRYPTO_INPUT_NEXT_DECRYPT4_POST;
266 /* FIXME multi-seg */
267 sa0->total_data_size += b0->current_length;
269 res->ops[res->n_ops] = op;
270 res->bi[res->n_ops] = bi0;
273 /* Convert vlib buffer to mbuf */
274 mb0->data_len = b0->current_length;
275 mb0->pkt_len = b0->current_length;
276 mb0->data_off = RTE_PKTMBUF_HEADROOM + b0->current_data;
278 trunc_size = auth_alg->trunc_size;
279 iv_size = cipher_alg->iv_len;
281 /* Outer IP header has already been stripped */
283 b0->current_length - sizeof (esp_header_t) - iv_size - trunc_size;
285 ASSERT (payload_len >= 4);
287 if (payload_len & (cipher_alg->boundary - 1))
289 clib_warning ("payload %u not multiple of %d\n",
290 payload_len, cipher_alg->boundary);
292 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
293 ESP_DECRYPT_ERROR_BAD_LEN, 1);
295 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
296 ESP_DECRYPT_ERROR_BAD_LEN, 1);
304 u32 cipher_off, cipher_len;
308 u8 *iv = (u8 *) (esp0 + 1);
310 dpdk_gcm_cnt_blk *icb = &priv->cb;
312 cipher_off = sizeof (esp_header_t) + iv_size;
313 cipher_len = payload_len;
315 u8 *digest = vlib_buffer_get_tail (b0) - trunc_size;
317 mb0->buf_physaddr + digest - ((u8 *) mb0->buf_addr);
319 if (!is_aead && cipher_alg->alg == RTE_CRYPTO_CIPHER_AES_CBC)
320 clib_memcpy_fast (icb, iv, 16);
323 u32 *_iv = (u32 *) iv;
325 crypto_set_icb (icb, sa0->salt, _iv[0], _iv[1]);
331 u32 *_aad = (u32 *) aad;
332 clib_memcpy_fast (aad, esp0, 8);
334 /* _aad[3] should always be 0 */
335 if (PREDICT_FALSE (sa0->use_esn))
336 _aad[2] = clib_host_to_net_u32 (sa0->seq_hi);
342 auth_len = sizeof (esp_header_t) + iv_size + payload_len;
346 clib_memcpy_fast (priv->icv, digest, trunc_size);
347 u32 *_digest = (u32 *) digest;
348 _digest[0] = clib_host_to_net_u32 (sa0->seq_hi);
349 auth_len += sizeof (sa0->seq_hi);
353 op->phys_addr + (uintptr_t) priv->icv - (uintptr_t) op;
357 crypto_op_setup (is_aead, mb0, op, session, cipher_off, cipher_len,
358 0, auth_len, aad, digest, digest_paddr);
360 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
362 esp_decrypt_trace_t *tr =
363 vlib_add_trace (vm, node, b0, sizeof (*tr));
364 tr->crypto_alg = sa0->crypto_alg;
365 tr->integ_alg = sa0->integ_alg;
366 clib_memcpy_fast (tr->packet_data, vlib_buffer_get_current (b0),
367 sizeof (esp_header_t));
370 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
375 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
376 ESP_DECRYPT_ERROR_RX_PKTS,
377 from_frame->n_vectors);
379 crypto_enqueue_ops (vm, cwm, 0, dpdk_esp6_decrypt_node.index,
380 ESP_DECRYPT_ERROR_ENQ_FAIL, numa);
384 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
385 ESP_DECRYPT_ERROR_RX_PKTS,
386 from_frame->n_vectors);
388 crypto_enqueue_ops (vm, cwm, 0, dpdk_esp4_decrypt_node.index,
389 ESP_DECRYPT_ERROR_ENQ_FAIL, numa);
392 crypto_free_ops (numa, ops, cwm->ops + from_frame->n_vectors - ops);
394 return from_frame->n_vectors;
397 VLIB_NODE_FN (dpdk_esp4_decrypt_node) (vlib_main_t * vm,
398 vlib_node_runtime_t * node,
399 vlib_frame_t * from_frame)
401 return dpdk_esp_decrypt_inline (vm, node, from_frame, 0 /*is_ip6 */ );
405 VLIB_REGISTER_NODE (dpdk_esp4_decrypt_node) = {
406 .name = "dpdk-esp4-decrypt",
407 .vector_size = sizeof (u32),
408 .format_trace = format_esp_decrypt_trace,
409 .type = VLIB_NODE_TYPE_INTERNAL,
411 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
412 .error_strings = esp_decrypt_error_strings,
414 .n_next_nodes = ESP_DECRYPT_N_NEXT,
416 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
417 foreach_esp_decrypt_next
423 VLIB_NODE_FN (dpdk_esp6_decrypt_node) (vlib_main_t * vm,
424 vlib_node_runtime_t * node,
425 vlib_frame_t * from_frame)
427 return dpdk_esp_decrypt_inline (vm, node, from_frame, 1 /*is_ip6 */ );
431 VLIB_REGISTER_NODE (dpdk_esp6_decrypt_node) = {
432 .name = "dpdk-esp6-decrypt",
433 .vector_size = sizeof (u32),
434 .format_trace = format_esp_decrypt_trace,
435 .type = VLIB_NODE_TYPE_INTERNAL,
437 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
438 .error_strings = esp_decrypt_error_strings,
440 .n_next_nodes = ESP_DECRYPT_N_NEXT,
442 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
443 foreach_esp_decrypt_next
453 #define foreach_esp_decrypt_post_error \
454 _(PKTS, "ESP post pkts")
458 #define _(sym,str) ESP_DECRYPT_POST_ERROR_##sym,
459 foreach_esp_decrypt_post_error
461 ESP_DECRYPT_POST_N_ERROR,
462 } esp_decrypt_post_error_t;
464 static char *esp_decrypt_post_error_strings[] = {
465 #define _(sym,string) string,
466 foreach_esp_decrypt_post_error
470 extern vlib_node_registration_t dpdk_esp4_decrypt_post_node;
471 extern vlib_node_registration_t dpdk_esp6_decrypt_post_node;
474 format_esp_decrypt_post_trace (u8 * s, va_list * args)
476 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
477 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
478 esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
479 u32 indent = format_get_indent (s);
481 s = format (s, "cipher %U auth %U\n",
482 format_ipsec_crypto_alg, t->crypto_alg,
483 format_ipsec_integ_alg, t->integ_alg);
485 ip4_header_t *ih4 = (ip4_header_t *) t->packet_data;
486 if ((ih4->ip_version_and_header_length & 0xF0) == 0x60)
488 format (s, "%U%U", format_white_space, indent, format_ip6_header, ih4);
491 format (s, "%U%U", format_white_space, indent, format_ip4_header, ih4);
497 dpdk_esp_decrypt_post_inline (vlib_main_t * vm,
498 vlib_node_runtime_t * node,
499 vlib_frame_t * from_frame, int is_ip6)
501 u32 n_left_from, *from, *to_next = 0, next_index;
504 ipsec_main_t *im = &ipsec_main;
505 dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
507 from = vlib_frame_vector_args (from_frame);
508 n_left_from = from_frame->n_vectors;
510 next_index = node->cached_next_index;
512 while (n_left_from > 0)
516 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
518 while (n_left_from > 0 && n_left_to_next > 0)
521 u32 bi0, iv_size, next0;
522 vlib_buffer_t *b0 = 0;
523 ip4_header_t *ih4 = 0, *oh4 = 0;
524 ip6_header_t *ih6 = 0, *oh6 = 0;
525 crypto_alg_t *cipher_alg, *auth_alg;
527 u8 trunc_size, is_aead;
528 u16 udp_encap_adv = 0;
530 next0 = ESP_DECRYPT_NEXT_DROP;
537 b0 = vlib_get_buffer (vm, bi0);
538 esp0 = vlib_buffer_get_current (b0);
540 sa_index0 = vnet_buffer (b0)->ipsec.sad_index;
541 sa0 = pool_elt_at_index (im->sad, sa_index0);
546 cipher_alg = vec_elt_at_index (dcm->cipher_algs, sa0->crypto_alg);
547 auth_alg = vec_elt_at_index (dcm->auth_algs, sa0->integ_alg);
548 is_aead = cipher_alg->type == RTE_CRYPTO_SYM_XFORM_AEAD;
550 auth_alg = cipher_alg;
552 trunc_size = auth_alg->trunc_size;
554 iv_size = cipher_alg->iv_len;
556 if (sa0->use_anti_replay)
559 seq = clib_host_to_net_u32 (esp0->seq);
560 if (PREDICT_TRUE (sa0->use_esn))
561 esp_replay_advance_esn (sa0, seq);
563 esp_replay_advance (sa0, seq);
566 /* if UDP encapsulation is used adjust the address of the IP header */
567 if (sa0->udp_encap && (b0->flags & VNET_BUFFER_F_IS_IP4))
569 udp_encap_adv = sizeof (udp_header_t);
572 if (b0->flags & VNET_BUFFER_F_IS_IP4)
573 ih4 = (ip4_header_t *)
574 ((u8 *) esp0 - udp_encap_adv - sizeof (ip4_header_t));
576 ih4 = (ip4_header_t *) ((u8 *) esp0 - sizeof (ip6_header_t));
578 vlib_buffer_advance (b0, sizeof (esp_header_t) + iv_size);
580 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
581 f0 = (esp_footer_t *) (vlib_buffer_get_tail (b0) - trunc_size - 2);
582 b0->current_length -= (f0->pad_length + trunc_size + 2);
585 const u8 *padding = vlib_buffer_get_tail (b0);
586 if (PREDICT_FALSE (memcmp (padding, pad_data, f0->pad_length)))
588 clib_warning ("bad padding");
589 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
590 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
597 if (f0->next_header == IP_PROTOCOL_IP_IN_IP)
598 next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
599 else if (sa0->is_tunnel_ip6
600 && f0->next_header == IP_PROTOCOL_IPV6)
601 next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
604 clib_warning ("next header: 0x%x", f0->next_header);
606 vlib_node_increment_counter (vm,
607 dpdk_esp6_decrypt_node.index,
608 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
611 vlib_node_increment_counter (vm,
612 dpdk_esp4_decrypt_node.index,
613 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
618 else /* transport mode */
620 if ((ih4->ip_version_and_header_length & 0xF0) == 0x40)
622 u16 ih4_len = ip4_header_bytes (ih4);
623 vlib_buffer_advance (b0, -ih4_len - udp_encap_adv);
624 next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
627 oh4 = vlib_buffer_get_current (b0);
628 memmove (oh4, ih4, ih4_len);
629 oh4->protocol = f0->next_header;
630 oh4->length = clib_host_to_net_u16 (b0->current_length);
631 oh4->checksum = ip4_header_checksum (oh4);
634 else if ((ih4->ip_version_and_header_length & 0xF0) == 0x60)
636 ih6 = (ip6_header_t *) ih4;
637 vlib_buffer_advance (b0, -sizeof (ip6_header_t));
638 oh6 = vlib_buffer_get_current (b0);
639 memmove (oh6, ih6, sizeof (ip6_header_t));
641 next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
642 oh6->protocol = f0->next_header;
643 u16 len = b0->current_length - sizeof (ip6_header_t);
644 oh6->payload_length = clib_host_to_net_u16 (len);
648 clib_warning ("next header: 0x%x", f0->next_header);
650 vlib_node_increment_counter (vm,
651 dpdk_esp6_decrypt_node.index,
652 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
655 vlib_node_increment_counter (vm,
656 dpdk_esp4_decrypt_node.index,
657 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
663 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
666 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
668 esp_decrypt_trace_t *tr =
669 vlib_add_trace (vm, node, b0, sizeof (*tr));
670 tr->crypto_alg = sa0->crypto_alg;
671 tr->integ_alg = sa0->integ_alg;
672 ih4 = vlib_buffer_get_current (b0);
673 clib_memcpy_fast (tr->packet_data, ih4, sizeof (ip6_header_t));
676 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
677 to_next, n_left_to_next, bi0,
680 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
684 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_post_node.index,
685 ESP_DECRYPT_POST_ERROR_PKTS,
686 from_frame->n_vectors);
688 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_post_node.index,
689 ESP_DECRYPT_POST_ERROR_PKTS,
690 from_frame->n_vectors);
692 return from_frame->n_vectors;
695 VLIB_NODE_FN (dpdk_esp4_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_esp4_decrypt_post_node) = {
704 .name = "dpdk-esp4-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
721 VLIB_NODE_FN (dpdk_esp6_decrypt_post_node) (vlib_main_t * vm,
722 vlib_node_runtime_t * node,
723 vlib_frame_t * from_frame)
725 return dpdk_esp_decrypt_post_inline (vm, node, from_frame, 0 /*is_ip6 */ );
729 VLIB_REGISTER_NODE (dpdk_esp6_decrypt_post_node) = {
730 .name = "dpdk-esp6-decrypt-post",
731 .vector_size = sizeof (u32),
732 .format_trace = format_esp_decrypt_post_trace,
733 .type = VLIB_NODE_TYPE_INTERNAL,
735 .n_errors = ARRAY_LEN(esp_decrypt_post_error_strings),
736 .error_strings = esp_decrypt_post_error_strings,
738 .n_next_nodes = ESP_DECRYPT_N_NEXT,
740 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
741 foreach_esp_decrypt_next
748 * fd.io coding-style-patch-verification: ON
751 * eval: (c-set-style "gnu")