Skip to content

Commit f7a39db

Browse files
authored
password-hash: update README.md (#2187)
Better describe what this crate actually does
1 parent d3f7629 commit f7a39db

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

password-hash/README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,26 @@ Traits which describe the functionality of [password hashing algorithms].
1111

1212
## About
1313

14-
Provides a `no_std`-friendly implementation of the
14+
This crate contains traits for using password hashing algorithms to create and verify password hash strings of the sort
15+
used by the [`crypt(3)`] API, which typically begin with `${ident}$...`.
16+
17+
It provides first-class support for the
1518
[Password Hashing Competition (PHC) string format specification][PHC]
16-
(a well-defined subset of the [Modular Crypt Format a.k.a. MCF][MCF]) which
17-
works in conjunction with the traits this crate defines.
19+
via the [`phc` crate] and can also be used with the
20+
[Modular Crypt Format (MCF)][MCF])
21+
via the [`mcf` crate].
1822

19-
## Supported Crates
23+
## Supported Password Hashing Algorithms
2024

2125
See [RustCrypto/password-hashes] for algorithm implementations which use
2226
this crate for interoperability:
2327

24-
- [`argon2`] - Argon2 memory hard key derivation function
25-
- [`pbkdf2`] - Password-Based Key Derivation Function v2
26-
- [`scrypt`] - scrypt key derivation function
28+
- [`argon2`]: Argon2 memory hard key derivation function
29+
- [`balloon-hash`]: PBKDF with proven memory-hard password-hashing and modern design
30+
- [`pbkdf2`]: Password-Based Key Derivation Function V2
31+
- [`scrypt`]: scrypt key derivation function
32+
- [`sha-crypt`]: SHA-crypt legacy password hashing algorithm for `crypt(3)`
33+
- [`yescrypt`]: yescrypt key derivation (improved version of scrypt)
2734

2835
## License
2936

@@ -56,9 +63,15 @@ dual licensed as above, without any additional terms or conditions.
5663
[//]: # (general links)
5764

5865
[password hashing algorithms]: https://en.wikipedia.org/wiki/Cryptographic_hash_function#Password_verification
66+
[`crypt(3)`]: https://en.wikipedia.org/wiki/Crypt_(C)
5967
[PHC]: https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md
68+
[`phc` crate]: https://docs.rs/phc
6069
[MCF]: https://passlib.readthedocs.io/en/stable/modular_crypt_format.html
70+
[`mcf` crate]: https://docs.rs/mcf
6171
[RustCrypto/password-hashes]: https://github.com/RustCrypto/password-hashes
6272
[`argon2`]: https://docs.rs/argon2
73+
[`balloon-hash`]: https://docs.rs/balloon-hash
6374
[`pbkdf2`]: https://docs.rs/pbkdf2
6475
[`scrypt`]: https://docs.rs/scrypt
76+
[`sha-crypt`]: https://docs.rs/sha-crypt
77+
[`yescrypt`]: https://docs.rs/yescrypt

0 commit comments

Comments
 (0)