commit dcad168acfe3ce9f5cde4914661f1db444ef1faf
author Waleed Elmelegy <waleed.elmelegy@arm.com> Tue Aug 29 14:55:03 2023 +0100
committer Waleed Elmelegy <waleed.elmelegy@arm.com> Mon Sep 04 17:56:39 2023 +0100
tree 6fe08afe68910358e5572188d7a71fc532876f26
parent 7aeb6e76107eddb9c85f9929aee133baac2894e5

Improve mbedtls_pkcs5_pbes2_ext function test data

Signed-off-by: Waleed Elmelegy <waleed.elmelegy@arm.com>

include/mbedtls/pkcs5.h

diff --git a/include/mbedtls/pkcs5.h b/include/mbedtls/pkcs5.h
index d054d67..e995d3d 100644
--- a/include/mbedtls/pkcs5.h
+++ b/include/mbedtls/pkcs5.h
@@ -73,7 +73,7 @@
  *                   time, this function does not validate the CBC padding.
  *
  * \param pbe_params the ASN.1 algorithm parameters
- * \param mode       either MBEDTLS_PKCS5_DECRYPT or MBEDTLS_PKCS5_ENCRYPT
+ * \param mode       either #MBEDTLS_PKCS5_DECRYPT or #MBEDTLS_PKCS5_ENCRYPT
  * \param pwd        password to use when generating key
  * \param pwdlen     length of password
  * \param data       data to process
@@ -110,7 +110,7 @@
  *                   password are about 1/255).
  *
  * \param pbe_params the ASN.1 algorithm parameters
- * \param mode       either MBEDTLS_PKCS5_DECRYPT or MBEDTLS_PKCS5_ENCRYPT
+ * \param mode       either #MBEDTLS_PKCS5_DECRYPT or #MBEDTLS_PKCS5_ENCRYPT
  * \param pwd        password to use when generating key
  * \param pwdlen     length of password
  * \param data       data to process
@@ -128,7 +128,7 @@
  *                    padding data.
  * \param output_len On success, length of actual data written to the output buffer.
  *
- * \returns        0 on success, or a MBEDTLS_ERR_XXX code if verification fails.
+ * \returns        0 on success, or a MBEDTLS_ERR_XXX code if parsing or decryption fails.
  */
 int mbedtls_pkcs5_pbes2_ext(const mbedtls_asn1_buf *pbe_params, int mode,
                             const unsigned char *pwd,  size_t pwdlen,