feat: Add forwarder and forwarder_device to EncryptionInfo.

Signed-off-by: Skye Elliot <[email protected]>

Author: kaylendog

crates/matrix-sdk-base/src/event_cache/store/integration_tests.rs

@@ -79,6 +79,8 @@ pub fn make_test_event_with_event_id(
     let encryption_info = Arc::new(EncryptionInfo {
         sender: (*ALICE).into(),
         sender_device: None,
+        forwarder: None,
+        forwarder_device: None,
         algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
             curve25519_key: "1337".to_owned(),
             sender_claimed_keys: Default::default(),

crates/matrix-sdk-common/src/deserialized_responses.rs

@@ -328,6 +328,17 @@ pub struct EncryptionInfo {
     /// The device ID of the device that sent us the event, note this is
     /// untrusted data unless `verification_state` is `Verified` as well.
     pub sender_device: Option<OwnedDeviceId>,
+    /// If the keys for this message shared-on-invite as part of an
+    /// [MSC4268] key bundle, the ID of the user who sent them to us.
+    ///
+    /// [MSC4268]: https://github.com/matrix-org/matrix-spec-proposals/pull/4268
+    pub forwarder: Option<OwnedUserId>,
+    /// If the keys for this message were shared-on-invite as part of an
+    /// [MSC4268] key bundle, the ID of the device from which they were
+    /// sent.
+    ///
+    /// [MSC4268]: https://github.com/matrix-org/matrix-spec-proposals/pull/4268
+    pub forwarder_device: Option<OwnedDeviceId>,
     /// Information about the algorithm that was used to encrypt the event.
     pub algorithm_info: AlgorithmInfo,
     /// The verification state of the device that sent us the event, note this
@@ -361,14 +372,23 @@ impl<'de> Deserialize<'de> for EncryptionInfo {
         struct Helper {
             pub sender: OwnedUserId,
             pub sender_device: Option<OwnedDeviceId>,
+            pub forwarder: Option<OwnedUserId>,
+            pub forwarder_device: Option<OwnedDeviceId>,
             pub algorithm_info: AlgorithmInfo,
             pub verification_state: VerificationState,
             #[serde(rename = "session_id")]
             pub old_session_id: Option<String>,
         }
 
-        let Helper { sender, sender_device, algorithm_info, verification_state, old_session_id } =
-            Helper::deserialize(deserializer)?;
+        let Helper {
+            sender,
+            sender_device,
+            forwarder,
+            forwarder_device,
+            algorithm_info,
+            verification_state,
+            old_session_id,
+        } = Helper::deserialize(deserializer)?;
 
         let algorithm_info = match algorithm_info {
             AlgorithmInfo::MegolmV1AesSha2 { curve25519_key, sender_claimed_keys, session_id } => {
@@ -382,7 +402,14 @@ impl<'de> Deserialize<'de> for EncryptionInfo {
             other => other,
         };
 
-        Ok(EncryptionInfo { sender, sender_device, algorithm_info, verification_state })
+        Ok(EncryptionInfo {
+            sender,
+            sender_device,
+            forwarder,
+            forwarder_device,
+            algorithm_info,
+            verification_state,
+        })
     }
 }
 
@@ -1617,6 +1644,8 @@ mod tests {
                 encryption_info: Arc::new(EncryptionInfo {
                     sender: user_id!("@sender:example.com").to_owned(),
                     sender_device: None,
+                    forwarder: None,
+                    forwarder_device: None,
                     algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
                         curve25519_key: "xxx".to_owned(),
                         sender_claimed_keys: Default::default(),
@@ -2041,6 +2070,8 @@ mod tests {
         let info = EncryptionInfo {
             sender: user_id!("@alice:localhost").to_owned(),
             sender_device: Some(device_id!("ABCDEFGH").to_owned()),
+            forwarder: None,
+            forwarder_device: None,
             algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
                 curve25519_key: "curvecurvecurve".into(),
                 sender_claimed_keys: Default::default(),
@@ -2062,6 +2093,8 @@ mod tests {
                 encryption_info: Arc::new(EncryptionInfo {
                     sender: user_id!("@sender:example.com").to_owned(),
                     sender_device: Some(device_id!("ABCDEFGHIJ").to_owned()),
+                    forwarder: None,
+                    forwarder_device: None,
                     algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
                         curve25519_key: "xxx".to_owned(),
                         sender_claimed_keys: BTreeMap::from([

crates/matrix-sdk-crypto/src/machine/mod.rs

@@ -1136,6 +1136,8 @@ impl OlmMachine {
         EncryptionInfo {
             sender: self.inner.user_id.clone(),
             sender_device: Some(self.inner.device_id.clone()),
+            forwarder: None,
+            forwarder_device: None,
             algorithm_info,
             verification_state: VerificationState::Verified,
         }
@@ -2021,6 +2023,15 @@ impl OlmMachine {
         Ok(Arc::new(EncryptionInfo {
             sender,
             sender_device: device_id,
+            forwarder: session.forwarder_data.as_ref().and_then(|data| data.user_id()),
+            forwarder_device: session.forwarder_data.as_ref().and_then(|data| match data {
+                SenderData::SenderUnverified(known_sender_data)
+                | SenderData::SenderVerified(known_sender_data) => {
+                    known_sender_data.device_id.clone()
+                }
+                // TODO: This should never happen.
+                _ => None,
+            }),
             algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
                 curve25519_key: session.sender_key().to_base64(),
                 sender_claimed_keys: session

crates/matrix-sdk-crypto/src/olm/account.rs

@@ -1704,6 +1704,8 @@ impl Account {
         EncryptionInfo {
             sender: sender_id.to_owned(),
             sender_device: sender_device.as_ref().map(|d| d.device_id().to_owned()),
+            forwarder: None,
+            forwarder_device: None,
             algorithm_info: AlgorithmInfo::OlmV1Curve25519AesSha2 {
                 curve25519_public_key_base64: sender_key.to_base64(),
             },

crates/matrix-sdk-ui/src/timeline/controller/decryption_retry_task.rs

@@ -296,6 +296,8 @@ mod tests {
             encryption_info: Some(Arc::new(EncryptionInfo {
                 sender: owned_user_id!("@u:s.co"),
                 sender_device: None,
+                forwarder: None,
+                forwarder_device: None,
                 algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
                     curve25519_key: "".to_owned(),
                     sender_claimed_keys: BTreeMap::new(),

crates/matrix-sdk-ui/src/timeline/tests/edit.rs

@@ -163,6 +163,8 @@ async fn test_edit_updates_encryption_info() {
     let mut encryption_info = Arc::new(EncryptionInfo {
         sender: (*ALICE).into(),
         sender_device: None,
+        forwarder: None,
+        forwarder_device: None,
         algorithm_info: AlgorithmInfo::MegolmV1AesSha2 {
             curve25519_key: "123".to_owned(),
             sender_claimed_keys: BTreeMap::new(),

crates/matrix-sdk/tests/integration/encryption/shared_history.rs

@@ -195,6 +195,12 @@ async fn test_shared_history_out_of_order() {
         .await
         .expect("Bob should be able to fetch the event Alice has sent");
 
+    let encryption_info = event.encryption_info().expect("Event did not have encryption info");
+
+    // Check Bob stored information about the key forwarder.
+    assert_eq!(encryption_info.forwarder, Some(alice_user_id.to_owned()));
+    assert_eq!(encryption_info.forwarder_device, Some(alice_device_id.to_owned()));
+
     assert_decrypted_message_eq!(
         event,
         "It's a secret to everybody",