Updated documentation

pull/339/head
Jeffrey Walton 2016-11-01 21:06:52 -04:00
parent 8de854cae6
commit d55d3d53d1
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
2 changed files with 18 additions and 3 deletions

View File

@ -2,6 +2,7 @@
//! \file sosemanuk.h
//! \brief Classes for Sosemanuk stream cipher
//! \since Crypto++ 5.5
#ifndef CRYPTOPP_SOSEMANUK_H
#define CRYPTOPP_SOSEMANUK_H
@ -17,13 +18,17 @@
NAMESPACE_BEGIN(CryptoPP)
//! algorithm info
//! \class SosemanukInfo
//! \brief Sosemanuk stream cipher information
//! \since Crypto++ 5.5
struct SosemanukInfo : public VariableKeyLength<16, 1, 32, 1, SimpleKeyingInterface::UNIQUE_IV, 16>
{
CRYPTOPP_CONSTEXPR static const char *StaticAlgorithmName() {return "Sosemanuk";}
};
//! _
//! \class SosemanukPolicy
//! \brief Sosemanuk stream cipher implementation
//! \since Crypto++ 5.5
class SosemanukPolicy : public AdditiveCipherConcretePolicy<word32, 20>, public SosemanukInfo
{
protected:
@ -40,7 +45,14 @@ protected:
FixedSizeAlignedSecBlock<word32, 12> m_state;
};
//! <a href="http://www.cryptolounge.org/wiki/Sosemanuk">Sosemanuk</a>
//! \class Sosemanuk
//! \brief Sosemanuk stream cipher
//! \details is a stream cipher developed by Come Berbain, Olivier Billet, Anne Canteaut, Nicolas Courtois,
//! Henri Gilbert, Louis Goubin, Aline Gouget, Louis Granboulan, Cédric Lauradoux, Marine Minier, Thomas
//! Pornin and Hervé Sibert. Sosemanuk is one of the final four Profile 1 (software) ciphers selected for
//! the eSTREAM Portfolio.
//! \sa <a href="http://www.cryptolounge.org/wiki/Sosemanuk">Sosemanuk</a>
//! \since Crypto++ 5.5
struct Sosemanuk : public SosemanukInfo, public SymmetricCipherDocumentation
{
typedef SymmetricCipherFinal<ConcretePolicyHolder<SosemanukPolicy, AdditiveCipherTemplate<> >, SosemanukInfo> Encryption;

3
vmac.h
View File

@ -2,6 +2,7 @@
//! \file vmac.h
//! \brief Classes for the VMAC message authentication code
//! \since Crypto++ 5.5
#ifndef CRYPTOPP_VMAC_H
#define CRYPTOPP_VMAC_H
@ -20,6 +21,7 @@ NAMESPACE_BEGIN(CryptoPP)
//! \class VMAC_Base
//! \brief VMAC message authentication code base class
//! \since Crypto++ 5.5
class VMAC_Base : public IteratedHashBase<word64, MessageAuthenticationCode>
{
public:
@ -74,6 +76,7 @@ protected:
//! \details The implementation is based on Ted Krovetz's public domain vmac.c
//! and <a href="http://tools.ietf.org/html/draft-krovetz-vmac-01">draft-krovetz-vmac-01.txt</a>.
//! \sa <a href="http://www.cryptolounge.org/wiki/VMAC">VMAC</a>.
//! \since Crypto++ 5.5
template <class T_BlockCipher, int T_DigestBitSize = 128>
class VMAC : public SimpleKeyingInterfaceImpl<VMAC_Base, SameKeyLengthAs<T_BlockCipher, SimpleKeyingInterface::UNIQUE_IV, T_BlockCipher::BLOCKSIZE> >
{