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

Compare commits

base: PapaTutuWawa:master
Branches Tags
PapaTutuWawa:master
PapaTutuWawa:fix/ci
PapaTutuWawa:v0.6.0
PapaTutuWawa:v0.5.0
PapaTutuWawa:v0.4.3
PapaTutuWawa:v0.4.2
PapaTutuWawa:v0.4.1
PapaTutuWawa:v0.3.2
PapaTutuWawa:v0.3.1
PapaTutuWawa:v0.3.0
PapaTutuWawa:v0.2.1
PapaTutuWawa:v0.2.0
PapaTutuWawa:v0.1.3
PapaTutuWawa:v0.1.2
PapaTutuWawa:v0.1.1
PapaTutuWawa:v0.1.0
..
compare: PapaTutuWawa:fix/ci
Branches Tags
PapaTutuWawa:master
PapaTutuWawa:fix/ci
PapaTutuWawa:v0.6.0
PapaTutuWawa:v0.5.0
PapaTutuWawa:v0.4.3
PapaTutuWawa:v0.4.2
PapaTutuWawa:v0.4.1
PapaTutuWawa:v0.3.2
PapaTutuWawa:v0.3.1
PapaTutuWawa:v0.3.0
PapaTutuWawa:v0.2.1
PapaTutuWawa:v0.2.0
PapaTutuWawa:v0.1.3
PapaTutuWawa:v0.1.2
PapaTutuWawa:v0.1.1
PapaTutuWawa:v0.1.0

No commits in common. "master" and "fix/ci" have entirely different histories.
master ... fix/ci

6 changed files with 50 additions and 64 deletions
Show Stats Expand all files Collapse all files

10
.woodpecker.yml
View File

@ -1,14 +1,16 @@
pipeline: pipeline:
analysis: lint:
image: dart:3.0.7 image: dart:3.0.7
commands: commands:
# Proxy requests to pub.dev using pubcached # Proxy requests to pub.dev using pubcached
- PUB_HOSTED_URL=http://172.17.0.1:8000 dart pub get - PUB_HOSTED_URL=http://172.17.0.1:8000 dart pub get
- dart analyze --fatal-infos --fatal-warnings - dart analyze --fatal-infos --fatal-warnings
test:
image: dart:3.0.7
commands:
# Proxy requests to pub.dev using pubcached
- PUB_HOSTED_URL=http://172.17.0.1:8000 dart pub get
- dart test - dart test
when:
path:
includes: ['lib/**', 'test/**']
notify: notify:
image: git.polynom.me/papatutuwawa/woodpecker-xmpp image: git.polynom.me/papatutuwawa/woodpecker-xmpp
settings: settings:

4
CHANGELOG.md
View File

@ -71,7 +71,3 @@ This version is a complete rework of omemo_dart!
- Remove `added` and `replaced` from the data passed to the `CommitRatchetsCallback` - Remove `added` and `replaced` from the data passed to the `CommitRatchetsCallback`
- Added a list of newly added and replaced ratchets to the encryption and decryption results. This is useful for displaying messages like "Contact added a new device" - Added a list of newly added and replaced ratchets to the encryption and decryption results. This is useful for displaying messages like "Contact added a new device"
## 0.6.0
- Bump dependencies to fix running with never version of Dart

34
example/omemo_dart_example.dart
View File

