include/cryptopp/argnames.h

0001 // argnames.h - originally written and placed in the public domain by Wei Dai

0002
0003 /// \file argnames.h

0004 /// \brief Standard names for retrieving values by name when working with \p NameValuePairs

0005
0006 #ifndef CRYPTOPP_ARGNAMES_H
0007 #define CRYPTOPP_ARGNAMES_H
0008
0009 #include "cryptlib.h"
0010
0011 NAMESPACE_BEGIN(CryptoPP)
0012
0013 DOCUMENTED_NAMESPACE_BEGIN(Name)
0014
0015 #define CRYPTOPP_DEFINE_NAME_STRING(name)   inline const char *name() {return #name;}
0016
0017 CRYPTOPP_DEFINE_NAME_STRING(ValueNames)         ///< string, a list of value names with a semicolon (';') after each name

0018 CRYPTOPP_DEFINE_NAME_STRING(Version)            ///< int

0019 CRYPTOPP_DEFINE_NAME_STRING(Seed)               ///< ConstByteArrayParameter

0020 CRYPTOPP_DEFINE_NAME_STRING(Key)                ///< ConstByteArrayParameter

0021 CRYPTOPP_DEFINE_NAME_STRING(IV)                 ///< ConstByteArrayParameter, also accepts const byte * for backwards compatibility

0022 CRYPTOPP_DEFINE_NAME_STRING(StolenIV)           ///< byte *

0023 CRYPTOPP_DEFINE_NAME_STRING(Nonce)              ///< ConstByteArrayParameter

0024 CRYPTOPP_DEFINE_NAME_STRING(Rounds)             ///< int

0025 CRYPTOPP_DEFINE_NAME_STRING(FeedbackSize)       ///< int

0026 CRYPTOPP_DEFINE_NAME_STRING(WordSize)           ///< int, in bytes

0027 CRYPTOPP_DEFINE_NAME_STRING(BlockSize)          ///< int, in bytes

0028 CRYPTOPP_DEFINE_NAME_STRING(EffectiveKeyLength) ///< int, in bits

0029 CRYPTOPP_DEFINE_NAME_STRING(KeySize)            ///< int, in bits

0030 CRYPTOPP_DEFINE_NAME_STRING(ModulusSize)        ///< int, in bits

0031 CRYPTOPP_DEFINE_NAME_STRING(SubgroupOrderSize)  ///< int, in bits

0032 CRYPTOPP_DEFINE_NAME_STRING(PrivateExponentSize)///< int, in bits

0033 CRYPTOPP_DEFINE_NAME_STRING(Modulus)            ///< Integer

0034 CRYPTOPP_DEFINE_NAME_STRING(PublicExponent)     ///< Integer

0035 CRYPTOPP_DEFINE_NAME_STRING(PrivateExponent)    ///< Integer

0036 CRYPTOPP_DEFINE_NAME_STRING(PublicElement)      ///< Integer

0037 CRYPTOPP_DEFINE_NAME_STRING(SubgroupOrder)      ///< Integer

0038 CRYPTOPP_DEFINE_NAME_STRING(Cofactor)           ///< Integer

0039 CRYPTOPP_DEFINE_NAME_STRING(SubgroupGenerator)  ///< Integer, ECP::Point, or EC2N::Point

0040 CRYPTOPP_DEFINE_NAME_STRING(Curve)              ///< ECP or EC2N

0041 CRYPTOPP_DEFINE_NAME_STRING(GroupOID)           ///< OID

0042 CRYPTOPP_DEFINE_NAME_STRING(PointerToPrimeSelector)     ///< const PrimeSelector *

0043 CRYPTOPP_DEFINE_NAME_STRING(Prime1)             ///< Integer

0044 CRYPTOPP_DEFINE_NAME_STRING(Prime2)             ///< Integer

0045 CRYPTOPP_DEFINE_NAME_STRING(ModPrime1PrivateExponent)   ///< Integer

0046 CRYPTOPP_DEFINE_NAME_STRING(ModPrime2PrivateExponent)   ///< Integer

0047 CRYPTOPP_DEFINE_NAME_STRING(MultiplicativeInverseOfPrime2ModPrime1) ///< Integer

0048 CRYPTOPP_DEFINE_NAME_STRING(QuadraticResidueModPrime1)  ///< Integer

0049 CRYPTOPP_DEFINE_NAME_STRING(QuadraticResidueModPrime2)  ///< Integer

0050 CRYPTOPP_DEFINE_NAME_STRING(PutMessage)         ///< bool

0051 CRYPTOPP_DEFINE_NAME_STRING(TruncatedDigestSize)    ///< int

0052 CRYPTOPP_DEFINE_NAME_STRING(BlockPaddingScheme) ///< StreamTransformationFilter::BlockPaddingScheme

