Convert serverkeys to inthttp (#1097)

cmd/dendrite-client-api-server/main.go

@@ -32,7 +32,7 @@ func main() {
 	deviceDB := base.CreateDeviceDB()
 	federation := base.CreateFederationClient()
 
-	serverKeyAPI := base.CreateHTTPServerKeyAPIs()
+	serverKeyAPI := base.ServerKeyAPIClient()
 	keyRing := serverKeyAPI.KeyRing()
 
 	asQuery := base.AppserviceHTTPClient()

cmd/dendrite-federation-api-server/main.go

@@ -31,7 +31,7 @@ func main() {
 	deviceDB := base.CreateDeviceDB()
 	federation := base.CreateFederationClient()
 
-	serverKeyAPI := base.CreateHTTPServerKeyAPIs()
+	serverKeyAPI := base.ServerKeyAPIClient()
 	keyRing := serverKeyAPI.KeyRing()
 
 	fsAPI := base.FederationSenderHTTPClient()

cmd/dendrite-federation-sender-server/main.go

@@ -26,7 +26,7 @@ func main() {
 
 	federation := base.CreateFederationClient()
 
-	serverKeyAPI := base.CreateHTTPServerKeyAPIs()
+	serverKeyAPI := base.ServerKeyAPIClient()
 	keyRing := serverKeyAPI.KeyRing()
 
 	rsAPI := base.RoomserverHTTPClient()

cmd/dendrite-monolith-server/main.go

@@ -74,7 +74,7 @@ func main() {
 		base, federation,
 	)
 	if base.UseHTTPAPIs {
-		serverKeyAPI = base.CreateHTTPServerKeyAPIs()
+		serverKeyAPI = base.ServerKeyAPIClient()
 	}
 	keyRing := serverKeyAPI.KeyRing()
 

cmd/dendrite-room-server/main.go

@@ -25,7 +25,7 @@ func main() {
 	defer base.Close() // nolint: errcheck
 	federation := base.CreateFederationClient()
 
-	serverKeyAPI := base.CreateHTTPServerKeyAPIs()
+	serverKeyAPI := base.ServerKeyAPIClient()
 	keyRing := serverKeyAPI.KeyRing()
 
 	fsAPI := base.FederationSenderHTTPClient()

internal/basecomponent/base.go

@@ -45,6 +45,7 @@ import (
 	roomserverAPI "github.com/matrix-org/dendrite/roomserver/api"
 	rsinthttp "github.com/matrix-org/dendrite/roomserver/inthttp"
 	serverKeyAPI "github.com/matrix-org/dendrite/serverkeyapi/api"
+	skinthttp "github.com/matrix-org/dendrite/serverkeyapi/inthttp"
 	"github.com/sirupsen/logrus"
 
 	_ "net/http/pprof"
@@ -176,10 +177,9 @@ func (b *BaseDendrite) FederationSenderHTTPClient() federationSenderAPI.Federati
 	return f
 }
 
-// CreateHTTPServerKeyAPIs returns ServerKeyInternalAPI for hitting the server key
+// ServerKeyAPIClient returns ServerKeyInternalAPI for hitting the server key API over HTTP
-// API over HTTP
+func (b *BaseDendrite) ServerKeyAPIClient() serverKeyAPI.ServerKeyInternalAPI {
-func (b *BaseDendrite) CreateHTTPServerKeyAPIs() serverKeyAPI.ServerKeyInternalAPI {
+	f, err := skinthttp.NewServerKeyClient(
-	f, err := serverKeyAPI.NewServerKeyInternalAPIHTTP(
 		b.Cfg.ServerKeyAPIURL(),
 		b.httpClient,
 		b.ImmutableCache,

serverkeyapi/api/api.go

@@ -2,11 +2,7 @@ package api
 
 import (
 	"context"
-	"errors"
-	"net/http"
-	"time"
 
-	"github.com/matrix-org/dendrite/internal/caching"
 	"github.com/matrix-org/gomatrixserverlib"
 )
 
@@ -28,97 +24,17 @@ type ServerKeyInternalAPI interface {
 	) error
 }
 
-// NewRoomserverInputAPIHTTP creates a RoomserverInputAPI implemented by talking to a HTTP POST API.
+type QueryPublicKeysRequest struct {
-// If httpClient is nil an error is returned
+	Requests map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.Timestamp `json:"requests"`
-func NewServerKeyInternalAPIHTTP(
-	serverKeyAPIURL string,
-	httpClient *http.Client,
-	immutableCache caching.ImmutableCache,
-) (ServerKeyInternalAPI, error) {
-	if httpClient == nil {
-		return nil, errors.New("NewRoomserverInternalAPIHTTP: httpClient is <nil>")
-	}
-	return &httpServerKeyInternalAPI{
-		serverKeyAPIURL: serverKeyAPIURL,
-		httpClient:      httpClient,
-		immutableCache:  immutableCache,
-	}, nil
 }
 
-type httpServerKeyInternalAPI struct {
+type QueryPublicKeysResponse struct {
-	ServerKeyInternalAPI
+	Results map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult `json:"results"`
-
-	serverKeyAPIURL string
-	httpClient      *http.Client
-	immutableCache  caching.ImmutableCache
 }
 
-func (s *httpServerKeyInternalAPI) KeyRing() *gomatrixserverlib.KeyRing {
+type InputPublicKeysRequest struct {
-	// This is a bit of a cheat - we tell gomatrixserverlib that this API is
+	Keys map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult `json:"keys"`
-	// both the key database and the key fetcher. While this does have the
-	// rather unfortunate effect of preventing gomatrixserverlib from handling
-	// key fetchers directly, we can at least reimplement this behaviour on
-	// the other end of the API.
-	return &gomatrixserverlib.KeyRing{
-		KeyDatabase: s,
-		KeyFetchers: []gomatrixserverlib.KeyFetcher{s},
-	}
 }
 
-func (s *httpServerKeyInternalAPI) FetcherName() string {
+type InputPublicKeysResponse struct {
-	return "httpServerKeyInternalAPI"
-}
-
-func (s *httpServerKeyInternalAPI) StoreKeys(
-	_ context.Context,
-	results map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult,
-) error {
-	// Run in a background context - we don't want to stop this work just
-	// because the caller gives up waiting.
-	ctx := context.Background()
-	request := InputPublicKeysRequest{
-		Keys: make(map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult),
-	}
-	response := InputPublicKeysResponse{}
-	for req, res := range results {
-		request.Keys[req] = res
-		s.immutableCache.StoreServerKey(req, res)
-	}
-	return s.InputPublicKeys(ctx, &request, &response)
-}
-
-func (s *httpServerKeyInternalAPI) FetchKeys(
-	_ context.Context,
-	requests map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.Timestamp,
-) (map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult, error) {
-	// Run in a background context - we don't want to stop this work just
-	// because the caller gives up waiting.
-	ctx := context.Background()
-	result := make(map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult)
-	request := QueryPublicKeysRequest{
-		Requests: make(map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.Timestamp),
-	}
-	response := QueryPublicKeysResponse{
-		Results: make(map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult),
-	}
-	now := gomatrixserverlib.AsTimestamp(time.Now())
-	for req, ts := range requests {
-		if res, ok := s.immutableCache.GetServerKey(req); ok {
-			if now > res.ValidUntilTS && res.ExpiredTS == gomatrixserverlib.PublicKeyNotExpired {
-				continue
-			}
-			result[req] = res
-			continue
-		}
-		request.Requests[req] = ts
-	}
-	err := s.QueryPublicKeys(ctx, &request, &response)
-	if err != nil {
-		return nil, err
-	}
-	for req, res := range response.Results {
-		result[req] = res
-		s.immutableCache.StoreServerKey(req, res)
-	}
-	return result, nil
 }

serverkeyapi/api/http.go

@@ -1,57 +0,0 @@
-package api
-
-import (
-	"context"
-
-	commonHTTP "github.com/matrix-org/dendrite/internal/http"
-	"github.com/matrix-org/gomatrixserverlib"
-
-	"github.com/opentracing/opentracing-go"
-)
-
-const (
-	// ServerKeyInputPublicKeyPath is the HTTP path for the InputPublicKeys API.
-	ServerKeyInputPublicKeyPath = "/serverkeyapi/inputPublicKey"
-
-	// ServerKeyQueryPublicKeyPath is the HTTP path for the QueryPublicKeys API.
-	ServerKeyQueryPublicKeyPath = "/serverkeyapi/queryPublicKey"
-)
-
-type InputPublicKeysRequest struct {
-	Keys map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult `json:"keys"`
-}
-
-type InputPublicKeysResponse struct {
-}
-
-func (h *httpServerKeyInternalAPI) InputPublicKeys(
-	ctx context.Context,
-	request *InputPublicKeysRequest,
-	response *InputPublicKeysResponse,
-) error {
-	span, ctx := opentracing.StartSpanFromContext(ctx, "InputPublicKey")
-	defer span.Finish()
-
-	apiURL := h.serverKeyAPIURL + ServerKeyInputPublicKeyPath
-	return commonHTTP.PostJSON(ctx, span, h.httpClient, apiURL, request, response)
-}
-
-type QueryPublicKeysRequest struct {
-	Requests map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.Timestamp `json:"requests"`
-}
-
-type QueryPublicKeysResponse struct {
-	Results map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult `json:"results"`
-}
-
-func (h *httpServerKeyInternalAPI) QueryPublicKeys(
-	ctx context.Context,
-	request *QueryPublicKeysRequest,
-	response *QueryPublicKeysResponse,
-) error {
-	span, ctx := opentracing.StartSpanFromContext(ctx, "QueryPublicKey")
-	defer span.Finish()
-
-	apiURL := h.serverKeyAPIURL + ServerKeyQueryPublicKeyPath
-	return commonHTTP.PostJSON(ctx, span, h.httpClient, apiURL, request, response)
-}

serverkeyapi/internal/api.go

@@ -5,7 +5,6 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/matrix-org/dendrite/internal/caching"
 	"github.com/matrix-org/dendrite/serverkeyapi/api"
 	"github.com/matrix-org/gomatrixserverlib"
 )
@@ -13,7 +12,6 @@ import (
 type ServerKeyAPI struct {
 	api.ServerKeyInternalAPI
 
-	ImmutableCache caching.ImmutableCache
 	OurKeyRing gomatrixserverlib.KeyRing
 	FedClient  *gomatrixserverlib.FederationClient
 }

serverkeyapi/inthttp/client.go

@@ -0,0 +1,137 @@
+package inthttp
+
+import (
+	"context"
+	"errors"
+	"net/http"
+	"time"
+
+	"github.com/matrix-org/dendrite/internal/caching"
+	internalHTTP "github.com/matrix-org/dendrite/internal/http"
+	"github.com/matrix-org/dendrite/serverkeyapi/api"
+	"github.com/matrix-org/gomatrixserverlib"
+	"github.com/opentracing/opentracing-go"
+)
+
+// HTTP paths for the internal HTTP APIs
+const (
+	ServerKeyInputPublicKeyPath = "/serverkeyapi/inputPublicKey"
+	ServerKeyQueryPublicKeyPath = "/serverkeyapi/queryPublicKey"
+)
+
+// NewServerKeyClient creates a ServerKeyInternalAPI implemented by talking to a HTTP POST API.
+// If httpClient is nil an error is returned
+func NewServerKeyClient(
+	serverKeyAPIURL string,
+	httpClient *http.Client,
+	immutableCache caching.ImmutableCache,
+) (api.ServerKeyInternalAPI, error) {
+	if httpClient == nil {
+		return nil, errors.New("NewRoomserverInternalAPIHTTP: httpClient is <nil>")
+	}
+	return &httpServerKeyInternalAPI{
+		serverKeyAPIURL: serverKeyAPIURL,
+		httpClient:      httpClient,
+		immutableCache:  immutableCache,
+	}, nil
+}
+
+type httpServerKeyInternalAPI struct {
+	serverKeyAPIURL string
+	httpClient      *http.Client
+	immutableCache  caching.ImmutableCache
+}
+
+func (s *httpServerKeyInternalAPI) KeyRing() *gomatrixserverlib.KeyRing {
+	// This is a bit of a cheat - we tell gomatrixserverlib that this API is
+	// both the key database and the key fetcher. While this does have the
+	// rather unfortunate effect of preventing gomatrixserverlib from handling
+	// key fetchers directly, we can at least reimplement this behaviour on
+	// the other end of the API.
+	return &gomatrixserverlib.KeyRing{
+		KeyDatabase: s,
+		KeyFetchers: []gomatrixserverlib.KeyFetcher{s},
+	}
+}
+
+func (s *httpServerKeyInternalAPI) FetcherName() string {
+	return "httpServerKeyInternalAPI"
+}
+
+func (s *httpServerKeyInternalAPI) StoreKeys(
+	_ context.Context,
+	results map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult,
+) error {
+	// Run in a background context - we don't want to stop this work just
+	// because the caller gives up waiting.
+	ctx := context.Background()
+	request := api.InputPublicKeysRequest{
+		Keys: make(map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult),
+	}
+	response := api.InputPublicKeysResponse{}
+	for req, res := range results {
+		request.Keys[req] = res
+		s.immutableCache.StoreServerKey(req, res)
+	}
+	return s.InputPublicKeys(ctx, &request, &response)
+}
+
+func (s *httpServerKeyInternalAPI) FetchKeys(
+	_ context.Context,
+	requests map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.Timestamp,
+) (map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult, error) {
+	// Run in a background context - we don't want to stop this work just
+	// because the caller gives up waiting.
+	ctx := context.Background()
+	result := make(map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult)
+	request := api.QueryPublicKeysRequest{
+		Requests: make(map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.Timestamp),
+	}
+	response := api.QueryPublicKeysResponse{
+		Results: make(map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult),
+	}
+	now := gomatrixserverlib.AsTimestamp(time.Now())
+	for req, ts := range requests {
+		if res, ok := s.immutableCache.GetServerKey(req); ok {
+			if now > res.ValidUntilTS && res.ExpiredTS == gomatrixserverlib.PublicKeyNotExpired {
+				continue
+			}
+			result[req] = res
+			continue
+		}
+		request.Requests[req] = ts
+	}
+	err := s.QueryPublicKeys(ctx, &request, &response)
+	if err != nil {
+		return nil, err
+	}
+	for req, res := range response.Results {
+		result[req] = res
+		s.immutableCache.StoreServerKey(req, res)
+	}
+	return result, nil
+}
+
+func (h *httpServerKeyInternalAPI) InputPublicKeys(
+	ctx context.Context,
+	request *api.InputPublicKeysRequest,
+	response *api.InputPublicKeysResponse,
+) error {
+	span, ctx := opentracing.StartSpanFromContext(ctx, "InputPublicKey")
+	defer span.Finish()
+
+	apiURL := h.serverKeyAPIURL + ServerKeyInputPublicKeyPath
+	return internalHTTP.PostJSON(ctx, span, h.httpClient, apiURL, request, response)
+}
+
+func (h *httpServerKeyInternalAPI) QueryPublicKeys(
+	ctx context.Context,
+	request *api.QueryPublicKeysRequest,
+	response *api.QueryPublicKeysResponse,
+) error {
+	span, ctx := opentracing.StartSpanFromContext(ctx, "QueryPublicKey")
+	defer span.Finish()
+
+	apiURL := h.serverKeyAPIURL + ServerKeyQueryPublicKeyPath
+	return internalHTTP.PostJSON(ctx, span, h.httpClient, apiURL, request, response)
+}

serverkeyapi/inthttp/server.go

@@ -1,4 +1,4 @@
-package internal
+package inthttp
 
 import (
 	"encoding/json"
@@ -6,13 +6,14 @@ import (
 
 	"github.com/gorilla/mux"
 	"github.com/matrix-org/dendrite/internal"
+	"github.com/matrix-org/dendrite/internal/caching"
 	"github.com/matrix-org/dendrite/serverkeyapi/api"
 	"github.com/matrix-org/gomatrixserverlib"
 	"github.com/matrix-org/util"
 )
 
-func (s *ServerKeyAPI) SetupHTTP(internalAPIMux *mux.Router) {
+func AddRoutes(s api.ServerKeyInternalAPI, internalAPIMux *mux.Router, cache caching.ImmutableCache) {
-	internalAPIMux.Handle(api.ServerKeyQueryPublicKeyPath,
+	internalAPIMux.Handle(ServerKeyQueryPublicKeyPath,
 		internal.MakeInternalAPI("queryPublicKeys", func(req *http.Request) util.JSONResponse {
 			request := api.QueryPublicKeysRequest{}
 			response := api.QueryPublicKeysResponse{}
@@ -27,7 +28,7 @@ func (s *ServerKeyAPI) SetupHTTP(internalAPIMux *mux.Router) {
 			return util.JSONResponse{Code: http.StatusOK, JSON: &response}
 		}),
 	)
-	internalAPIMux.Handle(api.ServerKeyInputPublicKeyPath,
+	internalAPIMux.Handle(ServerKeyInputPublicKeyPath,
 		internal.MakeInternalAPI("inputPublicKeys", func(req *http.Request) util.JSONResponse {
 			request := api.InputPublicKeysRequest{}
 			response := api.InputPublicKeysResponse{}
@@ -37,7 +38,7 @@ func (s *ServerKeyAPI) SetupHTTP(internalAPIMux *mux.Router) {
 			store := make(map[gomatrixserverlib.PublicKeyLookupRequest]gomatrixserverlib.PublicKeyLookupResult)
 			for req, res := range request.Keys {
 				store[req] = res
-				s.ImmutableCache.StoreServerKey(req, res)
+				cache.StoreServerKey(req, res)
 			}
 			if err := s.StoreKeys(req.Context(), store); err != nil {
 				return util.ErrorResponse(err)

serverkeyapi/serverkeyapi.go

@@ -7,6 +7,7 @@ import (
 	"github.com/matrix-org/dendrite/internal/basecomponent"
 	"github.com/matrix-org/dendrite/serverkeyapi/api"
 	"github.com/matrix-org/dendrite/serverkeyapi/internal"
+	"github.com/matrix-org/dendrite/serverkeyapi/inthttp"
 	"github.com/matrix-org/dendrite/serverkeyapi/storage"
 	"github.com/matrix-org/dendrite/serverkeyapi/storage/cache"
 	"github.com/matrix-org/gomatrixserverlib"
@@ -34,7 +35,6 @@ func SetupServerKeyAPIComponent(
 	}
 
 	internalAPI := internal.ServerKeyAPI{
-		ImmutableCache: base.ImmutableCache,
 		FedClient: fedClient,
 		OurKeyRing: gomatrixserverlib.KeyRing{
 			KeyFetchers: []gomatrixserverlib.KeyFetcher{
@@ -77,7 +77,7 @@ func SetupServerKeyAPIComponent(
 		}).Info("Enabled perspective key fetcher")
 	}
 
-	internalAPI.SetupHTTP(base.InternalAPIMux)
+	inthttp.AddRoutes(&internalAPI, base.InternalAPIMux, base.ImmutableCache)
 
 	return &internalAPI
 }