CryptoPPForUE4.17.2_5.6.5.zip

// cryptlib.h - written and placed in the public domain by Wei Dai //! \file cryptlib.h //! \brief Abstract base classes that provide a uniform interface to this library. /*! \mainpage Crypto++ Library 5.6.5 API Reference <dl> <dt>Abstract Base Classes<dd> cryptlib.h <dt>Authenticated Encryption Modes<dd> CCM, EAX, \ref GCM "GCM (2K tables)", \ref GCM "GCM (64K tables)" <dt>Block Ciphers<dd> \ref Rijndael "AES", Weak::ARC4, Blowfish, BTEA, Camellia, CAST128, CAST256, DES, \ref DES_EDE2 "2-key Triple-DES", \ref DES_EDE3 "3-key Triple-DES", \ref DES_XEX3 "DESX", GOST, IDEA, \ref LR "Luby-Rackoff", MARS, RC2, RC5, RC6, \ref SAFER_K "SAFER-K", \ref SAFER_SK "SAFER-SK", SEED, Serpent, \ref SHACAL2 "SHACAL-2", SHARK, SKIPJACK, Square, TEA, \ref ThreeWay "3-Way", Twofish, XTEA <dt>Stream Ciphers<dd> ChaCha8, ChaCha12, ChaCha20, \ref Panama "Panama-LE", \ref Panama "Panama-BE", Salsa20, \ref SEAL "SEAL-LE", \ref SEAL "SEAL-BE", WAKE, XSalsa20 <dt>Hash Functions<dd> BLAKE2s, BLAKE2b, \ref Keccak "Keccak (F1600)", SHA1, SHA224, SHA256, SHA384, SHA512, \ref SHA3 "SHA-3", Tiger, Whirlpool, RIPEMD160, RIPEMD320, RIPEMD128, RIPEMD256, Weak::MD2, Weak::MD4, Weak::MD5 <dt>Non-Cryptographic Checksums<dd> CRC32, Adler32 <dt>Message Authentication Codes<dd> VMAC, HMAC, CBC_MAC, CMAC, DMAC, TTMAC, \ref GCM "GCM (GMAC)", BLAKE2 <dt>Random Number Generators<dd> NullRNG(), LC_RNG, RandomPool, BlockingRng, NonblockingRng, AutoSeededRandomPool, AutoSeededX917RNG, \ref MersenneTwister "MersenneTwister (MT19937 and MT19937-AR)", RDRAND, RDSEED <dt>Key Derivation and Password-based Cryptography<dd> HKDF, \ref PKCS12_PBKDF "PBKDF (PKCS #12)", \ref PKCS5_PBKDF1 "PBKDF-1 (PKCS #5)", \ref PKCS5_PBKDF2_HMAC "PBKDF-2/HMAC (PKCS #5)" <dt>Public Key Cryptosystems<dd> DLIES, ECIES, LUCES, RSAES, RabinES, LUC_IES <dt>Public Key Signature Schemes<dd> DSA2, GDSA, ECDSA, NR, ECNR, LUCSS, RSASS, RSASS_ISO, RabinSS, RWSS, ESIGN <dt>Key Agreement<dd> DH, DH2, \ref MQV_Domain "MQV", \ref HMQV_Domain "HMQV", \ref FHMQV_Domain "FHMQV", ECDH, ECMQV, ECHMQV, ECFHMQV, XTR_DH <dt>Algebraic Structures<dd> Integer, PolynomialMod2, PolynomialOver, RingOfPolynomialsOver, ModularArithmetic, MontgomeryRepresentation, GFP2_ONB, GF2NP, GF256, GF2_32, EC2N, ECP <dt>Secret Sharing and Information Dispersal<dd> SecretSharing, SecretRecovery, InformationDispersal, InformationRecovery <dt>Compression<dd> Deflator, Inflator, Gzip, Gunzip, ZlibCompressor, ZlibDecompressor <dt>Input Source Classes<dd> StringSource, ArraySource, FileSource, SocketSource, WindowsPipeSource, RandomNumberSource <dt>Output Sink Classes<dd> StringSinkTemplate, StringSink, ArraySink, FileSink, SocketSink, WindowsPipeSink, RandomNumberSink <dt>Filter Wrappers<dd> StreamTransformationFilter, HashFilter, HashVerificationFilter, SignerFilter, SignatureVerificationFilter <dt>Binary to Text Encoders and Decoders<dd> HexEncoder, HexDecoder, Base64Encoder, Base64Decoder, Base64URLEncoder, Base64URLDecoder, Base32Encoder, Base32Decoder <dt>Wrappers for OS features<dd> Timer, Socket, WindowsHandle, ThreadLocalStorage, ThreadUserTimer <dt>FIPS 140 validated cryptography<dd> fips140.h </dl> In the DLL version of Crypto++, only the following implementation class are available. <dl> <dt>Block Ciphers<dd> AES, \ref DES_EDE2 "2-key Triple-DES", \ref DES_EDE3 "3-key Triple-DES", SKIPJACK <dt>Cipher Modes (replace template parameter BC with one of the block ciphers above)<dd> \ref ECB_Mode "ECB_Mode<BC>", \ref CTR_Mode "CTR_Mode<BC>", \ref CBC_Mode "CBC_Mode<BC>", \ref CFB_FIPS_Mode "CFB_FIPS_Mode<BC>", \ref OFB_Mode "OFB_Mode<BC>", \ref GCM "GCM<AES>" <dt>Hash Functions<dd> SHA1, SHA224, SHA256, SHA384, SHA512 <dt>Public Key Signature Schemes (replace template parameter H with one of the hash functions above)<dd> RSASS\<PKCS1v15, H\>, RSASS\<PSS, H\>, RSASS_ISO\<H\>, RWSS\<P1363_EMSA2, H\>, DSA, ECDSA\<ECP, H\>, ECDSA\<EC2N, H\> <dt>Message Authentication Codes (replace template parameter H with one of the hash functions above)<dd> HMAC\<H\>, CBC_MAC\<DES_EDE2\>, CBC_MAC\<DES_EDE3\>, GCM\<AES\> <dt>Random Number Generators<dd> DefaultAutoSeededRNG (AutoSeededX917RNG\<AES\>) <dt>Key Agreement<dd> DH, DH2 <dt>Public Key Cryptosystems<dd> RSAES\<OAEP\<SHA1\> \> </dl> <p>This reference manual is a work in progress. Some classes are lack detailed descriptions. <p>Click <a href="CryptoPPRef.zip">here</a> to download a zip archive containing this manual. <p>Thanks to Ryan Phillips for providing the Doxygen configuration file and getting us started on the manual. */ #ifndef CRYPTOPP_CRYPTLIB_H #define CRYPTOPP_CRYPTLIB_H #include "config.h" #include "stdcpp.h" #include "trap.h" #if defined(CRYPTOPP_BSD_AVAILABLE) || defined(CRYPTOPP_UNIX_AVAILABLE) # include <signal.h> #endif #if CRYPTOPP_MSC_VERSION # pragma warning(push) # pragma warning(disable: 4127 4189 4702) #endif NAMESPACE_BEGIN(CryptoPP) // forward declarations class Integer; class RandomNumberGenerator; class BufferedTransformation; //! \brief Specifies a direction for a cipher to operate //! \sa BlockTransformation::IsForwardTransformation(), BlockTransformation::IsPermutation(), BlockTransformation::GetCipherDirection() enum CipherDir { //! \brief the cipher is performing encryption ENCRYPTION, //! \brief the cipher is performing decryption DECRYPTION}; //! \brief Represents infinite time const unsigned long INFINITE_TIME = ULONG_MAX; // VC60 workaround: using enums as template parameters causes problems //! \brief Converts a typename to an enumerated value template <typename ENUM_TYPE, int VALUE> struct EnumToType { static ENUM_TYPE ToEnum() {return (ENUM_TYPE)VALUE;} }; //! \brief Provides the byte ordering //! \details Big-endian and little-endian modes are supported. Bi-endian and PDP-endian modes //! are not supported. enum ByteOrder { //! \brief byte order is little-endian LITTLE_ENDIAN_ORDER = 0, //! \brief byte order is big-endian BIG_ENDIAN_ORDER = 1}; //! \brief Provides a constant for LittleEndian typedef EnumToType<ByteOrder, LITTLE_ENDIAN_ORDER> LittleEndian; //! \brief Provides a constant for BigEndian typedef EnumToType<ByteOrder, BIG_ENDIAN_ORDER> BigEndian; //! \class Exception //! \brief Base class for all exceptions thrown by the library //! \details All library exceptions directly or indirectly inherit from the Exception class. //! The Exception class itself inherits from std::exception. The library does not use //! std::runtime_error derived classes. class CRYPTOPP_DLL Exception : public std::exception { public: //! \enum ErrorType //! \brief Error types or categories enum ErrorType { //! \brief A method was called which was not implemented NOT_IMPLEMENTED, //! \brief An invalid argument was detected INVALID_ARGUMENT, //! \brief BufferedTransformation received a Flush(true) signal but can't flush buffers CANNOT_FLUSH, //! \brief Data integerity check, such as CRC or MAC, failed DATA_INTEGRITY_CHECK_FAILED, //! \brief Input data was received that did not conform to expected format INVALID_DATA_FORMAT, //! \brief Error reading from input device or writing to output device IO_ERROR, //! \brief Some other error occurred not belonging to other categories OTHER_ERROR }; //! \brief Construct a new Exception explicit Exception(ErrorType errorType, const std::string &s) : m_errorType(errorType), m_what(s) {} virtual ~Exception() throw() {} //! \brief Retrieves a C-string describing the exception const char *what() const throw() {return (m_what.c_str());} //! \brief Retrieves a string describing the exception const std::string &GetWhat() const {return m_what;} //! \brief Sets the error string for the exception void SetWhat(const std::string &s) {m_what = s;} //! \brief Retrieves the error type for the exception