diff options
Diffstat (limited to 'srp/README.md')
| -rw-r--r-- | srp/README.md | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/srp/README.md b/srp/README.md new file mode 100644 index 0000000..3aa7583 --- /dev/null +++ b/srp/README.md @@ -0,0 +1,73 @@ +# [RustCrypto]: SRP + +[![crate][crate-image]][crate-link] +[![Docs][docs-image]][docs-link] +![Apache2/MIT licensed][license-image] +![Rust Version][rustc-image] +[![Project Chat][chat-image]][chat-link] +[![Build Status][build-image]][build-link] + +Pure Rust implementation of the [Secure Remote Password] password-authenticated +key-exchange algorithm. + +[Documentation][docs-link] + +## About + +This implementation is generic over hash functions using the [`Digest`] trait, +so you will need to choose a hash function, e.g. `Sha256` from [`sha2`] crate. + +Additionally this crate allows to use a specialized password hashing +algorithm for private key computation instead of method described in the +SRP literature. + +Compatibility with other implementations has not yet been tested. + +## ⚠️ Security Warning + +This crate has never received an independent third party audit for security and +correctness. + +USE AT YOUR OWN RISK! + +## Minimum Supported Rust Version + +Rust **1.56** or higher. + +Minimum supported Rust version can be changed in the future, but it will be +done with a minor version bump. + +## License + +Licensed under either of: + + * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) + * [MIT license](http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +[//]: # (badges) + +[crate-image]: https://img.shields.io/crates/v/srp.svg +[crate-link]: https://crates.io/crates/srp +[docs-image]: https://docs.rs/srp/badge.svg +[docs-link]: https://docs.rs/srp/ +[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg +[rustc-image]: https://img.shields.io/badge/rustc-1.56+-blue.svg +[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg +[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/260045-PAKEs +[build-image]: https://github.com/RustCrypto/PAKEs/actions/workflows/srp.yml/badge.svg +[build-link]: https://github.com/RustCrypto/PAKEs/actions/workflows/srp.yml + +[//]: # (general links) + +[RustCrypto]: https://github.com/RustCrypto +[Secure Remote Password]: https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol +[`Digest`]: https://docs.rs/digest +[`sha2`]: https://crates.io/crates/sha2 |