Update cipher api description 41/293341/2
authorKrzysztof Jackiewicz <k.jackiewicz@samsung.com>
Wed, 24 May 2023 09:02:48 +0000 (11:02 +0200)
committerKrzysztof Jackiewicz <k.jackiewicz@samsung.com>
Mon, 5 Jun 2023 14:05:26 +0000 (16:05 +0200)
Encryption may return an empty buffer. Specify the return value in such
case.

Change-Id: Iabcbe30dc002d4dc7eb932fdbd5418263488ba2a

src/include/ckmc/ckmc-manager.h

index 7febfd7..76cca21 100644 (file)
@@ -1324,7 +1324,7 @@ int ckmc_cipher_initialize(ckmc_param_list_h params,
  *
  * @param[in] context Encryption/decryption context created with ckmc_cipher_initialize()
  * @param[in] in Encryption/decryption input
- * @param[out] ppout Encryption/decryption output
+ * @param[out] ppout Encryption/decryption output. Will be set to NULL if the output is empty.
  *
  * @return @c 0 on success, otherwise a negative error value
  * @retval #CKMC_ERROR_NONE Successful
@@ -1355,7 +1355,7 @@ int ckmc_cipher_update(ckmc_cipher_ctx_h context,
  *
  * @param[in] context Encryption/decryption context created with ckmc_cipher_initialize()
  * @param[in] in Optional additional decryption input required by some of the modes.
- * @param[out] ppout Encryption/decryption output
+ * @param[out] ppout Encryption/decryption output. Will be set to NULL if the output is empty.
  *
  * @return @c 0 on success, otherwise a negative error value
  * @retval #CKMC_ERROR_NONE Successful