From 61ec50dabe14c5d4582ac187706ea27645b3562b Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Wed, 29 Nov 2017 10:54:33 -0500 Subject: Change Doxygen comment style from //! to /// Also see https://groups.google.com/forum/#!topic/cryptopp-users/A7-Xt5Knlzw --- randpool.h | 90 +++++++++++++++++++++++++++++++------------------------------- 1 file changed, 45 insertions(+), 45 deletions(-) (limited to 'randpool.h') diff --git a/randpool.h b/randpool.h index 248c004f..fafad343 100644 --- a/randpool.h +++ b/randpool.h @@ -1,19 +1,19 @@ // randpool.h - originally written and placed in the public domain by Wei Dai // OldRandPool added by JW in August, 2017. -//! \file randpool.h -//! \brief Class file for Randomness Pool -//! \details RandomPool can be used to generate cryptographic quality pseudorandom bytes -//! after seeding the pool with IncorporateEntropy(). Internally, the generator uses -//! AES-256 to produce the stream. Entropy is stirred in using SHA-256. -//! \details RandomPool used to follow the design of randpool in PGP 2.6.x. At version 5.5 -//! RandomPool was redesigned to reduce the risk of reusing random numbers after state -//! rollback (which may occur when running in a virtual machine like VMware or a hosted -//! environment). -//! \details If you need the pre-Crypto++ 5.5 generator then use OldRandomPool class. You -//! should migrate away from OldRandomPool at the earliest opportunity. Use RandomPool -//! or AutoSeededRandomPool instead. -//! \since Crypto++ 4.0 (PGP 2.6.x style), Crypto++ 5.5 (AES-256 based) +/// \file randpool.h +/// \brief Class file for Randomness Pool +/// \details RandomPool can be used to generate cryptographic quality pseudorandom bytes +/// after seeding the pool with IncorporateEntropy(). Internally, the generator uses +/// AES-256 to produce the stream. Entropy is stirred in using SHA-256. +/// \details RandomPool used to follow the design of randpool in PGP 2.6.x. At version 5.5 +/// RandomPool was redesigned to reduce the risk of reusing random numbers after state +/// rollback (which may occur when running in a virtual machine like VMware or a hosted +/// environment). +/// \details If you need the pre-Crypto++ 5.5 generator then use OldRandomPool class. You +/// should migrate away from OldRandomPool at the earliest opportunity. Use RandomPool +/// or AutoSeededRandomPool instead. +/// \since Crypto++ 4.0 (PGP 2.6.x style), Crypto++ 5.5 (AES-256 based) #ifndef CRYPTOPP_RANDPOOL_H #define CRYPTOPP_RANDPOOL_H @@ -26,23 +26,23 @@ NAMESPACE_BEGIN(CryptoPP) -//! \class RandomPool -//! \brief Randomness Pool based on AES-256 -//! \details RandomPool can be used to generate cryptographic quality pseudorandom bytes -//! after seeding the pool with IncorporateEntropy(). Internally, the generator uses -//! AES-256 to produce the stream. Entropy is stirred in using SHA-256. -//! \details RandomPool used to follow the design of randpool in PGP 2.6.x. At version 5.5 -//! RandomPool was redesigned to reduce the risk of reusing random numbers after state -//! rollback, which may occur when running in a virtual machine like VMware or a hosted -//! environment. -//! \details If you need the pre-Crypto++ 5.5 generator then use OldRandomPool class. You -//! should migrate away from OldRandomPool at the earliest opportunity. -//! \sa OldRandomPool -//! \since Crypto++ 4.0 (PGP 2.6.x style), Crypto++ 5.5 (AES-256 based) +/// \class RandomPool +/// \brief Randomness Pool based on AES-256 +/// \details RandomPool can be used to generate cryptographic quality pseudorandom bytes +/// after seeding the pool with IncorporateEntropy(). Internally, the generator uses +/// AES-256 to produce the stream. Entropy is stirred in using SHA-256. +/// \details RandomPool used to follow the design of randpool in PGP 2.6.x. At version 5.5 +/// RandomPool was redesigned to reduce the risk of reusing random numbers after state +/// rollback, which may occur when running in a virtual machine like VMware or a hosted +/// environment. +/// \details If you need the pre-Crypto++ 5.5 generator then use OldRandomPool class. You +/// should migrate away from OldRandomPool at the earliest opportunity. +/// \sa OldRandomPool +/// \since Crypto++ 4.0 (PGP 2.6.x style), Crypto++ 5.5 (AES-256 based) class CRYPTOPP_DLL RandomPool : public RandomNumberGenerator, public NotCopyable { public: - //! \brief Construct a RandomPool + /// \brief Construct a RandomPool RandomPool(); bool CanIncorporateEntropy() const {return true;} @@ -56,27 +56,27 @@ private: bool m_keySet; }; -//! \class OldRandomPool -//! \brief Randomness Pool based on PGP 2.6.x with MDC -//! \details If you need the pre-Crypto++ 5.5 generator then use OldRandomPool class. The -//! OldRandomPool class is always available so you dont need to define -//! CRYPTOPP_MAINTAIN_BACKWARDS_COMPATIBILITY. OldRandomPool also provides the modern -//! interface, including CanIncorporateEntropy, IncorporateEntropy and -//! GenerateIntoBufferedTransformation. -//! \details You should migrate away from OldRandomPool at the earliest opportunity. Use a -//! modern random number generator or key derivation function, like AutoSeededRandomPool or -//! HKDF. -//! \deprecated This class uses an old style PGP 2.6.x with MDC. The generator risks reusing -//! random random numbers after state rollback. You should migrate away from OldRandomPool -//! at the earliest opportunity. -//! \sa RandomPool, AutoSeededRandomPool, HKDF, P1363_KDF2, PKCS12_PBKDF, PKCS5_PBKDF2_HMAC -//! \since Crypto++ 6.0 (PGP 2.6.x style) +/// \class OldRandomPool +/// \brief Randomness Pool based on PGP 2.6.x with MDC +/// \details If you need the pre-Crypto++ 5.5 generator then use OldRandomPool class. The +/// OldRandomPool class is always available so you dont need to define +/// CRYPTOPP_MAINTAIN_BACKWARDS_COMPATIBILITY. OldRandomPool also provides the modern +/// interface, including CanIncorporateEntropy, IncorporateEntropy and +/// GenerateIntoBufferedTransformation. +/// \details You should migrate away from OldRandomPool at the earliest opportunity. Use a +/// modern random number generator or key derivation function, like AutoSeededRandomPool or +/// HKDF. +/// \deprecated This class uses an old style PGP 2.6.x with MDC. The generator risks reusing +/// random random numbers after state rollback. You should migrate away from OldRandomPool +/// at the earliest opportunity. +/// \sa RandomPool, AutoSeededRandomPool, HKDF, P1363_KDF2, PKCS12_PBKDF, PKCS5_PBKDF2_HMAC +/// \since Crypto++ 6.0 (PGP 2.6.x style) class CRYPTOPP_DLL OldRandomPool : public RandomNumberGenerator { public: - //! \brief Construct an OldRandomPool - //! \param poolSize internal pool size of the generator - //! \details poolSize must be greater than 16 + /// \brief Construct an OldRandomPool + /// \param poolSize internal pool size of the generator + /// \details poolSize must be greater than 16 OldRandomPool(unsigned int poolSize=384); // RandomNumberGenerator interface (Crypto++ 5.5 and above) -- cgit v1.2.1