Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-22 11:24:08 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Specify the order in which one-time keys are returned (MSC4225)

Browse source 
Signed-off-by: Andy Balaam <andy.balaam@matrix.org>
This commit is contained in:
Andy Balaam 2024-12-09 15:52:11 +00:00
parent 075a98d619
commit 5e0d6d9308
3 changed files with 23 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1 @@
Specify order of one-time keys, as per [MSC4225](https://github.com/matrix-org/matrix-spec-proposals/pull/4225).

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

@ -288,7 +288,17 @@ paths:
/keys/claim:
post:
summary: Claim one-time encryption keys.
description: Claims one-time keys for use in pre-key messages.
description: |-
Claims one-time keys for use in pre-key messages.
The request contains the user ID, device ID and algorithm name of the
keys that are required. The response contains a key matching this -
either a one-time key, or if none are available, a fallback key.
One-time keys are given out in the order that they were uploaded via
[/keys/upload](/client-server-api/#post_matrixclientv3keysupload). (All
keys uploaded within a given call to `/keys/upload` are considered
equivalent in this regard; no ordering is specified within them.)
operationId: claimKeys
security:
- accessTokenQuery: []

12
data/api/server-server/user_keys.yaml
View file

@ -20,7 +20,17 @@ paths:
/user/keys/claim:
post:
summary: Claims one-time encryption keys for a user.
description: Claims one-time keys for use in pre-key messages.
description: |-
Claims one-time keys for use in pre-key messages.
The request contains the user ID, device ID and algorithm name of the
keys that are required. The response contains a key matching this -
either a one-time key, or if none are available, a fallback key.
One-time keys are given out in the order that they were uploaded via
[/keys/upload](/client-server-api/#post_matrixclientv3keysupload). (All
keys uploaded within a given call to `/keys/upload` are considered
equivalent in this regard; no ordering is specified within them.)
operationId: claimUserEncryptionKeys
security:
- signedRequest: []