@ -17,7 +17,7 @@ void main() async {
// implements "Blind Trust Before Verification". To make things simpler, we keep // implements "Blind Trust Before Verification". To make things simpler, we keep
// no persistent data and can thus use the MemoryBTBVTrustManager. If we wanted to keep // no persistent data and can thus use the MemoryBTBVTrustManager. If we wanted to keep
// the state, we would have to override BlindTrustBeforeVerificationTrustManager. // the state, we would have to override BlindTrustBeforeVerificationTrustManager.
BlindTrustBeforeVerificationTrustManager(), MemoryBTBVTrustManager(),
// This function is called whenever we need to send an OMEMO heartbeat to [recipient]. // This function is called whenever we need to send an OMEMO heartbeat to [recipient].
// [result] is the encryted data to include. This needs to be wired into your XMPP library's // [result] is the encryted data to include. This needs to be wired into your XMPP library's
// OMEMO implementation. // OMEMO implementation.
@ -41,7 +41,9 @@ void main() async {
(device) async {}, (device) async {},
); );
// Bob, on his side, also creates an [OmemoManager] similar to Alice. // Alice now wants to chat with Bob at his bare Jid "bob@other.server". To make things
// simple, we just generate the identity bundle ourselves. In the real world, we would
// request it using PEP and then convert the device bundle into a OmemoBundle object.
final bobManager = OmemoManager( final bobManager = OmemoManager(
await OmemoDevice.generateNewDevice(bobJid), await OmemoDevice.generateNewDevice(bobJid),
BlindTrustBeforeVerificationTrustManager(), BlindTrustBeforeVerificationTrustManager(),
@ -49,13 +51,10 @@ void main() async {
(jid) async => [], (jid) async => [],
(jid, id) async => null, (jid, id) async => null,
(jid) async {}, (jid) async {},
(device) async {},
); );
// Alice prepares to send the message to Bob, so she builds the message stanza and // Alice prepares to send the message to Bob, so she builds the message stanza and
// collects all the children of the stanza that should be encrypted into a string. // collects all the children of the stanza that should be encrypted into a string.
// Note that this leaves out the wrapping stanza, i.e. if we want to send a <message />
// we only include the <message />'s children.
const aliceMessageStanzaBody = ''' const aliceMessageStanzaBody = '''
<body>Hello Bob, it's me, Alice!</body> <body>Hello Bob, it's me, Alice!</body>
<super-secret-element xmlns='super-secret-element' /> <super-secret-element xmlns='super-secret-element' />
@ -76,10 +75,10 @@ void main() async {
</envelope> </envelope>
'''; ''';
// Next, we encrypt the envelope element using Alice's [OmemoManager]. It will // Since Alice has no open session with Bob, we need to tell the session manager to build
// automatically attempt to fetch the device bundles of Bob. // it when sending the message.
final message = await aliceManager.onOutgoingStanza( final message = await aliceSession.onOutgoingStanza(
const OmemoOutgoingStanza( OmemoOutgoingStanza(
// The bare receiver Jid // The bare receiver Jid
[bobJid], [bobJid],
@ -88,15 +87,17 @@ void main() async {
), ),
); );
// In a proper implementation, we would also do some error checking here. // In a proper implementation, we should also do some error checking here.
// Alice now builds the actual message stanza for Bob // Alice now builds the actual message stanza for Bob
final payload = base64.encode(message.ciphertext!); final payload = base64.encode(message.ciphertext!);
final aliceDevice = await aliceManager.getDevice(); final aliceDevice = await aliceSession.getDevice();
// ignore: unused_local_variable
final bobDevice = await bobSession.getDevice();
// Since we know we have just one key for Bob, we take a shortcut. However, in the real // Since we know we have just one key for Bob, we take a shortcut. However, in the real
// world, we have to serialise every EncryptedKey to a <key /> element and group them // world, we have to serialise every EncryptedKey to a <key /> element and group them
// per Jid. // per Jid.
final key = message.encryptedKeys[bobJid]![0]; final key = message.encryptedKeys[0];
// Note that the key's "kex" attribute refers to key.kex. It just means that the // Note that the key's "kex" attribute refers to key.kex. It just means that the
// encrypted key also contains the required data for Bob to build a session with Alice. // encrypted key also contains the required data for Bob to build a session with Alice.
@ -106,7 +107,7 @@ void main() async {
<encrypted xmlns='urn:xmpp:omemo:2'> <encrypted xmlns='urn:xmpp:omemo:2'>
<header sid='${aliceDevice.id}'> <header sid='${aliceDevice.id}'>
<keys jid='$bobJid'> <keys jid='$bobJid'>
<key rid='${key.rid} kex='${key.kex}'> <key rid='${key.rid} kex='true'>
${key.value} ${key.value}
</key> </key>
</keys> </keys>
@ -124,7 +125,7 @@ void main() async {
// Bob now receives an OMEMO encrypted message from Alice and wants to decrypt it. // Bob now receives an OMEMO encrypted message from Alice and wants to decrypt it.
// Since we have just one key, let's just deserialise the one key by hand. // Since we have just one key, let's just deserialise the one key by hand.
final keys = [ final keys = [
EncryptedKey(key.rid, key.value, true), EncryptedKey(bobJid, key.rid, key.value, true),
]; ];
// Bob extracts the payload and attempts to decrypt it. // Bob extracts the payload and attempts to decrypt it.
@ -133,9 +134,14 @@ void main() async {
OmemoIncomingStanza( OmemoIncomingStanza(
// The bare sender JID of the message. In this case, it's Alice's. // The bare sender JID of the message. In this case, it's Alice's.
aliceJid, aliceJid,
// The 'sid' attribute of the <header /> element. Here, we know that Alice only has one device. // The 'sid' attribute of the <header /> element. Here, we know that Alice only has one device.
aliceDevice.id, aliceDevice.id,
// Time the message was sent. Since the message was not delayed, we use the
// current time.
DateTime.now().millisecondsSinceEpoch,
/// The decoded <key /> elements. from the header. Note that we only include the ones /// The decoded <key /> elements. from the header. Note that we only include the ones
/// relevant for Bob, so all children of <keys jid='$bobJid' />. /// relevant for Bob, so all children of <keys jid='$bobJid' />.
keys, keys,

36
flake.lock
View File

@ -1,15 +1,12 @@
{ {
"nodes": { "nodes": {
"flake-utils": { "flake-utils": {
"inputs": {
"systems": "systems"
},
"locked": { "locked": {
"lastModified": 1692799911, "lastModified": 1656065134,
"narHash": "sha256-3eihraek4qL744EvQXsK1Ha6C3CR7nnT8X2qWap4RNk=", "narHash": "sha256-oc6E6ByIw3oJaIyc67maaFcnjYOz1mMcOtHxbEf9NwQ=",
"owner": "numtide", "owner": "numtide",
"repo": "flake-utils", "repo": "flake-utils",
"rev": "f9e7cf818399d17d347f847525c5a5a8032e4e44", "rev": "bee6a7250dd1b01844a2de7e02e4df7d8a0a206c",
"type": "github" "type": "github"
}, },
"original": { "original": {
@ -20,16 +17,16 @@
}, },
"nixpkgs": { "nixpkgs": {
"locked": { "locked": {
"lastModified": 1727586919, "lastModified": 1657540956,
"narHash": "sha256-e/YXG0tO5GWHDS8QQauj8aj4HhXEm602q9swrrlTlKQ=", "narHash": "sha256-ihGbOFWtAkENwxBE5kV/yWt2MncvW+BObLDsmxCLo/Q=",
"owner": "NixOS", "owner": "NANASHI0X74",
"repo": "nixpkgs", "repo": "nixpkgs",
"rev": "2dcd9c55e8914017226f5948ac22c53872a13ee2", "rev": "043de04db8a6b0391b3fefaaade160514d866946",
"type": "github" "type": "github"
}, },
"original": { "original": {
"owner": "NixOS", "owner": "NANASHI0X74",
"ref": "nixpkgs-unstable", "ref": "flutter-3-0-0",
"repo": "nixpkgs", "repo": "nixpkgs",
"type": "github" "type": "github"
} }
@ -39,21 +36,6 @@
"flake-utils": "flake-utils", "flake-utils": "flake-utils",
"nixpkgs": "nixpkgs" "nixpkgs": "nixpkgs"
} }
},
"systems": {
"locked": {
"lastModified": 1681028828,
"narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
"owner": "nix-systems",
"repo": "default",
"rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
"type": "github"
},
"original": {
"owner": "nix-systems",
"repo": "default",
"type": "github"
}
} }
}, },
"root": "root", "root": "root",

2
flake.nix
View File

@ -1,7 +1,7 @@
{ {
description = "omemo_dart"; description = "omemo_dart";
inputs = { inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; nixpkgs.url = "github:NANASHI0X74/nixpkgs/flutter-3-0-0";
flake-utils.url = "github:numtide/flake-utils"; flake-utils.url = "github:numtide/flake-utils";
}; };
outputs = { self, nixpkgs, flake-utils }: flake-utils.lib.eachDefaultSystem (system: let outputs = { self, nixpkgs, flake-utils }: flake-utils.lib.eachDefaultSystem (system: let

26
pubspec.yaml
View File

@ -1,27 +1,27 @@
name: omemo_dart name: omemo_dart
description: An XMPP library independent OMEMO library description: An XMPP library independent OMEMO library
version: 0.6.0 version: 0.5.1
homepage: https://github.com/PapaTutuWawa/omemo_dart homepage: https://github.com/PapaTutuWawa/omemo_dart
publish_to: https://git.polynom.me/api/packages/PapaTutuWawa/pub publish_to: https://git.polynom.me/api/packages/PapaTutuWawa/pub
environment: environment:
sdk: ">=3.0.0 <4.0.0" sdk: '>=2.17.0 <3.0.0'
dependencies: dependencies:
collection: ^1.18.0 collection: ^1.16.0
cryptography: ^2.7.0 cryptography: ^2.0.5
hex: ^0.2.0 hex: ^0.2.0
logging: ^1.2.0 logging: ^1.0.2
meta: ^1.15.0 meta: ^1.7.0
moxlib: moxlib:
version: ^0.2.0 version: ^0.2.0
hosted: https://git.polynom.me/api/packages/Moxxy/pub hosted: https://git.polynom.me/api/packages/Moxxy/pub
pinenacl: ^0.6.0 pinenacl: ^0.5.1
protobuf: ^3.1.0 protobuf: ^2.1.0
protoc_plugin: ^21.1.2 protoc_plugin: ^20.0.1
synchronized: ^3.3.0+3 synchronized: ^3.0.0+2
dev_dependencies: dev_dependencies:
lints: ^5.0.0 lints: ^2.0.0
test: ^1.25.8 test: ^1.21.0
very_good_analysis: ^6.0.0 very_good_analysis: ^3.0.1