README.md

   1 # SRP [![Build Status](https://travis-ci.org/RustCrypto/SRP.svg?branch=master)](https://travis-ci.org/RustCrypto/SRP) [![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)
   2 [Secure Remote Password][1] (SRP) protocol implementation.
   3
   4 This implementation uses little-endian representation of big integers and is
   5 generic over hash functions using [`Digest`][2] trait, so you will need to
   6 choose a hash function, e.g. `Sha256` from [`sha2`][3] crate. Additionally this
   7 crate allows to use a specialized password hashing algorithms for private key
   8 computation instead of method described in the SRP literature.
   9
  10 Currently compatability with over implementations was not tested.
  11
  12 ## Warnings
  13
  14 This crate have not yet received any formal cryptographic and security reviews.
  15
  16 No efforts were yet taken in regards of [blinding][4] or erasing secrets from
  17 the memory.
  18
  19 **USE AT YOUR OWN RISK.**
  20
  21 ## License
  22
  23 This crate is 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
  31 [1]: https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol
  32 [2]: https://crates.io/crates/digest
  33 [3]: https://crates.io/crates/sha2
  34 [4]: https://en.wikipedia.org/wiki/Blinding_(cryptography)