Room versions 8 and 9: Restricted rooms

changelogs/client_server/newsfragments/3387.feature

@@ -0,0 +1 @@
+Add support for `restricted` rooms as per [MSC3083](https://github.com/matrix-org/matrix-doc/pull/3083), [MSC3289](https://github.com/matrix-org/matrix-doc/pull/3289), and [MSC3375](https://github.com/matrix-org/matrix-doc/pull/3375).

changelogs/server_server/newsfragments/3387.feature

@@ -0,0 +1 @@
+Add support for `restricted` rooms as per [MSC3083](https://github.com/matrix-org/matrix-doc/pull/3083), [MSC3289](https://github.com/matrix-org/matrix-doc/pull/3289), and [MSC3375](https://github.com/matrix-org/matrix-doc/pull/3375).

content/_index.md

@@ -523,6 +523,10 @@ The available room versions are:
 -   [Version 6](/rooms/v6) - **Stable**. Alters several
     authorization rules for events.
 -   [Version 7](/rooms/v7) - **Stable**. Introduces knocking.
+-   [Version 8](/rooms/v8) - **Stable**. Adds a join rule to allow members
+    of another room to join without invite.
+-   [Version 9](/rooms/v9) - **Stable**. Builds on v8 to fix issues when
+    redacting some membership events.
 
 ## Specification Versions
 

content/client-server-api/_index.md

@@ -1734,6 +1734,12 @@ This room can only be joined if you were invited, and allows anyone to
 request an invite to the room. Note that this join rule is only available
 to rooms based upon [room version 7](/rooms/v7).
 
+`restricted`
+This room can be joined if you were invited or if you are a member of another
+room listed in the join rules. If the server cannot verify membership for any
+of the listed rooms then you can only join with an invite. Note that this join
+rule is only available to rooms based upon [room version 8](/rooms/v8).
+
 The allowable state transitions of membership are:
 
 ![membership-flow-diagram](/diagrams/membership.png)
@@ -1781,6 +1787,30 @@ server chose to auto-accept.
 
 {{% http-api spec="client-server" api="knocking" %}}
 
+##### Restricted rooms
+
+Restricted rooms are rooms with a `join_rule` of `restricted`. These rooms
+are accompanied by "allow conditions" as described in the
+[`m.room.join_rules`](#mroomjoin_rules) state event.
+
+If the user has an invite to the room then the restrictions will not affect
+them. They should be able to join by simply accepting the invite.
+
+Currently there is only one condition available: `m.room_membership`. This
+condition requires the user trying to join the room to be a *joined* member
+of another room (specifically, the `room_id` accompanying the condition).
+
+When joining without an invite, the server MUST verify that the requesting
+user meets at least one of the conditions. If no conditions can be verified
+or no conditions are satisfied, the user will not be able to join. This
+validation is additionally done over federation when using a remote server
+to join the room.
+
+If the room is `restricted` but no valid conditions are presented then the
+room is effectively invite only. The user does not need to maintain the
+conditions in order to stay a member of the room: the conditions are only
+checked/evaluated during the join process.
+
 #### Leaving rooms
 
 A user can leave a room to stop receiving events for that room. A user

content/rooms/_index.md

@@ -11,3 +11,5 @@ weight: 60
 * [Room Version 5](v5)
 * [Room Version 6](v6)
 * [Room Version 7](v7)
+* [Room Version 8](v8)
+* [Room Version 9](v9)

content/rooms/v8.md

@@ -0,0 +1,75 @@
+---
+title: Room Version 8
+type: docs
+weight: 60
+---
+
+This room version builds on [version 7](/rooms/v7) to introduce a new
+join rule that allows members to join the room based on membership in
+another room.
+
+{{% boxes/warning %}}
+This room version is known to have issues relating to redactions of member
+join events. [Room version 9](/rooms/v9) should be preferred over v8 when
+creating rooms.
+{{% /boxes/warning %}}
+
+## Client considerations
+
+Clients are encouraged to expose the option for the join rule in their
+user interface for supported room versions.
+
+The new join rule, `restricted`, is described in the Client-Server API
+under the [`m.room.join_rules`](/client-server-api/#mroomjoin_rules) section.
+
+## 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 8 adds a new join rule to allow members of a room to join another
+room without invite. Otherwise, the room version inherits all properties of
+[Room version 7](/rooms/v7).
+
+### Authorization rules for events
+
+`m.room.member` events for `membership` of `join` are now validated as such:
+
+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
+   `knock`.
+5. **[New in this room version]** If the `join_rule` is `restricted`:
+   1. If membership state is `join`, allow.
+   2. If `content.join_authorised_via_users_server` is not a user with
+      sufficient permission to invite other users, reject.
+   3. If the event is not validly signed by the server denoted by the user ID in
+      `content.join_authorised_via_users_server`, reject.
+   4. Otherwise, allow.
+6. If the `join_rule` is `public`, allow.
+7. Otherwise, reject.
+
+The remaining rules are the same as in [room version 7](/rooms/v7#server-implementation-components).
+
+### Redactions
+
+Events of type `m.room.join_rules` now keep the following `content` properties
+when the event is redacted:
+* `join_rule`
+* **[New in this room version]** `allow`
+
+{{% boxes/warning %}}
+[Room version 9](/rooms/v9) adds additional cases of protected properties for behaviour
+related to restricted rooms (the functionality introduced in v8). v9 is preferred over
+v8 when creating new rooms.
+{{% /boxes/warning %}}
+
+The remaining rules are the same as in [room version 6](/rooms/v6#redactions) (the
+last room version to modify the redaction rules).

content/rooms/v9.md

@@ -0,0 +1,52 @@
+---
+title: Room Version 9
+type: docs
+weight: 60
+---
+
+This room version builds on [version 8](/rooms/v8) to add additional redaction
+rules that were unintentionally missed when incorporating v8.
+
+## Client considerations
+
+See [room version 8](/rooms/v8) for specific details regarding the addition of
+restricted rooms.
+
+Clients which implement a local redaction algorithm are encouraged to read on.
+
+## 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 8 added a new `restricted` join rule to allow members of a room
+to join another room without invite. Room version 9 is based upon v8 with the
+following considerations.
+
+### Redactions
+
+Events of type `m.room.member` now keep the following `content` properties
+when the event is redacted:
+* `membership`
+* **[New in this room version]** `join_authorised_via_users_server`
+
+The remaining rules are the same as in [room version 8](/rooms/v8#redactions).
+
+{{% boxes/rationale %}}
+Without the `join_authorised_via_users_server` property redacted join events
+can become invalid when verifying the auth chain of a given event, thus creating
+a split-brain scenario where the user is able to speak from one server's
+perspective but most others will continually reject their events.
+
+This can theoretically be worked around with a rejoin to the room, being careful
+not to use the faulty events as `prev_events`, though instead it is encouraged
+to use v9 rooms over v8 rooms to outright avoid the situation.
+
+[Issue #3373](https://github.com/matrix-org/matrix-doc/issues/3373) has further
+information.
+{{% /boxes/rationale %}}

content/server-server-api.md

@@ -407,21 +407,26 @@ the sender permission to send the event. The `auth_events` for the
 `m.room.create` event in a room is empty; for other events, it should be
 the following subset of the room state:
 
--   The `m.room.create` event.
+- The `m.room.create` event.
 
--   The current `m.room.power_levels` event, if any.
+- The current `m.room.power_levels` event, if any.
 
--   The sender's current `m.room.member` event, if any.
+- The sender's current `m.room.member` event, if any.
 
--   If type is `m.room.member`:
+- If type is `m.room.member`:
 
-    -   The target's current `m.room.member` event, if any.
-    -   If `membership` is `join` or `invite`, the current
-        `m.room.join_rules` event, if any.
-    -   If membership is `invite` and `content` contains a
-        `third_party_invite` property, the current
-        `m.room.third_party_invite` event with `state_key` matching
-        `content.third_party_invite.signed.token`, if any.
+    - The target's current `m.room.member` event, if any.
+    - If `membership` is `join` or `invite`, the current
+      `m.room.join_rules` event, if any.
+    - If membership is `invite` and `content` contains a
+      `third_party_invite` property, the current
+      `m.room.third_party_invite` event with `state_key` matching
+      `content.third_party_invite.signed.token`, if any.
+    - If `content.join_authorised_via_users_server` is present,
+      the `m.room.member` event with `state_key` matching
+      `content.join_authorised_via_users_server`. Due to the
+      auth rules for the event, the target membership event should
+      always be eligible for inclusion.
 
 #### Rejection
 
@@ -721,15 +726,43 @@ To complete the join handshake, the joining server must now submit this
 new event to a resident homeserver, by using the `PUT /send_join`
 endpoint.
 
-The resident homeserver then accepts this event into the room's event
-graph, and responds to the joining server with the full set of state for
-the newly-joined room. The resident server must also send the event to
-other servers participating in the room.
+The resident homeserver then adds its signature to this event and
+accepts it into the room's event graph. The joining server receives
+the full set of state for the newly-joined room as well as the freshly
+signed membership event. The resident server must also send the event
+to other servers participating in the room.
 
 {{% http-api spec="server-server" api="joins-v1" %}}
 
 {{% http-api spec="server-server" api="joins-v2" %}}
 
+### Restricted rooms
+
+Restricted rooms are described in detail in the
+[client-server API](/client-server-api/#restricted-rooms) and are available
+in room versions based on [v8](/rooms/v8).
+
+A resident server attempting to join a server to a restricted room must
+ensure that the joining server satisfies at least one of the conditions
+specified by `m.room.join_rules`. If no conditions are available, or none
+match the required schema, then the joining server is considered to have
+failed all conditions.
+
+The resident server uses a 400 `M_UNABLE_TO_AUTHORISE_JOIN` error on
+`/make_join` and `/send_join` to denote that the resident server is unable
+to validate any of the conditions, usually because the resident server
+does not have state information about rooms required by the conditions.
+
+The resident server uses a 400 `M_UNABLE_TO_GRANT_JOIN` error on `/make_join`
+and `/send_join` to denote that the joining server should try a different
+server. This is typically because the resident server can see that the
+joining user satisfies one of the conditions, though the resident server
+would be unable to meet the auth rules governing `join_authorised_via_users_server`
+on the resulting `m.room.member` event.
+
+If the joining server fails all conditions then a 403 `M_FORBIDDEN` error
+is used by the resident server.
+
 ## Knocking upon a room
 
 Rooms can permit knocking through the join rules, and if permitted this

data/api/client-server/joining.yaml

@@ -94,6 +94,7 @@ paths:
 
             - The room is invite-only and the user was not invited.
             - The user has been banned from the room.
+            - The room is restricted and the user failed to satisfy any of the conditions.
           examples:
             application/json: {
               "errcode": "M_FORBIDDEN", "error": "You are not invited to this room."}
@@ -180,6 +181,7 @@ paths:
 
             - The room is invite-only and the user was not invited.
             - The user has been banned from the room.
+            - The room is restricted and the user failed to satisfy any of the conditions.
           examples:
             application/json: {
               "errcode": "M_FORBIDDEN", "error": "You are not invited to this room."}

data/api/server-server/definitions/send_join_response.yaml

@@ -55,4 +55,12 @@ properties:
         properties: []
       example:
         $ref: "../examples/minimal_pdu.json"
+  event:
+    type: object
+    title: SignedMembershipEvent
+    description: |-
+      Required if the room version is based upon [v8](/rooms/v8). The signed copy of the membership
+      event sent to other servers by the resident server, including the resident server's signature.
+    example:
+      $ref: "../examples/minimal_pdu.json"
 required: ["auth_chain", "state", "origin"]

data/api/server-server/examples/pdu_v4_join_membership.json

@@ -0,0 +1,28 @@
+{
+    "$ref": "unsigned_pdu_base.json",
+    "hashes": {
+        "sha256": "thishashcoversallfieldsincasethisisredacted"
+    },
+    "signatures": {
+        "example.com": {
+            "ed25519:key_version:": "these86bytesofbase64signaturecoveressentialfieldsincludinghashessocancheckredactedpdus"
+        },
+        "resident.example.com": {
+            "ed25519:key_version:": "a different signature"
+        }
+    },
+    "auth_events": [
+        "$urlsafe_base64_encoded_eventid",
+        "$a-different-event-id"
+    ],
+    "prev_events": [
+        "$urlsafe_base64_encoded_eventid",
+        "$a-different-event-id"
+    ],
+    "type": "m.room.member",
+    "state_key": "@alice:example.com",
+    "content": {
+        "membership": "join",
+        "join_authorised_via_users_server": "@arbitrary:resident.example.com"
+    }
+}