diff options
| author | Jaeden Amero <jaeden.amero@arm.com> | 2019-05-22 15:35:56 +0100 |
|---|---|---|
| committer | Jaeden Amero <jaeden.amero@arm.com> | 2019-05-23 15:14:06 +0100 |
| commit | cbcd327376adb03bad1caa9e33e27c8fe00de470 (patch) | |
| tree | 885f122b155c501a8617fa09ab9dda48476c3e4b /include | |
| parent | c7aa05eb34137ea28417e0189234f199ab48abd9 (diff) | |
| parent | b5f9a198da3ba885b1adac6854233f241fb62e8b (diff) | |
Merge remote-tracking branch 'origin/pr/2611' into mbedtls-2.16
* origin/pr/2611:
Update change log
Reword ssl_conf_max_frag_len documentation for clarity
Diffstat (limited to 'include')
| -rw-r--r-- | include/mbedtls/ssl.h | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/include/mbedtls/ssl.h b/include/mbedtls/ssl.h index 8106bb4a..d31f6cdd 100644 --- a/include/mbedtls/ssl.h +++ b/include/mbedtls/ssl.h @@ -2532,22 +2532,28 @@ void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf, #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) /** - * \brief Set the maximum fragment length to emit and/or negotiate - * (Default: the smaller of MBEDTLS_SSL_IN_CONTENT_LEN and - * MBEDTLS_SSL_OUT_CONTENT_LEN, usually 2^14 bytes) + * \brief Set the maximum fragment length to emit and/or negotiate. + * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and + * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes) * (Server: set maximum fragment length to emit, - * usually negotiated by the client during handshake + * usually negotiated by the client during handshake) * (Client: set maximum fragment length to emit *and* * negotiate with the server during handshake) + * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE) * - * \note With TLS, this currently only affects ApplicationData (sent - * with \c mbedtls_ssl_read()), not handshake messages. - * With DTLS, this affects both ApplicationData and handshake. + * \note On the client side, the maximum fragment length extension + * *will not* be used, unless the maximum fragment length has + * been set via this function to a value different than + * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE. * * \note This sets the maximum length for a record's payload, * excluding record overhead that will be added to it, see * \c mbedtls_ssl_get_record_expansion(). * + * \note With TLS, this currently only affects ApplicationData (sent + * with \c mbedtls_ssl_read()), not handshake messages. + * With DTLS, this affects both ApplicationData and handshake. + * * \note For DTLS, it is also possible to set a limit for the total * size of daragrams passed to the transport layer, including * record overhead, see \c mbedtls_ssl_set_mtu(). |