arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated documentation

pull/161/head
Jeffrey Walton 2016-04-24 22:20:25 -04:00
parent a5621a9de9
commit f4877218fa
4 changed files with 26 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
authenc.h
View File

@ -13,7 +13,7 @@
NAMESPACE_BEGIN(CryptoPP) NAMESPACE_BEGIN(CryptoPP)
//! \class AuthenticatedSymmetricCipherBase //! \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 class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE AuthenticatedSymmetricCipherBase : public AuthenticatedSymmetricCipher
{ {
public: public:
@ -22,7 +22,14 @@ public:
bool IsRandomAccess() const {return false;} bool IsRandomAccess() const {return false;}
bool IsSelfInverting() const {return true;} 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 &params)
{CRYPTOPP_UNUSED(key), CRYPTOPP_UNUSED(length), CRYPTOPP_UNUSED(params); assert(false);}
void SetKey(const byte *userKey, size_t keylength, const NameValuePairs &params); void SetKey(const byte *userKey, size_t keylength, const NameValuePairs &params);
void Restart() {if (m_state > State_KeySet) m_state = State_KeySet;} void Restart() {if (m_state > State_KeySet) m_state = State_KeySet;}

0
chacha.h Executable file → Normal file
View File

4
misc.h
View File

@ -2009,7 +2009,7 @@ inline void PutWord(bool assumeAligned, ByteOrder order, byte *block, T value, c
//! \tparam A flag indicating alignment //! \tparam A flag indicating alignment
//! \details GetBlock() provides alternate read access to a block of memory. The enumeration B is //! \details GetBlock() provides alternate read access to a block of memory. The enumeration B is
//! BigEndian or LittleEndian. The flag A indicates if the memory block is aligned for class or type T. //! BigEndian or LittleEndian. The flag A indicates if the memory block is aligned for class or type T.
//! Repeatedly applying \ref GetBlock::operator() "operator()" results in advancing in the block of memory. //! Repeatedly applying operator() results in advancing in the block of memory.
//! \details An example of reading two word32 values from a block of memory is shown below. <tt>w1</tt> //! \details An example of reading two word32 values from a block of memory is shown below. <tt>w1</tt>
//! will be <tt>0x03020100</tt> and <tt>w1</tt> will be <tt>0x07060504</tt>. //! will be <tt>0x03020100</tt> and <tt>w1</tt> will be <tt>0x07060504</tt>.
//! <pre> //! <pre>
@ -2051,7 +2051,7 @@ private:
//! \tparam A flag indicating alignment //! \tparam A flag indicating alignment
//! \details GetBlock() provides alternate write access to a block of memory. The enumeration B is //! \details GetBlock() provides alternate write access to a block of memory. The enumeration B is
//! BigEndian or LittleEndian. The flag A indicates if the memory block is aligned for class or type T. //! BigEndian or LittleEndian. The flag A indicates if the memory block is aligned for class or type T.
//! Repeatedly applying \ref PutBlock::operator() "operator()" results in advancing in the block of memory. //! Repeatedly applying operator() results in advancing in the block of memory.
//! \details An example of reading two word32 values from a block of memory is shown below. <tt>w1</tt> //! \details An example of reading two word32 values from a block of memory is shown below. <tt>w1</tt>
//! will be <tt>0x03020100</tt> and <tt>w1</tt> will be <tt>0x07060504</tt>. //! will be <tt>0x03020100</tt> and <tt>w1</tt> will be <tt>0x07060504</tt>.
//! <pre> //! <pre>