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 ## Rust version requirements
  22
  23 The MSRV (Minimum Supported Rust Version) is 1.32.0 . If/when this changes,
  24 it will be noted in the changelog, and the crate semver will be updated. So
  25 downstream projects should depend upon e.g. `spake2 = "0.2"` to avoid picking
  26 up new versions that would require a newer compiler.
  27
  28 SRP-v0.4.1 actually works with rustc-1.31.1, but this will probably be
  29 changed in the next release.
  30
  31 SPAKE2 required rustc-1.32 beginning with spake2-v0.2.0 .
  32
  33 Our CI scripts check all builds against a pinned version of rustc to test the
  34 intended MSRV. Sometimes upstream dependencies make surprising changes that
  35 could require a newer version of rustc, without changes to the source code in
  36 this repository, but hopefully this won't happen very frequently.
  37
  38 ## License
  39
  40 All crates are licensed under either of
  41
  42  * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
  43  * [MIT license](http://opensource.org/licenses/MIT)
  44
  45 at your option.
  46
  47 ### Contribution
  48
  49 Unless you explicitly state otherwise, any contribution intentionally submitted
  50 for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
  51 dual licensed as above, without any additional terms or conditions.
  52
  53 [//]: # (badges)
  54
  55 [deps-image]: https://deps.rs/repo/github/RustCrypto/PAKEs/status.svg
  56 [deps-link]: https://deps.rs/repo/github/RustCrypto/PAKEs
  57
  58 [//]: # (footnotes)
  59
  60 [1]: https://en.wikipedia.org/wiki/Password-authenticated_key_agreement
  61 [2]: https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol
  62 [3]: https://en.wikipedia.org/wiki/Blinding_(cryptography)
  63 [4]: https://www.di.ens.fr/~mabdalla/papers/AbPo05a-letter.pdf