From b2efc4d4648082058461c664ca597cf661074902 Mon Sep 17 00:00:00 2001 From: Hanno Becker Date: Sat, 15 May 2021 06:26:24 +0100 Subject: [PATCH] Add migration guide Signed-off-by: Hanno Becker --- docs/3.0-migration-guide.d/max-record-payload-api.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 docs/3.0-migration-guide.d/max-record-payload-api.md diff --git a/docs/3.0-migration-guide.d/max-record-payload-api.md b/docs/3.0-migration-guide.d/max-record-payload-api.md new file mode 100644 index 000000000..0b34915f4 --- /dev/null +++ b/docs/3.0-migration-guide.d/max-record-payload-api.md @@ -0,0 +1,11 @@ +Remove MaximumFragmentLength (MFL) query API +----------------------------------------------------------------- + +This affects users which use the MFL query APIs +`mbedtls_ssl_get_{input,output}_max_frag_len()` to +infer upper bounds on the plaintext size of incoming and +outgoing record. + +Users should switch to `mbedtls_ssl_get_max_{in,out}_record_payload()` +instead, which also provides such upper bounds but takes more factors +than just the MFL configuration into account.