PapaTutuWawa/omemo_dart
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update README

Browse Source
This commit is contained in:
PapaTutuWawa 2022-08-05 18:26:20 +02:00
parent fdc3985a8d
commit 1a672677e0
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,9 +1,23 @@
# omemo_dart
Hopefully, a library enabling developers to build OMEMO-supporting
XMPP clients in Dart and Flutter.
`omemo_dart` is a Dart library to help developers of Dart/Flutter XMPP clients to implement
[OMEMO](https://xmpp.org/extensions/xep-0384.html) in its newest version - currently 0.8.3.
**Please note that this library has not been audited for its security! Use at your own risk!**
The library provides an implementation of the [X3DH](https://signal.org/docs/specifications/x3dh/)
key exchange, the [Double Ratchet](https://signal.org/docs/specifications/doubleratchet/) with
the OMEMO 0.8.3 specific `ENCRYPT`, `DECRYPT` and `KDF_*` functions and a very high-level
`OmemoSessionManager` that manages all Double Ratchet sessions and provides a clean and simple
interface for encrypting a message for all known Ratchet sessions we have with a user.
This library also has no dependency on any XMPP library. `omemo_dart` instead defines an
intermediary format for the required data, that you, the user, will need to transform between
the stanza format of your preferred XMPP library and `omemo_dart`'s intermediary format
yourself.
## Important Notes
- **Please note that this library has not been audited for its security! Use at your own risk!**
- This library is not tested with other implementations of OMEMO 0.8.3 as I do not know of any client implementing spec compliant OMEMO 0.8.3. It does, however, work with itself.
## Contributing