房间版本 4
本房间版本在 版本 3 的基础上,采用了不同的事件 ID 编码方式。
客户端注意事项
本房间版本更改了发送给客户端的事件 ID 格式。客户端应始终将事件 ID 视为不可理解的标识符,而不应关心其具体格式。在将事件 ID 包含在请求路径中时,客户端仍需对其进行编码。
客户端应做好事件 ID 的格式已从 $randomstring:example.org 更改为类似 $Rqnc-F-dvnEYJTyHq_iKxU2bZ1CI92-kuZq3a5lr5Zg(请注意没有域名部分)的准备。
虽然本房间版本对此未作更改,但如客户端在本地实现了修订算法,应参考下文的 修订 部分,了解完整内容。
服务器实现要点
本节内容仅供服务器实现者参考。使用 Client-Server API 的应用通常不会受到此处细节的影响。上述关于客户端注意事项的部分,才是 Client-Server API 用例应参考的内容。
房间版本 4 使用了 房间版本 3 中定义的相同算法,不过在生成事件 ID 时采用了 URL 安全的 base64 编码方式。
事件 ID
房间版本 3 生成的事件 ID,对于未对事件 ID 编码的客户端实现来说难以正常使用。此外,由于 / 字符在某些反向代理软件中会被区别对待,也引发了相关担忧,并在一般管理上带来了不便。
[New in this version] 事件 ID 是事件的参考哈希,其采用一种变体的无填充 Base64 编码,将第 62 和第 63 个字符分别替换为 - 和 _,而不是使用 + 和 /。这与 RFC4648 URL 安全型 base64 的定义一致。
事件 ID 仍以前缀 $ 开头,最终可能类似于 $Rqnc-F-dvnEYJTyHq_iKxU2bZ1CI92-kuZq3a5lr5Zg。
与 v3 保持一致的部分
以下内容自 v3 起未作修改,为保证完整性予以收录。
修订
在接收到删除事件后,服务器必须移除除以下列表外的所有键:
event_idtyperoom_idsenderstate_keycontenthashessignaturesdepthprev_eventsprev_stateauth_eventsoriginorigin_server_tsmembership
对于 content 对象,也必须移除除下列类型允许外的所有键:
m.room.member允许键membership。m.room.create允许键creator。m.room.join_rules允许键join_rule。m.room.power_levels允许的键有ban、events、events_default、kick、redact、state_default、users、users_default。m.room.aliases允许键aliases。m.room.history_visibility允许 键history_visibility。
处理修订
在房间版本1和2中,清除操作(redactions)明确属于授权规则第11条。自房间版本3起,这些条件不再适用,如本版本的授权规则所示。
尽管清除操作始终被事件的授权规则接受,但只有在清除事件和被清除的事件都已被接收并且能够被验证后,才能将其发送给客户端。如果这两个事件都有效并已被服务器看到,那么在满足以下任一条件时,服务器会应用清除操作:
- 清除事件的
sender的权限等级大于或等于清除权限等级(redact level)。 - 清除事件的
sender的域名与原事件的sender的域名一致。
如果服务器将应用清除操作,则该清除事件也会被发送给客户端。否则,服务器只会等待有效的配对事件到来,届时可以重新检查上述条件。
事件格式
事件格式与 房间版本 3 相同,但以下示例中的事件 ID 已根据本房间版本的更改进行了更新。
此版本中房间内的事件结构如下:
Persistent Data Unit
Persistent Data Unit
A persistent data unit (event) for room versions 4, 5, 6, 7, 8, 9 and 10.
| 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 |
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 |
string |
Required: Event type |
unsigned |
UnsignedData |
Additional data added by the origin server but not covered by the |
| Name | Type | Description |
|---|---|---|
sha256 |
string |
Required: The hash. |
| 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 事件中的每个整数值属性
都可以被编码为字符串而非整数。这包括 events、notifications 和 users
属性中的嵌套值。例如,以下是在此房间版本中有效的
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 ")。
授权规则
在房间版本1和2中,事件需要来自 event_id 域的签名才能被视为有效。此房间版本在联邦过程中并未以相同方式包含 event_id,因此不需要该服务器的签名。不过,事件仍然必须由 sender 属性标识的服务器签名。
影响授权的状态事件类型有:
当未显式提供权限等级时,将根据默认值推断。例如,对 sender 权限等级的引用,也可以指代房间内用户的默认权限等级。
截至房间版本3,完整的规则列表如下:
- 如果类型为
m.room.create:- 如果有任何
prev_events,则拒绝。 - 如果
room_id的域与sender的域不匹配,则拒绝。 - 如果存在
content.room_version但不是被识别的版本,则拒绝。 - 如果
content中缺少creator属性,则拒绝。 - 否则,允许。
- 如果有任何
- 考虑事件的
auth_events:- 如果某一对相同
type和state_key的条目重复,则拒绝。 - 如果存在
type和state_key不符合授权事件选择算法(见服务器规范)要求的条目,则拒绝。 - 如果存在在PDU接收时执行的检查中被拒绝的条目,则拒绝。
- 如果没有
m.room.create事件,则拒绝。
- 如果某一对相同
- 如果房间状态中的
m.room.create事件的content属性m.federate设置为false,且当前事件sender的域与创建事件的sender域不匹配,则拒绝。 - 如果类型为
m.room.aliases:- 如果没有
state_key,则拒绝。 - 如果发送者域与
state_key不同,则拒绝。 - 否则,允许。
- 如果没有
- 如果类型为
m.room.member:- 如果没有
state_key属性,或content中没有membership属性,则拒绝。 - 如果
membership是join:- 如果唯一的前置事件是
m.room.create并且state_key是创建者,则允许。 - 如果
sender不等于state_key,则拒绝。 - 如果
sender被封禁,则拒绝。 - 如果
join_rule为invite,则当成员状态为invite或join时允许。 - 如果
join_rule为public,则允许。 - 否则,拒绝。
- 如果唯一的前置事件是
- 如果
membership是invite:- 如果
content包含third_party_invite属性:- 如果目标用户被封禁,则拒绝。
- 如果
content.third_party_invite没有signed属性,则拒绝。 - 如果
signed没有mxid和token属性,则拒绝。 - 如果
mxid与state_key不一致,则拒绝。 - 如果当前房间状态下没有
state_key与token匹配的m.room.third_party_invite事件,则拒绝。 - 如果
sender不等于该m.room.third_party_invite的sender,则拒绝。 - 如果
signed中任一签名与m.room.third_party_invite事件中的任意公钥匹配,则允许。公钥可在m.room.third_party_invite的content中如下出现:public_key属性中的单个公钥。public_keys属性中的公钥列表。
- 否则,拒绝。
- 如果
sender当前的成员状态不是join,则拒绝。 - 如果目标用户当前成员状态为
join或ban,则拒绝。 - 如果
sender的权限等级大于或等于邀请等级,则允许。 - 否则,拒绝。
- 如果
- 如果
membership是leave:- 如果
sender等于state_key,且该用户当前成员状态为invite或join,则允许,否则拒绝。 - 如果
sender当前成员状态不是join,则拒绝。 - 如果目标用户当前成员状态为
ban,且sender权限等级小于封禁等级,则拒绝。 - 如果
sender权限等级大于或等于踢出等级,且目标用户的权限等级小于sender,则允许。 - 否则,拒绝。
- 如果
- 如果
membership是ban:- 如果
sender当前的成员状态不是join,则拒绝。 - 如果
sender权限等级大于或等于封禁等级,且目标用户的权限等级小于sender,则允许。 - 否则,拒绝。
- 如果
- 其他情况下,成员状态未知,拒绝。
- 如果没有
- 如果
sender当前成员状态不是join,则拒绝。 - 如果类型为
m.room.third_party_invite:- 仅当
sender当前权限等级大于或等于邀请等级时允许。
- 仅当
- 如果事件类型的所需权限等级大于
sender的权限等级,则拒绝。 - 如果事件有以
@开头且与sender不一致的state_key,则拒绝。 - 如果类型为
m.room.power_levels:- 如果
content中的users属性不是一个以有效用户ID为键、值为整数(或整数字符串)的对象,则拒绝。 - 如果房间中没有先前的
m.room.power_levels事件,则允许。 - 检查
users_default、events_default、state_default、ban、redact、kick、invite属性是否被新增、变更或移除。对于每一个变动:- 如果当前值大于
sender当前权限等级,则拒绝。 - 如果新值大于
sender当前权限等级,则拒绝。
- 如果当前值大于
- 针对
events属性中被更改或移除的每一项:- 如果当前值大于
sender当前权限等级,则拒绝。
- 如果当前值大于
- 针对
events属性中被新增或变更的每一项:- 如果新值大于
sender当前权限等级,则拒绝。
- 如果新值大于
- 针对
users属性中被更改或移除的每一项(除了sender自己的项):- 如果当前值大于等于
sender当前权限等级,则拒绝。
- 如果当前值大于等于
- 针对
users属性中被新增或变更的每一项:- 如果新值大于
sender当前权限等级,则拒绝。
- 如果新值大于
- 否则,允许。
- 如果
- 其他情况下,允许。
这些规则的一些后果:
- 除非你是房间成员,除了初始化创建/加入外,唯一被允许的操作是:加入公开房间;接受或拒绝房间邀请。
- 要解除对某人的封禁,你的权限等级必须大于等于踢出和封禁等级,并且高于目标用户的权限等级。
状态解析
事件 E 之后的房间状态 S′(E) 由事件 E 之前的房间状态 S(E) 定义,并且依赖于 E 是状态事件还是消息事件:
- 如果 E 是一条消息事件,则 S′(E) = S(E)。
- 如果 E 是一条状态事件,则 S′(E) 与 S(E) 相同,除了其与 E 的
event_type和state_key对应的项被 E 的event_id替换。
事件 E 之前的房间状态 S(E) 是 prev_event 集合 {E1, E2, …} 之后的状态集合 {S′(E1), S′(E2), …} 的 合并与决议结果。如何对一组状态进行合并与决议,见下述算法。
定义
版本 2 房间的状态合并算法使用如下定义,并以房间状态集 {S1, S2, …} 为输入:
权限事件(Power events)。
权限事件 指具有类型 m.room.power_levels 或 m.room.join_rules 的状态事件,或者类型为 m.room.member 且 membership 字段为 leave 或 ban,且 sender 与 state_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)进行拓扑排序,得到字典序最小的排序,并从最早事件到最晚事件排列。比较两个拓扑排序确定哪一个字典序更小时,事件的比较关系如下:对事件 x 和 y,若
- x 的发送者的权限级别 高于 y 的发送者(以各自的
auth_event查得);或 - 发送者权限级别相同,但 x 的
origin_server_ts小于 y;或 - 权限级别与
origin_server_ts都相同,但 x 的event_id小于 y 的event_id,
则 x < y。
逆拓扑权限排序可用 Kahn 算法进行拓扑排序,每步从候选顶点中按上述比较关系选择最小顶点。
主链排序(Mainline ordering)。
令 P = P0 为某个 m.room.power_levels 事件。从 i = 0 开始,反复获取 Pi+1,即 Pi 的 auth_events 中类型为 m.room.power_levels 的事件。每次自增 i,直到 Pi 的 auth_events 中没有 m.room.power_levels 事件为止。P0 的 主链 为 [P0 , P1, … , Pn]。
若另有事件 e = e0(可以是另一个 m.room.power_levels 事件),可以构造类似事件链 [e1, …, em],其中 ej+1 为 ej 的 auth_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 的主链排序,就是将一组事件按以下比较关系(从小到大)排序:对事件 x 和 y,若
- x 的主链位置 大于 y(即 x 的鉴权链基于主链上的较早事件);或
- 主链位置相同,但 x 的
origin_server_ts小于 y;或 - 主链位置、
origin_server_ts都相同,但 x 的event_id小于 y,
则 x < y。
迭代鉴权检查(Iterative auth checks)。
迭代鉴权检查算法 的输入是初始房间状态和已排序的状态事件列表。它通过遍历事件列表,将符合授权规则的状态事件依次应用到房间状态上。若某状态事件未通过授权规则,则忽略该事件。如果验证授权规则时缺少某个必须的 (event_type, state_key) key,则用事件 auth_events 中相应的状态事件(若未被拒绝)替代。
算法
一组状态的 合并与决议 按如下步骤执行:
- 选取出现在 完整冲突集 内的所有权限事件组成集合 X。对于每一个权限事件 P,将 P 的鉴权链中同时属于完整冲突集的事件也加入 X。对 X 按 逆拓扑权限排序 排序为列表。
- 从 无冲突状态映射 作为起点,对上一步得到的事件列表应用迭代鉴权检查算法,得出部分已决议状态。
- 将第 1 步未涉及的所有剩余事件按第 2 步已决议状态中的权限等级,用主链排序确定顺序。
- 对上述部分已决议状态及新排序的事件列表,再次应用迭代鉴权检查算法。
- 用无冲突状态映射中的相同 key 事件(若存在)替换当前结果中对应事件,得出最终合并决议状态。
被拒绝的事件
由于基于事件当前状态(而非鉴权链)验证授权而被拒绝的事件,除非另有特别说明,在算法中仍按常规方式处理。
注意,那些由于无法通过其鉴权链授权而被拒绝的事件不应出现在此流程中,因为他们不会出现在状态集合之内(本算法只使用状态集中的事件,或状态集中事件的鉴权链中的事件)。
这样做有助于保证不同服务器下房间状态更易收敛,因为事件的被拒绝状态可能不同。如果某服务器在另一个服务器作为中转加入房间时返回了不正确的状态(无论是故障还是恶意),就有可能出现此类差异。状态收敛是重要特性,因为它确保房间中所有用户都看到(基本)一致的房间状态。如果各服务器状态视图分歧,可能导致房间分裂,例如因对成员列表存在分歧。
直观来看,使用被拒绝的事件似乎有风险,但实际上:
- 服务器无法随意伪造状态,因为它们仍需通过根据事件鉴权链的鉴权检查(例如,若之前没有权限,不能自授权限)。
- 若想使一个已被拒绝的事件通过鉴权,必须存在某个状态集允许该事件。恶意服务器可能构造一个分支,声称状态就是该特定状态集,然后复制被拒绝事件指向该分支并发送该事件。复制的事件将通过鉴权检查。因此,忽略被拒绝事件未必能消除潜在攻击路径。
被拒绝的鉴权事件(auth events)故意不参与迭代鉴权检查,因为检查过程中不会对鉴权事件重新授权(但非鉴权事件则会被检查)。
规范化 JSON
出于附录中所述的原因,服务器不得强制严格遵循所规定的 JSON 格式。