diff options
author | Jeffrey Walton <noloader@gmail.com> | 2018-01-22 19:50:11 -0500 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2018-01-22 19:50:11 -0500 |
commit | e3d79bf98c3d068c4be602c544a0b2dec207d5a1 (patch) | |
tree | 76684c8413e4f5120a063b28f772316d3afcfa9c /pssr.h | |
parent | 27cbfe03d6d3d4c533eb94557081307853030d14 (diff) | |
download | cryptopp-git-e3d79bf98c3d068c4be602c544a0b2dec207d5a1.tar.gz |
Update documentation
Diffstat (limited to 'pssr.h')
-rw-r--r-- | pssr.h | 7 |
1 files changed, 7 insertions, 0 deletions
@@ -2,6 +2,7 @@ /// \file pssr.h
/// \brief Classes for probablistic signature schemes
+/// \since Crypto++ 2.1
#ifndef CRYPTOPP_PSSR_H
#define CRYPTOPP_PSSR_H
@@ -17,6 +18,7 @@ NAMESPACE_BEGIN(CryptoPP)
/// \brief PSSR Message Encoding Method interface
+/// \since Crypto++ 2.1
class CRYPTOPP_DLL PSSR_MEM_Base : public PK_RecoverableSignatureMessageEncodingMethod
{
public:
@@ -46,6 +48,7 @@ private: /// \brief PSSR Message Encoding Method with Hash Identifier
/// \tparam USE_HASH_ID flag indicating whether the HashId is used
+/// \since Crypto++ 2.1
template <bool USE_HASH_ID> class PSSR_MEM_BaseWithHashId;
/// \brief PSSR Message Encoding Method with Hash Identifier
@@ -54,6 +57,7 @@ template<> class PSSR_MEM_BaseWithHashId<true> : public EMSA2HashIdLookup<PSSR_M /// \brief PSSR Message Encoding Method without Hash Identifier
/// \details If USE_HASH_ID is false, then PSSR_MEM_Base is used for the base class
+/// \since Crypto++ 2.1
template<> class PSSR_MEM_BaseWithHashId<false> : public PSSR_MEM_Base {};
/// \brief PSSR Message Encoding Method
@@ -65,6 +69,7 @@ template<> class PSSR_MEM_BaseWithHashId<false> : public PSSR_MEM_Base {}; /// \details If ALLOW_RECOVERY is true, the the signature scheme provides message recovery. If
/// ALLOW_RECOVERY is false, the the signature scheme is appendix, and the message must be
/// provided during verification.
+/// \since Crypto++ 2.1
template <bool ALLOW_RECOVERY, class MGF=P1363_MGF1, int SALT_LEN=-1, int MIN_PAD_LEN=0, bool USE_HASH_ID=false>
class PSSR_MEM : public PSSR_MEM_BaseWithHashId<USE_HASH_ID>
{
@@ -80,6 +85,7 @@ public: /// \brief Probabilistic Signature Scheme with Recovery
/// \details Signature Schemes with Recovery encode the message with the signature.
/// \sa <a href="http://www.weidai.com/scan-mirror/sig.html#sem_PSSR-MGF1">PSSR-MGF1</a>
+/// \since Crypto++ 2.1
struct PSSR : public SignatureStandard
{
typedef PSSR_MEM<true> SignatureMessageEncodingMethod;
@@ -88,6 +94,7 @@ struct PSSR : public SignatureStandard /// \brief Probabilistic Signature Scheme with Appendix
/// \details Signature Schemes with Appendix require the message to be provided during verification.
/// \sa <a href="http://www.weidai.com/scan-mirror/sig.html#sem_PSS-MGF1">PSS-MGF1</a>
+/// \since Crypto++ 2.1
struct PSS : public SignatureStandard
{
typedef PSSR_MEM<false> SignatureMessageEncodingMethod;
|