async-matrix 0.1.3 → 1.1.0

data/data/matrix-spec/event-schemas/schema/m.identity_server.yaml

@@ -0,0 +1,28 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+description: |-
+  Persists the user's preferred identity server, or preference to not use
+  an identity server at all, in the user's account data.
+properties:
+  content:
+    type: object
+    properties:
+      base_url:
+        anyOf:
+          - type: string
+            format: uri
+          - type: "null"
+        description: |-
+          The URL of the identity server the user prefers to use, or `null`
+          if the user does not want to use an identity server. This value is
+          similar in structure to the `base_url` for identity servers in the
+          `.well-known/matrix/client` schema.
+  type:
+    enum:
+      - m.identity_server
+    type: string
+title: Identity Server Preference
+type: object

data/data/matrix-spec/event-schemas/schema/m.ignored_user_list.yaml

@@ -0,0 +1,30 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+description: |-
+  A map of users which are considered ignored is kept in `account_data`
+  in an event type of `m.ignored_user_list`.
+properties:
+  content:
+    type: object
+    properties:
+      ignored_users:
+        type: object
+        description: |-
+          The map of users to ignore. This is a mapping of user ID to empty
+          object.
+        patternProperties:
+          "^@":
+            type: "object"
+            description: "An empty object for future enhancement"
+            x-pattern-format: "mx-user-id"
+    required:
+      - ignored_users
+  type:
+    enum:
+      - m.ignored_user_list
+    type: string
+title: Ignored User List
+type: object

data/data/matrix-spec/event-schemas/schema/m.invite_permission_config.yaml

