@bytebase/dbhub 0.4.1 → 0.4.5

package/README.md

@@ -113,7 +113,7 @@ docker run --rm --init \
 
 ```bash
 # PostgreSQL example
-npx @bytebase/dbhub --transport sse --port 8080 --dsn "postgres://user:password@localhost:5432/dbname"
+npx @bytebase/dbhub --transport sse --port 8080 --dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
 ```
 
 ```bash
@@ -175,6 +175,38 @@ npx @bytebase/dbhub --transport sse --port 8080 --demo
 
 ## Usage
 
+### SSL Connections
+
+You can specify the SSL mode using the `sslmode` parameter in your DSN string:
+
+| Database   | `sslmode=disable` | `sslmode=require` | Default SSL Behavior |
+|------------|:----------------:|:----------------:|:-------------------:|
+| PostgreSQL | ✅ | ✅ | Certificate verification |
+| MySQL      | ✅ | ✅ | Certificate verification |
+| MariaDB    | ✅ | ✅ | Certificate verification |
+| SQL Server | ✅ | ✅ | Certificate verification |
+| Oracle     | ✅ | ✅ | N/A (use Oracle client config) |
+| SQLite     | ❌ | ❌ | N/A (file-based)        |
+
+**SSL Mode Options:**
+
+- `sslmode=disable`: All SSL/TLS encryption is turned off. Data is transmitted in plaintext.
+- `sslmode=require`: Connection is encrypted, but the server's certificate is not verified. This provides protection against packet sniffing but not against man-in-the-middle attacks. You may use this for trusted self-signed CA.
+
+Without specifying `sslmode`, most databases default to certificate verification, which provides the highest level of security.
+
+Example usage:
+```bash
+# Disable SSL
+postgres://user:password@localhost:5432/dbname?sslmode=disable
+
+# Require SSL without certificate verification
+postgres://user:password@localhost:5432/dbname?sslmode=require
+
+# Standard SSL with certificate verification (default)
+postgres://user:password@localhost:5432/dbname
+```
+
 ### Read-only Mode
 
 You can run DBHub in read-only mode, which restricts SQL query execution to read-only operations:
@@ -225,12 +257,12 @@ DBHub supports the following database connection string formats:
 
 | Database   | DSN Format                                                | Example                                                                                                     |
 | ---------- | --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
-| MySQL      | `mysql://[user]:[password]@[host]:[port]/[database]`      | `mysql://user:password@localhost:3306/dbname`                                                               |
-| MariaDB    | `mariadb://[user]:[password]@[host]:[port]/[database]`    | `mariadb://user:password@localhost:3306/dbname`                                                             |
+| MySQL      | `mysql://[user]:[password]@[host]:[port]/[database]`      | `mysql://user:password@localhost:3306/dbname?sslmode=disable`                                                               |
+| MariaDB    | `mariadb://[user]:[password]@[host]:[port]/[database]`    | `mariadb://user:password@localhost:3306/dbname?sslmode=disable`                                                             |
 | PostgreSQL | `postgres://[user]:[password]@[host]:[port]/[database]`   | `postgres://user:password@localhost:5432/dbname?sslmode=disable`                                            |
-| SQL Server | `sqlserver://[user]:[password]@[host]:[port]/[database]`  | `sqlserver://user:password@localhost:1433/dbname`                                                           |
+| SQL Server | `sqlserver://[user]:[password]@[host]:[port]/[database]`  | `sqlserver://user:password@localhost:1433/dbname?sslmode=disable`                                           |
 | SQLite     | `sqlite:///[path/to/file]` or `sqlite::memory:`           | `sqlite:///path/to/database.db`, `sqlite:C:/Users/YourName/data/database.db (windows)` or `sqlite::memory:` |
-| Oracle     | `oracle://[user]:[password]@[host]:[port]/[service_name]` | `oracle://username:password@localhost:1521/service_name`                                                    |
+| Oracle     | `oracle://[user]:[password]@[host]:[port]/[service_name]` | `oracle://username:password@localhost:1521/service_name?sslmode=disable`                                     |
 
 #### Oracle
 

package/dist/index.js

@@ -76,7 +76,13 @@ var PostgresDSNParser = class {
       };
       url.searchParams.forEach((value, key) => {
         if (key === "sslmode") {
-          config.ssl = value !== "disable";
+          if (value === "disable") {
+            config.ssl = false;
+          } else if (value === "require") {
+            config.ssl = { rejectUnauthorized: false };
+          } else {
+            config.ssl = true;
+          }
         }
       });
       return config;
