tuxmain/double-ratchet-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add std support, wording changes, code improvements

Browse source
This commit is contained in:
satvrn 2023-07-19 21:50:47 +00:00
commit 2b559b79f9
7 changed files with 65 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -5,10 +5,10 @@
# double-ratchet-rs
A pure Rust implementation of the Double Ratchet Algorithm as specified by [Signal][1].
A pure Rust implementation of the Double Ratchet algorithm as described by [Signal][1].
This implementation follows the cryptographic recommendations provided by [Signal][2].
The AEAD Algorithm uses a constant Nonce. This might be changed in the future.
The AEAD algorithm uses a constant Nonce. This might be changed in the future.
Fork of [double-ratchet-2](https://github.com/Dione-Software/double-ratchet-2).
@ -163,9 +163,14 @@ let im_ratchet = RatchetEncHeader::import(&ex_ratchet).unwrap();
assert_eq!(im_ratchet, bob_ratchet)
```
## Features
- `hashbrown`: Use `hashbrown` for `HashMap`. Enabled by default for `no_std` support.
- `std`: Use `std` instead of `alloc`. Can be used with `hashbrown`, but it isn't required.
## **M**inimum **S**upported **R**ust **V**ersion (MSRV)
The current MSRV is 1.61.0.
The current MSRV is 1.60.0 without `hashbrown` and 1.64.0 with `hashbrown`.
## License
@ -174,4 +179,3 @@ This project is licensed under the [MIT license](https://github.com/notsatvrn/do
[1]: https://signal.org/docs/specifications/doubleratchet/
[2]: https://signal.org/docs/specifications/doubleratchet/#recommended-cryptographic-algorithms
[3]: https://signal.org/docs/specifications/doubleratchet/#double-ratchet-with-header-encryption