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
//! `POST /_matrix/client/*/keys/query`
//!
//! Returns the current devices and identity keys for the given users.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/v1.4/client-server-api/#post_matrixclientv3keysquery
use std::{collections::BTreeMap, time::Duration};
use ruma_common::{
api::{request, response, Metadata},
encryption::{CrossSigningKey, DeviceKeys},
metadata,
serde::Raw,
OwnedDeviceId, OwnedUserId,
};
use serde_json::Value as JsonValue;
const METADATA: Metadata = metadata! {
method: POST,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/keys/query",
1.1 => "/_matrix/client/v3/keys/query",
}
};
/// Request type for the `get_keys` endpoint.
#[request(error = crate::Error)]
#[derive(Default)]
pub struct Request {
/// The time (in milliseconds) to wait when downloading keys from remote servers.
///
/// 10 seconds is the recommended default.
#[serde(
with = "ruma_common::serde::duration::opt_ms",
default,
skip_serializing_if = "Option::is_none"
)]
pub timeout: Option<Duration>,
/// The keys to be downloaded.
///
/// An empty list indicates all devices for the corresponding user.
pub device_keys: BTreeMap<OwnedUserId, Vec<OwnedDeviceId>>,
/// If the client is fetching keys as a result of a device update received in a sync
/// request, this should be the 'since' token of that sync request, or any later sync
/// token.
///
/// This allows the server to ensure its response contains the keys advertised by the
/// notification in that sync.
#[serde(skip_serializing_if = "Option::is_none")]
pub token: Option<String>,
}
/// Response type for the `get_keys` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {
/// If any remote homeservers could not be reached, they are recorded here.
///
/// The names of the properties are the names of the unreachable servers.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub failures: BTreeMap<String, JsonValue>,
/// Information on the queried devices.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub device_keys: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, Raw<DeviceKeys>>>,
/// Information on the master cross-signing keys of the queried users.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub master_keys: BTreeMap<OwnedUserId, Raw<CrossSigningKey>>,
/// Information on the self-signing keys of the queried users.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub self_signing_keys: BTreeMap<OwnedUserId, Raw<CrossSigningKey>>,
/// Information on the user-signing keys of the queried users.
#[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
pub user_signing_keys: BTreeMap<OwnedUserId, Raw<CrossSigningKey>>,
}
impl Request {
/// Creates an empty `Request`.
pub fn new() -> Self {
Default::default()
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Default::default()
}
}
}