Skip to content

Commit 538ac09

Browse files
authored
Update Alternatives section
1 parent 0c26298 commit 538ac09

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

proposals/2778-appservice-login.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,21 +67,41 @@ new devices should the appservice intentionally or inadvertently have lost the c
6767

6868
## Alternatives
6969

70+
### 1. Include the token in the `/login` request body
71+
7072
One minor tweak to the current proposal could be to include the token as part of the auth data, rather than
7173
being part of the header/params to the request. An argument could be made for either, but since the specification
7274
expects the appservice to pass the token this way in all requests, including `/register`, it seems wise to keep
7375
it that way.
7476

75-
Some community members have used implementation details such as a "shared secret" authentication method to
77+
### 2. Use implementation specific "shared secret" authentication
78+
79+
Some community members have used homeserver implementation details such as a "shared secret" authentication method to
7680
log into the accounts without having to use the /login process at all. Synapse provides such a function,
77-
but also means the appservice can now authenticate as any user on the homeserver. This seems undesirable from a
81+
but also means the appservice can now authenticate as any user on the homeserver. This is undesirable from a
7882
security standpoint.
7983

84+
### 3. Keep using `/register` solely
85+
8086
A third option could be to create a new endpoint that simply creates a new device for an appservice user on demand.
8187
Given the rest of the matrix eco-system does this with /login, and /login is already extensible with `type`, it would
8288
create more work for all parties involved for little benefit.
8389

84-
Finally, `POST /register` does already return a `device_id`, `access_token` for appservice users by default. However critically
90+
Finally, `POST /register` does already return a `device_id` and `access_token` so appservices
91+
could store this information rather than calling `POST /login` at all. This does however present a few problems:
92+
93+
- Quite a few appservices which only support unencrypted messaging do not use/store the `device_id`/`access_token` from a register call.
94+
In the event that an appservice eventually gains the ability to support encryption, they would be unable to fetch a new `device_id`/
95+
`access_token` for any existing users (as `/register` would fail for an existing user).
96+
- If user tokens were lost or exposed, there is no way to programattically create new access tokens for these users.
97+
- Finally, if a user was registered externally and the appservice would like to masquerade as it, it would be unable to fetch
98+
an access token for that user.
99+
100+
While `POST /register` does work, it is impactical as the sole method of fetching an access token.
101+
102+
103+
Most appservices
104+
which do not implement encryption do not store this information as neither the device_id or access_token are needed f However critically
85105
this means that bridges will need to be designed to store the access_token and device_id from the point of creating the user,
86106
so older bridges would be unable to get an access token for existing users as `POST /register` would fail.
87107
It would difficult to log out these tokens if they got exposed additionally, as the AS would not be able to fetch a new access token.

0 commit comments

Comments
 (0)