Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

feat: support TiDB extra connection parameters (#20180)

p0ny3b4b2128ece6
diff --git a/backend/api/v1/instance_service.go b/backend/api/v1/instance_service.go
index 20e536942f..4b8f9b0fd4 100644
--- a/backend/api/v1/instance_service.go
+++ b/backend/api/v1/instance_service.go
@@ -429,7 +429,7 @@ func (s *InstanceService) checkDataSource(ctx context.Context, instance *store.I
return nil
}
- // Validate extra connection parameters for MySQL-based engines
+ // Validate extra connection parameters for MySQL-compatible engines
if err := validateExtraConnectionParameters(instance.Metadata.GetEngine(), dataSource.GetExtraConnectionParameters()); err != nil {
return connect.NewError(connect.CodeInvalidArgument, err)
}
@@ -1164,9 +1164,9 @@ func (s *InstanceService) instanceCountGuard(ctx context.Context) error {
// validateExtraConnectionParameters validates extra connection parameters for security risks.
func validateExtraConnectionParameters(engine storepb.Engine, params map[string]string) error {
- // Validate MySQL-based engines
+ // Validate MySQL-compatible engines
switch engine {
- case storepb.Engine_MYSQL, storepb.Engine_MARIADB, storepb.Engine_OCEANBASE:
+ case storepb.Engine_MYSQL, storepb.Engine_MARIADB, storepb.Engine_OCEANBASE, storepb.Engine_TIDB:
for key := range params {
normalizedKey := strings.ToLower(strings.TrimSpace(key))
if normalizedKey == "allowallfiles" {
diff --git a/backend/api/v1/instance_service_test.go b/backend/api/v1/instance_service_test.go
new file mode 100644
index 0000000000..845fdadbfd
--- /dev/null
+++ b/backend/api/v1/instance_service_test.go
@@ -0,0 +1,17 @@
+package v1
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+)
+
+func TestValidateExtraConnectionParametersRejectsTiDBAllowAllFiles(t *testing.T) {
+ err := validateExtraConnectionParameters(storepb.Engine_TIDB, map[string]string{
+ "allowAllFiles": "true",
+ })
+ require.Error(t, err)
+ require.Contains(t, err.Error(), "allowAllFiles")
+}
diff --git a/backend/plugin/db/tidb/tidb.go b/backend/plugin/db/tidb/tidb.go
index 149e23b9cf..cd5bed1a13 100644
--- a/backend/plugin/db/tidb/tidb.go
+++ b/backend/plugin/db/tidb/tidb.go
@@ -56,7 +56,18 @@ func newDriver() db.Driver {
return &Driver{}
}
-// Open opens a MySQL driver.
+// validateTiDBExtraConnectionParameters validates that no dangerous parameters are present.
+func validateTiDBExtraConnectionParameters(params map[string]string) error {
+ for key := range params {
+ normalizedKey := strings.ToLower(strings.TrimSpace(key))
+ if normalizedKey == "allowallfiles" {
+ return errors.Errorf("connection parameter %q is not allowed for security reasons", key)
+ }
+ }
+ return nil
+}
+
+// Open opens a TiDB driver.
func (d *Driver) Open(_ context.Context, dbType storepb.Engine, connCfg db.ConnectionConfig) (db.Driver, error) {
defer func() {
for _, f := range d.openCleanUp {
@@ -64,15 +75,40 @@ func (d *Driver) Open(_ context.Context, dbType storepb.Engine, connCfg db.Conne
}
}()
+ dsn, err := d.getTiDBConnection(connCfg)
+ if err != nil {
+ return nil, err
+ }
+ db, err := sql.Open("mysql", dsn)
+ if err != nil {
+ return nil, err
+ }
+ d.dbType = dbType
+ d.db = db
+ // TODO(d): remove the work-around once we have clean-up the migration connection hack.
+ db.SetConnMaxLifetime(2 * time.Hour)
+ db.SetMaxOpenConns(50)
+ db.SetMaxIdleConns(15)
+ d.databaseName = connCfg.ConnectionContext.DatabaseName
+ return d, nil
+}
+
+func (d *Driver) getTiDBConnection(connCfg db.ConnectionConfig) (string, error) {
protocol := "tcp"
if strings.HasPrefix(connCfg.DataSource.Host, "/") {
protocol = "unix"
}
params := []string{"multiStatements=true", "maxAllowedPacket=0"}
+ if err := validateTiDBExtraConnectionParameters(connCfg.DataSource.GetExtraConnectionParameters()); err != nil {
+ return "", err
+ }
+ for key, value := range connCfg.DataSource.GetExtraConnectionParameters() {
+ params = append(params, fmt.Sprintf("%s=%s", key, value))
+ }
if connCfg.DataSource.GetSshHost() != "" {
sshClient, err := util.GetSSHClient(connCfg.DataSource)
if err != nil {
- return nil, err
+ return "", err
}
d.sshClient = sshClient
// Now we register the dialer with the ssh connection as a parameter.
@@ -85,31 +121,19 @@ func (d *Driver) Open(_ context.Context, dbType storepb.Engine, connCfg db.Conne
tlscfg, err := util.GetTLSConfig(connCfg.DataSource)
if err != nil {
- return nil, errors.Wrap(err, "sql: tls config error")
+ return "", errors.Wrap(err, "sql: tls config error")
}
tlsKey := uuid.NewString()
if tlscfg != nil {
if err := mysql.RegisterTLSConfig(tlsKey, tlscfg); err != nil {
- return nil, errors.Wrap(err, "sql: failed to register tls config")
+ return "", errors.Wrap(err, "sql: failed to register tls config")
}
// TLS config is only used during sql.Open, so should be safe to deregister afterwards.
d.openCleanUp = append(d.openCleanUp, func() { mysql.DeregisterTLSConfig(tlsKey) })
params = append(params, fmt.Sprintf("tls=%s", tlsKey))
}
- dsn := fmt.Sprintf("%s:%s@%s(%s:%s)/%s?%s", connCfg.DataSource.Username, connCfg.Password, protocol, connCfg.DataSource.Host, connCfg.DataSource.Port, connCfg.ConnectionContext.DatabaseName, strings.Join(params, "&"))
- db, err := sql.Open("mysql", dsn)
- if err != nil {
- return nil, err
- }
- d.dbType = dbType
- d.db = db
- // TODO(d): remove the work-around once we have clean-up the migration connection hack.
- db.SetConnMaxLifetime(2 * time.Hour)
- db.SetMaxOpenConns(50)
- db.SetMaxIdleConns(15)
- d.databaseName = connCfg.ConnectionContext.DatabaseName
- return d, nil
+ return fmt.Sprintf("%s:%s@%s(%s:%s)/%s?%s", connCfg.DataSource.Username, connCfg.Password, protocol, connCfg.DataSource.Host, connCfg.DataSource.Port, connCfg.ConnectionContext.DatabaseName, strings.Join(params, "&")), nil
}
// Close closes the driver.
diff --git a/backend/plugin/db/tidb/tidb_test.go b/backend/plugin/db/tidb/tidb_test.go
index 0b7da6af78..3ae7d122f4 100644
--- a/backend/plugin/db/tidb/tidb_test.go
+++ b/backend/plugin/db/tidb/tidb_test.go
@@ -4,8 +4,53 @@ import (
"testing"
"github.com/stretchr/testify/require"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/db"
)
+func TestGetTiDBConnectionUsesExtraConnectionParameters(t *testing.T) {
+ d := &Driver{}
+ dsn, err := d.getTiDBConnection(db.ConnectionConfig{
+ DataSource: &storepb.DataSource{
+ Host: "127.0.0.1",
+ Port: "4000",
+ Username: "root",
+ ExtraConnectionParameters: map[string]string{
+ "readTimeout": "30s",
+ "writeTimeout": "45s",
+ },
+ },
+ Password: "secret",
+ ConnectionContext: db.ConnectionContext{
+ DatabaseName: "test",
+ },
+ })
+ require.NoError(t, err)
+ require.Contains(t, dsn, "readTimeout=30s")
+ require.Contains(t, dsn, "writeTimeout=45s")
+}
+
+func TestGetTiDBConnectionRejectsAllowAllFiles(t *testing.T) {
+ d := &Driver{}
+ _, err := d.getTiDBConnection(db.ConnectionConfig{
+ DataSource: &storepb.DataSource{
+ Host: "127.0.0.1",
+ Port: "4000",
+ Username: "root",
+ ExtraConnectionParameters: map[string]string{
+ "allowAllFiles": "true",
+ },
+ },
+ Password: "secret",
+ ConnectionContext: db.ConnectionContext{
+ DatabaseName: "test",
+ },
+ })
+ require.Error(t, err)
+ require.Contains(t, err.Error(), "allowAllFiles")
+}
+
func TestParseVersion(t *testing.T) {
tests := []struct {
version string
diff --git a/frontend/src/utils/v1/instance.test.ts b/frontend/src/utils/v1/instance.test.ts
new file mode 100644
index 0000000000..73adf1f66d
--- /dev/null
+++ b/frontend/src/utils/v1/instance.test.ts
@@ -0,0 +1,27 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { Engine } from "@/types/proto-es/v1/common_pb";
+
+vi.mock("@/plugins/i18n", () => ({
+ t: (key: string) => key,
+}));
+
+vi.mock("@/store", () => ({
+ useSubscriptionV1Store: () => ({ currentPlan: 0 }),
+}));
+
+vi.mock("@/types", () => ({
+ isValidInstanceName: () => true,
+ languageOfEngineV1: () => "sql",
+ unknownInstance: () => ({ title: "Unknown" }),
+}));
+
+describe("instanceV1HasExtraParameters", () => {
+ beforeEach(() => {
+ vi.resetModules();
+ });
+
+ it("supports TiDB extra connection parameters", async () => {
+ const { instanceV1HasExtraParameters } = await import("./instance");
+ expect(instanceV1HasExtraParameters(Engine.TIDB)).toBe(true);
+ });
+});
diff --git a/frontend/src/utils/v1/instance.ts b/frontend/src/utils/v1/instance.ts
index b163d0964b..1253d98d52 100644
--- a/frontend/src/utils/v1/instance.ts
+++ b/frontend/src/utils/v1/instance.ts
@@ -185,6 +185,7 @@ export const instanceV1HasExtraParameters = (
const engine = engineOfInstanceV1(instanceOrEngine);
return [
Engine.MYSQL,
+ Engine.TIDB,
Engine.MARIADB,
Engine.OCEANBASE,
Engine.POSTGRES,