797 lines
		
	
	
		
			29 KiB
		
	
	
	
		
			Python
		
	
	
			
		
		
	
	
			797 lines
		
	
	
		
			29 KiB
		
	
	
	
		
			Python
		
	
	
# -*- coding: utf-8 -*-
 | 
						|
# Copyright 2015, 2016 OpenMarket Ltd
 | 
						|
# Copyright 2017 Vector Creations Ltd
 | 
						|
# Copyright 2018 New Vector 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.
 | 
						|
import logging
 | 
						|
 | 
						|
from six.moves import http_client
 | 
						|
 | 
						|
from twisted.internet import defer
 | 
						|
 | 
						|
from synapse.api.constants import LoginType
 | 
						|
from synapse.api.errors import Codes, SynapseError, ThreepidValidationError
 | 
						|
from synapse.config.emailconfig import ThreepidBehaviour
 | 
						|
from synapse.http.server import finish_request
 | 
						|
from synapse.http.servlet import (
 | 
						|
    RestServlet,
 | 
						|
    assert_params_in_dict,
 | 
						|
    parse_json_object_from_request,
 | 
						|
    parse_string,
 | 
						|
)
 | 
						|
from synapse.push.mailer import Mailer, load_jinja2_templates
 | 
						|
from synapse.util.msisdn import phone_number_to_msisdn
 | 
						|
from synapse.util.threepids import check_3pid_allowed
 | 
						|
 | 
						|
from ._base import client_patterns, interactive_auth_handler
 | 
						|
 | 
						|
logger = logging.getLogger(__name__)
 | 
						|
 | 
						|
 | 
						|
class EmailPasswordRequestTokenRestServlet(RestServlet):
 | 
						|
    PATTERNS = client_patterns("/account/password/email/requestToken$")
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        super(EmailPasswordRequestTokenRestServlet, self).__init__()
 | 
						|
        self.hs = hs
 | 
						|
        self.datastore = hs.get_datastore()
 | 
						|
        self.config = hs.config
 | 
						|
        self.identity_handler = hs.get_handlers().identity_handler
 | 
						|
 | 
						|
        if self.config.threepid_behaviour_email == ThreepidBehaviour.LOCAL:
 | 
						|
            template_html, template_text = load_jinja2_templates(
 | 
						|
                self.config.email_template_dir,
 | 
						|
                [
 | 
						|
                    self.config.email_password_reset_template_html,
 | 
						|
                    self.config.email_password_reset_template_text,
 | 
						|
                ],
 | 
						|
                apply_format_ts_filter=True,
 | 
						|
                apply_mxc_to_http_filter=True,
 | 
						|
                public_baseurl=self.config.public_baseurl,
 | 
						|
            )
 | 
						|
            self.mailer = Mailer(
 | 
						|
                hs=self.hs,
 | 
						|
                app_name=self.config.email_app_name,
 | 
						|
                template_html=template_html,
 | 
						|
                template_text=template_text,
 | 
						|
            )
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_POST(self, request):
 | 
						|
        if self.config.threepid_behaviour_email == ThreepidBehaviour.OFF:
 | 
						|
            if self.config.local_threepid_handling_disabled_due_to_email_config:
 | 
						|
                logger.warn(
 | 
						|
                    "User password resets have been disabled due to lack of email config"
 | 
						|
                )
 | 
						|
            raise SynapseError(
 | 
						|
                400, "Email-based password resets have been disabled on this server"
 | 
						|
            )
 | 
						|
 | 
						|
        body = parse_json_object_from_request(request)
 | 
						|
 | 
						|
        assert_params_in_dict(body, ["client_secret", "email", "send_attempt"])
 | 
						|
 | 
						|
        # Extract params from body
 | 
						|
        client_secret = body["client_secret"]
 | 
						|
        email = body["email"]
 | 
						|
        send_attempt = body["send_attempt"]
 | 
						|
        next_link = body.get("next_link")  # Optional param
 | 
						|
 | 
						|
        if not check_3pid_allowed(self.hs, "email", email):
 | 
						|
            raise SynapseError(
 | 
						|
                403,
 | 
						|
                "Your email domain is not authorized on this server",
 | 
						|
                Codes.THREEPID_DENIED,
 | 
						|
            )
 | 
						|
 | 
						|
        existing_user_id = yield self.hs.get_datastore().get_user_id_by_threepid(
 | 
						|
            "email", email
 | 
						|
        )
 | 
						|
 | 
						|
        if existing_user_id is None:
 | 
						|
            raise SynapseError(400, "Email not found", Codes.THREEPID_NOT_FOUND)
 | 
						|
 | 
						|
        if self.config.threepid_behaviour_email == ThreepidBehaviour.REMOTE:
 | 
						|
            assert self.hs.config.account_threepid_delegate_email
 | 
						|
 | 
						|
            # Have the configured identity server handle the request
 | 
						|
            ret = yield self.identity_handler.requestEmailToken(
 | 
						|
                self.hs.config.account_threepid_delegate_email,
 | 
						|
                email,
 | 
						|
                client_secret,
 | 
						|
                send_attempt,
 | 
						|
                next_link,
 | 
						|
            )
 | 
						|
        else:
 | 
						|
            # Send password reset emails from Synapse
 | 
						|
            sid = yield self.identity_handler.send_threepid_validation(
 | 
						|
                email,
 | 
						|
                client_secret,
 | 
						|
                send_attempt,
 | 
						|
                self.mailer.send_password_reset_mail,
 | 
						|
                next_link,
 | 
						|
            )
 | 
						|
 | 
						|
            # Wrap the session id in a JSON object
 | 
						|
            ret = {"sid": sid}
 | 
						|
 | 
						|
        return 200, ret
 | 
						|
 | 
						|
 | 
						|
class PasswordResetSubmitTokenServlet(RestServlet):
 | 
						|
    """Handles 3PID validation token submission"""
 | 
						|
 | 
						|
    PATTERNS = client_patterns(
 | 
						|
        "/password_reset/(?P<medium>[^/]*)/submit_token$", releases=(), unstable=True
 | 
						|
    )
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        """
 | 
						|
        Args:
 | 
						|
            hs (synapse.server.HomeServer): server
 | 
						|
        """
 | 
						|
        super(PasswordResetSubmitTokenServlet, self).__init__()
 | 
						|
        self.hs = hs
 | 
						|
        self.auth = hs.get_auth()
 | 
						|
        self.config = hs.config
 | 
						|
        self.clock = hs.get_clock()
 | 
						|
        self.store = hs.get_datastore()
 | 
						|
        if self.config.threepid_behaviour_email == ThreepidBehaviour.LOCAL:
 | 
						|
            self.failure_email_template, = load_jinja2_templates(
 | 
						|
                self.config.email_template_dir,
 | 
						|
                [self.config.email_password_reset_template_failure_html],
 | 
						|
            )
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_GET(self, request, medium):
 | 
						|
        # We currently only handle threepid token submissions for email
 | 
						|
        if medium != "email":
 | 
						|
            raise SynapseError(
 | 
						|
                400, "This medium is currently not supported for password resets"
 | 
						|
            )
 | 
						|
        if self.config.threepid_behaviour_email == ThreepidBehaviour.OFF:
 | 
						|
            if self.config.local_threepid_handling_disabled_due_to_email_config:
 | 
						|
                logger.warn(
 | 
						|
                    "Password reset emails have been disabled due to lack of an email config"
 | 
						|
                )
 | 
						|
            raise SynapseError(
 | 
						|
                400, "Email-based password resets are disabled on this server"
 | 
						|
            )
 | 
						|
 | 
						|
        sid = parse_string(request, "sid", required=True)
 | 
						|
        client_secret = parse_string(request, "client_secret", required=True)
 | 
						|
        token = parse_string(request, "token", required=True)
 | 
						|
 | 
						|
        # Attempt to validate a 3PID session
 | 
						|
        try:
 | 
						|
            # Mark the session as valid
 | 
						|
            next_link = yield self.store.validate_threepid_session(
 | 
						|
                sid, client_secret, token, self.clock.time_msec()
 | 
						|
            )
 | 
						|
 | 
						|
            # Perform a 302 redirect if next_link is set
 | 
						|
            if next_link:
 | 
						|
                if next_link.startswith("file:///"):
 | 
						|
                    logger.warn(
 | 
						|
                        "Not redirecting to next_link as it is a local file: address"
 | 
						|
                    )
 | 
						|
                else:
 | 
						|
                    request.setResponseCode(302)
 | 
						|
                    request.setHeader("Location", next_link)
 | 
						|
                    finish_request(request)
 | 
						|
                    return None
 | 
						|
 | 
						|
            # Otherwise show the success template
 | 
						|
            html = self.config.email_password_reset_template_success_html
 | 
						|
            request.setResponseCode(200)
 | 
						|
        except ThreepidValidationError as e:
 | 
						|
            request.setResponseCode(e.code)
 | 
						|
 | 
						|
            # Show a failure page with a reason
 | 
						|
            template_vars = {"failure_reason": e.msg}
 | 
						|
            html = self.failure_email_template.render(**template_vars)
 | 
						|
 | 
						|
        request.write(html.encode("utf-8"))
 | 
						|
        finish_request(request)
 | 
						|
 | 
						|
 | 
						|
