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

//! Types for the *m.room.third_party_invite* event.

use ruma_events_macros::ruma_event;
use serde::{Deserialize, Serialize};

ruma_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.
    ThirdPartyInviteEvent {
        kind: StateEvent,
        event_type: "m.room.third_party_invite",
        content: {
            /// A user-readable string which represents the user who has been invited.
            pub display_name: String,

            /// A URL which can be fetched to validate whether the key has been revoked.
            pub key_validity_url: String,

            /// A Base64-encoded Ed25519 key with which the token must be signed.
            pub public_key: String,

            /// Keys with which the token may be signed.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub public_keys: Option<Vec<PublicKey>>,
        },
    }
}

/// A public key for signing a third party invite token.
#[derive(Clone, Debug, Deserialize, Serialize)]
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: String,
}