房间版本 8

本页面的翻译未经核对,可能存在翻译质量不佳、错翻、漏翻等情况。您可以在 Forgejo 存储库 打开 Issue、提交 Pull Request 或邮件联系我们提出改进建议和参与翻译与核对。

本房间版本在版本 7的基础上,新增了一种加入规则,允许成员基于在另一个房间的成员身份加入该房间。

已知此房间版本存在有关成员加入事件撤回的问题。房间版本 9在创建房间时应优先选择,而不是 v8。

客户端注意事项

建议客户端在其用户界面中为支持的房间版本提供该加入规则的选项。

新的加入规则 restricted 的详细信息请参考 客户端-服务器 API

在本地实现撤回事务算法的客户端应参考下方撤回章节了解完整内容。

撤回

[New in this version] m.room.join_rules 事件现在在被撤回时,除了其他 content 键外,仍会保留 allow

房间版本 9增加了“受保护属性”更多的情形,以应对 v8 引入的受限房间功能。当创建新房间时,应优先选择 v9。

完整的撤回事务算法如下:

收到撤回事务事件时,服务器必须移除以下列表外的任何键:

  • event_id
  • type
  • room_id
  • sender
  • state_key
  • content
  • hashes
  • signatures
  • depth
  • prev_events
  • prev_state
  • auth_events
  • origin
  • origin_server_ts
  • membership

content 对象的所有键也必须被移除,除非该事件类型属于以下之一:

  • m.room.member 允许键 membership
  • m.room.create 允许键 creator
  • m.room.join_rules 允许键 join_ruleallow
  • m.room.power_levels 允许键 baneventsevents_defaultkickredactstate_defaultusersusers_default
  • m.room.history_visibility 允许键 history_visibility

服务器实现组件

本节信息仅面向服务器实现者。采用客户端-服务器 API 的应用通常不受此处详细内容的影响。客户端-服务器 API 用例应以上方客户端注意事项为准。

房间版本 8 新增了一种加入规则,允许某个房间的成员无需邀请即可加入另一个房间。除此以外,房间版本继承了房间版本 7的所有属性。

鉴权规则

[New in this version]m.room.member 事件执行检查时,新增了处理 content.join_authorised_via_users_server 的要点(规则 4.2 和 4.3.5)。

事件必须由 sender 属性指示的服务器进行签名。

影响授权的状态事件类型包括:

当未明确提供时,权限级别将从默认值推断。例如,提及 sender 的权限级别也可以指房间中用户的默认权限级别。

m.room.redaction 事件与其他事件一样需遵守授权规则。实际上,这意味着除非 m.room.power_levels 事件通过 eventsevents_default 属性为 m.room.redaction 事件设置了权限级别要求,否则通常会被授权规则允许。特别地,redact level 不会被授权规则考虑在内。

能够发送撤回事件并不意味着应执行撤回。接收服务器必须执行额外的检查,详见处理撤回章节。

