matrix-spec-proposals/data/event-schemas/schema/m.room_key_request.yaml

---
allOf:
  - $ref: core-event-schema/event.yaml

description: |-
  This event type is used to request keys for end-to-end encryption. It is sent as an
  unencrypted `to-device`_ event.
properties:
  content:
    properties:
      body:
        description: |-
          Information about the requested key. Required when ``action`` is
          ``request``.
        properties:
          algorithm:
            type: string
            description: |-
              The encryption algorithm the requested key in this event is to be used
              with.
          room_id:
            type: string
            description: The room where the key is used.
          sender_key:
            type: string
            description: |-
              The Curve25519 key of the device which initiated the session originally.
          session_id:
            type: string
            description: The ID of the session that the key is for.
        required:
          - algorithm
          - room_id
          - session_id
          - sender_key
        type: object
        title: RequestedKeyInfo
      action:
        enum:
          - request
          - request_cancellation
        type: string
      requesting_device_id:
        description: ID of the device requesting the key.
        type: string
      request_id:
        description: |-
          A random string uniquely identifying the request for a key. If the key is
          requested multiple times, it should be reused. It should also reused in order
          to cancel a request.
        type: string
    required:
      - action
      - requesting_device_id
      - request_id
    type: object
  type:
    enum:
      - m.room_key_request
    type: string
type: object
document key sharing and m.room_key_request 6 years ago			`---`
			`allOf:`
			`- $ref: core-event-schema/event.yaml`

			`description: \|-`
			`This event type is used to request keys for end-to-end encryption. It is sent as an`
			unencrypted `to-device`_ event.
			`properties:`
			`content:`
			`properties:`
			`body:`
fixup! document key sharing and m.room_key_request 6 years ago			`description: \|-`
			Information about the requested key. Required when ``action`` is
			``request``.
document key sharing and m.room_key_request 6 years ago			`properties:`
			`algorithm:`
			`type: string`
			`description: \|-`
			`The encryption algorithm the requested key in this event is to be used`
			`with.`
			`room_id:`
			`type: string`
			`description: The room where the key is used.`
			`sender_key:`
			`type: string`
			`description: \|-`
			`The Curve25519 key of the device which initiated the session originally.`
			`session_id:`
			`type: string`
fixup! document key sharing and m.room_key_request 6 years ago			`description: The ID of the session that the key is for.`
document key sharing and m.room_key_request 6 years ago			`required:`
			`- algorithm`
			`- room_id`
			`- session_id`
			`- sender_key`
			`type: object`
			`title: RequestedKeyInfo`
			`action:`
			`enum:`
			`- request`
Fix the action of a room key request cancellation. The spec states that the action of a room key request cancellation should be "cancel_request" but every known implementation uses "request_cancellation" instead. This patch fixes the spec to reflect the implementations. 5 years ago			`- request_cancellation`
document key sharing and m.room_key_request 6 years ago			`type: string`
			`requesting_device_id:`
			`description: ID of the device requesting the key.`
			`type: string`
			`request_id:`
			`description: \|-`
			`A random string uniquely identifying the request for a key. If the key is`
			`requested multiple times, it should be reused. It should also reused in order`
			`to cancel a request.`
			`type: string`
			`required:`
			`- action`
			`- requesting_device_id`
			`- request_id`
			`type: object`
			`type:`
			`enum:`
			`- m.room_key_request`
			`type: string`
			`type: object`