yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2025-01-22 20:51:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change wording of directions on the usage of SSL context after error

Browse source
This commit is contained in:
Hanno Becker 2017-11-06 10:45:26 +00:00
parent 77abef5cba
commit 298a7b214d
1 changed files with 31 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
include/mbedtls/ssl.h
View file

@ -2418,10 +2418,10 @@ int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session
* DTLS records. * DTLS records.
* *
* \note If this function returns something other than 0 or * \note If this function returns something other than 0 or
* MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
* becomes unusable, and you should either free it or call * the SSL context for reading or writing, and either free it or
* \c mbedtls_ssl_session_reset() on it before re-using it for * call \c mbedtls_ssl_session_reset() on it before re-using it
* a new connection; the current connection must be closed. * for a new connection; the current connection must be closed.
* *
* \note If DTLS is in use, then you may choose to handle * \note If DTLS is in use, then you may choose to handle
* MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
@ -2438,10 +2438,10 @@ int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
* call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER. * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
* *
* \note If this function returns something other than 0 or * \note If this function returns something other than 0 or
* MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
* becomes unusable, and you should either free it or call * the SSL context for reading or writing, and either free it or
* \c mbedtls_ssl_session_reset() on it before re-using it for * call \c mbedtls_ssl_session_reset() on it before re-using it
* a new connection; the current connection must be closed. * for a new connection; the current connection must be closed.
* *
* \param ssl SSL context * \param ssl SSL context
* *
@ -2465,10 +2465,10 @@ int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
* value. * value.
* *
* \note If this function returns something other than 0 or * \note If this function returns something other than 0 or
* MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
* becomes unusable, and you should either free it or call * the SSL context for reading or writing, and either free it or
* \c mbedtls_ssl_session_reset() on it before re-using it for * call \c mbedtls_ssl_session_reset() on it before re-using it
* a new connection; the current connection must be closed. * for a new connection; the current connection must be closed.
*/ */
int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl ); int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
#endif /* MBEDTLS_SSL_RENEGOTIATION */ #endif /* MBEDTLS_SSL_RENEGOTIATION */
@ -2507,12 +2507,12 @@ int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
* again, or not transmitting the new identity to the * again, or not transmitting the new identity to the
* application layer, would allow authentication bypass! * application layer, would allow authentication bypass!
* *
* If this function returns something other than a positive * \note If this function returns something other than a positive value
* value or MBEDTLS_ERR_SSL_WANT_READ/WRITE or * or MBEDTLS_ERR_SSL_WANT_READ/WRITE or MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
* MBEDTLS_ERR_SSL_CLIENT_RECONNECT, then the ssl context * you must stop using the SSL context for reading or writing,
* becomes unusable, and you should either free it or call * and either free it or call \c mbedtls_ssl_session_reset() on it
* \c mbedtls_ssl_session_reset() on it before re-using it for * before re-using it for a new connection; the current connection
* a new connection. * must be closed.
* *
* \note Remarks regarding event-driven DTLS: * \note Remarks regarding event-driven DTLS:
* - If the function returns MBEDTLS_ERR_SSL_WANT_READ, no datagram * - If the function returns MBEDTLS_ERR_SSL_WANT_READ, no datagram
@ -2548,11 +2548,11 @@ int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len )
* or MBEDTLS_ERR_SSL_WANT_WRITE or MBEDTLS_ERR_SSL_WANT_READ, * or MBEDTLS_ERR_SSL_WANT_WRITE or MBEDTLS_ERR_SSL_WANT_READ,
* or another negative error code. * or another negative error code.
* *
* \note If this function returns something other than a positive * \note If this function returns something other than a positive value
* value or MBEDTLS_ERR_SSL_WANT_READ/WRITE, the ssl context * or MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
* becomes unusable, and you should either free it or call * the SSL context for reading or writing, and either free it or
* \c mbedtls_ssl_session_reset() on it before re-using it for * call \c mbedtls_ssl_session_reset() on it before re-using it
* a new connection; the current connection must be closed. * for a new connection; the current connection must be closed.
* *
* \note When this function returns MBEDTLS_ERR_SSL_WANT_WRITE/READ, * \note When this function returns MBEDTLS_ERR_SSL_WANT_WRITE/READ,
* it must be called later with the *same* arguments, * it must be called later with the *same* arguments,
@ -2579,10 +2579,10 @@ int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_
* \return 0 if successful, or a specific SSL error code. * \return 0 if successful, or a specific SSL error code.
* *
* \note If this function returns something other than 0 or * \note If this function returns something other than 0 or
* MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
* becomes unusable, and you should either free it or call * the SSL context for reading or writing, and either free it or
* \c mbedtls_ssl_session_reset() on it before re-using it for * call \c mbedtls_ssl_session_reset() on it before re-using it
* a new connection; the current connection must be closed. * for a new connection; the current connection must be closed.
*/ */
int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl, int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
unsigned char level, unsigned char level,
@ -2595,10 +2595,10 @@ int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
* \return 0 if successful, or a specific SSL error code. * \return 0 if successful, or a specific SSL error code.
* *
* \note If this function returns something other than 0 or * \note If this function returns something other than 0 or
* MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
* becomes unusable, and you should either free it or call * the SSL context for reading or writing, and either free it or
* \c mbedtls_ssl_session_reset() on it before re-using it for * call \c mbedtls_ssl_session_reset() on it before re-using it
* a new connection; the current connection must be closed. * for a new connection; the current connection must be closed.
*/ */
int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl ); int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );