yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2025-07-23 00:08:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve Blowfish documentation

Browse source
This commit is contained in:
Hanno Becker 2018-12-17 15:15:42 +00:00
parent f947c0a2dd
commit 3d9a3490f8
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
include/mbedtls/blowfish.h
View file

@ -88,8 +88,8 @@ void mbedtls_blowfish_init( mbedtls_blowfish_context *ctx );
* *
* \param ctx The Blowfish context to be cleared. * \param ctx The Blowfish context to be cleared.
* This may be \c NULL, in which case this function * This may be \c NULL, in which case this function
* is a no-op. If it is not \c NULL, it must point * returns immediately. If it is not \c NULL, it must
* to an initialized Blowfish context. * point to an initialized Blowfish context.
*/ */
void mbedtls_blowfish_free( mbedtls_blowfish_context *ctx ); void mbedtls_blowfish_free( mbedtls_blowfish_context *ctx );
@ -146,7 +146,7 @@ int mbedtls_blowfish_crypt_ecb( mbedtls_blowfish_context *ctx,
* #MBEDTLS_BLOWFISH_DECRYPT for decryption. * #MBEDTLS_BLOWFISH_DECRYPT for decryption.
* \param length The length of the input data in Bytes. This must be * \param length The length of the input data in Bytes. This must be
* multiple of \c 8. * multiple of \c 8.
* \param iv The initialization vector. This must be an RW buffer * \param iv The initialization vector. This must be a read/write buffer
* of length \c 8 Bytes. It is updated by this function. * of length \c 8 Bytes. It is updated by this function.
* \param input The input data. This must be a readable buffer of length * \param input The input data. This must be a readable buffer of length
* \p length Bytes. If \p length if \c 0, it may be \c NULL. * \p length Bytes. If \p length if \c 0, it may be \c NULL.
@ -183,10 +183,10 @@ int mbedtls_blowfish_crypt_cbc( mbedtls_blowfish_context *ctx,
* #MBEDTLS_BLOWFISH_DECRYPT for decryption. * #MBEDTLS_BLOWFISH_DECRYPT for decryption.
* \param length The length of the input data in Bytes. * \param length The length of the input data in Bytes.
* \param iv_off The offset in the initialiation vector. * \param iv_off The offset in the initialiation vector.
* The value pointed to must be smaller than \c 8. * The value pointed to must be smaller than \c 8 Bytes.
* It is updated by this function to support the aforementioned * It is updated by this function to support the aforementioned
* streaming usage. * streaming usage.
* \param iv The initialization vector. This must be an RW buffer of * \param iv The initialization vector. This must be a read/write buffer of
* size \c 8 Bytes. It is updated after use. * size \c 8 Bytes. It is updated after use.
* \param input The input data. This must be a readable buffer of length * \param input The input data. This must be a readable buffer of length
* \p length Bytes. If \p length if \c 0, it may be \c NULL. * \p length Bytes. If \p length if \c 0, it may be \c NULL.
@ -257,10 +257,10 @@ int mbedtls_blowfish_crypt_cfb64( mbedtls_blowfish_context *ctx,
* within current cipher stream). The offset pointer to * within current cipher stream). The offset pointer to
* should be \c 0 at the start of a stream and must be * should be \c 0 at the start of a stream and must be
* smaller than \c 8. It is updated by this function. * smaller than \c 8. It is updated by this function.
* \param nonce_counter The 64-bit nonce and counter. This must point to an RW * \param nonce_counter The 64-bit nonce and counter. This must point to a
* buffer of length \c 8 Bytes. * read/write buffer of length \c 8 Bytes.
* \param stream_block The saved stream-block for resuming. This must point to * \param stream_block The saved stream-block for resuming. This must point to
* an RW buffer of length \c 8 Bytes. * a read/write buffer of length \c 8 Bytes.
* \param input The input data. This must be a readable buffer of length * \param input The input data. This must be a readable buffer of length
* \p length Bytes. If \p length is \c 0, it may be \c NULL. * \p length Bytes. If \p length is \c 0, it may be \c NULL.
* \param output The output data. This must be a writable buffer of length * \param output The output data. This must be a writable buffer of length