1f349/dendrite
4
0
Fork 0
mirror of https://github.com/1f349/dendrite.git synced 2024-12-23 00:34:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
eb0efa4636
dendrite/keyserver
History
Neil Alexander eb0efa4636
Cross-signing groundwork (#1953) 
* Cross-signing groundwork

* Update to matrix-org/gomatrixserverlib#274

* Fix gobind builds, which stops unit tests in CI from yelling

* Some changes from review comments

* Fix build by passing in UIA

* Update to matrix-org/gomatrixserverlib@bec8d22

* Process master/self-signing keys from devices call

* nolint

* Enum-ify the key type in the database

* Process self-signing key too

* Fix sanity check in device list updater

* Fix check

* Fix sytest, hopefully

* Fix build
2021-08-04 17:56:29 +01:00
..
api Cross-signing groundwork (#1953) 2021-08-04 17:56:29 +01:00
consumers Cross-signing groundwork (#1953) 2021-08-04 17:56:29 +01:00
internal Cross-signing groundwork (#1953) 2021-08-04 17:56:29 +01:00
inthttp Cross-signing groundwork (#1953) 2021-08-04 17:56:29 +01:00
producers Summarise key change logs (#1278) 2020-08-18 11:14:37 +01:00
storage Cross-signing storage code (#1959) 2021-08-04 17:31:18 +01:00
types Cross-signing storage code (#1959) 2021-08-04 17:31:18 +01:00
keyserver.go Cross-signing groundwork (#1953) 2021-08-04 17:56:29 +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.