examples/ipsec-secgw: support security offload
[dpdk.git] / examples / ipsec-secgw / sa.c
index 1e071e6..4c448e5 100644 (file)
 
 #include <rte_memzone.h>
 #include <rte_crypto.h>
+#include <rte_security.h>
 #include <rte_cryptodev.h>
 #include <rte_byteorder.h>
 #include <rte_errno.h>
 #include <rte_ip.h>
 #include <rte_random.h>
+#include <rte_ethdev.h>
 
 #include "ipsec.h"
 #include "esp.h"
 #include "parser.h"
 
+#define IPDEFTTL 64
+
 struct supported_cipher_algo {
        const char *keyword;
        enum rte_crypto_cipher_algorithm algo;
@@ -64,7 +68,6 @@ struct supported_auth_algo {
        enum rte_crypto_auth_algorithm algo;
        uint16_t digest_len;
        uint16_t key_len;
-       uint8_t aad_len;
        uint8_t key_not_req;
 };
 
@@ -94,13 +97,6 @@ const struct supported_cipher_algo cipher_algos[] = {
                .block_size = 16,
                .key_len = 16
        },
-       {
-               .keyword = "aes-128-gcm",
-               .algo = RTE_CRYPTO_CIPHER_AES_GCM,
-               .iv_len = 8,
-               .block_size = 4,
-               .key_len = 20
-       },
        {
                .keyword = "aes-128-ctr",
                .algo = RTE_CRYPTO_CIPHER_AES_CTR,
@@ -129,18 +125,21 @@ const struct supported_auth_algo auth_algos[] = {
                .algo = RTE_CRYPTO_AUTH_SHA256_HMAC,
                .digest_len = 12,
                .key_len = 32
-       },
+       }
+};
+
+const struct supported_aead_algo aead_algos[] = {
        {
                .keyword = "aes-128-gcm",
-               .algo = RTE_CRYPTO_AUTH_AES_GCM,
+               .algo = RTE_CRYPTO_AEAD_AES_GCM,
+               .iv_len = 8,
+               .block_size = 4,
+               .key_len = 20,
                .digest_len = 16,
                .aad_len = 8,
-               .key_not_req = 1
        }
 };
 
-const struct supported_aead_algo aead_algos[] = { { } };
-
 struct ipsec_sa sa_out[IPSEC_SA_MAX_ENTRIES];
 uint32_t nb_sa_out;
 
