ruma_events/
forwarded_room_key.rs

Help
1//! Types for the [`m.forwarded_room_key`] event.
2//!
3//! [`m.forwarded_room_key`]: https://spec.matrix.org/latest/client-server-api/#mforwarded_room_key
4
5use ruma_common::{EventEncryptionAlgorithm, OwnedRoomId};
6use ruma_macros::EventContent;
7use serde::{Deserialize, Serialize};
8
9/// The content of an `m.forwarded_room_key` event.
10///
11/// To create an instance of this type, first create a `ToDeviceForwardedRoomKeyEventContentInit`
12/// and convert it via `ToDeviceForwardedRoomKeyEventContent::from` / `.into()`.
13#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
14#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
15#[ruma_event(type = "m.forwarded_room_key", kind = ToDevice)]
16pub struct ToDeviceForwardedRoomKeyEventContent {
17    /// The encryption algorithm the key in this event is to be used with.
18    pub algorithm: EventEncryptionAlgorithm,
19
20    /// The room where the key is used.
21    pub room_id: OwnedRoomId,
22
23    /// The Curve25519 key of the device which initiated the session originally.
24    pub sender_key: String,
25
26    /// The ID of the session that the key is for.
27    pub session_id: String,
28
29    /// The key to be exchanged.
30    pub session_key: String,
31
32    /// The Ed25519 key of the device which initiated the session originally.
33    ///
34    /// It is "claimed" because the receiving device has no way to tell that the original
35    /// room_key actually came from a device which owns the private part of this key unless
36    /// they have done device verification.
37    pub sender_claimed_ed25519_key: String,
38
39    /// Chain of Curve25519 keys.
40    ///
41    /// It starts out empty, but each time the key is forwarded to another device, the
42    /// previous sender in the chain is added to the end of the list. For example, if the
43    /// key is forwarded from A to B to C, this field is empty between A and B, and contains
44    /// A's Curve25519 key between B and C.
45    pub forwarding_curve25519_key_chain: Vec<String>,
46
47    /// Used to mark key if allowed for shared history.
48    ///
49    /// Defaults to `false`.
50    #[cfg(feature = "unstable-msc3061")]
51    #[serde(
52        default,
53        rename = "org.matrix.msc3061.shared_history",
54        skip_serializing_if = "ruma_common::serde::is_default"
55    )]
56    pub shared_history: bool,
57}
58
59/// Initial set of fields of `ToDeviceForwardedRoomKeyEventContent`.
60///
61/// This struct will not be updated even if additional fields are added to `ConditionalPushRule` in
62/// a new (non-breaking) release of the Matrix specification.
63#[derive(Debug)]
64#[allow(clippy::exhaustive_structs)]
65pub struct ToDeviceForwardedRoomKeyEventContentInit {
66    /// The encryption algorithm the key in this event is to be used with.
67    pub algorithm: EventEncryptionAlgorithm,
68
69    /// The room where the key is used.
70    pub room_id: OwnedRoomId,
71
72    /// The Curve25519 key of the device which initiated the session originally.
73    pub sender_key: String,
74
75    /// The ID of the session that the key is for.
76    pub session_id: String,
77
78    /// The key to be exchanged.
79    pub session_key: String,
80
81    /// The Ed25519 key of the device which initiated the session originally.
82    ///
83    /// It is "claimed" because the receiving device has no way to tell that the original
84    /// room_key actually came from a device which owns the private part of this key unless
85    /// they have done device verification.
86    pub sender_claimed_ed25519_key: String,
87
88    /// Chain of Curve25519 keys.
89    ///
90    /// It starts out empty, but each time the key is forwarded to another device, the
91    /// previous sender in the chain is added to the end of the list. For example, if the
92    /// key is forwarded from A to B to C, this field is empty between A and B, and contains
93    /// A's Curve25519 key between B and C.
94    pub forwarding_curve25519_key_chain: Vec<String>,
95}
96
97impl From<ToDeviceForwardedRoomKeyEventContentInit> for ToDeviceForwardedRoomKeyEventContent {
98    fn from(init: ToDeviceForwardedRoomKeyEventContentInit) -> Self {
99        Self {
100            algorithm: init.algorithm,
101            room_id: init.room_id,
102            sender_key: init.sender_key,
103            session_id: init.session_id,
104            session_key: init.session_key,
105            sender_claimed_ed25519_key: init.sender_claimed_ed25519_key,
106            forwarding_curve25519_key_chain: init.forwarding_curve25519_key_chain,
107            #[cfg(feature = "unstable-msc3061")]
108            shared_history: false,
109        }
110    }
111}
ruma_events/forwarded_room_key.rs

ruma_events/
forwarded_room_key.rs
