aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/misc
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/misc')
-rw-r--r--src/lib/misc/pem/pem.h10
-rw-r--r--src/lib/misc/srp6/srp6_files.h8
2 files changed, 18 insertions, 0 deletions
diff --git a/src/lib/misc/pem/pem.h b/src/lib/misc/pem/pem.h
index aaae5ee35..acbd40a77 100644
--- a/src/lib/misc/pem/pem.h
+++ b/src/lib/misc/pem/pem.h
@@ -16,6 +16,10 @@ namespace PEM_Code {
/**
* Encode some binary data in PEM format
+* @param data binary data to encode
+* @param data_len length of binary data in bytes
+* @param label PEM label put after BEGIN and END
+* @param line_width after this many characters, a new line is inserted
*/
BOTAN_DLL std::string encode(const byte data[],
size_t data_len,
@@ -24,6 +28,9 @@ BOTAN_DLL std::string encode(const byte data[],
/**
* Encode some binary data in PEM format
+* @param data binary data to encode
+* @param label PEM label
+* @param line_width after this many characters, a new line is inserted
*/
inline std::string encode(const std::vector<byte>& data,
const std::string& label,
@@ -34,6 +41,9 @@ inline std::string encode(const std::vector<byte>& data,
/**
* Encode some binary data in PEM format
+* @param data binary data to encode
+* @param label PEM label put after BEGIN and END
+* @param line_width after this many characters, a new line is inserted
*/
inline std::string encode(const secure_vector<byte>& data,
const std::string& label,
diff --git a/src/lib/misc/srp6/srp6_files.h b/src/lib/misc/srp6/srp6_files.h
index db128727e..8c899aad6 100644
--- a/src/lib/misc/srp6/srp6_files.h
+++ b/src/lib/misc/srp6/srp6_files.h
@@ -27,6 +27,14 @@ class BOTAN_DLL SRP6_Authenticator_File
*/
explicit SRP6_Authenticator_File(std::istream& input);
+ /**
+ * Looks up a user in the authenticator file.
+ * @param username user to look up
+ * @param v set to the host's password verifier
+ * @param salt set to the user's salt value
+ * @param group_id set to the user's group value
+ * @return whether a user exists in the authenticator file
+ */
bool lookup_user(const std::string& username,
BigInt& v,
std::vector<byte>& salt,