Crypto++
5.6.3
Free C++ class library of cryptographic schemes
|
Base class for Filter classes that are proxies for a chain of other filters. More...
Public Member Functions | |
ProxyFilter (BufferedTransformation *filter, size_t firstSize, size_t lastSize, BufferedTransformation *attachment) | |
bool | IsolatedFlush (bool hardFlush, bool blocking) |
void | SetFilter (Filter *filter) |
void | NextPutMultiple (const byte *s, size_t len) |
void | NextPutModifiable (byte *inString, size_t length) |
void | IsolatedInitialize (const NameValuePairs ¶meters) |
Initialize or reinitialize this object, without signal propagation. More... | |
size_t | Put2 (const byte *inString, size_t length, int messageEnd, bool blocking) |
Input multiple bytes for processing. More... | |
size_t | PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking) |
Input multiple bytes that may be modified by callee. More... | |
void | ForceNextPut () |
bool | Attachable () |
Determine if attachable. More... | |
BufferedTransformation * | AttachedTransformation () |
Retrieve attached transformation. More... | |
const BufferedTransformation * | AttachedTransformation () const |
Retrieve attached transformation. More... | |
void | Detach (BufferedTransformation *newAttachment=NULL) |
Replace an attached transformation. More... | |
size_t | TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) |
Transfer bytes from this object to another BufferedTransformation. More... | |
size_t | CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const |
Copy bytes from this object to another BufferedTransformation. More... | |
void | Initialize (const NameValuePairs ¶meters=g_nullNameValuePairs, int propagation=-1) |
Initialize or reinitialize this object, with signal propagation. More... | |
bool | Flush (bool hardFlush, int propagation=-1, bool blocking=true) |
Flush buffered input and/or output, with signal propagation. More... | |
bool | MessageSeriesEnd (int propagation=-1, bool blocking=true) |
Marks the end of a series of messages, with signal propagation. More... | |
BufferedTransformation & | Ref () |
Provides a reference to this object. More... | |
virtual std::string | AlgorithmName () const |
Provides the name of this algorithm. More... | |
virtual Clonable * | Clone () const |
Copies this object. More... | |
bool | Wait (unsigned long milliseconds, CallStack const &callStack) |
wait on this object More... | |
INPUT | |
size_t | Put (byte inByte, bool blocking=true) |
Input a byte for processing. More... | |
size_t | Put (const byte *inString, size_t length, bool blocking=true) |
Input a byte buffer for processing. More... | |
size_t | PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
Input a 16-bit word for processing. More... | |
size_t | PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
Input a 32-bit word for processing. More... | |
virtual byte * | CreatePutSpace (size_t &size) |
Request space which can be written into by the caller. More... | |
virtual bool | CanModifyInput () const |
Determines whether input can be modifed by the callee. More... | |
size_t | PutModifiable (byte *inString, size_t length, bool blocking=true) |
Input multiple bytes that may be modified by callee. More... | |
bool | MessageEnd (int propagation=-1, bool blocking=true) |
Signals the end of messages to the object. More... | |
size_t | PutMessageEnd (const byte *inString, size_t length, int propagation=-1, bool blocking=true) |
Input multiple bytes for processing and signal the end of a message. More... | |
WAITING | |
unsigned int | GetMaxWaitObjectCount () const |
Retrieves the maximum number of waitable objects. | |
void | GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack) |
Retrieves waitable objects. More... | |
SIGNALS | |
virtual bool | IsolatedMessageSeriesEnd (bool blocking) |
Marks the end of a series of messages, without signal propagation. More... | |
virtual void | SetAutoSignalPropagation (int propagation) |
Set propagation of automatically generated and transferred signals. More... | |
virtual int | GetAutoSignalPropagation () const |
Retrieve automatic signal propagation value. | |
RETRIEVAL OF ONE MESSAGE | |
virtual lword | MaxRetrievable () const |
Provides the number of bytes ready for retrieval. More... | |
virtual bool | AnyRetrievable () const |
Determines whether bytes are ready for retrieval. More... | |
virtual size_t | Get (byte &outByte) |
Retrieve a 8-bit byte. More... | |
virtual size_t | Get (byte *outString, size_t getMax) |
Retrieve a block of bytes. More... | |
virtual size_t | Peek (byte &outByte) const |
Peek a 8-bit byte. More... | |
virtual size_t | Peek (byte *outString, size_t peekMax) const |
Peek a block of bytes. More... | |
size_t | GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) |
Retrieve a 16-bit word. More... | |
size_t | GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) |
Retrieve a 32-bit word. More... | |
size_t | PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const |
Peek a 16-bit word. More... | |
size_t | PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const |
Peek a 32-bit word. More... | |
lword | TransferTo (BufferedTransformation &target, lword transferMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) |
move transferMax bytes of the buffered output to target as input More... | |
virtual lword | Skip (lword skipMax=LWORD_MAX) |
Discard skipMax bytes from the output buffer. More... | |
lword | CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const |
copy copyMax bytes of the buffered output to target as input More... | |
lword | CopyRangeTo (BufferedTransformation &target, lword position, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const |
Copy bytes from this object using an index to another BufferedTransformation. More... | |
RETRIEVAL OF MULTIPLE MESSAGES | |
virtual lword | TotalBytesRetrievable () const |
Provides the number of bytes ready for retrieval. More... | |
virtual unsigned int | NumberOfMessages () const |
Provides the number of meesages processed by this object. More... | |
virtual bool | AnyMessages () const |
Determines if any messages are available for retrieval. More... | |
virtual bool | GetNextMessage () |
Start retrieving the next message. More... | |
virtual unsigned int | SkipMessages (unsigned int count=UINT_MAX) |
Skip a number of meessages. More... | |
unsigned int | TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) |
Transfer messages from this object to another BufferedTransformation. More... | |
unsigned int | CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) const |
Copies messages from this object to another BufferedTransformation. More... | |
virtual void | SkipAll () |
void | TransferAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) |
void | CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const |
virtual bool | GetNextMessageSeries () |
virtual unsigned int | NumberOfMessagesInThisSeries () const |
virtual unsigned int | NumberOfMessageSeries () const |
NON-BLOCKING TRANSFER OF OUTPUT | |
size_t | TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) |
Transfer messages from this object to another BufferedTransformation. More... | |
size_t | TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) |
Transfer all bytes from this object to another BufferedTransformation. More... | |
CHANNELS | |
size_t | ChannelPut (const std::string &channel, byte inByte, bool blocking=true) |
Input a byte for processing on a channel. More... | |
size_t | ChannelPut (const std::string &channel, const byte *inString, size_t length, bool blocking=true) |
Input a byte buffer for processing on a channel. More... | |
size_t | ChannelPutModifiable (const std::string &channel, byte *inString, size_t length, bool blocking=true) |
Input multiple bytes that may be modified by callee on a channel. More... | |
size_t | ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
Input a 16-bit word for processing on a channel. More... | |
size_t | ChannelPutWord32 (const std::string &channel, word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
Input a 32-bit word for processing on a channel. More... | |
bool | ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true) |
Signal the end of a message. More... | |
size_t | ChannelPutMessageEnd (const std::string &channel, const byte *inString, size_t length, int propagation=-1, bool blocking=true) |
Input multiple bytes for processing and signal the end of a message. More... | |
virtual byte * | ChannelCreatePutSpace (const std::string &channel, size_t &size) |
Request space which can be written into by the caller. More... | |
virtual size_t | ChannelPut2 (const std::string &channel, const byte *inString, size_t length, int messageEnd, bool blocking) |
Input multiple bytes for processing on a channel. More... | |
virtual size_t | ChannelPutModifiable2 (const std::string &channel, byte *inString, size_t length, int messageEnd, bool blocking) |
Input multiple bytes that may be modified by callee on a channel. More... | |
virtual bool | ChannelFlush (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true) |
Flush buffered input and/or output on a channel. More... | |
virtual bool | ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true) |
Marks the end of a series of messages on a channel. More... | |
virtual void | SetRetrievalChannel (const std::string &channel) |
Sets the default retrieval channel. More... | |
ATTACHMENT | |
virtual void | Attach (BufferedTransformation *newAttachment) |
Add newAttachment to the end of attachment chain. More... | |
Static Public Attributes | |
static const std::string & | NULL_CHANNEL = DEFAULT_CHANNEL |
Base class for Filter classes that are proxies for a chain of other filters.
|
virtual |
calls ForceNextPut() if hardFlush is true
Reimplemented from FilterWithBufferedInput.
Definition at line 498 of file filters.cpp.
|
virtualinherited |
Initialize or reinitialize this object, without signal propagation.
parameters | a set of NameValuePairs used to initialize this object |
NotImplemented |
IsolatedInitialize() is used to initialize or reinitialize an object using a variable number of arbitrarily typed arguments. The function avoids the need for multiple constuctors providing all possible combintations of configurable parameters.
IsolatedInitialize() does not call Initialize() on attached transformations. If initialization should be propagated, then use the Initialize() function.
Setting propagation to -1
means unlimited propagation.
If a derived class does not override IsolatedInitialize(), then the base class throws NotImplemented.
Reimplemented from BufferedTransformation.
Reimplemented in AuthenticatedEncryptionFilter, and HexEncoder.
Definition at line 336 of file filters.cpp.
References SIZE_MAX.
Referenced by AuthenticatedDecryptionFilter::AuthenticatedDecryptionFilter(), AuthenticatedEncryptionFilter::IsolatedInitialize(), HashFilter::Put2(), SignerFilter::Put2(), and ArrayXorSink::Put2().
|
inlinevirtualinherited |
Input multiple bytes for processing.
inString | the byte buffer to process |
length | the size of the string, in bytes |
messageEnd | means how many filters to signal MessageEnd() to, including this one |
blocking | specifies whether the object should block when processing input |
Derived classes must implement Put2().
Implements BufferedTransformation.
Definition at line 267 of file filters.h.
Referenced by AuthenticatedEncryptionFilter::ChannelPut2(), and AuthenticatedDecryptionFilter::ChannelPut2().
|
inlinevirtualinherited |
Input multiple bytes that may be modified by callee.
inString | the byte buffer to process. |
length | the size of the string, in bytes. |
messageEnd | means how many filters to signal MessageEnd() to, including this one. |
blocking | specifies whether the object should block when processing input. |
Internally, PutModifiable2() calls Put2().
Reimplemented from BufferedTransformation.
|
inherited |
The input buffer may contain more than blockSize bytes if lastSize != 0. ForceNextPut() forces a call to NextPut() if this is the case.
Definition at line 448 of file filters.cpp.
Referenced by AuthenticatedDecryptionFilter::ChannelPut2(), DefaultDecryptor::DefaultDecryptor(), and FilterWithBufferedInput::IsolatedFlush().
|
inlinevirtualinherited |
Determine if attachable.
true
if the object allows attached transformations, false
otherwise. Reimplemented from BufferedTransformation.
Definition at line 50 of file filters.h.
References DEFAULT_CHANNEL, and g_nullNameValuePairs.
|
virtualinherited |
Retrieve attached transformation.
NULL
otherwise. Reimplemented from BufferedTransformation.
Definition at line 36 of file filters.cpp.
Referenced by Filter::CopyRangeTo2(), DefaultEncryptor::DefaultEncryptor(), Gunzip::Gunzip(), Deflator::IsolatedFlush(), Inflator::IsolatedFlush(), Filter::MessageSeriesEnd(), HashFilter::Put2(), SignerFilter::Put2(), ArrayXorSink::Put2(), Filter::TransferTo2(), and ZlibDecompressor::ZlibDecompressor().
|
virtualinherited |
Retrieve attached transformation.
NULL
otherwise. Reimplemented from BufferedTransformation.
Definition at line 43 of file filters.cpp.
|
virtualinherited |
Replace an attached transformation.
newAttachment | pointer to a new BufferedTransformation |
newAttachment cab ne a single filter, a chain of filters or NULL
. Pass NULL
to remove an existing BufferedTransformation or chain of filters
Reimplemented from BufferedTransformation.
Definition at line 50 of file filters.cpp.
Referenced by Inflator::Inflator(), and ArrayXorSink::Put2().
|
virtualinherited |
Transfer bytes from this object to another BufferedTransformation.
target | the destination BufferedTransformation |
byteCount | the number of bytes to transfer |
channel | the channel on which the transfer should occur |
blocking | specifies whether the object should block when processing input |
TransferTo removes bytes from this object and moves them to the destination. Transfer begins at the index position in the current stream, and not from an absolute position in the stream.
byteCount is an IN and OUT parameter. When the call is made, byteCount is the requested size of the transfer. When the call returns, byteCount is the number of bytes that were transferred.
Implements BufferedTransformation.
Definition at line 66 of file filters.cpp.
References Filter::AttachedTransformation(), and BufferedTransformation::TransferTo2().
|
virtualinherited |
Copy bytes from this object to another BufferedTransformation.
target | the destination BufferedTransformation |
begin | the 0-based index of the first byte to copy in the stream |
end | the 0-based index of the last byte to copy in the stream |
channel | the channel on which the transfer should occur |
blocking | specifies whether the object should block when processing input |
CopyRangeTo2 copies bytes from this object to the destination. The bytes are not removed from this object. Copying begins at the index position in the current stream, and not from an absolute position in the stream.
begin is an IN and OUT parameter. When the call is made, begin is the starting position of the copy. When the call returns, begin is the position of the first byte that was not copied (which may be different tahn end). begin can be used for subsequent calls to CopyRangeTo2.
Implements BufferedTransformation.
Definition at line 61 of file filters.cpp.
References Filter::AttachedTransformation(), and BufferedTransformation::CopyRangeTo2().
Referenced by StringStore::TransferTo2().
|
virtualinherited |
Initialize or reinitialize this object, with signal propagation.
parameters | a set of NameValuePairs used to initialize or reinitialize this object and attached transformations |
propagation | the number of attached transformations the Initialize() signal should be passed |
Initialize() is used to initialize or reinitialize an object using a variable number of arbitrarily typed arguments. The function avoids the need for multiple constuctors providing all possible combintations of configurable parameters.
propagation count includes this object. Setting propagation to 1
means this object only. Setting propagation to -1
means unlimited propagation.
Reimplemented from BufferedTransformation.
Definition at line 71 of file filters.cpp.
References BufferedTransformation::IsolatedInitialize().
Referenced by AuthenticatedDecryptionFilter::AuthenticatedDecryptionFilter(), HuffmanEncoder::HuffmanEncoder(), HexEncoder::IsolatedInitialize(), Base64Encoder::IsolatedInitialize(), Base32Encoder::IsolatedInitialize(), and Base32Decoder::IsolatedInitialize().
|
virtualinherited |
Flush buffered input and/or output, with signal propagation.
hardFlush | is used to indicate whether all data should be flushed |
propagation | the number of attached transformations the Flush() signal should be passed |
blocking | specifies whether the object should block when processing input |
propagation count includes this object. Setting propagation to 1
means this object only. Setting propagation to -1
means unlimited propagation.
Reimplemented from BufferedTransformation.
Reimplemented in InformationDispersal, and SecretSharing.
Definition at line 78 of file filters.cpp.
References BufferedTransformation::IsolatedFlush().
Referenced by TestDataNameValuePairs::GetVoidValue().
|
virtualinherited |
Marks the end of a series of messages, with signal propagation.
propagation | the number of attached transformations the MessageSeriesEnd() signal should be passed |
blocking | specifies whether the object should block when processing input |
Each object that receives the signal will perform its processing, decrement propagation, and then pass the signal on to attached transformations if the value is not 0.
propagation count includes this object. Setting propagation to 1
means this object only. Setting propagation to -1
means unlimited propagation.
Reimplemented from BufferedTransformation.
Definition at line 95 of file filters.cpp.
References Filter::AttachedTransformation(), BufferedTransformation::ChannelFlush(), BufferedTransformation::ChannelMessageSeriesEnd(), BufferedTransformation::ChannelPut2(), BufferedTransformation::ChannelPutModifiable2(), BufferedTransformation::Initialize(), BufferedTransformation::IsolatedMessageSeriesEnd(), and SaturatingSubtract().
|
inlineinherited |
Provides a reference to this object.
Useful for passing a temporary object to a function that takes a non-const reference
Definition at line 1258 of file cryptlib.h.
Referenced by TestDataNameValuePairs::GetVoidValue().
|
inlineinherited |
Input a byte for processing.
inByte | the 8-bit byte (octet) to be processed. |
blocking | specifies whether the object should block when processing input. |
Put(byte)
calls Put(byte*, size_t)
.
Definition at line 1268 of file cryptlib.h.
Referenced by EqualityComparisonFilter::ChannelPut2(), AuthenticatedDecryptionFilter::ChannelPut2(), DefaultDecryptor::DefaultDecryptor(), DefaultEncryptor::DefaultEncryptor(), X509PublicKey::DEREncode(), DEREncodeBitString(), DEREncodeOctetString(), DEREncodeUnsigned(), DERLengthEncode(), PolynomialMod2::Encode(), Integer::Encode(), FixedRNG::GenerateBlock(), InvertibleLUCFunction::GenerateRandom(), Gunzip::Gunzip(), Deflator::IsolatedFlush(), ByteQueue::Put2(), HashFilter::Put2(), SignerFilter::Put2(), FilterTester::Put2(), ArrayXorSink::Put2(), and ZlibDecompressor::ZlibDecompressor().
|
inlineinherited |
Input a byte buffer for processing.
inString | the byte buffer to process |
length | the size of the string, in bytes |
blocking | specifies whether the object should block when processing input |
Internally, Put() calls Put2().
Definition at line 1277 of file cryptlib.h.
|
inherited |
Input a 16-bit word for processing.
value | the 16-bit value to be processed |
order | the ByteOrder in which the word should be processed |
blocking | specifies whether the object should block when processing input |
Definition at line 717 of file cryptlib.cpp.
Referenced by Deflator::IsolatedFlush(), and Integer::OpenPGPEncode().
|
inherited |
Input a 32-bit word for processing.
value | the 32-bit value to be processed. |
order | the ByteOrder in which the word should be processed. |
blocking | specifies whether the object should block when processing input. |
Definition at line 722 of file cryptlib.cpp.
|
inlinevirtualinherited |
Request space which can be written into by the caller.
size | the requested size of the buffer |
The purpose of this method is to help avoid extra memory allocations.
size is an IN and OUT parameter and used as a hint. When the call is made, size is the requested size of the buffer. When the call returns, size is the size of the array returned to the caller.
The base class implementation sets size to 0 and returns NULL.
Reimplemented in ArrayXorSink, ArraySink, OutputProxy, Redirector, HashFilter, MeterFilter, and ByteQueue.
Definition at line 1303 of file cryptlib.h.
Referenced by AuthenticatedEncryptionFilter::ChannelCreatePutSpace(), AuthenticatedDecryptionFilter::ChannelCreatePutSpace(), and ArrayXorSink::CreatePutSpace().
|
inlinevirtualinherited |
Determines whether input can be modifed by the callee.
The base class implementation returns false.
Reimplemented in Redirector.
Definition at line 1309 of file cryptlib.h.
|
inlineinherited |
Input multiple bytes that may be modified by callee.
inString | the byte buffer to process |
length | the size of the string, in bytes |
blocking | specifies whether the object should block when processing input |
Definition at line 1318 of file cryptlib.h.
Referenced by ArrayXorSink::Put2().
|
inlineinherited |
Signals the end of messages to the object.
propagation | the number of attached transformations the MessageEnd() signal should be passed |
blocking | specifies whether the object should block when processing input |
propagation count includes this object. Setting propagation to 1
means this object only. Setting propagation to -1
means unlimited propagation.
Definition at line 1326 of file cryptlib.h.
Referenced by EqualityComparisonFilter::ChannelPut2(), AuthenticatedEncryptionFilter::ChannelPut2(), AuthenticatedDecryptionFilter::ChannelPut2(), TestDataNameValuePairs::GetVoidValue(), and FilterTester::Put2().
|
inlineinherited |
Input multiple bytes for processing and signal the end of a message.
inString | the byte buffer to process |
length | the size of the string, in bytes |
propagation | the number of attached transformations the MessageEnd() signal should be passed |
blocking | specifies whether the object should block when processing input |
Internally, PutMessageEnd() calls Put2() with a modified propagation to ensure all attached transformations finish processing the message.
propagation count includes this object. Setting propagation to 1
means this object only. Setting propagation to -1
means unlimited propagation.
Definition at line 1338 of file cryptlib.h.
Referenced by AuthenticatedDecryptionFilter::ChannelPut2(), and IntegrityCheckModule().
|
virtualinherited |
Retrieves waitable objects.
container | the wait container to receive the references to the objects |
callStack | CallStack object used to select waitable objects |
GetWaitObjects is usually called in one of two ways. First, it can be called like something.GetWaitObjects(c, CallStack("my func after X", 0));
. Second, if in an outer GetWaitObjects() method that itself takes a callStack parameter, it can be called like innerThing.GetWaitObjects(c, CallStack("MyClass::GetWaitObjects at X", &callStack));
.
Implements Waitable.
Reimplemented in Redirector, NetworkSink, and NetworkSource.
Definition at line 431 of file cryptlib.cpp.
References BufferedTransformation::GetWaitObjects().
Referenced by BufferedTransformation::GetWaitObjects().
|
inlinevirtualinherited |
Marks the end of a series of messages, without signal propagation.
blocking | specifies whether the object should block when completing the processing on the current series of messages |
Reimplemented in MeterFilter, and MessageQueue.
Definition at line 1407 of file cryptlib.h.
References g_nullNameValuePairs.
Referenced by Filter::MessageSeriesEnd().
|
inlinevirtualinherited |
Set propagation of automatically generated and transferred signals.
propagation | then new value |
Setting propagation to 0
means do not automaticly generate signals. Setting propagation to -1
means unlimited propagation.
Reimplemented in SourceTemplate< T >, SourceTemplate< FileStore >, SourceTemplate< RandomNumberStore >, and SourceTemplate< StringStore >.
Definition at line 1451 of file cryptlib.h.
|
virtualinherited |
Provides the number of bytes ready for retrieval.
All retrieval functions return the actual number of bytes retrieved, which is the lesser of the request number and MaxRetrievable()
Reimplemented in NullStore, RandomNumberStore, ByteQueue::Walker, FileStore, MessageQueue, and ByteQueue.
Definition at line 499 of file cryptlib.cpp.
References TheBitBucket().
Referenced by Integer::BERDecode(), Integer::Decode(), Integer::OpenPGPDecode(), and FilterTester::Put2().
|
virtualinherited |
Determines whether bytes are ready for retrieval.
Reimplemented in RandomNumberStore, MessageQueue, and ByteQueue.
Definition at line 507 of file cryptlib.cpp.
Referenced by Store::GetNextMessage().
|
virtualinherited |
Retrieve a 8-bit byte.
outByte | the 8-bit value to be retrieved |
Use the return value of Get to detect short reads.
Reimplemented in ByteQueue::Walker, and ByteQueue.
Definition at line 518 of file cryptlib.cpp.
Referenced by BERDecodeUnsigned(), Integer::Decode(), DefaultDecryptor::DefaultDecryptor(), DEREncodeBitString(), DEREncodeOctetString(), DERLengthEncode(), PolynomialMod2::Encode(), and FilterTester::Put2().
|
virtualinherited |
Retrieve a block of bytes.
outString | a block of bytes |
getMax | the number of bytes to Get |
Use the return value of Get to detect short reads.
Reimplemented in ByteQueue::Walker, and ByteQueue.
Definition at line 526 of file cryptlib.cpp.
|
virtualinherited |
Peek a 8-bit byte.
outByte | the 8-bit value to be retrieved |
Peek does not remove bytes from the object. Use the return value of Get to detect short reads.
Reimplemented in ByteQueue::Walker, and ByteQueue.
Definition at line 537 of file cryptlib.cpp.
Referenced by Integer::Decode(), DEREncodeBitString(), and DL_GroupParameters_EC< EC >::GenerateRandom().
|
virtualinherited |
Peek a block of bytes.
outString | a block of bytes |
peekMax | the number of bytes to Peek |
Peek does not remove bytes from the object. Use the return value of Get to detect short reads.
Reimplemented in ByteQueue::Walker, and ByteQueue.
Definition at line 545 of file cryptlib.cpp.
|
inherited |
Retrieve a 16-bit word.
value | the 16-bit value to be retrieved |
order | the ByteOrder in which the word should be retrieved |
Use the return value of GetWord16 to detect short reads.
Definition at line 753 of file cryptlib.cpp.
Referenced by Integer::OpenPGPDecode().
|
inherited |
Retrieve a 32-bit word.
value | the 32-bit value to be retrieved |
order | the ByteOrder in which the word should be retrieved |
Use the return value of GetWord16 to detect short reads.
Definition at line 758 of file cryptlib.cpp.
|
inherited |
Peek a 16-bit word.
value | the 16-bit value to be retrieved |
order | the ByteOrder in which the word should be retrieved |
Peek does not consume bytes in the stream. Use the return value of GetWord16 to detect short reads.
Definition at line 727 of file cryptlib.cpp.
|
inherited |
Peek a 32-bit word.
value | the 32-bit value to be retrieved |
order | the ByteOrder in which the word should be retrieved |
Peek does not consume bytes in the stream. Use the return value of GetWord16 to detect short reads.
Definition at line 740 of file cryptlib.cpp.
|
inlineinherited |
move transferMax bytes of the buffered output to target as input
Transfer bytes from this object to another BufferedTransformation
target | the destination BufferedTransformation |
transferMax | the number of bytes to transfer |
channel | the channel on which the transfer should occur |
TransferTo removes bytes from this object and moves them to the destination.
The function always returns transferMax. If an accurate count is needed, then use TransferTo2.
Definition at line 1543 of file cryptlib.h.
Referenced by DEREncodeBitString(), DEREncodeOctetString(), ByteQueue::Get(), ByteQueue::Walker::Get(), MessageQueue::GetNextMessage(), IntegrityCheckModule(), and Inflator::IsolatedFlush().
|
virtualinherited |
Discard skipMax bytes from the output buffer.
skipMax | the number of bytes to discard |
Skip always returns skipMax.
Reimplemented in FileStore.
Definition at line 556 of file cryptlib.cpp.
References TheBitBucket().
Referenced by ByteQueue::CopyRangeTo2(), ByteQueue::Walker::CopyRangeTo2(), Integer::Decode(), Inflator::IsolatedFlush(), and ByteQueue::TransferTo2().
|
inlineinherited |
copy copyMax bytes of the buffered output to target as input
Copy bytes from this object to another BufferedTransformation
target | the destination BufferedTransformation |
copyMax | the number of bytes to copy |
channel | the channel on which the transfer should occur |
CopyTo copies bytes from this object to the destination. The bytes are not removed from this object.
The function always returns copyMax. If an accurate count is needed, then use CopyRangeTo2.
Definition at line 1560 of file cryptlib.h.
Referenced by Store::GetNextMessage(), ByteQueue::Peek(), and ByteQueue::Walker::Peek().
|
inlineinherited |
Copy bytes from this object using an index to another BufferedTransformation.
target | the destination BufferedTransformation |
position | the 0-based index of the byte stream to begin the copying |
copyMax | the number of bytes to copy |
channel | the channel on which the transfer should occur |
CopyTo copies bytes from this object to the destination. The bytes remain in this object. Copying begins at the index position in the current stream, and not from an absolute position in the stream.
The function returns the new position in the stream after transferring the bytes starting at the index.
Definition at line 1573 of file cryptlib.h.
|
virtualinherited |
Provides the number of bytes ready for retrieval.
Reimplemented in MessageQueue.
Definition at line 564 of file cryptlib.cpp.
|
virtualinherited |
Provides the number of meesages processed by this object.
NumberOfMessages returns number of times MessageEnd() has been received minus messages retrieved or skipped
Reimplemented in Store, and MessageQueue.
Definition at line 572 of file cryptlib.cpp.
References TheBitBucket().
|
virtualinherited |
Determines if any messages are available for retrieval.
NumberOfMessages() > 0
, false otherwiseAnyMessages returns true if NumberOfMessages() > 0
Definition at line 580 of file cryptlib.cpp.
|
virtualinherited |
Start retrieving the next message.
GetNextMessage() returns true if a message is ready for retrieval; false if no more messages exist or this message is not completely retrieved.
Reimplemented in Store, and MessageQueue.
Definition at line 588 of file cryptlib.cpp.
|
virtualinherited |
Skip a number of meessages.
SkipMessages() skips count number of messages. If there is an AttachedTransformation() then SkipMessages() is called on the attached transformation. If there is no attached transformation, then count number of messages are sent to TheBitBucket() using TransferMessagesTo().
Definition at line 599 of file cryptlib.cpp.
References TheBitBucket().
|
inlineinherited |
Transfer messages from this object to another BufferedTransformation.
target | the destination BufferedTransformation |
count | the number of messages to transfer |
channel | the channel on which the transfer should occur |
TransferMessagesTo2 removes messages from this object and moves them to the destination. If all bytes are not transferred for a message, then processing stops and the number of remaining bytes is returned. TransferMessagesTo() does not proceed to the next message.
A return value of 0 indicates all messages were successfully transferred.
Definition at line 1621 of file cryptlib.h.
References DEFAULT_CHANNEL.
|
inherited |
Copies messages from this object to another BufferedTransformation.
target | the destination BufferedTransformation |
count | the number of messages to transfer |
channel | the channel on which the transfer should occur |
CopyMessagesTo copies messages from this object and copies them to the destination. If all bytes are not transferred for a message, then processing stops and the number of remaining bytes is returned. CopyMessagesTo() does not proceed to the next message.
A return value of 0 indicates all messages were successfully copied.
Definition at line 637 of file cryptlib.cpp.
|
inherited |
Transfer messages from this object to another BufferedTransformation.
target | the destination BufferedTransformation |
messageCount | the number of messages to transfer |
channel | the channel on which the transfer should occur |
blocking | specifies whether the object should block when processing input |
TransferMessagesTo2 removes messages from this object and moves them to the destination.
Definition at line 607 of file cryptlib.cpp.
References BufferedTransformation::ChannelMessageEnd().
|
inherited |
Transfer all bytes from this object to another BufferedTransformation.
target | the destination BufferedTransformation |
channel | the channel on which the transfer should occur |
blocking | specifies whether the object should block when processing input |
TransferMessagesTo2 removes messages from this object and moves them to the destination.
Definition at line 656 of file cryptlib.cpp.
|
inlineinherited |
Input a byte for processing on a channel.
channel | the channel to process the data. |
inByte | the 8-bit byte (octet) to be processed. |
blocking | specifies whether the object should block when processing input. |
Definition at line 1725 of file cryptlib.h.
Referenced by FileStore::CopyRangeTo2(), RandomPool::GenerateIntoBufferedTransformation(), X917RNG::GenerateIntoBufferedTransformation(), RandomNumberGenerator::GenerateIntoBufferedTransformation(), and ByteQueue::TransferTo2().
|
inlineinherited |
Input a byte buffer for processing on a channel.
channel | the channel to process the data |
inString | the byte buffer to process |
length | the size of the string, in bytes |
blocking | specifies whether the object should block when processing input |
Definition at line 1735 of file cryptlib.h.
|
inlineinherited |
Input multiple bytes that may be modified by callee on a channel.
channel | the channel to process the data. |
inString | the byte buffer to process |
length | the size of the string, in bytes |
blocking | specifies whether the object should block when processing input |
Definition at line 1745 of file cryptlib.h.
Referenced by ByteQueue::TransferTo2().
|
inherited |
Input a 16-bit word for processing on a channel.
channel | the channel to process the data. |
value | the 16-bit value to be processed. |
order | the ByteOrder in which the word should be processed. |
blocking | specifies whether the object should block when processing input. |
Definition at line 705 of file cryptlib.cpp.
|
inherited |
Input a 32-bit word for processing on a channel.
channel | the channel to process the data. |
value | the 32-bit value to be processed. |
order | the ByteOrder in which the word should be processed. |
blocking | specifies whether the object should block when processing input. |
Definition at line 711 of file cryptlib.cpp.
|
inlineinherited |
Signal the end of a message.
channel | the channel to process the data. |
propagation | the number of attached transformations the ChannelMessageEnd() signal should be passed |
blocking | specifies whether the object should block when processing input |
propagation count includes this object. Setting propagation to 1
means this object only. Setting propagation to -1
means unlimited propagation.
Definition at line 1774 of file cryptlib.h.
Referenced by MessageQueue::GetNextMessage(), Store::GetNextMessage(), and BufferedTransformation::TransferMessagesTo2().
|
inlineinherited |
Input multiple bytes for processing and signal the end of a message.
channel | the channel to process the data. |
inString | the byte buffer to process |
length | the size of the string, in bytes |
propagation | the number of attached transformations the ChannelPutMessageEnd() signal should be passed |
blocking | specifies whether the object should block when processing input |
propagation count includes this object. Setting propagation to 1
means this object only. Setting propagation to -1
means unlimited propagation.
Definition at line 1787 of file cryptlib.h.
|
virtualinherited |
Request space which can be written into by the caller.
channel | the channel to process the data |
size | the requested size of the buffer |
The purpose of this method is to help avoid extra memory allocations.
size is an IN and OUT parameter and used as a hint. When the call is made, size is the requested size of the buffer. When the call returns, size is the size of the array returned to the caller.
The base class implementation sets size to 0 and returns NULL.
Reimplemented in OutputProxy, Redirector, AuthenticatedDecryptionFilter, AuthenticatedEncryptionFilter, and ChannelSwitch.
Definition at line 459 of file cryptlib.cpp.
Referenced by ChannelSwitch::ChannelCreatePutSpace().
|
virtualinherited |
Input multiple bytes for processing on a channel.
channel | the channel to process the data. |
inString | the byte buffer to process. |
length | the size of the string, in bytes. |
messageEnd | means how many filters to signal MessageEnd() to, including this one. |
blocking | specifies whether the object should block when processing input. |
Reimplemented in OutputProxy, Redirector, AuthenticatedDecryptionFilter, AuthenticatedEncryptionFilter, ChannelSwitch, EqualityComparisonFilter, and RawIDA.
Definition at line 467 of file cryptlib.cpp.
Referenced by StringStore::CopyRangeTo2(), NullStore::CopyRangeTo2(), Filter::MessageSeriesEnd(), and ByteQueue::Walker::TransferTo2().
|
virtualinherited |
Input multiple bytes that may be modified by callee on a channel.
channel | the channel to process the data |
inString | the byte buffer to process |
length | the size of the string, in bytes |
messageEnd | means how many filters to signal MessageEnd() to, including this one |
blocking | specifies whether the object should block when processing input |
Reimplemented in OutputProxy, Redirector, and ChannelSwitch.
Definition at line 475 of file cryptlib.cpp.
Referenced by ChannelSwitch::ChannelPutModifiable2(), Filter::MessageSeriesEnd(), and FileStore::TransferTo2().
|
virtualinherited |
Flush buffered input and/or output on a channel.
channel | the channel to flush the data |
hardFlush | is used to indicate whether all data should be flushed |
propagation | the number of attached transformations the ChannelFlush() signal should be passed |
blocking | specifies whether the object should block when processing input |
propagation count includes this object. Setting propagation to 1
means this object only. Setting propagation to -1
means unlimited propagation.
Reimplemented in OutputProxy, Redirector, and ChannelSwitch.
Definition at line 483 of file cryptlib.cpp.
Referenced by Filter::MessageSeriesEnd().
|
virtualinherited |
Marks the end of a series of messages on a channel.
channel | the channel to signal the end of a series of messages |
propagation | the number of attached transformations the ChannelMessageSeriesEnd() signal should be passed |
blocking | specifies whether the object should block when processing input |
Each object that receives the signal will perform its processing, decrement propagation, and then pass the signal on to attached transformations if the value is not 0.
propagation count includes this object. Setting propagation to 1
means this object only. Setting propagation to -1
means unlimited propagation.
Reimplemented in OutputProxy, Redirector, ChannelSwitch, and EqualityComparisonFilter.
Definition at line 491 of file cryptlib.cpp.
Referenced by Filter::MessageSeriesEnd().
|
virtualinherited |
Sets the default retrieval channel.
channel | the channel to signal the end of a series of messages |
Definition at line 699 of file cryptlib.cpp.
|
virtualinherited |
Add newAttachment to the end of attachment chain.
newAttachment | the attachment to add to the end of the chain |
Definition at line 763 of file cryptlib.cpp.
Referenced by FilterTester::Put2().
|
inlinevirtualinherited |
Provides the name of this algorithm.
The standard algorithm name can be a name like AES or AES/GCM. Some algorithms do not have standard names yet. For example, there is no standard algorithm name for Shoup's ECIES.
Reimplemented in AuthenticatedSymmetricCipher, SignatureVerificationFilter, SignerFilter, AuthenticatedDecryptionFilter, HashVerificationFilter, HashFilter, StreamTransformationFilter, ClassNullRNG, BitBucket, RDSEED, DH_Domain< GROUP_PARAMETERS, COFACTOR_OPTION >, HMAC< T >, RDRAND, CRC32, GCM_Base, Adler32, EAX_Base, CCM_Base, SHA3, and VMAC_Base.
Definition at line 488 of file cryptlib.h.
Referenced by VariableRounds< 6, 2 >::StaticGetDefaultRounds().
|
inlinevirtualinherited |
Copies this object.
NotImplemented |
Definition at line 464 of file cryptlib.h.
|
inherited |
wait on this object
same as creating an empty container, calling GetWaitObjects(), and calling Wait() on the container
Definition at line 426 of file wait.cpp.
Referenced by NetworkSource::GetWaitObjects(), and NetworkSink::Put2().