cuberite/polarssl
1
0
Fork 0
mirror of https://github.com/cuberite/polarssl.git synced 2025-11-03 20:22:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix docs to desribe written-into buffer parameter as writable

Browse Source 
Signed-off-by: Yonatan Goldschmidt <yon.goldschmidt@gmail.com>
This commit is contained in:
Yonatan Goldschmidt 2020-09-12 00:19:52 +03:00
parent 2a739c41bd
commit 6e2af094b0
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/mbedtls/ccm.h
View File

@ -148,7 +148,7 @@ void mbedtls_ccm_free( mbedtls_ccm_context *ctx );
* 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. This must be a * \param tag The buffer holding the authentication field. This must be a
* readable buffer of at least \p tag_len Bytes. * writable buffer of at least \p tag_len Bytes.
* \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.
* *
@ -193,7 +193,7 @@ int mbedtls_ccm_encrypt_and_tag( mbedtls_ccm_context *ctx, size_t length,
* 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. This must be a * \param tag The buffer holding the authentication field. This must be a
* readable buffer of at least \p tag_len Bytes. * writable buffer of at least \p tag_len Bytes.
* \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.
* *

4
include/mbedtls/gcm.h
View File

@ -155,7 +155,7 @@ int mbedtls_gcm_setkey( mbedtls_gcm_context *ctx,
* than zero, this must be a writable buffer of at least that * than zero, this must be a writable buffer of at least that
* size in Bytes. * size in Bytes.
* \param tag_len The length of the tag to generate. * \param tag_len The length of the tag to generate.
* \param tag The buffer for holding the tag. This must be a readable * \param tag The buffer for holding the tag. This must be a writable
* buffer of at least \p tag_len Bytes. * buffer of at least \p tag_len Bytes.
* *
* \return \c 0 if the encryption or decryption was performed * \return \c 0 if the encryption or decryption was performed
@ -283,7 +283,7 @@ int mbedtls_gcm_update( mbedtls_gcm_context *ctx,
* tag. The tag can have a maximum length of 16 Bytes. * tag. The tag can have a maximum length of 16 Bytes.
* *
* \param ctx The GCM context. This must be initialized. * \param ctx The GCM context. This must be initialized.
* \param tag The buffer for holding the tag. This must be a readable * \param tag The buffer for holding the tag. This must be a writable
* buffer of at least \p tag_len Bytes. * buffer of at least \p tag_len Bytes.
* \param tag_len The length of the tag to generate. This must be at least * \param tag_len The length of the tag to generate. This must be at least
* four. * four.