Merge f0affdfa3c into 967b54195c

Clarify the special casing of membership events and redactions in power levels (#2231 )
docs: grammar fix
2026-04-28 05:14:10 +02:00 · 2025-10-29 11:44:03 -06:00 · 2025-10-29 16:33:47 +00:00 · 2025-09-17 22:23:32 +02:00 · 2025-08-03 18:21:35 +02:00
11 changed files with 90 additions and 75 deletions
--- a/changelogs/client_server/newsfragments/2188.clarification
+++ b/changelogs/client_server/newsfragments/2188.clarification
@ -0,0 +1 @@
 Clarify terminology for keys in cross-signing module.
--- a/changelogs/client_server/newsfragments/2231.clarification
+++ b/changelogs/client_server/newsfragments/2231.clarification
@ -0,0 +1 @@
 Clarify the special casing of membership events and redactions in power levels.
--- a/content/client-server-api/modules/end_to_end_encryption.md
+++ b/content/client-server-api/modules/end_to_end_encryption.md
@ -93,7 +93,7 @@ Example:
 ```
 `ed25519` and `curve25519` keys are used for [device keys](#device-keys).
-Additionally, `ed25519` keys are used for [cross-signing keys](#cross-signing).
+Additionally, `ed25519` keys are used for [cross-signing](#cross-signing).
 `signed_curve25519` keys are used for [one-time and fallback keys](#one-time-and-fallback-keys).
@ -675,7 +675,7 @@ The process between Alice and Bob verifying each other would be:
 15. Assuming they match, Alice and Bob's devices each calculate Message
    Authentication Codes (MACs) for:
    * Each of the keys that they wish the other user to verify (usually their
-      device ed25519 key and their master cross-signing key).
+      device ed25519 key and their master key, see below).
    * The complete list of key IDs that they wish the other user to verify.
    The MAC calculation is defined [below](#mac-calculation).
@ -931,16 +931,16 @@ and can be translated online:
 Rather than requiring Alice to verify each of Bob's devices with each of
 her own devices and vice versa, the cross-signing feature allows users
 to sign their device keys such that Alice and Bob only need to verify
-once. With cross-signing, each user has a set of cross-signing keys that
+once. With cross-signing, each user has a set of ed25519 key pairs that
 are used to sign their own device keys and other users' keys, and can be
 used to trust device keys that were not verified directly.
-Each user has three ed25519 key pairs for cross-signing:
+Each user has three ed25519 key pairs used for cross-signing:
-   a master key (MSK) that serves as the user's identity in
+-   a master key (MK) that serves as the user's identity in
-    cross-signing and signs their other cross-signing keys;
+    cross-signing and signs their user-signing and self-signing keys;
 -   a user-signing key (USK) -- only visible to the user that it belongs
-    to --that signs other users' master keys; and
+    to -- that signs other users' master keys; and
 -   a self-signing key (SSK) that signs the user's own device keys.
 The master key may also be used to sign other items such as the backup
@ -950,13 +950,15 @@ previously verified Bob's device and Bob's device has signed his master
 key, then Alice's device can trust Bob's master key, and she can sign it
 with her user-signing key.
-Users upload their cross-signing keys to the server using [POST
+Users upload the public part of their master, user-signing and self-signing
 key to the server using [POST
 /\_matrix/client/v3/keys/device\_signing/upload](/client-server-api/#post_matrixclientv3keysdevice_signingupload). When Alice uploads
-new cross-signing keys, her user ID will appear in the `changed`
+new keys, her user ID will appear in the `changed`
 property of the `device_lists` field of the `/sync` of response of all
 users who share an encrypted room with her. When Bob sees Alice's user
 ID in his `/sync`, he will call [POST /\_matrix/client/v3/keys/query](/client-server-api/#post_matrixclientv3keysquery)
-to retrieve Alice's device and cross-signing keys.
+to retrieve Alice's device keys, as well as their master, user-signing and
 self-signing key.
 If Alice has a device and wishes to send an encrypted message to Bob,
 she can trust Bob's device if:
@ -971,13 +973,13 @@ The following diagram illustrates how keys are signed:
 ```
    +------------------+                ..................   +----------------+
-    | +--------------+ |   ..................            :   | +------------+ |
+    | +--------------+ |  ...................            :   | +------------+ |
-    | |              v v   v            :   :            v   v v            | |
+    | |              v v  v             :   :            v   v v            | |
-    | |           +-----------+         :   :         +-----------+         | |
+    | |           +----------+          :   :         +----------+          | |
-    | |           | Alice MSK |         :   :         |  Bob MSK  |         | |
+    | |           | Alice MK |          :   :         |  Bob MK  |          | |
-    | |           +-----------+         :   :         +-----------+         | |
+    | |           +----------+          :   :         +----------+          | |
-    | |             |       :           :   :           :       |           | |
+    | |             |      :            :   :           :      |            | |
-    | |          +--+       :...        :   :        ...:       +--+        | |
+    | |          +--+      :....        :   :        ...:      +---+        | |
    | |          v             v        :   :        v             v        | |
    | |    +-----------+ .............  :   :  ............. +-----------+  | |
    | |    | Alice SSK | : Alice USK :  :   :  :  Bob USK  : |  Bob SSK  |  | |
@ -1004,11 +1006,11 @@ signatures that she cannot see:
    +------------------+                +----------------+   +----------------+
    | +--------------+ |                |                |   | +------------+ |
    | |              v v                |                v   v v            | |
-    | |           +-----------+         |             +-----------+         | |
+    | |           +----------+          |             +----------+          | |
-    | |           | Alice MSK |         |             |  Bob MSK  |         | |
+    | |           | Alice MK |          |             |  Bob MK  |          | |
-    | |           +-----------+         |             +-----------+         | |
+    | |           +----------+          |             +----------+          | |
-    | |             |       |           |                       |           | |
+    | |             |      |            |                      |            | |
-    | |          +--+       +--+        |                       +--+        | |
+    | |          +--+      +---+        |                      +---+        | |
    | |          v             v        |                          v        | |
    | |    +-----------+ +-----------+  |                    +-----------+  | |
    | |    | Alice SSK | | Alice USK |  |                    |  Bob SSK  |  | |
@ -1024,16 +1026,16 @@ signatures that she cannot see:
 ```
 [Verification methods](#device-verification) can be used to verify a
-user's master key by using the master public key, encoded using unpadded
+user's master key by treating the master public key, encoded using unpadded
 base64, as the device ID, and treating it as a normal device. For
 example, if Alice and Bob verify each other using SAS, Alice's
 `m.key.verification.mac` message to Bob may include
 `"ed25519:alices+master+public+key": "alices+master+public+key"` in the
 `mac` property. Servers therefore must ensure that device IDs will not
-collide with cross-signing public keys.
+collide with public keys used for cross-signing.
-The cross-signing private keys can be stored on the server or shared with other
+Using the [Secrets](#secrets) module the private keys used for cross-signing can
-devices using the [Secrets](#secrets) module.  When doing so, the master,
+be stored on the server or shared with other devices.  When doing so, the master,
 user-signing, and self-signing keys are identified using the names
 `m.cross_signing.master`, `m.cross_signing.user_signing`, and
 `m.cross_signing.self_signing`, respectively, and the keys are base64-encoded
@ -1052,14 +1054,14 @@ If a user's client sees that any other user has changed their master
 key, that client must notify the user about the change before allowing
 communication between the users to continue.
-Since device key IDs (`ed25519:DEVICE_ID`) and cross-signing key IDs
+Since device key IDs (`ed25519:DEVICE_ID`) as well as master, user-signing and
-(`ed25519:PUBLIC_KEY`) occupy the same namespace, clients must ensure that they
+self-signing key IDs (`ed25519:PUBLIC_KEY`) occupy the same namespace, clients
-use the correct keys when verifying.
+must ensure that they use the correct keys when verifying.
-While servers MUST not allow devices to have the same IDs as cross-signing
+While servers MUST not allow devices to have the same IDs as keys used for
-keys, a malicious server could construct such a situation, so clients must not
+cross-signing, a malicious server could construct such a situation, so clients
-rely on the server being well-behaved and should take the following precautions
+must not rely on the server being well-behaved and should take the following
-against this.
+precautions against this:
 1. Clients MUST refer to keys by their public keys during the verification
   process, rather than only by the key ID.
@ -1067,7 +1069,8 @@ against this.
   verification process, and ensure that they do not change in the course of
   verification.
 3. Clients SHOULD also display a warning and MUST refuse to verify a user when
-   they detect that the user has a device with the same ID as a cross-signing key.
+   they detect that the user has a device with the same ID as a key used for
   cross-signing.
 A user's user-signing and self-signing keys are intended to be easily
 replaceable if they are compromised by re-issuing a new key signed by
@ -1104,7 +1107,7 @@ user-signing keys.
 Verifying by QR codes provides a quick way to verify when one of the parties
 has a device capable of scanning a QR code. The QR code encodes both parties'
-master signing keys as well as a random shared secret that is used to allow
+master keys as well as a random shared secret that is used to allow
 bi-directional verification from a single scan.
 To advertise the ability to show a QR code, clients use the names
@ -1202,15 +1205,14 @@ The binary segment MUST be of the following form:
    bytes of the ID as a UTF-8 string
  - the ID encoded as a UTF-8 string
 - the first key, as 32 bytes.  The key to use depends on the mode field:
-  - if `0x00` or `0x01`, then the current user's own master cross-signing public key
+  - if `0x00` or `0x01`, then the current user's own master public key
  - if `0x02`, then the current device's Ed25519 signing key
 - the second key, as 32 bytes.  The key to use depends on the mode field:
  - if `0x00`, then what the device thinks the other user's master
-    cross-signing public key is
+    public key is
  - if `0x01`, then what the device thinks the other device's Ed25519 signing
    public key is
-  - if `0x02`, then what the device thinks the user's master cross-signing public
+  - if `0x02`, then what the device thinks the user's master public key is
    key is
 - a random shared secret, as a sequence of bytes.  It is suggested to use a secret
  that is about 8 bytes long.  Note: as we do not share the length of the
  secret, and it is not a fixed size, clients will just use the remainder of
@ -1221,14 +1223,14 @@ For example, if Alice displays a QR code encoding the following binary data:
 ```
      "MATRIX"    |ver|mode| len   | event ID
 4D 41 54 52 49 58  02  00   00 2D   21 41 42 43 44 ...
-| user's cross-signing key    | other user's cross-signing key | shared secret
+| the first key               | the second key              | shared secret
-  00 01 02 03 04 05 06 07 ...   10 11 12 13 14 15 16 17 ...      20 21 22 23 24 25 26 27
+  00 01 02 03 04 05 06 07 ...   10 11 12 13 14 15 16 17 ...   20 21 22 23 24 25 26 27
 ```
-this indicates that Alice is verifying another user (say Bob), in response to
+Mode `0x00` indicates that Alice is verifying another user (say Bob), in
-the request from event "$ABCD...", her cross-signing key is
+response to the request from event "$ABCD...", her master key is
 `0001020304050607...` (which is "AAECAwQFBg..." in base64), she thinks that
-Bob's cross-signing key is `1011121314151617...` (which is "EBESExQVFh..." in
+Bob's master key is `1011121314151617...` (which is "EBESExQVFh..." in
 base64), and the shared secret is `2021222324252627` (which is "ICEiIyQlJic" in
 base64).
@ -1300,8 +1302,8 @@ one of its variants.
 Clients must only store keys in backups after they have ensured that the
 `auth_data` is trusted. This can be done either by:
- checking that it is signed by the user's [master cross-signing
+- checking that it is signed by the user's [master key](#cross-signing)
-  key](#cross-signing) or by a verified device belonging to the same user, or
+  or by a verified device belonging to the same user, or
 - deriving the public key from a private key that it obtained from a trusted
  source. Trusted sources for the private key include the user entering the
  key, retrieving the key stored in [secret storage](#secret-storage), or
@ -1786,13 +1788,14 @@ a way to identify the server's support for fallback keys.
 | Parameter  | Type      | Description                                                                                                                                                      |
 |------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| changed    | [string]  | List of users who have updated their device identity or cross-signing keys, or who now share an encrypted room with the client since the previous sync response. |
+| changed    | [string]  | List of users who have updated their device identity or their master, self-signing or user-signing keys, or who now share an encrypted room with the client since the previous sync response. |
 | left       | [string]  | List of users with whom we do not share any encrypted rooms anymore since the previous sync response.                                                            |
 {{% boxes/note %}}
 For optimal performance, Alice should be added to `changed` in Bob's
-sync only when she updates her devices or cross-signing keys, or when
+sync only when she updates her devices or master, self-signing or
-Alice and Bob now share a room but didn't share any room previously.
+user-signing keys, or when Alice and Bob now share a room but didn't
 share any room previously.
 However, for the sake of simpler logic, a server may add Alice to
 `changed` when Alice and Bob share a new room, even if they previously
 already shared a room.
--- a/data/api/client-server/cross_signing.yaml
+++ b/data/api/client-server/cross_signing.yaml
@ -21,16 +21,16 @@ paths:
      x-addedInMatrixVersion: "1.1"
      x-changedInMatrixVersion:
        "1.11": UIA is not always required for this endpoint.
-      summary: Upload cross-signing keys.
+      summary: Upload keys used for cross-signing.
      description: |-
-        Publishes cross-signing keys for the user.
+        Publishes keys used for cross-signing for the user.
        This API endpoint uses the [User-Interactive Authentication API](/client-server-api/#user-interactive-authentication-api).
        User-Interactive Authentication MUST be performed, except in these cases:
-        - there is no existing cross-signing master key uploaded to the homeserver, OR
+        - there is no existing master key uploaded to the homeserver, OR
-        - there is an existing cross-signing master key and it exactly matches the
+        - there is an existing master key and it exactly matches the
-          cross-signing master key provided in the request body. If there are any additional
+          master key provided in the request body. If there are any additional
          keys provided in the request (self-signing key, user-signing key) they MUST also
          match the existing keys stored on the server. In other words, the request contains
          no new keys.
--- a/data/api/client-server/definitions/cross_signing_key.yaml
+++ b/data/api/client-server/definitions/cross_signing_key.yaml
@ -13,7 +13,7 @@
 # limitations under the License.
 type: object
 title: CrossSigningKey
-description: Cross signing key
+description: Key used for cross signing
 properties:
  user_id:
    type: string
--- a/data/api/client-server/keys.yaml
+++ b/data/api/client-server/keys.yaml
@ -219,7 +219,7 @@ paths:
                    x-addedInMatrixVersion: "1.1"
                    type: object
                    description: |-
-                      Information on the master cross-signing keys of the queried users.
+                      Information on the master keys of the queried users.
                      A map from user ID, to master key information.  For each key, the
                      information returned will be the same as uploaded via
                      `/keys/device_signing/upload`, along with the signatures
--- a/data/api/client-server/redaction.yaml
+++ b/data/api/client-server/redaction.yaml
@ -26,9 +26,9 @@ paths:
        This cannot be undone.
        Any user with a power level greater than or equal to the `m.room.redaction`
-        event power level may send redaction events in the room. If the user's power
+        event power level may send redactions for their own events in the room. If
-        level is also greater than or equal to the `redact` power level of the room,
+        the user's power level is also greater than or equal to the `redact` power
-        the user may redact events sent by other users.
+        level of the room, the user may redact events sent by other users.
        Server administrators may redact events sent by users on their server.
      operationId: redactEvent
--- a/data/api/server-server/definitions/event-schemas/m.signing_key_update.yaml
+++ b/data/api/server-server/definitions/event-schemas/m.signing_key_update.yaml
@ -17,7 +17,7 @@ type: object
 title: m.signing_key_update
 description: |-
  An EDU that lets servers push details to each other when one of their users
-  updates their cross-signing keys.
+  updates their keys used for cross-signing.
 allOf:
  - $ref: ../edu.yaml
  - type: object
@ -34,7 +34,7 @@ allOf:
        properties:
          user_id:
            type: string
-            description: The user ID whose cross-signing keys have changed.
+            description: The user ID whose keys have changed.
            example: "@alice:example.com"
          master_key:
            allOf:
--- a/data/api/server-server/user_devices.yaml
+++ b/data/api/server-server/user_devices.yaml
@ -79,7 +79,7 @@ paths:
                        - keys
                  master_key:
                    type: object
-                    description: The user\'s master cross-signing key.
+                    description: The user\'s master key.
                    allOf:
                      - $ref: ../client-server/definitions/cross_signing_key.yaml
                      - example:
--- a/data/api/server-server/user_keys.yaml
+++ b/data/api/server-server/user_keys.yaml
@ -194,7 +194,7 @@ paths:
                    x-addedInMatrixVersion: "1.1"
                    type: object
                    description: |-
-                      Information on the master cross-signing keys of the queried users.
+                      Information on the master keys of the queried users.
                      A map from user ID, to master key information.  For each key, the
                      information returned will be the same as uploaded via
                      `/keys/device_signing/upload`, along with the signatures
--- a/data/event-schemas/schema/m.room.power_levels.yaml
+++ b/data/event-schemas/schema/m.room.power_levels.yaml
@ -13,24 +13,34 @@ description: |-
  0. If the room contains no `m.room.power_levels` event, the room's creator has
  a power level of 100, and all other users have a power level of 0.
-  The level required to send a certain event is governed by `events`,
+  Except for membership events and redactions, the level required to
-  `state_default` and `events_default`. If an event type is specified in
+  send a certain event is governed purely by `events`, `state_default`
-  `events`, then the user must have at least the level specified in order to
+  and `events_default`. If an event type is specified in `events`, then
-  send that event. If the event type is not supplied, it defaults to
+  the user must have at least the level specified in order to send that
-  `events_default` for Message Events and `state_default` for State
+  event. If the event type is not supplied, it defaults to `events_default`
-  Events.
+  for message events and `state_default` for state events.
  If there is no `state_default` in the `m.room.power_levels` event, or
  there is no `m.room.power_levels` event, the `state_default` is 50.
  If there is no `events_default` in the `m.room.power_levels` event,
  or there is no `m.room.power_levels` event, the `events_default` is 0.
-  The power level required to invite a user to the room, kick a user from the
+  Membership events are not subject to `events`, `events_default`, or
-  room, ban a user from the room, or redact an event sent by another user, is
+  `state_default`. Instead, the power level required to invite a user
-  defined by `invite`, `kick`, `ban`, and `redact`, respectively.  The levels
+  to the room, kick a user from the room, or ban a user from the room
-  for `kick`, `ban` and `redact` default to 50 if they are not specified in the
+  is defined by `invite`, `kick`, and `ban`, respectively. The levels
-  `m.room.power_levels` event, or if the room contains no `m.room.power_levels`
+  for `kick` and `ban` default to 50 if they are not specified in the
-  event. `invite` defaults to 0 in either case.
+  `m.room.power_levels` event, or if the room contains no
  `m.room.power_levels` event. `invite` defaults to 0 in either case.
  Other membership values are handled during event authorization. See
  the authorization rules in [room versions](/rooms) for further details.
  For redactions of a user's own events, the required power level is
  determined by the `m.room.redaction` event power level, as per `events`
  and `events_default`. The power level required to redact an event sent
  by another user is _additionally_ governed by `redact`. The level for
  `redact` defaults to 50 if it is not specified in the `m.room.power_levels`
  event, or if the room contains no `m.room.power_levels` event.
  **Note:**
Author	SHA1	Message	Date
codedust	0a1b5ba9e5	Merge `f0affdfa3c` into `967b54195c`	2025-10-29 11:44:03 -06:00
Johannes Marbach	967b54195c	Clarify the special casing of membership events and redactions in power levels (#2231 )	2025-10-29 16:33:47 +00:00
codedust	f0affdfa3c	docs: grammar fix Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>	2025-09-17 22:23:32 +02:00
codedust	f42ce28bfe	Clarify terminology for keys in cross-signing module - do not use the term 'cross-signing keys' anymore: Previously, the term 'cross-signing keys' was used to refer to the master, user-signing and self-signing keys. This is not ideal since the master key is used for cross-signing but may also be used to sign the backup key, for example. In these contexts, the master key is not used for cross-signing. The term 'cross-signing keys' has therefor been replaced by 'keys used for cross-signing' or, more explicitely, by 'master, user-signing and self-signing key'. - the naming of the master key has been harmonised (no more 'master cross-signing key' or 'master signing keys'). Also the abbr. 'MSK' has been replaced by 'MK'. - in the QR code example, the term 'cross-signing key' has been replaced by 'master key' since in mode 0x00, the current user's own master key and what the device thinks the other user's master key is used. - it has been made more explicit that private keys used for cross-signing can be stored on the server are stored as described in the secrets module (as opposed to store them in unencrypted form) Signed-off-by: codedust <codedust@so.urceco.de>	2025-08-03 18:21:35 +02:00
		`@ -0,0 +1 @@`
							`Clarify terminology for keys in cross-signing module.`
		`@ -0,0 +1 @@`
							`Clarify the special casing of membership events and redactions in power levels.`