Files
continuwuity/src/api/server/make_knock.rs
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

101 lines
2.6 KiB
Rust
Raw Normal View History

use RoomVersionId::*;
use axum::extract::State;
use futures::TryFutureExt;
use ruma::{
RoomVersionId,
2025-06-29 03:33:29 +00:00
api::{client::error::ErrorKind, federation::membership::prepare_knock_event},
events::room::member::{MembershipState, RoomMemberEventContent},
};
2026-01-16 22:12:20 +05:00
use tuwunel_core::{Err, Error, Result, at, debug_warn, matrix::pdu::PduBuilder};
use crate::Ruma;
/// # `GET /_matrix/federation/v1/make_knock/{roomId}/{userId}`
///
/// Creates a knock template.
pub(crate) async fn create_knock_event_template_route(
2025-01-11 18:43:54 -05:00
State(services): State<crate::State>,
2025-06-29 03:33:29 +00:00
body: Ruma<prepare_knock_event::v1::Request>,
) -> Result<prepare_knock_event::v1::Response> {
2025-08-22 20:15:54 +05:00
if !services.metadata.exists(&body.room_id).await {
return Err!(Request(NotFound("Room is unknown to this server.")));
}
if body.user_id.server_name() != body.origin() {
return Err!(Request(BadJson("Not allowed to knock on behalf of another server/user.")));
}
// ACL check origin server
services
.event_handler
.acl_check(body.origin(), &body.room_id)
.await?;
2026-01-15 17:39:33 -05:00
if let Some(server) = body.room_id.server_name()
&& services
.config
.forbidden_remote_server_names
.is_match(server.host())
2026-01-15 17:39:33 -05:00
{
return Err!(Request(Forbidden("Server is banned on this homeserver.")));
}
let room_version = services
2025-04-22 04:42:26 +00:00
.state
.get_room_version(&body.room_id)
.await?;
if matches!(room_version, V1 | V2 | V3 | V4 | V5 | V6) {
return Err(Error::BadRequest(
ErrorKind::IncompatibleRoomVersion { room_version },
"Room version does not support knocking.",
));
}
if !body.ver.contains(&room_version) {
return Err(Error::BadRequest(
ErrorKind::IncompatibleRoomVersion { room_version },
"Your homeserver does not support the features required to knock on this room.",
));
}
2025-08-22 20:15:54 +05:00
let state_lock = services.state.mutex.lock(&body.room_id).await;
2025-01-11 18:43:54 -05:00
if let Ok(membership) = services
.state_accessor
.get_member(&body.room_id, &body.user_id)
2026-01-15 17:39:33 -05:00
.await && membership.membership == MembershipState::Ban
2025-01-11 18:43:54 -05:00
{
2026-01-15 17:39:33 -05:00
debug_warn!(
"Remote user {} is banned from {} but attempted to knock",
&body.user_id,
&body.room_id
);
2026-01-15 17:39:33 -05:00
return Err!(Request(Forbidden("You cannot knock on a room you are banned from.")));
2025-01-11 18:43:54 -05:00
}
let pdu_json = services
.timeline
.create_hash_and_sign_event(
2025-01-11 18:43:54 -05:00
PduBuilder::state(
body.user_id.to_string(),
&RoomMemberEventContent::new(MembershipState::Knock),
),
&body.user_id,
&body.room_id,
&state_lock,
)
.map_ok(at!(1))
.await?;
drop(state_lock);
let event = services
.federation
.format_pdu_into(pdu_json, Some(&room_version))
.await;
// room v3 and above removed the "event_id" field from remote PDU format
Ok(prepare_knock_event::v1::Response { room_version, event })
}