Fabcoin Core  0.16.2
P2P Digital Currency
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
StreamTransformationFilter Class Reference

Filter wrapper for StreamTransformation. More...

#include <filters.h>

Inheritance diagram for StreamTransformationFilter:
[legend]
Collaboration diagram for StreamTransformationFilter:
[legend]

Public Member Functions

virtual ~StreamTransformationFilter ()
 
 StreamTransformationFilter (StreamTransformation &c, BufferedTransformation *attachment=NULL, BlockPaddingScheme padding=DEFAULT_PADDING, bool allowAuthenticatedSymmetricCipher=false)
 Construct a StreamTransformationFilter. More...
 
std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
- Public Member Functions inherited from FilterWithBufferedInput
virtual ~FilterWithBufferedInput ()
 
 FilterWithBufferedInput (BufferedTransformation *attachment)
 Construct a FilterWithBufferedInput with an attached transformation. More...
 
 FilterWithBufferedInput (size_t firstSize, size_t blockSize, size_t lastSize, BufferedTransformation *attachment)
 Construct a FilterWithBufferedInput with an attached transformation. More...
 
void IsolatedInitialize (const NameValuePairs &parameters)
 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...
 
bool IsolatedFlush (bool hardFlush, bool blocking)
 Flushes data buffered by this object, without signal propagation. More...
 
void ForceNextPut ()
 Flushes data buffered by this object. More...
 
- Public Member Functions inherited from Filter
virtual ~Filter ()
 
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 &parameters=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...
 
 Filter (BufferedTransformation *attachment=NULL)
 Construct a Filter. More...
 
bool Attachable ()
 Determine if attachable. More...
 
BufferedTransformationAttachedTransformation ()
 Retrieve attached transformation. More...
 
const BufferedTransformationAttachedTransformation () const
 Retrieve attached transformation. More...
 
void Detach (BufferedTransformation *newAttachment=NULL)
 Replace an attached transformation. More...
 
- Public Member Functions inherited from BufferedTransformation
virtual ~BufferedTransformation ()
 
 BufferedTransformation ()
 Construct a BufferedTransformation. More...
 
BufferedTransformationRef ()
 Provides a reference to this object. More...
 
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 byteCreatePutSpace (size_t &size)
 Request space which can be written into by the caller. More...
 
virtual bool CanModifyInput () const
 Determines whether input can be modified 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...
 
unsigned int GetMaxWaitObjectCount () const
 Retrieves the maximum number of waitable objects. More...
 
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 Retrieves waitable objects. More...
 
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. More...
 
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...
 
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
 Copy messages from this object to another BufferedTransformation. More...
 
virtual void SkipAll ()
 Skip all messages in the series. More...
 
void TransferAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL)
 Transfer all bytes from this object to another BufferedTransformation. More...
 
void CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const
 Copy messages from this object to another BufferedTransformation. More...
 
virtual bool GetNextMessageSeries ()
 Retrieve the next message in a series. More...
 
virtual unsigned int NumberOfMessagesInThisSeries () const
 Provides the number of messages in a series. More...
 
