Improve documentation of CBC functions

This commit is contained in:
Manuel Pégourié-Gonnard 2015-01-23 16:19:47 +00:00
parent cfa9a45dd6
commit 2be147a9cb
4 changed files with 72 additions and 0 deletions

View file

@ -114,6 +114,14 @@ int blowfish_crypt_ecb( blowfish_context *ctx,
* Length should be a multiple of the block
* size (8 bytes)
*
* \note Upon exit, the content of the IV is updated so that you can
* call the function same function again on the following
* block(s) of data and get the same result as if it was
* encrypted in one call. This allows a "streaming" usage.
* If on the other hand you need to retain the contents of the
* IV, you should either save it manually or use the cipher
* module instead.
*
* \param ctx Blowfish context
* \param mode BLOWFISH_ENCRYPT or BLOWFISH_DECRYPT
* \param length length of the input data
@ -136,6 +144,14 @@ int blowfish_crypt_cbc( blowfish_context *ctx,
/**
* \brief Blowfish CFB buffer encryption/decryption.
*
* \note Upon exit, the content of the IV is updated so that you can
* call the function same function again on the following
* block(s) of data and get the same result as if it was
* encrypted in one call. This allows a "streaming" usage.
* If on the other hand you need to retain the contents of the
* IV, you should either save it manually or use the cipher
* module instead.
*
* \param ctx Blowfish context
* \param mode BLOWFISH_ENCRYPT or BLOWFISH_DECRYPT
* \param length length of the input data