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
//! Types for the [`m.room.third_party_invite`] event.
//!
//! [`m.room.third_party_invite`]: https://spec.matrix.org/v1.18/client-server-api/#mroomthird_party_invite
use ruma_common::third_party_invite::IdentityServerBase64PublicKey;
use ruma_macros::EventContent;
use serde::{Deserialize, Serialize};
/// The content of an `m.room.third_party_invite` event.
///
/// An invitation to a room issued to a third party identifier, rather than a matrix user ID.
///
/// Acts as an `m.room.member` invite event, where there isn't a target user_id to invite. This
/// event contains a token and a public key whose private key must be used to sign the token.
/// Any user who can present that signature may use this invitation to join the target room.
#[derive(Clone, Debug, Deserialize, Serialize, EventContent)]
#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
#[ruma_event(type = "m.room.third_party_invite", kind = State, state_key_type = String)]
pub struct RoomThirdPartyInviteEventContent {
/// A user-readable string which represents the user who has been invited.
///
/// If the `compat-optional` feature is enabled, this field being absent in JSON will result
/// in an empty string instead of an error when deserializing.
#[cfg_attr(feature = "compat-optional", serde(default))]
pub display_name: String,
/// A URL which can be fetched to validate whether the key has been revoked.
///
/// If the `compat-optional` feature is enabled, this field being absent in JSON will result
/// in an empty string instead of an error when deserializing.
#[cfg_attr(feature = "compat-optional", serde(default))]
pub key_validity_url: String,
/// A base64-encoded Ed25519 key with which the token must be signed.
///
/// If the `compat-optional` feature is enabled, this field being absent in JSON will result
/// in an empty string instead of an error when deserializing.
#[cfg_attr(
feature = "compat-optional",
serde(default = "empty_identity_server_base64_public_key")
)]
pub public_key: IdentityServerBase64PublicKey,
/// Keys with which the token may be signed.
#[serde(skip_serializing_if = "Option::is_none")]
pub public_keys: Option<Vec<PublicKey>>,
}
impl RoomThirdPartyInviteEventContent {
/// Creates a new `RoomThirdPartyInviteEventContent` with the given display name, key validity
/// url and public key.
pub fn new(
display_name: String,
key_validity_url: String,
public_key: IdentityServerBase64PublicKey,
) -> Self {
Self { display_name, key_validity_url, public_key, public_keys: None }
}
}
/// A public key for signing a third party invite token.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
pub struct PublicKey {
/// An optional URL which can be fetched to validate whether the key has been revoked.
///
/// The URL must return a JSON object containing a boolean property named 'valid'.
/// If this URL is absent, the key must be considered valid indefinitely.
#[serde(skip_serializing_if = "Option::is_none")]
pub key_validity_url: Option<String>,
/// A base64-encoded Ed25519 key with which the token must be signed.
pub public_key: IdentityServerBase64PublicKey,
}
impl PublicKey {
/// Creates a new `PublicKey` with the given base64-encoded ed25519 key.
pub fn new(public_key: IdentityServerBase64PublicKey) -> Self {
Self { key_validity_url: None, public_key }
}
}
/// Generate an empty [`IdentityServerBase64PublicKey`].
#[cfg(feature = "compat-optional")]
fn empty_identity_server_base64_public_key() -> IdentityServerBase64PublicKey {
IdentityServerBase64PublicKey(String::new())
}