eden-emu/mbedtls
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor improvements to CAMELLIA documentation

Browse source
This commit is contained in:
Hanno Becker 2018-12-17 09:30:27 +00:00
parent ff62f44ad7
commit af4b83bb2a
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
include/mbedtls/camellia.h
View file

@ -159,15 +159,15 @@ int mbedtls_camellia_crypt_ecb( mbedtls_camellia_context *ctx,
* and bound to a key. * and bound to a key.
* \param mode The mode of operation. This must be either * \param mode The mode of operation. This must be either
* #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT. * #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT.
* \param length The length in Bytes of the input data. * \param length The length in Bytes of the input data \p input.
* Must be a multiple of \c 16. * This must be a multiple of \c 16.
* \param iv The initialization vector. This must be RW buffer * \param iv The initialization vector. This must be RW buffer
* of length \c 16 Bytes. It is updated to allow streaming * of length \c 16 Bytes. It is updated to allow streaming
* use as explained above. * use as explained above.
* \param input The buffer holding the input data. This must point to a * \param input The buffer holding the input data. This must point to a
* readable buffer of length \p length Bytes. This may be * readable buffer of length \p length Bytes. This may be
* \c NULL if `length == 0`. * \c NULL if `length == 0`.
* \param input The buffer holding the output data. This must point to a * \param output The buffer holding the output data. This must point to a
* writable buffer of length \p length Bytes. This may be * writable buffer of length \p length Bytes. This may be
* \c NULL if `length == 0`. * \c NULL if `length == 0`.
* *
@ -204,7 +204,7 @@ int mbedtls_camellia_crypt_cbc( mbedtls_camellia_context *ctx,
* and bound to a key. * and bound to a key.
* \param mode The mode of operation. This must be either * \param mode The mode of operation. This must be either
* #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT. * #MBEDTLS_CAMELLIA_ENCRYPT or #MBEDTLS_CAMELLIA_DECRYPT.
* \param length The length of the input data. Any value is allowed. * \param length The length of the input data \p input. Any value is allowed.
* \param iv_off The current offset in the IV. This must be smaller * \param iv_off The current offset in the IV. This must be smaller
* than \c 16. It is updated after this call to allow * than \c 16. It is updated after this call to allow
* the aforementioned streaming usage. * the aforementioned streaming usage.
@ -284,8 +284,10 @@ int mbedtls_camellia_crypt_cfb128( mbedtls_camellia_context *ctx,
* content must not be written to insecure storage and should be * content must not be written to insecure storage and should be
* securely discarded as soon as it's no longer needed. * securely discarded as soon as it's no longer needed.
* *
* \param ctx The CAMELLIA context to use. * \param ctx The CAMELLIA context to use. This must be initialized
* \param length The length of the input data. Any value is allowed. * and bound to a key.
* \param length The length of the input data \p input.
* Any value is allowed.
* \param nc_off The offset in the current \p stream_block (for resuming * \param nc_off The offset in the current \p stream_block (for resuming
* 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. It is updated * should be \c 0 at the start of a stream. It is updated