0053 CRYPTOPP_DEFINE_NAME_STRING(HashVerificationFilterFlags)        ///< word32

0054 CRYPTOPP_DEFINE_NAME_STRING(AuthenticatedDecryptionFilterFlags) ///< word32

0055 CRYPTOPP_DEFINE_NAME_STRING(SignatureVerificationFilterFlags)   ///< word32

0056 CRYPTOPP_DEFINE_NAME_STRING(InputBuffer)        ///< ConstByteArrayParameter

0057 CRYPTOPP_DEFINE_NAME_STRING(OutputBuffer)       ///< ByteArrayParameter

0058 CRYPTOPP_DEFINE_NAME_STRING(InputFileName)      ///< const char *

0059 CRYPTOPP_DEFINE_NAME_STRING(InputFileNameWide)  ///< const wchar_t *

0060 CRYPTOPP_DEFINE_NAME_STRING(InputStreamPointer) ///< std::istream *

0061 CRYPTOPP_DEFINE_NAME_STRING(InputBinaryMode)    ///< bool

0062 CRYPTOPP_DEFINE_NAME_STRING(OutputFileName)     ///< const char *

0063 CRYPTOPP_DEFINE_NAME_STRING(OutputFileNameWide) ///< const wchar_t *

0064 CRYPTOPP_DEFINE_NAME_STRING(OutputStreamPointer)    ///< std::ostream *

0065 CRYPTOPP_DEFINE_NAME_STRING(OutputBinaryMode)   ///< bool

0066 CRYPTOPP_DEFINE_NAME_STRING(EncodingParameters) ///< ConstByteArrayParameter

0067 CRYPTOPP_DEFINE_NAME_STRING(KeyDerivationParameters)    ///< ConstByteArrayParameter

0068 CRYPTOPP_DEFINE_NAME_STRING(Separator)          ///< ConstByteArrayParameter

0069 CRYPTOPP_DEFINE_NAME_STRING(Terminator)         ///< ConstByteArrayParameter

0070 CRYPTOPP_DEFINE_NAME_STRING(Uppercase)          ///< bool

0071 CRYPTOPP_DEFINE_NAME_STRING(GroupSize)          ///< int

0072 CRYPTOPP_DEFINE_NAME_STRING(Pad)                ///< bool

0073 CRYPTOPP_DEFINE_NAME_STRING(PaddingByte)        ///< byte

0074 CRYPTOPP_DEFINE_NAME_STRING(Log2Base)           ///< int

0075 CRYPTOPP_DEFINE_NAME_STRING(EncodingLookupArray)    ///< const byte *

0076 CRYPTOPP_DEFINE_NAME_STRING(DecodingLookupArray)    ///< const byte *

0077 CRYPTOPP_DEFINE_NAME_STRING(InsertLineBreaks)   ///< bool

0078 CRYPTOPP_DEFINE_NAME_STRING(MaxLineLength)      ///< int

0079 CRYPTOPP_DEFINE_NAME_STRING(DigestSize)         ///< int, in bytes

0080 CRYPTOPP_DEFINE_NAME_STRING(L1KeyLength)        ///< int, in bytes

0081 CRYPTOPP_DEFINE_NAME_STRING(TableSize)          ///< int, in bytes

0082 CRYPTOPP_DEFINE_NAME_STRING(Blinding)           ///< bool, timing attack mitigations, ON by default

0083 CRYPTOPP_DEFINE_NAME_STRING(DerivedKey)         ///< ByteArrayParameter, key derivation, derived key

0084 CRYPTOPP_DEFINE_NAME_STRING(DerivedKeyLength)   ///< int, key derivation, derived key length in bytes

0085 CRYPTOPP_DEFINE_NAME_STRING(Personalization)    ///< ConstByteArrayParameter

0086 CRYPTOPP_DEFINE_NAME_STRING(PersonalizationSize)    ///< int, in bytes

0087 CRYPTOPP_DEFINE_NAME_STRING(Salt)               ///< ConstByteArrayParameter

0088 CRYPTOPP_DEFINE_NAME_STRING(Tweak)              ///< ConstByteArrayParameter

0089 CRYPTOPP_DEFINE_NAME_STRING(SaltSize)           ///< int, in bytes

0090 CRYPTOPP_DEFINE_NAME_STRING(TreeMode)           ///< byte

0091 CRYPTOPP_DEFINE_NAME_STRING(FileName)           ///< const char *

0092 CRYPTOPP_DEFINE_NAME_STRING(FileTime)           ///< int

0093 CRYPTOPP_DEFINE_NAME_STRING(Comment)            ///< const char *

0094 CRYPTOPP_DEFINE_NAME_STRING(Identity)           ///< ConstByteArrayParameter

0095 DOCUMENTED_NAMESPACE_END
0096
0097 NAMESPACE_END
0098
0099 #endif