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>
53 struct supported_cipher_algo {
55 enum rte_crypto_cipher_algorithm algo;
61 struct supported_auth_algo {
63 enum rte_crypto_auth_algorithm algo;
70 const struct supported_cipher_algo cipher_algos[] = {
73 .algo = RTE_CRYPTO_CIPHER_NULL,
79 .keyword = "aes-128-cbc",
80 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
86 .keyword = "aes-128-gcm",
87 .algo = RTE_CRYPTO_CIPHER_AES_GCM,
94 const struct supported_auth_algo auth_algos[] = {
97 .algo = RTE_CRYPTO_AUTH_NULL,
103 .keyword = "sha1-hmac",
104 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
109 .keyword = "aes-128-gcm",
110 .algo = RTE_CRYPTO_AUTH_AES_GCM,
118 struct ipsec_sa sa_out[IPSEC_SA_MAX_ENTRIES];
121 struct ipsec_sa sa_in[IPSEC_SA_MAX_ENTRIES];
124 static const struct supported_cipher_algo *
125 find_match_cipher_algo(const char *cipher_keyword)
129 for (i = 0; i < RTE_DIM(cipher_algos); i++) {
130 const struct supported_cipher_algo *algo =
133 if (strcmp(cipher_keyword, algo->keyword) == 0)
140 static const struct supported_auth_algo *
141 find_match_auth_algo(const char *auth_keyword)
145 for (i = 0; i < RTE_DIM(auth_algos); i++) {
146 const struct supported_auth_algo *algo =
149 if (strcmp(auth_keyword, algo->keyword) == 0)
157 * parse x:x:x:x.... hex number key string into uint8_t *key
159 * > 0: number of bytes parsed
163 parse_key_string(const char *key_str, uint8_t *key)
165 const char *pt_start = key_str, *pt_end = key_str;
167 uint32_t nb_bytes = 0;
169 while (pt_end != NULL) {
170 pt_end = strchr(pt_start, ':');
173 strncpy(sub_str, pt_start, strlen(pt_start));
175 if (pt_end - pt_start > 2)
178 strncpy(sub_str, pt_start, pt_end - pt_start);
179 pt_start = pt_end + 1;
182 key[nb_bytes++] = strtol(sub_str, NULL, 16);
189 parse_sa_tokens(char **tokens, uint32_t n_tokens,
190 struct parse_status *status)
192 struct ipsec_sa *rule = NULL;
193 uint32_t ti; /*token index*/
194 uint32_t *ri /*rule index*/;
195 uint32_t cipher_algo_p = 0;
196 uint32_t auth_algo_p = 0;
201 if (strcmp(tokens[0], "in") == 0) {
204 APP_CHECK(*ri <= IPSEC_SA_MAX_ENTRIES - 1, status,
205 "too many sa rules, abort insertion\n");
206 if (status->status < 0)
213 APP_CHECK(*ri <= IPSEC_SA_MAX_ENTRIES - 1, status,
214 "too many sa rules, abort insertion\n");
215 if (status->status < 0)
222 APP_CHECK_TOKEN_IS_NUM(tokens, 1, status);
223 if (status->status < 0)
225 rule->spi = atoi(tokens[1]);
227 for (ti = 2; ti < n_tokens; ti++) {
228 if (strcmp(tokens[ti], "mode") == 0) {
229 APP_CHECK_PRESENCE(mode_p, tokens[ti], status);
230 if (status->status < 0)
233 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
234 if (status->status < 0)
237 if (strcmp(tokens[ti], "ipv4-tunnel") == 0)
238 rule->flags = IP4_TUNNEL;
239 else if (strcmp(tokens[ti], "ipv6-tunnel") == 0)
240 rule->flags = IP6_TUNNEL;
241 else if (strcmp(tokens[ti], "transport") == 0)
242 rule->flags = TRANSPORT;
244 APP_CHECK(0, status, "unrecognized "
245 "input \"%s\"", tokens[ti]);
253 if (strcmp(tokens[ti], "cipher_algo") == 0) {
254 const struct supported_cipher_algo *algo;
257 APP_CHECK_PRESENCE(cipher_algo_p, tokens[ti],
259 if (status->status < 0)
262 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
263 if (status->status < 0)
266 algo = find_match_cipher_algo(tokens[ti]);
268 APP_CHECK(algo != NULL, status, "unrecognized "
269 "input \"%s\"", tokens[ti]);
271 rule->cipher_algo = algo->algo;
272 rule->block_size = algo->block_size;
273 rule->iv_len = algo->iv_len;
274 rule->cipher_key_len = algo->key_len;
276 /* for NULL algorithm, no cipher key required */
277 if (rule->cipher_algo == RTE_CRYPTO_CIPHER_NULL) {
282 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
283 if (status->status < 0)
286 APP_CHECK(strcmp(tokens[ti], "cipher_key") == 0,
287 status, "unrecognized input \"%s\", "
288 "expect \"cipher_key\"", tokens[ti]);
289 if (status->status < 0)
292 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
293 if (status->status < 0)
296 key_len = parse_key_string(tokens[ti],
298 APP_CHECK(key_len == rule->cipher_key_len, status,
299 "unrecognized input \"%s\"", tokens[ti]);
300 if (status->status < 0)
307 if (strcmp(tokens[ti], "auth_algo") == 0) {
308 const struct supported_auth_algo *algo;
311 APP_CHECK_PRESENCE(auth_algo_p, tokens[ti],
313 if (status->status < 0)
316 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
317 if (status->status < 0)
320 algo = find_match_auth_algo(tokens[ti]);
321 APP_CHECK(algo != NULL, status, "unrecognized "
322 "input \"%s\"", tokens[ti]);
324 rule->auth_algo = algo->algo;
325 rule->auth_key_len = algo->key_len;
326 rule->digest_len = algo->digest_len;
327 rule->aad_len = algo->key_len;
329 /* NULL algorithm and combined algos do not
332 if (algo->key_not_req) {
337 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
338 if (status->status < 0)
341 APP_CHECK(strcmp(tokens[ti], "auth_key") == 0,
342 status, "unrecognized input \"%s\", "
343 "expect \"auth_key\"", tokens[ti]);
344 if (status->status < 0)
347 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
348 if (status->status < 0)
351 key_len = parse_key_string(tokens[ti],
353 APP_CHECK(key_len == rule->auth_key_len, status,
354 "unrecognized input \"%s\"", tokens[ti]);
355 if (status->status < 0)
362 if (strcmp(tokens[ti], "src") == 0) {
363 APP_CHECK_PRESENCE(src_p, tokens[ti], status);
364 if (status->status < 0)
367 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
368 if (status->status < 0)
371 if (rule->flags == IP4_TUNNEL) {
374 APP_CHECK(parse_ipv4_addr(tokens[ti],
375 &ip, NULL) == 0, status,
376 "unrecognized input \"%s\", "
377 "expect valid ipv4 addr",
379 if (status->status < 0)
381 rule->src.ip.ip4 = rte_bswap32(
382 (uint32_t)ip.s_addr);
383 } else if (rule->flags == IP6_TUNNEL) {
386 APP_CHECK(parse_ipv6_addr(tokens[ti], &ip,
388 "unrecognized input \"%s\", "
389 "expect valid ipv6 addr",
391 if (status->status < 0)
393 memcpy(rule->src.ip.ip6.ip6_b,
395 } else if (rule->flags == TRANSPORT) {
396 APP_CHECK(0, status, "unrecognized input "
397 "\"%s\"", tokens[ti]);
405 if (strcmp(tokens[ti], "dst") == 0) {
406 APP_CHECK_PRESENCE(dst_p, tokens[ti], status);
407 if (status->status < 0)
410 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
411 if (status->status < 0)
414 if (rule->flags == IP4_TUNNEL) {
417 APP_CHECK(parse_ipv4_addr(tokens[ti],
418 &ip, NULL) == 0, status,
419 "unrecognized input \"%s\", "
420 "expect valid ipv4 addr",
422 if (status->status < 0)
424 rule->dst.ip.ip4 = rte_bswap32(
425 (uint32_t)ip.s_addr);
426 } else if (rule->flags == IP6_TUNNEL) {
429 APP_CHECK(parse_ipv6_addr(tokens[ti], &ip,
431 "unrecognized input \"%s\", "
432 "expect valid ipv6 addr",
434 if (status->status < 0)
436 memcpy(rule->dst.ip.ip6.ip6_b, ip.s6_addr, 16);
437 } else if (rule->flags == TRANSPORT) {
438 APP_CHECK(0, status, "unrecognized "
439 "input \"%s\"", tokens[ti]);
447 /* unrecognizeable input */
448 APP_CHECK(0, status, "unrecognized input \"%s\"",
453 APP_CHECK(cipher_algo_p == 1, status, "missing cipher options");
454 if (status->status < 0)
457 APP_CHECK(auth_algo_p == 1, status, "missing auth options");
458 if (status->status < 0)
461 APP_CHECK(mode_p == 1, status, "missing mode option");
462 if (status->status < 0)
469 print_one_sa_rule(const struct ipsec_sa *sa, int inbound)
474 printf("\tspi_%s(%3u):", inbound?"in":"out", sa->spi);
476 for (i = 0; i < RTE_DIM(cipher_algos); i++) {
477 if (cipher_algos[i].algo == sa->cipher_algo) {
478 printf("%s ", cipher_algos[i].keyword);
483 for (i = 0; i < RTE_DIM(auth_algos); i++) {
484 if (auth_algos[i].algo == sa->auth_algo) {
485 printf("%s ", auth_algos[i].keyword);
494 printf("IP4Tunnel ");
495 uint32_t_to_char(sa->src.ip.ip4, &a, &b, &c, &d);
496 printf("%hhu.%hhu.%hhu.%hhu ", d, c, b, a);
497 uint32_t_to_char(sa->dst.ip.ip4, &a, &b, &c, &d);
498 printf("%hhu.%hhu.%hhu.%hhu", d, c, b, a);
501 printf("IP6Tunnel ");
502 for (i = 0; i < 16; i++) {
503 if (i % 2 && i != 15)
504 printf("%.2x:", sa->src.ip.ip6.ip6_b[i]);
506 printf("%.2x", sa->src.ip.ip6.ip6_b[i]);
509 for (i = 0; i < 16; i++) {
510 if (i % 2 && i != 15)
511 printf("%.2x:", sa->dst.ip.ip6.ip6_b[i]);
513 printf("%.2x", sa->dst.ip.ip6.ip6_b[i]);
524 struct ipsec_sa sa[IPSEC_SA_MAX_ENTRIES];
526 struct rte_crypto_sym_xform a;
527 struct rte_crypto_sym_xform b;
528 } xf[IPSEC_SA_MAX_ENTRIES];
531 static struct sa_ctx *
532 sa_create(const char *name, int32_t socket_id)
535 struct sa_ctx *sa_ctx;
537 const struct rte_memzone *mz;
539 snprintf(s, sizeof(s), "%s_%u", name, socket_id);
541 /* Create SA array table */
542 printf("Creating SA context with %u maximum entries\n",
543 IPSEC_SA_MAX_ENTRIES);
545 mz_size = sizeof(struct sa_ctx);
546 mz = rte_memzone_reserve(s, mz_size, socket_id,
547 RTE_MEMZONE_1GB | RTE_MEMZONE_SIZE_HINT_ONLY);
549 printf("Failed to allocate SA DB memory\n");
554 sa_ctx = (struct sa_ctx *)mz->addr;
560 sa_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
561 uint32_t nb_entries, uint32_t inbound)
566 for (i = 0; i < nb_entries; i++) {
567 idx = SPI2IDX(entries[i].spi);
568 sa = &sa_ctx->sa[idx];
570 printf("Index %u already in use by SPI %u\n",
579 sa->src.ip.ip4 = rte_cpu_to_be_32(sa->src.ip.ip4);
580 sa->dst.ip.ip4 = rte_cpu_to_be_32(sa->dst.ip.ip4);
584 sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
585 sa_ctx->xf[idx].b.cipher.algo = sa->cipher_algo;
586 sa_ctx->xf[idx].b.cipher.key.data = sa->cipher_key;
587 sa_ctx->xf[idx].b.cipher.key.length =
589 sa_ctx->xf[idx].b.cipher.op =
590 RTE_CRYPTO_CIPHER_OP_DECRYPT;
591 sa_ctx->xf[idx].b.next = NULL;
593 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_AUTH;
594 sa_ctx->xf[idx].a.auth.algo = sa->auth_algo;
595 sa_ctx->xf[idx].a.auth.add_auth_data_length =
597 sa_ctx->xf[idx].a.auth.key.data = sa->auth_key;
598 sa_ctx->xf[idx].a.auth.key.length =
600 sa_ctx->xf[idx].a.auth.digest_length =
602 sa_ctx->xf[idx].a.auth.op =
603 RTE_CRYPTO_AUTH_OP_VERIFY;
605 } else { /* outbound */
606 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
607 sa_ctx->xf[idx].a.cipher.algo = sa->cipher_algo;
608 sa_ctx->xf[idx].a.cipher.key.data = sa->cipher_key;
609 sa_ctx->xf[idx].a.cipher.key.length =
611 sa_ctx->xf[idx].a.cipher.op =
612 RTE_CRYPTO_CIPHER_OP_ENCRYPT;
613 sa_ctx->xf[idx].a.next = NULL;
615 sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_AUTH;
616 sa_ctx->xf[idx].b.auth.algo = sa->auth_algo;
617 sa_ctx->xf[idx].b.auth.add_auth_data_length =
619 sa_ctx->xf[idx].b.auth.key.data = sa->auth_key;
620 sa_ctx->xf[idx].b.auth.key.length =
622 sa_ctx->xf[idx].b.auth.digest_length =
624 sa_ctx->xf[idx].b.auth.op =
625 RTE_CRYPTO_AUTH_OP_GENERATE;
628 sa_ctx->xf[idx].a.next = &sa_ctx->xf[idx].b;
629 sa_ctx->xf[idx].b.next = NULL;
630 sa->xforms = &sa_ctx->xf[idx].a;
632 print_one_sa_rule(sa, inbound);
639 sa_out_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
642 return sa_add_rules(sa_ctx, entries, nb_entries, 0);
646 sa_in_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
649 return sa_add_rules(sa_ctx, entries, nb_entries, 1);
653 sa_init(struct socket_ctx *ctx, int32_t socket_id)
658 rte_exit(EXIT_FAILURE, "NULL context.\n");
660 if (ctx->sa_in != NULL)
661 rte_exit(EXIT_FAILURE, "Inbound SA DB for socket %u already "
662 "initialized\n", socket_id);
664 if (ctx->sa_out != NULL)
665 rte_exit(EXIT_FAILURE, "Outbound SA DB for socket %u already "
666 "initialized\n", socket_id);
670 ctx->sa_in = sa_create(name, socket_id);
671 if (ctx->sa_in == NULL)
672 rte_exit(EXIT_FAILURE, "Error [%d] creating SA "
673 "context %s in socket %d\n", rte_errno,
676 sa_in_add_rules(ctx->sa_in, sa_in, nb_sa_in);
678 RTE_LOG(WARNING, IPSEC, "No SA Inbound rule specified\n");
682 ctx->sa_out = sa_create(name, socket_id);
683 if (ctx->sa_out == NULL)
684 rte_exit(EXIT_FAILURE, "Error [%d] creating SA "
685 "context %s in socket %d\n", rte_errno,
688 sa_out_add_rules(ctx->sa_out, sa_out, nb_sa_out);
690 RTE_LOG(WARNING, IPSEC, "No SA Outbound rule "
695 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx)
697 struct ipsec_mbuf_metadata *priv;
699 priv = RTE_PTR_ADD(m, sizeof(struct rte_mbuf));
701 return (sa_ctx->sa[sa_idx].spi == priv->sa->spi);
705 single_inbound_lookup(struct ipsec_sa *sadb, struct rte_mbuf *pkt,
706 struct ipsec_sa **sa_ret)
716 ip = rte_pktmbuf_mtod(pkt, struct ip *);
717 if (ip->ip_v == IPVERSION)
718 esp = (struct esp_hdr *)(ip + 1);
720 esp = (struct esp_hdr *)(((struct ip6_hdr *)ip) + 1);
722 if (esp->spi == INVALID_SPI)
725 sa = &sadb[SPI2IDX(rte_be_to_cpu_32(esp->spi))];
726 if (rte_be_to_cpu_32(esp->spi) != sa->spi)
731 src4_addr = RTE_PTR_ADD(ip, offsetof(struct ip, ip_src));
732 if ((ip->ip_v == IPVERSION) &&
733 (sa->src.ip.ip4 == *src4_addr) &&
734 (sa->dst.ip.ip4 == *(src4_addr + 1)))
738 src6_addr = RTE_PTR_ADD(ip, offsetof(struct ip6_hdr, ip6_src));
739 if ((ip->ip_v == IP6_VERSION) &&
740 !memcmp(&sa->src.ip.ip6.ip6, src6_addr, 16) &&
741 !memcmp(&sa->dst.ip.ip6.ip6, src6_addr + 16, 16))
750 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[],
751 struct ipsec_sa *sa[], uint16_t nb_pkts)
755 for (i = 0; i < nb_pkts; i++)
756 single_inbound_lookup(sa_ctx->sa, pkts[i], &sa[i]);
760 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[],
761 struct ipsec_sa *sa[], uint16_t nb_pkts)
765 for (i = 0; i < nb_pkts; i++)
766 sa[i] = &sa_ctx->sa[sa_idx[i]];