11 KiB
| title | type | weight | version |
|---|---|---|---|
| Room Version 6 | docs | 60 | 6 |
This room version builds on version 5 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 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.
Redactions
Event format
{{% added-in v=6 %}} Through enforcement of 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:
{{% 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 section. {{% /boxes/note %}}
The rules are as follows:
- If type is
m.room.create:- If it has any
prev_events, reject. - If the domain of the
room_iddoes not match the domain of thesender, reject. - If
content.room_versionis present and is not a recognised version, reject. - If
contenthas nocreatorproperty, reject. - Otherwise, allow.
- If it has any
- Considering the event's
auth_events:-
If there are duplicate entries for a given
typeandstate_keypair, reject. -
If there are entries whose
typeandstate_keydon't match those specified by the auth events selection algorithm described in the server specification, reject.Note: This room version requires an
m.room.createevent to be selected. -
If there are entries which were themselves rejected under the checks performed on receipt of a PDU, reject.
-
If there is no
m.room.createevent among the entries, reject. -
If any event in
auth_eventshas aroom_idwhich does not match that of the event being authorised, reject.
-
- If the
contentof them.room.createevent in the room state has the propertym.federateset tofalse, and thesenderdomain of the event does not match thesenderdomain of the create event, reject. - If type is
m.room.member:- If there is no
state_keyproperty, or nomembershipproperty incontent, reject. - If
membershipisjoin:- If the only previous event is an
m.room.createand thestate_keyis the creator, allow. - If the
senderdoes not matchstate_key, reject. - If the
senderis banned, reject. - If the
join_ruleisinvitethen allow if membership state isinviteorjoin. - If the
join_ruleispublic, allow. - Otherwise, reject.
- If the only previous event is an
- If
membershipisinvite:- If
contenthas athird_party_inviteproperty:- If target user is banned, reject.
- If
content.third_party_invitedoes not have asignedproperty, reject. - If
signeddoes not havemxidandtokenproperties, reject. - If
mxiddoes not matchstate_key, reject. - If there is no
m.room.third_party_inviteevent in the current room state withstate_keymatchingtoken, reject. - If
senderdoes not matchsenderof them.room.third_party_invite, reject. - If any signature in
signedmatches any public key in them.room.third_party_inviteevent, allow. The public keys are incontentofm.room.third_party_inviteas:- A single public key in the
public_keyproperty. - A list of public keys in the
public_keysproperty.
- A single public key in the
- Otherwise, reject.
- If the
sender's current membership state is notjoin, reject. - If target user's current membership state is
joinorban, reject. - If the
sender's power level is greater than or equal to the invite level, allow. - Otherwise, reject.
- If
- If
membershipisleave:- If the
sendermatchesstate_key, allow if and only if that user's current membership state isinviteorjoin. - If the
sender's current membership state is notjoin, reject. - If the target user's current membership state is
ban, and thesender's power level is less than the ban level, reject. - 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 thesender's power level, allow. - Otherwise, reject.
- If the
- If
membershipisban:- If the
sender's current membership state is notjoin, reject. - 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 thesender's power level, allow. - Otherwise, reject.
- If the
- Otherwise, the membership is unknown. Reject.
- If there is no
- If the
sender's current membership state is notjoin, reject. - If type is
m.room.third_party_invite:- Allow if and only if
sender's current power level is greater than or equal to the invite level.
- Allow if and only if
- If the event type's required power level is greater than the
sender's power level, reject. - If the event has a
state_keythat starts with an@and does not match thesender, reject. - If type is
m.room.power_levels:- If the
usersproperty incontentis not an object with keys that are valid user IDs with values that are integers (or a string that is an integer), reject. - If there is no previous
m.room.power_levelsevent in the room, allow. - For the properties
users_default,events_default,state_default,ban,redact,kick,invitecheck if they were added, changed or removed. For each found alteration:- If the current value is higher than the
sender's current power level, reject. - If the new value is higher than the
sender's current power level, reject.
- If the current value is higher than the
- {{% changed-in v=6 %}}
For each entry being changed in, or removed from, the
eventsornotificationsproperties:- If the current value is greater than the
sender's current power level, reject.
- If the current value is greater than the
- {{% changed-in v=6 %}}
For each entry being added to, or changed in, the
eventsornotificationsproperties:- If the new value is greater than the
sender's current power level, reject.
- If the new value is greater than the
- For each entry being changed in, or removed from, the
usersproperty, other than thesender's own entry:- If the current value is greater than or equal to the
sender's current power level, reject.
- If the current value is greater than or equal to the
- For each entry being added to, or changed in, the
usersproperty:- If the new value is greater than the
sender's current power level, reject.
- If the new value is greater than the
- Otherwise, allow.
- If the
- 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" %}}