From a2828f6ae67c3d7294118a8144b1b2ec431237c4 Mon Sep 17 00:00:00 2001 From: weidai Date: Thu, 22 Jul 2004 00:51:57 +0000 Subject: fix documentation, fix PanamaMAC, fix algorithm names git-svn-id: svn://svn.code.sf.net/p/cryptopp/code/trunk/c5@186 57ff6487-cd31-0410-9ec3-f628ee90f5f0 --- cryptlib.h | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) (limited to 'cryptlib.h') diff --git a/cryptlib.h b/cryptlib.h index 401b50e..763b5de 100644 --- a/cryptlib.h +++ b/cryptlib.h @@ -4,20 +4,22 @@ classes that provide a uniform interface to this library. */ -/*! \mainpage Crypto++TM Library 5.2 Reference Manual +/*! \mainpage Crypto++TM Library 5.2.1 Reference Manual
Abstract Base Classes
cryptlib.h
Symmetric Ciphers
SymmetricCipherDocumentation
Hash Functions
- HAVAL, MD2, MD4, MD5, PanamaHash, RIPEMD160, SHA, SHA256, SHA384, SHA512, Tiger + HAVAL, MD2, MD4, MD5, PanamaHash, RIPEMD160, RIPEMD320, RIPEMD128, RIPEMD256, SHA, SHA256, SHA384, SHA512, Tiger, Whirlpool
Non-Cryptographic Checksums
CRC32, Adler32
Message Authentication Codes
- #MD5MAC, XMACC, HMAC, CBC_MAC, DMAC, PanamaMAC + #MD5MAC, XMACC, HMAC, CBC_MAC, DMAC, PanamaMAC, TTMAC
Random Number Generators
NullRNG(), LC_RNG, RandomPool, BlockingRng, NonblockingRng, AutoSeededRandomPool, AutoSeededX917RNG +
Password-based Cryptography
+ PasswordBasedKeyDerivationFunction
Public Key Cryptosystems
DLIES, ECIES, LUCES, RSAES, RabinES, LUC_IES
Public Key Signature Schemes
@@ -39,9 +41,9 @@
Filter Wrappers
StreamTransformationFilter, HashFilter, HashVerificationFilter, SignerFilter, SignatureVerificationFilter
Binary to Text Encoders and Decoders
- HexEncoder, HexDecoder, Base64Encoder, Base64Decoder + HexEncoder, HexDecoder, Base64Encoder, Base64Decoder, Base32Encoder, Base32Decoder
Wrappers for OS features
- Timer, Socket, WindowsHandle, ThreadLocalStorage + Timer, Socket, WindowsHandle, ThreadLocalStorage, ThreadUserTimer
FIPS 140 related
fips140.h
@@ -51,19 +53,19 @@ In the FIPS 140-2 validated DLL version of Crypto++, only the following implemen
Block Ciphers
AES, DES_EDE2, DES_EDE3, SKIPJACK
Cipher Modes (replace template parameter BC with one of the block ciphers above)
- ECB_Mode , CTR_Mode , CBC_Mode , CFB_Mode , OFB_Mode + ECB_Mode\, CTR_Mode\, CBC_Mode\, CFB_Mode\, OFB_Mode\
Hash Functions
SHA
Public Key Signature Schemes
- RSASSA , DSA, ECDSA , ECDSA + RSASS\, DSA, ECDSA\, ECDSA\
Message Authentication Codes
- HMAC , CBC_MAC , CBC_MAC + HMAC\, CBC_MAC\, CBC_MAC\
Random Number Generators
- AutoSeededX917RNG + AutoSeededX917RNG\
Key Agreement
#DH
Public Key Cryptosystems
- RSAES > + RSAES\ \>

This reference manual is a work in progress. Some classes are still lacking detailed descriptions. @@ -311,14 +313,14 @@ DOCUMENTED_NAMESPACE_BEGIN(Name) // more names defined in argnames.h DOCUMENTED_NAMESPACE_END -//! . +//! empty set of name-value pairs class CRYPTOPP_DLL NullNameValuePairs : public NameValuePairs { public: bool GetVoidValue(const char *name, const std::type_info &valueType, void *pValue) const {return false;} }; -//! . +//! _ extern CRYPTOPP_DLL const NullNameValuePairs g_nullNameValuePairs; // ******************************************************** @@ -578,7 +580,8 @@ protected: void ThrowIfInvalidTruncatedSize(unsigned int size) const; }; -//! . +typedef HashTransformation HashFunction; + template class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE SimpleKeyedTransformation : public T, public SimpleKeyingInterface { @@ -587,12 +590,11 @@ public: {SimpleKeyingInterface::ThrowIfInvalidKeyLength(*this, length);} }; -//! . -typedef HashTransformation HashFunction; #ifdef CRYPTOPP_DOXYGEN_PROCESSING -//! These objects usually should not be used directly. See BlockTransformation for more details. +//! interface for one direction (encryption or decryption) of a block cipher +/*! \note These objects usually should not be used directly. See BlockTransformation for more details. */ class BlockCipher : public BlockTransformation, public SimpleKeyingInterface {}; -//! interface for stream ciphers +//! interface for one direction (encryption or decryption) of a stream cipher or cipher mode class SymmetricCipher : public StreamTransformation, public SimpleKeyingInterface {}; //! interface for message authentication codes class MessageAuthenticationCode : public HashTransformation, public SimpleKeyingInterface {}; @@ -600,11 +602,11 @@ class MessageAuthenticationCode : public HashTransformation, public SimpleKeying typedef SimpleKeyedTransformation BlockCipher; typedef SimpleKeyedTransformation SymmetricCipher; typedef SimpleKeyedTransformation MessageAuthenticationCode; +#endif CRYPTOPP_DLL_TEMPLATE_CLASS SimpleKeyedTransformation; CRYPTOPP_DLL_TEMPLATE_CLASS SimpleKeyedTransformation; CRYPTOPP_DLL_TEMPLATE_CLASS SimpleKeyedTransformation; -#endif #ifdef CRYPTOPP_MAINTAIN_BACKWARDS_COMPATIBILITY typedef SymmetricCipher StreamCipher; @@ -882,7 +884,6 @@ public: //! \name NON-BLOCKING TRANSFER OF OUTPUT //@{ - //! . virtual unsigned int TransferTo2(BufferedTransformation &target, unsigned long &byteCount, const std::string &channel=NULL_CHANNEL, bool blocking=true) =0; virtual unsigned int CopyRangeTo2(BufferedTransformation &target, unsigned long &begin, unsigned long end=ULONG_MAX, const std::string &channel=NULL_CHANNEL, bool blocking=true) const =0; unsigned int TransferMessagesTo2(BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=NULL_CHANNEL, bool blocking=true); @@ -1140,7 +1141,7 @@ public: class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE PK_Encryptor : virtual public PK_CryptoSystem, public PublicKeyAlgorithm { public: - //! . + //! exception thrown when trying to encrypt plaintext of invalid length class CRYPTOPP_DLL InvalidPlaintextLength : public Exception { public: -- cgit v1.2.1