crypto/aesni_mb: support AES-CCM
[dpdk.git] / drivers / crypto / aesni_mb / rte_aesni_mb_pmd.c
index f91504d..636c6c3 100644 (file)
@@ -1,41 +1,14 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2015-2017 Intel Corporation. All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2015-2017 Intel Corporation
  */
 
+#include <des.h>
+
 #include <rte_common.h>
 #include <rte_hexdump.h>
 #include <rte_cryptodev.h>
 #include <rte_cryptodev_pmd.h>
-#include <rte_cryptodev_vdev.h>
-#include <rte_vdev.h>
+#include <rte_bus_vdev.h>
 #include <rte_malloc.h>
 #include <rte_cpuflags.h>
 
@@ -109,6 +82,15 @@ aesni_mb_get_chain_order(const struct rte_crypto_sym_xform *xform)
                        return AESNI_MB_OP_HASH_CIPHER;
        }
 
+       if (xform->type == RTE_CRYPTO_SYM_XFORM_AEAD) {
+               if (xform->aead.algo == RTE_CRYPTO_AEAD_AES_CCM) {
+                       if (xform->aead.op == RTE_CRYPTO_AEAD_OP_ENCRYPT)
+                               return AESNI_MB_OP_AEAD_CIPHER_HASH;
+                       else
+                               return AESNI_MB_OP_AEAD_HASH_CIPHER;
+               }
+       }
+
        return AESNI_MB_OP_NOT_SUPPORTED;
 }
 
