rte_crypto_sym.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2016-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.
 */

#ifndef _RTE_CRYPTO_SYM_H_
#define _RTE_CRYPTO_SYM_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <string.h>

#include <rte_mbuf.h>
#include <rte_memory.h>
#include <rte_mempool.h>
#include <rte_common.h>


enum rte_crypto_cipher_algorithm {
    RTE_CRYPTO_CIPHER_NULL = 1,
    RTE_CRYPTO_CIPHER_3DES_CBC,
    RTE_CRYPTO_CIPHER_3DES_CTR,
    RTE_CRYPTO_CIPHER_3DES_ECB,
    RTE_CRYPTO_CIPHER_AES_CBC,
    RTE_CRYPTO_CIPHER_AES_CTR,
    RTE_CRYPTO_CIPHER_AES_ECB,
    RTE_CRYPTO_CIPHER_AES_F8,
    RTE_CRYPTO_CIPHER_AES_XTS,
    RTE_CRYPTO_CIPHER_ARC4,
    RTE_CRYPTO_CIPHER_KASUMI_F8,
    RTE_CRYPTO_CIPHER_SNOW3G_UEA2,
    RTE_CRYPTO_CIPHER_ZUC_EEA3,
    RTE_CRYPTO_CIPHER_DES_CBC,
    RTE_CRYPTO_CIPHER_AES_DOCSISBPI,
    RTE_CRYPTO_CIPHER_DES_DOCSISBPI,
    RTE_CRYPTO_CIPHER_LIST_END

};

extern const char *
rte_crypto_cipher_algorithm_strings[];

enum rte_crypto_cipher_operation {
    RTE_CRYPTO_CIPHER_OP_ENCRYPT,
    RTE_CRYPTO_CIPHER_OP_DECRYPT
};

extern const char *
rte_crypto_cipher_operation_strings[];

struct rte_crypto_cipher_xform {
    enum rte_crypto_cipher_operation op;
    enum rte_crypto_cipher_algorithm algo;
    struct {
        uint8_t *data;  
        uint16_t length;
    } key;
    struct {
        uint16_t offset;
        uint16_t length;
    } iv;   
};

enum rte_crypto_auth_algorithm {
    RTE_CRYPTO_AUTH_NULL = 1,
    RTE_CRYPTO_AUTH_AES_CBC_MAC,
    RTE_CRYPTO_AUTH_AES_CMAC,
    RTE_CRYPTO_AUTH_AES_GMAC,
    RTE_CRYPTO_AUTH_AES_XCBC_MAC,
    RTE_CRYPTO_AUTH_KASUMI_F9,
    RTE_CRYPTO_AUTH_MD5,
    RTE_CRYPTO_AUTH_MD5_HMAC,
    RTE_CRYPTO_AUTH_SHA1,
    RTE_CRYPTO_AUTH_SHA1_HMAC,
    RTE_CRYPTO_AUTH_SHA224,
    RTE_CRYPTO_AUTH_SHA224_HMAC,
    RTE_CRYPTO_AUTH_SHA256,
    RTE_CRYPTO_AUTH_SHA256_HMAC,
    RTE_CRYPTO_AUTH_SHA384,
    RTE_CRYPTO_AUTH_SHA384_HMAC,
    RTE_CRYPTO_AUTH_SHA512,
    RTE_CRYPTO_AUTH_SHA512_HMAC,
    RTE_CRYPTO_AUTH_SNOW3G_UIA2,
    RTE_CRYPTO_AUTH_ZUC_EIA3,
    RTE_CRYPTO_AUTH_LIST_END
};

extern const char *
rte_crypto_auth_algorithm_strings[];

enum rte_crypto_auth_operation {
    RTE_CRYPTO_AUTH_OP_VERIFY,  
    RTE_CRYPTO_AUTH_OP_GENERATE 
};

extern const char *
rte_crypto_auth_operation_strings[];

