keyserver

README

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.

Documentation

Index

• func AddInternalRoutes(router *mux.Router, intAPI api.KeyInternalAPI)
• func NewInternalAPI(base *base.BaseDendrite, cfg *config.KeyServer, ...) api.KeyInternalAPI

Functions

func AddInternalRoutes

func AddInternalRoutes(router *mux.Router, intAPI api.KeyInternalAPI)

AddInternalRoutes registers HTTP handlers for the internal API. Invokes functions on the given input API.

func NewInternalAPI

func NewInternalAPI(
	base *base.BaseDendrite, cfg *config.KeyServer, fedClient fedsenderapi.FederationClient,
) api.KeyInternalAPI

NewInternalAPI returns a concerete implementation of the internal API. Callers can call functions directly on the returned API or via an HTTP interface using AddInternalRoutes.