规则如下:

  1. 如果类型为 m.room.create
    1. 如果存在任何 prev_events,则拒绝。
    2. 如果 room_id 的域与 sender 的域不匹配,则拒绝。
    3. 如果存在 content.room_version 且不是已识别的版本,则拒绝。
    4. 如果 content 中没有 creator 属性,则拒绝。
    5. 否则,允许。
  2. 考虑事件的 auth_events
    1. 如果对于某个 typestate_key 对存在重复条目,则拒绝。
    2. 如果存在条目的 typestate_key授权事件选择算法(按服务器规范描述)指定的不符,则拒绝。
    3. 如果存在条目本身按接收 PDU 时执行的检查被拒绝,则拒绝。
    4. 如果条目中没有 m.room.create 事件,则拒绝。
  3. 如果房间状态中的 m.room.create 事件的 content 属性 m.federatefalse,并且该事件的 sender 域与创建事件的 sender 域不匹配,则拒绝。
  4. 如果类型为 m.room.member
    1. 如果没有 state_key 属性,或 content 中没有 membership 属性,则拒绝。
    2. [New in this version] 如果 content 中有 join_authorised_via_users_server 属性:
      1. 如果事件未被该 key 标识的用户 ID 的 homeserver 有效签名,则拒绝。
    3. 如果 membershipjoin
      1. 如果唯一先前事件为 m.room.createstate_key 为创建者,则允许。
      2. 如果 senderstate_key 不匹配,则拒绝。
      3. 如果 sender 被封禁,则拒绝。
      4. 如果 join_ruleinviteknock,当成员状态为 invitejoin 时允许。
      5. [New in this version] 如果 join_rulerestricted
        1. 如果成员状态为 joininvite,则允许。
        2. 如果 content 中的 join_authorised_via_users_server key 不是有足够权限邀请其它用户的用户,则拒绝。
        3. 否则,允许。
      6. 如果 join_rulepublic,允许。
      7. 否则,拒绝。
    4. 如果 membershipinvite
      1. 如果 content 包含 third_party_invite 属性:
        1. 如果目标用户被封禁,则拒绝。
        2. 如果 content.third_party_invite 没有 signed 属性,则拒绝。
        3. 如果 signed 没有 mxidtoken 属性,则拒绝。
        4. 如果 mxid 不等于 state_key,则拒绝。
        5. 如果当前房间状态中没有 state_keytoken 匹配的 m.room.third_party_invite 事件,则拒绝。
        6. 如果 senderm.room.third_party_invitesender 不匹配,则拒绝。
        7. 如果 signed 中的任一签名与 m.room.third_party_invite 事件中的任何公钥匹配,则允许。公钥位于 m.room.third_party_invitecontent 中:
          1. public_key 属性中为单个公钥。
          2. public_keys 属性中为公钥列表。
        8. 否则,拒绝。
      2. 如果 sender 当前成员状态不是 join,则拒绝。
      3. 如果目标用户的当前成员状态为 joinban,则拒绝。
      4. 如果 sender 的权限级别大于或等于邀请级别,允许。
      5. 否则,拒绝。
    5. 如果 membershipleave
      1. 如果 senderstate_key 匹配,且该用户当前的成员状态为 invitejoinknock 时允许,否则拒绝。
      2. 如果 sender 当前成员状态不是 join,则拒绝。
      3. 如果目标用户的当前成员状态为 bansender 的权限级别低于封禁级别,则拒绝。
      4. 如果 sender 的权限级别大于或等于踢出级别,且目标用户的权限级别低于 sender,则允许。
      5. 否则,拒绝。
    6. 如果 membershipban
      1. 如果 sender 当前成员状态不是 join,则拒绝。
      2. 如果 sender 的权限级别大于或等于封禁级别,且目标用户的权限级别低于 sender,则允许。
      3. 否则,拒绝。
    7. 如果 membershipknock
      1. 如果 join_rule 不是 knock,则拒绝。
      2. 如果 senderstate_key 不匹配,则拒绝。
      3. 如果 sender 当前的成员状态不是 baninvitejoin,则允许。
      4. 否则,拒绝。
    8. 否则,成员状态未知。拒绝。
  5. 如果 sender 当前的成员状态不是 join,拒绝。
  6. 如果类型为 m.room.third_party_invite
    1. 只有当 sender 当前的权限级别大于或等于邀请级别时,允许。
  7. 如果事件类型的所需权限级别大于 sender 的权限级别,拒绝。
  8. 如果事件含有以 @ 开头的 state_key 且与 sender 不匹配,则拒绝。
  9. 如果类型为 m.room.power_levels
    1. 如果 contentusers 属性不是一个有效的对象(主键为合法用户 ID,值为整数或可转为整数的字符串),则拒绝。
    2. 如果房间中没有之前的 m.room.power_levels 事件,允许。
    3. 对于 users_defaultevents_defaultstate_defaultbanredactkickinvite 属性,检查它们是否有新增、更改或移除。对每个更改项:
      1. 如果当前值高于 sender 当前权限级别,则拒绝。
      2. 如果新值高于 sender 当前权限级别,则拒绝。
    4. 针对 eventsnotifications 属性中被更改或移除的每个条目:
      1. 如果当前值大于 sender 当前权限级别,则拒绝。
    5. 对于向 eventsnotifications 属性新增或更改的每个条目:
      1. 如果新值大于 sender 当前权限级别,则拒绝。
    6. 除了 sender 自身的条目外,对 users 属性被更改或移除的每个条目:
      1. 如果当前值大于等于 sender 当前权限级别,则拒绝。
    7. 对于向 users 属性新增或更改的每个条目:
      1. 如果新值大于 sender 当前权限级别,则拒绝。
    8. 否则,允许。
  10. 否则,允许。

这些规则的一些结果:

  • 除非你是房间成员,否则唯一被允许的操作(除初始创建/加入外)为:加入公开房间、接受或拒绝房间邀请。
  • 要解除某人的封禁,你必须拥有大于等于踢出封禁级别的权限级别,比目标用户的权限级别高。

撤回

见上文

与 v7 保持一致

下列章节自 v7 起未做修改,这里为保证文档完整性一并列出。

撤回事件处理

本页面的翻译未经核对,可能存在翻译质量不佳、错翻、漏翻等情况。您可以在 Forgejo 存储库 打开 Issue、提交 Pull Request 或邮件联系我们提出改进建议和参与翻译与核对。

