README.md

   1 # PAKE [![Build Status](https://travis-ci.org/RustCrypto/PAKE.svg?branch=master)](https://travis-ci.org/RustCrypto/PAKE)
   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
  20 ## License
  21
  22 All crates are licensed under either of
  23
  24  * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
  25  * [MIT license](http://opensource.org/licenses/MIT)
  26
  27 at your option.
  28
  29
  30 [1]: https://en.wikipedia.org/wiki/Password-authenticated_key_agreement
  31 [2]: https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol
  32 [3]: https://en.wikipedia.org/wiki/Blinding_(cryptography)