Compare commits

..

No commits in common. "96d9c55c870fddee44880df6a5257c9fd9b46282" and "438012d8f8e24f63ba69c0af6ee80a2d433c1d42" have entirely different histories.

7 changed files with 134 additions and 77 deletions

View File

@ -94,20 +94,11 @@ class OmemoDoubleRatchet {
] ]
} }
*/ */
// NOTE: Dart has some issues with just casting a List<dynamic> to List<Map<...>>, as final mkSkipped = <SkippedKey, List<int>>{};
// such we need to convert the items by hand. for (final entry in data['mkskipped']! as List<Map<String, dynamic>>) {
final mkSkipped = Map<SkippedKey, List<int>>.fromEntries( final key = SkippedKey.fromJson(entry);
(data['mkskipped']! as List<dynamic>).map<MapEntry<SkippedKey, List<int>>>( mkSkipped[key] = base64.decode(entry['key']! as String);
(entry) { }
final map = entry as Map<String, dynamic>;
final key = SkippedKey.fromJson(map);
return MapEntry(
key,
base64.decode(map['key']! as String),
);
},
),
);
return OmemoDoubleRatchet( return OmemoDoubleRatchet(
OmemoKeyPair.fromBytes( OmemoKeyPair.fromBytes(

View File

@ -49,23 +49,14 @@ class Device {
] ]
} }
*/ */
// NOTE: Dart has some issues with just casting a List<dynamic> to List<Map<...>>, as final opks = <int, OmemoKeyPair>{};
// such we need to convert the items by hand. for (final opk in data['opks']! as List<Map<String, dynamic>>) {
final opks = Map<int, OmemoKeyPair>.fromEntries( opks[opk['id']! as int] = OmemoKeyPair.fromBytes(
(data['opks']! as List<dynamic>).map<MapEntry<int, OmemoKeyPair>>( base64.decode(opk['public']! as String),
(opk) { base64.decode(opk['private']! as String),
final map = opk as Map<String, dynamic>; KeyPairType.x25519,
return MapEntry( );
map['id']! as int, }
OmemoKeyPair.fromBytes(
base64.decode(map['public']! as String),
base64.decode(map['private']! as String),
KeyPairType.x25519,
),
);
},
),
);
return Device( return Device(
data['jid']! as String, data['jid']! as String,

View File

@ -3,7 +3,6 @@ import 'dart:convert';
import 'package:collection/collection.dart'; import 'package:collection/collection.dart';
import 'package:cryptography/cryptography.dart'; import 'package:cryptography/cryptography.dart';
import 'package:hex/hex.dart'; import 'package:hex/hex.dart';
import 'package:logging/logging.dart';
import 'package:meta/meta.dart'; import 'package:meta/meta.dart';
import 'package:omemo_dart/src/crypto.dart'; import 'package:omemo_dart/src/crypto.dart';
import 'package:omemo_dart/src/double_ratchet/double_ratchet.dart'; import 'package:omemo_dart/src/double_ratchet/double_ratchet.dart';
@ -32,28 +31,31 @@ class OmemoSessionManager {
OmemoSessionManager(this._device, this._deviceMap, this._ratchetMap, this._trustManager) OmemoSessionManager(this._device, this._deviceMap, this._ratchetMap, this._trustManager)
: _lock = Lock(), : _lock = Lock(),
_deviceLock = Lock(), _deviceLock = Lock(),
_eventStreamController = StreamController<OmemoEvent>.broadcast(), _eventStreamController = StreamController<OmemoEvent>.broadcast();
_log = Logger('OmemoSessionManager');
/// Deserialise the OmemoSessionManager from JSON data [data].
factory OmemoSessionManager.fromJson(Map<String, dynamic> data, TrustManager trustManager) {
final ratchetMap = <RatchetMapKey, OmemoDoubleRatchet>{};
for (final rawRatchet in data['sessions']! as List<Map<String, dynamic>>) {
final key = RatchetMapKey(rawRatchet['jid']! as String, rawRatchet['deviceId']! as int);
final ratchet = OmemoDoubleRatchet.fromJson(rawRatchet['ratchet']! as Map<String, dynamic>);
ratchetMap[key] = ratchet;
}
return OmemoSessionManager(
Device.fromJson(data['device']! as Map<String, dynamic>),
data['devices']! as Map<String, List<int>>,
ratchetMap,
trustManager,
);
}
/// Deserialise the OmemoSessionManager from JSON data [data] that does not contain /// Deserialise the OmemoSessionManager from JSON data [data] that does not contain
/// the ratchet sessions. /// the ratchet sessions.
factory OmemoSessionManager.fromJsonWithoutSessions( factory OmemoSessionManager.fromJsonWithoutSessions(Map<String, dynamic> data, Map<RatchetMapKey, OmemoDoubleRatchet> ratchetMap, TrustManager trustManager) {
Map<String, dynamic> data,
Map<RatchetMapKey, OmemoDoubleRatchet> ratchetMap,
TrustManager trustManager,
) {
// NOTE: Dart has some issues with just casting a List<dynamic> to List<Map<...>>, as
// such we need to convert the items by hand.
return OmemoSessionManager( return OmemoSessionManager(
Device.fromJson(data['device']! as Map<String, dynamic>), Device.fromJson(data['device']! as Map<String, dynamic>),
(data['devices']! as Map<String, dynamic>).map<String, List<int>>( data['devices']! as Map<String, List<int>>,
(key, value) {
return MapEntry(
key,
(value as List<dynamic>).map<int>((i) => i as int).toList(),
);
}
),
ratchetMap, ratchetMap,
trustManager, trustManager,
); );
@ -67,9 +69,6 @@ class OmemoSessionManager {
return OmemoSessionManager(device, {}, {}, trustManager); return OmemoSessionManager(device, {}, {}, trustManager);
} }
/// Logging
Logger _log;
/// Lock for _ratchetMap and _bundleMap /// Lock for _ratchetMap and _bundleMap
final Lock _lock; final Lock _lock;
@ -305,7 +304,7 @@ class OmemoSessionManager {
/// [mapKey] with [oldRatchet]. /// [mapKey] with [oldRatchet].
Future<void> _restoreRatchet(RatchetMapKey mapKey, OmemoDoubleRatchet oldRatchet) async { Future<void> _restoreRatchet(RatchetMapKey mapKey, OmemoDoubleRatchet oldRatchet) async {
await _lock.synchronized(() { await _lock.synchronized(() {
_log.finest('Restoring ratchet ${mapKey.jid}:${mapKey.deviceId}'); print('RESTORING RATCHETS');
_ratchetMap[mapKey] = oldRatchet; _ratchetMap[mapKey] = oldRatchet;
// Commit the ratchet // Commit the ratchet
@ -562,6 +561,42 @@ class OmemoSessionManager {
@visibleForTesting @visibleForTesting
Map<RatchetMapKey, OmemoDoubleRatchet> getRatchetMap() => _ratchetMap; Map<RatchetMapKey, OmemoDoubleRatchet> getRatchetMap() => _ratchetMap;
/// Serialise the entire session manager into a JSON object.
Future<Map<String, dynamic>> toJson() async {
/*
{
'devices': {
'alice@...': [1, 2, ...],
'bob@...': [1],
...
},
'device': { ... },
'sessions': [
{
'jid': 'alice@...',
'deviceId': 1,
'ratchet': { ... },
},
...
],
}
*/
final sessions = List<Map<String, dynamic>>.empty(growable: true);
for (final entry in _ratchetMap.entries) {
sessions.add({
'jid': entry.key.jid,
'deviceId': entry.key.deviceId,
'ratchet': await entry.value.toJson(),
});
}
return {
'devices': _deviceMap,
'device': await (await getDevice()).toJson(),
'sessions': sessions,
};
}
/// Serialise the entire session manager into a JSON object. /// Serialise the entire session manager into a JSON object.
Future<Map<String, dynamic>> toJsonWithoutSessions() async { Future<Map<String, dynamic>> toJsonWithoutSessions() async {
/* /*

View File

@ -214,6 +214,11 @@ abstract class BlindTrustBeforeVerificationTrustManager extends TrustManager {
@visibleForOverriding @visibleForOverriding
Future<void> commitState(); Future<void> commitState();
/// Called when the user wants to restore the state of the trust manager. The format
/// and actual storage mechanism is left to the user.
@visibleForOverriding
Future<void> loadState();
@visibleForTesting @visibleForTesting
BTBVTrustState getDeviceTrust(String jid, int deviceId) => trustCache[RatchetMapKey(jid, deviceId)]!; BTBVTrustState getDeviceTrust(String jid, int deviceId) => trustCache[RatchetMapKey(jid, deviceId)]!;
} }
@ -223,4 +228,7 @@ abstract class BlindTrustBeforeVerificationTrustManager extends TrustManager {
class MemoryBTBVTrustManager extends BlindTrustBeforeVerificationTrustManager { class MemoryBTBVTrustManager extends BlindTrustBeforeVerificationTrustManager {
@override @override
Future<void> commitState() async {} Future<void> commitState() async {}
@override
Future<void> loadState() async {}
} }

View File

@ -11,7 +11,6 @@ dependencies:
collection: ^1.16.0 collection: ^1.16.0
cryptography: ^2.0.5 cryptography: ^2.0.5
hex: ^0.2.0 hex: ^0.2.0
logging: ^1.0.2
meta: ^1.7.0 meta: ^1.7.0
pinenacl: ^0.5.1 pinenacl: ^0.5.1
synchronized: ^3.0.0+2 synchronized: ^3.0.0+2

View File

@ -1,17 +1,9 @@
import 'package:logging/logging.dart';
import 'package:omemo_dart/omemo_dart.dart'; import 'package:omemo_dart/omemo_dart.dart';
import 'package:omemo_dart/src/trust/always.dart'; import 'package:omemo_dart/src/trust/always.dart';
import 'package:omemo_dart/src/trust/never.dart'; import 'package:omemo_dart/src/trust/never.dart';
import 'package:test/test.dart'; import 'package:test/test.dart';
void main() { void main() {
Logger.root
..level = Level.ALL
..onRecord.listen((record) {
// ignore: avoid_print
print('${record.level.name}: ${record.message}');
});
test('Test using OMEMO sessions with only one device per user', () async { test('Test using OMEMO sessions with only one device per user', () async {
const aliceJid = 'alice@server.example'; const aliceJid = 'alice@server.example';
const bobJid = 'bob@other.server.example'; const bobJid = 'bob@other.server.example';

View File

@ -3,10 +3,6 @@ import 'package:omemo_dart/omemo_dart.dart';
import 'package:omemo_dart/src/trust/always.dart'; import 'package:omemo_dart/src/trust/always.dart';
import 'package:test/test.dart'; import 'package:test/test.dart';
Map<String, dynamic> jsonify(Map<String, dynamic> map) {
return jsonDecode(jsonEncode(map)) as Map<String, dynamic>;
}
void main() { void main() {
test('Test serialising and deserialising the Device', () async { test('Test serialising and deserialising the Device', () async {
// Generate a random session // Generate a random session
@ -16,7 +12,7 @@ void main() {
opkAmount: 1, opkAmount: 1,
); );
final oldDevice = await oldSession.getDevice(); final oldDevice = await oldSession.getDevice();
final serialised = jsonify(await oldDevice.toJson()); final serialised = await oldDevice.toJson();
final newDevice = Device.fromJson(serialised); final newDevice = Device.fromJson(serialised);
expect(await oldDevice.equals(newDevice), true); expect(await oldDevice.equals(newDevice), true);
@ -30,7 +26,7 @@ void main() {
opkAmount: 1, opkAmount: 1,
); );
final oldDevice = await (await oldSession.getDevice()).replaceSignedPrekey(); final oldDevice = await (await oldSession.getDevice()).replaceSignedPrekey();
final serialised = jsonify(await oldDevice.toJson()); final serialised = await oldDevice.toJson();
final newDevice = Device.fromJson(serialised); final newDevice = Device.fromJson(serialised);
expect(await oldDevice.equals(newDevice), true); expect(await oldDevice.equals(newDevice), true);
@ -64,7 +60,7 @@ void main() {
aliceMessage.encryptedKeys, aliceMessage.encryptedKeys,
); );
final aliceOld = aliceSession.getRatchet(bobJid, await bobSession.getDeviceId()); final aliceOld = aliceSession.getRatchet(bobJid, await bobSession.getDeviceId());
final aliceSerialised = jsonify(await aliceOld.toJson()); final aliceSerialised = await aliceOld.toJson();
final aliceNew = OmemoDoubleRatchet.fromJson(aliceSerialised); final aliceNew = OmemoDoubleRatchet.fromJson(aliceSerialised);
expect(await aliceOld.equals(aliceNew), true); expect(await aliceOld.equals(aliceNew), true);
@ -89,11 +85,9 @@ void main() {
); );
// Serialise and deserialise // Serialise and deserialise
final serialised = jsonify(await oldSession.toJsonWithoutSessions()); final serialised = await oldSession.toJson();
final newSession = OmemoSessionManager.fromJsonWithoutSessions( final newSession = OmemoSessionManager.fromJson(
serialised, serialised,
// NOTE: At this point, we don't care about this attribute
{},
AlwaysTrustingTrustManager(), AlwaysTrustingTrustManager(),
); );
@ -101,6 +95,51 @@ void main() {
final newDevice = await newSession.getDevice(); final newDevice = await newSession.getDevice();
expect(await oldDevice.equals(newDevice), true); expect(await oldDevice.equals(newDevice), true);
expect(await oldSession.getDeviceMap(), await newSession.getDeviceMap()); expect(await oldSession.getDeviceMap(), await newSession.getDeviceMap());
expect(oldSession.getRatchetMap().length, newSession.getRatchetMap().length);
for (final session in oldSession.getRatchetMap().entries) {
expect(newSession.getRatchetMap().containsKey(session.key), true);
final oldRatchet = oldSession.getRatchetMap()[session.key]!;
final newRatchet = newSession.getRatchetMap()[session.key]!;
expect(await oldRatchet.equals(newRatchet), true);
}
});
test('Test serialising and deserialising the BlindTrustBeforeVerificationTrustManager', () async {
// Caroline's BTBV manager
final btbv = MemoryBTBVTrustManager();
// Example data
const aliceJid = 'alice@some.server';
const bobJid = 'bob@other.server';
// Caroline starts a chat a device from Alice
await btbv.onNewSession(aliceJid, 1);
expect(await btbv.isTrusted(aliceJid, 1), true);
expect(await btbv.isEnabled(aliceJid, 1), true);
// Caroline meets with Alice and verifies her fingerprint
await btbv.setDeviceTrust(aliceJid, 1, BTBVTrustState.verified);
expect(await btbv.isTrusted(aliceJid, 1), true);
// Alice adds a new device
await btbv.onNewSession(aliceJid, 2);
expect(await btbv.isTrusted(aliceJid, 2), false);
expect(btbv.getDeviceTrust(aliceJid, 2), BTBVTrustState.notTrusted);
expect(await btbv.isEnabled(aliceJid, 2), false);
// Caronline starts a chat with Bob but since they live far apart, Caroline cannot
// verify his fingerprint.
await btbv.onNewSession(bobJid, 3);
// Bob adds a new device
await btbv.onNewSession(bobJid, 4);
expect(await btbv.isTrusted(bobJid, 3), true);
expect(await btbv.isTrusted(bobJid, 4), true);
expect(btbv.getDeviceTrust(bobJid, 3), BTBVTrustState.blindTrust);
expect(btbv.getDeviceTrust(bobJid, 4), BTBVTrustState.blindTrust);
expect(await btbv.isEnabled(bobJid, 3), true);
expect(await btbv.isEnabled(bobJid, 4), true);
}); });
test('Test serializing and deserializing RatchetMapKey', () { test('Test serializing and deserializing RatchetMapKey', () {
@ -128,19 +167,21 @@ void main() {
await btbv.onNewSession(bobJid, 3); await btbv.onNewSession(bobJid, 3);
await btbv.onNewSession(bobJid, 4); await btbv.onNewSession(bobJid, 4);
final serialized = jsonify(await btbv.toJson()); final managerJson = await btbv.toJson();
final managerString = jsonEncode(managerJson);
final managerPostJson = jsonDecode(managerString) as Map<String, dynamic>;
final deviceList = BlindTrustBeforeVerificationTrustManager.deviceListFromJson( final deviceList = BlindTrustBeforeVerificationTrustManager.deviceListFromJson(
serialized, managerPostJson,
); );
expect(btbv.devices, deviceList); expect(btbv.devices, deviceList);
final trustCache = BlindTrustBeforeVerificationTrustManager.trustCacheFromJson( final trustCache = BlindTrustBeforeVerificationTrustManager.trustCacheFromJson(
serialized, managerPostJson,
); );
expect(btbv.trustCache, trustCache); expect(btbv.trustCache, trustCache);
final enableCache = BlindTrustBeforeVerificationTrustManager.enableCacheFromJson( final enableCache = BlindTrustBeforeVerificationTrustManager.enableCacheFromJson(
serialized, managerPostJson,
); );
expect(btbv.enablementCache, enableCache); expect(btbv.enablementCache, enableCache);
}); });