Filter wrapper for decrypting with AuthenticatedSymmetricCipher. More...

#include <filters.h>

Inheritance diagram for AuthenticatedDecryptionFilter:

Public Types
enum	Flags { MAC_AT_END =0 , MAC_AT_BEGIN =1 , THROW_EXCEPTION =16 , DEFAULT_FLAGS = THROW_EXCEPTION }
	Flags controlling filter behavior. More...

Public Types inherited from BlockPaddingSchemeDef
enum	BlockPaddingScheme { NO_PADDING , ZEROS_PADDING , PKCS_PADDING , ONE_AND_ZEROS_PADDING , W3C_PADDING , DEFAULT_PADDING }
	Padding schemes used for block ciphers. More...

Public Member Functions
	AuthenticatedDecryptionFilter (AuthenticatedSymmetricCipher &c, BufferedTransformation *attachment=NULL, word32 flags=DEFAULT_FLAGS, int truncatedDigestSize=-1, BlockPaddingScheme padding=DEFAULT_PADDING)
	Construct a AuthenticatedDecryptionFilter.

std::string	AlgorithmName () const
	Provides the name of this algorithm.

byte *	ChannelCreatePutSpace (const std::string &channel, size_t &size)
	Request space which can be written into by the caller.

size_t	ChannelPut2 (const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)
	Input multiple bytes for processing on a channel.

size_t	ChannelPutModifiable2 (const std::string &channel, byte *begin, size_t length, int messageEnd, bool blocking)
	Input multiple bytes that may be modified by callee on a channel.

bool	GetLastResult () const
	Get verifier result.

Public Member Functions inherited from FilterWithBufferedInput
	FilterWithBufferedInput (BufferedTransformation *attachment)
	Construct a FilterWithBufferedInput with an attached transformation.

	FilterWithBufferedInput (size_t firstSize, size_t blockSize, size_t lastSize, BufferedTransformation *attachment)
	Construct a FilterWithBufferedInput with an attached transformation.

void	IsolatedInitialize (const NameValuePairs &parameters)
	Initialize or reinitialize this object, without signal propagation.

size_t	Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes for processing.

size_t	PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes that may be modified by callee.

bool	IsolatedFlush (bool hardFlush, bool blocking)
	Flushes data buffered by this object, without signal propagation.

void	ForceNextPut ()
	Flushes data buffered by this object.

Public Member Functions inherited from Filter
	Filter (BufferedTransformation *attachment=NULL)
	Construct a Filter.

bool	Attachable ()
	Determine if attachable.

BufferedTransformation *	AttachedTransformation ()
	Retrieve attached transformation.

const BufferedTransformation *	AttachedTransformation () const
	Retrieve attached transformation.

void	Detach (BufferedTransformation *newAttachment=NULL)
	Replace an attached transformation.

size_t	TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
	Transfer bytes from this object to another BufferedTransformation.

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.

void	Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
	Initialize or reinitialize this object, with signal propagation.

bool	Flush (bool hardFlush, int propagation=-1, bool blocking=true)
	Flush buffered input and/or output, with signal propagation.

bool	MessageSeriesEnd (int propagation=-1, bool blocking=true)
	Marks the end of a series of messages, with signal propagation.

Public Member Functions inherited from BufferedTransformation
	BufferedTransformation ()
	Construct a BufferedTransformation.

BufferedTransformation &	Ref ()
	Provides a reference to this object.

virtual void	Attach (BufferedTransformation *newAttachment)
	Add newAttachment to the end of attachment chain.

size_t	Put (byte inByte, bool blocking=true)
	Input a byte for processing.

size_t	Put (const byte *inString, size_t length, bool blocking=true)
	Input a byte buffer for processing.

size_t	PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 16-bit word for processing.

size_t	PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 32-bit word for processing.

size_t	PutWord64 (word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 64-bit word for processing.

virtual byte *	CreatePutSpace (size_t &size)
	Request space which can be written into by the caller.

virtual bool	CanModifyInput () const
	Determines whether input can be modified by the callee.

size_t	PutModifiable (byte *inString, size_t length, bool blocking=true)
	Input multiple bytes that may be modified by callee.

bool	MessageEnd (int propagation=-1, bool blocking=true)
	Signals the end of messages to the object.

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.

unsigned int	GetMaxWaitObjectCount () const
	Retrieves the maximum number of waitable objects.

void	GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
	Retrieves waitable objects.

virtual bool	IsolatedMessageSeriesEnd (bool blocking)
	Marks the end of a series of messages, without signal propagation.

virtual void	SetAutoSignalPropagation (int propagation)
	Set propagation of automatically generated and transferred signals.

virtual int	GetAutoSignalPropagation () const
	Retrieve automatic signal propagation value.

virtual lword	MaxRetrievable () const
	Provides the number of bytes ready for retrieval.

virtual bool	AnyRetrievable () const
	Determines whether bytes are ready for retrieval.

virtual size_t	Get (byte &outByte)
	Retrieve a 8-bit byte.

virtual size_t	Get (byte *outString, size_t getMax)
	Retrieve a block of bytes.

virtual size_t	Peek (byte &outByte) const
	Peek a 8-bit byte.

virtual size_t	Peek (byte *outString, size_t peekMax) const
	Peek a block of bytes.

size_t	GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
	Retrieve a 16-bit word.

size_t	GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
	Retrieve a 32-bit word.

size_t	GetWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER)
	Retrieve a 64-bit word.

size_t	PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
	Peek a 16-bit word.

size_t	PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
	Peek a 32-bit word.

size_t	PeekWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
	Peek a 64-bit word.

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

virtual lword	Skip (lword skipMax=LWORD_MAX)
	Discard skipMax bytes from the output buffer.

lword	CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
	Copy bytes from this object to another BufferedTransformation.

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.

virtual lword	TotalBytesRetrievable () const
	Provides the number of bytes ready for retrieval.

virtual unsigned int	NumberOfMessages () const
	Provides the number of meesages processed by this object.

virtual bool	AnyMessages () const
	Determines if any messages are available for retrieval.

virtual bool	GetNextMessage ()
	Start retrieving the next message.

virtual unsigned int	SkipMessages (unsigned int count=UINT_MAX)
	Skip a number of meessages.

unsigned int	TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL)
	Transfer messages from this object to another BufferedTransformation.

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.

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.

void	CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const
	Copy messages from this object to another BufferedTransformation.

virtual bool	GetNextMessageSeries ()
	Retrieve the next message in a series.

virtual unsigned int	NumberOfMessagesInThisSeries () const
	Provides the number of messages in a series.

virtual unsigned int	NumberOfMessageSeries () const
	Provides the number of messages in a series.

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.

size_t	TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
	Transfer all bytes from this object to another BufferedTransformation.

size_t	ChannelPut (const std::string &channel, byte inByte, bool blocking=true)
	Input a byte for processing on a channel.

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.

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.

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.

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.

size_t	ChannelPutWord64 (const std::string &channel, word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 64-bit word for processing on a channel.

bool	ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true)
	Signal the end of a message.

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.

virtual bool	ChannelFlush (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)
	Flush buffered input and/or output on a channel.

virtual bool	ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true)
	Marks the end of a series of messages on a channel.

virtual void	SetRetrievalChannel (const std::string &channel)
	Sets the default retrieval channel.

Public Member Functions inherited from Algorithm
	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms.

virtual std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm.

Public Member Functions inherited from Clonable
virtual Clonable *	Clone () const
	Copies this object.

Public Member Functions inherited from Waitable
bool	Wait (unsigned long milliseconds, CallStack const &callStack)
	Wait on this object.

Detailed Description

Filter wrapper for decrypting with AuthenticatedSymmetricCipher.

AuthenticatedDecryptionFilter() is a wrapper for decrypting with AuthenticatedSymmetricCipher(), optionally handling padding/unpadding when needed.

AuthenticatedDecryptionFilter() for Crypto++ 8.2 and earlier had a bug where a FileSource() would cause an exception, but a StringSource() was OK. Also see Issue 817 and Commit ff110c6e183e.

