Update SHA-224 documentation.
Rephrase config.h documentation and add a note to template
configs.
Signed-off-by: Mateusz Starzyk <mateusz.starzyk@mobica.com>
diff --git a/configs/config-ccm-psk-tls1_2.h b/configs/config-ccm-psk-tls1_2.h
index 09223b9..8a8e729 100644
--- a/configs/config-ccm-psk-tls1_2.h
+++ b/configs/config-ccm-psk-tls1_2.h
@@ -48,6 +48,8 @@
#define MBEDTLS_ENTROPY_C
#define MBEDTLS_MD_C
#define MBEDTLS_NET_C
+/* Library does not support enabling SHA-224 without SHA-256. Future version will
+ * have this option disabled by default. */
#define MBEDTLS_SHA224_C
#define MBEDTLS_SHA256_C
#define MBEDTLS_SSL_CLI_C
diff --git a/configs/config-mini-tls1_1.h b/configs/config-mini-tls1_1.h
index 0d58e49..d09c1f8 100644
--- a/configs/config-mini-tls1_1.h
+++ b/configs/config-mini-tls1_1.h
@@ -56,6 +56,8 @@
#define MBEDTLS_PK_PARSE_C
#define MBEDTLS_RSA_C
#define MBEDTLS_SHA1_C
+/* Library does not support enabling SHA-224 without SHA-256. Future version will
+ * have this option disabled by default. */
#define MBEDTLS_SHA224_C
#define MBEDTLS_SHA256_C
#define MBEDTLS_SSL_CLI_C
diff --git a/configs/config-no-entropy.h b/configs/config-no-entropy.h
index d4948de..d0aef1d 100644
--- a/configs/config-no-entropy.h
+++ b/configs/config-no-entropy.h
@@ -73,6 +73,8 @@
#define MBEDTLS_PK_WRITE_C
#define MBEDTLS_PLATFORM_C
#define MBEDTLS_RSA_C
+/* Library does not support enabling SHA-224 without SHA-256. Future version will
+ * have this option disabled by default. */
#define MBEDTLS_SHA224_C
#define MBEDTLS_SHA256_C
#define MBEDTLS_SHA384_C
diff --git a/configs/config-suite-b.h b/configs/config-suite-b.h
index 9466845..ea6a5bf 100644
--- a/configs/config-suite-b.h
+++ b/configs/config-suite-b.h
@@ -63,6 +63,8 @@
#define MBEDTLS_OID_C
#define MBEDTLS_PK_C
#define MBEDTLS_PK_PARSE_C
+/* Library does not support enabling SHA-224 without SHA-256. Future version will
+ * have this option disabled by default. */
#define MBEDTLS_SHA224_C
#define MBEDTLS_SHA256_C
#define MBEDTLS_SHA384_C
diff --git a/configs/config-symmetric-only.h b/configs/config-symmetric-only.h
index 9b69dfe..066991c 100644
--- a/configs/config-symmetric-only.h
+++ b/configs/config-symmetric-only.h
@@ -84,6 +84,8 @@
#define MBEDTLS_PSA_ITS_FILE_C
#define MBEDTLS_RIPEMD160_C
#define MBEDTLS_SHA1_C
+/* Library does not support enabling SHA-224 without SHA-256. Future version will
+ * have this option disabled by default. */
#define MBEDTLS_SHA224_C
#define MBEDTLS_SHA256_C
#define MBEDTLS_SHA384_C
diff --git a/configs/config-thread.h b/configs/config-thread.h
index 3314037..4ccbffa 100644
--- a/configs/config-thread.h
+++ b/configs/config-thread.h
@@ -67,6 +67,8 @@
#define MBEDTLS_OID_C
#define MBEDTLS_PK_C
#define MBEDTLS_PK_PARSE_C
+/* Library does not support enabling SHA-224 without SHA-256. Future version will
+ * have this option disabled by default. */
#define MBEDTLS_SHA224_C
#define MBEDTLS_SHA256_C
#define MBEDTLS_SSL_COOKIE_C
diff --git a/include/mbedtls/config.h b/include/mbedtls/config.h
index 251a616..8e60951 100644
--- a/include/mbedtls/config.h
+++ b/include/mbedtls/config.h
@@ -3106,10 +3106,10 @@
* \def MBEDTLS_SHA224_C
*
* Enable the SHA-224 cryptographic hash algorithm.
+ * Future version will have this option disabled by default.
*
* Requires: MBEDTLS_SHA256_C. Library does not support enabling
- * SHA-224 without SHA-256. Future version will have
- * this option disabled by default.
+ * SHA-224 without SHA-256.
*
* Module: library/sha256.c
* Caller: library/md.c