struct rte_crypto_auth_xform {
    enum rte_crypto_auth_operation op;
    enum rte_crypto_auth_algorithm algo;
    struct {
        uint8_t *data;  
        uint16_t length;
    } key;
    struct {
        uint16_t offset;
        uint16_t length;
    } iv;   
    uint16_t digest_length;
};


enum rte_crypto_aead_algorithm {
    RTE_CRYPTO_AEAD_AES_CCM = 1,
    RTE_CRYPTO_AEAD_AES_GCM,
    RTE_CRYPTO_AEAD_LIST_END
};

extern const char *
rte_crypto_aead_algorithm_strings[];

enum rte_crypto_aead_operation {
    RTE_CRYPTO_AEAD_OP_ENCRYPT,
    RTE_CRYPTO_AEAD_OP_DECRYPT
};

extern const char *
rte_crypto_aead_operation_strings[];

struct rte_crypto_aead_xform {
    enum rte_crypto_aead_operation op;
    enum rte_crypto_aead_algorithm algo;
    struct {
        uint8_t *data;  
        uint16_t length;
    } key;

    struct {
        uint16_t offset;
        uint16_t length;
    } iv;   
    uint16_t digest_length;

    uint16_t aad_length;
};

enum rte_crypto_sym_xform_type {
    RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED = 0, 
    RTE_CRYPTO_SYM_XFORM_AUTH,      
    RTE_CRYPTO_SYM_XFORM_CIPHER,        
    RTE_CRYPTO_SYM_XFORM_AEAD       
};

struct rte_crypto_sym_xform {
    struct rte_crypto_sym_xform *next;
    enum rte_crypto_sym_xform_type type
    ; 
    RTE_STD_C11
    union {
        struct rte_crypto_auth_xform auth;
        struct rte_crypto_cipher_xform cipher;
        struct rte_crypto_aead_xform aead;
    };
};

struct rte_cryptodev_sym_session;

struct rte_crypto_sym_op {
    struct rte_mbuf *m_src; 
    struct rte_mbuf *m_dst; 
    RTE_STD_C11
    union {
        struct rte_cryptodev_sym_session *session;
        struct rte_crypto_sym_xform *xform;
        struct rte_security_session *sec_session;
    };

    RTE_STD_C11
    union {
        struct {
            struct {
                uint32_t offset;
                uint32_t length;
            } data; 
            struct {
                uint8_t *data;
                rte_iova_t phys_addr;
            } digest; 
            struct {
                uint8_t *data;
                rte_iova_t phys_addr;   
            } aad;
        } aead;

        struct {
            struct {
                struct {
                    uint32_t offset;
                    uint32_t length;
                } data; 
            } cipher;

            struct {
                struct {
                    uint32_t offset;
                    uint32_t length;
                } data;
                struct {
                    uint8_t *data;
                    rte_iova_t phys_addr;
                } digest; 
            } auth;
        };
    };
};


static inline void
__rte_crypto_sym_op_reset(struct rte_crypto_sym_op *op)
{
    memset(op, 0, sizeof(*op));
}


static inline struct rte_crypto_sym_xform *
__rte_crypto_sym_op_sym_xforms_alloc(struct rte_crypto_sym_op *sym_op,
        void *priv_data, uint8_t nb_xforms)
{
    struct rte_crypto_sym_xform *xform;

    sym_op->xform = xform = (struct rte_crypto_sym_xform *)priv_data;

    do {
        xform->type = RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED;
        xform = xform->next = --nb_xforms > 0 ? xform + 1 : NULL;
    } while (xform);

    return sym_op->xform;
}


static inline int
__rte_crypto_sym_op_attach_sym_session(struct rte_crypto_sym_op *sym_op,
        struct rte_cryptodev_sym_session *sess)
{
    sym_op->session = sess;

    return 0;
}


#ifdef __cplusplus
}
#endif

#endif /* _RTE_CRYPTO_SYM_H_ */