crypto: fix misspelled key in qt format

Message ID 20220210102533.22192-1-arkadiuszx.kusztal@intel.com (mailing list archive)
State Superseded, archived
Delegated to: akhil goyal
Headers
Series crypto: fix misspelled key in qt format |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot: build fail github build: failed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-abi-testing warning Testing issues
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

Arkadiusz Kusztal Feb. 10, 2022, 10:25 a.m. UTC
  This patch fixes misspelled RTE_RSA_KEY_TYPE_QT,
this will prevent checkpach from complaining wherever
change to RSA is being made.

Fixes: 26008aaed14c ("cryptodev: add asymmetric xform and op definitions")

Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
---
 app/test/test_cryptodev_asym.c             | 2 +-
 app/test/test_cryptodev_rsa_test_vectors.h | 2 +-
 drivers/crypto/qat/qat_asym.c              | 4 ++--
 lib/cryptodev/rte_crypto_asym.h            | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)
  

Comments

Akhil Goyal Feb. 12, 2022, 11:34 a.m. UTC | #1
> This patch fixes misspelled RTE_RSA_KEY_TYPE_QT,
> this will prevent checkpach from complaining wherever
> change to RSA is being made.
> 
> Fixes: 26008aaed14c ("cryptodev: add asymmetric xform and op definitions")
> 
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
> ---
Fix ABI warning.
Add libabigail.abiignore rule.
  
Arkadiusz Kusztal Feb. 18, 2022, 6:11 a.m. UTC | #2
> -----Original Message-----
> From: Akhil Goyal <gakhil@marvell.com>
> Sent: Saturday, February 12, 2022 12:34 PM
> To: Kusztal, ArkadiuszX <arkadiuszx.kusztal@intel.com>; dev@dpdk.org
> Cc: Zhang, Roy Fan <roy.fan.zhang@intel.com>
> Subject: RE: [EXT] [PATCH] crypto: fix misspelled key in qt format
> 
> > This patch fixes misspelled RTE_RSA_KEY_TYPE_QT, this will prevent
> > checkpach from complaining wherever change to RSA is being made.
> >
> > Fixes: 26008aaed14c ("cryptodev: add asymmetric xform and op
> > definitions")
> >
> > Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
> > ---
> Fix ABI warning.
> Add libabigail.abiignore rule.

I think what is worth noticing is a fact that after "random 'k' patch" addition of
[suppress_type]
        name = rte_crypto_asym_op
this problem does not show up.

But I think it is safer to send addition of
[suppress_type]
        name = rte_crypto_rsa_priv_key_type
anyway.
Will send v2.
  
Thomas Monjalon Feb. 25, 2022, 5:56 p.m. UTC | #3
18/02/2022 07:11, Kusztal, ArkadiuszX:
> From: Akhil Goyal <gakhil@marvell.com>
> > Fix ABI warning.
> > Add libabigail.abiignore rule.
> 
> I think what is worth noticing is a fact that after "random 'k' patch" addition of
> [suppress_type]
>         name = rte_crypto_asym_op
> this problem does not show up.
> 
> But I think it is safer to send addition of
> [suppress_type]
>         name = rte_crypto_rsa_priv_key_type
> anyway.
> Will send v2.

I don't understand why adding this rule,
and the comment does say nothing about it:
	"Ignore name change of rsa qt key type"

The ABI check is fine without above because of this existing exception:

; Ignore changes to rte_crypto_asym_op, asymmetric crypto API is experimental
[suppress_type]
        name = rte_crypto_asym_op

So I will just drop the unjustified additional exception while pulling.

Next time, please make sure such ABI exception is approved by more maintainers.
  
Ray Kinsella Feb. 25, 2022, 7:35 p.m. UTC | #4
Thomas Monjalon <thomas@monjalon.net> writes:

> 18/02/2022 07:11, Kusztal, ArkadiuszX:
>> From: Akhil Goyal <gakhil@marvell.com>
>> > Fix ABI warning.
>> > Add libabigail.abiignore rule.
>> 
>> I think what is worth noticing is a fact that after "random 'k' patch" addition of
>> [suppress_type]
>>         name = rte_crypto_asym_op
>> this problem does not show up.
>> 
>> But I think it is safer to send addition of
>> [suppress_type]
>>         name = rte_crypto_rsa_priv_key_type
>> anyway.
>> Will send v2.
>
> I don't understand why adding this rule,
> and the comment does say nothing about it:
> 	"Ignore name change of rsa qt key type"
>
> The ABI check is fine without above because of this existing exception:
>
> ; Ignore changes to rte_crypto_asym_op, asymmetric crypto API is experimental
> [suppress_type]
>         name = rte_crypto_asym_op
>
> So I will just drop the unjustified additional exception while pulling.
>
> Next time, please make sure such ABI exception is approved by more maintainers.

To be fair to those involved, I had been CC'ed on the v2 of this.
I didn't respond before the patch was merged however.
  

Patch

diff --git a/app/test/test_cryptodev_asym.c b/app/test/test_cryptodev_asym.c
index 9d3a5589bb..423db2408b 100644
--- a/app/test/test_cryptodev_asym.c
+++ b/app/test/test_cryptodev_asym.c
@@ -560,7 +560,7 @@  test_one_case(const void *test_case, int sessionless)
 						status = test_cryptodev_asym_op(
 							&testsuite_params,
 							&tc, test_msg, sessionless, i,
-							RTE_RSA_KET_TYPE_QT);
+							RTE_RSA_KEY_TYPE_QT);
 					}
 					if (status)
 						break;
