char
/
dendrite
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
dendrite/keyserver
History
Kegan Dougal 366fd975c8 Fix unit tests 2020-08-07 17:58:44 +01:00
..
api Process inbound device list updates from federation (#1240) 2020-08-05 13:41:16 +01:00
internal Fix unit tests 2020-08-07 17:58:44 +01:00
inthttp Process inbound device list updates from federation (#1240) 2020-08-05 13:41:16 +01:00
producers Generate stream IDs for locally uploaded device keys (#1236) 2020-08-03 17:07:06 +01:00
storage Finish inbound E2E device lists (#1243) 2020-08-07 17:32:13 +01:00
README.md Add boilerplate for key server APIs (#1196) 2020-07-13 16:02:35 +01:00
keyserver.go Add device list updater which manages updating remote device lists (#1242) 2020-08-06 17:48:10 +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.