]> git.lizzy.rs Git - PAKEs.git/commitdiff
srp: fix typos in docstrings (#58)
authorLuca Bruno <lucab@redhat.com>
Mon, 21 Jun 2021 14:30:23 +0000 (14:30 +0000)
committerGitHub <noreply@github.com>
Mon, 21 Jun 2021 14:30:23 +0000 (07:30 -0700)
This fixes a few minor typos in docstrings.

srp/src/client.rs
srp/src/lib.rs
srp/src/server.rs

index 04f4807a459352832d5384aec8a930537bb50135..d47983e8459a8056ded91ecd47221b31f62d26c9 100644 (file)
@@ -48,7 +48,7 @@
 //! authenticated cipher mode).
 //!
 //! For user registration on the server first generate salt (e.g. 32 bytes long)
-//! and get password verifier which depends on private key. Send useranme, salt
+//! and get password verifier which depends on private key. Send username, salt
 //! and password verifier over protected channel to protect against
 //! Man-in-the-middle (MITM) attack for registration.
 //!
index cec6f3684b8e569b000f3b81be8b636e98af6f2a..4cb7a7a2b8ce1edd42dbfd55324c30f1ae000955 100644 (file)
@@ -10,7 +10,7 @@
 //! Compatibility with over implementations was not yet tested.
 //!
 //! # Usage
-//! Add `srp` dependecy to your `Cargo.toml`:
+//! Add `srp` dependency to your `Cargo.toml`:
 //!
 //! ```toml
 //! [dependencies]
@@ -27,7 +27,7 @@
 //! [`server`](server/index.html) modules.
 //!
 //! # Algorithm description
-//! Here we briefly describe implemented algroithm. For additionall information
+//! Here we briefly describe implemented algorithm. For additional information
 //! refer to SRP literature. All arithmetic is done modulo `N`, where `N` is a
 //! large safe prime (`N = 2q+1`, where `q` is prime). Additionally `g` MUST be
 //! a generator modulo `N`. It's STRONGLY recommended to use SRP parameters
@@ -43,8 +43,7 @@
 //! |`M1 = H(A ‖ B ‖ K)`     |     — `M1` —>     | (verify `M1`)                   |
 //! |(verify `M2`)           |    <— `M2` —      | `M2 = H(A ‖ M1 ‖ K)`            |
 //!
-//! Variables and notations have the following
-//! meaning:
+//! Variables and notations have the following meaning:
 //!
 //! - `I` — user identity (username)
 //! - `P` — user password
index 9be1948ecef147fdabb5443f7ccb379de92f6029..e134861d7e47fa9f0735ba30dada45b39457473d 100644 (file)
@@ -22,7 +22,7 @@
 //! conn.reply_to_handshake(&user.salt, b_pub);
 //! ```
 //!
-//! And finally recieve user proof, verify it and send server proof in the
+//! And finally receive user proof, verify it and send server proof in the
 //! reply:
 //!
 //! ```ignore