improve document about session tickets

Signed-off-by: Jerry Yu <jerry.h.yu@arm.com>
This commit is contained in:
Jerry Yu 2022-09-23 09:58:22 +08:00
parent 40b4a01388
commit ba627bfd0d

View file

@ -4137,16 +4137,17 @@ void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets
defined(MBEDTLS_SSL_SRV_C) && \ defined(MBEDTLS_SSL_SRV_C) && \
defined(MBEDTLS_SSL_PROTO_TLS1_3) defined(MBEDTLS_SSL_PROTO_TLS1_3)
/** /**
* \brief Number of NewSessionTicket messages for the server to send * \brief Number of NewSessionTicket messages for the server to send
* after handshake completion. * after handshake completion.
*
* \note The default value is * \note The default value is
* MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS. * \c MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS.
* \note In case of a session resumption, this setting only partially *
* apply. At most one ticket is sent in that case to just review the * \note In case of a session resumption, this setting only partially apply.
* pool of tickets of the client. The rationale is to avoid the * At most one ticket is sent in that case to just renew the pool of
* number of tickets on the server to become rapidly out of * tickets of the client. The rationale is to avoid the number of
* control when the server has the same configuration for all its * tickets on the server to become rapidly out of control when the
* connection instances. * server has the same configuration for all its connection instances.
* *
* \param conf SSL configuration * \param conf SSL configuration
* \param num_tickets Number of NewSessionTicket. * \param num_tickets Number of NewSessionTicket.