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