Remove the `complete_sso_login` method from the Module API which was deprecated in Synapse 1.13.0. (#13843)
Signed-off-by: Quentin Gliech <quenting@element.io>pull/13667/head
parent
fff9b955fa
commit
85fc7ea1a1
|
@ -0,0 +1 @@
|
||||||
|
Remove the `complete_sso_login` method from the Module API which was deprecated in Synapse 1.13.0.
|
|
@ -63,7 +63,6 @@ from synapse.http.server import finish_request, respond_with_html
|
||||||
from synapse.http.site import SynapseRequest
|
from synapse.http.site import SynapseRequest
|
||||||
from synapse.logging.context import defer_to_thread
|
from synapse.logging.context import defer_to_thread
|
||||||
from synapse.metrics.background_process_metrics import run_as_background_process
|
from synapse.metrics.background_process_metrics import run_as_background_process
|
||||||
from synapse.storage.roommember import ProfileInfo
|
|
||||||
from synapse.types import JsonDict, Requester, UserID
|
from synapse.types import JsonDict, Requester, UserID
|
||||||
from synapse.util import stringutils as stringutils
|
from synapse.util import stringutils as stringutils
|
||||||
from synapse.util.async_helpers import delay_cancellation, maybe_awaitable
|
from synapse.util.async_helpers import delay_cancellation, maybe_awaitable
|
||||||
|
@ -1687,41 +1686,10 @@ class AuthHandler:
|
||||||
respond_with_html(request, 403, self._sso_account_deactivated_template)
|
respond_with_html(request, 403, self._sso_account_deactivated_template)
|
||||||
return
|
return
|
||||||
|
|
||||||
profile = await self.store.get_profileinfo(
|
user_profile_data = await self.store.get_profileinfo(
|
||||||
UserID.from_string(registered_user_id).localpart
|
UserID.from_string(registered_user_id).localpart
|
||||||
)
|
)
|
||||||
|
|
||||||
self._complete_sso_login(
|
|
||||||
registered_user_id,
|
|
||||||
auth_provider_id,
|
|
||||||
request,
|
|
||||||
client_redirect_url,
|
|
||||||
extra_attributes,
|
|
||||||
new_user=new_user,
|
|
||||||
user_profile_data=profile,
|
|
||||||
auth_provider_session_id=auth_provider_session_id,
|
|
||||||
)
|
|
||||||
|
|
||||||
def _complete_sso_login(
|
|
||||||
self,
|
|
||||||
registered_user_id: str,
|
|
||||||
auth_provider_id: str,
|
|
||||||
request: Request,
|
|
||||||
client_redirect_url: str,
|
|
||||||
extra_attributes: Optional[JsonDict] = None,
|
|
||||||
new_user: bool = False,
|
|
||||||
user_profile_data: Optional[ProfileInfo] = None,
|
|
||||||
auth_provider_session_id: Optional[str] = None,
|
|
||||||
) -> None:
|
|
||||||
"""
|
|
||||||
The synchronous portion of complete_sso_login.
|
|
||||||
|
|
||||||
This exists purely for backwards compatibility of synapse.module_api.ModuleApi.
|
|
||||||
"""
|
|
||||||
|
|
||||||
if user_profile_data is None:
|
|
||||||
user_profile_data = ProfileInfo(None, None)
|
|
||||||
|
|
||||||
# Store any extra attributes which will be passed in the login response.
|
# Store any extra attributes which will be passed in the login response.
|
||||||
# Note that this is per-user so it may overwrite a previous value, this
|
# Note that this is per-user so it may overwrite a previous value, this
|
||||||
# is considered OK since the newest SSO attributes should be most valid.
|
# is considered OK since the newest SSO attributes should be most valid.
|
||||||
|
|
|
@ -836,31 +836,6 @@ class ModuleApi:
|
||||||
self._store.db_pool.runInteraction(desc, func, *args, **kwargs) # type: ignore[arg-type]
|
self._store.db_pool.runInteraction(desc, func, *args, **kwargs) # type: ignore[arg-type]
|
||||||
)
|
)
|
||||||
|
|
||||||
def complete_sso_login(
|
|
||||||
self, registered_user_id: str, request: SynapseRequest, client_redirect_url: str
|
|
||||||
) -> None:
|
|
||||||
"""Complete a SSO login by redirecting the user to a page to confirm whether they
|
|
||||||
want their access token sent to `client_redirect_url`, or redirect them to that
|
|
||||||
URL with a token directly if the URL matches with one of the whitelisted clients.
|
|
||||||
|
|
||||||
This is deprecated in favor of complete_sso_login_async.
|
|
||||||
|
|
||||||
Added in Synapse v1.11.1.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
registered_user_id: The MXID that has been registered as a previous step of
|
|
||||||
of this SSO login.
|
|
||||||
request: The request to respond to.
|
|
||||||
client_redirect_url: The URL to which to offer to redirect the user (or to
|
|
||||||
redirect them directly if whitelisted).
|
|
||||||
"""
|
|
||||||
self._auth_handler._complete_sso_login(
|
|
||||||
registered_user_id,
|
|
||||||
"<unknown>",
|
|
||||||
request,
|
|
||||||
client_redirect_url,
|
|
||||||
)
|
|
||||||
|
|
||||||
async def complete_sso_login_async(
|
async def complete_sso_login_async(
|
||||||
self,
|
self,
|
||||||
registered_user_id: str,
|
registered_user_id: str,
|
||||||
|
|
Loading…
Reference in New Issue