mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-29 01:33:10 -06:00
Code Issues Packages Projects Releases Wiki Activity
dendrite/keyserver
History
alexfca acf63daf79
Add CT and UT to all documents and refactor (#17) 
* - Create CosmosDocument as a base class
- Add CT and UT
- Refactor all tables to use the CosmosDocument

* - Add UpsertDocument method to perform updates in a generic way
- Add SetUpdateTime() to update the UT for updates
- Refactor it all

Co-authored-by: alexf@example.com <alexf@example.com>
2021-09-20 17:41:04 +10:00
..
api Delete device keys/signatures from key server when deleting devices (#1979) 2021-08-18 12:07:09 +01:00
consumers Cross-signing fixes, notifications via sync, federation (#1974) 2021-08-17 13:44:30 +01:00
internal Delete device keys/signatures from key server when deleting devices (#1979) 2021-08-18 12:07:09 +01:00
inthttp Delete device keys/signatures from key server when deleting devices (#1979) 2021-08-18 12:07:09 +01:00
producers Cross-signing fixes, notifications via sync, federation (#1974) 2021-08-17 13:44:30 +01:00
storage Add CT and UT to all documents and refactor (#17) 2021-09-20 17:41:04 +10: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 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.