aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorlloyd <[email protected]>2012-07-06 17:43:16 +0000
committerlloyd <[email protected]>2012-07-06 17:43:16 +0000
commitb8870b9659e8f1c5d8b88ff6ee7efc44024c1c41 (patch)
treefbe78d6615e5a81117a4a37caa50de92dcba793a /src
parent53639d4d23ffd547e0d52b1a0b8f59ed24cc4712 (diff)
More Doxygen comments
Diffstat (limited to 'src')
-rw-r--r--src/constructs/srp6/srp6.h5
-rw-r--r--src/pbe/pbes2/pbes2.h10
2 files changed, 12 insertions, 3 deletions
diff --git a/src/constructs/srp6/srp6.h b/src/constructs/srp6/srp6.h
index b34253d7a..d67ce361a 100644
--- a/src/constructs/srp6/srp6.h
+++ b/src/constructs/srp6/srp6.h
@@ -42,6 +42,8 @@ BOTAN_DLL srp6_client_agree(const std::string& username,
* @param identifier a username or other client identifier
* @param password the secret used to authenticate user
* @param salt a randomly chosen value, at least 128 bits long
+* @param group_id specifies the shared SRP group
+* @param hash_id specifies a secure hash function
*/
BigInt BOTAN_DLL generate_srp6_verifier(const std::string& identifier,
const std::string& password,
@@ -52,6 +54,9 @@ BigInt BOTAN_DLL generate_srp6_verifier(const std::string& identifier,
/**
* Return the group id for this SRP param set, or else thrown an
* exception
+* @param N the group modulus
+* @param g the group generator
+* @return group identifier
*/
std::string BOTAN_DLL srp6_group_identifier(const BigInt& N, const BigInt& g);
diff --git a/src/pbe/pbes2/pbes2.h b/src/pbe/pbes2/pbes2.h
index 4c9eb9b8a..5f692cc8a 100644
--- a/src/pbe/pbes2/pbes2.h
+++ b/src/pbe/pbes2/pbes2.h
@@ -27,20 +27,24 @@ class BOTAN_DLL PBE_PKCS5v20 : public PBE
std::string name() const;
- void write(const byte[], size_t);
+ void write(const byte buf[], size_t buf_len);
void start_msg();
void end_msg();
/**
* Load a PKCS #5 v2.0 encrypted stream
- * @param input is the input source
+ * @param params the PBES2 parameters
+ * @param passphrase the passphrase to use for decryption
*/
PBE_PKCS5v20(const std::vector<byte>& params,
const std::string& passphrase);
/**
* @param cipher the block cipher to use
- * @param hash the hash function to use
+ * @param mac the MAC to use
+ * @param passphrase the passphrase to use for encryption
+ * @param msec how many milliseconds to run the PBKDF
+ * @param rng a random number generator
*/
PBE_PKCS5v20(BlockCipher* cipher,
MessageAuthenticationCode* mac,