summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@redhat.com>2015-11-11 11:29:21 +0100
committerNikos Mavrogiannopoulos <nmav@redhat.com>2015-11-11 11:29:35 +0100
commitb0ab3fd8f09c125e707f06cae987b629747ec3eb (patch)
tree190a98d9481083fa879d0867b9dfddb0d9ecd6d1
parentfe7a6f051689f186922c199d8d54550f33693f13 (diff)
downloadgnutls-b0ab3fd8f09c125e707f06cae987b629747ec3eb.tar.gz
crypto-api: doc update
-rw-r--r--lib/crypto-api.c8
1 files changed, 6 insertions, 2 deletions
diff --git a/lib/crypto-api.c b/lib/crypto-api.c
index e169092cf1..1c532ad054 100644
--- a/lib/crypto-api.c
+++ b/lib/crypto-api.c
@@ -221,7 +221,9 @@ gnutls_cipher_decrypt(gnutls_cipher_hd_t handle, void *ctext,
* @ctext_len: the available length for encrypted data
*
* This function will encrypt the given data using the algorithm
- * specified by the context.
+ * specified by the context. For block ciphers the @ptext_len must be
+ * a multiple of the block size. For the supported ciphers the encrypted
+ * data length will equal the plaintext size.
*
* Returns: Zero or a negative error code on error.
*
@@ -247,7 +249,9 @@ gnutls_cipher_encrypt2(gnutls_cipher_hd_t handle, const void *ptext,
* @ptext_len: the available length for decrypted data
*
* This function will decrypt the given data using the algorithm
- * specified by the context.
+ * specified by the context. For block ciphers the @ctext_len must be
+ * a multiple of the block size. For the supported ciphers the plaintext
+ * data length will equal the ciphertext size.
*
* Note that in AEAD ciphers, this will not check the tag. You will
* need to compare the tag sent with the value returned from gnutls_cipher_tag().