State explicitly that multi-part CCM is not implemented in Mbed TLS yet

Signed-off-by: Ronald Cron <ronald.cron@arm.com>
This commit is contained in:
Ronald Cron 2021-05-26 10:37:45 +02:00
parent 9ca25503ba
commit 4c2a379280

View file

@ -297,6 +297,8 @@ int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
* \brief This function starts a CCM encryption or decryption * \brief This function starts a CCM encryption or decryption
* operation. * operation.
* *
* \note This function is not implemented in Mbed TLS yet.
*
* \param ctx The CCM context. This must be initialized. * \param ctx The CCM context. This must be initialized.
* \param mode The operation to perform: #MBEDTLS_CCM_ENCRYPT or * \param mode The operation to perform: #MBEDTLS_CCM_ENCRYPT or
* #MBEDTLS_CCM_DECRYPT or #MBEDTLS_CCM_STAR_ENCRYPT or * #MBEDTLS_CCM_DECRYPT or #MBEDTLS_CCM_STAR_ENCRYPT or
@ -333,6 +335,8 @@ int mbedtls_ccm_starts( mbedtls_ccm_context *ctx,
* \c total_ad_len passed to mbedtls_ccm_starts(). You may not * \c total_ad_len passed to mbedtls_ccm_starts(). You may not
* call this function after calling mbedtls_ccm_update(). * call this function after calling mbedtls_ccm_update().
* *
* \note This function is not implemented in Mbed TLS yet.
*
* \param ctx The CCM context. This must have been started with * \param ctx The CCM context. This must have been started with
* mbedtls_ccm_starts() and must not have yet received * mbedtls_ccm_starts() and must not have yet received
* any input with mbedtls_ccm_update(). * any input with mbedtls_ccm_update().
@ -386,6 +390,8 @@ int mbedtls_ccm_update_ad( mbedtls_ccm_context *ctx,
* the last one) then it is correct to use \p output_size * the last one) then it is correct to use \p output_size
* =\p input_length. * =\p input_length.
* *
* \note This function is not implemented in Mbed TLS yet.
*
* \note For decryption, the output buffer cannot be the same as * \note For decryption, the output buffer cannot be the same as
* the input buffer. If the buffers overlap, the output buffer * the input buffer. If the buffers overlap, the output buffer
* must trail at least 8 Bytes behind the input buffer. * must trail at least 8 Bytes behind the input buffer.
@ -423,6 +429,8 @@ int mbedtls_ccm_update( mbedtls_ccm_context *ctx,
* It wraps up the CCM stream, and generates the * It wraps up the CCM stream, and generates the
* tag. The tag can have a maximum length of 16 Bytes. * tag. The tag can have a maximum length of 16 Bytes.
* *
* \note This function is not implemented in Mbed TLS yet.
*
* \param ctx The CCM context. This must be initialized. * \param ctx The CCM context. This must be initialized.
* \param tag The buffer for holding the tag. If \p tag_len is greater * \param tag The buffer for holding the tag. If \p tag_len is greater
* than zero, this must be a writable buffer of at least \p * than zero, this must be a writable buffer of at least \p