Skip to content
Snippets Groups Projects
membership.rs 22.8 KiB
Newer Older
  • Learn to ignore specific revisions
  • use super::State;
    
        client_server,
        pdu::{PduBuilder, PduEvent},
    
        server_server, utils, ConduitResult, Database, Error, Result, Ruma,
    
    use log::{error, warn};
    
    use ruma::{
    
        api::{
            client::{
                error::ErrorKind,
    
                r0::membership::{
                    ban_user, forget_room, get_member_events, invite_user, join_room_by_id,
                    join_room_by_id_or_alias, joined_members, joined_rooms, kick_user, leave_room,
                    unban_user, IncomingThirdPartySigned,
    
        events::{pdu::Pdu, room::member, EventType},
    
        serde::{to_canonical_value, CanonicalJsonObject, Raw},
        EventId, RoomId, RoomVersionId, ServerName, UserId,
    
    use std::{collections::BTreeMap, convert::TryFrom, sync::RwLock};
    
    
    #[cfg(feature = "conduit_bin")]
    use rocket::{get, post};
    
    #[cfg_attr(
        feature = "conduit_bin",
        post("/_matrix/client/r0/rooms/<_>/join", data = "<body>")
    )]
    
    #[tracing::instrument(skip(db, body))]
    
    pub async fn join_room_by_id_route(
    
        db: State<'_, Database>,
    
    Timo Kösters's avatar
    Timo Kösters committed
        body: Ruma<join_room_by_id::Request<'_>>,
    
    ) -> ConduitResult<join_room_by_id::Response> {
    
            body.sender_user.as_ref(),
    
            &[body.room_id.server_name().to_owned()],
    
            body.third_party_signed.as_ref(),
        )
        .await
    
    }
    
    #[cfg_attr(
        feature = "conduit_bin",
        post("/_matrix/client/r0/join/<_>", data = "<body>")
    )]
    
    #[tracing::instrument(skip(db, body))]
    
    pub async fn join_room_by_id_or_alias_route(
    
        db: State<'_, Database>,
    
    Timo Kösters's avatar
    Timo Kösters committed
        body: Ruma<join_room_by_id_or_alias::Request<'_>>,
    
    ) -> ConduitResult<join_room_by_id_or_alias::Response> {
    
        let (servers, room_id) = match RoomId::try_from(body.room_id_or_alias.clone()) {
            Ok(room_id) => (vec![room_id.server_name().to_owned()], room_id),
    
            Err(room_alias) => {
    
                let response = client_server::get_alias_helper(&db, &room_alias).await?;
    
                (response.0.servers, response.0.room_id)
    
        let join_room_response = join_room_by_id_helper(
            &db,
            body.sender_user.as_ref(),
            &room_id,
            &servers,
            body.third_party_signed.as_ref(),
        )
        .await?;
    
        db.flush().await?;
    
    
        Ok(join_room_by_id_or_alias::Response {
    
            room_id: join_room_response.0.room_id,
    
        }
        .into())
    }
    
    #[cfg_attr(
        feature = "conduit_bin",
        post("/_matrix/client/r0/rooms/<_>/leave", data = "<body>")
    )]
    
    #[tracing::instrument(skip(db, body))]
    
    pub async fn leave_room_route(
    
        db: State<'_, Database>,
    
    Timo Kösters's avatar
    Timo Kösters committed
        body: Ruma<leave_room::Request<'_>>,
    
    ) -> ConduitResult<leave_room::Response> {
    
        let sender_user = body.sender_user.as_ref().expect("user is authenticated");
    
        db.rooms.leave_room(sender_user, &body.room_id, &db).await?;
    
        Ok(leave_room::Response::new().into())
    
    }
    
    #[cfg_attr(
        feature = "conduit_bin",
        post("/_matrix/client/r0/rooms/<_>/invite", data = "<body>")
    )]
    
    #[tracing::instrument(skip(db, body))]
    
    pub async fn invite_user_route(
    
        db: State<'_, Database>,
    
    Timo Kösters's avatar
    Timo Kösters committed
        body: Ruma<invite_user::Request<'_>>,
    
    ) -> ConduitResult<invite_user::Response> {
    
        let sender_user = body.sender_user.as_ref().expect("user is authenticated");
    
    Timo Kösters's avatar
    Timo Kösters committed
        if let invite_user::IncomingInvitationRecipient::UserId { user_id } = &body.recipient {
    
    Timo Kösters's avatar
    Timo Kösters committed
            db.rooms.build_and_append_pdu(
                PduBuilder {
                    event_type: EventType::RoomMember,
                    content: serde_json::to_value(member::MemberEventContent {
                        membership: member::MembershipState::Invite,
                        displayname: db.users.displayname(&user_id)?,
                        avatar_url: db.users.avatar_url(&user_id)?,
                        is_direct: None,
                        third_party_invite: None,
                    })
                    .expect("event is valid, we just created it"),
                    unsigned: None,
                    state_key: Some(user_id.to_string()),
                    redacts: None,
                },
    
                &sender_user,
    
    Timo Kösters's avatar
    Timo Kösters committed
                &body.room_id,
    
    Devin Ragotzy's avatar
    Devin Ragotzy committed
                &db,
    
    Timo Kösters's avatar
    Timo Kösters committed
            )?;
    
            Ok(invite_user::Response.into())
        } else {
            Err(Error::BadRequest(ErrorKind::NotFound, "User not found."))
        }
    }
    
    #[cfg_attr(
        feature = "conduit_bin",
        post("/_matrix/client/r0/rooms/<_>/kick", data = "<body>")
    )]
    
    #[tracing::instrument(skip(db, body))]
    
    pub async fn kick_user_route(
    
        db: State<'_, Database>,
    
    Timo Kösters's avatar
    Timo Kösters committed
        body: Ruma<kick_user::Request<'_>>,
    
    ) -> ConduitResult<kick_user::Response> {
    
        let sender_user = body.sender_user.as_ref().expect("user is authenticated");
    
    
        let mut event = serde_json::from_value::<Raw<ruma::events::room::member::MemberEventContent>>(
            db.rooms
                .room_state_get(
                    &body.room_id,
                    &EventType::RoomMember,
                    &body.user_id.to_string(),
                )?
                .ok_or(Error::BadRequest(
                    ErrorKind::BadState,
                    "Cannot kick member that's not in the room.",
                ))?
                .content,
        )
        .expect("Raw::from_value always works")
        .deserialize()
        .map_err(|_| Error::bad_database("Invalid member event in database."))?;
    
        event.membership = ruma::events::room::member::MembershipState::Leave;
        // TODO: reason
    
    
    Timo Kösters's avatar
    Timo Kösters committed
        db.rooms.build_and_append_pdu(
            PduBuilder {
                event_type: EventType::RoomMember,
                content: serde_json::to_value(event).expect("event is valid, we just created it"),
                unsigned: None,
                state_key: Some(body.user_id.to_string()),
                redacts: None,
            },
    
            &sender_user,
    
    Timo Kösters's avatar
    Timo Kösters committed
            &body.room_id,
    
    Devin Ragotzy's avatar
    Devin Ragotzy committed
            &db,
    
    Timo Kösters's avatar
    Timo Kösters committed
        )?;
    
        Ok(kick_user::Response::new().into())
    
    }
    
    #[cfg_attr(
        feature = "conduit_bin",
        post("/_matrix/client/r0/rooms/<_>/ban", data = "<body>")
    )]
    
    #[tracing::instrument(skip(db, body))]
    
    pub async fn ban_user_route(
    
        db: State<'_, Database>,
    
    Timo Kösters's avatar
    Timo Kösters committed
        body: Ruma<ban_user::Request<'_>>,
    
    ) -> ConduitResult<ban_user::Response> {
    
        let sender_user = body.sender_user.as_ref().expect("user is authenticated");
    
    
        // TODO: reason
    
        let event = db
            .rooms
            .room_state_get(
                &body.room_id,
                &EventType::RoomMember,
                &body.user_id.to_string(),
            )?
            .map_or(
                Ok::<_, Error>(member::MemberEventContent {
                    membership: member::MembershipState::Ban,
                    displayname: db.users.displayname(&body.user_id)?,
                    avatar_url: db.users.avatar_url(&body.user_id)?,
                    is_direct: None,
                    third_party_invite: None,
                }),
    
                    let mut event =
                        serde_json::from_value::<Raw<member::MemberEventContent>>(event.content)
                            .expect("Raw::from_value always works")
                            .deserialize()
                            .map_err(|_| Error::bad_database("Invalid member event in database."))?;
                    event.membership = ruma::events::room::member::MembershipState::Ban;
                    Ok(event)
                },
            )?;
    
    
    Timo Kösters's avatar
    Timo Kösters committed
        db.rooms.build_and_append_pdu(
            PduBuilder {
                event_type: EventType::RoomMember,
                content: serde_json::to_value(event).expect("event is valid, we just created it"),
                unsigned: None,
                state_key: Some(body.user_id.to_string()),
                redacts: None,
            },
    
            &sender_user,
    
    Timo Kösters's avatar
    Timo Kösters committed
            &body.room_id,
    
    Devin Ragotzy's avatar
    Devin Ragotzy committed
            &db,
    
    Timo Kösters's avatar
    Timo Kösters committed
        )?;
    
        Ok(ban_user::Response::new().into())
    
    }
    
    #[cfg_attr(
        feature = "conduit_bin",
        post("/_matrix/client/r0/rooms/<_>/unban", data = "<body>")
    )]
    
    #[tracing::instrument(skip(db, body))]
    
    pub async fn unban_user_route(
    
        db: State<'_, Database>,
    
    Timo Kösters's avatar
    Timo Kösters committed
        body: Ruma<unban_user::Request<'_>>,
    
    ) -> ConduitResult<unban_user::Response> {
    
        let sender_user = body.sender_user.as_ref().expect("user is authenticated");
    
    
        let mut event = serde_json::from_value::<Raw<ruma::events::room::member::MemberEventContent>>(
            db.rooms
                .room_state_get(
                    &body.room_id,
                    &EventType::RoomMember,
                    &body.user_id.to_string(),
                )?
                .ok_or(Error::BadRequest(
                    ErrorKind::BadState,
                    "Cannot unban a user who is not banned.",
                ))?
                .content,
        )
        .expect("from_value::<Raw<..>> can never fail")
        .deserialize()
        .map_err(|_| Error::bad_database("Invalid member event in database."))?;
    
        event.membership = ruma::events::room::member::MembershipState::Leave;
    
    
    Timo Kösters's avatar
    Timo Kösters committed
        db.rooms.build_and_append_pdu(
            PduBuilder {
                event_type: EventType::RoomMember,
                content: serde_json::to_value(event).expect("event is valid, we just created it"),
                unsigned: None,
                state_key: Some(body.user_id.to_string()),
                redacts: None,
            },
    
            &sender_user,
    
    Timo Kösters's avatar
    Timo Kösters committed
            &body.room_id,
    
    Devin Ragotzy's avatar
    Devin Ragotzy committed
            &db,
    
    Timo Kösters's avatar
    Timo Kösters committed
        )?;
    
        Ok(unban_user::Response::new().into())
    
    }
    
    #[cfg_attr(
        feature = "conduit_bin",
        post("/_matrix/client/r0/rooms/<_>/forget", data = "<body>")
    )]
    
    #[tracing::instrument(skip(db, body))]
    
    pub async fn forget_room_route(
    
        db: State<'_, Database>,
    
    Timo Kösters's avatar
    Timo Kösters committed
        body: Ruma<forget_room::Request<'_>>,
    
    ) -> ConduitResult<forget_room::Response> {
    
        let sender_user = body.sender_user.as_ref().expect("user is authenticated");
    
        db.rooms.forget(&body.room_id, &sender_user)?;
    
        Ok(forget_room::Response::new().into())
    
    }
    
    #[cfg_attr(
        feature = "conduit_bin",
        get("/_matrix/client/r0/joined_rooms", data = "<body>")
    )]
    
    #[tracing::instrument(skip(db, body))]
    
    pub async fn joined_rooms_route(
    
        db: State<'_, Database>,
        body: Ruma<joined_rooms::Request>,
    ) -> ConduitResult<joined_rooms::Response> {
    
        let sender_user = body.sender_user.as_ref().expect("user is authenticated");
    
    
        Ok(joined_rooms::Response {
            joined_rooms: db
                .rooms
    
                .rooms_joined(&sender_user)
    
                .filter_map(|r| r.ok())
                .collect(),
        }
        .into())
    }
    
    #[cfg_attr(
        feature = "conduit_bin",
        get("/_matrix/client/r0/rooms/<_>/members", data = "<body>")
    )]
    
    #[tracing::instrument(skip(db, body))]
    
    pub async fn get_member_events_route(
    
        db: State<'_, Database>,
    
    Timo Kösters's avatar
    Timo Kösters committed
        body: Ruma<get_member_events::Request<'_>>,
    
    ) -> ConduitResult<get_member_events::Response> {
    
        let sender_user = body.sender_user.as_ref().expect("user is authenticated");
    
        if !db.rooms.is_joined(sender_user, &body.room_id)? {
    
            return Err(Error::BadRequest(
                ErrorKind::Forbidden,
                "You don't have permission to view this room.",
            ));
        }
    
        Ok(get_member_events::Response {
            chunk: db
                .rooms
    
                .room_state_full(&body.room_id)?
                .iter()
                .filter(|(key, _)| key.0 == EventType::RoomMember)
                .map(|(_, pdu)| pdu.to_member_event())
    
                .collect(),
        }
        .into())
    }
    
    #[cfg_attr(
        feature = "conduit_bin",
        get("/_matrix/client/r0/rooms/<_>/joined_members", data = "<body>")
    )]
    
    #[tracing::instrument(skip(db, body))]
    
    pub async fn joined_members_route(
    
        db: State<'_, Database>,
    
    Timo Kösters's avatar
    Timo Kösters committed
        body: Ruma<joined_members::Request<'_>>,
    
    ) -> ConduitResult<joined_members::Response> {
    
        let sender_user = body.sender_user.as_ref().expect("user is authenticated");
    
            .is_joined(&sender_user, &body.room_id)
    
            .unwrap_or(false)
        {
            return Err(Error::BadRequest(
                ErrorKind::Forbidden,
                "You aren't a member of the room.",
            ));
        }
    
        let mut joined = BTreeMap::new();
        for user_id in db.rooms.room_members(&body.room_id).filter_map(|r| r.ok()) {
            let display_name = db.users.displayname(&user_id)?;
            let avatar_url = db.users.avatar_url(&user_id)?;
    
            joined.insert(
                user_id,
                joined_members::RoomMember {
                    display_name,
                    avatar_url,
                },
            );
        }
    
        Ok(joined_members::Response { joined }.into())
    }
    
    #[tracing::instrument(skip(db))]
    
    async fn join_room_by_id_helper(
        db: &Database,
    
        sender_user: Option<&UserId>,
    
        _third_party_signed: Option<&IncomingThirdPartySigned>,
    ) -> ConduitResult<join_room_by_id::Response> {
    
        let sender_user = sender_user.expect("user is authenticated");
    
    
        // Ask a remote server if we don't have this room
        if !db.rooms.exists(&room_id)? && room_id.server_name() != db.globals.server_name() {
    
            let mut make_join_response_and_server = Err(Error::BadServerResponse(
                "No server available to assist in joining.",
            ));
    
            for remote_server in servers {
    
                let make_join_response = db
                    .sending
                    .send_federation_request(
                        &db.globals,
    
                        remote_server,
    
                        federation::membership::create_join_event_template::v1::Request {
                            room_id,
                            user_id: sender_user,
    
                            ver: &[RoomVersionId::Version6],
    
    
                make_join_response_and_server = make_join_response.map(|r| (r, remote_server));
    
                if make_join_response_and_server.is_ok() {
                    break;
                }
            }
    
            let (make_join_response, remote_server) = make_join_response_and_server?;
    
            let room_version = match make_join_response.room_version {
                Some(room_version) if room_version == RoomVersionId::Version6 => room_version,
                _ => return Err(Error::BadServerResponse("Room version is not supported")),
            };
    
    
            let mut join_event_stub =
                serde_json::from_str::<CanonicalJsonObject>(make_join_response.event.json().get())
    
                    .map_err(|_| {
                        Error::BadServerResponse("Invalid make_join event json received from server.")
                    })?;
    
    
            // TODO: Is origin needed?
    
            join_event_stub.insert(
                "origin".to_owned(),
    
                to_canonical_value(db.globals.server_name())
                    .map_err(|_| Error::bad_database("Invalid server name found"))?,
    
            );
            join_event_stub.insert(
                "origin_server_ts".to_owned(),
    
                to_canonical_value(utils::millis_since_unix_epoch())
                    .expect("Timestamp is valid js_int value"),
    
            join_event_stub.insert(
                "content".to_owned(),
    
                to_canonical_value(member::MemberEventContent {
    
                    membership: member::MembershipState::Join,
    
                    displayname: db.users.displayname(&sender_user)?,
                    avatar_url: db.users.avatar_url(&sender_user)?,
    
                    is_direct: None,
                    third_party_invite: None,
                })
                .expect("event is valid, we just created it"),
            );
    
            // We don't leave the event id in the pdu because that's only allowed in v1 or v2 rooms
    
            join_event_stub.remove("event_id");
    
            // In order to create a compatible ref hash (EventID) the `hashes` field needs to be present
    
            ruma::signatures::hash_and_sign_event(
                db.globals.server_name().as_str(),
                db.globals.keypair(),
    
                &room_version,
    
            )
            .expect("event is valid, we just created it");
    
    
            // Generate event id
            let event_id = EventId::try_from(&*format!(
                "${}",
    
                ruma::signatures::reference_hash(&join_event_stub, &room_version)
    
                    .expect("ruma can calculate reference hashes")
            ))
            .expect("ruma's reference hashes are valid event ids");
    
    
            // Add event_id back
    
                to_canonical_value(&event_id).expect("EventId is a valid CanonicalJsonValue"),
    
    
            // It has enough fields to be called a proper event now
    
            let join_event = join_event_stub;
    
            let send_join_response = db
                .sending
                .send_federation_request(
                    &db.globals,
    
                    remote_server,
    
                    federation::membership::create_join_event::v2::Request {
                        room_id,
                        event_id: &event_id,
                        pdu: PduEvent::convert_to_outgoing_federation_event(join_event.clone()),
                    },
                )
                .await?;
    
            let count = db.globals.next_count()?;
    
            let mut pdu_id = room_id.as_bytes().to_vec();
            pdu_id.push(0xff);
            pdu_id.extend_from_slice(&count.to_be_bytes());
    
            let pdu = PduEvent::from_id_val(&event_id, join_event.clone())
                .map_err(|_| Error::BadServerResponse("Invalid PDU in send_join response."))?;
    
    
            let mut state = BTreeMap::new();
    
    Timo Kösters's avatar
    Timo Kösters committed
            let pub_key_map = RwLock::new(BTreeMap::new());
    
    
            for result in futures::future::join_all(
                send_join_response
                    .room_state
                    .state
                    .iter()
                    .map(|pdu| validate_and_add_event_id(pdu, &room_version, &pub_key_map, &db)),
            )
            .await
            {
    
    Timo Kösters's avatar
    Timo Kösters committed
                let (event_id, value) = match result {
                    Ok(t) => t,
                    Err(_) => continue,
                };
    
    
                let pdu = PduEvent::from_id_val(&event_id, value.clone()).map_err(|e| {
                    warn!("{:?}: {}", value, e);
                    Error::BadServerResponse("Invalid PDU in send_join response.")
                })?;
    
    
                db.rooms.add_pdu_outlier(&pdu)?;
                if let Some(state_key) = &pdu.state_key {
                    if pdu.kind == EventType::RoomMember {
    
                        let target_user_id = UserId::try_from(state_key.clone()).map_err(|e| {
    
                            warn!(
                                "Invalid user id in send_join response: {}: {}",
                                state_key, e
                            );
    
                            Error::BadServerResponse("Invalid user id in send_join response.")
                        })?;
    
    
                        let invite_state = Vec::new(); // TODO add a few important events
    
    
                        // Update our membership info, we do this here incase a user is invited
                        // and immediately leaves we need the DB to record the invite event for auth
                        db.rooms.update_membership(
                            &pdu.room_id,
                            &target_user_id,
    
                            serde_json::from_value::<member::MembershipState>(
                                pdu.content
                                    .get("membership")
    
    Timo Kösters's avatar
    Timo Kösters committed
                                    .ok_or(Error::BadServerResponse("Invalid member event content"))?
    
                                    .clone(),
                            )
                            .map_err(|_| {
                                Error::BadServerResponse("Invalid membership state content.")
    
                            Some(invite_state),
    
    Timo Kösters's avatar
    Timo Kösters committed
                            db,
    
                    state.insert((pdu.kind.clone(), state_key.clone()), pdu.event_id.clone());
    
            state.insert(
                (
                    pdu.kind.clone(),
                    pdu.state_key.clone().expect("join event has state key"),
                ),
    
                pdu.event_id.clone(),
    
            db.rooms.force_state(room_id, state, &db.globals)?;
    
    Timo Kösters's avatar
    Timo Kösters committed
            for result in futures::future::join_all(
                send_join_response
                    .room_state
                    .auth_chain
                    .iter()
                    .map(|pdu| validate_and_add_event_id(pdu, &room_version, &pub_key_map, &db)),
            )
            .await
            {
                let (event_id, value) = match result {
                    Ok(t) => t,
                    Err(_) => continue,
                };
    
    
                let pdu = PduEvent::from_id_val(&event_id, value.clone()).map_err(|e| {
                    warn!("{:?}: {}", value, e);
                    Error::BadServerResponse("Invalid PDU in send_join response.")
                })?;
    
                db.rooms.add_pdu_outlier(&pdu)?;
    
            // We append to state before appending the pdu, so we don't have a moment in time with the
            // pdu without it's state. This is okay because append_pdu can't fail.
            let statehashid = db.rooms.append_to_state(&pdu, &db.globals)?;
    
    
            db.rooms.append_pdu(
                &pdu,
                utils::to_canonical_object(&pdu).expect("Pdu is valid canonical object"),
                db.globals.next_count()?,
                pdu_id.into(),
                &[pdu.event_id.clone()],
                db,
            )?;
    
    
            // We set the room state after inserting the pdu, so that we never have a moment in time
            // where events in the current room state do not exist
            db.rooms.set_room_state(&room_id, statehashid)?;
    
        } else {
            let event = member::MemberEventContent {
                membership: member::MembershipState::Join,
    
                displayname: db.users.displayname(&sender_user)?,
                avatar_url: db.users.avatar_url(&sender_user)?,
    
                is_direct: None,
                third_party_invite: None,
            };
    
    Timo Kösters's avatar
    Timo Kösters committed
            db.rooms.build_and_append_pdu(
                PduBuilder {
                    event_type: EventType::RoomMember,
                    content: serde_json::to_value(event).expect("event is valid, we just created it"),
                    unsigned: None,
    
                    state_key: Some(sender_user.to_string()),
    
    Timo Kösters's avatar
    Timo Kösters committed
                    redacts: None,
                },
    
                &sender_user,
    
    Timo Kösters's avatar
    Timo Kösters committed
                &room_id,
    
    Devin Ragotzy's avatar
    Devin Ragotzy committed
                &db,
    
    Timo Kösters's avatar
    Timo Kösters committed
            )?;
    
        db.flush().await?;
    
    
        Ok(join_room_by_id::Response::new(room_id.clone()).into())
    }
    
    
    async fn validate_and_add_event_id(
        pdu: &Raw<Pdu>,
        room_version: &RoomVersionId,
    
        pub_key_map: &RwLock<BTreeMap<String, BTreeMap<String, String>>>,
    
        db: &Database,
    ) -> Result<(EventId, CanonicalJsonObject)> {
        let mut value = serde_json::from_str::<CanonicalJsonObject>(pdu.json().get()).map_err(|e| {
            error!("{:?}: {:?}", pdu, e);
            Error::BadServerResponse("Invalid PDU in server response")
        })?;
    
        server_server::fetch_required_signing_keys(&value, pub_key_map, db).await?;
    
        if let Err(e) = ruma::signatures::verify_event(
            &*pub_key_map
                .read()
                .map_err(|_| Error::bad_database("RwLock is poisoned."))?,
            &value,
            room_version,
        ) {
            warn!("Event failed verification: {}", e);
            return Err(Error::BadServerResponse("Event failed verification."));
        }
    
    
        let event_id = EventId::try_from(&*format!(
            "${}",
            ruma::signatures::reference_hash(&value, &room_version)
                .expect("ruma can calculate reference hashes")
        ))
        .expect("ruma's reference hashes are valid event ids");
    
        value.insert(
            "event_id".to_owned(),
            to_canonical_value(&event_id)
                .expect("a valid EventId can be converted to CanonicalJsonValue"),
        );
    
        Ok((event_id, value))
    }