mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-07-29 09:07:58 +02:00
e2b879d13d
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
Signed-off-by: Johanna Stuber <johannas@element.io>
43 lines
1.2 KiB
YAML
43 lines
1.2 KiB
YAML
---
|
|
$schema: https://json-schema.org/draft/2020-12/schema
|
|
|
|
allOf:
|
|
- $ref: core-event-schema/event.yaml
|
|
|
|
description: |-
|
|
This event type is used to share a bundle of room keys when inviting a new user to the room.
|
|
|
|
It is encrypted as an
|
|
[`m.room.encrypted`](/client-server-api/#mroomencrypted) [to-device
|
|
event](/client-server-api/#send-to-device-messaging) using
|
|
[Olm](/client-server-api/#molmv1curve25519-aes-sha2).
|
|
|
|
The `sender_device_keys` property in the [Olm
|
|
plaintext](/client-server-api/#definition-olmplaintext) MUST be
|
|
populated. Recipients SHOULD ignore `m.room_key_bundle` messages which omit
|
|
them.
|
|
properties:
|
|
content:
|
|
properties:
|
|
room_id:
|
|
type: string
|
|
format: mx-room-id
|
|
pattern: "^!"
|
|
description: The room to which the keys in the key bundle relate.
|
|
file:
|
|
description: |-
|
|
An [EncryptedFile](/client-server-api/#definition-encryptedfile)
|
|
structure. The location and decryption keys for the encrypted
|
|
[`RoomKeyBundle`](/client-server-api/#definition-roomkeybundle).
|
|
title: EncryptedFile
|
|
type: object
|
|
required:
|
|
- room_id
|
|
- file
|
|
type: object
|
|
type:
|
|
enum:
|
|
- m.room_key_bundle
|
|
type: string
|
|
type: object
|