api/spec/crypto_types.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2014-2018 Linaro Limited
 * Copyright (c) 2021-2025 Nokia
 */
 
#ifndef ODP_API_SPEC_CRYPTO_TYPES_H_
#define ODP_API_SPEC_CRYPTO_TYPES_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/deprecated.h>
#include <odp/api/packet_types.h>
#include <odp/api/pool_types.h>
#include <odp/api/std_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    ODP_CRYPTO_SYNC,
    ODP_CRYPTO_ASYNC,
} odp_crypto_op_mode_t;
 
typedef enum {
    ODP_CRYPTO_OP_ENCODE,
    ODP_CRYPTO_OP_DECODE,
} odp_crypto_op_t;
 
typedef enum {
    ODP_CIPHER_ALG_NULL,
 
    ODP_CIPHER_ALG_DES,
 
    ODP_CIPHER_ALG_3DES_CBC,
 
    ODP_CIPHER_ALG_3DES_ECB,
 
    ODP_CIPHER_ALG_AES_CBC,
 
    ODP_CIPHER_ALG_AES_CTR,
 
    ODP_CIPHER_ALG_AES_ECB,
 
    ODP_CIPHER_ALG_AES_CFB128,
 
    ODP_CIPHER_ALG_AES_XTS,
 
    ODP_CIPHER_ALG_AES_GCM,
 
    ODP_CIPHER_ALG_AES_CCM,
 
    ODP_CIPHER_ALG_CHACHA20_POLY1305,
 
    ODP_CIPHER_ALG_KASUMI_F8,
 
    ODP_CIPHER_ALG_SNOW3G_UEA2,
 
    ODP_CIPHER_ALG_SNOW5G_NEA4,
 
    ODP_CIPHER_ALG_AES_EEA2,
 
    ODP_CIPHER_ALG_ZUC_EEA3,
 
    ODP_CIPHER_ALG_ZUC_NEA6,
 
    ODP_CIPHER_ALG_SNOW_V,
 
    ODP_CIPHER_ALG_SNOW_V_GCM,
 
    ODP_CIPHER_ALG_SM4_ECB,
 
    ODP_CIPHER_ALG_SM4_CBC,
 
    ODP_CIPHER_ALG_SM4_CTR,
 
    ODP_CIPHER_ALG_SM4_GCM,
 
    ODP_CIPHER_ALG_SM4_CCM,
 
} odp_cipher_alg_t;
 
typedef enum {
    ODP_AUTH_ALG_NULL,
 
    ODP_AUTH_ALG_MD5_HMAC,
 
    ODP_AUTH_ALG_SHA1_HMAC,
 
    ODP_AUTH_ALG_SHA224_HMAC,
 
    ODP_AUTH_ALG_SHA256_HMAC,
 
    ODP_AUTH_ALG_SHA384_HMAC,
 
    ODP_AUTH_ALG_SHA512_HMAC,
 
    ODP_AUTH_ALG_SHA3_224_HMAC,
 
    ODP_AUTH_ALG_SHA3_256_HMAC,
 
    ODP_AUTH_ALG_SHA3_384_HMAC,
 
    ODP_AUTH_ALG_SHA3_512_HMAC,
 
    ODP_AUTH_ALG_AES_GCM,
 
    ODP_AUTH_ALG_AES_GMAC,
 
    ODP_AUTH_ALG_AES_CCM,
 
    ODP_AUTH_ALG_AES_CMAC,
 
    ODP_AUTH_ALG_AES_XCBC_MAC,
 
    ODP_AUTH_ALG_CHACHA20_POLY1305,
 
    ODP_AUTH_ALG_KASUMI_F9,
 
    ODP_AUTH_ALG_SNOW3G_UIA2,
 
    ODP_AUTH_ALG_SNOW5G_NIA4,
 
    ODP_AUTH_ALG_AES_EIA2,
 
    ODP_AUTH_ALG_ZUC_EIA3,
 
    ODP_AUTH_ALG_ZUC_NIA6,
 
    ODP_AUTH_ALG_SNOW_V_GCM,
 
    ODP_AUTH_ALG_SNOW_V_GMAC,
 
    ODP_AUTH_ALG_SM3_HMAC,
 
    ODP_AUTH_ALG_SM4_GCM,
 
    ODP_AUTH_ALG_SM4_GMAC,
 
    ODP_AUTH_ALG_SM4_CCM,
 
    ODP_AUTH_ALG_MD5,
 
    ODP_AUTH_ALG_SHA1,
 
    ODP_AUTH_ALG_SHA224,
 
    ODP_AUTH_ALG_SHA256,
 
    ODP_AUTH_ALG_SHA384,
 
    ODP_AUTH_ALG_SHA512,
 
    ODP_AUTH_ALG_SHA3_224,
 
    ODP_AUTH_ALG_SHA3_256,
 
    ODP_AUTH_ALG_SHA3_384,
 
    ODP_AUTH_ALG_SHA3_512,
 
    ODP_AUTH_ALG_SM3,
 
} odp_auth_alg_t;
 
