Crypto++ 8.6 Free C++ class library of cryptographic schemes

argnames.h
Go to the documentation of this file.
1 // argnames.h - originally written and placed in the public domain by Wei Dai
2
3 /// \file argnames.h
4 /// \brief Standard names for retrieving values by name when working with \p NameValuePairs
5
6 #ifndef CRYPTOPP_ARGNAMES_H
7 #define CRYPTOPP_ARGNAMES_H
8
9 #include "cryptlib.h"
10
11 NAMESPACE_BEGIN(CryptoPP)
12
13 DOCUMENTED_NAMESPACE_BEGIN(Name)
14
15 #define CRYPTOPP_DEFINE_NAME_STRING(name) inline const char *name() {return #name;}
16
17 CRYPTOPP_DEFINE_NAME_STRING(ValueNames) ///< string, a list of value names with a semicolon (';') after each name
18 CRYPTOPP_DEFINE_NAME_STRING(Version) ///< int
19 CRYPTOPP_DEFINE_NAME_STRING(Seed) ///< ConstByteArrayParameter
20 CRYPTOPP_DEFINE_NAME_STRING(Key) ///< ConstByteArrayParameter
21 CRYPTOPP_DEFINE_NAME_STRING(IV) ///< ConstByteArrayParameter, also accepts const byte * for backwards compatibility
22 CRYPTOPP_DEFINE_NAME_STRING(StolenIV) ///< byte *
23 CRYPTOPP_DEFINE_NAME_STRING(Nonce) ///< ConstByteArrayParameter
24 CRYPTOPP_DEFINE_NAME_STRING(Rounds) ///< int
25 CRYPTOPP_DEFINE_NAME_STRING(FeedbackSize) ///< int
26 CRYPTOPP_DEFINE_NAME_STRING(WordSize) ///< int, in bytes
27 CRYPTOPP_DEFINE_NAME_STRING(BlockSize) ///< int, in bytes
28 CRYPTOPP_DEFINE_NAME_STRING(EffectiveKeyLength) ///< int, in bits
29 CRYPTOPP_DEFINE_NAME_STRING(KeySize) ///< int, in bits
30 CRYPTOPP_DEFINE_NAME_STRING(ModulusSize) ///< int, in bits
31 CRYPTOPP_DEFINE_NAME_STRING(SubgroupOrderSize) ///< int, in bits
32 CRYPTOPP_DEFINE_NAME_STRING(PrivateExponentSize)///< int, in bits
33 CRYPTOPP_DEFINE_NAME_STRING(Modulus) ///< Integer
34 CRYPTOPP_DEFINE_NAME_STRING(PublicExponent) ///< Integer
35 CRYPTOPP_DEFINE_NAME_STRING(PrivateExponent) ///< Integer
36 CRYPTOPP_DEFINE_NAME_STRING(PublicElement) ///< Integer
37 CRYPTOPP_DEFINE_NAME_STRING(SubgroupOrder) ///< Integer
38 CRYPTOPP_DEFINE_NAME_STRING(Cofactor) ///< Integer
39 CRYPTOPP_DEFINE_NAME_STRING(SubgroupGenerator) ///< Integer, ECP::Point, or EC2N::Point
40 CRYPTOPP_DEFINE_NAME_STRING(Curve) ///< ECP or EC2N
41 CRYPTOPP_DEFINE_NAME_STRING(GroupOID) ///< OID
42 CRYPTOPP_DEFINE_NAME_STRING(PointerToPrimeSelector) ///< const PrimeSelector *
43 CRYPTOPP_DEFINE_NAME_STRING(Prime1) ///< Integer
44 CRYPTOPP_DEFINE_NAME_STRING(Prime2) ///< Integer
45 CRYPTOPP_DEFINE_NAME_STRING(ModPrime1PrivateExponent) ///< Integer
46 CRYPTOPP_DEFINE_NAME_STRING(ModPrime2PrivateExponent) ///< Integer
47 CRYPTOPP_DEFINE_NAME_STRING(MultiplicativeInverseOfPrime2ModPrime1) ///< Integer
48 CRYPTOPP_DEFINE_NAME_STRING(QuadraticResidueModPrime1) ///< Integer
49 CRYPTOPP_DEFINE_NAME_STRING(QuadraticResidueModPrime2) ///< Integer
50 CRYPTOPP_DEFINE_NAME_STRING(PutMessage) ///< bool
51 CRYPTOPP_DEFINE_NAME_STRING(TruncatedDigestSize) ///< int
52 CRYPTOPP_DEFINE_NAME_STRING(BlockPaddingScheme) ///< StreamTransformationFilter::BlockPaddingScheme
53 CRYPTOPP_DEFINE_NAME_STRING(HashVerificationFilterFlags) ///< word32
54 CRYPTOPP_DEFINE_NAME_STRING(AuthenticatedDecryptionFilterFlags) ///< word32
55 CRYPTOPP_DEFINE_NAME_STRING(SignatureVerificationFilterFlags) ///< word32
56 CRYPTOPP_DEFINE_NAME_STRING(InputBuffer) ///< ConstByteArrayParameter
57 CRYPTOPP_DEFINE_NAME_STRING(OutputBuffer) ///< ByteArrayParameter
58 CRYPTOPP_DEFINE_NAME_STRING(InputFileName) ///< const char *
59 CRYPTOPP_DEFINE_NAME_STRING(InputFileNameWide) ///< const wchar_t *
60 CRYPTOPP_DEFINE_NAME_STRING(InputStreamPointer) ///< std::istream *
61 CRYPTOPP_DEFINE_NAME_STRING(InputBinaryMode) ///< bool
62 CRYPTOPP_DEFINE_NAME_STRING(OutputFileName) ///< const char *
63 CRYPTOPP_DEFINE_NAME_STRING(OutputFileNameWide) ///< const wchar_t *
64 CRYPTOPP_DEFINE_NAME_STRING(OutputStreamPointer) ///< std::ostream *
65 CRYPTOPP_DEFINE_NAME_STRING(OutputBinaryMode) ///< bool
66 CRYPTOPP_DEFINE_NAME_STRING(EncodingParameters) ///< ConstByteArrayParameter
67 CRYPTOPP_DEFINE_NAME_STRING(KeyDerivationParameters) ///< ConstByteArrayParameter
68 CRYPTOPP_DEFINE_NAME_STRING(Separator) ///< ConstByteArrayParameter
69 CRYPTOPP_DEFINE_NAME_STRING(Terminator) ///< ConstByteArrayParameter
70 CRYPTOPP_DEFINE_NAME_STRING(Uppercase) ///< bool
71 CRYPTOPP_DEFINE_NAME_STRING(GroupSize) ///< int
72 CRYPTOPP_DEFINE_NAME_STRING(Pad) ///< bool
73 CRYPTOPP_DEFINE_NAME_STRING(PaddingByte) ///< byte
74 CRYPTOPP_DEFINE_NAME_STRING(Log2Base) ///< int
75 CRYPTOPP_DEFINE_NAME_STRING(EncodingLookupArray) ///< const byte *
76 CRYPTOPP_DEFINE_NAME_STRING(DecodingLookupArray) ///< const byte *
77 CRYPTOPP_DEFINE_NAME_STRING(InsertLineBreaks) ///< bool
78 CRYPTOPP_DEFINE_NAME_STRING(MaxLineLength) ///< int
79 CRYPTOPP_DEFINE_NAME_STRING(DigestSize) ///< int, in bytes
80 CRYPTOPP_DEFINE_NAME_STRING(L1KeyLength) ///< int, in bytes
81 CRYPTOPP_DEFINE_NAME_STRING(TableSize) ///< int, in bytes
82 CRYPTOPP_DEFINE_NAME_STRING(Blinding) ///< bool, timing attack mitigations, ON by default
83 CRYPTOPP_DEFINE_NAME_STRING(DerivedKey) ///< ByteArrayParameter, key derivation, derived key
84 CRYPTOPP_DEFINE_NAME_STRING(DerivedKeyLength) ///< int, key derivation, derived key length in bytes
85 CRYPTOPP_DEFINE_NAME_STRING(Personalization) ///< ConstByteArrayParameter
86 CRYPTOPP_DEFINE_NAME_STRING(PersonalizationSize) ///< int, in bytes
87 CRYPTOPP_DEFINE_NAME_STRING(Salt) ///< ConstByteArrayParameter
88 CRYPTOPP_DEFINE_NAME_STRING(Tweak) ///< ConstByteArrayParameter
89 CRYPTOPP_DEFINE_NAME_STRING(SaltSize) ///< int, in bytes
90 CRYPTOPP_DEFINE_NAME_STRING(TreeMode) ///< byte
91 CRYPTOPP_DEFINE_NAME_STRING(FileName) ///< const char *
92 CRYPTOPP_DEFINE_NAME_STRING(FileTime) ///< int
93 CRYPTOPP_DEFINE_NAME_STRING(Comment) ///< const char *
94 CRYPTOPP_DEFINE_NAME_STRING(Identity) ///< ConstByteArrayParameter
95 DOCUMENTED_NAMESPACE_END
96
97 NAMESPACE_END
98
99 #endif
Name
Namespace containing value name definitions.
Definition: argnames.h:13
CryptoPP
Crypto++ library namespace.
cryptlib.h
Abstract base classes that provide a uniform interface to this library.