jimzah/dendrite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
1bee1ae204
dendrite/keyserver
History
Neil Alexander ff21675c5b
Cross-signing fixes, notifications via sync, federation (#1974) 
* Initial work on signing key update EDUs

* Fix build

* Produce/consume EDUs

* Producer logging

* Only produce key change notifications for local users

* Better naming

* Try to notify sync

* Enable feature

* Use key change topic

* Don't bother verifying signatures, validate key lengths if we can, notifier fixes

* Copyright notices

* Remove tests from whitelist until matrix-org/sytest#1117

* Some review comment fixes

* Update to matrix-org/gomatrixserverlib@f9416ac

* Remove unneeded parameter
2021-08-17 13:44:30 +01:00
..
api Cross-signing fixes, notifications via sync, federation (#1974) 2021-08-17 13:44:30 +01:00
consumers Cross-signing fixes, notifications via sync, federation (#1974) 2021-08-17 13:44:30 +01:00
internal Cross-signing fixes, notifications via sync, federation (#1974) 2021-08-17 13:44:30 +01:00
inthttp Cross-signing signature handling (#1965) 2021-08-09 14:35:24 +01:00
producers Cross-signing fixes, notifications via sync, federation (#1974) 2021-08-17 13:44:30 +01:00
storage Add type field to DeviceMessage, allow fields to be nullable (#1969) 2021-08-11 09:44:14 +01:00
types Cross-signing storage code (#1959) 2021-08-04 17:31:18 +01:00
keyserver.go Cross-signing fixes, notifications via sync, federation (#1974) 2021-08-17 13:44:30 +01:00
README.md

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.