Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Classes | Public Types | Public Member Functions | Friends | List of all members
HashVerificationFilter Class Reference

Filter wrapper for HashTransformation. More...

+ Inheritance diagram for HashVerificationFilter:

Classes

class  HashVerificationFailed
 Exception thrown when a data integrity check failure is encountered. More...
 

Public Types

enum  Flags {
  HASH_AT_END =0, HASH_AT_BEGIN =1, PUT_MESSAGE =2, PUT_HASH =4,
  PUT_RESULT =8, THROW_EXCEPTION =16, DEFAULT_FLAGS = HASH_AT_BEGIN | PUT_RESULT
}
 Flags controlling filter behavior. More...
 

Public Member Functions

 HashVerificationFilter (HashTransformation &hm, BufferedTransformation *attachment=NULL, word32 flags=DEFAULT_FLAGS, int truncatedDigestSize=-1)
 Construct a HashVerificationFilter. More...
 
std::string AlgorithmName () const
 Provides the name of this algorithm. More...
 
bool GetLastResult () const
 
- Public Member Functions inherited from FilterWithBufferedInput
 FilterWithBufferedInput ()
 default FilterWithBufferedInput for temporaries
 
 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)
 
void ForceNextPut ()
 
- Public Member Functions inherited from 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
 BufferedTransformation ()
 Construct a BufferedTransformation.
 
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 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...
 
unsigned int GetMaxWaitObjectCount () const
 Retrieves the maximum number of waitable objects.
 
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.
 
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 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...
 
virtual void Attach (BufferedTransformation *newAttachment)
 Add newAttachment to the end of attachment chain. More...
 
- Public Member Functions inherited from Algorithm
 Algorithm (bool checkSelfTestStatus=true)
 Interface for all crypto algorithms. More...
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object. More...
 
- Public Member Functions inherited from Waitable
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 Wait on this object. More...
 

Friends

class AuthenticatedDecryptionFilter
 

Additional Inherited Members

- Static Public Attributes inherited from BufferedTransformation
static const std::string & NULL_CHANNEL = DEFAULT_CHANNEL
 

Detailed Description

Filter wrapper for HashTransformation.

Definition at line 535 of file filters.h.

Member Enumeration Documentation

Flags controlling filter behavior.

The flags are a bitmask and can be OR'd together.

Enumerator
HASH_AT_END 

Indicates the hash is at the end of the message (i.e., concatenation of message+hash)

HASH_AT_BEGIN 

Indicates the hash is at the beginning of the message (i.e., concatenation of hash+message)

PUT_MESSAGE 

Indicates the message should be passed to an attached transformation.

PUT_HASH 

Indicates the hash should be passed to an attached transformation.

PUT_RESULT 

Indicates the result of the verification should be passed to an attached transformation.

THROW_EXCEPTION 

Indicates the filter should throw a HashVerificationFailed if a failure is encountered.

DEFAULT_FLAGS 

Default flags using HASH_AT_BEGIN and PUT_RESULT.

Definition at line 550 of file filters.h.

Constructor & Destructor Documentation

HashVerificationFilter::HashVerificationFilter ( HashTransformation hm,
BufferedTransformation attachment = NULL,
word32  flags = DEFAULT_FLAGS,
int  truncatedDigestSize = -1 
)

Construct a HashVerificationFilter.

Parameters
hmreference to a HashTransformation
attachmentan optional attached transformation
flagsflags indicating behaviors for the filter
truncatedDigestSizethe size of the digest

truncatedDigestSize = -1 indicates DigestSize should be used.

Definition at line 799 of file filters.cpp.

Member Function Documentation

std::string HashVerificationFilter::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 575 of file filters.h.


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