Compare commits

...

7 commits

Author SHA1 Message Date
Helix K 66a44a3f09
Merge d9d14dcfe2 into 19fbee9842 2026-06-01 16:21:53 -05:00
gewitternacht 19fbee9842
add links from the Client-Server spec to the Olm message definitions (#2381)
Some checks are pending
Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run
Spec / 🔎 Check Event schema examples (push) Waiting to run
Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run
Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run
Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run
Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions
Spec / 📢 Run towncrier for changelog (push) Waiting to run
Spec / 📖 Build the spec (push) Blocked by required conditions
Spec / 🔎 Validate generated HTML (push) Blocked by required conditions
Spec / 📖 Build the historical backup spec (push) Blocked by required conditions
Spec / Create release (push) Blocked by required conditions
Spell Check / Spell Check with Typos (push) Waiting to run
* add links from the Client-Server spec to the Olm message definitions

* add newsfragment
2026-06-01 14:43:17 +02:00
gewitternacht f65501882d
replace "Olm message" where not referring to the Olm message format (#2383)
* replace "Olm message" where not referring to the Olm message format

* add newsfragment
2026-06-01 14:40:39 +02:00
gewitternacht ce47b27acf
disambiguate placeholder descriptions in OlmPayload example (#2382)
* disambiguate placeholder descriptions in OlmPayload example

* add newsfragment
2026-06-01 14:36:37 +02:00
Helix K d9d14dcfe2
reword 2026-03-18 09:29:51 -05:00
Kierre 54f32b72de
newsfragment 2026-03-10 17:43:59 -05:00
Kierre efafa1c3cf
Clarify that ACLs are case-insensitive 2026-03-10 17:39:11 -05:00
7 changed files with 17 additions and 11 deletions

View file

@ -0,0 +1 @@
Add links from the Client-Server spec to the Olm message definitions.

View file

@ -0,0 +1 @@
Disambiguate placeholder descriptions in OlmPayload example.

View file

@ -0,0 +1 @@
Replace "Olm message" with "event encrypted using Olm" where not referring to the Olm message format.

View file

@ -0,0 +1 @@
Clarify that server ACLs are case-insensitive.

View file

@ -1623,9 +1623,9 @@ An event encrypted using Olm has the following format:
```
`ciphertext` is a mapping from device Curve25519 key to an encrypted
payload for that device. `body` is a Base64-encoded Olm message body.
payload for that device. `body` is a Base64-encoded [Olm message body](/olm-megolm/olm/#the-olm-message-format).
`type` is an integer indicating the type of the message body: 0 for the
initial pre-key message, 1 for ordinary messages.
initial [pre-key message](/olm-megolm/olm/#pre-key-messages), 1 for [normal messages](/olm-megolm/olm/#normal-messages).
Olm sessions will generate messages with a type of 0 until they receive
a message. Once a session has decrypted a message it will produce
@ -1698,7 +1698,7 @@ Curve25519 key used to establish the Olm session does indeed belong
to the claimed `sender`. This requires a signed "device keys" structure
for that Curve25519 key, which can be obtained in one of two ways:
1. An Olm message may be received with a `sender_device_keys` property
1. An event encrypted using Olm may be received with a `sender_device_keys` property
in the decrypted content.
2. The keys are returned via a [`/keys/query`](#post_matrixclientv3keysquery)
request. Note that both the Curve25519 key **and** the Ed25519 key in

View file

@ -16,7 +16,7 @@
type: object
title: OlmPayload
description: |-
The plaintext payload of Olm message events.
The plaintext payload of an event encrypted using Olm.
properties:
type:
type: string
@ -65,15 +65,15 @@ example: {
"sender": "<sender_user_id>",
"recipient": "<recipient_user_id>",
"recipient_keys": {
"ed25519": "<our_ed25519_key>"
"ed25519": "<recipient_ed25519_key>"
},
"keys": {
"ed25519": "<sender_ed25519_key>"
},
"sender_device_keys": {
"algorithms": ["<supported>", "<algorithms>"],
"user_id": "<user_id>",
"device_id": "<device_id>",
"user_id": "<sender_user_id>",
"device_id": "<sender_device_id>",
"keys": {
"ed25519:<device_id>": "<sender_ed25519_key>",
"curve25519:<device_id>": "<sender_curve25519_key>"

View file

@ -62,8 +62,9 @@ properties:
allow:
type: array
description: |-
The server names to allow in the room, excluding any port information.
Each entry is interpreted as a [glob-style pattern](/appendices#glob-style-matching).
The case-insensitive [glob expressions](/appendices#glob-style-matching) that are
evaluated against server names excluding any port information to determine the servers
to allow in the room.
**This defaults to an empty list when not provided, effectively disallowing
every server.**
@ -72,8 +73,9 @@ properties:
deny:
type: array
description: |-
The server names to disallow in the room, excluding any port information.
Each entry is interpreted as a [glob-style pattern](/appendices#glob-style-matching).
The case-insensitive [glob expressions](/appendices#glob-style-matching) that are
evaluated against server names excluding any port information to determine the servers
to disallow in the room.
This defaults to an empty list when not provided.
items: