-
Notifications
You must be signed in to change notification settings - Fork 380
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MSC4190: Device management for application services #4190
Open
sandhose
wants to merge
3
commits into
main
Choose a base branch
from
quenting/as-device-management
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,48 @@ | ||
# MSC4190: Device management for application services | ||
|
||
[MSC3202] allows application services to handle and send encrypted events. | ||
One part of [MSC3202] is the ability to masquerade devices using the `device_id` query parameter on C-S API requests, which eliminates the need to maintain individual access tokens for each application service user. | ||
|
||
However, application services don't have an endpoint to create devices for their users, which means that, in practice, encrypted application services still use `/login` with the `m.login.application_service` login type to create devices for their users. | ||
|
||
Consequently, such application services leave many unused but active access tokens for those users. | ||
|
||
Furthermore, if [MSC3861] were adopted, the `/login` endpoint would no longer be available for application services to use. | ||
|
||
This MSC proposes a dedicated API endpoint for application services to create and delete devices for users, addressing the existing gap to enable encrypted application services without `/login`. | ||
|
||
## Proposal | ||
|
||
This MSC proposes to extend existing endpoints to allow application services to create and delete devices for their users without relying on the `/login` and `/logout` mechanisms. | ||
|
||
### **`PUT /_matrix/client/v3/devices/{deviceId}`** | ||
|
||
This endpoint is updated to allow the creation of a new device for a user, if the device ID does not exist. | ||
This behavior is only available to application services. | ||
|
||
This endpoint will use the 201 status code to indicate that a new device was created, in addition to the existing 200 status code for existing devices. | ||
|
||
### **`DELETE /_matrix/client/v3/devices/{deviceId}`** | ||
|
||
This endpoint no longer requires User-Interactive Authentication for application services. | ||
|
||
### **`POST /_matrix/client/v3/delete_devices`** | ||
|
||
This endpoint no longer requires User-Interactive Authentication for application services. | ||
|
||
### **`POST /_matrix/client/v3/register`** | ||
|
||
This endpoint no longer generates a new access token, as if `inhibit_login` was set to `true` in the request by default. | ||
|
||
## Alternatives | ||
|
||
A new set of endpoints dedicated to application services could be added to the specification, like `GET|PUT|DELETE /_matrix/client/v3/appservices/{appId}/devices/{deviceId}`. | ||
|
||
This would have the advantage of not changing the behavior of existing endpoints. | ||
|
||
## Unstable prefix | ||
|
||
Until this MSC is stable, application services must opt-in to the new behavior by setting the `io.element.msc4190` flag to `true` in their registration file. | ||
|
||
[MSC3202]: https://github.com/matrix-org/matrix-spec-proposals/pull/3202 | ||
[MSC3861]: https://github.com/matrix-org/matrix-spec-proposals/pull/3861 |
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.
Implementation requirements:
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.
Appservice implementation: mautrix/go#288