rte_crypto_asym.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2018 Cavium Networks
 */

#ifndef _RTE_CRYPTO_ASYM_H_
#define _RTE_CRYPTO_ASYM_H_

#include <string.h>
#include <stdint.h>

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

#include "rte_crypto_sym.h"

struct rte_cryptodev_asym_session;

#ifdef __cplusplus
extern "C" {
#endif

extern const char *
rte_crypto_asym_ke_strings[];

extern const char *
rte_crypto_asym_op_strings[];

extern const uint16_t
rte_crypto_ml_kem_pubkey_size[];
extern const uint16_t
rte_crypto_ml_kem_privkey_size[];
extern const uint16_t
rte_crypto_ml_kem_cipher_size[];
extern const uint16_t
rte_crypto_ml_dsa_pubkey_size[];
extern const uint16_t
rte_crypto_ml_dsa_privkey_size[];
extern const uint16_t
rte_crypto_ml_dsa_sign_size[];

#ifdef __cplusplus
}
#endif

#define RTE_CRYPTO_ASYM_FLAG_PUB_KEY_NO_PADDING     RTE_BIT32(0)

#define RTE_CRYPTO_ASYM_FLAG_SHARED_KEY_NO_PADDING  RTE_BIT32(1)

#define RTE_CRYPTO_ASYM_FLAG_PUB_KEY_COMPRESSED     RTE_BIT32(2)

enum rte_crypto_curve_id {
    RTE_CRYPTO_EC_GROUP_SECP192R1 = 19,
    RTE_CRYPTO_EC_GROUP_SECP224R1 = 21,
    RTE_CRYPTO_EC_GROUP_SECP256R1 = 23,
    RTE_CRYPTO_EC_GROUP_SECP384R1 = 24,
    RTE_CRYPTO_EC_GROUP_SECP521R1 = 25,
    RTE_CRYPTO_EC_GROUP_ED25519   = 29,
    RTE_CRYPTO_EC_GROUP_ED448     = 30,
    RTE_CRYPTO_EC_GROUP_SM2       = 41,
};

enum rte_crypto_edward_instance {
    RTE_CRYPTO_EDCURVE_25519,
    RTE_CRYPTO_EDCURVE_25519CTX,
    RTE_CRYPTO_EDCURVE_25519PH,
    RTE_CRYPTO_EDCURVE_448,
    RTE_CRYPTO_EDCURVE_448PH
};

enum rte_crypto_asym_xform_type {
    RTE_CRYPTO_ASYM_XFORM_UNSPECIFIED = 0,
    RTE_CRYPTO_ASYM_XFORM_NONE,
    RTE_CRYPTO_ASYM_XFORM_RSA,
    RTE_CRYPTO_ASYM_XFORM_DH,
    RTE_CRYPTO_ASYM_XFORM_DSA,
    RTE_CRYPTO_ASYM_XFORM_MODINV,
    RTE_CRYPTO_ASYM_XFORM_MODEX,
    RTE_CRYPTO_ASYM_XFORM_ECDSA,
    RTE_CRYPTO_ASYM_XFORM_ECDH,
    RTE_CRYPTO_ASYM_XFORM_ECPM,
    RTE_CRYPTO_ASYM_XFORM_ECFPM,
    RTE_CRYPTO_ASYM_XFORM_SM2,
    RTE_CRYPTO_ASYM_XFORM_EDDSA,
    RTE_CRYPTO_ASYM_XFORM_ML_KEM,
    RTE_CRYPTO_ASYM_XFORM_ML_DSA
};

enum rte_crypto_asym_op_type {
    RTE_CRYPTO_ASYM_OP_ENCRYPT,
    RTE_CRYPTO_ASYM_OP_DECRYPT,
    RTE_CRYPTO_ASYM_OP_SIGN,
    RTE_CRYPTO_ASYM_OP_VERIFY,
    RTE_CRYPTO_ASYM_OP_LIST_END
};

enum rte_crypto_asym_ke_type {
    RTE_CRYPTO_ASYM_KE_PRIV_KEY_GENERATE,
    RTE_CRYPTO_ASYM_KE_PUB_KEY_GENERATE,
    RTE_CRYPTO_ASYM_KE_SHARED_SECRET_COMPUTE,
    RTE_CRYPTO_ASYM_KE_PUB_KEY_VERIFY
};

enum rte_crypto_rsa_padding_type {
    RTE_CRYPTO_RSA_PADDING_NONE = 0,
    RTE_CRYPTO_RSA_PADDING_PKCS1_5,
    RTE_CRYPTO_RSA_PADDING_OAEP,
    RTE_CRYPTO_RSA_PADDING_PSS,
};

enum rte_crypto_rsa_priv_key_type {
    RTE_RSA_KEY_TYPE_EXP,
    RTE_RSA_KEY_TYPE_QT,
};

