ruma_client_api/keys/
upload_keys.rs

Help
1//! `POST /_matrix/client/*/keys/upload`
2//!
3//! Publishes end-to-end encryption keys for the device.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3keysupload
9
10    use std::collections::BTreeMap;
11
12    use js_int::UInt;
13    use ruma_common::{
14        api::{request, response, Metadata},
15        encryption::{DeviceKeys, OneTimeKey},
16        metadata,
17        serde::Raw,
18        OneTimeKeyAlgorithm, OwnedOneTimeKeyId,
19    };
20
21    const METADATA: Metadata = metadata! {
22        method: POST,
23        rate_limited: false,
24        authentication: AccessToken,
25        history: {
26            1.0 => "/_matrix/client/r0/keys/upload",
27            1.1 => "/_matrix/client/v3/keys/upload",
28        }
29    };
30
31    /// Request type for the `upload_keys` endpoint.
32    #[request(error = crate::Error)]
33    #[derive(Default)]
34    pub struct Request {
35        /// Identity keys for the device.
36        ///
37        /// May be absent if no new identity keys are required.
38        #[serde(skip_serializing_if = "Option::is_none")]
39        pub device_keys: Option<Raw<DeviceKeys>>,
40
41        /// One-time public keys for "pre-key" messages.
42        #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
43        pub one_time_keys: BTreeMap<OwnedOneTimeKeyId, Raw<OneTimeKey>>,
44
45        /// Fallback public keys for "pre-key" messages.
46        #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
47        pub fallback_keys: BTreeMap<OwnedOneTimeKeyId, Raw<OneTimeKey>>,
48    }
49
50    /// Response type for the `upload_keys` endpoint.
51    #[response(error = crate::Error)]
52    pub struct Response {
53        /// For each key algorithm, the number of unclaimed one-time keys of that
54        /// type currently held on the server for this device.
55        pub one_time_key_counts: BTreeMap<OneTimeKeyAlgorithm, UInt>,
56    }
57
58    impl Request {
59        /// Creates an empty `Request`.
60        pub fn new() -> Self {
61            Default::default()
62        }
63    }
64
65    impl Response {
66        /// Creates a new `Response` with the given one time key counts.
67        pub fn new(one_time_key_counts: BTreeMap<OneTimeKeyAlgorithm, UInt>) -> Self {
68            Self { one_time_key_counts }
69        }
70    }
71}
ruma_client_api/keys/upload_keys.rs

ruma_client_api/keys/
upload_keys.rs
