tls13: Fix doc of mbedtls_ssl_session_set() - 1

It was eventually decided to not support multiple
tickets in TLS 1.3 ClientHello messages thus
removing the parts in mbedtls_ssl_session_set()
documentation that were anticipating that.

Signed-off-by: Ronald Cron <ronald.cron@arm.com>
This commit is contained in:
Ronald Cron 2024-04-04 10:34:21 +02:00
parent 66a206c26c
commit d85eeae740

View File

@ -3216,16 +3216,11 @@ void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
* a full handshake. * a full handshake.
* *
* \note This function can handle a variety of mechanisms for session * \note This function can handle a variety of mechanisms for session
* resumption: For TLS 1.2, both session ID-based resumption and * resumption: For TLS 1.2, both session ID-based resumption
* ticket-based resumption will be considered. For TLS 1.3, * and ticket-based resumption will be considered. For TLS 1.3,
* once implemented, sessions equate to tickets, and loading * sessions equate to tickets, and loading one session by
* one or more sessions via this call will lead to their * calling this function will lead to its corresponding ticket
* corresponding tickets being advertised as resumption PSKs * being advertised as resumption PSK by the client.
* by the client.
*
* \note Calling this function multiple times will only be useful
* once TLS 1.3 is supported. For TLS 1.2 connections, this
* function should be called at most once.
* *
* \param ssl The SSL context representing the connection which should * \param ssl The SSL context representing the connection which should
* be attempted to be setup using session resumption. This * be attempted to be setup using session resumption. This
@ -3240,9 +3235,10 @@ void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
* *
* \return \c 0 if successful. * \return \c 0 if successful.
* \return \c MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the session * \return \c MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the session
* could not be loaded because of an implementation limitation. * could not be loaded because one session has already been
* This error is non-fatal, and has no observable effect on * loaded. This error is non-fatal, and has no observable
* the SSL context or the session that was attempted to be loaded. * effect on the SSL context or the session that was attempted
* to be loaded.
* \return Another negative error code on other kinds of failure. * \return Another negative error code on other kinds of failure.
* *
* \sa mbedtls_ssl_get_session() * \sa mbedtls_ssl_get_session()