Changeset 102491 in vbox for trunk/include

Timestamp:

Dec 6, 2023 12:48:47 AM (14 months ago)

Author:

vboxsync

Message:

IRPT/shacrypt: Minor cleanups, doxygen fix. bugref:10551

File:

• trunk/include/iprt/crypto/shacrypt.h (modified) (4 diffs)

trunk/include/iprt/crypto/shacrypt.h

@@ -115 +115 @@
  *                      RT_SHACRYPT_MAX_SALT_LEN, both inclusive.
  *
- * @param   cRounds     Number of rounds to use (@see
- *                      RT_SHACRYPT_ROUNDS_DEFAULT).  This is ignored if the
- *                      salt includes a 'rounds=xxx$' part.
+ * @param   cRounds     Number of rounds to use, must be in the range
+ *                      RT_SHACRYPT_ROUNDS_MIN thru RT_SHACRYPT_ROUNDS_MAX.
+ *                      If unsure, use RT_SHACRYPT_ROUNDS_DEFAULT.  This is
+ *                      ignored if the salt includes a 'rounds=xxx$' part.
  * @param   pszString   Where to store the string on success.
  * @param   cbString    The size of the buffer pointed to by @a pszString.
@@ -145 +146 @@
  *                      RT_SHACRYPT_MAX_SALT_LEN, both inclusive.
  *
+ * @param   cRounds     Number of rounds to use, must be in the range
+ *                      RT_SHACRYPT_ROUNDS_MIN thru RT_SHACRYPT_ROUNDS_MAX.
+ *                      If unsure, use RT_SHACRYPT_ROUNDS_DEFAULT.  This is
+ *                      ignored if the salt includes a 'rounds=xxx$' part.
  * @param   pszString   Where to store the string on success.
  * @param   cbString    The size of the buffer pointed to by @a pszString.
@@ -175 +180 @@
  *                      RT_SHACRYPT_MAX_SALT_LEN, both inclusive.
  *
- * @param   cRounds     Number of rounds to use (@see
- *                      RT_SHACRYPT_ROUNDS_DEFAULT).
+ * @param   cRounds     Number of rounds to use, must be in the range
+ *                      RT_SHACRYPT_ROUNDS_MIN thru RT_SHACRYPT_ROUNDS_MAX.
+ *                      If unsure, use RT_SHACRYPT_ROUNDS_DEFAULT.  This is
+ *                      ignored if the salt includes a 'rounds=xxx$' part.
  * @param   pabHash     Where to return the hash on success.
  * @see     RTCrShaCrypt256, RTCrShaCrypt256ToString
@@ -201 +208 @@
  *                      RT_SHACRYPT_MAX_SALT_LEN, both inclusive.
  *
- * @param   cRounds     Number of rounds to use (@see
- *                      RT_SHACRYPT_ROUNDS_DEFAULT).
+ * @param   cRounds     Number of rounds to use, must be in the range
+ *                      RT_SHACRYPT_ROUNDS_MIN thru RT_SHACRYPT_ROUNDS_MAX.
+ *                      If unsure, use RT_SHACRYPT_ROUNDS_DEFAULT.  This is
+ *                      ignored if the salt includes a 'rounds=xxx$' part.
  * @param   pabHash     Where to return the hash on success.
  * @see     RTCrShaCrypt512, RTCrShaCrypt512ToString