Update documentation (GH #1088)

1 files changed, 12 insertions, 0 deletions

diff --git a/strciphr.h b/strciphr.h
index 5df2fe72..22cd8c24 100644
--- a/strciphr.h
+++ b/strciphr.h
@@ -320,6 +320,12 @@ public:
 	///     ChaCha20 chacha(key, keySize);

 	///     chacha.ProcessData(cipher, plain, size);

 	/// </pre>

+	/// \details You should use distinct buffers for inString and outString. If the buffers

+	///  are the same, then the data will be copied to an internal buffer to avoid GCC alias

+	///  violations. The internal copy will impact performance.

+	/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/1088">Issue 1088, 36% loss

+	///  of performance with AES</A>, <A HREF="https://github.com/weidai11/cryptopp/issues/101">Issue

+	///  1010, HIGHT cipher troubles with FileSource</A>

     void ProcessData(byte *outString, const byte *inString, size_t length);

 

 	/// \brief Resynchronize the cipher

@@ -578,6 +584,12 @@ public:
 	///     ChaCha20 chacha(key, keySize);

 	///     chacha.ProcessData(cipher, plain, size);

 	/// </pre>

+	/// \details You should use distinct buffers for inString and outString. If the buffers

+	///  are the same, then the data will be copied to an internal buffer to avoid GCC alias

+	///  violations. The internal copy will impact performance.

+	/// \sa <A HREF="https://github.com/weidai11/cryptopp/issues/1088">Issue 1088, 36% loss

+	///  of performance with AES</A>, <A HREF="https://github.com/weidai11/cryptopp/issues/101">Issue

+	///  1010, HIGHT cipher troubles with FileSource</A>

 	void ProcessData(byte *outString, const byte *inString, size_t length);

 

 	/// \brief Resynchronize the cipher