MSC1721: Rename m.login.cas to m.login.sso #1721
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # MSC1721: Rename `m.login.cas` to `m.login.sso` | ||
|
|
||
| The Matrix Client-Server spec includes a [section on client login using Central | ||
| Authentication Service | ||
| (CAS)](https://matrix.org/docs/spec/client_server/r0.4.0.html#cas-based-client-login). | ||
|
|
||
| The spec currently fails to mention it, but this process is triggered when [`GET | ||
| /login`](https://matrix.org/docs/spec/client_server/r0.4.0.html#get-matrix-client-r0-login) | ||
| returns a flow type of `m.login.cas`. | ||
|
|
||
| Nothing in this flow is specific to CAS - it is equally applicable for other | ||
| web-based single-sign-on processes, such as SAML. | ||
|
|
||
| Accordingly, we should rename `cas` to `sso`. | ||
|
|
||
| ## Proposal | ||
|
|
||
| 1. `m.login.sso` should be defined as a valid login type for return from `GET | ||
| /login`. (We should probably mention `m.login.cas` in the spec while we are | ||
| there). | ||
|
|
||
| 2. When a client wishes to use the SSO login type, it should redirect to | ||
| `/_matrix/client/r0/login/sso/redirect` (instead of | ||
| `/_matrix/client/r0/login/cas/redirect`). | ||
|
|
||
| 3. Servers should treat `/_matrix/client/r0/login/sso/redirect` identically to | ||
| `/_matrix/client/r0/login/cas/redirect`: they should issue a redirect to | ||
| their configured single-sign-on system. | ||
|
|
||
| 4. Servers should probably rename the post-authentication callback endpoint | ||
|
There was a problem hiding this comment. I've actually removed this section altogether. The server's behaviour needs to be completely different depending on whether it's handling a CAS or a SAML response, so it makes sense to leave it as |
||
| `/_matrix/client/r0/login/sso/ticket` instead of | ||
| `/_matrix/client/r0/login/cas/ticket`. Note, however, that this name is only | ||
| a suggestion: the full name of this endpoint is implementation-specific. | ||
|
|
||
| 5. Servers which support `m.login.sso` should make sure they update their [login | ||
| fallback page](https://matrix.org/docs/spec/client_server/r0.4.0.html#login-fallback) | ||
| to understand the new login type. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will it return
m.long.ssoalong withm.login.casor instead of it? I'd probably recommend "along" for the transition period (but I'd really be interested to know how many clients are even watching form.login.cas- probably there's nothing worth discussing).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/m.long.sso/m.login.sso
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yup think it's best to return both for now.
riot-web has some very rudimentary support for m.login.cas, but that's it afaik