From a9350fcc41133f6d96a71ebcce750754098c7e53 Mon Sep 17 00:00:00 2001 From: Sumner Evans Date: Fri, 7 Jun 2024 11:31:58 -0600 Subject: [PATCH] fixup! e2ee/device verification: normalize all links Signed-off-by: Sumner Evans --- .../schema/m.key.verification.cancel.yaml | 22 +++++++++++-------- .../m.key.verification.m.relates_to.yaml | 11 +++++----- .../schema/m.key.verification.ready.yaml | 8 +++---- .../schema/m.key.verification.request.yaml | 5 +++-- 4 files changed, 26 insertions(+), 20 deletions(-) diff --git a/data/event-schemas/schema/m.key.verification.cancel.yaml b/data/event-schemas/schema/m.key.verification.cancel.yaml index 237f0d06..53973a39 100644 --- a/data/event-schemas/schema/m.key.verification.cancel.yaml +++ b/data/event-schemas/schema/m.key.verification.cancel.yaml @@ -31,17 +31,19 @@ properties: * `m.user`: The user cancelled the verification. * `m.timeout`: The verification process timed out. Verification processes - can define their own timeout parameters. + can define their own timeout parameters. * `m.unknown_transaction`: The device does not know about the given transaction - ID. + 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.unknown_method`: The device does not know how to handle the + requested method. This should be sent for + [`m.key.verification.start`](#mkeyverificationstart) 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.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. @@ -49,8 +51,10 @@ properties: * `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. + * `m.accepted`: A + [`m.key.verification.request`](#mkeyverificationrequest) 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 diff --git a/data/event-schemas/schema/m.key.verification.m.relates_to.yaml b/data/event-schemas/schema/m.key.verification.m.relates_to.yaml index 038344b9..9604602a 100644 --- a/data/event-schemas/schema/m.key.verification.m.relates_to.yaml +++ b/data/event-schemas/schema/m.key.verification.m.relates_to.yaml @@ -1,9 +1,9 @@ --- 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. + [`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. properties: rel_type: type: string @@ -15,7 +15,8 @@ properties: event_id: type: string description: |- - The event ID of the `m.key.verification.request` that this message is - related to. + The event ID of the + [`m.key.verification.request`](#mkeyverificationrequest) that this + message is related to. type: object title: VerificationRelatesTo diff --git a/data/event-schemas/schema/m.key.verification.ready.yaml b/data/event-schemas/schema/m.key.verification.ready.yaml index 1c5ed7bd..cdaac01a 100644 --- a/data/event-schemas/schema/m.key.verification.ready.yaml +++ b/data/event-schemas/schema/m.key.verification.ready.yaml @@ -4,7 +4,7 @@ allOf: description: |- Accepts a key verification request. Sent in response to an - `m.key.verification.request` event. + [`m.key.verification.request`](#mkeyverificationrequest) event. properties: content: properties: @@ -16,14 +16,14 @@ properties: 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. + verification request, as given in the + [`m.key.verification.request`](#mkeyverificationrequest) 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. + [`m.key.verification.request`](#mkeyverificationrequest) message. items: type: string m.relates_to: diff --git a/data/event-schemas/schema/m.key.verification.request.yaml b/data/event-schemas/schema/m.key.verification.request.yaml index 76ba618d..9a2fd098 100644 --- a/data/event-schemas/schema/m.key.verification.request.yaml +++ b/data/event-schemas/schema/m.key.verification.request.yaml @@ -4,8 +4,9 @@ allOf: 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`](#mroommessagemkeyverificationrequest) as msgtype. + verification in a room, a [`m.room.message`](#mroommessage should be used, + with [`m.key.verification.request`](#mroommessagemkeyverificationrequest) as + msgtype. properties: content: properties: