diff options
author | Jeffrey Walton <noloader@gmail.com> | 2016-10-25 23:43:40 -0400 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2016-10-25 23:43:40 -0400 |
commit | efd4bc6b08cf70407224d3234c570524180f9f46 (patch) | |
tree | dbdff592142173bbe8bb9b15d6ffebdc41088878 /dmac.h | |
parent | 29dae707fde49a2e38b22f9614febbe48171234c (diff) | |
download | cryptopp-git-efd4bc6b08cf70407224d3234c570524180f9f46.tar.gz |
Updated documentation
Diffstat (limited to 'dmac.h')
-rw-r--r-- | dmac.h | 18 |
1 files changed, 13 insertions, 5 deletions
@@ -11,7 +11,9 @@ NAMESPACE_BEGIN(CryptoPP)
-//! _
+//! \class DMAC_Base
+//! \brief DMAC message authentication code base class
+//! \tparam T class derived from BlockCipherDocumentation
template <class T>
class CRYPTOPP_NO_VTABLE DMAC_Base : public SameKeyLengthAs<T>, public MessageAuthenticationCode
{
@@ -37,15 +39,21 @@ private: unsigned int m_counter;
};
-//! DMAC
-/*! Based on "CBC MAC for Real-Time Data Sources" by Erez Petrank
- and Charles Rackoff. T should be a class derived from BlockCipherDocumentation.
-*/
+//! \class DMAC
+//! \brief DMAC message authentication code
+//! \tparam T class derived from BlockCipherDocumentation
+//! \sa <A HREF="https://eprint.iacr.org/1997/010">CBC MAC for Real-Time Data Sources (08.15.1997)</A>
+//! by Erez Petrank and Charles Rackoff
template <class T>
class DMAC : public MessageAuthenticationCodeFinal<DMAC_Base<T> >
{
public:
+ //! \brief Construct a DMAC
DMAC() {}
+
+ //! \brief Construct a DMAC
+ //! \param key a byte array used to key the cipher
+ //! \param length the size of the byte array, in bytes
DMAC(const byte *key, size_t length=DMAC_Base<T>::DEFAULT_KEYLENGTH)
{this->SetKey(key, length);}
};
|