1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2020 Intel Corporation
6 * Security Associations
9 #include <netinet/in.h>
10 #include <netinet/ip.h>
11 #include <netinet/ip6.h>
13 #include <rte_memzone.h>
14 #include <rte_crypto.h>
15 #include <rte_security.h>
16 #include <rte_cryptodev.h>
17 #include <rte_byteorder.h>
18 #include <rte_errno.h>
20 #include <rte_random.h>
21 #include <rte_ethdev.h>
22 #include <rte_malloc.h>
31 #define IP4_FULL_MASK (sizeof(((struct ip_addr *)NULL)->ip.ip4) * CHAR_BIT)
33 #define IP6_FULL_MASK (sizeof(((struct ip_addr *)NULL)->ip.ip6.ip6) * CHAR_BIT)
35 #define MBUF_NO_SEC_OFFLOAD(m) ((m->ol_flags & PKT_RX_SEC_OFFLOAD) == 0)
37 struct supported_cipher_algo {
39 enum rte_crypto_cipher_algorithm algo;
45 struct supported_auth_algo {
47 enum rte_crypto_auth_algorithm algo;
53 struct supported_aead_algo {
55 enum rte_crypto_aead_algorithm algo;
64 const struct supported_cipher_algo cipher_algos[] = {
67 .algo = RTE_CRYPTO_CIPHER_NULL,
73 .keyword = "aes-128-cbc",
74 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
80 .keyword = "aes-192-cbc",
81 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
87 .keyword = "aes-256-cbc",
88 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
94 .keyword = "aes-128-ctr",
95 .algo = RTE_CRYPTO_CIPHER_AES_CTR,
101 .keyword = "3des-cbc",
102 .algo = RTE_CRYPTO_CIPHER_3DES_CBC,
109 const struct supported_auth_algo auth_algos[] = {
112 .algo = RTE_CRYPTO_AUTH_NULL,
118 .keyword = "sha1-hmac",
119 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
124 .keyword = "sha256-hmac",
125 .algo = RTE_CRYPTO_AUTH_SHA256_HMAC,
131 const struct supported_aead_algo aead_algos[] = {
133 .keyword = "aes-128-gcm",
134 .algo = RTE_CRYPTO_AEAD_AES_GCM,
142 .keyword = "aes-192-gcm",
143 .algo = RTE_CRYPTO_AEAD_AES_GCM,
151 .keyword = "aes-256-gcm",
152 .algo = RTE_CRYPTO_AEAD_AES_GCM,
161 #define SA_INIT_NB 128
163 struct ipsec_sa *sa_out;
165 static uint32_t sa_out_sz;
166 static struct ipsec_sa_cnt sa_out_cnt;
168 struct ipsec_sa *sa_in;
170 static uint32_t sa_in_sz;
171 static struct ipsec_sa_cnt sa_in_cnt;
173 static const struct supported_cipher_algo *
174 find_match_cipher_algo(const char *cipher_keyword)
178 for (i = 0; i < RTE_DIM(cipher_algos); i++) {
179 const struct supported_cipher_algo *algo =
182 if (strcmp(cipher_keyword, algo->keyword) == 0)
189 static const struct supported_auth_algo *
190 find_match_auth_algo(const char *auth_keyword)
194 for (i = 0; i < RTE_DIM(auth_algos); i++) {
195 const struct supported_auth_algo *algo =
198 if (strcmp(auth_keyword, algo->keyword) == 0)
205 static const struct supported_aead_algo *
206 find_match_aead_algo(const char *aead_keyword)
210 for (i = 0; i < RTE_DIM(aead_algos); i++) {
211 const struct supported_aead_algo *algo =
214 if (strcmp(aead_keyword, algo->keyword) == 0)
222 * parse x:x:x:x.... hex number key string into uint8_t *key
224 * > 0: number of bytes parsed
228 parse_key_string(const char *key_str, uint8_t *key)
230 const char *pt_start = key_str, *pt_end = key_str;
231 uint32_t nb_bytes = 0;
233 while (pt_end != NULL) {
234 char sub_str[3] = {0};
236 pt_end = strchr(pt_start, ':');
238 if (pt_end == NULL) {
239 if (strlen(pt_start) > 2)
241 strncpy(sub_str, pt_start, 2);
243 if (pt_end - pt_start > 2)
246 strncpy(sub_str, pt_start, pt_end - pt_start);
247 pt_start = pt_end + 1;
250 key[nb_bytes++] = strtol(sub_str, NULL, 16);
257 extend_sa_arr(struct ipsec_sa **sa_tbl, uint32_t cur_cnt, uint32_t *cur_sz)
259 if (*sa_tbl == NULL) {
260 *sa_tbl = calloc(SA_INIT_NB, sizeof(struct ipsec_sa));
263 *cur_sz = SA_INIT_NB;
267 if (cur_cnt >= *cur_sz) {
268 *sa_tbl = realloc(*sa_tbl,
269 *cur_sz * sizeof(struct ipsec_sa) * 2);
272 /* clean reallocated extra space */
273 memset(&(*sa_tbl)[*cur_sz], 0,
274 *cur_sz * sizeof(struct ipsec_sa));
282 parse_sa_tokens(char **tokens, uint32_t n_tokens,
283 struct parse_status *status)
285 struct ipsec_sa *rule = NULL;
286 struct rte_ipsec_session *ips;
287 uint32_t ti; /*token index*/
288 uint32_t *ri /*rule index*/;
289 struct ipsec_sa_cnt *sa_cnt;
290 uint32_t cipher_algo_p = 0;
291 uint32_t auth_algo_p = 0;
292 uint32_t aead_algo_p = 0;
297 uint32_t portid_p = 0;
298 uint32_t fallback_p = 0;
299 int16_t status_p = 0;
301 if (strcmp(tokens[0], "in") == 0) {
304 if (extend_sa_arr(&sa_in, nb_sa_in, &sa_in_sz) < 0)
307 rule->direction = RTE_SECURITY_IPSEC_SA_DIR_INGRESS;
310 sa_cnt = &sa_out_cnt;
311 if (extend_sa_arr(&sa_out, nb_sa_out, &sa_out_sz) < 0)
314 rule->direction = RTE_SECURITY_IPSEC_SA_DIR_EGRESS;
318 APP_CHECK_TOKEN_IS_NUM(tokens, 1, status);
319 if (status->status < 0)
321 if (atoi(tokens[1]) == INVALID_SPI)
323 rule->spi = atoi(tokens[1]);
324 rule->portid = UINT16_MAX;
325 ips = ipsec_get_primary_session(rule);
327 for (ti = 2; ti < n_tokens; ti++) {
328 if (strcmp(tokens[ti], "mode") == 0) {
329 APP_CHECK_PRESENCE(mode_p, tokens[ti], status);
330 if (status->status < 0)
333 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
334 if (status->status < 0)
337 if (strcmp(tokens[ti], "ipv4-tunnel") == 0) {
339 rule->flags = IP4_TUNNEL;
340 } else if (strcmp(tokens[ti], "ipv6-tunnel") == 0) {
342 rule->flags = IP6_TUNNEL;
343 } else if (strcmp(tokens[ti], "transport") == 0) {
346 rule->flags = TRANSPORT;
348 APP_CHECK(0, status, "unrecognized "
349 "input \"%s\"", tokens[ti]);
357 if (strcmp(tokens[ti], "cipher_algo") == 0) {
358 const struct supported_cipher_algo *algo;
361 APP_CHECK_PRESENCE(cipher_algo_p, tokens[ti],
363 if (status->status < 0)
366 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
367 if (status->status < 0)
370 algo = find_match_cipher_algo(tokens[ti]);
372 APP_CHECK(algo != NULL, status, "unrecognized "
373 "input \"%s\"", tokens[ti]);
375 if (status->status < 0)
378 rule->cipher_algo = algo->algo;
379 rule->block_size = algo->block_size;
380 rule->iv_len = algo->iv_len;
381 rule->cipher_key_len = algo->key_len;
383 /* for NULL algorithm, no cipher key required */
384 if (rule->cipher_algo == RTE_CRYPTO_CIPHER_NULL) {
389 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
390 if (status->status < 0)
393 APP_CHECK(strcmp(tokens[ti], "cipher_key") == 0,
394 status, "unrecognized input \"%s\", "
395 "expect \"cipher_key\"", tokens[ti]);
396 if (status->status < 0)
399 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
400 if (status->status < 0)
403 key_len = parse_key_string(tokens[ti],
405 APP_CHECK(key_len == rule->cipher_key_len, status,
406 "unrecognized input \"%s\"", tokens[ti]);
407 if (status->status < 0)
410 if (algo->algo == RTE_CRYPTO_CIPHER_AES_CBC ||
411 algo->algo == RTE_CRYPTO_CIPHER_3DES_CBC)
412 rule->salt = (uint32_t)rte_rand();
414 if (algo->algo == RTE_CRYPTO_CIPHER_AES_CTR) {
416 rule->cipher_key_len = key_len;
418 &rule->cipher_key[key_len], 4);
425 if (strcmp(tokens[ti], "auth_algo") == 0) {
426 const struct supported_auth_algo *algo;
429 APP_CHECK_PRESENCE(auth_algo_p, tokens[ti],
431 if (status->status < 0)
434 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
435 if (status->status < 0)
438 algo = find_match_auth_algo(tokens[ti]);
439 APP_CHECK(algo != NULL, status, "unrecognized "
440 "input \"%s\"", tokens[ti]);
442 if (status->status < 0)
445 rule->auth_algo = algo->algo;
446 rule->auth_key_len = algo->key_len;
447 rule->digest_len = algo->digest_len;
449 /* NULL algorithm and combined algos do not
452 if (algo->key_not_req) {
457 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
458 if (status->status < 0)
461 APP_CHECK(strcmp(tokens[ti], "auth_key") == 0,
462 status, "unrecognized input \"%s\", "
463 "expect \"auth_key\"", tokens[ti]);
464 if (status->status < 0)
467 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
468 if (status->status < 0)
471 key_len = parse_key_string(tokens[ti],
473 APP_CHECK(key_len == rule->auth_key_len, status,
474 "unrecognized input \"%s\"", tokens[ti]);
475 if (status->status < 0)
482 if (strcmp(tokens[ti], "aead_algo") == 0) {
483 const struct supported_aead_algo *algo;
486 APP_CHECK_PRESENCE(aead_algo_p, tokens[ti],
488 if (status->status < 0)
491 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
492 if (status->status < 0)
495 algo = find_match_aead_algo(tokens[ti]);
497 APP_CHECK(algo != NULL, status, "unrecognized "
498 "input \"%s\"", tokens[ti]);
500 if (status->status < 0)
503 rule->aead_algo = algo->algo;
504 rule->cipher_key_len = algo->key_len;
505 rule->digest_len = algo->digest_len;
506 rule->aad_len = algo->aad_len;
507 rule->block_size = algo->block_size;
508 rule->iv_len = algo->iv_len;
510 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
511 if (status->status < 0)
514 APP_CHECK(strcmp(tokens[ti], "aead_key") == 0,
515 status, "unrecognized input \"%s\", "
516 "expect \"aead_key\"", tokens[ti]);
517 if (status->status < 0)
520 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
521 if (status->status < 0)
524 key_len = parse_key_string(tokens[ti],
526 APP_CHECK(key_len == rule->cipher_key_len, status,
527 "unrecognized input \"%s\"", tokens[ti]);
528 if (status->status < 0)
532 rule->cipher_key_len = key_len;
534 &rule->cipher_key[key_len], 4);
540 if (strcmp(tokens[ti], "src") == 0) {
541 APP_CHECK_PRESENCE(src_p, tokens[ti], status);
542 if (status->status < 0)
545 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
546 if (status->status < 0)
549 if (IS_IP4_TUNNEL(rule->flags)) {
552 APP_CHECK(parse_ipv4_addr(tokens[ti],
553 &ip, NULL) == 0, status,
554 "unrecognized input \"%s\", "
555 "expect valid ipv4 addr",
557 if (status->status < 0)
559 rule->src.ip.ip4 = rte_bswap32(
560 (uint32_t)ip.s_addr);
561 } else if (IS_IP6_TUNNEL(rule->flags)) {
564 APP_CHECK(parse_ipv6_addr(tokens[ti], &ip,
566 "unrecognized input \"%s\", "
567 "expect valid ipv6 addr",
569 if (status->status < 0)
571 memcpy(rule->src.ip.ip6.ip6_b,
573 } else if (IS_TRANSPORT(rule->flags)) {
574 APP_CHECK(0, status, "unrecognized input "
575 "\"%s\"", tokens[ti]);
583 if (strcmp(tokens[ti], "dst") == 0) {
584 APP_CHECK_PRESENCE(dst_p, tokens[ti], status);
585 if (status->status < 0)
588 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
589 if (status->status < 0)
592 if (IS_IP4_TUNNEL(rule->flags)) {
595 APP_CHECK(parse_ipv4_addr(tokens[ti],
596 &ip, NULL) == 0, status,
597 "unrecognized input \"%s\", "
598 "expect valid ipv4 addr",
600 if (status->status < 0)
602 rule->dst.ip.ip4 = rte_bswap32(
603 (uint32_t)ip.s_addr);
604 } else if (IS_IP6_TUNNEL(rule->flags)) {
607 APP_CHECK(parse_ipv6_addr(tokens[ti], &ip,
609 "unrecognized input \"%s\", "
610 "expect valid ipv6 addr",
612 if (status->status < 0)
614 memcpy(rule->dst.ip.ip6.ip6_b, ip.s6_addr, 16);
615 } else if (IS_TRANSPORT(rule->flags)) {
616 APP_CHECK(0, status, "unrecognized "
617 "input \"%s\"", tokens[ti]);
625 if (strcmp(tokens[ti], "type") == 0) {
626 APP_CHECK_PRESENCE(type_p, tokens[ti], status);
627 if (status->status < 0)
630 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
631 if (status->status < 0)
634 if (strcmp(tokens[ti], "inline-crypto-offload") == 0)
636 RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO;
637 else if (strcmp(tokens[ti],
638 "inline-protocol-offload") == 0)
640 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL;
641 else if (strcmp(tokens[ti],
642 "lookaside-protocol-offload") == 0)
644 RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL;
645 else if (strcmp(tokens[ti], "no-offload") == 0)
646 ips->type = RTE_SECURITY_ACTION_TYPE_NONE;
647 else if (strcmp(tokens[ti], "cpu-crypto") == 0)
648 ips->type = RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO;
650 APP_CHECK(0, status, "Invalid input \"%s\"",
659 if (strcmp(tokens[ti], "port_id") == 0) {
660 APP_CHECK_PRESENCE(portid_p, tokens[ti], status);
661 if (status->status < 0)
663 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
664 if (status->status < 0)
666 if (rule->portid == UINT16_MAX)
667 rule->portid = atoi(tokens[ti]);
668 else if (rule->portid != atoi(tokens[ti])) {
670 "portid %s not matching with already assigned portid %u",
671 tokens[ti], rule->portid);
678 if (strcmp(tokens[ti], "fallback") == 0) {
679 struct rte_ipsec_session *fb;
681 APP_CHECK(app_sa_prm.enable, status, "Fallback session "
682 "not allowed for legacy mode.");
683 if (status->status < 0)
685 APP_CHECK(ips->type ==
686 RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO, status,
687 "Fallback session allowed if primary session "
688 "is of type inline-crypto-offload only.");
689 if (status->status < 0)
691 APP_CHECK(rule->direction ==
692 RTE_SECURITY_IPSEC_SA_DIR_INGRESS, status,
693 "Fallback session not allowed for egress "
695 if (status->status < 0)
697 APP_CHECK_PRESENCE(fallback_p, tokens[ti], status);
698 if (status->status < 0)
700 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
701 if (status->status < 0)
703 fb = ipsec_get_fallback_session(rule);
704 if (strcmp(tokens[ti], "lookaside-none") == 0)
705 fb->type = RTE_SECURITY_ACTION_TYPE_NONE;
706 else if (strcmp(tokens[ti], "cpu-crypto") == 0)
707 fb->type = RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO;
709 APP_CHECK(0, status, "unrecognized fallback "
710 "type %s.", tokens[ti]);
714 rule->fallback_sessions = 1;
718 if (strcmp(tokens[ti], "flow-direction") == 0) {
720 case RTE_SECURITY_ACTION_TYPE_NONE:
721 case RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO:
723 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
724 if (status->status < 0)
726 if (rule->portid == UINT16_MAX)
727 rule->portid = atoi(tokens[ti]);
728 else if (rule->portid != atoi(tokens[ti])) {
730 "portid %s not matching with already assigned portid %u",
731 tokens[ti], rule->portid);
734 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
735 if (status->status < 0)
737 rule->fdir_qid = atoi(tokens[ti]);
738 /* validating portid and queueid */
739 status_p = check_flow_params(rule->portid,
742 printf("port id %u / queue id %u is "
743 "not valid\n", rule->portid,
747 case RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO:
748 case RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL:
749 case RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL:
752 "flow director not supported for security session type %d",
759 /* unrecognizeable input */
760 APP_CHECK(0, status, "unrecognized input \"%s\"",
766 APP_CHECK(cipher_algo_p == 0, status,
767 "AEAD used, no need for cipher options");
768 if (status->status < 0)
771 APP_CHECK(auth_algo_p == 0, status,
772 "AEAD used, no need for auth options");
773 if (status->status < 0)
776 APP_CHECK(cipher_algo_p == 1, status, "missing cipher or AEAD options");
777 if (status->status < 0)
780 APP_CHECK(auth_algo_p == 1, status, "missing auth or AEAD options");
781 if (status->status < 0)
785 APP_CHECK(mode_p == 1, status, "missing mode option");
786 if (status->status < 0)
789 if ((ips->type != RTE_SECURITY_ACTION_TYPE_NONE && ips->type !=
790 RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO) && (portid_p == 0))
791 printf("Missing portid option, falling back to non-offload\n");
793 if (!type_p || (!portid_p && ips->type !=
794 RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO)) {
795 ips->type = RTE_SECURITY_ACTION_TYPE_NONE;
802 print_one_sa_rule(const struct ipsec_sa *sa, int inbound)
806 const struct rte_ipsec_session *ips;
807 const struct rte_ipsec_session *fallback_ips;
809 printf("\tspi_%s(%3u):", inbound?"in":"out", sa->spi);
811 for (i = 0; i < RTE_DIM(cipher_algos); i++) {
812 if (cipher_algos[i].algo == sa->cipher_algo &&
813 cipher_algos[i].key_len == sa->cipher_key_len) {
814 printf("%s ", cipher_algos[i].keyword);
819 for (i = 0; i < RTE_DIM(auth_algos); i++) {
820 if (auth_algos[i].algo == sa->auth_algo) {
821 printf("%s ", auth_algos[i].keyword);
826 for (i = 0; i < RTE_DIM(aead_algos); i++) {
827 if (aead_algos[i].algo == sa->aead_algo &&
828 aead_algos[i].key_len-4 == sa->cipher_key_len) {
829 printf("%s ", aead_algos[i].keyword);
836 switch (WITHOUT_TRANSPORT_VERSION(sa->flags)) {
838 printf("IP4Tunnel ");
839 uint32_t_to_char(sa->src.ip.ip4, &a, &b, &c, &d);
840 printf("%hhu.%hhu.%hhu.%hhu ", d, c, b, a);
841 uint32_t_to_char(sa->dst.ip.ip4, &a, &b, &c, &d);
842 printf("%hhu.%hhu.%hhu.%hhu", d, c, b, a);
845 printf("IP6Tunnel ");
846 for (i = 0; i < 16; i++) {
847 if (i % 2 && i != 15)
848 printf("%.2x:", sa->src.ip.ip6.ip6_b[i]);
850 printf("%.2x", sa->src.ip.ip6.ip6_b[i]);
853 for (i = 0; i < 16; i++) {
854 if (i % 2 && i != 15)
855 printf("%.2x:", sa->dst.ip.ip6.ip6_b[i]);
857 printf("%.2x", sa->dst.ip.ip6.ip6_b[i]);
861 printf("Transport ");
865 ips = &sa->sessions[IPSEC_SESSION_PRIMARY];
868 case RTE_SECURITY_ACTION_TYPE_NONE:
869 printf("no-offload ");
871 case RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO:
872 printf("inline-crypto-offload ");
874 case RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL:
875 printf("inline-protocol-offload ");
877 case RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL:
878 printf("lookaside-protocol-offload ");
880 case RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO:
881 printf("cpu-crypto-accelerated ");
885 fallback_ips = &sa->sessions[IPSEC_SESSION_FALLBACK];
886 if (fallback_ips != NULL && sa->fallback_sessions > 0) {
887 printf("inline fallback: ");
888 switch (fallback_ips->type) {
889 case RTE_SECURITY_ACTION_TYPE_NONE:
890 printf("lookaside-none");
892 case RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO:
893 printf("cpu-crypto-accelerated");
900 if (sa->fdir_flag == 1)
901 printf("flow-direction port %d queue %d", sa->portid,
907 static struct sa_ctx *
908 sa_create(const char *name, int32_t socket_id, uint32_t nb_sa)
911 struct sa_ctx *sa_ctx;
913 const struct rte_memzone *mz;
915 snprintf(s, sizeof(s), "%s_%u", name, socket_id);
917 /* Create SA context */
918 printf("Creating SA context with %u maximum entries on socket %d\n",
921 mz_size = sizeof(struct ipsec_xf) * nb_sa;
922 mz = rte_memzone_reserve(s, mz_size, socket_id,
923 RTE_MEMZONE_1GB | RTE_MEMZONE_SIZE_HINT_ONLY);
925 printf("Failed to allocate SA XFORM memory\n");
930 sa_ctx = rte_zmalloc(NULL, sizeof(struct sa_ctx) +
931 sizeof(struct ipsec_sa) * nb_sa, RTE_CACHE_LINE_SIZE);
933 if (sa_ctx == NULL) {
934 printf("Failed to allocate SA CTX memory\n");
936 rte_memzone_free(mz);
940 sa_ctx->xf = (struct ipsec_xf *)mz->addr;
941 sa_ctx->nb_sa = nb_sa;
947 check_eth_dev_caps(uint16_t portid, uint32_t inbound)
949 struct rte_eth_dev_info dev_info;
952 retval = rte_eth_dev_info_get(portid, &dev_info);
955 "Error during getting device (port %u) info: %s\n",
956 portid, strerror(-retval));
962 if ((dev_info.rx_offload_capa &
963 DEV_RX_OFFLOAD_SECURITY) == 0) {
964 RTE_LOG(WARNING, PORT,
965 "hardware RX IPSec offload is not supported\n");
969 } else { /* outbound */
970 if ((dev_info.tx_offload_capa &
971 DEV_TX_OFFLOAD_SECURITY) == 0) {
972 RTE_LOG(WARNING, PORT,
973 "hardware TX IPSec offload is not supported\n");
981 * Helper function, tries to determine next_proto for SPI
982 * by searching though SP rules.
985 get_spi_proto(uint32_t spi, enum rte_security_ipsec_sa_direction dir,
986 struct ip_addr ip_addr[2], uint32_t mask[2])
990 rc4 = sp4_spi_present(spi, dir == RTE_SECURITY_IPSEC_SA_DIR_INGRESS,
992 rc6 = sp6_spi_present(spi, dir == RTE_SECURITY_IPSEC_SA_DIR_INGRESS,
998 "%s: SPI %u used simultaeously by "
999 "IPv4(%d) and IPv6 (%d) SP rules\n",
1000 __func__, spi, rc4, rc6);
1003 return IPPROTO_IPIP;
1004 } else if (rc6 < 0) {
1006 "%s: SPI %u is not used by any SP rule\n",
1010 return IPPROTO_IPV6;
1014 * Helper function for getting source and destination IP addresses
1015 * from SP. Needed for inline crypto transport mode, as addresses are not
1016 * provided in config file for that mode. It checks if SP for current SA exists,
1017 * and based on what type of protocol is returned, it stores appropriate
1018 * addresses got from SP into SA.
1021 sa_add_address_inline_crypto(struct ipsec_sa *sa)
1024 struct ip_addr ip_addr[2];
1027 protocol = get_spi_proto(sa->spi, sa->direction, ip_addr, mask);
1030 else if (protocol == IPPROTO_IPIP) {
1031 sa->flags |= IP4_TRANSPORT;
1032 if (mask[0] == IP4_FULL_MASK &&
1033 mask[1] == IP4_FULL_MASK &&
1034 ip_addr[0].ip.ip4 != 0 &&
1035 ip_addr[1].ip.ip4 != 0) {
1037 sa->src.ip.ip4 = ip_addr[0].ip.ip4;
1038 sa->dst.ip.ip4 = ip_addr[1].ip.ip4;
1041 "%s: No valid address or mask entry in"
1042 " IPv4 SP rule for SPI %u\n",
1046 } else if (protocol == IPPROTO_IPV6) {
1047 sa->flags |= IP6_TRANSPORT;
1048 if (mask[0] == IP6_FULL_MASK &&
1049 mask[1] == IP6_FULL_MASK &&
1050 (ip_addr[0].ip.ip6.ip6[0] != 0 ||
1051 ip_addr[0].ip.ip6.ip6[1] != 0) &&
1052 (ip_addr[1].ip.ip6.ip6[0] != 0 ||
1053 ip_addr[1].ip.ip6.ip6[1] != 0)) {
1055 sa->src.ip.ip6 = ip_addr[0].ip.ip6;
1056 sa->dst.ip.ip6 = ip_addr[1].ip.ip6;
1059 "%s: No valid address or mask entry in"
1060 " IPv6 SP rule for SPI %u\n",
1069 sa_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
1070 uint32_t nb_entries, uint32_t inbound,
1071 struct socket_ctx *skt_ctx)
1073 struct ipsec_sa *sa;
1075 uint16_t iv_length, aad_length;
1078 struct rte_ipsec_session *ips;
1080 /* for ESN upper 32 bits of SQN also need to be part of AAD */
1081 aad_length = (app_sa_prm.enable_esn != 0) ? sizeof(uint32_t) : 0;
1083 for (i = 0; i < nb_entries; i++) {
1085 sa = &sa_ctx->sa[idx];
1087 printf("Index %u already in use by SPI %u\n",
1094 rc = ipsec_sad_add(&sa_ctx->sad, sa);
1100 ips = ipsec_get_primary_session(sa);
1102 if (ips->type == RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL ||
1103 ips->type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO) {
1104 if (check_eth_dev_caps(sa->portid, inbound))
1108 switch (WITHOUT_TRANSPORT_VERSION(sa->flags)) {
1110 sa->src.ip.ip4 = rte_cpu_to_be_32(sa->src.ip.ip4);
1111 sa->dst.ip.ip4 = rte_cpu_to_be_32(sa->dst.ip.ip4);
1115 RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO) {
1117 sa_add_address_inline_crypto(sa);
1118 if (inline_status < 0)
1119 return inline_status;
1124 if (sa->aead_algo == RTE_CRYPTO_AEAD_AES_GCM) {
1127 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_AEAD;
1128 sa_ctx->xf[idx].a.aead.algo = sa->aead_algo;
1129 sa_ctx->xf[idx].a.aead.key.data = sa->cipher_key;
1130 sa_ctx->xf[idx].a.aead.key.length =
1132 sa_ctx->xf[idx].a.aead.op = (inbound == 1) ?
1133 RTE_CRYPTO_AEAD_OP_DECRYPT :
1134 RTE_CRYPTO_AEAD_OP_ENCRYPT;
1135 sa_ctx->xf[idx].a.next = NULL;
1136 sa_ctx->xf[idx].a.aead.iv.offset = IV_OFFSET;
1137 sa_ctx->xf[idx].a.aead.iv.length = iv_length;
1138 sa_ctx->xf[idx].a.aead.aad_length =
1139 sa->aad_len + aad_length;
1140 sa_ctx->xf[idx].a.aead.digest_length =
1143 sa->xforms = &sa_ctx->xf[idx].a;
1145 switch (sa->cipher_algo) {
1146 case RTE_CRYPTO_CIPHER_NULL:
1147 case RTE_CRYPTO_CIPHER_3DES_CBC:
1148 case RTE_CRYPTO_CIPHER_AES_CBC:
1149 iv_length = sa->iv_len;
1151 case RTE_CRYPTO_CIPHER_AES_CTR:
1155 RTE_LOG(ERR, IPSEC_ESP,
1156 "unsupported cipher algorithm %u\n",
1162 sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
1163 sa_ctx->xf[idx].b.cipher.algo = sa->cipher_algo;
1164 sa_ctx->xf[idx].b.cipher.key.data = sa->cipher_key;
1165 sa_ctx->xf[idx].b.cipher.key.length =
1167 sa_ctx->xf[idx].b.cipher.op =
1168 RTE_CRYPTO_CIPHER_OP_DECRYPT;
1169 sa_ctx->xf[idx].b.next = NULL;
1170 sa_ctx->xf[idx].b.cipher.iv.offset = IV_OFFSET;
1171 sa_ctx->xf[idx].b.cipher.iv.length = iv_length;
1173 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_AUTH;
1174 sa_ctx->xf[idx].a.auth.algo = sa->auth_algo;
1175 sa_ctx->xf[idx].a.auth.key.data = sa->auth_key;
1176 sa_ctx->xf[idx].a.auth.key.length =
1178 sa_ctx->xf[idx].a.auth.digest_length =
1180 sa_ctx->xf[idx].a.auth.op =
1181 RTE_CRYPTO_AUTH_OP_VERIFY;
1182 } else { /* outbound */
1183 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
1184 sa_ctx->xf[idx].a.cipher.algo = sa->cipher_algo;
1185 sa_ctx->xf[idx].a.cipher.key.data = sa->cipher_key;
1186 sa_ctx->xf[idx].a.cipher.key.length =
1188 sa_ctx->xf[idx].a.cipher.op =
1189 RTE_CRYPTO_CIPHER_OP_ENCRYPT;
1190 sa_ctx->xf[idx].a.next = NULL;
1191 sa_ctx->xf[idx].a.cipher.iv.offset = IV_OFFSET;
1192 sa_ctx->xf[idx].a.cipher.iv.length = iv_length;
1194 sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_AUTH;
1195 sa_ctx->xf[idx].b.auth.algo = sa->auth_algo;
1196 sa_ctx->xf[idx].b.auth.key.data = sa->auth_key;
1197 sa_ctx->xf[idx].b.auth.key.length =
1199 sa_ctx->xf[idx].b.auth.digest_length =
1201 sa_ctx->xf[idx].b.auth.op =
1202 RTE_CRYPTO_AUTH_OP_GENERATE;
1205 sa_ctx->xf[idx].a.next = &sa_ctx->xf[idx].b;
1206 sa_ctx->xf[idx].b.next = NULL;
1207 sa->xforms = &sa_ctx->xf[idx].a;
1211 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL ||
1213 RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO) {
1214 rc = create_inline_session(skt_ctx, sa, ips);
1216 RTE_LOG(ERR, IPSEC_ESP,
1217 "create_inline_session() failed\n");
1222 if (sa->fdir_flag && inbound) {
1223 rc = create_ipsec_esp_flow(sa);
1225 RTE_LOG(ERR, IPSEC_ESP,
1226 "create_ipsec_esp_flow() failed %s\n",
1229 print_one_sa_rule(sa, inbound);
1236 sa_out_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
1237 uint32_t nb_entries, struct socket_ctx *skt_ctx)
1239 return sa_add_rules(sa_ctx, entries, nb_entries, 0, skt_ctx);
1243 sa_in_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
1244 uint32_t nb_entries, struct socket_ctx *skt_ctx)
1246 return sa_add_rules(sa_ctx, entries, nb_entries, 1, skt_ctx);
1250 * helper function, fills parameters that are identical for all SAs
1253 fill_ipsec_app_sa_prm(struct rte_ipsec_sa_prm *prm,
1254 const struct app_sa_prm *app_prm)
1256 memset(prm, 0, sizeof(*prm));
1258 prm->flags = app_prm->flags;
1259 prm->ipsec_xform.options.esn = app_prm->enable_esn;
1260 prm->ipsec_xform.replay_win_sz = app_prm->window_size;
1264 fill_ipsec_sa_prm(struct rte_ipsec_sa_prm *prm, const struct ipsec_sa *ss,
1265 const struct rte_ipv4_hdr *v4, struct rte_ipv6_hdr *v6)
1270 * Try to get SPI next proto by searching that SPI in SPD.
1271 * probably not the optimal way, but there seems nothing
1274 rc = get_spi_proto(ss->spi, ss->direction, NULL, NULL);
1278 fill_ipsec_app_sa_prm(prm, &app_sa_prm);
1279 prm->userdata = (uintptr_t)ss;
1281 /* setup ipsec xform */
1282 prm->ipsec_xform.spi = ss->spi;
1283 prm->ipsec_xform.salt = ss->salt;
1284 prm->ipsec_xform.direction = ss->direction;
1285 prm->ipsec_xform.proto = RTE_SECURITY_IPSEC_SA_PROTO_ESP;
1286 prm->ipsec_xform.mode = (IS_TRANSPORT(ss->flags)) ?
1287 RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT :
1288 RTE_SECURITY_IPSEC_SA_MODE_TUNNEL;
1289 prm->ipsec_xform.options.ecn = 1;
1290 prm->ipsec_xform.options.copy_dscp = 1;
1292 if (IS_IP4_TUNNEL(ss->flags)) {
1293 prm->ipsec_xform.tunnel.type = RTE_SECURITY_IPSEC_TUNNEL_IPV4;
1294 prm->tun.hdr_len = sizeof(*v4);
1295 prm->tun.next_proto = rc;
1297 } else if (IS_IP6_TUNNEL(ss->flags)) {
1298 prm->ipsec_xform.tunnel.type = RTE_SECURITY_IPSEC_TUNNEL_IPV6;
1299 prm->tun.hdr_len = sizeof(*v6);
1300 prm->tun.next_proto = rc;
1303 /* transport mode */
1304 prm->trs.proto = rc;
1307 /* setup crypto section */
1308 prm->crypto_xform = ss->xforms;
1313 fill_ipsec_session(struct rte_ipsec_session *ss, struct rte_ipsec_sa *sa)
1319 if (ss->type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO ||
1320 ss->type == RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL) {
1321 if (ss->security.ses != NULL) {
1322 rc = rte_ipsec_session_prepare(ss);
1324 memset(ss, 0, sizeof(*ss));
1332 * Initialise related rte_ipsec_sa object.
1335 ipsec_sa_init(struct ipsec_sa *lsa, struct rte_ipsec_sa *sa, uint32_t sa_size)
1338 struct rte_ipsec_sa_prm prm;
1339 struct rte_ipsec_session *ips;
1340 struct rte_ipv4_hdr v4 = {
1341 .version_ihl = IPVERSION << 4 |
1342 sizeof(v4) / RTE_IPV4_IHL_MULTIPLIER,
1343 .time_to_live = IPDEFTTL,
1344 .next_proto_id = IPPROTO_ESP,
1345 .src_addr = lsa->src.ip.ip4,
1346 .dst_addr = lsa->dst.ip.ip4,
1348 struct rte_ipv6_hdr v6 = {
1349 .vtc_flow = htonl(IP6_VERSION << 28),
1350 .proto = IPPROTO_ESP,
1353 if (IS_IP6_TUNNEL(lsa->flags)) {
1354 memcpy(v6.src_addr, lsa->src.ip.ip6.ip6_b, sizeof(v6.src_addr));
1355 memcpy(v6.dst_addr, lsa->dst.ip.ip6.ip6_b, sizeof(v6.dst_addr));
1358 rc = fill_ipsec_sa_prm(&prm, lsa, &v4, &v6);
1360 rc = rte_ipsec_sa_init(sa, &prm, sa_size);
1364 /* init primary processing session */
1365 ips = ipsec_get_primary_session(lsa);
1366 rc = fill_ipsec_session(ips, sa);
1370 /* init inline fallback processing session */
1371 if (lsa->fallback_sessions == 1)
1372 rc = fill_ipsec_session(ipsec_get_fallback_session(lsa), sa);
1378 * Allocate space and init rte_ipsec_sa strcutures,
1382 ipsec_satbl_init(struct sa_ctx *ctx, uint32_t nb_ent, int32_t socket)
1387 struct rte_ipsec_sa *sa;
1388 struct ipsec_sa *lsa;
1389 struct rte_ipsec_sa_prm prm;
1391 /* determine SA size */
1393 fill_ipsec_sa_prm(&prm, ctx->sa + idx, NULL, NULL);
1394 sz = rte_ipsec_sa_size(&prm);
1396 RTE_LOG(ERR, IPSEC, "%s(%p, %u, %d): "
1397 "failed to determine SA size, error code: %d\n",
1398 __func__, ctx, nb_ent, socket, sz);
1404 ctx->satbl = rte_zmalloc_socket(NULL, tsz, RTE_CACHE_LINE_SIZE, socket);
1405 if (ctx->satbl == NULL) {
1407 "%s(%p, %u, %d): failed to allocate %zu bytes\n",
1408 __func__, ctx, nb_ent, socket, tsz);
1413 for (i = 0; i != nb_ent && rc == 0; i++) {
1417 sa = (struct rte_ipsec_sa *)((uintptr_t)ctx->satbl + sz * i);
1418 lsa = ctx->sa + idx;
1420 rc = ipsec_sa_init(lsa, sa, sz);
1427 sa_cmp(const void *p, const void *q)
1429 uint32_t spi1 = ((const struct ipsec_sa *)p)->spi;
1430 uint32_t spi2 = ((const struct ipsec_sa *)q)->spi;
1432 return (int)(spi1 - spi2);
1436 * Walk through all SA rules to find an SA with given SPI
1439 sa_spi_present(struct sa_ctx *sa_ctx, uint32_t spi, int inbound)
1442 struct ipsec_sa *sa;
1443 struct ipsec_sa tmpl;
1444 const struct ipsec_sa *sar;
1454 sa = bsearch(&tmpl, sar, num, sizeof(struct ipsec_sa), sa_cmp);
1456 return RTE_PTR_DIFF(sa, sar) / sizeof(struct ipsec_sa);
1462 sa_init(struct socket_ctx *ctx, int32_t socket_id)
1468 rte_exit(EXIT_FAILURE, "NULL context.\n");
1470 if (ctx->sa_in != NULL)
1471 rte_exit(EXIT_FAILURE, "Inbound SA DB for socket %u already "
1472 "initialized\n", socket_id);
1474 if (ctx->sa_out != NULL)
1475 rte_exit(EXIT_FAILURE, "Outbound SA DB for socket %u already "
1476 "initialized\n", socket_id);
1480 ctx->sa_in = sa_create(name, socket_id, nb_sa_in);
1481 if (ctx->sa_in == NULL)
1482 rte_exit(EXIT_FAILURE, "Error [%d] creating SA "
1483 "context %s in socket %d\n", rte_errno,
1486 rc = ipsec_sad_create(name, &ctx->sa_in->sad, socket_id,
1489 rte_exit(EXIT_FAILURE, "failed to init SAD\n");
1491 sa_in_add_rules(ctx->sa_in, sa_in, nb_sa_in, ctx);
1493 if (app_sa_prm.enable != 0) {
1494 rc = ipsec_satbl_init(ctx->sa_in, nb_sa_in,
1497 rte_exit(EXIT_FAILURE,
1498 "failed to init inbound SAs\n");
1501 RTE_LOG(WARNING, IPSEC, "No SA Inbound rule specified\n");
1503 if (nb_sa_out > 0) {
1505 ctx->sa_out = sa_create(name, socket_id, nb_sa_out);
1506 if (ctx->sa_out == NULL)
1507 rte_exit(EXIT_FAILURE, "Error [%d] creating SA "
1508 "context %s in socket %d\n", rte_errno,
1511 sa_out_add_rules(ctx->sa_out, sa_out, nb_sa_out, ctx);
1513 if (app_sa_prm.enable != 0) {
1514 rc = ipsec_satbl_init(ctx->sa_out, nb_sa_out,
1517 rte_exit(EXIT_FAILURE,
1518 "failed to init outbound SAs\n");
1521 RTE_LOG(WARNING, IPSEC, "No SA Outbound rule "
1526 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx)
1528 struct ipsec_mbuf_metadata *priv;
1529 struct ipsec_sa *sa;
1534 return (sa_ctx->sa[sa_idx].spi == sa->spi);
1536 RTE_LOG(ERR, IPSEC, "SA not saved in private data\n");
1541 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[],
1542 void *sa_arr[], uint16_t nb_pkts)
1546 struct ipsec_sa *sa;
1548 sad_lookup(&sa_ctx->sad, pkts, sa_arr, nb_pkts);
1551 * Mark need for inline offload fallback on the LSB of SA pointer.
1552 * Thanks to packet grouping mechanism which ipsec_process is using
1553 * packets marked for fallback processing will form separate group.
1555 * Because it is not safe to use SA pointer it is casted to generic
1556 * pointer to prevent from unintentional use. Use ipsec_mask_saptr
1557 * to get valid struct pointer.
1559 for (i = 0; i < nb_pkts; i++) {
1560 if (sa_arr[i] == NULL)
1563 result_sa = sa = sa_arr[i];
1564 if (MBUF_NO_SEC_OFFLOAD(pkts[i]) &&
1565 sa->fallback_sessions > 0) {
1566 uintptr_t intsa = (uintptr_t)sa;
1567 intsa |= IPSEC_SA_OFFLOAD_FALLBACK_FLAG;
1568 result_sa = (void *)intsa;
1570 sa_arr[i] = result_sa;
1575 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[],
1576 void *sa[], uint16_t nb_pkts)
1580 for (i = 0; i < nb_pkts; i++)
1581 sa[i] = &sa_ctx->sa[sa_idx[i]];
1585 * Select HW offloads to be used.
1588 sa_check_offloads(uint16_t port_id, uint64_t *rx_offloads,
1589 uint64_t *tx_offloads)
1591 struct ipsec_sa *rule;
1593 enum rte_security_session_action_type rule_type;
1598 /* Check for inbound rules that use offloads and use this port */
1599 for (idx_sa = 0; idx_sa < nb_sa_in; idx_sa++) {
1600 rule = &sa_in[idx_sa];
1601 rule_type = ipsec_get_action_type(rule);
1602 if ((rule_type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO ||
1604 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL)
1605 && rule->portid == port_id)
1606 *rx_offloads |= DEV_RX_OFFLOAD_SECURITY;
1609 /* Check for outbound rules that use offloads and use this port */
1610 for (idx_sa = 0; idx_sa < nb_sa_out; idx_sa++) {
1611 rule = &sa_out[idx_sa];
1612 rule_type = ipsec_get_action_type(rule);
1613 if ((rule_type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO ||
1615 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL)
1616 && rule->portid == port_id)
1617 *tx_offloads |= DEV_TX_OFFLOAD_SECURITY;
1625 qsort(sa_in, nb_sa_in, sizeof(struct ipsec_sa), sa_cmp);
1626 qsort(sa_out, nb_sa_out, sizeof(struct ipsec_sa), sa_cmp);