Add warnings about status of implementation of CID API

This commit is contained in:
Hanno Becker 2019-04-23 12:01:20 +01:00
parent 963cb35a24
commit 8d0893d0b0
2 changed files with 20 additions and 3 deletions

View file

@ -1415,8 +1415,8 @@ void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
/**
* \brief Configure the use of the Connection ID (CID) extension
* in the next handshake.
* \brief (STUB) Configure the use of the Connection ID (CID)
* extension in the next handshake.
*
* Reference:
* https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-04
@ -1439,6 +1439,11 @@ void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
* extension in the next handshake and to set the value of
* the CID to be used for incoming messages.
*
* \warning The current implementation of this API does nothing!
* It is included solely to allow review and coding against
* the new Connection CID API.
* The actual implementation will be added in the future.
*
* \param ssl The SSL context to configure. This must be initialized.
* \param enable This value determines whether the CID extension should
* be used or not. Possible values are:
@ -1498,9 +1503,15 @@ int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
size_t own_cid_len );
/**
* \brief Get information about the current use of the
* \brief (STUB) Get information about the current use of the
* CID extension.
*
* \warning The current implementation of this API does nothing
* except setting `*enabled` to MBEDTLS_SSL_CID_DISABLED!
* It is included solely to allow review and coding against
* the new Connection CID API.
* The actual implementation will be added in the future.
*
* \param ssl The SSL context to query.
* \param enabled The address at which to store whether the CID extension
* is currently in use or not. If the CID is in use,