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

Minor Blowfish documentation improvements

Browse Source
This commit is contained in:
Hanno Becker 2018-12-19 15:48:37 +00:00
parent 20376d631d
commit ed54128fdb
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/mbedtls/blowfish.h
View File

@ -94,7 +94,7 @@ void mbedtls_blowfish_init( mbedtls_blowfish_context *ctx );
void mbedtls_blowfish_free( mbedtls_blowfish_context *ctx ); void mbedtls_blowfish_free( mbedtls_blowfish_context *ctx );
/** /**
* \brief Perform a Blowfish key schedule. * \brief Perform a Blowfish key schedule operation.
* *
* \param ctx The Blowfish context to perform the key schedule on. * \param ctx The Blowfish context to perform the key schedule on.
* \param key The encryption key. This must be a readable buffer of * \param key The encryption key. This must be a readable buffer of
@ -109,7 +109,7 @@ int mbedtls_blowfish_setkey( mbedtls_blowfish_context *ctx, const unsigned char
unsigned int keybits ); unsigned int keybits );
/** /**
* \brief Perform a Blowfish-ECB block encryption/decryption. * \brief Perform a Blowfish-ECB block encryption/decryption operation.
* *
* \param ctx The Blowfish context to use. This must be initialized * \param ctx The Blowfish context to use. This must be initialized
* and bound to a key. * and bound to a key.
@ -131,7 +131,7 @@ int mbedtls_blowfish_crypt_ecb( mbedtls_blowfish_context *ctx,
#if defined(MBEDTLS_CIPHER_MODE_CBC) #if defined(MBEDTLS_CIPHER_MODE_CBC)
/** /**
* \brief Perform a Blowfish-CBC buffer encryption/decryption. * \brief Perform a Blowfish-CBC buffer encryption/decryption operation.
* *
* \note Upon exit, the content of the IV is updated so that you can * \note Upon exit, the content of the IV is updated so that you can
* call the function same function again on the following * call the function same function again on the following
@ -168,7 +168,7 @@ int mbedtls_blowfish_crypt_cbc( mbedtls_blowfish_context *ctx,
#if defined(MBEDTLS_CIPHER_MODE_CFB) #if defined(MBEDTLS_CIPHER_MODE_CFB)
/** /**
* \brief Perform a Blowfish CFB buffer encryption/decryption. * \brief Perform a Blowfish CFB buffer encryption/decryption operation.
* *
* \note Upon exit, the content of the IV is updated so that you can * \note Upon exit, the content of the IV is updated so that you can
* call the function same function again on the following * call the function same function again on the following
@ -209,7 +209,7 @@ int mbedtls_blowfish_crypt_cfb64( mbedtls_blowfish_context *ctx,
#if defined(MBEDTLS_CIPHER_MODE_CTR) #if defined(MBEDTLS_CIPHER_MODE_CTR)
/** /**
* \brief Perform a Blowfish-CTR buffer encryption/decryption. * \brief Perform a Blowfish-CTR buffer encryption/decryption operation.
* *
* \warning You must never reuse a nonce value with the same key. Doing so * \warning You must never reuse a nonce value with the same key. Doing so
* would void the encryption for the two messages encrypted with * would void the encryption for the two messages encrypted with
@ -256,7 +256,7 @@ int mbedtls_blowfish_crypt_cfb64( mbedtls_blowfish_context *ctx,
* and bound to a key. * and bound to a key.
* \param length The length of the input data in Bytes. * \param length The length of the input data in Bytes.
* \param nc_off The offset in the current stream_block (for resuming * \param nc_off The offset in the current stream_block (for resuming
* within current cipher stream). The offset pointer to * within current cipher stream). The offset pointer
* 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 a * \param nonce_counter The 64-bit nonce and counter. This must point to a