1f349/dendrite
4
0
Fork 0
mirror of https://github.com/1f349/dendrite.git synced 2025-02-02 04:36:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
aaf4e5c865
dendrite/keyserver
History
Till e245a26f6b
Enable/Disable internal metrics (#2899) 
Basically enables us to use `test.WithAllDatabases` when testing
internal HTTP APIs, as this would otherwise result in Prometheus
complaining about already registered metric names.
2022-12-05 13:53:36 +01:00
..
api Add /_dendrite/admin/refreshDevices/{userID} (#2746) 2022-09-30 09:32:31 +01:00
consumers Federation fixes for virtual hosting 2022-11-15 15:05:23 +00:00
internal Federation fixes for virtual hosting 2022-11-15 15:05:23 +00:00
inthttp Enable/Disable internal metrics (#2899) 2022-12-05 13:53:36 +01:00
producers Remove eduserver (#2306) 2022-03-29 14:14:35 +02:00
storage Add custom build flag to satisfy Sytest 2022-11-07 15:07:47 +01:00
types Remove sarama/saramajetstream dependencies (#2138) 2022-02-04 13:08:13 +00:00
keyserver.go Enable/Disable internal metrics (#2899) 2022-12-05 13:53:36 +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.