2015-03-30 17:13:10 +00:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-05 18:01:18 +00:00
|
|
|
# Copyright 2015 - 2016 OpenMarket Ltd
|
2017-03-13 17:27:51 +00:00
|
|
|
# Copyright 2017 Vector Creations Ltd
|
2015-03-30 17:13:10 +00:00
|
|
|
#
|
|
|
|
# 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 06:09:20 +00:00
|
|
|
import hmac
|
|
|
|
import logging
|
2019-09-25 10:32:05 +00:00
|
|
|
from typing import List, Union
|
2018-07-09 06:09:20 +00:00
|
|
|
|
|
|
|
from six import string_types
|
|
|
|
|
2015-03-30 17:13:10 +00:00
|
|
|
from twisted.internet import defer
|
|
|
|
|
2016-11-25 15:25:30 +00:00
|
|
|
import synapse
|
2017-10-16 16:57:27 +00:00
|
|
|
import synapse.types
|
2015-03-30 17:13:10 +00:00
|
|
|
from synapse.api.constants import LoginType
|
2019-03-05 14:25:33 +00:00
|
|
|
from synapse.api.errors import (
|
|
|
|
Codes,
|
|
|
|
LimitExceededError,
|
|
|
|
SynapseError,
|
2019-09-06 10:35:28 +00:00
|
|
|
ThreepidValidationError,
|
2019-03-05 14:25:33 +00:00
|
|
|
UnrecognizedRequestError,
|
|
|
|
)
|
2019-09-25 10:32:05 +00:00
|
|
|
from synapse.config.captcha import CaptchaConfig
|
|
|
|
from synapse.config.consent_config import ConsentConfig
|
2019-09-06 10:35:28 +00:00
|
|
|
from synapse.config.emailconfig import ThreepidBehaviour
|
2019-05-15 17:06:04 +00:00
|
|
|
from synapse.config.ratelimiting import FederationRateLimitConfig
|
2019-09-25 10:32:05 +00:00
|
|
|
from synapse.config.registration import RegistrationConfig
|
2018-08-31 16:11:11 +00:00
|
|
|
from synapse.config.server import is_threepid_reserved
|
2019-09-06 10:35:28 +00:00
|
|
|
from synapse.http.server import finish_request
|
2017-03-13 17:27:51 +00:00
|
|
|
from synapse.http.servlet import (
|
2018-07-09 06:09:20 +00:00
|
|
|
RestServlet,
|
2018-07-13 19:53:01 +00:00
|
|
|
assert_params_in_dict,
|
2018-07-09 06:09:20 +00:00
|
|
|
parse_json_object_from_request,
|
|
|
|
parse_string,
|
2017-03-13 17:27:51 +00:00
|
|
|
)
|
2019-09-06 10:35:28 +00:00
|
|
|
from synapse.push.mailer import load_jinja2_templates
|
2017-03-13 17:27:51 +00:00
|
|
|
from synapse.util.msisdn import phone_number_to_msisdn
|
2018-07-09 06:09:20 +00:00
|
|
|
from synapse.util.ratelimitutils import FederationRateLimiter
|
2018-01-19 15:33:55 +00:00
|
|
|
from synapse.util.threepids import check_3pid_allowed
|
2015-03-30 17:13:10 +00:00
|
|
|
|
2019-06-03 11:28:59 +00:00
|
|
|
from ._base import client_patterns, interactive_auth_handler
|
2015-03-30 17:13:10 +00:00
|
|
|
|
2015-04-02 16:01:29 +00:00
|
|
|
# We ought to be using hmac.compare_digest() but on older pythons it doesn't
|
|
|
|
# exist. It's a _really minor_ security flaw to use plain string comparison
|
|
|
|
# because the timing attack is so obscured by all the other code here it's
|
|
|
|
# unlikely to make much difference
|
|
|
|
if hasattr(hmac, "compare_digest"):
|
|
|
|
compare_digest = hmac.compare_digest
|
|
|
|
else:
|
2019-06-20 09:32:02 +00:00
|
|
|
|
2016-02-02 17:18:50 +00:00
|
|
|
def compare_digest(a, b):
|
|
|
|
return a == b
|
2015-03-30 17:13:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
2017-03-13 17:27:51 +00:00
|
|
|
class EmailRegisterRequestTokenRestServlet(RestServlet):
|
2019-06-03 11:28:59 +00:00
|
|
|
PATTERNS = client_patterns("/register/email/requestToken$")
|
2016-07-11 08:57:07 +00:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2016-07-19 09:21:42 +00:00
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer): server
|
|
|
|
"""
|
2017-03-13 17:27:51 +00:00
|
|
|
super(EmailRegisterRequestTokenRestServlet, self).__init__()
|
2016-07-11 08:57:07 +00:00
|
|
|
self.hs = hs
|
|
|
|
self.identity_handler = hs.get_handlers().identity_handler
|
2019-09-06 10:35:28 +00:00
|
|
|
self.config = hs.config
|
|
|
|
|
|
|
|
if self.hs.config.threepid_behaviour_email == ThreepidBehaviour.LOCAL:
|
|
|
|
from synapse.push.mailer import Mailer, load_jinja2_templates
|
|
|
|
|
|
|
|
template_html, template_text = load_jinja2_templates(
|
|
|
|
self.config.email_template_dir,
|
|
|
|
[
|
|
|
|
self.config.email_registration_template_html,
|
|
|
|
self.config.email_registration_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,
|
|
|
|
)
|
2016-07-11 08:57:07 +00:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request):
|
2019-09-06 10:35:28 +00:00
|
|
|
if self.hs.config.threepid_behaviour_email == ThreepidBehaviour.OFF:
|
|
|
|
if self.hs.config.local_threepid_handling_disabled_due_to_email_config:
|
|
|
|
logger.warn(
|
|
|
|
"Email registration has been disabled due to lack of email config"
|
|
|
|
)
|
|
|
|
raise SynapseError(
|
|
|
|
400, "Email-based registration has been disabled on this server"
|
|
|
|
)
|
2016-07-11 08:57:07 +00:00
|
|
|
body = parse_json_object_from_request(request)
|
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
assert_params_in_dict(body, ["client_secret", "email", "send_attempt"])
|
2016-07-11 08:57:07 +00:00
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
# 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):
|
2018-01-19 00:53:58 +00:00
|
|
|
raise SynapseError(
|
2018-09-04 11:03:17 +00:00
|
|
|
403,
|
|
|
|
"Your email domain is not authorized to register on this server",
|
|
|
|
Codes.THREEPID_DENIED,
|
2018-01-19 00:53:58 +00:00
|
|
|
)
|
2018-01-19 00:19:58 +00:00
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
existing_user_id = yield self.hs.get_datastore().get_user_id_by_threepid(
|
2019-06-20 09:32:02 +00:00
|
|
|
"email", body["email"]
|
2016-07-11 08:57:07 +00:00
|
|
|
)
|
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
if existing_user_id is not None:
|
2016-07-11 08:57:07 +00:00
|
|
|
raise SynapseError(400, "Email is already in use", Codes.THREEPID_IN_USE)
|
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
if self.config.threepid_behaviour_email == ThreepidBehaviour.REMOTE:
|
2019-09-20 14:21:30 +00:00
|
|
|
assert self.hs.config.account_threepid_delegate_email
|
2019-09-06 10:35:28 +00:00
|
|
|
|
2019-09-20 14:21:30 +00:00
|
|
|
# Have the configured identity server handle the request
|
2019-09-06 10:35:28 +00:00
|
|
|
ret = yield self.identity_handler.requestEmailToken(
|
|
|
|
self.hs.config.account_threepid_delegate_email,
|
|
|
|
email,
|
|
|
|
client_secret,
|
|
|
|
send_attempt,
|
|
|
|
next_link,
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
# Send registration emails from Synapse
|
|
|
|
sid = yield self.identity_handler.send_threepid_validation(
|
|
|
|
email,
|
|
|
|
client_secret,
|
|
|
|
send_attempt,
|
|
|
|
self.mailer.send_registration_mail,
|
|
|
|
next_link,
|
|
|
|
)
|
|
|
|
|
|
|
|
# Wrap the session id in a JSON object
|
|
|
|
ret = {"sid": sid}
|
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, ret
|
2016-07-11 08:57:07 +00:00
|
|
|
|
|
|
|
|
2017-03-13 17:27:51 +00:00
|
|
|
class MsisdnRegisterRequestTokenRestServlet(RestServlet):
|
2019-06-03 11:28:59 +00:00
|
|
|
PATTERNS = client_patterns("/register/msisdn/requestToken$")
|
2017-03-13 17:27:51 +00:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer): server
|
|
|
|
"""
|
|
|
|
super(MsisdnRegisterRequestTokenRestServlet, self).__init__()
|
|
|
|
self.hs = hs
|
|
|
|
self.identity_handler = hs.get_handlers().identity_handler
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request):
|
|
|
|
body = parse_json_object_from_request(request)
|
|
|
|
|
2019-06-20 09:32:02 +00:00
|
|
|
assert_params_in_dict(
|
2019-09-06 10:35:28 +00:00
|
|
|
body, ["client_secret", "country", "phone_number", "send_attempt"]
|
2019-06-20 09:32:02 +00:00
|
|
|
)
|
2019-09-06 10:35:28 +00:00
|
|
|
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
|
2017-03-13 17:27:51 +00:00
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
msisdn = phone_number_to_msisdn(country, phone_number)
|
2017-03-13 17:27:51 +00:00
|
|
|
|
2018-01-19 00:19:58 +00:00
|
|
|
if not check_3pid_allowed(self.hs, "msisdn", msisdn):
|
2018-01-19 00:53:58 +00:00
|
|
|
raise SynapseError(
|
2018-09-04 11:03:17 +00:00
|
|
|
403,
|
|
|
|
"Phone numbers are not authorized to register on this server",
|
|
|
|
Codes.THREEPID_DENIED,
|
2018-01-19 00:53:58 +00:00
|
|
|
)
|
2018-01-19 00:19:58 +00:00
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
existing_user_id = yield self.hs.get_datastore().get_user_id_by_threepid(
|
2019-06-20 09:32:02 +00:00
|
|
|
"msisdn", msisdn
|
2017-03-13 17:27:51 +00:00
|
|
|
)
|
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
if existing_user_id is not None:
|
2017-03-13 17:27:51 +00:00
|
|
|
raise SynapseError(
|
|
|
|
400, "Phone number is already in use", Codes.THREEPID_IN_USE
|
|
|
|
)
|
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
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, "Registration by phone number is not supported on this homeserver"
|
|
|
|
)
|
|
|
|
|
|
|
|
ret = yield self.identity_handler.requestMsisdnToken(
|
|
|
|
self.hs.config.account_threepid_delegate_msisdn,
|
|
|
|
country,
|
|
|
|
phone_number,
|
|
|
|
client_secret,
|
|
|
|
send_attempt,
|
|
|
|
next_link,
|
|
|
|
)
|
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, ret
|
2017-03-13 17:27:51 +00:00
|
|
|
|
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
class RegistrationSubmitTokenServlet(RestServlet):
|
|
|
|
"""Handles registration 3PID validation token submission"""
|
|
|
|
|
|
|
|
PATTERNS = client_patterns(
|
|
|
|
"/registration/(?P<medium>[^/]*)/submit_token$", releases=(), unstable=True
|
|
|
|
)
|
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer): server
|
|
|
|
"""
|
|
|
|
super(RegistrationSubmitTokenServlet, self).__init__()
|
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
|
|
|
self.config = hs.config
|
|
|
|
self.clock = hs.get_clock()
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
|
2019-09-20 14:21:30 +00:00
|
|
|
if self.config.threepid_behaviour_email == ThreepidBehaviour.LOCAL:
|
|
|
|
self.failure_email_template, = load_jinja2_templates(
|
|
|
|
self.config.email_template_dir,
|
|
|
|
[self.config.email_registration_template_failure_html],
|
|
|
|
)
|
|
|
|
|
2019-09-23 15:50:27 +00:00
|
|
|
if self.config.threepid_behaviour_email == ThreepidBehaviour.LOCAL:
|
|
|
|
self.failure_email_template, = load_jinja2_templates(
|
|
|
|
self.config.email_template_dir,
|
|
|
|
[self.config.email_registration_template_failure_html],
|
|
|
|
)
|
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request, medium):
|
|
|
|
if medium != "email":
|
|
|
|
raise SynapseError(
|
|
|
|
400, "This medium is currently not supported for registration"
|
|
|
|
)
|
|
|
|
if self.config.threepid_behaviour_email == ThreepidBehaviour.OFF:
|
|
|
|
if self.config.local_threepid_handling_disabled_due_to_email_config:
|
|
|
|
logger.warn(
|
|
|
|
"User registration via email has been disabled due to lack of email config"
|
|
|
|
)
|
|
|
|
raise SynapseError(
|
|
|
|
400, "Email-based registration is 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_registration_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}
|
2019-09-20 14:21:30 +00:00
|
|
|
html = self.failure_email_template.render(**template_vars)
|
2019-09-06 10:35:28 +00:00
|
|
|
|
|
|
|
request.write(html.encode("utf-8"))
|
|
|
|
finish_request(request)
|
|
|
|
|
|
|
|
|
2017-05-03 10:55:44 +00:00
|
|
|
class UsernameAvailabilityRestServlet(RestServlet):
|
2019-06-03 11:28:59 +00:00
|
|
|
PATTERNS = client_patterns("/register/available")
|
2017-05-03 10:55:44 +00:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer): server
|
|
|
|
"""
|
|
|
|
super(UsernameAvailabilityRestServlet, self).__init__()
|
|
|
|
self.hs = hs
|
2019-02-20 07:47:31 +00:00
|
|
|
self.registration_handler = hs.get_registration_handler()
|
2017-05-03 10:55:44 +00:00
|
|
|
self.ratelimiter = FederationRateLimiter(
|
|
|
|
hs.get_clock(),
|
2019-05-15 17:06:04 +00:00
|
|
|
FederationRateLimitConfig(
|
|
|
|
# Time window of 2s
|
|
|
|
window_size=2000,
|
|
|
|
# Artificially delay requests if rate > sleep_limit/window_size
|
|
|
|
sleep_limit=1,
|
|
|
|
# Amount of artificial delay to apply
|
|
|
|
sleep_msec=1000,
|
|
|
|
# Error with 429 if more than reject_limit requests are queued
|
|
|
|
reject_limit=1,
|
|
|
|
# Allow 1 request at a time
|
|
|
|
concurrent_requests=1,
|
2019-06-20 09:32:02 +00:00
|
|
|
),
|
2017-05-03 10:55:44 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2017-05-10 16:17:12 +00:00
|
|
|
def on_GET(self, request):
|
2019-09-23 14:38:38 +00:00
|
|
|
if not self.hs.config.enable_registration:
|
|
|
|
raise SynapseError(
|
|
|
|
403, "Registration has been disabled", errcode=Codes.FORBIDDEN
|
|
|
|
)
|
|
|
|
|
2017-05-03 10:55:44 +00:00
|
|
|
ip = self.hs.get_ip_from_request(request)
|
|
|
|
with self.ratelimiter.ratelimit(ip) as wait_deferred:
|
|
|
|
yield wait_deferred
|
|
|
|
|
2017-05-10 16:17:12 +00:00
|
|
|
username = parse_string(request, "username", required=True)
|
2017-05-03 10:55:44 +00:00
|
|
|
|
2017-05-10 16:17:12 +00:00
|
|
|
yield self.registration_handler.check_username(username)
|
2017-05-03 10:55:44 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, {"available": True}
|
2017-05-03 10:55:44 +00:00
|
|
|
|
|
|
|
|
2015-03-30 17:13:10 +00:00
|
|
|
class RegisterRestServlet(RestServlet):
|
2019-06-03 11:28:59 +00:00
|
|
|
PATTERNS = client_patterns("/register$")
|
2015-03-30 17:13:10 +00:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2016-07-19 09:21:42 +00:00
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer): server
|
|
|
|
"""
|
2015-03-30 17:13:10 +00:00
|
|
|
super(RegisterRestServlet, self).__init__()
|
2016-07-19 09:21:42 +00:00
|
|
|
|
2015-03-30 17:13:10 +00:00
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
2016-04-29 10:43:57 +00:00
|
|
|
self.store = hs.get_datastore()
|
2016-06-02 12:31:45 +00:00
|
|
|
self.auth_handler = hs.get_auth_handler()
|
2019-02-20 07:47:31 +00:00
|
|
|
self.registration_handler = hs.get_registration_handler()
|
2015-04-16 18:56:44 +00:00
|
|
|
self.identity_handler = hs.get_handlers().identity_handler
|
2018-03-01 10:54:37 +00:00
|
|
|
self.room_member_handler = hs.get_room_member_handler()
|
2017-02-02 10:53:36 +00:00
|
|
|
self.macaroon_gen = hs.get_macaroon_generator()
|
2019-03-06 11:02:42 +00:00
|
|
|
self.ratelimiter = hs.get_registration_ratelimiter()
|
2019-03-05 14:25:33 +00:00
|
|
|
self.clock = hs.get_clock()
|
2015-03-30 17:13:10 +00:00
|
|
|
|
2019-09-25 10:32:05 +00:00
|
|
|
self._registration_flows = _calculate_registration_flows(hs.config)
|
|
|
|
|
2017-12-04 15:47:27 +00:00
|
|
|
@interactive_auth_handler
|
2015-03-30 17:13:10 +00:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request):
|
2016-11-25 15:25:30 +00:00
|
|
|
body = parse_json_object_from_request(request)
|
|
|
|
|
2019-03-05 14:25:33 +00:00
|
|
|
client_addr = request.getClientIP()
|
|
|
|
|
|
|
|
time_now = self.clock.time()
|
|
|
|
|
|
|
|
allowed, time_allowed = self.ratelimiter.can_do_action(
|
2019-06-20 09:32:02 +00:00
|
|
|
client_addr,
|
|
|
|
time_now_s=time_now,
|
2019-03-15 17:46:16 +00:00
|
|
|
rate_hz=self.hs.config.rc_registration.per_second,
|
|
|
|
burst_count=self.hs.config.rc_registration.burst_count,
|
2019-03-05 14:25:33 +00:00
|
|
|
update=False,
|
|
|
|
)
|
|
|
|
|
|
|
|
if not allowed:
|
|
|
|
raise LimitExceededError(
|
2019-06-20 09:32:02 +00:00
|
|
|
retry_after_ms=int(1000 * (time_allowed - time_now))
|
2019-03-05 14:25:33 +00:00
|
|
|
)
|
|
|
|
|
2018-08-01 14:54:06 +00:00
|
|
|
kind = b"user"
|
|
|
|
if b"kind" in request.args:
|
|
|
|
kind = request.args[b"kind"][0]
|
2015-11-04 17:29:07 +00:00
|
|
|
|
2018-08-01 14:54:06 +00:00
|
|
|
if kind == b"guest":
|
2019-03-05 14:25:33 +00:00
|
|
|
ret = yield self._do_guest_registration(body, address=client_addr)
|
2019-07-23 13:00:55 +00:00
|
|
|
return ret
|
2018-08-01 14:54:06 +00:00
|
|
|
elif kind != b"user":
|
2015-11-04 17:29:07 +00:00
|
|
|
raise UnrecognizedRequestError(
|
|
|
|
"Do not understand membership kind: %s" % (kind,)
|
|
|
|
)
|
|
|
|
|
2015-07-28 16:34:12 +00:00
|
|
|
# we do basic sanity checks here because the auth layer will store these
|
|
|
|
# in sessions. Pull out the username/password provided to us.
|
2019-06-20 09:32:02 +00:00
|
|
|
if "password" in body:
|
|
|
|
if (
|
|
|
|
not isinstance(body["password"], string_types)
|
|
|
|
or len(body["password"]) > 512
|
|
|
|
):
|
2015-07-15 18:28:03 +00:00
|
|
|
raise SynapseError(400, "Invalid password")
|
2015-04-16 18:56:44 +00:00
|
|
|
|
2015-07-28 16:34:12 +00:00
|
|
|
desired_username = None
|
2019-06-20 09:32:02 +00:00
|
|
|
if "username" in body:
|
|
|
|
if (
|
|
|
|
not isinstance(body["username"], string_types)
|
|
|
|
or len(body["username"]) > 512
|
|
|
|
):
|
2015-07-15 18:28:03 +00:00
|
|
|
raise SynapseError(400, "Invalid username")
|
2019-06-20 09:32:02 +00:00
|
|
|
desired_username = body["username"]
|
2015-03-30 17:13:10 +00:00
|
|
|
|
2015-07-28 16:34:12 +00:00
|
|
|
appservice = None
|
2018-07-13 21:34:49 +00:00
|
|
|
if self.auth.has_access_token(request):
|
2015-07-28 16:34:12 +00:00
|
|
|
appservice = yield self.auth.get_appservice_by_req(request)
|
|
|
|
|
2019-07-23 09:55:18 +00:00
|
|
|
# fork off as soon as possible for ASes which have completely
|
|
|
|
# different registration flows to normal users
|
2015-07-28 16:34:12 +00:00
|
|
|
|
|
|
|
# == Application Service Registration ==
|
|
|
|
if appservice:
|
2016-04-14 13:52:26 +00:00
|
|
|
# Set the desired user according to the AS API (which uses the
|
|
|
|
# 'user' key not 'username'). Since this is a new addition, we'll
|
|
|
|
# fallback to 'username' if they gave one.
|
2016-07-16 17:37:34 +00:00
|
|
|
desired_username = body.get("user", desired_username)
|
2017-11-09 22:20:01 +00:00
|
|
|
|
2017-11-10 12:39:45 +00:00
|
|
|
# XXX we should check that desired_username is valid. Currently
|
|
|
|
# we give appservices carte blanche for any insanity in mxids,
|
|
|
|
# because the IRC bridges rely on being able to register stupid
|
|
|
|
# IDs.
|
2017-11-09 22:20:01 +00:00
|
|
|
|
2018-07-13 21:34:49 +00:00
|
|
|
access_token = self.auth.get_access_token_from_request(request)
|
2016-07-16 14:40:21 +00:00
|
|
|
|
2018-04-28 21:53:07 +00:00
|
|
|
if isinstance(desired_username, string_types):
|
2016-07-16 14:40:21 +00:00
|
|
|
result = yield self._do_appservice_registration(
|
2016-09-09 15:29:10 +00:00
|
|
|
desired_username, access_token, body
|
2016-07-16 14:40:21 +00:00
|
|
|
)
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, result # we throw for non 200 responses
|
2015-07-28 16:34:12 +00:00
|
|
|
|
2019-07-23 09:55:18 +00:00
|
|
|
# for regular registration, downcase the provided username before
|
|
|
|
# attempting to register it. This should mean
|
2017-11-10 12:39:05 +00:00
|
|
|
# that people who try to register with upper-case in their usernames
|
|
|
|
# don't get a nasty surprise. (Note that we treat username
|
|
|
|
# case-insenstively in login, so they are free to carry on imagining
|
|
|
|
# that their username is CrAzYh4cKeR if that keeps them happy)
|
|
|
|
if desired_username is not None:
|
|
|
|
desired_username = desired_username.lower()
|
|
|
|
|
2015-07-28 16:34:12 +00:00
|
|
|
# == Normal User Registration == (everyone else)
|
2016-02-03 14:42:01 +00:00
|
|
|
if not self.hs.config.enable_registration:
|
2015-07-28 16:34:12 +00:00
|
|
|
raise SynapseError(403, "Registration has been disabled")
|
|
|
|
|
2016-01-05 18:01:18 +00:00
|
|
|
guest_access_token = body.get("guest_access_token", None)
|
|
|
|
|
2019-06-20 09:32:02 +00:00
|
|
|
if "initial_device_display_name" in body and "password" not in body:
|
2016-11-18 17:07:35 +00:00
|
|
|
# ignore 'initial_device_display_name' if sent without
|
|
|
|
# a password to work around a client bug where it sent
|
|
|
|
# the 'initial_device_display_name' param alone, wiping out
|
|
|
|
# the original registration params
|
|
|
|
logger.warn("Ignoring initial_device_display_name without password")
|
2019-06-20 09:32:02 +00:00
|
|
|
del body["initial_device_display_name"]
|
2016-11-18 17:07:35 +00:00
|
|
|
|
2016-03-16 19:36:57 +00:00
|
|
|
session_id = self.auth_handler.get_session_id(body)
|
|
|
|
registered_user_id = None
|
|
|
|
if session_id:
|
|
|
|
# if we get a registered user id out of here, it means we previously
|
|
|
|
# registered a user for this session, so we could just return the
|
|
|
|
# user here. We carry on and go through the auth checks though,
|
|
|
|
# for paranoia.
|
|
|
|
registered_user_id = self.auth_handler.get_session_data(
|
|
|
|
session_id, "registered_user_id", None
|
|
|
|
)
|
|
|
|
|
2015-08-03 16:03:27 +00:00
|
|
|
if desired_username is not None:
|
2016-01-05 18:01:18 +00:00
|
|
|
yield self.registration_handler.check_username(
|
2017-11-10 12:39:05 +00:00
|
|
|
desired_username,
|
2016-03-16 19:36:57 +00:00
|
|
|
guest_access_token=guest_access_token,
|
|
|
|
assigned_user_id=registered_user_id,
|
2016-01-05 18:01:18 +00:00
|
|
|
)
|
2015-04-02 16:51:19 +00:00
|
|
|
|
2017-12-04 15:47:27 +00:00
|
|
|
auth_result, params, session_id = yield self.auth_handler.check_auth(
|
2019-09-25 10:32:05 +00:00
|
|
|
self._registration_flows, body, self.hs.get_ip_from_request(request)
|
2015-03-30 17:13:10 +00:00
|
|
|
)
|
|
|
|
|
2018-01-19 15:33:55 +00:00
|
|
|
# Check that we're not trying to register a denied 3pid.
|
|
|
|
#
|
|
|
|
# the user-facing checks will probably already have happened in
|
|
|
|
# /register/email/requestToken when we requested a 3pid, but that's not
|
|
|
|
# guaranteed.
|
|
|
|
|
2018-01-19 18:23:56 +00:00
|
|
|
if auth_result:
|
2018-01-19 19:55:33 +00:00
|
|
|
for login_type in [LoginType.EMAIL_IDENTITY, LoginType.MSISDN]:
|
2018-01-19 18:23:56 +00:00
|
|
|
if login_type in auth_result:
|
2019-06-20 09:32:02 +00:00
|
|
|
medium = auth_result[login_type]["medium"]
|
|
|
|
address = auth_result[login_type]["address"]
|
2018-01-19 18:23:56 +00:00
|
|
|
|
|
|
|
if not check_3pid_allowed(self.hs, medium, address):
|
|
|
|
raise SynapseError(
|
2018-09-04 11:03:17 +00:00
|
|
|
403,
|
2019-06-20 09:32:02 +00:00
|
|
|
"Third party identifiers (email/phone numbers)"
|
|
|
|
+ " are not authorized on this server",
|
2018-01-19 18:23:56 +00:00
|
|
|
Codes.THREEPID_DENIED,
|
|
|
|
)
|
2018-01-19 00:19:58 +00:00
|
|
|
|
2016-03-16 11:56:24 +00:00
|
|
|
if registered_user_id is not None:
|
|
|
|
logger.info(
|
2019-06-20 09:32:02 +00:00
|
|
|
"Already registered user ID %r for this session", registered_user_id
|
2016-03-16 11:56:24 +00:00
|
|
|
)
|
2017-03-13 17:27:51 +00:00
|
|
|
# don't re-register the threepids
|
2019-02-20 07:47:31 +00:00
|
|
|
registered = False
|
2016-07-19 12:12:22 +00:00
|
|
|
else:
|
|
|
|
# NB: This may be from the auth handler and NOT from the POST
|
2018-07-13 19:53:01 +00:00
|
|
|
assert_params_in_dict(params, ["password"])
|
2016-07-19 12:12:22 +00:00
|
|
|
|
|
|
|
desired_username = params.get("username", None)
|
|
|
|
guest_access_token = params.get("guest_access_token", None)
|
2018-08-01 14:54:06 +00:00
|
|
|
new_password = params.get("password", None)
|
2016-07-19 12:12:22 +00:00
|
|
|
|
2017-11-09 22:20:01 +00:00
|
|
|
if desired_username is not None:
|
|
|
|
desired_username = desired_username.lower()
|
|
|
|
|
2018-08-31 09:49:14 +00:00
|
|
|
threepid = None
|
|
|
|
if auth_result:
|
|
|
|
threepid = auth_result.get(LoginType.EMAIL_IDENTITY)
|
|
|
|
|
2019-05-14 18:04:59 +00:00
|
|
|
# Also check that we're not trying to register a 3pid that's already
|
|
|
|
# been registered.
|
|
|
|
#
|
|
|
|
# This has probably happened in /register/email/requestToken as well,
|
|
|
|
# but if a user hits this endpoint twice then clicks on each link from
|
|
|
|
# the two activation emails, they would register the same 3pid twice.
|
|
|
|
for login_type in [LoginType.EMAIL_IDENTITY, LoginType.MSISDN]:
|
|
|
|
if login_type in auth_result:
|
2019-06-20 09:32:02 +00:00
|
|
|
medium = auth_result[login_type]["medium"]
|
|
|
|
address = auth_result[login_type]["address"]
|
2019-05-14 18:04:59 +00:00
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
existing_user_id = yield self.store.get_user_id_by_threepid(
|
2019-06-20 09:32:02 +00:00
|
|
|
medium, address
|
2019-05-14 18:04:59 +00:00
|
|
|
)
|
|
|
|
|
2019-09-06 10:35:28 +00:00
|
|
|
if existing_user_id is not None:
|
2019-05-14 18:04:59 +00:00
|
|
|
raise SynapseError(
|
|
|
|
400,
|
|
|
|
"%s is already in use" % medium,
|
|
|
|
Codes.THREEPID_IN_USE,
|
|
|
|
)
|
|
|
|
|
2019-07-08 18:01:08 +00:00
|
|
|
registered_user_id = yield self.registration_handler.register_user(
|
2016-07-19 12:12:22 +00:00
|
|
|
localpart=desired_username,
|
|
|
|
password=new_password,
|
|
|
|
guest_access_token=guest_access_token,
|
2018-08-31 09:49:14 +00:00
|
|
|
threepid=threepid,
|
2019-03-05 14:25:33 +00:00
|
|
|
address=client_addr,
|
2016-03-16 12:51:34 +00:00
|
|
|
)
|
2018-08-31 14:42:51 +00:00
|
|
|
# Necessary due to auth checks prior to the threepid being
|
|
|
|
# written to the db
|
2019-01-22 17:47:00 +00:00
|
|
|
if threepid:
|
|
|
|
if is_threepid_reserved(
|
|
|
|
self.hs.config.mau_limits_reserved_threepids, threepid
|
|
|
|
):
|
|
|
|
yield self.store.upsert_monthly_active_user(registered_user_id)
|
2016-03-16 11:56:24 +00:00
|
|
|
|
2016-07-19 12:12:22 +00:00
|
|
|
# remember that we've now registered that user account, and with
|
|
|
|
# what user ID (since the user may not have specified)
|
|
|
|
self.auth_handler.set_session_data(
|
|
|
|
session_id, "registered_user_id", registered_user_id
|
|
|
|
)
|
2015-07-28 16:34:12 +00:00
|
|
|
|
2019-02-20 07:47:31 +00:00
|
|
|
registered = True
|
2015-03-30 17:13:10 +00:00
|
|
|
|
2016-07-29 14:25:24 +00:00
|
|
|
return_dict = yield self._create_registration_details(
|
2016-07-21 10:34:16 +00:00
|
|
|
registered_user_id, params
|
2015-03-30 17:13:10 +00:00
|
|
|
)
|
2015-04-16 18:56:44 +00:00
|
|
|
|
2019-02-20 07:47:31 +00:00
|
|
|
if registered:
|
|
|
|
yield self.registration_handler.post_registration_actions(
|
|
|
|
user_id=registered_user_id,
|
|
|
|
auth_result=auth_result,
|
|
|
|
access_token=return_dict.get("access_token"),
|
2016-07-19 14:50:01 +00:00
|
|
|
)
|
2015-04-16 18:56:44 +00:00
|
|
|
|
2019-08-30 15:28:26 +00:00
|
|
|
return 200, return_dict
|
2015-03-30 17:13:10 +00:00
|
|
|
|
|
|
|
def on_OPTIONS(self, _):
|
|
|
|
return 200, {}
|
|
|
|
|
2015-07-28 16:34:12 +00:00
|
|
|
@defer.inlineCallbacks
|
2016-07-19 17:38:26 +00:00
|
|
|
def _do_appservice_registration(self, username, as_token, body):
|
2016-07-19 17:46:19 +00:00
|
|
|
user_id = yield self.registration_handler.appservice_register(
|
2015-07-29 09:00:54 +00:00
|
|
|
username, as_token
|
2015-07-28 16:34:12 +00:00
|
|
|
)
|
2019-07-23 13:00:55 +00:00
|
|
|
return (yield self._create_registration_details(user_id, body))
|
2015-07-28 16:34:12 +00:00
|
|
|
|
2016-03-09 23:08:37 +00:00
|
|
|
@defer.inlineCallbacks
|
2016-07-21 10:34:16 +00:00
|
|
|
def _create_registration_details(self, user_id, params):
|
2016-07-19 17:46:19 +00:00
|
|
|
"""Complete registration of newly-registered user
|
|
|
|
|
2016-12-01 11:42:17 +00:00
|
|
|
Allocates device_id if one was not given; also creates access_token.
|
2016-07-19 17:46:19 +00:00
|
|
|
|
|
|
|
Args:
|
|
|
|
(str) user_id: full canonical @user:id
|
2016-07-21 10:34:16 +00:00
|
|
|
(object) params: registration parameters, from which we pull
|
2017-11-02 16:31:07 +00:00
|
|
|
device_id, initial_device_name and inhibit_login
|
2016-07-19 17:46:19 +00:00
|
|
|
Returns:
|
|
|
|
defer.Deferred: (object) dictionary for response from /register
|
|
|
|
"""
|
2019-06-20 09:32:02 +00:00
|
|
|
result = {"user_id": user_id, "home_server": self.hs.hostname}
|
2017-11-02 16:31:07 +00:00
|
|
|
if not params.get("inhibit_login", False):
|
2019-02-18 12:12:57 +00:00
|
|
|
device_id = params.get("device_id")
|
|
|
|
initial_display_name = params.get("initial_device_display_name")
|
2019-02-18 16:49:38 +00:00
|
|
|
device_id, access_token = yield self.registration_handler.register_device(
|
2019-06-20 09:32:02 +00:00
|
|
|
user_id, device_id, initial_display_name, is_guest=False
|
2016-07-22 13:52:53 +00:00
|
|
|
)
|
2016-07-19 17:46:19 +00:00
|
|
|
|
2019-06-20 09:32:02 +00:00
|
|
|
result.update({"access_token": access_token, "device_id": device_id})
|
2019-07-23 13:00:55 +00:00
|
|
|
return result
|
2015-07-28 16:34:12 +00:00
|
|
|
|
2015-11-04 17:29:07 +00:00
|
|
|
@defer.inlineCallbacks
|
2019-03-05 14:25:33 +00:00
|
|
|
def _do_guest_registration(self, params, address=None):
|
2015-11-04 17:29:07 +00:00
|
|
|
if not self.hs.config.allow_guest_access:
|
2018-07-17 10:43:18 +00:00
|
|
|
raise SynapseError(403, "Guest access is disabled")
|
2019-07-08 18:01:08 +00:00
|
|
|
user_id = yield self.registration_handler.register_user(
|
|
|
|
make_guest=True, address=address
|
2016-01-06 11:38:09 +00:00
|
|
|
)
|
2016-11-25 15:25:30 +00:00
|
|
|
|
|
|
|
# we don't allow guests to specify their own device_id, because
|
|
|
|
# we have nowhere to store it.
|
|
|
|
device_id = synapse.api.auth.GUEST_DEVICE_ID
|
|
|
|
initial_display_name = params.get("initial_device_display_name")
|
2019-02-18 16:49:38 +00:00
|
|
|
device_id, access_token = yield self.registration_handler.register_device(
|
2019-06-20 09:32:02 +00:00
|
|
|
user_id, device_id, initial_display_name, is_guest=True
|
2016-11-25 15:25:30 +00:00
|
|
|
)
|
|
|
|
|
2019-07-23 13:00:55 +00:00
|
|
|
return (
|
|
|
|
200,
|
|
|
|
{
|
|
|
|
"user_id": user_id,
|
|
|
|
"device_id": device_id,
|
|
|
|
"access_token": access_token,
|
|
|
|
"home_server": self.hs.hostname,
|
|
|
|
},
|
2019-06-20 09:32:02 +00:00
|
|
|
)
|
2015-11-04 17:29:07 +00:00
|
|
|
|
2015-03-30 17:13:10 +00:00
|
|
|
|
2019-09-25 10:32:05 +00:00
|
|
|
def _calculate_registration_flows(
|
|
|
|
# technically `config` has to provide *all* of these interfaces, not just one
|
|
|
|
config: Union[RegistrationConfig, ConsentConfig, CaptchaConfig],
|
|
|
|
) -> List[List[str]]:
|
|
|
|
"""Get a suitable flows list for registration
|
|
|
|
|
|
|
|
Args:
|
|
|
|
config: server configuration
|
|
|
|
|
|
|
|
Returns: a list of supported flows
|
|
|
|
"""
|
|
|
|
# FIXME: need a better error than "no auth flow found" for scenarios
|
|
|
|
# where we required 3PID for registration but the user didn't give one
|
|
|
|
require_email = "email" in config.registrations_require_3pid
|
|
|
|
require_msisdn = "msisdn" in config.registrations_require_3pid
|
|
|
|
|
|
|
|
show_msisdn = True
|
|
|
|
if config.disable_msisdn_registration:
|
|
|
|
show_msisdn = False
|
|
|
|
require_msisdn = False
|
|
|
|
|
|
|
|
flows = []
|
|
|
|
|
|
|
|
# only support 3PIDless registration if no 3PIDs are required
|
|
|
|
if not require_email and not require_msisdn:
|
|
|
|
# Add a dummy step here, otherwise if a client completes
|
|
|
|
# recaptcha first we'll assume they were going for this flow
|
|
|
|
# and complete the request, when they could have been trying to
|
|
|
|
# complete one of the flows with email/msisdn auth.
|
|
|
|
flows.append([LoginType.DUMMY])
|
|
|
|
|
|
|
|
# only support the email-only flow if we don't require MSISDN 3PIDs
|
|
|
|
if not require_msisdn:
|
|
|
|
flows.append([LoginType.EMAIL_IDENTITY])
|
|
|
|
|
|
|
|
# only support the MSISDN-only flow if we don't require email 3PIDs
|
|
|
|
if show_msisdn and not require_email:
|
|
|
|
flows.append([LoginType.MSISDN])
|
|
|
|
|
|
|
|
if show_msisdn:
|
|
|
|
flows.append([LoginType.MSISDN, LoginType.EMAIL_IDENTITY])
|
|
|
|
|
|
|
|
# Prepend m.login.terms to all flows if we're requiring consent
|
|
|
|
if config.user_consent_at_registration:
|
|
|
|
for flow in flows:
|
|
|
|
flow.insert(0, LoginType.TERMS)
|
|
|
|
|
|
|
|
# Prepend recaptcha to all flows if we're requiring captcha
|
|
|
|
if config.enable_registration_captcha:
|
|
|
|
for flow in flows:
|
|
|
|
flow.insert(0, LoginType.RECAPTCHA)
|
|
|
|
|
|
|
|
return flows
|
|
|
|
|
|
|
|
|
2015-03-30 17:13:10 +00:00
|
|
|
def register_servlets(hs, http_server):
|
2017-03-13 17:27:51 +00:00
|
|
|
EmailRegisterRequestTokenRestServlet(hs).register(http_server)
|
|
|
|
MsisdnRegisterRequestTokenRestServlet(hs).register(http_server)
|
2017-05-03 10:55:44 +00:00
|
|
|
UsernameAvailabilityRestServlet(hs).register(http_server)
|
2019-09-06 10:35:28 +00:00
|
|
|
RegistrationSubmitTokenServlet(hs).register(http_server)
|
2015-03-31 08:50:44 +00:00
|
|
|
RegisterRestServlet(hs).register(http_server)
|