diff --git a/ccm.h b/ccm.h
index 56815f8e..722bb27d 100644
--- a/ccm.h
+++ b/ccm.h
@@ -31,10 +31,10 @@ public:
{return GetBlockCipher().MaxKeyLength();}
size_t DefaultKeyLength() const
{return GetBlockCipher().DefaultKeyLength();}
- size_t GetValidKeyLength(size_t n) const
- {return GetBlockCipher().GetValidKeyLength(n);}
- bool IsValidKeyLength(size_t n) const
- {return GetBlockCipher().IsValidKeyLength(n);}
+ size_t GetValidKeyLength(size_t keylength) const
+ {return GetBlockCipher().GetValidKeyLength(keylength);}
+ bool IsValidKeyLength(size_t keylength) const
+ {return GetBlockCipher().IsValidKeyLength(keylength);}
unsigned int OptimalDataAlignment() const
{return GetBlockCipher().OptimalDataAlignment();}
IV_Requirement IVRequirement() const
diff --git a/cryptlib.h b/cryptlib.h
index 9ac0e8a8..a2713b61 100644
--- a/cryptlib.h
+++ b/cryptlib.h
@@ -549,7 +549,7 @@ public:
//! then the function returns MAX_KEYLENGTH. if If keylength is a multiple of KEYLENGTH_MULTIPLE,
//! then keylength is returned. Otherwise, the function returns a \a lower multiple of
//! KEYLENGTH_MULTIPLE.
- virtual size_t GetValidKeyLength(size_t n) const =0;
+ virtual size_t GetValidKeyLength(size_t keylength) const =0;
//! \brief Returns whether keylength is a valid key length
//! \param keylength the requested keylength
diff --git a/filters.h b/filters.h
index 67caf9f1..faec51ab 100644
--- a/filters.h
+++ b/filters.h
@@ -384,7 +384,7 @@ protected:
//! \details 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
+ //! if totalLength < firstSize then length == totalLength
//! else if totalLength <= firstSize+lastSize then length == totalLength-firstSize
//! else lastSize <= length < lastSize+blockSize
//!
@@ -638,7 +638,7 @@ public:
//! \details 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
+ //! if totalLength < firstSize then length == totalLength
//! else if totalLength <= firstSize+lastSize then length == totalLength-firstSize
//! else lastSize <= length < lastSize+blockSize
//!
@@ -698,7 +698,7 @@ protected:
//! \details 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
+ //! if totalLength < firstSize then length == totalLength
//! else if totalLength <= firstSize+lastSize then length == totalLength-firstSize
//! else lastSize <= length < lastSize+blockSize
//!
@@ -887,13 +887,22 @@ private:
word32 m_behavior;
};
-// Used By ProxyFilter
+//! \class OutputProxy
+//! \brief Filter class that is a proxy for a sink
+//! \details Used By ProxyFilter
class CRYPTOPP_DLL OutputProxy : public CustomSignalPropagation
{
public:
+ //! \brief Construct an OutputProxy
+ //! \param owner the owning transformation
+ //! \param passSignal flag indicating if signals should be passed
OutputProxy(BufferedTransformation &owner, bool passSignal) : m_owner(owner), m_passSignal(passSignal) {}
+ //! \brief Retrieve passSignal flag
+ //! \returns flag indicating if signals should be passed
bool GetPassSignal() const {return m_passSignal;}
+ //! \brief Set passSignal flag
+ //! \param passSignal flag indicating if signals should be passed
void SetPassSignal(bool passSignal) {m_passSignal = passSignal;}
byte * CreatePutSpace(size_t &size)
@@ -969,7 +978,7 @@ public:
//! \details 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
+ //! if totalLength < firstSize then length == totalLength
//! else if totalLength <= firstSize+lastSize then length == totalLength-firstSize
//! else lastSize <= length < lastSize+blockSize
//!
diff --git a/simple.h b/simple.h
index afe06c75..e6a334aa 100644
--- a/simple.h
+++ b/simple.h
@@ -153,16 +153,31 @@ public:
};
//! \class CustomFlushPropagation
-//! \brief Provides interface for custom flush signals
-//! \tparam T the class or type
-//! \details T should be a BufferedTransformation derived class
+//! \brief Interface for custom flush signals propagation
+//! \tparam T BufferedTransformation derived class
template
class CRYPTOPP_NO_VTABLE CustomFlushPropagation : public T
{
public:
//! \name SIGNALS
//@{
+
+ //! \brief Flush buffered input and/or output, with signal propagation
+ //! \param hardFlush is used to indicate whether all data should be flushed
+ //! \param propagation the number of attached transformations the Flush() signal should be passed
+ //! \param blocking specifies whether the object should block when processing input
+ //! \details propagation count includes this object. Setting propagation to 1 means this
+ //! object only. Setting propagation to -1 means unlimited propagation.
+ //! \note Hard flushes must be used with care. It means try to process and output everything, even if
+ //! there may not be enough data to complete the action. For example, hard flushing a HexDecoder
+ //! would cause an error if you do it after inputing an odd number of hex encoded characters.
+ //! \note For some types of filters, like ZlibDecompressor, hard flushes can only
+ //! be done at "synchronization points". These synchronization points are positions in the data
+ //! stream that are created by hard flushes on the corresponding reverse filters, in this
+ //! example ZlibCompressor. This is useful when zlib compressed data is moved across a
+ //! network in packets and compression state is preserved across packets, as in the SSH2 protocol.
virtual bool Flush(bool hardFlush, int propagation=-1, bool blocking=true) =0;
+
//@}
private:
@@ -171,13 +186,20 @@ private:
};
//! \class CustomSignalPropagation
-//! \brief Provides interface for initialization of derived filters
-//! \tparam T the class or type
-//! \details T should be a BufferedTransformation derived class
+//! \brief Interface for custom flush signals
+//! \tparam T BufferedTransformation derived class
template
class CRYPTOPP_NO_VTABLE CustomSignalPropagation : public CustomFlushPropagation
{
public:
+ //! \brief Initialize or reinitialize this object, with signal propagation
+ //! \param parameters a set of NameValuePairs to initialize or reinitialize this object
+ //! \param propagation the number of attached transformations the Initialize() signal should be passed
+ //! \details 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.
+ //! \details propagation count includes this object. Setting propagation to 1 means this
+ //! object only. Setting propagation to -1 means unlimited propagation.
virtual void Initialize(const NameValuePairs ¶meters=g_nullNameValuePairs, int propagation=-1) =0;
private:
@@ -186,7 +208,7 @@ private:
};
//! \class Multichannel
-//! \brief Provides multiple channels support for custom flush signal processing
+//! \brief Multiple channels support for custom signal processing
//! \tparam T the class or type
//! \details T should be a BufferedTransformation derived class
template
@@ -195,12 +217,45 @@ class CRYPTOPP_NO_VTABLE Multichannel : public CustomFlushPropagation
public:
bool Flush(bool hardFlush, int propagation=-1, bool blocking=true)
{return this->ChannelFlush(DEFAULT_CHANNEL, hardFlush, propagation, blocking);}
+
+ //! \brief Marks the end of a series of messages, with signal propagation
+ //! \param propagation the number of attached transformations the MessageSeriesEnd() signal should be passed
+ //! \param blocking specifies whether the object should block when processing input
+ //! \details 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.
+ //! \details propagation count includes this object. Setting propagation to 1 means this
+ //! object only. Setting propagation to -1 means unlimited propagation.
+ //! \note There should be a MessageEnd() immediately before MessageSeriesEnd().
bool MessageSeriesEnd(int propagation=-1, bool blocking=true)
{return this->ChannelMessageSeriesEnd(DEFAULT_CHANNEL, propagation, blocking);}
+
+ //! \brief Request space which can be written into by the caller
+ //! \param size the requested size of the buffer
+ //! \details The purpose of this method is to help avoid extra memory allocations.
+ //! \details size is an \a IN and \a 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.
+ //! \details 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.
byte * CreatePutSpace(size_t &size)
{return this->ChannelCreatePutSpace(DEFAULT_CHANNEL, size);}
+
+ //! \brief Input multiple bytes for processing
+ //! \param inString the byte buffer to process
+ //! \param length the size of the string, in bytes
+ //! \param messageEnd means how many filters to signal MessageEnd() to, including this one
+ //! \param blocking specifies whether the object should block when processing input
+ //! \details Derived classes must implement Put2().
size_t Put2(const byte *inString, size_t length, int messageEnd, bool blocking)
{return this->ChannelPut2(DEFAULT_CHANNEL, inString, length, messageEnd, blocking);}
+
+ //! \brief Input multiple bytes that may be modified by callee.
+ //! \param inString the byte buffer to process.
+ //! \param length the size of the string, in bytes.
+ //! \param messageEnd means how many filters to signal MessageEnd() to, including this one.
+ //! \param blocking specifies whether the object should block when processing input.
+ //! \details Internally, PutModifiable2() calls Put2().
size_t PutModifiable2(byte *inString, size_t length, int messageEnd, bool blocking)
{return this->ChannelPutModifiable2(DEFAULT_CHANNEL, inString, length, messageEnd, blocking);}
@@ -220,12 +275,13 @@ public:
//! \class AutoSignaling
//! \brief Provides auto signaling support
-//! \tparam T the class or type
-//! \details T should be a BufferedTransformation derived class
+//! \tparam T BufferedTransformation derived class
template
class CRYPTOPP_NO_VTABLE AutoSignaling : public T
{
public:
+ //! \brief Construct an AutoSignaling
+ //! \param propagation the propagation count
AutoSignaling(int propagation=-1) : m_autoSignalPropagation(propagation) {}
void SetAutoSignalPropagation(int propagation)
@@ -239,8 +295,7 @@ private:
//! \class Store
//! \brief Acts as a Source for pre-existing, static data
-//! \tparam T the class or type
-//! \details A BufferedTransformation that only contains pre-existing data as "output"
+//! \tparam T BufferedTransformation that only contains pre-existing data as "output"
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Store : public AutoSignaling >
{
public: