diff options
| -rw-r--r-- | doc/contents.rst | 1 | ||||
| -rw-r--r-- | doc/srp.rst | 25 |
2 files changed, 26 insertions, 0 deletions
diff --git a/doc/contents.rst b/doc/contents.rst index d55c36cc3..9116f9157 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -23,6 +23,7 @@ Contents kdf pbkdf passhash + srp rng fpe python diff --git a/doc/srp.rst b/doc/srp.rst new file mode 100644 index 000000000..03792c97e --- /dev/null +++ b/doc/srp.rst @@ -0,0 +1,25 @@ +Secure Remote Password +======================================== + +The library contains an implementation of the SRP-6a password based +key exchange protocol in ``srp6.h``. + +.. cpp:function:: BigInt generate_srp6_verifier( \ + const std::string& identifier, \ + const std::string& password, \ + const std::vector<byte>& salt, \ + const std::string& group_id, \ + const std::string& hash_id) + + +.. cpp:function:: std::pair<BigInt,SymmetricKey> srp6_client_agree( \ + const std::string& username, \ + const std::string& password, \ + const std::string& group_id, \ + const std::string& hash_id, \ + const std::vector<byte>& salt, \ + const BigInt& B, \ + RandomNumberGenerator& rng) + +.. cpp:function:: std::string srp6_group_identifier( \ + const BigInt& N, const BigInt& g) |