char
/
dendrite
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
dendrite/keyserver
History
Kegsay adf7b59294
Persist partition|offset|user_id in the keyserver (#1226) 
* Persist partition|offset|user_id in the keyserver

Required for a query API which will be used by the syncapi which
will be called when a `/sync` request comes in which will return
a list of user IDs of people who have changed their device keys
between two tokens.

* Add tests and fix maxOffset bug

* s/offset/log_offset/g because 'offset' is a reserved word in postgres
 		2020-07-28 17:38:30 +01:00
..
api
…
internal
…
inthttp
…
producers Persist partition|offset|user_id in the keyserver (#1226) 2020-07-28 17:38:30 +01:00
storage Persist partition|offset|user_id in the keyserver (#1226) 2020-07-28 17:38:30 +01:00
README.md
…
keyserver.go Persist partition|offset|user_id in the keyserver (#1226) 2020-07-28 17:38:30 +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.