mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-24 16:23:41 +01:00
00c6a866e2
Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
60 lines
1.9 KiB
YAML
60 lines
1.9 KiB
YAML
---
|
|
allOf:
|
|
- $ref: core-event-schema/event.yaml
|
|
|
|
description: |-
|
|
Accepts a previously sent ``m.key.verification.start`` message. Typically sent as a
|
|
`to-device`_ event.
|
|
properties:
|
|
content:
|
|
properties:
|
|
transaction_id:
|
|
type: string
|
|
description: |-
|
|
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 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 ``m.key.verification.start`` message.
|
|
required:
|
|
- transaction_id
|
|
- method
|
|
- key_agreement_protocol
|
|
- hash
|
|
- message_authentication_code
|
|
- short_authentication_string
|
|
- commitment
|
|
type: object
|
|
type:
|
|
enum:
|
|
- m.key.verification.accept
|
|
type: string
|
|
type: object
|