MirrorHub/dendrite
0
0
Fork 0
mirror of https://github.com/matrix-org/dendrite synced 2024-06-01 03:59:03 +02:00
Code Issues Releases Wiki Activity
dendrite/keyserver
History
Till 7e8c605f98
Avoid unneeded JSON operations (#2698) 
We were `json.Unmarshal`ing the EDU and `json.Marshal`ing right before
sending the EDU to the stream. Those are now removed and the consumer
does `json.Unmarshal` once.
2022-09-07 12:16:04 +02:00
..
api Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
consumers Avoid unneeded JSON operations (#2698) 2022-09-07 12:16:04 +02:00
internal Re-add waitTime if we're not blacklisted and no RetryAfter was 2022-09-07 12:13:02 +02:00
inthttp Generic-based internal HTTP API (#2626) 2022-08-11 15:29:33 +01:00
producers Remove eduserver (#2306) 2022-03-29 14:14:35 +02:00
storage Fix issues with migrations not getting executed (#2628) 2022-08-08 10:18:57 +02:00
types Remove sarama/saramajetstream dependencies (#2138) 2022-02-04 13:08:13 +00:00
keyserver.go Add a SigningKeyUpdate producer (#2697) 2022-09-07 11:45:12 +02: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.