mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-25 20:44:09 +01:00
e2ee/device verification start: clarify required nature of transaction_id or m.relates_to
Add notes about the fact that the start event *may* be the first event sent during a verification process and that clients should handle other clients doing so, but not themselves send the start event first. Signed-off-by: Sumner Evans <sumner.evans@automattic.com>
This commit is contained in:
parent
a79d5a66ed
commit
4282a1a319
|
|
@ -16,11 +16,20 @@ properties:
|
||||||
transaction_id:
|
transaction_id:
|
||||||
type: string
|
type: string
|
||||||
description: |-
|
description: |-
|
||||||
Required when sent as a to-device message. An opaque identifier for
|
Required when sent as a to-device message unless the start event is
|
||||||
the verification process. Must be unique with respect to the devices
|
sent without a corresponding
|
||||||
involved. Must be the same as the `transaction_id` given in the
|
[`m.key.verification.request`](#mkeyverificationrequest).
|
||||||
`m.key.verification.request` if this process is originating from a
|
|
||||||
request.
|
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`](#mkeyverificationrequest) if this
|
||||||
|
process is originating from a request.
|
||||||
|
|
||||||
|
Note that sending a start event without a request is deprecated, and
|
||||||
|
clients should not send a start event without first sending a request
|
||||||
|
event, but clients should handle other clients doing so.
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
description: |-
|
description: |-
|
||||||
|
|
@ -32,7 +41,36 @@ properties:
|
||||||
when the `method` chosen only verifies one user's key. This field will
|
when the `method` chosen only verifies one user's key. This field will
|
||||||
never be present if the `method` verifies keys both ways.
|
never be present if the `method` verifies keys both ways.
|
||||||
m.relates_to:
|
m.relates_to:
|
||||||
$ref: m.key.verification.m.relates_to.yaml
|
description: |-
|
||||||
|
Required when sent as an in-room message unless the start event is
|
||||||
|
sent without a corresponding
|
||||||
|
[`m.key.verification.request`](#mkeyverificationrequest).
|
||||||
|
|
||||||
|
Indicates the
|
||||||
|
[`m.key.verification.request`](#mkeyverificationrequest) that this
|
||||||
|
message is related to. Note that for encrypted messages, this
|
||||||
|
property should be in the unencrypted portion of the event.
|
||||||
|
|
||||||
|
Note that sending a start event without a request is deprecated, and
|
||||||
|
clients should not send a start event without first sending a request
|
||||||
|
event, but clients should handle other clients doing so.
|
||||||
|
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`](#mkeyverificationrequest) that
|
||||||
|
this message is related to.
|
||||||
|
type: object
|
||||||
|
title: VerificationRelatesTo
|
||||||
required:
|
required:
|
||||||
- from_device
|
- from_device
|
||||||
- method
|
- method
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue