Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Properly register all callback hooks for legacy password authentication providers #11340

Merged
merged 4 commits into from
Nov 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/11340.bugfix
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix a bug, introduced in Synapse 1.46.0, which caused the `check_3pid_auth` and `on_logged_out` callbacks in legacy password authentication provider modules to not be registered. Modules using the generic module API were not affected.
26 changes: 13 additions & 13 deletions synapse/handlers/auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -1828,13 +1828,6 @@ def load_single_legacy_password_auth_provider(
logger.error("Error while initializing %r: %s", module, e)
raise

# The known hooks. If a module implements a method who's name appears in this set
# we'll want to register it
password_auth_provider_methods = {
"check_3pid_auth",
"on_logged_out",
}

# All methods that the module provides should be async, but this wasn't enforced
# in the old module system, so we wrap them if needed
def async_wrapper(f: Optional[Callable]) -> Optional[Callable[..., Awaitable]]:
Expand Down Expand Up @@ -1919,11 +1912,14 @@ def run(*args: Tuple, **kwargs: Dict) -> Awaitable:

return run

# populate hooks with the implemented methods, wrapped with async_wrapper
hooks = {
hook: async_wrapper(getattr(provider, hook, None))
for hook in password_auth_provider_methods
}
# If the module has these methods implemented, then we pull them out
# and register them as hooks.
check_3pid_auth_hook: Optional[CHECK_3PID_AUTH_CALLBACK] = async_wrapper(
getattr(provider, "check_3pid_auth", None)
)
on_logged_out_hook: Optional[ON_LOGGED_OUT_CALLBACK] = async_wrapper(
getattr(provider, "on_logged_out", None)
)

supported_login_types = {}
# call get_supported_login_types and add that to the dict
Expand All @@ -1950,7 +1946,11 @@ def run(*args: Tuple, **kwargs: Dict) -> Awaitable:
# need to use a tuple here for ("password",) not a list since lists aren't hashable
auth_checkers[(LoginType.PASSWORD, ("password",))] = check_password

api.register_password_auth_provider_callbacks(hooks, auth_checkers=auth_checkers)
api.register_password_auth_provider_callbacks(
check_3pid_auth=check_3pid_auth_hook,
on_logged_out=on_logged_out_hook,
auth_checkers=auth_checkers,
)


CHECK_3PID_AUTH_CALLBACK = Callable[
Expand Down