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

Clarify how to interpret missing one time key counts (#3636)

Browse source
This commit is contained in:
Hubert Chathi 2022-01-11 15:30:46 -05:00 • committed by GitHub
parent 2a5e33a760
commit 6fb684397a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1 @@
Clarify how to interpret missing one-time key counts.

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

@ -1645,7 +1645,7 @@ a way to identify the server's support for fallback keys.
| Parameter | Type | Description | | Parameter | Type | Description |
|----------------------------------|--------------------|------------------------------------------------------------------------------------------------------------------------| |----------------------------------|--------------------|------------------------------------------------------------------------------------------------------------------------|
| device_lists | DeviceLists | Optional. Information on e2e device updates. Note: only present on an incremental sync. | | device_lists | DeviceLists | Optional. Information on e2e device updates. Note: only present on an incremental sync. |
| device_one_time_keys_count | {string: integer} | Optional. For each key algorithm, the number of unclaimed one-time keys currently held on the server for this device. | | device_one_time_keys_count | {string: integer} | Optional. For each key algorithm, the number of unclaimed one-time keys currently held on the server for this device. If an algorithm is unlisted, the count for that algorithm is assumed to be zero. If this entire parameter is missing, the count for all algorithms is assumed to be zero. |
| device_unused_fallback_key_types | [string] | **Required.** The unused fallback key algorithms. | | device_unused_fallback_key_types | [string] | **Required.** The unused fallback key algorithms. |
`DeviceLists` `DeviceLists`

2
data/api/client-server/keys.yaml
View file

@ -148,6 +148,8 @@ paths:
description: |- description: |-
For each key algorithm, the number of unclaimed one-time keys For each key algorithm, the number of unclaimed one-time keys
of that type currently held on the server for this device. of that type currently held on the server for this device.
If an algorithm is not listed, the count for that algorithm
is to be assumed zero.
example: example:
curve25519: 10 curve25519: 10
signed_curve25519: 20 signed_curve25519: 20