From c5c6a6af5ca4bcbcbcd84c995ad5b65828b46eab Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Wed, 16 Aug 2017 05:11:37 -0400 Subject: [PATCH 1/3] Fix Doxygen constant documentation --- config.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/config.h b/config.h index 0cb20bb5..3176832c 100644 --- a/config.h +++ b/config.h @@ -535,7 +535,11 @@ NAMESPACE_END //#else //# define CRYPTOPP_CONSTANT(x) static const int x; //#endif -#define CRYPTOPP_CONSTANT(x) enum {x}; +#if defined(CRYPTOPP_DOXYGEN_PROCESSING) +# define CRYPTOPP_CONSTANT(x) static const int x; +#else +# define CRYPTOPP_CONSTANT(x) enum {x}; +#endif // Linux provides X32, which is 32-bit integers, longs and pointers on x86_64 using the full x86_64 register set. // Detect via __ILP32__ (http://wiki.debian.org/X32Port). However, __ILP32__ shows up in more places than From e19fad007fde3bc744c9c7b1ebdbd7d49ae6a185 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Wed, 16 Aug 2017 05:36:11 -0400 Subject: [PATCH 2/3] Fix library version number in script --- TestScripts/change-version.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/TestScripts/change-version.sh b/TestScripts/change-version.sh index d59ec927..c9a15145 100644 --- a/TestScripts/change-version.sh +++ b/TestScripts/change-version.sh @@ -4,6 +4,6 @@ # building the docs. Before running the script, copy it to the root # directory. After running this script, you can 'make docs' -gsed -i 's|Library 6.0 API|Library 5.6.5 API|g' cryptlib.h -gsed -i 's|= 6.0.0|= 5.6.5|g' Doxyfile -gsed -i 's|CRYPTOPP_VERSION 600|CRYPTOPP_VERSION 565|g' config.h +sed -i 's|Library 6.0 API|Library 5.6.5 API|g' cryptlib.h +sed -i 's|= 6.0|= 5.6.5|g' Doxyfile +sed -i 's|CRYPTOPP_VERSION 600|CRYPTOPP_VERSION 565|g' config.h From b311aabc313c12d3b66c3468338453ed7fdfc0a9 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Wed, 16 Aug 2017 05:42:58 -0400 Subject: [PATCH 3/3] Update documentation --- aes.h | 6 ++++++ rijndael.h | 2 +- shacal2.h | 8 ++++++++ 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/aes.h b/aes.h index e95d2102..2921ae90 100644 --- a/aes.h +++ b/aes.h @@ -2,6 +2,9 @@ //! \file //! \brief Class file for the AES cipher (Rijndael) +//! \details AES is a typdef for Rijndael classes. All key sizes are supported. +//! The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks +//! \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0 #ifndef CRYPTOPP_AES_H #define CRYPTOPP_AES_H @@ -12,7 +15,10 @@ NAMESPACE_BEGIN(CryptoPP) //! \class AES //! \brief AES block cipher (Rijndael) +//! \details AES is a typdef for Rijndael classes. All key sizes are supported. +//! The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks //! \sa AES winner, announced on 10/2/2000 +//! \since Rijndael since Crypto++ 3.2, Intel AESNI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0 DOCUMENTED_TYPEDEF(Rijndael, AES); typedef RijndaelEncryption AESEncryption; diff --git a/rijndael.h b/rijndael.h index 0a17ad84..d8cba04e 100644 --- a/rijndael.h +++ b/rijndael.h @@ -29,7 +29,7 @@ struct Rijndael_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 1 //! \sa Rijndael class CRYPTOPP_DLL Rijndael : public Rijndael_Info, public BlockCipherDocumentation { - //! \brief Rijndael block cipher data processing functionss + //! \brief Rijndael block cipher data processing functions //! \details Provides implementation common to encryption and decryption class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl { diff --git a/shacal2.h b/shacal2.h index 2a92cb6d..79c35c53 100644 --- a/shacal2.h +++ b/shacal2.h @@ -2,6 +2,7 @@ //! \file shacal2.h //! \brief Classes for the SHACAL-2 block cipher +//! \since Crypto++ 5.2, Intel SHA since Crypto++ 6.0 #ifndef CRYPTOPP_SHACAL2_H #define CRYPTOPP_SHACAL2_H @@ -20,9 +21,12 @@ struct SHACAL2_Info : public FixedBlockSize<32>, public VariableKeyLength<16, 16 //! \class SHACAL2 //! \brief SHACAL2 block cipher +//! \since Crypto++ 5.2, Intel SHA since Crypto++ 6.0 //! \sa SHACAL-2 class SHACAL2 : public SHACAL2_Info, public BlockCipherDocumentation { + //! \brief SHACAL2 block cipher data processing functions + //! \details Provides implementation common to encryption and decryption class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl { public: @@ -34,12 +38,16 @@ class SHACAL2 : public SHACAL2_Info, public BlockCipherDocumentation static const word32 K[64]; }; + //! \brief SHACAL2 block cipher data processing functions + //! \details Provides implementation for encryption transformation class CRYPTOPP_NO_VTABLE Enc : public Base { public: void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; }; + //! \brief SHACAL2 block cipher data processing functions + //! \details Provides implementation for decryption transformation class CRYPTOPP_NO_VTABLE Dec : public Base { public: