From 44085de5f705fc9f81a4d0ef0a9bd793a1bb79f0 Mon Sep 17 00:00:00 2001 From: Mateusz Starzyk Date: Wed, 19 May 2021 13:22:53 +0200 Subject: [PATCH] Add migration guide for SHA384 and SHA224 options. Signed-off-by: Mateusz Starzyk --- .../modify_SHA384_option_behaviour.md | 9 +++++++++ .../separate_SHA224_from_SHA256.md | 11 +++++++++++ 2 files changed, 20 insertions(+) create mode 100644 docs/3.0-migration-guide.d/modify_SHA384_option_behaviour.md create mode 100644 docs/3.0-migration-guide.d/separate_SHA224_from_SHA256.md diff --git a/docs/3.0-migration-guide.d/modify_SHA384_option_behaviour.md b/docs/3.0-migration-guide.d/modify_SHA384_option_behaviour.md new file mode 100644 index 000000000..0efe14aa7 --- /dev/null +++ b/docs/3.0-migration-guide.d/modify_SHA384_option_behaviour.md @@ -0,0 +1,9 @@ +Replaced MBEDTLS_SHA512_NO_SHA384 with MBEDTLS_SHA384_C +------------------------------------------------------ + +This does not affect users who use the default `config.h`. +MBEDTLS_SHA512_NO_SHA384 was disabled by default, now MBEDTLS_SHA384_C is +enabled by default. + +If you were using a config file with MBEDTLS_SHA512_NO_SHA384 enabled, +then just remove it (don't define MBEDTLS_SHA384_C). diff --git a/docs/3.0-migration-guide.d/separate_SHA224_from_SHA256.md b/docs/3.0-migration-guide.d/separate_SHA224_from_SHA256.md new file mode 100644 index 000000000..96a38e057 --- /dev/null +++ b/docs/3.0-migration-guide.d/separate_SHA224_from_SHA256.md @@ -0,0 +1,11 @@ +Separated MBEDTLS_SHA224_C and MBEDTLS_SHA256_C +----------------------------------------------------------------- + +This does not affect users who use the default `config.h`. MBEDTLS_SHA256_C +was enabled by default. Now both MBEDTLS_SHA256_C and MBEDTLS_SHA224_C are +enabled. + +If you were using custom config file with MBEDTLS_SHA256_C enabled, then +you will need to add `#define MBEDTLS_SHA224_C` option your config. +Current version of the library does not support enabling MBEDTLS_SHA256_C +without MBEDTLS_SHA224_C.