https://github.com/matrix-org/vodozemac
An implementation of Olm and Megolm in pure Rust.
https://github.com/matrix-org/vodozemac
cryptography double-ratchet encryption matrix rust
Last synced: 19 days ago
JSON representation
An implementation of Olm and Megolm in pure Rust.
- Host: GitHub
- URL: https://github.com/matrix-org/vodozemac
- Owner: matrix-org
- License: apache-2.0
- Created: 2021-12-16T21:16:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-31T09:18:49.000Z (3 months ago)
- Last Synced: 2025-04-06T05:05:04.652Z (26 days ago)
- Topics: cryptography, double-ratchet, encryption, matrix, rust
- Language: Rust
- Homepage:
- Size: 6.37 MB
- Stars: 216
- Watchers: 18
- Forks: 36
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
vodozemac
vodozemac is an implementation of Olm (Double Ratchet) and Megolm
[vodozemac] is a pure Rust implementation of the [Olm] and [Megolm]
cryptographic ratchets, offering a high-level API for straightforward creation
of secure communication channels using these ratchets.
Designed as a modern alternative to the [libolm] cryptographic library, which is
used for end-to-end encryption in [Matrix], vodozemac provides not only the
[Olm] and [Megolm] ratchets but also additional cryptographic features useful
for developing Matrix clients, such as [SAS] and the integrated encryption
scheme outlined in [MSC4108].
[vodozemac]: https://hjp.znanje.hr/index.php?show=search_by_id&id=f19vXxZ%2F
[Olm]: https://gitlab.matrix.org/matrix-org/olm/-/blob/master/docs/olm.md
[Megolm]: https://gitlab.matrix.org/matrix-org/olm/-/blob/master/docs/megolm.md
[libolm]: https://gitlab.matrix.org/matrix-org/olm
[SAS]: https://spec.matrix.org/v1.2/client-server-api/#short-authentication-string-sas-verification
[Matrix]: https://matrix.org
[MSC4108]: https://github.com/matrix-org/matrix-spec-proposals/pull/4108
# Documentation
Explore how to implement end-to-end encryption in our [documentation].
[documentation]: https://docs.rs/vodozemac/latest/vodozemac/
# Installation
To install add the following to your project's `Cargo.toml`:
```toml
[dependencies]
vodozemac = "0.9.0"
```
# Security Notes
This crate has received one security [audit] by [Least Authority], with no
significant findings.
[audit]: https://matrix.org/media/Least%20Authority%20-%20Matrix%20vodozemac%20Final%20Audit%20Report.pdf
[Least Authority]: https://leastauthority.com/