mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-05 19:24:10 +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
70 lines
2.1 KiB
YAML
70 lines
2.1 KiB
YAML
---
|
|
allOf:
|
|
- $ref: core-event-schema/event.yaml
|
|
|
|
description: |-
|
|
Begins a SAS key verification process using the ``m.sas.v1`` method. Typically sent as a `to-device`_ event.
|
|
properties:
|
|
content:
|
|
properties:
|
|
from_device:
|
|
type: string
|
|
description: |-
|
|
The device ID which is initiating the process.
|
|
transaction_id:
|
|
type: string
|
|
description: |-
|
|
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 codes that the sending device understands.
|
|
Must include at least ``hkdf-hmac-sha256``.
|
|
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"]
|
|
required:
|
|
- from_device
|
|
- transaction_id
|
|
- method
|
|
- key_agreement_protocols
|
|
- hashes
|
|
- message_authentication_codes
|
|
- short_authentication_string
|
|
type: object
|
|
type:
|
|
enum:
|
|
- m.key.verification.start
|
|
type: string
|
|
type: object
|