@@ -188,6 +170,7 @@ aesni_mb_set_session_cipher_parameters(const struct aesni_mb_op_fns *mb_ops,
                struct aesni_mb_session *sess,
                const struct rte_crypto_sym_xform *xform)
 {
+       uint8_t is_aes = 0;
        aes_keyexp_t aes_keyexp_fn;
 
        if (xform == NULL) {
@@ -217,43 +200,121 @@ aesni_mb_set_session_cipher_parameters(const struct aesni_mb_op_fns *mb_ops,
        switch (xform->cipher.algo) {
        case RTE_CRYPTO_CIPHER_AES_CBC:
                sess->cipher.mode = CBC;
+               is_aes = 1;
                break;
        case RTE_CRYPTO_CIPHER_AES_CTR:
                sess->cipher.mode = CNTR;
+               is_aes = 1;
                break;
        case RTE_CRYPTO_CIPHER_AES_DOCSISBPI:
                sess->cipher.mode = DOCSIS_SEC_BPI;
+               is_aes = 1;
+               break;
+       case RTE_CRYPTO_CIPHER_DES_CBC:
+               sess->cipher.mode = DES;
+               break;
+       case RTE_CRYPTO_CIPHER_DES_DOCSISBPI:
+               sess->cipher.mode = DOCSIS_DES;
                break;
        default:
                MB_LOG_ERR("Unsupported cipher mode parameter");
                return -ENOTSUP;
        }
 
-       /* Check key length and choose key expansion function */
-       switch (xform->cipher.key.length) {
+       /* Set IV parameters */
+       sess->iv.offset = xform->cipher.iv.offset;
+       sess->iv.length = xform->cipher.iv.length;
+
+       /* Check key length and choose key expansion function for AES */
+       if (is_aes) {
+               switch (xform->cipher.key.length) {
+               case AES_128_BYTES:
+                       sess->cipher.key_length_in_bytes = AES_128_BYTES;
+                       aes_keyexp_fn = mb_ops->aux.keyexp.aes128;
+                       break;
+               case AES_192_BYTES:
+                       sess->cipher.key_length_in_bytes = AES_192_BYTES;
+                       aes_keyexp_fn = mb_ops->aux.keyexp.aes192;
+                       break;
+               case AES_256_BYTES:
+                       sess->cipher.key_length_in_bytes = AES_256_BYTES;
+                       aes_keyexp_fn = mb_ops->aux.keyexp.aes256;
+                       break;
+               default:
+                       MB_LOG_ERR("Invalid cipher key length");
+                       return -EINVAL;
+               }
+
+               /* Expanded cipher keys */
+               (*aes_keyexp_fn)(xform->cipher.key.data,
+                               sess->cipher.expanded_aes_keys.encode,
+                               sess->cipher.expanded_aes_keys.decode);
+
+       } else {
+               if (xform->cipher.key.length != 8) {
+                       MB_LOG_ERR("Invalid cipher key length");
+                       return -EINVAL;
+               }
+               sess->cipher.key_length_in_bytes = 8;
+
+               des_key_schedule((uint64_t *)sess->cipher.expanded_aes_keys.encode,
+                               xform->cipher.key.data);
+               des_key_schedule((uint64_t *)sess->cipher.expanded_aes_keys.decode,
+                               xform->cipher.key.data);
+       }
+
+       return 0;
+}
+
+static int
+aesni_mb_set_session_aead_parameters(const struct aesni_mb_op_fns *mb_ops,
+               struct aesni_mb_session *sess,
+               const struct rte_crypto_sym_xform *xform)
+{
+       aes_keyexp_t aes_keyexp_fn;
+
+       switch (xform->aead.op) {
+       case RTE_CRYPTO_AEAD_OP_ENCRYPT:
+               sess->cipher.direction = ENCRYPT;
+               sess->auth.operation = RTE_CRYPTO_AUTH_OP_GENERATE;
+               break;
+       case RTE_CRYPTO_AEAD_OP_DECRYPT:
+               sess->cipher.direction = DECRYPT;
+               sess->auth.operation = RTE_CRYPTO_AUTH_OP_VERIFY;
+               break;
+       default:
+               MB_LOG_ERR("Invalid aead operation parameter");
+               return -EINVAL;
+       }
+
+       switch (xform->aead.algo) {
+       case RTE_CRYPTO_AEAD_AES_CCM:
+               sess->cipher.mode = CCM;
+               sess->auth.algo = AES_CCM;
+               break;
+       default:
+               MB_LOG_ERR("Unsupported aead mode parameter");
+               return -ENOTSUP;
+       }
+
+       /* Set IV parameters */
+       sess->iv.offset = xform->aead.iv.offset;
+       sess->iv.length = xform->aead.iv.length;
+
+       /* Check key length and choose key expansion function for AES */
+
+       switch (xform->aead.key.length) {
        case AES_128_BYTES:
                sess->cipher.key_length_in_bytes = AES_128_BYTES;
                aes_keyexp_fn = mb_ops->aux.keyexp.aes128;
                break;
-       case AES_192_BYTES:
-               sess->cipher.key_length_in_bytes = AES_192_BYTES;
-               aes_keyexp_fn = mb_ops->aux.keyexp.aes192;
-               break;
-       case AES_256_BYTES:
-               sess->cipher.key_length_in_bytes = AES_256_BYTES;
-               aes_keyexp_fn = mb_ops->aux.keyexp.aes256;
-               break;
        default:
                MB_LOG_ERR("Invalid cipher key length");
                return -EINVAL;
        }
 
-       /* Set IV parameters */
-       sess->iv.offset = xform->cipher.iv.offset;
-       sess->iv.length = xform->cipher.iv.length;
-
        /* Expanded cipher keys */
-       (*aes_keyexp_fn)(xform->cipher.key.data,
+       (*aes_keyexp_fn)(xform->aead.key.data,
                        sess->cipher.expanded_aes_keys.encode,
                        sess->cipher.expanded_aes_keys.decode);
 
@@ -268,6 +329,7 @@ aesni_mb_set_session_parameters(const struct aesni_mb_op_fns *mb_ops,
 {
        const struct rte_crypto_sym_xform *auth_xform = NULL;
        const struct rte_crypto_sym_xform *cipher_xform = NULL;
+       const struct rte_crypto_sym_xform *aead_xform = NULL;
        int ret;
 
        /* Select Crypto operation - hash then cipher / cipher then hash */
@@ -301,6 +363,18 @@ aesni_mb_set_session_parameters(const struct aesni_mb_op_fns *mb_ops,
                auth_xform = NULL;
                cipher_xform = xform;
                break;
+       case AESNI_MB_OP_AEAD_CIPHER_HASH:
+               sess->chain_order = CIPHER_HASH;
+               sess->aead.aad_len = xform->aead.aad_length;
+               sess->aead.digest_len = xform->aead.digest_length;
+               aead_xform = xform;
+               break;
+       case AESNI_MB_OP_AEAD_HASH_CIPHER:
+               sess->chain_order = HASH_CIPHER;
+               sess->aead.aad_len = xform->aead.aad_length;
+               sess->aead.digest_len = xform->aead.digest_length;
+               aead_xform = xform;
+               break;
        case AESNI_MB_OP_NOT_SUPPORTED:
        default:
                MB_LOG_ERR("Unsupported operation chain order parameter");
@@ -323,6 +397,15 @@ aesni_mb_set_session_parameters(const struct aesni_mb_op_fns *mb_ops,
                return ret;
        }
 
+       if (aead_xform) {
+               ret = aesni_mb_set_session_aead_parameters(mb_ops, sess,
+                               aead_xform);
+               if (ret != 0) {
+                       MB_LOG_ERR("Invalid/unsupported aead parameters");
+                       return ret;
+               }
+       }
+
        return 0;
 }
 
@@ -437,6 +520,9 @@ set_mb_job_params(JOB_AES_HMAC *job, struct aesni_mb_qp *qp,
                job->_k1_expanded = session->auth.xcbc.k1_expanded;
                job->_k2 = session->auth.xcbc.k2;
                job->_k3 = session->auth.xcbc.k3;
+       } else if (job->hash_alg == AES_CCM) {
+               job->u.CCM.aad = op->sym->aead.aad.data + 18;
+               job->u.CCM.aad_len_in_bytes = session->aead.aad_len;
        } else {
                job->hashed_auth_key_xor_ipad = session->auth.pads.inner;
                job->hashed_auth_key_xor_opad = session->auth.pads.outer;
@@ -460,7 +546,10 @@ set_mb_job_params(JOB_AES_HMAC *job, struct aesni_mb_qp *qp,
                                rte_pktmbuf_data_len(op->sym->m_src));
        } else {
                m_dst = m_src;
-               m_offset = op->sym->cipher.data.offset;
+               if (job->hash_alg == AES_CCM)
+                       m_offset = op->sym->aead.data.offset;
+               else
+                       m_offset = op->sym->cipher.data.offset;
        }
 
        /* Set digest output location */
@@ -469,30 +558,51 @@ set_mb_job_params(JOB_AES_HMAC *job, struct aesni_mb_qp *qp,
                job->auth_tag_output = qp->temp_digests[*digest_idx];
                *digest_idx = (*digest_idx + 1) % MAX_JOBS;
        } else {
-               job->auth_tag_output = op->sym->auth.digest.data;
+               if (job->hash_alg == AES_CCM)
+                       job->auth_tag_output = op->sym->aead.digest.data;
+               else
+                       job->auth_tag_output = op->sym->auth.digest.data;
        }
 
        /*
         * Multi-buffer library current only support returning a truncated
         * digest length as specified in the relevant IPsec RFCs
         */
-       job->auth_tag_output_len_in_bytes =
-                       get_truncated_digest_byte_length(job->hash_alg);
+       if (job->hash_alg != AES_CCM)
+               job->auth_tag_output_len_in_bytes =
+                               get_truncated_digest_byte_length(job->hash_alg);
+       else
+               job->auth_tag_output_len_in_bytes = session->aead.digest_len;
+
 
        /* Set IV parameters */
-       job->iv = rte_crypto_op_ctod_offset(op, uint8_t *,
-                       session->iv.offset);
+
        job->iv_len_in_bytes = session->iv.length;
 
        /* Data  Parameter */
        job->src = rte_pktmbuf_mtod(m_src, uint8_t *);
        job->dst = rte_pktmbuf_mtod_offset(m_dst, uint8_t *, m_offset);
 
-       job->cipher_start_src_offset_in_bytes = op->sym->cipher.data.offset;
-       job->msg_len_to_cipher_in_bytes = op->sym->cipher.data.length;
+       if (job->hash_alg == AES_CCM) {
+               job->cipher_start_src_offset_in_bytes =
+                               op->sym->aead.data.offset;
+               job->msg_len_to_cipher_in_bytes = op->sym->aead.data.length;
+               job->hash_start_src_offset_in_bytes = op->sym->aead.data.offset;
+               job->msg_len_to_hash_in_bytes = op->sym->aead.data.length;
 
-       job->hash_start_src_offset_in_bytes = op->sym->auth.data.offset;
-       job->msg_len_to_hash_in_bytes = op->sym->auth.data.length;
+               job->iv = rte_crypto_op_ctod_offset(op, uint8_t *,
+                       session->iv.offset + 1);
+       } else {
+               job->cipher_start_src_offset_in_bytes =
+                               op->sym->cipher.data.offset;
+               job->msg_len_to_cipher_in_bytes = op->sym->cipher.data.length;
+
+               job->hash_start_src_offset_in_bytes = op->sym->auth.data.offset;
+               job->msg_len_to_hash_in_bytes = op->sym->auth.data.length;
+
+               job->iv = rte_crypto_op_ctod_offset(op, uint8_t *,
+                       session->iv.offset);
+       }
 
        /* Set user data to be crypto operation data struct */
        job->user_data = op;
@@ -504,9 +614,15 @@ static inline void
 verify_digest(struct aesni_mb_qp *qp __rte_unused, JOB_AES_HMAC *job,
                struct rte_crypto_op *op) {
        /* Verify digest if required */
-       if (memcmp(job->auth_tag_output, op->sym->auth.digest.data,
-                       job->auth_tag_output_len_in_bytes) != 0)
-               op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
+       if (job->hash_alg == AES_CCM) {
+               if (memcmp(job->auth_tag_output, op->sym->aead.digest.data,
+                               job->auth_tag_output_len_in_bytes) != 0)
+                       op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
+       } else {
+               if (memcmp(job->auth_tag_output, op->sym->auth.digest.data,
+                               job->auth_tag_output_len_in_bytes) != 0)
+                       op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
+       }
 }
 
 /**
@@ -689,15 +805,23 @@ static int cryptodev_aesni_mb_remove(struct rte_vdev_device *vdev);
 static int
 cryptodev_aesni_mb_create(const char *name,
                        struct rte_vdev_device *vdev,
-                       struct rte_crypto_vdev_init_params *init_params)
+                       struct rte_cryptodev_pmd_init_params *init_params)
 {
        struct rte_cryptodev *dev;
        struct aesni_mb_private *internals;
        enum aesni_mb_vector_mode vector_mode;
 
-       if (init_params->name[0] == '\0')
-               snprintf(init_params->name, sizeof(init_params->name),
-                               "%s", name);
+       /* Check CPU for support for AES instruction set */
+       if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_AES)) {
+               MB_LOG_ERR("AES instructions not supported by CPU");
+               return -EFAULT;
+       }
+
+       dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
+       if (dev == NULL) {
+               MB_LOG_ERR("failed to create cryptodev vdev");
+               return -ENODEV;
+       }
 
        /* Check CPU for supported vector instruction set */
        if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX512F))
@@ -709,14 +833,6 @@ cryptodev_aesni_mb_create(const char *name,
        else
                vector_mode = RTE_AESNI_MB_SSE;
 
-       dev = rte_cryptodev_vdev_pmd_init(init_params->name,
-                       sizeof(struct aesni_mb_private), init_params->socket_id,
-                       vdev);
-       if (dev == NULL) {
-               MB_LOG_ERR("failed to create cryptodev vdev");
-               goto init_error;
-       }
-
        dev->driver_id = cryptodev_driver_id;
        dev->dev_ops = rte_aesni_mb_pmd_ops;
 
@@ -753,41 +869,33 @@ cryptodev_aesni_mb_create(const char *name,
        internals->max_nb_sessions = init_params->max_nb_sessions;
 
        return 0;
-init_error:
-       MB_LOG_ERR("driver %s: cryptodev_aesni_create failed",
-                       init_params->name);
-
-       cryptodev_aesni_mb_remove(vdev);
-       return -EFAULT;
 }
 
 static int
 cryptodev_aesni_mb_probe(struct rte_vdev_device *vdev)
 {
-       struct rte_crypto_vdev_init_params init_params = {
-               RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
-               RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
+       struct rte_cryptodev_pmd_init_params init_params = {
+               "",
+               sizeof(struct aesni_mb_private),
                rte_socket_id(),
-               ""
+               RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS,
+               RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_SESSIONS
        };
-       const char *name;
-       const char *input_args;
+       const char *name, *args;
+       int retval;
 
        name = rte_vdev_device_name(vdev);
        if (name == NULL)
                return -EINVAL;
-       input_args = rte_vdev_device_args(vdev);
-       rte_cryptodev_vdev_parse_init_params(&init_params, input_args);
-
-       RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", name,
-                       init_params.socket_id);
-       if (init_params.name[0] != '\0')
-               RTE_LOG(INFO, PMD, "  User defined name = %s\n",
-                       init_params.name);
-       RTE_LOG(INFO, PMD, "  Max number of queue pairs = %d\n",
-                       init_params.max_nb_queue_pairs);
-       RTE_LOG(INFO, PMD, "  Max number of sessions = %d\n",
-                       init_params.max_nb_sessions);
+
+       args = rte_vdev_device_args(vdev);
+
+       retval = rte_cryptodev_pmd_parse_input_args(&init_params, args);
+       if (retval) {
+               MB_LOG_ERR("Failed to parse initialisation arguments[%s]\n",
+                               args);
+               return -EINVAL;
+       }
 
        return cryptodev_aesni_mb_create(name, vdev, &init_params);
 }
@@ -795,16 +903,18 @@ cryptodev_aesni_mb_probe(struct rte_vdev_device *vdev)
 static int
 cryptodev_aesni_mb_remove(struct rte_vdev_device *vdev)
 {
+       struct rte_cryptodev *cryptodev;
        const char *name;
 
        name = rte_vdev_device_name(vdev);
        if (name == NULL)
                return -EINVAL;
 
-       RTE_LOG(INFO, PMD, "Closing AESNI crypto device %s on numa socket %u\n",
-                       name, rte_socket_id());
+       cryptodev = rte_cryptodev_pmd_get_named_dev(name);
+       if (cryptodev == NULL)
+               return -ENODEV;
 
-       return 0;
+       return rte_cryptodev_pmd_destroy(cryptodev);
 }
 
 static struct rte_vdev_driver cryptodev_aesni_mb_pmd_drv = {