identity-service-api: Add 3PID bind endpoint

This commit is contained in:
Adam 2021-06-10 18:59:37 +01:00 committed by GitHub
parent 5fe1876643
commit ef7dd6dd84
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 95 additions and 0 deletions

View File

@ -16,6 +16,11 @@ pub type EntitySignatures<K> = BTreeMap<SigningKeyId<K>, String>;
/// signatures.insert(server_name, key_identifier, signature.into()); /// signatures.insert(server_name, key_identifier, signature.into());
/// ``` /// ```
#[derive(Clone, Debug, Default)] #[derive(Clone, Debug, Default)]
#[cfg_attr(
feature = "serde",
derive(serde::Serialize, serde::Deserialize),
serde(transparent, crate = "serde")
)]
pub struct Signatures<E: Ord, K: ?Sized>(BTreeMap<E, EntitySignatures<K>>); pub struct Signatures<E: Ord, K: ?Sized>(BTreeMap<E, EntitySignatures<K>>);
impl<E: Ord, K: ?Sized> Signatures<E, K> { impl<E: Ord, K: ?Sized> Signatures<E, K> {

View File

@ -1,5 +1,16 @@
# [unreleased] # [unreleased]
Improvements:
* Add more endpoints:
```rust
association::{
check_3pid_validity::v2,
bind_3pid::v2,
}
```
# 0.1.0 # 0.1.0
Breaking changes: Breaking changes:

View File

@ -1,5 +1,6 @@
//! Endpoints to create associations with a Matrix ID on the identity server. //! Endpoints to create associations with a Matrix ID on the identity server.
pub mod bind_3pid;
pub mod check_3pid_validity; pub mod check_3pid_validity;
pub mod email; pub mod email;
pub mod msisdn; pub mod msisdn;

View File

@ -0,0 +1,3 @@
//! Endpoint to bind a session to a Matrix user ID.
pub mod v2;

View File

@ -0,0 +1,75 @@
//! [POST /_matrix/identity/v2/3pid/bind](https://matrix.org/docs/spec/identity_service/r0.3.0#post-matrix-identity-v2-3pid-bind)
use ruma_api::ruma_api;
use ruma_common::{thirdparty::Medium, MilliSecondsSinceUnixEpoch};
use ruma_identifiers::{ServerSignatures, UserId};
ruma_api! {
metadata: {
description: "Publish an association between a session and a Matrix user ID.",
method: POST,
name: "bind_3pid",
path: "/_matrix/identity/v2/3pid/bind",
rate_limited: false,
authentication: AccessToken,
}
request: {
/// The session ID generated by the `requestToken` call.
pub sid: &'a str,
/// The client secret passed to the `requestToken` call.
pub client_secret: &'a str,
/// The Matrix user ID to associate with the 3PIDs.
pub mxid: &'a UserId,
}
response: {
/// The 3PID address of the user being looked up.
pub address: String,
/// The medium type of the 3PID.
pub medium: Medium,
/// The Matrix user ID associated with the 3PID.
pub mxid: UserId,
/// A UNIX timestamp before which the association is not known to be valid.
pub not_before: MilliSecondsSinceUnixEpoch,
/// A UNIX timestamp after which the association is not known to be valid.
pub not_after: MilliSecondsSinceUnixEpoch,
/// The UNIX timestamp at which the association was verified.
pub ts: MilliSecondsSinceUnixEpoch,
/// The signatures of the verifiying identity servers which show that the
/// association should be trusted, if you trust the verifying identity services.
pub signatures: ServerSignatures,
}
}
impl<'a> Request<'a> {
/// Creates a `Request` with the given session ID, client secret and Matrix user ID.
pub fn new(sid: &'a str, client_secret: &'a str, mxid: &'a UserId) -> Self {
Self { sid, client_secret, mxid }
}
}
impl Response {
/// Creates a `Response` with the given 3PID address, medium, Matrix user ID, timestamps and
/// signatures.
pub fn new(
address: String,
medium: Medium,
mxid: UserId,
not_before: MilliSecondsSinceUnixEpoch,
not_after: MilliSecondsSinceUnixEpoch,
ts: MilliSecondsSinceUnixEpoch,
signatures: ServerSignatures,
) -> Self {
Self { address, medium, mxid, not_before, not_after, ts, signatures }
}
}