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: about 2 months 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 (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-26T12:07:14.000Z (about 2 months ago)
• Last Synced: 2024-07-27T09:52:25.845Z (about 2 months ago)
• Topics: cryptography, double-ratchet, encryption, matrix, rust
• Language: Rust
• Homepage:
• Size: 2.24 MB
• Stars: 123
• Watchers: 20
• Forks: 25
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
![Build Status](https://img.shields.io/github/actions/workflow/status/matrix-org/vodozemac/ci.yml?style=flat-square)

[![codecov](https://img.shields.io/codecov/c/github/matrix-org/vodozemac/main.svg?style=flat-square)](https://codecov.io/gh/matrix-org/vodozemac)

[![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)

[![Docs - Main](https://img.shields.io/badge/docs-main-blue.svg?style=flat-square)](https://matrix-org.github.io/vodozemac/vodozemac/index.html)

[![Docs - Stable](https://img.shields.io/crates/v/vodozemac?color=blue&label=docs&style=flat-square)](https://docs.rs/vodozemac)

A Rust implementation of Olm and Megolm

vodozemac is a Rust reimplementation of

[libolm](https://gitlab.matrix.org/matrix-org/olm), a cryptographic library

used for end-to-end encryption in [Matrix](https://matrix.org). At its core, it

is an implementation of the [Olm][olm-docs] and [Megolm][megolm-docs] cryptographic ratchets,

along with a high-level API to easily establish cryptographic communication

channels employing those ratchets with other parties. It also implements some

other miscellaneous cryptographic functionality which is useful for building

Matrix clients, such as [SAS][sas].

[olm-docs]:

[megolm-docs]:

[sas]:

# Features

## Supported

- [Olm](https://matrix-org.github.io/vodozemac/vodozemac/olm/index.html)

- [Megolm](https://matrix-org.github.io/vodozemac/vodozemac/megolm/index.html)

- libolm pickle format (read-only)

- Modern pickle format

- [SAS (Short Authentication Strings)](https://matrix-org.github.io/vodozemac/vodozemac/sas/index.html)

## Unsupported

- Creating asymmetric [server-side message key

  backups][legacy-message-key-backup], since these have been implemented in

  [matrix-sdk-crypto].

[legacy-message-key-backup]:

[matrix-sdk-crypto]:

## Planned

- Primitives for the asymmetric authenticated [server-side message key backups][authenticated-message-key-backup].

[authenticated-message-key-backup]: