Skip to content

Commit

Permalink
Merge pull request #1623 from famedly/nico/fix-key-backup
Browse files Browse the repository at this point in the history 
fix: key uploads only running once
  • Loading branch information
@krille-chan
krille-chan authored Nov 27, 2023
2 parents 9019dfd + 25f4353 commit f1e0268
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 65 deletions.
9 changes: 6 additions & 3 deletions lib/encryption/encryption.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -232,9 +232,12 @@ class Encryption {
// the entry should always exist. In the case it doesn't, the following
// line *could* throw an error. As that is a future, though, and we call
// it un-awaited here, nothing happens, which is exactly the result we want
// ignore: discarded_futures
client.database?.updateInboundGroupSessionIndexes(
json.encode(inboundGroupSession.indexes), roomId, sessionId);
client.database
// ignore: discarded_futures
?.updateInboundGroupSessionIndexes(
json.encode(inboundGroupSession.indexes), roomId, sessionId)
// ignore: discarded_futures
.onError((e, _) => Logs().e('Ignoring error for updating indexes'));
}
decryptedPayload = json.decode(decryptResult.plaintext);
} catch (exception) {
Expand Down
134 changes: 73 additions & 61 deletions lib/encryption/key_manager.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -795,74 +795,86 @@ class KeyManager {
// Make sure to not run in parallel
if (_uploadingFuture != null) {
if (skipIfInProgress) return;
await _uploadingFuture;
try {
await _uploadingFuture;
} finally {
// shouldn't be necessary, since it will be unset already by the other process that started it, but just to be safe, also unset the future here
_uploadingFuture = null;
}
}
final completer = Completer<void>();
_uploadingFuture = completer.future;

await client.userDeviceKeysLoading;
try {
if (!(await isCached())) {
return; // we can't backup anyways
}
final dbSessions = await database.getInboundGroupSessionsToUpload();
if (dbSessions.isEmpty) {
return; // nothing to do
}
final privateKey =
base64decodeUnpadded((await encryption.ssss.getCached(megolmKey))!);
// decryption is needed to calculate the public key and thus see if the claimed information is in fact valid
final decryption = olm.PkDecryption();
final info = await getRoomKeysBackupInfo(false);
String backupPubKey;
Future<void> uploadInternal() async {
try {
backupPubKey = decryption.init_with_private_key(privateKey);
await client.userDeviceKeysLoading;

if (info.algorithm !=
BackupAlgorithm.mMegolmBackupV1Curve25519AesSha2 ||
info.authData['public_key'] != backupPubKey) {
return;
if (!(await isCached())) {
return; // we can't backup anyways
}
final args = GenerateUploadKeysArgs(
pubkey: backupPubKey,
dbSessions: <DbInboundGroupSessionBundle>[],
userId: userID,
);
// we need to calculate verified beforehand, as else we pass a closure to an isolate
// with 500 keys they do, however, noticably block the UI, which is why we give brief async suspentions in here
// so that the event loop can progress
var i = 0;
for (final dbSession in dbSessions) {
final device =
client.getUserDeviceKeysByCurve25519Key(dbSession.senderKey);
args.dbSessions.add(DbInboundGroupSessionBundle(
dbSession: dbSession,
verified: device?.verified ?? false,
));
i++;
if (i > 10) {
await Future.delayed(Duration(milliseconds: 1));
i = 0;
}
final dbSessions = await database.getInboundGroupSessionsToUpload();
if (dbSessions.isEmpty) {
return; // nothing to do
}
final roomKeys =
await client.nativeImplementations.generateUploadKeys(args);
Logs().i('[Key Manager] Uploading ${dbSessions.length} room keys...');
// upload the payload...
await client.putRoomKeys(info.version, roomKeys);
// and now finally mark all the keys as uploaded
// no need to optimze this, as we only run it so seldomly and almost never with many keys at once
for (final dbSession in dbSessions) {
await database.markInboundGroupSessionAsUploaded(
dbSession.roomId, dbSession.sessionId);
final privateKey =
base64decodeUnpadded((await encryption.ssss.getCached(megolmKey))!);
// decryption is needed to calculate the public key and thus see if the claimed information is in fact valid
final decryption = olm.PkDecryption();
final info = await getRoomKeysBackupInfo(false);
String backupPubKey;
try {
backupPubKey = decryption.init_with_private_key(privateKey);

if (info.algorithm !=
BackupAlgorithm.mMegolmBackupV1Curve25519AesSha2 ||
info.authData['public_key'] != backupPubKey) {
decryption.free();
return;
}
final args = GenerateUploadKeysArgs(
pubkey: backupPubKey,
dbSessions: <DbInboundGroupSessionBundle>[],
userId: userID,
);
// we need to calculate verified beforehand, as else we pass a closure to an isolate
// with 500 keys they do, however, noticably block the UI, which is why we give brief async suspentions in here
// so that the event loop can progress
var i = 0;
for (final dbSession in dbSessions) {
final device =
client.getUserDeviceKeysByCurve25519Key(dbSession.senderKey);
args.dbSessions.add(DbInboundGroupSessionBundle(
dbSession: dbSession,
verified: device?.verified ?? false,
));
i++;
if (i > 10) {
await Future.delayed(Duration(milliseconds: 1));
i = 0;
}
}
final roomKeys =
await client.nativeImplementations.generateUploadKeys(args);
Logs().i('[Key Manager] Uploading ${dbSessions.length} room keys...');
// upload the payload...
await client.putRoomKeys(info.version, roomKeys);
// and now finally mark all the keys as uploaded
// no need to optimze this, as we only run it so seldomly and almost never with many keys at once
for (final dbSession in dbSessions) {
await database.markInboundGroupSessionAsUploaded(
dbSession.roomId, dbSession.sessionId);
}
} finally {
decryption.free();
}
} finally {
decryption.free();
} catch (e, s) {
Logs().e('[Key Manager] Error uploading room keys', e, s);
}
} catch (e, s) {
Logs().e('[Key Manager] Error uploading room keys', e, s);
}

_uploadingFuture = uploadInternal();
try {
await _uploadingFuture;
} finally {
completer.complete();
_uploadingFuture = null;
}
}

Expand Down Expand Up @@ -1187,12 +1199,12 @@ RoomKeys generateUploadKeysImplementation(GenerateUploadKeysArgs args) {
},
);
}
enc.free();
return roomKeys;
} catch (e, s) {
Logs().e('[Key Manager] Error generating payload', e, s);
rethrow;
} finally {
enc.free();
rethrow;
}
}

Expand Down
6 changes: 5 additions & 1 deletion lib/src/utils/native_implementations.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ abstract class NativeImplementations {

/// this implementation will catch any non-implemented method
@override
dynamic noSuchMethod(Invocation invocation) async {
dynamic noSuchMethod(Invocation invocation) {
final dynamic argument = invocation.positionalArguments.single;
final memberName = invocation.memberName.toString().split('"')[1];

Expand All @@ -62,11 +62,15 @@ abstract class NativeImplementations {
'Fallback from NativeImplementations.dummy used.',
);
switch (memberName) {
// we need to pass the futures right through or we will run into type errors later!
case 'generateUploadKeys':
// ignore: discarded_futures
return dummy.generateUploadKeys(argument);
case 'keyFromPassphrase':
// ignore: discarded_futures
return dummy.keyFromPassphrase(argument);
case 'decryptFile':
// ignore: discarded_futures
return dummy.decryptFile(argument);
case 'shrinkImage':
return dummy.shrinkImage(argument);
Expand Down

0 comments on commit f1e0268

Please sign in to comment.