aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorRonald Cron <ronald.cron@arm.com>2024-04-04 10:34:21 +0200
committerRonald Cron <ronald.cron@arm.com>2024-04-04 15:39:20 +0200
commitd85eeae7400fdeae62af303ba3f033939304127f (patch)
tree1a809b59fde36013ac5e664d182f13a2ea98e894 /include
parent66a206c26ca3bd23512a11088552ba6ebc19ffe7 (diff)
downloadmbedtls-d85eeae7400fdeae62af303ba3f033939304127f.zip
mbedtls-d85eeae7400fdeae62af303ba3f033939304127f.tar.gz
mbedtls-d85eeae7400fdeae62af303ba3f033939304127f.tar.bz2
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>
Diffstat (limited to 'include')
-rw-r--r--include/mbedtls/ssl.h22
1 files changed, 9 insertions, 13 deletions
diff --git a/include/mbedtls/ssl.h b/include/mbedtls/ssl.h
index 02737cb..11e447b 100644
--- a/include/mbedtls/ssl.h
+++ b/include/mbedtls/ssl.h
@@ -3216,16 +3216,11 @@ void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
* a full handshake.
*
* \note This function can handle a variety of mechanisms for session
- * resumption: For TLS 1.2, both session ID-based resumption and
- * ticket-based resumption will be considered. For TLS 1.3,
- * once implemented, sessions equate to tickets, and loading
- * one or more sessions via this call will lead to their
- * corresponding tickets being advertised as resumption PSKs
- * 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.
+ * resumption: For TLS 1.2, both session ID-based resumption
+ * and ticket-based resumption will be considered. For TLS 1.3,
+ * sessions equate to tickets, and loading one session by
+ * calling this function will lead to its corresponding ticket
+ * being advertised as resumption PSK by the client.
*
* \param ssl The SSL context representing the connection which should
* 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 MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the session
- * could not be loaded because of an implementation limitation.
- * This error is non-fatal, and has no observable effect on
- * the SSL context or the session that was attempted to be loaded.
+ * could not be loaded because one session has already been
+ * loaded. This error is non-fatal, and has no observable
+ * effect on the SSL context or the session that was attempted
+ * to be loaded.
* \return Another negative error code on other kinds of failure.
*
* \sa mbedtls_ssl_get_session()