wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Apply suggestions from code review

Browse source 
Co-authored-by: Travis Ralston <travpc@gmail.com>
This commit is contained in:
Hubert Chathi 2021-04-28 15:59:55 -04:00 • committed by Richard van der Hoff
parent c85f98bdab
commit 1a1f01234d
1 changed files with 13 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

18
content/client-server-api/modules/end_to_end_encryption.md
View file

@ -999,6 +999,9 @@ To advertise the ability to show a QR code, clients use the names
advertise the ability to scan a QR code, clients use the names advertise the ability to scan a QR code, clients use the names
`m.qr_code.scan.v1` and `m.reciprocate.v1` in the `methods` fields of the `m.qr_code.scan.v1` and `m.reciprocate.v1` in the `methods` fields of the
`m.key.verification.request` and `m.key.verification.ready` events. `m.key.verification.request` and `m.key.verification.ready` events.
Clients that support both showing and scanning QR codes would advertise
`m.qr_code.show.v1`, `m.qr_code.scan.v1`, and `m.reciprocate.v1` as
methods.
The process between Alice and Bob verifying each other would be: The process between Alice and Bob verifying each other would be:
@ -1010,7 +1013,9 @@ The process between Alice and Bob verifying each other would be:
is able to scan. Bob's client prompts displays a QR code that Alice can is able to scan. Bob's client prompts displays a QR code that Alice can
scan if Alice's client indicated the ability to scan, and an option to scan scan if Alice's client indicated the ability to scan, and an option to scan
Alice's QR code if his client is able to scan. The format for the QR code Alice's QR code if his client is able to scan. The format for the QR code
is described below. is described below. Other options, like starting SAS Emoji verification,
can be presented alongside the QR code if the devices have appropriate
support.
5. Alice scans Bob's QR code. 5. Alice scans Bob's QR code.
6. Alice's device ensures that the keys encoded in the QR code match the 6. Alice's device ensures that the keys encoded in the QR code match the
expected values for the keys. If not, Alice's device displays an error expected values for the keys. If not, Alice's device displays an error
@ -1024,8 +1029,11 @@ The process between Alice and Bob verifying each other would be:
Thus for Bob to verify Alice's key, Alice needs to tell Bob that he has the Thus for Bob to verify Alice's key, Alice needs to tell Bob that he has the
right key. right key.
7. Alice's device displays a message saying that the verification was 7. Alice's device displays a message saying that the verification was
successful. This message tells Alice that she has the right key for Bob, successful because the QR code's keys will have matched the keys
and tells Bob that he has the right key for Alice. expected for Bob. Bob's device hasn't had a chance to verify Alice's
keys yet so wouldn't show the same message. Bob will know that
he has the right key for Alice because Alice's device will have shown
this message, as otherwise the verification would be cancelled.
8. Alice's device sends an `m.key.verification.start` message with `method` set 8. Alice's device sends an `m.key.verification.start` message with `method` set
to `m.reciprocate.v1` to Bob (see below). The message includes the shared to `m.reciprocate.v1` to Bob (see below). The message includes the shared
secret from the QR code. This signals to Bob's device that Alice has secret from the QR code. This signals to Bob's device that Alice has
@ -1060,9 +1068,9 @@ The process between Alice and Bob verifying each other would be:
The QR codes to be displayed and scanned using this format will encode binary The QR codes to be displayed and scanned using this format will encode binary
strings in the general form: strings in the general form:
- the ASCII string "MATRIX" - the ASCII string `MATRIX`
- one byte indicating the QR code version (must be `0x02`) - one byte indicating the QR code version (must be `0x02`)
- one byte indicating the QR code verification mode. May be one of the - one byte indicating the QR code verification mode. Should be one of the
following values: following values:
- `0x00` verifying another user with cross-signing - `0x00` verifying another user with cross-signing
- `0x01` self-verifying in which the current device does trust the master key - `0x01` self-verifying in which the current device does trust the master key