README.md

   1 # RustCrypto: PAKEs [![dependency status][deps-image]][deps-link]
   2 [Password-Authenticated Key Agreement][1] protocols implementation.
   3
   4 ## Warnings
   5
   6 Crates in this repository have not yet received any formal cryptographic and
   7 security reviews.
   8
   9 No efforts were yet taken in regards of [blinding][3] or erasing secrets from
  10 the memory.
  11
  12 **USE AT YOUR OWN RISK.**
  13
  14 ## Supported algorithms
  15
  16 | Name      | Crates.io  | Documentation  |
  17 | --------- |:----------:| :-----:|
  18 | [SRP][2]  | [![crates.io](https://img.shields.io/crates/v/srp.svg)](https://crates.io/crates/srp) | [![Documentation](https://docs.rs/srp/badge.svg)](https://docs.rs/srp) |
  19 | [spake2][4]  | [![crates.io](https://img.shields.io/crates/v/spake2.svg)](https://crates.io/crates/spake2) | [![Documentation](https://docs.rs/spake2/badge.svg)](https://docs.rs/spake2) |
  20
  21 ## License
  22
  23 All crates are licensed under either of
  24
  25  * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
  26  * [MIT license](http://opensource.org/licenses/MIT)
  27
  28 at your option.
  29
  30 ### Contribution
  31
  32 Unless you explicitly state otherwise, any contribution intentionally submitted
  33 for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
  34 dual licensed as above, without any additional terms or conditions.
  35
  36 [//]: # (badges)
  37
  38 [deps-image]: https://deps.rs/repo/github/RustCrypto/PAKEs/status.svg
  39 [deps-link]: https://deps.rs/repo/github/RustCrypto/PAKEs
  40
  41 [//]: # (footnotes)
  42
  43 [1]: https://en.wikipedia.org/wiki/Password-authenticated_key_agreement
  44 [2]: https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol
  45 [3]: https://en.wikipedia.org/wiki/Blinding_(cryptography)
  46 [4]: https://www.di.ens.fr/~mabdalla/papers/AbPo05a-letter.pdf