From f4877218fa17372b26ccb112e2e8bef6bc08d21e Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Sun, 24 Apr 2016 22:20:25 -0400 Subject: Updated documentation --- authenc.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'authenc.h') diff --git a/authenc.h b/authenc.h index a41dcd21..a40a538c 100644 --- a/authenc.h +++ b/authenc.h @@ -13,7 +13,7 @@ NAMESPACE_BEGIN(CryptoPP) //! \class AuthenticatedSymmetricCipherBase -//! \brief +//! \brief Base implementation for one direction (encryption or decryption) of a stream cipher or block cipher mode with authentication class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE AuthenticatedSymmetricCipherBase : public AuthenticatedSymmetricCipher { public: @@ -22,7 +22,14 @@ public: bool IsRandomAccess() const {return false;} bool IsSelfInverting() const {return true;} - void UncheckedSetKey(const byte *,unsigned int,const CryptoPP::NameValuePairs &) {assert(false);} + + //! \brief Sets the key for this object without performing parameter validation + //! \param key a byte buffer used to key the cipher + //! \param length the length of the byte buffer + //! \param params additional parameters passed as NameValuePairs + //! \details key must be at least DEFAULT_KEYLENGTH in length. + void UncheckedSetKey(const byte * key, unsigned int length,const CryptoPP::NameValuePairs ¶ms) + {CRYPTOPP_UNUSED(key), CRYPTOPP_UNUSED(length), CRYPTOPP_UNUSED(params); assert(false);} void SetKey(const byte *userKey, size_t keylength, const NameValuePairs ¶ms); void Restart() {if (m_state > State_KeySet) m_state = State_KeySet;} -- cgit v1.2.1