typedef struct rte_crypto_param_t {
    uint8_t *data;
    rte_iova_t iova;
    size_t length;
} rte_crypto_param;

typedef rte_crypto_param rte_crypto_uint;

struct rte_crypto_ec_point {
    rte_crypto_param x;
    rte_crypto_param y;
};

struct rte_crypto_rsa_priv_key_qt {
    rte_crypto_uint p;
    rte_crypto_uint q;
    rte_crypto_uint dP;
    rte_crypto_uint dQ;
    rte_crypto_uint qInv;
};

struct rte_crypto_rsa_padding {
    enum rte_crypto_rsa_padding_type type;
    enum rte_crypto_auth_algorithm hash;
    enum rte_crypto_auth_algorithm mgf1hash;
    uint16_t pss_saltlen;
    rte_crypto_param oaep_label;
};

struct rte_crypto_rsa_xform {
    rte_crypto_uint n;
    rte_crypto_uint e;
    enum rte_crypto_rsa_priv_key_type key_type;

    struct {
        rte_crypto_uint d;
        struct rte_crypto_rsa_priv_key_qt qt;
    };

    struct rte_crypto_rsa_padding padding;
};

struct rte_crypto_modex_xform {
    rte_crypto_uint modulus;
    rte_crypto_uint exponent;
};

struct rte_crypto_modinv_xform {
    rte_crypto_uint modulus;
};

struct rte_crypto_dh_xform {
    rte_crypto_uint p;
    rte_crypto_uint g;
};

struct rte_crypto_dsa_xform {
    rte_crypto_uint p;
    rte_crypto_uint q;
    rte_crypto_uint g;
    rte_crypto_uint x;
};

struct rte_crypto_ec_xform {
    enum rte_crypto_curve_id curve_id;
    rte_crypto_uint pkey;
    struct rte_crypto_ec_point q;
};

struct rte_crypto_mod_op_param {
    rte_crypto_uint base;
    rte_crypto_uint result;
};

struct rte_crypto_rsa_op_param {
    enum rte_crypto_asym_op_type op_type;
    rte_crypto_param message;
    rte_crypto_param cipher;
    rte_crypto_param sign;
};

struct rte_crypto_dh_op_param {
    enum rte_crypto_asym_ke_type ke_type;
    rte_crypto_uint priv_key;
    rte_crypto_uint pub_key;
    rte_crypto_uint shared_secret;
};

struct rte_crypto_ecdh_op_param {
    enum rte_crypto_asym_ke_type ke_type;
    rte_crypto_uint priv_key;
    struct rte_crypto_ec_point pub_key;
    struct rte_crypto_ec_point shared_secret;
};

struct rte_crypto_dsa_op_param {
    enum rte_crypto_asym_op_type op_type;
    rte_crypto_param message;
    rte_crypto_uint k;
    rte_crypto_uint r;
    rte_crypto_uint s;
    rte_crypto_uint y;
};

struct rte_crypto_ecdsa_op_param {
    enum rte_crypto_asym_op_type op_type;
    rte_crypto_param message;
    rte_crypto_uint k;
    rte_crypto_uint r;
    rte_crypto_uint s;
};

struct rte_crypto_eddsa_op_param {
    enum rte_crypto_asym_op_type op_type;
    rte_crypto_param message;
    rte_crypto_param context;
    enum rte_crypto_edward_instance instance;
    rte_crypto_uint sign;
};

struct rte_crypto_ecpm_op_param {
    struct rte_crypto_ec_point p;
    struct rte_crypto_ec_point r;
    rte_crypto_param scalar;
};

enum rte_crypto_sm2_op_capa {
    RTE_CRYPTO_SM2_RNG,
    RTE_CRYPTO_SM2_PH,
    RTE_CRYPTO_SM2_PARTIAL,
};

struct rte_crypto_sm2_op_param {
    enum rte_crypto_asym_op_type op_type;
    enum rte_crypto_auth_algorithm hash;
    rte_crypto_param message;
    union {
        rte_crypto_param cipher;
        struct {
            struct rte_crypto_ec_point c1;
            struct rte_crypto_ec_point kp;
        };
    };

    rte_crypto_uint id;
    rte_crypto_uint k;
    rte_crypto_uint r;
    rte_crypto_uint s;
};

enum rte_crypto_ml_kem_type {
    RTE_CRYPTO_ML_KEM_NONE,
    RTE_CRYPTO_ML_KEM_512,
    RTE_CRYPTO_ML_KEM_768,
    RTE_CRYPTO_ML_KEM_1024,
};

enum rte_crypto_ml_kem_op_type {
    RTE_CRYPTO_ML_KEM_OP_KEYGEN,
    RTE_CRYPTO_ML_KEM_OP_KEYVER,
    RTE_CRYPTO_ML_KEM_OP_ENCAP,
    RTE_CRYPTO_ML_KEM_OP_DECAP,
    RTE_CRYPTO_ML_KEM_OP_END
};

