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-256-cbc",
81 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
87 .keyword = "aes-128-ctr",
88 .algo = RTE_CRYPTO_CIPHER_AES_CTR,
94 .keyword = "3des-cbc",
95 .algo = RTE_CRYPTO_CIPHER_3DES_CBC,
102 const struct supported_auth_algo auth_algos[] = {
105 .algo = RTE_CRYPTO_AUTH_NULL,
111 .keyword = "sha1-hmac",
112 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
117 .keyword = "sha256-hmac",
118 .algo = RTE_CRYPTO_AUTH_SHA256_HMAC,
124 const struct supported_aead_algo aead_algos[] = {
126 .keyword = "aes-128-gcm",
127 .algo = RTE_CRYPTO_AEAD_AES_GCM,
136 #define SA_INIT_NB 128
138 static struct ipsec_sa *sa_out;
139 static uint32_t sa_out_sz;
140 static uint32_t nb_sa_out;
141 static struct ipsec_sa_cnt sa_out_cnt;
143 static struct ipsec_sa *sa_in;
144 static uint32_t sa_in_sz;
145 static uint32_t nb_sa_in;
146 static struct ipsec_sa_cnt sa_in_cnt;
148 static const struct supported_cipher_algo *
149 find_match_cipher_algo(const char *cipher_keyword)
153 for (i = 0; i < RTE_DIM(cipher_algos); i++) {
154 const struct supported_cipher_algo *algo =
157 if (strcmp(cipher_keyword, algo->keyword) == 0)
164 static const struct supported_auth_algo *
165 find_match_auth_algo(const char *auth_keyword)
169 for (i = 0; i < RTE_DIM(auth_algos); i++) {
170 const struct supported_auth_algo *algo =
173 if (strcmp(auth_keyword, algo->keyword) == 0)
180 static const struct supported_aead_algo *
181 find_match_aead_algo(const char *aead_keyword)
185 for (i = 0; i < RTE_DIM(aead_algos); i++) {
186 const struct supported_aead_algo *algo =
189 if (strcmp(aead_keyword, algo->keyword) == 0)
197 * parse x:x:x:x.... hex number key string into uint8_t *key
199 * > 0: number of bytes parsed
203 parse_key_string(const char *key_str, uint8_t *key)
205 const char *pt_start = key_str, *pt_end = key_str;
206 uint32_t nb_bytes = 0;
208 while (pt_end != NULL) {
209 char sub_str[3] = {0};
211 pt_end = strchr(pt_start, ':');
213 if (pt_end == NULL) {
214 if (strlen(pt_start) > 2)
216 strncpy(sub_str, pt_start, 2);
218 if (pt_end - pt_start > 2)
221 strncpy(sub_str, pt_start, pt_end - pt_start);
222 pt_start = pt_end + 1;
225 key[nb_bytes++] = strtol(sub_str, NULL, 16);
232 extend_sa_arr(struct ipsec_sa **sa_tbl, uint32_t cur_cnt, uint32_t *cur_sz)
234 if (*sa_tbl == NULL) {
235 *sa_tbl = calloc(SA_INIT_NB, sizeof(struct ipsec_sa));
238 *cur_sz = SA_INIT_NB;
242 if (cur_cnt >= *cur_sz) {
243 *sa_tbl = realloc(*sa_tbl,
244 *cur_sz * sizeof(struct ipsec_sa) * 2);
247 /* clean reallocated extra space */
248 memset(&(*sa_tbl)[*cur_sz], 0,
249 *cur_sz * sizeof(struct ipsec_sa));
257 parse_sa_tokens(char **tokens, uint32_t n_tokens,
258 struct parse_status *status)
260 struct ipsec_sa *rule = NULL;
261 struct rte_ipsec_session *ips;
262 uint32_t ti; /*token index*/
263 uint32_t *ri /*rule index*/;
264 struct ipsec_sa_cnt *sa_cnt;
265 uint32_t cipher_algo_p = 0;
266 uint32_t auth_algo_p = 0;
267 uint32_t aead_algo_p = 0;
272 uint32_t portid_p = 0;
273 uint32_t fallback_p = 0;
275 if (strcmp(tokens[0], "in") == 0) {
278 if (extend_sa_arr(&sa_in, nb_sa_in, &sa_in_sz) < 0)
281 rule->direction = RTE_SECURITY_IPSEC_SA_DIR_INGRESS;
284 sa_cnt = &sa_out_cnt;
285 if (extend_sa_arr(&sa_out, nb_sa_out, &sa_out_sz) < 0)
288 rule->direction = RTE_SECURITY_IPSEC_SA_DIR_EGRESS;
292 APP_CHECK_TOKEN_IS_NUM(tokens, 1, status);
293 if (status->status < 0)
295 if (atoi(tokens[1]) == INVALID_SPI)
297 rule->spi = atoi(tokens[1]);
298 ips = ipsec_get_primary_session(rule);
300 for (ti = 2; ti < n_tokens; ti++) {
301 if (strcmp(tokens[ti], "mode") == 0) {
302 APP_CHECK_PRESENCE(mode_p, tokens[ti], status);
303 if (status->status < 0)
306 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
307 if (status->status < 0)
310 if (strcmp(tokens[ti], "ipv4-tunnel") == 0) {
312 rule->flags = IP4_TUNNEL;
313 } else if (strcmp(tokens[ti], "ipv6-tunnel") == 0) {
315 rule->flags = IP6_TUNNEL;
316 } else if (strcmp(tokens[ti], "transport") == 0) {
319 rule->flags = TRANSPORT;
321 APP_CHECK(0, status, "unrecognized "
322 "input \"%s\"", tokens[ti]);
330 if (strcmp(tokens[ti], "cipher_algo") == 0) {
331 const struct supported_cipher_algo *algo;
334 APP_CHECK_PRESENCE(cipher_algo_p, tokens[ti],
336 if (status->status < 0)
339 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
340 if (status->status < 0)
343 algo = find_match_cipher_algo(tokens[ti]);
345 APP_CHECK(algo != NULL, status, "unrecognized "
346 "input \"%s\"", tokens[ti]);
348 if (status->status < 0)
351 rule->cipher_algo = algo->algo;
352 rule->block_size = algo->block_size;
353 rule->iv_len = algo->iv_len;
354 rule->cipher_key_len = algo->key_len;
356 /* for NULL algorithm, no cipher key required */
357 if (rule->cipher_algo == RTE_CRYPTO_CIPHER_NULL) {
362 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
363 if (status->status < 0)
366 APP_CHECK(strcmp(tokens[ti], "cipher_key") == 0,
367 status, "unrecognized input \"%s\", "
368 "expect \"cipher_key\"", tokens[ti]);
369 if (status->status < 0)
372 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
373 if (status->status < 0)
376 key_len = parse_key_string(tokens[ti],
378 APP_CHECK(key_len == rule->cipher_key_len, status,
379 "unrecognized input \"%s\"", tokens[ti]);
380 if (status->status < 0)
383 if (algo->algo == RTE_CRYPTO_CIPHER_AES_CBC ||
384 algo->algo == RTE_CRYPTO_CIPHER_3DES_CBC)
385 rule->salt = (uint32_t)rte_rand();
387 if (algo->algo == RTE_CRYPTO_CIPHER_AES_CTR) {
389 rule->cipher_key_len = key_len;
391 &rule->cipher_key[key_len], 4);
398 if (strcmp(tokens[ti], "auth_algo") == 0) {
399 const struct supported_auth_algo *algo;
402 APP_CHECK_PRESENCE(auth_algo_p, tokens[ti],
404 if (status->status < 0)
407 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
408 if (status->status < 0)
411 algo = find_match_auth_algo(tokens[ti]);
412 APP_CHECK(algo != NULL, status, "unrecognized "
413 "input \"%s\"", tokens[ti]);
415 if (status->status < 0)
418 rule->auth_algo = algo->algo;
419 rule->auth_key_len = algo->key_len;
420 rule->digest_len = algo->digest_len;
422 /* NULL algorithm and combined algos do not
425 if (algo->key_not_req) {
430 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
431 if (status->status < 0)
434 APP_CHECK(strcmp(tokens[ti], "auth_key") == 0,
435 status, "unrecognized input \"%s\", "
436 "expect \"auth_key\"", tokens[ti]);
437 if (status->status < 0)
440 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
441 if (status->status < 0)
444 key_len = parse_key_string(tokens[ti],
446 APP_CHECK(key_len == rule->auth_key_len, status,
447 "unrecognized input \"%s\"", tokens[ti]);
448 if (status->status < 0)
455 if (strcmp(tokens[ti], "aead_algo") == 0) {
456 const struct supported_aead_algo *algo;
459 APP_CHECK_PRESENCE(aead_algo_p, tokens[ti],
461 if (status->status < 0)
464 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
465 if (status->status < 0)
468 algo = find_match_aead_algo(tokens[ti]);
470 APP_CHECK(algo != NULL, status, "unrecognized "
471 "input \"%s\"", tokens[ti]);
473 if (status->status < 0)
476 rule->aead_algo = algo->algo;
477 rule->cipher_key_len = algo->key_len;
478 rule->digest_len = algo->digest_len;
479 rule->aad_len = algo->aad_len;
480 rule->block_size = algo->block_size;
481 rule->iv_len = algo->iv_len;
483 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
484 if (status->status < 0)
487 APP_CHECK(strcmp(tokens[ti], "aead_key") == 0,
488 status, "unrecognized input \"%s\", "
489 "expect \"aead_key\"", tokens[ti]);
490 if (status->status < 0)
493 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
494 if (status->status < 0)
497 key_len = parse_key_string(tokens[ti],
499 APP_CHECK(key_len == rule->cipher_key_len, status,
500 "unrecognized input \"%s\"", tokens[ti]);
501 if (status->status < 0)
505 rule->cipher_key_len = key_len;
507 &rule->cipher_key[key_len], 4);
513 if (strcmp(tokens[ti], "src") == 0) {
514 APP_CHECK_PRESENCE(src_p, tokens[ti], status);
515 if (status->status < 0)
518 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
519 if (status->status < 0)
522 if (IS_IP4_TUNNEL(rule->flags)) {
525 APP_CHECK(parse_ipv4_addr(tokens[ti],
526 &ip, NULL) == 0, status,
527 "unrecognized input \"%s\", "
528 "expect valid ipv4 addr",
530 if (status->status < 0)
532 rule->src.ip.ip4 = rte_bswap32(
533 (uint32_t)ip.s_addr);
534 } else if (IS_IP6_TUNNEL(rule->flags)) {
537 APP_CHECK(parse_ipv6_addr(tokens[ti], &ip,
539 "unrecognized input \"%s\", "
540 "expect valid ipv6 addr",
542 if (status->status < 0)
544 memcpy(rule->src.ip.ip6.ip6_b,
546 } else if (IS_TRANSPORT(rule->flags)) {
547 APP_CHECK(0, status, "unrecognized input "
548 "\"%s\"", tokens[ti]);
556 if (strcmp(tokens[ti], "dst") == 0) {
557 APP_CHECK_PRESENCE(dst_p, tokens[ti], status);
558 if (status->status < 0)
561 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
562 if (status->status < 0)
565 if (IS_IP4_TUNNEL(rule->flags)) {
568 APP_CHECK(parse_ipv4_addr(tokens[ti],
569 &ip, NULL) == 0, status,
570 "unrecognized input \"%s\", "
571 "expect valid ipv4 addr",
573 if (status->status < 0)
575 rule->dst.ip.ip4 = rte_bswap32(
576 (uint32_t)ip.s_addr);
577 } else if (IS_IP6_TUNNEL(rule->flags)) {
580 APP_CHECK(parse_ipv6_addr(tokens[ti], &ip,
582 "unrecognized input \"%s\", "
583 "expect valid ipv6 addr",
585 if (status->status < 0)
587 memcpy(rule->dst.ip.ip6.ip6_b, ip.s6_addr, 16);
588 } else if (IS_TRANSPORT(rule->flags)) {
589 APP_CHECK(0, status, "unrecognized "
590 "input \"%s\"", tokens[ti]);
598 if (strcmp(tokens[ti], "type") == 0) {
599 APP_CHECK_PRESENCE(type_p, tokens[ti], status);
600 if (status->status < 0)
603 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
604 if (status->status < 0)
607 if (strcmp(tokens[ti], "inline-crypto-offload") == 0)
609 RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO;
610 else if (strcmp(tokens[ti],
611 "inline-protocol-offload") == 0)
613 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL;
614 else if (strcmp(tokens[ti],
615 "lookaside-protocol-offload") == 0)
617 RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL;
618 else if (strcmp(tokens[ti], "no-offload") == 0)
619 ips->type = RTE_SECURITY_ACTION_TYPE_NONE;
620 else if (strcmp(tokens[ti], "cpu-crypto") == 0)
621 ips->type = RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO;
623 APP_CHECK(0, status, "Invalid input \"%s\"",
632 if (strcmp(tokens[ti], "port_id") == 0) {
633 APP_CHECK_PRESENCE(portid_p, tokens[ti], status);
634 if (status->status < 0)
636 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
637 if (status->status < 0)
639 rule->portid = atoi(tokens[ti]);
640 if (status->status < 0)
646 if (strcmp(tokens[ti], "fallback") == 0) {
647 struct rte_ipsec_session *fb;
649 APP_CHECK(app_sa_prm.enable, status, "Fallback session "
650 "not allowed for legacy mode.");
651 if (status->status < 0)
653 APP_CHECK(ips->type ==
654 RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO, status,
655 "Fallback session allowed if primary session "
656 "is of type inline-crypto-offload only.");
657 if (status->status < 0)
659 APP_CHECK(rule->direction ==
660 RTE_SECURITY_IPSEC_SA_DIR_INGRESS, status,
661 "Fallback session not allowed for egress "
663 if (status->status < 0)
665 APP_CHECK_PRESENCE(fallback_p, tokens[ti], status);
666 if (status->status < 0)
668 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
669 if (status->status < 0)
671 fb = ipsec_get_fallback_session(rule);
672 if (strcmp(tokens[ti], "lookaside-none") == 0) {
673 fb->type = RTE_SECURITY_ACTION_TYPE_NONE;
675 APP_CHECK(0, status, "unrecognized fallback "
676 "type %s.", tokens[ti]);
680 rule->fallback_sessions = 1;
685 /* unrecognizeable input */
686 APP_CHECK(0, status, "unrecognized input \"%s\"",
692 APP_CHECK(cipher_algo_p == 0, status,
693 "AEAD used, no need for cipher options");
694 if (status->status < 0)
697 APP_CHECK(auth_algo_p == 0, status,
698 "AEAD used, no need for auth options");
699 if (status->status < 0)
702 APP_CHECK(cipher_algo_p == 1, status, "missing cipher or AEAD options");
703 if (status->status < 0)
706 APP_CHECK(auth_algo_p == 1, status, "missing auth or AEAD options");
707 if (status->status < 0)
711 APP_CHECK(mode_p == 1, status, "missing mode option");
712 if (status->status < 0)
715 if ((ips->type != RTE_SECURITY_ACTION_TYPE_NONE && ips->type !=
716 RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO) && (portid_p == 0))
717 printf("Missing portid option, falling back to non-offload\n");
719 if (!type_p || (!portid_p && ips->type !=
720 RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO)) {
721 ips->type = RTE_SECURITY_ACTION_TYPE_NONE;
729 print_one_sa_rule(const struct ipsec_sa *sa, int inbound)
733 const struct rte_ipsec_session *ips;
734 const struct rte_ipsec_session *fallback_ips;
736 printf("\tspi_%s(%3u):", inbound?"in":"out", sa->spi);
738 for (i = 0; i < RTE_DIM(cipher_algos); i++) {
739 if (cipher_algos[i].algo == sa->cipher_algo &&
740 cipher_algos[i].key_len == sa->cipher_key_len) {
741 printf("%s ", cipher_algos[i].keyword);
746 for (i = 0; i < RTE_DIM(auth_algos); i++) {
747 if (auth_algos[i].algo == sa->auth_algo) {
748 printf("%s ", auth_algos[i].keyword);
753 for (i = 0; i < RTE_DIM(aead_algos); i++) {
754 if (aead_algos[i].algo == sa->aead_algo) {
755 printf("%s ", aead_algos[i].keyword);
762 switch (WITHOUT_TRANSPORT_VERSION(sa->flags)) {
764 printf("IP4Tunnel ");
765 uint32_t_to_char(sa->src.ip.ip4, &a, &b, &c, &d);
766 printf("%hhu.%hhu.%hhu.%hhu ", d, c, b, a);
767 uint32_t_to_char(sa->dst.ip.ip4, &a, &b, &c, &d);
768 printf("%hhu.%hhu.%hhu.%hhu", d, c, b, a);
771 printf("IP6Tunnel ");
772 for (i = 0; i < 16; i++) {
773 if (i % 2 && i != 15)
774 printf("%.2x:", sa->src.ip.ip6.ip6_b[i]);
776 printf("%.2x", sa->src.ip.ip6.ip6_b[i]);
779 for (i = 0; i < 16; i++) {
780 if (i % 2 && i != 15)
781 printf("%.2x:", sa->dst.ip.ip6.ip6_b[i]);
783 printf("%.2x", sa->dst.ip.ip6.ip6_b[i]);
787 printf("Transport ");
791 ips = &sa->sessions[IPSEC_SESSION_PRIMARY];
794 case RTE_SECURITY_ACTION_TYPE_NONE:
795 printf("no-offload ");
797 case RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO:
798 printf("inline-crypto-offload ");
800 case RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL:
801 printf("inline-protocol-offload ");
803 case RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL:
804 printf("lookaside-protocol-offload ");
806 case RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO:
807 printf("cpu-crypto-accelerated");
811 fallback_ips = &sa->sessions[IPSEC_SESSION_FALLBACK];
812 if (fallback_ips != NULL && sa->fallback_sessions > 0) {
813 printf("inline fallback: ");
814 switch (fallback_ips->type) {
815 case RTE_SECURITY_ACTION_TYPE_NONE:
816 printf("lookaside-none");
818 case RTE_SECURITY_ACTION_TYPE_CPU_CRYPTO:
819 printf("cpu-crypto-accelerated");
830 struct rte_crypto_sym_xform a;
831 struct rte_crypto_sym_xform b;
835 void *satbl; /* pointer to array of rte_ipsec_sa objects*/
836 struct ipsec_sad sad;
839 struct ipsec_sa sa[];
842 static struct sa_ctx *
843 sa_create(const char *name, int32_t socket_id, uint32_t nb_sa)
846 struct sa_ctx *sa_ctx;
848 const struct rte_memzone *mz;
850 snprintf(s, sizeof(s), "%s_%u", name, socket_id);
852 /* Create SA context */
853 printf("Creating SA context with %u maximum entries on socket %d\n",
856 mz_size = sizeof(struct ipsec_xf) * nb_sa;
857 mz = rte_memzone_reserve(s, mz_size, socket_id,
858 RTE_MEMZONE_1GB | RTE_MEMZONE_SIZE_HINT_ONLY);
860 printf("Failed to allocate SA XFORM memory\n");
865 sa_ctx = rte_zmalloc(NULL, sizeof(struct sa_ctx) +
866 sizeof(struct ipsec_sa) * nb_sa, RTE_CACHE_LINE_SIZE);
868 if (sa_ctx == NULL) {
869 printf("Failed to allocate SA CTX memory\n");
871 rte_memzone_free(mz);
875 sa_ctx->xf = (struct ipsec_xf *)mz->addr;
876 sa_ctx->nb_sa = nb_sa;
882 check_eth_dev_caps(uint16_t portid, uint32_t inbound)
884 struct rte_eth_dev_info dev_info;
887 retval = rte_eth_dev_info_get(portid, &dev_info);
890 "Error during getting device (port %u) info: %s\n",
891 portid, strerror(-retval));
897 if ((dev_info.rx_offload_capa &
898 DEV_RX_OFFLOAD_SECURITY) == 0) {
899 RTE_LOG(WARNING, PORT,
900 "hardware RX IPSec offload is not supported\n");
904 } else { /* outbound */
905 if ((dev_info.tx_offload_capa &
906 DEV_TX_OFFLOAD_SECURITY) == 0) {
907 RTE_LOG(WARNING, PORT,
908 "hardware TX IPSec offload is not supported\n");
916 * Helper function, tries to determine next_proto for SPI
917 * by searching though SP rules.
920 get_spi_proto(uint32_t spi, enum rte_security_ipsec_sa_direction dir,
921 struct ip_addr ip_addr[2], uint32_t mask[2])
925 rc4 = sp4_spi_present(spi, dir == RTE_SECURITY_IPSEC_SA_DIR_INGRESS,
927 rc6 = sp6_spi_present(spi, dir == RTE_SECURITY_IPSEC_SA_DIR_INGRESS,
933 "%s: SPI %u used simultaeously by "
934 "IPv4(%d) and IPv6 (%d) SP rules\n",
935 __func__, spi, rc4, rc6);
939 } else if (rc6 < 0) {
941 "%s: SPI %u is not used by any SP rule\n",
949 * Helper function for getting source and destination IP addresses
950 * from SP. Needed for inline crypto transport mode, as addresses are not
951 * provided in config file for that mode. It checks if SP for current SA exists,
952 * and based on what type of protocol is returned, it stores appropriate
953 * addresses got from SP into SA.
956 sa_add_address_inline_crypto(struct ipsec_sa *sa)
959 struct ip_addr ip_addr[2];
962 protocol = get_spi_proto(sa->spi, sa->direction, ip_addr, mask);
965 else if (protocol == IPPROTO_IPIP) {
966 sa->flags |= IP4_TRANSPORT;
967 if (mask[0] == IP4_FULL_MASK &&
968 mask[1] == IP4_FULL_MASK &&
969 ip_addr[0].ip.ip4 != 0 &&
970 ip_addr[1].ip.ip4 != 0) {
972 sa->src.ip.ip4 = ip_addr[0].ip.ip4;
973 sa->dst.ip.ip4 = ip_addr[1].ip.ip4;
976 "%s: No valid address or mask entry in"
977 " IPv4 SP rule for SPI %u\n",
981 } else if (protocol == IPPROTO_IPV6) {
982 sa->flags |= IP6_TRANSPORT;
983 if (mask[0] == IP6_FULL_MASK &&
984 mask[1] == IP6_FULL_MASK &&
985 (ip_addr[0].ip.ip6.ip6[0] != 0 ||
986 ip_addr[0].ip.ip6.ip6[1] != 0) &&
987 (ip_addr[1].ip.ip6.ip6[0] != 0 ||
988 ip_addr[1].ip.ip6.ip6[1] != 0)) {
990 sa->src.ip.ip6 = ip_addr[0].ip.ip6;
991 sa->dst.ip.ip6 = ip_addr[1].ip.ip6;
994 "%s: No valid address or mask entry in"
995 " IPv6 SP rule for SPI %u\n",
1004 sa_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
1005 uint32_t nb_entries, uint32_t inbound,
1006 struct socket_ctx *skt_ctx)
1008 struct ipsec_sa *sa;
1010 uint16_t iv_length, aad_length;
1013 struct rte_ipsec_session *ips;
1015 /* for ESN upper 32 bits of SQN also need to be part of AAD */
1016 aad_length = (app_sa_prm.enable_esn != 0) ? sizeof(uint32_t) : 0;
1018 for (i = 0; i < nb_entries; i++) {
1020 sa = &sa_ctx->sa[idx];
1022 printf("Index %u already in use by SPI %u\n",
1029 rc = ipsec_sad_add(&sa_ctx->sad, sa);
1035 ips = ipsec_get_primary_session(sa);
1037 if (ips->type == RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL ||
1038 ips->type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO) {
1039 if (check_eth_dev_caps(sa->portid, inbound))
1043 switch (WITHOUT_TRANSPORT_VERSION(sa->flags)) {
1045 sa->src.ip.ip4 = rte_cpu_to_be_32(sa->src.ip.ip4);
1046 sa->dst.ip.ip4 = rte_cpu_to_be_32(sa->dst.ip.ip4);
1050 RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO) {
1052 sa_add_address_inline_crypto(sa);
1053 if (inline_status < 0)
1054 return inline_status;
1059 if (sa->aead_algo == RTE_CRYPTO_AEAD_AES_GCM) {
1060 struct rte_ipsec_session *ips;
1063 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_AEAD;
1064 sa_ctx->xf[idx].a.aead.algo = sa->aead_algo;
1065 sa_ctx->xf[idx].a.aead.key.data = sa->cipher_key;
1066 sa_ctx->xf[idx].a.aead.key.length =
1068 sa_ctx->xf[idx].a.aead.op = (inbound == 1) ?
1069 RTE_CRYPTO_AEAD_OP_DECRYPT :
1070 RTE_CRYPTO_AEAD_OP_ENCRYPT;
1071 sa_ctx->xf[idx].a.next = NULL;
1072 sa_ctx->xf[idx].a.aead.iv.offset = IV_OFFSET;
1073 sa_ctx->xf[idx].a.aead.iv.length = iv_length;
1074 sa_ctx->xf[idx].a.aead.aad_length =
1075 sa->aad_len + aad_length;
1076 sa_ctx->xf[idx].a.aead.digest_length =
1079 sa->xforms = &sa_ctx->xf[idx].a;
1081 ips = ipsec_get_primary_session(sa);
1083 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL ||
1085 RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO) {
1086 rc = create_inline_session(skt_ctx, sa, ips);
1088 RTE_LOG(ERR, IPSEC_ESP,
1089 "create_inline_session() failed\n");
1094 switch (sa->cipher_algo) {
1095 case RTE_CRYPTO_CIPHER_NULL:
1096 case RTE_CRYPTO_CIPHER_3DES_CBC:
1097 case RTE_CRYPTO_CIPHER_AES_CBC:
1098 iv_length = sa->iv_len;
1100 case RTE_CRYPTO_CIPHER_AES_CTR:
1104 RTE_LOG(ERR, IPSEC_ESP,
1105 "unsupported cipher algorithm %u\n",
1111 sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
1112 sa_ctx->xf[idx].b.cipher.algo = sa->cipher_algo;
1113 sa_ctx->xf[idx].b.cipher.key.data = sa->cipher_key;
1114 sa_ctx->xf[idx].b.cipher.key.length =
1116 sa_ctx->xf[idx].b.cipher.op =
1117 RTE_CRYPTO_CIPHER_OP_DECRYPT;
1118 sa_ctx->xf[idx].b.next = NULL;
1119 sa_ctx->xf[idx].b.cipher.iv.offset = IV_OFFSET;
1120 sa_ctx->xf[idx].b.cipher.iv.length = iv_length;
1122 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_AUTH;
1123 sa_ctx->xf[idx].a.auth.algo = sa->auth_algo;
1124 sa_ctx->xf[idx].a.auth.key.data = sa->auth_key;
1125 sa_ctx->xf[idx].a.auth.key.length =
1127 sa_ctx->xf[idx].a.auth.digest_length =
1129 sa_ctx->xf[idx].a.auth.op =
1130 RTE_CRYPTO_AUTH_OP_VERIFY;
1131 } else { /* outbound */
1132 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
1133 sa_ctx->xf[idx].a.cipher.algo = sa->cipher_algo;
1134 sa_ctx->xf[idx].a.cipher.key.data = sa->cipher_key;
1135 sa_ctx->xf[idx].a.cipher.key.length =
1137 sa_ctx->xf[idx].a.cipher.op =
1138 RTE_CRYPTO_CIPHER_OP_ENCRYPT;
1139 sa_ctx->xf[idx].a.next = NULL;
1140 sa_ctx->xf[idx].a.cipher.iv.offset = IV_OFFSET;
1141 sa_ctx->xf[idx].a.cipher.iv.length = iv_length;
1143 sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_AUTH;
1144 sa_ctx->xf[idx].b.auth.algo = sa->auth_algo;
1145 sa_ctx->xf[idx].b.auth.key.data = sa->auth_key;
1146 sa_ctx->xf[idx].b.auth.key.length =
1148 sa_ctx->xf[idx].b.auth.digest_length =
1150 sa_ctx->xf[idx].b.auth.op =
1151 RTE_CRYPTO_AUTH_OP_GENERATE;
1154 sa_ctx->xf[idx].a.next = &sa_ctx->xf[idx].b;
1155 sa_ctx->xf[idx].b.next = NULL;
1156 sa->xforms = &sa_ctx->xf[idx].a;
1159 print_one_sa_rule(sa, inbound);
1166 sa_out_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
1167 uint32_t nb_entries, struct socket_ctx *skt_ctx)
1169 return sa_add_rules(sa_ctx, entries, nb_entries, 0, skt_ctx);
1173 sa_in_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
1174 uint32_t nb_entries, struct socket_ctx *skt_ctx)
1176 return sa_add_rules(sa_ctx, entries, nb_entries, 1, skt_ctx);
1180 * helper function, fills parameters that are identical for all SAs
1183 fill_ipsec_app_sa_prm(struct rte_ipsec_sa_prm *prm,
1184 const struct app_sa_prm *app_prm)
1186 memset(prm, 0, sizeof(*prm));
1188 prm->flags = app_prm->flags;
1189 prm->ipsec_xform.options.esn = app_prm->enable_esn;
1190 prm->ipsec_xform.replay_win_sz = app_prm->window_size;
1194 fill_ipsec_sa_prm(struct rte_ipsec_sa_prm *prm, const struct ipsec_sa *ss,
1195 const struct rte_ipv4_hdr *v4, struct rte_ipv6_hdr *v6)
1200 * Try to get SPI next proto by searching that SPI in SPD.
1201 * probably not the optimal way, but there seems nothing
1204 rc = get_spi_proto(ss->spi, ss->direction, NULL, NULL);
1208 fill_ipsec_app_sa_prm(prm, &app_sa_prm);
1209 prm->userdata = (uintptr_t)ss;
1211 /* setup ipsec xform */
1212 prm->ipsec_xform.spi = ss->spi;
1213 prm->ipsec_xform.salt = ss->salt;
1214 prm->ipsec_xform.direction = ss->direction;
1215 prm->ipsec_xform.proto = RTE_SECURITY_IPSEC_SA_PROTO_ESP;
1216 prm->ipsec_xform.mode = (IS_TRANSPORT(ss->flags)) ?
1217 RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT :
1218 RTE_SECURITY_IPSEC_SA_MODE_TUNNEL;
1219 prm->ipsec_xform.options.ecn = 1;
1220 prm->ipsec_xform.options.copy_dscp = 1;
1222 if (IS_IP4_TUNNEL(ss->flags)) {
1223 prm->ipsec_xform.tunnel.type = RTE_SECURITY_IPSEC_TUNNEL_IPV4;
1224 prm->tun.hdr_len = sizeof(*v4);
1225 prm->tun.next_proto = rc;
1227 } else if (IS_IP6_TUNNEL(ss->flags)) {
1228 prm->ipsec_xform.tunnel.type = RTE_SECURITY_IPSEC_TUNNEL_IPV6;
1229 prm->tun.hdr_len = sizeof(*v6);
1230 prm->tun.next_proto = rc;
1233 /* transport mode */
1234 prm->trs.proto = rc;
1237 /* setup crypto section */
1238 prm->crypto_xform = ss->xforms;
1243 fill_ipsec_session(struct rte_ipsec_session *ss, struct rte_ipsec_sa *sa)
1249 if (ss->type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO ||
1250 ss->type == RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL) {
1251 if (ss->security.ses != NULL) {
1252 rc = rte_ipsec_session_prepare(ss);
1254 memset(ss, 0, sizeof(*ss));
1262 * Initialise related rte_ipsec_sa object.
1265 ipsec_sa_init(struct ipsec_sa *lsa, struct rte_ipsec_sa *sa, uint32_t sa_size)
1268 struct rte_ipsec_sa_prm prm;
1269 struct rte_ipsec_session *ips;
1270 struct rte_ipv4_hdr v4 = {
1271 .version_ihl = IPVERSION << 4 |
1272 sizeof(v4) / RTE_IPV4_IHL_MULTIPLIER,
1273 .time_to_live = IPDEFTTL,
1274 .next_proto_id = IPPROTO_ESP,
1275 .src_addr = lsa->src.ip.ip4,
1276 .dst_addr = lsa->dst.ip.ip4,
1278 struct rte_ipv6_hdr v6 = {
1279 .vtc_flow = htonl(IP6_VERSION << 28),
1280 .proto = IPPROTO_ESP,
1283 if (IS_IP6_TUNNEL(lsa->flags)) {
1284 memcpy(v6.src_addr, lsa->src.ip.ip6.ip6_b, sizeof(v6.src_addr));
1285 memcpy(v6.dst_addr, lsa->dst.ip.ip6.ip6_b, sizeof(v6.dst_addr));
1288 rc = fill_ipsec_sa_prm(&prm, lsa, &v4, &v6);
1290 rc = rte_ipsec_sa_init(sa, &prm, sa_size);
1294 /* init primary processing session */
1295 ips = ipsec_get_primary_session(lsa);
1296 rc = fill_ipsec_session(ips, sa);
1300 /* init inline fallback processing session */
1301 if (lsa->fallback_sessions == 1)
1302 rc = fill_ipsec_session(ipsec_get_fallback_session(lsa), sa);
1308 * Allocate space and init rte_ipsec_sa strcutures,
1312 ipsec_satbl_init(struct sa_ctx *ctx, uint32_t nb_ent, int32_t socket)
1317 struct rte_ipsec_sa *sa;
1318 struct ipsec_sa *lsa;
1319 struct rte_ipsec_sa_prm prm;
1321 /* determine SA size */
1323 fill_ipsec_sa_prm(&prm, ctx->sa + idx, NULL, NULL);
1324 sz = rte_ipsec_sa_size(&prm);
1326 RTE_LOG(ERR, IPSEC, "%s(%p, %u, %d): "
1327 "failed to determine SA size, error code: %d\n",
1328 __func__, ctx, nb_ent, socket, sz);
1334 ctx->satbl = rte_zmalloc_socket(NULL, tsz, RTE_CACHE_LINE_SIZE, socket);
1335 if (ctx->satbl == NULL) {
1337 "%s(%p, %u, %d): failed to allocate %zu bytes\n",
1338 __func__, ctx, nb_ent, socket, tsz);
1343 for (i = 0; i != nb_ent && rc == 0; i++) {
1347 sa = (struct rte_ipsec_sa *)((uintptr_t)ctx->satbl + sz * i);
1348 lsa = ctx->sa + idx;
1350 rc = ipsec_sa_init(lsa, sa, sz);
1357 sa_cmp(const void *p, const void *q)
1359 uint32_t spi1 = ((const struct ipsec_sa *)p)->spi;
1360 uint32_t spi2 = ((const struct ipsec_sa *)q)->spi;
1362 return (int)(spi1 - spi2);
1366 * Walk through all SA rules to find an SA with given SPI
1369 sa_spi_present(struct sa_ctx *sa_ctx, uint32_t spi, int inbound)
1372 struct ipsec_sa *sa;
1373 struct ipsec_sa tmpl;
1374 const struct ipsec_sa *sar;
1384 sa = bsearch(&tmpl, sar, num, sizeof(struct ipsec_sa), sa_cmp);
1386 return RTE_PTR_DIFF(sa, sar) / sizeof(struct ipsec_sa);
1392 sa_init(struct socket_ctx *ctx, int32_t socket_id)
1398 rte_exit(EXIT_FAILURE, "NULL context.\n");
1400 if (ctx->sa_in != NULL)
1401 rte_exit(EXIT_FAILURE, "Inbound SA DB for socket %u already "
1402 "initialized\n", socket_id);
1404 if (ctx->sa_out != NULL)
1405 rte_exit(EXIT_FAILURE, "Outbound SA DB for socket %u already "
1406 "initialized\n", socket_id);
1410 ctx->sa_in = sa_create(name, socket_id, nb_sa_in);
1411 if (ctx->sa_in == NULL)
1412 rte_exit(EXIT_FAILURE, "Error [%d] creating SA "
1413 "context %s in socket %d\n", rte_errno,
1416 rc = ipsec_sad_create(name, &ctx->sa_in->sad, socket_id,
1419 rte_exit(EXIT_FAILURE, "failed to init SAD\n");
1421 sa_in_add_rules(ctx->sa_in, sa_in, nb_sa_in, ctx);
1423 if (app_sa_prm.enable != 0) {
1424 rc = ipsec_satbl_init(ctx->sa_in, nb_sa_in,
1427 rte_exit(EXIT_FAILURE,
1428 "failed to init inbound SAs\n");
1431 RTE_LOG(WARNING, IPSEC, "No SA Inbound rule specified\n");
1433 if (nb_sa_out > 0) {
1435 ctx->sa_out = sa_create(name, socket_id, nb_sa_out);
1436 if (ctx->sa_out == NULL)
1437 rte_exit(EXIT_FAILURE, "Error [%d] creating SA "
1438 "context %s in socket %d\n", rte_errno,
1441 sa_out_add_rules(ctx->sa_out, sa_out, nb_sa_out, ctx);
1443 if (app_sa_prm.enable != 0) {
1444 rc = ipsec_satbl_init(ctx->sa_out, nb_sa_out,
1447 rte_exit(EXIT_FAILURE,
1448 "failed to init outbound SAs\n");
1451 RTE_LOG(WARNING, IPSEC, "No SA Outbound rule "
1456 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx)
1458 struct ipsec_mbuf_metadata *priv;
1459 struct ipsec_sa *sa;
1464 return (sa_ctx->sa[sa_idx].spi == sa->spi);
1466 RTE_LOG(ERR, IPSEC, "SA not saved in private data\n");
1471 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[],
1472 void *sa_arr[], uint16_t nb_pkts)
1476 struct ipsec_sa *sa;
1478 sad_lookup(&sa_ctx->sad, pkts, sa_arr, nb_pkts);
1481 * Mark need for inline offload fallback on the LSB of SA pointer.
1482 * Thanks to packet grouping mechanism which ipsec_process is using
1483 * packets marked for fallback processing will form separate group.
1485 * Because it is not safe to use SA pointer it is casted to generic
1486 * pointer to prevent from unintentional use. Use ipsec_mask_saptr
1487 * to get valid struct pointer.
1489 for (i = 0; i < nb_pkts; i++) {
1490 if (sa_arr[i] == NULL)
1493 result_sa = sa = sa_arr[i];
1494 if (MBUF_NO_SEC_OFFLOAD(pkts[i]) &&
1495 sa->fallback_sessions > 0) {
1496 uintptr_t intsa = (uintptr_t)sa;
1497 intsa |= IPSEC_SA_OFFLOAD_FALLBACK_FLAG;
1498 result_sa = (void *)intsa;
1500 sa_arr[i] = result_sa;
1505 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[],
1506 void *sa[], uint16_t nb_pkts)
1510 for (i = 0; i < nb_pkts; i++)
1511 sa[i] = &sa_ctx->sa[sa_idx[i]];
1515 * Select HW offloads to be used.
1518 sa_check_offloads(uint16_t port_id, uint64_t *rx_offloads,
1519 uint64_t *tx_offloads)
1521 struct ipsec_sa *rule;
1523 enum rte_security_session_action_type rule_type;
1528 /* Check for inbound rules that use offloads and use this port */
1529 for (idx_sa = 0; idx_sa < nb_sa_in; idx_sa++) {
1530 rule = &sa_in[idx_sa];
1531 rule_type = ipsec_get_action_type(rule);
1532 if ((rule_type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO ||
1534 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL)
1535 && rule->portid == port_id)
1536 *rx_offloads |= DEV_RX_OFFLOAD_SECURITY;
1539 /* Check for outbound rules that use offloads and use this port */
1540 for (idx_sa = 0; idx_sa < nb_sa_out; idx_sa++) {
1541 rule = &sa_out[idx_sa];
1542 rule_type = ipsec_get_action_type(rule);
1543 if ((rule_type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO ||
1545 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL)
1546 && rule->portid == port_id)
1547 *tx_offloads |= DEV_TX_OFFLOAD_SECURITY;
1555 qsort(sa_in, nb_sa_in, sizeof(struct ipsec_sa), sa_cmp);
1556 qsort(sa_out, nb_sa_out, sizeof(struct ipsec_sa), sa_cmp);