cd/reposerver/server.go

package reposerver

import (
	"crypto/tls"
	"crypto/x509"
	"fmt"
	"os"
	"path/filepath"

	grpc_prometheus "github.com/grpc-ecosystem/go-grpc-middleware/providers/prometheus"
	"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/logging"
	"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/recovery"
	log "github.com/sirupsen/logrus"
	"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials"
	"google.golang.org/grpc/health"
	"google.golang.org/grpc/health/grpc_health_v1"
	"google.golang.org/grpc/keepalive"
	"google.golang.org/grpc/reflection"

	"github.com/hanzoai/cd/common"
	versionpkg "github.com/hanzoai/cd/pkg/apiclient/version"
	"github.com/hanzoai/cd/reposerver/apiclient"
	reposervercache "github.com/hanzoai/cd/reposerver/cache"
	"github.com/hanzoai/cd/reposerver/metrics"
	"github.com/hanzoai/cd/reposerver/repository"
	"github.com/hanzoai/cd/server/version"
	"github.com/hanzoai/cd/util/env"
	"github.com/hanzoai/cd/util/git"
	grpc_util "github.com/hanzoai/cd/util/grpc"
	tlsutil "github.com/hanzoai/cd/util/tls"
)

// Server is the repo server implementation
type Server struct {
	repoService *repository.Service
	opts        []grpc.ServerOption
	tlsConfig   *tls.Config
	// healthCheckClientCert is an ephemeral cert generated at startup for the liveness probe self-connection.
	// It is nil when mTLS is not enabled.
	healthCheckClientCert *tls.Certificate
}

// The hostnames to generate self-signed certificates with
var tlsHostList = []string{"localhost", "reposerver"}

// NewServer returns a new instance of the Hanzo CD Repo server
func NewServer(metricsServer *metrics.MetricsServer, cache *reposervercache.Cache, tlsConfCustomizer tlsutil.ConfigCustomizer, initConstants repository.RepoServerInitConstants, gitCredsStore git.CredsStore, clientCAPath string, disableTLS bool) (*Server, error) {
	var tlsConfig *tls.Config
	var healthCheckClientCert *tls.Certificate

	if !disableTLS {
		var err error
		certPath := env.StringFromEnv(common.EnvAppConfigPath, common.DefaultAppConfigPath) + "/reposerver/tls/tls.crt"
		keyPath := env.StringFromEnv(common.EnvAppConfigPath, common.DefaultAppConfigPath) + "/reposerver/tls/tls.key"
		tlsConfig, err = tlsutil.CreateServerTLSConfig(certPath, keyPath, tlsHostList, clientCAPath)
		if err != nil {
			return nil, fmt.Errorf("error creating server TLS config: %w", err)
		}
		if tlsConfCustomizer != nil {
			tlsConfCustomizer(tlsConfig)
		}

		// When mTLS is active the server will reject any connection that does not present a valid client cert.
		// The liveness probe connects to localhost, so we generate a dedicated ephemeral cert and register it with the
		// server's ClientCAs pool.
		if clientCAPath != "" && tlsConfig.ClientCAs != nil {
			hcCert, err := tlsutil.GenerateHealthCheckClientCert()
			if err != nil {
				return nil, fmt.Errorf("error generating health-check client certificate: %w", err)
			}
			parsedCert, err := x509.ParseCertificate(hcCert.Certificate[0])
			if err != nil {
				return nil, fmt.Errorf("error parsing health-check certificate: %w", err)
			}
			tlsConfig.ClientCAs.AddCert(parsedCert)
			healthCheckClientCert = hcCert
			log.Infof("Generated ephemeral health-check client certificate (CN=%s)", parsedCert.Subject.CommonName)
		}
	}
	// Always ensure ClientAuth is set if we have a CA pool, as we might have customized the config.
	if tlsConfig != nil && tlsConfig.ClientCAs != nil {
		tlsConfig.ClientAuth = tls.RequireAndVerifyClientCert
	}

	var serverMetricsOptions []grpc_prometheus.ServerMetricsOption
	if os.Getenv(common.EnvEnableGRPCTimeHistogramEnv) == "true" {
		serverMetricsOptions = append(serverMetricsOptions, grpc_prometheus.WithServerHandlingTimeHistogram())
	}
	serverMetrics := grpc_prometheus.NewServerMetrics(serverMetricsOptions...)
	metricsServer.PrometheusRegistry.MustRegister(serverMetrics)

	serverLog := log.NewEntry(log.StandardLogger())
	streamInterceptors := []grpc.StreamServerInterceptor{
		logging.StreamServerInterceptor(grpc_util.InterceptorLogger(serverLog)),
		serverMetrics.StreamServerInterceptor(),
		recovery.StreamServerInterceptor(recovery.WithRecoveryHandler(grpc_util.LoggerRecoveryHandler(serverLog))),
	}
	unaryInterceptors := []grpc.UnaryServerInterceptor{
		logging.UnaryServerInterceptor(grpc_util.InterceptorLogger(serverLog)),
		serverMetrics.UnaryServerInterceptor(),
		recovery.UnaryServerInterceptor(recovery.WithRecoveryHandler(grpc_util.LoggerRecoveryHandler(serverLog))),
		grpc_util.ErrorSanitizerUnaryServerInterceptor(),
	}

	serverOpts := []grpc.ServerOption{
		grpc.ChainUnaryInterceptor(unaryInterceptors...),
		grpc.ChainStreamInterceptor(streamInterceptors...),
		grpc.MaxRecvMsgSize(apiclient.MaxGRPCMessageSize),
		grpc.MaxSendMsgSize(apiclient.MaxGRPCMessageSize),
		grpc.KeepaliveEnforcementPolicy(
			keepalive.EnforcementPolicy{
				MinTime: common.GetGRPCKeepAliveEnforcementMinimum(),
			},
		),
		grpc.StatsHandler(otelgrpc.NewServerHandler()),
	}

	// We do allow for non-TLS servers to be created, in case of mTLS will be
	// implemented by e.g. a sidecar container.
	if tlsConfig != nil {
		serverOpts = append(serverOpts, grpc.Creds(credentials.NewTLS(tlsConfig)))
	}
	repoService := repository.NewService(metricsServer, cache, initConstants, gitCredsStore, filepath.Join(os.TempDir(), "_cd-repo"))
	if err := repoService.Init(); err != nil {
		return nil, fmt.Errorf("failed to initialize the repo service: %w", err)
	}

	return &Server{
		opts:                  serverOpts,
		repoService:           repoService,
		tlsConfig:             tlsConfig,
		healthCheckClientCert: healthCheckClientCert,
	}, nil
}

// CreateGRPC creates new configured grpc server
func (a *Server) CreateGRPC() *grpc.Server {
	server := grpc.NewServer(a.opts...)
	versionpkg.RegisterVersionServiceServer(server, version.NewServer(nil, func() (bool, error) {
		return true, nil
	}))
	apiclient.RegisterRepoServerServiceServer(server, a.repoService)

	healthService := health.NewServer()
	grpc_health_v1.RegisterHealthServer(server, healthService)

	// Register reflection service on gRPC server.
	reflection.Register(server)

	return server
}

// GetTLSConfig returns the TLS configuration of the server
func (a *Server) GetTLSConfig() *tls.Config {
	return a.tlsConfig
}

// GetHealthCheckClientCert returns the ephemeral client certificate used by the liveness probe self-connection
func (a *Server) GetHealthCheckClientCert() *tls.Certificate {
	return a.healthCheckClientCert
}