From 6a68abea0a59efd5f293a5b446df4abe05b2e476 Mon Sep 17 00:00:00 2001
From: Jeffrey Walton <noloader@gmail.com>
Date: Fri, 25 Jan 2019 08:14:23 -0500
Subject: [PATCH] Update comments

---
 chacha.cpp |  7 +++++--
 chacha.h   | 30 ++++++++++++++----------------
 2 files changed, 19 insertions(+), 18 deletions(-)

diff --git a/chacha.cpp b/chacha.cpp
index e9b1918c..3676eaf7 100644
--- a/chacha.cpp
+++ b/chacha.cpp
@@ -83,9 +83,9 @@ enum {BYTES_PER_ITERATION=64};
 // during addition in an intermediate result. Conditions to trigger
 // issue include a user seeks to around 2^32 blocks (256 GB of data).
 // https://github.com/weidai11/cryptopp/issues/732
-inline bool MultiBlockSafe(unsigned int state12, unsigned int blocks)
+inline bool MultiBlockSafe(unsigned int ctrLow, unsigned int blocks)
 {
-    return 0xffffffff - state12 > blocks;
+    return 0xffffffff - ctrLow > blocks;
 }
 
 // OperateKeystream always produces a key stream. The key stream is written
@@ -217,6 +217,9 @@ void ChaCha_OperateKeystream(KeystreamOperation operation,
 
     // We may re-enter a SIMD keystream operation from here.
     } while (iterationCount--);
+
+    #undef CHACHA_QUARTER_ROUND
+    #undef CHACHA_OUTPUT
 }
 
 std::string ChaCha_AlgorithmProvider()
diff --git a/chacha.h b/chacha.h
index ba71a6a4..28b195f6 100644
--- a/chacha.h
+++ b/chacha.h
@@ -3,12 +3,12 @@
 //            and Bernstein's reference ChaCha family implementation at
 //            http://cr.yp.to/chacha.html.
 
-// Crypto++ added Bernstein's ChaCha classses at version 5.6.4 of the library.
-// The IETF uses a slightly different implementation, and the classes were
-// added at Crypto++ version 8.1. We wanted to maintain ABI compatibility at
-// the 8.1 release so the original ChaCha classes were not disturbed. Instead
-// new classes were added for IETF ChaCha. The back-end implementation shares
-// code as expected, however.
+// The library added Bernstein's ChaCha classses at Crypto++ 5.6.4. The IETF
+// uses a slightly different implementation than Bernstein, and the IETF
+// classes were added at Crypto++ 8.1. We wanted to maintain ABI compatibility
+// at the 8.1 release so the original ChaCha classes were not disturbed.
+// Instead new classes were added for IETF ChaCha. The back-end implementation
+// shares code as expected, however.
 
 /// \file chacha.h
 /// \brief Classes for ChaCha8, ChaCha12 and ChaCha20 stream ciphers
@@ -73,12 +73,10 @@ protected:
 };
 
 /// \brief ChaCha stream cipher
-/// \details Bernstein and ECRYPT's ChaCha is _slightly_ different from the TLS working
-///   group's implementation for cipher suites
-///   <tt>TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256</tt>,
-///   <tt>TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256</tt>, and
-///   <tt>TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256</tt>.
-/// \sa <a href="http://cr.yp.to/chacha/chacha-20080208.pdf">ChaCha, a variant of Salsa20</a> (2008.01.28).
+/// \details This is Bernstein and ECRYPT's ChaCha. It is _slightly_ different
+///   from the IETF's version of ChaCha called ChaChaTLS.
+/// \sa <a href="http://cr.yp.to/chacha/chacha-20080208.pdf">ChaCha, a variant
+///   of Salsa20</a> (2008.01.28).
 /// \since Crypto++ 5.6.4
 struct ChaCha : public ChaCha_Info, public SymmetricCipherDocumentation
 {
@@ -96,9 +94,9 @@ struct ChaChaTLS_Info : public FixedKeyLength<32, SimpleKeyingInterface::UNIQUE_
     /// \returns the algorithm name
     /// \details StaticAlgorithmName returns the algorithm's name as a static
     ///   member function.
-    /// \details This is the IETF's variant of Bernstein's ChaCha from RFC 7539.
-    ///   IETF ChaCha is called ChaChaTLS in the Crypto++ library. It is
-    ///   _slightly_ different from Bernstein's implementation.
+    /// \details This is the IETF's variant of Bernstein's ChaCha from RFC
+    ///   7539. IETF ChaCha is called ChaChaTLS in the Crypto++ library. It
+    ///   is _slightly_ different from Bernstein's implementation.
     static const char* StaticAlgorithmName() {
         return "ChaChaTLS";
     }
@@ -131,7 +129,7 @@ protected:
 /// \brief ChaCha-TLS stream cipher
 /// \details This is the IETF's variant of Bernstein's ChaCha from RFC 7539.
 ///   IETF ChaCha is called ChaChaTLS in the Crypto++ library. It is
-///   _slightly_ different from the Bernstein's implementation. ChaCha-TLS
+///   _slightly_ different from the Bernstein implementation. ChaCha-TLS
 ///   can be used for cipher suites
 ///   <tt>TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256</tt>,
 ///   <tt>TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256</tt>, and