Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add specification for room version 3: Event IDs as hashes
Original proposal: #1659 Implementation proofs (some traversing of the PR tree may be required to get all of them): * matrix-org/synapse#4483 * matrix-org/synapse#4499 This doesn't intentionally change anything from the proposal. **Implementation details**: The simple part of this is the introduction of a rooms/v3.html document. The somewhat unclear part is the stuff done to the s2s definitions. This pulls `unsigned_pdu` out to `unsigned_pdu_base` (all fields except `event_id`) where it can be reused in `pdu` and `pdu_v3` (for rooms v3). These definitions are further moved into the room version specifications where they can highlight the exact schemas in detail. Version 1 has been updated to include the pre-existing event format, however the core principles of the room have not been changed. The same applies to room version 2. Room versions have immutable core principles once in the spec, otherwise these format changes would land in a pre-existing version. The client-server API event formats will need updating, however that is being punted to a different commit to try and keep these changes reviewable.
- Loading branch information
Showing
11 changed files
with
610 additions
and
348 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # Copyright 2019 New Vector Ltd | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| type: object | ||
| title: Persistent Data Unit | ||
| description: A persistent data unit (event) for room version 3. | ||
| example: | ||
| $ref: "../examples/pdu_v3.json" | ||
| allOf: | ||
| - $ref: "unsigned_pdu_base.yaml" | ||
| - type: object | ||
| properties: | ||
| auth_events: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: Event ID. | ||
| description: |- | ||
| Event IDs and reference hashes for the authorization events that would | ||
| allow this event to be in the room. | ||
| example: ["$abase64encodedhash", "$anotherevent"] | ||
| prev_events: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: Event ID. | ||
| description: |- | ||
| Event IDs and reference hashes for the most recent events in the room | ||
| that the homeserver was aware of when it made this event. | ||
| example: ["$abase64encodedhash", "$anotherevent"] | ||
| hashes: | ||
| type: object | ||
| title: Event Hash | ||
| description: |- | ||
| Content hashes of the PDU, following the algorithm specified in `Signing Events`_. | ||
| example: { | ||
| "sha256": "thishashcoversallfieldsincasethisisredacted" | ||
| } | ||
| properties: | ||
| sha256: | ||
| type: string | ||
| description: The hash. | ||
| example: thishashcoversallfieldsincasthisisredacted | ||
| required: ['sha256'] | ||
| signatures: | ||
| type: object | ||
| description: |- | ||
| Signatures for the PDU, following the algorithm specified in `Signing Events`_. | ||
| example: { | ||
| "example.com": { | ||
| "ed25519:key_version:": "these86bytesofbase64signaturecoveressentialfieldsincludinghashessocancheckredactedpdus" | ||
| } | ||
| } | ||
| additionalProperties: | ||
| type: object | ||
| title: Server Signatures | ||
| additionalProperties: | ||
| type: string | ||
| required: | ||
| - auth_events | ||
| - prev_events | ||
| - hashes | ||
| - signatures |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| # Copyright 2018 New Vector Ltd | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| type: object | ||
| title: Unsigned Persistent Data Unit | ||
| description: An unsigned persistent data unit (event) | ||
| example: | ||
| $ref: "../examples/unsigned_pdu_base.json" | ||
| properties: | ||
| room_id: | ||
| type: string | ||
| description: Room identifier. | ||
| example: "!abc123:matrix.org" | ||
| sender: | ||
| type: string | ||
| description: The ID of the user sending the event. | ||
| example: "@someone:matrix.org" | ||
| origin: | ||
| type: string | ||
| description: The ``server_name`` of the homeserver that created this event. | ||
| example: "matrix.org" | ||
| origin_server_ts: | ||
| type: integer | ||
| format: int64 | ||
| description: Timestamp in milliseconds on origin homeserver when this event was created. | ||
| example: 1234567890 | ||
| type: | ||
| type: string | ||
| description: Event type | ||
| example: "m.room.message" | ||
| state_key: | ||
| type: string | ||
| description: |- | ||
| 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. | ||
| example: "my_key" | ||
| content: | ||
| type: object | ||
| description: The content of the event. | ||
| example: {"key": "value"} | ||
| prev_events: | ||
| type: array | ||
| description: |- | ||
| Event IDs and reference hashes for the most recent events in the room | ||
| that the homeserver was aware of when it made this event. | ||
| items: | ||
| type: array | ||
| maxItems: 2 | ||
| minItems: 2 | ||
| items: | ||
| - type: string | ||
| title: Event ID | ||
| example: "$abc123:matrix.org" | ||
| - type: object | ||
| title: Event Hash | ||
| example: { | ||
| "sha256": "abase64encodedsha256hashshouldbe43byteslong" | ||
| } | ||
| properties: | ||
| sha256: | ||
| type: string | ||
| description: The event hash. | ||
| example: abase64encodedsha256hashshouldbe43byteslong | ||
| required: ['sha256'] | ||
| depth: | ||
| type: integer | ||
| description: |- | ||
| The maximum depth of the ``prev_events``, plus one. Must be less than the | ||
| maximum value for an integer (2^63 - 1). If the room's depth is already at | ||
| the limit, the depth must be set to the limit. | ||
| example: 12 | ||
| auth_events: | ||
| type: array | ||
| description: |- | ||
| Event IDs and reference hashes for the authorization events that would | ||
| allow this event to be in the room. | ||
| items: | ||
| type: array | ||
| maxItems: 2 | ||
| minItems: 2 | ||
| items: | ||
| - type: string | ||
| title: Event ID | ||
| example: "$abc123:matrix.org" | ||
| - type: object | ||
| title: Event Hash | ||
| example: { | ||
| "sha256": "abase64encodedsha256hashshouldbe43byteslong" | ||
| } | ||
| properties: | ||
| sha256: | ||
| type: string | ||
| description: The event hash. | ||
| example: abase64encodedsha256hashshouldbe43byteslong | ||
| required: ['sha256'] | ||
| redacts: | ||
| type: string | ||
| description: For redaction events, the ID of the event being redacted. | ||
| example: "$def456:matrix.org" | ||
| unsigned: | ||
| type: object | ||
| title: Example Unsigned Data | ||
| description: |- | ||
| Additional data added by the origin server but not covered by the ``signatures``. More | ||
| keys than those defined here may be used. | ||
| example: {"key": "value"} | ||
| properties: | ||
| age: | ||
| type: integer | ||
| description: The number of milliseconds that have passed since this message was sent. | ||
| example: 4612 | ||
| replaces_state: | ||
| type: string | ||
| description: The event ID of the state event this event replaces. | ||
| example: "$state_event:example.org" | ||
| prev_sender: | ||
| type: string | ||
| description: The sender of the replaced state event. | ||
| example: "@someone:example.org" | ||
| prev_content: | ||
| type: object | ||
| description: The content of the replaced state event. | ||
| example: { | ||
| "membership": "join", | ||
| "displayname": "Bob" | ||
| } | ||
| redacted_because: | ||
| type: string | ||
| description: A reason for why the event was redacted. | ||
| example: "Inappropriate content" | ||
| required: | ||
| - event_id | ||
| - room_id | ||
| - sender | ||
| - origin | ||
| - origin_server_ts | ||
| - type | ||
| - content | ||
| - prev_events | ||
| - depth | ||
| - auth_events |
Oops, something went wrong.