class PasswordRestServlet(RestServlet):
 | 
						|
    PATTERNS = client_patterns("/account/password$")
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        super(PasswordRestServlet, self).__init__()
 | 
						|
        self.hs = hs
 | 
						|
        self.auth = hs.get_auth()
 | 
						|
        self.auth_handler = hs.get_auth_handler()
 | 
						|
        self.datastore = self.hs.get_datastore()
 | 
						|
        self._set_password_handler = hs.get_set_password_handler()
 | 
						|
 | 
						|
    @interactive_auth_handler
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_POST(self, request):
 | 
						|
        body = parse_json_object_from_request(request)
 | 
						|
 | 
						|
        # there are two possibilities here. Either the user does not have an
 | 
						|
        # access token, and needs to do a password reset; or they have one and
 | 
						|
        # need to validate their identity.
 | 
						|
        #
 | 
						|
        # In the first case, we offer a couple of means of identifying
 | 
						|
        # themselves (email and msisdn, though it's unclear if msisdn actually
 | 
						|
        # works).
 | 
						|
        #
 | 
						|
        # In the second case, we require a password to confirm their identity.
 | 
						|
 | 
						|
        if self.auth.has_access_token(request):
 | 
						|
            requester = yield self.auth.get_user_by_req(request)
 | 
						|
            params = yield self.auth_handler.validate_user_via_ui_auth(
 | 
						|
                requester, body, self.hs.get_ip_from_request(request)
 | 
						|
            )
 | 
						|
            user_id = requester.user.to_string()
 | 
						|
        else:
 | 
						|
            requester = None
 | 
						|
            result, params, _ = yield self.auth_handler.check_auth(
 | 
						|
                [[LoginType.EMAIL_IDENTITY]], body, self.hs.get_ip_from_request(request)
 | 
						|
            )
 | 
						|
 | 
						|
            if LoginType.EMAIL_IDENTITY in result:
 | 
						|
                threepid = result[LoginType.EMAIL_IDENTITY]
 | 
						|
                if "medium" not in threepid or "address" not in threepid:
 | 
						|
                    raise SynapseError(500, "Malformed threepid")
 | 
						|
                if threepid["medium"] == "email":
 | 
						|
                    # For emails, transform the address to lowercase.
 | 
						|
                    # We store all email addreses as lowercase in the DB.
 | 
						|
                    # (See add_threepid in synapse/handlers/auth.py)
 | 
						|
                    threepid["address"] = threepid["address"].lower()
 | 
						|
                # if using email, we must know about the email they're authing with!
 | 
						|
                threepid_user_id = yield self.datastore.get_user_id_by_threepid(
 | 
						|
                    threepid["medium"], threepid["address"]
 | 
						|
                )
 | 
						|
                if not threepid_user_id:
 | 
						|
                    raise SynapseError(404, "Email address not found", Codes.NOT_FOUND)
 | 
						|
                user_id = threepid_user_id
 | 
						|
            else:
 | 
						|
                logger.error("Auth succeeded but no known type! %r", result.keys())
 | 
						|
                raise SynapseError(500, "", Codes.UNKNOWN)
 | 
						|
 | 
						|
        assert_params_in_dict(params, ["new_password"])
 | 
						|
        new_password = params["new_password"]
 | 
						|
 | 
						|
        yield self._set_password_handler.set_password(user_id, new_password, requester)
 | 
						|
 | 
						|
        return 200, {}
 | 
						|
 | 
						|
    def on_OPTIONS(self, _):
 | 
						|
        return 200, {}
 | 
						|
 | 
						|
 | 
						|
class DeactivateAccountRestServlet(RestServlet):
 | 
						|
    PATTERNS = client_patterns("/account/deactivate$")
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        super(DeactivateAccountRestServlet, self).__init__()
 | 
						|
        self.hs = hs
 | 
						|
        self.auth = hs.get_auth()
 | 
						|
        self.auth_handler = hs.get_auth_handler()
 | 
						|
        self._deactivate_account_handler = hs.get_deactivate_account_handler()
 | 
						|
 | 
						|
    @interactive_auth_handler
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_POST(self, request):
 | 
						|
        body = parse_json_object_from_request(request)
 | 
						|
        erase = body.get("erase", False)
 | 
						|
        if not isinstance(erase, bool):
 | 
						|
            raise SynapseError(
 | 
						|
                http_client.BAD_REQUEST,
 | 
						|
                "Param 'erase' must be a boolean, if given",
 | 
						|
                Codes.BAD_JSON,
 | 
						|
            )
 | 
						|
 | 
						|
        requester = yield self.auth.get_user_by_req(request)
 | 
						|
 | 
						|
        # allow ASes to dectivate their own users
 | 
						|
        if requester.app_service:
 | 
						|
            yield self._deactivate_account_handler.deactivate_account(
 | 
						|
                requester.user.to_string(), erase
 | 
						|
            )
 | 
						|
            return 200, {}
 | 
						|
 | 
						|
        yield self.auth_handler.validate_user_via_ui_auth(
 | 
						|
            requester, body, self.hs.get_ip_from_request(request)
 | 
						|
        )
 | 
						|
        result = yield self._deactivate_account_handler.deactivate_account(
 | 
						|
            requester.user.to_string(), erase, id_server=body.get("id_server")
 | 
						|
        )
 | 
						|
        if result:
 | 
						|
            id_server_unbind_result = "success"
 | 
						|
        else:
 | 
						|
            id_server_unbind_result = "no-support"
 | 
						|
 | 
						|
        return 200, {"id_server_unbind_result": id_server_unbind_result}
 | 
						|
 | 
						|
 | 
						|
class EmailThreepidRequestTokenRestServlet(RestServlet):
 | 
						|
    PATTERNS = client_patterns("/account/3pid/email/requestToken$")
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        super(EmailThreepidRequestTokenRestServlet, self).__init__()
 | 
						|
        self.hs = hs
 | 
						|
        self.config = hs.config
 | 
						|
        self.identity_handler = hs.get_handlers().identity_handler
 | 
						|
        self.store = self.hs.get_datastore()
 | 
						|
 | 
						|
        if self.config.threepid_behaviour_email == ThreepidBehaviour.LOCAL:
 | 
						|
            template_html, template_text = load_jinja2_templates(
 | 
						|
                self.config.email_template_dir,
 | 
						|
                [
 | 
						|
                    self.config.email_add_threepid_template_html,
 | 
						|
                    self.config.email_add_threepid_template_text,
 | 
						|
                ],
 | 
						|
                public_baseurl=self.config.public_baseurl,
 | 
						|
            )
 | 
						|
            self.mailer = Mailer(
 | 
						|
                hs=self.hs,
 | 
						|
                app_name=self.config.email_app_name,
 | 
						|
                template_html=template_html,
 | 
						|
                template_text=template_text,
 | 
						|
            )
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_POST(self, request):
 | 
						|
        if self.config.threepid_behaviour_email == ThreepidBehaviour.OFF:
 | 
						|
            if self.config.local_threepid_handling_disabled_due_to_email_config:
 | 
						|
                logger.warn(
 | 
						|
                    "Adding emails have been disabled due to lack of an email config"
 | 
						|
                )
 | 
						|
            raise SynapseError(
 | 
						|
                400, "Adding an email to your account is disabled on this server"
 | 
						|
            )
 | 
						|
 | 
						|
        body = parse_json_object_from_request(request)
 | 
						|
        assert_params_in_dict(body, ["client_secret", "email", "send_attempt"])
 | 
						|
        client_secret = body["client_secret"]
 | 
						|
        email = body["email"]
 | 
						|
        send_attempt = body["send_attempt"]
 | 
						|
        next_link = body.get("next_link")  # Optional param
 | 
						|
 | 
						|
        if not check_3pid_allowed(self.hs, "email", email):
 | 
						|
            raise SynapseError(
 | 
						|
                403,
 | 
						|
                "Your email domain is not authorized on this server",
 | 
						|
                Codes.THREEPID_DENIED,
 | 
						|
            )
 | 
						|
 | 
						|
        existing_user_id = yield self.store.get_user_id_by_threepid(
 | 
						|
            "email", body["email"]
 | 
						|
        )
 | 
						|
 | 
						|
        if existing_user_id is not None:
 | 
						|
            raise SynapseError(400, "Email is already in use", Codes.THREEPID_IN_USE)
 | 
						|
 | 
						|
        if self.config.threepid_behaviour_email == ThreepidBehaviour.REMOTE:
 | 
						|
            assert self.hs.config.account_threepid_delegate_email
 | 
						|
 | 
						|
            # Have the configured identity server handle the request
 | 
						|
            ret = yield self.identity_handler.requestEmailToken(
 | 
						|
                self.hs.config.account_threepid_delegate_email,
 | 
						|
                email,
 | 
						|
                client_secret,
 | 
						|
                send_attempt,
 | 
						|
                next_link,
 | 
						|
            )
 | 
						|
        else:
 | 
						|
            # Send threepid validation emails from Synapse
 | 
						|
            sid = yield self.identity_handler.send_threepid_validation(
 | 
						|
                email,
 | 
						|
                client_secret,
 | 
						|
                send_attempt,
 | 
						|
                self.mailer.send_add_threepid_mail,
 | 
						|
                next_link,
 | 
						|
            )
 | 
						|
 | 
						|
            # Wrap the session id in a JSON object
 | 
						|
            ret = {"sid": sid}
 | 
						|
 | 
						|
        return 200, ret
 | 
						|
 | 
						|
 | 
						|
