mirror of
https://github.com/zitadel/zitadel.git
synced 2025-07-11 21:08:30 +00:00
9ebf2316c6
# Which Problems Are Solved The current maintained gRPC server in combination with a REST (grpc) gateway is getting harder and harder to maintain. Additionally, there have been and still are issues with supporting / displaying `oneOf`s correctly. We therefore decided to exchange the server implementation to connectRPC, which apart from supporting connect as protocol, also also "standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g. curl directly call the server without any additional gateway. # How the Problems Are Solved - All v2 services are moved to connectRPC implementation. (v1 services are still served as pure grpc servers) - All gRPC server interceptors were migrated / copied to a corresponding connectRPC interceptor. - API.ListGrpcServices and API. ListGrpcMethods were changed to include the connect services and endpoints. - gRPC server reflection was changed to a `StaticReflector` using the `ListGrpcServices` list. - The `grpc.Server` interfaces was split into different combinations to be able to handle the different cases (grpc server and prefixed gateway, connect server with grpc gateway, connect server only, ...) - Docs of services serving connectRPC only with no additional gateway (instance, webkey, project, app, org v2 beta) are changed to expose that - since the plugin is not yet available on buf, we download it using `postinstall` hook of the docs # Additional Changes - WebKey service is added as v2 service (in addition to the current v2beta) # Additional Context closes #9483 --------- Co-authored-by: Elio Bischof <elio@zitadel.com>
91 lines
2.9 KiB
Go
91 lines
2.9 KiB
Go
package server
|
|
|
|
import (
|
|
"crypto/tls"
|
|
"net/http"
|
|
|
|
"connectrpc.com/connect"
|
|
grpc_middleware "github.com/grpc-ecosystem/go-grpc-middleware"
|
|
"google.golang.org/grpc"
|
|
"google.golang.org/grpc/credentials"
|
|
healthpb "google.golang.org/grpc/health/grpc_health_v1"
|
|
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
|
|
|
|
"github.com/zitadel/zitadel/internal/api/authz"
|
|
grpc_api "github.com/zitadel/zitadel/internal/api/grpc"
|
|
"github.com/zitadel/zitadel/internal/api/grpc/server/middleware"
|
|
"github.com/zitadel/zitadel/internal/logstore"
|
|
"github.com/zitadel/zitadel/internal/logstore/record"
|
|
"github.com/zitadel/zitadel/internal/query"
|
|
"github.com/zitadel/zitadel/internal/telemetry/metrics"
|
|
system_pb "github.com/zitadel/zitadel/pkg/grpc/system"
|
|
)
|
|
|
|
type Server interface {
|
|
AppName() string
|
|
MethodPrefix() string
|
|
AuthMethods() authz.MethodMapping
|
|
}
|
|
|
|
type GrpcServer interface {
|
|
Server
|
|
RegisterServer(*grpc.Server)
|
|
}
|
|
|
|
type WithGateway interface {
|
|
Server
|
|
RegisterGateway() RegisterGatewayFunc
|
|
}
|
|
|
|
// WithGatewayPrefix extends the server interface with a prefix for the grpc gateway
|
|
//
|
|
// it's used for the System, Admin, Mgmt and Auth API
|
|
type WithGatewayPrefix interface {
|
|
GrpcServer
|
|
WithGateway
|
|
GatewayPathPrefix() string
|
|
}
|
|
|
|
type ConnectServer interface {
|
|
Server
|
|
RegisterConnectServer(interceptors ...connect.Interceptor) (string, http.Handler)
|
|
FileDescriptor() protoreflect.FileDescriptor
|
|
}
|
|
|
|
func CreateServer(
|
|
verifier authz.APITokenVerifier,
|
|
systemAuthz authz.Config,
|
|
authConfig authz.Config,
|
|
queries *query.Queries,
|
|
externalDomain string,
|
|
tlsConfig *tls.Config,
|
|
accessSvc *logstore.Service[*record.AccessLog],
|
|
) *grpc.Server {
|
|
metricTypes := []metrics.MetricType{metrics.MetricTypeTotalCount, metrics.MetricTypeRequestCount, metrics.MetricTypeStatusCode}
|
|
serverOptions := []grpc.ServerOption{
|
|
grpc.UnaryInterceptor(
|
|
grpc_middleware.ChainUnaryServer(
|
|
middleware.CallDurationHandler(),
|
|
middleware.MetricsHandler(metricTypes, grpc_api.Probes...),
|
|
middleware.NoCacheInterceptor(),
|
|
middleware.InstanceInterceptor(queries, externalDomain, system_pb.SystemService_ServiceDesc.ServiceName, healthpb.Health_ServiceDesc.ServiceName),
|
|
middleware.AccessStorageInterceptor(accessSvc),
|
|
middleware.ErrorHandler(),
|
|
middleware.LimitsInterceptor(system_pb.SystemService_ServiceDesc.ServiceName),
|
|
middleware.AuthorizationInterceptor(verifier, systemAuthz, authConfig),
|
|
middleware.TranslationHandler(),
|
|
middleware.QuotaExhaustedInterceptor(accessSvc, system_pb.SystemService_ServiceDesc.ServiceName),
|
|
middleware.ExecutionHandler(queries),
|
|
middleware.ValidationHandler(),
|
|
middleware.ServiceHandler(),
|
|
middleware.ActivityInterceptor(),
|
|
),
|
|
),
|
|
grpc.StatsHandler(middleware.DefaultTracingServer()),
|
|
}
|
|
if tlsConfig != nil {
|
|
serverOptions = append(serverOptions, grpc.Creds(credentials.NewTLS(tlsConfig)))
|
|
}
|
|
return grpc.NewServer(serverOptions...)
|
|
}
|