rest/client/v2_alpha/register.py: Refactor flow somewhat.

This is meant to be an *almost* non-functional change, with the exception that
it fixes what looks a lot like a bug in that it only calls
`auth_handler.add_threepid` and `add_pusher` once instead of three times.

The idea is to move the generation of the `access_token` out of
`registration_handler.register`, because `access_token`s now require a
device_id, and we only want to generate a device_id once registration has been
successful.
This commit is contained in:
Richard van der Hoff 2016-07-19 13:12:22 +01:00
parent 0c62c958fd
commit 0da0d0a29d
2 changed files with 104 additions and 76 deletions

View File

@ -199,92 +199,55 @@ class RegisterRestServlet(RestServlet):
"Already registered user ID %r for this session", "Already registered user ID %r for this session",
registered_user_id registered_user_id
) )
access_token = yield self.auth_handler.issue_access_token(registered_user_id) # don't re-register the email address
refresh_token = yield self.auth_handler.issue_refresh_token( add_email = False
registered_user_id else:
)
defer.returnValue((200, {
"user_id": registered_user_id,
"access_token": access_token,
"home_server": self.hs.hostname,
"refresh_token": refresh_token,
}))
# NB: This may be from the auth handler and NOT from the POST # NB: This may be from the auth handler and NOT from the POST
if 'password' not in params: if 'password' not in params:
raise SynapseError(400, "Missing password.", Codes.MISSING_PARAM) raise SynapseError(400, "Missing password.",
Codes.MISSING_PARAM)
desired_username = params.get("username", None) desired_username = params.get("username", None)
new_password = params.get("password", None) new_password = params.get("password", None)
guest_access_token = params.get("guest_access_token", None) guest_access_token = params.get("guest_access_token", None)
(user_id, token) = yield self.registration_handler.register( (registered_user_id, _) = yield self.registration_handler.register(
localpart=desired_username, localpart=desired_username,
password=new_password, password=new_password,
guest_access_token=guest_access_token, guest_access_token=guest_access_token,
generate_token=False,
) )
# remember that we've now registered that user account, and with what # remember that we've now registered that user account, and with
# user ID (since the user may not have specified) # what user ID (since the user may not have specified)
self.auth_handler.set_session_data( self.auth_handler.set_session_data(
session_id, "registered_user_id", user_id session_id, "registered_user_id", registered_user_id
) )
if result and LoginType.EMAIL_IDENTITY in result: add_email = True
access_token = yield self.auth_handler.issue_access_token(
registered_user_id
)
if add_email and result and LoginType.EMAIL_IDENTITY in result:
threepid = result[LoginType.EMAIL_IDENTITY] threepid = result[LoginType.EMAIL_IDENTITY]
reqd = ('medium', 'address', 'validated_at')
for reqd in ['medium', 'address', 'validated_at']: if all(x in threepid for x in reqd):
if reqd not in threepid: yield self._register_email_threepid(
logger.info("Can't add incomplete 3pid") registered_user_id, threepid, access_token
)
# XXX why is bind_email not protected by this?
else: else:
yield self.auth_handler.add_threepid( logger.info("Can't add incomplete 3pid")
user_id, if params.get("bind_email"):
threepid['medium'],
threepid['address'],
threepid['validated_at'],
)
# And we add an email pusher for them by default, but only
# if email notifications are enabled (so people don't start
# getting mail spam where they weren't before if email
# notifs are set up on a home server)
if (
self.hs.config.email_enable_notifs and
self.hs.config.email_notif_for_new_users
):
# Pull the ID of the access token back out of the db
# It would really make more sense for this to be passed
# up when the access token is saved, but that's quite an
# invasive change I'd rather do separately.
user_tuple = yield self.store.get_user_by_access_token(
token
)
yield self.hs.get_pusherpool().add_pusher(
user_id=user_id,
access_token=user_tuple["token_id"],
kind="email",
app_id="m.email",
app_display_name="Email Notifications",
device_display_name=threepid["address"],
pushkey=threepid["address"],
lang=None, # We don't know a user's language here
data={},
)
if 'bind_email' in params and params['bind_email']:
logger.info("bind_email specified: binding") logger.info("bind_email specified: binding")
yield self._bind_email(registered_user_id, threepid)
emailThreepid = result[LoginType.EMAIL_IDENTITY]
threepid_creds = emailThreepid['threepid_creds']
logger.debug("Binding emails %s to %s" % (
emailThreepid, user_id
))
yield self.identity_handler.bind_threepid(threepid_creds, user_id)
else: else:
logger.info("bind_email not specified: not binding email") logger.info("bind_email not specified: not binding email")
result = yield self._create_registration_details(user_id, token) result = yield self._create_registration_details(registered_user_id,
access_token)
defer.returnValue((200, result)) defer.returnValue((200, result))
def on_OPTIONS(self, _): def on_OPTIONS(self, _):
@ -324,6 +287,70 @@ class RegisterRestServlet(RestServlet):
) )
defer.returnValue((yield self._create_registration_details(user_id, token))) defer.returnValue((yield self._create_registration_details(user_id, token)))
@defer.inlineCallbacks
def _register_email_threepid(self, user_id, threepid, token):
"""Add an email address as a 3pid identifier
Also adds an email pusher for the email address, if configured in the
HS config
Args:
user_id (str): id of user
threepid (object): m.login.email.identity auth response
token (str): access_token for the user
Returns:
defer.Deferred:
"""
yield self.auth_handler.add_threepid(
user_id,
threepid['medium'],
threepid['address'],
threepid['validated_at'],
)
# And we add an email pusher for them by default, but only
# if email notifications are enabled (so people don't start
# getting mail spam where they weren't before if email
# notifs are set up on a home server)
if (self.hs.config.email_enable_notifs and
self.hs.config.email_notif_for_new_users):
# Pull the ID of the access token back out of the db
# It would really make more sense for this to be passed
# up when the access token is saved, but that's quite an
# invasive change I'd rather do separately.
user_tuple = yield self.store.get_user_by_access_token(
token
)
token_id = user_tuple["token_id"]
yield self.hs.get_pusherpool().add_pusher(
user_id=user_id,
access_token=token_id,
kind="email",
app_id="m.email",
app_display_name="Email Notifications",
device_display_name=threepid["address"],
pushkey=threepid["address"],
lang=None, # We don't know a user's language here
data={},
)
defer.returnValue()
def _bind_email(self, user_id, email_threepid):
"""Bind emails to the given user_id on the identity server
Args:
user_id (str): user id to bind the emails to
email_threepid (object): m.login.email.identity auth response
Returns:
defer.Deferred:
"""
threepid_creds = email_threepid['threepid_creds']
logger.debug("Binding emails %s to %s" % (
email_threepid, user_id
))
return self.identity_handler.bind_threepid(threepid_creds, user_id)
@defer.inlineCallbacks @defer.inlineCallbacks
def _create_registration_details(self, user_id, token): def _create_registration_details(self, user_id, token):
refresh_token = yield self.auth_handler.issue_refresh_token(user_id) refresh_token = yield self.auth_handler.issue_refresh_token(user_id)

View File

@ -114,7 +114,8 @@ class RegisterRestServletTestCase(unittest.TestCase):
"username": "kermit", "username": "kermit",
"password": "monkey" "password": "monkey"
}, None) }, None)
self.registration_handler.register = Mock(return_value=(user_id, token)) self.registration_handler.register = Mock(return_value=(user_id, None))
self.auth_handler.issue_access_token = Mock(return_value=token)
(code, result) = yield self.servlet.on_POST(self.request) (code, result) = yield self.servlet.on_POST(self.request)
self.assertEquals(code, 200) self.assertEquals(code, 200)