[v2,1/2] cryptodev: support SM3_HMAC,SM4_CFB and SM4_OFB

Message ID 20230525100806.36992-1-sunyang.wu@jaguarmicro.com (mailing list archive)
State Superseded, archived
Delegated to: akhil goyal
Headers
Series [v2,1/2] cryptodev: support SM3_HMAC,SM4_CFB and SM4_OFB |

Checks

Context Check Description
ci/checkpatch warning coding style issues

Commit Message

Sunyang Wu May 25, 2023, 10:08 a.m. UTC
  Add SM3_HMAC/SM4_CFB/SM4_OFB support in DPDK.

Signed-off-by: Sunyang Wu <sunyang.wu@jaguarmicro.com>
---
 doc/guides/cryptodevs/features/default.ini |  3 +++
 doc/guides/rel_notes/release_23_07.rst     |  5 +++++
 lib/cryptodev/rte_crypto_sym.h             |  8 +++++++-
 lib/cryptodev/rte_cryptodev.c              | 12 +++++++++---
 4 files changed, 24 insertions(+), 4 deletions(-)
  

Comments

Akhil Goyal May 25, 2023, 2:48 p.m. UTC | #1
> Add SM3_HMAC/SM4_CFB/SM4_OFB support in DPDK.
> 
> Signed-off-by: Sunyang Wu <sunyang.wu@jaguarmicro.com>
> ---
>  doc/guides/cryptodevs/features/default.ini |  3 +++
>  doc/guides/rel_notes/release_23_07.rst     |  5 +++++
>  lib/cryptodev/rte_crypto_sym.h             |  8 +++++++-
>  lib/cryptodev/rte_cryptodev.c              | 12 +++++++++---
>  4 files changed, 24 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/guides/cryptodevs/features/default.ini
> b/doc/guides/cryptodevs/features/default.ini
> index 523da0cfa8..8f54d4a2a5 100644
> --- a/doc/guides/cryptodevs/features/default.ini
> +++ b/doc/guides/cryptodevs/features/default.ini
> @@ -64,6 +64,8 @@ ZUC EEA3       =
>  SM4 ECB        =
>  SM4 CBC        =
>  SM4 CTR        =
> +SM4 CFB        =
> +SM4 OFB        =
> 
>  ;
>  ; Supported authentication algorithms of a default crypto driver.
> @@ -99,6 +101,7 @@ SHA3_384 HMAC   =
>  SHA3_512        =
>  SHA3_512 HMAC   =
>  SM3             =
> +SM3 HMAC        =
>  SHAKE_128       =
>  SHAKE_256       =
> 
> diff --git a/doc/guides/rel_notes/release_23_07.rst
> b/doc/guides/rel_notes/release_23_07.rst
> index a9b1293689..405b34c6d2 100644
> --- a/doc/guides/rel_notes/release_23_07.rst
> +++ b/doc/guides/rel_notes/release_23_07.rst
> @@ -55,6 +55,11 @@ New Features
>       Also, make sure to start the actual text at the margin.
>       =======================================================
> 
> +* **Added new algorithms to cryptodev.**
> +
> +  * Added symmetric hash algorithm SM3-HMAC.
> +  * Added symmetric cipher algorithm ShangMi 4 (SM4) in CFB and OFB modes.
> +
> 
>  Removed Items
>  -------------
> diff --git a/lib/cryptodev/rte_crypto_sym.h b/lib/cryptodev/rte_crypto_sym.h
> index b43174dbec..428603d06e 100644
> --- a/lib/cryptodev/rte_crypto_sym.h
> +++ b/lib/cryptodev/rte_crypto_sym.h
> @@ -172,8 +172,12 @@ enum rte_crypto_cipher_algorithm {
>  	/**< ShangMi 4 (SM4) algorithm in ECB mode */
>  	RTE_CRYPTO_CIPHER_SM4_CBC,
>  	/**< ShangMi 4 (SM4) algorithm in CBC mode */
> -	RTE_CRYPTO_CIPHER_SM4_CTR
> +	RTE_CRYPTO_CIPHER_SM4_CTR,
>  	/**< ShangMi 4 (SM4) algorithm in CTR mode */
> +	RTE_CRYPTO_CIPHER_SM4_OFB,
> +	/**< ShangMi 4 (SM4) algorithm in OFB mode */
> +	RTE_CRYPTO_CIPHER_SM4_CFB
> +	/**< ShangMi 4 (SM4) algorithm in CFB mode */
>  };
> 
>  /** Cipher algorithm name strings */
> @@ -376,6 +380,8 @@ enum rte_crypto_auth_algorithm {
>  	/**< HMAC using 512 bit SHA3 algorithm. */
>  	RTE_CRYPTO_AUTH_SM3,
>  	/**< ShangMi 3 (SM3) algorithm */
> +	RTE_CRYPTO_AUTH_SM3_HMAC,
> +	/** < HMAC using ShangMi 3 (SM3) algorithm */
> 
>  	RTE_CRYPTO_AUTH_SHAKE_128,
>  	/**< 128 bit SHAKE algorithm. */
> diff --git a/lib/cryptodev/rte_cryptodev.c b/lib/cryptodev/rte_cryptodev.c
> index a96114b2da..3e5e65dc58 100644
> --- a/lib/cryptodev/rte_cryptodev.c
> +++ b/lib/cryptodev/rte_cryptodev.c
> @@ -94,7 +94,9 @@ rte_crypto_cipher_algorithm_strings[] = {
>  	[RTE_CRYPTO_CIPHER_ZUC_EEA3]	= "zuc-eea3",
>  	[RTE_CRYPTO_CIPHER_SM4_ECB]	= "sm4-ecb",
>  	[RTE_CRYPTO_CIPHER_SM4_CBC]	= "sm4-cbc",
> -	[RTE_CRYPTO_CIPHER_SM4_CTR]	= "sm4-ctr"
> +	[RTE_CRYPTO_CIPHER_SM4_CTR]	= "sm4-ctr",
> +	[RTE_CRYPTO_CIPHER_SM4_CFB]	= "sm4-cfb",
> +	[RTE_CRYPTO_CIPHER_SM4_OFB]	= "sm4-ofb"
>  };
> 
>  /**
> @@ -127,7 +129,9 @@ crypto_cipher_algorithm_strings[] = {
>  	[RTE_CRYPTO_CIPHER_ZUC_EEA3]	= "zuc-eea3",
>  	[RTE_CRYPTO_CIPHER_SM4_ECB]	= "sm4-ecb",
>  	[RTE_CRYPTO_CIPHER_SM4_CBC]	= "sm4-cbc",
> -	[RTE_CRYPTO_CIPHER_SM4_CTR]	= "sm4-ctr"
> +	[RTE_CRYPTO_CIPHER_SM4_CTR]	= "sm4-ctr",
> +	[RTE_CRYPTO_CIPHER_SM4_CFB]	= "sm4-cfb",
> +	[RTE_CRYPTO_CIPHER_SM4_OFB]	= "sm4-ofb"
>  };
> 
>  /**
> @@ -182,7 +186,8 @@ rte_crypto_auth_algorithm_strings[] = {
>  	[RTE_CRYPTO_AUTH_KASUMI_F9]	= "kasumi-f9",
>  	[RTE_CRYPTO_AUTH_SNOW3G_UIA2]	= "snow3g-uia2",
>  	[RTE_CRYPTO_AUTH_ZUC_EIA3]	= "zuc-eia3",
> -	[RTE_CRYPTO_AUTH_SM3]		= "sm3"
> +	[RTE_CRYPTO_AUTH_SM3]		= "sm3",
> +	[RTE_CRYPTO_AUTH_SM3_HMAC]	= "sm3-hmac"
>  };
> 
>  /**
> @@ -227,6 +232,7 @@ crypto_auth_algorithm_strings[] = {
>  	[RTE_CRYPTO_AUTH_SNOW3G_UIA2]	= "snow3g-uia2",
>  	[RTE_CRYPTO_AUTH_ZUC_EIA3]	= "zuc-eia3",
>  	[RTE_CRYPTO_AUTH_SM3]		= "sm3",
> +	[RTE_CRYPTO_AUTH_SM3_HMAC]	= "sm3",
> 
>  	[RTE_CRYPTO_AUTH_SHAKE_128]	 = "shake-128",
>  	[RTE_CRYPTO_AUTH_SHAKE_256]	 = "shake-256",
> --
I asked you to update only the crypto_auth_algorithm_strings
And crypto_cipher_algorithm_strings and not the rte_ ones.
Changing rte_ will create ABI break and these are deprecated
arrays, so it should not be changed.
  

Patch

diff --git a/doc/guides/cryptodevs/features/default.ini b/doc/guides/cryptodevs/features/default.ini
index 523da0cfa8..8f54d4a2a5 100644
--- a/doc/guides/cryptodevs/features/default.ini
+++ b/doc/guides/cryptodevs/features/default.ini
@@ -64,6 +64,8 @@  ZUC EEA3       =
 SM4 ECB        =
 SM4 CBC        =
 SM4 CTR        =
+SM4 CFB        =
+SM4 OFB        =
 
 ;
 ; Supported authentication algorithms of a default crypto driver.
@@ -99,6 +101,7 @@  SHA3_384 HMAC   =
 SHA3_512        =
 SHA3_512 HMAC   =
 SM3             =
+SM3 HMAC        =
 SHAKE_128       =
 SHAKE_256       =
 
diff --git a/doc/guides/rel_notes/release_23_07.rst b/doc/guides/rel_notes/release_23_07.rst
index a9b1293689..405b34c6d2 100644
--- a/doc/guides/rel_notes/release_23_07.rst
+++ b/doc/guides/rel_notes/release_23_07.rst
@@ -55,6 +55,11 @@  New Features
      Also, make sure to start the actual text at the margin.
      =======================================================
 
+* **Added new algorithms to cryptodev.**
+
+  * Added symmetric hash algorithm SM3-HMAC.
+  * Added symmetric cipher algorithm ShangMi 4 (SM4) in CFB and OFB modes.
+
 
 Removed Items
 -------------
diff --git a/lib/cryptodev/rte_crypto_sym.h b/lib/cryptodev/rte_crypto_sym.h
index b43174dbec..428603d06e 100644
--- a/lib/cryptodev/rte_crypto_sym.h
+++ b/lib/cryptodev/rte_crypto_sym.h
@@ -172,8 +172,12 @@  enum rte_crypto_cipher_algorithm {
 	/**< ShangMi 4 (SM4) algorithm in ECB mode */
 	RTE_CRYPTO_CIPHER_SM4_CBC,
 	/**< ShangMi 4 (SM4) algorithm in CBC mode */
-	RTE_CRYPTO_CIPHER_SM4_CTR
+	RTE_CRYPTO_CIPHER_SM4_CTR,
 	/**< ShangMi 4 (SM4) algorithm in CTR mode */
+	RTE_CRYPTO_CIPHER_SM4_OFB,
+	/**< ShangMi 4 (SM4) algorithm in OFB mode */
+	RTE_CRYPTO_CIPHER_SM4_CFB
+	/**< ShangMi 4 (SM4) algorithm in CFB mode */
 };
 
 /** Cipher algorithm name strings */
@@ -376,6 +380,8 @@  enum rte_crypto_auth_algorithm {
 	/**< HMAC using 512 bit SHA3 algorithm. */
 	RTE_CRYPTO_AUTH_SM3,
 	/**< ShangMi 3 (SM3) algorithm */
+	RTE_CRYPTO_AUTH_SM3_HMAC,
+	/** < HMAC using ShangMi 3 (SM3) algorithm */
 
 	RTE_CRYPTO_AUTH_SHAKE_128,
 	/**< 128 bit SHAKE algorithm. */
diff --git a/lib/cryptodev/rte_cryptodev.c b/lib/cryptodev/rte_cryptodev.c
index a96114b2da..3e5e65dc58 100644
--- a/lib/cryptodev/rte_cryptodev.c
+++ b/lib/cryptodev/rte_cryptodev.c
@@ -94,7 +94,9 @@  rte_crypto_cipher_algorithm_strings[] = {
 	[RTE_CRYPTO_CIPHER_ZUC_EEA3]	= "zuc-eea3",
 	[RTE_CRYPTO_CIPHER_SM4_ECB]	= "sm4-ecb",
 	[RTE_CRYPTO_CIPHER_SM4_CBC]	= "sm4-cbc",
-	[RTE_CRYPTO_CIPHER_SM4_CTR]	= "sm4-ctr"
+	[RTE_CRYPTO_CIPHER_SM4_CTR]	= "sm4-ctr",
+	[RTE_CRYPTO_CIPHER_SM4_CFB]	= "sm4-cfb",
+	[RTE_CRYPTO_CIPHER_SM4_OFB]	= "sm4-ofb"
 };
 
 /**
@@ -127,7 +129,9 @@  crypto_cipher_algorithm_strings[] = {
 	[RTE_CRYPTO_CIPHER_ZUC_EEA3]	= "zuc-eea3",
 	[RTE_CRYPTO_CIPHER_SM4_ECB]	= "sm4-ecb",
 	[RTE_CRYPTO_CIPHER_SM4_CBC]	= "sm4-cbc",
-	[RTE_CRYPTO_CIPHER_SM4_CTR]	= "sm4-ctr"
+	[RTE_CRYPTO_CIPHER_SM4_CTR]	= "sm4-ctr",
+	[RTE_CRYPTO_CIPHER_SM4_CFB]	= "sm4-cfb",
+	[RTE_CRYPTO_CIPHER_SM4_OFB]	= "sm4-ofb"
 };
 
 /**
@@ -182,7 +186,8 @@  rte_crypto_auth_algorithm_strings[] = {
 	[RTE_CRYPTO_AUTH_KASUMI_F9]	= "kasumi-f9",
 	[RTE_CRYPTO_AUTH_SNOW3G_UIA2]	= "snow3g-uia2",
 	[RTE_CRYPTO_AUTH_ZUC_EIA3]	= "zuc-eia3",
-	[RTE_CRYPTO_AUTH_SM3]		= "sm3"
+	[RTE_CRYPTO_AUTH_SM3]		= "sm3",
+	[RTE_CRYPTO_AUTH_SM3_HMAC]	= "sm3-hmac"
 };
 
 /**
@@ -227,6 +232,7 @@  crypto_auth_algorithm_strings[] = {
 	[RTE_CRYPTO_AUTH_SNOW3G_UIA2]	= "snow3g-uia2",
 	[RTE_CRYPTO_AUTH_ZUC_EIA3]	= "zuc-eia3",
 	[RTE_CRYPTO_AUTH_SM3]		= "sm3",
+	[RTE_CRYPTO_AUTH_SM3_HMAC]	= "sm3",
 
 	[RTE_CRYPTO_AUTH_SHAKE_128]	 = "shake-128",
 	[RTE_CRYPTO_AUTH_SHAKE_256]	 = "shake-256",