102 #ifndef CRYPTOPP_CRYPTLIB_H 103 #define CRYPTOPP_CRYPTLIB_H 109 #if CRYPTOPP_MSC_VERSION 110 # pragma warning(push) 111 # pragma warning(disable: 4127 4189 4505 4702) 134 template <
typename ENUM_TYPE,
int VALUE>
137 static ENUM_TYPE ToEnum() {
return static_cast<ENUM_TYPE
>(VALUE);}
186 const char *
what()
const throw() {
return (m_what.c_str());}
188 const std::string &
GetWhat()
const {
return m_what;}
190 void SetWhat(
const std::string &s) {m_what = s;}
263 OS_Error(
ErrorType errorType,
const std::string &s,
const std::string& operation,
int errorCode)
264 :
Exception(errorType, s), m_operation(operation), m_errorCode(errorCode) {}
272 std::string m_operation;
336 ValueTypeMismatch(
const std::string &name,
const std::type_info &stored,
const std::type_info &retrieving)
337 :
InvalidArgument(
"NameValuePairs: type mismatch for '" + name +
"', stored '" + stored.name() +
"', trying to retrieve '" + retrieving.name() +
"'")
338 , m_stored(stored), m_retrieving(retrieving) {}
349 const std::type_info &m_stored;
350 const std::type_info &m_retrieving;
359 return GetValue((std::string(
"ThisObject:")+
typeid(T).name()).c_str(),
object);
368 return GetValue((std::string(
"ThisPointer:")+
typeid(T).name()).c_str(), ptr);
381 return GetVoidValue(name,
typeid(T), &value);
395 bool result = GetValue(name, value);
397 if (result) {
return value;}
405 {std::string result; GetValue(
"ValueNames", result);
return result;}
416 {
return GetValue(name, value);}
425 {
return GetValueWithDefault(name, defaultValue);}
434 {
return GetValue(name, value);}
443 {
return GetValueWithDefault(name, defaultValue);}
454 CRYPTOPP_DLL
static void CRYPTOPP_API
ThrowIfTypeMismatch(
const char *name,
const std::type_info &stored,
const std::type_info &retrieving)
470 if (!GetValue(name, value))
471 throw InvalidArgument(std::string(className) +
": missing required parameter '" + name +
"'");
485 if (!GetIntValue(name, value))
486 throw InvalidArgument(std::string(className) +
": missing required parameter '" + name +
"'");
499 CRYPTOPP_DLL
virtual bool GetVoidValue(
const char *name,
const std::type_info &valueType,
void *pValue)
const =0;
503 #if CRYPTOPP_DOXYGEN_PROCESSING 538 #if CRYPTOPP_DOXYGEN_PROCESSING 546 DOCUMENTED_NAMESPACE_BEGIN(
Name)
548 DOCUMENTED_NAMESPACE_END
562 DOCUMENTED_NAMESPACE_BEGIN(
Weak)
564 DOCUMENTED_NAMESPACE_END
569 DOCUMENTED_NAMESPACE_BEGIN(
NaCl)
571 DOCUMENTED_NAMESPACE_END
576 DOCUMENTED_NAMESPACE_BEGIN(
Test)
578 DOCUMENTED_NAMESPACE_END
612 Algorithm(
bool checkSelfTestStatus =
true);
649 virtual size_t MinKeyLength()
const =0;
653 virtual size_t MaxKeyLength()
const =0;
657 virtual size_t DefaultKeyLength()
const =0;
667 virtual size_t GetValidKeyLength(
size_t keylength)
const =0;
674 {
return keylength == GetValidKeyLength(keylength);}
680 virtual void SetKey(
const byte *key,
size_t length,
const NameValuePairs ¶ms = g_nullNameValuePairs);
690 void SetKeyWithRounds(
const byte *key,
size_t length,
int rounds);
700 void SetKeyWithIV(
const byte *key,
size_t length,
const byte *iv,
size_t ivLength);
710 {SetKeyWithIV(key, length, iv, IVSize());}
763 {
throw NotImplemented(GetAlgorithm().AlgorithmName() +
": this object doesn't support resynchronization");}
785 CRYPTOPP_UNUSED(iv); CRYPTOPP_UNUSED(ivLength);
786 throw NotImplemented(GetAlgorithm().AlgorithmName() +
": this object doesn't support resynchronization");
803 virtual const Algorithm & GetAlgorithm()
const =0;
810 virtual void UncheckedSetKey(
const byte *key,
unsigned int length,
const NameValuePairs ¶ms) =0;
815 void ThrowIfInvalidKeyLength(
size_t length);
822 void ThrowIfResynchronizable();
831 void ThrowIfInvalidIV(
const byte *iv);
836 size_t ThrowIfInvalidIVLength(
int length);
843 const byte * GetIVAndThrowIfInvalid(
const NameValuePairs ¶ms,
size_t &size);
847 inline void AssertValidKeyLength(
size_t length)
const 870 virtual void ProcessAndXorBlock(
const byte *inBlock,
const byte *xorBlock, byte *outBlock)
const =0;
881 {ProcessAndXorBlock(inBlock, NULLPTR, outBlock);}
890 {ProcessAndXorBlock(inoutBlock, NULLPTR, inoutBlock);}
894 virtual unsigned int BlockSize()
const =0;
899 virtual unsigned int OptimalDataAlignment()
const;
908 virtual bool IsForwardTransformation()
const =0;
918 BT_InBlockIsCounter=1,
920 BT_DontIncrementInOutPointers=2,
924 BT_ReverseDirection=8,
926 BT_AllowParallel=16};
936 virtual size_t AdvancedProcessBlocks(
const byte *inBlocks,
const byte *xorBlocks, byte *outBlocks,
size_t length, word32 flags)
const;
982 virtual unsigned int OptimalDataAlignment()
const;
991 virtual void ProcessData(byte *outString,
const byte *inString,
size_t length) =0;
1005 virtual size_t ProcessLastBlock(byte *outString,
size_t outLength,
const byte *inString,
size_t inLength);
1062 {ProcessData(inoutString, inoutString, length);}
1070 {ProcessData(outString, inString, length);}
1076 {ProcessData(&input, &input, 1);
return input;}
1080 virtual bool IsRandomAccess()
const =0;
1089 CRYPTOPP_UNUSED(pos);
1091 throw NotImplemented(
"StreamTransformation: this object doesn't support random access");
1098 virtual bool IsSelfInverting()
const =0;
1103 virtual bool IsForwardTransformation()
const =0;
1126 virtual void Update(
const byte *input,
size_t length) =0;
1149 {TruncatedFinal(NULLPTR, 0);}
1178 virtual unsigned int OptimalDataAlignment()
const;
1190 {Update(input, length); Final(digest);}
1202 {
return TruncatedVerify(digest,
DigestSize());}
1217 virtual bool VerifyDigest(
const byte *digest,
const byte *input,
size_t length)
1218 {Update(input, length);
return Verify(digest);}
1225 virtual void TruncatedFinal(byte *digest,
size_t digestSize) =0;
1238 {Update(input, length); TruncatedFinal(digest, digestSize);}
1250 virtual bool TruncatedVerify(
const byte *digest,
size_t digestLength);
1267 {Update(input, length);
return TruncatedVerify(digest, digestLength);}
1274 void ThrowIfInvalidTruncatedSize(
size_t size)
const;
1282 const Algorithm & GetAlgorithm()
const {
return *
this;}
1290 const Algorithm & GetAlgorithm()
const {
return *
this;}
1298 const Algorithm & GetAlgorithm()
const {
return *
this;}
1328 explicit BadState(
const std::string &name,
const char *message) :
Exception(OTHER_ERROR, name +
": " + message) {}
1329 explicit BadState(
const std::string &name,
const char *
function,
const char *state) :
Exception(OTHER_ERROR, name +
": " +
function +
" was called before " + state) {}
1334 virtual lword MaxHeaderLength()
const =0;
1338 virtual lword MaxMessageLength()
const =0;
1360 void SpecifyDataLengths(lword headerLength, lword messageLength, lword footerLength=0);
1374 virtual void EncryptAndAuthenticate(byte *ciphertext, byte *mac,
size_t macSize,
const byte *iv,
int ivLength,
const byte *header,
size_t headerLength,
const byte *message,
size_t messageLength);
1391 virtual bool DecryptAndVerify(byte *message,
const byte *mac,
size_t macSize,
const byte *iv,
int ivLength,
const byte *header,
size_t headerLength,
const byte *ciphertext,
size_t ciphertextLength);
1398 virtual std::string AlgorithmName()
const;
1403 virtual void UncheckedSpecifyDataLengths(lword headerLength, lword messageLength, lword footerLength)
1404 {CRYPTOPP_UNUSED(headerLength); CRYPTOPP_UNUSED(messageLength); CRYPTOPP_UNUSED(footerLength);}
1429 CRYPTOPP_UNUSED(input); CRYPTOPP_UNUSED(length);
1430 throw NotImplemented(
"RandomNumberGenerator: IncorporateEntropy not implemented");
1442 virtual byte GenerateByte();
1449 virtual unsigned int GenerateBit();
1459 virtual word32 GenerateWord32(word32 min=0, word32 max=0xffffffffUL);
1468 virtual void GenerateBlock(byte *output,
size_t size);
1480 virtual void GenerateIntoBufferedTransformation(
BufferedTransformation &target,
const std::string &channel, lword length);
1484 virtual void DiscardBytes(
size_t n);
1490 template <
class IT>
void Shuffle(IT begin, IT end)
1493 for (; begin != end; ++begin)
1494 std::iter_swap(begin, begin + GenerateWord32(0, static_cast<word32>(end-begin-1)));
1509 virtual std::string AlgorithmName()
const =0;
1513 virtual size_t MinDerivedKeyLength()
const;
1517 virtual size_t MaxDerivedKeyLength()
const;
1522 virtual size_t GetValidDerivedLength(
size_t keylength)
const =0;
1529 return keylength == GetValidDerivedLength(keylength);
1545 virtual size_t DeriveKey(byte *derived,
size_t derivedLen,
const byte *secret,
size_t secretLen,
const NameValuePairs& params = g_nullNameValuePairs)
const =0;
1556 virtual const Algorithm & GetAlgorithm()
const =0;
1561 void ThrowIfInvalidDerivedKeyLength(
size_t length)
const;
1578 class WaitObjectContainer;
1589 virtual unsigned int GetMaxWaitObjectCount()
const =0;
1599 virtual void GetWaitObjects(WaitObjectContainer &container, CallStack
const& callStack) =0;
1605 bool Wait(
unsigned long milliseconds, CallStack
const& callStack);
1653 size_t Put(byte inByte,
bool blocking=
true)
1654 {
return Put(&inByte, 1, blocking);}
1663 size_t Put(
const byte *inString,
size_t length,
bool blocking=
true)
1664 {
return Put2(inString, length, 0, blocking);}
1701 {size=0;
return NULLPTR;}
1716 {
return PutModifiable2(inString, length, 0, blocking);}
1724 {
return !!Put2(NULLPTR, 0, propagation < 0 ? -1 : propagation+1, blocking);}
1737 size_t PutMessageEnd(
const byte *inString,
size_t length,
int propagation=-1,
bool blocking=
true)
1738 {
return Put2(inString, length, propagation < 0 ? -1 : propagation+1, blocking);}
1748 virtual size_t Put2(
const byte *inString,
size_t length,
int messageEnd,
bool blocking) =0;
1758 virtual size_t PutModifiable2(byte *inString,
size_t length,
int messageEnd,
bool blocking)
1759 {
return Put2(inString, length, messageEnd, blocking);}
1770 unsigned int GetMaxWaitObjectCount()
const;
1780 void GetWaitObjects(WaitObjectContainer &container, CallStack
const& callStack);
1797 CRYPTOPP_UNUSED(parameters);
1798 throw NotImplemented(
"BufferedTransformation: this object can't be reinitialized");
1805 virtual bool IsolatedFlush(
bool hardFlush,
bool blocking) =0;
1811 {CRYPTOPP_UNUSED(blocking);
return false;}
1821 virtual void Initialize(
const NameValuePairs ¶meters=g_nullNameValuePairs,
int propagation=-1);
1842 virtual bool Flush(
bool hardFlush,
int propagation=-1,
bool blocking=
true);
1852 virtual bool MessageSeriesEnd(
int propagation=-1,
bool blocking=
true);
1859 {CRYPTOPP_UNUSED(propagation);}
1874 virtual lword MaxRetrievable()
const;
1878 virtual bool AnyRetrievable()
const;
1884 virtual size_t Get(byte &outByte);
1891 virtual size_t Get(byte *outString,
size_t getMax);
1898 virtual size_t Peek(byte &outByte)
const;
1906 virtual size_t Peek(byte *outString,
size_t peekMax)
const;
1965 {TransferTo2(target, transferMax, channel);
return transferMax;}
1978 virtual lword Skip(lword skipMax=LWORD_MAX);
1990 {
return CopyRangeTo(target, 0, copyMax, channel);}
2003 {lword i = position; CopyRangeTo2(target, i, i+copyMax, channel);
return i-position;}
2011 virtual lword TotalBytesRetrievable()
const;
2017 virtual unsigned int NumberOfMessages()
const;
2022 virtual bool AnyMessages()
const;
2028 virtual bool GetNextMessage();
2035 virtual unsigned int SkipMessages(
unsigned int count=UINT_MAX);
2047 {TransferMessagesTo2(target, count, channel);
return count;}
2061 virtual void SkipAll();
2069 {TransferAllTo2(target, channel);}
2169 size_t ChannelPut(
const std::string &channel, byte inByte,
bool blocking=
true)
2170 {
return ChannelPut(channel, &inByte, 1, blocking);}
2179 size_t ChannelPut(
const std::string &channel,
const byte *inString,
size_t length,
bool blocking=
true)
2180 {
return ChannelPut2(channel, inString, length, 0, blocking);}
2190 {
return ChannelPutModifiable2(channel, inString, length, 0, blocking);}
2199 size_t ChannelPutWord16(
const std::string &channel, word16 value,
ByteOrder order=
BIG_ENDIAN_ORDER,
bool blocking=
true);
2208 size_t ChannelPutWord32(
const std::string &channel, word32 value,
ByteOrder order=
BIG_ENDIAN_ORDER,
bool blocking=
true);
2217 size_t ChannelPutWord64(
const std::string &channel, word64 value,
ByteOrder order=
BIG_ENDIAN_ORDER,
bool blocking=
true);
2228 {
return !!ChannelPut2(channel, NULLPTR, 0, propagation < 0 ? -1 : propagation+1, blocking);}
2239 size_t ChannelPutMessageEnd(
const std::string &channel,
const byte *inString,
size_t length,
int propagation=-1,
bool blocking=
true)
2240 {
return ChannelPut2(channel, inString, length, propagation < 0 ? -1 : propagation+1, blocking);}
2253 virtual byte * ChannelCreatePutSpace(
const std::string &channel,
size_t &size);
2262 virtual size_t ChannelPut2(
const std::string &channel,
const byte *inString,
size_t length,
int messageEnd,
bool blocking);
2271 virtual size_t ChannelPutModifiable2(
const std::string &channel, byte *inString,
size_t length,
int messageEnd,
bool blocking);
2281 virtual bool ChannelFlush(
const std::string &channel,
bool hardFlush,
int propagation=-1,
bool blocking=
true);
2292 virtual bool ChannelMessageSeriesEnd(
const std::string &channel,
int propagation=-1,
bool blocking=
true);
2297 virtual void SetRetrievalChannel(
const std::string &channel);
2332 throw NotImplemented(
"BufferedTransformation: this object is not attachable");
2343 static int DecrementPropagation(
int propagation)
2344 {
return propagation != 0 ? propagation - 1 : 0;}
2402 {
if (!Validate(rng, level))
throw InvalidMaterial(
"CryptoMaterial: this object contains invalid values");}
2414 {CRYPTOPP_UNUSED(bt);
throw NotImplemented(
"CryptoMaterial: this object does not support saving");}
2431 {CRYPTOPP_UNUSED(bt);
throw NotImplemented(
"CryptoMaterial: this object does not support loading");}
2447 CRYPTOPP_UNUSED(precomputationStorage);
CRYPTOPP_ASSERT(!SupportsPrecomputation());
2448 throw NotImplemented(
"CryptoMaterial: this object does not support precomputation");
2456 {CRYPTOPP_UNUSED(storedPrecomputation);
CRYPTOPP_ASSERT(!SupportsPrecomputation());
throw NotImplemented(
"CryptoMaterial: this object does not support precomputation");}
2463 {CRYPTOPP_UNUSED(storedPrecomputation);
CRYPTOPP_ASSERT(!SupportsPrecomputation());
throw NotImplemented(
"CryptoMaterial: this object does not support precomputation");}
2469 #if defined(__SUNPRO_CC) 2474 char m_sunCCworkaround;
2495 CRYPTOPP_UNUSED(rng); CRYPTOPP_UNUSED(params);
2496 throw NotImplemented(
"GeneratableCryptoMaterial: this object does not support key/parameter generation");
2552 {AccessMaterial().
Load(bt);}
2559 {GetMaterial().Save(bt);}
2574 {
return AccessPublicKey();}
2578 {
return GetPublicKey();}
2582 virtual PublicKey & AccessPublicKey() =0;
2604 virtual PrivateKey & AccessPrivateKey() =0;
2625 virtual CryptoParameters & AccessCryptoParameters() =0;
2642 virtual size_t MaxPlaintextLength(
size_t ciphertextLength)
const =0;
2647 virtual size_t CiphertextLength(
size_t plaintextLength)
const =0;
2654 virtual bool ParameterSupported(
const char *name)
const =0;
2692 const byte *plaintext,
size_t plaintextLength,
2693 byte *ciphertext,
const NameValuePairs ¶meters = g_nullNameValuePairs)
const =0;
2726 const byte *ciphertext,
size_t ciphertextLength,
2727 byte *plaintext,
const NameValuePairs ¶meters = g_nullNameValuePairs)
const =0;
2752 {
return Decrypt(rng, ciphertext, FixedCiphertextLength(), plaintext, parameters);}
2784 virtual size_t SignatureLength()
const =0;
2792 {CRYPTOPP_UNUSED(recoverablePartLength);
return SignatureLength();}
2798 virtual size_t MaxRecoverableLength()
const =0;
2806 virtual size_t MaxRecoverableLengthFromSignatureLength(
size_t signatureLength)
const =0;
2812 virtual bool IsProbabilistic()
const =0;
2816 virtual bool AllowNonrecoverablePart()
const =0;
2828 virtual bool RecoverablePartFirst()
const =0;
2839 {
throw NotImplemented(
"PK_MessageAccumulator: DigestSize() should not be called");}
2844 CRYPTOPP_UNUSED(digest); CRYPTOPP_UNUSED(digestSize);
2845 throw NotImplemented(
"PK_MessageAccumulator: TruncatedFinal() should not be called");
2866 virtual void InputRecoverableMessage(
PK_MessageAccumulator &messageAccumulator,
const byte *recoverableMessage,
size_t recoverableMessageLength)
const =0;
2893 virtual size_t SignMessage(
RandomNumberGenerator &rng,
const byte *message,
size_t messageLen, byte *signature)
const;
2904 virtual size_t SignMessageWithRecovery(
RandomNumberGenerator &rng,
const byte *recoverableMessage,
size_t recoverableMessageLength,
2905 const byte *nonrecoverableMessage,
size_t nonrecoverableMessageLength, byte *signature)
const;
2929 virtual void InputSignature(
PK_MessageAccumulator &messageAccumulator,
const byte *signature,
size_t signatureLength)
const =0;
2949 virtual bool VerifyMessage(
const byte *message,
size_t messageLen,
2950 const byte *signature,
size_t signatureLen)
const;
2977 const byte *nonrecoverableMessage,
size_t nonrecoverableMessageLength,
2978 const byte *signature,
size_t signatureLength)
const;
2993 virtual unsigned int AgreedValueLength()
const =0;
2997 virtual unsigned int PrivateKeyLength()
const =0;
3001 virtual unsigned int PublicKeyLength()
const =0;
3014 virtual void GeneratePublicKey(
RandomNumberGenerator &rng,
const byte *privateKey, byte *publicKey)
const =0;
3037 virtual bool Agree(byte *agreedValue,
const byte *privateKey,
const byte *otherPublicKey,
bool validateOtherPublicKey=
true)
const =0;
3052 virtual unsigned int AgreedValueLength()
const =0;
3056 virtual unsigned int StaticPrivateKeyLength()
const =0;
3060 virtual unsigned int StaticPublicKeyLength()
const =0;
3073 virtual void GenerateStaticPublicKey(
RandomNumberGenerator &rng,
const byte *privateKey, byte *publicKey)
const =0;
3082 virtual void GenerateStaticKeyPair(
RandomNumberGenerator &rng, byte *privateKey, byte *publicKey)
const;
3086 virtual unsigned int EphemeralPrivateKeyLength()
const =0;
3090 virtual unsigned int EphemeralPublicKeyLength()
const =0;
3103 virtual void GenerateEphemeralPublicKey(
RandomNumberGenerator &rng,
const byte *privateKey, byte *publicKey)
const =0;
3110 virtual void GenerateEphemeralKeyPair(
RandomNumberGenerator &rng, byte *privateKey, byte *publicKey)
const;
3128 virtual bool Agree(byte *agreedValue,
3129 const byte *staticPrivateKey,
const byte *ephemeralPrivateKey,
3130 const byte *staticOtherPublicKey,
const byte *ephemeralOtherPublicKey,
3131 bool validateStaticOtherPublicKey=
true)
const =0;
3157 class ProtocolSession
3164 ProtocolError(ErrorType errorType,
const std::string &s) :
Exception(errorType, s) {}
3169 class UnexpectedMethodCall :
public Exception 3172 UnexpectedMethodCall(
const std::string &s) :
Exception(OTHER_ERROR, s) {}
3175 virtual ~ProtocolSession() {}
3177 ProtocolSession() : m_rng(NULLPTR), m_throwOnProtocolError(
true), m_validState(
false) {}
3181 bool GetThrowOnProtocolError()
const {
return m_throwOnProtocolError;}
3182 void SetThrowOnProtocolError(
bool throwOnProtocolError) {m_throwOnProtocolError = throwOnProtocolError;}
3184 bool HasValidState()
const {
return m_validState;}
3186 virtual bool OutgoingMessageAvailable()
const =0;
3187 virtual unsigned int GetOutgoingMessageLength()
const =0;
3188 virtual void GetOutgoingMessage(byte *message) =0;
3190 virtual bool LastMessageProcessed()
const =0;
3191 virtual void ProcessIncomingMessage(
const byte *message,
unsigned int messageLength) =0;
3195 void CheckAndHandleInvalidState()
const;
3196 void SetValidState(
bool valid) {m_validState = valid;}
3201 bool m_throwOnProtocolError, m_validState;
3204 class KeyAgreementSession :
public ProtocolSession
3207 virtual ~KeyAgreementSession() {}
3209 virtual unsigned int GetAgreedValueLength()
const =0;
3210 virtual void GetAgreedValue(byte *agreedValue)
const =0;
3213 class PasswordAuthenticatedKeyAgreementSession :
public KeyAgreementSession
3216 virtual ~PasswordAuthenticatedKeyAgreementSession() {}
3219 const byte *myId,
unsigned int myIdLength,
3220 const byte *counterPartyId,
unsigned int counterPartyIdLength,
3221 const byte *passwordOrVerifier,
unsigned int passwordOrVerifierLength);
3229 virtual ~PasswordAuthenticatedKeyAgreementDomain() {}
3233 {
return GetCryptoParameters().Validate(rng, 2);}
3235 virtual unsigned int GetPasswordVerifierLength(
const byte *password,
unsigned int passwordLength)
const =0;
3236 virtual void GeneratePasswordVerifier(
RandomNumberGenerator &rng,
const byte *userId,
unsigned int userIdLength,
const byte *password,
unsigned int passwordLength, byte *verifier)
const =0;
3238 enum RoleFlags {CLIENT=1, SERVER=2, INITIATOR=4, RESPONDER=8};
3240 virtual bool IsValidRole(
unsigned int role) =0;
3241 virtual PasswordAuthenticatedKeyAgreementSession * CreateProtocolSession(
unsigned int role)
const =0;
3345 return CRYPTOPP_VERSION;
3351 #if CRYPTOPP_MSC_VERSION 3352 # pragma warning(pop)
Base class for all exceptions thrown by the library.
int HeaderVersion()
Specifies the runtime version of the library.
Exception thrown when invalid crypto material is detected.
virtual void Precompute(unsigned int precomputationStorage)
Perform precomputation.
the cipher is performing decryption
const char * DigestSize()
int, in bytes
An invalid argument was detected.
void SetKeyWithIV(const byte *key, size_t length, const byte *iv)
Sets or reset the key of this object.
virtual bool IsValidDerivedLength(size_t keylength) const
Returns whether keylength is a valid key length.
Interface for message authentication codes.
ErrorType
Error types or categories.
NotImplemented(const std::string &s)
Construct an NotImplemented.
CRYPTOPP_DLL int GetIntValueWithDefault(const char *name, int defaultValue) const
Get a named value with type int, with default.
Interface for asymmetric algorithms.
virtual unsigned int MinIVLength() const
Provides the minimum size of an IV.
Namespace containing NaCl library functions.
virtual bool NeedsPrespecifiedDataLengths() const
Determines if data lengths must be specified prior to inputting data.
Interface for public-key encryptors and decryptors.
ByteOrder
Provides the byte ordering.
const char * what() const
Retrieves a C-string describing the exception.
virtual void ThrowIfInvalid(RandomNumberGenerator &rng, unsigned int level) const
Check this object for errors.
The IV is set by the object.
The operating system reported an error.
Interface for authenticated encryption modes of operation.
T GetValueWithDefault(const char *name, T defaultValue) const
Get a named value.
const std::type_info & GetStoredTypeInfo() const
Provides the stored type.
virtual void Load(BufferedTransformation &bt)
Loads a key from a BufferedTransformation.
Exception(ErrorType errorType, const std::string &s)
Construct a new Exception.
Exception thrown when the object is in the wrong state for the operation.
const CryptoMaterial & GetMaterial() const
Retrieves a reference to Crypto Parameters.
CRYPTOPP_DLL std::string GetValueNames() const
Get a list of value names that can be retrieved.
Interface for public-key signers.
Interface for public-key encryptors.
Converts an enumeration to a type suitable for use as a template parameter.
bool GetThisObject(T &object) const
Get a copy of this object or subobject.
bool CanUseRandomIVs() const
Determines if the object can use random IVs.
CipherDir
Specifies a direction for a cipher to operate.
CRYPTOPP_DLL bool GetWord64Value(const char *name, word64 &value) const
Get a named value with type word64.
DecodingResult FixedLengthDecrypt(RandomNumberGenerator &rng, const byte *ciphertext, byte *plaintext, const NameValuePairs ¶meters=g_nullNameValuePairs) const
Decrypt a fixed size ciphertext.
Flush(true) was called but it can't completely flush its buffers.
Thrown when an unexpected type is encountered.
CryptoMaterial & AccessMaterial()
Retrieves a reference to a Private Key.
Interface for asymmetric algorithms using private keys.
ValueTypeMismatch(const std::string &name, const std::type_info &stored, const std::type_info &retrieving)
Construct a ValueTypeMismatch.
virtual Clonable * Clone() const
Copies this object.
EnumToType< ByteOrder, LITTLE_ENDIAN_ORDER > LittleEndian
Provides a constant for LittleEndian.
Library configuration file.
Interface for random number generators.
size_t messageLength
Recovered message length if isValidCoding is true, undefined otherwise.
virtual const PublicKey & GetPublicKey() const
Retrieves a reference to a Public Key.
CRYPTOPP_DLL void GetRequiredIntParameter(const char *className, const char *name, int &value) const
Retrieves a required name/value pair.
OS_Error(ErrorType errorType, const std::string &s, const std::string &operation, int errorCode)
Construct an OS_Error.
Interface for private keys.
Interface for cloning objects.
virtual size_t FixedCiphertextLength() const
Provides the fixed ciphertext length, if one exists.
bool operator==(const OID &lhs, const OID &rhs)
Compare two OIDs for equality.
Data integerity check, such as CRC or MAC, failed.
byte order is little-endian
Interface for one direction (encryption or decryption) of a block cipher.
CRYPTOPP_DLL RandomNumberGenerator &CRYPTOPP_API NullRNG()
Random Number Generator that does not produce random numbers.
virtual std::string AlgorithmProvider() const
Retrieve the provider of this algorithm.
void SetWhat(const std::string &s)
Sets the error string for the exception.
Interface for objects that can be waited on.
the cipher is performing encryption
virtual void SavePrecomputation(BufferedTransformation &storedPrecomputation) const
Save precomputation for later use.
const std::type_info & GetRetrievingTypeInfo() const
Provides the retrieveing type.
void DoQuickSanityCheck() const
Perform a quick sanity check.
Interface for domains of simple key agreement protocols.
const CryptoMaterial & GetMaterial() const
Retrieves a reference to a Private Key.
bool CanUsePredictableIVs() const
Determines if the object can use random but possibly predictable IVs.
Returns a decoding results.
virtual void LoadPrecomputation(BufferedTransformation &storedPrecomputation)
Retrieve previously saved precomputation.
Exception thrown when trying to encrypt plaintext of invalid length.
Input data was received that did not conform to expected format.
Interface for public-key decryptors.
A method was called which was not implemented.
Exception throw when the private or public key is too short to sign or verify.
const std::string DEFAULT_CHANNEL
Default channel for BufferedTransformation.
bool operator!=(const DecodingResult &rhs) const
Compare two DecodingResult.
virtual unsigned int MaxIVLength() const
Provides the maximum size of an IV.
unsigned int DigestSize() const
virtual bool IsValidKeyLength(size_t keylength) const
Returns whether keylength is a valid key length.
CRYPTOPP_DLL word64 GetWord64ValueWithDefault(const char *name, word64 defaultValue) const
Get a named value with type word64, with default.
Interface for encoding and decoding ASN1 objects.
virtual void Resynchronize(const byte *iv, int ivLength=-1)
Resynchronize with an IV.
DecodingResult()
Constructs a DecodingResult.
Interface for one direction (encryption or decryption) of a stream cipher or cipher mode...
Multiple precision integer with arithmetic operations.
DecodingResult(size_t len)
Constructs a DecodingResult.
Exception throw when the private or public key has a length that can't be used.
Interface for algorithms that take byte strings as keys.
bool operator==(const DecodingResult &rhs) const
Compare two DecodingResult.
CannotFlush(const std::string &s)
Construct an CannotFlush.
Interface for asymmetric algorithms using public keys.
virtual unsigned int IVSize() const
Returns length of the IV accepted by this object.
const NameValuePairs & g_nullNameValuePairs
An empty set of name-value pairs.
Namespace containing testing and benchmark classes.
virtual bool CanIncorporateEntropy() const
Determines if a generator can accept additional entropy.
bool CanUseStructuredIVs() const
Determines if the object can use structured IVs.
Interface for public-key signers and verifiers.
const std::string & GetOperation() const
Retrieve the operating system API that reported the error.
virtual std::string AlgorithmName() const
Provides the name of this algorithm.
#define CRYPTOPP_ASSERT(exp)
Debugging and diagnostic assertion.
int GetErrorCode() const
Retrieve the error code returned by the operating system.
const char * BlockSize()
int, in bytes
const unsigned long INFINITE_TIME
Represents infinite time.
ErrorType GetErrorType() const
Retrieves the error type for the exception.
void GetRequiredParameter(const char *className, const char *name, T &value) const
Retrieves a required name/value pair.
CRYPTOPP_DLL bool GetIntValue(const char *name, int &value) const
Get a named value with type int.
Interface for all crypto algorithms.
Interface for accumulating messages to be signed or verified.
unsigned int DefaultIVLength() const
Provides the default size of an IV.
A decryption filter encountered invalid ciphertext.
Interface for key agreement algorithms.
IV_Requirement
Secure IVs requirements as enumerated values.
CryptoMaterial & AccessMaterial()
Retrieves a reference to a Public Key.
virtual const CryptoParameters & GetCryptoParameters() const
Retrieves a reference to Crypto Parameters.
Interface for public-key signature verifiers.
void Shuffle(IT begin, IT end)
Randomly shuffle the specified array.
Debugging and diagnostic assertions.
InvalidArgument(const std::string &s)
Construct an InvalidArgument.
Interface for crypto material.
Interface for certificates.
virtual void GenerateRandom(RandomNumberGenerator &rng, const NameValuePairs ¶ms=g_nullNameValuePairs)
Generate a random key or crypto parameters.
Interface for password based key derivation functions.
CryptoMaterial & AccessMaterial()
Retrieves a reference to Crypto Parameters.
An invalid argument was detected.
Interface for crypto material.
Interface for crypto prameters.
bool GetThisPointer(T *&ptr) const
Get a pointer to this object.
CRYPTOPP_DLL BufferedTransformation & TheBitBucket()
An input discarding BufferedTransformation.
bool isValidCoding
Flag to indicate the decoding is valid.
Namespace containing value name definitions.
BufferedTransformation received a Flush(true) signal but can't flush buffers.
void SetErrorType(ErrorType errorType)
Sets the error type for the exceptions.
int LibraryVersion(...)
Specifies the build-time version of the library.
Interface for public keys.
Crypto++ library namespace.
bool GetValue(const char *name, T &value) const
Get a named value.
The IV must be random and unpredictable.
bool IsResynchronizable() const
Determines if the object can be resynchronized.
Interface for domains of authenticated key agreement protocols.
void TruncatedFinal(byte *digest, size_t digestSize)
A method was called which was not implemented.
const std::string AAD_CHANNEL
Channel for additional authenticated data.
virtual void BEREncode(BufferedTransformation &bt) const
Encode this object into a BufferedTransformation.
Error reading from input device or writing to output device.
virtual void Save(BufferedTransformation &bt) const
Saves a key to a BufferedTransformation.
virtual bool SupportsPrecomputation() const
Determines whether the object supports precomputation.
virtual lword MaxFooterLength() const
Provides the the maximum length of AAD.
virtual const PrivateKey & GetPrivateKey() const
Retrieves a reference to a Private Key.
const CryptoMaterial & GetMaterial() const
Retrieves a reference to a Public Key.
virtual size_t MaxSignatureLength(size_t recoverablePartLength=0) const
Provides the maximum signature length produced given the length of the recoverable message part...
static CRYPTOPP_DLL void CRYPTOPP_API ThrowIfTypeMismatch(const char *name, const std::type_info &stored, const std::type_info &retrieving)
Ensures an expected name and type is present.
EnumToType< ByteOrder, BIG_ENDIAN_ORDER > BigEndian
Provides a constant for BigEndian.
Namespace containing weak and wounded algorithms.
virtual bool SignatureUpfront() const
Determines whether the signature must be input before the message.
virtual void IncorporateEntropy(const byte *input, size_t length)
Update RNG state with additional unpredictable values.
InvalidCiphertext(const std::string &s)
Construct an InvalidCiphertext.
Interface for key derivation functions.
virtual size_t FixedMaxPlaintextLength() const
Provides the maximum plaintext length given a fixed ciphertext length.
Interface for retrieving values given their names.
Exception thrown when an ASN.1 BER decoing error is encountered.
The IV must be random and possibly predictable.
const std::string & GetWhat() const
Retrieves a string describing the exception.
