Add support for the shared history flag defined in MSC3061 #4700
+532
−75
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
… a helper function
…access in some places In several places, we access almost all the fields of a struct to create an `InboundGroupSession` from a pure data struct. When new fields are added to these data structs, it's easy to overlook updating the `InboundGroupSession` accordingly. By using struct destructuring, we ensure that newly added fields are explicitly considered, making it harder to forget one of the newly added fields.
poljar
force-pushed
the
poljar/shared_history_flag
branch
3 times, most recently
from
fc77217 to
b0918eb
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4700 +/- ##
==========================================
+ Coverage 85.90% 85.96% +0.06%
==========================================
Files 292 292
Lines 33907 33940 +33
==========================================
+ Hits 29127 29176 +49
+ Misses 4780 4764 -16 ☔ View full report in Codecov by Sentry. |
This patch adds support for the `shared_history` flag from MSC3061 to the `m.room_key` content, exported room keys, and backed-up room keys. The flag is now persisted in our `InboundGroupSession`. Additionally, when creating a new `InboundGroupSession`, we ensure the `shared_history` flag is set appropriately. MSC3061: matrix-org/matrix-spec-proposals#3061
…elves crate a session
poljar
force-pushed
the
poljar/shared_history_flag
branch
from
b0918eb to
c4c6c6b
Compare
poljar
requested review from
jmartinesp and
richvdh
and removed request for
a team
jmartinesp
reviewed
Feb 24, 2025
Hywan
approved these changes
Feb 24, 2025
Comment on lines
335
to
345
| let PickledInboundGroupSession { | ||
| pickle, | ||
| sender_key, | ||
| signing_key, | ||
| sender_data, | ||
| room_id, | ||
| imported, | ||
| backed_up, | ||
| history_visibility, | ||
| algorithm, | ||
| } = pickle; |
richvdh
reviewed
Feb 24, 2025
| sender_claimed_keys, | ||
| forwarding_curve25519_key_chain: _, | ||
| } = key; | ||
|
|
||
| let config = OutboundGroupSession::session_config(&key.algorithm)?; |
| /// A backed up version of an `InboundGroupSession` | ||
| /// A backed up version of an [`InboundGroupSession`]. | ||
| /// | ||
| /// This can be used to backup the [`InboundGroupSession`] to the server using |
There was a problem hiding this comment.
nit
Suggested change
| /// This can be used to backup the [`InboundGroupSession`] to the server using | |
| /// This can be used to back up the [`InboundGroupSession`] to the server using |
Comment on lines
+158
to
+159
| /// Whether this [`InboundGroupSession`] can be shared with newly joined | ||
| /// users, allowing access to history, as defined in [MSC3061]. |
There was a problem hiding this comment.
we actually do the share when the user is invited -- they may never join.
Suggested change
| /// Whether this [`InboundGroupSession`] can be shared with newly joined | |
| /// users, allowing access to history, as defined in [MSC3061]. | |
| /// Whether this [`InboundGroupSession`] can be shared with users who are invited to the room | |
| /// in the future, allowing access to history, as defined in [MSC3061]. |
There was a problem hiding this comment.
This wording appears in a lot of places in this commit -- it could do with updating in all of them.
| @@ -184,6 +191,7 @@ impl InboundGroupSession { | |||
| sender_data: SenderData, | |||
| encryption_algorithm: EventEncryptionAlgorithm, | |||
| history_visibility: Option<HistoryVisibility>, | |||
| shared_history: bool, | |||
There was a problem hiding this comment.
I guess if you're getting rid of this constructor soon it's fine, but as a matter of good practice, I'd like to see the new parameter documented.
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.
This is the first PR in many for the "Encrypted history sharing" feature.
This specific PR tackles element-hq/element-meta#2720.
There are a couple of commits preparing the introduction of the
shared_historyflag but the meat of the PR is contained in 97a7705. The latter commits add a bunch of tests ensuring that the flag is correctly handled in all the various scenarios where we receive or send a room key.Thus a review commit by commit is advised.
One final note, the main constructor for
InboundGroupSessionnow has too many arguments, but I'd like to get rid of that constructor or at least make it private. In many (or perhaps all?) cases this constructor is used to create anInboundGroupSessionfor testing purposes. I think that theAccount::create_group_session_pair()method is better suited for this purpose.