@@ -0,0 +1,21 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+allOf:
+  - $ref: core-event-schema/event.yaml
+  - title: Invite Permission
+    type: object
+    description: |-
+      The permission configuration for receiving invites for the current account.
+    properties:
+      content:
+        type: object
+        properties:
+          default_action:
+            type: string
+            description: |-
+              When set to `block`, the user does not wish to receive *any* room invites, and they
+              should be rejected automatically by the homeserver.
+
+              A missing, invalid or unsupported value means that the user wants to receive invites
+              as normal. Other parts of the specification might still have effects on invites, like
+              [ignoring users](/client-server-api/#ignoring-users).

data/data/matrix-spec/event-schemas/schema/m.key.verification.accept.yaml

@@ -0,0 +1,63 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  Accepts a previously sent `m.key.verification.start` message.
+properties:
+  content:
+    properties:
+      transaction_id:
+        type: string
+        description: |-
+          Required when sent as a to-device message. An opaque identifier for
+          the verification process. Must be the same as the one used for the
+          `m.key.verification.start` message.
+      key_agreement_protocol:
+        type: string
+        description: |-
+          The key agreement protocol the device is choosing to use, out of the
+          options in the `m.key.verification.start` message.
+      hash:
+        type: string
+        description: |-
+          The hash method the device is choosing to use, out of the options in
+          the `m.key.verification.start` message.
+      message_authentication_code:
+        type: string
+        description: |-
+          The message authentication code method the device is choosing to use, out of
+          the options in the `m.key.verification.start` message.
+      short_authentication_string:
+        type: array
+        description: |-
+          The SAS methods both devices involved in the verification process
+          understand. Must be a subset of the options in the `m.key.verification.start`
+          message.
+        items:
+          type: string
+          enum: ["decimal", "emoji"]
+      commitment:
+        type: string
+        description: |-
+          The hash (encoded as unpadded base64) of the concatenation of the device's
+          ephemeral public key (encoded as unpadded base64) and the canonical JSON
+          representation of the `content` object of the `m.key.verification.start`
+          message.
+      m.relates_to:
+        $ref: m.key.verification.m.relates_to.yaml
+    required:
+      - method
+      - key_agreement_protocol
+      - hash
+      - message_authentication_code
+      - short_authentication_string
+      - commitment
+    type: object
+  type:
+    enum:
+      - m.key.verification.accept
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.key.verification.cancel.yaml

@@ -0,0 +1,72 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  Cancels a key verification process/request.
+properties:
+  content:
+    properties:
+      transaction_id:
+        type: string
+        description: |-
+          Required when sent as a to-device message. The opaque identifier for
+          the verification process/request.
+      reason:
+        type: string
+        description: |-
+          A human readable description of the `code`. The client should only rely on this
+          string if it does not understand the `code`.
+      code:
+        type: string
+        # Note: this is not an enum because we go into detail about the different
+        # error codes. If we made this an enum, we'd be repeating information.
+        # Also, we can't put a real bulleted list in here because the HTML2RST parser
+        # cuts the text at weird points, breaking the list completely.
+        description: |-
+          The error code for why the process/request was cancelled by the user. Error
+          codes should use the Java package naming convention if not in the following
+          list:
+
+          * `m.user`: The user cancelled the verification.
+
+          * `m.timeout`: The verification process timed out. Verification processes
+          can define their own timeout parameters.
+
+          * `m.unknown_transaction`: The device does not know about the given transaction
+          ID.
+
+          * `m.unknown_method`: The device does not know how to handle the requested
+          method. This should be sent for `m.key.verification.start` messages and
+          messages defined by individual verification processes.
+
+          * `m.unexpected_message`: The device received an unexpected message. Typically
+          raised when one of the parties is handling the verification out of order.
+
+          * `m.key_mismatch`: The key was not verified.
+
+          * `m.user_mismatch`: The expected user did not match the user verified.
+
+          * `m.invalid_message`: The message received was invalid.
+
+          * `m.accepted`: A `m.key.verification.request` was accepted by a different
+            device. The device receiving this error can ignore the verification request.
+
+          Clients should be careful to avoid error loops. For example, if a device sends
+          an incorrect message and the client returns `m.invalid_message` to which it
+          gets an unexpected response with `m.unexpected_message`, the client should not
+          respond again with `m.unexpected_message` to avoid the other device potentially
+          sending another error response.
+      m.relates_to:
+        $ref: m.key.verification.m.relates_to.yaml
+    required:
+      - code
+      - reason
+    type: object
+  type:
+    enum:
+      - m.key.verification.cancel
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.key.verification.done.yaml

@@ -0,0 +1,24 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  Indicates that a verification process/request has completed successfully.
+properties:
+  content:
+    properties:
+      transaction_id:
+        type: string
+        description: |-
+          Required when sent as a to-device message. The opaque identifier for
+          the verification process/request.
+      m.relates_to:
+        $ref: m.key.verification.m.relates_to.yaml
+    type: object
+  type:
+    enum:
+      - m.key.verification.done
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.key.verification.key.yaml

@@ -0,0 +1,31 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  Sends the ephemeral public key for a device to the partner device.
+properties:
+  content:
+    properties:
+      transaction_id:
+        type: string
+        description: |-
+          Required when sent as a to-device message. An opaque identifier for
+          the verification process. Must be the same as the one used for the
+          `m.key.verification.start` message.
+      key:
+        type: string
+        description: |-
+          The device's ephemeral public key, encoded as unpadded base64.
+      m.relates_to:
+        $ref: m.key.verification.m.relates_to.yaml
+    required:
+      - key
+    type: object
+  type:
+    enum:
+      - m.key.verification.key
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.key.verification.m.relates_to.yaml

@@ -0,0 +1,23 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+description: |-
+  Required when sent as an in-room message. Indicates the
+  `m.key.verification.request` that this message is related to. Note that for
+  encrypted messages, this property should be in the unencrypted portion of the
+  event.
+properties:
+  rel_type:
+    type: string
+    enum:
+      - m.reference
+    description: |-
+      The relationship type. Currently, this can only be an
+      [`m.reference`](/client-server-api/#reference-relations) relationship type.
+  event_id:
+    type: string
+    description: |-
+      The event ID of the `m.key.verification.request` that this message is
+      related to.
+type: object
+title: VerificationRelatesTo

data/data/matrix-spec/event-schemas/schema/m.key.verification.mac.yaml

@@ -0,0 +1,43 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  Sends the MAC of a device's key to the partner device.  The MAC is calculated
+  using the method given in `message_authentication_code` property of the
+  `m.key.verification.accept` message.
+properties:
+  content:
+    properties:
+      transaction_id:
+        type: string
+        description: |-
+          Required when sent as a to-device message. An opaque identifier for
+          the verification process. Must be the same as the one used for the
+          `m.key.verification.start` message.
+      mac:
+        type: object
+        description: |-
+          A map of the key ID to the MAC of the key, using the algorithm in the
+          verification process. The MAC is encoded as unpadded base64.
+        additionalProperties:
+          type: string
+          description: The key's MAC, encoded as unpadded base64.
+      keys:
+        type: string
+        description: |-
+          The MAC of the comma-separated, sorted, list of key IDs given in the `mac`
+          property, encoded as unpadded base64.
+      m.relates_to:
+        $ref: m.key.verification.m.relates_to.yaml
+    required:
+      - mac
+      - keys
+    type: object
+  type:
+    enum:
+      - m.key.verification.mac
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.key.verification.ready.yaml

@@ -0,0 +1,41 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  Accepts a key verification request. Sent in response to an
+  `m.key.verification.request` event.
+properties:
+  content:
+    properties:
+      from_device:
+        type: string
+        description: |-
+          The device ID which is accepting the request.
+      transaction_id:
+        type: string
+        description: |-
+          Required when sent as a to-device message. The transaction ID of the
+          verification request, as given in the `m.key.verification.request`
+          message.
+      methods:
+        type: array
+        description: |-
+          The verification methods supported by the sender, corresponding to
+          the verification methods indicated in the
+          `m.key.verification.request` message.
+        items:
+          type: string
+      m.relates_to:
+        $ref: m.key.verification.m.relates_to.yaml
+    required:
+      - from_device
+      - methods
+    type: object
+  type:
+    enum:
+      - m.key.verification.ready
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.key.verification.request.yaml

@@ -0,0 +1,47 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  Requests a key verification using to-device messaging.  When requesting a key
+  verification in a room, a `m.room.message` should be used, with
+  [`m.key.verification.request`](/client-server-api/#mroommessagemkeyverificationrequest)
+  as msgtype.
+properties:
+  content:
+    properties:
+      from_device:
+        type: string
+        description: |-
+          The device ID which is initiating the request.
+      transaction_id:
+        type: string
+        description: |-
+          Required when sent as a to-device message. An opaque identifier for
+          the verification request. Must be unique with respect to the devices
+          involved.
+      methods:
+        type: array
+        description: |-
+          The verification methods supported by the sender.
+        items:
+          type: string
+      timestamp:
+        type: integer
+        format: int64
+        description: |-
+          Required when sent as a to-device message. The POSIX timestamp in
+          milliseconds for when the request was made. If the request is in the
+          future by more than 5 minutes or more than 10 minutes in the past,
+          the message should be ignored by the receiver.
+    required:
+      - from_device
+      - methods
+    type: object
+  type:
+    enum:
+      - m.key.verification.request
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.key.verification.start$m.reciprocate.v1.yaml

@@ -0,0 +1,45 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  Begins a key verification process using the `m.reciprocate.v1` method, after
+  scanning a QR code.
+properties:
+  content:
+    properties:
+      from_device:
+        type: string
+        description: |-
+          The device ID which is initiating the process.
+      transaction_id:
+        type: string
+        description: |-
+          Required when sent as a to-device message. An opaque identifier for
+          the verification process. Must be unique with respect to the devices
+          involved. Must be the same as the `transaction_id` given in the
+          `m.key.verification.request` if this process is originating from a
+          request.
+      method:
+        type: string
+        enum: ["m.reciprocate.v1"]
+        description: |-
+          The verification method to use.
+      secret:
+        type: string
+        description: |-
+          The shared secret from the QR code, encoded using unpadded base64.
+      m.relates_to:
+        $ref: m.key.verification.m.relates_to.yaml
+    required:
+      - from_device
+      - method
+      - secret
+    type: object
+  type:
+    enum:
+      - m.key.verification.start
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.key.verification.start$m.sas.v1.yaml

@@ -0,0 +1,76 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  Begins a SAS key verification process using the `m.sas.v1` method.
+properties:
+  content:
+    properties:
+      from_device:
+        type: string
+        description: |-
+          The device ID which is initiating the process.
+      transaction_id:
+        type: string
+        description: |-
+          Required when sent as a to-device message. An opaque identifier for
+          the verification process. Must be unique with respect to the devices
+          involved. Must be the same as the `transaction_id` given in the
+          `m.key.verification.request` if this process is originating from a
+          request.
+      method:
+        type: string
+        enum: ["m.sas.v1"]
+        description: |-
+          The verification method to use.
+      key_agreement_protocols:
+        type: array
+        description: |-
+          The key agreement protocols the sending device understands. Should
+          include at least `curve25519-hkdf-sha256`.
+        items:
+          type: string
+      hashes:
+        type: array
+        description: |-
+          The hash methods the sending device understands. Must include at least
+          `sha256`.
+        items:
+          type: string
+      message_authentication_codes:
+        type: array
+        description: |-
+          The message authentication code methods that the sending device understands.
+          Must include at least `hkdf-hmac-sha256.v2`.  Should also include
+          `hkdf-hmac-sha256` for compatibility with older clients, though this
+          identifier is deprecated and will be removed in a future version of
+          the spec.
+        items:
+          type: string
+      short_authentication_string:
+        type: array
+        description: |-
+          The SAS methods the sending device (and the sending device's user)
+          understands. Must include at least `decimal`. Optionally can include
+          `emoji`.
+        items:
+          type: string
+          enum: ["decimal", "emoji"]
+      m.relates_to:
+        $ref: m.key.verification.m.relates_to.yaml
+    required:
+      - from_device
+      - method
+      - key_agreement_protocols
+      - hashes
+      - message_authentication_codes
+      - short_authentication_string
+    type: object
+  type:
+    enum:
+      - m.key.verification.start
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.key.verification.start.yaml

@@ -0,0 +1,46 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+
+description: |-
+  Begins a key verification process. Typically sent as a [to-device](/client-server-api/#send-to-device-messaging) event. The `method`
+  field determines the type of verification. The fields in the event will differ depending
+  on the `method`. This definition includes fields that are in common among all variants.
+properties:
+  content:
+    properties:
+      from_device:
+        type: string
+        description: |-
+          The device ID which is initiating the process.
+      transaction_id:
+        type: string
+        description: |-
+          Required when sent as a to-device message. An opaque identifier for
+          the verification process. Must be unique with respect to the devices
+          involved. Must be the same as the `transaction_id` given in the
+          `m.key.verification.request` if this process is originating from a
+          request.
+      method:
+        type: string
+        description: |-
+          The verification method to use.
+      next_method:
+        type: string
+        description: |-
+          Optional method to use to verify the other user's key with. Applicable
+          when the `method` chosen only verifies one user's key. This field will
+          never be present if the `method` verifies keys both ways.
+      m.relates_to:
+        $ref: m.key.verification.m.relates_to.yaml
+    required:
+      - from_device
+      - method
+    type: object
+  type:
+    enum:
+      - m.key.verification.start
+    type: string
+type: object

data/data/matrix-spec/event-schemas/schema/m.key_backup.yaml

@@ -0,0 +1,24 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/event.yaml
+description: |-
+  Allows clients to track user preferences about key backup.
+properties:
+  content:
+    type: object
+    properties:
+      enabled:
+        type: boolean
+        description: |-
+          True if the user chose to enable key backup. False if the user chose
+          to disable key backup.
+    required:
+      - enabled
+  type:
+    type: string
+    enum:
+      - m.key_backup
+title: Key Backup Event
+type: object

data/data/matrix-spec/event-schemas/schema/m.marked_unread.yaml

@@ -0,0 +1,26 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "title": "Unread Marker Event",
+    "description": "The current state of the user's unread marker in a room. This event appears in the user's room account data for the room the marker is applicable for.",
+    "allOf": [{
+        "$ref": "core-event-schema/event.yaml"
+    }],
+    "properties": {
+        "content": {
+            "type": "object",
+            "properties": {
+                "unread": {
+                    "type": "boolean",
+                    "description": "Whether the room is marked unread or not."
+                }
+            },
+            "required": ["unread"]
+        },
+        "type": {
+            "type": "string",
+            "enum": ["m.marked_unread"]
+        }
+    },
+    "required": ["type", "content"]
+}

data/data/matrix-spec/event-schemas/schema/m.policy.rule.room.yaml

@@ -0,0 +1,17 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+
+allOf:
+  - $ref: core-event-schema/state_event.yaml
+description: A moderation policy rule which affects room IDs and room aliases.
+properties:
+  content:
+    $ref: "../moderation_policy_rule.yaml"
+  state_key:
+    description: An arbitrary string decided upon by the sender.
+    type: string
+  type:
+    enum:
+      - m.policy.rule.room
+    type: string
+type: object