123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781 |
- # -*- coding: utf-8 -*-
- # Copyright 2014 - 2016 OpenMarket Ltd
- #
- # 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.
- """Contains functions for registering clients."""
- import logging
- from synapse import types
- from synapse.api.constants import MAX_USERID_LENGTH, EventTypes, JoinRules, LoginType
- from synapse.api.errors import AuthError, Codes, ConsentNotGivenError, SynapseError
- from synapse.config.server import is_threepid_reserved
- from synapse.http.servlet import assert_params_in_dict
- from synapse.replication.http.login import RegisterDeviceReplicationServlet
- from synapse.replication.http.register import (
- ReplicationPostRegisterActionsServlet,
- ReplicationRegisterServlet,
- )
- from synapse.spam_checker_api import RegistrationBehaviour
- from synapse.storage.state import StateFilter
- from synapse.types import RoomAlias, UserID, create_requester
- from ._base import BaseHandler
- logger = logging.getLogger(__name__)
- class RegistrationHandler(BaseHandler):
- def __init__(self, hs):
- """
- Args:
- hs (synapse.server.HomeServer):
- """
- super().__init__(hs)
- self.hs = hs
- self.auth = hs.get_auth()
- self._auth_handler = hs.get_auth_handler()
- self.profile_handler = hs.get_profile_handler()
- self.user_directory_handler = hs.get_user_directory_handler()
- self.identity_handler = self.hs.get_identity_handler()
- self.ratelimiter = hs.get_registration_ratelimiter()
- self.macaroon_gen = hs.get_macaroon_generator()
- self._server_notices_mxid = hs.config.server_notices_mxid
- self.spam_checker = hs.get_spam_checker()
- if hs.config.worker_app:
- self._register_client = ReplicationRegisterServlet.make_client(hs)
- self._register_device_client = RegisterDeviceReplicationServlet.make_client(
- hs
- )
- self._post_registration_client = ReplicationPostRegisterActionsServlet.make_client(
- hs
- )
- else:
- self.device_handler = hs.get_device_handler()
- self.pusher_pool = hs.get_pusherpool()
- self.session_lifetime = hs.config.session_lifetime
- async def check_username(
- self, localpart, guest_access_token=None, assigned_user_id=None
- ):
- if types.contains_invalid_mxid_characters(localpart):
- raise SynapseError(
- 400,
- "User ID can only contain characters a-z, 0-9, or '=_-./'",
- Codes.INVALID_USERNAME,
- )
- if not localpart:
- raise SynapseError(400, "User ID cannot be empty", Codes.INVALID_USERNAME)
- if localpart[0] == "_":
- raise SynapseError(
- 400, "User ID may not begin with _", Codes.INVALID_USERNAME
- )
- user = UserID(localpart, self.hs.hostname)
- user_id = user.to_string()
- if assigned_user_id:
- if user_id == assigned_user_id:
- return
- else:
- raise SynapseError(
- 400,
- "A different user ID has already been registered for this session",
- )
- self.check_user_id_not_appservice_exclusive(user_id)
- if len(user_id) > MAX_USERID_LENGTH:
- raise SynapseError(
- 400,
- "User ID may not be longer than %s characters" % (MAX_USERID_LENGTH,),
- Codes.INVALID_USERNAME,
- )
- users = await self.store.get_users_by_id_case_insensitive(user_id)
- if users:
- if not guest_access_token:
- raise SynapseError(
- 400, "User ID already taken.", errcode=Codes.USER_IN_USE
- )
- user_data = await self.auth.get_user_by_access_token(guest_access_token)
- if (
- not user_data.is_guest
- or UserID.from_string(user_data.user_id).localpart != localpart
- ):
- raise AuthError(
- 403,
- "Cannot register taken user ID without valid guest "
- "credentials for that user.",
- errcode=Codes.FORBIDDEN,
- )
- if guest_access_token is None:
- try:
- int(localpart)
- raise SynapseError(
- 400,
- "Numeric user IDs are reserved for guest users.",
- errcode=Codes.INVALID_USERNAME,
- )
- except ValueError:
- pass
- async def register_user(
- self,
- localpart=None,
- password_hash=None,
- guest_access_token=None,
- make_guest=False,
- admin=False,
- threepid=None,
- user_type=None,
- default_display_name=None,
- address=None,
- bind_emails=[],
- by_admin=False,
- user_agent_ips=None,
- ):
- """Registers a new client on the server.
- Args:
- localpart: The local part of the user ID to register. If None,
- one will be generated.
- password_hash (str|None): The hashed password to assign to this user so they can
- login again. This can be None which means they cannot login again
- via a password (e.g. the user is an application service user).
- user_type (str|None): type of user. One of the values from
- api.constants.UserTypes, or None for a normal user.
- default_display_name (unicode|None): if set, the new user's displayname
- will be set to this. Defaults to 'localpart'.
- address (str|None): the IP address used to perform the registration.
- bind_emails (List[str]): list of emails to bind to this account.
- by_admin (bool): True if this registration is being made via the
- admin api, otherwise False.
- user_agent_ips (List[(str, str)]): Tuples of IP addresses and user-agents used
- during the registration process.
- Returns:
- str: user_id
- Raises:
- SynapseError if there was a problem registering.
- """
- self.check_registration_ratelimit(address)
- result = self.spam_checker.check_registration_for_spam(
- threepid, localpart, user_agent_ips or [],
- )
- if result == RegistrationBehaviour.DENY:
- logger.info(
- "Blocked registration of %r", localpart,
- )
- # We return a 429 to make it not obvious that they've been
- # denied.
- raise SynapseError(429, "Rate limited")
- shadow_banned = result == RegistrationBehaviour.SHADOW_BAN
- if shadow_banned:
- logger.info(
- "Shadow banning registration of %r", localpart,
- )
- # do not check_auth_blocking if the call is coming through the Admin API
- if not by_admin:
- await self.auth.check_auth_blocking(threepid=threepid)
- if localpart is not None:
- await self.check_username(localpart, guest_access_token=guest_access_token)
- was_guest = guest_access_token is not None
- user = UserID(localpart, self.hs.hostname)
- user_id = user.to_string()
- if was_guest:
- # If the user was a guest then they already have a profile
- default_display_name = None
- elif default_display_name is None:
- default_display_name = localpart
- await self.register_with_store(
- user_id=user_id,
- password_hash=password_hash,
- was_guest=was_guest,
- make_guest=make_guest,
- create_profile_with_displayname=default_display_name,
- admin=admin,
- user_type=user_type,
- address=address,
- shadow_banned=shadow_banned,
- )
- if self.hs.config.user_directory_search_all_users:
- profile = await self.store.get_profileinfo(localpart)
- await self.user_directory_handler.handle_local_profile_change(
- user_id, profile
- )
- else:
- # autogen a sequential user ID
- fail_count = 0
- user = None
- while not user:
- # Fail after being unable to find a suitable ID a few times
- if fail_count > 10:
- raise SynapseError(500, "Unable to find a suitable guest user ID")
- localpart = await self.store.generate_user_id()
- user = UserID(localpart, self.hs.hostname)
- user_id = user.to_string()
- self.check_user_id_not_appservice_exclusive(user_id)
- if default_display_name is None:
- default_display_name = localpart
- try:
- await self.register_with_store(
- user_id=user_id,
- password_hash=password_hash,
- make_guest=make_guest,
- create_profile_with_displayname=default_display_name,
- address=address,
- shadow_banned=shadow_banned,
- )
- # Successfully registered
- break
- except SynapseError:
- # if user id is taken, just generate another
- user = None
- user_id = None
- fail_count += 1
- if not self.hs.config.user_consent_at_registration:
- if not self.hs.config.auto_join_rooms_for_guests and make_guest:
- logger.info(
- "Skipping auto-join for %s because auto-join for guests is disabled",
- user_id,
- )
- else:
- await self._auto_join_rooms(user_id)
- else:
- logger.info(
- "Skipping auto-join for %s because consent is required at registration",
- user_id,
- )
- # Bind any specified emails to this account
- current_time = self.hs.get_clock().time_msec()
- for email in bind_emails:
- # generate threepid dict
- threepid_dict = {
- "medium": "email",
- "address": email,
- "validated_at": current_time,
- }
- # Bind email to new account
- await self._register_email_threepid(user_id, threepid_dict, None)
- return user_id
- async def _create_and_join_rooms(self, user_id: str):
- """
- Create the auto-join rooms and join or invite the user to them.
- This should only be called when the first "real" user registers.
- Args:
- user_id: The user to join
- """
- # Getting the handlers during init gives a dependency loop.
- room_creation_handler = self.hs.get_room_creation_handler()
- room_member_handler = self.hs.get_room_member_handler()
- # Generate a stub for how the rooms will be configured.
- stub_config = {
- "preset": self.hs.config.registration.autocreate_auto_join_room_preset,
- }
- # If the configuration providers a user ID to create rooms with, use
- # that instead of the first user registered.
- requires_join = False
- if self.hs.config.registration.auto_join_user_id:
- fake_requester = create_requester(
- self.hs.config.registration.auto_join_user_id
- )
- # If the room requires an invite, add the user to the list of invites.
- if self.hs.config.registration.auto_join_room_requires_invite:
- stub_config["invite"] = [user_id]
- # If the room is being created by a different user, the first user
- # registered needs to join it. Note that in the case of an invitation
- # being necessary this will occur after the invite was sent.
- requires_join = True
- else:
- fake_requester = create_requester(user_id)
- # Choose whether to federate the new room.
- if not self.hs.config.registration.autocreate_auto_join_rooms_federated:
- stub_config["creation_content"] = {"m.federate": False}
- for r in self.hs.config.registration.auto_join_rooms:
- logger.info("Auto-joining %s to %s", user_id, r)
- try:
- room_alias = RoomAlias.from_string(r)
- if self.hs.hostname != room_alias.domain:
- logger.warning(
- "Cannot create room alias %s, "
- "it does not match server domain",
- r,
- )
- else:
- # A shallow copy is OK here since the only key that is
- # modified is room_alias_name.
- config = stub_config.copy()
- # create room expects the localpart of the room alias
- config["room_alias_name"] = room_alias.localpart
- info, _ = await room_creation_handler.create_room(
- fake_requester, config=config, ratelimit=False,
- )
- # If the room does not require an invite, but another user
- # created it, then ensure the first user joins it.
- if requires_join:
- await room_member_handler.update_membership(
- requester=create_requester(user_id),
- target=UserID.from_string(user_id),
- room_id=info["room_id"],
- # Since it was just created, there are no remote hosts.
- remote_room_hosts=[],
- action="join",
- ratelimit=False,
- )
- except ConsentNotGivenError as e:
- # Technically not necessary to pull out this error though
- # moving away from bare excepts is a good thing to do.
- logger.error("Failed to join new user to %r: %r", r, e)
- except Exception as e:
- logger.error("Failed to join new user to %r: %r", r, e)
- async def _join_rooms(self, user_id: str):
- """
- Join or invite the user to the auto-join rooms.
- Args:
- user_id: The user to join
- """
- room_member_handler = self.hs.get_room_member_handler()
- for r in self.hs.config.registration.auto_join_rooms:
- logger.info("Auto-joining %s to %s", user_id, r)
- try:
- room_alias = RoomAlias.from_string(r)
- if RoomAlias.is_valid(r):
- (
- room_id,
- remote_room_hosts,
- ) = await room_member_handler.lookup_room_alias(room_alias)
- room_id = room_id.to_string()
- else:
- raise SynapseError(
- 400, "%s was not legal room ID or room alias" % (r,)
- )
- # Calculate whether the room requires an invite or can be
- # joined directly. Note that unless a join rule of public exists,
- # it is treated as requiring an invite.
- requires_invite = True
- state = await self.store.get_filtered_current_state_ids(
- room_id, StateFilter.from_types([(EventTypes.JoinRules, "")])
- )
- event_id = state.get((EventTypes.JoinRules, ""))
- if event_id:
- join_rules_event = await self.store.get_event(
- event_id, allow_none=True
- )
- if join_rules_event:
- join_rule = join_rules_event.content.get("join_rule", None)
- requires_invite = join_rule and join_rule != JoinRules.PUBLIC
- # Send the invite, if necessary.
- if requires_invite:
- await room_member_handler.update_membership(
- requester=create_requester(
- self.hs.config.registration.auto_join_user_id
- ),
- target=UserID.from_string(user_id),
- room_id=room_id,
- remote_room_hosts=remote_room_hosts,
- action="invite",
- ratelimit=False,
- )
- # Send the join.
- await room_member_handler.update_membership(
- requester=create_requester(user_id),
- target=UserID.from_string(user_id),
- room_id=room_id,
- remote_room_hosts=remote_room_hosts,
- action="join",
- ratelimit=False,
- )
- except ConsentNotGivenError as e:
- # Technically not necessary to pull out this error though
- # moving away from bare excepts is a good thing to do.
- logger.error("Failed to join new user to %r: %r", r, e)
- except Exception as e:
- logger.error("Failed to join new user to %r: %r", r, e)
- async def _auto_join_rooms(self, user_id: str):
- """Automatically joins users to auto join rooms - creating the room in the first place
- if the user is the first to be created.
- Args:
- user_id: The user to join
- """
- # auto-join the user to any rooms we're supposed to dump them into
- # try to create the room if we're the first real user on the server. Note
- # that an auto-generated support or bot user is not a real user and will never be
- # the user to create the room
- should_auto_create_rooms = False
- is_real_user = await self.store.is_real_user(user_id)
- if self.hs.config.registration.autocreate_auto_join_rooms and is_real_user:
- count = await self.store.count_real_users()
- should_auto_create_rooms = count == 1
- if should_auto_create_rooms:
- await self._create_and_join_rooms(user_id)
- else:
- await self._join_rooms(user_id)
- async def post_consent_actions(self, user_id):
- """A series of registration actions that can only be carried out once consent
- has been granted
- Args:
- user_id (str): The user to join
- """
- await self._auto_join_rooms(user_id)
- async def appservice_register(self, user_localpart, as_token):
- user = UserID(user_localpart, self.hs.hostname)
- user_id = user.to_string()
- service = self.store.get_app_service_by_token(as_token)
- if not service:
- raise AuthError(403, "Invalid application service token.")
- if not service.is_interested_in_user(user_id):
- raise SynapseError(
- 400,
- "Invalid user localpart for this application service.",
- errcode=Codes.EXCLUSIVE,
- )
- service_id = service.id if service.is_exclusive_user(user_id) else None
- self.check_user_id_not_appservice_exclusive(user_id, allowed_appservice=service)
- await self.register_with_store(
- user_id=user_id,
- password_hash="",
- appservice_id=service_id,
- create_profile_with_displayname=user.localpart,
- )
- return user_id
- def check_user_id_not_appservice_exclusive(self, user_id, allowed_appservice=None):
- # don't allow people to register the server notices mxid
- if self._server_notices_mxid is not None:
- if user_id == self._server_notices_mxid:
- raise SynapseError(
- 400, "This user ID is reserved.", errcode=Codes.EXCLUSIVE
- )
- # valid user IDs must not clash with any user ID namespaces claimed by
- # application services.
- services = self.store.get_app_services()
- interested_services = [
- s
- for s in services
- if s.is_interested_in_user(user_id) and s != allowed_appservice
- ]
- for service in interested_services:
- if service.is_exclusive_user(user_id):
- raise SynapseError(
- 400,
- "This user ID is reserved by an application service.",
- errcode=Codes.EXCLUSIVE,
- )
- def check_registration_ratelimit(self, address):
- """A simple helper method to check whether the registration rate limit has been hit
- for a given IP address
- Args:
- address (str|None): the IP address used to perform the registration. If this is
- None, no ratelimiting will be performed.
- Raises:
- LimitExceededError: If the rate limit has been exceeded.
- """
- if not address:
- return
- self.ratelimiter.ratelimit(address)
- def register_with_store(
- self,
- user_id,
- password_hash=None,
- was_guest=False,
- make_guest=False,
- appservice_id=None,
- create_profile_with_displayname=None,
- admin=False,
- user_type=None,
- address=None,
- shadow_banned=False,
- ):
- """Register user in the datastore.
- Args:
- user_id (str): The desired user ID to register.
- password_hash (str|None): Optional. The password hash for this user.
- was_guest (bool): Optional. Whether this is a guest account being
- upgraded to a non-guest account.
- make_guest (boolean): True if the the new user should be guest,
- false to add a regular user account.
- appservice_id (str|None): The ID of the appservice registering the user.
- create_profile_with_displayname (unicode|None): Optionally create a
- profile for the user, setting their displayname to the given value
- admin (boolean): is an admin user?
- user_type (str|None): type of user. One of the values from
- api.constants.UserTypes, or None for a normal user.
- address (str|None): the IP address used to perform the registration.
- shadow_banned (bool): Whether to shadow-ban the user
- Returns:
- Awaitable
- """
- if self.hs.config.worker_app:
- return self._register_client(
- user_id=user_id,
- password_hash=password_hash,
- was_guest=was_guest,
- make_guest=make_guest,
- appservice_id=appservice_id,
- create_profile_with_displayname=create_profile_with_displayname,
- admin=admin,
- user_type=user_type,
- address=address,
- shadow_banned=shadow_banned,
- )
- else:
- return self.store.register_user(
- user_id=user_id,
- password_hash=password_hash,
- was_guest=was_guest,
- make_guest=make_guest,
- appservice_id=appservice_id,
- create_profile_with_displayname=create_profile_with_displayname,
- admin=admin,
- user_type=user_type,
- shadow_banned=shadow_banned,
- )
- async def register_device(
- self, user_id, device_id, initial_display_name, is_guest=False
- ):
- """Register a device for a user and generate an access token.
- The access token will be limited by the homeserver's session_lifetime config.
- Args:
- user_id (str): full canonical @user:id
- device_id (str|None): The device ID to check, or None to generate
- a new one.
- initial_display_name (str|None): An optional display name for the
- device.
- is_guest (bool): Whether this is a guest account
- Returns:
- tuple[str, str]: Tuple of device ID and access token
- """
- if self.hs.config.worker_app:
- r = await self._register_device_client(
- user_id=user_id,
- device_id=device_id,
- initial_display_name=initial_display_name,
- is_guest=is_guest,
- )
- return r["device_id"], r["access_token"]
- valid_until_ms = None
- if self.session_lifetime is not None:
- if is_guest:
- raise Exception(
- "session_lifetime is not currently implemented for guest access"
- )
- valid_until_ms = self.clock.time_msec() + self.session_lifetime
- device_id = await self.device_handler.check_device_registered(
- user_id, device_id, initial_display_name
- )
- if is_guest:
- assert valid_until_ms is None
- access_token = self.macaroon_gen.generate_access_token(
- user_id, ["guest = true"]
- )
- else:
- access_token = await self._auth_handler.get_access_token_for_user_id(
- user_id, device_id=device_id, valid_until_ms=valid_until_ms
- )
- return (device_id, access_token)
- async def post_registration_actions(self, user_id, auth_result, access_token):
- """A user has completed registration
- Args:
- user_id (str): The user ID that consented
- auth_result (dict): The authenticated credentials of the newly
- registered user.
- access_token (str|None): The access token of the newly logged in
- device, or None if `inhibit_login` enabled.
- """
- if self.hs.config.worker_app:
- await self._post_registration_client(
- user_id=user_id, auth_result=auth_result, access_token=access_token
- )
- return
- if auth_result and LoginType.EMAIL_IDENTITY in auth_result:
- threepid = auth_result[LoginType.EMAIL_IDENTITY]
- # Necessary due to auth checks prior to the threepid being
- # written to the db
- if is_threepid_reserved(
- self.hs.config.mau_limits_reserved_threepids, threepid
- ):
- await self.store.upsert_monthly_active_user(user_id)
- await self._register_email_threepid(user_id, threepid, access_token)
- if auth_result and LoginType.MSISDN in auth_result:
- threepid = auth_result[LoginType.MSISDN]
- await self._register_msisdn_threepid(user_id, threepid)
- if auth_result and LoginType.TERMS in auth_result:
- await self._on_user_consented(user_id, self.hs.config.user_consent_version)
- async def _on_user_consented(self, user_id, consent_version):
- """A user consented to the terms on registration
- Args:
- user_id (str): The user ID that consented.
- consent_version (str): version of the policy the user has
- consented to.
- """
- logger.info("%s has consented to the privacy policy", user_id)
- await self.store.user_set_consent_version(user_id, consent_version)
- await self.post_consent_actions(user_id)
- async def _register_email_threepid(self, user_id, threepid, token):
- """Add an email address as a 3pid identifier
- Also adds an email pusher for the email address, if configured in the
- HS config
- Must be called on master.
- Args:
- user_id (str): id of user
- threepid (object): m.login.email.identity auth response
- token (str|None): access_token for the user, or None if not logged
- in.
- """
- reqd = ("medium", "address", "validated_at")
- if any(x not in threepid for x in reqd):
- # This will only happen if the ID server returns a malformed response
- logger.info("Can't add incomplete 3pid")
- return
- await self._auth_handler.add_threepid(
- user_id, threepid["medium"], threepid["address"], threepid["validated_at"],
- )
- # And we add an email pusher for them by default, but only
- # if email notifications are enabled (so people don't start
- # getting mail spam where they weren't before if email
- # notifs are set up on a homeserver)
- if (
- self.hs.config.email_enable_notifs
- and self.hs.config.email_notif_for_new_users
- and token
- ):
- # Pull the ID of the access token back out of the db
- # It would really make more sense for this to be passed
- # up when the access token is saved, but that's quite an
- # invasive change I'd rather do separately.
- user_tuple = await self.store.get_user_by_access_token(token)
- token_id = user_tuple.token_id
- await self.pusher_pool.add_pusher(
- user_id=user_id,
- access_token=token_id,
- kind="email",
- app_id="m.email",
- app_display_name="Email Notifications",
- device_display_name=threepid["address"],
- pushkey=threepid["address"],
- lang=None, # We don't know a user's language here
- data={},
- )
- async def _register_msisdn_threepid(self, user_id, threepid):
- """Add a phone number as a 3pid identifier
- Must be called on master.
- Args:
- user_id (str): id of user
- threepid (object): m.login.msisdn auth response
- """
- try:
- assert_params_in_dict(threepid, ["medium", "address", "validated_at"])
- except SynapseError as ex:
- if ex.errcode == Codes.MISSING_PARAM:
- # This will only happen if the ID server returns a malformed response
- logger.info("Can't add incomplete 3pid")
- return None
- raise
- await self._auth_handler.add_threepid(
- user_id, threepid["medium"], threepid["address"], threepid["validated_at"],
- )
|