1f349/dendrite
4
0
Fork 0
mirror of https://github.com/1f349/dendrite.git synced 2024-11-09 22:42:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
1b3fa9689c
dendrite/keyserver
History
Neil Alexander 09d754cfbf
One NATS instance per BaseDendrite (#2438) 
* One NATS instance per `BaseDendrite`

* Fix roomserver
2022-05-09 14:15:24 +01:00
..
api Clean up interface definitions (#2427) 2022-05-06 12:39:26 +01:00
internal Clean up interface definitions (#2427) 2022-05-06 12:39:26 +01:00
inthttp Clean up interface definitions (#2427) 2022-05-06 12:39:26 +01:00
producers Remove eduserver (#2306) 2022-03-29 14:14:35 +02:00
storage Add (user_id, device_id) index on OTK table (#2435) 2022-05-09 11:13:04 +01:00
types Remove sarama/saramajetstream dependencies (#2138) 2022-02-04 13:08:13 +00:00
keyserver.go One NATS instance per BaseDendrite (#2438) 2022-05-09 14:15:24 +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.