Skip to content

Commit 782aed7

Browse files
authored
Add proposal for accepting query parameters to the login fallback endpoint. (#2604)
1 parent b770cfe commit 782aed7

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Parameters for Login Fallback
2+
3+
The [login fallback](https://matrix.org/docs/spec/client_server/r0.6.1#login-fallback)
4+
API can be used by clients to support logins that they do not recognize. It is
5+
expected to be loaded in a web view and calls a JavaScript function
6+
(`window.onLogin`) when the login process is complete.
7+
8+
Since the login fallback page does the full login process there is no
9+
opportunity for the application to provide a device ID (to re-authenticate
10+
an expired session in the [case of soft-logout](https://matrix.org/docs/spec/client_server/r0.6.1#soft-logout))
11+
or an [initial device display name](https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-login)
12+
(in the case of an initial login). This causes a few issues:
13+
14+
* It can make it difficult for a user to manage their sessions (as additional
15+
sessions get created for each soft-logout).
16+
* Cross-signing information gets reset when a new device ID is returned from the
17+
login process. This results in users needing to re-validate their device.
18+
19+
## Proposal
20+
21+
The login fallback page will accept query parameters for non-credential related
22+
parameters of the login endpoint. These will be forwarded by the login fallback
23+
API to the login API throughout the login process. Currently the following
24+
parameters should be accepted:
25+
26+
* `device_id`
27+
* `initial_device_display_name`
28+
29+
30+
## Potential issues
31+
32+
There are no backwards compatibility concerns: if a client provides the query
33+
parameters to a homeserver that does not check for them than the current
34+
behavior will occur.
35+
36+
37+
## Security considerations
38+
39+
None.

0 commit comments

Comments
 (0)