Document gotcha of move_handshake_to_state

A single call to move_handshake_to_state() can't do a full handshake.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine
2025-03-07 20:37:49 +01:00
committed by Manuel Pégourié-Gonnard
parent c67befee6a
commit a4bf00227f

View File

@@ -476,6 +476,18 @@ void mbedtls_test_ssl_endpoint_free(
* /p second_ssl is used as second endpoint and their sockets have to be
* connected before calling this function.
*
* For example, to perform a full handshake:
* ```
* mbedtls_test_move_handshake_to_state(
* &server.ssl, &client.ssl,
* MBEDTLS_SSL_HANDSHAKE_OVER);
* mbedtls_test_move_handshake_to_state(
* &client.ssl, &client.ssl,
* MBEDTLS_SSL_HANDSHAKE_OVER);
* ```
* Note that you need both calls to reach the handshake-over state on
* both sides.
*
* \retval 0 on success, otherwise error code.
*/
int mbedtls_test_move_handshake_to_state(mbedtls_ssl_context *ssl,