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

Improve documentation of mbedtls_ssl_get_peer_cert()

Browse source
This commit is contained in:
Hanno Becker 2019-02-25 10:13:43 +00:00
parent 3ed64578d2
commit 24bc570814
1 changed files with 8 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
include/mbedtls/ssl.h
View file

@ -3256,20 +3256,16 @@ int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
/** /**
* \brief Return the peer certificate from the current connection. * \brief Return the peer certificate from the current connection.
* *
* For ciphersuites not using certificate-based peer
* authentication (such as PSK-based ciphersuites), no
* peer certificate is available, and this function returns
* \c NULL.
*
* \param ssl The SSL context to use. This must be initialized and setup. * \param ssl The SSL context to use. This must be initialized and setup.
* *
* \return The current peer certificate, or \c NULL if * \return The current peer certificate, if available.
* none is available, which might be because the chosen * The returned certificate is owned by the SSL context and
* ciphersuite does not use peer certificates, or because * is valid only until the next call to the SSL API.
* #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled. * \return \c NULL if no peer certificate is available. This might
* If this functions does not return \c NULL, the returned * be because the chosen ciphersuite doesn't use CRTs
* certificate is owned by the SSL context and valid only * (PSK-based ciphersuites, for example), or because
* until the next call to the SSL API. * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
* allowing the stack to free the peer's CRT to save memory.
* *
* \note For one-time inspection of the peer's certificate during * \note For one-time inspection of the peer's certificate during
* the handshake, consider registering an X.509 CRT verification * the handshake, consider registering an X.509 CRT verification