nrf_security: Combine Cracen hash headers

Vge0rge · rlubos · commit d5e332065d8b · 2025-04-08T15:16:50.000+02:00
Combine all the individual hash headers to the
hashdefs.h instead of having multiple files.

This is preparation work, following work will be
selecting the size of the hash context depending on the
selected algorithms. This makes more sense to be in one
file in order to be more clear what context size will
be used.

Signed-off-by: Georgios Vasilakis &lt;georgios.vasilakis@nordicsemi.no&gt;
diff --git a/subsys/nrf_security/src/drivers/cracen/cracenpsa/src/common.c b/subsys/nrf_security/src/drivers/cracen/cracenpsa/src/common.c
@@ -22,9 +22,7 @@
 #include <silexpk/ik.h>
 #include <silexpk/sxops/eccweierstrass.h>
 #include <stddef.h>
-#include <sxsymcrypt/sha1.h>
-#include <sxsymcrypt/sha2.h>
-#include <sxsymcrypt/sha3.h>
+#include <sxsymcrypt/hashdefs.h>
 #include <zephyr/logging/log.h>
 #include <zephyr/sys/util.h>
 #include <psa/nrf_platform_key_ids.h>
diff --git a/subsys/nrf_security/src/drivers/cracen/cracenpsa/src/common.h b/subsys/nrf_security/src/drivers/cracen/cracenpsa/src/common.h
@@ -14,9 +14,7 @@
 #include <zephyr/sys/util.h>
 #include <sicrypto/sicrypto.h>
 #include <silexpk/sxbuf/sxbufop.h>
-#include <sxsymcrypt/sha1.h>
-#include <sxsymcrypt/sha2.h>
-#include <sxsymcrypt/sha3.h>
+#include <sxsymcrypt/hashdefs.h>
 
 /* RFC5480 - first byte of ECC public key that indicates that the key
  * is uncompressed
diff --git a/subsys/nrf_security/src/drivers/cracen/cracenpsa/src/ed25519.c b/subsys/nrf_security/src/drivers/cracen/cracenpsa/src/ed25519.c
@@ -27,7 +27,7 @@
  *         32 bytes of this area.
  */
 #include <string.h>
-#include <sxsymcrypt/sha2.h>
+#include <sxsymcrypt/hashdefs.h>
 #include <silexpk/ed25519.h>
 #include <cracen/ec_helpers.h>
 #include <sxsymcrypt/hash.h>
diff --git a/subsys/nrf_security/src/drivers/cracen/cracenpsa/src/hash.c b/subsys/nrf_security/src/drivers/cracen/cracenpsa/src/hash.c
@@ -12,9 +12,7 @@
 #include <string.h>
 #include <sxsymcrypt/hash.h>
 #include <sxsymcrypt/internal.h>
-#include <sxsymcrypt/sha1.h>
-#include <sxsymcrypt/sha2.h>
-#include <sxsymcrypt/sha3.h>
+#include <sxsymcrypt/hashdefs.h>
 #include <cracen/statuscodes.h>
 #include <zephyr/sys/__assert.h>
 #include "common.h"
diff --git a/subsys/nrf_security/src/drivers/cracen/cracenpsa/src/sign.c b/subsys/nrf_security/src/drivers/cracen/cracenpsa/src/sign.c
@@ -22,8 +22,7 @@
 #include <silexpk/ik.h>
 #include <silexpk/sxbuf/sxbufop.h>
 #include <string.h>
-#include <sxsymcrypt/sha1.h>
-#include <sxsymcrypt/sha2.h>
+#include <sxsymcrypt/hashdefs.h>
 #include <sxsymcrypt/trng.h>
 #include "hashdefs.h"
 
diff --git a/subsys/nrf_security/src/drivers/cracen/sicrypto/include/sicrypto/internal.h b/subsys/nrf_security/src/drivers/cracen/sicrypto/include/sicrypto/internal.h
@@ -11,6 +11,7 @@
 #include <sxsymcrypt/aead.h>
 #include <sxsymcrypt/blkcipher.h>
 #include <sxsymcrypt/internal.h>
+#include <sxsymcrypt/hashdefs.h>
 #include <silexpk/ec_curves.h>
 #include <stdbool.h>
 #include <stdint.h>
diff --git a/subsys/nrf_security/src/drivers/cracen/sicrypto/src/ecdsa.c b/subsys/nrf_security/src/drivers/cracen/sicrypto/src/ecdsa.c
@@ -26,7 +26,7 @@
 #include <silexpk/core.h>
 #include <silexpk/iomem.h>
 #include <silexpk/cmddefs/ecc.h>
-#include <sxsymcrypt/sha2.h>
+#include <sxsymcrypt/hashdefs.h>
 #include "../include/sicrypto/sicrypto.h"
 #include "../include/sicrypto/ecdsa.h"
 #include "../include/sicrypto/hash.h"
