MirrorHub
/
dendrite
mirror of https://github.com/matrix-org/dendrite
0
0
Fork 0
Code Issues Releases Wiki Activity
dendrite/keyserver
History
Neil Alexander fec3ee384b
Stop CPU burn in `PerformMarkAsStaleIfNeeded` 		2022-10-03 12:59:56 +01:00
..
api Add `/_dendrite/admin/refreshDevices/{userID}` (#2746) 2022-09-30 09:32:31 +01:00
consumers Avoid unneeded JSON operations (#2698) 2022-09-07 12:16:04 +02:00
internal Stop CPU burn in `PerformMarkAsStaleIfNeeded` 2022-10-03 12:59:56 +01:00
inthttp Mark device list as stale, if we don't have the requesting device (#2728) 2022-09-20 11:32:03 +02:00
producers Remove eduserver (#2306) 2022-03-29 14:14:35 +02:00
storage Check unique constraint errors when manually inserting migrations (#2712) 2022-09-13 08:07:43 +02:00
types Remove sarama/saramajetstream dependencies (#2138) 2022-02-04 13:08:13 +00:00
README.md Add boilerplate for key server APIs (#1196) 2020-07-13 16:02:35 +01:00
keyserver.go Allow more time for device list updates (#2749) 2022-09-30 09:41:16 +01:00

README.md

Key Server

This is an internal component which manages E2E keys from clients. It handles all the Key Management APIs with the exception of /keys/changes which is handled by Sync API. This component is designed to shard by user ID.

Keys are uploaded and stored in this component, and key changes are emitted to a Kafka topic for downstream components such as Sync API.

Internal APIs

  • PerformUploadKeys stores identity keys and one-time public keys for given user(s).
  • PerformClaimKeys acquires one-time public keys for given user(s). This may involve outbound federation calls.
  • QueryKeys returns identity keys for given user(s). This may involve outbound federation calls. This component may then cache federated identity keys to avoid repeatedly hitting remote servers.
  • A topic which emits identity keys every time there is a change (addition or deletion).

### Endpoint mappings

  • Client API maps /keys/upload to PerformUploadKeys.
  • Client API maps /keys/query to QueryKeys.
  • Client API maps /keys/claim to PerformClaimKeys.
  • Federation API maps /user/keys/query to QueryKeys.
  • Federation API maps /user/keys/claim to PerformClaimKeys.
  • Sync API maps /keys/changes to consuming from the Kafka topic.