1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2020 Intel Corporation
5 #include <netinet/in.h>
6 #include <netinet/ip.h>
8 #include <rte_branch_prediction.h>
10 #include <rte_crypto.h>
11 #include <rte_security.h>
12 #include <rte_cryptodev.h>
13 #include <rte_ipsec.h>
14 #include <rte_ethdev.h>
22 set_ipsec_conf(struct ipsec_sa *sa, struct rte_security_ipsec_xform *ipsec)
24 if (ipsec->mode == RTE_SECURITY_IPSEC_SA_MODE_TUNNEL) {
25 struct rte_security_ipsec_tunnel_param *tunnel =
27 if (IS_IP4_TUNNEL(sa->flags)) {
29 RTE_SECURITY_IPSEC_TUNNEL_IPV4;
30 tunnel->ipv4.ttl = IPDEFTTL;
32 memcpy((uint8_t *)&tunnel->ipv4.src_ip,
33 (uint8_t *)&sa->src.ip.ip4, 4);
35 memcpy((uint8_t *)&tunnel->ipv4.dst_ip,
36 (uint8_t *)&sa->dst.ip.ip4, 4);
37 } else if (IS_IP6_TUNNEL(sa->flags)) {
39 RTE_SECURITY_IPSEC_TUNNEL_IPV6;
40 tunnel->ipv6.hlimit = IPDEFTTL;
41 tunnel->ipv6.dscp = 0;
42 tunnel->ipv6.flabel = 0;
44 memcpy((uint8_t *)&tunnel->ipv6.src_addr,
45 (uint8_t *)&sa->src.ip.ip6.ip6_b, 16);
47 memcpy((uint8_t *)&tunnel->ipv6.dst_addr,
48 (uint8_t *)&sa->dst.ip.ip6.ip6_b, 16);
50 /* TODO support for Transport */
52 ipsec->esn_soft_limit = IPSEC_OFFLOAD_ESN_SOFTLIMIT;
53 ipsec->replay_win_sz = app_sa_prm.window_size;
54 ipsec->options.esn = app_sa_prm.enable_esn;
58 create_lookaside_session(struct ipsec_ctx *ipsec_ctx, struct ipsec_sa *sa,
59 struct rte_ipsec_session *ips)
61 struct rte_cryptodev_info cdev_info;
62 unsigned long cdev_id_qp = 0;
64 struct cdev_key key = { 0 };
66 key.lcore_id = (uint8_t)rte_lcore_id();
68 key.cipher_algo = (uint8_t)sa->cipher_algo;
69 key.auth_algo = (uint8_t)sa->auth_algo;
70 key.aead_algo = (uint8_t)sa->aead_algo;
72 ret = rte_hash_lookup_data(ipsec_ctx->cdev_map, &key,
73 (void **)&cdev_id_qp);
76 "No cryptodev: core %u, cipher_algo %u, "
77 "auth_algo %u, aead_algo %u\n",
85 RTE_LOG_DP(DEBUG, IPSEC, "Create session for SA spi %u on cryptodev "
86 "%u qp %u\n", sa->spi,
87 ipsec_ctx->tbl[cdev_id_qp].id,
88 ipsec_ctx->tbl[cdev_id_qp].qp);
90 if (ips->type != RTE_SECURITY_ACTION_TYPE_NONE &&
91 ips->type != RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO) {
92 struct rte_security_session_conf sess_conf = {
93 .action_type = ips->type,
94 .protocol = RTE_SECURITY_PROTOCOL_IPSEC,
100 .direction = sa->direction,
101 .proto = RTE_SECURITY_IPSEC_SA_PROTO_ESP,
102 .mode = (IS_TUNNEL(sa->flags)) ?
103 RTE_SECURITY_IPSEC_SA_MODE_TUNNEL :
104 RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT,
106 .crypto_xform = sa->xforms,
111 if (ips->type == RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL) {
112 struct rte_security_ctx *ctx = (struct rte_security_ctx *)
113 rte_cryptodev_get_sec_ctx(
114 ipsec_ctx->tbl[cdev_id_qp].id);
116 /* Set IPsec parameters in conf */
117 set_ipsec_conf(sa, &(sess_conf.ipsec));
119 ips->security.ses = rte_security_session_create(ctx,
120 &sess_conf, ipsec_ctx->session_priv_pool);
121 if (ips->security.ses == NULL) {
123 "SEC Session init failed: err: %d\n", ret);
127 RTE_LOG(ERR, IPSEC, "Inline not supported\n");
131 if (ips->type == RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO) {
132 struct rte_cryptodev_info info;
135 cdev_id = ipsec_ctx->tbl[cdev_id_qp].id;
136 rte_cryptodev_info_get(cdev_id, &info);
137 if (!(info.feature_flags &
138 RTE_CRYPTODEV_FF_SYM_CPU_CRYPTO))
141 ips->crypto.dev_id = cdev_id;
143 ips->crypto.ses = rte_cryptodev_sym_session_create(
144 ipsec_ctx->session_pool);
145 rte_cryptodev_sym_session_init(ipsec_ctx->tbl[cdev_id_qp].id,
146 ips->crypto.ses, sa->xforms,
147 ipsec_ctx->session_priv_pool);
149 rte_cryptodev_info_get(ipsec_ctx->tbl[cdev_id_qp].id,
153 sa->cdev_id_qp = cdev_id_qp;
159 create_inline_session(struct socket_ctx *skt_ctx, struct ipsec_sa *sa,
160 struct rte_ipsec_session *ips)
163 struct rte_security_ctx *sec_ctx;
164 struct rte_security_session_conf sess_conf = {
165 .action_type = ips->type,
166 .protocol = RTE_SECURITY_PROTOCOL_IPSEC,
172 .direction = sa->direction,
173 .proto = RTE_SECURITY_IPSEC_SA_PROTO_ESP,
174 .mode = (sa->flags == IP4_TUNNEL ||
175 sa->flags == IP6_TUNNEL) ?
176 RTE_SECURITY_IPSEC_SA_MODE_TUNNEL :
177 RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT,
179 .crypto_xform = sa->xforms,
183 RTE_LOG_DP(DEBUG, IPSEC, "Create session for SA spi %u on port %u\n",
184 sa->spi, sa->portid);
186 if (ips->type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO) {
187 struct rte_flow_error err;
188 const struct rte_security_capability *sec_cap;
191 sec_ctx = (struct rte_security_ctx *)
192 rte_eth_dev_get_sec_ctx(
194 if (sec_ctx == NULL) {
196 " rte_eth_dev_get_sec_ctx failed\n");
200 ips->security.ses = rte_security_session_create(sec_ctx,
201 &sess_conf, skt_ctx->session_pool);
202 if (ips->security.ses == NULL) {
204 "SEC Session init failed: err: %d\n", ret);
208 sec_cap = rte_security_capabilities_get(sec_ctx);
210 /* iterate until ESP tunnel*/
211 while (sec_cap->action != RTE_SECURITY_ACTION_TYPE_NONE) {
212 if (sec_cap->action == ips->type &&
214 RTE_SECURITY_PROTOCOL_IPSEC &&
215 sec_cap->ipsec.mode ==
216 RTE_SECURITY_IPSEC_SA_MODE_TUNNEL &&
217 sec_cap->ipsec.direction == sa->direction)
222 if (sec_cap->action == RTE_SECURITY_ACTION_TYPE_NONE) {
224 "No suitable security capability found\n");
228 ips->security.ol_flags = sec_cap->ol_flags;
229 ips->security.ctx = sec_ctx;
230 sa->pattern[0].type = RTE_FLOW_ITEM_TYPE_ETH;
232 if (IS_IP6(sa->flags)) {
233 sa->pattern[1].mask = &rte_flow_item_ipv6_mask;
234 sa->pattern[1].type = RTE_FLOW_ITEM_TYPE_IPV6;
235 sa->pattern[1].spec = &sa->ipv6_spec;
237 memcpy(sa->ipv6_spec.hdr.dst_addr,
238 sa->dst.ip.ip6.ip6_b, 16);
239 memcpy(sa->ipv6_spec.hdr.src_addr,
240 sa->src.ip.ip6.ip6_b, 16);
241 } else if (IS_IP4(sa->flags)) {
242 sa->pattern[1].mask = &rte_flow_item_ipv4_mask;
243 sa->pattern[1].type = RTE_FLOW_ITEM_TYPE_IPV4;
244 sa->pattern[1].spec = &sa->ipv4_spec;
246 sa->ipv4_spec.hdr.dst_addr = sa->dst.ip.ip4;
247 sa->ipv4_spec.hdr.src_addr = sa->src.ip.ip4;
250 sa->pattern[2].type = RTE_FLOW_ITEM_TYPE_ESP;
251 sa->pattern[2].spec = &sa->esp_spec;
252 sa->pattern[2].mask = &rte_flow_item_esp_mask;
253 sa->esp_spec.hdr.spi = rte_cpu_to_be_32(sa->spi);
255 sa->pattern[3].type = RTE_FLOW_ITEM_TYPE_END;
257 sa->action[0].type = RTE_FLOW_ACTION_TYPE_SECURITY;
258 sa->action[0].conf = ips->security.ses;
260 sa->action[1].type = RTE_FLOW_ACTION_TYPE_END;
262 sa->attr.egress = (sa->direction ==
263 RTE_SECURITY_IPSEC_SA_DIR_EGRESS);
264 sa->attr.ingress = (sa->direction ==
265 RTE_SECURITY_IPSEC_SA_DIR_INGRESS);
266 if (sa->attr.ingress) {
268 struct rte_eth_rss_conf rss_conf = {
272 struct rte_eth_dev_info dev_info;
273 uint16_t queue[RTE_MAX_QUEUES_PER_PORT];
274 struct rte_flow_action_rss action_rss;
278 ret = rte_eth_dev_info_get(sa->portid, &dev_info);
281 "Error during getting device (port %u) info: %s\n",
282 sa->portid, strerror(-ret));
286 sa->action[2].type = RTE_FLOW_ACTION_TYPE_END;
288 sa->action[1].type = RTE_FLOW_ACTION_TYPE_RSS;
289 sa->action[1].conf = &action_rss;
290 ret = rte_eth_dev_rss_hash_conf_get(sa->portid,
294 "rte_eth_dev_rss_hash_conf_get:ret=%d\n",
298 for (i = 0, j = 0; i < dev_info.nb_rx_queues; ++i)
301 action_rss = (struct rte_flow_action_rss){
302 .types = rss_conf.rss_hf,
303 .key_len = rss_conf.rss_key_len,
308 ret = rte_flow_validate(sa->portid, &sa->attr,
309 sa->pattern, sa->action,
314 sa->action[1].type = RTE_FLOW_ACTION_TYPE_QUEUE;
316 &(struct rte_flow_action_queue){
319 ret = rte_flow_validate(sa->portid, &sa->attr,
320 sa->pattern, sa->action,
323 sa->action[1].type = RTE_FLOW_ACTION_TYPE_END;
324 sa->action[1].conf = NULL;
325 ret = rte_flow_validate(sa->portid, &sa->attr,
326 sa->pattern, sa->action,
329 goto flow_create_failure;
330 } else if (sa->attr.egress &&
331 (ips->security.ol_flags &
332 RTE_SECURITY_TX_HW_TRAILER_OFFLOAD)) {
334 RTE_FLOW_ACTION_TYPE_PASSTHRU;
336 RTE_FLOW_ACTION_TYPE_END;
339 sa->flow = rte_flow_create(sa->portid,
340 &sa->attr, sa->pattern, sa->action, &err);
341 if (sa->flow == NULL) {
344 "Failed to create ipsec flow msg: %s\n",
348 } else if (ips->type == RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL) {
349 const struct rte_security_capability *sec_cap;
351 sec_ctx = (struct rte_security_ctx *)
352 rte_eth_dev_get_sec_ctx(sa->portid);
354 if (sec_ctx == NULL) {
356 "Ethernet device doesn't have security features registered\n");
360 /* Set IPsec parameters in conf */
361 set_ipsec_conf(sa, &(sess_conf.ipsec));
363 /* Save SA as userdata for the security session. When
364 * the packet is received, this userdata will be
365 * retrieved using the metadata from the packet.
367 * The PMD is expected to set similar metadata for other
368 * operations, like rte_eth_event, which are tied to
369 * security session. In such cases, the userdata could
370 * be obtained to uniquely identify the security
371 * parameters denoted.
374 sess_conf.userdata = (void *) sa;
376 ips->security.ses = rte_security_session_create(sec_ctx,
377 &sess_conf, skt_ctx->session_pool);
378 if (ips->security.ses == NULL) {
380 "SEC Session init failed: err: %d\n", ret);
384 sec_cap = rte_security_capabilities_get(sec_ctx);
385 if (sec_cap == NULL) {
387 "No capabilities registered\n");
391 /* iterate until ESP tunnel*/
392 while (sec_cap->action !=
393 RTE_SECURITY_ACTION_TYPE_NONE) {
394 if (sec_cap->action == ips->type &&
396 RTE_SECURITY_PROTOCOL_IPSEC &&
397 sec_cap->ipsec.mode ==
398 sess_conf.ipsec.mode &&
399 sec_cap->ipsec.direction == sa->direction)
404 if (sec_cap->action == RTE_SECURITY_ACTION_TYPE_NONE) {
406 "No suitable security capability found\n");
410 ips->security.ol_flags = sec_cap->ol_flags;
411 ips->security.ctx = sec_ctx;
419 * queue crypto-ops into PMD queue.
422 enqueue_cop_burst(struct cdev_qp *cqp)
424 uint32_t i, len, ret;
427 ret = rte_cryptodev_enqueue_burst(cqp->id, cqp->qp, cqp->buf, len);
429 RTE_LOG_DP(DEBUG, IPSEC, "Cryptodev %u queue %u:"
430 " enqueued %u crypto ops out of %u\n",
431 cqp->id, cqp->qp, ret, len);
432 /* drop packets that we fail to enqueue */
433 for (i = ret; i < len; i++)
434 rte_pktmbuf_free(cqp->buf[i]->sym->m_src);
436 cqp->in_flight += ret;
441 enqueue_cop(struct cdev_qp *cqp, struct rte_crypto_op *cop)
443 cqp->buf[cqp->len++] = cop;
445 if (cqp->len == MAX_PKT_BURST)
446 enqueue_cop_burst(cqp);
450 ipsec_enqueue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
451 struct rte_mbuf *pkts[], void *sas[],
455 struct ipsec_mbuf_metadata *priv;
456 struct rte_crypto_sym_op *sym_cop;
458 struct rte_ipsec_session *ips;
460 for (i = 0; i < nb_pkts; i++) {
461 if (unlikely(sas[i] == NULL)) {
462 rte_pktmbuf_free(pkts[i]);
466 rte_prefetch0(sas[i]);
467 rte_prefetch0(pkts[i]);
469 priv = get_priv(pkts[i]);
470 sa = ipsec_mask_saptr(sas[i]);
472 ips = ipsec_get_primary_session(sa);
475 case RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL:
476 priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
477 priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
479 rte_prefetch0(&priv->sym_cop);
481 if ((unlikely(ips->security.ses == NULL)) &&
482 create_lookaside_session(ipsec_ctx, sa, ips)) {
483 rte_pktmbuf_free(pkts[i]);
487 sym_cop = get_sym_cop(&priv->cop);
488 sym_cop->m_src = pkts[i];
490 rte_security_attach_session(&priv->cop,
494 case RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO:
495 RTE_LOG(ERR, IPSEC, "CPU crypto is not supported by the"
497 rte_pktmbuf_free(pkts[i]);
500 case RTE_SECURITY_ACTION_TYPE_NONE:
502 priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
503 priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
505 rte_prefetch0(&priv->sym_cop);
507 if ((unlikely(ips->crypto.ses == NULL)) &&
508 create_lookaside_session(ipsec_ctx, sa, ips)) {
509 rte_pktmbuf_free(pkts[i]);
513 rte_crypto_op_attach_sym_session(&priv->cop,
516 ret = xform_func(pkts[i], sa, &priv->cop);
518 rte_pktmbuf_free(pkts[i]);
522 case RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL:
523 RTE_ASSERT(ips->security.ses != NULL);
524 ipsec_ctx->ol_pkts[ipsec_ctx->ol_pkts_cnt++] = pkts[i];
525 if (ips->security.ol_flags &
526 RTE_SECURITY_TX_OLOAD_NEED_MDATA)
527 rte_security_set_pkt_metadata(
528 ips->security.ctx, ips->security.ses,
531 case RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO:
532 RTE_ASSERT(ips->security.ses != NULL);
533 priv->cop.type = RTE_CRYPTO_OP_TYPE_SYMMETRIC;
534 priv->cop.status = RTE_CRYPTO_OP_STATUS_NOT_PROCESSED;
536 rte_prefetch0(&priv->sym_cop);
537 rte_security_attach_session(&priv->cop,
540 ret = xform_func(pkts[i], sa, &priv->cop);
542 rte_pktmbuf_free(pkts[i]);
546 ipsec_ctx->ol_pkts[ipsec_ctx->ol_pkts_cnt++] = pkts[i];
547 if (ips->security.ol_flags &
548 RTE_SECURITY_TX_OLOAD_NEED_MDATA)
549 rte_security_set_pkt_metadata(
550 ips->security.ctx, ips->security.ses,
555 RTE_ASSERT(sa->cdev_id_qp < ipsec_ctx->nb_qps);
556 enqueue_cop(&ipsec_ctx->tbl[sa->cdev_id_qp], &priv->cop);
560 static inline int32_t
561 ipsec_inline_dequeue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
562 struct rte_mbuf *pkts[], uint16_t max_pkts)
564 int32_t nb_pkts, ret;
565 struct ipsec_mbuf_metadata *priv;
567 struct rte_mbuf *pkt;
570 while (ipsec_ctx->ol_pkts_cnt > 0 && nb_pkts < max_pkts) {
571 pkt = ipsec_ctx->ol_pkts[--ipsec_ctx->ol_pkts_cnt];
573 priv = get_priv(pkt);
575 ret = xform_func(pkt, sa, &priv->cop);
577 rte_pktmbuf_free(pkt);
580 pkts[nb_pkts++] = pkt;
587 ipsec_dequeue(ipsec_xform_fn xform_func, struct ipsec_ctx *ipsec_ctx,
588 struct rte_mbuf *pkts[], uint16_t max_pkts)
590 int32_t nb_pkts = 0, ret = 0, i, j, nb_cops;
591 struct ipsec_mbuf_metadata *priv;
592 struct rte_crypto_op *cops[max_pkts];
594 struct rte_mbuf *pkt;
596 for (i = 0; i < ipsec_ctx->nb_qps && nb_pkts < max_pkts; i++) {
599 cqp = &ipsec_ctx->tbl[ipsec_ctx->last_qp++];
600 if (ipsec_ctx->last_qp == ipsec_ctx->nb_qps)
601 ipsec_ctx->last_qp %= ipsec_ctx->nb_qps;
603 if (cqp->in_flight == 0)
606 nb_cops = rte_cryptodev_dequeue_burst(cqp->id, cqp->qp,
607 cops, max_pkts - nb_pkts);
609 cqp->in_flight -= nb_cops;
611 for (j = 0; j < nb_cops; j++) {
612 pkt = cops[j]->sym->m_src;
615 priv = get_priv(pkt);
618 RTE_ASSERT(sa != NULL);
620 if (ipsec_get_action_type(sa) ==
621 RTE_SECURITY_ACTION_TYPE_NONE) {
622 ret = xform_func(pkt, sa, cops[j]);
624 rte_pktmbuf_free(pkt);
627 } else if (ipsec_get_action_type(sa) ==
628 RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL) {
629 if (cops[j]->status) {
630 rte_pktmbuf_free(pkt);
634 pkts[nb_pkts++] = pkt;
643 ipsec_inbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
644 uint16_t nb_pkts, uint16_t len)
648 inbound_sa_lookup(ctx->sa_ctx, pkts, sas, nb_pkts);
650 ipsec_enqueue(esp_inbound, ctx, pkts, sas, nb_pkts);
652 return ipsec_inline_dequeue(esp_inbound_post, ctx, pkts, len);
656 ipsec_inbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
659 return ipsec_dequeue(esp_inbound_post, ctx, pkts, len);
663 ipsec_outbound(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
664 uint32_t sa_idx[], uint16_t nb_pkts, uint16_t len)
668 outbound_sa_lookup(ctx->sa_ctx, sa_idx, sas, nb_pkts);
670 ipsec_enqueue(esp_outbound, ctx, pkts, sas, nb_pkts);
672 return ipsec_inline_dequeue(esp_outbound_post, ctx, pkts, len);
676 ipsec_outbound_cqp_dequeue(struct ipsec_ctx *ctx, struct rte_mbuf *pkts[],
679 return ipsec_dequeue(esp_outbound_post, ctx, pkts, len);