dendrite

History

Neil Alexander 11a39fe3b5 Deduplicate FS database, EDU persistence table (#1207 ) * Deduplicate FS database, add some EDU persistence groundwork * Extend TransactionWriter to use optional existing transaction, use that for FS SQLite database writes * Fix build due to bad keyserver import * Working EDU persistence * gocyclo, unsurprisingly * Remove unused * Update copyright notices		2020-07-20 16:55:20 +01:00
..
api	Implement /keys/query locally (#1204 )	2020-07-15 18:40:41 +01:00
internal	Implement /keys/query locally (#1204 )	2020-07-15 18:40:41 +01:00
inthttp
storage	Deduplicate FS database, EDU persistence table (#1207 )	2020-07-20 16:55:20 +01:00
keyserver.go	Implement /keys/query locally (#1204 )	2020-07-15 18:40:41 +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.