diff --git a/subsys/nrf_security/src/drivers/cracen/sicrypto/src/ed25519.c b/subsys/nrf_security/src/drivers/cracen/sicrypto/src/ed25519.c
@@ -33,7 +33,7 @@
  */
 
 #include <string.h>
-#include <sxsymcrypt/sha2.h>
+#include <sxsymcrypt/hashdefs.h>
 #include <silexpk/core.h>
 #include <silexpk/ed25519.h>
 #include <sicrypto/sicrypto.h>
diff --git a/subsys/nrf_security/src/drivers/cracen/sicrypto/src/ed25519ph.c b/subsys/nrf_security/src/drivers/cracen/sicrypto/src/ed25519ph.c
@@ -31,7 +31,7 @@
  */
 
 #include <string.h>
-#include <sxsymcrypt/sha2.h>
+#include <sxsymcrypt/hashdefs.h>
 #include <silexpk/core.h>
 #include <silexpk/ed25519.h>
 #include <sicrypto/sicrypto.h>
diff --git a/subsys/nrf_security/src/drivers/cracen/sicrypto/src/ed448.c b/subsys/nrf_security/src/drivers/cracen/sicrypto/src/ed448.c
@@ -41,7 +41,7 @@
  */
 
 #include <string.h>
-#include <sxsymcrypt/sha3.h>
+#include <sxsymcrypt/hashdefs.h>
 #include <silexpk/core.h>
 #include <silexpk/ed448.h>
 #include <sicrypto/sicrypto.h>
diff --git a/subsys/nrf_security/src/drivers/cracen/sicrypto/src/iksig.c b/subsys/nrf_security/src/drivers/cracen/sicrypto/src/iksig.c
@@ -19,7 +19,7 @@
 #include <silexpk/core.h>
 #include <silexpk/iomem.h>
 #include <sxsymcrypt/hash.h>
-#include <sxsymcrypt/sha2.h>
+#include <sxsymcrypt/hashdefs.h>
 #include <silexpk/ik.h>
 #include "../include/sicrypto/sicrypto.h"
 #include "../include/sicrypto/hash.h"
diff --git a/subsys/nrf_security/src/drivers/cracen/sicrypto/src/rsassa_pkcs1v15.c b/subsys/nrf_security/src/drivers/cracen/sicrypto/src/rsassa_pkcs1v15.c
@@ -17,8 +17,7 @@
 #include <string.h>
 #include <silexpk/iomem.h>
 #include <silexpk/core.h>
-#include <sxsymcrypt/sha1.h>
-#include <sxsymcrypt/sha2.h>
+#include <sxsymcrypt/hashdefs.h>
 #include "../include/sicrypto/sicrypto.h"
 #include "../include/sicrypto/rsassa_pkcs1v15.h"
 #include "../include/sicrypto/hash.h"
diff --git a/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/hashdefs.h b/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/hashdefs.h
@@ -9,6 +9,11 @@
 
 #include <stddef.h>
 #include <stdint.h>
