diff options
| author | Jeffrey Walton <noloader@gmail.com> | 2021-04-16 18:46:16 -0400 |
|---|---|---|
| committer | Jeffrey Walton <noloader@gmail.com> | 2021-04-16 18:46:16 -0400 |
| commit | 8e63b121ae5fbef5187be649ca8ad9051bfd2c49 (patch) | |
| tree | 52e8d520c097863c8be3c1f12eac2f65cdd58dd5 /lsh.h | |
| parent | 8fe0ba4c74bd70b290c3aec6f6da9845d6a1ce70 (diff) | |
| download | cryptopp-git-8e63b121ae5fbef5187be649ca8ad9051bfd2c49.tar.gz | |
Update documentation
Diffstat (limited to 'lsh.h')
| -rw-r--r-- | lsh.h | 32 |
1 files changed, 31 insertions, 1 deletions
@@ -71,6 +71,12 @@ public: /// \details LSH_256 uses LSH256_MSG_BLK_BYTE_LEN for block size, which is 128
CRYPTOPP_CONSTANT(BLOCKSIZE = LSH256_Base::BLOCKSIZE);
+ /// \brief The algorithm's name
+ /// \return the standard algorithm name
+ /// \details The standard algorithm name can be a name like <tt>AES</tt> or <tt>AES/GCM</tt>.
+ /// Some algorithms do not have standard names yet. For example, there is no standard
+ /// algorithm name for Shoup's ECIES.
+ /// \note StaticAlgorithmName is not universally implemented yet.
static std::string StaticAlgorithmName() { return "LSH-224"; }
/// \brief Construct a LSH-224
@@ -94,6 +100,12 @@ public: /// \details LSH_256 uses LSH256_MSG_BLK_BYTE_LEN for block size, which is 128
CRYPTOPP_CONSTANT(BLOCKSIZE = LSH256_Base::BLOCKSIZE);
+ /// \brief The algorithm's name
+ /// \return the standard algorithm name
+ /// \details The standard algorithm name can be a name like <tt>AES</tt> or <tt>AES/GCM</tt>.
+ /// Some algorithms do not have standard names yet. For example, there is no standard
+ /// algorithm name for Shoup's ECIES.
+ /// \note StaticAlgorithmName is not universally implemented yet.
static std::string StaticAlgorithmName() { return "LSH-256"; }
/// \brief Construct a LSH-256
@@ -110,7 +122,7 @@ class LSH512_Base : public HashTransformation {
public:
/// \brief Block size, in bytes
- //// \details LSH_512 uses LSH512_MSG_BLK_BYTE_LEN for block size, which is 256
+ /// \details LSH_512 uses LSH512_MSG_BLK_BYTE_LEN for block size, which is 256
CRYPTOPP_CONSTANT(BLOCKSIZE = 256);
virtual ~LSH512_Base() {}
@@ -157,6 +169,12 @@ public: /// \details LSH_512 uses LSH512_MSG_BLK_BYTE_LEN for block size, which is 256
CRYPTOPP_CONSTANT(BLOCKSIZE = LSH512_Base::BLOCKSIZE);
+ /// \brief The algorithm's name
+ /// \return the standard algorithm name
+ /// \details The standard algorithm name can be a name like <tt>AES</tt> or <tt>AES/GCM</tt>.
+ /// Some algorithms do not have standard names yet. For example, there is no standard
+ /// algorithm name for Shoup's ECIES.
+ /// \note StaticAlgorithmName is not universally implemented yet.
static std::string StaticAlgorithmName() { return "LSH-384"; }
/// \brief Construct a LSH-384
@@ -180,6 +198,12 @@ public: /// \details LSH_512 uses LSH512_MSG_BLK_BYTE_LEN for block size, which is 256
CRYPTOPP_CONSTANT(BLOCKSIZE = LSH512_Base::BLOCKSIZE);
+ /// \brief The algorithm's name
+ /// \return the standard algorithm name
+ /// \details The standard algorithm name can be a name like <tt>AES</tt> or <tt>AES/GCM</tt>.
+ /// Some algorithms do not have standard names yet. For example, there is no standard
+ /// algorithm name for Shoup's ECIES.
+ /// \note StaticAlgorithmName is not universally implemented yet.
static std::string StaticAlgorithmName() { return "LSH-512"; }
/// \brief Construct a LSH-512
@@ -203,6 +227,12 @@ public: /// \details LSH_512 uses LSH512_MSG_BLK_BYTE_LEN for block size, which is 256
CRYPTOPP_CONSTANT(BLOCKSIZE = LSH512_Base::BLOCKSIZE);
+ /// \brief The algorithm's name
+ /// \return the standard algorithm name
+ /// \details The standard algorithm name can be a name like <tt>AES</tt> or <tt>AES/GCM</tt>.
+ /// Some algorithms do not have standard names yet. For example, there is no standard
+ /// algorithm name for Shoup's ECIES.
+ /// \note StaticAlgorithmName is not universally implemented yet.
static std::string StaticAlgorithmName() { return "LSH-512-256"; }
/// \brief Construct a LSH-512-256
|