Crypto++
5.6.4
Free C++ class library of cryptographic schemes
|
6 #if CRYPTOPP_MSC_VERSION
7 # pragma warning(disable: 4127 4189 4459)
10 #if CRYPTOPP_GCC_DIAGNOSTIC_AVAILABLE
11 # pragma GCC diagnostic ignored "-Wunused-value"
12 # pragma GCC diagnostic ignored "-Wunused-variable"
13 # pragma GCC diagnostic ignored "-Wunused-parameter"
16 #ifndef CRYPTOPP_IMPORTS
31 #if (defined(__CYGWIN__) || defined(__CYGWIN32__)) && defined(PREFER_WINDOWS_STYLE_SOCKETS)
32 # error Cygwin does not support Windows style sockets. See http://www.cygwin.com/faq.html#faq.api.winsock
36 #define HAVE_GCC_INIT_PRIORITY (__GNUC__ && (CRYPTOPP_INIT_PRIORITY > 0) && !(MACPORTS_GCC_COMPILER > 0))
37 #define HAVE_MSC_INIT_PRIORITY (_MSC_VER && (CRYPTOPP_INIT_PRIORITY > 0))
45 #ifdef CRYPTOPP_NATIVE_DWORD_AVAILABLE
49 #if HAVE_GCC_INIT_PRIORITY
51 const std::string
DEFAULT_CHANNEL __attribute__ ((init_priority (CRYPTOPP_INIT_PRIORITY + 25))) =
"";
52 const std::string
AAD_CHANNEL __attribute__ ((init_priority (CRYPTOPP_INIT_PRIORITY + 26))) =
"AAD";
53 const std::string &BufferedTransformation::NULL_CHANNEL =
DEFAULT_CHANNEL;
54 #elif HAVE_MSC_INIT_PRIORITY
55 #pragma warning(disable: 4073)
59 const std::string &BufferedTransformation::NULL_CHANNEL =
DEFAULT_CHANNEL;
60 #pragma warning(default: 4073)
62 static const std::string s1(
""), s2(
"AAD");
65 const std::string &BufferedTransformation::NULL_CHANNEL =
DEFAULT_CHANNEL;
71 bool GetVoidValue(
const char *name,
const std::type_info &valueType,
void *pValue)
const
72 {CRYPTOPP_UNUSED(name); CRYPTOPP_UNUSED(valueType); CRYPTOPP_UNUSED(pValue);
return false;}
75 #if HAVE_GCC_INIT_PRIORITY
94 throw SelfTestFailure(
"Cryptographic algorithms are disabled before the power-up self tests are performed.");
97 throw SelfTestFailure(
"Cryptographic algorithms are disabled after a power-up self test failed.");
103 this->ThrowIfInvalidKeyLength(length);
104 this->UncheckedSetKey(key, (
unsigned int)length, params);
117 void SimpleKeyingInterface::ThrowIfInvalidKeyLength(
size_t length)
123 void SimpleKeyingInterface::ThrowIfResynchronizable()
126 throw InvalidArgument(GetAlgorithm().AlgorithmName() +
": this object requires an IV");
129 void SimpleKeyingInterface::ThrowIfInvalidIV(
const byte *iv)
132 throw InvalidArgument(GetAlgorithm().AlgorithmName() +
": this object cannot use a null IV");
135 size_t SimpleKeyingInterface::ThrowIfInvalidIVLength(
int size)
147 const byte * SimpleKeyingInterface::GetIVAndThrowIfInvalid(
const NameValuePairs ¶ms,
size_t &size)
153 try {found = params.
GetValue(Name::IV(), ivWithLength);}
158 iv = ivWithLength.
begin();
159 ThrowIfInvalidIV(iv);
160 size = ThrowIfInvalidIVLength((
int)ivWithLength.
size());
163 else if (params.
GetValue(Name::IV(), iv))
165 ThrowIfInvalidIV(iv);
171 ThrowIfResynchronizable();
190 size_t xorIncrement = xorBlocks ? blockSize : 0;
195 assert(length % blockSize == 0);
196 inBlocks += length - blockSize;
197 xorBlocks += length - blockSize;
198 outBlocks += length - blockSize;
199 inIncrement = 0-inIncrement;
200 xorIncrement = 0-xorIncrement;
201 outIncrement = 0-outIncrement;
204 while (length >= blockSize)
206 if (flags & BT_XorInput)
210 #if defined(__COVERITY__)
213 xorbuf(outBlocks, xorBlocks, inBlocks, blockSize);
223 const_cast<byte *
>(inBlocks)[blockSize-1]++;
224 inBlocks += inIncrement;
225 outBlocks += outIncrement;
226 xorBlocks += xorIncrement;
235 return GetAlignmentOf<word32>();
240 return GetAlignmentOf<word32>();
245 return GetAlignmentOf<word32>();
254 else if (length != 0)
269 UncheckedSpecifyDataLengths(headerLength, messageLength, footerLength);
276 Update(header, headerLength);
285 Update(header, headerLength);
304 const word32 range = max-min;
312 value =
Crop(value, maxBits);
313 }
while (value > range);
332 CRYPTOPP_UNUSED(output), CRYPTOPP_UNUSED(size);
336 throw NotImplemented(
"RandomNumberGenerator: GenerateBlock not implemented");
355 size_t rem = target.
ChannelPut(channel, buffer, len);
356 CRYPTOPP_UNUSED(rem); assert(rem == 0);
373 #if defined(CRYPTOPP_DOXYGEN_PROCESSING)
385 CRYPTOPP_UNUSED(output); CRYPTOPP_UNUSED(size);
386 throw NotImplemented(
"NullRNG: NullRNG should only be passed to functions that don't need to generate random bytes");
389 #if defined(CRYPTOPP_DOXYGEN_PROCESSING)
402 Clonable* Clone ()
const {
return NULL; }
414 ThrowIfInvalidTruncatedSize(digestLength);
420 void HashTransformation::ThrowIfInvalidTruncatedSize(
size_t size)
const
441 CRYPTOPP_UNUSED(propagation);
448 CRYPTOPP_UNUSED(propagation);
455 CRYPTOPP_UNUSED(propagation);
471 return Put2(begin, length, messageEnd, blocking);
481 return ChannelPut2(channel, begin, length, messageEnd, blocking);
487 return Flush(completeFlush, propagation, blocking);
524 return Get(&outByte, 1);
543 return Peek(&outByte, 1);
553 return (
size_t)
CopyTo(arraySink, peekMax);
614 unsigned int maxMessages = messageCount;
615 for (messageCount=0; messageCount < maxMessages &&
AnyMessages(); messageCount++)
618 lword transferredBytes;
622 transferredBytes = LWORD_MAX;
623 blockedBytes =
TransferTo2(target, transferredBytes, channel, blocking);
624 if (blockedBytes > 0)
632 CRYPTOPP_UNUSED(result); assert(result);
665 unsigned int messageCount;
668 messageCount = UINT_MAX;
673 while (messageCount != 0);
678 byteCount = ULONG_MAX;
679 size_t blockedBytes =
TransferTo2(target, byteCount, channel, blocking);
683 while (byteCount != 0);
708 PutWord(
false, order, m_buf, value);
709 return ChannelPut(channel, m_buf, 2, blocking);
714 PutWord(
false, order, m_buf, value);
715 return ChannelPut(channel, m_buf, 4, blocking);
730 byte buf[2] = {0, 0};
731 size_t len =
Peek(buf, 2);
734 value = (buf[0] << 8) | buf[1];
736 value = (buf[1] << 8) | buf[0];
743 byte buf[4] = {0, 0, 0, 0};
744 size_t len =
Peek(buf, 4);
747 value = (buf[0] << 24) | (buf[1] << 16) | (buf[2] << 8) | buf [3];
749 value = (buf[3] << 24) | (buf[2] << 16) | (buf[1] << 8) | buf [0];
781 : m_rng(rng), m_encryptor(encryptor), m_parameters(parameters)
786 size_t Put2(
const byte *inString,
size_t length,
int messageEnd,
bool blocking)
789 m_plaintextQueue.
Put(inString, length);
794 size_t plaintextLength;
795 if (!
SafeConvert(m_plaintextQueue.CurrentSize(), plaintextLength))
796 throw InvalidArgument(
"PK_DefaultEncryptionFilter: plaintext too long");
800 m_plaintextQueue.
Get(plaintext, plaintextLength);
801 m_ciphertext.
resize(ciphertextLength);
802 m_encryptor.
Encrypt(m_rng, plaintext, plaintextLength, m_ciphertext, m_parameters);
805 FILTER_OUTPUT(1, m_ciphertext, m_ciphertext.
size(), messageEnd);
807 FILTER_END_NO_MESSAGE_END;
826 : m_rng(rng), m_decryptor(decryptor), m_parameters(parameters)
831 size_t Put2(
const byte *inString,
size_t length,
int messageEnd,
bool blocking)
834 m_ciphertextQueue.
Put(inString, length);
839 size_t ciphertextLength;
840 if (!
SafeConvert(m_ciphertextQueue.CurrentSize(), ciphertextLength))
841 throw InvalidArgument(
"PK_DefaultDecryptionFilter: ciphertext too long");
845 m_ciphertextQueue.
Get(ciphertext, ciphertextLength);
846 m_plaintext.
resize(maxPlaintextLength);
847 m_result = m_decryptor.
Decrypt(m_rng, ciphertext, ciphertextLength, m_plaintext, m_parameters);
852 FILTER_OUTPUT(1, m_plaintext, m_result.
messageLength, messageEnd);
854 FILTER_END_NO_MESSAGE_END;
879 m->
Update(message, messageLen);
884 const byte *nonrecoverableMessage,
size_t nonrecoverableMessageLength,
byte *signature)
const
888 m->
Update(nonrecoverableMessage, nonrecoverableMessageLength);
902 m->
Update(message, messageLen);
913 const byte *nonrecoverableMessage,
size_t nonrecoverableMessageLength,
914 const byte *signature,
size_t signatureLength)
const
918 m->
Update(nonrecoverableMessage, nonrecoverableMessageLength);
virtual void GenerateIntoBufferedTransformation(BufferedTransformation &target, const std::string &channel, lword length)
Generate random bytes into a BufferedTransformation.
Interface for public-key encryptors.
Random Number Generator that does not produce random numbers.
virtual lword MaxHeaderLength() const =0
Provides the maximum length of AAD that can be input.
Algorithm(bool checkSelfTestStatus=true)
Interface for all crypto algorithms.
@ UNPREDICTABLE_RANDOM_IV
The IV must be random and unpredictable.
size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing.
virtual DecodingResult RecoverMessage(byte *recoveredMessage, const byte *nonrecoverableMessage, size_t nonrecoverableMessageLength, const byte *signature, size_t signatureLength) const
Recover a message from its signature.
size_t size() const
Length of the memory block.
void xorbuf(byte *buf, const byte *mask, size_t count)
Performs an XOR of a buffer with a mask.
bool CanIncorporateEntropy() const
An implementation that returns false.
AlgorithmParameters MakeParameters(const char *name, const T &value, bool throwIfNotUsed=true)
Create an object that implements NameValuePairs.
virtual std::string AlgorithmName() const
Provides the name of this algorithm.
A method was called which was not implemented.
virtual void GenerateStaticKeyPair(RandomNumberGenerator &rng, byte *privateKey, byte *publicKey) const
Generate a static private/public key pair.
void GenerateIntoBufferedTransformation(BufferedTransformation &target, const std::string &channel, lword length)
An implementation that throws NotImplemented.
virtual void GenerateKeyPair(RandomNumberGenerator &rng, byte *privateKey, byte *publicKey) const
Generate a private/public key pair.
virtual bool Verify(PK_MessageAccumulator *messageAccumulator) const
Check whether messageAccumulator contains a valid signature and message.
virtual BufferedTransformation * CreateDecryptionFilter(RandomNumberGenerator &rng, BufferedTransformation *attachment=NULL, const NameValuePairs ¶meters=g_nullNameValuePairs) const
Create a new decryption filter.
virtual void DiscardBytes(size_t n)
Generate and discard n bytes.
Data structure used to store byte strings.
virtual std::string AlgorithmName() const =0
Provides the name of this algorithm.
virtual BufferedTransformation * CreateEncryptionFilter(RandomNumberGenerator &rng, BufferedTransformation *attachment=NULL, const NameValuePairs ¶meters=g_nullNameValuePairs) const
Create a new encryption filter.
void DiscardBytes(size_t n)
An implementation that does nothing.
virtual IV_Requirement IVRequirement() const =0
Minimal requirement for secure IVs.
Classes and functions for secure memory allocations.
Interface for cloning objects.
virtual unsigned int MaxIVLength() const
Provides the maximum size of an IV.
virtual size_t MaxPlaintextLength(size_t ciphertextLength) const =0
Provides the maximum length of plaintext for a given ciphertext length.
const T1 UnsignedMin(const T1 &a, const T2 &b)
Safe comparison of values that could be neagtive and incorrectly promoted.
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)
Encrypts and calculates a MAC in one call.
Classes for automatic resource management.
Interface for public-key decryptors.
const std::string DEFAULT_CHANNEL
Default channel for BufferedTransformation.
Acts as an input discarding Filter or Sink.
bool SafeConvert(T1 from, T2 &to)
Tests whether a conversion from -> to is safe to perform.
#define CRYPTOPP_COMPILE_ASSERT(expr)
Compile time assertion.
bool FIPS_140_2_ComplianceEnabled()
Determines whether the library provides FIPS validated cryptography.
bool GetVoidValue(const char *name, const std::type_info &valueType, void *pValue) const
Get a named value.
virtual void GenerateBlock(byte *output, size_t size)
Generate random array of bytes.
byte GenerateByte()
An implementation that throws NotImplemented.
const std::string AAD_CHANNEL
Channel for additional authenticated data.
virtual bool IsValidKeyLength(size_t keylength) const
Returns whether keylength is a valid key length.
Implementation of BufferedTransformation's attachment interface.
Interface for random number generators.
void resize(size_type newSize)
Change size and preserve contents.
Standard names for retrieving values by name when working with NameValuePairs.
size_t messageLength
Recovered message length if isValidCoding is true, undefined otherwise.
virtual void Resynchronize(const byte *iv, int ivLength=-1)
Resynchronize with an IV.
Thrown when an unexpected type is encountered.
Classes and functions for the FIPS 140-2 validated library.
unsigned int GenerateBit()
An implementation that throws NotImplemented.
Utility functions for the Crypto++ library.
virtual size_t SignMessage(RandomNumberGenerator &rng, const byte *message, size_t messageLen, byte *signature) const
Sign a message.
RandomNumberGenerator & NullRNG()
Random Number Generator that does not produce random numbers.
@ POWER_UP_SELF_TEST_FAILED
The self tests were executed via DoPowerUpSelfTest() or DoDllPowerUpSelfTest(), but the result was fa...
bool VerifyBufsEqual(const byte *buf1, const byte *buf2, size_t count)
Performs a near constant-time comparison of two equally sized buffers.
virtual unsigned int GenerateBit()
Generate new random bit and return it.
Copy input to a memory buffer.
PowerUpSelfTestStatus GetPowerUpSelfTestStatus()
Provides the current power-up self test status.
std::string IntToString(T value, unsigned int base=10)
Converts a value to a string.
Interface for accumulating messages to be signed or verified.
Returns a decoding results.
virtual DecodingResult Decrypt(RandomNumberGenerator &rng, const byte *ciphertext, size_t ciphertextLength, byte *plaintext, const NameValuePairs ¶meters=g_nullNameValuePairs) const =0
Decrypt a byte string.
bool IsResynchronizable() const
Determines if the object can be resynchronized.
virtual PK_MessageAccumulator * NewSignatureAccumulator(RandomNumberGenerator &rng) const =0
Create a new HashTransformation to accumulate the message to be signed.
virtual void GenerateEphemeralKeyPair(RandomNumberGenerator &rng, byte *privateKey, byte *publicKey) const
Generate private/public key pair.
virtual unsigned int IVSize() const
Returns length of the IV accepted by this object.
Base class for unflushable filters.
ByteOrder
Provides the byte ordering.
virtual void InputRecoverableMessage(PK_MessageAccumulator &messageAccumulator, const byte *recoverableMessage, size_t recoverableMessageLength) const =0
Input a recoverable message to an accumulator.
void Detach(BufferedTransformation *newAttachment=NULL)
Replace an attached transformation.
void IncorporateEntropy(const byte *input, size_t length)
An implementation that throws NotImplemented.
std::string AlgorithmName() const
The name of the generator.
void Shuffle(IT begin, IT end)
An implementation that does nothing.
void SetKeyWithRounds(const byte *key, size_t length, int rounds)
Sets or reset the key of this object.
virtual word32 GenerateWord32(word32 min=0, word32 max=0xffffffffUL)
Generate a random 32 bit word in the range min to max, inclusive.
virtual void Encrypt(RandomNumberGenerator &rng, const byte *plaintext, size_t plaintextLength, byte *ciphertext, const NameValuePairs ¶meters=g_nullNameValuePairs) const =0
Encrypt a byte string.
unsigned int BitPrecision(const T &value)
Returns the number of bits required for a value.
virtual PK_MessageAccumulator * NewVerificationAccumulator() const =0
Create a new HashTransformation to accumulate the message to be verified.
size_type size() const
Provides the count of elements in the SecBlock.
virtual void GenerateRandom(RandomNumberGenerator &rng, const NameValuePairs ¶ms=g_nullNameValuePairs)
Generate a random key or crypto parameters.
void GenerateRandomWithKeySize(RandomNumberGenerator &rng, unsigned int keySize)
Generate a random key or crypto parameters.
virtual void GetNextIV(RandomNumberGenerator &rng, byte *iv)
Retrieves a secure IV for the next message.
virtual void GeneratePublicKey(RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const =0
Generate a public key from a private key in this domain.
An invalid argument was detected.
const byte * begin() const
Pointer to the first byte in the memory block.
virtual void GenerateStaticPrivateKey(RandomNumberGenerator &rng, byte *privateKey) const =0
Generate static private key in this domain.
virtual unsigned int MinIVLength() const
Provides the minimum size of an IV.
void SpecifyDataLengths(lword headerLength, lword messageLength, lword footerLength=0)
Prespecifies the data lengths.
Manages resources for a single object.
BufferedTransformation & TheBitBucket()
An input discarding BufferedTransformation.
const NameValuePairs & g_nullNameValuePairs
An empty set of name-value pairs.
T Crop(T value, size_t bits)
Truncates the value to the specified number of bits.
Crypto++ library namespace.
virtual size_t CiphertextLength(size_t plaintextLength) const =0
Calculate the length of ciphertext given length of plaintext.
virtual lword MaxFooterLength() const
Provides the the maximum length of AAD.
virtual void GenerateEphemeralPublicKey(RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const =0
Generate ephemeral public key.
virtual lword MaxMessageLength() const =0
Provides the maximum length of encrypted data.
bool GetValue(const char *name, T &value) const
Get a named value.
void SetKeyWithIV(const byte *key, size_t length, const byte *iv, size_t ivLength)
Sets or reset the key of this object.
virtual bool VerifyMessage(const byte *message, size_t messageLen, const byte *signature, size_t signatureLen) const
Check whether input signature is a valid signature for input message.
Classes for access to the operating system's random number generators.
size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
Input multiple bytes for processing.
Library configuration file.
virtual bool VerifyAndRestart(PK_MessageAccumulator &messageAccumulator) const =0
Check whether messageAccumulator contains a valid signature and message, and restart messageAccumulat...
virtual void SetKey(const byte *key, size_t length, const NameValuePairs ¶ms=g_nullNameValuePairs)
Sets or reset the key of this object.
word32 GenerateWord32(word32 min, word32 max)
An implementation that throws NotImplemented.
@ POWER_UP_SELF_TEST_NOT_DONE
The self tests have not been performed.
bool isValidCoding
Flag to indicate the decoding is valid.
virtual void GenerateStaticPublicKey(RandomNumberGenerator &rng, const byte *privateKey, byte *publicKey) const =0
Generate a static public key from a private key in this domain.
Exception thrown when an invalid key length is encountered.
virtual bool DecryptAndVerify(byte *message, const byte *mac, size_t macLength, const byte *iv, int ivLength, const byte *header, size_t headerLength, const byte *ciphertext, size_t ciphertextLength)
Decrypts and verifies a MAC in one call.
virtual DecodingResult Recover(byte *recoveredMessage, PK_MessageAccumulator *messageAccumulator) const
Recover a message from its signature.
virtual void InputSignature(PK_MessageAccumulator &messageAccumulator, const byte *signature, size_t signatureLength) const =0
Input signature into a message accumulator.
size_t Get(byte &outByte)
Retrieve a 8-bit byte.
virtual DecodingResult RecoverAndRestart(byte *recoveredMessage, PK_MessageAccumulator &messageAccumulator) const =0
Recover a message from its signature.
container of wait objects
virtual byte GenerateByte()
Generate new random byte and return it.
virtual void GenerateEphemeralPrivateKey(RandomNumberGenerator &rng, byte *privateKey) const =0
Generate ephemeral private key.
Interface for retrieving values given their names.
Abstract base classes that provide a uniform interface to this library.
virtual void GeneratePrivateKey(RandomNumberGenerator &rng, byte *privateKey) const =0
Generate private key in this domain.
Used to pass byte array input as part of a NameValuePairs object.
Classes for working with NameValuePairs.
virtual size_t SignAndRestart(RandomNumberGenerator &rng, PK_MessageAccumulator &messageAccumulator, byte *signature, bool restart=true) const =0
Sign and restart messageAccumulator.
virtual size_t SignMessageWithRecovery(RandomNumberGenerator &rng, const byte *recoverableMessage, size_t recoverableMessageLength, const byte *nonrecoverableMessage, size_t nonrecoverableMessageLength, byte *signature) const
Sign a recoverable message.
virtual size_t Sign(RandomNumberGenerator &rng, PK_MessageAccumulator *messageAccumulator, byte *signature) const
Sign and delete the messageAccumulator.
void GenerateBlock(byte *output, size_t size)
An implementation that throws NotImplemented.
A decryption filter encountered invalid ciphertext.