+#include "internal.h"
+
+#ifndef SX_HASH_PRIV_SZ
+#define SX_HASH_PRIV_SZ 344
+#endif
 
 struct sx_digesttags {
 	uint32_t cfg;
@@ -17,6 +22,25 @@ struct sx_digesttags {
 	uint32_t data;
 };
 
+/** A hash operation.
+ *
+ * To be used with sx_hash_*() functions.
+ *
+ * All members should be considered INTERNAL and may not be accessed
+ * directly.
+ */
+struct sxhash {
+	const struct sxhashalg *algo;
+	const struct sx_digesttags *dmatags;
+	uint32_t cntindescs;
+	size_t totalfeedsz;
+	uint32_t feedsz;
+	void (*digest)(struct sxhash *c, char *digest);
+	struct sx_dmactl dma;
+	struct sxdesc descs[7 + SX_EXTRA_IN_DESCS];
+	uint8_t extramem[SX_HASH_PRIV_SZ];
+};
+
 struct sxhashalg {
 	uint32_t cfgword;
 	uint32_t resumecfg;
@@ -28,17 +52,77 @@ struct sxhashalg {
 	int (*reservehw)(struct sxhash *c, size_t csz);
 };
 
+#define SX_HASH_DIGESTSZ_SHA1 20
+#define SX_HASH_BLOCKSZ_SHA1 64
+#define SX_HASH_DIGESTSZ_SHA2_224 28
+#define SX_HASH_DIGESTSZ_SHA2_256 32
+#define SX_HASH_DIGESTSZ_SHA2_384 48
+#define SX_HASH_DIGESTSZ_SHA2_512 64
+#define SX_HASH_BLOCKSZ_SHA2_224 64
+#define SX_HASH_BLOCKSZ_SHA2_256 64
+#define SX_HASH_BLOCKSZ_SHA2_384 128
+#define SX_HASH_BLOCKSZ_SHA2_512 128
+#define SX_HASH_DIGESTSZ_SHA3_224 28
+#define SX_HASH_DIGESTSZ_SHA3_256 32
+#define SX_HASH_DIGESTSZ_SHA3_384 48
+#define SX_HASH_DIGESTSZ_SHA3_512 64
+#define SX_HASH_BLOCKSZ_SHA3_224 144
+#define SX_HASH_BLOCKSZ_SHA3_256 136
+#define SX_HASH_BLOCKSZ_SHA3_384 104
+#define SX_HASH_BLOCKSZ_SHA3_512 72
+#define SX_HASH_DIGESTSZ_SM3 32
+#define SX_HASH_BLOCKSZ_SM3 64
+
+/** Hash algorithm SHA-1 (Secure Hash Algorithm 1)
+ *
+ * Deprecated algorithm. NIST formally deprecated use of SHA-1 in 2011
+ * and disallowed its use for digital signatures in 2013. SHA-3 or SHA-2
+ * are recommended instead.
+ */
 extern const struct sxhashalg sxhashalg_sha1;
+
+/** Hash algorithm SHA-2 224
+ *
+ * Has only 32 bit capacity against length extension attacks.
+ */
 extern const struct sxhashalg sxhashalg_sha2_224;
+
+/** Hash algorithm SHA-2 256
+ *
+ * Has no resistance against length extension attacks.
+ */
 extern const struct sxhashalg sxhashalg_sha2_256;
+
+/** Hash algorithm SHA-2 384
+ *
+ * Has 128 bit capacity against length extension attacks.
+ */
 extern const struct sxhashalg sxhashalg_sha2_384;
+
+/** Hash algorithm SHA-2 512
+ *
+ * Has no resistance against length extension attacks.
+ */
 extern const struct sxhashalg sxhashalg_sha2_512;
-extern const struct sxhashalg sxhashalg_sm3;
+
+/** Hash algorithm SHA-3 224 */
 extern const struct sxhashalg sxhashalg_sha3_224;
+
+/** Hash algorithm SHA-3 256 */
 extern const struct sxhashalg sxhashalg_sha3_256;
+
+/** Hash algorithm SHA-3 384 */
 extern const struct sxhashalg sxhashalg_sha3_384;
+
+/** Hash algorithm SHA-3 512*/
 extern const struct sxhashalg sxhashalg_sha3_512;
 
+/** Hash algorithm SHAKE256, with output size fixed to 114 bytes (for Ed448). */
+extern const struct sxhashalg sxhashalg_shake256_114;
+
+/** GM/T 0004-2012: SM3 cryptographic hash algorithm */
+extern const struct sxhashalg sxhashalg_sm3;
+
 #define CMDMA_BA413_BUS_MSK 3
 #define HASH_INVALID_BYTES  4 /* number of invalid bytes when empty message, required by HW */
 #define OFFSET_EXTRAMEM(c)  (sizeof((c)->dma.dmamem) + sizeof((c)->descs))
diff --git a/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/internal.h b/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/internal.h
@@ -17,9 +17,6 @@ extern "C" {
 #ifndef SX_EXTRA_IN_DESCS
 #define SX_EXTRA_IN_DESCS 0
 #endif
-#ifndef SX_HASH_PRIV_SZ
-#define SX_HASH_PRIV_SZ 344
-#endif
 
 #define SX_BLKCIPHER_PRIV_SZ (16)
 #define SX_AEAD_PRIV_SZ	     (70)
@@ -32,7 +29,6 @@ extern "C" {
 struct sx3gppalg;
 struct sx_blkcipher_cmdma_cfg;
 struct sx_aead_cmdma_cfg;
-struct sxhashalg;
 
 /** A cryptomaster DMA descriptor */
 struct sxdesc {
@@ -134,26 +130,6 @@ struct sx3gpp {
 	size_t outsz;
 };
 
-/** A hash operation.
- *
- * To be used with sx_hash_*() functions.
- *
- * All members should be considered INTERNAL and may not be accessed
- * directly.
- */
-struct sxhash {
-	const struct sxhashalg *algo;
-	const struct sx_digesttags *dmatags;
-	uint32_t cntindescs;
-	size_t totalfeedsz;
-	uint32_t feedsz;
-	void (*digest)(struct sxhash *c, char *digest);
-	struct sx_dmactl dma;
-	struct sxdesc descs[7 + SX_EXTRA_IN_DESCS];
-	uint8_t extramem[SX_HASH_PRIV_SZ];
-};
-
-
 /** A simple MAC(message authentication code) operation
  *
  * To be used with sx_mac_*() functions.
diff --git a/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/sha1.h b/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/sha1.h
diff --git a/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/sha2.h b/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/sha2.h
diff --git a/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/sha3.h b/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/sha3.h
diff --git a/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/sm3.h b/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/include/sxsymcrypt/sm3.h
diff --git a/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/src/hash.c b/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/src/hash.c
diff --git a/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/src/sha3.c b/subsys/nrf_security/src/drivers/cracen/sxsymcrypt/src/sha3.c