virtual unsigned int NumberOfMessageSeries () const
 Provides the number of messages in a series. More...
 
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...
 
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 byteChannelCreatePutSpace (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...
 
virtual void Attach (BufferedTransformation *newAttachment)
 Add newAttachment to the end of attachment chain. More...
 
- Public Member Functions inherited from Algorithm
virtual ~Algorithm ()
 
 Algorithm (bool checkSelfTestStatus=true)
 Interface for all crypto algorithms. More...
 
- Public Member Functions inherited from Clonable
virtual ~Clonable ()
 
virtual ClonableClone () const
 Copies this object. More...
 
- Public Member Functions inherited from Waitable
virtual ~Waitable ()
 
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 Wait on this object. More...
 
- Public Member Functions inherited from NotCopyable
 NotCopyable ()
 

Protected Member Functions

void InitializeDerivedAndReturnNewSizes (const NameValuePairs &parameters, size_t &firstSize, size_t &blockSize, size_t &lastSize)
 
void FirstPut (const byte *inString)
 
void NextPutMultiple (const byte *inString, size_t length)
 
void NextPutModifiable (byte *inString, size_t length)
 
void LastPut (const byte *inString, size_t length)
 Input the last block of data. More...
 
- Protected Member Functions inherited from FilterWithBufferedInput
virtual bool DidFirstPut () const
 
virtual size_t GetFirstPutSize () const
 
virtual size_t GetBlockPutSize () const
 
virtual size_t GetLastPutSize () const
 
virtual void InitializeDerived (const NameValuePairs &parameters)
 
virtual void NextPutSingle (const byte *inString)
 
virtual void FlushDerived ()
 
size_t PutMaybeModifiable (byte *begin, size_t length, int messageEnd, bool blocking, bool modifiable)
 
void NextPutMaybeModifiable (byte *inString, size_t length, bool modifiable)
 
virtual int NextPut (const byte *inString, size_t length)
 
- Protected Member Functions inherited from Filter
virtual BufferedTransformationNewDefaultAttachment () const
 
void Insert (Filter *nextFilter)
 
virtual bool ShouldPropagateMessageEnd () const
 
virtual bool ShouldPropagateMessageSeriesEnd () const
 
void PropagateInitialize (const NameValuePairs &parameters, int propagation)
 
size_t Output (int outputSite, const byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Forward processed data on to attached transformation. More...
 
size_t OutputModifiable (int outputSite, byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Output multiple bytes that may be modified by callee. More...
 
bool OutputMessageEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Signals the end of messages to the object. More...
 
bool OutputFlush (int outputSite, bool hardFlush, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Flush buffered input and/or output, with signal propagation. More...
 
bool OutputMessageSeriesEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Marks the end of a series of messages, with signal propagation. More...
 

Static Protected Member Functions

static size_t LastBlockSize (StreamTransformation &c, BlockPaddingScheme padding)
 
- Static Protected Member Functions inherited from BufferedTransformation
static int DecrementPropagation (int propagation)
 Decrements the propagation count while clamping at 0. More...
 

Protected Attributes

StreamTransformationm_cipher
 
BlockPaddingScheme m_padding
 
unsigned int m_optimalBufferSize
 
- Protected Attributes inherited from FilterWithBufferedInput
size_t m_firstSize
 
size_t m_blockSize
 
size_t m_lastSize
 
bool m_firstInputDone
 
BlockQueue m_queue
 
- Protected Attributes inherited from Filter
size_t m_inputPosition
 
int m_continueAt
 

Additional Inherited Members

- Public Types inherited from BlockPaddingSchemeDef
enum  BlockPaddingScheme {
  NO_PADDING, ZEROS_PADDING, PKCS_PADDING, ONE_AND_ZEROS_PADDING,
  DEFAULT_PADDING
}
 Padding schemes used for block ciphers. More...
 
- Static Public Attributes inherited from BufferedTransformation
static const std::string & NULL_CHANNEL = DEFAULT_CHANNEL
 
- Private Member Functions inherited from FilterPutSpaceHelper
virtual ~FilterPutSpaceHelper ()
 
byteHelpCreatePutSpace (BufferedTransformation &target, const std::string &channel, size_t minSize, size_t desiredSize, size_t &bufferSize)
 Create a working space in a BufferedTransformation. More...
 
byteHelpCreatePutSpace (BufferedTransformation &target, const std::string &channel, size_t minSize)
 Create a working space in a BufferedTransformation. More...
 
byteHelpCreatePutSpace (BufferedTransformation &target, const std::string &channel, size_t minSize, size_t bufferSize)
 Create a working space in a BufferedTransformation. More...
 
- Private Attributes inherited from FilterPutSpaceHelper
SecByteBlock m_tempSpace
 Temporay working space. More...
 

Detailed Description

Filter wrapper for StreamTransformation.

StreamTransformationFilter is a filter wrapper for StreamTransformation. The filter will optionally handle padding/unpadding when needed

Definition at line 491 of file filters.h.

Constructor & Destructor Documentation

virtual StreamTransformationFilter::~StreamTransformationFilter ( )
inlinevirtual

Definition at line 494 of file filters.h.

StreamTransformationFilter::StreamTransformationFilter ( StreamTransformation c,
BufferedTransformation attachment = NULL,
BlockPaddingScheme  padding = DEFAULT_PADDING,
bool  allowAuthenticatedSymmetricCipher = false 
)

Construct a StreamTransformationFilter.

Parameters
creference to a StreamTransformation
attachmentan optional attached transformation
paddingthe padding scheme
allowAuthenticatedSymmetricCipherflag indicating whether the filter should allow authenticated encryption schemes

Definition at line 582 of file filters.cpp.

Here is the call graph for this function:

Member Function Documentation

std::string StreamTransformationFilter::AlgorithmName ( ) const
inlinevirtual

Provides the name of this algorithm.

Returns
the standard algorithm name

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.

Note
AlgorithmName is not universally implemented yet

Reimplemented from Algorithm.

Definition at line 503 of file filters.h.

void StreamTransformationFilter::FirstPut ( const byte inString)
protectedvirtual

Implements FilterWithBufferedInput.

Definition at line 622 of file filters.cpp.

Here is the call graph for this function:

void StreamTransformationFilter::InitializeDerivedAndReturnNewSizes ( const NameValuePairs parameters,
size_t &  firstSize,
size_t &  blockSize,
size_t &  lastSize 
)
protectedvirtual

Reimplemented from FilterWithBufferedInput.

Definition at line 604 of file filters.cpp.

Here is the call graph for this function:

size_t StreamTransformationFilter::LastBlockSize ( StreamTransformation c,
BlockPaddingScheme  padding 
)
staticprotected

Definition at line 594 of file filters.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void StreamTransformationFilter::LastPut ( const byte inString,
size_t  length 
)
protectedvirtual

Input the last block of data.

Parameters
inStringthe input byte buffer
lengththe size of the input buffer, in bytes

LastPut() processes the last block of data and signals attached filters to do the same. LastPut() is always called. The pseudo algorithm for the logic is:

    if totalLength < firstSize then length == totalLength
    else if totalLength <= firstSize+lastSize then length == totalLength-firstSize
    else lastSize <= length < lastSize+blockSize

Implements FilterWithBufferedInput.

Reimplemented in AuthenticatedEncryptionFilter.

Definition at line 662 of file filters.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void StreamTransformationFilter::NextPutModifiable ( byte inString,
size_t  length 
)
protectedvirtual

Reimplemented from FilterWithBufferedInput.

Definition at line 656 of file filters.cpp.

Here is the call graph for this function:

void StreamTransformationFilter::NextPutMultiple ( const byte inString,
size_t  length 
)
protectedvirtual

Reimplemented from FilterWithBufferedInput.

Definition at line 629 of file filters.cpp.

Here is the call graph for this function:

Member Data Documentation

StreamTransformation& StreamTransformationFilter::m_cipher
protected

Definition at line 514 of file filters.h.

unsigned int StreamTransformationFilter::m_optimalBufferSize
protected

Definition at line 516 of file filters.h.

BlockPaddingScheme StreamTransformationFilter::m_padding
protected

Definition at line 515 of file filters.h.


The documentation for this class was generated from the following files: