ruma_events/key/verification/
cancel.rs

Help
1//! Types for the [`m.key.verification.cancel`] event.
2//!
3//! [`m.key.verification.cancel`]: https://spec.matrix.org/latest/client-server-api/#mkeyverificationcancel
4
5use ruma_common::{serde::StringEnum, OwnedTransactionId};
6use ruma_macros::EventContent;
7use serde::{Deserialize, Serialize};
8
9use crate::{relation::Reference, PrivOwnedStr};
10
11/// The content of a to-device `m.key.verification.cancel` event.
12///
13/// Cancels a key verification process/request.
14#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
15#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
16#[ruma_event(type = "m.key.verification.cancel", kind = ToDevice)]
17pub struct ToDeviceKeyVerificationCancelEventContent {
18    /// The opaque identifier for the verification process/request.
19    pub transaction_id: OwnedTransactionId,
20
21    /// A human readable description of the `code`.
22    ///
23    /// The client should only rely on this string if it does not understand the `code`.
24    pub reason: String,
25
26    /// The error code for why the process / request was cancelled by the user.
27    pub code: CancelCode,
28}
29
30impl ToDeviceKeyVerificationCancelEventContent {
31    /// Creates a new `ToDeviceKeyVerificationCancelEventContent` with the given transaction ID,
32    /// reason and code.
33    pub fn new(transaction_id: OwnedTransactionId, reason: String, code: CancelCode) -> Self {
34        Self { transaction_id, reason, code }
35    }
36}
37
38/// The content of an in-room `m.key.verification.cancel` event.
39///
40/// Cancels a key verification process/request.
41#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
42#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
43#[ruma_event(type = "m.key.verification.cancel", kind = MessageLike)]
44pub struct KeyVerificationCancelEventContent {
45    /// A human readable description of the `code`.
46    ///
47    /// The client should only rely on this string if it does not understand the `code`.
48    pub reason: String,
49
50    /// The error code for why the process/request was cancelled by the user.
51    pub code: CancelCode,
52
53    /// Information about the related event.
54    #[serde(rename = "m.relates_to")]
55    pub relates_to: Reference,
56}
57
58impl KeyVerificationCancelEventContent {
59    /// Creates a new `KeyVerificationCancelEventContent` with the given reason, code and reference.
60    pub fn new(reason: String, code: CancelCode, relates_to: Reference) -> Self {
61        Self { reason, code, relates_to }
62    }
63}
64
65/// An error code for why the process/request was cancelled by the user.
66///
67/// Custom error codes should use the Java package naming convention.
68#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
69#[derive(Clone, PartialEq, Eq, StringEnum)]
70#[ruma_enum(rename_all = "m.snake_case")]
71#[non_exhaustive]
72pub enum CancelCode {
73    /// The user cancelled the verification.
74    User,
75
76    /// The verification process timed out.
77    ///
78    /// Verification processes can define their own timeout parameters.
79    Timeout,
80
81    /// The device does not know about the given transaction ID.
82    UnknownTransaction,
83
84    /// The device does not know how to handle the requested method.
85    ///
86    /// Should be sent for `m.key.verification.start` messages and messages defined by individual
87    /// verification processes.
88    UnknownMethod,
89
90    /// The device received an unexpected message.
91    ///
92    /// Typically raised when one of the parties is handling the verification out of order.
93    UnexpectedMessage,
94
95    /// The key was not verified.
96    KeyMismatch,
97
98    /// The expected user did not match the user verified.
99    UserMismatch,
100
101    /// The message received was invalid.
102    InvalidMessage,
103
104    /// An `m.key.verification.request` was accepted by a different device.
105    ///
106    /// The device receiving this error can ignore the verification request.
107    Accepted,
108
109    /// The device receiving this error can ignore the verification request.
110    MismatchedCommitment,
111
112    /// The SAS did not match.
113    MismatchedSas,
114
115    #[doc(hidden)]
116    _Custom(PrivOwnedStr),
117}
118
119#[cfg(test)]
120mod tests {
121    use serde_json::{from_value as from_json_value, json, to_value as to_json_value};
122
123    use super::CancelCode;
124
125    #[test]
126    fn cancel_codes_serialize_to_display_form() {
127        assert_eq!(to_json_value(&CancelCode::User).unwrap(), json!("m.user"));
128    }
129
130    #[test]
131    fn custom_cancel_codes_serialize_to_display_form() {
132        assert_eq!(to_json_value(CancelCode::from("io.ruma.test")).unwrap(), json!("io.ruma.test"));
133    }
134
135    #[test]
136    fn cancel_codes_deserialize_from_display_form() {
137        assert_eq!(from_json_value::<CancelCode>(json!("m.user")).unwrap(), CancelCode::User);
138    }
139
140    #[test]
141    fn custom_cancel_codes_deserialize_from_display_form() {
142        assert_eq!(
143            from_json_value::<CancelCode>(json!("io.ruma.test")).unwrap(),
144            "io.ruma.test".into()
145        );
146    }
147}
ruma_events/key/verification/cancel.rs

ruma_events/key/verification/
cancel.rs
