Share Megolm session keys when inviting a new user #1447
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Anderas
requested review from
a team and
gileluard
and removed request for
a team
Anderas
force-pushed
the
andy/4947_sharing_keys
branch
from
5493d8b to
e941973
Compare
Anderas
force-pushed
the
andy/4947_sharing_keys
branch
from
e941973 to
07526b3
Compare
gileluard
approved these changes
Apr 27, 2022
| chainIndex:nil]; | ||
|
|
||
| MXUsersDevicesMap<NSDictionary*> *contentMap = [[MXUsersDevicesMap alloc] init]; | ||
| for (MXDeviceInfo *deviceInfo in devices) { |
There was a problem hiding this comment.
Suggested change
| for (MXDeviceInfo *deviceInfo in devices) { | |
| for (MXDeviceInfo *deviceInfo in devices) | |
| { |
| MXUsersDevicesMap<NSDictionary*> *contentMap = [[MXUsersDevicesMap alloc] init]; | ||
| for (MXDeviceInfo *deviceInfo in devices) { | ||
| MXOlmSessionResult *olmSessionResult = [results objectForDevice:deviceInfo.deviceId forUser:userId]; | ||
| if (olmSessionResult.sessionId) { |
There was a problem hiding this comment.
Suggested change
| if (olmSessionResult.sessionId) { | |
| if (olmSessionResult.sessionId) | |
| { |
| if (olmSessionResult.sessionId) { | ||
| NSDictionary *message = [self->crypto encryptMessage:payload forDevices:@[deviceInfo]]; | ||
| [contentMap setObject:message forUser:userId andDevice:deviceInfo.deviceId]; | ||
| } else { |
There was a problem hiding this comment.
Suggested change
| } else { | |
| } | |
| else | |
| { |
| } | ||
| } | ||
|
|
||
| if (contentMap.count == 0) { |
There was a problem hiding this comment.
Suggested change
| if (contentMap.count == 0) { | |
| if (contentMap.count == 0) | |
| { |
MatrixSDK/Data/MXRoom.m
Outdated
| @@ -116,6 +121,11 @@ - (id)initWithRoomId:(NSString *)roomId matrixSession:(MXSession *)mxSession2 an | |||
| { | |||
| _roomId = roomId; | |||
| mxSession = mxSession2; | |||
|
|
|||
| if (mxSession.crypto) { | |||
There was a problem hiding this comment.
Suggested change
| if (mxSession.crypto) { | |
| if (mxSession.crypto) | |
| { |
MatrixSDK/Data/MXRoom.m
Outdated
| @@ -1932,9 +1942,23 @@ - (MXHTTPOperation*)inviteUser:(NSString*)userId | |||
| success:(void (^)(void))success | |||
| failure:(void (^)(NSError *error))failure | |||
| { | |||
| if (MXSDKOptions.sharedInstance.enableRoomSharedHistoryOnInvite) { | |||
There was a problem hiding this comment.
Suggested change
| if (MXSDKOptions.sharedInstance.enableRoomSharedHistoryOnInvite) { | |
| if (MXSDKOptions.sharedInstance.enableRoomSharedHistoryOnInvite) | |
| { |
Thx, would be great to have a linter / formatter for this, as one has to fight the Xcode tooling / autocompletion with this style |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates to element-hq/element-ios#4947 which is an implementation of matrix-org/matrix-spec-proposals#3061
After previously storing
sharedHistoryflag for inbound Megolm sessions, add new mechanism that will share these inbound keys with a user invited to the current room.Because the current Rest API allows sharing of only one key at a time and because sharing keys always increases the amount of potential issues (e.g. how far in the past?, shared with which devices?, do we retry if sharing fails?), the scope of this feature is currently limited to only share the "immediate context", which is arbitrarily interpreted as keys for the last 20 messages in this room. This should achieve the outcome that when you are invited to a room, you can see any immediate messages before that may be related to you invitation.
We will be re-implementing key-sharing in RustSDK where the feature will be more robust and accounting for more edge cases.
In this PR:
MXSharedHistoryKeyManager(equivalent to existingMXOutgoingRoomKeyRequestManagerandMXIncomingRoomKeyRequestManager), which handles the complexity of fetching the last 20 messages, extracting their session details, and creating key sharing requests accordinglyMXMegolmDecryptionto allow sharing of keys viaMXSharedHistoryKeyRequest. Previously one could only share keys with one device per user at a time, with the new request keys may be shared with multiple devices at once. Existing tests (in particularMXCryptoShareTests.testNominalCase()) should ensure the refactor did not break existing behaviourMXRoomwhen a user is invited. The behaviour is controlled by a build / config flag, so that forms of the project can disable this behavior.