mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-04-25 03:54:10 +02:00
Compare commits
9 commits
f588b42d76
...
f0a1ee14d9
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f0a1ee14d9 | ||
|
|
ae9a8c319f | ||
|
|
866c05f487 | ||
|
|
7470c72d94 | ||
|
|
643a6dca2d | ||
|
|
cbf1854b93 | ||
|
|
2c734c3c5b | ||
|
|
075d203ecd | ||
|
|
4ed55a60ec |
|
|
@ -0,0 +1 @@
|
||||||
|
Correct null value handling for the AS Registration's `url` property.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
Rooms published in `/publicRooms` don't necessarily have `public` join rules or `world_readable` history visibility.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
Spaces are subject to the same access mechanisms as rooms.
|
||||||
1
changelogs/client_server/newsfragments/2122.feature
Normal file
1
changelogs/client_server/newsfragments/2122.feature
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Include device keys with Olm-encrypted events as per [MSC4147](https://github.com/matrix-org/matrix-spec-proposals/pull/4147).
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
Fix typo: as->has.
|
||||||
1
changelogs/internal/newsfragments/2137.clarification
Normal file
1
changelogs/internal/newsfragments/2137.clarification
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Update the header navigation menu with links to modern matrix.org. Contributed by @HarHarLinks.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
Rooms published in `/publicRooms` don't necessarily have `public` join rules or `world_readable` history visibility.
|
||||||
|
|
@ -23,15 +23,15 @@ description = "Home of the Matrix specification for decentralised communication"
|
||||||
[menus]
|
[menus]
|
||||||
[[menus.main]]
|
[[menus.main]]
|
||||||
name = 'Foundation'
|
name = 'Foundation'
|
||||||
url = 'https://matrix.org/foundation/'
|
url = 'https://matrix.org/foundation/about/'
|
||||||
weight = 10
|
weight = 10
|
||||||
[[menus.main]]
|
[[menus.main]]
|
||||||
name = 'FAQs'
|
name = 'User Docs'
|
||||||
url = 'https://matrix.org/faq'
|
url = 'https://matrix.org/docs/'
|
||||||
weight = 20
|
weight = 20
|
||||||
[[menus.main]]
|
[[menus.main]]
|
||||||
name = 'Blog'
|
name = 'Blog'
|
||||||
url = 'https://matrix.org/blog/posts'
|
url = 'https://matrix.org/blog/'
|
||||||
weight = 30
|
weight = 30
|
||||||
|
|
||||||
[markup]
|
[markup]
|
||||||
|
|
|
||||||
|
|
@ -492,10 +492,10 @@ via the query string). It is expected that the application service use
|
||||||
the transactions pushed to it to handle events rather than syncing with
|
the transactions pushed to it to handle events rather than syncing with
|
||||||
the user implied by `sender_localpart`.
|
the user implied by `sender_localpart`.
|
||||||
|
|
||||||
#### Application service room directories
|
#### Published room directories
|
||||||
|
|
||||||
Application services can maintain their own room directories for their
|
Application services can maintain their own published room directories for
|
||||||
defined third-party protocols. These room directories may be accessed by
|
their defined third-party protocols. These directories may be accessed by
|
||||||
clients through additional parameters on the `/publicRooms`
|
clients through additional parameters on the `/publicRooms`
|
||||||
client-server endpoint.
|
client-server endpoint.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2909,7 +2909,35 @@ re-invited.
|
||||||
|
|
||||||
{{% http-api spec="client-server" api="banning" %}}
|
{{% http-api spec="client-server" api="banning" %}}
|
||||||
|
|
||||||
### Listing rooms
|
### Published room directory
|
||||||
|
|
||||||
|
Homeservers MAY publish a room directory to allow users to discover rooms. A room
|
||||||
|
can have one of two visibility settings in the directory:
|
||||||
|
|
||||||
|
- `public`: The room will be shown in the published room directory.
|
||||||
|
- `private`: The room will be hidden from the published room directory.
|
||||||
|
|
||||||
|
Clients can define a room's initial visibility in the directory via the `visibility`
|
||||||
|
parameter in [`/createRoom`](#post_matrixclientv3createroom). Irrespective of room
|
||||||
|
creation, clients can query and change a room's visibility in the directory through
|
||||||
|
the endpoints listed below, provided that the server permits this.
|
||||||
|
|
||||||
|
{{% boxes/warning %}}
|
||||||
|
The visibility setting merely defines whether a room is included in the published
|
||||||
|
room directory or not. It doesn't make any guarantees about the room's
|
||||||
|
[join rule](#mroomjoin_rules) or [history visibility](#room-history-visibility).
|
||||||
|
|
||||||
|
In particular, a visibility setting of `public` should not be confused with a `public`
|
||||||
|
join rule. Rooms with a join rule of `knock`, for instance, could reasonably be published
|
||||||
|
in the directory, too.
|
||||||
|
|
||||||
|
Similarly, a visibility setting of `public` does not necessarily imply a `world_readable`
|
||||||
|
history visibility.
|
||||||
|
|
||||||
|
To increase performance or by preference, servers MAY apply additional filters when listing the
|
||||||
|
directory, for instance, by automatically excluding rooms with `invite` join rules
|
||||||
|
that are not `world_readable` regardless of their visibility.
|
||||||
|
{{% /boxes/warning %}}
|
||||||
|
|
||||||
{{% http-api spec="client-server" api="list_public_rooms" %}}
|
{{% http-api spec="client-server" api="list_public_rooms" %}}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -528,7 +528,7 @@ messages, Alice only sends one request event (an event with type
|
||||||
`m.room.message` with `msgtype: m.key.verification.request`, rather than an
|
`m.room.message` with `msgtype: m.key.verification.request`, rather than an
|
||||||
event with type `m.key.verification.request`), to the room. In addition, Alice
|
event with type `m.key.verification.request`), to the room. In addition, Alice
|
||||||
does not send an `m.key.verification.cancel` event to tell Bob's other devices
|
does not send an `m.key.verification.cancel` event to tell Bob's other devices
|
||||||
that the request as already been accepted; instead, when Bob's other devices
|
that the request has already been accepted; instead, when Bob's other devices
|
||||||
see his `m.key.verification.ready` event, they will know that the request has
|
see his `m.key.verification.ready` event, they will know that the request has
|
||||||
already been accepted, and that they should ignore the request.
|
already been accepted, and that they should ignore the request.
|
||||||
|
|
||||||
|
|
@ -1512,40 +1512,11 @@ message.
|
||||||
|
|
||||||
The plaintext payload is of the form:
|
The plaintext payload is of the form:
|
||||||
|
|
||||||
```json
|
{{% definition path="api/client-server/definitions/olm_payload" %}}
|
||||||
{
|
|
||||||
"type": "<type of the plaintext event>",
|
|
||||||
"content": "<content for the plaintext event>",
|
|
||||||
"sender": "<sender_user_id>",
|
|
||||||
"recipient": "<recipient_user_id>",
|
|
||||||
"recipient_keys": {
|
|
||||||
"ed25519": "<our_ed25519_key>"
|
|
||||||
},
|
|
||||||
"keys": {
|
|
||||||
"ed25519": "<sender_ed25519_key>"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The type and content of the plaintext message event are given in the
|
The type and content of the plaintext message event are given in the
|
||||||
payload.
|
payload.
|
||||||
|
|
||||||
Other properties are included in order to prevent an attacker from
|
|
||||||
publishing someone else's curve25519 keys as their own and subsequently
|
|
||||||
claiming to have sent messages which they didn't. `sender` must
|
|
||||||
correspond to the user who sent the event, `recipient` to the local
|
|
||||||
user, and `recipient_keys` to the local ed25519 key.
|
|
||||||
|
|
||||||
Clients must confirm that the `sender_key` property in the cleartext
|
|
||||||
`m.room.encrypted` event body, and the `keys.ed25519` property in the
|
|
||||||
decrypted plaintext, match the keys returned by
|
|
||||||
[`/keys/query`](#post_matrixclientv3keysquery) for
|
|
||||||
the given user. Clients must also verify the signature of the keys from the
|
|
||||||
`/keys/query` response. Without this check, a client cannot be sure that
|
|
||||||
the sender device owns the private part of the ed25519 key it claims to
|
|
||||||
have in the Olm payload. This is crucial when the ed25519 key corresponds
|
|
||||||
to a verified device.
|
|
||||||
|
|
||||||
If a client has multiple sessions established with another device, it
|
If a client has multiple sessions established with another device, it
|
||||||
should use the session from which it last received and successfully
|
should use the session from which it last received and successfully
|
||||||
decrypted a message. For these purposes, a session that has not received
|
decrypted a message. For these purposes, a session that has not received
|
||||||
|
|
@ -1555,6 +1526,68 @@ maximum number of olm sessions that it will maintain for each device,
|
||||||
and expiring sessions on a Least Recently Used basis. The maximum number
|
and expiring sessions on a Least Recently Used basis. The maximum number
|
||||||
of olm sessions maintained per device should be at least 4.
|
of olm sessions maintained per device should be at least 4.
|
||||||
|
|
||||||
|
###### Validation of incoming decrypted events
|
||||||
|
|
||||||
|
{{% changed-in v="1.15" %}} Existing checks made more explicit, and checks for `sender_device_keys` added.
|
||||||
|
|
||||||
|
After decrypting an incoming encrypted event, clients MUST apply the
|
||||||
|
following checks:
|
||||||
|
|
||||||
|
1. The `sender` property in the decrypted content must match the
|
||||||
|
`sender` of the event.
|
||||||
|
2. The `keys.ed25519` property in the decrypted content must match
|
||||||
|
the `sender_key` property in the cleartext `m.room.encrypted`
|
||||||
|
event body.
|
||||||
|
3. The `recipient` property in the decrypted content must match
|
||||||
|
the user ID of the local user.
|
||||||
|
4. The `recipient_keys.ed25519` property in the decrypted content
|
||||||
|
must match the client device's [Ed25519 signing key](#device-keys).
|
||||||
|
5. Where `sender_device_keys` is present in the decrypted content:
|
||||||
|
1. `sender_device_keys.user_id` must also match the `sender`
|
||||||
|
of the event.
|
||||||
|
2. `sender_device_keys.keys.ed25519:<device_id>` must also match
|
||||||
|
the `sender_key` property in the cleartext `m.room.encrypted`
|
||||||
|
event body.
|
||||||
|
3. `sender_device_keys.keys.curve25519:<device_id>` must match
|
||||||
|
the Curve25519 key used to establish the Olm session.
|
||||||
|
4. The `sender_device_keys` structure must have a valid signature
|
||||||
|
from the key with ID `ed25519:<device_id>` (i.e., the sending
|
||||||
|
device's Ed25519 key).
|
||||||
|
|
||||||
|
Any event that does not comply with these checks MUST be discarded.
|
||||||
|
|
||||||
|
###### Verification of the sending user for incoming events
|
||||||
|
|
||||||
|
{{% added-in v="1.15" %}}
|
||||||
|
|
||||||
|
In addition, for each Olm session, clients MUST verify that the
|
||||||
|
Curve25519 key used to establish the Olm session does indeed belong
|
||||||
|
to the claimed `sender`. This requires a signed "device keys" structure
|
||||||
|
for that Curve25519 key, which can be obtained in one of two ways:
|
||||||
|
|
||||||
|
1. An Olm message may be received with a `sender_device_keys` property
|
||||||
|
in the decrypted content.
|
||||||
|
2. The keys are returned via a [`/keys/query`](#post_matrixclientv3keysquery)
|
||||||
|
request. Note that both the Curve25519 key **and** the Ed25519 key in
|
||||||
|
the returned device keys structure must match those used in an
|
||||||
|
Olm-encrypted event as above. (In particular, the Ed25519 key must
|
||||||
|
be present in the **encrypted** content of an Olm-encrypted event
|
||||||
|
to prevent an attacker from claiming another user's Curve25519 key
|
||||||
|
as their own.)
|
||||||
|
|
||||||
|
Ownership of the Curve25519 key is then established in one of two ways:
|
||||||
|
|
||||||
|
1. Via [cross-signing](#cross-signing). For this to be sufficient, the
|
||||||
|
device keys structure must be signed by the sender's self-signing key,
|
||||||
|
and that self-signing key must itself have been validated (either via
|
||||||
|
[explicit verification](#device-verification) or a "trust on first use" (TOFU) mechanism).
|
||||||
|
2. Via explicit verification of the device's Ed25519 signing key, as
|
||||||
|
contained in the device keys structure. This is no longer recommended.
|
||||||
|
|
||||||
|
A failure to complete these verifications does not necessarily mean that
|
||||||
|
the session is bogus; however it is the case that there is no proof that
|
||||||
|
the claimed sender is accurate, and the user should be warned accordingly.
|
||||||
|
|
||||||
###### Recovering from undecryptable messages
|
###### Recovering from undecryptable messages
|
||||||
|
|
||||||
Occasionally messages may be undecryptable by clients due to a variety
|
Occasionally messages may be undecryptable by clients due to a variety
|
||||||
|
|
|
||||||
|
|
@ -2,8 +2,8 @@
|
||||||
|
|
||||||
{{% added-in v="1.2" %}}
|
{{% added-in v="1.2" %}}
|
||||||
|
|
||||||
Often used to group rooms of similar subject matter (such as a public "Official
|
Often used to group rooms of similar subject matter (such as an "Official
|
||||||
matrix.org rooms" space or personal "Work stuff" space), spaces are a way to
|
matrix.org rooms" space or a "Work stuff" space), spaces are a way to
|
||||||
organise rooms while being represented as rooms themselves.
|
organise rooms while being represented as rooms themselves.
|
||||||
|
|
||||||
A space is defined by the [`m.space` room type](#types), making it known as a
|
A space is defined by the [`m.space` room type](#types), making it known as a
|
||||||
|
|
@ -18,11 +18,11 @@ In the default power level structure, this would be `100`. Clients might wish to
|
||||||
go a step further and explicitly ignore notification counts on space-rooms.
|
go a step further and explicitly ignore notification counts on space-rooms.
|
||||||
|
|
||||||
Membership of a space is defined and controlled by the existing mechanisms which
|
Membership of a space is defined and controlled by the existing mechanisms which
|
||||||
govern a room: [`m.room.member`](#mroommember), [`m.room.history_visibility`](#mroomhistory_visibility),
|
govern a room: [`m.room.member`](/client-server-api#mroommember), [`m.room.history_visibility`](/client-server-api#mroomhistory_visibility),
|
||||||
and [`m.room.join_rules`](#mroomjoin_rules). Public spaces are encouraged to have
|
and [`m.room.join_rules`](/client-server-api#mroomjoin_rules). Canonical aliases and invites, including
|
||||||
a similar setup to public rooms: `world_readable` history visibility, published
|
third-party invites, still work just as they do in normal rooms as well. Furthermore,
|
||||||
canonical alias, and suitably public `join_rule`. Invites, including third-party
|
spaces can also be published in the [room directory](/client-server-api#published-room-directory) to make them
|
||||||
invites, still work just as they do in normal rooms as well.
|
discoverable.
|
||||||
|
|
||||||
All other aspects of regular rooms are additionally carried over, such as the
|
All other aspects of regular rooms are additionally carried over, such as the
|
||||||
ability to set arbitrary state events, hold room account data, etc. Spaces are
|
ability to set arbitrary state events, hold room account data, etc. Spaces are
|
||||||
|
|
@ -87,10 +87,9 @@ the state of `#space:example.org` would consist of:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
No state events in the child rooms themselves would be required (though they
|
No state events in the child rooms themselves would be required (though they can also
|
||||||
can also be present). This allows for users
|
be present). This allows for users to define spaces without needing explicit permission
|
||||||
to define personal/private spaces to organise their own rooms without needing explicit
|
from the room moderators/admins.
|
||||||
permission from the room moderators/admins.
|
|
||||||
|
|
||||||
Child rooms can be removed from a space by omitting the `via` key of `content` on the
|
Child rooms can be removed from a space by omitting the `via` key of `content` on the
|
||||||
relevant state event, such as through redaction or otherwise clearing the `content`.
|
relevant state event, such as through redaction or otherwise clearing the `content`.
|
||||||
|
|
|
||||||
|
|
@ -1048,11 +1048,10 @@ user's Matrix ID and the token delivered when the invite was stored,
|
||||||
this verification will prove that the `m.room.member` invite event comes
|
this verification will prove that the `m.room.member` invite event comes
|
||||||
from the user owning the invited third-party identifier.
|
from the user owning the invited third-party identifier.
|
||||||
|
|
||||||
## Public Room Directory
|
## Published Room Directory
|
||||||
|
|
||||||
To complement the [Client-Server
|
To complement the [room directory in the Client-Server API](/client-server-api#published-room-directory),
|
||||||
API](/client-server-api)'s room directory,
|
homeservers need a way to query the published rooms of another server.
|
||||||
homeservers need a way to query the public rooms for another server.
|
|
||||||
This can be done by making a request to the `/publicRooms` endpoint for
|
This can be done by making a request to the `/publicRooms` endpoint for
|
||||||
the server the room directory should be retrieved for.
|
the server the room directory should be retrieved for.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -19,7 +19,7 @@ properties:
|
||||||
type: string
|
type: string
|
||||||
description: A unique, user-defined ID of the application service which will never change.
|
description: A unique, user-defined ID of the application service which will never change.
|
||||||
url:
|
url:
|
||||||
type: string
|
type: ["null", "string"]
|
||||||
description: The URL for the application service. May include a path after the domain name. Optionally set to null if no traffic is required.
|
description: The URL for the application service. May include a path after the domain name. Optionally set to null if no traffic is required.
|
||||||
as_token:
|
as_token:
|
||||||
type: string
|
type: string
|
||||||
|
|
|
||||||
|
|
@ -13,18 +13,21 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
openapi: 3.1.0
|
openapi: 3.1.0
|
||||||
info:
|
info:
|
||||||
title: Matrix Client-Server Application Service Room Directory API
|
title: Matrix Client-Server Application Service Published Room Directory API
|
||||||
version: 1.0.0
|
version: 1.0.0
|
||||||
paths:
|
paths:
|
||||||
"/directory/list/appservice/{networkId}/{roomId}":
|
"/directory/list/appservice/{networkId}/{roomId}":
|
||||||
put:
|
put:
|
||||||
summary: Updates a room's visibility in the application service's room directory.
|
summary: |-
|
||||||
description: |-
|
Updates a room's visibility in the application service's published room
|
||||||
Updates the visibility of a given room on the application service's room
|
|
||||||
directory.
|
directory.
|
||||||
|
description: |-
|
||||||
|
Updates the visibility of a given room in the application service's
|
||||||
|
published room directory.
|
||||||
|
|
||||||
This API is similar to the room directory visibility API used by clients
|
This API is similar to the
|
||||||
to update the homeserver's more general room directory.
|
[visibility API](/client-server-api#put_matrixclientv3directorylistroomroomid)
|
||||||
|
used by clients to update the homeserver's more general published room directory.
|
||||||
|
|
||||||
This API requires the use of an application service access token (`as_token`)
|
This API requires the use of an application service access token (`as_token`)
|
||||||
instead of a typical client's access_token. This API cannot be invoked by
|
instead of a typical client's access_token. This API cannot be invoked by
|
||||||
|
|
|
||||||
|
|
@ -87,12 +87,9 @@ paths:
|
||||||
- public
|
- public
|
||||||
- private
|
- private
|
||||||
description: |-
|
description: |-
|
||||||
A `public` visibility indicates that the room will be shown
|
The room's visibility in the server's
|
||||||
in the published room list. A `private` visibility will hide
|
[published room directory](/client-server-api#published-room-directory).
|
||||||
the room from the published room list. Rooms default to
|
Defaults to `private`.
|
||||||
`private` visibility if this key is not included. NB: This
|
|
||||||
should not be confused with `join_rules` which also uses the
|
|
||||||
word `public`.
|
|
||||||
room_alias_name:
|
room_alias_name:
|
||||||
type: string
|
type: string
|
||||||
description: |-
|
description: |-
|
||||||
|
|
|
||||||
88
data/api/client-server/definitions/olm_payload.yaml
Normal file
88
data/api/client-server/definitions/olm_payload.yaml
Normal file
|
|
@ -0,0 +1,88 @@
|
||||||
|
# Copyright 2025 The Matrix.org Foundation C.I.C
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
|
||||||
|
|
||||||
|
type: object
|
||||||
|
title: OlmPayload
|
||||||
|
description: |-
|
||||||
|
The plaintext payload of Olm message events.
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
type: string
|
||||||
|
description: The type of the event.
|
||||||
|
content:
|
||||||
|
type: object
|
||||||
|
description: The event content.
|
||||||
|
sender:
|
||||||
|
type: string
|
||||||
|
description: The user ID of the event sender.
|
||||||
|
recipient:
|
||||||
|
type: string
|
||||||
|
description: The user ID of the intended event recipient.
|
||||||
|
recipient_keys:
|
||||||
|
description: The recipient's signing keys of the encrypted event.
|
||||||
|
$ref: "#/components/schemas/SigningKeys"
|
||||||
|
keys:
|
||||||
|
$ref: "#/components/schemas/SigningKeys"
|
||||||
|
description: The sender's signing keys of the encrypted event.
|
||||||
|
sender_device_keys:
|
||||||
|
$ref: device_keys.yaml
|
||||||
|
description: The sender's device keys.
|
||||||
|
x-addedInMatrixVersion: "1.15"
|
||||||
|
required:
|
||||||
|
- type
|
||||||
|
- content
|
||||||
|
- sender
|
||||||
|
- recipient
|
||||||
|
- recipient_keys
|
||||||
|
- keys
|
||||||
|
components:
|
||||||
|
schemas:
|
||||||
|
SigningKeys:
|
||||||
|
type: object
|
||||||
|
title: SigningKeys
|
||||||
|
description: Public keys used for an `m.olm.v1.curve25519-aes-sha2` event.
|
||||||
|
properties:
|
||||||
|
ed25519:
|
||||||
|
type: string
|
||||||
|
description: The Ed25519 public key encoded using unpadded base64.
|
||||||
|
required:
|
||||||
|
- ed25519
|
||||||
|
example: {
|
||||||
|
"type": "<type of the plaintext event>",
|
||||||
|
"content": "<content for the plaintext event>",
|
||||||
|
"sender": "<sender_user_id>",
|
||||||
|
"recipient": "<recipient_user_id>",
|
||||||
|
"recipient_keys": {
|
||||||
|
"ed25519": "<our_ed25519_key>"
|
||||||
|
},
|
||||||
|
"keys": {
|
||||||
|
"ed25519": "<sender_ed25519_key>"
|
||||||
|
},
|
||||||
|
"sender_device_keys": {
|
||||||
|
"algorithms": ["<supported>", "<algorithms>"],
|
||||||
|
"user_id": "<user_id>",
|
||||||
|
"device_id": "<device_id>",
|
||||||
|
"keys": {
|
||||||
|
"ed25519:<device_id>": "<sender_ed25519_key>",
|
||||||
|
"curve25519:<device_id>": "<sender_curve25519_key>"
|
||||||
|
},
|
||||||
|
"signatures": {
|
||||||
|
"<user_id>": {
|
||||||
|
"ed25519:<device_id>": "<device_signature>",
|
||||||
|
"ed25519:<ssk_id>": "<ssk_signature>",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -13,7 +13,7 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
type: object
|
type: object
|
||||||
title: "PublicRoomsChunk"
|
title: "PublishedRoomsChunk"
|
||||||
properties:
|
properties:
|
||||||
canonical_alias:
|
canonical_alias:
|
||||||
type: string
|
type: string
|
||||||
|
|
|
||||||
|
|
@ -13,28 +13,15 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
type: object
|
type: object
|
||||||
description: A list of the rooms on the server.
|
description: A list of the published rooms on the server.
|
||||||
required: ["chunk"]
|
required: ["chunk"]
|
||||||
properties:
|
properties:
|
||||||
chunk:
|
chunk:
|
||||||
type: array
|
type: array
|
||||||
description: |-
|
description: |-
|
||||||
A paginated chunk of public rooms.
|
A paginated chunk of published rooms.
|
||||||
items:
|
items:
|
||||||
allOf:
|
$ref: "public_rooms_chunk.yaml"
|
||||||
- $ref: "public_rooms_chunk.yaml"
|
|
||||||
- type: object
|
|
||||||
title: PublicRoomsChunk
|
|
||||||
properties:
|
|
||||||
# Override description of join_rule
|
|
||||||
join_rule:
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
The room's join rule. When not present, the room is assumed to
|
|
||||||
be `public`. Note that rooms with `invite` join rules are not
|
|
||||||
expected here, but rooms with `knock` rules are given their
|
|
||||||
near-public nature.
|
|
||||||
example: "public"
|
|
||||||
next_batch:
|
next_batch:
|
||||||
type: string
|
type: string
|
||||||
description: |-
|
description: |-
|
||||||
|
|
@ -50,7 +37,7 @@ properties:
|
||||||
total_room_count_estimate:
|
total_room_count_estimate:
|
||||||
type: integer
|
type: integer
|
||||||
description: |-
|
description: |-
|
||||||
An estimate on the total number of public rooms, if the
|
An estimate on the total number of published rooms, if the
|
||||||
server has an estimate.
|
server has an estimate.
|
||||||
example: {
|
example: {
|
||||||
"chunk": [
|
"chunk": [
|
||||||
|
|
|
||||||
|
|
@ -13,14 +13,15 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
openapi: 3.1.0
|
openapi: 3.1.0
|
||||||
info:
|
info:
|
||||||
title: Matrix Client-Server Room Directory API
|
title: Matrix Client-Server Published Room Directory API
|
||||||
version: 1.0.0
|
version: 1.0.0
|
||||||
paths:
|
paths:
|
||||||
"/directory/list/room/{roomId}":
|
"/directory/list/room/{roomId}":
|
||||||
get:
|
get:
|
||||||
summary: Gets the visibility of a room in the directory
|
summary: Gets the visibility of a room in the directory
|
||||||
description: Gets the visibility of a given room on the server's public room
|
description: |-
|
||||||
directory.
|
Gets the visibility of a given room in the server's
|
||||||
|
published room directory.
|
||||||
operationId: getRoomVisibilityOnDirectory
|
operationId: getRoomVisibilityOnDirectory
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
|
@ -32,7 +33,7 @@ paths:
|
||||||
type: string
|
type: string
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: The visibility of the room in the directory
|
description: The visibility of the room in the directory.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -50,7 +51,7 @@ paths:
|
||||||
"visibility": "public"
|
"visibility": "public"
|
||||||
}
|
}
|
||||||
"404":
|
"404":
|
||||||
description: The room is not known to the server
|
description: The room is not known to the server.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -64,14 +65,13 @@ paths:
|
||||||
tags:
|
tags:
|
||||||
- Room discovery
|
- Room discovery
|
||||||
put:
|
put:
|
||||||
summary: Sets the visibility of a room in the room directory
|
summary: Sets the visibility of a room in the directory
|
||||||
description: |-
|
description: |-
|
||||||
Sets the visibility of a given room in the server's public room
|
Sets the visibility of a given room in the server's published room directory.
|
||||||
directory.
|
|
||||||
|
|
||||||
Servers may choose to implement additional access control checks
|
Servers MAY implement additional access control checks, for instance,
|
||||||
here, for instance that room visibility can only be changed by
|
to ensure that a room's visibility can only be changed by the room creator
|
||||||
the room creator or a server administrator.
|
or a server administrator.
|
||||||
operationId: setRoomVisibilityOnDirectory
|
operationId: setRoomVisibilityOnDirectory
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
@ -97,11 +97,11 @@ paths:
|
||||||
- public
|
- public
|
||||||
description: |-
|
description: |-
|
||||||
The new visibility setting for the room.
|
The new visibility setting for the room.
|
||||||
Defaults to 'public'.
|
Defaults to `public`.
|
||||||
example: {
|
example: {
|
||||||
"visibility": "public"
|
"visibility": "public"
|
||||||
}
|
}
|
||||||
description: The new visibility for the room on the room directory.
|
description: The new visibility for the room in the published room directory.
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
|
|
@ -114,7 +114,7 @@ paths:
|
||||||
response:
|
response:
|
||||||
value: {}
|
value: {}
|
||||||
"404":
|
"404":
|
||||||
description: The room is not known to the server
|
description: The room is not known to the server.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -129,9 +129,9 @@ paths:
|
||||||
- Room discovery
|
- Room discovery
|
||||||
/publicRooms:
|
/publicRooms:
|
||||||
get:
|
get:
|
||||||
summary: Lists the public rooms on the server.
|
summary: Lists a server's published room directory
|
||||||
description: |-
|
description: |-
|
||||||
Lists the public rooms on the server.
|
Lists a server's published room directory.
|
||||||
|
|
||||||
This API returns paginated responses. The rooms are ordered by the number
|
This API returns paginated responses. The rooms are ordered by the number
|
||||||
of joined members, with the largest rooms first.
|
of joined members, with the largest rooms first.
|
||||||
|
|
@ -154,13 +154,13 @@ paths:
|
||||||
- in: query
|
- in: query
|
||||||
name: server
|
name: server
|
||||||
description: |-
|
description: |-
|
||||||
The server to fetch the public room lists from. Defaults to the
|
The server to fetch the published room directory from. Defaults
|
||||||
local server. Case sensitive.
|
to the local server. Case sensitive.
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: A list of the rooms on the server.
|
description: A list of the published rooms on the server.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
@ -168,9 +168,9 @@ paths:
|
||||||
tags:
|
tags:
|
||||||
- Room discovery
|
- Room discovery
|
||||||
post:
|
post:
|
||||||
summary: Lists the public rooms on the server with optional filter.
|
summary: Lists a server's published room directory with an optional filter
|
||||||
description: |-
|
description: |-
|
||||||
Lists the public rooms on the server, with optional filter.
|
Lists a server's published room directory with an optional filter.
|
||||||
|
|
||||||
This API returns paginated responses. The rooms are ordered by the number
|
This API returns paginated responses. The rooms are ordered by the number
|
||||||
of joined members, with the largest rooms first.
|
of joined members, with the largest rooms first.
|
||||||
|
|
@ -182,8 +182,8 @@ paths:
|
||||||
- in: query
|
- in: query
|
||||||
name: server
|
name: server
|
||||||
description: |-
|
description: |-
|
||||||
The server to fetch the public room lists from. Defaults to the
|
The server to fetch the published room directory from. Defaults
|
||||||
local server. Case sensitive.
|
to the local server. Case sensitive.
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
requestBody:
|
requestBody:
|
||||||
|
|
@ -253,7 +253,7 @@ paths:
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: A list of the rooms on the server.
|
description: A filtered list of the published rooms on the server.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
|
|
|
||||||
|
|
@ -13,16 +13,20 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
openapi: 3.1.0
|
openapi: 3.1.0
|
||||||
info:
|
info:
|
||||||
title: Matrix Federation Public Rooms API
|
title: Matrix Federation Published Room Directory API
|
||||||
version: 1.0.0
|
version: 1.0.0
|
||||||
paths:
|
paths:
|
||||||
/publicRooms:
|
/publicRooms:
|
||||||
get:
|
get:
|
||||||
summary: Get all the public rooms for a homeserver
|
summary: Lists the server's published room directory
|
||||||
description: |-
|
description: |-
|
||||||
Gets all the public rooms for the homeserver. This should not return
|
Lists the server's published room directory.
|
||||||
rooms that are listed on another homeserver's directory, just those
|
|
||||||
listed on the receiving homeserver's directory.
|
This API returns paginated responses. The rooms are ordered by the number
|
||||||
|
of joined members, with the largest rooms first.
|
||||||
|
|
||||||
|
This SHOULD not return rooms that are listed on another homeserver's directory,
|
||||||
|
just those listed on the receiving homeserver's directory.
|
||||||
operationId: getPublicRooms
|
operationId: getPublicRooms
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -62,21 +66,18 @@ paths:
|
||||||
type: string
|
type: string
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: The public room list for the homeserver.
|
description: A list of the published rooms on the server.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: ../client-server/definitions/public_rooms_response.yaml
|
$ref: ../client-server/definitions/public_rooms_response.yaml
|
||||||
post:
|
post:
|
||||||
summary: Gets the public rooms on the server with optional filter.
|
summary: Lists the server's published room directory with an optional filter
|
||||||
description: |-
|
description: |-
|
||||||
Lists the public rooms on the server, with optional filter.
|
Lists the server's published room directory with an optional filter.
|
||||||
|
|
||||||
This API returns paginated responses. The rooms are ordered by the number
|
This API returns paginated responses. The rooms are ordered by the number
|
||||||
of joined members, with the largest rooms first.
|
of joined members, with the largest rooms first.
|
||||||
|
|
||||||
Note that this endpoint receives and returns the same format that is seen
|
|
||||||
in the Client-Server API's `POST /publicRooms` endpoint.
|
|
||||||
operationId: queryPublicRooms
|
operationId: queryPublicRooms
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
@ -147,69 +148,11 @@ paths:
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: A list of the rooms on the server.
|
description: A filtered list of the published rooms on the server.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
$ref: ../client-server/definitions/public_rooms_response.yaml
|
||||||
description: A list of the rooms on the server.
|
|
||||||
required:
|
|
||||||
- chunk
|
|
||||||
properties:
|
|
||||||
chunk:
|
|
||||||
title: PublicRoomsChunks
|
|
||||||
type: array
|
|
||||||
description: A paginated chunk of public rooms.
|
|
||||||
items:
|
|
||||||
allOf:
|
|
||||||
- $ref: ../client-server/definitions/public_rooms_chunk.yaml
|
|
||||||
- type: object
|
|
||||||
properties:
|
|
||||||
# Override description of join_rule
|
|
||||||
join_rule:
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
The room's join rule. When not present, the room is assumed to
|
|
||||||
be `public`. Note that rooms with `invite` join rules are not
|
|
||||||
expected here, but rooms with `knock` rules are given their
|
|
||||||
near-public nature.
|
|
||||||
next_batch:
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
A pagination token for the response. The absence of this token
|
|
||||||
means there are no more results to fetch and the client should
|
|
||||||
stop paginating.
|
|
||||||
prev_batch:
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
A pagination token that allows fetching previous results. The
|
|
||||||
absence of this token means there are no results before this
|
|
||||||
batch, i.e. this is the first batch.
|
|
||||||
total_room_count_estimate:
|
|
||||||
type: integer
|
|
||||||
description: |-
|
|
||||||
An estimate on the total number of public rooms, if the
|
|
||||||
server has an estimate.
|
|
||||||
examples:
|
|
||||||
response:
|
|
||||||
value: {
|
|
||||||
"chunk": [
|
|
||||||
{
|
|
||||||
"avatar_url": "mxc://bleecker.street/CHEDDARandBRIE",
|
|
||||||
"guest_can_join": false,
|
|
||||||
"name": "CHEESE",
|
|
||||||
"num_joined_members": 37,
|
|
||||||
"room_id": "!ol19s:bleecker.street",
|
|
||||||
"topic": "Tasty tasty cheese",
|
|
||||||
"world_readable": true,
|
|
||||||
"join_rule": "public",
|
|
||||||
"room_type": "m.space"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"next_batch": "p190q",
|
|
||||||
"prev_batch": "p1902",
|
|
||||||
"total_room_count_estimate": 115
|
|
||||||
}
|
|
||||||
servers:
|
servers:
|
||||||
- url: "{protocol}://{hostname}{basePath}"
|
- url: "{protocol}://{hostname}{basePath}"
|
||||||
variables:
|
variables:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue