Skip to content
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.

Sign up for GitHub

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

Jump to bottom

MSC2499: Fixes for Well-known URIs #2499

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

MSC2499: Fixes for Well-known URIs #2499

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2f19796
Create MSC with fixes for client well-known
aaronraimist Apr 13, 2020
9ca1b65
Clarify redirects that should be followed, add maximum size
aaronraimist Apr 26, 2021
1a6a0e4
Remove change from FAIL_PROMPT to IGNORE
aaronraimist May 6, 2021
4c2d13a
Update proposals/2499-client-well-known-fixes.md
aaronraimist May 6, 2021
a8b5fbd
Deprecate /_matrix/identity/v2
aaronraimist May 6, 2021
4fb1292
Merge branch 'main' into fix-client-well-known
aaronraimist Dec 28, 2021
fb2186b
Remove duplicate words
aaronraimist Mar 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions proposals/2499-client-well-known-fixes.md
View file
Open in desktop
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
`/_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.