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