typedef union odp_crypto_cipher_algos_t {
    struct {
        uint32_t null        : 1;
 
        uint32_t des         : 1;
 
        uint32_t trides_cbc  : 1;
 
        uint32_t trides_ecb : 1;
 
        uint32_t aes_cbc     : 1;
 
        uint32_t aes_ctr     : 1;
 
        uint32_t aes_ecb     : 1;
 
        uint32_t aes_cfb128  : 1;
 
        uint32_t aes_xts     : 1;
 
        uint32_t aes_gcm     : 1;
 
        uint32_t aes_ccm     : 1;
 
        uint32_t chacha20_poly1305 : 1;
 
        uint32_t kasumi_f8   : 1;
 
        uint32_t snow3g_uea2 : 1;
 
        uint32_t snow5g_nea4 : 1;
 
        uint32_t aes_eea2 : 1;
 
        uint32_t zuc_eea3    : 1;
 
        uint32_t zuc_nea6    : 1;
 
        uint32_t snow_v      : 1;
 
        uint32_t snow_v_gcm  : 1;
 
        uint32_t sm4_ecb  : 1;
 
        uint32_t sm4_cbc  : 1;
 
        uint32_t sm4_ctr  : 1;
 
        uint32_t sm4_gcm  : 1;
 
        uint32_t sm4_ccm  : 1;
 
    } bit;
 
    uint64_t all_bits;
} odp_crypto_cipher_algos_t;
 
typedef union odp_crypto_auth_algos_t {
    struct {
        uint32_t null        : 1;
 
        uint32_t md5_hmac    : 1;
 
        uint32_t sha1_hmac : 1;
 
        uint32_t sha224_hmac : 1;
 
        uint32_t sha256_hmac : 1;
 
        uint32_t sha384_hmac : 1;
 
        uint32_t sha512_hmac : 1;
 
        uint32_t sha3_224_hmac : 1;
 
        uint32_t sha3_256_hmac : 1;
 
        uint32_t sha3_384_hmac : 1;
 
        uint32_t sha3_512_hmac : 1;
 
        uint32_t aes_gcm     : 1;
 
        uint32_t aes_gmac    : 1;
 
        uint32_t aes_ccm     : 1;
 
        uint32_t aes_cmac    : 1;
 
        uint32_t aes_xcbc_mac    : 1;
 
        uint32_t chacha20_poly1305 : 1;
 
        uint32_t kasumi_f9   : 1;
 
        uint32_t snow3g_uia2 : 1;
 
        uint32_t snow5g_nia4 : 1;
 
        uint32_t aes_eia2 : 1;
 
        uint32_t zuc_eia3    : 1;
 
        uint32_t zuc_nia6    : 1;
 
        uint32_t snow_v_gcm : 1;
 
        uint32_t snow_v_gmac : 1;
 
        uint32_t sm3_hmac : 1;
 
        uint32_t sm4_gcm : 1;
 
        uint32_t sm4_gmac : 1;
 
        uint32_t sm4_ccm : 1;
 
        uint32_t md5 : 1;
 
        uint32_t sha1 : 1;
 
        uint32_t sha224 : 1;
 
        uint32_t sha256 : 1;
 
        uint32_t sha384 : 1;
 
        uint32_t sha512 : 1;
 
        uint32_t sha3_224 : 1;
 
        uint32_t sha3_256 : 1;
 
        uint32_t sha3_384 : 1;
 
        uint32_t sha3_512 : 1;
 
        uint32_t sm3 : 1;
 
    } bit;
 
    uint64_t all_bits;
} odp_crypto_auth_algos_t;
 
