synapse-product/synapse/handlers/deactivate_account.py

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

273 lines
11 KiB
Python
Raw Normal View History

# Copyright 2017, 2018 New Vector Ltd
# Copyright 2019 The Matrix.org Foundation C.I.C.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
2018-07-09 02:09:20 -04:00
import logging
from typing import TYPE_CHECKING, Optional
2018-07-09 02:09:20 -04:00
from synapse.api.errors import SynapseError
from synapse.metrics.background_process_metrics import run_as_background_process
from synapse.types import Requester, UserID, create_requester
if TYPE_CHECKING:
from synapse.server import HomeServer
logger = logging.getLogger(__name__)
class DeactivateAccountHandler:
"""Handler which deals with deactivating user accounts."""
2019-06-20 05:32:02 -04:00
def __init__(self, hs: "HomeServer"):
self.store = hs.get_datastore()
self.hs = hs
self._auth_handler = hs.get_auth_handler()
self._device_handler = hs.get_device_handler()
self._room_member_handler = hs.get_room_member_handler()
self._identity_handler = hs.get_identity_handler()
self._profile_handler = hs.get_profile_handler()
self.user_directory_handler = hs.get_user_directory_handler()
self._server_name = hs.hostname
2018-05-10 07:20:40 -04:00
# Flag that indicates whether the process to part users from rooms is running
self._user_parter_running = False
2018-05-10 07:20:40 -04:00
# Start the user parter loop so it can resume parting users from rooms where
# it left off (if it has work left to do).
if hs.config.worker.run_background_tasks:
hs.get_reactor().callWhenRunning(self._start_user_parting)
self._account_validity_enabled = (
hs.config.account_validity.account_validity_enabled
)
async def deactivate_account(
self,
user_id: str,
erase_data: bool,
requester: Requester,
id_server: Optional[str] = None,
by_admin: bool = False,
) -> bool:
"""Deactivate a user's account
Args:
user_id: ID of user to be deactivated
erase_data: whether to GDPR-erase the user's data
requester: The user attempting to make this change.
id_server: Use the given identity server when unbinding
any threepids. If None then will attempt to unbind using the
identity server specified when binding (if known).
by_admin: Whether this change was made by an administrator.
Returns:
True if identity server supports removing threepids, otherwise False.
"""
# FIXME: Theoretically there is a race here wherein user resets
# password using threepid.
# delete threepids first. We remove these from the IS so if this fails,
# leave the user still active so they can try again.
# Ideally we would prevent password resets and then do this in the
# background thread.
# This will be set to false if the identity server doesn't support
# unbinding
identity_server_supports_unbinding = True
# Retrieve the 3PIDs this user has bound to an identity server
threepids = await self.store.user_get_bound_threepids(user_id)
for threepid in threepids:
try:
result = await self._identity_handler.try_unbind_threepid(
2018-05-24 06:23:15 -04:00
user_id,
{
"medium": threepid["medium"],
"address": threepid["address"],
2019-04-02 06:17:51 -04:00
"id_server": id_server,
},
)
identity_server_supports_unbinding &= result
2018-05-24 06:23:15 -04:00
except Exception:
# Do we want this to be a fatal error or should we carry on?
logger.exception("Failed to remove threepid from ID server")
raise SynapseError(400, "Failed to remove threepid from ID server")
await self.store.user_delete_threepid(
2018-05-24 06:23:15 -04:00
user_id, threepid["medium"], threepid["address"]
)
# Remove all 3PIDs this user has bound to the homeserver
await self.store.user_delete_threepids(user_id)
2018-06-04 07:01:23 -04:00
# delete any devices belonging to the user, which will also
# delete corresponding access tokens.
await self._device_handler.delete_all_devices_for_user(user_id)
# then delete any remaining access tokens which weren't associated with
# a device.
await self._auth_handler.delete_access_tokens_for_user(user_id)
await self.store.user_set_password_hash(user_id, None)
# Most of the pushers will have been deleted when we logged out the
# associated devices above, but we still need to delete pushers not
# associated with devices, e.g. email pushers.
await self.store.delete_all_pushers_for_user(user_id)
2018-05-22 12:14:06 -04:00
# Add the user to a table of users pending deactivation (ie.
2018-05-10 07:20:40 -04:00
# removal from all the rooms they're a member of)
await self.store.add_user_pending_deactivation(user_id)
# delete from user directory
await self.user_directory_handler.handle_local_user_deactivated(user_id)
# If the user is present in the monthly active users table
# remove them
await self.store.remove_deactivated_user_from_mau_table(user_id)
# Mark the user as erased, if they asked for that
if erase_data:
user = UserID.from_string(user_id)
# Remove avatar URL from this user
await self._profile_handler.set_avatar_url(user, requester, "", by_admin)
# Remove displayname from this user
await self._profile_handler.set_displayname(user, requester, "", by_admin)
logger.info("Marking %s as erased", user_id)
await self.store.mark_user_erased(user_id)
2018-05-10 07:20:40 -04:00
# Now start the process that goes through that list and
# parts users from rooms (if it isn't already running)
2018-05-09 10:10:37 -04:00
self._start_user_parting()
2019-09-27 11:15:01 -04:00
# Reject all pending invites for the user, so that the user doesn't show up in the
# "invited" section of rooms' members list.
await self._reject_pending_invites_for_user(user_id)
2019-09-27 09:49:53 -04:00
# Remove all information on the user from the account_validity table.
if self._account_validity_enabled:
await self.store.delete_account_validity_for_user(user_id)
# Mark the user as deactivated.
await self.store.set_user_deactivated_status(user_id, True)
return identity_server_supports_unbinding
async def _reject_pending_invites_for_user(self, user_id: str) -> None:
2019-09-27 09:49:53 -04:00
"""Reject pending invites addressed to a given user ID.
Args:
user_id: The user ID to reject pending invites for.
2019-09-27 09:49:53 -04:00
"""
user = UserID.from_string(user_id)
pending_invites = await self.store.get_invited_rooms_for_local_user(user_id)
2019-09-27 09:49:53 -04:00
for room in pending_invites:
try:
await self._room_member_handler.update_membership(
create_requester(user, authenticated_entity=self._server_name),
2019-09-27 09:49:53 -04:00
user,
room.room_id,
"leave",
ratelimit=False,
require_consent=False,
)
2019-09-27 10:13:39 -04:00
logger.info(
"Rejected invite for deactivated user %r in room %r",
user_id,
room.room_id,
2019-09-27 10:13:39 -04:00
)
2019-09-27 09:49:53 -04:00
except Exception:
logger.exception(
"Failed to reject invite for user %r in room %r:"
" ignoring and continuing",
user_id,
room.room_id,
)
def _start_user_parting(self) -> None:
2018-05-10 07:20:40 -04:00
"""
Start the process that goes through the table of users
pending deactivation, if it isn't already running.
"""
2018-05-09 10:06:16 -04:00
if not self._user_parter_running:
run_as_background_process("user_parter_loop", self._user_parter_loop)
async def _user_parter_loop(self) -> None:
2018-05-10 07:20:40 -04:00
"""Loop that parts deactivated users from rooms"""
self._user_parter_running = True
logger.info("Starting user parter")
try:
while True:
user_id = await self.store.get_user_pending_deactivation()
if user_id is None:
break
logger.info("User parter parting %r", user_id)
await self._part_user(user_id)
await self.store.del_user_pending_deactivation(user_id)
logger.info("User parter finished parting %r", user_id)
logger.info("User parter finished: stopping")
finally:
self._user_parter_running = False
async def _part_user(self, user_id: str) -> None:
2018-05-10 07:20:40 -04:00
"""Causes the given user_id to leave all the rooms they're joined to"""
user = UserID.from_string(user_id)
rooms_for_user = await self.store.get_rooms_for_user(user_id)
for room_id in rooms_for_user:
logger.info("User parter parting %r from %r", user_id, room_id)
2018-05-10 07:23:53 -04:00
try:
await self._room_member_handler.update_membership(
create_requester(user, authenticated_entity=self._server_name),
2018-05-10 07:23:53 -04:00
user,
room_id,
"leave",
ratelimit=False,
2019-03-20 13:39:29 -04:00
require_consent=False,
2018-05-10 07:23:53 -04:00
)
except Exception:
logger.exception(
"Failed to part user %r from room %r: ignoring and continuing",
user_id,
room_id,
)
async def activate_account(self, user_id: str) -> None:
"""
Activate an account that was previously deactivated.
This marks the user as active and not erased in the database, but does
not attempt to rejoin rooms, re-add threepids, etc.
If enabled, the user will be re-added to the user directory.
The user will also need a password hash set to actually login.
Args:
user_id: ID of user to be re-activated
"""
user = UserID.from_string(user_id)
# Ensure the user is not marked as erased.
await self.store.mark_user_not_erased(user_id)
# Mark the user as active.
await self.store.set_user_deactivated_status(user_id, False)
# Add the user to the directory, if necessary. Note that
# this must be done after the user is re-activated, because
# deactivated users are excluded from the user directory.
profile = await self.store.get_profileinfo(user.localpart)
await self.user_directory_handler.handle_local_profile_change(user_id, profile)