complete m.room_key documentation

pull/1284/head
Valentin Deniaud 7 years ago
parent 3a8d13df60
commit c60109d235

@ -3,7 +3,7 @@
"algorithm": "m.megolm.v1.aes-sha2", "algorithm": "m.megolm.v1.aes-sha2",
"room_id": "!UCnwUWwIKhcpaPTHtR:sw1v.org", "room_id": "!UCnwUWwIKhcpaPTHtR:sw1v.org",
"session_id": "X3lUlvLELLYxeTx4yOVu6UDpasGEVO0Jbu+QFnm0cKQ", "session_id": "X3lUlvLELLYxeTx4yOVu6UDpasGEVO0Jbu+QFnm0cKQ",
"session_key": "AgAAAADxKHa9uFxcXzwYoNueL5Xqi69IkD4sni8LlfJL7qNBEYbf8q5V1G7D/0GHj81JbEFsaE8JOHXJCyIqUGU9svVEi52SAGiC4lpID43TAeGfYc64rUsBx5ovhZl8WrdszLxld29I+7H9e8GZt/NVd/ZQEBBfOv3vrgoODT3WpJiWZ7VEIjL6gspKkkRTDcmwYU6Eff+A11iJ2tEC9njtCeNfTrK7XUIPoXkHWmEjPwqdSQi9pqVb1OYRKT7un7WFJzo0WEw8xjo6wyEolSikaBr3/o8FhoIMIA9KvbjR4y1WDg" "session_key": "AgAAAADxKHa9uFxcXzwYoNueL5Xqi69IkD4sni8LlfJL7qNBEY..."
}, },
"type": "m.room_key" "type": "m.room_key"
} }

@ -4,18 +4,29 @@ allOf:
description: |- description: |-
This event type is used to exchange keys for end-to-end encryption. Typically This event type is used to exchange keys for end-to-end encryption. Typically
it is encrypted as an ``m.room.encrypted`` event. it is encrypted as an ``m.room.encrypted`` event, then sent as a `to-device`_ event.
properties: properties:
content: content:
properties: properties:
algorithm: algorithm:
type: string type: string
enum: ["m.megolm.v1.aes-sha2"]
description: |- description: |-
The encryption algorithm the keys in this event are to be used The encryption algorithm the key in this event is to be used with.
with. The value of this field determines which other properties will room_id:
be present. type: string
description: The room where the key is used.
session_id:
type: string
description: The ID of the session that the key is for.
session_key:
type: string
description: The key to be exchanged.
required: required:
- algorithm - algorithm
- room_id
- session_id
- session_key
type: object type: object
type: type:
enum: enum:

Loading…
Cancel
Save