9.0 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_iddoes not match the domain of thesender, reject. - If
content.room_versionis present and is not a recognised version, reject. - If
contenthas nocreatorfield, reject. - Otherwise, allow.
- Reject if event has
auth_eventsthat:- have duplicate entries for a given
typeandstate_keypair - have entries whose
typeandstate_keydon'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.createin itsauth_events, reject. - If type is
m.room.member:- If no
state_keykey ormembershipkey 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_ruleisinviteorknockthen allow if membership state isinviteorjoin. - If the
join_ruleispublic, allow. - Otherwise, reject.
- If the only previous event is an
- If
membershipisinvite:- If
contenthasthird_party_invitekey:- If target user is banned, reject.
- If
content.third_party_invitedoes not have asignedkey, reject. - If
signeddoes not havemxidandtokenkeys, 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_keyfield. - A list of public keys in the
public_keysfield.
- 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 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
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
- If
membershipisknock:- If the
join_ruleis anything other thanknock, reject. - If
senderdoes not matchstate_key, reject. - If the
sender's current membership is notbanorjoin, 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_keythat starts with an@and does not match thesender, reject. - If type is
m.room.power_levels:- If
userskey incontentis 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_levelsevent in the room, allow. - For the keys
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
- For each entry being added, changed or removed in both the
events,users, andnotificationskeys:- 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
userskey, 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" %}}