From: Krzysztof Jackiewicz <k.jackiewicz@samsung.com>
Date: Tue, 19 Jul 2016 15:11:47 +0000 (+0200)
Subject: ACR: Describe finalize-without-update cases
X-Git-Tag: accepted/tizen/common/20160810.161523~7
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F05%2F80705%2F3;p=platform%2Fcore%2Fsecurity%2Fyaca.git

ACR: Describe finalize-without-update cases

Change-Id: I4164b05325472f32de426db21b6924b3acfb8583
---

diff --git a/api/yaca/yaca_encrypt.h b/api/yaca/yaca_encrypt.h
index d2d2ff5..d99db9b 100755
--- a/api/yaca/yaca_encrypt.h
+++ b/api/yaca/yaca_encrypt.h
@@ -125,6 +125,9 @@ int yaca_encrypt_update(yaca_context_h ctx,
 /**
  * @brief  Encrypts the final chunk of the data.
  *
+ * @remarks  Skipping yaca_encrypt_update() and calling only yaca_encrypt_finalize() will produce an
+ *           encryption of an empty message.
+ *
  * @since_tizen 3.0
  *
  * @param[in,out] ctx             A valid encrypt context
@@ -211,6 +214,9 @@ int yaca_decrypt_update(yaca_context_h ctx,
 /**
  * @brief  Decrypts the final chunk of the data.
  *
+ * @remarks  Skipping yaca_decrypt_update() and calling only yaca_decrypt_finalize() will produce a
+ *           decryption of an empty ciphertext.
+ *
  * @since_tizen 3.0
  *
  * @param[in,out] ctx            A valid decrypt context
diff --git a/api/yaca/yaca_seal.h b/api/yaca/yaca_seal.h
index a6ad219..982855c 100755
--- a/api/yaca/yaca_seal.h
+++ b/api/yaca/yaca_seal.h
@@ -120,6 +120,9 @@ int yaca_seal_update(yaca_context_h ctx,
 /**
  * @brief  Encrypts the final piece of the data.
  *
+ * @remarks  Skipping yaca_seal_update() and calling only yaca_seal_finalize() will produce an
+ *           encryption of an empty message.
+ *
  * @since_tizen 3.0
  *
  * @param[in,out] ctx             A valid seal context
@@ -212,6 +215,9 @@ int yaca_open_update(yaca_context_h ctx,
 /**
  * @brief  Decrypts last chunk of sealed message.
  *
+ * @remarks  Skipping yaca_open_update() and calling only yaca_open_finalize() will produce a
+ *           decryption of an empty ciphertext.
+ *
  * @since_tizen 3.0
  *
  * @param[in,out] ctx            A valid open context
diff --git a/api/yaca/yaca_sign.h b/api/yaca/yaca_sign.h
index 0bf3097..a7eefe8 100755
--- a/api/yaca/yaca_sign.h
+++ b/api/yaca/yaca_sign.h
@@ -171,6 +171,9 @@ int yaca_sign_update(yaca_context_h ctx,
  *
  * @since_tizen 3.0
  *
+ * @remarks  Skipping yaca_sign_update() and calling only yaca_sign_finalize() will produce a
+ *           signature or MAC of an empty message.
+ *
  * @param[in,out] ctx              A valid sign context
  * @param[out]    signature        Buffer for the MAC or the signature
  *                                 (must be allocated by client, see yaca_context_get_output_length())
@@ -251,6 +254,9 @@ int yaca_verify_update(yaca_context_h ctx,
  *
  * @since_tizen 3.0
  *
+ * @remarks  Skipping yaca_verify_update() and calling only yaca_verify_finalize() will verify
+ *           the signature of an empty message.
+ *
  * @param[in,out] ctx            A valid verify context
  * @param[in]     signature      Input signature (returned by yaca_sign_finalize())
  * @param[in]     signature_len  Size of the signature