yuzu-emu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-11-22 23:25:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Increase strictness of NULL parameter validity in CCM's doxygen

Browse Source
This commit is contained in:
k-stachowiak 2018-12-19 13:36:03 +01:00 committed by Gilles Peskine
parent 6adb0574ea
commit 247a782668
1 changed files with 15 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
include/mbedtls/ccm.h
View File

@ -112,8 +112,6 @@ int mbedtls_ccm_setkey( mbedtls_ccm_context *ctx,
* *
* \param ctx The CCM context to clear. If this is \c NULL, the function * \param ctx The CCM context to clear. If this is \c NULL, the function
* has no effect. Otherwise, this must be initialized. * has no effect. Otherwise, this must be initialized.
*
* \note If ctx is \c NULL, the function has no effect.
*/ */
void mbedtls_ccm_free( mbedtls_ccm_context *ctx ); void mbedtls_ccm_free( mbedtls_ccm_context *ctx );
@ -136,7 +134,7 @@ void mbedtls_ccm_free( mbedtls_ccm_context *ctx );
* 15 - \p iv_len. * 15 - \p iv_len.
* \param add The additional data field. If \p add_len is greater than * \param add The additional data field. If \p add_len is greater than
* zero, \p add must be a readable buffer of at least that * zero, \p add must be a readable buffer of at least that
* length. If `add_len == 0`, this may be \c NULL. * length.
* \param add_len The length of additional data in Bytes. * \param add_len The length of additional data in Bytes.
* This must be less than `2^16 - 2^8`. * This must be less than `2^16 - 2^8`.
* \param input The buffer holding the input data. If \p length is greater * \param input The buffer holding the input data. If \p length is greater
@ -145,9 +143,8 @@ void mbedtls_ccm_free( mbedtls_ccm_context *ctx );
* \param output The buffer holding the output data. If \p length is greater * \param output The buffer holding the output data. If \p length is greater
* than zero, \p output must be a writable buffer of at least * than zero, \p output must be a writable buffer of at least
* that length. * that length.
* \param tag The buffer holding the authentication field. If * \param tag The buffer holding the authentication field. This must be a
* `tag_len > 0`, then this must be a readable buffer of at * readable buffer of at least \p tag_len Bytes.
* least \p tag_len Bytes. Otherwise, this may be \c NULL.
* \param tag_len The length of the authentication field to generate in Bytes: * \param tag_len The length of the authentication field to generate in Bytes:
* 4, 6, 8, 10, 12, 14 or 16. * 4, 6, 8, 10, 12, 14 or 16.
* *
@ -181,9 +178,8 @@ int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
* \param iv_len The length of the nonce in Bytes: 7, 8, 9, 10, 11, 12, * \param iv_len The length of the nonce in Bytes: 7, 8, 9, 10, 11, 12,
* or 13. The length L of the message length field is * or 13. The length L of the message length field is
* 15 - \p iv_len. * 15 - \p iv_len.
* \param add The additional data field. If \p add_len is greater than * \param add The additional data field. This must be a readable buffer of
* zero, \p add must be a readable buffer of at least that * at least \p add_len Bytes.
* length. If `add_len == 0`, this may be \c NULL.
* \param add_len The length of additional data in Bytes. * \param add_len The length of additional data in Bytes.
* This must be less than 2^16 - 2^8. * This must be less than 2^16 - 2^8.
* \param input The buffer holding the input data. If \p length is greater * \param input The buffer holding the input data. If \p length is greater
@ -192,9 +188,8 @@ int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
* \param output The buffer holding the output data. If \p length is greater * \param output The buffer holding the output data. If \p length is greater
* than zero, \p output must be a writable buffer of at least * than zero, \p output must be a writable buffer of at least
* that length. * that length.
* \param tag The buffer holding the authentication field. If * \param tag The buffer holding the authentication field. This must be a
* `tag_len > 0`, then this must be a readable buffer of at * readable buffer of at least \p tag_len Bytes.
* least \p tag_len Bytes. Otherwise, this may be \c NULL.
* \param tag_len The length of the authentication field to generate in Bytes: * \param tag_len The length of the authentication field to generate in Bytes:
* 0, 4, 6, 8, 10, 12, 14 or 16. * 0, 4, 6, 8, 10, 12, 14 or 16.
* *
@ -222,9 +217,8 @@ int mbedtls_ccm_star_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
* \param iv_len The length of the nonce in Bytes: 7, 8, 9, 10, 11, 12, * \param iv_len The length of the nonce in Bytes: 7, 8, 9, 10, 11, 12,
* or 13. The length L of the message length field is * or 13. The length L of the message length field is
* 15 - \p iv_len. * 15 - \p iv_len.
* \param add The additional data field. If \p add_len is greater than * \param add The additional data field. This must be a readable buffer
* zero, \p add must be a readable buffer of at least that * of at least that \p add_len Bytes..
* length. If `add_len == 0`, this may be \c NULL.
* \param add_len The length of additional data in Bytes. * \param add_len The length of additional data in Bytes.
* This must be less than 2^16 - 2^8. * This must be less than 2^16 - 2^8.
* \param input The buffer holding the input data. If \p length is greater * \param input The buffer holding the input data. If \p length is greater
@ -233,9 +227,8 @@ int mbedtls_ccm_star_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
* \param output The buffer holding the output data. If \p length is greater * \param output The buffer holding the output data. If \p length is greater
* than zero, \p output must be a writable buffer of at least * than zero, \p output must be a writable buffer of at least
* that length. * that length.
* \param tag The buffer holding the authentication field. If * \param tag The buffer holding the authentication field. This must be a
* `tag_len > 0`, then this must be a readable buffer of at * readable buffer of at least \p tag_len Bytes.
* least \p tag_len Bytes. Otherwise, this may be \c NULL.
* \param tag_len The length of the authentication field to generate in Bytes: * \param tag_len The length of the authentication field to generate in Bytes:
* 4, 6, 8, 10, 12, 14 or 16. * 4, 6, 8, 10, 12, 14 or 16.
* *
@ -266,9 +259,8 @@ int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
* \param iv_len The length of the nonce in Bytes: 7, 8, 9, 10, 11, 12, * \param iv_len The length of the nonce in Bytes: 7, 8, 9, 10, 11, 12,
* or 13. The length L of the message length field is * or 13. The length L of the message length field is
* 15 - \p iv_len. * 15 - \p iv_len.
* \param add The additional data field. If \p add_len is greater than * \param add The additional data field. This must be a readable buffer of
* zero, \p add must be a readable buffer of at least that * at least that \p add_len Bytes.
* length. If `add_len == 0`, this may be \c NULL.
* \param add_len The length of additional data in Bytes. * \param add_len The length of additional data in Bytes.
* This must be less than 2^16 - 2^8. * This must be less than 2^16 - 2^8.
* \param input The buffer holding the input data. If \p length is greater * \param input The buffer holding the input data. If \p length is greater
@ -277,9 +269,8 @@ int mbedtls_ccm_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
* \param output The buffer holding the output data. If \p length is greater * \param output The buffer holding the output data. If \p length is greater
* than zero, \p output must be a writable buffer of at least * than zero, \p output must be a writable buffer of at least
* that length. * that length.
* \param tag The buffer holding the authentication field. If * \param tag The buffer holding the authentication field. This must be a
* `tag_len > 0`, then this must be a readable buffer of at * readable buffer of at least \p tag_len Bytes.
* least \p tag_len Bytes. Otherwise, this may be \c NULL.
* \param tag_len The length of the authentication field in Bytes. * \param tag_len The length of the authentication field in Bytes.
* 0, 4, 6, 8, 10, 12, 14 or 16. * 0, 4, 6, 8, 10, 12, 14 or 16.
* *