aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorRonald Cron <ronald.cron@arm.com>2024-04-04 15:34:22 +0200
committerRonald Cron <ronald.cron@arm.com>2024-04-04 15:34:22 +0200
commit66a206c26ca3bd23512a11088552ba6ebc19ffe7 (patch)
tree857061c5a635c7773510fa92e4bf1f045d89e68c /include
parent81bb589090f9ee1e0a83a5d3711a4c6f3e6760d4 (diff)
downloadmbedtls-66a206c26ca3bd23512a11088552ba6ebc19ffe7.zip
mbedtls-66a206c26ca3bd23512a11088552ba6ebc19ffe7.tar.gz
mbedtls-66a206c26ca3bd23512a11088552ba6ebc19ffe7.tar.bz2
tls13: Fix doc of mbedtls_ssl_session_get() - 2
Fix documentation of mbedtls_ssl_session_get() regarding its interaction with session ticket enablement. Signed-off-by: Ronald Cron <ronald.cron@arm.com>
Diffstat (limited to 'include')
-rw-r--r--include/mbedtls/ssl.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/include/mbedtls/ssl.h b/include/mbedtls/ssl.h
index 4064ab2..02737cb 100644
--- a/include/mbedtls/ssl.h
+++ b/include/mbedtls/ssl.h
@@ -4845,8 +4845,12 @@ const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl
* \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,
- * sessions equate to tickets, and this function exports the
- * last received ticket.
+ * sessions equate to tickets, and if session tickets are
+ * enabled (see #MBEDTLS_SSL_SESSION_TICKETS configuration
+ * option), this function exports the last received ticket and
+ * the exported session may be used to resume the TLS 1.3
+ * session. If session tickets are disabled, exported sessions
+ * cannot be used to resume a TLS 1.3 session.
*
* \return \c 0 if successful. In this case, \p session can be used for
* session resumption by passing it to mbedtls_ssl_set_session(),