crypto: check sender_device_keys on incoming Olm messages
#4922
Conversation
This file contains hidden or 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
MSC4147 added a `sender_device_keys` property to the plaintext of *all* olm-encrypted events. 03d4a30 added the field to `DecryptedOlmV1Event`, but due to Reasons, there is an almost-parallel struct `ToDeviceCustomEvent` which is used for event types other than the 4 we have content types for. To complete the set, let's add the field to `ToDeviceCustomEvent`.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4922 +/- ##
==========================================
+ Coverage 85.75% 85.79% +0.03%
==========================================
Files 316 316
Lines 35487 35501 +14
==========================================
+ Hits 30433 30459 +26
+ Misses 5054 5042 -12 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
richvdh
force-pushed
the
rav/check_sender_device_keys
branch
from
03ca45d to
59c5c48
Compare
MSC4147 added a `sender_device_keys` property to olm-encrypted to-device messages, with recommendations about checking the values in that propety. We do (most of?) those checks for `m.room_key` messages today, but not other types of to-device message.
richvdh
force-pushed
the
rav/check_sender_device_keys
branch
from
59c5c48 to
e020ba1
Compare
richvdh
added a commit
to matrix-org/matrix-js-sdk
that referenced
this pull request
Jun 21, 2025
For js-sdk users, this includes the following:
- Send stable identifier `sender_device_keys` for MSC4147 (Including device keys with Olm-encrypted events).
([#4964](matrix-org/matrix-rust-sdk#4964))
- Check the `sender_device_keys` field on _all_ incoming Olm-encrypted to-device messages and ignore any to-device messages which include the field but whose data is invalid (as per [MSC4147](matrix-org/matrix-spec-proposals#4147)).
([#4922](matrix-org/matrix-rust-sdk#4922))
- Fix bug which caused room keys to be unnecessarily rotated on every send in the presence of blacklisted/withheld devices in the room.
([#4954](matrix-org/matrix-rust-sdk#4954))
- Fix [matrix-rust-sdk#2729](matrix-org/matrix-rust-sdk#2729) which in rare cases can cause room key oversharing.
([#4975](matrix-org/matrix-rust-sdk#4975))
github-merge-queue bot
pushed a commit
to matrix-org/matrix-js-sdk
that referenced
this pull request
Jun 23, 2025
For js-sdk users, this includes the following:
- Send stable identifier `sender_device_keys` for MSC4147 (Including device keys with Olm-encrypted events).
([#4964](matrix-org/matrix-rust-sdk#4964))
- Check the `sender_device_keys` field on _all_ incoming Olm-encrypted to-device messages and ignore any to-device messages which include the field but whose data is invalid (as per [MSC4147](matrix-org/matrix-spec-proposals#4147)).
([#4922](matrix-org/matrix-rust-sdk#4922))
- Fix bug which caused room keys to be unnecessarily rotated on every send in the presence of blacklisted/withheld devices in the room.
([#4954](matrix-org/matrix-rust-sdk#4954))
- Fix [matrix-rust-sdk#2729](matrix-org/matrix-rust-sdk#2729) which in rare cases can cause room key oversharing.
([#4975](matrix-org/matrix-rust-sdk#4975))
github-merge-queue bot
pushed a commit
to matrix-org/matrix-js-sdk
that referenced
this pull request
Jun 23, 2025
For js-sdk users, this includes the following:
- Send stable identifier `sender_device_keys` for MSC4147 (Including device keys with Olm-encrypted events).
([#4964](matrix-org/matrix-rust-sdk#4964))
- Check the `sender_device_keys` field on _all_ incoming Olm-encrypted to-device messages and ignore any to-device messages which include the field but whose data is invalid (as per [MSC4147](matrix-org/matrix-spec-proposals#4147)).
([#4922](matrix-org/matrix-rust-sdk#4922))
- Fix bug which caused room keys to be unnecessarily rotated on every send in the presence of blacklisted/withheld devices in the room.
([#4954](matrix-org/matrix-rust-sdk#4954))
- Fix [matrix-rust-sdk#2729](matrix-org/matrix-rust-sdk#2729) which in rare cases can cause room key oversharing.
([#4975](matrix-org/matrix-rust-sdk#4975))
github-merge-queue bot
pushed a commit
to matrix-org/matrix-js-sdk
that referenced
this pull request
Jun 23, 2025
For js-sdk users, this includes the following:
- Send stable identifier `sender_device_keys` for MSC4147 (Including device keys with Olm-encrypted events).
([#4964](matrix-org/matrix-rust-sdk#4964))
- Check the `sender_device_keys` field on _all_ incoming Olm-encrypted to-device messages and ignore any to-device messages which include the field but whose data is invalid (as per [MSC4147](matrix-org/matrix-spec-proposals#4147)).
([#4922](matrix-org/matrix-rust-sdk#4922))
- Fix bug which caused room keys to be unnecessarily rotated on every send in the presence of blacklisted/withheld devices in the room.
([#4954](matrix-org/matrix-rust-sdk#4954))
- Fix [matrix-rust-sdk#2729](matrix-org/matrix-rust-sdk#2729) which in rare cases can cause room key oversharing.
([#4975](matrix-org/matrix-rust-sdk#4975))
toger5
pushed a commit
to matrix-org/matrix-js-sdk
that referenced
this pull request
Jul 18, 2025
For js-sdk users, this includes the following:
- Send stable identifier `sender_device_keys` for MSC4147 (Including device keys with Olm-encrypted events).
([#4964](matrix-org/matrix-rust-sdk#4964))
- Check the `sender_device_keys` field on _all_ incoming Olm-encrypted to-device messages and ignore any to-device messages which include the field but whose data is invalid (as per [MSC4147](matrix-org/matrix-spec-proposals#4147)).
([#4922](matrix-org/matrix-rust-sdk#4922))
- Fix bug which caused room keys to be unnecessarily rotated on every send in the presence of blacklisted/withheld devices in the room.
([#4954](matrix-org/matrix-rust-sdk#4954))
- Fix [matrix-rust-sdk#2729](matrix-org/matrix-rust-sdk#2729) which in rare cases can cause room key oversharing.
([#4975](matrix-org/matrix-rust-sdk#4975))
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.
MSC4147 added a
sender_device_keysproperty to olm-encrypted to-device messages, with recommendations about checking the values in that propety. We do (most of?) those checks form.room_keymessages today, but not other types of to-device message.(This is prep work for #4512.)