[dpdk-dev,v2,3/6] lib/cryptodev: add asymmetric crypto capability in cryptodev
Checks
Commit Message
Extend cryptodev with asymmetric capability APIs and
definitions.
Signed-off-by: Shally Verma <shally.verma@caviumnetworks.com>
Signed-off-by: Sunila Sahu <sunila.sahu@caviumnetworks.com>
Signed-off-by: Ashish Gupta <ashish.gupta@caviumnetworks.com>
---
User must apply patch
"lib/cryptodev: add asymmetric algos in cryptodev" before compilation
---
lib/librte_cryptodev/rte_cryptodev.c | 96 ++++++++++++++++++++++
lib/librte_cryptodev/rte_cryptodev.h | 105 ++++++++++++++++++++++++-
lib/librte_cryptodev/rte_cryptodev_version.map | 4 +
3 files changed, 204 insertions(+), 1 deletion(-)
Comments
Hi Shally,
> -----Original Message-----
> From: Shally Verma [mailto:shally.verma@caviumnetworks.com]
> Sent: Thursday, April 5, 2018 12:25 PM
> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Cc: Doherty, Declan <declan.doherty@intel.com>; Trahe, Fiona <fiona.trahe@intel.com>;
> pathreya@caviumnetworks.com; ssahu@caviumnetworks.com; agupta@caviumnetworks.com;
> dev@dpdk.org; Sunila Sahu <sunila.sahu@caviumnetworks.com>; Ashish Gupta
> <ashish.gupta@caviumnetworks.com>
> Subject: [PATCH v2 3/6] lib/cryptodev: add asymmetric crypto capability in cryptodev
>
> Extend cryptodev with asymmetric capability APIs and
> definitions.
>
> Signed-off-by: Shally Verma <shally.verma@caviumnetworks.com>
> Signed-off-by: Sunila Sahu <sunila.sahu@caviumnetworks.com>
> Signed-off-by: Ashish Gupta <ashish.gupta@caviumnetworks.com>
>
> ---
/// snip ///
> +int __rte_experimental
> +rte_cryptodev_asym_xfrm_capability_check_modlen(
> + const struct rte_cryptodev_asymmetric_xfrm_capability *capability,
> + uint16_t modlen)
> +{
> + /* handle special case of 0 which mean PMD define no limit defined */
[Fiona] grammar. Maybe "which means PMD doesn't define any limit"
> + if ((capability->modlen.min != 0) &&
> + ((modlen < capability->modlen.min) ||
> + (capability->modlen.increment != 0 &&
> + (modlen % (capability->modlen.increment)))))
> + return -1;
> + if ((capability->modlen.max != 0) &&
> + ((modlen > capability->modlen.max) ||
> + (capability->modlen.increment != 0 &&
> + (modlen % (capability->modlen.increment)))))
> + return -1;
> +
> + return 0;
> +}
> +
>
> const char *
> rte_cryptodev_get_feature_name(uint64_t flag)
> diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
> index 68d1ae1..deae3d6 100644
> --- a/lib/librte_cryptodev/rte_cryptodev.h
> +++ b/lib/librte_cryptodev/rte_cryptodev.h
> @@ -178,6 +178,37 @@ struct rte_cryptodev_symmetric_capability {
> };
> };
>
> +/**
> + * Asymmetric Xform Crypto Capability
> + *
> + */
> +struct rte_cryptodev_asymmetric_xfrm_capability {
> + enum rte_crypto_asym_xform_type xform_type;
> + /**< Transform type: RSA/MODEXP/DH/DSA/MODINV */
> +
> + uint32_t op_types;
> + /**< bitmask for supported rte_crypto_asym_op_type */
> +
> + __extension__
> + union {
> + struct rte_crypto_param_range modlen;
> + /**< Range of modulus length supported by modulus based xform.
> + * Value 0 mean implementation default
> + */
> + };
> +};
> +
> +/**
> + * Asymmetric Crypto Capability
> + *
> + */
> +struct rte_cryptodev_asymmetric_capability {
> + enum rte_crypto_asym_xform_type xform_type;
> + /**< Transform type: RSA/MODEXP/DH/DSA/MODINV */
> + struct rte_cryptodev_asymmetric_xfrm_capability xfrm_capa;
> +};
[Fiona] Is it necessary to have xform_type in both above structures?
Seems like duplication. Or would it be better if both are combined into 1 struct?
> +
> +
> /** Structure used to capture a capability of a crypto device */
> struct rte_cryptodev_capabilities {
> enum rte_crypto_op_type op;
> @@ -187,6 +218,8 @@ struct rte_cryptodev_capabilities {
> union {
> struct rte_cryptodev_symmetric_capability sym;
> /**< Symmetric operation capability parameters */
> + struct rte_cryptodev_asymmetric_capability asym;
> + /**< Asymmetric operation capability parameters */
> };
> };
/// snip ///
>-----Original Message-----
>From: Trahe, Fiona [mailto:fiona.trahe@intel.com]
>Sent: 08 May 2018 20:30
>To: Verma, Shally <Shally.Verma@cavium.com>; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
>Cc: Doherty, Declan <declan.doherty@intel.com>; Athreya, Narayana Prasad <NarayanaPrasad.Athreya@cavium.com>; Sahu, Sunila
><Sunila.Sahu@cavium.com>; Gupta, Ashish <Ashish.Gupta@cavium.com>; dev@dpdk.org; Sahu, Sunila <Sunila.Sahu@cavium.com>;
>Gupta, Ashish <Ashish.Gupta@cavium.com>
>Subject: RE: [PATCH v2 3/6] lib/cryptodev: add asymmetric crypto capability in cryptodev
>
>Hi Shally,
>
>> -----Original Message-----
>> From: Shally Verma [mailto:shally.verma@caviumnetworks.com]
>> Sent: Thursday, April 5, 2018 12:25 PM
>> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
>> Cc: Doherty, Declan <declan.doherty@intel.com>; Trahe, Fiona <fiona.trahe@intel.com>;
>> pathreya@caviumnetworks.com; ssahu@caviumnetworks.com; agupta@caviumnetworks.com;
>> dev@dpdk.org; Sunila Sahu <sunila.sahu@caviumnetworks.com>; Ashish Gupta
>> <ashish.gupta@caviumnetworks.com>
>> Subject: [PATCH v2 3/6] lib/cryptodev: add asymmetric crypto capability in cryptodev
>>
>> Extend cryptodev with asymmetric capability APIs and
>> definitions.
>>
>> Signed-off-by: Shally Verma <shally.verma@caviumnetworks.com>
>> Signed-off-by: Sunila Sahu <sunila.sahu@caviumnetworks.com>
>> Signed-off-by: Ashish Gupta <ashish.gupta@caviumnetworks.com>
>>
>> ---
>/// snip ///
>> +int __rte_experimental
>> +rte_cryptodev_asym_xfrm_capability_check_modlen(
>> + const struct rte_cryptodev_asymmetric_xfrm_capability *capability,
>> + uint16_t modlen)
>> +{
>> + /* handle special case of 0 which mean PMD define no limit defined */
>[Fiona] grammar. Maybe "which means PMD doesn't define any limit"
>
>> + if ((capability->modlen.min != 0) &&
>> + ((modlen < capability->modlen.min) ||
>> + (capability->modlen.increment != 0 &&
>> + (modlen % (capability->modlen.increment)))))
>> + return -1;
>> + if ((capability->modlen.max != 0) &&
>> + ((modlen > capability->modlen.max) ||
>> + (capability->modlen.increment != 0 &&
>> + (modlen % (capability->modlen.increment)))))
>> + return -1;
>> +
>> + return 0;
>> +}
>> +
>>
>> const char *
>> rte_cryptodev_get_feature_name(uint64_t flag)
>> diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
>> index 68d1ae1..deae3d6 100644
>> --- a/lib/librte_cryptodev/rte_cryptodev.h
>> +++ b/lib/librte_cryptodev/rte_cryptodev.h
>> @@ -178,6 +178,37 @@ struct rte_cryptodev_symmetric_capability {
>> };
>> };
>>
>> +/**
>> + * Asymmetric Xform Crypto Capability
>> + *
>> + */
>> +struct rte_cryptodev_asymmetric_xfrm_capability {
>> + enum rte_crypto_asym_xform_type xform_type;
>> + /**< Transform type: RSA/MODEXP/DH/DSA/MODINV */
>> +
>> + uint32_t op_types;
>> + /**< bitmask for supported rte_crypto_asym_op_type */
>> +
>> + __extension__
>> + union {
>> + struct rte_crypto_param_range modlen;
>> + /**< Range of modulus length supported by modulus based xform.
>> + * Value 0 mean implementation default
>> + */
>> + };
>> +};
>> +
>> +/**
>> + * Asymmetric Crypto Capability
>> + *
>> + */
>> +struct rte_cryptodev_asymmetric_capability {
>> + enum rte_crypto_asym_xform_type xform_type;
>> + /**< Transform type: RSA/MODEXP/DH/DSA/MODINV */
>> + struct rte_cryptodev_asymmetric_xfrm_capability xfrm_capa;
>> +};
>[Fiona] Is it necessary to have xform_type in both above structures?
>Seems like duplication. Or would it be better if both are combined into 1 struct?
>
[Shally] Ok.
>> +
>> +
>> /** Structure used to capture a capability of a crypto device */
>> struct rte_cryptodev_capabilities {
>> enum rte_crypto_op_type op;
>> @@ -187,6 +218,8 @@ struct rte_cryptodev_capabilities {
>> union {
>> struct rte_cryptodev_symmetric_capability sym;
>> /**< Symmetric operation capability parameters */
>> + struct rte_cryptodev_asymmetric_capability asym;
>> + /**< Asymmetric operation capability parameters */
>> };
>> };
>/// snip ///
@@ -166,6 +166,31 @@ struct rte_cryptodev_callback {
[RTE_CRYPTO_AEAD_OP_DECRYPT] = "decrypt"
};
+/**
+ * Asymmetric crypto transform operation strings identifiers.
+ */
+const char *rte_crypto_asym_xform_strings[] = {
+ [RTE_CRYPTO_ASYM_XFORM_NONE] = "none",
+ [RTE_CRYPTO_ASYM_XFORM_RSA] = "rsa",
+ [RTE_CRYPTO_ASYM_XFORM_MODEX] = "modexp",
+ [RTE_CRYPTO_ASYM_XFORM_MODINV] = "modinv",
+ [RTE_CRYPTO_ASYM_XFORM_DH] = "dh",
+ [RTE_CRYPTO_ASYM_XFORM_DSA] = "dsa",
+};
+
+/**
+ * Asymmetric crypto operation strings identifiers.
+ */
+const char *rte_crypto_asym_op_strings[] = {
+ [RTE_CRYPTO_ASYM_OP_ENCRYPT] = "encrypt",
+ [RTE_CRYPTO_ASYM_OP_DECRYPT] = "decrypt",
+ [RTE_CRYPTO_ASYM_OP_SIGN] = "sign",
+ [RTE_CRYPTO_ASYM_OP_VERIFY] = "verify",
+ [RTE_CRYPTO_ASYM_OP_PRIVATE_KEY_GENERATE] = "priv_key_generate",
+ [RTE_CRYPTO_ASYM_OP_PUBLIC_KEY_GENERATE] = "pub_key_generate",
+ [RTE_CRYPTO_ASYM_OP_SHARED_SECRET_COMPUTE] = "sharedsecret_compute",
+};
+
int
rte_cryptodev_get_cipher_algo_enum(enum rte_crypto_cipher_algorithm *algo_enum,
const char *algo_string)
@@ -217,6 +242,24 @@ struct rte_cryptodev_callback {
return -1;
}
+int __rte_experimental
+rte_cryptodev_get_asym_xform_enum(enum rte_crypto_asym_xform_type *xform_enum,
+ const char *xform_string)
+{
+ unsigned int i;
+
+ for (i = 1; i < RTE_DIM(rte_crypto_asym_xform_strings); i++) {
+ if (strcmp(xform_string,
+ rte_crypto_asym_xform_strings[i]) == 0) {
+ *xform_enum = (enum rte_crypto_asym_xform_type) i;
+ return 0;
+ }
+ }
+
+ /* Invalid string */
+ return -1;
+}
+
/**
* The crypto auth operation strings identifiers.
* It could be used in application command line.
@@ -262,6 +305,28 @@ struct rte_cryptodev_callback {
}
+const struct rte_cryptodev_asymmetric_xfrm_capability * __rte_experimental
+rte_cryptodev_asym_capability_get(uint8_t dev_id,
+ const struct rte_cryptodev_asym_capability_idx *idx)
+{
+ const struct rte_cryptodev_capabilities *capability;
+ struct rte_cryptodev_info dev_info;
+ unsigned int i = 0;
+
+ memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
+ rte_cryptodev_info_get(dev_id, &dev_info);
+
+ while ((capability = &dev_info.capabilities[i++])->op !=
+ RTE_CRYPTO_OP_TYPE_UNDEFINED) {
+ if (capability->op != RTE_CRYPTO_OP_TYPE_ASYMMETRIC)
+ continue;
+
+ if (capability->asym.xform_type == idx->type)
+ return &capability->asym.xfrm_capa;
+ }
+ return NULL;
+};
+
#define param_range_check(x, y) \
(((x < y.min) || (x > y.max)) || \
(y.increment != 0 && (x % y.increment) != 0))
@@ -317,6 +382,37 @@ struct rte_cryptodev_callback {
return 0;
}
+int __rte_experimental
+rte_cryptodev_asym_xfrm_capability_check_optype(
+ const struct rte_cryptodev_asymmetric_xfrm_capability *capability,
+ enum rte_crypto_asym_op_type op_type)
+{
+ if (capability->op_types & (1 << op_type))
+ return 1;
+
+ return 0;
+}
+
+int __rte_experimental
+rte_cryptodev_asym_xfrm_capability_check_modlen(
+ const struct rte_cryptodev_asymmetric_xfrm_capability *capability,
+ uint16_t modlen)
+{
+ /* handle special case of 0 which mean PMD define no limit defined */
+ if ((capability->modlen.min != 0) &&
+ ((modlen < capability->modlen.min) ||
+ (capability->modlen.increment != 0 &&
+ (modlen % (capability->modlen.increment)))))
+ return -1;
+ if ((capability->modlen.max != 0) &&
+ ((modlen > capability->modlen.max) ||
+ (capability->modlen.increment != 0 &&
+ (modlen % (capability->modlen.increment)))))
+ return -1;
+
+ return 0;
+}
+
const char *
rte_cryptodev_get_feature_name(uint64_t flag)
@@ -178,6 +178,37 @@ struct rte_cryptodev_symmetric_capability {
};
};
+/**
+ * Asymmetric Xform Crypto Capability
+ *
+ */
+struct rte_cryptodev_asymmetric_xfrm_capability {
+ enum rte_crypto_asym_xform_type xform_type;
+ /**< Transform type: RSA/MODEXP/DH/DSA/MODINV */
+
+ uint32_t op_types;
+ /**< bitmask for supported rte_crypto_asym_op_type */
+
+ __extension__
+ union {
+ struct rte_crypto_param_range modlen;
+ /**< Range of modulus length supported by modulus based xform.
+ * Value 0 mean implementation default
+ */
+ };
+};
+
+/**
+ * Asymmetric Crypto Capability
+ *
+ */
+struct rte_cryptodev_asymmetric_capability {
+ enum rte_crypto_asym_xform_type xform_type;
+ /**< Transform type: RSA/MODEXP/DH/DSA/MODINV */
+ struct rte_cryptodev_asymmetric_xfrm_capability xfrm_capa;
+};
+
+
/** Structure used to capture a capability of a crypto device */
struct rte_cryptodev_capabilities {
enum rte_crypto_op_type op;
@@ -187,6 +218,8 @@ struct rte_cryptodev_capabilities {
union {
struct rte_cryptodev_symmetric_capability sym;
/**< Symmetric operation capability parameters */
+ struct rte_cryptodev_asymmetric_capability asym;
+ /**< Asymmetric operation capability parameters */
};
};
@@ -201,7 +234,17 @@ struct rte_cryptodev_sym_capability_idx {
};
/**
- * Provide capabilities available for defined device and algorithm
+ * Structure used to describe asymmetric crypto xforms
+ * Each xform maps to one asym algorithm.
+ *
+ */
+struct rte_cryptodev_asym_capability_idx {
+ enum rte_crypto_asym_xform_type type;
+ /**< Asymmetric xform (algo) type */
+};
+
+/**
+ * Provide capabilities available for defined device and algorithm
*
* @param dev_id The identifier of the device.
* @param idx Description of crypto algorithms.
@@ -215,6 +258,20 @@ struct rte_cryptodev_sym_capability_idx {
const struct rte_cryptodev_sym_capability_idx *idx);
/**
+ * Provide capabilities available for defined device and algorithm
+ *
+ * @param dev_id The identifier of the device.
+ * @param algo Description of crypto algorithms.
+ *
+ * @return
+ * - Return description of the asymmetric crypto capability if exist.
+ * - Return NULL if the capability not exist.
+ */
+const struct rte_cryptodev_asymmetric_xfrm_capability * __rte_experimental
+rte_cryptodev_asym_capability_get(uint8_t dev_id,
+ const struct rte_cryptodev_asym_capability_idx *idx);
+
+/**
* Check if key size and initial vector are supported
* in crypto cipher capability
*
@@ -270,6 +327,36 @@ struct rte_cryptodev_sym_capability_idx {
uint16_t iv_size);
/**
+ * Check if op type is supported
+ *
+ * @param capability Description of the asymmetric crypto capability.
+ * @param op_type op type
+ *
+ * @return
+ * - Return 1 if the op type is supported
+ * - Return 0 if unsupported
+ */
+int __rte_experimental
+rte_cryptodev_asym_xfrm_capability_check_optype(
+ const struct rte_cryptodev_asymmetric_xfrm_capability *capability,
+ enum rte_crypto_asym_op_type op_type);
+
+/**
+ * Check if modulus length is in supported range
+ *
+ * @param capability Description of the asymmetric crypto capability.
+ * @param modlen modulus length.
+ *
+ * @return
+ * - Return 0 if the parameters are in range of the capability.
+ * - Return -1 if the parameters are out of range of the capability.
+ */
+int __rte_experimental
+rte_cryptodev_asym_xfrm_capability_check_modlen(
+ const struct rte_cryptodev_asymmetric_xfrm_capability *capability,
+ uint16_t modlen);
+
+/**
* Provide the cipher algorithm enum, given an algorithm string
*
* @param algo_enum A pointer to the cipher algorithm
@@ -314,6 +401,22 @@ struct rte_cryptodev_sym_capability_idx {
rte_cryptodev_get_aead_algo_enum(enum rte_crypto_aead_algorithm *algo_enum,
const char *algo_string);
+/**
+ * Provide the Asymmetric xform enum, given an xform string
+ *
+ * @param xform_enum A pointer to the xform type
+ * enum to be filled
+ * @param xform_string xform string
+ *
+ * @return
+ * - Return -1 if string is not valid
+ * - Return 0 if the string is valid
+ */
+int __rte_experimental
+rte_cryptodev_get_asym_xform_enum(enum rte_crypto_asym_xform_type *xform_enum,
+ const char *xform_string);
+
+
/** Macro used at end of crypto PMD list */
#define RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST() \
{ RTE_CRYPTO_OP_TYPE_UNDEFINED }
@@ -89,11 +89,15 @@ DPDK_17.11 {
EXPERIMENTAL {
global:
+ rte_cryptodev_asym_capability_get;
rte_cryptodev_asym_session_clear;
rte_cryptodev_asym_session_create;
rte_cryptodev_asym_session_free;
rte_cryptodev_asym_session_init;
+ rte_cryptodev_asym_xfrm_capability_check_modlen;
+ rte_cryptodev_asym_xfrm_capability_check_optype;
rte_cryptodev_get_asym_session_private_size;
+ rte_cryptodev_get_asym_xform_enum;
local: *;
};