Expand documentation of new options a bit

This commit is contained in:
Manuel Pégourié-Gonnard 2019-07-01 11:06:35 +02:00
parent 8a0944cb99
commit 320eb7ac4e
2 changed files with 15 additions and 11 deletions

View file

@ -38,10 +38,12 @@ Features
ServerHello. ServerHello.
* Add new configuration option MBEDTLS_SSL_PROTO_NO_TLS that enables code * Add new configuration option MBEDTLS_SSL_PROTO_NO_TLS that enables code
size savings in configurations where only DTLS is used. size savings in configurations where only DTLS is used.
* Add new configuration option MBEDTLS_SSL_NO_SESSION_CACHE that can be used * Add new configuration option MBEDTLS_SSL_NO_SESSION_CACHE that enables
to disable cache based session resumption code size savings in configurations where cache-based session resumption is
* Add new configuration option MBEDTLS_SSL_NO_SESSION_RESUMPTION that can be not used.
used to disable session resumption feature entirely. * Add new configuration option MBEDTLS_SSL_NO_SESSION_RESUMPTION that
enables code size savings in configurations where no form of session
resumption is used.
API Changes API Changes
* Add a new X.509 API call `mbedtls_x509_parse_der_nocopy()`. * Add a new X.509 API call `mbedtls_x509_parse_der_nocopy()`.

View file

@ -1666,14 +1666,16 @@
* *
* Requires: !MBEDTLS_SSL_NO_SESSION_RESUMPTION * Requires: !MBEDTLS_SSL_NO_SESSION_RESUMPTION
* *
* Comment this macro to disable support for SSL session tickets * Comment this macro to disable support for SSL session tickets.
*/ */
#define MBEDTLS_SSL_SESSION_TICKETS #define MBEDTLS_SSL_SESSION_TICKETS
/** /**
* \def MBEDTLS_SSL_NO_SESSION_CACHE * \def MBEDTLS_SSL_NO_SESSION_CACHE
* *
* Disable support for cache based session resumption. * Disable support for cache based session resumption. This is useful to
* reduce code size in configurations where cache-based session resumption is
* not used.
* *
* This option is only about the server-side support of the session caches. * This option is only about the server-side support of the session caches.
* Client will only need !MBEDTLS_SSL_NO_SESSION_RESUMPTION to support * Client will only need !MBEDTLS_SSL_NO_SESSION_RESUMPTION to support
@ -1685,19 +1687,19 @@
* If MBEDTLS_SSL_NO_SESSION_RESUMPTION is defined, this needs to be defined * If MBEDTLS_SSL_NO_SESSION_RESUMPTION is defined, this needs to be defined
* as well. * as well.
* *
* Uncomment this macro to disable support for SSL session cache * Uncomment this macro to disable support for SSL session cache.
*/ */
//#define MBEDTLS_SSL_NO_SESSION_CACHE //#define MBEDTLS_SSL_NO_SESSION_CACHE
/** /**
* \def MBEDTLS_SSL_NO_SESSION_RESUMPTION * \def MBEDTLS_SSL_NO_SESSION_RESUMPTION
* *
* Disable support for session resumption. This is useful in constrained * Disable support for session resumption. This is useful to reduce code size
* devices where session resumption isn't used. * in configurations where no form of session resumption is used.
* *
* \note Session resumption is part of the TLS standard, disabling this * \note Session resumption is part of the TLS standard, disabling this
* option means that the full implementation of the standard is no longer * option means that the full implementation of the standard is no longer
* used. This shouldn't cause any interoperability issues as by the standard * used. This shouldn't cause any interoperability issues as the standard
* mandates that peers who want to resume a session need to be prepared to * mandates that peers who want to resume a session need to be prepared to
* fall back to a full handshake. * fall back to a full handshake.
* *
@ -1715,7 +1717,7 @@
* or tickets, examples of which are provided by MBEDTLS_SSL_CACHE_C * or tickets, examples of which are provided by MBEDTLS_SSL_CACHE_C
* and MBEDTLS_SSL_TICKETS_C respectively. * and MBEDTLS_SSL_TICKETS_C respectively.
* *
* Uncomment this macro to disable support for SSL session resumption * Uncomment this macro to disable support for SSL session resumption.
*/ */
//#define MBEDTLS_SSL_NO_SESSION_RESUMPTION //#define MBEDTLS_SSL_NO_SESSION_RESUMPTION