cryptodev: rework mod exp and mod inv comments
Checks
Commit Message
This patch changes modular exponentiation and modular multiplicative
inverse API comments to make it more precise.
Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
---
lib/librte_cryptodev/rte_crypto_asym.h | 42 ++++++++++++++++++++++------------
1 file changed, 28 insertions(+), 14 deletions(-)
Comments
Hi Arek,
> -----Original Message-----
> From: Kusztal, ArkadiuszX
> Sent: Tuesday, February 5, 2019 11:13 AM
> To: dev@dpdk.org
> Cc: shally.verma@caviumnetworks.com; sunila.sahu@caviumnetworks.com;
> ashish.gupta@caviumnetworks.com; umesh.kartha@caviumnetworks.com; Trahe, Fiona
> <fiona.trahe@intel.com>; akhil.goyal@nxp.com; Kusztal, ArkadiuszX <arkadiuszx.kusztal@intel.com>
> Subject: [PATCH] cryptodev: rework mod exp and mod inv comments
>
> This patch changes modular exponentiation and modular multiplicative
> inverse API comments to make it more precise.
>
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
> + * In case this number is equal to zero driver set crypto op
> + * status field to RTE_CRYPTO_OP_STATUS_ERROR
[Fiona] grammar nit - ....the driver should set the crypto op.....
> - * Structure describing modulus inverse xform params
> + * Structure describing modular multiplicative inverse transform xform params
[Fiona] grammar nit - no need for transform and xform - one will do.
> + * In case this number is equal to zero driver set crypto op
> + * status field to RTE_CRYPTO_OP_STATUS_ERROR
[Fiona] grammar nit - same comment as above
> + *
> + * This number need to be relatively prime to base
> + * in corresponding Modular Multiplicative Inverse
> + * rte_crypto_mod_op_param
> */
[Fiona] grammar nit - "The number needs..." or "This number should be"
> struct rte_crypto_mod_op_param {
> rte_crypto_param base;
> /**<
> - * Pointer to base of modular exponentiation/inversion data in
> - * Octet-string network byte order format.
> + * Pointer to base of modular exponentiation/multiplicative
> + * inverse data in Octet-string network byte order format.
[Fiona] grammar nit - octet-string - no need for capitalisation
> + *
> + * In case Multiplicative Inverse is used this number need
> + * to be relatively prime to modulus in corresponding Modular
> + * Multiplicative Inverse rte_crypto_modinv_xform
[Fiona] grammar nit - same comment as above
@@ -72,8 +72,8 @@ enum rte_crypto_asym_xform_type {
* Refer to rte_crypto_asym_op_type
*/
RTE_CRYPTO_ASYM_XFORM_MODINV,
- /**< Modular Inverse
- * Perform Modulus inverse b^(-1) mod n
+ /**< Modular Multiplicative Inverse
+ * Perform Modular Multiplicative Inverse b^(-1) mod n
*/
RTE_CRYPTO_ASYM_XFORM_MODEX,
/**< Modular Exponentiation
@@ -233,29 +233,39 @@ struct rte_crypto_rsa_xform {
struct rte_crypto_modex_xform {
rte_crypto_param modulus;
/**< modulus
- * Prime modulus of the modexp transform operation in octet-string
- * network byte order format.
+ * Pointer to the modulus data for modexp transform operation
+ * in octet-string network byte order format, any positive integer
+ *
+ * In case this number is equal to zero driver set crypto op
+ * status field to RTE_CRYPTO_OP_STATUS_ERROR
*/
rte_crypto_param exponent;
/**< exponent
- * Private exponent of the modexp transform operation in
+ * Exponent of the modexp transform operation in
* octet-string network byte order format.
*/
};
/**
- * Asymmetric modular inverse transform operation
+ * Asymmetric modular multiplicative inverse transform operation
*
- * Structure describing modulus inverse xform params
+ * Structure describing modular multiplicative inverse transform xform params
*
*/
struct rte_crypto_modinv_xform {
rte_crypto_param modulus;
/**<
- * Pointer to the prime modulus data for modular
- * inverse operation in octet-string network byte
- * order format.
+ * Pointer to the modulus data for modular multiplicative inverse
+ * operation in octet-string network byte order format,
+ * positive integer
+ *
+ * In case this number is equal to zero driver set crypto op
+ * status field to RTE_CRYPTO_OP_STATUS_ERROR
+ *
+ * This number need to be relatively prime to base
+ * in corresponding Modular Multiplicative Inverse
+ * rte_crypto_mod_op_param
*/
};
@@ -317,14 +327,18 @@ struct rte_crypto_dsa_xform {
/**
* Operations params for modular operations:
- * exponentiation and invert
+ * exponentiation and multiplicative inverse
*
*/
struct rte_crypto_mod_op_param {
rte_crypto_param base;
/**<
- * Pointer to base of modular exponentiation/inversion data in
- * Octet-string network byte order format.
+ * Pointer to base of modular exponentiation/multiplicative
+ * inverse data in Octet-string network byte order format.
+ *
+ * In case Multiplicative Inverse is used this number need
+ * to be relatively prime to modulus in corresponding Modular
+ * Multiplicative Inverse rte_crypto_modinv_xform
*/
};
@@ -348,7 +362,7 @@ struct rte_crypto_asym_xform {
/**< Modular Exponentiation xform parameters */
struct rte_crypto_modinv_xform modinv;
- /**< Modulus Inverse xform parameters */
+ /**< Modular Multiplicative Inverse xform parameters */
struct rte_crypto_dh_xform dh;
/**< DH xform parameters */