lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-08-08 17:42:09 +03:00
Code Activity

Fix typos in the 3.0 migration guide

Browse Source 
Signed-off-by: David Horstmann <david.horstmann@arm.com>
This commit is contained in:
David Horstmann
2025-03-13 15:52:00 +00:00
parent 906d3cdff5
commit edebcc04f8
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/3.0-migration-guide.md
View File

@@ -349,7 +349,7 @@ original names of those functions. The renamed functions are:
| `mbedtls_sha512_finish_ret` | `mbedtls_sha512_finish` | | `mbedtls_sha512_finish_ret` | `mbedtls_sha512_finish` |
| `mbedtls_sha512_ret` | `mbedtls_sha512` | | `mbedtls_sha512_ret` | `mbedtls_sha512` |
To migrate to the this change the user can keep the `*_ret` names in their code To migrate to this change the user can keep the `*_ret` names in their code
and include the `compat_2.x.h` header file which holds macros with proper and include the `compat_2.x.h` header file which holds macros with proper
renaming or to rename those functions in their code according to the list from renaming or to rename those functions in their code according to the list from
mentioned header file. mentioned header file.
@@ -409,7 +409,7 @@ using the multi-part API.
Previously, the documentation didn't state explicitly if it was OK to call Previously, the documentation didn't state explicitly if it was OK to call
`mbedtls_cipher_check_tag()` or `mbedtls_cipher_write_tag()` directly after `mbedtls_cipher_check_tag()` or `mbedtls_cipher_write_tag()` directly after
the last call to `mbedtls_cipher_update()` — that is, without calling the last call to `mbedtls_cipher_update()` — that is, without calling
`mbedtls_cipher_finish()` in-between. If you code was missing that call, `mbedtls_cipher_finish()` in-between. If your code was missing that call,
please add it and be prepared to get as much as 15 bytes of output. please add it and be prepared to get as much as 15 bytes of output.
Currently the output is always 0 bytes, but it may be more when alternative Currently the output is always 0 bytes, but it may be more when alternative
@@ -422,7 +422,7 @@ This change affects users of the MD2, MD4, RC4, Blowfish and XTEA algorithms.
They are already niche or obsolete and most of them are weak or broken. For They are already niche or obsolete and most of them are weak or broken. For
those reasons possible users should consider switching to modern and safe those reasons possible users should consider switching to modern and safe
alternatives to be found in literature. alternatives to be found in the literature.
### Deprecated functions were removed from cipher ### Deprecated functions were removed from cipher
@@ -806,11 +806,11 @@ multiple times on the same SSL configuration.
In Mbed TLS 2.x, users would observe later calls overwriting In Mbed TLS 2.x, users would observe later calls overwriting
the effect of earlier calls, with the prevailing PSK being the effect of earlier calls, with the prevailing PSK being
the one that has been configured last. In Mbed TLS 3.0, the one that has been configured last. In Mbed TLS 3.0,
calling `mbedtls_ssl_conf_[opaque_]psk()` multiple times calling `mbedtls_ssl_conf_psk[_opaque]()` multiple times
will return an error, leaving the first PSK intact. will return an error, leaving the first PSK intact.
To achieve equivalent functionality when migrating to Mbed TLS 3.0, To achieve equivalent functionality when migrating to Mbed TLS 3.0,
users calling `mbedtls_ssl_conf_[opaque_]psk()` multiple times should users calling `mbedtls_ssl_conf_psk[_opaque]()` multiple times should
remove all but the last call, so that only one call to _either_ remove all but the last call, so that only one call to _either_
`mbedtls_ssl_conf_psk()` _or_ `mbedtls_ssl_conf_psk_opaque()` `mbedtls_ssl_conf_psk()` _or_ `mbedtls_ssl_conf_psk_opaque()`
remains. remains.