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

fallback keys should have a "fallback: true" property (#1676)

Browse source 
* fallback keys should have a "fallback: true" property

* add changelog
This commit is contained in:
Hubert Chathi 2023-11-29 11:56:57 -05:00 • committed by GitHub
parent 6fe2ff4fa7
commit 62c377e19c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/1676.clarification Normal file
View file

@ -0,0 +1 @@
Indicate that fallback keys should have a `fallback` property set to `true`.

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

@ -77,6 +77,7 @@ algorithm is represented by an object with the following properties:
|------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| key | string | **Required.** The unpadded Base64-encoded 32-byte Curve25519 public key. |
| signatures | Signatures | **Required.** Signatures of the key object. The signature is calculated using the process described at [Signing JSON](/appendices/#signing-json). |
| fallback | boolean | Indicates whether this is a [fallback key](#one-time-and-fallback-keys). Defaults to `false`. |
Example:
@ -150,7 +151,9 @@ JSON](/appendices/#signing-json).
One-time and fallback keys are also uploaded to the homeserver using the
[`/keys/upload`](/client-server-api/#post_matrixclientv3keysupload) API. New
one-time and fallback keys are uploaded as needed.
one-time and fallback keys are uploaded as needed. Fallback keys for key
algorithms whose format is a signed JSON object should contain a property named
`fallback` with a value of `true`.
Devices must store the private part of each key they upload. They can
discard the private part of a one-time key when they receive a message