2014-08-12 10:10:52 -04:00
|
|
|
# -*- coding: utf-8 -*-
|
2015-01-06 08:21:39 -05:00
|
|
|
# Copyright 2014, 2015 OpenMarket Ltd
|
2014-08-12 10:10:52 -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.
|
2014-08-12 22:14:34 -04:00
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
"""Contains functions for registering clients."""
|
|
|
|
from twisted.internet import defer
|
|
|
|
|
|
|
|
from synapse.types import UserID
|
2014-09-06 01:55:29 -04:00
|
|
|
from synapse.api.errors import (
|
2015-04-17 11:46:45 -04:00
|
|
|
AuthError, Codes, SynapseError, RegistrationError, InvalidCaptchaError
|
2014-09-06 01:55:29 -04:00
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
from ._base import BaseHandler
|
|
|
|
import synapse.util.stringutils as stringutils
|
2014-12-08 04:24:37 -05:00
|
|
|
from synapse.util.async import run_on_reactor
|
2014-10-02 08:57:48 -04:00
|
|
|
from synapse.http.client import CaptchaServerHttpClient
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
import bcrypt
|
2014-09-03 13:22:27 -04:00
|
|
|
import logging
|
2015-03-18 07:33:46 -04:00
|
|
|
import urllib
|
2014-09-03 13:22:27 -04:00
|
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
|
|
|
|
class RegistrationHandler(BaseHandler):
|
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
super(RegistrationHandler, self).__init__(hs)
|
|
|
|
|
|
|
|
self.distributor = hs.get_distributor()
|
|
|
|
self.distributor.declare("registered_user")
|
|
|
|
|
2015-04-16 14:56:44 -04:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def check_username(self, localpart):
|
|
|
|
yield run_on_reactor()
|
|
|
|
|
|
|
|
if urllib.quote(localpart) != localpart:
|
|
|
|
raise SynapseError(
|
|
|
|
400,
|
|
|
|
"User ID must only contain characters which do not"
|
|
|
|
" require URL encoding."
|
|
|
|
)
|
|
|
|
|
|
|
|
user = UserID(localpart, self.hs.hostname)
|
|
|
|
user_id = user.to_string()
|
|
|
|
|
|
|
|
yield self.check_user_id_is_valid(user_id)
|
|
|
|
|
|
|
|
u = yield self.store.get_user_by_id(user_id)
|
|
|
|
if u:
|
|
|
|
raise SynapseError(
|
|
|
|
400,
|
|
|
|
"User ID already taken.",
|
|
|
|
errcode=Codes.USER_IN_USE,
|
|
|
|
)
|
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
@defer.inlineCallbacks
|
2014-09-15 07:42:36 -04:00
|
|
|
def register(self, localpart=None, password=None):
|
2014-08-12 10:10:52 -04:00
|
|
|
"""Registers a new client on the server.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
localpart : The local part of the user ID to register. If None,
|
|
|
|
one will be randomly generated.
|
|
|
|
password (str) : The password to assign to this user so they can
|
2015-07-28 12:34:12 -04:00
|
|
|
login again. This can be None which means they cannot login again
|
|
|
|
via a password (e.g. the user is an application service user).
|
2014-08-12 10:10:52 -04:00
|
|
|
Returns:
|
|
|
|
A tuple of (user_id, access_token).
|
|
|
|
Raises:
|
|
|
|
RegistrationError if there was a problem registering.
|
|
|
|
"""
|
2014-12-08 04:24:37 -05:00
|
|
|
yield run_on_reactor()
|
2014-08-12 10:10:52 -04:00
|
|
|
password_hash = None
|
|
|
|
if password:
|
2015-05-07 12:45:42 -04:00
|
|
|
password_hash = bcrypt.hashpw(password, bcrypt.gensalt())
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
if localpart:
|
2015-04-17 07:57:25 -04:00
|
|
|
yield self.check_username(localpart)
|
2015-03-18 07:33:46 -04:00
|
|
|
|
2014-12-08 04:24:37 -05:00
|
|
|
user = UserID(localpart, self.hs.hostname)
|
2014-08-12 10:10:52 -04:00
|
|
|
user_id = user.to_string()
|
|
|
|
|
2015-08-20 06:35:56 -04:00
|
|
|
token = self.auth_handler().generate_access_token(user_id)
|
2014-10-30 07:10:17 -04:00
|
|
|
yield self.store.register(
|
|
|
|
user_id=user_id,
|
2014-08-12 10:10:52 -04:00
|
|
|
token=token,
|
2014-10-30 07:10:17 -04:00
|
|
|
password_hash=password_hash
|
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2014-11-20 11:24:00 -05:00
|
|
|
yield self.distributor.fire("registered_user", user)
|
2014-08-12 10:10:52 -04:00
|
|
|
else:
|
|
|
|
# autogen a random user ID
|
|
|
|
attempts = 0
|
|
|
|
user_id = None
|
|
|
|
token = None
|
|
|
|
while not user_id and not token:
|
|
|
|
try:
|
|
|
|
localpart = self._generate_user_id()
|
2014-12-08 04:24:37 -05:00
|
|
|
user = UserID(localpart, self.hs.hostname)
|
2014-08-12 10:10:52 -04:00
|
|
|
user_id = user.to_string()
|
2015-02-05 11:46:56 -05:00
|
|
|
yield self.check_user_id_is_valid(user_id)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2015-08-20 06:35:56 -04:00
|
|
|
token = self.auth_handler().generate_access_token(user_id)
|
2014-08-12 10:10:52 -04:00
|
|
|
yield self.store.register(
|
|
|
|
user_id=user_id,
|
|
|
|
token=token,
|
|
|
|
password_hash=password_hash)
|
|
|
|
|
|
|
|
self.distributor.fire("registered_user", user)
|
|
|
|
except SynapseError:
|
|
|
|
# if user id is taken, just generate another
|
|
|
|
user_id = None
|
|
|
|
token = None
|
|
|
|
attempts += 1
|
|
|
|
if attempts > 5:
|
|
|
|
raise RegistrationError(
|
|
|
|
500, "Cannot generate user ID.")
|
|
|
|
|
2015-02-07 08:32:14 -05:00
|
|
|
# create a default avatar for the user
|
|
|
|
# XXX: ideally clients would explicitly specify one, but given they don't
|
|
|
|
# and we want consistent and pretty identicons for random users, we'll
|
|
|
|
# do it here.
|
2015-02-07 16:24:08 -05:00
|
|
|
try:
|
|
|
|
auth_user = UserID.from_string(user_id)
|
2015-02-10 11:30:48 -05:00
|
|
|
media_repository = self.hs.get_resource_for_media_repository()
|
|
|
|
identicon_resource = media_repository.getChildWithDefault("identicon", None)
|
|
|
|
upload_resource = media_repository.getChildWithDefault("upload", None)
|
2015-02-07 16:24:08 -05:00
|
|
|
identicon_bytes = identicon_resource.generate_identicon(user_id, 320, 320)
|
|
|
|
content_uri = yield upload_resource.create_content(
|
|
|
|
"image/png", None, identicon_bytes, len(identicon_bytes), auth_user
|
|
|
|
)
|
|
|
|
profile_handler = self.hs.get_handlers().profile_handler
|
2015-02-10 11:30:48 -05:00
|
|
|
profile_handler.set_avatar_url(
|
|
|
|
auth_user, auth_user, ("%s#auto" % (content_uri,))
|
|
|
|
)
|
2015-02-07 16:24:08 -05:00
|
|
|
except NotImplementedError:
|
2015-02-10 11:30:48 -05:00
|
|
|
pass # make tests pass without messing around creating default avatars
|
|
|
|
|
2014-09-03 13:22:27 -04:00
|
|
|
defer.returnValue((user_id, token))
|
|
|
|
|
2015-02-05 12:29:27 -05:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def appservice_register(self, user_localpart, as_token):
|
|
|
|
user = UserID(user_localpart, self.hs.hostname)
|
|
|
|
user_id = user.to_string()
|
|
|
|
service = yield self.store.get_app_service_by_token(as_token)
|
|
|
|
if not service:
|
2015-02-06 12:10:04 -05:00
|
|
|
raise AuthError(403, "Invalid application service token.")
|
2015-02-05 12:29:27 -05:00
|
|
|
if not service.is_interested_in_user(user_id):
|
|
|
|
raise SynapseError(
|
2015-02-06 12:10:04 -05:00
|
|
|
400, "Invalid user localpart for this application service.",
|
|
|
|
errcode=Codes.EXCLUSIVE
|
2015-02-05 12:29:27 -05:00
|
|
|
)
|
2015-08-20 06:35:56 -04:00
|
|
|
token = self.auth_handler().generate_access_token(user_id)
|
2015-02-05 12:29:27 -05:00
|
|
|
yield self.store.register(
|
|
|
|
user_id=user_id,
|
|
|
|
token=token,
|
|
|
|
password_hash=""
|
|
|
|
)
|
|
|
|
self.distributor.fire("registered_user", user)
|
|
|
|
defer.returnValue((user_id, token))
|
|
|
|
|
2014-09-15 07:42:36 -04:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def check_recaptcha(self, ip, private_key, challenge, response):
|
2015-03-30 13:13:10 -04:00
|
|
|
"""
|
|
|
|
Checks a recaptcha is correct.
|
|
|
|
|
|
|
|
Used only by c/s api v1
|
|
|
|
"""
|
2014-09-15 07:42:36 -04:00
|
|
|
|
|
|
|
captcha_response = yield self._validate_captcha(
|
|
|
|
ip,
|
|
|
|
private_key,
|
|
|
|
challenge,
|
|
|
|
response
|
|
|
|
)
|
|
|
|
if not captcha_response["valid"]:
|
|
|
|
logger.info("Invalid captcha entered from %s. Error: %s",
|
|
|
|
ip, captcha_response["error_url"])
|
|
|
|
raise InvalidCaptchaError(
|
|
|
|
error_url=captcha_response["error_url"]
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
logger.info("Valid captcha entered from %s", ip)
|
|
|
|
|
2015-07-07 08:10:30 -04:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def register_saml2(self, localpart):
|
|
|
|
"""
|
|
|
|
Registers email_id as SAML2 Based Auth.
|
|
|
|
"""
|
|
|
|
if urllib.quote(localpart) != localpart:
|
|
|
|
raise SynapseError(
|
|
|
|
400,
|
|
|
|
"User ID must only contain characters which do not"
|
|
|
|
" require URL encoding."
|
|
|
|
)
|
|
|
|
user = UserID(localpart, self.hs.hostname)
|
|
|
|
user_id = user.to_string()
|
|
|
|
|
|
|
|
yield self.check_user_id_is_valid(user_id)
|
2015-08-20 06:35:56 -04:00
|
|
|
token = self.auth_handler().generate_access_token(user_id)
|
2015-07-07 08:10:30 -04:00
|
|
|
try:
|
|
|
|
yield self.store.register(
|
|
|
|
user_id=user_id,
|
|
|
|
token=token,
|
|
|
|
password_hash=None
|
|
|
|
)
|
|
|
|
yield self.distributor.fire("registered_user", user)
|
|
|
|
except Exception, e:
|
|
|
|
yield self.store.add_access_token_to_user(user_id, token)
|
|
|
|
# Ignore Registration errors
|
|
|
|
logger.exception(e)
|
|
|
|
defer.returnValue((user_id, token))
|
|
|
|
|
2014-09-15 07:42:36 -04:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def register_email(self, threepidCreds):
|
2015-04-15 10:50:38 -04:00
|
|
|
"""
|
|
|
|
Registers emails with an identity server.
|
|
|
|
|
|
|
|
Used only by c/s api v1
|
|
|
|
"""
|
2014-09-15 07:42:36 -04:00
|
|
|
|
|
|
|
for c in threepidCreds:
|
|
|
|
logger.info("validating theeepidcred sid %s on id server %s",
|
|
|
|
c['sid'], c['idServer'])
|
|
|
|
try:
|
2015-04-16 14:56:44 -04:00
|
|
|
identity_handler = self.hs.get_handlers().identity_handler
|
|
|
|
threepid = yield identity_handler.threepid_from_creds(c)
|
2014-09-15 07:42:36 -04:00
|
|
|
except:
|
2014-11-03 05:16:28 -05:00
|
|
|
logger.exception("Couldn't validate 3pid")
|
2014-09-15 07:42:36 -04:00
|
|
|
raise RegistrationError(400, "Couldn't validate 3pid")
|
|
|
|
|
|
|
|
if not threepid:
|
|
|
|
raise RegistrationError(400, "Couldn't validate 3pid")
|
2014-11-20 12:41:56 -05:00
|
|
|
logger.info("got threepid with medium '%s' and address '%s'",
|
2014-09-15 07:42:36 -04:00
|
|
|
threepid['medium'], threepid['address'])
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def bind_emails(self, user_id, threepidCreds):
|
2015-04-16 14:56:44 -04:00
|
|
|
"""Links emails with a user ID and informs an identity server.
|
|
|
|
|
|
|
|
Used only by c/s api v1
|
|
|
|
"""
|
2014-09-15 07:42:36 -04:00
|
|
|
|
|
|
|
# Now we have a matrix ID, bind it to the threepids we were given
|
|
|
|
for c in threepidCreds:
|
2015-04-16 14:56:44 -04:00
|
|
|
identity_handler = self.hs.get_handlers().identity_handler
|
2014-09-15 07:42:36 -04:00
|
|
|
# XXX: This should be a deferred list, shouldn't it?
|
2015-04-16 14:56:44 -04:00
|
|
|
yield identity_handler.bind_threepid(c, user_id)
|
2014-09-15 07:42:36 -04:00
|
|
|
|
2015-02-05 11:46:56 -05:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def check_user_id_is_valid(self, user_id):
|
|
|
|
# valid user IDs must not clash with any user ID namespaces claimed by
|
|
|
|
# application services.
|
|
|
|
services = yield self.store.get_app_services()
|
|
|
|
interested_services = [
|
|
|
|
s for s in services if s.is_interested_in_user(user_id)
|
|
|
|
]
|
2015-02-27 08:51:41 -05:00
|
|
|
for service in interested_services:
|
|
|
|
if service.is_exclusive_user(user_id):
|
|
|
|
raise SynapseError(
|
|
|
|
400, "This user ID is reserved by an application service.",
|
|
|
|
errcode=Codes.EXCLUSIVE
|
|
|
|
)
|
2015-02-05 11:46:56 -05:00
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
def _generate_user_id(self):
|
|
|
|
return "-" + stringutils.random_string(18)
|
2014-09-03 13:22:27 -04:00
|
|
|
|
2014-09-05 22:18:23 -04:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def _validate_captcha(self, ip_addr, private_key, challenge, response):
|
|
|
|
"""Validates the captcha provided.
|
2014-09-15 07:42:36 -04:00
|
|
|
|
2015-03-30 13:13:10 -04:00
|
|
|
Used only by c/s api v1
|
|
|
|
|
2014-09-05 22:18:23 -04:00
|
|
|
Returns:
|
|
|
|
dict: Containing 'valid'(bool) and 'error_url'(str) if invalid.
|
2014-09-15 07:42:36 -04:00
|
|
|
|
2014-09-05 22:18:23 -04:00
|
|
|
"""
|
2014-09-15 07:42:36 -04:00
|
|
|
response = yield self._submit_captcha(ip_addr, private_key, challenge,
|
2014-09-06 01:55:29 -04:00
|
|
|
response)
|
2014-09-05 22:18:23 -04:00
|
|
|
# parse Google's response. Lovely format..
|
|
|
|
lines = response.split('\n')
|
|
|
|
json = {
|
|
|
|
"valid": lines[0] == 'true',
|
2014-09-15 07:42:36 -04:00
|
|
|
"error_url": "http://www.google.com/recaptcha/api/challenge?" +
|
2014-09-06 01:55:29 -04:00
|
|
|
"error=%s" % lines[1]
|
2014-09-05 22:18:23 -04:00
|
|
|
}
|
|
|
|
defer.returnValue(json)
|
2014-09-15 07:42:36 -04:00
|
|
|
|
2014-09-05 22:18:23 -04:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def _submit_captcha(self, ip_addr, private_key, challenge, response):
|
2015-03-30 13:13:10 -04:00
|
|
|
"""
|
|
|
|
Used only by c/s api v1
|
|
|
|
"""
|
2014-10-02 08:57:48 -04:00
|
|
|
# TODO: get this from the homeserver rather than creating a new one for
|
|
|
|
# each request
|
|
|
|
client = CaptchaServerHttpClient(self.hs)
|
2014-09-05 22:18:23 -04:00
|
|
|
data = yield client.post_urlencoded_get_raw(
|
2014-11-20 12:41:56 -05:00
|
|
|
"http://www.google.com:80/recaptcha/api/verify",
|
2014-09-15 07:42:36 -04:00
|
|
|
args={
|
|
|
|
'privatekey': private_key,
|
2014-09-05 22:18:23 -04:00
|
|
|
'remoteip': ip_addr,
|
|
|
|
'challenge': challenge,
|
|
|
|
'response': response
|
|
|
|
}
|
|
|
|
)
|
|
|
|
defer.returnValue(data)
|
2015-08-20 06:35:56 -04:00
|
|
|
|
|
|
|
def auth_handler(self):
|
|
|
|
return self.hs.get_handlers().auth_handler
|