blob: 875164b25bc9a9d559a0aa30f7a59a700856d5dd [file] [log] [blame] [view]
TRodziewicz1fcd72e2021-06-14 11:16:06 +02001Rename mbedtls_*_ret() cryptography functions whose deprecated variants
TRodziewicz28a4a962021-06-15 00:18:32 +02002have been removed
3-----------------
TRodziewicz1e666422021-06-09 11:25:28 +02004
TRodziewicz1fcd72e2021-06-14 11:16:06 +02005This change affects users who were using the `mbedtls_*_ret()` cryptography
6functions.
TRodziewicz1e666422021-06-09 11:25:28 +02007
8Those functions were created based on now-deprecated functions according to a
9requirement that a function needs to return a value. This change brings back the
TRodziewicz28a4a962021-06-15 00:18:32 +020010original names of those functions. The renamed functions are:
11
12| name before this change | after the change |
13|------------------------------|--------------------------|
14| mbedtls_ctr_drbg_update_ret | mbedtls_ctr_drbg_update |
15| mbedtls_hmac_drbg_update_ret | mbedtls_hmac_drbg_update |
TRodziewicz28a4a962021-06-15 00:18:32 +020016| mbedtls_md5_starts_ret | mbedtls_md5_starts |
17| mbedtls_md5_update_ret | mbedtls_md5_update |
18| mbedtls_md5_finish_ret | mbedtls_md5_finish |
19| mbedtls_md5_ret | mbedtls_md5 |
20| mbedtls_ripemd160_starts_ret | mbedtls_ripemd160_starts |
21| mbedtls_ripemd160_update_ret | mbedtls_ripemd160_update |
22| mbedtls_ripemd160_finish_ret | mbedtls_ripemd160_finish |
23| mbedtls_ripemd160_ret | mbedtls_ripemd160 |
24| mbedtls_sha1_starts_ret | mbedtls_sha1_starts |
25| mbedtls_sha1_update_ret | mbedtls_sha1_update |
26| mbedtls_sha1_finish_ret | mbedtls_sha1_finish |
27| mbedtls_sha1_ret | mbedtls_sha1 |
28| mbedtls_sha256_starts_ret | mbedtls_sha256_starts |
29| mbedtls_sha256_update_ret | mbedtls_sha256_update |
30| mbedtls_sha256_finish_ret | mbedtls_sha256_finish |
31| mbedtls_sha256_ret | mbedtls_sha256 |
32| mbedtls_sha512_starts_ret | mbedtls_sha512_starts |
33| mbedtls_sha512_update_ret | mbedtls_sha512_update |
34| mbedtls_sha512_finish_ret | mbedtls_sha512_finish |
35| mbedtls_sha512_ret | mbedtls_sha512 |
TRodziewicz1e666422021-06-09 11:25:28 +020036
37To migrate to the this change the user can keep the `*_ret` names in their code
38and include the `compat_2.x.h` header file which holds macros with proper
39renaming or to rename those function in their code according to the list from
40mentioned header file.
TRodziewicz28a4a962021-06-15 00:18:32 +020041
42
43