summaryrefslogtreecommitdiff
path: root/salsa.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2016-04-21 00:40:03 -0400
committerJeffrey Walton <noloader@gmail.com>2016-04-21 00:40:03 -0400
commit8ac5c499c2e07792105b51b9288be3e9beba3031 (patch)
treeba3a31e031666c7b89daa5028f144603df8f181d /salsa.h
parent4c78330cb9e92a0580f9811190d39ccb44f7779d (diff)
downloadcryptopp-git-8ac5c499c2e07792105b51b9288be3e9beba3031.tar.gz
Updated documentation
Diffstat (limited to 'salsa.h')
-rw-r--r--salsa.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/salsa.h b/salsa.h
index 5c2c91c5..37742400 100644
--- a/salsa.h
+++ b/salsa.h
@@ -19,7 +19,7 @@
NAMESPACE_BEGIN(CryptoPP)
//! \class Salsa20_Info
-//! \brief Salsa block cipher information
+//! \brief Salsa stream cipher information
struct Salsa20_Info : public VariableKeyLength<32, 16, 32, 16, SimpleKeyingInterface::UNIQUE_IV, 8>
{
static const char *StaticAlgorithmName() {return "Salsa20";}
@@ -42,10 +42,10 @@ protected:
int m_rounds;
};
-// <a href="http://www.cryptolounge.org/wiki/Salsa20">Salsa20</a>, variable rounds: 8, 12 or 20 (default 20)
//! \class Salsa20
-//! \brief Salsa20 block cipher information
-//! \details Salsa20 provides a variable number of rounds: 8, 12 or 20. The default number of rounds is 20.
+//! \brief Salsa20 stream cipher information
+//! \details XSalsa20 provides a variable number of rounds: 8, 12 or 20. The default number of rounds is 20.
+//! \sa <a href="http://www.cryptolounge.org/wiki/XSalsa20">XSalsa20</a>
struct Salsa20 : public Salsa20_Info, public SymmetricCipherDocumentation
{
typedef SymmetricCipherFinal<ConcretePolicyHolder<Salsa20_Policy, AdditiveCipherTemplate<> >, Salsa20_Info> Encryption;
@@ -53,7 +53,7 @@ struct Salsa20 : public Salsa20_Info, public SymmetricCipherDocumentation
};
//! \class XSalsa20_Info
-//! \brief XSalsa20 block cipher information
+//! \brief XSalsa20 stream cipher information
struct XSalsa20_Info : public FixedKeyLength<32, SimpleKeyingInterface::UNIQUE_IV, 24>
{
static const char *StaticAlgorithmName() {return "XSalsa20";}
@@ -69,10 +69,10 @@ protected:
FixedSizeSecBlock<word32, 8> m_key;
};
-// <a href="http://www.cryptolounge.org/wiki/XSalsa20">XSalsa20</a>, variable rounds: 8, 12 or 20 (default 20)
//! \class XSalsa20
-//! \brief XSalsa20 block cipher information
+//! \brief XSalsa20 stream cipher information
//! \details XSalsa20 provides a variable number of rounds: 8, 12 or 20. The default number of rounds is 20.
+//! \sa <a href="http://www.cryptolounge.org/wiki/XSalsa20">XSalsa20</a>
struct XSalsa20 : public XSalsa20_Info, public SymmetricCipherDocumentation
{
typedef SymmetricCipherFinal<ConcretePolicyHolder<XSalsa20_Policy, AdditiveCipherTemplate<> >, XSalsa20_Info> Encryption;