Files
Warp/server/internal/federationapi/keys.go
T
tajniak81andClaude Opus 5.5 74f7bc8805
CI / Test (ubuntu-latest) (push) Canceled after 0s
CI / Test (windows-latest) (push) Canceled after 0s
CI / Storage tests on PostgreSQL (push) Canceled after 0s
CI / Complement (federation off) (push) Canceled after 0s
CI / golangci-lint (push) Canceled after 0s
CI / Smoke test the binary (push) Canceled after 0s
keyserver: cache remote users' device and cross-signing keys
POST /keys/query for a remote user who shares a room with a local user is
now answered from a cache, fetched whole with GET /user/devices/{userId}
on a miss. Incoming m.device_list_update EDUs are applied when their
prev_id matches the cached stream_id; anything else marks the copy stale
and it is fetched again in the background, and a stale copy is never
served. m.signing_key_update replaces the cached cross-signing keys. A
user's copy is dropped once no local user shares a room with them, by a
keyserver listener on the roomserver's emit stage.

Migration 0009 adds keyserver_remote_users, keyserver_remote_device_keys
and keyserver_remote_cross_signing_keys for sqlite and postgres.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-17 10:36:08 +02:00

111 lines
3.8 KiB
Go

package federationapi
import (
"context"
"encoding/json"
"net/http"
"github.com/dariuszjaniak/warp/server/internal/federation"
"github.com/dariuszjaniak/warp/server/internal/httputil"
"github.com/dariuszjaniak/warp/server/internal/matrix/id"
)
// The end-to-end encryption endpoints other servers call: the keys of this
// server's users, their one-time keys, and their whole device lists.
// KeyService answers other servers' questions about this server's users'
// keys, and takes in their news about their own users'. *keyserver.API
// satisfies it.
type KeyService interface {
QueryLocalKeys(ctx context.Context, req federation.UserKeysQueryRequest) (federation.UserKeysQueryResponse, error)
ClaimLocalKeys(ctx context.Context, want map[string]map[string]string) (map[string]map[string]map[string]json.RawMessage, error)
UserDevices(ctx context.Context, userID string) (federation.UserDevicesResponse, error)
RemoteDeviceListUpdate(ctx context.Context, update federation.DeviceListUpdateContent) error
RemoteSigningKeyUpdate(ctx context.Context, update federation.SigningKeyUpdateContent) error
}
// registerKeyRoutes adds the key endpoints, if there is a keyserver.
func (s *Server) registerKeyRoutes(authed func(string, authedHandler)) {
if s.keyService == nil {
return
}
const v1 = "/_matrix/federation/v1"
authed("POST "+v1+"/user/keys/query", s.handleUserKeysQuery)
authed("POST "+v1+"/user/keys/claim", s.handleUserKeysClaim)
authed("GET "+v1+"/user/devices/{userID}", s.handleUserDevices)
}
func (s *Server) handleUserKeysQuery(w http.ResponseWriter, r *http.Request, _ string, body []byte) error {
var req federation.UserKeysQueryRequest
if err := decode(body, &req); err != nil {
return err
}
resp, err := s.keyService.QueryLocalKeys(r.Context(), req)
if err != nil {
return err
}
httputil.WriteJSON(w, http.StatusOK, resp)
return nil
}
func (s *Server) handleUserKeysClaim(w http.ResponseWriter, r *http.Request, _ string, body []byte) error {
var req federation.UserKeysClaimRequest
if err := decode(body, &req); err != nil {
return err
}
claimed, err := s.keyService.ClaimLocalKeys(r.Context(), req.OneTimeKeys)
if err != nil {
return err
}
httputil.WriteJSON(w, http.StatusOK, federation.UserKeysClaimResponse{OneTimeKeys: claimed})
return nil
}
func (s *Server) handleUserDevices(w http.ResponseWriter, r *http.Request, _ string, _ []byte) error {
userID := r.PathValue("userID")
server, err := id.ServerNameOf(userID)
if err != nil {
return httputil.InvalidParam("%s is not a user ID", userID)
}
if server != s.serverName {
return httputil.NotFound("%s is not a user of this server", userID)
}
resp, err := s.keyService.UserDevices(r.Context(), userID)
if err != nil {
return err
}
httputil.WriteJSON(w, http.StatusOK, resp)
return nil
}
// receiveKeyEDU takes in an m.device_list_update or m.signing_key_update:
// a user of the sending server changed their keys. The keyserver brings
// its cached copy of them up to date and tells the local clients that
// care. An update about a user of another server is dropped — a server
// speaks for its own users only.
func (s *Server) receiveKeyEDU(ctx context.Context, origin string, edu federation.EDU) {
if s.keyService == nil {
return
}
var err error
switch edu.Type {
case federation.EDUDeviceListUp:
var c federation.DeviceListUpdateContent
if json.Unmarshal(edu.Content, &c) != nil || !sameServer(c.UserID, origin) {
return
}
err = s.keyService.RemoteDeviceListUpdate(ctx, c)
case federation.EDUSigningKeys:
var c federation.SigningKeyUpdateContent
if json.Unmarshal(edu.Content, &c) != nil || !sameServer(c.UserID, origin) {
return
}
err = s.keyService.RemoteSigningKeyUpdate(ctx, c)
default:
return
}
if err != nil {
s.log.Debug("ignored a key update EDU", "origin", origin, "type", edu.Type, "error", err)
}
}