2015-03-30 13:13:10 -04:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-05 13:01:18 -05:00
|
|
|
# Copyright 2015 - 2016 OpenMarket Ltd
|
2017-03-13 13:27:51 -04:00
|
|
|
# Copyright 2017 Vector Creations Ltd
|
2015-03-30 13:13:10 -04: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 02:09:20 -04:00
|
|
|
import hmac
|
|
|
|
import logging
|
2020-08-24 06:33:55 -04:00
|
|
|
import random
|
2019-09-25 06:32:05 -04:00
|
|
|
from typing import List, Union
|
2018-07-09 02:09:20 -04:00
|
|
|
|
2016-11-25 10:25:30 -05:00
|
|
|
import synapse
|
2020-01-20 12:38:21 -05:00
|
|
|
import synapse.api.auth
|
2017-10-16 12:57:27 -04:00
|
|
|
import synapse.types
|
2015-03-30 13:13:10 -04:00
|
|
|
from synapse.api.constants import LoginType
|
2019-03-05 09:25:33 -05:00
|
|
|
from synapse.api.errors import (
|
|
|
|
Codes,
|
2020-08-06 08:09:55 -04:00
|
|
|
InteractiveAuthIncompleteError,
|
2019-03-05 09:25:33 -05:00
|
|
|
SynapseError,
|
2019-09-06 06:35:28 -04:00
|
|
|
ThreepidValidationError,
|
2019-03-05 09:25:33 -05:00
|
|
|
UnrecognizedRequestError,
|
|
|
|
)
|
2019-09-25 07:10:26 -04:00
|
|
|
from synapse.config import ConfigError
|
2019-09-25 06:32:05 -04:00
|
|
|
from synapse.config.captcha import CaptchaConfig
|
|
|
|
from synapse.config.consent_config import ConsentConfig
|
2019-09-06 06:35:28 -04:00
|
|
|
from synapse.config.emailconfig import ThreepidBehaviour
|
2019-05-15 13:06:04 -04:00
|
|
|
from synapse.config.ratelimiting import FederationRateLimitConfig
|
2019-09-25 06:32:05 -04:00
|
|
|
from synapse.config.registration import RegistrationConfig
|
2018-08-31 12:11:11 -04:00
|
|
|
from synapse.config.server import is_threepid_reserved
|
2019-09-25 07:10:26 -04:00
|
|
|
from synapse.handlers.auth import AuthHandler
|
2021-01-12 12:38:03 -05:00
|
|
|
from synapse.handlers.ui_auth import UIAuthSessionDataConstants
|
2020-07-01 09:10:23 -04:00
|
|
|
from synapse.http.server import finish_request, respond_with_html
|
2017-03-13 13:27:51 -04:00
|
|
|
from synapse.http.servlet import (
|
2018-07-09 02:09:20 -04:00
|
|
|
RestServlet,
|
2018-07-13 15:53:01 -04:00
|
|
|
assert_params_in_dict,
|
2018-07-09 02:09:20 -04:00
|
|
|
parse_json_object_from_request,
|
|
|
|
parse_string,
|
2017-03-13 13:27:51 -04:00
|
|
|
)
|
2020-11-13 07:03:51 -05:00
|
|
|
from synapse.metrics import threepid_send_requests
|
2020-08-17 12:05:00 -04:00
|
|
|
from synapse.push.mailer import Mailer
|
2017-03-13 13:27:51 -04:00
|
|
|
from synapse.util.msisdn import phone_number_to_msisdn
|
2018-07-09 02:09:20 -04:00
|
|
|
from synapse.util.ratelimitutils import FederationRateLimiter
|
2020-04-23 05:23:53 -04:00
|
|
|
from synapse.util.stringutils import assert_valid_client_secret, random_string
|
2020-07-03 09:03:13 -04:00
|
|
|
from synapse.util.threepids import canonicalise_email, check_3pid_allowed
|
2015-03-30 13:13:10 -04:00
|
|
|
|
2019-06-03 07:28:59 -04:00
|
|
|
from ._base import client_patterns, interactive_auth_handler
|
2015-03-30 13:13:10 -04:00
|
|
|
|
2015-04-02 12:01:29 -04: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 05:32:02 -04:00
|
|
|
|
2016-02-02 12:18:50 -05:00
|
|
|
def compare_digest(a, b):
|
|
|
|
return a == b
|
2015-03-30 13:13:10 -04:00
|
|
|
|
|
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
2017-03-13 13:27:51 -04:00
|
|
|
class EmailRegisterRequestTokenRestServlet(RestServlet):
|
2019-06-03 07:28:59 -04:00
|
|
|
PATTERNS = client_patterns("/register/email/requestToken$")
|
2016-07-11 04:57:07 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2016-07-19 05:21:42 -04:00
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer): server
|
|
|
|
"""
|
2020-09-18 09:56:44 -04:00
|
|
|
super().__init__()
|
2016-07-11 04:57:07 -04:00
|
|
|
self.hs = hs
|
2020-10-09 07:24:34 -04:00
|
|
|
self.identity_handler = hs.get_identity_handler()
|
2019-09-06 06:35:28 -04:00
|
|
|
self.config = hs.config
|
|
|
|
|
|
|
|
if self.hs.config.threepid_behaviour_email == ThreepidBehaviour.LOCAL:
|
|
|
|
self.mailer = Mailer(
|
|
|
|
hs=self.hs,
|
|
|
|
app_name=self.config.email_app_name,
|
2020-08-17 12:05:00 -04:00
|
|
|
template_html=self.config.email_registration_template_html,
|
|
|
|
template_text=self.config.email_registration_template_text,
|
2019-09-06 06:35:28 -04:00
|
|
|
)
|
2016-07-11 04:57:07 -04:00
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
async def on_POST(self, request):
|
2019-09-06 06:35:28 -04:00
|
|
|
if self.hs.config.threepid_behaviour_email == ThreepidBehaviour.OFF:
|
|
|
|
if self.hs.config.local_threepid_handling_disabled_due_to_email_config:
|
2019-10-31 06:23:24 -04:00
|
|
|
logger.warning(
|
2019-09-06 06:35:28 -04:00
|
|
|
"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 04:57:07 -04:00
|
|
|
body = parse_json_object_from_request(request)
|
|
|
|
|
2019-09-06 06:35:28 -04:00
|
|
|
assert_params_in_dict(body, ["client_secret", "email", "send_attempt"])
|
2016-07-11 04:57:07 -04:00
|
|
|
|
2019-09-06 06:35:28 -04:00
|
|
|
# Extract params from body
|
|
|
|
client_secret = body["client_secret"]
|
2020-01-24 09:28:40 -05:00
|
|
|
assert_valid_client_secret(client_secret)
|
|
|
|
|
2020-07-03 09:03:13 -04:00
|
|
|
# For emails, canonicalise the address.
|
|
|
|
# We store all email addresses canonicalised in the DB.
|
|
|
|
# (See on_POST in EmailThreepidRequestTokenRestServlet
|
|
|
|
# in synapse/rest/client/v2_alpha/account.py)
|
|
|
|
try:
|
|
|
|
email = canonicalise_email(body["email"])
|
|
|
|
except ValueError as e:
|
|
|
|
raise SynapseError(400, str(e))
|
2019-09-06 06:35:28 -04:00
|
|
|
send_attempt = body["send_attempt"]
|
|
|
|
next_link = body.get("next_link") # Optional param
|
|
|
|
|
|
|
|
if not check_3pid_allowed(self.hs, "email", email):
|
2018-01-18 19:53:58 -05:00
|
|
|
raise SynapseError(
|
2018-09-04 07:03:17 -04:00
|
|
|
403,
|
|
|
|
"Your email domain is not authorized to register on this server",
|
|
|
|
Codes.THREEPID_DENIED,
|
2018-01-18 19:53:58 -05:00
|
|
|
)
|
2018-01-18 19:19:58 -05:00
|
|
|
|
2021-03-30 07:06:09 -04:00
|
|
|
await self.identity_handler.ratelimit_request_token_requests(
|
|
|
|
request, "email", email
|
|
|
|
)
|
2021-01-28 12:39:21 -05:00
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
existing_user_id = await self.hs.get_datastore().get_user_id_by_threepid(
|
2020-07-03 09:03:13 -04:00
|
|
|
"email", email
|
2016-07-11 04:57:07 -04:00
|
|
|
)
|
|
|
|
|
2019-09-06 06:35:28 -04:00
|
|
|
if existing_user_id is not None:
|
2020-04-23 05:23:53 -04:00
|
|
|
if self.hs.config.request_token_inhibit_3pid_errors:
|
|
|
|
# Make the client think the operation succeeded. See the rationale in the
|
|
|
|
# comments for request_token_inhibit_3pid_errors.
|
2020-08-24 06:33:55 -04:00
|
|
|
# Also wait for some random amount of time between 100ms and 1s to make it
|
|
|
|
# look like we did something.
|
2020-11-30 13:28:44 -05:00
|
|
|
await self.hs.get_clock().sleep(random.randint(1, 10) / 10)
|
2020-04-23 05:23:53 -04:00
|
|
|
return 200, {"sid": random_string(16)}
|
|
|
|
|
2016-07-11 04:57:07 -04:00
|
|
|
raise SynapseError(400, "Email is already in use", Codes.THREEPID_IN_USE)
|
|
|
|
|
2019-09-06 06:35:28 -04:00
|
|
|
if self.config.threepid_behaviour_email == ThreepidBehaviour.REMOTE:
|
2019-09-20 10:21:30 -04:00
|
|
|
assert self.hs.config.account_threepid_delegate_email
|
2019-09-06 06:35:28 -04:00
|
|
|
|
2019-09-20 10:21:30 -04:00
|
|
|
# Have the configured identity server handle the request
|
2019-12-05 11:46:37 -05:00
|
|
|
ret = await self.identity_handler.requestEmailToken(
|
2019-09-06 06:35:28 -04:00
|
|
|
self.hs.config.account_threepid_delegate_email,
|
|
|
|
email,
|
|
|
|
client_secret,
|
|
|
|
send_attempt,
|
|
|
|
next_link,
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
# Send registration emails from Synapse
|
2019-12-05 11:46:37 -05:00
|
|
|
sid = await self.identity_handler.send_threepid_validation(
|
2019-09-06 06:35:28 -04:00
|
|
|
email,
|
|
|
|
client_secret,
|
|
|
|
send_attempt,
|
|
|
|
self.mailer.send_registration_mail,
|
|
|
|
next_link,
|
|
|
|
)
|
|
|
|
|
|
|
|
# Wrap the session id in a JSON object
|
|
|
|
ret = {"sid": sid}
|
|
|
|
|
2020-11-13 07:03:51 -05:00
|
|
|
threepid_send_requests.labels(type="email", reason="register").observe(
|
|
|
|
send_attempt
|
|
|
|
)
|
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, ret
|
2016-07-11 04:57:07 -04:00
|
|
|
|
|
|
|
|
2017-03-13 13:27:51 -04:00
|
|
|
class MsisdnRegisterRequestTokenRestServlet(RestServlet):
|
2019-06-03 07:28:59 -04:00
|
|
|
PATTERNS = client_patterns("/register/msisdn/requestToken$")
|
2017-03-13 13:27:51 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer): server
|
|
|
|
"""
|
2020-09-18 09:56:44 -04:00
|
|
|
super().__init__()
|
2017-03-13 13:27:51 -04:00
|
|
|
self.hs = hs
|
2020-10-09 07:24:34 -04:00
|
|
|
self.identity_handler = hs.get_identity_handler()
|
2017-03-13 13:27:51 -04:00
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
async def on_POST(self, request):
|
2017-03-13 13:27:51 -04:00
|
|
|
body = parse_json_object_from_request(request)
|
|
|
|
|
2018-07-13 15:53:01 -04:00
|
|
|
assert_params_in_dict(
|
2019-09-06 06:35:28 -04:00
|
|
|
body, ["client_secret", "country", "phone_number", "send_attempt"]
|
2017-03-13 13:27:51 -04:00
|
|
|
)
|
2019-09-06 06:35:28 -04:00
|
|
|
client_secret = body["client_secret"]
|
2021-02-08 13:59:54 -05:00
|
|
|
assert_valid_client_secret(client_secret)
|
2019-09-06 06:35:28 -04:00
|
|
|
country = body["country"]
|
|
|
|
phone_number = body["phone_number"]
|
|
|
|
send_attempt = body["send_attempt"]
|
|
|
|
next_link = body.get("next_link") # Optional param
|
2017-03-13 13:27:51 -04:00
|
|
|
|
2019-09-06 06:35:28 -04:00
|
|
|
msisdn = phone_number_to_msisdn(country, phone_number)
|
2017-03-13 13:27:51 -04:00
|
|
|
|
2018-01-18 19:19:58 -05:00
|
|
|
if not check_3pid_allowed(self.hs, "msisdn", msisdn):
|
2018-01-18 19:53:58 -05:00
|
|
|
raise SynapseError(
|
2018-09-04 07:03:17 -04:00
|
|
|
403,
|
|
|
|
"Phone numbers are not authorized to register on this server",
|
|
|
|
Codes.THREEPID_DENIED,
|
2018-01-18 19:53:58 -05:00
|
|
|
)
|
2018-01-18 19:19:58 -05:00
|
|
|
|
2021-03-30 07:06:09 -04:00
|
|
|
await self.identity_handler.ratelimit_request_token_requests(
|
2021-01-28 12:39:21 -05:00
|
|
|
request, "msisdn", msisdn
|
|
|
|
)
|
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
existing_user_id = await self.hs.get_datastore().get_user_id_by_threepid(
|
2017-03-13 13:27:51 -04:00
|
|
|
"msisdn", msisdn
|
|
|
|
)
|
|
|
|
|
2019-09-06 06:35:28 -04:00
|
|
|
if existing_user_id is not None:
|
2020-04-23 05:23:53 -04:00
|
|
|
if self.hs.config.request_token_inhibit_3pid_errors:
|
|
|
|
# Make the client think the operation succeeded. See the rationale in the
|
|
|
|
# comments for request_token_inhibit_3pid_errors.
|
2020-08-24 06:33:55 -04:00
|
|
|
# Also wait for some random amount of time between 100ms and 1s to make it
|
|
|
|
# look like we did something.
|
2020-11-30 13:28:44 -05:00
|
|
|
await self.hs.get_clock().sleep(random.randint(1, 10) / 10)
|
2020-04-23 05:23:53 -04:00
|
|
|
return 200, {"sid": random_string(16)}
|
|
|
|
|
2017-03-13 13:27:51 -04:00
|
|
|
raise SynapseError(
|
|
|
|
400, "Phone number is already in use", Codes.THREEPID_IN_USE
|
|
|
|
)
|
|
|
|
|
2019-09-06 06:35:28 -04:00
|
|
|
if not self.hs.config.account_threepid_delegate_msisdn:
|
2019-10-31 06:23:24 -04:00
|
|
|
logger.warning(
|
2019-09-06 06:35:28 -04:00
|
|
|
"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"
|
|
|
|
)
|
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
ret = await self.identity_handler.requestMsisdnToken(
|
2019-09-06 06:35:28 -04:00
|
|
|
self.hs.config.account_threepid_delegate_msisdn,
|
|
|
|
country,
|
|
|
|
phone_number,
|
|
|
|
client_secret,
|
|
|
|
send_attempt,
|
|
|
|
next_link,
|
|
|
|
)
|
|
|
|
|
2020-11-13 07:03:51 -05:00
|
|
|
threepid_send_requests.labels(type="msisdn", reason="register").observe(
|
|
|
|
send_attempt
|
|
|
|
)
|
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, ret
|
2017-03-13 13:27:51 -04:00
|
|
|
|
|
|
|
|
2019-09-06 06:35:28 -04: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
|
|
|
|
"""
|
2020-09-18 09:56:44 -04:00
|
|
|
super().__init__()
|
2019-09-06 06:35:28 -04:00
|
|
|
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 10:21:30 -04:00
|
|
|
if self.config.threepid_behaviour_email == ThreepidBehaviour.LOCAL:
|
2020-08-17 12:05:00 -04:00
|
|
|
self._failure_email_template = (
|
|
|
|
self.config.email_registration_template_failure_html
|
2019-09-23 11:50:27 -04:00
|
|
|
)
|
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
async def on_GET(self, request, medium):
|
2019-09-06 06:35:28 -04:00
|
|
|
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:
|
2019-10-31 06:23:24 -04:00
|
|
|
logger.warning(
|
2019-09-06 06:35:28 -04:00
|
|
|
"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)
|
2021-02-08 13:59:54 -05:00
|
|
|
assert_valid_client_secret(client_secret)
|
2019-09-06 06:35:28 -04:00
|
|
|
token = parse_string(request, "token", required=True)
|
|
|
|
|
|
|
|
# Attempt to validate a 3PID session
|
|
|
|
try:
|
|
|
|
# Mark the session as valid
|
2019-12-05 11:46:37 -05:00
|
|
|
next_link = await self.store.validate_threepid_session(
|
2019-09-06 06:35:28 -04:00
|
|
|
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:///"):
|
2019-10-31 06:23:24 -04:00
|
|
|
logger.warning(
|
2019-09-06 06:35:28 -04:00
|
|
|
"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
|
2020-07-01 09:10:23 -04:00
|
|
|
status_code = 200
|
2019-09-06 06:35:28 -04:00
|
|
|
except ThreepidValidationError as e:
|
2020-07-01 09:10:23 -04:00
|
|
|
status_code = e.code
|
2019-09-06 06:35:28 -04:00
|
|
|
|
|
|
|
# Show a failure page with a reason
|
|
|
|
template_vars = {"failure_reason": e.msg}
|
2020-08-17 12:05:00 -04:00
|
|
|
html = self._failure_email_template.render(**template_vars)
|
2019-09-06 06:35:28 -04:00
|
|
|
|
2020-07-01 09:10:23 -04:00
|
|
|
respond_with_html(request, status_code, html)
|
2019-09-06 06:35:28 -04:00
|
|
|
|
|
|
|
|
2017-05-03 06:55:44 -04:00
|
|
|
class UsernameAvailabilityRestServlet(RestServlet):
|
2019-06-03 07:28:59 -04:00
|
|
|
PATTERNS = client_patterns("/register/available")
|
2017-05-03 06:55:44 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer): server
|
|
|
|
"""
|
2020-09-18 09:56:44 -04:00
|
|
|
super().__init__()
|
2017-05-03 06:55:44 -04:00
|
|
|
self.hs = hs
|
2019-02-20 02:47:31 -05:00
|
|
|
self.registration_handler = hs.get_registration_handler()
|
2017-05-03 06:55:44 -04:00
|
|
|
self.ratelimiter = FederationRateLimiter(
|
|
|
|
hs.get_clock(),
|
2019-05-15 13:06:04 -04: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,
|
|
|
|
),
|
2017-05-03 06:55:44 -04:00
|
|
|
)
|
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
async def on_GET(self, request):
|
2019-09-23 10:38:38 -04:00
|
|
|
if not self.hs.config.enable_registration:
|
|
|
|
raise SynapseError(
|
|
|
|
403, "Registration has been disabled", errcode=Codes.FORBIDDEN
|
|
|
|
)
|
|
|
|
|
2021-01-12 07:48:12 -05:00
|
|
|
ip = request.getClientIP()
|
2017-05-03 06:55:44 -04:00
|
|
|
with self.ratelimiter.ratelimit(ip) as wait_deferred:
|
2019-12-05 11:46:37 -05:00
|
|
|
await wait_deferred
|
2017-05-03 06:55:44 -04:00
|
|
|
|
2017-05-10 12:17:12 -04:00
|
|
|
username = parse_string(request, "username", required=True)
|
2017-05-03 06:55:44 -04:00
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
await self.registration_handler.check_username(username)
|
2017-05-03 06:55:44 -04:00
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, {"available": True}
|
2017-05-03 06:55:44 -04:00
|
|
|
|
|
|
|
|
2015-03-30 13:13:10 -04:00
|
|
|
class RegisterRestServlet(RestServlet):
|
2019-06-03 07:28:59 -04:00
|
|
|
PATTERNS = client_patterns("/register$")
|
2015-03-30 13:13:10 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2016-07-19 05:21:42 -04:00
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer): server
|
|
|
|
"""
|
2020-09-18 09:56:44 -04:00
|
|
|
super().__init__()
|
2016-07-19 05:21:42 -04:00
|
|
|
|
2015-03-30 13:13:10 -04:00
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
2016-04-29 06:43:57 -04:00
|
|
|
self.store = hs.get_datastore()
|
2016-06-02 08:31:45 -04:00
|
|
|
self.auth_handler = hs.get_auth_handler()
|
2019-02-20 02:47:31 -05:00
|
|
|
self.registration_handler = hs.get_registration_handler()
|
2020-10-09 07:24:34 -04:00
|
|
|
self.identity_handler = hs.get_identity_handler()
|
2018-03-01 05:54:37 -05:00
|
|
|
self.room_member_handler = hs.get_room_member_handler()
|
2017-02-02 05:53:36 -05:00
|
|
|
self.macaroon_gen = hs.get_macaroon_generator()
|
2019-03-06 06:02:42 -05:00
|
|
|
self.ratelimiter = hs.get_registration_ratelimiter()
|
2020-03-26 12:51:13 -04:00
|
|
|
self.password_policy_handler = hs.get_password_policy_handler()
|
2019-03-05 09:25:33 -05:00
|
|
|
self.clock = hs.get_clock()
|
2020-08-06 08:09:55 -04:00
|
|
|
self._registration_enabled = self.hs.config.enable_registration
|
2015-03-30 13:13:10 -04:00
|
|
|
|
2019-09-25 07:10:26 -04:00
|
|
|
self._registration_flows = _calculate_registration_flows(
|
|
|
|
hs.config, self.auth_handler
|
|
|
|
)
|
2019-09-25 06:32:05 -04:00
|
|
|
|
2017-12-04 10:47:27 -05:00
|
|
|
@interactive_auth_handler
|
2019-12-05 11:46:37 -05:00
|
|
|
async def on_POST(self, request):
|
2016-11-25 10:25:30 -05:00
|
|
|
body = parse_json_object_from_request(request)
|
|
|
|
|
2019-03-05 09:25:33 -05:00
|
|
|
client_addr = request.getClientIP()
|
|
|
|
|
2021-03-30 07:06:09 -04:00
|
|
|
await self.ratelimiter.ratelimit(None, client_addr, update=False)
|
2019-03-05 09:25:33 -05:00
|
|
|
|
2018-08-01 10:54:06 -04:00
|
|
|
kind = b"user"
|
|
|
|
if b"kind" in request.args:
|
|
|
|
kind = request.args[b"kind"][0]
|
2015-11-04 12:29:07 -05:00
|
|
|
|
2018-08-01 10:54:06 -04:00
|
|
|
if kind == b"guest":
|
2019-12-05 11:46:37 -05:00
|
|
|
ret = await self._do_guest_registration(body, address=client_addr)
|
2019-07-23 09:00:55 -04:00
|
|
|
return ret
|
2018-08-01 10:54:06 -04:00
|
|
|
elif kind != b"user":
|
2015-11-04 12:29:07 -05:00
|
|
|
raise UnrecognizedRequestError(
|
2020-01-20 12:38:21 -05:00
|
|
|
"Do not understand membership kind: %s" % (kind.decode("utf8"),)
|
2015-11-04 12:29:07 -05:00
|
|
|
)
|
|
|
|
|
2020-08-06 08:09:55 -04:00
|
|
|
# Pull out the provided username and do basic sanity checks early since
|
|
|
|
# the auth layer will store these in sessions.
|
2015-07-28 12:34:12 -04:00
|
|
|
desired_username = None
|
2015-04-16 14:56:44 -04:00
|
|
|
if "username" in body:
|
2020-06-16 08:51:47 -04:00
|
|
|
if not isinstance(body["username"], str) or len(body["username"]) > 512:
|
2015-07-15 14:28:03 -04:00
|
|
|
raise SynapseError(400, "Invalid username")
|
2015-04-16 14:56:44 -04:00
|
|
|
desired_username = body["username"]
|
2015-03-30 13:13:10 -04:00
|
|
|
|
2015-07-28 12:34:12 -04:00
|
|
|
appservice = None
|
2018-07-13 17:34:49 -04:00
|
|
|
if self.auth.has_access_token(request):
|
2020-08-06 08:30:06 -04:00
|
|
|
appservice = self.auth.get_appservice_by_req(request)
|
2015-07-28 12:34:12 -04:00
|
|
|
|
2019-07-23 05:55:18 -04:00
|
|
|
# fork off as soon as possible for ASes which have completely
|
|
|
|
# different registration flows to normal users
|
2015-07-28 12:34:12 -04:00
|
|
|
|
|
|
|
# == Application Service Registration ==
|
|
|
|
if appservice:
|
2016-04-14 09:52:26 -04: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 13:37:34 -04:00
|
|
|
desired_username = body.get("user", desired_username)
|
2017-11-09 17:20:01 -05:00
|
|
|
|
2017-11-10 07:39:45 -05: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 17:20:01 -05:00
|
|
|
|
2018-07-13 17:34:49 -04:00
|
|
|
access_token = self.auth.get_access_token_from_request(request)
|
2016-07-16 10:40:21 -04:00
|
|
|
|
2020-09-17 06:54:56 -04:00
|
|
|
if not isinstance(desired_username, str):
|
|
|
|
raise SynapseError(400, "Desired Username is missing or not a string")
|
|
|
|
|
|
|
|
result = await self._do_appservice_registration(
|
|
|
|
desired_username, access_token, body
|
|
|
|
)
|
|
|
|
|
|
|
|
return 200, result
|
2015-07-28 12:34:12 -04:00
|
|
|
|
|
|
|
# == Normal User Registration == (everyone else)
|
2020-08-06 08:09:55 -04:00
|
|
|
if not self._registration_enabled:
|
2020-12-03 10:41:19 -05:00
|
|
|
raise SynapseError(403, "Registration has been disabled", Codes.FORBIDDEN)
|
2015-07-28 12:34:12 -04:00
|
|
|
|
2020-08-06 08:09:55 -04:00
|
|
|
# For regular registration, convert the provided username to lowercase
|
|
|
|
# before attempting to register it. This should mean that people who try
|
|
|
|
# to register with upper-case in their usernames don't get a nasty surprise.
|
|
|
|
#
|
|
|
|
# Note that we treat usernames case-insensitively 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()
|
|
|
|
|
|
|
|
# Check if this account is upgrading from a guest account.
|
2016-01-05 13:01:18 -05:00
|
|
|
guest_access_token = body.get("guest_access_token", None)
|
|
|
|
|
2020-08-06 08:09:55 -04:00
|
|
|
# Pull out the provided password and do basic sanity checks early.
|
|
|
|
#
|
|
|
|
# Note that we remove the password from the body since the auth layer
|
|
|
|
# will store the body in the session and we don't want a plaintext
|
|
|
|
# password store there.
|
|
|
|
password = body.pop("password", None)
|
|
|
|
if password is not None:
|
|
|
|
if not isinstance(password, str) or len(password) > 512:
|
|
|
|
raise SynapseError(400, "Invalid password")
|
|
|
|
self.password_policy_handler.validate_password(password)
|
|
|
|
|
|
|
|
if "initial_device_display_name" in body and password is None:
|
2016-11-18 12:07:35 -05: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
|
2019-10-31 06:23:24 -04:00
|
|
|
logger.warning("Ignoring initial_device_display_name without password")
|
2016-11-18 12:07:35 -05:00
|
|
|
del body["initial_device_display_name"]
|
|
|
|
|
2016-03-16 15:36:57 -04:00
|
|
|
session_id = self.auth_handler.get_session_id(body)
|
|
|
|
registered_user_id = None
|
2020-08-06 08:09:55 -04:00
|
|
|
password_hash = None
|
2016-03-16 15:36:57 -04:00
|
|
|
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.
|
2020-04-30 13:47:49 -04:00
|
|
|
registered_user_id = await self.auth_handler.get_session_data(
|
2021-01-12 12:38:03 -05:00
|
|
|
session_id, UIAuthSessionDataConstants.REGISTERED_USER_ID, None
|
2016-03-16 15:36:57 -04:00
|
|
|
)
|
2020-08-06 08:09:55 -04:00
|
|
|
# Extract the previously-hashed password from the session.
|
|
|
|
password_hash = await self.auth_handler.get_session_data(
|
2021-01-12 12:38:03 -05:00
|
|
|
session_id, UIAuthSessionDataConstants.PASSWORD_HASH, None
|
2020-08-06 08:09:55 -04:00
|
|
|
)
|
2016-03-16 15:36:57 -04:00
|
|
|
|
2020-08-06 08:09:55 -04:00
|
|
|
# Ensure that the username is valid.
|
2015-08-03 12:03:27 -04:00
|
|
|
if desired_username is not None:
|
2019-12-05 11:46:37 -05:00
|
|
|
await self.registration_handler.check_username(
|
2017-11-10 07:39:05 -05:00
|
|
|
desired_username,
|
2016-03-16 15:36:57 -04:00
|
|
|
guest_access_token=guest_access_token,
|
|
|
|
assigned_user_id=registered_user_id,
|
2016-01-05 13:01:18 -05:00
|
|
|
)
|
2015-04-02 12:51:19 -04:00
|
|
|
|
2020-08-06 08:09:55 -04:00
|
|
|
# Check if the user-interactive authentication flows are complete, if
|
|
|
|
# not this will raise a user-interactive auth error.
|
|
|
|
try:
|
|
|
|
auth_result, params, session_id = await self.auth_handler.check_ui_auth(
|
2021-01-12 07:48:12 -05:00
|
|
|
self._registration_flows,
|
|
|
|
request,
|
|
|
|
body,
|
|
|
|
"register a new account",
|
2020-08-06 08:09:55 -04:00
|
|
|
)
|
|
|
|
except InteractiveAuthIncompleteError as e:
|
|
|
|
# The user needs to provide more steps to complete auth.
|
|
|
|
#
|
|
|
|
# Hash the password and store it with the session since the client
|
|
|
|
# is not required to provide the password again.
|
|
|
|
#
|
|
|
|
# If a password hash was previously stored we will not attempt to
|
|
|
|
# re-hash and store it for efficiency. This assumes the password
|
|
|
|
# does not change throughout the authentication flow, but this
|
|
|
|
# should be fine since the data is meant to be consistent.
|
|
|
|
if not password_hash and password:
|
|
|
|
password_hash = await self.auth_handler.hash(password)
|
|
|
|
await self.auth_handler.set_session_data(
|
2021-01-12 12:38:03 -05:00
|
|
|
e.session_id,
|
|
|
|
UIAuthSessionDataConstants.PASSWORD_HASH,
|
|
|
|
password_hash,
|
2020-08-06 08:09:55 -04:00
|
|
|
)
|
|
|
|
raise
|
2015-03-30 13:13:10 -04:00
|
|
|
|
2018-01-19 10:33:55 -05: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 13:23:56 -05:00
|
|
|
if auth_result:
|
2018-01-19 14:55:33 -05:00
|
|
|
for login_type in [LoginType.EMAIL_IDENTITY, LoginType.MSISDN]:
|
2018-01-19 13:23:56 -05:00
|
|
|
if login_type in auth_result:
|
2018-01-24 05:07:24 -05:00
|
|
|
medium = auth_result[login_type]["medium"]
|
|
|
|
address = auth_result[login_type]["address"]
|
2018-01-19 13:23:56 -05:00
|
|
|
|
|
|
|
if not check_3pid_allowed(self.hs, medium, address):
|
|
|
|
raise SynapseError(
|
2018-09-04 07:03:17 -04:00
|
|
|
403,
|
2018-09-04 07:07:00 -04:00
|
|
|
"Third party identifiers (email/phone numbers)"
|
|
|
|
+ " are not authorized on this server",
|
2018-01-19 13:23:56 -05:00
|
|
|
Codes.THREEPID_DENIED,
|
|
|
|
)
|
2018-01-18 19:19:58 -05:00
|
|
|
|
2016-03-16 07:56:24 -04:00
|
|
|
if registered_user_id is not None:
|
|
|
|
logger.info(
|
|
|
|
"Already registered user ID %r for this session", registered_user_id
|
|
|
|
)
|
2017-03-13 13:27:51 -04:00
|
|
|
# don't re-register the threepids
|
2019-02-20 02:47:31 -05:00
|
|
|
registered = False
|
2016-07-19 08:12:22 -04:00
|
|
|
else:
|
2020-08-06 08:09:55 -04:00
|
|
|
# If we have a password in this request, prefer it. Otherwise, there
|
|
|
|
# might be a password hash from an earlier request.
|
|
|
|
if password:
|
|
|
|
password_hash = await self.auth_handler.hash(password)
|
|
|
|
if not password_hash:
|
|
|
|
raise SynapseError(400, "Missing params: password", Codes.MISSING_PARAM)
|
2016-07-19 08:12:22 -04:00
|
|
|
|
|
|
|
desired_username = params.get("username", None)
|
|
|
|
guest_access_token = params.get("guest_access_token", None)
|
|
|
|
|
2017-11-09 17:20:01 -05:00
|
|
|
if desired_username is not None:
|
|
|
|
desired_username = desired_username.lower()
|
|
|
|
|
2018-08-31 05:49:14 -04:00
|
|
|
threepid = None
|
|
|
|
if auth_result:
|
|
|
|
threepid = auth_result.get(LoginType.EMAIL_IDENTITY)
|
|
|
|
|
2019-05-14 14:04:59 -04: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:
|
|
|
|
medium = auth_result[login_type]["medium"]
|
|
|
|
address = auth_result[login_type]["address"]
|
2020-07-03 09:03:13 -04:00
|
|
|
# For emails, canonicalise the address.
|
|
|
|
# We store all email addresses canonicalised in the DB.
|
|
|
|
# (See on_POST in EmailThreepidRequestTokenRestServlet
|
|
|
|
# in synapse/rest/client/v2_alpha/account.py)
|
|
|
|
if medium == "email":
|
|
|
|
try:
|
|
|
|
address = canonicalise_email(address)
|
|
|
|
except ValueError as e:
|
|
|
|
raise SynapseError(400, str(e))
|
2019-05-14 14:04:59 -04:00
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
existing_user_id = await self.store.get_user_id_by_threepid(
|
2019-05-14 14:04:59 -04:00
|
|
|
medium, address
|
|
|
|
)
|
|
|
|
|
2019-09-06 06:35:28 -04:00
|
|
|
if existing_user_id is not None:
|
2019-05-14 14:04:59 -04:00
|
|
|
raise SynapseError(
|
|
|
|
400,
|
|
|
|
"%s is already in use" % medium,
|
|
|
|
Codes.THREEPID_IN_USE,
|
|
|
|
)
|
|
|
|
|
2020-08-20 15:42:58 -04:00
|
|
|
entries = await self.store.get_user_agents_ips_to_ui_auth_session(
|
|
|
|
session_id
|
|
|
|
)
|
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
registered_user_id = await self.registration_handler.register_user(
|
2016-07-19 08:12:22 -04:00
|
|
|
localpart=desired_username,
|
2020-08-06 08:09:55 -04:00
|
|
|
password_hash=password_hash,
|
2016-07-19 08:12:22 -04:00
|
|
|
guest_access_token=guest_access_token,
|
2018-08-31 05:49:14 -04:00
|
|
|
threepid=threepid,
|
2019-03-05 09:25:33 -05:00
|
|
|
address=client_addr,
|
2020-08-20 15:42:58 -04:00
|
|
|
user_agent_ips=entries,
|
2016-03-16 08:51:34 -04:00
|
|
|
)
|
2018-08-31 10:42:51 -04:00
|
|
|
# Necessary due to auth checks prior to the threepid being
|
|
|
|
# written to the db
|
2019-01-22 12:47:00 -05:00
|
|
|
if threepid:
|
|
|
|
if is_threepid_reserved(
|
|
|
|
self.hs.config.mau_limits_reserved_threepids, threepid
|
|
|
|
):
|
2019-12-05 11:46:37 -05:00
|
|
|
await self.store.upsert_monthly_active_user(registered_user_id)
|
2016-03-16 07:56:24 -04:00
|
|
|
|
2020-08-06 08:09:55 -04:00
|
|
|
# Remember that the user account has been registered (and the user
|
|
|
|
# ID it was registered with, since it might not have been specified).
|
2020-04-30 13:47:49 -04:00
|
|
|
await self.auth_handler.set_session_data(
|
2021-01-12 12:38:03 -05:00
|
|
|
session_id,
|
|
|
|
UIAuthSessionDataConstants.REGISTERED_USER_ID,
|
|
|
|
registered_user_id,
|
2016-07-19 08:12:22 -04:00
|
|
|
)
|
2015-07-28 12:34:12 -04:00
|
|
|
|
2019-02-20 02:47:31 -05:00
|
|
|
registered = True
|
2015-03-30 13:13:10 -04:00
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
return_dict = await self._create_registration_details(
|
2016-07-21 06:34:16 -04:00
|
|
|
registered_user_id, params
|
2015-03-30 13:13:10 -04:00
|
|
|
)
|
2015-04-16 14:56:44 -04:00
|
|
|
|
2019-02-20 02:47:31 -05:00
|
|
|
if registered:
|
2019-12-05 11:46:37 -05:00
|
|
|
await self.registration_handler.post_registration_actions(
|
2019-02-20 02:47:31 -05:00
|
|
|
user_id=registered_user_id,
|
|
|
|
auth_result=auth_result,
|
|
|
|
access_token=return_dict.get("access_token"),
|
2016-07-19 10:50:01 -04:00
|
|
|
)
|
2015-04-16 14:56:44 -04:00
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, return_dict
|
2015-03-30 13:13:10 -04:00
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
async def _do_appservice_registration(self, username, as_token, body):
|
|
|
|
user_id = await self.registration_handler.appservice_register(
|
2015-07-29 05:00:54 -04:00
|
|
|
username, as_token
|
2015-07-28 12:34:12 -04:00
|
|
|
)
|
2020-12-17 07:55:21 -05:00
|
|
|
return await self._create_registration_details(
|
|
|
|
user_id,
|
|
|
|
body,
|
|
|
|
is_appservice_ghost=True,
|
|
|
|
)
|
2015-07-28 12:34:12 -04:00
|
|
|
|
2020-12-17 07:55:21 -05:00
|
|
|
async def _create_registration_details(
|
|
|
|
self, user_id, params, is_appservice_ghost=False
|
|
|
|
):
|
2016-07-19 13:46:19 -04:00
|
|
|
"""Complete registration of newly-registered user
|
|
|
|
|
2016-12-01 06:42:17 -05:00
|
|
|
Allocates device_id if one was not given; also creates access_token.
|
2016-07-19 13:46:19 -04:00
|
|
|
|
|
|
|
Args:
|
|
|
|
(str) user_id: full canonical @user:id
|
2016-07-21 06:34:16 -04:00
|
|
|
(object) params: registration parameters, from which we pull
|
2017-11-02 12:31:07 -04:00
|
|
|
device_id, initial_device_name and inhibit_login
|
2016-07-19 13:46:19 -04:00
|
|
|
Returns:
|
2020-09-04 06:54:56 -04:00
|
|
|
dictionary for response from /register
|
2016-07-19 13:46:19 -04:00
|
|
|
"""
|
2017-11-02 12:31:07 -04:00
|
|
|
result = {"user_id": user_id, "home_server": self.hs.hostname}
|
|
|
|
if not params.get("inhibit_login", False):
|
2019-02-18 07:12:57 -05:00
|
|
|
device_id = params.get("device_id")
|
|
|
|
initial_display_name = params.get("initial_device_display_name")
|
2019-12-05 11:46:37 -05:00
|
|
|
device_id, access_token = await self.registration_handler.register_device(
|
2020-12-17 07:55:21 -05:00
|
|
|
user_id,
|
|
|
|
device_id,
|
|
|
|
initial_display_name,
|
|
|
|
is_guest=False,
|
|
|
|
is_appservice_ghost=is_appservice_ghost,
|
2016-07-22 09:52:53 -04:00
|
|
|
)
|
2016-07-19 13:46:19 -04:00
|
|
|
|
2017-11-02 12:31:07 -04:00
|
|
|
result.update({"access_token": access_token, "device_id": device_id})
|
2019-07-23 09:00:55 -04:00
|
|
|
return result
|
2015-07-28 12:34:12 -04:00
|
|
|
|
2019-12-05 11:46:37 -05:00
|
|
|
async def _do_guest_registration(self, params, address=None):
|
2015-11-04 12:29:07 -05:00
|
|
|
if not self.hs.config.allow_guest_access:
|
2018-07-17 06:43:18 -04:00
|
|
|
raise SynapseError(403, "Guest access is disabled")
|
2019-12-05 11:46:37 -05:00
|
|
|
user_id = await self.registration_handler.register_user(
|
2019-07-08 14:01:08 -04:00
|
|
|
make_guest=True, address=address
|
2016-01-06 06:38:09 -05:00
|
|
|
)
|
2016-11-25 10:25:30 -05: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-12-05 11:46:37 -05:00
|
|
|
device_id, access_token = await self.registration_handler.register_device(
|
2019-02-18 07:12:57 -05:00
|
|
|
user_id, device_id, initial_display_name, is_guest=True
|
2016-11-25 10:25:30 -05:00
|
|
|
)
|
|
|
|
|
2019-07-23 09:00:55 -04:00
|
|
|
return (
|
|
|
|
200,
|
|
|
|
{
|
|
|
|
"user_id": user_id,
|
|
|
|
"device_id": device_id,
|
|
|
|
"access_token": access_token,
|
|
|
|
"home_server": self.hs.hostname,
|
|
|
|
},
|
2019-06-20 05:32:02 -04:00
|
|
|
)
|
2015-11-04 12:29:07 -05:00
|
|
|
|
2015-03-30 13:13:10 -04:00
|
|
|
|
2019-09-25 06:32:05 -04:00
|
|
|
def _calculate_registration_flows(
|
|
|
|
# technically `config` has to provide *all* of these interfaces, not just one
|
|
|
|
config: Union[RegistrationConfig, ConsentConfig, CaptchaConfig],
|
2019-09-25 07:10:26 -04:00
|
|
|
auth_handler: AuthHandler,
|
2019-09-25 06:32:05 -04:00
|
|
|
) -> List[List[str]]:
|
|
|
|
"""Get a suitable flows list for registration
|
|
|
|
|
|
|
|
Args:
|
|
|
|
config: server configuration
|
2019-09-25 07:10:26 -04:00
|
|
|
auth_handler: authorization handler
|
2019-09-25 06:32:05 -04:00
|
|
|
|
|
|
|
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
|
2019-09-25 07:10:26 -04:00
|
|
|
show_email = True
|
|
|
|
|
2019-09-25 06:32:05 -04:00
|
|
|
if config.disable_msisdn_registration:
|
|
|
|
show_msisdn = False
|
|
|
|
require_msisdn = False
|
|
|
|
|
2019-09-25 07:10:26 -04:00
|
|
|
enabled_auth_types = auth_handler.get_enabled_auth_types()
|
|
|
|
if LoginType.EMAIL_IDENTITY not in enabled_auth_types:
|
|
|
|
show_email = False
|
|
|
|
if require_email:
|
|
|
|
raise ConfigError(
|
|
|
|
"Configuration requires email address at registration, but email "
|
|
|
|
"validation is not configured"
|
|
|
|
)
|
|
|
|
|
|
|
|
if LoginType.MSISDN not in enabled_auth_types:
|
|
|
|
show_msisdn = False
|
|
|
|
if require_msisdn:
|
|
|
|
raise ConfigError(
|
|
|
|
"Configuration requires msisdn at registration, but msisdn "
|
|
|
|
"validation is not configured"
|
|
|
|
)
|
|
|
|
|
2019-09-25 06:32:05 -04:00
|
|
|
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
|
2019-09-25 07:10:26 -04:00
|
|
|
if show_email and not require_msisdn:
|
2019-09-25 06:32:05 -04:00
|
|
|
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])
|
|
|
|
|
2019-09-25 07:10:26 -04:00
|
|
|
if show_email and show_msisdn:
|
|
|
|
# always let users provide both MSISDN & email
|
2019-09-25 06:32:05 -04:00
|
|
|
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 13:13:10 -04:00
|
|
|
def register_servlets(hs, http_server):
|
2017-03-13 13:27:51 -04:00
|
|
|
EmailRegisterRequestTokenRestServlet(hs).register(http_server)
|
|
|
|
MsisdnRegisterRequestTokenRestServlet(hs).register(http_server)
|
2017-05-03 06:55:44 -04:00
|
|
|
UsernameAvailabilityRestServlet(hs).register(http_server)
|
2019-09-06 06:35:28 -04:00
|
|
|
RegistrationSubmitTokenServlet(hs).register(http_server)
|
2015-03-31 04:50:44 -04:00
|
|
|
RegisterRestServlet(hs).register(http_server)
|