mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-15 19:45:34 -04:00
7a263433c7
This patch adds a couple more states to the SAS verification state machine. Namely we add the following states: * KeySent * KeysExchanged This prevents users from confirming that the short auth string matches before they have sent out a m.key.verification.key event, which is necessary for the other side to present the short auth string. The KeysExchanged state functionally replaces the KeyReceived state. Meaning that the short auth string can only presented once we transitioned into the KeysExchanged state. We can transition into the KeysExchanged state from the KeyReceived state or from the KeySent state, depending on if we first receive a m.key.verification.key event or if we first send out our own m.key.verification.key event. This means that, if the transition into the KeysExchanged state happens through the KeySent state, users won't be able to tell if the transition happened. In other words, listening to `m.key.verification` events doesn't work anymore, users will need to use the new `Sas::changes()` API to listen to a stream of state changes.
matrix-rust-sdk
matrix-rust-sdk is an implementation of a Matrix client-server library in Rust.
Project structure
The rust-sdk consists of multiple crates that can be picked at your convenience:
- matrix-sdk - High level client library, with batteries included, you're most likely interested in this.
- matrix-sdk-base - No (network) IO client state machine that can be used to embed a Matrix client in your project or build a full fledged network enabled client lib on top of it.
- matrix-sdk-crypto - No (network) IO encryption state machine that can be used to add Matrix E2EE support to your client or client library.
Minimum Supported Rust Version (MSRV)
These crates are built with the Rust language version 2021 and require a minimum compiler version of 1.64
Status
The library is in an alpha state, things that are implemented generally work but the API will change in breaking ways.
If you are interested in using the matrix-sdk now is the time to try it out and provide feedback.
Bindings
Some crates of the matrix-rust-sdk can be embedded inside other
environments, like Swift, Kotlin, JavaScript, Node.js etc. Please,
explore the bindings/ directory to learn more.