@bytebase/dbhub 0.4.1 → 0.4.2

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 | ❌ | ❌ | Built-in encryption     |
+| SQLite     | ❌ | ❌ | N/A (file-based)        |
+| Oracle     | ❌ | ❌ | Built-in encryption     |
+
+**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:

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 {
@@ -930,8 +936,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 +954,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 +1292,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 +1310,7 @@ var MariadbDSNParser = class {
     }
   }
   getSampleDSN() {
-    return "mariadb://root:password@localhost:3306/db";
+    return "mariadb://root:password@localhost:3306/db?sslmode=require";
   }
   isValidDSN(dsn) {
     try {

package/package.json

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