9.1 KiB
title | type | weight |
---|---|---|
Room Version 7 | docs | 70 |
This room version builds on version 6 to introduce knocking as a possible join rule and membership state.
Client considerations
This is the first room version to support knocking completely. As such, users will not be able to knock on rooms which are not based off v7.
Though unchanged in this room version, clients which implement the redaction algorithm locally should refer to the redactions section below for a full overview.
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 7 adds new authorization rules for events to support knocking. Room version 6 has details of other authorization rule changes, as do the versions v6 is based upon.
Authorization rules
{{% added-in this=true %}} For checks performed upon m.room.member
events, a
new point for membership=knock
is added.
Events must be signed by the server denoted by the sender
key.
m.room.redaction
events are not explicitly part of the auth rules.
They are still subject to the minimum power level rules, but should always
fall into "10. Otherwise, allow". Instead of being authorized at the time
of receipt, they are authorized at a later stage: see the
Redactions section below for more information.
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 %}}
The rules are as follows:
- If type is
m.room.create
:- If it has any previous events, reject.
- If the domain of the
room_id
does not match the domain of thesender
, reject. - If
content.room_version
is present and is not a recognised version, reject. - If
content
has nocreator
field, reject. - Otherwise, allow.
- Reject if event has
auth_events
that:- have duplicate entries for a given
type
andstate_key
pair - have entries whose
type
andstate_key
don't match those specified by the auth events selection algorithm described in the server specification.
- have duplicate entries for a given
- If event does not have a
m.room.create
in itsauth_events
, reject. - If type is
m.room.member
:- If no
state_key
key ormembership
key incontent
, reject. - If
membership
isjoin
:- If the only previous event is an
m.room.create
and thestate_key
is the creator, allow. - If the
sender
does not matchstate_key
, reject. - If the
sender
is banned, reject. - If the
join_rule
isinvite
orknock
then allow if membership state isinvite
orjoin
. - If the
join_rule
ispublic
, allow. - Otherwise, reject.
- If the only previous event is an
- If
membership
isinvite
:- If
content
hasthird_party_invite
key:- If target user is banned, reject.
- If
content.third_party_invite
does not have asigned
key, reject. - If
signed
does not havemxid
andtoken
keys, reject. - If
mxid
does not matchstate_key
, reject. - If there is no
m.room.third_party_invite
event in the current room state withstate_key
matchingtoken
, reject. - If
sender
does not matchsender
of them.room.third_party_invite
, reject. - If any signature in
signed
matches any public key in them.room.third_party_invite
event, allow. The public keys are incontent
ofm.room.third_party_invite
as:- A single public key in the
public_key
field. - A list of public keys in the
public_keys
field.
- 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
join
orban
, reject. - If the
sender
's power level is greater than or equal to the invite level, allow. - Otherwise, reject.
- If
- If
membership
isleave
:- If the
sender
matchesstate_key
, allow if and only if that user's current membership state isinvite
,join
, orknock
. - 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
membership
isban
:- 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
- If
membership
isknock
:- If the
join_rule
is anything other thanknock
, reject. - If
sender
does not matchstate_key
, reject. - If the
sender
's current membership is notban
,invite
, orjoin
, allow. - Otherwise, reject.
- If the
- Otherwise, the membership is unknown. Reject.
- If 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_key
that starts with an@
and does not match thesender
, reject. - If type is
m.room.power_levels
:- If
users
key incontent
is not a dictionary 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_levels
event in the room, allow. - For the keys
users_default
,events_default
,state_default
,ban
,redact
,kick
,invite
check 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
- For each entry being added, changed or removed in both the
events
,users
, andnotifications
keys:- 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
- For each entry being changed under the
users
key, other than thesender
's own entry:- If the current value is equal to the
sender
's current power level, reject.
- If the current value is equal to the
- Otherwise, allow.
- If
- 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 %}}
Unchanged from v6
The following sections have not been modified since v6, but are included for completeness.
Redactions
{{% rver-fragment name="v6-redactions" %}}
Handling redactions
{{% rver-fragment name="v3-handling-redactions" %}}
Event IDs
{{% rver-fragment name="v4-event-ids" %}}
Event format
{{% rver-fragment name="v4-event-format" %}}
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" %}}
Canonical JSON
{{% rver-fragment name="v6-canonical-json" %}}
Signing key validity period
{{% rver-fragment name="v5-signing-requirements" %}}