diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 61 |
1 files changed, 32 insertions, 29 deletions
@@ -1,29 +1,32 @@ -# spake2.rs -The SPAKE2 password-authenticated key-exchange algorithm, in Rust. - -[![Build Status][build-status-image]][build-status-url] -[![Codecov][codecov-image]][codecov-url] -[![Is-It-Maintained-Resolution-Time][iim-resolution-image]][iim-resolution-url] -[![Is-It-Maintained-Open-Issues][iim-open-image]][iim-open-url] -[![Crates.io][crates-io-image]][crates-io-url] -[![Docs.rs][docs-image]][docs-url] -[![License][license-image]][license-url] - -This is still pretty early, but seems to do the job. It needs a proper security review before you should consider using it for anything serious. - -Note that the API has changed since 0.0.8 . I released 0.0.9 by mistake. - -[build-status-image]: https://travis-ci.org/warner/spake2.rs.svg?branch=master -[build-status-url]: https://travis-ci.org/warner/spake2.rs -[codecov-image]: https://codecov.io/gh/warner/spake2.rs/branch/master/graph/badge.svg -[codecov-url]: https://codecov.io/gh/warner/spake2.rs -[crates-io-image]: https://img.shields.io/crates/v/spake2.svg -[crates-io-url]: https://crates.io/crates/spake2 -[docs-image]: https://docs.rs/spake2/badge.svg -[docs-url]: https://docs.rs/spake2 -[license-image]: https://img.shields.io/badge/License-MIT-blue.svg -[license-url]: LICENSE -[iim-resolution-image]: http://isitmaintained.com/badge/resolution/warner/spake2.rs.svg -[iim-resolution-url]: http://isitmaintained.com/project/warner/spake2.rs -[iim-open-image]: http://isitmaintained.com/badge/open/warner/spake2.rs.svg -[iim-open-url]: http://isitmaintained.com/project/warner/spake2.rs +# PAKE [](https://travis-ci.org/RustCrypto/PAKE) +[Password-Authenticated Key Agreement][1] protocols implementation. + +## Warnings + +Crates in this repository have not yet received any formal cryptographic and +security reviews. + +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] | [](https://crates.io/crates/srp) | [](https://docs.rs/srp) | + +## License + +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) + +at your option. + + +[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 |