aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorlloyd <[email protected]>2012-07-09 19:45:46 +0000
committerlloyd <[email protected]>2012-07-09 19:45:46 +0000
commit0dffe4ce78737a8d2d2861621705728c2b08c279 (patch)
tree679ab6d0df25a5ea329a4c98eadc51851d34d167 /src
parente20279e07b37f9cff036b6e4bd6e11532de0f363 (diff)
More Doxygen warning fixes
Diffstat (limited to 'src')
-rw-r--r--src/constructs/srp6/srp6.h9
-rw-r--r--src/pbe/pbes1/pbes1.h3
-rw-r--r--src/pbkdf/pbkdf.h3
3 files changed, 15 insertions, 0 deletions
diff --git a/src/constructs/srp6/srp6.h b/src/constructs/srp6/srp6.h
index d67ce361a..6f3960be1 100644
--- a/src/constructs/srp6/srp6.h
+++ b/src/constructs/srp6/srp6.h
@@ -69,12 +69,21 @@ class BOTAN_DLL SRP6_Server_Session
/**
* Server side step 1
* @param v the verification value saved from client registration
+ * @param group_id the SRP group id
+ * @param hash_id the SRP hash in use
+ * @param rng a random number generator
+ * @return SRP-6 B value
*/
BigInt step1(const BigInt& v,
const std::string& group_id,
const std::string& hash_id,
RandomNumberGenerator& rng);
+ /**
+ * Server side step 2
+ * @param A the client's value
+ * @return shared symmetric key
+ */
SymmetricKey step2(const BigInt& A);
private:
diff --git a/src/pbe/pbes1/pbes1.h b/src/pbe/pbes1/pbes1.h
index 0c921dadd..dd09cee20 100644
--- a/src/pbe/pbes1/pbes1.h
+++ b/src/pbe/pbes1/pbes1.h
@@ -34,6 +34,9 @@ class BOTAN_DLL PBE_PKCS5v15 : public PBE
/**
* @param cipher the block cipher to use (DES or RC2)
* @param hash the hash function to use
+ * @param passphrase the passphrase to use
+ * @param msec how many milliseconds to run the PBKDF
+ * @param rng a random number generator
*/
PBE_PKCS5v15(BlockCipher* cipher,
HashFunction* hash,
diff --git a/src/pbkdf/pbkdf.h b/src/pbkdf/pbkdf.h
index 176ed0302..2508dc6a3 100644
--- a/src/pbkdf/pbkdf.h
+++ b/src/pbkdf/pbkdf.h
@@ -68,6 +68,9 @@ class BOTAN_DLL PBKDF : public Algorithm
* @param salt a randomly chosen salt
* @param salt_len length of salt in bytes
* @param iterations the number of iterations to use (use 10K or more)
+ * @param msec if iterations is zero, then instead the PBKDF is
+ * run until msec milliseconds has passed.
+ * @return the number of iterations performed and the derived key
*/
virtual std::pair<size_t, OctetString>
key_derivation(size_t output_len,