ruma_federation_api/
discovery.rs

Help
1//! Server discovery endpoints.
2
3use std::collections::BTreeMap;
4
5use ruma_common::{
6    serde::Base64, MilliSecondsSinceUnixEpoch, OwnedServerName, OwnedServerSigningKeyId,
7    ServerSignatures,
8};
9use serde::{Deserialize, Serialize};
10
11pub mod discover_homeserver;
12pub mod get_remote_server_keys;
13pub mod get_remote_server_keys_batch;
14pub mod get_server_keys;
15pub mod get_server_version;
16#[cfg(feature = "unstable-msc3723")]
17pub mod get_server_versions;
18
19/// Public key of the homeserver for verifying digital signatures.
20#[derive(Clone, Debug, Deserialize, Serialize)]
21#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
22pub struct VerifyKey {
23    /// The unpadded base64-encoded key.
24    pub key: Base64,
25}
26
27impl VerifyKey {
28    /// Creates a new `VerifyKey` from the given key.
29    pub fn new(key: Base64) -> Self {
30        Self { key }
31    }
32}
33
34/// A key the server used to use, but stopped using.
35#[derive(Clone, Debug, Deserialize, Serialize)]
36#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
37pub struct OldVerifyKey {
38    /// Timestamp when this key expired.
39    pub expired_ts: MilliSecondsSinceUnixEpoch,
40
41    /// The unpadded base64-encoded key.
42    pub key: Base64,
43}
44
45impl OldVerifyKey {
46    /// Creates a new `OldVerifyKey` with the given expiry time and key.
47    pub fn new(expired_ts: MilliSecondsSinceUnixEpoch, key: Base64) -> Self {
48        Self { expired_ts, key }
49    }
50}
51
52/// Queried server key, signed by the notary server.
53#[derive(Clone, Debug, Deserialize, Serialize)]
54#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
55pub struct ServerSigningKeys {
56    /// DNS name of the homeserver.
57    pub server_name: OwnedServerName,
58
59    /// Public keys of the homeserver for verifying digital signatures.
60    pub verify_keys: BTreeMap<OwnedServerSigningKeyId, VerifyKey>,
61
62    /// Public keys that the homeserver used to use and when it stopped using them.
63    // This field is optional, but all fields were assumed to be required before clarification
64    // in https://github.com/matrix-org/matrix-spec/pull/1930, so we still send it.
65    #[serde(default)]
66    pub old_verify_keys: BTreeMap<OwnedServerSigningKeyId, OldVerifyKey>,
67
68    /// Digital signatures of this object signed using the verify_keys.
69    ///
70    /// Map of server name to keys by key ID.
71    pub signatures: ServerSignatures,
72
73    /// Timestamp when the keys should be refreshed.
74    ///
75    /// This field MUST be ignored in room versions 1, 2, 3, and 4.
76    pub valid_until_ts: MilliSecondsSinceUnixEpoch,
77}
78
79impl ServerSigningKeys {
80    /// Creates a new `ServerSigningKeys` with the given server name and validity timestamp.
81    ///
82    /// All other fields will be empty.
83    pub fn new(server_name: OwnedServerName, valid_until_ts: MilliSecondsSinceUnixEpoch) -> Self {
84        Self {
85            server_name,
86            verify_keys: BTreeMap::new(),
87            old_verify_keys: BTreeMap::new(),
88            signatures: ServerSignatures::default(),
89            valid_until_ts,
90        }
91    }
92}
ruma_federation_api/discovery.rs

ruma_federation_api/
discovery.rs