@@ -87,7 +93,7 @@ var PostgresDSNParser = class {
     }
   }
   getSampleDSN() {
-    return "postgres://postgres:password@localhost:5432/postgres?sslmode=disable";
+    return "postgres://postgres:password@localhost:5432/postgres?sslmode=require";
   }
   isValidDSN(dsn) {
     try {
@@ -388,16 +394,22 @@ var SQLServerDSNParser = class {
     const password = url.password ? decodeURIComponent(url.password) : "";
     const options = {};
     for (const [key, value] of url.searchParams.entries()) {
-      if (key === "encrypt") {
-        options.encrypt = value === "true" ? true : value === "false" ? false : value;
-      } else if (key === "trustServerCertificate") {
-        options.trustServerCertificate = value === "true";
-      } else if (key === "connectTimeout") {
+      if (key === "connectTimeout") {
         options.connectTimeout = parseInt(value, 10);
       } else if (key === "requestTimeout") {
         options.requestTimeout = parseInt(value, 10);
       } else if (key === "authentication") {
         options.authentication = value;
+      } else if (key === "sslmode") {
+        options.sslmode = value;
+      }
+    }
+    if (options.sslmode) {
+      if (options.sslmode === "disable") {
+        options.encrypt = false;
+      } else if (options.sslmode === "require") {
+        options.encrypt = true;
+        options.trustServerCertificate = true;
       }
     }
     const config = {
@@ -433,7 +445,7 @@ var SQLServerDSNParser = class {
     return config;
   }
   getSampleDSN() {
-    return "sqlserver://username:password@localhost:1433/database?encrypt=true";
+    return "sqlserver://username:password@localhost:1433/database?sslmode=require";
   }
   isValidDSN(dsn) {
     try {
@@ -930,8 +942,14 @@ var MySQLDSNParser = class {
         password: url.password ? decodeURIComponent(url.password) : ""
       };
       url.searchParams.forEach((value, key) => {
-        if (key === "ssl") {
-          config.ssl = value === "true" ? {} : void 0;
+        if (key === "sslmode") {
+          if (value === "disable") {
+            config.ssl = void 0;
+          } else if (value === "require") {
+            config.ssl = { rejectUnauthorized: false };
+          } else {
+            config.ssl = {};
+          }
         }
       });
       return config;
@@ -942,7 +960,7 @@ var MySQLDSNParser = class {
     }
   }
   getSampleDSN() {
-    return "mysql://root:password@localhost:3306/mysql";
+    return "mysql://root:password@localhost:3306/mysql?sslmode=require";
   }
   isValidDSN(dsn) {
     try {
@@ -1280,8 +1298,14 @@ var MariadbDSNParser = class {
         password: decodeURIComponent(url.password)
       };
       url.searchParams.forEach((value, key) => {
-        if (key === "ssl") {
-          config.ssl = value === "true" ? {} : void 0;
+        if (key === "sslmode") {
+          if (value === "disable") {
+            config.ssl = void 0;
+          } else if (value === "require") {
+            config.ssl = { rejectUnauthorized: false };
+          } else {
+            config.ssl = {};
+          }
         }
       });
       return config;
@@ -1292,7 +1316,7 @@ var MariadbDSNParser = class {
     }
   }
   getSampleDSN() {
-    return "mariadb://root:password@localhost:3306/db";
+    return "mariadb://root:password@localhost:3306/db?sslmode=require";
   }
   isValidDSN(dsn) {
     try {
@@ -1617,7 +1641,7 @@ ConnectorRegistry.register(mariadbConnector);
 // src/connectors/oracle/index.ts
 import oracledb from "oracledb";
 oracledb.outFormat = oracledb.OUT_FORMAT_OBJECT;
-var OracleConnector = class {
+var _OracleConnector = class _OracleConnector {
   // constructor(config: ConnectionConfig) { // Removed config
   constructor() {
     // Connector ID and Name are part of the Connector interface
@@ -1661,6 +1685,15 @@ var OracleConnector = class {
               case "poolincrement":
                 config.poolIncrement = parseInt(value, 10);
                 break;
+              case "sslmode":
+                switch (value.toLowerCase()) {
+                  case "disable":
+                    break;
+                  case "require":
+                    config.sslServerDNMatch = false;
+                    break;
+                }
+                break;
             }
           });
           return config;
@@ -1669,7 +1702,7 @@ var OracleConnector = class {
         }
       },
       getSampleDSN: () => {
-        return "oracle://username:password@host:1521/service_name";
+        return "oracle://username:password@host:1521/service_name?sslmode=require";
       },
       isValidDSN: (dsn) => {
         try {
@@ -1680,6 +1713,13 @@ var OracleConnector = class {
         }
       }
     };
+    oracledb.autoCommit = true;
+  }
+  // Initialize Oracle client only once
+  initClient() {
+    if (_OracleConnector.clientInitialized) {
+      return;
+    }
     try {
       if (process.env.ORACLE_LIB_DIR) {
         oracledb.initOracleClient({ libDir: process.env.ORACLE_LIB_DIR });
@@ -1687,13 +1727,14 @@ var OracleConnector = class {
       } else {
         console.error("ORACLE_LIB_DIR not specified, will use Thin mode by default");
       }
+      _OracleConnector.clientInitialized = true;
     } catch (err) {
       console.error("Failed to initialize Oracle client:", err);
     }
-    oracledb.autoCommit = true;
   }
   async connect(dsn, initializationScript) {
     try {
+      this.initClient();
       const config = await this.dsnParser.parse(dsn);
       this.pool = await oracledb.createPool(config);
       const conn = await this.getConnection();
@@ -2074,6 +2115,9 @@ To resolve this, you need to use Thick mode:
     return this.pool.getConnection();
   }
 };
+// Track if we've already initialized the client
+_OracleConnector.clientInitialized = false;
+var OracleConnector = _OracleConnector;
 function formatOracleDataType(dataType, dataLength, dataPrecision, dataScale) {
   if (!dataType) {
     return "UNKNOWN";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytebase/dbhub",
-  "version": "0.4.1",
+  "version": "0.4.5",
   "description": "Universal Database MCP Server",
   "main": "dist/index.js",
   "type": "module",