mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2026-01-17 02:53:11 -06:00
Code Issues Packages Projects Releases Wiki Activity
dendrite/keyserver
History
Brian Meek b90114cda3 Merge upstream Dendrite 0.11 changes, Dendrite and lib tests passing (#1440) 
Signed-off-by: Brian Meek <brian@hntlabs.com>
2023-02-08 16:58:48 -08:00
..
api Jterzis/update dendrite (#656) 2022-10-17 15:59:47 -07:00
consumers Merge upstream Dendrite 0.11 changes, Dendrite and lib tests passing (#1440) 2023-02-08 16:58:48 -08:00
internal Merge upstream Dendrite 0.11 changes, Dendrite and lib tests passing (#1440) 2023-02-08 16:58:48 -08:00
inthttp Merge upstream Dendrite 0.11 changes, Dendrite and lib tests passing (#1440) 2023-02-08 16:58:48 -08:00
producers Remove eduserver (#2306) 2022-03-29 14:14:35 +02:00
storage Merge upstream Dendrite 0.11 changes, Dendrite and lib tests passing (#1440) 2023-02-08 16:58:48 -08:00
types Remove sarama/saramajetstream dependencies (#2138) 2022-02-04 13:08:13 +00:00
keyserver.go Merge upstream Dendrite 0.11 changes, Dendrite and lib tests passing (#1440) 2023-02-08 16:58:48 -08:00
keyserver_test.go Merge upstream Dendrite 0.11 changes, Dendrite and lib tests passing (#1440) 2023-02-08 16:58:48 -08: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.