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

Update documentation

pull/461/head
Jeffrey Walton 2017-08-16 05:42:58 -04:00
parent e19fad007f
commit b311aabc31
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
3 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
aes.h
View File

@ -2,6 +2,9 @@
//! \file //! \file
//! \brief Class file for the AES cipher (Rijndael) //! \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 #ifndef CRYPTOPP_AES_H
#define CRYPTOPP_AES_H #define CRYPTOPP_AES_H
@ -12,7 +15,10 @@ NAMESPACE_BEGIN(CryptoPP)
//! \class AES //! \class AES
//! \brief AES block cipher (Rijndael) //! \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 <a href="http://www.cryptolounge.org/wiki/AES">AES</a> winner, announced on 10/2/2000 //! \sa <a href="http://www.cryptolounge.org/wiki/AES">AES</a> 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); DOCUMENTED_TYPEDEF(Rijndael, AES);
typedef RijndaelEncryption AESEncryption; typedef RijndaelEncryption AESEncryption;

2
rijndael.h
View File

@ -29,7 +29,7 @@ struct Rijndael_Info : public FixedBlockSize<16>, public VariableKeyLength<16, 1
//! \sa <a href="http://www.weidai.com/scan-mirror/cs.html#Rijndael">Rijndael</a> //! \sa <a href="http://www.weidai.com/scan-mirror/cs.html#Rijndael">Rijndael</a>
class CRYPTOPP_DLL Rijndael : public Rijndael_Info, public BlockCipherDocumentation 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 //! \details Provides implementation common to encryption and decryption
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<Rijndael_Info> class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<Rijndael_Info>
{ {

8
shacal2.h
View File

@ -2,6 +2,7 @@
//! \file shacal2.h //! \file shacal2.h
//! \brief Classes for the SHACAL-2 block cipher //! \brief Classes for the SHACAL-2 block cipher
//! \since Crypto++ 5.2, Intel SHA since Crypto++ 6.0
#ifndef CRYPTOPP_SHACAL2_H #ifndef CRYPTOPP_SHACAL2_H
#define CRYPTOPP_SHACAL2_H #define CRYPTOPP_SHACAL2_H
@ -20,9 +21,12 @@ struct SHACAL2_Info : public FixedBlockSize<32>, public VariableKeyLength<16, 16
//! \class SHACAL2 //! \class SHACAL2
//! \brief SHACAL2 block cipher //! \brief SHACAL2 block cipher
//! \since Crypto++ 5.2, Intel SHA since Crypto++ 6.0
//! \sa <a href="http://www.weidai.com/scan-mirror/cs.html#SHACAL-2">SHACAL-2</a> //! \sa <a href="http://www.weidai.com/scan-mirror/cs.html#SHACAL-2">SHACAL-2</a>
class SHACAL2 : public SHACAL2_Info, public BlockCipherDocumentation 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<SHACAL2_Info> class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<SHACAL2_Info>
{ {
public: public:
@ -34,12 +38,16 @@ class SHACAL2 : public SHACAL2_Info, public BlockCipherDocumentation
static const word32 K[64]; 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 class CRYPTOPP_NO_VTABLE Enc : public Base
{ {
public: public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const; 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 class CRYPTOPP_NO_VTABLE Dec : public Base
{ {
public: public: