Skip to content

Commit 6671909

Browse files
Ensure there is a blank line before headers (markdown portability)
Signed-off-by: Gilles Peskine <[email protected]>
1 parent 2c0cb99 commit 6671909

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/4.0-migration-guide.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,7 @@ If you integrate Mbed TLS with a platform or hardware drivers:
211211
- The PSA driver wrapper is now generated in TF-PSA-Crypto.
212212
- Platform-specific configuration are now handled in `crypto_config.h`.
213213
- See [Repository split](#repository-split) for how platform components moved to TF-PSA-Crypto.
214+
214215
## Compile-time configuration
215216

216217
### Configuration file split
@@ -255,6 +256,7 @@ The option to enable null cipher suites in TLS 1.2 has been renamed from `MBEDTL
255256
#### Removal of backward compatibility options
256257

257258
The option `MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT` has been removed. Only the version standardized in RFC 9146 is supported now.
259+
258260
## PSA as the only cryptography API
259261

260262
The PSA API is now the only API for cryptographic primitives.
@@ -278,6 +280,7 @@ See also [function prototype changes](#function-prototype-changes), many of whic
278280
### Impact on the library configuration
279281

280282
Mbed TLS follows the configuration of TF-PSA-Crypto with respect to cryptographic mechanisms. They are now based on `PSA_WANT_xxx` macros instead of legacy configuration macros such as `MBEDTLS_RSA_C`, `MBEDTLS_PKCS1_V15`, etc. The configuration of X.509 and TLS is not directly affected by the configuration. However, applications and middleware that rely on these configuration symbols to know which cryptographic mechanisms to support will need to migrate to `PSA_WANT_xxx` macros. For more information, consult the PSA transition guide in TF-PSA-Crypto.
283+
281284
## Private declarations
282285

283286
Since Mbed TLS 3.0, some things that are declared in a public header are not part of the stable application programming interface (API), but instead are considered private. Private elements may be removed or may have their semantics changed in a future minor release without notice.
@@ -311,6 +314,7 @@ We strongly recommend against defining `MBEDTLS_DECLARE_PRIVATE_IDENTIFIERS` or
311314
may not compile or work with future minor releases. If there's something you
312315
want to do that you feel can only be achieved by using one of these two macros,
313316
please reach out on github or the mailing list.
317+
314318
## Error codes
315319

316320
### Unified error code space
@@ -348,6 +352,7 @@ Many legacy error codes have been removed in favor of PSA error codes. Generally
348352
| `MBEDTLS_ERR_X509_BUFFER_TOO_SMALL` | `PSA_ERROR_BUFFER_TOO_SMALL` |
349353

350354
See also the corresponding section in the TF-PSA-Crypto migration guide, which lists error codes from cryptography modules.
355+
351356
## Removal of deprecated functions
352357

353358
### Removal of deprecated X.509 functions
@@ -362,6 +367,7 @@ The function was superseded by `mbedtls_ssl_conf_groups()`.
362367
### Removal of `compat-2.x.h`
363368

364369
The header `compat-2.x.h`, containing some definitions for backward compatibility with Mbed TLS 2.x, has been removed.
370+
365371
## Removed features
366372

367373
### Removal of obsolete key exchanges methods in (D)TLS 1.2
@@ -514,6 +520,7 @@ Following their removal from the crypto library, elliptic curves of less than 25
514520
The deprecated functions `mbedtls_ssl_conf_min_version()` and `mbedtls_ssl_conf_max_version()`, and the associated constants `MBEDTLS_SSL_MAJOR_VERSION_3`, `MBEDTLS_SSL_MINOR_VERSION_3` and `MBEDTLS_SSL_MINOR_VERSION_4` have been removed. Use `mbedtls_ssl_conf_min_tls_version()` and `mbedtls_ssl_conf_max_tls_version()` with `MBEDTLS_SSL_VERSION_TLS1_2` or `MBEDTLS_SSL_VERSION_TLS1_3` instead.
515521

516522
The deprecated function `mbedtls_ssl_conf_sig_hashes()` has been removed. Use `mbedtls_ssl_conf_sig_algs()` instead.
523+
517524
## Function prototype changes
518525

519526
A number of existing functions now take a different list of arguments, mostly to migrate them to the PSA API.
@@ -603,6 +610,7 @@ int mbedtls_ssl_ticket_setup(mbedtls_ssl_ticket_context *ctx,
603610
psa_algorithm_t alg, psa_key_type_t key_type, psa_key_bits_t key_bits,
604611
uint32_t lifetime);
605612
```
613+
606614
## OID module
607615

608616
The compilation option `MBEDTLS_OID_C` no longer exists. OID tables are included in the build automatically as needed for parsing and writing X.509 data.

0 commit comments

Comments
 (0)