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

clarify otk and fallback key types in examples (#1715)

Browse source 
* clarify otk and fallback key types in examples

- remove unsigned curve25519 keys from examples because we don't use those for
  otks and fallback keys
- add missing `device_unused_fallback_key_types` property, which is required

* add changelog
This commit is contained in:
Hubert Chathi 2024-02-08 15:54:52 -05:00 • committed by GitHub
parent 650e691a22
commit 170626da67
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 3 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1 @@
Clarify one-time key and fallback key types in examples.

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

@ -1776,9 +1776,9 @@ Example response:
], ],
}, },
"device_one_time_keys_count": { "device_one_time_keys_count": {
"curve25519": 10,
"signed_curve25519": 20 "signed_curve25519": 20
} },
"device_unused_fallback_key_types": ["signed_curve25519"]
} }
``` ```

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

@ -52,7 +52,6 @@ paths:
May be absent if no new one-time keys are required. May be absent if no new one-time keys are required.
example: example:
curve25519:AAAAAQ: /qyvZvwjiTxGdGU0RCguDCLeR+nmsb3FfNG3/Ve4vU8
signed_curve25519:AAAAHg: signed_curve25519:AAAAHg:
key: zKbLg+NrIjpnagy+pIY6uPL4ZwEG2v+8F9lmgsnlZzs key: zKbLg+NrIjpnagy+pIY6uPL4ZwEG2v+8F9lmgsnlZzs
signatures: signatures:
@ -84,7 +83,6 @@ paths:
May be absent if a new fallback key is not required. May be absent if a new fallback key is not required.
example: example:
curve25519:AAAAAG: /qyvZvwjiTxGdGU0RCguDCLeR+nmsb3FfNG3/Ve4vU8
signed_curve25519:AAAAGj: signed_curve25519:AAAAGj:
key: zKbLg+NrIjpnagy+pIY6uPL4ZwEG2v+8F9lmgsnlZzs key: zKbLg+NrIjpnagy+pIY6uPL4ZwEG2v+8F9lmgsnlZzs
fallback: true fallback: true
@ -111,7 +109,6 @@ paths:
If an algorithm is not listed, the count for that algorithm If an algorithm is not listed, the count for that algorithm
is to be assumed zero. is to be assumed zero.
example: example:
curve25519: 10
signed_curve25519: 20 signed_curve25519: 20
required: required:
- one_time_key_counts - one_time_key_counts