4 * Copyright(c) 2016 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 * Security Associations
37 #include <sys/types.h>
38 #include <netinet/in.h>
39 #include <netinet/ip.h>
40 #include <netinet/ip6.h>
42 #include <rte_memzone.h>
43 #include <rte_crypto.h>
44 #include <rte_cryptodev.h>
45 #include <rte_byteorder.h>
46 #include <rte_errno.h>
48 #include <rte_random.h>
54 struct supported_cipher_algo {
56 enum rte_crypto_cipher_algorithm algo;
62 struct supported_auth_algo {
64 enum rte_crypto_auth_algorithm algo;
71 const struct supported_cipher_algo cipher_algos[] = {
74 .algo = RTE_CRYPTO_CIPHER_NULL,
80 .keyword = "aes-128-cbc",
81 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
87 .keyword = "aes-128-gcm",
88 .algo = RTE_CRYPTO_CIPHER_AES_GCM,
94 .keyword = "aes-128-ctr",
95 .algo = RTE_CRYPTO_CIPHER_AES_CTR,
97 .block_size = 16, /* XXX AESNI MB limition, should be 4 */
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,
123 .keyword = "aes-128-gcm",
124 .algo = RTE_CRYPTO_AUTH_AES_GCM,
131 struct ipsec_sa sa_out[IPSEC_SA_MAX_ENTRIES];
134 struct ipsec_sa sa_in[IPSEC_SA_MAX_ENTRIES];
137 static const struct supported_cipher_algo *
138 find_match_cipher_algo(const char *cipher_keyword)
142 for (i = 0; i < RTE_DIM(cipher_algos); i++) {
143 const struct supported_cipher_algo *algo =
146 if (strcmp(cipher_keyword, algo->keyword) == 0)
153 static const struct supported_auth_algo *
154 find_match_auth_algo(const char *auth_keyword)
158 for (i = 0; i < RTE_DIM(auth_algos); i++) {
159 const struct supported_auth_algo *algo =
162 if (strcmp(auth_keyword, algo->keyword) == 0)
170 * parse x:x:x:x.... hex number key string into uint8_t *key
172 * > 0: number of bytes parsed
176 parse_key_string(const char *key_str, uint8_t *key)
178 const char *pt_start = key_str, *pt_end = key_str;
179 uint32_t nb_bytes = 0;
181 while (pt_end != NULL) {
182 char sub_str[3] = {0};
184 pt_end = strchr(pt_start, ':');
186 if (pt_end == NULL) {
187 if (strlen(pt_start) > 2)
189 strncpy(sub_str, pt_start, 2);
191 if (pt_end - pt_start > 2)
194 strncpy(sub_str, pt_start, pt_end - pt_start);
195 pt_start = pt_end + 1;
198 key[nb_bytes++] = strtol(sub_str, NULL, 16);
205 parse_sa_tokens(char **tokens, uint32_t n_tokens,
206 struct parse_status *status)
208 struct ipsec_sa *rule = NULL;
209 uint32_t ti; /*token index*/
210 uint32_t *ri /*rule index*/;
211 uint32_t cipher_algo_p = 0;
212 uint32_t auth_algo_p = 0;
217 if (strcmp(tokens[0], "in") == 0) {
220 APP_CHECK(*ri <= IPSEC_SA_MAX_ENTRIES - 1, status,
221 "too many sa rules, abort insertion\n");
222 if (status->status < 0)
229 APP_CHECK(*ri <= IPSEC_SA_MAX_ENTRIES - 1, status,
230 "too many sa rules, abort insertion\n");
231 if (status->status < 0)
238 APP_CHECK_TOKEN_IS_NUM(tokens, 1, status);
239 if (status->status < 0)
241 rule->spi = atoi(tokens[1]);
243 for (ti = 2; ti < n_tokens; ti++) {
244 if (strcmp(tokens[ti], "mode") == 0) {
245 APP_CHECK_PRESENCE(mode_p, tokens[ti], status);
246 if (status->status < 0)
249 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
250 if (status->status < 0)
253 if (strcmp(tokens[ti], "ipv4-tunnel") == 0)
254 rule->flags = IP4_TUNNEL;
255 else if (strcmp(tokens[ti], "ipv6-tunnel") == 0)
256 rule->flags = IP6_TUNNEL;
257 else if (strcmp(tokens[ti], "transport") == 0)
258 rule->flags = TRANSPORT;
260 APP_CHECK(0, status, "unrecognized "
261 "input \"%s\"", tokens[ti]);
269 if (strcmp(tokens[ti], "cipher_algo") == 0) {
270 const struct supported_cipher_algo *algo;
273 APP_CHECK_PRESENCE(cipher_algo_p, tokens[ti],
275 if (status->status < 0)
278 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
279 if (status->status < 0)
282 algo = find_match_cipher_algo(tokens[ti]);
284 APP_CHECK(algo != NULL, status, "unrecognized "
285 "input \"%s\"", tokens[ti]);
287 rule->cipher_algo = algo->algo;
288 rule->block_size = algo->block_size;
289 rule->iv_len = algo->iv_len;
290 rule->cipher_key_len = algo->key_len;
292 /* for NULL algorithm, no cipher key required */
293 if (rule->cipher_algo == RTE_CRYPTO_CIPHER_NULL) {
298 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
299 if (status->status < 0)
302 APP_CHECK(strcmp(tokens[ti], "cipher_key") == 0,
303 status, "unrecognized input \"%s\", "
304 "expect \"cipher_key\"", tokens[ti]);
305 if (status->status < 0)
308 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
309 if (status->status < 0)
312 key_len = parse_key_string(tokens[ti],
314 APP_CHECK(key_len == rule->cipher_key_len, status,
315 "unrecognized input \"%s\"", tokens[ti]);
316 if (status->status < 0)
319 if (algo->algo == RTE_CRYPTO_CIPHER_AES_CBC)
320 rule->salt = (uint32_t)rte_rand();
322 if ((algo->algo == RTE_CRYPTO_CIPHER_AES_CTR) ||
323 (algo->algo == RTE_CRYPTO_CIPHER_AES_GCM)) {
325 rule->cipher_key_len = key_len;
327 &rule->cipher_key[key_len], 4);
334 if (strcmp(tokens[ti], "auth_algo") == 0) {
335 const struct supported_auth_algo *algo;
338 APP_CHECK_PRESENCE(auth_algo_p, tokens[ti],
340 if (status->status < 0)
343 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
344 if (status->status < 0)
347 algo = find_match_auth_algo(tokens[ti]);
348 APP_CHECK(algo != NULL, status, "unrecognized "
349 "input \"%s\"", tokens[ti]);
351 rule->auth_algo = algo->algo;
352 rule->auth_key_len = algo->key_len;
353 rule->digest_len = algo->digest_len;
354 rule->aad_len = algo->key_len;
356 /* NULL algorithm and combined algos do not
359 if (algo->key_not_req) {
364 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
365 if (status->status < 0)
368 APP_CHECK(strcmp(tokens[ti], "auth_key") == 0,
369 status, "unrecognized input \"%s\", "
370 "expect \"auth_key\"", tokens[ti]);
371 if (status->status < 0)
374 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
375 if (status->status < 0)
378 key_len = parse_key_string(tokens[ti],
380 APP_CHECK(key_len == rule->auth_key_len, status,
381 "unrecognized input \"%s\"", tokens[ti]);
382 if (status->status < 0)
389 if (strcmp(tokens[ti], "src") == 0) {
390 APP_CHECK_PRESENCE(src_p, tokens[ti], status);
391 if (status->status < 0)
394 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
395 if (status->status < 0)
398 if (rule->flags == IP4_TUNNEL) {
401 APP_CHECK(parse_ipv4_addr(tokens[ti],
402 &ip, NULL) == 0, status,
403 "unrecognized input \"%s\", "
404 "expect valid ipv4 addr",
406 if (status->status < 0)
408 rule->src.ip.ip4 = rte_bswap32(
409 (uint32_t)ip.s_addr);
410 } else if (rule->flags == IP6_TUNNEL) {
413 APP_CHECK(parse_ipv6_addr(tokens[ti], &ip,
415 "unrecognized input \"%s\", "
416 "expect valid ipv6 addr",
418 if (status->status < 0)
420 memcpy(rule->src.ip.ip6.ip6_b,
422 } else if (rule->flags == TRANSPORT) {
423 APP_CHECK(0, status, "unrecognized input "
424 "\"%s\"", tokens[ti]);
432 if (strcmp(tokens[ti], "dst") == 0) {
433 APP_CHECK_PRESENCE(dst_p, tokens[ti], status);
434 if (status->status < 0)
437 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
438 if (status->status < 0)
441 if (rule->flags == IP4_TUNNEL) {
444 APP_CHECK(parse_ipv4_addr(tokens[ti],
445 &ip, NULL) == 0, status,
446 "unrecognized input \"%s\", "
447 "expect valid ipv4 addr",
449 if (status->status < 0)
451 rule->dst.ip.ip4 = rte_bswap32(
452 (uint32_t)ip.s_addr);
453 } else if (rule->flags == IP6_TUNNEL) {
456 APP_CHECK(parse_ipv6_addr(tokens[ti], &ip,
458 "unrecognized input \"%s\", "
459 "expect valid ipv6 addr",
461 if (status->status < 0)
463 memcpy(rule->dst.ip.ip6.ip6_b, ip.s6_addr, 16);
464 } else if (rule->flags == TRANSPORT) {
465 APP_CHECK(0, status, "unrecognized "
466 "input \"%s\"", tokens[ti]);
474 /* unrecognizeable input */
475 APP_CHECK(0, status, "unrecognized input \"%s\"",
480 APP_CHECK(cipher_algo_p == 1, status, "missing cipher options");
481 if (status->status < 0)
484 APP_CHECK(auth_algo_p == 1, status, "missing auth options");
485 if (status->status < 0)
488 APP_CHECK(mode_p == 1, status, "missing mode option");
489 if (status->status < 0)
496 print_one_sa_rule(const struct ipsec_sa *sa, int inbound)
501 printf("\tspi_%s(%3u):", inbound?"in":"out", sa->spi);
503 for (i = 0; i < RTE_DIM(cipher_algos); i++) {
504 if (cipher_algos[i].algo == sa->cipher_algo) {
505 printf("%s ", cipher_algos[i].keyword);
510 for (i = 0; i < RTE_DIM(auth_algos); i++) {
511 if (auth_algos[i].algo == sa->auth_algo) {
512 printf("%s ", auth_algos[i].keyword);
521 printf("IP4Tunnel ");
522 uint32_t_to_char(sa->src.ip.ip4, &a, &b, &c, &d);
523 printf("%hhu.%hhu.%hhu.%hhu ", d, c, b, a);
524 uint32_t_to_char(sa->dst.ip.ip4, &a, &b, &c, &d);
525 printf("%hhu.%hhu.%hhu.%hhu", d, c, b, a);
528 printf("IP6Tunnel ");
529 for (i = 0; i < 16; i++) {
530 if (i % 2 && i != 15)
531 printf("%.2x:", sa->src.ip.ip6.ip6_b[i]);
533 printf("%.2x", sa->src.ip.ip6.ip6_b[i]);
536 for (i = 0; i < 16; i++) {
537 if (i % 2 && i != 15)
538 printf("%.2x:", sa->dst.ip.ip6.ip6_b[i]);
540 printf("%.2x", sa->dst.ip.ip6.ip6_b[i]);
551 struct ipsec_sa sa[IPSEC_SA_MAX_ENTRIES];
553 struct rte_crypto_sym_xform a;
554 struct rte_crypto_sym_xform b;
555 } xf[IPSEC_SA_MAX_ENTRIES];
558 static struct sa_ctx *
559 sa_create(const char *name, int32_t socket_id)
562 struct sa_ctx *sa_ctx;
564 const struct rte_memzone *mz;
566 snprintf(s, sizeof(s), "%s_%u", name, socket_id);
568 /* Create SA array table */
569 printf("Creating SA context with %u maximum entries\n",
570 IPSEC_SA_MAX_ENTRIES);
572 mz_size = sizeof(struct sa_ctx);
573 mz = rte_memzone_reserve(s, mz_size, socket_id,
574 RTE_MEMZONE_1GB | RTE_MEMZONE_SIZE_HINT_ONLY);
576 printf("Failed to allocate SA DB memory\n");
581 sa_ctx = (struct sa_ctx *)mz->addr;
587 sa_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
588 uint32_t nb_entries, uint32_t inbound)
593 for (i = 0; i < nb_entries; i++) {
594 idx = SPI2IDX(entries[i].spi);
595 sa = &sa_ctx->sa[idx];
597 printf("Index %u already in use by SPI %u\n",
606 sa->src.ip.ip4 = rte_cpu_to_be_32(sa->src.ip.ip4);
607 sa->dst.ip.ip4 = rte_cpu_to_be_32(sa->dst.ip.ip4);
611 sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
612 sa_ctx->xf[idx].b.cipher.algo = sa->cipher_algo;
613 sa_ctx->xf[idx].b.cipher.key.data = sa->cipher_key;
614 sa_ctx->xf[idx].b.cipher.key.length =
616 sa_ctx->xf[idx].b.cipher.op =
617 RTE_CRYPTO_CIPHER_OP_DECRYPT;
618 sa_ctx->xf[idx].b.next = NULL;
620 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_AUTH;
621 sa_ctx->xf[idx].a.auth.algo = sa->auth_algo;
622 sa_ctx->xf[idx].a.auth.add_auth_data_length =
624 sa_ctx->xf[idx].a.auth.key.data = sa->auth_key;
625 sa_ctx->xf[idx].a.auth.key.length =
627 sa_ctx->xf[idx].a.auth.digest_length =
629 sa_ctx->xf[idx].a.auth.op =
630 RTE_CRYPTO_AUTH_OP_VERIFY;
632 } else { /* outbound */
633 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
634 sa_ctx->xf[idx].a.cipher.algo = sa->cipher_algo;
635 sa_ctx->xf[idx].a.cipher.key.data = sa->cipher_key;
636 sa_ctx->xf[idx].a.cipher.key.length =
638 sa_ctx->xf[idx].a.cipher.op =
639 RTE_CRYPTO_CIPHER_OP_ENCRYPT;
640 sa_ctx->xf[idx].a.next = NULL;
642 sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_AUTH;
643 sa_ctx->xf[idx].b.auth.algo = sa->auth_algo;
644 sa_ctx->xf[idx].b.auth.add_auth_data_length =
646 sa_ctx->xf[idx].b.auth.key.data = sa->auth_key;
647 sa_ctx->xf[idx].b.auth.key.length =
649 sa_ctx->xf[idx].b.auth.digest_length =
651 sa_ctx->xf[idx].b.auth.op =
652 RTE_CRYPTO_AUTH_OP_GENERATE;
655 sa_ctx->xf[idx].a.next = &sa_ctx->xf[idx].b;
656 sa_ctx->xf[idx].b.next = NULL;
657 sa->xforms = &sa_ctx->xf[idx].a;
659 print_one_sa_rule(sa, inbound);
666 sa_out_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
669 return sa_add_rules(sa_ctx, entries, nb_entries, 0);
673 sa_in_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
676 return sa_add_rules(sa_ctx, entries, nb_entries, 1);
680 sa_init(struct socket_ctx *ctx, int32_t socket_id)
685 rte_exit(EXIT_FAILURE, "NULL context.\n");
687 if (ctx->sa_in != NULL)
688 rte_exit(EXIT_FAILURE, "Inbound SA DB for socket %u already "
689 "initialized\n", socket_id);
691 if (ctx->sa_out != NULL)
692 rte_exit(EXIT_FAILURE, "Outbound SA DB for socket %u already "
693 "initialized\n", socket_id);
697 ctx->sa_in = sa_create(name, socket_id);
698 if (ctx->sa_in == NULL)
699 rte_exit(EXIT_FAILURE, "Error [%d] creating SA "
700 "context %s in socket %d\n", rte_errno,
703 sa_in_add_rules(ctx->sa_in, sa_in, nb_sa_in);
705 RTE_LOG(WARNING, IPSEC, "No SA Inbound rule specified\n");
709 ctx->sa_out = sa_create(name, socket_id);
710 if (ctx->sa_out == NULL)
711 rte_exit(EXIT_FAILURE, "Error [%d] creating SA "
712 "context %s in socket %d\n", rte_errno,
715 sa_out_add_rules(ctx->sa_out, sa_out, nb_sa_out);
717 RTE_LOG(WARNING, IPSEC, "No SA Outbound rule "
722 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx)
724 struct ipsec_mbuf_metadata *priv;
726 priv = RTE_PTR_ADD(m, sizeof(struct rte_mbuf));
728 return (sa_ctx->sa[sa_idx].spi == priv->sa->spi);
732 single_inbound_lookup(struct ipsec_sa *sadb, struct rte_mbuf *pkt,
733 struct ipsec_sa **sa_ret)
743 ip = rte_pktmbuf_mtod(pkt, struct ip *);
744 if (ip->ip_v == IPVERSION)
745 esp = (struct esp_hdr *)(ip + 1);
747 esp = (struct esp_hdr *)(((struct ip6_hdr *)ip) + 1);
749 if (esp->spi == INVALID_SPI)
752 sa = &sadb[SPI2IDX(rte_be_to_cpu_32(esp->spi))];
753 if (rte_be_to_cpu_32(esp->spi) != sa->spi)
758 src4_addr = RTE_PTR_ADD(ip, offsetof(struct ip, ip_src));
759 if ((ip->ip_v == IPVERSION) &&
760 (sa->src.ip.ip4 == *src4_addr) &&
761 (sa->dst.ip.ip4 == *(src4_addr + 1)))
765 src6_addr = RTE_PTR_ADD(ip, offsetof(struct ip6_hdr, ip6_src));
766 if ((ip->ip_v == IP6_VERSION) &&
767 !memcmp(&sa->src.ip.ip6.ip6, src6_addr, 16) &&
768 !memcmp(&sa->dst.ip.ip6.ip6, src6_addr + 16, 16))
777 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[],
778 struct ipsec_sa *sa[], uint16_t nb_pkts)
782 for (i = 0; i < nb_pkts; i++)
783 single_inbound_lookup(sa_ctx->sa, pkts[i], &sa[i]);
787 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[],
788 struct ipsec_sa *sa[], uint16_t nb_pkts)
792 for (i = 0; i < nb_pkts; i++)
793 sa[i] = &sa_ctx->sa[sa_idx[i]];