Document that the use of CID is disabled by default.

(Even if MBEDTLS_SSL_CID is set in config.h)
This commit is contained in:
Hanno Becker 2019-04-23 11:37:38 +01:00
parent 9742809531
commit 318a87b336

View file

@ -1523,7 +1523,8 @@ void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
* \param enable This value determines whether the CID extension should * \param enable This value determines whether the CID extension should
* be used or not. Possible values are: * be used or not. Possible values are:
* - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID. * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
* - MBEDTLS_SSL_CID_DISABLED to disable the use of the CID. * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
* of the CID.
* \param own_cid The address of the readable buffer holding the CID we want * \param own_cid The address of the readable buffer holding the CID we want
* the peer to use when sending encrypted messages to us. * the peer to use when sending encrypted messages to us.
* This may be \c NULL if \p own_cid_len is \c 0. * This may be \c NULL if \p own_cid_len is \c 0.