@@ -243,6 +242,8 @@ parse_sa_tokens(char **tokens, uint32_t n_tokens,
        uint32_t src_p = 0;
        uint32_t dst_p = 0;
        uint32_t mode_p = 0;
+       uint32_t type_p = 0;
+       uint32_t portid_p = 0;
 
        if (strcmp(tokens[0], "in") == 0) {
                ri = &nb_sa_in;
@@ -349,8 +350,7 @@ parse_sa_tokens(char **tokens, uint32_t n_tokens,
                        if (algo->algo == RTE_CRYPTO_CIPHER_AES_CBC)
                                rule->salt = (uint32_t)rte_rand();
 
-                       if ((algo->algo == RTE_CRYPTO_CIPHER_AES_CTR) ||
-                               (algo->algo == RTE_CRYPTO_CIPHER_AES_GCM)) {
+                       if (algo->algo == RTE_CRYPTO_CIPHER_AES_CTR) {
                                key_len -= 4;
                                rule->cipher_key_len = key_len;
                                memcpy(&rule->salt,
@@ -381,7 +381,6 @@ parse_sa_tokens(char **tokens, uint32_t n_tokens,
                        rule->auth_algo = algo->algo;
                        rule->auth_key_len = algo->key_len;
                        rule->digest_len = algo->digest_len;
-                       rule->aad_len = algo->key_len;
 
                        /* NULL algorithm and combined algos do not
                         * require auth key
@@ -437,7 +436,7 @@ parse_sa_tokens(char **tokens, uint32_t n_tokens,
                        rule->aead_algo = algo->algo;
                        rule->cipher_key_len = algo->key_len;
                        rule->digest_len = algo->digest_len;
-                       rule->aad_len = algo->key_len;
+                       rule->aad_len = algo->aad_len;
                        rule->block_size = algo->block_size;
                        rule->iv_len = algo->iv_len;
 
@@ -556,6 +555,52 @@ parse_sa_tokens(char **tokens, uint32_t n_tokens,
                        continue;
                }
 
+               if (strcmp(tokens[ti], "type") == 0) {
+                       APP_CHECK_PRESENCE(type_p, tokens[ti], status);
+                       if (status->status < 0)
+                               return;
+
+                       INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
+                       if (status->status < 0)
+                               return;
+
+                       if (strcmp(tokens[ti], "inline-crypto-offload") == 0)
+                               rule->type =
+                                       RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO;
+                       else if (strcmp(tokens[ti],
+                                       "inline-protocol-offload") == 0)
+                               rule->type =
+                               RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL;
+                       else if (strcmp(tokens[ti],
+                                       "lookaside-protocol-offload") == 0)
+                               rule->type =
+                               RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL;
+                       else if (strcmp(tokens[ti], "no-offload") == 0)
+                               rule->type = RTE_SECURITY_ACTION_TYPE_NONE;
+                       else {
+                               APP_CHECK(0, status, "Invalid input \"%s\"",
+                                               tokens[ti]);
+                               return;
+                       }
+
+                       type_p = 1;
+                       continue;
+               }
+
+               if (strcmp(tokens[ti], "port_id") == 0) {
+                       APP_CHECK_PRESENCE(portid_p, tokens[ti], status);
+                       if (status->status < 0)
+                               return;
+                       INCREMENT_TOKEN_INDEX(ti, n_tokens, status);
+                       if (status->status < 0)
+                               return;
+                       rule->portid = atoi(tokens[ti]);
+                       if (status->status < 0)
+                               return;
+                       portid_p = 1;
+                       continue;
+               }
+
                /* unrecognizeable input */
                APP_CHECK(0, status, "unrecognized input \"%s\"",
                        tokens[ti]);
@@ -586,6 +631,14 @@ parse_sa_tokens(char **tokens, uint32_t n_tokens,
        if (status->status < 0)
                return;
 
+       if ((rule->type != RTE_SECURITY_ACTION_TYPE_NONE) && (portid_p == 0))
+               printf("Missing portid option, falling back to non-offload\n");
+
+       if (!type_p || !portid_p) {
+               rule->type = RTE_SECURITY_ACTION_TYPE_NONE;
+               rule->portid = -1;
+       }
+
        *ri = *ri + 1;
 }
 
@@ -653,9 +706,11 @@ print_one_sa_rule(const struct ipsec_sa *sa, int inbound)
 
 struct sa_ctx {
        struct ipsec_sa sa[IPSEC_SA_MAX_ENTRIES];
-       struct {
-               struct rte_crypto_sym_xform a;
-               struct rte_crypto_sym_xform b;
+       union {
+               struct {
+                       struct rte_crypto_sym_xform a;
+                       struct rte_crypto_sym_xform b;
+               };
        } xf[IPSEC_SA_MAX_ENTRIES];
 };
 
@@ -687,6 +742,33 @@ sa_create(const char *name, int32_t socket_id)
        return sa_ctx;
 }
 
+static int
+check_eth_dev_caps(uint16_t portid, uint32_t inbound)
+{
+       struct rte_eth_dev_info dev_info;
+
+       rte_eth_dev_info_get(portid, &dev_info);
+
+       if (inbound) {
+               if ((dev_info.rx_offload_capa &
+                               DEV_RX_OFFLOAD_SECURITY) == 0) {
+                       RTE_LOG(WARNING, PORT,
+                               "hardware RX IPSec offload is not supported\n");
+                       return -EINVAL;
+               }
+
+       } else { /* outbound */
+               if ((dev_info.tx_offload_capa &
+                               DEV_TX_OFFLOAD_SECURITY) == 0) {
+                       RTE_LOG(WARNING, PORT,
+                               "hardware TX IPSec offload is not supported\n");
+                       return -EINVAL;
+               }
+       }
+       return 0;
+}
+
+
 static int
 sa_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
                uint32_t nb_entries, uint32_t inbound)
@@ -706,81 +788,110 @@ sa_add_rules(struct sa_ctx *sa_ctx, const struct ipsec_sa entries[],
                *sa = entries[i];
                sa->seq = 0;
 
+               if (sa->type == RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL ||
+                       sa->type == RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO) {
+                       if (check_eth_dev_caps(sa->portid, inbound))
+                               return -EINVAL;
+               }
+
+               sa->direction = (inbound == 1) ?
+                               RTE_SECURITY_IPSEC_SA_DIR_INGRESS :
+                               RTE_SECURITY_IPSEC_SA_DIR_EGRESS;
+
                switch (sa->flags) {
                case IP4_TUNNEL:
                        sa->src.ip.ip4 = rte_cpu_to_be_32(sa->src.ip.ip4);
                        sa->dst.ip.ip4 = rte_cpu_to_be_32(sa->dst.ip.ip4);
                }
 
-               switch (sa->cipher_algo) {
-               case RTE_CRYPTO_CIPHER_NULL:
-               case RTE_CRYPTO_CIPHER_AES_CBC:
-                       iv_length = sa->iv_len;
-                       break;
-               case RTE_CRYPTO_CIPHER_AES_CTR:
-               case RTE_CRYPTO_CIPHER_AES_GCM:
+               if (sa->aead_algo == RTE_CRYPTO_AEAD_AES_GCM) {
                        iv_length = 16;
-                       break;
-               default:
-                       RTE_LOG(ERR, IPSEC_ESP, "unsupported cipher algorithm %u\n",
-                                       sa->cipher_algo);
-                       return -EINVAL;
-               }
-
-               if (inbound) {
-                       sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
-                       sa_ctx->xf[idx].b.cipher.algo = sa->cipher_algo;
-                       sa_ctx->xf[idx].b.cipher.key.data = sa->cipher_key;
-                       sa_ctx->xf[idx].b.cipher.key.length =
-                               sa->cipher_key_len;
-                       sa_ctx->xf[idx].b.cipher.op =
-                               RTE_CRYPTO_CIPHER_OP_DECRYPT;
-                       sa_ctx->xf[idx].b.cipher.iv.offset = IV_OFFSET;
-                       sa_ctx->xf[idx].b.cipher.iv.length = iv_length;
-                       sa_ctx->xf[idx].b.next = NULL;
 
-                       sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_AUTH;
-                       sa_ctx->xf[idx].a.auth.algo = sa->auth_algo;
-                       sa_ctx->xf[idx].a.auth.add_auth_data_length =
-                               sa->aad_len;
-                       sa_ctx->xf[idx].a.auth.key.data = sa->auth_key;
-                       sa_ctx->xf[idx].a.auth.key.length =
-                               sa->auth_key_len;
-                       sa_ctx->xf[idx].a.auth.digest_length =
-                               sa->digest_len;
-                       sa_ctx->xf[idx].a.auth.op =
-                               RTE_CRYPTO_AUTH_OP_VERIFY;
-
-               } else { /* outbound */
-                       sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
-                       sa_ctx->xf[idx].a.cipher.algo = sa->cipher_algo;
-                       sa_ctx->xf[idx].a.cipher.key.data = sa->cipher_key;
-                       sa_ctx->xf[idx].a.cipher.key.length =
+                       sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_AEAD;
+                       sa_ctx->xf[idx].a.aead.algo = sa->aead_algo;
+                       sa_ctx->xf[idx].a.aead.key.data = sa->cipher_key;
+                       sa_ctx->xf[idx].a.aead.key.length =
                                sa->cipher_key_len;
-                       sa_ctx->xf[idx].a.cipher.op =
-                               RTE_CRYPTO_CIPHER_OP_ENCRYPT;
-                       sa_ctx->xf[idx].a.cipher.iv.offset = IV_OFFSET;
-                       sa_ctx->xf[idx].a.cipher.iv.length = iv_length;
+                       sa_ctx->xf[idx].a.aead.op = (inbound == 1) ?
+                               RTE_CRYPTO_AEAD_OP_DECRYPT :
+                               RTE_CRYPTO_AEAD_OP_ENCRYPT;
                        sa_ctx->xf[idx].a.next = NULL;
-
-                       sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_AUTH;
-                       sa_ctx->xf[idx].b.auth.algo = sa->auth_algo;
-                       sa_ctx->xf[idx].b.auth.add_auth_data_length =
+                       sa_ctx->xf[idx].a.aead.iv.offset = IV_OFFSET;
+                       sa_ctx->xf[idx].a.aead.iv.length = iv_length;
+                       sa_ctx->xf[idx].a.aead.aad_length =
                                sa->aad_len;
-                       sa_ctx->xf[idx].b.auth.key.data = sa->auth_key;
-                       sa_ctx->xf[idx].b.auth.key.length =
-                               sa->auth_key_len;
-                       sa_ctx->xf[idx].b.auth.digest_length =
+                       sa_ctx->xf[idx].a.aead.digest_length =
                                sa->digest_len;
-                       sa_ctx->xf[idx].b.auth.op =
-                               RTE_CRYPTO_AUTH_OP_GENERATE;
-               }
 
-               sa_ctx->xf[idx].a.next = &sa_ctx->xf[idx].b;
-               sa_ctx->xf[idx].b.next = NULL;
-               sa->xforms = &sa_ctx->xf[idx].a;
+                       sa->xforms = &sa_ctx->xf[idx].a;
 
-               print_one_sa_rule(sa, inbound);
+                       print_one_sa_rule(sa, inbound);
+               } else {
+                       switch (sa->cipher_algo) {
+                       case RTE_CRYPTO_CIPHER_NULL:
+                       case RTE_CRYPTO_CIPHER_AES_CBC:
+                               iv_length = sa->iv_len;
+                               break;
+                       case RTE_CRYPTO_CIPHER_AES_CTR:
+                               iv_length = 16;
+                               break;
+                       default:
+                               RTE_LOG(ERR, IPSEC_ESP,
+                                               "unsupported cipher algorithm %u\n",
+                                               sa->cipher_algo);
+                               return -EINVAL;
+                       }
+
+                       if (inbound) {
+                               sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
+                               sa_ctx->xf[idx].b.cipher.algo = sa->cipher_algo;
+                               sa_ctx->xf[idx].b.cipher.key.data = sa->cipher_key;
+                               sa_ctx->xf[idx].b.cipher.key.length =
+                                       sa->cipher_key_len;
+                               sa_ctx->xf[idx].b.cipher.op =
+                                       RTE_CRYPTO_CIPHER_OP_DECRYPT;
+                               sa_ctx->xf[idx].b.next = NULL;
+                               sa_ctx->xf[idx].b.cipher.iv.offset = IV_OFFSET;
+                               sa_ctx->xf[idx].b.cipher.iv.length = iv_length;
+
+                               sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_AUTH;
+                               sa_ctx->xf[idx].a.auth.algo = sa->auth_algo;
+                               sa_ctx->xf[idx].a.auth.key.data = sa->auth_key;
+                               sa_ctx->xf[idx].a.auth.key.length =
+                                       sa->auth_key_len;
+                               sa_ctx->xf[idx].a.auth.digest_length =
+                                       sa->digest_len;
+                               sa_ctx->xf[idx].a.auth.op =
+                                       RTE_CRYPTO_AUTH_OP_VERIFY;
+                       } else { /* outbound */
+                               sa_ctx->xf[idx].a.type = RTE_CRYPTO_SYM_XFORM_CIPHER;
+                               sa_ctx->xf[idx].a.cipher.algo = sa->cipher_algo;
+                               sa_ctx->xf[idx].a.cipher.key.data = sa->cipher_key;
+                               sa_ctx->xf[idx].a.cipher.key.length =
+                                       sa->cipher_key_len;
+                               sa_ctx->xf[idx].a.cipher.op =
+                                       RTE_CRYPTO_CIPHER_OP_ENCRYPT;
+                               sa_ctx->xf[idx].a.next = NULL;
+                               sa_ctx->xf[idx].a.cipher.iv.offset = IV_OFFSET;
+                               sa_ctx->xf[idx].a.cipher.iv.length = iv_length;
+
+                               sa_ctx->xf[idx].b.type = RTE_CRYPTO_SYM_XFORM_AUTH;
+                               sa_ctx->xf[idx].b.auth.algo = sa->auth_algo;
+                               sa_ctx->xf[idx].b.auth.key.data = sa->auth_key;
+                               sa_ctx->xf[idx].b.auth.key.length =
+                                       sa->auth_key_len;
+                               sa_ctx->xf[idx].b.auth.digest_length =
+                                       sa->digest_len;
+                               sa_ctx->xf[idx].b.auth.op =
+                                       RTE_CRYPTO_AUTH_OP_GENERATE;
+                       }
+
+                       sa_ctx->xf[idx].a.next = &sa_ctx->xf[idx].b;
+                       sa_ctx->xf[idx].b.next = NULL;
+                       sa->xforms = &sa_ctx->xf[idx].a;
+
+                       print_one_sa_rule(sa, inbound);
+               }
        }
 
        return 0;