-
Notifications
You must be signed in to change notification settings - Fork 385
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
MSC2451: Remove query_auth
federation endpoint.
#2451
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
420180a
MSC: Remove query_auth federation endpoint.
clokep c342077
Clarify history of endpoint.
clokep 6754d5b
Move filename based on MSC #.
clokep 68357a7
Fix a typo in -> and.
clokep 61715f6
Update and expand the proposal based on feedback and additional info.
clokep 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 |
---|---|---|
|
@@ -12,3 +12,4 @@ | |
*.swp | ||
_rendered.rst | ||
/.vscode/ | ||
/.idea/ |
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,56 @@ | ||
# MSC2451: Remove the `query_auth` federation endpoint | ||
|
||
This API was added without sufficient thought nor testing. The endpoint isn't | ||
used in any known implementations, and we do not believe it to be necessary | ||
for federation to work. The only known implementation (in Synapse) was not fully | ||
fleshed out and is broken. | ||
|
||
For background, the idea behind this endpoint was that two homeservers would be | ||
able to share state events with the hope of filling in missing state from one | ||
of homeservers allowing state resolution to complete. This was to protect | ||
against a joining server not providing the full (or providing stale) state. | ||
|
||
In addition to the ideas above not coming to fruition, it is unclear whether the | ||
current design of this endpoint would be sufficient. If this state negotiation | ||
feature is needed in the future it should be redesigned from scratch via the MSC | ||
proposal process. | ||
|
||
## Proposal | ||
|
||
Remove the following endpoint: | ||
|
||
* [POST `/_matrix/federation/v1/query_auth/{roomId}/{eventId}`](https://matrix.org/docs/spec/server_server/r0.1.3#post-matrix-federation-v1-query-auth-roomid-eventid) | ||
|
||
## Potential issues | ||
|
||
Removing this endpoint impacts backwards compatibility, in practice removing | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure it's fair to say it impacts backwards compatibility, given the synapse code was unreachable even before 1.5? |
||
this endpoint should have minimal impact as it was an unused error path in | ||
Synapse. The federation client code to call this endpoint was removed in Synapse | ||
v1.5.0rc1. | ||
|
||
There is no evidence of other homeserver implementations having implemented this | ||
endpoint. | ||
|
||
### History | ||
|
||
This endpoint (and the federation client code) to call it was initially | ||
added in Synapse v0.7.0 (see [#43](https://github.com/matrix-org/synapse/pull/43)). | ||
The federation client code was heavily modified for v1.0.0rc1 (see | ||
[#5227](https://github.com/matrix-org/synapse/pull/5227/)), | ||
|
||
The federation client code to call this endpoint was removed in v1.5.0rc1 of | ||
Synapse (see [#6214](https://github.com/matrix-org/synapse/pull/6214). After | ||
that point this endpoint is not called). | ||
|
||
During removal it was noted that the code to call this endpoint was already | ||
unreachable. It seems that this code was never reachable and was meant for an | ||
error situation which was never built out (see `git log -S NOT_ANCESTOR`, the | ||
error condition is never assigned). | ||
|
||
## Alternatives | ||
|
||
The endpoint could be deprecated and removed in a future version of the specification. | ||
|
||
## Security considerations | ||
|
||
None. |
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.
state events or auth events?