summaryrefslogtreecommitdiff
path: root/scrypt.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2018-03-31 21:26:38 -0400
committerJeffrey Walton <noloader@gmail.com>2018-03-31 21:26:38 -0400
commit2e8ccc77773fa52c421c0322d1bafa2dd47653fe (patch)
tree9de5167092765e1592e372ce3689c5650b0ef008 /scrypt.h
parent129d65d987de231c200b5339e3ef978e9d1c475a (diff)
downloadcryptopp-git-2e8ccc77773fa52c421c0322d1bafa2dd47653fe.tar.gz
Update documentation
Add asserts to Scrypt ValidateParameters
Diffstat (limited to 'scrypt.h')
-rw-r--r--scrypt.h8
1 files changed, 3 insertions, 5 deletions
diff --git a/scrypt.h b/scrypt.h
index d52738dc..3f0fce02 100644
--- a/scrypt.h
+++ b/scrypt.h
@@ -15,12 +15,13 @@
#include "cryptlib.h"
#include "secblock.h"
-#include "algparam.h"
NAMESPACE_BEGIN(CryptoPP)
/// \brief Scrypt key derivation function
-/// \sa <A HREF="https://www.tarsnap.com/scrypt.html">The scrypt key derivation function</A>
+/// \sa <A HREF="https://www.tarsnap.com/scrypt/scrypt.pdf">Stronger Key Derivation via
+/// Sequential Memory-Hard Functions</a>,
+/// <A HREF="https://www.tarsnap.com/scrypt.html">The scrypt key derivation function</A>
/// and <A HREF="https://tools.ietf.org/html/rfc7914">RFC 7914, The scrypt Password-Based
/// Key Derivation Function</A>
/// \since Crypto++ 6.2
@@ -71,9 +72,6 @@ public:
/// size.
/// \details The <tt>parallelization</tt> parameter ("p" in the documents) is a positive
/// integer less than or equal to <tt>((2^32-1) * 32) / (128 * r)</tt>.
- /// \details Crypto++ uses <tt>size_t</tt> for its size datatype, and limits are
- /// based on the 32-bit version of <tt>size_t</tt>. For example, <tt>cost</tt> is
- /// limited to <tt>0xffffffff</tt> instead of <tt>2^(128 * r / 8)</tt>.
/// \details Scrypt always returns 1 because it only performs 1 iteration. Other
/// derivation functions, like PBKDF's, will return more interesting values.
size_t DeriveKey(byte *derived, size_t derivedLen, const byte *secret, size_t secretLen,