wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Clarify that the only new item here is the new authentication type.

Browse source
This commit is contained in:
Patrick Cloke 2020-04-01 10:48:05 -04:00
parent eb48863c40
commit 4cfcda57fb
1 changed files with 26 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

31
proposals/2454-ui-interactive-auth-for-sso.md
View file

@ -22,11 +22,27 @@ supported among clients.
An [additional authentication type](https://matrix.org/docs/spec/client_server/r0.6.0#authentication-types) An [additional authentication type](https://matrix.org/docs/spec/client_server/r0.6.0#authentication-types)
of `m.login.sso` is added to the user-interactive authentication specification. of `m.login.sso` is added to the user-interactive authentication specification.
There are no additional parameters as part of this authentication type.
There are no additional parameters as part of this authentication type. As per
the user-interactive authentication specification the only parameter include in
the `auth` dictionary should be the session ID from the homeserver, e.g.:
```json
{
"auth": {
"session": "<session ID>"
}
}
```
### Detailed fallback authentication flow:
The following is a re-iteration of the [fallback authentication flow](https://matrix.org/docs/spec/client_server/r0.6.0#fallback),
but with details filled in for the proposed new authentication type.
When choosing this authentication flow, the following should occur: When choosing this authentication flow, the following should occur:
1. If the client wants to complete that authentication type, it opens a browser 1. If the client wants to complete authentication using SSO, it opens a browser
window for `/_matrix/client/r0/auth/m.login.sso/fallback/web?session=<...>` window for `/_matrix/client/r0/auth/m.login.sso/fallback/web?session=<...>`
with session set to the UI-Auth session id (from the "auth" dict). with session set to the UI-Auth session id (from the "auth" dict).
@ -59,6 +75,10 @@ limited by the chosen SSO implementation, for example:
### Example flow: ### Example flow:
A more complete example is provided below in which a user attempts to delete
a device and is pushed into the user interactive authentication process with
SSO being the only possible flow.
0. Client submits the request, which the server says requires SSO: 0. Client submits the request, which the server says requires SSO:
``` ```
@ -163,7 +183,7 @@ limited by the chosen SSO implementation, for example:
## Alternatives ## Alternatives
An alternative client flow where the fallback auth ends up redirecting to a An alternative client flow where the fallback auth ends up redirecting to a
given URI, instead of doing JavaScript postMessage foo could be considered. given URI, instead of doing JavaScript `postMessage` foo could be considered.
This is probably an orthogonal change to the fallback auth though. This is probably an orthogonal change to the fallback auth though.
## Security considerations ## Security considerations
@ -200,8 +220,9 @@ This problem can be mitigated by clearly telling the user what is about to happe
### Reusing User Interactive Authentication sessions ### Reusing User Interactive Authentication sessions
The security of this relies on User Interactive Authentication sessions only The security of this relies on User Interactive Authentication sessions only
being used for the same request as they were initiated for. It is not believed being used for the same request as they were initiated for. This security is not
that this is currently enforced. only a concern for the proposed SSO authentication type. It is not believed
that this is currently enforced in implementations.
## Unstable prefix ## Unstable prefix