From 49a79fa24fdd30c733b2da8584236b6258e23afa Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Wed, 1 Apr 2020 11:13:10 -0400 Subject: [PATCH] Update method names and docstrings for handling tickets. --- synapse/handlers/cas_handler.py | 6 +++--- synapse/rest/client/v1/login.py | 2 +- synapse/rest/client/v2_alpha/auth.py | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/synapse/handlers/cas_handler.py b/synapse/handlers/cas_handler.py index af86baaa07..b3cb29f366 100644 --- a/synapse/handlers/cas_handler.py +++ b/synapse/handlers/cas_handler.py @@ -172,11 +172,11 @@ class CasHandler: return "%s/login?%s" % (self._cas_server_url, args) - async def handle_login_request( + async def handle_ticket_for_login( self, request: SynapseRequest, client_redirect_url: str, ticket: str ) -> None: """ - Validates a CAS ticket sent by the client for login and authenticates the user with SSO. + Validates a CAS ticket sent by the client and completes the login process. Registers the user if necessary, and then returns a redirect (with a login token) to the client. @@ -206,7 +206,7 @@ class CasHandler: registered_user_id, request, client_redirect_url ) - async def handle_ui_auth_response( + async def handle_ticket_for_ui_auth( self, request: SynapseRequest, ticket: str, session_id: str ) -> None: """ diff --git a/synapse/rest/client/v1/login.py b/synapse/rest/client/v1/login.py index 8beb2f1ed2..ffaff41c41 100644 --- a/synapse/rest/client/v1/login.py +++ b/synapse/rest/client/v1/login.py @@ -440,7 +440,7 @@ class CasTicketServlet(RestServlet): async def on_GET(self, request: SynapseRequest) -> None: client_redirect_url = parse_string(request, "redirectUrl", required=True) ticket = parse_string(request, "ticket", required=True) - await self._cas_handler.handle_login_request( + await self._cas_handler.handle_ticket_for_login( request, client_redirect_url, ticket ) diff --git a/synapse/rest/client/v2_alpha/auth.py b/synapse/rest/client/v2_alpha/auth.py index fba00c5412..6a9deef984 100644 --- a/synapse/rest/client/v2_alpha/auth.py +++ b/synapse/rest/client/v2_alpha/auth.py @@ -262,7 +262,7 @@ class CasAuthTicketServlet(RestServlet): # Pull the UI Auth session ID out. session_id = parse_string(request, "session", required=True) - return await self._cas_handler.handle_ui_auth_response( + return await self._cas_handler.handle_ticket_for_ui_auth( request, ticket, session_id )