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);
168 /* store bi in op private */
172 sizeof (op[0]) + sizeof (op[0].sym[0]) + sizeof (priv[0]);
173 CLIB_PREFETCH (op, op_len, STORE);
175 sa_index0 = vnet_buffer (b0)->ipsec.sad_index;
177 if (sa_index0 != last_sa_index)
179 sa0 = pool_elt_at_index (im->sad, sa_index0);
182 vec_elt_at_index (dcm->cipher_algs, sa0->crypto_alg);
183 auth_alg = vec_elt_at_index (dcm->auth_algs, sa0->integ_alg);
185 is_aead = (cipher_alg->type == RTE_CRYPTO_SYM_XFORM_AEAD);
187 auth_alg = cipher_alg;
189 res_idx = get_resource (cwm, sa0);
191 if (PREDICT_FALSE (res_idx == (u16) ~ 0))
193 clib_warning ("unsupported SA by thread index %u",
196 vlib_node_increment_counter (vm,
197 dpdk_esp6_decrypt_node.index,
198 ESP_DECRYPT_ERROR_NOSUP, 1);
200 vlib_node_increment_counter (vm,
201 dpdk_esp4_decrypt_node.index,
202 ESP_DECRYPT_ERROR_NOSUP, 1);
208 res = vec_elt_at_index (dcm->resource, res_idx);
210 error = crypto_get_session (&session, sa_index0, res, cwm, 0);
211 if (PREDICT_FALSE (error || !session))
213 clib_warning ("failed to get crypto session");
215 vlib_node_increment_counter (vm,
216 dpdk_esp6_decrypt_node.index,
217 ESP_DECRYPT_ERROR_SESSION,
220 vlib_node_increment_counter (vm,
221 dpdk_esp4_decrypt_node.index,
222 ESP_DECRYPT_ERROR_SESSION,
230 last_sa_index = sa_index0;
233 /* anti-replay check */
234 if (sa0->use_anti_replay)
238 seq = clib_net_to_host_u32 (esp0->seq);
240 if (PREDICT_TRUE (sa0->use_esn))
241 rv = esp_replay_check_esn (sa0, seq);
243 rv = esp_replay_check (sa0, seq);
245 if (PREDICT_FALSE (rv))
247 clib_warning ("failed anti-replay check");
249 vlib_node_increment_counter (vm,
250 dpdk_esp6_decrypt_node.index,
251 ESP_DECRYPT_ERROR_REPLAY, 1);
253 vlib_node_increment_counter (vm,
254 dpdk_esp4_decrypt_node.index,
255 ESP_DECRYPT_ERROR_REPLAY, 1);
264 priv->next = DPDK_CRYPTO_INPUT_NEXT_DECRYPT6_POST;
266 priv->next = DPDK_CRYPTO_INPUT_NEXT_DECRYPT4_POST;
268 /* FIXME multi-seg */
269 sa0->total_data_size += b0->current_length;
271 res->ops[res->n_ops] = op;
272 res->bi[res->n_ops] = bi0;
275 /* Convert vlib buffer to mbuf */
276 mb0->data_len = b0->current_length;
277 mb0->pkt_len = b0->current_length;
278 mb0->data_off = RTE_PKTMBUF_HEADROOM + b0->current_data;
280 trunc_size = auth_alg->trunc_size;
281 iv_size = cipher_alg->iv_len;
283 /* Outer IP header has already been stripped */
285 b0->current_length - sizeof (esp_header_t) - iv_size - trunc_size;
287 ASSERT (payload_len >= 4);
289 if (payload_len & (cipher_alg->boundary - 1))
291 clib_warning ("payload %u not multiple of %d\n",
292 payload_len, cipher_alg->boundary);
294 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
295 ESP_DECRYPT_ERROR_BAD_LEN, 1);
297 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
298 ESP_DECRYPT_ERROR_BAD_LEN, 1);
306 u32 cipher_off, cipher_len;
310 u8 *iv = (u8 *) (esp0 + 1);
312 dpdk_gcm_cnt_blk *icb = &priv->cb;
314 cipher_off = sizeof (esp_header_t) + iv_size;
315 cipher_len = payload_len;
317 u8 *digest = vlib_buffer_get_tail (b0) - trunc_size;
319 mb0->buf_physaddr + digest - ((u8 *) mb0->buf_addr);
321 if (!is_aead && cipher_alg->alg == RTE_CRYPTO_CIPHER_AES_CBC)
322 clib_memcpy_fast (icb, iv, 16);
325 u32 *_iv = (u32 *) iv;
327 crypto_set_icb (icb, sa0->salt, _iv[0], _iv[1]);
333 u32 *_aad = (u32 *) aad;
334 clib_memcpy_fast (aad, esp0, 8);
336 /* _aad[3] should always be 0 */
337 if (PREDICT_FALSE (sa0->use_esn))
338 _aad[2] = clib_host_to_net_u32 (sa0->seq_hi);
344 auth_len = sizeof (esp_header_t) + iv_size + payload_len;
348 clib_memcpy_fast (priv->icv, digest, trunc_size);
349 u32 *_digest = (u32 *) digest;
350 _digest[0] = clib_host_to_net_u32 (sa0->seq_hi);
351 auth_len += sizeof (sa0->seq_hi);
355 op->phys_addr + (uintptr_t) priv->icv - (uintptr_t) op;
359 crypto_op_setup (is_aead, mb0, op, session, cipher_off, cipher_len,
360 0, auth_len, aad, digest, digest_paddr);
362 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
364 esp_decrypt_trace_t *tr =
365 vlib_add_trace (vm, node, b0, sizeof (*tr));
366 tr->crypto_alg = sa0->crypto_alg;
367 tr->integ_alg = sa0->integ_alg;
368 clib_memcpy_fast (tr->packet_data, vlib_buffer_get_current (b0),
369 sizeof (esp_header_t));
372 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
377 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_node.index,
378 ESP_DECRYPT_ERROR_RX_PKTS,
379 from_frame->n_vectors);
381 crypto_enqueue_ops (vm, cwm, dpdk_esp6_decrypt_node.index,
382 ESP_DECRYPT_ERROR_ENQ_FAIL, numa);
386 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_node.index,
387 ESP_DECRYPT_ERROR_RX_PKTS,
388 from_frame->n_vectors);
390 crypto_enqueue_ops (vm, cwm, dpdk_esp4_decrypt_node.index,
391 ESP_DECRYPT_ERROR_ENQ_FAIL, numa);
394 crypto_free_ops (numa, ops, cwm->ops + from_frame->n_vectors - ops);
396 return from_frame->n_vectors;
399 VLIB_NODE_FN (dpdk_esp4_decrypt_node) (vlib_main_t * vm,
400 vlib_node_runtime_t * node,
401 vlib_frame_t * from_frame)
403 return dpdk_esp_decrypt_inline (vm, node, from_frame, 0 /*is_ip6 */ );
407 VLIB_REGISTER_NODE (dpdk_esp4_decrypt_node) = {
408 .name = "dpdk-esp4-decrypt",
409 .vector_size = sizeof (u32),
410 .format_trace = format_esp_decrypt_trace,
411 .type = VLIB_NODE_TYPE_INTERNAL,
413 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
414 .error_strings = esp_decrypt_error_strings,
416 .n_next_nodes = ESP_DECRYPT_N_NEXT,
418 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
419 foreach_esp_decrypt_next
425 VLIB_NODE_FN (dpdk_esp6_decrypt_node) (vlib_main_t * vm,
426 vlib_node_runtime_t * node,
427 vlib_frame_t * from_frame)
429 return dpdk_esp_decrypt_inline (vm, node, from_frame, 1 /*is_ip6 */ );
433 VLIB_REGISTER_NODE (dpdk_esp6_decrypt_node) = {
434 .name = "dpdk-esp6-decrypt",
435 .vector_size = sizeof (u32),
436 .format_trace = format_esp_decrypt_trace,
437 .type = VLIB_NODE_TYPE_INTERNAL,
439 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
440 .error_strings = esp_decrypt_error_strings,
442 .n_next_nodes = ESP_DECRYPT_N_NEXT,
444 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
445 foreach_esp_decrypt_next
455 #define foreach_esp_decrypt_post_error \
456 _(PKTS, "ESP post pkts")
460 #define _(sym,str) ESP_DECRYPT_POST_ERROR_##sym,
461 foreach_esp_decrypt_post_error
463 ESP_DECRYPT_POST_N_ERROR,
464 } esp_decrypt_post_error_t;
466 static char *esp_decrypt_post_error_strings[] = {
467 #define _(sym,string) string,
468 foreach_esp_decrypt_post_error
472 extern vlib_node_registration_t dpdk_esp4_decrypt_post_node;
473 extern vlib_node_registration_t dpdk_esp6_decrypt_post_node;
476 format_esp_decrypt_post_trace (u8 * s, va_list * args)
478 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
479 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
480 esp_decrypt_trace_t *t = va_arg (*args, esp_decrypt_trace_t *);
481 u32 indent = format_get_indent (s);
483 s = format (s, "cipher %U auth %U\n",
484 format_ipsec_crypto_alg, t->crypto_alg,
485 format_ipsec_integ_alg, t->integ_alg);
487 ip4_header_t *ih4 = (ip4_header_t *) t->packet_data;
488 if ((ih4->ip_version_and_header_length & 0xF0) == 0x60)
490 format (s, "%U%U", format_white_space, indent, format_ip6_header, ih4);
493 format (s, "%U%U", format_white_space, indent, format_ip4_header, ih4);
499 dpdk_esp_decrypt_post_inline (vlib_main_t * vm,
500 vlib_node_runtime_t * node,
501 vlib_frame_t * from_frame, int is_ip6)
503 u32 n_left_from, *from, *to_next = 0, next_index;
506 ipsec_main_t *im = &ipsec_main;
507 dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
509 from = vlib_frame_vector_args (from_frame);
510 n_left_from = from_frame->n_vectors;
512 next_index = node->cached_next_index;
514 while (n_left_from > 0)
518 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
520 while (n_left_from > 0 && n_left_to_next > 0)
523 u32 bi0, iv_size, next0;
524 vlib_buffer_t *b0 = 0;
525 ip4_header_t *ih4 = 0, *oh4 = 0;
526 ip6_header_t *ih6 = 0, *oh6 = 0;
527 crypto_alg_t *cipher_alg, *auth_alg;
529 u8 trunc_size, is_aead;
530 u16 udp_encap_adv = 0;
532 next0 = ESP_DECRYPT_NEXT_DROP;
539 b0 = vlib_get_buffer (vm, bi0);
540 esp0 = vlib_buffer_get_current (b0);
542 sa_index0 = vnet_buffer (b0)->ipsec.sad_index;
543 sa0 = pool_elt_at_index (im->sad, sa_index0);
548 cipher_alg = vec_elt_at_index (dcm->cipher_algs, sa0->crypto_alg);
549 auth_alg = vec_elt_at_index (dcm->auth_algs, sa0->integ_alg);
550 is_aead = cipher_alg->type == RTE_CRYPTO_SYM_XFORM_AEAD;
552 auth_alg = cipher_alg;
554 trunc_size = auth_alg->trunc_size;
556 iv_size = cipher_alg->iv_len;
558 if (sa0->use_anti_replay)
561 seq = clib_host_to_net_u32 (esp0->seq);
562 if (PREDICT_TRUE (sa0->use_esn))
563 esp_replay_advance_esn (sa0, seq);
565 esp_replay_advance (sa0, seq);
568 /* if UDP encapsulation is used adjust the address of the IP header */
569 if (sa0->udp_encap && (b0->flags & VNET_BUFFER_F_IS_IP4))
571 udp_encap_adv = sizeof (udp_header_t);
574 if (b0->flags & VNET_BUFFER_F_IS_IP4)
575 ih4 = (ip4_header_t *)
576 ((u8 *) esp0 - udp_encap_adv - sizeof (ip4_header_t));
578 ih4 = (ip4_header_t *) ((u8 *) esp0 - sizeof (ip6_header_t));
580 vlib_buffer_advance (b0, sizeof (esp_header_t) + iv_size);
582 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
583 f0 = (esp_footer_t *) (vlib_buffer_get_tail (b0) - trunc_size - 2);
584 b0->current_length -= (f0->pad_length + trunc_size + 2);
587 const u8 *padding = vlib_buffer_get_tail (b0);
588 if (PREDICT_FALSE (memcmp (padding, pad_data, f0->pad_length)))
590 clib_warning ("bad padding");
591 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
592 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
599 if (f0->next_header == IP_PROTOCOL_IP_IN_IP)
600 next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
601 else if (sa0->is_tunnel_ip6
602 && f0->next_header == IP_PROTOCOL_IPV6)
603 next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
606 clib_warning ("next header: 0x%x", f0->next_header);
608 vlib_node_increment_counter (vm,
609 dpdk_esp6_decrypt_node.index,
610 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
613 vlib_node_increment_counter (vm,
614 dpdk_esp4_decrypt_node.index,
615 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
620 else /* transport mode */
622 if ((ih4->ip_version_and_header_length & 0xF0) == 0x40)
624 u16 ih4_len = ip4_header_bytes (ih4);
625 vlib_buffer_advance (b0, -ih4_len - udp_encap_adv);
626 next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
629 oh4 = vlib_buffer_get_current (b0);
630 memmove (oh4, ih4, ih4_len);
631 oh4->protocol = f0->next_header;
632 oh4->length = clib_host_to_net_u16 (b0->current_length);
633 oh4->checksum = ip4_header_checksum (oh4);
636 else if ((ih4->ip_version_and_header_length & 0xF0) == 0x60)
638 ih6 = (ip6_header_t *) ih4;
639 vlib_buffer_advance (b0, -sizeof (ip6_header_t));
640 oh6 = vlib_buffer_get_current (b0);
641 memmove (oh6, ih6, sizeof (ip6_header_t));
643 next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
644 oh6->protocol = f0->next_header;
645 u16 len = b0->current_length - sizeof (ip6_header_t);
646 oh6->payload_length = clib_host_to_net_u16 (len);
650 clib_warning ("next header: 0x%x", f0->next_header);
652 vlib_node_increment_counter (vm,
653 dpdk_esp6_decrypt_node.index,
654 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
657 vlib_node_increment_counter (vm,
658 dpdk_esp4_decrypt_node.index,
659 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
665 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
668 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
670 esp_decrypt_trace_t *tr =
671 vlib_add_trace (vm, node, b0, sizeof (*tr));
672 tr->crypto_alg = sa0->crypto_alg;
673 tr->integ_alg = sa0->integ_alg;
674 ih4 = vlib_buffer_get_current (b0);
675 clib_memcpy_fast (tr->packet_data, ih4, sizeof (ip6_header_t));
678 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
679 to_next, n_left_to_next, bi0,
682 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
686 vlib_node_increment_counter (vm, dpdk_esp6_decrypt_post_node.index,
687 ESP_DECRYPT_POST_ERROR_PKTS,
688 from_frame->n_vectors);
690 vlib_node_increment_counter (vm, dpdk_esp4_decrypt_post_node.index,
691 ESP_DECRYPT_POST_ERROR_PKTS,
692 from_frame->n_vectors);
694 return from_frame->n_vectors;
697 VLIB_NODE_FN (dpdk_esp4_decrypt_post_node) (vlib_main_t * vm,
698 vlib_node_runtime_t * node,
699 vlib_frame_t * from_frame)
701 return dpdk_esp_decrypt_post_inline (vm, node, from_frame, 0 /*is_ip6 */ );
705 VLIB_REGISTER_NODE (dpdk_esp4_decrypt_post_node) = {
706 .name = "dpdk-esp4-decrypt-post",
707 .vector_size = sizeof (u32),
708 .format_trace = format_esp_decrypt_post_trace,
709 .type = VLIB_NODE_TYPE_INTERNAL,
711 .n_errors = ARRAY_LEN(esp_decrypt_post_error_strings),
712 .error_strings = esp_decrypt_post_error_strings,
714 .n_next_nodes = ESP_DECRYPT_N_NEXT,
716 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
717 foreach_esp_decrypt_next
723 VLIB_NODE_FN (dpdk_esp6_decrypt_post_node) (vlib_main_t * vm,
724 vlib_node_runtime_t * node,
725 vlib_frame_t * from_frame)
727 return dpdk_esp_decrypt_post_inline (vm, node, from_frame, 0 /*is_ip6 */ );
731 VLIB_REGISTER_NODE (dpdk_esp6_decrypt_post_node) = {
732 .name = "dpdk-esp6-decrypt-post",
733 .vector_size = sizeof (u32),
734 .format_trace = format_esp_decrypt_post_trace,
735 .type = VLIB_NODE_TYPE_INTERNAL,
737 .n_errors = ARRAY_LEN(esp_decrypt_post_error_strings),
738 .error_strings = esp_decrypt_post_error_strings,
740 .n_next_nodes = ESP_DECRYPT_N_NEXT,
742 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
743 foreach_esp_decrypt_next
750 * fd.io coding-style-patch-verification: ON
753 * eval: (c-set-style "gnu")