From f4307d55daa8bb2f16b01cc86790a676ce909b76 Mon Sep 17 00:00:00 2001 From: Tom Cosgrove Date: Mon, 22 Nov 2021 15:01:25 +0000 Subject: [PATCH 1/2] doc improvement in aes include Remove description of non-existing "mode" parameter from the docs of mbedtls_aes_crypt_ctr Backport of #5105 Signed-off-by: Tom Cosgrove --- include/mbedtls/aes.h | 4 ---- 1 file changed, 4 deletions(-) diff --git a/include/mbedtls/aes.h b/include/mbedtls/aes.h index 33a11a72ed..dc5ae199ca 100644 --- a/include/mbedtls/aes.h +++ b/include/mbedtls/aes.h @@ -538,10 +538,6 @@ int mbedtls_aes_crypt_ofb( mbedtls_aes_context *ctx, * \brief This function performs an AES-CTR encryption or decryption * operation. * - * This function performs the operation defined in the \p mode - * parameter (encrypt/decrypt), on the input data buffer - * defined in the \p input parameter. - * * Due to the nature of CTR, you must use the same key schedule * for both encryption and decryption operations. Therefore, you * must use the context initialized with mbedtls_aes_setkey_enc() From a5f85c860be0396af44d6c0c0b72cddab8877cad Mon Sep 17 00:00:00 2001 From: Tom Cosgrove Date: Mon, 22 Nov 2021 15:35:27 +0000 Subject: [PATCH 2/2] further improvements to sha256 docs Signed-off-by: Tom Cosgrove --- include/mbedtls/sha256.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/include/mbedtls/sha256.h b/include/mbedtls/sha256.h index c55177d79e..68386a52a9 100644 --- a/include/mbedtls/sha256.h +++ b/include/mbedtls/sha256.h @@ -264,6 +264,9 @@ MBEDTLS_DEPRECATED void mbedtls_sha256_process( mbedtls_sha256_context *ctx, * be a writable buffer of length \c 32 Bytes. * \param is224 Determines which function to use. This must be * either \c 0 for SHA-256, or \c 1 for SHA-224. + * + * \return \c 0 on success. + * \return A negative error code on failure. */ int mbedtls_sha256_ret( const unsigned char *input, size_t ilen,