OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Update comments based on suggestions. 

Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
pull/7186/head
Patrick Cloke 2020-04-02 10:21:40 -04:00 committed by GitHub
parent fce9db19df
commit f68df97edd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
synapse/handlers/cas_handler.py
View File

@ -74,6 +74,7 @@ class CasHandler:
Args: Args:
ticket: The CAS ticket from the client. ticket: The CAS ticket from the client.
service_args: Additional arguments to include in the service URL. service_args: Additional arguments to include in the service URL.
Should be the same as those passed to `get_redirect_url`.
""" """
uri = self._cas_server_url + "/proxyValidate" uri = self._cas_server_url + "/proxyValidate"
args = { args = {
@ -149,7 +150,7 @@ class CasHandler:
def get_redirect_url(self, service_args: Dict[str, str]) -> str: def get_redirect_url(self, service_args: Dict[str, str]) -> str:
""" """
Generates a URL to the CAS server where the client should be redirected. Generates a URL for the CAS server where the client should be redirected.
Args: Args:
service_args: Additional arguments to include in the final redirect URL. service_args: Additional arguments to include in the final redirect URL.
@ -171,22 +172,23 @@ class CasHandler:
session: Optional[str], session: Optional[str],
) -> None: ) -> None:
""" """
Called once the user has successfully authenticated with the SSO, Called once the user has successfully authenticated with the SSO.
validates a CAS ticket sent by the client and completes the login process. validates a CAS ticket sent by the client and completes the auth process.
Registers the user if necessary, and then returns a redirect (with Registers the user if necessary, and then returns a redirect (with
a login token) to the client. a login token) to the client.
Args: Args:
request: the incoming request from the browser. We'll request: the incoming request from the browser. We'll
respond to it with a redirect. respond to it with a redirect or an HTML page.
ticket: The CAS ticket provided by the client. ticket: The CAS ticket provided by the client.
client_redirect_url: the redirect_url the client gave us when client_redirect_url: the redirectUrl parameter from the `/cas/ticket` HTTP request, if given.
it first started the process. This should be the same as the redirectUrl from the original `/login/sso/redirect` request.
session_id: The UI Auth session ID, if applicable. session_id: The session_id parameter from the `/cas/ticket` HTTP request, if given.
This should be the UI Auth session id.
""" """
args = {} args = {}
if client_redirect_url: if client_redirect_url: