2 * esp_decrypt.c : IPSec ESP Decrypt node using DPDK Cryptodev
4 * Copyright (c) 2016 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 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 <dpdk/ipsec/ipsec.h>
24 #include <dpdk/ipsec/esp.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") \
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 _(NO_CRYPTODEV, "Cryptodev not configured") \
47 _(BAD_LEN, "Invalid ciphertext length") \
48 _(UNSUPPORTED, "Cipher/Auth not supported")
52 #define _(sym,str) ESP_DECRYPT_ERROR_##sym,
53 foreach_esp_decrypt_error
56 } esp_decrypt_error_t;
58 static char * esp_decrypt_error_strings[] = {
59 #define _(sym,string) string,
60 foreach_esp_decrypt_error
64 vlib_node_registration_t dpdk_esp_decrypt_node;
67 ipsec_crypto_alg_t crypto_alg;
68 ipsec_integ_alg_t integ_alg;
69 } esp_decrypt_trace_t;
71 /* packet trace format function */
72 static u8 * format_esp_decrypt_trace (u8 * s, va_list * args)
74 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
75 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
76 esp_decrypt_trace_t * t = va_arg (*args, esp_decrypt_trace_t *);
78 s = format (s, "esp: crypto %U integrity %U",
79 format_ipsec_crypto_alg, t->crypto_alg,
80 format_ipsec_integ_alg, t->integ_alg);
85 dpdk_esp_decrypt_node_fn (vlib_main_t * vm,
86 vlib_node_runtime_t * node,
87 vlib_frame_t * from_frame)
89 u32 n_left_from, *from, *to_next, next_index;
90 ipsec_main_t *im = &ipsec_main;
91 u32 thread_index = vlib_get_thread_index();
92 dpdk_crypto_main_t * dcm = &dpdk_crypto_main;
93 dpdk_esp_main_t * em = &dpdk_esp_main;
96 from = vlib_frame_vector_args (from_frame);
97 n_left_from = from_frame->n_vectors;
99 crypto_worker_main_t *cwm =
100 vec_elt_at_index(dcm->workers_main, thread_index);
101 u32 n_qps = vec_len(cwm->qp_data);
102 struct rte_crypto_op ** cops_to_enq[n_qps];
103 u32 n_cop_qp[n_qps], * bi_to_enq[n_qps];
105 for (i = 0; i < n_qps; i++)
107 bi_to_enq[i] = cwm->qp_data[i].bi;
108 cops_to_enq[i] = cwm->qp_data[i].cops;
111 memset(n_cop_qp, 0, n_qps * sizeof(u32));
115 next_index = ESP_DECRYPT_NEXT_DROP;
117 while (n_left_from > 0)
121 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
123 while (n_left_from > 0 && n_left_to_next > 0)
125 u32 bi0, sa_index0 = ~0, seq, icv_size, iv_size;
129 struct rte_mbuf * mb0 = 0;
130 const int BLOCK_SIZE = 16;
131 crypto_sa_session_t * sa_sess;
134 struct rte_crypto_op * cop = 0;
140 b0 = vlib_get_buffer (vm, bi0);
141 esp0 = vlib_buffer_get_current (b0);
143 sa_index0 = vnet_buffer(b0)->ipsec.sad_index;
144 sa0 = pool_elt_at_index (im->sad, sa_index0);
146 seq = clib_host_to_net_u32(esp0->seq);
148 /* anti-replay check */
149 if (sa0->use_anti_replay)
153 if (PREDICT_TRUE(sa0->use_esn))
154 rv = esp_replay_check_esn(sa0, seq);
156 rv = esp_replay_check(sa0, seq);
158 if (PREDICT_FALSE(rv))
160 clib_warning ("anti-replay SPI %u seq %u", sa0->spi, seq);
161 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
162 ESP_DECRYPT_ERROR_REPLAY, 1);
170 sa0->total_data_size += b0->current_length;
172 if (PREDICT_FALSE(sa0->integ_alg == IPSEC_INTEG_ALG_NONE) ||
173 PREDICT_FALSE(sa0->crypto_alg == IPSEC_CRYPTO_ALG_NONE))
175 clib_warning ("SPI %u : only cipher + auth supported", sa0->spi);
176 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
177 ESP_DECRYPT_ERROR_UNSUPPORTED, 1);
184 sa_sess = pool_elt_at_index(cwm->sa_sess_d[0], sa_index0);
186 if (PREDICT_FALSE(!sa_sess->sess))
188 int ret = create_sym_sess(sa0, sa_sess, 0);
190 if (PREDICT_FALSE (ret))
199 sess = sa_sess->sess;
200 qp_index = sa_sess->qp_index;
202 ASSERT (vec_len (vec_elt (cwm->qp_data, qp_index).free_cops) > 0);
203 cop = vec_pop (vec_elt (cwm->qp_data, qp_index).free_cops);
204 ASSERT (cop->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED);
206 cops_to_enq[qp_index][0] = cop;
207 cops_to_enq[qp_index] += 1;
208 n_cop_qp[qp_index] += 1;
209 bi_to_enq[qp_index][0] = bi0;
210 bi_to_enq[qp_index] += 1;
212 rte_crypto_op_attach_sym_session(cop, sess);
214 icv_size = em->esp_integ_algs[sa0->integ_alg].trunc_size;
215 iv_size = em->esp_crypto_algs[sa0->crypto_alg].iv_len;
217 /* Convert vlib buffer to mbuf */
218 mb0 = rte_mbuf_from_vlib_buffer(b0);
219 mb0->data_len = b0->current_length;
220 mb0->pkt_len = b0->current_length;
221 mb0->data_off = RTE_PKTMBUF_HEADROOM + b0->current_data;
223 /* Outer IP header has already been stripped */
224 u16 payload_len = rte_pktmbuf_pkt_len(mb0) - sizeof (esp_header_t) -
227 if ((payload_len & (BLOCK_SIZE - 1)) || (payload_len <= 0))
229 clib_warning ("payload %u not multiple of %d\n",
230 payload_len, BLOCK_SIZE);
231 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
232 ESP_DECRYPT_ERROR_BAD_LEN, 1);
233 vec_add (vec_elt (cwm->qp_data, qp_index).free_cops, &cop, 1);
234 bi_to_enq[qp_index] -= 1;
235 cops_to_enq[qp_index] -= 1;
236 n_cop_qp[qp_index] -= 1;
243 struct rte_crypto_sym_op *sym_cop = (struct rte_crypto_sym_op *)(cop + 1);
245 sym_cop->m_src = mb0;
246 sym_cop->cipher.data.offset = sizeof (esp_header_t) + iv_size;
247 sym_cop->cipher.data.length = payload_len;
249 u8 *iv = rte_pktmbuf_mtod_offset(mb0, void*, sizeof (esp_header_t));
250 dpdk_cop_priv_t * priv = (dpdk_cop_priv_t *)(sym_cop + 1);
252 if (sa0->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128)
254 dpdk_gcm_cnt_blk *icb = &priv->cb;
255 icb->salt = sa0->salt;
256 clib_memcpy(icb->iv, iv, 8);
257 icb->cnt = clib_host_to_net_u32(1);
258 sym_cop->cipher.iv.data = (u8 *)icb;
259 sym_cop->cipher.iv.phys_addr = cop->phys_addr +
260 (uintptr_t)icb - (uintptr_t)cop;
261 sym_cop->cipher.iv.length = 16;
264 clib_memcpy(aad, iv - sizeof(esp_header_t), 8);
265 sym_cop->auth.aad.data = aad;
266 sym_cop->auth.aad.phys_addr = cop->phys_addr +
267 (uintptr_t)aad - (uintptr_t)cop;
270 *((u32*)&aad[8]) = sa0->seq_hi;
271 sym_cop->auth.aad.length = 12;
275 sym_cop->auth.aad.length = 8;
278 sym_cop->auth.digest.data = rte_pktmbuf_mtod_offset(mb0, void*,
279 rte_pktmbuf_pkt_len(mb0) - icv_size);
280 sym_cop->auth.digest.phys_addr = rte_pktmbuf_mtophys_offset(mb0,
281 rte_pktmbuf_pkt_len(mb0) - icv_size);
282 sym_cop->auth.digest.length = icv_size;
287 sym_cop->cipher.iv.data = rte_pktmbuf_mtod_offset(mb0, void*,
288 sizeof (esp_header_t));
289 sym_cop->cipher.iv.phys_addr = rte_pktmbuf_mtophys_offset(mb0,
290 sizeof (esp_header_t));
291 sym_cop->cipher.iv.length = iv_size;
295 dpdk_cop_priv_t* priv = (dpdk_cop_priv_t*) (sym_cop + 1);
296 u8* payload_end = rte_pktmbuf_mtod_offset(
297 mb0, u8*, sizeof(esp_header_t) + iv_size + payload_len);
299 clib_memcpy (priv->icv, payload_end, icv_size);
300 *((u32*) payload_end) = sa0->seq_hi;
301 sym_cop->auth.data.offset = 0;
302 sym_cop->auth.data.length = sizeof(esp_header_t) + iv_size
303 + payload_len + sizeof(sa0->seq_hi);
304 sym_cop->auth.digest.data = priv->icv;
305 sym_cop->auth.digest.phys_addr = cop->phys_addr
306 + (uintptr_t) priv->icv - (uintptr_t) cop;
307 sym_cop->auth.digest.length = icv_size;
311 sym_cop->auth.data.offset = 0;
312 sym_cop->auth.data.length = sizeof(esp_header_t) +
313 iv_size + payload_len;
315 sym_cop->auth.digest.data = rte_pktmbuf_mtod_offset(mb0, void*,
316 rte_pktmbuf_pkt_len(mb0) - icv_size);
317 sym_cop->auth.digest.phys_addr = rte_pktmbuf_mtophys_offset(mb0,
318 rte_pktmbuf_pkt_len(mb0) - icv_size);
319 sym_cop->auth.digest.length = icv_size;
324 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
326 esp_decrypt_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
327 tr->crypto_alg = sa0->crypto_alg;
328 tr->integ_alg = sa0->integ_alg;
331 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
333 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
334 ESP_DECRYPT_ERROR_RX_PKTS,
335 from_frame->n_vectors);
336 crypto_qp_data_t *qpd;
338 vec_foreach_index (i, cwm->qp_data)
342 qpd = vec_elt_at_index(cwm->qp_data, i);
343 enq = rte_cryptodev_enqueue_burst(qpd->dev_id, qpd->qp_id,
344 qpd->cops, n_cop_qp[i]);
345 qpd->inflights += enq;
347 if (PREDICT_FALSE(enq < n_cop_qp[i]))
349 crypto_free_cop (qpd, &qpd->cops[enq], n_cop_qp[i] - enq);
350 vlib_buffer_free (vm, &qpd->bi[enq], n_cop_qp[i] - enq);
352 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
353 ESP_DECRYPT_ERROR_ENQ_FAIL,
359 return from_frame->n_vectors;
363 VLIB_REGISTER_NODE (dpdk_esp_decrypt_node) = {
364 .function = dpdk_esp_decrypt_node_fn,
365 .name = "dpdk-esp-decrypt",
366 .vector_size = sizeof (u32),
367 .format_trace = format_esp_decrypt_trace,
368 .type = VLIB_NODE_TYPE_INTERNAL,
370 .n_errors = ARRAY_LEN(esp_decrypt_error_strings),
371 .error_strings = esp_decrypt_error_strings,
373 .n_next_nodes = ESP_DECRYPT_N_NEXT,
375 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
376 foreach_esp_decrypt_next
382 VLIB_NODE_FUNCTION_MULTIARCH (dpdk_esp_decrypt_node, dpdk_esp_decrypt_node_fn)
388 #define foreach_esp_decrypt_post_error \
389 _(PKTS, "ESP post pkts")
392 #define _(sym,str) ESP_DECRYPT_POST_ERROR_##sym,
393 foreach_esp_decrypt_post_error
395 ESP_DECRYPT_POST_N_ERROR,
396 } esp_decrypt_post_error_t;
398 static char * esp_decrypt_post_error_strings[] = {
399 #define _(sym,string) string,
400 foreach_esp_decrypt_post_error
404 vlib_node_registration_t dpdk_esp_decrypt_post_node;
406 static u8 * format_esp_decrypt_post_trace (u8 * s, va_list * args)
412 dpdk_esp_decrypt_post_node_fn (vlib_main_t * vm,
413 vlib_node_runtime_t * node,
414 vlib_frame_t * from_frame)
416 u32 n_left_from, *from, *to_next = 0, next_index;
419 ipsec_main_t *im = &ipsec_main;
420 dpdk_esp_main_t *em = &dpdk_esp_main;
422 from = vlib_frame_vector_args (from_frame);
423 n_left_from = from_frame->n_vectors;
425 next_index = node->cached_next_index;
427 while (n_left_from > 0)
431 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
433 while (n_left_from > 0 && n_left_to_next > 0)
436 u32 bi0, next0, icv_size, iv_size;
437 vlib_buffer_t * b0 = 0;
438 ip4_header_t *ih4 = 0, *oh4 = 0;
439 ip6_header_t *ih6 = 0, *oh6 = 0;
441 u8 transport_ip6 = 0;
443 next0 = ESP_DECRYPT_NEXT_DROP;
450 b0 = vlib_get_buffer (vm, bi0);
452 sa_index0 = vnet_buffer(b0)->ipsec.sad_index;
453 sa0 = pool_elt_at_index (im->sad, sa_index0);
458 icv_size = em->esp_integ_algs[sa0->integ_alg].trunc_size;
459 iv_size = em->esp_crypto_algs[sa0->crypto_alg].iv_len;
461 if (sa0->use_anti_replay)
463 esp_header_t * esp0 = vlib_buffer_get_current (b0);
465 seq = clib_host_to_net_u32(esp0->seq);
466 if (PREDICT_TRUE(sa0->use_esn))
467 esp_replay_advance_esn(sa0, seq);
469 esp_replay_advance(sa0, seq);
472 ih4 = (ip4_header_t *) (b0->data + sizeof(ethernet_header_t));
473 vlib_buffer_advance (b0, sizeof (esp_header_t) + iv_size);
475 b0->current_length -= (icv_size + 2);
476 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
477 f0 = (esp_footer_t *) ((u8 *) vlib_buffer_get_current (b0) +
479 b0->current_length -= f0->pad_length;
482 if (PREDICT_FALSE(!sa0->is_tunnel && !sa0->is_tunnel_ip6))
486 if (PREDICT_TRUE((ih4->ip_version_and_header_length & 0xF0) != 0x40))
488 if (PREDICT_TRUE((ih4->ip_version_and_header_length & 0xF0) == 0x60))
492 clib_warning("next header: 0x%x", f0->next_header);
493 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
494 ESP_DECRYPT_ERROR_NOT_IP, 1);
500 if (PREDICT_TRUE (tunnel_mode))
502 if (PREDICT_TRUE(f0->next_header == IP_PROTOCOL_IP_IN_IP))
503 next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
504 else if (f0->next_header == IP_PROTOCOL_IPV6)
505 next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
508 clib_warning("next header: 0x%x", f0->next_header);
509 vlib_node_increment_counter (vm, dpdk_esp_decrypt_node.index,
510 ESP_DECRYPT_ERROR_DECRYPTION_FAILED,
518 if (PREDICT_FALSE(transport_ip6))
520 ih6 = (ip6_header_t *) (b0->data + sizeof(ethernet_header_t));
521 vlib_buffer_advance (b0, -sizeof(ip6_header_t));
522 oh6 = vlib_buffer_get_current (b0);
523 memmove(oh6, ih6, sizeof(ip6_header_t));
525 next0 = ESP_DECRYPT_NEXT_IP6_INPUT;
526 oh6->protocol = f0->next_header;
527 oh6->payload_length =
528 clib_host_to_net_u16 (
529 vlib_buffer_length_in_chain(vm, b0) -
530 sizeof (ip6_header_t));
534 vlib_buffer_advance (b0, -sizeof(ip4_header_t));
535 oh4 = vlib_buffer_get_current (b0);
536 memmove(oh4, ih4, sizeof(ip4_header_t));
538 next0 = ESP_DECRYPT_NEXT_IP4_INPUT;
539 oh4->ip_version_and_header_length = 0x45;
540 oh4->fragment_id = 0;
541 oh4->flags_and_fragment_offset = 0;
542 oh4->protocol = f0->next_header;
543 oh4->length = clib_host_to_net_u16 (
544 vlib_buffer_length_in_chain (vm, b0));
545 oh4->checksum = ip4_header_checksum (oh4);
549 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32)~0;
552 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
554 esp_decrypt_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
555 tr->crypto_alg = sa0->crypto_alg;
556 tr->integ_alg = sa0->integ_alg;
559 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
560 to_next, n_left_to_next, bi0, next0);
562 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
564 vlib_node_increment_counter (vm, dpdk_esp_decrypt_post_node.index,
565 ESP_DECRYPT_POST_ERROR_PKTS,
566 from_frame->n_vectors);
568 return from_frame->n_vectors;
572 VLIB_REGISTER_NODE (dpdk_esp_decrypt_post_node) = {
573 .function = dpdk_esp_decrypt_post_node_fn,
574 .name = "dpdk-esp-decrypt-post",
575 .vector_size = sizeof (u32),
576 .format_trace = format_esp_decrypt_post_trace,
577 .type = VLIB_NODE_TYPE_INTERNAL,
579 .n_errors = ARRAY_LEN(esp_decrypt_post_error_strings),
580 .error_strings = esp_decrypt_post_error_strings,
582 .n_next_nodes = ESP_DECRYPT_N_NEXT,
584 #define _(s,n) [ESP_DECRYPT_NEXT_##s] = n,
585 foreach_esp_decrypt_next
591 VLIB_NODE_FUNCTION_MULTIARCH (dpdk_esp_decrypt_post_node, dpdk_esp_decrypt_post_node_fn)