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 vlib_node_registration_t dpdk_esp_decrypt_node;
68 ipsec_crypto_alg_t crypto_alg;
69 ipsec_integ_alg_t integ_alg;
71 } esp_decrypt_trace_t;
73 /* packet trace format function */
74 static u8 * format_esp_decrypt_trace (u8 * s, va_list * args)
76 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
77 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
78 esp_decrypt_trace_t * t = va_arg (*args, esp_decrypt_trace_t *);
79 u32 indent = format_get_indent (s);
81 s = format (s, "cipher %U auth %U\n",
82 format_ipsec_crypto_alg, t->crypto_alg,
83 format_ipsec_integ_alg, t->integ_alg);
84 s = format (s, "%U%U",
85 format_white_space, indent,
86 format_esp_header, t->packet_data);
91 dpdk_esp_decrypt_node_fn (vlib_main_t * vm,
92 vlib_node_runtime_t * node,
93 vlib_frame_t * from_frame)
95 u32 n_left_from, *from, *to_next, next_index;
96 ipsec_main_t *im = &ipsec_main;
97 u32 thread_idx = vlib_get_thread_index();
98 dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
99 crypto_resource_t *res = 0;
101 crypto_alg_t *cipher_alg = 0, *auth_alg = 0;
102 struct rte_cryptodev_sym_session *session = 0;
103 u32 ret, last_sa_index = ~0;
104 u8 numa = rte_socket_id ();
106 crypto_worker_main_t *cwm =
107 vec_elt_at_index (dcm->workers_main, thread_idx);
108 struct rte_crypto_op **ops = cwm->ops;
110 from = vlib_frame_vector_args (from_frame);
111 n_left_from = from_frame->n_vectors;
113 ret = crypto_alloc_ops (numa, ops, n_left_from);
116 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
117 ESP_DECRYPT_ERROR_DISCARD, 1);
118 /* Discard whole frame */
122 next_index = ESP_DECRYPT_NEXT_DROP;
124 while (n_left_from > 0)
128 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
130 while (n_left_from > 0 && n_left_to_next > 0)
133 u32 bi0, sa_index0, seq, iv_size;
137 struct rte_mbuf *mb0;
138 struct rte_crypto_op *op;
145 b0 = vlib_get_buffer (vm, bi0);
146 mb0 = rte_mbuf_from_vlib_buffer(b0);
147 esp0 = vlib_buffer_get_current (b0);
150 CLIB_PREFETCH (esp0, sizeof (esp0[0]) + 16, LOAD);
152 CLIB_PREFETCH (mb0, CLIB_CACHE_LINE_BYTES, STORE);
156 ASSERT (op->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED);
158 dpdk_op_priv_t *priv = crypto_op_get_priv (op);
161 sizeof (op[0]) + sizeof (op[0].sym[0]) + sizeof (priv[0]);
162 CLIB_PREFETCH (op, op_len, STORE);
164 sa_index0 = vnet_buffer(b0)->ipsec.sad_index;
166 if (sa_index0 != last_sa_index)
168 sa0 = pool_elt_at_index (im->sad, sa_index0);
170 cipher_alg = vec_elt_at_index (dcm->cipher_algs, sa0->crypto_alg);
171 auth_alg = vec_elt_at_index (dcm->auth_algs, sa0->integ_alg);
174 is_aead = (sa0->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128 ||
175 sa0->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_192 ||
176 sa0->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_256);
178 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);
188 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
189 ESP_DECRYPT_ERROR_NOSUP, 1);
195 res = vec_elt_at_index (dcm->resource, res_idx);
197 error = crypto_get_session (&session, sa_index0, res, cwm, 0);
198 if (PREDICT_FALSE (error || !session))
200 clib_warning ("failed to get crypto session");
201 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
202 ESP_DECRYPT_ERROR_SESSION, 1);
209 last_sa_index = sa_index0;
212 /* anti-replay check */
213 if (sa0->use_anti_replay)
217 seq = clib_net_to_host_u32 (esp0->seq);
219 if (PREDICT_TRUE(sa0->use_esn))
220 rv = esp_replay_check_esn (sa0, seq);
222 rv = esp_replay_check (sa0, seq);
224 if (PREDICT_FALSE (rv))
226 clib_warning ("failed anti-replay check");
227 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
228 ESP_DECRYPT_ERROR_REPLAY, 1);
236 priv->next = DPDK_CRYPTO_INPUT_NEXT_DECRYPT_POST;
238 /* FIXME multi-seg */
239 sa0->total_data_size += b0->current_length;
241 res->ops[res->n_ops] = op;
242 res->bi[res->n_ops] = bi0;
245 /* Convert vlib buffer to mbuf */
246 mb0->data_len = b0->current_length;
247 mb0->pkt_len = b0->current_length;
248 mb0->data_off = RTE_PKTMBUF_HEADROOM + b0->current_data;
250 trunc_size = auth_alg->trunc_size;
251 iv_size = cipher_alg->iv_len;
253 /* Outer IP header has already been stripped */
255 b0->current_length - sizeof (esp_header_t) - iv_size - trunc_size;
257 ASSERT (payload_len >= 4);
259 if (payload_len & (cipher_alg->boundary - 1))
261 clib_warning ("payload %u not multiple of %d\n",
262 payload_len, cipher_alg->boundary);
263 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
264 ESP_DECRYPT_ERROR_BAD_LEN, 1);
272 u32 cipher_off, cipher_len;
273 u32 auth_len = 0, aad_size = 0;
274 u8 *aad = NULL, *digest = NULL;
275 u64 digest_paddr = 0;
277 u8 *iv = (u8 *) (esp0 + 1);
279 dpdk_gcm_cnt_blk *icb = &priv->cb;
281 cipher_off = sizeof (esp_header_t) + iv_size;
282 cipher_len = payload_len;
284 digest = vlib_buffer_get_tail (b0) - trunc_size;
286 if (!is_aead && cipher_alg->alg == RTE_CRYPTO_CIPHER_AES_CBC)
287 clib_memcpy(icb, iv, 16);
290 u32 *_iv = (u32 *) iv;
292 crypto_set_icb (icb, sa0->salt, _iv[0], _iv[1]);
303 clib_memcpy(aad, esp0, 8);
304 if (PREDICT_FALSE (sa0->use_esn))
306 *((u32*)&aad[8]) = sa0->seq_hi;
314 auth_len = sizeof(esp_header_t) + iv_size + payload_len;
318 clib_memcpy (priv->icv, digest, trunc_size);
319 *((u32*) digest) = sa0->seq_hi;
320 auth_len += sizeof(sa0->seq_hi);
324 op->phys_addr + (uintptr_t) priv->icv - (uintptr_t) op;
328 crypto_op_setup (is_aead, mb0, op, session,
329 cipher_off, cipher_len, (u8 *) icb, iv_size,
330 0, auth_len, aad, aad_size,
331 digest, digest_paddr, trunc_size);
333 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
335 esp_decrypt_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
336 tr->crypto_alg = sa0->crypto_alg;
337 tr->integ_alg = sa0->integ_alg;
338 clib_memcpy (tr->packet_data, vlib_buffer_get_current (b0),
339 sizeof (esp_header_t));
342 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
345 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
346 ESP_DECRYPT_ERROR_RX_PKTS,
347 from_frame->n_vectors);
349 crypto_enqueue_ops (vm, cwm, 0, dpdk_esp_decrypt_node.index,
350 ESP_DECRYPT_ERROR_ENQ_FAIL, numa);
352 crypto_free_ops (numa, ops, cwm->ops + from_frame->n_vectors - ops);
354 return from_frame->n_vectors;
358 VLIB_REGISTER_NODE (dpdk_esp_decrypt_node) = {
359 .function = dpdk_esp_decrypt_node_fn,
360 .name = "dpdk-esp-decrypt",
361 .vector_size = sizeof (u32),
362 .format_trace = format_esp_decrypt_trace,
363 .type = VLIB_NODE_TYPE_INTERNAL,
365 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
366 .error_strings = esp_decrypt_error_strings,
368 .n_next_nodes = ESP_DECRYPT_N_NEXT,
370 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
371 foreach_esp_decrypt_next
377 VLIB_NODE_FUNCTION_MULTIARCH (dpdk_esp_decrypt_node, dpdk_esp_decrypt_node_fn)
383 #define foreach_esp_decrypt_post_error \
384 _(PKTS, "ESP post pkts")
387 #define _(sym,str) ESP_DECRYPT_POST_ERROR_##sym,
388 foreach_esp_decrypt_post_error
390 ESP_DECRYPT_POST_N_ERROR,
391 } esp_decrypt_post_error_t;
393 static char * esp_decrypt_post_error_strings[] = {
394 #define _(sym,string) string,
395 foreach_esp_decrypt_post_error
399 vlib_node_registration_t dpdk_esp_decrypt_post_node;
401 static u8 * format_esp_decrypt_post_trace (u8 * s, va_list * args)
403 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
404 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
405 esp_decrypt_trace_t * t = va_arg (*args, esp_decrypt_trace_t *);
406 u32 indent = format_get_indent (s);
408 s = format (s, "cipher %U auth %U\n",
409 format_ipsec_crypto_alg, t->crypto_alg,
410 format_ipsec_integ_alg, t->integ_alg);
412 ip4_header_t *ih4 = (ip4_header_t *) t->packet_data;
413 if ((ih4->ip_version_and_header_length & 0xF0) == 0x60)
414 s = format (s, "%U%U", format_white_space, indent, format_ip6_header, ih4);
416 s = format (s, "%U%U", format_white_space, indent, format_ip4_header, ih4);
422 dpdk_esp_decrypt_post_node_fn (vlib_main_t * vm,
423 vlib_node_runtime_t * node,
424 vlib_frame_t * from_frame)
426 u32 n_left_from, *from, *to_next = 0, next_index;
429 ipsec_main_t *im = &ipsec_main;
430 dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
432 from = vlib_frame_vector_args (from_frame);
433 n_left_from = from_frame->n_vectors;
435 next_index = node->cached_next_index;
437 while (n_left_from > 0)
441 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
443 while (n_left_from > 0 && n_left_to_next > 0)
446 u32 bi0, iv_size, next0;
447 vlib_buffer_t * b0 = 0;
448 ip4_header_t *ih4 = 0, *oh4 = 0;
449 ip6_header_t *ih6 = 0, *oh6 = 0;
450 crypto_alg_t *cipher_alg, *auth_alg;
452 u8 trunc_size, is_aead;
454 next0 = ESP_DECRYPT_NEXT_DROP;
461 b0 = vlib_get_buffer (vm, bi0);
462 esp0 = vlib_buffer_get_current (b0);
464 sa_index0 = vnet_buffer(b0)->ipsec.sad_index;
465 sa0 = pool_elt_at_index (im->sad, sa_index0);
470 cipher_alg = vec_elt_at_index (dcm->cipher_algs, sa0->crypto_alg);
471 auth_alg = vec_elt_at_index (dcm->auth_algs, sa0->integ_alg);
473 is_aead = (sa0->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128 ||
474 sa0->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_192 ||
475 sa0->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_256);
477 is_aead = cipher_alg->type == RTE_CRYPTO_SYM_XFORM_AEAD;
480 auth_alg = cipher_alg;
482 trunc_size = auth_alg->trunc_size;
484 iv_size = cipher_alg->iv_len;
486 if (sa0->use_anti_replay)
489 seq = clib_host_to_net_u32(esp0->seq);
490 if (PREDICT_TRUE(sa0->use_esn))
491 esp_replay_advance_esn(sa0, seq);
493 esp_replay_advance(sa0, seq);
496 /* FIXME ip header */
497 ih4 = (ip4_header_t *) (b0->data + sizeof(ethernet_header_t));
498 vlib_buffer_advance (b0, sizeof (esp_header_t) + iv_size);
500 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
501 f0 = (esp_footer_t *) (vlib_buffer_get_tail (b0) - trunc_size - 2);
502 b0->current_length -= (f0->pad_length + trunc_size + 2);
505 const u8 *padding = vlib_buffer_get_tail (b0);
506 if (PREDICT_FALSE (memcmp (padding, pad_data, f0->pad_length)))
508 clib_warning("bad padding");
509 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
510 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
517 if (f0->next_header == IP_PROTOCOL_IP_IN_IP)
518 next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
519 else if (sa0->is_tunnel_ip6 && f0->next_header == IP_PROTOCOL_IPV6)
520 next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
523 clib_warning("next header: 0x%x", f0->next_header);
524 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
525 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
530 else /* transport mode */
532 if ((ih4->ip_version_and_header_length & 0xF0) == 0x40)
534 u16 ih4_len = ip4_header_bytes (ih4);
535 vlib_buffer_advance (b0, - ih4_len);
536 oh4 = vlib_buffer_get_current (b0);
537 memmove(oh4, ih4, ih4_len);
539 next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
541 ((u16) oh4->ttl) << 8 | (u16) oh4->protocol;
543 ((u16) oh4->ttl) << 8 | (u16) f0->next_header;
544 oh4->protocol = f0->next_header;
545 u16 new_len = clib_host_to_net_u16 (b0->current_length);
546 oh4->length = new_len;
547 /* rfc1264 incremental checksum update */
548 oh4->checksum = ~(~oh4->checksum + ~oh4->length + new_len +
549 ~old_ttl_prot + new_ttl_prot);
552 else if ((ih4->ip_version_and_header_length & 0xF0) == 0x60)
554 /* FIXME find ip header */
555 ih6 = (ip6_header_t *) (b0->data + sizeof(ethernet_header_t));
556 vlib_buffer_advance (b0, -sizeof(ip6_header_t));
557 oh6 = vlib_buffer_get_current (b0);
558 memmove(oh6, ih6, sizeof(ip6_header_t));
560 next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
561 oh6->protocol = f0->next_header;
562 u16 len = b0->current_length - sizeof (ip6_header_t);
563 oh6->payload_length = clib_host_to_net_u16 (len);
567 clib_warning("next header: 0x%x", f0->next_header);
568 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
569 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
575 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32)~0;
578 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
580 esp_decrypt_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
581 tr->crypto_alg = sa0->crypto_alg;
582 tr->integ_alg = sa0->integ_alg;
583 ih4 = vlib_buffer_get_current (b0);
584 clib_memcpy (tr->packet_data, ih4, sizeof (ip6_header_t));
587 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
588 to_next, n_left_to_next, bi0, next0);
590 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
593 vlib_node_increment_counter (vm, dpdk_esp_decrypt_post_node.index,
594 ESP_DECRYPT_POST_ERROR_PKTS,
595 from_frame->n_vectors);
597 return from_frame->n_vectors;
601 VLIB_REGISTER_NODE (dpdk_esp_decrypt_post_node) = {
602 .function = dpdk_esp_decrypt_post_node_fn,
603 .name = "dpdk-esp-decrypt-post",
604 .vector_size = sizeof (u32),
605 .format_trace = format_esp_decrypt_post_trace,
606 .type = VLIB_NODE_TYPE_INTERNAL,
608 .n_errors = ARRAY_LEN(esp_decrypt_post_error_strings),
609 .error_strings = esp_decrypt_post_error_strings,
611 .n_next_nodes = ESP_DECRYPT_N_NEXT,
613 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
614 foreach_esp_decrypt_next
620 VLIB_NODE_FUNCTION_MULTIARCH (dpdk_esp_decrypt_post_node, dpdk_esp_decrypt_post_node_fn)