WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

feat(crypto): Add forwarder_data to InboundGroupSession and pickle. #5943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kaylendog merged 5 commits into from
Dec 17, 2025
Merged

feat(crypto): Add forwarder_data to InboundGroupSession and pickle. #5943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f753d47
feat: Add `forwarder_data` to `InboundGroupSession` and pickle.
richvdh Dec 9, 2025
809643a
tests(crypto): Doctests, update snapshots to include `forwarder_data`.
kaylendog Dec 10, 2025
85f07b1
chore: Remove unused `TryFrom<&HistoricRoomKey>` implementation.
kaylendog Dec 17, 2025
f94ce7e
docs: Improve doc comments, linkify MSC4268.
kaylendog Dec 17, 2025
0e568a4
refactor: Use `impl Iterator<Item = InboundGroupSession>` as param.
kaylendog Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions bindings/matrix-sdk-crypto-ffi/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,6 +506,7 @@ fn collect_sessions(
})
.collect::<anyhow::Result<_>>()?,
sender_data: SenderData::legacy(),
forwarder_data: None,
room_id: RoomId::parse(session.room_id)?,
imported: session.imported,
backed_up: session.backed_up,
Expand Down
2 changes: 2 additions & 0 deletions crates/matrix-sdk-crypto/src/machine/tests/decryption_verification_state.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,7 @@ async fn test_verification_states_multiple_device() {
fake_room_id,
&olm,
SenderData::unknown(),
None,
EventEncryptionAlgorithm::MegolmV1AesSha2,
None,
false,
Expand All @@ -468,6 +469,7 @@ async fn test_verification_states_multiple_device() {
fake_room_id,
&olm,
SenderData::unknown(),
None,
EventEncryptionAlgorithm::MegolmV1AesSha2,
None,
false,
Expand Down
1 change: 1 addition & 0 deletions crates/matrix-sdk-crypto/src/olm/account.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ impl StaticAccountData {
room_id,
&outbound.session_key().await,
own_sender_data,
None,
algorithm,
Some(visibility),
shared_history,
Expand Down
78 changes: 67 additions & 11 deletions crates/matrix-sdk-crypto/src/olm/group_sessions/inbound.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,13 @@ pub struct InboundGroupSession {
/// key.
pub sender_data: SenderData,

/// If this session was shared-on-invite as part of an [MSC4268] key bundle,
/// information about the user who forwarded us the session information.
/// This is distinct from [`InboundGroupSession::sender_data`].
///
/// [MSC4268]: https://github.com/matrix-org/matrix-spec-proposals/pull/4268
pub forwarder_data: Option<SenderData>,

/// The Room this GroupSession belongs to
pub room_id: OwnedRoomId,

Expand Down Expand Up @@ -240,6 +247,10 @@ impl InboundGroupSession {
/// * `sender_data` - Information about the sender of the to-device message
/// that established this session.
///
/// * `forwarder_data` - If present, indicates this session was received via
/// an [MSC4268] room key bundle, and provides information about the
/// forwarder of this bundle.
///
/// * `encryption_algorithm` - The [`EventEncryptionAlgorithm`] that should
/// be used when messages are being decrypted. The method will return an
/// [`SessionCreationError::Algorithm`] error if an algorithm we do not
Expand All @@ -256,13 +267,15 @@ impl InboundGroupSession {
/// history visibility of the room.
///
/// [MSC3061]: https://github.com/matrix-org/matrix-spec-proposals/pull/3061
/// [MSC4268]: https://github.com/matrix-org/matrix-spec-proposals/pull/4268
#[allow(clippy::too_many_arguments)]
pub fn new(
sender_key: Curve25519PublicKey,
signing_key: Ed25519PublicKey,
room_id: &RoomId,
session_key: &SessionKey,
sender_data: SenderData,
forwarder_data: Option<SenderData>,
encryption_algorithm: EventEncryptionAlgorithm,
history_visibility: Option<HistoryVisibility>,
shared_history: bool,
Expand All @@ -286,6 +299,7 @@ impl InboundGroupSession {
signing_keys: keys.into(),
},
sender_data,
forwarder_data,
room_id: room_id.into(),
imported: false,
algorithm: encryption_algorithm.into(),
Expand Down Expand Up @@ -325,6 +339,7 @@ impl InboundGroupSession {
room_id,
session_key,
SenderData::unknown(),
None,
EventEncryptionAlgorithm::MegolmV1AesSha2,
None,
*shared_history,
Expand Down Expand Up @@ -380,6 +395,7 @@ impl InboundGroupSession {
sender_key: self.creator_info.curve25519_key,
signing_key: (*self.creator_info.signing_keys).clone(),
sender_data: self.sender_data.clone(),
forwarder_data: self.forwarder_data.clone(),
room_id: self.room_id().to_owned(),
imported: self.imported,
backed_up: self.backed_up(),
Expand Down Expand Up @@ -459,6 +475,7 @@ impl InboundGroupSession {
sender_key,
signing_key,
sender_data,
forwarder_data,
room_id,
imported,
backed_up,
Expand All @@ -479,6 +496,7 @@ impl InboundGroupSession {
signing_keys: signing_key.into(),
},
sender_data,
forwarder_data,
history_visibility: history_visibility.into(),
first_known_index,
room_id,
Expand Down Expand Up @@ -691,6 +709,9 @@ pub struct PickledInboundGroupSession {
/// Information on the device/sender who sent us this session
#[serde(default)]
pub sender_data: SenderData,
/// Information on the device/sender who forwarded us this session
#[serde(default)]
pub forwarder_data: Option<SenderData>,
/// The id of the room that the session is used in.
pub room_id: OwnedRoomId,
/// Flag remembering if the session was directly sent to us by the sender
Expand All @@ -717,18 +738,41 @@ fn default_algorithm() -> EventEncryptionAlgorithm {
EventEncryptionAlgorithm::MegolmV1AesSha2
}

impl TryFrom<&HistoricRoomKey> for InboundGroupSession {
type Error = SessionCreationError;

fn try_from(key: &HistoricRoomKey) -> Result<Self, Self::Error> {
impl HistoricRoomKey {
/// Converts a `HistoricRoomKey` into an `InboundGroupSession`.
///
/// This method takes the current `HistoricRoomKey` instance and attempts to
/// create an `InboundGroupSession` from it. The `forwarder_data` parameter
/// provides information about the user or device that forwarded the session
/// information. This is normally distinct from the original sender of the
/// session.
///
/// # Arguments
///
/// * `forwarder_data` - A reference to a `SenderData` object containing
/// information about the forwarder of the session.
///
/// # Returns
///
/// Returns a `Result` containing the newly created `InboundGroupSession` on
/// success, or a `SessionCreationError` if the conversion fails.
///
/// # Errors
///
/// This method will return a `SessionCreationError` if the session
/// configuration for the given algorithm cannot be determined.
pub fn try_into_inbound_group_session(
&self,
forwarder_data: &SenderData,
) -> Result<InboundGroupSession, SessionCreationError> {
let HistoricRoomKey {
algorithm,
room_id,
sender_key,
session_id,
session_key,
sender_claimed_keys,
} = key;
} = self;

let config = OutboundGroupSession::session_config(algorithm)?;
let session = InnerSession::import(session_key, config);
Expand All @@ -744,6 +788,7 @@ impl TryFrom<&HistoricRoomKey> for InboundGroupSession {
// TODO: How do we remember that this is a historic room key and events decrypted using
// this room key should always show some form of warning.
sender_data: SenderData::default(),
forwarder_data: Some(forwarder_data.clone()),
history_visibility: None.into(),
first_known_index,
room_id: room_id.to_owned(),
Expand Down Expand Up @@ -784,6 +829,7 @@ impl TryFrom<&ExportedRoomKey> for InboundGroupSession {
// TODO: In future, exported keys should contain sender data that we can use here.
// See https://github.com/matrix-org/matrix-rust-sdk/issues/3548
sender_data: SenderData::default(),
forwarder_data: None,
history_visibility: None.into(),
first_known_index,
room_id: room_id.to_owned(),
Expand Down Expand Up @@ -815,6 +861,7 @@ impl From<&ForwardedMegolmV1AesSha2Content> for InboundGroupSession {
// In future, exported keys should contain sender data that we can use here.
// See https://github.com/matrix-org/matrix-rust-sdk/issues/3548
sender_data: SenderData::default(),
forwarder_data: None,
history_visibility: None.into(),
first_known_index,
room_id: value.room_id.to_owned(),
Expand Down Expand Up @@ -842,6 +889,7 @@ impl From<&ForwardedMegolmV2AesSha2Content> for InboundGroupSession {
// In future, exported keys should contain sender data that we can use here.
// See https://github.com/matrix-org/matrix-rust-sdk/issues/3548
sender_data: SenderData::default(),
forwarder_data: None,
history_visibility: None.into(),
first_known_index,
room_id: value.room_id.to_owned(),
Expand Down Expand Up @@ -871,7 +919,7 @@ impl TryFrom<&DecryptedForwardedRoomKeyEvent> for InboundGroupSession {
#[cfg(test)]
mod tests {
use assert_matches2::assert_let;
use insta::assert_json_snapshot;
use insta::{assert_json_snapshot, with_settings};
use matrix_sdk_test::async_test;
use ruma::{
DeviceId, UserId, device_id, events::room::history_visibility::HistoryVisibility,
Expand Down Expand Up @@ -906,11 +954,17 @@ mod tests {

let pickle = session.pickle().await;

assert_json_snapshot!(pickle, {
".pickle.initial_ratchet.inner" => "[ratchet]",
".pickle.signing_key" => "[signing_key]",
".sender_key" => "[sender_key]",
".signing_key.ed25519" => "[ed25519_key]",
with_settings!({prepend_module_to_snapshot => false}, {
assert_json_snapshot!(
"InboundGroupSession__test_pickle_snapshot__regression",
pickle,
{
".pickle.initial_ratchet.inner" => "[ratchet]",
".pickle.signing_key" => "[signing_key]",
".sender_key" => "[sender_key]",
".signing_key.ed25519" => "[ed25519_key]",
}
);
});
}

Expand Down Expand Up @@ -982,6 +1036,7 @@ mod tests {
room_id!("!test:localhost"),
&create_session_key(),
SenderData::unknown(),
None,
EventEncryptionAlgorithm::MegolmV1AesSha2,
Some(HistoryVisibility::Shared),
false,
Expand Down Expand Up @@ -1028,6 +1083,7 @@ mod tests {
"legacy_session":false
}
},
"forwarder_data":null,
"room_id":"!test:localhost",
"imported":false,
"backed_up":false,
Expand Down
1 change: 1 addition & 0 deletions crates/matrix-sdk-crypto/src/olm/group_sessions/sender_data_finder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -826,6 +826,7 @@ mod tests {
room_id,
&session_key,
SenderData::unknown(),
None,
EventEncryptionAlgorithm::MegolmV1AesSha2,
None,
false,
Expand Down
1 change: 1 addition & 0 deletions ...ons__inbound__tests__pickle_snapshot.snap → ...on__test_pickle_snapshot__regression.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ expression: pickle
"legacy_session": false
}
},
"forwarder_data": null,
"room_id": "!test:localhost",
"imported": false,
"backed_up": false,
Expand Down
1 change: 1 addition & 0 deletions crates/matrix-sdk-crypto/src/store/integration_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1430,6 +1430,7 @@ macro_rules! cryptostore_integration_tests {
room_id!("!r:s.co"),
&session_key,
sender_data,
None,
EventEncryptionAlgorithm::MegolmV1AesSha2,
None,
false,
Expand Down
2 changes: 2 additions & 0 deletions crates/matrix-sdk-crypto/src/store/memorystore.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -847,6 +847,7 @@ mod tests {
room_id,
&outbound.session_key().await,
SenderData::unknown(),
None,
outbound.settings().algorithm.to_owned(),
None,
false,
Expand Down Expand Up @@ -1245,6 +1246,7 @@ mod tests {
room_id,
&outbound.session_key().await,
SenderData::unknown(),
None,
outbound.settings().algorithm.to_owned(),
None,
false,
Expand Down
Loading
Loading