struct rte_crypto_ml_kem_xform {
    enum rte_crypto_ml_kem_type type;
};

struct rte_crypto_ml_kem_keygen_op {
    rte_crypto_param d;
    rte_crypto_param z;
    rte_crypto_param ek;
    rte_crypto_param dk;
};

struct rte_crypto_ml_kem_keyver_op {
    enum rte_crypto_ml_kem_op_type op;
    rte_crypto_param key;
};

struct rte_crypto_ml_kem_encap_op {
    rte_crypto_param message;
    rte_crypto_param ek;
    rte_crypto_param cipher;
    rte_crypto_param sk;
};

struct rte_crypto_ml_kem_decap_op {
    rte_crypto_param cipher;
    rte_crypto_param dk;
    rte_crypto_param sk;
};

struct rte_crypto_ml_kem_op {
    enum rte_crypto_ml_kem_op_type op;
    union {
        struct rte_crypto_ml_kem_keygen_op keygen;
        struct rte_crypto_ml_kem_keyver_op keyver;
        struct rte_crypto_ml_kem_encap_op encap;
        struct rte_crypto_ml_kem_decap_op decap;
    };
};

enum rte_crypto_ml_dsa_type {
    RTE_CRYPTO_ML_DSA_NONE,
    RTE_CRYPTO_ML_DSA_44,
    RTE_CRYPTO_ML_DSA_65,
    RTE_CRYPTO_ML_DSA_87,
};

enum rte_crypto_ml_dsa_op_type {
    RTE_CRYPTO_ML_DSA_OP_KEYGEN,
    RTE_CRYPTO_ML_DSA_OP_SIGN,
    RTE_CRYPTO_ML_DSA_OP_VERIFY,
    RTE_CRYPTO_ML_DSA_OP_END
};

struct rte_crypto_ml_dsa_xform {
    enum rte_crypto_ml_dsa_type type;
    bool sign_deterministic;
    bool sign_prehash;
};

struct rte_crypto_ml_dsa_keygen_op {
    rte_crypto_param seed;
    rte_crypto_param pubkey;
    rte_crypto_param privkey;
};

struct rte_crypto_ml_dsa_siggen_op {
    rte_crypto_param message;
    rte_crypto_param mu;
    rte_crypto_param privkey;
    rte_crypto_param seed;
    rte_crypto_param ctx;
    enum rte_crypto_auth_algorithm hash;
    rte_crypto_param sign;
};

struct rte_crypto_ml_dsa_sigver_op {
    rte_crypto_param pubkey;
    rte_crypto_param message;
    rte_crypto_param sign;
    rte_crypto_param mu;
    rte_crypto_param ctx;
    enum rte_crypto_auth_algorithm hash;
};

struct rte_crypto_ml_dsa_op {
    enum rte_crypto_ml_dsa_op_type op;
    union {
        struct rte_crypto_ml_dsa_keygen_op keygen;
        struct rte_crypto_ml_dsa_siggen_op siggen;
        struct rte_crypto_ml_dsa_sigver_op sigver;
    };
};

struct rte_crypto_asym_xform {
    struct rte_crypto_asym_xform *next;
    enum rte_crypto_asym_xform_type xform_type;
    union {
        struct rte_crypto_rsa_xform rsa;
        struct rte_crypto_modex_xform modex;
        struct rte_crypto_modinv_xform modinv;
        struct rte_crypto_dh_xform dh;
        struct rte_crypto_dsa_xform dsa;
        struct rte_crypto_ec_xform ec;
        struct rte_crypto_ml_kem_xform mlkem;
        struct rte_crypto_ml_dsa_xform mldsa;
    };
};

struct rte_crypto_asym_op {
    union {
        struct rte_cryptodev_asym_session *session;
        struct rte_crypto_asym_xform *xform;
    };

    union {
        struct rte_crypto_rsa_op_param rsa;
        struct rte_crypto_mod_op_param modex;
        struct rte_crypto_mod_op_param modinv;
        struct rte_crypto_dh_op_param dh;
        struct rte_crypto_ecdh_op_param ecdh;
        struct rte_crypto_dsa_op_param dsa;
        struct rte_crypto_ecdsa_op_param ecdsa;
        struct rte_crypto_ecpm_op_param ecpm;
        struct rte_crypto_sm2_op_param sm2;
        struct rte_crypto_eddsa_op_param eddsa;
        struct rte_crypto_ml_kem_op mlkem;
        struct rte_crypto_ml_dsa_op mldsa;
    };
    uint16_t flags;
};

#endif /* _RTE_CRYPTO_ASYM_H_ */