在房间版本1和2中,清除操作(redactions)明确属于授权规则第11条。自房间版本3起,这些条件不再适用,如本版本的授权规则所示。

尽管清除操作始终被事件的授权规则接受,但只有在清除事件和被清除的事件都已被接收并且能够被验证后,才能将其发送给客户端。如果这两个事件都有效并已被服务器看到,那么在满足以下任一条件时,服务器会应用清除操作:

  1. 清除事件的 sender 的权限等级大于或等于清除权限等级(redact level)。
  2. 清除事件的 sender 的域名与原事件的 sender 的域名一致。

如果服务器将应用清除操作,则该清除事件也会被发送给客户端。否则,服务器只会等待有效的配对事件到来,届时可以重新检查上述条件。

事件 ID

本页面的翻译未经核对,可能存在翻译质量不佳、错翻、漏翻等情况。您可以在 Forgejo 存储库 打开 Issue、提交 Pull Request 或邮件联系我们提出改进建议和参与翻译与核对。

事件 ID 是事件的参考哈希,其采用一种变体的无填充 Base64 编码,将第 62 和第 63 个字符分别替换为 -_,而不是使用 +/。这与 RFC4648 URL 安全型 base64 的定义一致。

事件 ID 仍以前缀 $ 开头,最终可能类似于 $Rqnc-F-dvnEYJTyHq_iKxU2bZ1CI92-kuZq3a5lr5Zg

事件格式

本版本中房间内的事件具有以下结构:

Persistent Data Unit


A persistent data unit (event) for room versions 4, 5, 6, 7, 8, 9 and 10.

Persistent Data Unit
Name Type Description
auth_events [string]

Required: Event IDs for the authorization events that would allow this event to be in the room.

Must contain less than or equal to 10 events. Note that if the relevant auth event selection rules are used, this restriction should never be encountered.

content object

Required: The content of the event.

depth integer

Required: The maximum depth of the prev_events, plus one. Must be less than the maximum value for an integer (2^53 - 1). If the room’s depth is already at the limit, the depth must be set to the limit.

hashes Event Hash

Required: Content hashes of the PDU, following the algorithm specified in Signing Events.

origin_server_ts integer

Required: Timestamp in milliseconds on origin homeserver when this event was created.

prev_events [string]

Required: Event IDs for the most recent events in the room that the homeserver was aware of when it made this event.

Must contain less than or equal to 20 events.

redacts string

For redaction events, the ID of the event being redacted.

room_id string

Required: Room identifier.

sender string

Required: The ID of the user sending the event.

signatures {string: {string: string}}

Required: Signatures for the PDU, following the algorithm specified in Signing Events.

state_key string

If this key is present, the event is a state event, and it will replace previous events with the same type and state_key in the room state.

type string

Required: Event type

unsigned UnsignedData

Additional data added by the origin server but not covered by the signatures.

Event Hash
Name Type Description
sha256 string

Required: The hash.

UnsignedData
Name Type Description
age integer

The number of milliseconds that have passed since this message was sent.

Examples

{
  "auth_events": [
    "$urlsafe_base64_encoded_eventid",
    "$a-different-event-id"
  ],
  "content": {
    "key": "value"
  },
  "depth": 12,
  "hashes": {
    "sha256": "thishashcoversallfieldsincasethisisredacted"
  },
  "origin_server_ts": 1404838188000,
  "prev_events": [
    "$urlsafe_base64_encoded_eventid",
    "$a-different-event-id"
  ],
  "redacts": "$some-old_event",
  "room_id": "!UcYsUzyxTGDxLBEvLy:example.org",
  "sender": "@alice:example.com",
  "signatures": {
    "example.com": {
      "ed25519:key_version": "these86bytesofbase64signaturecoveressentialfieldsincludinghashessocancheckredactedpdus"
    }
  },
  "type": "m.room.message",
  "unsigned": {
    "age": 4612
  }
}

已弃用的事件内容模式

发送到此版本房间中的事件,其格式可能与其常规模式不同。此类情况将在此处进行说明。

此处描述的行为仅为严格保留向后兼容性。服务器应采取合理措施,防止用户发送这些所谓的“格式错误”事件,并且绝不能以此处描述的行为作为默认行为。

m.room.power_levels 事件支持以字符串形式传递数值

为了与早期实现保持向后兼容, m.room.power_levels 事件中的每个整数值属性 都可以被编码为字符串而非整数。这包括 eventsnotificationsusers 属性中的嵌套值。例如,以下是在此房间版本中有效的 m.room.power_levels 事件:

{
  "content": {
    "ban": "50",
    "events": {
      "m.room.power_levels": "100"
    },
    "events_default": "0",
    "state_default": "50",
    "users": {
      "@example:localhost": "100"
    },
    "users_default": "0"
  },
  "origin_server_ts": 1432735824653,
  "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
  "sender": "@example:example.org",
  "state_key": "",
  "type": "m.room.power_levels"
}

当该值表示整数时,必须符合以下格式:

  • 仅包含一个十进制整数,不允许浮点数或小数点,可以带任意数量的前导零(如 "100""000100");
  • 可选地在整数前面加一个 -+ 字符(如 "+100""-100");
  • 可选地在前后添加任意数量的空白字符(如 " 100 "" 00100 "" +100 "" -100 ")。

状态解析

事件 E 之后的房间状态 S′(E) 由事件 E 之前的房间状态 S(E) 定义,并且依赖于 E 是状态事件还是消息事件:

  • 如果 E 是一条消息事件,则 S′(E) = S(E)
  • 如果 E 是一条状态事件,则 S′(E)S(E) 相同,除了其与 Eevent_typestate_key 对应的项被 Eevent_id 替换。

事件 E 之前的房间状态 S(E)prev_event 集合 {E1, E2, …} 之后的状态集合 {S′(E1), S′(E2), …} 的 合并与决议结果。如何对一组状态进行合并与决议,见下述算法。

定义

版本 2 房间的状态合并算法使用如下定义,并以房间状态集 {S1, S2, …} 为输入:

权限事件(Power events)。
权限事件 指具有类型 m.room.power_levelsm.room.join_rules 的状态事件,或者类型为 m.room.membermembership 字段为 leaveban,且 senderstate_key 不一致的状态事件。其核心思想为:权限事件是那些可能移除某人在房间内某项操作权限的事件。

无冲突状态映射与冲突状态集。
状态映射 Si 的 key 为形如 (event_type, state_key) 的字符串二元组 K,对应的 value V 为一个状态事件。所有 Si 的 (K, V) 键值对可划分为两个集合:如果给定 key K 在所有 Si 出现,且值 V 在每个状态映射都一致,则此 (K, V) 属于 无冲突状态映射;否则,V 属于 冲突状态集

注意,无冲突状态映射每个 key K 只会有一个事件,而冲突状态集可能因同 key 包含多个事件。

鉴权链(Auth chain)。
事件 E鉴权链,是包含 E 的所有鉴权事件(auth events)、所有这些事件的鉴权事件,递归回溯直到房间创建为止的集合。换句话说,就是通过事件的 auth_events 链接遍历可达的所有事件。

鉴权差集(Auth difference)。
鉴权差集 的计算方式如下:首先对每个状态 Si,计算其完全鉴权链,即该状态中每个事件的鉴权链的并集。然后找出那些未在所有鉴权链中都出现的事件。若 Ci 表示 Si 的完全鉴权链,则鉴权差集为 ∪ Ci − ∩ Ci

完整冲突集(Full conflicted set)。
完整冲突集 是冲突状态集与鉴权差集的并集。

逆拓扑权限排序(Reverse topological power ordering)。
一组事件的 逆拓扑权限排序,是按鉴权事件形成的有向无环图(DAG)进行拓扑排序,得到字典序最小的排序,并从最早事件到最晚事件排列。比较两个拓扑排序确定哪一个字典序更小时,事件的比较关系如下:对事件 xy,若

  1. x 的发送者的权限级别 高于 y 的发送者(以各自的 auth_event 查得);或
  2. 发送者权限级别相同,但 xorigin_server_ts 小于 y;或
  3. 权限级别与 origin_server_ts 都相同,但 xevent_id 小于 yevent_id

x < y

逆拓扑权限排序可用 Kahn 算法进行拓扑排序,每步从候选顶点中按上述比较关系选择最小顶点。

主链排序(Mainline ordering)。
P = P0 为某个 m.room.power_levels 事件。从 i = 0 开始,反复获取 Pi+1,即 Piauth_events 中类型为 m.room.power_levels 的事件。每次自增 i,直到 Piauth_events 中没有 m.room.power_levels 事件为止。P0主链 为 [P0 , P1, … , Pn]。

若另有事件 e = e0(可以是另一个 m.room.power_levels 事件),可以构造类似事件链 [e1, …, em],其中 ej+1ejauth_events 中的 m.room.power_levels 事件,em 没有再指向任何 m.room.power_levels 事件。(注意 e0 本身不包含在该列表中,也有可能该列表为空,因为 e 可能没有引用过 m.room.power_levels 事件。)

对这两条列表进行如下比较:

  • 查找最小的 j ≥ 1,使得 ej 属于 P 的主链;
  • 若存在这样的 j,则 ej = Pi,且 i 唯一、i ≥ 0;否则令 i = ∞,其中 ∞ 为一个大于任何整数的特殊标记值;
  • 无论哪种情况,e主链位置 就是 i

P 计算得主链位置后,基于 P 的主链排序,就是将一组事件按以下比较关系(从小到大)排序:对事件 xy,若

  1. x 的主链位置 大于 y(即 x 的鉴权链基于主链上的较早事件);或
  2. 主链位置相同,但 xorigin_server_ts 小于 y;或
  3. 主链位置、origin_server_ts 都相同,但 xevent_id 小于 y

x < y

迭代鉴权检查(Iterative auth checks)。
迭代鉴权检查算法 的输入是初始房间状态和已排序的状态事件列表。它通过遍历事件列表,将符合授权规则的状态事件依次应用到房间状态上。若某状态事件未通过授权规则,则忽略该事件。如果验证授权规则时缺少某个必须的 (event_type, state_key) key,则用事件 auth_events 中相应的状态事件(若未被拒绝)替代。

算法

一组状态的 合并与决议 按如下步骤执行:

  1. 选取出现在 完整冲突集 内的所有权限事件组成集合 X。对于每一个权限事件 P,将 P 的鉴权链中同时属于完整冲突集的事件也加入 X。对 X逆拓扑权限排序 排序为列表。
  2. 无冲突状态映射 作为起点,对上一步得到的事件列表应用迭代鉴权检查算法,得出部分已决议状态。
  3. 将第 1 步未涉及的所有剩余事件按第 2 步已决议状态中的权限等级,用主链排序确定顺序。
  4. 对上述部分已决议状态及新排序的事件列表,再次应用迭代鉴权检查算法
  5. 无冲突状态映射中的相同 key 事件(若存在)替换当前结果中对应事件,得出最终合并决议状态。

被拒绝的事件

由于基于事件当前状态(而非鉴权链)验证授权而被拒绝的事件,除非另有特别说明,在算法中仍按常规方式处理。

注意,那些由于无法通过其鉴权链授权而被拒绝的事件不应出现在此流程中,因为他们不会出现在状态集合之内(本算法只使用状态集中的事件,或状态集中事件的鉴权链中的事件)。

这样做有助于保证不同服务器下房间状态更易收敛,因为事件的被拒绝状态可能不同。如果某服务器在另一个服务器作为中转加入房间时返回了不正确的状态(无论是故障还是恶意),就有可能出现此类差异。状态收敛是重要特性,因为它确保房间中所有用户都看到(基本)一致的房间状态。如果各服务器状态视图分歧,可能导致房间分裂,例如因对成员列表存在分歧。

直观来看,使用被拒绝的事件似乎有风险,但实际上:

  1. 服务器无法随意伪造状态,因为它们仍需通过根据事件鉴权链的鉴权检查(例如,若之前没有权限,不能自授权限)。
  2. 若想使一个已被拒绝的事件通过鉴权,必须存在某个状态集允许该事件。恶意服务器可能构造一个分支,声称状态就是该特定状态集,然后复制被拒绝事件指向该分支并发送该事件。复制的事件将通过鉴权检查。因此,忽略被拒绝事件未必能消除潜在攻击路径。

被拒绝的鉴权事件(auth events)故意不参与迭代鉴权检查,因为检查过程中不会对鉴权事件重新授权(但非鉴权事件则会被检查)。

标准 JSON

服务器必须严格执行 附录 中规定的 JSON 格式。这意味着在大多数端点会返回 400 M_BAD_JSON 错误,或者在联邦通信中丢弃事件。例如,Federation API 的 /send 端点会丢弃该事件,而 Client Server API 的 /send/{eventType} 端点则会返回 M_BAD_JSON 错误。

签名密钥有效期

在验证事件签名时,服务器必须强制要求密钥请求中的 valid_until_ts 属性至少与所验证事件的 origin_server_ts 相同或更大。缺少签名密钥副本的服务器必须尝试通过 GET /_matrix/key/v2/serverPOST /_matrix/key/v2/query API 获取密钥。当使用 /query 端点时,服务器必须设置 minimum_valid_until_ts 属性,以提示公证服务器在适当情况下尝试刷新密钥。

在确定密钥是否有效时,服务器必须采用 valid_until_ts 和当前时间起未来 7 天中的较小值。这是为了避免攻击者发布一个在较长时间内有效而无法被主服务器所有者撤销的密钥的情况。