mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-20 16:38:37 +01:00
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
* Placeholder * i++ * Room version 12 Template out a v12 room version Make v12 default, per MSC4304 Update PDU checks and auth event selection per MSC4291 Describe new room_id format per MSC4291 Move v6 depth definition to a component for easier referencing Move room_id to a component to prep for v12, per MSC4291 Create and use a new room_id component for v12+ per MSC4291 Reflect auth events selection change onto all room versions per MSC4291 The MSC asks the `description` of `auth_events` to be adjusted, however this feels like a better representation of the change. Add `room_id` format rules and renumber per MSC4291 Reflect change to rule 1.2 per MSC4291 Insert same room_id check to v1-12 auth rules per MSC4307 and MSC4291 Deprecate `predecessor.event_id` per MSC4291 Insert auth rule to validate `additional_creators` per MSC4289 Insert rule for `users` validation of creators and renumber per MSC4289 Define "room creator(s)" per MSC4289 Spec `additional_creators` on create events per MSC4289 Spec `additional_creators` on `/upgrade` per MSC4289 The MSC doesn't mention how to handle unsupported room versions, but the Synapse implementation used for FCP ignores the field in such room versions. This feels like a good approach, and will need clarifying in the MSC too (if accepted at the spec level). Add notes to `/upgrade` behaviour per MSC4289 and MSC4291 Describe how additional creators work during room creation per MSC4289 Fix default user power level descriptions per MSC4289 Describe tombstone power level changes per MSC4289 Warn clients about event format changes in v12 per MSC4289 and MSC4291 Flag additional room creators support for client reference per MSC4289 Remove TODO now that it's fully addressed Copy state res into v12 as-is for modification Apply Modification 1 to SR2.1 per MSC4297 Apply Modification 2 to SR2.1 per MSC4297 Add summary box to the top of SR2.1 for ease of developer reference Modification 2 was split into items 2 and 3 for further ease of understanding. Add all the changelogs `x` is used until a real PR number can be assigned. Some changelogs are duplicated to the Client-Server API to increase visibility of the changes to v12. Review: Minor phrasing adjustments in changelogs Review: Clarify that v12 isn't quite the default yet in the changelog Review: Clarify to clients that creators are immutable Review: Improve 'how to parse a domain' advice for legacy apps Review: Add a bit more detail as to why a room ID might be required Apply suggestions from code review Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Clarify that clients can override the tombstone default Mention creatorship UI label by finishing the Permissions section We probably should have removed the WIP note in v1.0, but alas. Add changelog for tombstone changes Use assigned spec PR number in changelogs (cherry picked from commit ec81eea7e4532fd398b8013071d6981c97117d9e)
256 lines
11 KiB
Markdown
256 lines
11 KiB
Markdown
---
|
|
title: Room Version 6
|
|
type: docs
|
|
weight: 60
|
|
version: 6
|
|
---
|
|
|
|
This room version builds on [version 5](/rooms/v5) while changing various
|
|
authorization rules performed on events.
|
|
|
|
## Client considerations
|
|
|
|
There are no client considerations introduced in this room version. Clients
|
|
which implement the redaction algorithm locally should refer to the
|
|
[redactions](#redactions) section below for a full overview of the algorithm.
|
|
|
|
### Redactions
|
|
|
|
{{% added-in v=6 %}} All significant meaning for `m.room.aliases`
|
|
has been removed from the redaction algorithm. The remaining rules are
|
|
the same as past room versions.
|
|
|
|
{{% rver-fragment name="v6-redactions" %}}
|
|
|
|
## Server implementation components
|
|
|
|
{{% boxes/warning %}}
|
|
The information contained in this section is strictly for server
|
|
implementors. Applications which use the Client-Server API are generally
|
|
unaffected by the intricacies contained here. The section above
|
|
regarding client considerations is the resource that Client-Server API
|
|
use cases should reference.
|
|
{{% /boxes/warning %}}
|
|
|
|
Room version 6 makes the following alterations to algorithms described
|
|
in [room version 5](/rooms/v5).
|
|
|
|
### Redactions
|
|
|
|
[See above](#redactions).
|
|
|
|
### Event format
|
|
|
|
{{% added-in v=6 %}} Through enforcement of [Canonical JSON](#canonical-json),
|
|
the `depth` limit has been reduced in this room version.
|
|
|
|
{{% rver-fragment name="v6-event-format" %}}
|
|
|
|
### Authorization rules
|
|
|
|
{{% added-in v=6 %}} Rule 4, which related specifically to events
|
|
of type `m.room.aliases`, is removed. `m.room.aliases` events must still pass
|
|
authorization checks relating to state events.
|
|
|
|
{{% added-in v=6 %}} Additionally, the authorization rules for events of
|
|
type `m.room.power_levels` now include a `notifications` property under
|
|
`content`. This updates rules 10.4 and 10.5 (now 9.4 and 9.5), which checked
|
|
the `events` property.
|
|
|
|
Events must be signed by the server denoted by the `sender` property.
|
|
|
|
The types of state events that affect authorization are:
|
|
|
|
- [`m.room.create`](/client-server-api#mroomcreate)
|
|
- [`m.room.member`](/client-server-api#mroommember)
|
|
- [`m.room.join_rules`](/client-server-api#mroomjoin_rules)
|
|
- [`m.room.power_levels`](/client-server-api#mroompower_levels)
|
|
- [`m.room.third_party_invite`](/client-server-api#mroomthird_party_invite)
|
|
|
|
{{% boxes/note %}}
|
|
Power levels are inferred from defaults when not explicitly supplied.
|
|
For example, mentions of the `sender`'s power level can also refer to
|
|
the default power level for users in the room.
|
|
{{% /boxes/note %}}
|
|
|
|
{{% boxes/note %}}
|
|
`m.room.redaction` events are subject to auth rules in the same way as any other event.
|
|
In practice, that means they will normally be allowed by the auth rules, unless the
|
|
`m.room.power_levels` event sets a power level requirement for `m.room.redaction`
|
|
events via the `events` or `events_default` properties. In particular, the _redact
|
|
level_ is **not** considered by the auth rules.
|
|
|
|
The ability to send a redaction event does not mean that the redaction itself should
|
|
be performed. Receiving servers must perform additional checks, as described in
|
|
the [Handling Redactions](#handling-redactions) section.
|
|
{{% /boxes/note %}}
|
|
|
|
The rules are as follows:
|
|
|
|
1. If type is `m.room.create`:
|
|
1. If it has any `prev_events`, reject.
|
|
2. If the domain of the `room_id` does not match the domain of the
|
|
`sender`, reject.
|
|
3. If `content.room_version` is present and is not a recognised
|
|
version, reject.
|
|
4. If `content` has no `creator` property, reject.
|
|
5. Otherwise, allow.
|
|
2. Considering the event's `auth_events`:
|
|
1. If there are duplicate entries for a given `type` and `state_key` pair,
|
|
reject.
|
|
2. If there are entries whose `type` and `state_key` don't match those
|
|
specified by the [auth events
|
|
selection](/server-server-api#auth-events-selection)
|
|
algorithm described in the server specification, reject.
|
|
|
|
**Note**: This room version requires an `m.room.create` event to be selected.
|
|
3. If there are entries which were themselves rejected under the [checks
|
|
performed on receipt of a
|
|
PDU](/server-server-api/#checks-performed-on-receipt-of-a-pdu), reject.
|
|
4. If there is no `m.room.create` event among the entries, reject.
|
|
5. If any event in `auth_events` has a `room_id` which does not match that of
|
|
the event being authorised, reject.
|
|
3. If the `content` of the `m.room.create` event in the room state has the
|
|
property `m.federate` set to `false`, and the `sender` domain of the event
|
|
does not match the `sender` domain of the create event, reject.
|
|
4. If type is `m.room.member`:
|
|
1. If there is no `state_key` property, or no `membership` property in
|
|
`content`, reject.
|
|
2. If `membership` is `join`:
|
|
1. If the only previous event is an `m.room.create` and the
|
|
`state_key` is the creator, allow.
|
|
2. If the `sender` does not match `state_key`, reject.
|
|
3. If the `sender` is banned, reject.
|
|
4. If the `join_rule` is `invite` then allow if membership
|
|
state is `invite` or `join`.
|
|
5. If the `join_rule` is `public`, allow.
|
|
6. Otherwise, reject.
|
|
3. If `membership` is `invite`:
|
|
1. If `content` has a `third_party_invite` property:
|
|
1. If *target user* is banned, reject.
|
|
2. If `content.third_party_invite` does not have a `signed`
|
|
property, reject.
|
|
3. If `signed` does not have `mxid` and `token` properties,
|
|
reject.
|
|
4. If `mxid` does not match `state_key`, reject.
|
|
5. If there is no `m.room.third_party_invite` event in the
|
|
current room state with `state_key` matching `token`,
|
|
reject.
|
|
6. If `sender` does not match `sender` of the
|
|
`m.room.third_party_invite`, reject.
|
|
7. If any signature in `signed` matches any public key in
|
|
the `m.room.third_party_invite` event, allow. The public
|
|
keys are in `content` of `m.room.third_party_invite` as:
|
|
1. A single public key in the `public_key` property.
|
|
2. A list of public keys in the `public_keys` property.
|
|
8. Otherwise, reject.
|
|
2. If the `sender`'s current membership state is not `join`,
|
|
reject.
|
|
3. If *target user*'s current membership state is `join` or
|
|
`ban`, reject.
|
|
4. If the `sender`'s power level is greater than or equal to
|
|
the *invite level*, allow.
|
|
5. Otherwise, reject.
|
|
4. If `membership` is `leave`:
|
|
1. If the `sender` matches `state_key`, allow if and only if
|
|
that user's current membership state is `invite` or `join`.
|
|
2. If the `sender`'s current membership state is not `join`,
|
|
reject.
|
|
3. If the *target user*'s current membership state is `ban`,
|
|
and the `sender`'s power level is less than the *ban level*,
|
|
reject.
|
|
4. If the `sender`'s power level is greater than or equal to
|
|
the *kick level*, and the *target user*'s power level is
|
|
less than the `sender`'s power level, allow.
|
|
5. Otherwise, reject.
|
|
5. If `membership` is `ban`:
|
|
1. If the `sender`'s current membership state is not `join`,
|
|
reject.
|
|
2. If the `sender`'s power level is greater than or equal to
|
|
the *ban level*, and the *target user*'s power level is less
|
|
than the `sender`'s power level, allow.
|
|
3. Otherwise, reject.
|
|
6. Otherwise, the membership is unknown. Reject.
|
|
5. If the `sender`'s current membership state is not `join`, reject.
|
|
6. If type is `m.room.third_party_invite`:
|
|
1. Allow if and only if `sender`'s current power level is greater
|
|
than or equal to the *invite level*.
|
|
7. If the event type's *required power level* is greater than the
|
|
`sender`'s power level, reject.
|
|
8. If the event has a `state_key` that starts with an `@` and does not
|
|
match the `sender`, reject.
|
|
9. If type is `m.room.power_levels`:
|
|
1. If the `users` property in `content` is not an object with keys that
|
|
are valid user IDs with values that are integers (or a string
|
|
that is an integer), reject.
|
|
2. If there is no previous `m.room.power_levels` event in the room,
|
|
allow.
|
|
3. For the properties `users_default`, `events_default`, `state_default`,
|
|
`ban`, `redact`, `kick`, `invite` check if they were added,
|
|
changed or removed. For each found alteration:
|
|
1. If the current value is higher than the `sender`'s current
|
|
power level, reject.
|
|
2. If the new value is higher than the `sender`'s current power
|
|
level, reject.
|
|
4. {{% changed-in v=6 %}}
|
|
For each entry being changed in, or removed from, the `events` or
|
|
`notifications` properties:
|
|
1. If the current value is greater than the `sender`'s current
|
|
power level, reject.
|
|
5. {{% changed-in v=6 %}}
|
|
For each entry being added to, or changed in, the `events` or
|
|
`notifications` properties:
|
|
1. If the new value is greater than the `sender`'s current power
|
|
level, reject.
|
|
6. For each entry being changed in, or removed from, the `users` property,
|
|
other than the `sender`'s own entry:
|
|
1. If the current value is greater than or equal to the `sender`'s
|
|
current power level, reject.
|
|
7. For each entry being added to, or changed in, the `users` property:
|
|
1. If the new value is greater than the `sender`'s current power
|
|
level, reject.
|
|
8. Otherwise, allow.
|
|
10. Otherwise, allow.
|
|
|
|
{{% boxes/note %}}
|
|
Some consequences of these rules:
|
|
|
|
- Unless you are a member of the room, the only permitted operations
|
|
(apart from the initial create/join) are: joining a public room;
|
|
accepting or rejecting an invitation to a room.
|
|
- To unban somebody, you must have power level greater than or equal
|
|
to both the kick *and* ban levels, *and* greater than the target
|
|
user's power level.
|
|
{{% /boxes/note %}}
|
|
|
|
### Canonical JSON
|
|
|
|
{{% rver-fragment name="v6-canonical-json" %}}
|
|
|
|
## Unchanged from v5
|
|
|
|
The following sections have not been modified since v5, but are included for
|
|
completeness.
|
|
|
|
### Handling redactions
|
|
|
|
{{% rver-fragment name="v3-handling-redactions" %}}
|
|
|
|
### Event IDs
|
|
|
|
{{% rver-fragment name="v4-event-ids" %}}
|
|
|
|
#### Deprecated event content schemas
|
|
|
|
{{% rver-fragment name="v1-deprecated-formatting-off-spec" %}}
|
|
|
|
{{% rver-fragment name="v1-stringy-power-levels" %}}
|
|
|
|
### State resolution
|
|
|
|
{{% rver-fragment name="v2-state-res" %}}
|
|
|
|
### Signing key validity period
|
|
|
|
{{% rver-fragment name="v5-signing-requirements" %}}
|