README.md

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