diff --git a/Doxyfile b/Doxyfile index 344c077f..7300daa0 100644 --- a/Doxyfile +++ b/Doxyfile @@ -41,7 +41,7 @@ PROJECT_NAME = Crypto++ # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 6.0.0 +PROJECT_NUMBER = 6.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/sha.h b/sha.h index 1f6041d5..6be24415 100644 --- a/sha.h +++ b/sha.h @@ -25,20 +25,25 @@ NAMESPACE_BEGIN(CryptoPP) class CRYPTOPP_DLL SHA1 : public IteratedHashWithStaticTransform { public: -#if CRYPTOPP_SHANI_AVAILABLE - size_t HashMultipleBlocks(const word32 *input, size_t length); -#endif + //! \brief Initialize state array + //! \param state the state of the hash + //! \details InitState sets a state array to SHA1 initial values + //! \details Hashes which derive from IteratedHashWithStaticTransform provide static + //! member functions InitState and Transform. External classes, like SEAL and MDC, + //! can initialize state with a user provided key and operate the hash on the data + //! with the user supplied state. + //! \note On Intel platforms the state array must be 16-byte aligned for SSE2. static void CRYPTOPP_API InitState(HashWordType *state); //! \brief Operate the hash //! \param digest the state of the hash //! \param data the data to be digested //! \details Transform operates the hash on data. When the call is invoked - //! data holds initial state. Upon return data holds the hash or + //! digest holds initial state. Upon return digest holds the hash or //! updated state. //! \details Hashes which derive from IteratedHashWithStaticTransform provide static //! member functions InitState and Transform. External classes, like SEAL and MDC, //! can initialize state with a user provided key and operate the hash on the data - //! with the used supplied initial state. + //! with the user supplied state. //! \note On Intel platforms the state array and data must be 16-byte aligned for SSE2. static void CRYPTOPP_API Transform(word32 *digest, const word32 *data); //! \brief The algorithm name @@ -63,19 +68,19 @@ public: //! \details Hashes which derive from IteratedHashWithStaticTransform provide static //! member functions InitState and Transform. External classes, like SEAL and MDC, //! can initialize state with a user provided key and operate the hash on the data - //! with the used supplied initial state. + //! with the user supplied state. //! \note On Intel platforms the state array must be 16-byte aligned for SSE2. static void CRYPTOPP_API InitState(HashWordType *state); //! \brief Operate the hash //! \param digest the state of the hash //! \param data the data to be digested //! \details Transform operates the hash on data. When the call is invoked - //! data holds initial state. Upon return data holds the hash or + //! digest holds initial state. Upon return digest holds the hash or //! updated state. //! \details Hashes which derive from IteratedHashWithStaticTransform provide static //! member functions InitState and Transform. External classes, like SEAL and MDC, //! can initialize state with a user provided key and operate the hash on the data - //! with the used supplied initial state. + //! with the user supplied state. //! \note On Intel platforms the state array and data must be 16-byte aligned for SSE2. static void CRYPTOPP_API Transform(word32 *digest, const word32 *data); //! \brief The algorithm name @@ -100,19 +105,19 @@ public: //! \details Hashes which derive from IteratedHashWithStaticTransform provide static //! member functions InitState and Transform. External classes, like SEAL and MDC, //! can initialize state with a user provided key and operate the hash on the data - //! with the used supplied initial state. + //! with the user supplied state. //! \note On Intel platforms the state array must be 16-byte aligned for SSE2. static void CRYPTOPP_API InitState(HashWordType *state); //! \brief Operate the hash //! \param digest the state of the hash //! \param data the data to be digested //! \details Transform operates the hash on data. When the call is invoked - //! data holds initial state. Upon return data holds the hash or + //! digest holds initial state. Upon return digest holds the hash or //! updated state. //! \details Hashes which derive from IteratedHashWithStaticTransform provide static //! member functions InitState and Transform. External classes, like SEAL and MDC, //! can initialize state with a user provided key and operate the hash on the data - //! with the used supplied initial state. + //! with the user supplied state. //! \note On Intel platforms the state array and data must be 16-byte aligned for SSE2. static void CRYPTOPP_API Transform(word32 *digest, const word32 *data) {SHA256::Transform(digest, data);} //! \brief The algorithm name @@ -137,19 +142,19 @@ public: //! \details Hashes which derive from IteratedHashWithStaticTransform provide static //! member functions InitState and Transform. External classes, like SEAL and MDC, //! can initialize state with a user provided key and operate the hash on the data - //! with the used supplied initial state. + //! with the user supplied state. //! \note On Intel platforms the state array must be 16-byte aligned for SSE2. static void CRYPTOPP_API InitState(HashWordType *state); //! \brief Operate the hash //! \param digest the state of the hash //! \param data the data to be digested //! \details Transform operates the hash on data. When the call is invoked - //! data holds initial state. Upon return data holds the hash or + //! digest holds initial state. Upon return digest holds the hash or //! updated state. //! \details Hashes which derive from IteratedHashWithStaticTransform provide static //! member functions InitState and Transform. External classes, like SEAL and MDC, //! can initialize state with a user provided key and operate the hash on the data - //! with the used supplied initial state. + //! with the user supplied state. //! \note On Intel platforms the state array and data must be 16-byte aligned for SSE2. static void CRYPTOPP_API Transform(word64 *digest, const word64 *data); //! \brief The algorithm name @@ -170,19 +175,19 @@ public: //! \details Hashes which derive from IteratedHashWithStaticTransform provide static //! member functions InitState and Transform. External classes, like SEAL and MDC, //! can initialize state with a user provided key and operate the hash on the data - //! with the used supplied initial state. + //! with the user supplied state. //! \note On Intel platforms the state array must be 16-byte aligned for SSE2. static void CRYPTOPP_API InitState(HashWordType *state); //! \brief Operate the hash //! \param digest the state of the hash //! \param data the data to be digested //! \details Transform operates the hash on data. When the call is invoked - //! data holds initial state. Upon return data holds the hash or + //! digest holds initial state. Upon return digest holds the hash or //! updated state. //! \details Hashes which derive from IteratedHashWithStaticTransform provide static //! member functions InitState and Transform. External classes, like SEAL and MDC, //! can initialize state with a user provided key and operate the hash on the data - //! with the used supplied initial state. + //! with the user supplied state. //! \note On Intel platforms the state array and data must be 16-byte aligned for SSE2. static void CRYPTOPP_API Transform(word64 *digest, const word64 *data) {SHA512::Transform(digest, data);} //! \brief The algorithm name