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

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

Browse source 
Signed-off-by: Andy Balaam <andy.balaam@matrix.org>
This commit is contained in:
Andy Balaam 2024-12-12 15:53:21 +00:00 • committed by GitHub
parent 2fd5bf10bb
commit 35c3ddb33b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 33 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -288,7 +288,22 @@ 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. If a key matching these requirements can be
found, the response contains it. The returned key is a one-time key
if one is available, and otherwise 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.)
Servers must ensure that each one-time key is returned at most once,
so when a key has been returned, no other request will ever return
the same key.
operationId: claimKeys
security:
- accessTokenQuery: []

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

@ -20,7 +20,22 @@ 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. If a key matching these requirements can be
found, the response contains it. The returned key is a one-time key
if one is available, and otherwise 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.)
Servers must ensure that each one-time key is returned at most once,
so when a key has been returned, no other request will ever return
the same key.
operationId: claimUserEncryptionKeys
security:
- signedRequest: []