MirrorHub/dendrite
0
0
Fork 0
mirror of https://github.com/matrix-org/dendrite synced 2024-11-16 06:41:06 +01:00
Code Issues Releases Wiki Activity
dendrite/keyserver
History
Kegsay 20c8f252a7
Make 'Device list doesn't change if remote server is down' pass (#1268) 
- As a last resort, query the DB when exhausting all possible remote query
  endpoints, but keep the field in `failures` so clients can detect that this
  is stale data.
- Unblock `DeviceListUpdater.Update` on failures rather than timing out.
- Use a mutex when writing directly to `res`, not just for failures.
2020-08-13 16:43:27 +01:00
..
api Fix more E2E sytests (#1265) 2020-08-12 22:43:02 +01:00
internal Make 'Device list doesn't change if remote server is down' pass (#1268) 2020-08-13 16:43:27 +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 Fix more E2E sytests (#1265) 2020-08-12 22:43:02 +01:00
keyserver.go Prefix-defined Kafka topics (#1254) 2020-08-10 15:18:37 +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.