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
|
# Noise-Rust
[](https://crates.io/crates/noise-protocol)
[](https://docs.rs/noise-protocol)
Implementation of the [Noise Protocol
Framework](http://noiseprotocol.org) in Rust.
## Status
Revision 34 is implemented.
Test vectors from [cacophony](https://github.com/centromere/cacophony) and [snow](https://github.com/mcginty/snow) are successfully verified.
## Philosophy
* Simple: straightforward implementation, small amount of code, almost no
dependencies, supports `no_std`. Feature `use_alloc` can optionallly be used
as an alternative to std.
* Fast: static dispatch, no heap allocation necessary.
* Unopinionated: flexible, primitive API, does not dictate how it should be
used.
## Documentation
* [noise-protocol](https://docs.rs/noise-protocol)
* [noise-rust-crypto](https://docs.rs/noise-rust-crypto)
## Crates
This repository contains several crates. The `noise-protocol` crate contains the
abstract implementation of the protocol framework. `noise-rust-crypto` provides concrete implementations of
the needed crypto primitives. It is a wrapper for `x25519-dalek` and
[RustCrypto](`https://github.com/RustCrypto`) crates.
The following table shows what primitives each of these crates
supports:
| | X25519 | AES-256-GCM | Chacha20-Poly1305 | SHA-256 | SHA-512 | BLAKE2s | BLAKE2b |
|-------------|:------:|:-----------:|:-----------------:|:-------:|:-------:|:-------:|:-------:|
| rust-ring | | ✔ | ✔ | ✔ | ✔ | | |
| rust-crypto | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
You can also plug in other primitive implementations by implementing the `DH`,
`Cipher` and `Hash` traits.
## `no_std` usage
The `noise-protocol` crate supports `no_std`, if default features are
disabled.
## License
Unlicense.
|
