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 = "aes-128-gcm",
118 .algo = RTE_CRYPTO_AUTH_AES_GCM,
125 struct ipsec_sa sa_out[IPSEC_SA_MAX_ENTRIES];
128 struct ipsec_sa sa_in[IPSEC_SA_MAX_ENTRIES];
131 static const struct supported_cipher_algo *
132 find_match_cipher_algo(const char *cipher_keyword)
136 for (i = 0; i < RTE_DIM(cipher_algos); i++) {
137 const struct supported_cipher_algo *algo =
140 if (strcmp(cipher_keyword, algo->keyword) == 0)
147 static const struct supported_auth_algo *
148 find_match_auth_algo(const char *auth_keyword)
152 for (i = 0; i < RTE_DIM(auth_algos); i++) {
153 const struct supported_auth_algo *algo =
156 if (strcmp(auth_keyword, algo->keyword) == 0)
164 * parse x:x:x:x.... hex number key string into uint8_t *key
166 * > 0: number of bytes parsed
170 parse_key_string(const char *key_str, uint8_t *key)
172 const char *pt_start = key_str, *pt_end = key_str;
173 uint32_t nb_bytes = 0;
175 while (pt_end != NULL) {
176 char sub_str[3] = {0};
178 pt_end = strchr(pt_start, ':');
180 if (pt_end == NULL) {
181 if (strlen(pt_start) > 2)
183 strncpy(sub_str, pt_start, 2);
185 if (pt_end - pt_start > 2)
188 strncpy(sub_str, pt_start, pt_end - pt_start);
189 pt_start = pt_end + 1;
192 key[nb_bytes++] = strtol(sub_str, NULL, 16);
199 parse_sa_tokens(char **tokens, uint32_t n_tokens,
200 struct parse_status *status)
202 struct ipsec_sa *rule = NULL;
203 uint32_t ti; /*token index*/
204 uint32_t *ri /*rule index*/;
205 uint32_t cipher_algo_p = 0;
206 uint32_t auth_algo_p = 0;
211 if (strcmp(tokens[0], "in") == 0) {
214 APP_CHECK(*ri <= IPSEC_SA_MAX_ENTRIES - 1, status,
215 "too many sa rules, abort insertion\n");
216 if (status->status < 0)
223 APP_CHECK(*ri <= IPSEC_SA_MAX_ENTRIES - 1, status,
224 "too many sa rules, abort insertion\n");
225 if (status->status < 0)
232 APP_CHECK_TOKEN_IS_NUM(tokens, 1, status);
233 if (status->status < 0)
235 if (atoi(tokens[1]) == INVALID_SPI)
237 rule->spi = atoi(tokens[1]);
239 for (ti = 2; ti < n_tokens; ti++) {
240 if (strcmp(tokens[ti], "mode") == 0) {
241 APP_CHECK_PRESENCE(mode_p, tokens[ti], status);
242 if (status->status < 0)
245 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
246 if (status->status < 0)
249 if (strcmp(tokens[ti], "ipv4-tunnel") == 0)
250 rule->flags = IP4_TUNNEL;
251 else if (strcmp(tokens[ti], "ipv6-tunnel") == 0)
252 rule->flags = IP6_TUNNEL;
253 else if (strcmp(tokens[ti], "transport") == 0)
254 rule->flags = TRANSPORT;
256 APP_CHECK(0, status, "unrecognized "
257 "input \"%s\"", tokens[ti]);
265 if (strcmp(tokens[ti], "cipher_algo") == 0) {
266 const struct supported_cipher_algo *algo;
269 APP_CHECK_PRESENCE(cipher_algo_p, tokens[ti],
271 if (status->status < 0)
274 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
275 if (status->status < 0)
278 algo = find_match_cipher_algo(tokens[ti]);
280 APP_CHECK(algo != NULL, status, "unrecognized "
281 "input \"%s\"", tokens[ti]);
283 rule->cipher_algo = algo->algo;
284 rule->block_size = algo->block_size;
285 rule->iv_len = algo->iv_len;
286 rule->cipher_key_len = algo->key_len;
288 /* for NULL algorithm, no cipher key required */
289 if (rule->cipher_algo == RTE_CRYPTO_CIPHER_NULL) {
294 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
295 if (status->status < 0)
298 APP_CHECK(strcmp(tokens[ti], "cipher_key") == 0,
299 status, "unrecognized input \"%s\", "
300 "expect \"cipher_key\"", tokens[ti]);
301 if (status->status < 0)
304 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
305 if (status->status < 0)
308 key_len = parse_key_string(tokens[ti],
310 APP_CHECK(key_len == rule->cipher_key_len, status,
311 "unrecognized input \"%s\"", tokens[ti]);
312 if (status->status < 0)
315 if (algo->algo == RTE_CRYPTO_CIPHER_AES_CBC)
316 rule->salt = (uint32_t)rte_rand();
318 if ((algo->algo == RTE_CRYPTO_CIPHER_AES_CTR) ||
319 (algo->algo == RTE_CRYPTO_CIPHER_AES_GCM)) {
321 rule->cipher_key_len = key_len;
323 &rule->cipher_key[key_len], 4);
330 if (strcmp(tokens[ti], "auth_algo") == 0) {
331 const struct supported_auth_algo *algo;
334 APP_CHECK_PRESENCE(auth_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_auth_algo(tokens[ti]);
344 APP_CHECK(algo != NULL, status, "unrecognized "
345 "input \"%s\"", tokens[ti]);
347 rule->auth_algo = algo->algo;
348 rule->auth_key_len = algo->key_len;
349 rule->digest_len = algo->digest_len;
350 rule->aad_len = algo->key_len;
352 /* NULL algorithm and combined algos do not
355 if (algo->key_not_req) {
360 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
361 if (status->status < 0)
364 APP_CHECK(strcmp(tokens[ti], "auth_key") == 0,
365 status, "unrecognized input \"%s\", "
366 "expect \"auth_key\"", tokens[ti]);
367 if (status->status < 0)
370 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
371 if (status->status < 0)
374 key_len = parse_key_string(tokens[ti],
376 APP_CHECK(key_len == rule->auth_key_len, status,
377 "unrecognized input \"%s\"", tokens[ti]);
378 if (status->status < 0)
385 if (strcmp(tokens[ti], "src") == 0) {
386 APP_CHECK_PRESENCE(src_p, tokens[ti], status);
387 if (status->status < 0)
390 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
391 if (status->status < 0)
394 if (rule->flags == IP4_TUNNEL) {
397 APP_CHECK(parse_ipv4_addr(tokens[ti],
398 &ip, NULL) == 0, status,
399 "unrecognized input \"%s\", "
400 "expect valid ipv4 addr",
402 if (status->status < 0)
404 rule->src.ip.ip4 = rte_bswap32(
405 (uint32_t)ip.s_addr);
406 } else if (rule->flags == IP6_TUNNEL) {
409 APP_CHECK(parse_ipv6_addr(tokens[ti], &ip,
411 "unrecognized input \"%s\", "
412 "expect valid ipv6 addr",
414 if (status->status < 0)
416 memcpy(rule->src.ip.ip6.ip6_b,
418 } else if (rule->flags == TRANSPORT) {
419 APP_CHECK(0, status, "unrecognized input "
420 "\"%s\"", tokens[ti]);
428 if (strcmp(tokens[ti], "dst") == 0) {
429 APP_CHECK_PRESENCE(dst_p, tokens[ti], status);
430 if (status->status < 0)
433 INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
434 if (status->status < 0)
437 if (rule->flags == IP4_TUNNEL) {
440 APP_CHECK(parse_ipv4_addr(tokens[ti],
441 &ip, NULL) == 0, status,
442 "unrecognized input \"%s\", "
443 "expect valid ipv4 addr",
445 if (status->status < 0)
447 rule->dst.ip.ip4 = rte_bswap32(
448 (uint32_t)ip.s_addr);
449 } else if (rule->flags == IP6_TUNNEL) {
452 APP_CHECK(parse_ipv6_addr(tokens[ti], &ip,
454 "unrecognized input \"%s\", "
455 "expect valid ipv6 addr",
457 if (status->status < 0)
459 memcpy(rule->dst.ip.ip6.ip6_b, ip.s6_addr, 16);
460 } else if (rule->flags == TRANSPORT) {
461 APP_CHECK(0, status, "unrecognized "
462 "input \"%s\"", tokens[ti]);
470 /* unrecognizeable input */
471 APP_CHECK(0, status, "unrecognized input \"%s\"",
476 APP_CHECK(cipher_algo_p == 1, status, "missing cipher options");
477 if (status->status < 0)
480 APP_CHECK(auth_algo_p == 1, status, "missing auth options");
481 if (status->status < 0)
484 APP_CHECK(mode_p == 1, status, "missing mode option");
485 if (status->status < 0)
492 print_one_sa_rule(const struct ipsec_sa *sa, int inbound)
497 printf("\tspi_%s(%3u):", inbound?"in":"out", sa->spi);
499 for (i = 0; i < RTE_DIM(cipher_algos); i++) {
500 if (cipher_algos[i].algo == sa->cipher_algo) {
501 printf("%s ", cipher_algos[i].keyword);
506 for (i = 0; i < RTE_DIM(auth_algos); i++) {
507 if (auth_algos[i].algo == sa->auth_algo) {
508 printf("%s ", auth_algos[i].keyword);
517 printf("IP4Tunnel ");
518 uint32_t_to_char(sa->src.ip.ip4, &a, &b, &c, &d);
519 printf("%hhu.%hhu.%hhu.%hhu ", d, c, b, a);
520 uint32_t_to_char(sa->dst.ip.ip4, &a, &b, &c, &d);
521 printf("%hhu.%hhu.%hhu.%hhu", d, c, b, a);
524 printf("IP6Tunnel ");
525 for (i = 0; i < 16; i++) {
526 if (i % 2 && i != 15)
527 printf("%.2x:", sa->src.ip.ip6.ip6_b[i]);
529 printf("%.2x", sa->src.ip.ip6.ip6_b[i]);
532 for (i = 0; i < 16; i++) {
533 if (i % 2 && i != 15)
534 printf("%.2x:", sa->dst.ip.ip6.ip6_b[i]);
536 printf("%.2x", sa->dst.ip.ip6.ip6_b[i]);
547 struct ipsec_sa sa[IPSEC_SA_MAX_ENTRIES];
549 struct rte_crypto_sym_xform a;
550 struct rte_crypto_sym_xform b;
551 } xf[IPSEC_SA_MAX_ENTRIES];
554 static struct sa_ctx *
555 sa_create(const char *name, int32_t socket_id)
558 struct sa_ctx *sa_ctx;
560 const struct rte_memzone *mz;
562 snprintf(s, sizeof(s), "%s_%u", name, socket_id);
564 /* Create SA array table */
565 printf("Creating SA context with %u maximum entries\n",
566 IPSEC_SA_MAX_ENTRIES);
568 mz_size = sizeof(struct sa_ctx);
569 mz = rte_memzone_reserve(s, mz_size, socket_id,
570 RTE_MEMZONE_1GB | RTE_MEMZONE_SIZE_HINT_ONLY);
572 printf("Failed to allocate SA DB memory\n");
577 sa_ctx = (struct sa_ctx *)mz->addr;
583 sa_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
584 uint32_t nb_entries, uint32_t inbound)
589 for (i = 0; i < nb_entries; i++) {
590 idx = SPI2IDX(entries[i].spi);
591 sa = &sa_ctx->sa[idx];
593 printf("Index %u already in use by SPI %u\n",
602 sa->src.ip.ip4 = rte_cpu_to_be_32(sa->src.ip.ip4);
603 sa->dst.ip.ip4 = rte_cpu_to_be_32(sa->dst.ip.ip4);
607 sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
608 sa_ctx->xf[idx].b.cipher.algo = sa->cipher_algo;
609 sa_ctx->xf[idx].b.cipher.key.data = sa->cipher_key;
610 sa_ctx->xf[idx].b.cipher.key.length =
612 sa_ctx->xf[idx].b.cipher.op =
613 RTE_CRYPTO_CIPHER_OP_DECRYPT;
614 sa_ctx->xf[idx].b.next = NULL;
616 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_AUTH;
617 sa_ctx->xf[idx].a.auth.algo = sa->auth_algo;
618 sa_ctx->xf[idx].a.auth.add_auth_data_length =
620 sa_ctx->xf[idx].a.auth.key.data = sa->auth_key;
621 sa_ctx->xf[idx].a.auth.key.length =
623 sa_ctx->xf[idx].a.auth.digest_length =
625 sa_ctx->xf[idx].a.auth.op =
626 RTE_CRYPTO_AUTH_OP_VERIFY;
628 } else { /* outbound */
629 sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
630 sa_ctx->xf[idx].a.cipher.algo = sa->cipher_algo;
631 sa_ctx->xf[idx].a.cipher.key.data = sa->cipher_key;
632 sa_ctx->xf[idx].a.cipher.key.length =
634 sa_ctx->xf[idx].a.cipher.op =
635 RTE_CRYPTO_CIPHER_OP_ENCRYPT;
636 sa_ctx->xf[idx].a.next = NULL;
638 sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_AUTH;
639 sa_ctx->xf[idx].b.auth.algo = sa->auth_algo;
640 sa_ctx->xf[idx].b.auth.add_auth_data_length =
642 sa_ctx->xf[idx].b.auth.key.data = sa->auth_key;
643 sa_ctx->xf[idx].b.auth.key.length =
645 sa_ctx->xf[idx].b.auth.digest_length =
647 sa_ctx->xf[idx].b.auth.op =
648 RTE_CRYPTO_AUTH_OP_GENERATE;
651 sa_ctx->xf[idx].a.next = &sa_ctx->xf[idx].b;
652 sa_ctx->xf[idx].b.next = NULL;
653 sa->xforms = &sa_ctx->xf[idx].a;
655 print_one_sa_rule(sa, inbound);
662 sa_out_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
665 return sa_add_rules(sa_ctx, entries, nb_entries, 0);
669 sa_in_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
672 return sa_add_rules(sa_ctx, entries, nb_entries, 1);
676 sa_init(struct socket_ctx *ctx, int32_t socket_id)
681 rte_exit(EXIT_FAILURE, "NULL context.\n");
683 if (ctx->sa_in != NULL)
684 rte_exit(EXIT_FAILURE, "Inbound SA DB for socket %u already "
685 "initialized\n", socket_id);
687 if (ctx->sa_out != NULL)
688 rte_exit(EXIT_FAILURE, "Outbound SA DB for socket %u already "
689 "initialized\n", socket_id);
693 ctx->sa_in = sa_create(name, socket_id);
694 if (ctx->sa_in == NULL)
695 rte_exit(EXIT_FAILURE, "Error [%d] creating SA "
696 "context %s in socket %d\n", rte_errno,
699 sa_in_add_rules(ctx->sa_in, sa_in, nb_sa_in);
701 RTE_LOG(WARNING, IPSEC, "No SA Inbound rule specified\n");
705 ctx->sa_out = sa_create(name, socket_id);
706 if (ctx->sa_out == NULL)
707 rte_exit(EXIT_FAILURE, "Error [%d] creating SA "
708 "context %s in socket %d\n", rte_errno,
711 sa_out_add_rules(ctx->sa_out, sa_out, nb_sa_out);
713 RTE_LOG(WARNING, IPSEC, "No SA Outbound rule "
718 inbound_sa_check(struct sa_ctx *sa_ctx, struct rte_mbuf *m, uint32_t sa_idx)
720 struct ipsec_mbuf_metadata *priv;
722 priv = RTE_PTR_ADD(m, sizeof(struct rte_mbuf));
724 return (sa_ctx->sa[sa_idx].spi == priv->sa->spi);
728 single_inbound_lookup(struct ipsec_sa *sadb, struct rte_mbuf *pkt,
729 struct ipsec_sa **sa_ret)
739 ip = rte_pktmbuf_mtod(pkt, struct ip *);
740 if (ip->ip_v == IPVERSION)
741 esp = (struct esp_hdr *)(ip + 1);
743 esp = (struct esp_hdr *)(((struct ip6_hdr *)ip) + 1);
745 if (esp->spi == INVALID_SPI)
748 sa = &sadb[SPI2IDX(rte_be_to_cpu_32(esp->spi))];
749 if (rte_be_to_cpu_32(esp->spi) != sa->spi)
754 src4_addr = RTE_PTR_ADD(ip, offsetof(struct ip, ip_src));
755 if ((ip->ip_v == IPVERSION) &&
756 (sa->src.ip.ip4 == *src4_addr) &&
757 (sa->dst.ip.ip4 == *(src4_addr + 1)))
761 src6_addr = RTE_PTR_ADD(ip, offsetof(struct ip6_hdr, ip6_src));
762 if ((ip->ip_v == IP6_VERSION) &&
763 !memcmp(&sa->src.ip.ip6.ip6, src6_addr, 16) &&
764 !memcmp(&sa->dst.ip.ip6.ip6, src6_addr + 16, 16))
773 inbound_sa_lookup(struct sa_ctx *sa_ctx, struct rte_mbuf *pkts[],
774 struct ipsec_sa *sa[], uint16_t nb_pkts)
778 for (i = 0; i < nb_pkts; i++)
779 single_inbound_lookup(sa_ctx->sa, pkts[i], &sa[i]);
783 outbound_sa_lookup(struct sa_ctx *sa_ctx, uint32_t sa_idx[],
784 struct ipsec_sa *sa[], uint16_t nb_pkts)
788 for (i = 0; i < nb_pkts; i++)
789 sa[i] = &sa_ctx->sa[sa_idx[i]];