diff --git a/app/test/test_cryptodev_rsa_test_vectors.h b/app/test/test_cryptodev_rsa_test_vectors.h
index 48a72e1492..04539a1ecf 100644
--- a/app/test/test_cryptodev_rsa_test_vectors.h
+++ b/app/test/test_cryptodev_rsa_test_vectors.h
@@ -378,7 +378,7 @@  struct rte_crypto_asym_xform rsa_xform_crt = {
 			.data = rsa_e,
 			.length = sizeof(rsa_e)
 		},
-		.key_type = RTE_RSA_KET_TYPE_QT,
+		.key_type = RTE_RSA_KEY_TYPE_QT,
 		.qt = {
 			.p = {
 				.data = rsa_p,
diff --git a/drivers/crypto/qat/qat_asym.c b/drivers/crypto/qat/qat_asym.c
index 09d8761c5f..bd0bf5f0cb 100644
--- a/drivers/crypto/qat/qat_asym.c
+++ b/drivers/crypto/qat/qat_asym.c
@@ -97,7 +97,7 @@  static void qat_clear_arrays_by_alg(struct qat_asym_op_cookie *cookie,
 		qat_clear_arrays(cookie, QAT_ASYM_MODINV_NUM_IN_PARAMS,
 				QAT_ASYM_MODINV_NUM_OUT_PARAMS, alg_size);
 	else if (xform->xform_type == RTE_CRYPTO_ASYM_XFORM_RSA) {
-		if (xform->rsa.key_type == RTE_RSA_KET_TYPE_QT)
+		if (xform->rsa.key_type == RTE_RSA_KEY_TYPE_QT)
 			qat_clear_arrays_crt(cookie, alg_size);
 		else {
 			qat_clear_arrays(cookie, QAT_ASYM_RSA_NUM_IN_PARAMS,
@@ -370,7 +370,7 @@  qat_asym_fill_arrays(struct rte_crypto_asym_op *asym_op,
 					return -(EINVAL);
 				}
 			}
-			if (xform->rsa.key_type == RTE_RSA_KET_TYPE_QT) {
+			if (xform->rsa.key_type == RTE_RSA_KEY_TYPE_QT) {
 
 				qat_req->input_param_count =
 						QAT_ASYM_RSA_QT_NUM_IN_PARAMS;
diff --git a/lib/cryptodev/rte_crypto_asym.h b/lib/cryptodev/rte_crypto_asym.h
index 9c866f553f..9c5bb9233a 100644
--- a/lib/cryptodev/rte_crypto_asym.h
+++ b/lib/cryptodev/rte_crypto_asym.h
@@ -146,7 +146,7 @@  enum rte_crypto_rsa_padding_type {
 enum rte_crypto_rsa_priv_key_type {
 	RTE_RSA_KEY_TYPE_EXP,
 	/**< RSA private key is an exponent */
-	RTE_RSA_KET_TYPE_QT,
+	RTE_RSA_KEY_TYPE_QT,
 	/**< RSA private key is in quintuple format
 	 * See rte_crypto_rsa_priv_key_qt
 	 */