logo
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
//! `GET /_matrix/identity/*/pubkey/isvalid`
//!
//! Endpoint to check for valid public key with an identity server.

pub mod v2 {
    //! `/v2/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.2/identity-service-api/#get_matrixidentityv2pubkeyisvalid

    use ruma_common::{api::ruma_api, serde::Base64};

    ruma_api! {
        metadata: {
            description: "Check whether a long-term public key is valid. The response should always be the same, provided the key exists.",
            method: GET,
            name: "check_public_key_validity",
            stable_path: "/_matrix/identity/v2/pubkey/isvalid",
            authentication: None,
            rate_limited: false,
            added: 1.0,
        }

        request: {
            /// Base64-encoded (no padding) public key to check for validity.
            #[ruma_api(query)]
            pub public_key: &'a Base64,
        }

        response: {
            /// Whether the public key is recognised and is currently valid.
            pub valid: bool,
        }
    }

    impl<'a> Request<'a> {
        /// Create a `Request` with the given base64-encoded (unpadded) public key.
        pub fn new(public_key: &'a Base64) -> Self {
            Self { public_key }
        }
    }

    impl Response {
        /// Create a `Response` with the given bool indicating the validity of the public key.
        pub fn new(valid: bool) -> Self {
            Self { valid }
        }
    }
}