hoernschen/dendrite
1
0
Fork 0
mirror of https://github.com/hoernschen/dendrite.git synced 2024-12-27 07:28:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
dendrite/keyserver
History
Neil Alexander f5756f1c59
Test sig upload
2021-07-30 12:22:33 +01:00
..
api Some groundwork 2021-07-29 18:22:27 +01:00
consumers More wiring/boilerplate 2021-07-28 14:29:02 +01:00
internal Test sig upload 2021-07-30 12:22:33 +01:00
inthttp Some refactoring 2021-07-29 15:47:30 +01:00
producers Summarise key change logs (#1278) 2020-08-18 11:14:37 +01:00
storage Fix queries 2021-07-29 15:30:23 +01:00
keyserver.go More wiring/boilerplate 2021-07-28 14:29:02 +01:00
README.md Add boilerplate for key server APIs (#1196) 2020-07-13 16:02:35 +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.