Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
fix: harden instance TLS path validation (#20084)
p0nyff366f6ad581
diff --git a/backend/api/v1/instance_service.go b/backend/api/v1/instance_service.goindex 46cb567edc..a7f31bd8ca 100644--- a/backend/api/v1/instance_service.go+++ b/backend/api/v1/instance_service.go@@ -252,6 +252,12 @@ func (s *InstanceService) CreateInstance(ctx context.Context, req *connect.Requereturn connect.NewResponse(result), nil}+func instanceWithMetadata(instance *store.InstanceMessage, metadata *storepb.Instance) *store.InstanceMessage {+ candidate := *instance+ candidate.Metadata = metadata+ return &candidate+}+func (s *InstanceService) checkInstanceDataSources(ctx context.Context, instance *store.InstanceMessage, dataSources []*storepb.DataSource) error {for _, ds := range dataSources {if err := s.checkDataSource(ctx, instance, ds); err != nil {@@ -786,6 +792,10 @@ func (s *InstanceService) AddDataSource(ctx context.Context, req *connect.Requesreturn nil, err}+ if err := s.licenseService.IsFeatureEnabledForInstance(ctx, common.GetWorkspaceIDFromContext(ctx), v1pb.PlanFeature_FEATURE_INSTANCE_READ_ONLY_CONNECTION, instance); err != nil {+ return nil, connect.NewError(connect.CodePermissionDenied, err)+ }+// Test connection.if req.Msg.ValidateOnly {err := func() error {@@ -807,16 +817,13 @@ func (s *InstanceService) AddDataSource(ctx context.Context, req *connect.Requesif err != nil {return nil, err}- result := convertToV1Instance(instance)+ result := convertToV1Instance(instanceWithMetadata(instance, metadata))return connect.NewResponse(result), nil}if dataSource.GetType() != storepb.DataSourceType_READ_ONLY {return nil, connect.NewError(connect.CodeInvalidArgument, errors.New("only read-only data source can be added"))}- if err := s.licenseService.IsFeatureEnabledForInstance(ctx, common.GetWorkspaceIDFromContext(ctx), v1pb.PlanFeature_FEATURE_INSTANCE_READ_ONLY_CONNECTION, instance); err != nil {- return nil, connect.NewError(connect.CodePermissionDenied, err)- }instance, err = s.store.UpdateInstance(ctx, &store.UpdateInstanceMessage{ResourceID: &instance.ResourceID,@@ -858,8 +865,9 @@ func (s *InstanceService) UpdateDataSource(ctx context.Context, req *connect.Reqif dataSource == nil {if req.Msg.AllowMissing {return s.AddDataSource(ctx, connect.NewRequest(&v1pb.AddDataSourceRequest{- Name: req.Msg.Name,- DataSource: req.Msg.DataSource,+ Name: req.Msg.Name,+ DataSource: req.Msg.DataSource,+ ValidateOnly: req.Msg.ValidateOnly,}))}return nil, connect.NewError(connect.CodeNotFound, errors.Errorf(`cannot found data source "%s"`, req.Msg.DataSource.Id))@@ -1027,7 +1035,7 @@ func (s *InstanceService) UpdateDataSource(ctx context.Context, req *connect.Reqif err != nil {return nil, err}- result := convertToV1Instance(instance)+ result := convertToV1Instance(instanceWithMetadata(instance, metadata))return connect.NewResponse(result), nil}diff --git a/backend/plugin/db/util/ssl.go b/backend/plugin/db/util/ssl.goindex e645d19dba..25cc791168 100644--- a/backend/plugin/db/util/ssl.go+++ b/backend/plugin/db/util/ssl.go@@ -4,6 +4,7 @@ package utilimport ("crypto/tls""crypto/x509"+ "io""os""path/filepath"@@ -13,6 +14,8 @@ import (storepb "github.com/bytebase/bytebase/backend/generated-go/store")+const maxTLSMaterialFileSize int64 = 10 << 20+func HasTLSPath(ds *storepb.DataSource) bool {if ds == nil {return false@@ -61,13 +64,36 @@ func readTLSPathFile(label, path string) (string, error) {if !filepath.IsAbs(path) {return "", errors.Errorf("%s path must be absolute", label)}- content, err := os.ReadFile(path)+ info, err := os.Stat(path)+ if err != nil {+ return "", errors.Errorf("failed to read %s file", label)+ }+ if !info.Mode().IsRegular() {+ return "", errors.Errorf("%s path must point to a regular file", label)+ }+ if info.Size() == 0 {+ return "", errors.Errorf("%s file is empty", label)+ }+ if info.Size() > maxTLSMaterialFileSize {+ return "", errors.Errorf("%s file is too large", label)+ }++ file, err := os.Open(path)+ if err != nil {+ return "", errors.Errorf("failed to read %s file", label)+ }+ defer file.Close()++ content, err := io.ReadAll(io.LimitReader(file, maxTLSMaterialFileSize+1))if err != nil {return "", errors.Errorf("failed to read %s file", label)}if len(content) == 0 {return "", errors.Errorf("%s file is empty", label)}+ if int64(len(content)) > maxTLSMaterialFileSize {+ return "", errors.Errorf("%s file is too large", label)+ }return string(content), nil}diff --git a/backend/plugin/db/util/ssl_test.go b/backend/plugin/db/util/ssl_test.goindex bc29b8b996..1c1d4eed8e 100644--- a/backend/plugin/db/util/ssl_test.go+++ b/backend/plugin/db/util/ssl_test.go@@ -92,6 +92,31 @@ func TestResolveTLSMaterialRedactsReadErrors(t *testing.T) {require.NotContains(t, err.Error(), "no such file")}+func TestResolveTLSMaterialRejectsNonRegularPath(t *testing.T) {+ dir := t.TempDir()++ _, err := ResolveTLSMaterial(&storepb.DataSource{+ UseSsl: true,+ SslCaPath: dir,+ })+ require.Error(t, err)+ require.Contains(t, err.Error(), "CA certificate path must point to a regular file")+ require.NotContains(t, err.Error(), dir)+}++func TestResolveTLSMaterialRejectsOversizedFile(t *testing.T) {+ path := filepath.Join(t.TempDir(), "ca.pem")+ require.NoError(t, os.WriteFile(path, make([]byte, maxTLSMaterialFileSize+1), 0o600))++ _, err := ResolveTLSMaterial(&storepb.DataSource{+ UseSsl: true,+ SslCaPath: path,+ })+ require.Error(t, err)+ require.Contains(t, err.Error(), "CA certificate file is too large")+ require.NotContains(t, err.Error(), path)+}+func TestGetTLSConfigRequiresResolvedTLSMaterial(t *testing.T) {_, err := GetTLSConfig(&storepb.DataSource{UseSsl: true,diff --git a/backend/tests/data_source_test.go b/backend/tests/data_source_test.goindex 67acebca7a..2ed615bf4f 100644--- a/backend/tests/data_source_test.go+++ b/backend/tests/data_source_test.go@@ -39,6 +39,17 @@ func TestDataSource(t *testing.T) {err = ctl.removeLicense(ctx)a.NoError(err)+ _, err = ctl.instanceServiceClient.AddDataSource(ctx, connect.NewRequest(&v1pb.AddDataSourceRequest{+ Name: instance.Name,+ DataSource: &v1pb.DataSource{+ Id: "readonly-validate-only",+ Type: v1pb.DataSourceType_READ_ONLY,+ Host: instanceDir,+ },+ ValidateOnly: true,+ }))+ a.ErrorContains(err, "TEAM feature, please upgrade to access it")+_, err = ctl.instanceServiceClient.AddDataSource(ctx, connect.NewRequest(&v1pb.AddDataSourceRequest{Name: instance.Name,DataSource: &v1pb.DataSource{@@ -153,3 +164,110 @@ func TestDataSource(t *testing.T) {}))a.NoError(err)}++func TestDataSourceValidateOnly(t *testing.T) {+ a := require.New(t)+ ctx := context.Background()+ ctl := &controller{}+ ctx, err := ctl.StartServerWithExternalPg(ctx)+ a.NoError(err)+ defer ctl.Close(ctx)++ instanceRootDir := t.TempDir()+ instanceName := "testInstanceValidateOnly"+ instanceDir, err := ctl.provisionSQLiteInstance(instanceRootDir, instanceName)+ a.NoError(err)++ instanceResp, err := ctl.instanceServiceClient.CreateInstance(ctx, connect.NewRequest(&v1pb.CreateInstanceRequest{+ InstanceId: generateRandomString("instance"),+ Instance: &v1pb.Instance{+ Title: "test",+ Engine: v1pb.Engine_SQLITE,+ Environment: new("environments/prod"),+ Activation: true,+ DataSources: []*v1pb.DataSource{{Type: v1pb.DataSourceType_ADMIN, Id: "admin-ds", Host: instanceDir}},+ },+ }))+ a.NoError(err)+ instance := instanceResp.Msg++ err = ctl.setLicense(ctx)+ a.NoError(err)++ addResp, err := ctl.instanceServiceClient.AddDataSource(ctx, connect.NewRequest(&v1pb.AddDataSourceRequest{+ Name: instance.Name,+ DataSource: &v1pb.DataSource{+ Id: "readonly-validate-only",+ Type: v1pb.DataSourceType_READ_ONLY,+ Host: instanceDir,+ },+ ValidateOnly: true,+ }))+ a.NoError(err)+ a.Len(addResp.Msg.DataSources, 2)+ a.NotNil(findDataSource(addResp.Msg.DataSources, "readonly-validate-only"))++ instanceResp, err = ctl.instanceServiceClient.GetInstance(ctx, connect.NewRequest(&v1pb.GetInstanceRequest{Name: instance.Name}))+ a.NoError(err)+ a.Len(instanceResp.Msg.DataSources, 1)+ a.Nil(findDataSource(instanceResp.Msg.DataSources, "readonly-validate-only"))++ updateResp, err := ctl.instanceServiceClient.UpdateDataSource(ctx, connect.NewRequest(&v1pb.UpdateDataSourceRequest{+ Name: instance.Name,+ DataSource: &v1pb.DataSource{+ Id: "readonly-allow-missing",+ Type: v1pb.DataSourceType_READ_ONLY,+ Host: instanceDir,+ },+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"host"}},+ ValidateOnly: true,+ AllowMissing: true,+ }))+ a.NoError(err)+ a.Len(updateResp.Msg.DataSources, 2)+ a.NotNil(findDataSource(updateResp.Msg.DataSources, "readonly-allow-missing"))++ instanceResp, err = ctl.instanceServiceClient.GetInstance(ctx, connect.NewRequest(&v1pb.GetInstanceRequest{Name: instance.Name}))+ a.NoError(err)+ a.Len(instanceResp.Msg.DataSources, 1)+ a.Nil(findDataSource(instanceResp.Msg.DataSources, "readonly-allow-missing"))++ _, err = ctl.instanceServiceClient.AddDataSource(ctx, connect.NewRequest(&v1pb.AddDataSourceRequest{+ Name: instance.Name,+ DataSource: &v1pb.DataSource{+ Id: "readonly",+ Type: v1pb.DataSourceType_READ_ONLY,+ Host: instanceDir,+ },+ }))+ a.NoError(err)++ updateResp, err = ctl.instanceServiceClient.UpdateDataSource(ctx, connect.NewRequest(&v1pb.UpdateDataSourceRequest{+ Name: instance.Name,+ DataSource: &v1pb.DataSource{+ Id: "readonly",+ Username: "updated-user",+ },+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"username"}},+ ValidateOnly: true,+ }))+ a.NoError(err)+ updated := findDataSource(updateResp.Msg.DataSources, "readonly")+ a.NotNil(updated)+ a.Equal("updated-user", updated.Username)++ instanceResp, err = ctl.instanceServiceClient.GetInstance(ctx, connect.NewRequest(&v1pb.GetInstanceRequest{Name: instance.Name}))+ a.NoError(err)+ persisted := findDataSource(instanceResp.Msg.DataSources, "readonly")+ a.NotNil(persisted)+ a.Equal("", persisted.Username)+}++func findDataSource(dataSources []*v1pb.DataSource, id string) *v1pb.DataSource {+ for _, dataSource := range dataSources {+ if dataSource.Id == id {+ return dataSource+ }+ }+ return nil+}