Skip to content

MSC3938: Remove keyId from /keys endpoints #3938

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

Merged
merged 1 commit into from
Dec 26, 2022
Merged

MSC3938: Remove keyId from /keys endpoints #3938

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 31 additions & 0 deletions proposals/3938-remove-keyid-from-keys-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# MSC3938: Remove deprecated `keyId` parameters from `/keys` endpoints

The `keyId` path parameter on
[`GET /_matrix/key/v2/server/{keyId}`](https://spec.matrix.org/v1.5/server-server-api/#get_matrixkeyv2serverkeyid)
and [`GET /_matrix/key/v2/query/{serverName}/{keyId}`](https://spec.matrix.org/v1.5/server-server-api/#get_matrixkeyv2queryservernamekeyid)
has been deprecated since before the Matrix spec was formally versioned
([pull request](https://github.com/matrix-org/matrix-spec-proposals/pull/1423)).
Comment on lines +3 to +7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't explicitly called out, but I assume POST /_matrix/key/v2/query is unchanged by this MSC?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. That does not take a keyId parameter.


The reason for deprecation was primarily that it was never implemented
correctly: making a request with a `keyId` had the same effect as making a
request without one.

## Proposal

The deprecated `keyId` path parameter should be removed from
[`GET /_matrix/key/v2/server/{keyId}`](https://spec.matrix.org/v1.5/server-server-api/#get_matrixkeyv2serverkeyid)
and [`GET /_matrix/key/v2/query/{serverName}/{keyId}`](https://spec.matrix.org/v1.5/server-server-api/#get_matrixkeyv2queryservernamekeyid).

Furthermore, a trailing slash at the end of the endpoint path will no longer be permitted.

The new endpoints will simply be `GET /_matrix/key/v2/server` and `GET
/_matrix/key/v2/query/{serverName}` respectively, and they will return all
available keys for the given server.

## Potential issues

This is a breaking change: some servers (such as Synapse, until [very
recently](https://github.com/matrix-org/synapse/pull/14525)) may include the
`{keyId}` in outgoing requests.
Comment on lines +27 to +29
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We talked a bit about this in the synapse issue for how to support Matrix v1.6: matrix-org/synapse#15089 (comment)