yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #3667 from Jongy/fix-docs

Browse source 
Fix docs to desribe written-into buffer parameter as writable
This commit is contained in:
Gilles Peskine 2020-09-17 00:02:08 +02:00 committed by GitHub
commit 1d9c11081a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
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.