2022-08-09 13:48:26 +00:00
|
|
|
import 'dart:convert';
|
|
|
|
|
import 'package:omemo_dart/omemo_dart.dart';
|
2022-06-30 12:00:18 +00:00
|
|
|
|
2022-08-09 13:48:26 +00:00
|
|
|
/// This example aims to demonstrate how omemo_dart is used. Since omemo_dart is not
|
|
|
|
|
/// dependent on any XMPP library, you need to convert stanzas to the appropriate
|
|
|
|
|
/// intermediary format and back.
|
|
|
|
|
void main() async {
|
|
|
|
|
const aliceJid = 'alice@some.server';
|
|
|
|
|
const bobJid = 'bob@other.serve';
|
|
|
|
|
|
2023-06-12 17:37:51 +00:00
|
|
|
// You are Alice and want to begin using OMEMO, so you first create an OmemoManager.
|
|
|
|
|
final aliceManager = OmemoManager(
|
|
|
|
|
// Generate Alice's OMEMO device bundle. We can specify how many One-time Prekeys we want, but
|
|
|
|
|
// per default, omemo_dart generates 100 (recommended by XEP-0384).
|
|
|
|
|
await OmemoDevice.generateNewDevice(aliceJid),
|
2022-08-09 13:48:26 +00:00
|
|
|
// The trust manager we want to use. In this case, we use the provided one that
|
|
|
|
|
// 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
|
|
|
|
|
// the state, we would have to override BlindTrustBeforeVerificationTrustManager.
|
|
|
|
|
MemoryBTBVTrustManager(),
|
2023-06-12 17:37:51 +00:00
|
|
|
// 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
|
|
|
|
|
// OMEMO implementation.
|
|
|
|
|
// For simplicity, we use an empty function and imagine it works.
|
|
|
|
|
(result, recipient) async => {},
|
|
|
|
|
// This function is called whenever we need to fetch the device list for [jid].
|
|
|
|
|
// This needs to be wired into your XMPP library's OMEMO implementation.
|
|
|
|
|
// For simplicity, we use an empty function and imagine it works.
|
|
|
|
|
(jid) async => [],
|
|
|
|
|
// This function is called whenever we need to fetch the device bundle with id [id] from [jid].
|
|
|
|
|
// This needs to be wired into your XMPP library's OMEMO implementation.
|
|
|
|
|
// For simplicity, we use an empty function and imagine it works.
|
|
|
|
|
(jid, id) async => null,
|
|
|
|
|
// This function is called whenever we need to subscribe to [jid]'s device list PubSub node.
|
|
|
|
|
// This needs to be wired into your XMPP library's OMEMO implementation.
|
|
|
|
|
// For simplicity, we use an empty function and imagine it works.
|
|
|
|
|
(jid) async {},
|
2023-06-17 21:14:00 +00:00
|
|
|
// This function is called whenever our own device bundle has to be republished to our PEP node.
|
|
|
|
|
// This needs to be wired into your XMPP library's OMEMO implementation.
|
|
|
|
|
// For simplicity, we use an empty function and imagine it works.
|
|
|
|
|
(device) async {},
|
2022-08-09 13:48:26 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
|
|
// 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.
|
2023-06-12 17:37:51 +00:00
|
|
|
final bobManager = OmemoManager(
|
|
|
|
|
await OmemoDevice.generateNewDevice(bobJid),
|
2023-06-17 13:21:11 +00:00
|
|
|
BlindTrustBeforeVerificationTrustManager(),
|
2023-06-12 17:37:51 +00:00
|
|
|
(result, recipient) async => {},
|
|
|
|
|
(jid) async => [],
|
|
|
|
|
(jid, id) async => null,
|
|
|
|
|
(jid) async {},
|
2022-08-09 13:48:26 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
|
|
// 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.
|
|
|
|
|
const aliceMessageStanzaBody = '''
|
|
|
|
|
<body>Hello Bob, it's me, Alice!</body>
|
|
|
|
|
<super-secret-element xmlns='super-secret-element' />
|
|
|
|
|
''';
|
|
|
|
|
|
|
|
|
|
// Since OMEMO 0.8.3 mandates usage of XEP-0420: Stanza Content Encryption, we have to
|
|
|
|
|
// wrap our acual payload - aliceMessageStanzaBody - into an SCE envelope. Note that
|
|
|
|
|
// the rpad element must contain a random string. See XEP-0420 for recommendations.
|
|
|
|
|
// OMEMO makes the <time /> element optional, but let's use for this example.
|
|
|
|
|
const envelope = '''
|
|
|
|
|
<envelope xmlns='urn:xmpp:sce:1'>
|
|
|
|
|
<content>
|
|
|
|
|
$aliceMessageStanzaBody
|
|
|
|
|
</content>
|
|
|
|
|
<rpad>s0m3-r4nd0m-b9t3s</rpad>
|
|
|
|
|
<from jid='$aliceJid' />
|
|
|
|
|
<time stamp='1969-07-20T21:56:15-05:00' />
|
|
|
|
|
</envelope>
|
|
|
|
|
''';
|
2023-06-12 17:20:43 +00:00
|
|
|
|
2022-08-09 13:48:26 +00:00
|
|
|
// Since Alice has no open session with Bob, we need to tell the session manager to build
|
|
|
|
|
// it when sending the message.
|
2023-06-12 17:37:51 +00:00
|
|
|
final message = await aliceSession.onOutgoingStanza(
|
|
|
|
|
OmemoOutgoingStanza(
|
|
|
|
|
// The bare receiver Jid
|
|
|
|
|
[bobJid],
|
|
|
|
|
|
|
|
|
|
// The payload we want to encrypt, i.e. the envelope.
|
|
|
|
|
envelope,
|
|
|
|
|
),
|
2022-08-09 13:48:26 +00:00
|
|
|
);
|
|
|
|
|
|
2023-06-12 17:37:51 +00:00
|
|
|
// In a proper implementation, we should also do some error checking here.
|
|
|
|
|
|
2022-08-09 13:48:26 +00:00
|
|
|
// Alice now builds the actual message stanza for Bob
|
|
|
|
|
final payload = base64.encode(message.ciphertext!);
|
|
|
|
|
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
|
|
|
|
|
// world, we have to serialise every EncryptedKey to a <key /> element and group them
|
|
|
|
|
// per Jid.
|
|
|
|
|
final key = message.encryptedKeys[0];
|
|
|
|
|
|
|
|
|
|
// 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.
|
|
|
|
|
// ignore: unused_local_variable
|
|
|
|
|
final aliceStanza = '''
|
|
|
|
|
<message from='$aliceJid/device1' to='$bobJid/device2'>
|
|
|
|
|
<encrypted xmlns='urn:xmpp:omemo:2'>
|
|
|
|
|
<header sid='${aliceDevice.id}'>
|
|
|
|
|
<keys jid='$bobJid'>
|
|
|
|
|
<key rid='${key.rid} kex='true'>
|
|
|
|
|
${key.value}
|
|
|
|
|
</key>
|
|
|
|
|
</keys>
|
|
|
|
|
</header>
|
|
|
|
|
<payload>
|
|
|
|
|
$payload
|
|
|
|
|
</payload>
|
|
|
|
|
</encrypted>
|
|
|
|
|
</message>
|
|
|
|
|
''';
|
|
|
|
|
|
|
|
|
|
// Alice can now send this message to Bob using our preferred XMPP library.
|
|
|
|
|
// ...
|
|
|
|
|
|
|
|
|
|
// 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.
|
|
|
|
|
final keys = [
|
|
|
|
|
EncryptedKey(bobJid, key.rid, key.value, true),
|
|
|
|
|
];
|
|
|
|
|
|
|
|
|
|
// Bob extracts the payload and attempts to decrypt it.
|
|
|
|
|
// ignore: unused_local_variable
|
2023-06-12 17:37:51 +00:00
|
|
|
final bobMessage = await bobManager.onIncomingStanza(
|
|
|
|
|
OmemoIncomingStanza(
|
|
|
|
|
// The bare sender JID of the message. In this case, it's Alice's.
|
|
|
|
|
aliceJid,
|
|
|
|
|
|
|
|
|
|
// The 'sid' attribute of the <header /> element. Here, we know that Alice only has one device.
|
|
|
|
|
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
|
|
|
|
|
/// relevant for Bob, so all children of <keys jid='$bobJid' />.
|
|
|
|
|
keys,
|
|
|
|
|
|
|
|
|
|
/// The text of the <payload /> element, if it exists. If not, then the message might be
|
|
|
|
|
/// a hearbeat, where no payload is sent. In that case, use null.
|
|
|
|
|
payload,
|
2023-06-15 22:18:14 +00:00
|
|
|
|
|
|
|
|
/// Since we did not receive this message due to a catch-up mechanism, like MAM, we
|
|
|
|
|
/// set this to false. If we, however, did use a catch-up mechanism, we must set this
|
|
|
|
|
/// to true to prevent the OPKs from being replaced.
|
|
|
|
|
false,
|
2023-06-12 17:37:51 +00:00
|
|
|
),
|
2022-08-09 13:48:26 +00:00
|
|
|
);
|
|
|
|
|
|
2023-06-12 17:20:43 +00:00
|
|
|
// All Bob has to do now is replace the OMEMO wrapper element
|
2022-08-09 13:48:26 +00:00
|
|
|
// <encrypted xmlns='urn:xmpp:omemo:2' />) with the content of the <content /> element
|
|
|
|
|
// of the envelope we just decrypted.
|
|
|
|
|
|
|
|
|
|
// Bob now has a session with Alice and can send encrypted message to her.
|
|
|
|
|
// Since they both used the BlindTrustBeforeVerificationTrustManager, they currently
|
|
|
|
|
// use blind trust, meaning that both Alice and Bob accept new devices without any
|
|
|
|
|
// hesitation. If Alice, however, decides to verify one of Bob's devices and sets
|
|
|
|
|
// it as verified using
|
|
|
|
|
// ```
|
|
|
|
|
// await aliceSession.trustManager.setDeviceTrust(bobJid, bobDevice.id, BTBVTrustState.verified)
|
|
|
|
|
// ```
|
|
|
|
|
// then Alice's OmemoSessionManager won't encrypt to new devices unless they are also
|
|
|
|
|
// verified. To prevent user confusion, you should check if every device is trusted
|
|
|
|
|
// before sending the message and ask the user for a trust decision.
|
|
|
|
|
// If you want to make the BlindTrustBeforeVerificationTrustManager persistent, then
|
|
|
|
|
// you need to subclass it and override the `Future<void> commitState()` and
|
|
|
|
|
// `Future<void> loadState()` functions. commitState is called everytime the internal
|
|
|
|
|
// state gets changed. loadState never gets automatically called but is more of a
|
|
|
|
|
// function for the user to restore the trust manager. In those functions you have
|
|
|
|
|
// access to `ratchetMap`, which maps a `RatchetMapKey` - essentially a tuple consisting
|
|
|
|
|
// of a bare Jid and the device identifier - to the trust state, and `devices` which
|
|
|
|
|
// maps a bare Jid to its device identifiers.
|
|
|
|
|
// To make the entire OmemoSessionManager persistent, you have two options:
|
|
|
|
|
// - use the provided `toJson()` and `fromJson()` functions. They, however, serialise
|
|
|
|
|
// and deserialise *ALL* known sessions, so it might be slow.
|
|
|
|
|
// - subscribe to the session manager's `eventStream`. There, events get triggered
|
|
|
|
|
// everytime a ratchet changes, our own device changes or the internal ratchet map
|
|
|
|
|
// gets changed. This give finer control over the the serialisation. The session
|
2022-08-09 13:49:40 +00:00
|
|
|
// manager can then be restored using its constructor. For a list of events, see
|
|
|
|
|
// lib/src/omemo/events.dart.
|
2022-06-30 12:00:18 +00:00
|
|
|
}
|
