aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Haines <mark.haines@matrix.org>2015-08-19 15:39:19 +0100
committerMark Haines <mark.haines@matrix.org>2015-08-19 15:39:19 +0100
commita378a40b3a139b789b00d778c1091a0818c4a8ad (patch)
treef68359d1f098bdae2a1673a37ccc35e1b1db76aa
parent900d2d70b47ce299222ee27f2ed6374d2a004aec (diff)
Document that the ciphertext and plaintext may share a buffer when encrypting and decrypting
-rw-r--r--include/olm/cipher.hh4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/olm/cipher.hh b/include/olm/cipher.hh
index f71b3af..c561972 100644
--- a/include/olm/cipher.hh
+++ b/include/olm/cipher.hh
@@ -47,6 +47,8 @@ public:
* output |--ciphertext_length-->| |---mac_length-->|
* ciphertext
*
+ * The plain-text pointers and cipher-text pointers may be the same.
+ *
* Returns std::size_t(-1) if the length of the cipher-text or the output
* buffer is too small. Otherwise returns the length of the output buffer.
*/
@@ -73,6 +75,8 @@ public:
* input |--ciphertext_length-->| |---mac_length-->|
* ciphertext
*
+ * The plain-text pointers and cipher-text pointers may be the same.
+ *
* Returns std::size_t(-1) if the length of the plain-text buffer is too
* small or if the authentication check fails. Otherwise returns the length
* of the plain text.