Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-04-13 06:34:10 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

make code required, and some more details about no_olm

Browse source
This commit is contained in:
Hubert Chathi 2020-03-19 17:10:44 -04:00
parent 654a9574be
commit a0fcb7d9e1
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
proposals/2399-reporting-no-key-sent.md
View file

@ -31,7 +31,7 @@ the properties:
- `algorithm`: Required. The encryption algorithm that the key is for. - `algorithm`: Required. The encryption algorithm that the key is for.
- `session_id`: Required if `code` is not `m.no_olm`. The ID of the session. - `session_id`: Required if `code` is not `m.no_olm`. The ID of the session.
- `sender_key`: Required. The key of the session creator. - `sender_key`: Required. The key of the session creator.
- `code`: A machine-readable code for why the key was not sent. - `code`: Required. A machine-readable code for why the key was not sent.
Possible values are: Possible values are:
- `m.blacklisted`: the user/device was blacklisted - `m.blacklisted`: the user/device was blacklisted
- `m.unverified`: the user/devices is unverified - `m.unverified`: the user/devices is unverified
@ -43,10 +43,9 @@ the properties:
- `m.no_olm`: an olm session could not be established. This may happen, for - `m.no_olm`: an olm session could not be established. This may happen, for
example, if the sender was unable to obtain a one-time key from the example, if the sender was unable to obtain a one-time key from the
recipient. recipient.
- `reason`: A human-readable reason for why the key was not sent. If there is - `reason`: A human-readable reason for why the key was not sent. The
a `code`, this should be a human-readable representation of `code`. The
receiving client should only use this string if it does not understand the receiving client should only use this string if it does not understand the
`code` or if `code` is not provided. `code`.
An `m.room_key.withheld` event should only be sent once per session; the An `m.room_key.withheld` event should only be sent once per session; the
recipient of the event should assume that the event applies to all messages in recipient of the event should assume that the event applies to all messages in
@ -60,8 +59,11 @@ A `code` of `m.no_olm` is used to indicate that the sender is unable to
establish an olm session with the recipient. When this happens, multiple establish an olm session with the recipient. When this happens, multiple
sessions will be affected. In order to avoid filling the recipient's device sessions will be affected. In order to avoid filling the recipient's device
mailbox, the sender should only send one `m.room_key.withheld` message with no mailbox, the sender should only send one `m.room_key.withheld` message with no
`room_id` nor `session_id` set. FIXME: how does the recipient determine which `room_id` nor `session_id` set. In response to receiving this message, the
sessions the notification applies to? recipient may start an olm session with the sender, and send an `m.dummy`
message to notify the sender of the new olm session. The recipient may assume
that this `m.room_key.withheld` message applies to all encrypted room messages
sent before it receives the message.
## Potential issues ## Potential issues
@ -71,8 +73,7 @@ megolm keys.
## Security considerations ## Security considerations
A user might not want to notify another user of the reason why it was not sent A user might not want to notify another user of the reason why it was not sent
the keys. Sending `m.room_key.withheld`, or specifying the `reason`/`code` are the keys. Sending `m.room_key.withheld` is optional.
optional.
## Unstable prefix ## Unstable prefix