From 9d2d6c9ea02dfac32f35ae5fce2128755c0f638f Mon Sep 17 00:00:00 2001 From: Mateusz Starzyk Date: Tue, 18 May 2021 15:54:20 +0200 Subject: [PATCH] Clarfiy SHA224 and SHA256 documentation Signed-off-by: Mateusz Starzyk --- configs/config-ccm-psk-tls1_2.h | 5 +++-- configs/config-mini-tls1_1.h | 5 +++-- configs/config-no-entropy.h | 5 +++-- configs/config-suite-b.h | 5 +++-- configs/config-symmetric-only.h | 5 +++-- configs/config-thread.h | 5 +++-- include/mbedtls/config.h | 6 +++--- 7 files changed, 21 insertions(+), 15 deletions(-) diff --git a/configs/config-ccm-psk-tls1_2.h b/configs/config-ccm-psk-tls1_2.h index 8a8e7299ea..e54e7a0a22 100644 --- a/configs/config-ccm-psk-tls1_2.h +++ b/configs/config-ccm-psk-tls1_2.h @@ -48,8 +48,9 @@ #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. */ +/* The library does not currently support enabling SHA-224 without SHA-256. + * A future version of the library 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 d09c1f81fa..83d1ab713c 100644 --- a/configs/config-mini-tls1_1.h +++ b/configs/config-mini-tls1_1.h @@ -56,8 +56,9 @@ #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. */ +/* The library does not currently support enabling SHA-224 without SHA-256. + * A future version of the library 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 d0aef1d5cb..09b3cf5e0a 100644 --- a/configs/config-no-entropy.h +++ b/configs/config-no-entropy.h @@ -73,8 +73,9 @@ #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. */ +/* The library does not currently support enabling SHA-224 without SHA-256. + * A future version of the library 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 ea6a5bf5f8..26e03de4a6 100644 --- a/configs/config-suite-b.h +++ b/configs/config-suite-b.h @@ -63,8 +63,9 @@ #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. */ +/* The library does not currently support enabling SHA-224 without SHA-256. + * A future version of the library 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 066991cb34..29e77b52c9 100644 --- a/configs/config-symmetric-only.h +++ b/configs/config-symmetric-only.h @@ -84,8 +84,9 @@ #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. */ +/* The library does not currently support enabling SHA-224 without SHA-256. + * A future version of the library 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 4ccbffa255..bce9668fd0 100644 --- a/configs/config-thread.h +++ b/configs/config-thread.h @@ -67,8 +67,9 @@ #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. */ +/* The library does not currently support enabling SHA-224 without SHA-256. + * A future version of the library 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 8e60951e77..8bd07a7b72 100644 --- a/include/mbedtls/config.h +++ b/include/mbedtls/config.h @@ -3106,9 +3106,9 @@ * \def MBEDTLS_SHA224_C * * Enable the SHA-224 cryptographic hash algorithm. - * Future version will have this option disabled by default. + * A future version of the library will have this option disabled by default. * - * Requires: MBEDTLS_SHA256_C. Library does not support enabling + * Requires: MBEDTLS_SHA256_C. The library does not currently support enabling * SHA-224 without SHA-256. * * Module: library/sha256.c @@ -3124,7 +3124,7 @@ * * Enable the SHA-256 cryptographic hash algorithm. * - * Requires: MBEDTLS_SHA224_C. Library does not support enabling + * Requires: MBEDTLS_SHA224_C. The library does not currently support enabling * SHA-256 without SHA-224. * * Module: library/sha256.c