See also: AuthenticatedSymmetricCipher, AuthenticatedEncryptionFilter, EAX, CCM, GCM, and AadSource on the Crypto++ wiki.

Since: Crypto++ 5.6.0

Definition at line 731 of file filters.h.

Member Enumeration Documentation

◆ Flags

enum AuthenticatedDecryptionFilter::Flags

Flags controlling filter behavior.

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

Enumerator
MAC_AT_END	The MAC is at the end of the message (i.e., concatenation of message+mac)
MAC_AT_BEGIN	The MAC is at the beginning of the message (i.e., concatenation of mac+message)
THROW_EXCEPTION	The filter should throw a HashVerificationFailed if a failure is encountered.
DEFAULT_FLAGS	Default flags using THROW_EXCEPTION.

Definition at line 737 of file filters.h.

Constructor & Destructor Documentation

◆ ~AuthenticatedDecryptionFilter()

virtual AuthenticatedDecryptionFilter::~AuthenticatedDecryptionFilter ( )

inlinevirtual

Definition at line 748 of file filters.h.

◆ AuthenticatedDecryptionFilter()

AuthenticatedDecryptionFilter::AuthenticatedDecryptionFilter	(	AuthenticatedSymmetricCipher &	c,
		BufferedTransformation *	attachment = NULL,
		word32	flags = DEFAULT_FLAGS,
		int	truncatedDigestSize = -1,
		BlockPaddingScheme	padding = DEFAULT_PADDING )

Construct a AuthenticatedDecryptionFilter.

Parameters

c	reference to a AuthenticatedSymmetricCipher
attachment	an optional attached transformation
flags	flags indicating behaviors for the filter
truncatedDigestSize	the size of the digest
padding	the padding scheme

Additional authenticated data should be given in channel "AAD".

truncatedDigestSize = -1 indicates DigestSize should be used.

Since: Crypto++ 5.6.0

Member Function Documentation

◆ AlgorithmName()

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

◆ ChannelCreatePutSpace()

byte * AuthenticatedDecryptionFilter::ChannelCreatePutSpace	(	const std::string &	channel,
		size_t &	size )

virtual

Request space which can be written into by the caller.

Parameters

channel	the channel to process the data
size	the requested size of the buffer

Returns: a pointer to a memory block with length size

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.

Note: Some objects, like ArraySink(), cannot create a space because its fixed. In the case of an ArraySink(), the pointer to the array is returned and the size is remaining size.

Reimplemented from BufferedTransformation.

◆ ChannelPut2()

size_t AuthenticatedDecryptionFilter::ChannelPut2	(	const std::string &	channel,
		const byte *	inString,
		size_t	length,
		int	messageEnd,
		bool	blocking )

virtual

Input multiple bytes for processing on a channel.

Parameters

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.

Returns: the number of bytes that remain to be processed (i.e., bytes not processed)

Reimplemented from BufferedTransformation.

◆ ChannelPutModifiable2()

size_t AuthenticatedDecryptionFilter::ChannelPutModifiable2	(	const std::string &	channel,
		byte *	inString,
		size_t	length,
		int	messageEnd,
		bool	blocking )

inlinevirtual

Input multiple bytes that may be modified by callee on a channel.

Parameters

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

Returns: the number of bytes that remain to be processed (i.e., bytes not processed)

Reimplemented from BufferedTransformation.

Definition at line 764 of file filters.h.

◆ GetLastResult()

bool AuthenticatedDecryptionFilter::GetLastResult ( ) const

inline

Get verifier result.

Returns: true if the digest on the previosus message was valid, false otherwise

Definition at line 768 of file filters.h.

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

filters.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Flags

Constructor & Destructor Documentation

◆ ~AuthenticatedDecryptionFilter()

◆ AuthenticatedDecryptionFilter()

Member Function Documentation

◆ AlgorithmName()

◆ ChannelCreatePutSpace()

◆ ChannelPut2()

◆ ChannelPutModifiable2()

◆ GetLastResult()