Crypto++  5.6.4
Free C++ class library of cryptographic schemes
argnames.h
Go to the documentation of this file.
1 // argnames.h - 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(Rounds) //!< int
24 CRYPTOPP_DEFINE_NAME_STRING(FeedbackSize) //!< int
25 CRYPTOPP_DEFINE_NAME_STRING(WordSize) //!< int, in bytes
26 CRYPTOPP_DEFINE_NAME_STRING(BlockSize) //!< int, in bytes
27 CRYPTOPP_DEFINE_NAME_STRING(EffectiveKeyLength) //!< int, in bits
28 CRYPTOPP_DEFINE_NAME_STRING(KeySize) //!< int, in bits
29 CRYPTOPP_DEFINE_NAME_STRING(ModulusSize) //!< int, in bits
30 CRYPTOPP_DEFINE_NAME_STRING(SubgroupOrderSize) //!< int, in bits
31 CRYPTOPP_DEFINE_NAME_STRING(PrivateExponentSize)//!< int, in bits
32 CRYPTOPP_DEFINE_NAME_STRING(Modulus) //!< Integer
33 CRYPTOPP_DEFINE_NAME_STRING(PublicExponent) //!< Integer
34 CRYPTOPP_DEFINE_NAME_STRING(PrivateExponent) //!< Integer
35 CRYPTOPP_DEFINE_NAME_STRING(PublicElement) //!< Integer
36 CRYPTOPP_DEFINE_NAME_STRING(SubgroupOrder) //!< Integer
37 CRYPTOPP_DEFINE_NAME_STRING(Cofactor) //!< Integer
38 CRYPTOPP_DEFINE_NAME_STRING(SubgroupGenerator) //!< Integer, ECP::Point, or EC2N::Point
39 CRYPTOPP_DEFINE_NAME_STRING(Curve) //!< ECP or EC2N
40 CRYPTOPP_DEFINE_NAME_STRING(GroupOID) //!< OID
41 CRYPTOPP_DEFINE_NAME_STRING(PointerToPrimeSelector) //!< const PrimeSelector *
42 CRYPTOPP_DEFINE_NAME_STRING(Prime1) //!< Integer
43 CRYPTOPP_DEFINE_NAME_STRING(Prime2) //!< Integer
44 CRYPTOPP_DEFINE_NAME_STRING(ModPrime1PrivateExponent) //!< Integer
45 CRYPTOPP_DEFINE_NAME_STRING(ModPrime2PrivateExponent) //!< Integer
46 CRYPTOPP_DEFINE_NAME_STRING(MultiplicativeInverseOfPrime2ModPrime1) //!< Integer
47 CRYPTOPP_DEFINE_NAME_STRING(QuadraticResidueModPrime1) //!< Integer
48 CRYPTOPP_DEFINE_NAME_STRING(QuadraticResidueModPrime2) //!< Integer
49 CRYPTOPP_DEFINE_NAME_STRING(PutMessage) //!< bool
50 CRYPTOPP_DEFINE_NAME_STRING(TruncatedDigestSize) //!< int
51 CRYPTOPP_DEFINE_NAME_STRING(BlockPaddingScheme) //!< StreamTransformationFilter::BlockPaddingScheme
52 CRYPTOPP_DEFINE_NAME_STRING(HashVerificationFilterFlags) //!< word32
53 CRYPTOPP_DEFINE_NAME_STRING(AuthenticatedDecryptionFilterFlags) //!< word32
54 CRYPTOPP_DEFINE_NAME_STRING(SignatureVerificationFilterFlags) //!< word32
55 CRYPTOPP_DEFINE_NAME_STRING(InputBuffer) //!< ConstByteArrayParameter
56 CRYPTOPP_DEFINE_NAME_STRING(OutputBuffer) //!< ByteArrayParameter
57 CRYPTOPP_DEFINE_NAME_STRING(InputFileName) //!< const char *
58 CRYPTOPP_DEFINE_NAME_STRING(InputFileNameWide) //!< const wchar_t *
59 CRYPTOPP_DEFINE_NAME_STRING(InputStreamPointer) //!< std::istream *
60 CRYPTOPP_DEFINE_NAME_STRING(InputBinaryMode) //!< bool
61 CRYPTOPP_DEFINE_NAME_STRING(OutputFileName) //!< const char *
62 CRYPTOPP_DEFINE_NAME_STRING(OutputFileNameWide) //!< const wchar_t *
63 CRYPTOPP_DEFINE_NAME_STRING(OutputStreamPointer) //!< std::ostream *
64 CRYPTOPP_DEFINE_NAME_STRING(OutputBinaryMode) //!< bool
65 CRYPTOPP_DEFINE_NAME_STRING(EncodingParameters) //!< ConstByteArrayParameter
66 CRYPTOPP_DEFINE_NAME_STRING(KeyDerivationParameters) //!< ConstByteArrayParameter
67 CRYPTOPP_DEFINE_NAME_STRING(Separator) //< ConstByteArrayParameter
68 CRYPTOPP_DEFINE_NAME_STRING(Terminator) //< ConstByteArrayParameter
69 CRYPTOPP_DEFINE_NAME_STRING(Uppercase) //< bool
70 CRYPTOPP_DEFINE_NAME_STRING(GroupSize) //< int
71 CRYPTOPP_DEFINE_NAME_STRING(Pad) //< bool
72 CRYPTOPP_DEFINE_NAME_STRING(PaddingByte) //< byte
73 CRYPTOPP_DEFINE_NAME_STRING(Log2Base) //< int
74 CRYPTOPP_DEFINE_NAME_STRING(EncodingLookupArray) //< const byte *
75 CRYPTOPP_DEFINE_NAME_STRING(DecodingLookupArray) //< const byte *
76 CRYPTOPP_DEFINE_NAME_STRING(InsertLineBreaks) //< bool
77 CRYPTOPP_DEFINE_NAME_STRING(MaxLineLength) //< int
78 CRYPTOPP_DEFINE_NAME_STRING(DigestSize) //!< int, in bytes
79 CRYPTOPP_DEFINE_NAME_STRING(L1KeyLength) //!< int, in bytes
80 CRYPTOPP_DEFINE_NAME_STRING(TableSize) //!< int, in bytes
81 CRYPTOPP_DEFINE_NAME_STRING(Blinding) //!< bool, timing attack mitigations, ON by default
82 CRYPTOPP_DEFINE_NAME_STRING(DerivedKey) //!< ByteArrayParameter, key derivation, derived key
83 CRYPTOPP_DEFINE_NAME_STRING(DerivedKeyLength) //!< int, key derivation, derived key length in bytes
84 CRYPTOPP_DEFINE_NAME_STRING(Personalization) //!< ConstByteArrayParameter
85 CRYPTOPP_DEFINE_NAME_STRING(PersonalizationSize) //!< int, in bytes
86 CRYPTOPP_DEFINE_NAME_STRING(Salt) //!< ConstByteArrayParameter
87 CRYPTOPP_DEFINE_NAME_STRING(Tweak) //!< ConstByteArrayParameter
88 CRYPTOPP_DEFINE_NAME_STRING(SaltSize) //!< int, in bytes
89 CRYPTOPP_DEFINE_NAME_STRING(TreeMode) //< byte
90 DOCUMENTED_NAMESPACE_END
91 
92 NAMESPACE_END
93 
94 #endif
const char * MultiplicativeInverseOfPrime2ModPrime1()
Integer.
Definition: argnames.h:46
const char * DigestSize()
int, in bytes
Definition: argnames.h:78
const char * FeedbackSize()
int
Definition: argnames.h:24
const char * InputFileNameWide()
const wchar_t *
Definition: argnames.h:58
const char * Rounds()
int
Definition: argnames.h:23
const char * Prime2()
Integer.
Definition: argnames.h:43
const char * HashVerificationFilterFlags()
word32
Definition: argnames.h:52
const char * DerivedKey()
ByteArrayParameter, key derivation, derived key.
Definition: argnames.h:82
const char * QuadraticResidueModPrime1()
Integer.
Definition: argnames.h:47
const char * AuthenticatedDecryptionFilterFlags()
word32
Definition: argnames.h:53
const char * DerivedKeyLength()
int, key derivation, derived key length in bytes
Definition: argnames.h:83
const char * SignatureVerificationFilterFlags()
word32
Definition: argnames.h:54
const char * BlockPaddingScheme()
StreamTransformationFilter::BlockPaddingScheme.
Definition: argnames.h:51
Abstract base classes that provide a uniform interface to this library.
const char * OutputStreamPointer()
std::ostream *
Definition: argnames.h:63
const char * WordSize()
int, in bytes
Definition: argnames.h:25
const char * InputFileName()
const char *
Definition: argnames.h:57
const char * PrivateExponent()
Integer.
Definition: argnames.h:34
const char * StolenIV()
byte *
Definition: argnames.h:22
const char * Prime1()
Integer.
Definition: argnames.h:42
const char * SubgroupOrderSize()
int, in bits
Definition: argnames.h:30
const char * InputStreamPointer()
std::istream *
Definition: argnames.h:59
const char * ValueNames()
string, a list of value names with a semicolon (';') after each name
Definition: argnames.h:17
const char * PersonalizationSize()
int, in bytes
Definition: argnames.h:85
const char * OutputBinaryMode()
bool
Definition: argnames.h:64
const char * QuadraticResidueModPrime2()
Integer.
Definition: argnames.h:48
const char * TableSize()
int, in bytes
Definition: argnames.h:80
const char * Blinding()
bool, timing attack mitigations, ON by default
Definition: argnames.h:81
const char * PublicExponent()
Integer.
Definition: argnames.h:33
const char * Version()
int
Definition: argnames.h:18
const char * EncodingParameters()
ConstByteArrayParameter.
Definition: argnames.h:65
const char * OutputFileName()
const char *
Definition: argnames.h:61
const char * ModPrime1PrivateExponent()
Integer.
Definition: argnames.h:44
const char * PutMessage()
bool
Definition: argnames.h:49
const char * GroupOID()
OID.
Definition: argnames.h:40
const char * Salt()
ConstByteArrayParameter.
Definition: argnames.h:86
const char * PrivateExponentSize()
int, in bits
Definition: argnames.h:31
const char * InputBuffer()
ConstByteArrayParameter.
Definition: argnames.h:55
const char * ModPrime2PrivateExponent()
Integer.
Definition: argnames.h:45
const char * Tweak()
ConstByteArrayParameter.
Definition: argnames.h:87
const char * SubgroupGenerator()
Integer, ECP::Point, or EC2N::Point.
Definition: argnames.h:38
const char * Seed()
ConstByteArrayParameter.
Definition: argnames.h:19
const char * Personalization()
ConstByteArrayParameter.
Definition: argnames.h:84
const char * BlockSize()
int, in bytes
Definition: argnames.h:26
const char * PointerToPrimeSelector()
const PrimeSelector *
Definition: argnames.h:41
const char * IV()
ConstByteArrayParameter, also accepts const byte * for backwards compatibility.
Definition: argnames.h:21
const char * OutputBuffer()
ByteArrayParameter.
Definition: argnames.h:56
const char * KeySize()
int, in bits
Definition: argnames.h:28
const char * Cofactor()
Integer.
Definition: argnames.h:37
const char * TruncatedDigestSize()
int
Definition: argnames.h:50
const char * Modulus()
Integer.
Definition: argnames.h:32
const char * L1KeyLength()
int, in bytes
Definition: argnames.h:79
const char * KeyDerivationParameters()
ConstByteArrayParameter.
Definition: argnames.h:66
Namespace containing value name definitions.
Definition: argnames.h:13
Crypto++ library namespace.
const char * ModulusSize()
int, in bits
Definition: argnames.h:29
const char * InputBinaryMode()
bool
Definition: argnames.h:60
const char * Curve()
ECP or EC2N.
Definition: argnames.h:39
const char * Key()
ConstByteArrayParameter.
Definition: argnames.h:20
const char * SaltSize()
int, in bytes
Definition: argnames.h:88
const char * SubgroupOrder()
Integer.
Definition: argnames.h:36
const char * PublicElement()
Integer.
Definition: argnames.h:35
const char * EffectiveKeyLength()
int, in bits
Definition: argnames.h:27
const char * OutputFileNameWide()
const wchar_t *
Definition: argnames.h:62