Skip to main content

Module user_keys

Module user_keys 

Source
Expand description

Implements APIs for client key upload from the matrix spec

Structsยง

SignatureError
Thrown when signature verification fails.
UserKeysComponent
Component implementing endpoints for user keys

Enumsยง

ShouldBeFallback ๐Ÿ”’
Parameter used to tell check_onetime_key() what to check.
UserKeysError ๐Ÿ”’

Functionsยง

check_device_key ๐Ÿ”’
Given the user and device IDs of the authenticated request made, performs various checks on a [DeviceKeys].
check_onetime_key ๐Ÿ”’
Performs various checks on a [OneTimeKey].
claim_keys_handler ๐Ÿ”’
Handler for POST /_matrix/client/v3/keys/claim (See https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3keysclaim).
get_keys_handler ๐Ÿ”’
Handler for POST /_matrix/client/v3/keys/query (See https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3keysquery).
handle_new_device_key ๐Ÿ”’
Handles a new device-keys upload by:
upload_keys_handler ๐Ÿ”’
Handler for POST /_matrix/client/v3/keys/upload (See https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3keysupload).