Matrix-Mirrors/forked-synapse
1
0
Fork 0
mirror of https://mau.dev/maunium/synapse.git synced 2024-10-01 01:36:05 -04:00
Code Issues Packages Projects Releases Wiki Activity

Allow password_auth_providers to return a callback

Browse Source 
... so that they have a way to record access tokens.
This commit is contained in:
Richard van der Hoff 2017-10-31 15:15:51 +00:00
parent 846a94fbc9
commit 4c8f94ac94
3 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/password_auth_providers.rst
View File

@ -70,6 +70,11 @@ Password auth provider classes may optionally provide the following methods.
the canonical ``@localpart:domain`` user id if authentication is successful, the canonical ``@localpart:domain`` user id if authentication is successful,
and ``None`` if not. and ``None`` if not.
Alternatively, the ``Deferred`` can resolve to a ``(str, func)`` tuple, in
which case the second field is a callback which will be called with the
result from the ``/login`` call (including ``access_token``, ``device_id``,
etc.)
``someprovider.check_password``\(*user_id*, *password*) ``someprovider.check_password``\(*user_id*, *password*)
This method provides a simpler interface than ``get_supported_login_types`` This method provides a simpler interface than ``get_supported_login_types``

13
synapse/handlers/auth.py
View File

@ -517,7 +517,8 @@ class AuthHandler(BaseHandler):
login_submission (dict): the whole of the login submission login_submission (dict): the whole of the login submission
(including 'type' and other relevant fields) (including 'type' and other relevant fields)
Returns: Returns:
Deferred[str]: canonical user id Deferred[str, func]: canonical user id, and optional callback
to be called once the access token and device id are issued
Raises: Raises:
StoreError if there was a problem accessing the database StoreError if there was a problem accessing the database
SynapseError if there was a problem with the request SynapseError if there was a problem with the request
@ -581,11 +582,13 @@ class AuthHandler(BaseHandler):
), ),
) )
returned_user_id = yield provider.check_auth( result = yield provider.check_auth(
username, login_type, login_dict, username, login_type, login_dict,
) )
if returned_user_id: if result:
defer.returnValue(returned_user_id) if isinstance(result, str):
result = (result, None)
defer.returnValue(result)
if login_type == LoginType.PASSWORD: if login_type == LoginType.PASSWORD:
known_login_type = True known_login_type = True
@ -595,7 +598,7 @@ class AuthHandler(BaseHandler):
) )
if canonical_user_id: if canonical_user_id:
defer.returnValue(canonical_user_id) defer.returnValue((canonical_user_id, None))
if not known_login_type: if not known_login_type:
raise SynapseError(400, "Unknown login type %s" % login_type) raise SynapseError(400, "Unknown login type %s" % login_type)

5
synapse/rest/client/v1/login.py
View File

@ -219,7 +219,7 @@ class LoginRestServlet(ClientV1RestServlet):
raise SynapseError(400, "User identifier is missing 'user' key") raise SynapseError(400, "User identifier is missing 'user' key")
auth_handler = self.auth_handler auth_handler = self.auth_handler
canonical_user_id = yield auth_handler.validate_login( canonical_user_id, callback = yield auth_handler.validate_login(
identifier["user"], identifier["user"],
login_submission, login_submission,
) )
@ -238,6 +238,9 @@ class LoginRestServlet(ClientV1RestServlet):
"device_id": device_id, "device_id": device_id,
} }
if callback is not None:
yield callback(result)
defer.returnValue((200, result)) defer.returnValue((200, result))
@defer.inlineCallbacks @defer.inlineCallbacks