From a378a40b3a139b789b00d778c1091a0818c4a8ad Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Wed, 19 Aug 2015 15:39:19 +0100 Subject: Document that the ciphertext and plaintext may share a buffer when encrypting and decrypting --- include/olm/cipher.hh | 4 ++++ 1 file changed, 4 insertions(+) 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. -- cgit v1.2.3