mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-07-25 23:37:48 +02:00
bf5fbc9945
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
* use User ID type in OlmPayload and DeviceKeys Signed-off-by: Johanna Stuber <johannas@element.io> * add newsfragment Signed-off-by: Johanna Stuber <johannas@element.io> --------- Signed-off-by: Johanna Stuber <johannas@element.io>
93 lines
2.6 KiB
YAML
93 lines
2.6 KiB
YAML
# Copyright 2025 The Matrix.org Foundation C.I.C
|
|
#
|
|
# 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: OlmPayload
|
|
description: |-
|
|
The plaintext payload of an event encrypted using Olm.
|
|
properties:
|
|
type:
|
|
type: string
|
|
description: The type of the event.
|
|
content:
|
|
type: object
|
|
description: The event content.
|
|
sender:
|
|
type: string
|
|
description: The user ID of the event sender.
|
|
format: mx-user-id
|
|
pattern: "^@"
|
|
recipient:
|
|
type: string
|
|
description: The user ID of the intended event recipient.
|
|
format: mx-user-id
|
|
pattern: "^@"
|
|
recipient_keys:
|
|
description: The recipient's signing keys of the encrypted event.
|
|
$ref: "#/components/schemas/SigningKeys"
|
|
keys:
|
|
$ref: "#/components/schemas/SigningKeys"
|
|
description: The sender's signing keys of the encrypted event.
|
|
sender_device_keys:
|
|
$ref: device_keys.yaml
|
|
description: The sender's device keys.
|
|
x-addedInMatrixVersion: "1.15"
|
|
required:
|
|
- type
|
|
- content
|
|
- sender
|
|
- recipient
|
|
- recipient_keys
|
|
- keys
|
|
components:
|
|
schemas:
|
|
SigningKeys:
|
|
type: object
|
|
title: SigningKeys
|
|
description: Public keys used for an `m.olm.v1.curve25519-aes-sha2` event.
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
description: The Ed25519 public key encoded using unpadded base64.
|
|
required:
|
|
- ed25519
|
|
example: {
|
|
"type": "<type of the plaintext event>",
|
|
"content": "<content for the plaintext event>",
|
|
"sender": "<sender_user_id>",
|
|
"recipient": "<recipient_user_id>",
|
|
"recipient_keys": {
|
|
"ed25519": "<recipient_ed25519_key>"
|
|
},
|
|
"keys": {
|
|
"ed25519": "<sender_ed25519_key>"
|
|
},
|
|
"sender_device_keys": {
|
|
"algorithms": ["<supported>", "<algorithms>"],
|
|
"user_id": "<sender_user_id>",
|
|
"device_id": "<sender_device_id>",
|
|
"keys": {
|
|
"ed25519:<device_id>": "<sender_ed25519_key>",
|
|
"curve25519:<device_id>": "<sender_curve25519_key>"
|
|
},
|
|
"signatures": {
|
|
"<user_id>": {
|
|
"ed25519:<device_id>": "<device_signature>",
|
|
"ed25519:<ssk_id>": "<ssk_signature>",
|
|
}
|
|
}
|
|
}
|
|
}
|