class MsisdnThreepidRequestTokenRestServlet(RestServlet):
 | 
						|
    PATTERNS = client_patterns("/account/3pid/msisdn/requestToken$")
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        self.hs = hs
 | 
						|
        super(MsisdnThreepidRequestTokenRestServlet, self).__init__()
 | 
						|
        self.store = self.hs.get_datastore()
 | 
						|
        self.identity_handler = hs.get_handlers().identity_handler
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_POST(self, request):
 | 
						|
        body = parse_json_object_from_request(request)
 | 
						|
        assert_params_in_dict(
 | 
						|
            body, ["client_secret", "country", "phone_number", "send_attempt"]
 | 
						|
        )
 | 
						|
        client_secret = body["client_secret"]
 | 
						|
        country = body["country"]
 | 
						|
        phone_number = body["phone_number"]
 | 
						|
        send_attempt = body["send_attempt"]
 | 
						|
        next_link = body.get("next_link")  # Optional param
 | 
						|
 | 
						|
        msisdn = phone_number_to_msisdn(country, phone_number)
 | 
						|
 | 
						|
        if not check_3pid_allowed(self.hs, "msisdn", msisdn):
 | 
						|
            raise SynapseError(
 | 
						|
                403,
 | 
						|
                "Account phone numbers are not authorized on this server",
 | 
						|
                Codes.THREEPID_DENIED,
 | 
						|
            )
 | 
						|
 | 
						|
        existing_user_id = yield self.store.get_user_id_by_threepid("msisdn", msisdn)
 | 
						|
 | 
						|
        if existing_user_id is not None:
 | 
						|
            raise SynapseError(400, "MSISDN is already in use", Codes.THREEPID_IN_USE)
 | 
						|
 | 
						|
        if not self.hs.config.account_threepid_delegate_msisdn:
 | 
						|
            logger.warn(
 | 
						|
                "No upstream msisdn account_threepid_delegate configured on the server to "
 | 
						|
                "handle this request"
 | 
						|
            )
 | 
						|
            raise SynapseError(
 | 
						|
                400,
 | 
						|
                "Adding phone numbers to user account is not supported by this homeserver",
 | 
						|
            )
 | 
						|
 | 
						|
        ret = yield self.identity_handler.requestMsisdnToken(
 | 
						|
            self.hs.config.account_threepid_delegate_msisdn,
 | 
						|
            country,
 | 
						|
            phone_number,
 | 
						|
            client_secret,
 | 
						|
            send_attempt,
 | 
						|
            next_link,
 | 
						|
        )
 | 
						|
 | 
						|
        return 200, ret
 | 
						|
 | 
						|
 | 
						|
class AddThreepidEmailSubmitTokenServlet(RestServlet):
 | 
						|
    """Handles 3PID validation token submission for adding an email to a user's account"""
 | 
						|
 | 
						|
    PATTERNS = client_patterns(
 | 
						|
        "/add_threepid/email/submit_token$", releases=(), unstable=True
 | 
						|
    )
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        """
 | 
						|
        Args:
 | 
						|
            hs (synapse.server.HomeServer): server
 | 
						|
        """
 | 
						|
        super().__init__()
 | 
						|
        self.config = hs.config
 | 
						|
        self.clock = hs.get_clock()
 | 
						|
        self.store = hs.get_datastore()
 | 
						|
        if self.config.threepid_behaviour_email == ThreepidBehaviour.LOCAL:
 | 
						|
            self.failure_email_template, = load_jinja2_templates(
 | 
						|
                self.config.email_template_dir,
 | 
						|
                [self.config.email_add_threepid_template_failure_html],
 | 
						|
            )
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_GET(self, request):
 | 
						|
        if self.config.threepid_behaviour_email == ThreepidBehaviour.OFF:
 | 
						|
            if self.config.local_threepid_handling_disabled_due_to_email_config:
 | 
						|
                logger.warn(
 | 
						|
                    "Adding emails have been disabled due to lack of an email config"
 | 
						|
                )
 | 
						|
            raise SynapseError(
 | 
						|
                400, "Adding an email to your account is disabled on this server"
 | 
						|
            )
 | 
						|
        elif self.config.threepid_behaviour_email == ThreepidBehaviour.REMOTE:
 | 
						|
            raise SynapseError(
 | 
						|
                400,
 | 
						|
                "This homeserver is not validating threepids. Use an identity server "
 | 
						|
                "instead.",
 | 
						|
            )
 | 
						|
 | 
						|
        sid = parse_string(request, "sid", required=True)
 | 
						|
        client_secret = parse_string(request, "client_secret", required=True)
 | 
						|
        token = parse_string(request, "token", required=True)
 | 
						|
 | 
						|
        # Attempt to validate a 3PID session
 | 
						|
        try:
 | 
						|
            # Mark the session as valid
 | 
						|
            next_link = yield self.store.validate_threepid_session(
 | 
						|
                sid, client_secret, token, self.clock.time_msec()
 | 
						|
            )
 | 
						|
 | 
						|
            # Perform a 302 redirect if next_link is set
 | 
						|
            if next_link:
 | 
						|
                if next_link.startswith("file:///"):
 | 
						|
                    logger.warn(
 | 
						|
                        "Not redirecting to next_link as it is a local file: address"
 | 
						|
                    )
 | 
						|
                else:
 | 
						|
                    request.setResponseCode(302)
 | 
						|
                    request.setHeader("Location", next_link)
 | 
						|
                    finish_request(request)
 | 
						|
                    return None
 | 
						|
 | 
						|
            # Otherwise show the success template
 | 
						|
            html = self.config.email_add_threepid_template_success_html_content
 | 
						|
            request.setResponseCode(200)
 | 
						|
        except ThreepidValidationError as e:
 | 
						|
            request.setResponseCode(e.code)
 | 
						|
 | 
						|
            # Show a failure page with a reason
 | 
						|
            template_vars = {"failure_reason": e.msg}
 | 
						|
            html = self.failure_email_template.render(**template_vars)
 | 
						|
 | 
						|
        request.write(html.encode("utf-8"))
 | 
						|
        finish_request(request)
 | 
						|
 | 
						|
 | 
						|
class AddThreepidMsisdnSubmitTokenServlet(RestServlet):
 | 
						|
    """Handles 3PID validation token submission for adding a phone number to a user's
 | 
						|
    account
 | 
						|
    """
 | 
						|
 | 
						|
    PATTERNS = client_patterns(
 | 
						|
        "/add_threepid/msisdn/submit_token$", releases=(), unstable=True
 | 
						|
    )
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        """
 | 
						|
        Args:
 | 
						|
            hs (synapse.server.HomeServer): server
 | 
						|
        """
 | 
						|
        super().__init__()
 | 
						|
        self.config = hs.config
 | 
						|
        self.clock = hs.get_clock()
 | 
						|
        self.store = hs.get_datastore()
 | 
						|
        self.identity_handler = hs.get_handlers().identity_handler
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_POST(self, request):
 | 
						|
        if not self.config.account_threepid_delegate_msisdn:
 | 
						|
            raise SynapseError(
 | 
						|
                400,
 | 
						|
                "This homeserver is not validating phone numbers. Use an identity server "
 | 
						|
                "instead.",
 | 
						|
            )
 | 
						|
 | 
						|
        body = parse_json_object_from_request(request)
 | 
						|
        assert_params_in_dict(body, ["client_secret", "sid", "token"])
 | 
						|
 | 
						|
        # Proxy submit_token request to msisdn threepid delegate
 | 
						|
        response = yield self.identity_handler.proxy_msisdn_submit_token(
 | 
						|
            self.config.account_threepid_delegate_msisdn,
 | 
						|
            body["client_secret"],
 | 
						|
            body["sid"],
 | 
						|
            body["token"],
 | 
						|
        )
 | 
						|
        return 200, response
 | 
						|
 | 
						|
 | 
						|
class ThreepidRestServlet(RestServlet):
 | 
						|
    PATTERNS = client_patterns("/account/3pid$")
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        super(ThreepidRestServlet, self).__init__()
 | 
						|
        self.hs = hs
 | 
						|
        self.identity_handler = hs.get_handlers().identity_handler
 | 
						|
        self.auth = hs.get_auth()
 | 
						|
        self.auth_handler = hs.get_auth_handler()
 | 
						|
        self.datastore = self.hs.get_datastore()
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_GET(self, request):
 | 
						|
        requester = yield self.auth.get_user_by_req(request)
 | 
						|
 | 
						|
        threepids = yield self.datastore.user_get_threepids(requester.user.to_string())
 | 
						|
 | 
						|
        return 200, {"threepids": threepids}
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_POST(self, request):
 | 
						|
        requester = yield self.auth.get_user_by_req(request)
 | 
						|
        user_id = requester.user.to_string()
 | 
						|
        body = parse_json_object_from_request(request)
 | 
						|
 | 
						|
        threepid_creds = body.get("threePidCreds") or body.get("three_pid_creds")
 | 
						|
        if threepid_creds is None:
 | 
						|
            raise SynapseError(
 | 
						|
                400, "Missing param three_pid_creds", Codes.MISSING_PARAM
 | 
						|
            )
 | 
						|
        assert_params_in_dict(threepid_creds, ["client_secret", "sid"])
 | 
						|
 | 
						|
        client_secret = threepid_creds["client_secret"]
 | 
						|
        sid = threepid_creds["sid"]
 | 
						|
 | 
						|
        validation_session = yield self.identity_handler.validate_threepid_session(
 | 
						|
            client_secret, sid
 | 
						|
        )
 | 
						|
        if validation_session:
 | 
						|
            yield self.auth_handler.add_threepid(
 | 
						|
                user_id,
 | 
						|
                validation_session["medium"],
 | 
						|
                validation_session["address"],
 | 
						|
                validation_session["validated_at"],
 | 
						|
            )
 | 
						|
            return 200, {}
 | 
						|
 | 
						|
        raise SynapseError(
 | 
						|
            400, "No validated 3pid session found", Codes.THREEPID_AUTH_FAILED
 | 
						|
        )
 | 
						|
 | 
						|
 | 
						|
class ThreepidAddRestServlet(RestServlet):
 | 
						|
    PATTERNS = client_patterns("/account/3pid/add$", releases=(), unstable=True)
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        super(ThreepidAddRestServlet, self).__init__()
 | 
						|
        self.hs = hs
 | 
						|
        self.identity_handler = hs.get_handlers().identity_handler
 | 
						|
        self.auth = hs.get_auth()
 | 
						|
        self.auth_handler = hs.get_auth_handler()
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_POST(self, request):
 | 
						|
        requester = yield self.auth.get_user_by_req(request)
 | 
						|
        user_id = requester.user.to_string()
 | 
						|
        body = parse_json_object_from_request(request)
 | 
						|
 | 
						|
        assert_params_in_dict(body, ["client_secret", "sid"])
 | 
						|
        client_secret = body["client_secret"]
 | 
						|
        sid = body["sid"]
 | 
						|
 | 
						|
        validation_session = yield self.identity_handler.validate_threepid_session(
 | 
						|
            client_secret, sid
 | 
						|
        )
 | 
						|
        if validation_session:
 | 
						|
            yield self.auth_handler.add_threepid(
 | 
						|
                user_id,
 | 
						|
                validation_session["medium"],
 | 
						|
                validation_session["address"],
 | 
						|
                validation_session["validated_at"],
 | 
						|
            )
 | 
						|
            return 200, {}
 | 
						|
 | 
						|
        raise SynapseError(
 | 
						|
            400, "No validated 3pid session found", Codes.THREEPID_AUTH_FAILED
 | 
						|
        )
 | 
						|
 | 
						|
 | 
						|
class ThreepidBindRestServlet(RestServlet):
 | 
						|
    PATTERNS = client_patterns("/account/3pid/bind$", releases=(), unstable=True)
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        super(ThreepidBindRestServlet, self).__init__()
 | 
						|
        self.hs = hs
 | 
						|
        self.identity_handler = hs.get_handlers().identity_handler
 | 
						|
        self.auth = hs.get_auth()
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_POST(self, request):
 | 
						|
        body = parse_json_object_from_request(request)
 | 
						|
 | 
						|
        assert_params_in_dict(body, ["id_server", "sid", "client_secret"])
 | 
						|
        id_server = body["id_server"]
 | 
						|
        sid = body["sid"]
 | 
						|
        client_secret = body["client_secret"]
 | 
						|
        id_access_token = body.get("id_access_token")  # optional
 | 
						|
 | 
						|
        requester = yield self.auth.get_user_by_req(request)
 | 
						|
        user_id = requester.user.to_string()
 | 
						|
 | 
						|
        yield self.identity_handler.bind_threepid(
 | 
						|
            client_secret, sid, user_id, id_server, id_access_token
 | 
						|
        )
 | 
						|
 | 
						|
        return 200, {}
 | 
						|
 | 
						|
 | 
						|
class ThreepidUnbindRestServlet(RestServlet):
 | 
						|
    PATTERNS = client_patterns("/account/3pid/unbind$", releases=(), unstable=True)
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        super(ThreepidUnbindRestServlet, self).__init__()
 | 
						|
        self.hs = hs
 | 
						|
        self.identity_handler = hs.get_handlers().identity_handler
 | 
						|
        self.auth = hs.get_auth()
 | 
						|
        self.datastore = self.hs.get_datastore()
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_POST(self, request):
 | 
						|
        """Unbind the given 3pid from a specific identity server, or identity servers that are
 | 
						|
        known to have this 3pid bound
 | 
						|
        """
 | 
						|
        requester = yield self.auth.get_user_by_req(request)
 | 
						|
        body = parse_json_object_from_request(request)
 | 
						|
        assert_params_in_dict(body, ["medium", "address"])
 | 
						|
 | 
						|
        medium = body.get("medium")
 | 
						|
        address = body.get("address")
 | 
						|
        id_server = body.get("id_server")
 | 
						|
 | 
						|
        # Attempt to unbind the threepid from an identity server. If id_server is None, try to
 | 
						|
        # unbind from all identity servers this threepid has been added to in the past
 | 
						|
        result = yield self.identity_handler.try_unbind_threepid(
 | 
						|
            requester.user.to_string(),
 | 
						|
            {"address": address, "medium": medium, "id_server": id_server},
 | 
						|
        )
 | 
						|
        return 200, {"id_server_unbind_result": "success" if result else "no-support"}
 | 
						|
 | 
						|
 | 
						|
class ThreepidDeleteRestServlet(RestServlet):
 | 
						|
    PATTERNS = client_patterns("/account/3pid/delete$")
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        super(ThreepidDeleteRestServlet, self).__init__()
 | 
						|
        self.auth = hs.get_auth()
 | 
						|
        self.auth_handler = hs.get_auth_handler()
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_POST(self, request):
 | 
						|
        body = parse_json_object_from_request(request)
 | 
						|
        assert_params_in_dict(body, ["medium", "address"])
 | 
						|
 | 
						|
        requester = yield self.auth.get_user_by_req(request)
 | 
						|
        user_id = requester.user.to_string()
 | 
						|
 | 
						|
        try:
 | 
						|
            ret = yield self.auth_handler.delete_threepid(
 | 
						|
                user_id, body["medium"], body["address"], body.get("id_server")
 | 
						|
            )
 | 
						|
        except Exception:
 | 
						|
            # NB. This endpoint should succeed if there is nothing to
 | 
						|
            # delete, so it should only throw if something is wrong
 | 
						|
            # that we ought to care about.
 | 
						|
            logger.exception("Failed to remove threepid")
 | 
						|
            raise SynapseError(500, "Failed to remove threepid")
 | 
						|
 | 
						|
        if ret:
 | 
						|
            id_server_unbind_result = "success"
 | 
						|
        else:
 | 
						|
            id_server_unbind_result = "no-support"
 | 
						|
 | 
						|
        return 200, {"id_server_unbind_result": id_server_unbind_result}
 | 
						|
 | 
						|
 | 
						|
class WhoamiRestServlet(RestServlet):
 | 
						|
    PATTERNS = client_patterns("/account/whoami$")
 | 
						|
 | 
						|
    def __init__(self, hs):
 | 
						|
        super(WhoamiRestServlet, self).__init__()
 | 
						|
        self.auth = hs.get_auth()
 | 
						|
 | 
						|
    @defer.inlineCallbacks
 | 
						|
    def on_GET(self, request):
 | 
						|
        requester = yield self.auth.get_user_by_req(request)
 | 
						|
 | 
						|
        return 200, {"user_id": requester.user.to_string()}
 | 
						|
 | 
						|
 | 
						|
def register_servlets(hs, http_server):
 | 
						|
    EmailPasswordRequestTokenRestServlet(hs).register(http_server)
 | 
						|
    PasswordResetSubmitTokenServlet(hs).register(http_server)
 | 
						|
    PasswordRestServlet(hs).register(http_server)
 | 
						|
    DeactivateAccountRestServlet(hs).register(http_server)
 | 
						|
    EmailThreepidRequestTokenRestServlet(hs).register(http_server)
 | 
						|
    MsisdnThreepidRequestTokenRestServlet(hs).register(http_server)
 | 
						|
    AddThreepidEmailSubmitTokenServlet(hs).register(http_server)
 | 
						|
    AddThreepidMsisdnSubmitTokenServlet(hs).register(http_server)
 | 
						|
    ThreepidRestServlet(hs).register(http_server)
 | 
						|
    ThreepidAddRestServlet(hs).register(http_server)
 | 
						|
    ThreepidBindRestServlet(hs).register(http_server)
 | 
						|
    ThreepidUnbindRestServlet(hs).register(http_server)
 | 
						|
    ThreepidDeleteRestServlet(hs).register(http_server)
 | 
						|
    WhoamiRestServlet(hs).register(http_server)
 |