Add 3PID binding callpack endpoint v1

ruma-federation-api/CHANGELOG.md

@@ -22,6 +22,7 @@ Improvements:
   membership::create_join_event::v2,
   membership::get_leave_event::v1,
   membership::create_leave_event::{v1, v2},
+  thirdparty::bind_callback::v1,
   ```
 
 # 0.0.3

ruma-federation-api/src/lib.rs

@@ -14,4 +14,5 @@ pub mod keys;
 pub mod membership;
 pub mod openid;
 pub mod query;
+pub mod thirdparty;
 pub mod transactions;

ruma-federation-api/src/thirdparty.rs

@@ -0,0 +1,3 @@
+//! Module for dealing with third party identifiers
+
+pub mod bind_callback;

ruma-federation-api/src/thirdparty/bind_callback.rs

@@ -0,0 +1,4 @@
+//! Used by identity servers to notify the homeserver that one of its users has bound a third party
+//! identifier successfully, including any pending room invites the identity server has been made
+//! aware of.
+pub mod v1;

ruma-federation-api/src/thirdparty/bind_callback/v1.rs

@@ -0,0 +1,78 @@
+//! [PUT /_matrix/federation/v1/3pid/onbind](https://matrix.org/docs/spec/server_server/r0.1.4#put-matrix-federation-v1-3pid-onbind)
+
+use ruma_api::ruma_api;
+use ruma_common::thirdparty::Medium;
+use ruma_identifiers::{RoomId, ServerKeyId, ServerNameBox, UserId};
+use serde::{Deserialize, Serialize};
+
+use std::collections::BTreeMap;
+
+ruma_api! {
+    metadata: {
+        description: "Used by identity servers to notify the homeserver that one of its users has bound a third party identifier successfully",
+        method: PUT,
+        name: "identifier_bound",
+        path: "/_matrix/federation/v1/3pid/onbind",
+        rate_limited: false,
+        authentication: None,
+    }
+
+    request: {
+        /// The type of third party identifier. Currently only "email" is a possible value.
+        pub medium: Medium,
+
+        /// The third party identifier itself. For example, an email address.
+        pub address: &'a str,
+
+        /// The user that is now bound to the third party identifier.
+        pub mxid: &'a UserId,
+
+        /// A list of pending invites that the third party identifier has received.
+        pub invites: &'a [ThirdPartyInvite],
+    }
+
+    response: {}
+}
+
+impl<'a> Request<'a> {
+    /// Creates a new `Request` with the given address, matrix id and third party invites.
+    pub fn new(address: &'a str, mxid: &'a UserId, invites: &'a [ThirdPartyInvite]) -> Self {
+        Self { medium: Medium::Email, address, mxid, invites }
+    }
+}
+
+/// A pending invite the third party identifier has received.
+#[derive(Debug, Clone, Deserialize, Serialize)]
+#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
+pub struct ThirdPartyInvite {
+    /// The type of third party invite issues. Currently only "email" is used.
+    pub medium: Medium,
+
+    /// The third party identifier that received the invite.
+    pub address: String,
+
+    /// The now-bound user ID that received the invite.
+    pub mxid: UserId,
+
+    /// The room ID the invite is valid for.
+    pub room_id: RoomId,
+
+    /// The user ID that sent the invite.
+    pub sender: UserId,
+
+    /// Signature from the identity server using a long-term private key.
+    pub signed: BTreeMap<ServerNameBox, BTreeMap<ServerKeyId, String>>,
+}
+
+impl ThirdPartyInvite {
+    /// Creates a new third party invite with the given parameters.
+    pub fn new(
+        address: String,
+        mxid: UserId,
+        room_id: RoomId,
+        sender: UserId,
+        signed: BTreeMap<ServerNameBox, BTreeMap<ServerKeyId, String>>,
+    ) -> Self {
+        Self { medium: Medium::Email, address, mxid, room_id, sender, signed }
+    }
+}