README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# RustCrypto: PAKEs [![dependency status][deps-image]][deps-link]
[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]  | [![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) |
| [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) |

## Rust version requirements

The MSRV (Minimum Supported Rust Version) is 1.32.0 . If/when this changes,
it will be noted in the changelog, and the crate semver will be updated. So
downstream projects should depend upon e.g. `spake2 = "0.2"` to avoid picking
up new versions that would require a newer compiler.

SRP-v0.4.1 actually works with rustc-1.31.1, but this will probably be
changed in the next release.

SPAKE2 required rustc-1.32 beginning with spake2-v0.2.0 .

Our CI scripts check all builds against a pinned version of rustc to test the
intended MSRV. Sometimes upstream dependencies make surprising changes that
could require a newer version of rustc, without changes to the source code in
this repository, but hopefully this won't happen very frequently.

## 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.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

[//]: # (badges)

[deps-image]: https://deps.rs/repo/github/RustCrypto/PAKEs/status.svg
[deps-link]: https://deps.rs/repo/github/RustCrypto/PAKEs

[//]: # (footnotes)

[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)
[4]: https://www.di.ens.fr/~mabdalla/papers/AbPo05a-letter.pdf