[installer, gitpod-db] Introduce database.ssl.ca

geropl · geropl · commit cf604cd8ee22 · 2022-12-14T11:10:22.000Z
diff --git a/components/gitpod-db/go/conn.go b/components/gitpod-db/go/conn.go
@@ -5,6 +5,8 @@
 package db
 
 import (
+	"crypto/tls"
+	"crypto/x509"
 	"fmt"
 	"time"
 
@@ -17,16 +19,17 @@ import (
 )
 
 type ConnectionParams struct {
-	User     string
-	Password string
-	Host     string
-	Database string
+	User         string
+	Password     string
+	Host         string
+	Database     string
+	CustomCACert string
 }
 
 func Connect(p ConnectionParams) (*gorm.DB, error) {
 	loc, err := time.LoadLocation("UTC")
 	if err != nil {
-		return nil, fmt.Errorf("failed to load UT location: %w", err)
+		return nil, fmt.Errorf("Failed to load UT location: %w", err)
 	}
 	cfg := driver_mysql.Config{
 		User:                 p.User,
@@ -39,6 +42,23 @@ func Connect(p ConnectionParams) (*gorm.DB, error) {
 		ParseTime:            true,
 	}
 
+	if p.CustomCACert != "" {
+		rootCertPool := x509.NewCertPool()
+		if ok := rootCertPool.AppendCertsFromPEM([]byte(p.CustomCACert)); !ok {
+			log.Fatal("Failed to append custom DB CA cert.")
+		}
+
+		tlsConfigName := "custom"
+		err = driver_mysql.RegisterTLSConfig(tlsConfigName, &tls.Config{
+			RootCAs:    rootCertPool,
+			MinVersion: tls.VersionTLS12, // semgrep finding: set lower boundary to exclude insecure TLS1.0
+		})
+		if err != nil {
+			return nil, fmt.Errorf("Failed to register custom DB CA cert: %w", err)
+		}
+		cfg.TLSConfig = tlsConfigName
+	}
+
 	// refer to https://github.com/go-sql-driver/mysql#dsn-data-source-name for details
 	return gorm.Open(mysql.Open(cfg.FormatDSN()), &gorm.Config{
 		Logger: logger.New(log.Log, logger.Config{
diff --git a/components/gitpod-db/src/config.ts b/components/gitpod-db/src/config.ts
@@ -13,28 +13,40 @@ import { ConnectionConfig } from "mysql";
 export class Config {
     get dbConfig(): DatabaseConfig {
         // defaults to be used only in tests
-        const dbSetup = {
+        const dbSetup: DatabaseConfig = {
             host: process.env.DB_HOST || "localhost",
             port: getEnvVarParsed("DB_PORT", Number.parseInt, "3306"),
             username: process.env.DB_USERNAME || "gitpod",
             password: process.env.DB_PASSWORD || "test",
             database: process.env.DB_NAME || "gitpod",
         };
 
+        if (process.env.DB_CUSTOM_CA_CERT) {
+            dbSetup.ssl = {
+                ca: process.env.DB_CUSTOM_CA_CERT,
+            };
+        }
+
         log.info(`Using DB: ${dbSetup.host}:${dbSetup.port}/${dbSetup.database}`);
 
         return dbSetup;
     }
 
     get mysqlConfig(): ConnectionConfig {
         const dbConfig = this.dbConfig;
-        return {
+        const mysqlConfig: ConnectionConfig = {
             host: dbConfig.host,
             port: dbConfig.port,
             user: dbConfig.username,
             password: dbConfig.password,
             database: dbConfig.database,
         };
+        if (dbConfig.ssl?.ca) {
+            mysqlConfig.ssl = {
+                ca: dbConfig.ssl.ca,
+            };
+        }
+        return mysqlConfig;
     }
 
     get dbEncryptionKeys(): string {
@@ -48,4 +60,7 @@ export interface DatabaseConfig {
     database?: string;
     username?: string;
     password?: string;
+    ssl?: {
+        ca?: string;
+    };
 }
diff --git a/components/gitpod-db/src/wait-for-db.ts b/components/gitpod-db/src/wait-for-db.ts
@@ -13,7 +13,7 @@ import * as mysql from "mysql";
 
 const retryPeriod = 5000; // [ms]
 const totalAttempts = 30;
-const connCfg = {
+const connCfg: mysql.ConnectionConfig = {
     ...new Config().mysqlConfig,
     timeout: retryPeriod,
 };
diff --git a/components/service-waiter/cmd/database.go b/components/service-waiter/cmd/database.go
@@ -5,6 +5,8 @@
 package cmd
 
 import (
+	"crypto/tls"
+	"crypto/x509"
 	"database/sql"
 	"net"
 	"os"
@@ -24,7 +26,7 @@ var databaseCmd = &cobra.Command{
 	Short: "waits for a MySQL database to become available",
 	Long: `Uses the default db env config of a Gitpod deployment to try and
 connect to a MySQL database, specifically DB_HOST, DB_PORT, DB_PASSWORD,
-and DB_USER(=gitpod)`,
+DB_CUSTOM_CA_CERT and DB_USER(=gitpod)`,
 	PreRun: func(cmd *cobra.Command, args []string) {
 		err := viper.BindPFlags(cmd.Flags())
 		if err != nil {
@@ -38,13 +40,31 @@ and DB_USER(=gitpod)`,
 		cfg.User = viper.GetString("username")
 		cfg.Passwd = viper.GetString("password")
 		cfg.Timeout = 1 * time.Second
-		dsn := cfg.FormatDSN()
 
+		dsn := cfg.FormatDSN()
 		censoredDSN := dsn
 		if cfg.Passwd != "" {
 			censoredDSN = strings.Replace(dsn, cfg.Passwd, "*****", -1)
 		}
 
+		customCACert := viper.GetString("customCA")
+		if customCACert != "" {
+			rootCertPool := x509.NewCertPool()
+			if ok := rootCertPool.AppendCertsFromPEM([]byte(customCACert)); !ok {
+				log.Fatal("Failed to append custom DB CA cert.")
+			}
+
+			tlsConfigName := "custom"
+			err := mysql.RegisterTLSConfig(tlsConfigName, &tls.Config{
+				RootCAs:    rootCertPool,
+				MinVersion: tls.VersionTLS12, // semgrep finding: set lower boundary to exclude insecure TLS1.0
+			})
+			if err != nil {
+				log.WithError(err).Fatal("Failed to register custom DB CA cert")
+			}
+			cfg.TLSConfig = tlsConfigName
+		}
+
 		timeout := getTimeout()
 		done := make(chan bool)
 		go func() {
@@ -92,4 +112,5 @@ func init() {
 	databaseCmd.Flags().StringP("port", "p", envOrDefault("DB_PORT", "3306"), "Port to connect on")
 	databaseCmd.Flags().StringP("password", "P", os.Getenv("DB_PASSWORD"), "Password to use when connecting")
 	databaseCmd.Flags().StringP("username", "u", envOrDefault("DB_USERNAME", "gitpod"), "Username to use when connected")
+	databaseCmd.Flags().StringP("customCA", "", os.Getenv("DB_CUSTOM_CA_CERT"), "Custom CA cert (chain) to use when connected")
 }
diff --git a/components/usage/pkg/server/server.go b/components/usage/pkg/server/server.go
@@ -51,10 +51,11 @@ func Start(cfg Config, version string) error {
 	log.WithField("config", cfg).Info("Starting usage component.")
 
 	conn, err := db.Connect(db.ConnectionParams{
-		User:     os.Getenv("DB_USERNAME"),
-		Password: os.Getenv("DB_PASSWORD"),
-		Host:     net.JoinHostPort(os.Getenv("DB_HOST"), os.Getenv("DB_PORT")),
-		Database: "gitpod",
+		User:         os.Getenv("DB_USERNAME"),
+		Password:     os.Getenv("DB_PASSWORD"),
+		Host:         net.JoinHostPort(os.Getenv("DB_HOST"), os.Getenv("DB_PORT")),
+		Database:     "gitpod",
+		CustomCACert: os.Getenv("DB_CUSTOM_CA_CERT"),
 	})
 	if err != nil {
 		return fmt.Errorf("failed to establish database connection: %w", err)
diff --git a/install/installer/pkg/common/common.go b/install/installer/pkg/common/common.go
@@ -344,6 +344,17 @@ func DatabaseEnv(cfg *config.Config) (res []corev1.EnvVar) {
 		},
 	)
 
+	if cfg.Database.SSL != nil && cfg.Database.SSL.CustomCA != nil {
+		secretRef = corev1.LocalObjectReference{Name: cfg.Database.SSL.CustomCA.Name}
+		envvars = append(envvars, corev1.EnvVar{
+			Name: DBCustomCaCertEnvVarName,
+			ValueFrom: &corev1.EnvVarSource{SecretKeyRef: &corev1.SecretKeySelector{
+				LocalObjectReference: secretRef,
+				Key:                  DBCustomCaFileName,
+			}},
+		})
+	}
+
 	return envvars
 }
 
diff --git a/install/installer/pkg/common/constants.go b/install/installer/pkg/common/constants.go
@@ -48,6 +48,10 @@ const (
 	ImageBuilderComponent       = "image-builder-mk3"
 	ImageBuilderRPCPort         = 8080
 	DebugNodePort               = 9229
+	DBCustomCaCertEnvVarName    = "DB_CUSTOM_CA_CERT"
+	DBCustomCaFileName          = "ca.crt"
+	DBCustomCaBasePath          = "/db-ssl"
+	DBCustomCaPath              = DBCustomCaBasePath + "/" + DBCustomCaFileName
 
 	AnnotationConfigChecksum = "gitpod.io/checksum_config"
 )
diff --git a/install/installer/pkg/components/database/init/constants.go b/install/installer/pkg/components/database/init/constants.go
@@ -5,9 +5,10 @@
 package init
 
 const (
-	Component       = "dbinit"
-	dbSessionsImage = "library/mysql"
-	dbSessionsTag   = "5.7.34"
-	initScriptDir   = "files"
-	sqlInitScripts  = "db-init-scripts"
+	Component         = "dbinit"
+	dbSessionsImage   = "library/mysql"
+	dbSessionsTag     = "5.7.34"
+	initScriptDir     = "files"
+	sqlInitScripts    = "db-init-scripts"
+	customCaMountName = "db-custom-ca"
 )
diff --git a/install/installer/pkg/components/database/init/job.go b/install/installer/pkg/components/database/init/job.go
@@ -31,6 +31,35 @@ func job(ctx *common.RenderContext) ([]runtime.Object, error) {
 		Annotations: common.CustomizeAnnotation(ctx, Component, common.TypeMetaBatchJob),
 	}
 
+	volumes := []corev1.Volume{{
+		Name: sqlInitScripts,
+		VolumeSource: corev1.VolumeSource{ConfigMap: &corev1.ConfigMapVolumeSource{
+			LocalObjectReference: corev1.LocalObjectReference{Name: sqlInitScripts},
+		}},
+	}}
+	volumeMounts := []corev1.VolumeMount{{
+		Name:      sqlInitScripts,
+		MountPath: "/db-init-scripts",
+		ReadOnly:  true,
+	}}
+
+	// We already have CA loaded at common.DBCustomCaCertEnvVarName, but mysql cli needs a file here, so we mount it like as one.
+	sslOptions := ""
+	if ctx.Config.Database.SSL != nil && ctx.Config.Database.SSL.CustomCA != nil {
+		volumes = append(volumes, corev1.Volume{
+			Name: customCaMountName,
+			VolumeSource: corev1.VolumeSource{Secret: &corev1.SecretVolumeSource{
+				SecretName: ctx.Config.Database.SSL.CustomCA.Name,
+			}},
+		})
+		volumeMounts = append(volumeMounts, corev1.VolumeMount{
+			Name:      customCaMountName,
+			MountPath: common.DBCustomCaBasePath,
+			ReadOnly:  true,
+		})
+		sslOptions = fmt.Sprintf(" --ssl-mode=VERIFY_IDENTITY --ssl-ca=%s ", common.DBCustomCaPath)
+	}
+
 	return []runtime.Object{&batchv1.Job{
 		TypeMeta:   common.TypeMetaBatchJob,
 		ObjectMeta: objectMeta,
@@ -43,12 +72,7 @@ func job(ctx *common.RenderContext) ([]runtime.Object, error) {
 					RestartPolicy:      corev1.RestartPolicyNever,
 					ServiceAccountName: Component,
 					EnableServiceLinks: pointer.Bool(false),
-					Volumes: []corev1.Volume{{
-						Name: sqlInitScripts,
-						VolumeSource: corev1.VolumeSource{ConfigMap: &corev1.ConfigMapVolumeSource{
-							LocalObjectReference: corev1.LocalObjectReference{Name: sqlInitScripts},
-						}},
-					}},
+					Volumes:            volumes,
 					// The init container is designed to emulate Helm hooks
 					InitContainers: []corev1.Container{*common.DatabaseWaiterContainer(ctx)},
 					Containers: []corev1.Container{{
@@ -64,13 +88,9 @@ func job(ctx *common.RenderContext) ([]runtime.Object, error) {
 						Command: []string{
 							"sh",
 							"-c",
-							"mysql -h $DB_HOST --port $DB_PORT -u $DB_USERNAME -p$DB_PASSWORD < /db-init-scripts/init.sql",
+							fmt.Sprintf("mysql -h $DB_HOST --port $DB_PORT -u $DB_USERNAME -p$DB_PASSWORD %s< /db-init-scripts/init.sql", sslOptions),
 						},
-						VolumeMounts: []corev1.VolumeMount{{
-							Name:      sqlInitScripts,
-							MountPath: "/db-init-scripts",
-							ReadOnly:  true,
-						}},
+						VolumeMounts: volumeMounts,
 					}},
 				},
 			},
diff --git a/install/installer/pkg/config/v1/config.go b/install/installer/pkg/config/v1/config.go
@@ -232,6 +232,7 @@ type Database struct {
 	InCluster *bool             `json:"inCluster,omitempty"`
 	External  *DatabaseExternal `json:"external,omitempty"`
 	CloudSQL  *DatabaseCloudSQL `json:"cloudSQL,omitempty"`
+	SSL       *SSLOptions       `json:"ssl,omitempty"`
 }
 
 type DatabaseExternal struct {
@@ -243,6 +244,10 @@ type DatabaseCloudSQL struct {
 	Instance       string    `json:"instance" validate:"required"`
 }
 
+type SSLOptions struct {
+	CustomCA *ObjectRef `json:"customCa,omitempty"`
+}
+
 type ObjectStorage struct {
 	InCluster    *bool                      `json:"inCluster,omitempty"`
 	S3           *ObjectStorageS3           `json:"s3,omitempty"`
