Update documentation

pull/484/merge
Jeffrey Walton 2017-09-28 04:42:48 -04:00
parent 7ef1c47c6d
commit db641b9258
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
2 changed files with 14 additions and 3 deletions

View File

@ -298,7 +298,7 @@ public:
DecodingResult Decrypt(RandomNumberGenerator &rng, const byte *ciphertext, size_t ciphertextLength, byte *plaintext, const NameValuePairs &parameters = g_nullNameValuePairs) const; DecodingResult Decrypt(RandomNumberGenerator &rng, const byte *ciphertext, size_t ciphertextLength, byte *plaintext, const NameValuePairs &parameters = g_nullNameValuePairs) const;
}; };
//! \class TF_DecryptorBase //! \class TF_EncryptorBase
//! \brief Trapdoor function cryptosystems encryption base class //! \brief Trapdoor function cryptosystems encryption base class
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE TF_EncryptorBase : public TF_CryptoSystemBase<PK_Encryptor, TF_Base<RandomizedTrapdoorFunction, PK_EncryptionMessageEncodingMethod> > class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE TF_EncryptorBase : public TF_CryptoSystemBase<PK_Encryptor, TF_Base<RandomizedTrapdoorFunction, PK_EncryptionMessageEncodingMethod> >
{ {

View File

@ -56,13 +56,16 @@ struct Threefish_Info : public VariableBlockSize<32, 32, 128>
} }
}; };
//! \class Threefish1024 //! \class Threefish
//! \brief Threefish-1024 block cipher //! \brief Threefish block cipher
//! \sa <a href="http://www.weidai.com/scan-mirror/cs.html#Threefish">Threefish</a> //! \sa <a href="http://www.weidai.com/scan-mirror/cs.html#Threefish">Threefish</a>
//! \since Crypto++ 6.0 //! \since Crypto++ 6.0
class Threefish : public Threefish_Info, public BlockCipherDocumentation class Threefish : public Threefish_Info, public BlockCipherDocumentation
{ {
public: public:
//! \brief Threefish block cipher data processing functions
//! \details Provides implementation common to encryption and decryption
//! \since Crypto++ 6.0
class CRYPTOPP_NO_VTABLE Base : public VariableBlockCipherImpl<Threefish_Info> class CRYPTOPP_NO_VTABLE Base : public VariableBlockCipherImpl<Threefish_Info>
{ {
public: public:
@ -84,6 +87,10 @@ public:
AlignedSecBlock64 m_tweak; AlignedSecBlock64 m_tweak;
}; };
//! \brief Provides implementation for encryption transformation
//! \details Enc provides implementation for encryption transformation. All key and block
//! sizes are supported.
//! \since Crypto++ 6.0
class CRYPTOPP_NO_VTABLE Enc : public Base class CRYPTOPP_NO_VTABLE Enc : public Base
{ {
protected: protected:
@ -94,6 +101,10 @@ public:
void ProcessAndXorBlock_1024(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; void ProcessAndXorBlock_1024(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
}; };
//! \brief Provides implementation for decryption transformation
//! \details Dec provides implementation for encryption transformation. All key and block
//! sizes are supported.
//! \since Crypto++ 6.0
class CRYPTOPP_NO_VTABLE Dec : public Base class CRYPTOPP_NO_VTABLE Dec : public Base
{ {
protected: protected: