MSC2499: Fixes for Well-known URIs #2499
There are no files selected for viewing
This file contains hidden or 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,28 @@ | ||||||||
| # MSC2499: Fixes for Well-Known URIs | ||||||||
|
|
||||||||
| Several minor issues and inconsistencies have come up with the well-known URIs used for | ||||||||
| discovering clients and servers. This proposal intends to fix these issues. | ||||||||
|
|
||||||||
| ## Proposal | ||||||||
|
|
||||||||
| The following changes should be made to the spec: | ||||||||
|
|
||||||||
| 1. The spec does not mention that redirects should be followed for `/.well-known/matrix/client` | ||||||||
| and does not clearly specify what type of redirects should be followed for `/.well-known/matrix/server`. | ||||||||
| To fix this, the spec should be changed to state that when a well-known URI is requested, | ||||||||
| the client or server should follow HTTP 301, 302, 303, 307, and 308 redirects up to 30 times. | ||||||||
aaronraimist marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||
|
|
||||||||
| 1. Currently the spec does not mention which Content-Type should be used for the response to | ||||||||
| `/.well-known/matrix/client`. The Client-Server spec should be changed to state the Content-Type | ||||||||
| SHOULD be `application/json` however it should be assumed to be JSON regardless of Content-Type. | ||||||||
| This is consistent with the Server-Server API. | ||||||||
|
|
||||||||
| 1. Step 3f in the Client-Server well-known flow should be changed to use the modern | ||||||||
|
Member
There was a problem hiding this comment.
Suggested change
The latest rendering of the spec uses numbers for the sub-steps instead of letters |
||||||||
| `/_matrix/identity/versions` API to validate the identity server rather than the deprecated | ||||||||
| `/_matrix/identity/api/v1`. | ||||||||
|
|
||||||||
| 1. Mark the `/_matrix/identity/v2` status check API as deprecated. `/_matrix/identity/versions` | ||||||||
| is the suggested replacement. | ||||||||
|
|
||||||||
| 1. The maximum size of the well-known file is 51200 bytes. A client or server | ||||||||
| requesting a well-known file MUST abort and FAIL_PROMPT if the response exceeds 51200 bytes. | ||||||||
|
Member
There was a problem hiding this comment.
Suggested change
Member
There was a problem hiding this comment. (Though #2499 (comment) says that this check is supposed to be removed entirely.) |
||||||||
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.
The server-server spec simply states
30x redirects should be followed, however redirection loops should be avoided.which is short, reasonable but not overcomplicated. Adopting the same for the Client-Server spec sounds reasonable?