aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorАртём Павлов [Artyom Pavlov] <newpavlov@gmail.com>2017-08-14 07:44:56 +0300
committerАртём Павлов [Artyom Pavlov] <newpavlov@gmail.com>2017-08-14 07:44:56 +0300
commit7322f5b65626a16497ad972f0f63ceb7c67826d5 (patch)
treee78ffe504b564575ac329b755d06450993c62e1e
parent331727194c231a10dc2e296922e09aa0e888f4bd (diff)
downloadPAKEs-7322f5b65626a16497ad972f0f63ceb7c67826d5.tar.xz
Readme udpate
-rw-r--r--README.md32
1 files changed, 15 insertions, 17 deletions
diff --git a/README.md b/README.md
index 2bfc250..ac34117 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,25 @@
-# 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)
-[Secure Remote Password][1] (SRP) protocol implementation.
-
-This implementation uses little-endian representation of big integers and is
-generic over hash functions using [`Digest`][2] trait, so you will need to
-choose a hash function, e.g. `Sha256` from [`sha2`][3] crate. Additionally this
-crate allows to use a specialized password hashing algorithms for private key
-computation instead of method described in the SRP literature.
-
-Currently compatability with over implementations was not tested.
+# PAKE [![Build Status](https://travis-ci.org/RustCrypto/PAKE.svg?branch=master)](https://travis-ci.org/RustCrypto/PAKE)
+[Password-Authenticated Key Agreement][1] protocols implementation.
## Warnings
-This crate have not yet received any formal cryptographic and security reviews.
+Crates in this repository have not yet received any formal cryptographic and
+security reviews.
-No efforts were yet taken in regards of [blinding][4] or erasing secrets from
+No efforts were yet taken in regards of [blinding][3] or erasing secrets from
the memory.
**USE AT YOUR OWN RISK.**
+## Supported algorithms
+
+| Name | Crates.io | Documentation |
+| --------- |:----------:| :-----:|
+| [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) |
+
## License
-This crate is licensed under either of
+All crates are licensed under either of
* [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
* [MIT license](http://opensource.org/licenses/MIT)
@@ -28,7 +27,6 @@ This crate is licensed under either of
at your option.
-[1]: https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol
-[2]: https://crates.io/crates/digest
-[3]: https://crates.io/crates/sha2
-[4]: https://en.wikipedia.org/wiki/Blinding_(cryptography) \ No newline at end of file
+[1]: https://en.wikipedia.org/wiki/Password-authenticated_key_agreement
+[2]: https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol
+[3]: https://en.wikipedia.org/wiki/Blinding_(cryptography) \ No newline at end of file