ruma_events/
room_key.rs

Help
1//! Types for the [`m.room_key`] event.
2//!
3//! [`m.room_key`]: https://spec.matrix.org/latest/client-server-api/#mroom_key
4
5use ruma_common::{EventEncryptionAlgorithm, OwnedRoomId};
6use ruma_macros::EventContent;
7use serde::{Deserialize, Serialize};
8
9/// The content of an `m.room_key` event.
10///
11/// Typically encrypted as an `m.room.encrypted` event, then sent as a to-device event.
12#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
13#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
14#[ruma_event(type = "m.room_key", kind = ToDevice)]
15pub struct ToDeviceRoomKeyEventContent {
16    /// The encryption algorithm the key in this event is to be used with.
17    ///
18    /// Must be `m.megolm.v1.aes-sha2`.
19    pub algorithm: EventEncryptionAlgorithm,
20
21    /// The room where the key is used.
22    pub room_id: OwnedRoomId,
23
24    /// The ID of the session that the key is for.
25    pub session_id: String,
26
27    /// The key to be exchanged.
28    pub session_key: String,
29
30    /// Used to mark key if allowed for shared history.
31    ///
32    /// Defaults to `false`.
33    #[cfg(feature = "unstable-msc3061")]
34    #[serde(
35        default,
36        rename = "org.matrix.msc3061.shared_history",
37        skip_serializing_if = "ruma_common::serde::is_default"
38    )]
39    pub shared_history: bool,
40}
41
42impl ToDeviceRoomKeyEventContent {
43    /// Creates a new `ToDeviceRoomKeyEventContent` with the given algorithm, room ID, session ID
44    /// and session key.
45    pub fn new(
46        algorithm: EventEncryptionAlgorithm,
47        room_id: OwnedRoomId,
48        session_id: String,
49        session_key: String,
50    ) -> Self {
51        Self {
52            algorithm,
53            room_id,
54            session_id,
55            session_key,
56            #[cfg(feature = "unstable-msc3061")]
57            shared_history: false,
58        }
59    }
60}
61
62#[cfg(test)]
63mod tests {
64    use ruma_common::owned_room_id;
65    use serde_json::{json, to_value as to_json_value};
66
67    use super::ToDeviceRoomKeyEventContent;
68    use crate::EventEncryptionAlgorithm;
69
70    #[test]
71    fn serialization() {
72        let content = ToDeviceRoomKeyEventContent {
73            algorithm: EventEncryptionAlgorithm::MegolmV1AesSha2,
74            room_id: owned_room_id!("!testroomid:example.org"),
75            session_id: "SessId".into(),
76            session_key: "SessKey".into(),
77            #[cfg(feature = "unstable-msc3061")]
78            shared_history: true,
79        };
80
81        #[cfg(not(feature = "unstable-msc3061"))]
82        assert_eq!(
83            to_json_value(content).unwrap(),
84            json!({
85                "algorithm": "m.megolm.v1.aes-sha2",
86                "room_id": "!testroomid:example.org",
87                "session_id": "SessId",
88                "session_key": "SessKey",
89            })
90        );
91
92        #[cfg(feature = "unstable-msc3061")]
93        assert_eq!(
94            to_json_value(content).unwrap(),
95            json!({
96                "algorithm": "m.megolm.v1.aes-sha2",
97                "room_id": "!testroomid:example.org",
98                "session_id": "SessId",
99                "session_key": "SessKey",
100                "org.matrix.msc3061.shared_history": true,
101            })
102        );
103    }
104}
ruma_events/room_key.rs

ruma_events/
room_key.rs
