Fix typos, grammar and wording in documentation

This commit is contained in:
Manuel Pégourié-Gonnard 2019-06-05 09:47:18 +02:00 committed by Jarno Lamsa
parent ac87e28bb2
commit 6d8f128790
3 changed files with 24 additions and 20 deletions

View file

@ -1406,20 +1406,20 @@
/** /**
* \def MBEDTLS_SSL_CONTEXT_SERIALIZATION * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
* *
* Enable the APIs for serialization of a full SSL context: * Enable serialization of the TLS context structures, through use of the
* mbedtls_ssl_context_save() and mbedtls_ssl_context_load(). * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
* *
* This pair of functions allows one side of a connection to serialize the * This pair of functions allows one side of a connection to serialize the
* context associated with the connection, then free or re-use that context * context associated with the connection, then free or re-use that context
* while the serialized state is persisted elsewhere, and finally deserialize * while the serialized state is persisted elsewhere, and finally deserialize
* that state to a live context for resuming read/write operations on the * that state to a live context for resuming read/write operations on the
* connection, in a way that's transparent to the peer, since from a protocol * connection. From a protocol perspective, the state of the connection is
* point of view, the state of the connection is unaffected. * unaffected, in particular this is entirely transparent to the peer.
* *
* Note: this is distinct from TLS session resumption, which is part of the * Note: this is distinct from TLS session resumption, which is part of the
* protocol and fully visible by the peer. TLS session resumption enables * protocol and fully visible by the peer. TLS session resumption enables
* establishing new connections associated to a saved session with shorter, * establishing new connections associated to a saved session with shorter,
* lighter handshakes, while context serialization is a local optimisation in * lighter handshakes, while context serialization is a local optimization in
* handling a single, potentially long-lived connection. * handling a single, potentially long-lived connection.
* *
* Enabling these APIs makes some SSL structures larger, as 64 extra bytes are * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are

View file

@ -3880,24 +3880,25 @@ int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
void mbedtls_ssl_free( mbedtls_ssl_context *ssl ); void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
/** /**
* \brief Save a live connection as serialized data in a buffer. * \brief Save an active connection as serialized data in a buffer.
* This allows to free or re-use the SSL context while still * This allows the freeing or re-using of the SSL context
* picking up the connection later in a way that it entirely * while still picking up the connection later in a way that
* transparent to the peer. * it entirely transparent to the peer.
* *
* \see mbedtls_ssl_context_load() * \see mbedtls_ssl_context_load()
* *
* \note This feature is currently only available under certain * \note This feature is currently only available under certain
* conditions, see the documentation of return value * conditions, see the documentation of the return value
* #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details. * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
* *
* \note When the function succeeds, it calls * \note When this function succeeds, it calls
* mbedtls_ssl_session_reset() on \p ssl which as a result is * mbedtls_ssl_session_reset() on \p ssl which as a result is
* no longer associated with the connection that has been * no longer associated with the connection that has been
* serialized. This avoid creating copies of the session * serialized. This avoids creating copies of the session
* state. You're then free to either re-use the context * state. You're then free to either re-use the context
* structure for a different connection, or call * structure for a different connection, or call
* mbedtls_ssl_session_free() on it. * mbedtls_ssl_session_free() on it. See the documentation of
* mbedtls_ssl_session_reset() for more details.
* *
* \param ssl The SSL context to save. On success, it is no longer * \param ssl The SSL context to save. On success, it is no longer
* associated with the connection that has been serialized. * associated with the connection that has been serialized.
@ -3915,7 +3916,7 @@ void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
* *
* \return \c 0 if successful. * \return \c 0 if successful.
* \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small. * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
* \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handsahke is in * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
* progress, or there is pending data for reading or sending, * progress, or there is pending data for reading or sending,
* or the connection does not use DTLS 1.2 with and AEAD * or the connection does not use DTLS 1.2 with and AEAD
* ciphersuite, or renegotiation is enabled. * ciphersuite, or renegotiation is enabled.
@ -3945,10 +3946,13 @@ int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
* calling mbedtls_ssl_session_reset() on a context that was * calling mbedtls_ssl_session_reset() on a context that was
* previously prepared as above but used in the meantime. * previously prepared as above but used in the meantime.
* *
* \note After calling this function sucessfully, you still need to * \note Before or after calling this function successfully, you
* configure some connection-specific callback and settings * also need to configure some connection-specific callback
* before you can use the connection again. Specifically, you * and settings before you can use the connection again
* want to call at least mbedtls_ssl_set_bio() and possibly * (unless they were already set before calling
* mbedtls_ssl_session_reset() and the values are suitable for
* the present connection). Specifically, you want to call
* at least mbedtls_ssl_set_bio() and possibly
* mbedtls_ssl_set_timer_cb(). You might also want to call * mbedtls_ssl_set_timer_cb(). You might also want to call
* mbedtls_ssl_set_mtu() if new information about the PMTU is * mbedtls_ssl_set_mtu() if new information about the PMTU is
* available - otherwise the saved information will be used. * available - otherwise the saved information will be used.

View file

@ -11286,7 +11286,7 @@ int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
size_t buf_len, size_t buf_len,
size_t *olen ) size_t *olen )
{ {
/* Unimplemented yet */ /* Unimplemented */
(void) ssl; (void) ssl;
if( buf != NULL ) if( buf != NULL )
@ -11304,7 +11304,7 @@ int mbedtls_ssl_context_load( mbedtls_ssl_context *ssl,
const unsigned char *buf, const unsigned char *buf,
size_t len ) size_t len )
{ {
/* Unimplemented yet */ /* Unimplemented */
(void) ssl; (void) ssl;
(void) buf; (void) buf;
(void) len; (void) len;