typedef struct odp_crypto_key {
    uint8_t *data;
 
    uint32_t length;
 
} odp_crypto_key_t;
 
typedef enum odp_crypto_op_type_t {
    ODP_CRYPTO_OP_TYPE_BASIC,
 
    ODP_CRYPTO_OP_TYPE_OOP,
 
    ODP_CRYPTO_OP_TYPE_BASIC_AND_OOP,
 
} odp_crypto_op_type_t;
 
typedef struct odp_crypto_session_param_t {
    odp_crypto_op_t op;
 
    odp_crypto_op_type_t op_type;
 
    odp_bool_t cipher_range_in_bits;
 
    odp_bool_t auth_range_in_bits;
 
    odp_bool_t auth_cipher_text;
 
    odp_bool_t hash_result_in_auth_range;
 
    odp_bool_t null_crypto_enable;
 
    odp_crypto_op_mode_t op_mode;
 
    odp_cipher_alg_t cipher_alg;
 
    odp_crypto_key_t cipher_key;
 
    uint32_t cipher_iv_len;
 
    odp_auth_alg_t auth_alg;
 
    odp_crypto_key_t auth_key;
 
    uint32_t auth_iv_len;
 
    uint32_t auth_digest_len;
 
    uint32_t auth_aad_len;
 
    odp_queue_t compl_queue;
 
    odp_pool_t output_pool;
 
} odp_crypto_session_param_t;
 
typedef struct odp_crypto_packet_op_param_t {
    odp_crypto_session_t session;
 
    const uint8_t *cipher_iv_ptr;
 
    const uint8_t *auth_iv_ptr;
 
    uint32_t hash_result_offset;
 
    const uint8_t *aad_ptr;
 
    odp_packet_data_range_t cipher_range;
 
    odp_packet_data_range_t auth_range;
 
    int32_t dst_offset_shift;
 
    uint8_t null_crypto :1;
 
} odp_crypto_packet_op_param_t;
 
typedef enum {
    ODP_CRYPTO_SES_ERR_NONE,
    ODP_CRYPTO_SES_ERR_ENOMEM,
    ODP_CRYPTO_SES_ERR_CIPHER,
    ODP_CRYPTO_SES_ERR_AUTH,
 
    ODP_CRYPTO_SES_ERR_ALG_COMBO,
 
    ODP_CRYPTO_SES_ERR_ALG_ORDER,
 
    ODP_CRYPTO_SES_ERR_PARAMS,
} odp_crypto_ses_create_err_t;
 
typedef enum {
    ODP_CRYPTO_ALG_ERR_NONE,
    ODP_CRYPTO_ALG_ERR_DATA_SIZE,
    ODP_CRYPTO_ALG_ERR_ICV_CHECK,
    ODP_CRYPTO_ALG_ERR_OTHER,
} odp_crypto_alg_err_t;
 
typedef struct odp_crypto_op_status {
    odp_crypto_alg_err_t alg_err;
} odp_crypto_op_status_t;
 
typedef struct odp_crypto_packet_result_t {
    odp_packet_t pkt_in;
 
    odp_crypto_op_status_t cipher_status;
 
    odp_crypto_op_status_t auth_status;
 
} odp_crypto_packet_result_t;
 
typedef struct odp_crypto_capability_t {
    uint32_t max_sessions;
 
    odp_support_t sync_mode;
 
    odp_support_t async_mode;
 
    odp_crypto_cipher_algos_t ciphers;
 
    odp_crypto_cipher_algos_t hw_ciphers;
 
    odp_crypto_auth_algos_t   auths;
 
    odp_crypto_auth_algos_t   hw_auths;
 
    odp_bool_t queue_type_sched;
 
    odp_bool_t queue_type_plain;
} odp_crypto_capability_t;
 
typedef struct odp_crypto_cipher_capability_t {
    uint32_t key_len;
 
    uint32_t iv_len;
 
    odp_bool_t bit_mode;
 
} odp_crypto_cipher_capability_t;
 
typedef struct odp_crypto_auth_capability_t {
    uint32_t digest_len;
 
    uint32_t key_len;
 
    uint32_t iv_len;
 
    struct {
        uint32_t min;
 
        uint32_t max;
 
        uint32_t inc;
    } aad_len;
 
    odp_bool_t bit_mode;
 
} odp_crypto_auth_capability_t;
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif