diff options
| author | Jeffrey Walton <noloader@gmail.com> | 2018-07-04 03:47:28 -0400 |
|---|---|---|
| committer | Jeffrey Walton <noloader@gmail.com> | 2018-07-04 03:47:28 -0400 |
| commit | d00777e1d7c5f129b8b86837f7a03c4e1de7da35 (patch) | |
| tree | 52056536d06cc9586c84145327bd4a7849bba7e4 /rabbit.h | |
| parent | 94e0b3c954b15048e00544c18c54f3776e1892da (diff) | |
| download | cryptopp-git-d00777e1d7c5f129b8b86837f7a03c4e1de7da35.tar.gz | |
Add Rabbit stream cipher (GH #678)
Diffstat (limited to 'rabbit.h')
| -rw-r--r-- | rabbit.h | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/rabbit.h b/rabbit.h new file mode 100644 index 00000000..46715f7e --- /dev/null +++ b/rabbit.h @@ -0,0 +1,111 @@ +// rabbit.h - written and placed in the public domain by Jeffrey Walton
+// based on public domain code by Martin Boesgaard, Mette Vesterager,
+// Thomas Pedersen, Jesper Christiansen and Ove Scavenius.
+//
+// The reference materials and source files are available at
+// The eSTREAM Project, http://www.ecrypt.eu.org/stream/rabbitpf.html.
+
+/// \file rabbit.h
+/// \brief Classes for Rabbit stream cipher
+/// \sa <A HREF="http://www.ecrypt.eu.org/stream/p3ciphers/rabbit/rabbit_p3.pdf">The
+/// Stream Cipher Rabbit (v1.1)< /A>, <A HREF="http://www.ecrypt.eu.org/stream/rabbitpf.html">The
+/// eSTREAM Project - eSTREAM Phase 3 - Rabbit</A> and
+/// <A HREF="https://www.cryptopp.com/wiki/Rabbit">Crypto++ Wiki | Rabbit</A>.
+/// \since Crypto++ 7.1
+
+#ifndef CRYPTOPP_RABBIT_H
+#define CRYPTOPP_RABBIT_H
+
+#include "strciphr.h"
+#include "secblock.h"
+
+// The library does not have a way to describe an optional IV. Rabbit takes
+// an optional IV so two classes are offered to bridge the gap. One provides
+// Rabbit without an IV and the second provides Rabbit with an IV.
+
+NAMESPACE_BEGIN(CryptoPP)
+
+/// \brief Rabbit stream cipher information
+/// \since Crypto++ 7.1
+struct RabbitInfo : public FixedKeyLength<16, SimpleKeyingInterface::NOT_RESYNCHRONIZABLE>
+{
+ CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() { return "Rabbit"; }
+};
+
+/// \brief Rabbit stream cipher information
+/// \since Crypto++ 7.1
+struct RabbitWithIVInfo : public FixedKeyLength<16, SimpleKeyingInterface::UNIQUE_IV, 8>
+{
+ CRYPTOPP_STATIC_CONSTEXPR const char* StaticAlgorithmName() { return "RabbitWithIV"; }
+};
+
+/// \brief Rabbit stream cipher implementation
+/// \since Crypto++ 7.1
+class RabbitPolicy : public AdditiveCipherConcretePolicy<word32, 4>, public RabbitInfo
+{
+protected:
+ void CipherSetKey(const NameValuePairs ¶ms, const byte *key, size_t length);
+ void OperateKeystream(KeystreamOperation operation, byte *output, const byte *input, size_t iterationCount);
+ bool CanOperateKeystream() const { return true; }
+ unsigned int GetOptimalBlockSize() const { return 16; }
+ bool CipherIsRandomAccess() const { return false; }
+
+ // Master and working states
+ FixedSizeSecBlock<word32, 8> m_mx, m_mc, m_wx, m_wc;
+ // Workspace
+ FixedSizeSecBlock<word32, 12> m_t;
+ word32 m_mcy, m_wcy; // carry
+};
+
+/// \brief Rabbit stream cipher implementation
+/// \since Crypto++ 7.1
+class RabbitWithIVPolicy : public AdditiveCipherConcretePolicy<word32, 4>, public RabbitWithIVInfo
+{
+protected:
+ void CipherSetKey(const NameValuePairs ¶ms, const byte *key, size_t length);
+ void OperateKeystream(KeystreamOperation operation, byte *output, const byte *input, size_t iterationCount);
+ void CipherResynchronize(byte *keystreamBuffer, const byte *iv, size_t length);
+ bool CanOperateKeystream() const { return true; }
+ unsigned int GetOptimalBlockSize() const { return 16; }
+ bool CipherIsRandomAccess() const { return false; }
+
+ // Master and working states
+ FixedSizeSecBlock<word32, 8> m_mx, m_mc, m_wx, m_wc;
+ // Workspace
+ FixedSizeSecBlock<word32, 12> m_t;
+ word32 m_mcy, m_wcy; // carry
+};
+
+/// \brief Rabbit stream cipher
+/// \details is a stream cipher developed by Martin Boesgaard, Mette Vesterager,
+// Thomas Pedersen, Jesper Christiansen and Ove Scavenius. Rabbit is one of the final four
+/// Profile 1 (software) ciphers selected for the eSTREAM Portfolio.
+/// \sa <A HREF="http://www.ecrypt.eu.org/stream/p3ciphers/rabbit/rabbit_p3.pdf">The
+/// Stream Cipher Rabbit (v1.1)< /A>, <A HREF="http://www.ecrypt.eu.org/stream/rabbitpf.html">The
+/// eSTREAM Project - eSTREAM Phase 3 - Rabbit</A> and
+/// <A HREF="https://www.cryptopp.com/wiki/Rabbit">Crypto++ Wiki | Rabbit</A>.
+/// \since Crypto++ 7.1
+struct Rabbit : public RabbitInfo, public SymmetricCipherDocumentation
+{
+ typedef SymmetricCipherFinal<ConcretePolicyHolder<RabbitPolicy, AdditiveCipherTemplate<> >, RabbitInfo> Encryption;
+ typedef Encryption Decryption;
+};
+
+/// \brief Rabbit stream cipher
+/// \details is a stream cipher developed by Martin Boesgaard, Mette Vesterager,
+// Thomas Pedersen, Jesper Christiansen and Ove Scavenius. Rabbit is one of the final four
+/// Profile 1 (software) ciphers selected for the eSTREAM Portfolio.
+/// \sa <A HREF="http://www.ecrypt.eu.org/stream/p3ciphers/rabbit/rabbit_p3.pdf">The
+/// Stream Cipher Rabbit (v1.1)< /A>, <A HREF="http://www.ecrypt.eu.org/stream/rabbitpf.html">The
+/// eSTREAM Project - eSTREAM Phase 3 - Rabbit</A> and
+/// <A HREF="https://www.cryptopp.com/wiki/Rabbit">Crypto++ Wiki | Rabbit</A>.
+/// \since Crypto++ 7.1
+struct RabbitWithIV : public RabbitWithIVInfo, public SymmetricCipherDocumentation
+{
+ typedef SymmetricCipherFinal<ConcretePolicyHolder<RabbitWithIVPolicy, AdditiveCipherTemplate<> >, RabbitWithIVInfo> Encryption;
+ typedef Encryption Decryption;
+};
+
+NAMESPACE_END
+
+#endif // CRYPTOPP_RABBIT_H
|