@bytebase/dbhub 0.4.0 → 0.4.2

package/README.md

@@ -98,11 +98,22 @@ docker run --rm --init \
    --dsn "oracle://username:password@localhost:1521/service_name"
 ```
 
+```bash
+# Oracle example with thick mode for connecting to 11g or older 
+docker run --rm --init \
+   --name dbhub \
+   --publish 8080:8080 \
+   bytebase/dbhub-oracle-thick \
+   --transport sse \
+   --port 8080 \
+   --dsn "oracle://username:password@localhost:1521/service_name"
+```
+
 ### NPM
 
 ```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
@@ -164,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:
@@ -221,6 +264,27 @@ DBHub supports the following database connection string formats:
 | 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
+
+If you see the error "NJS-138: connections to this database server version are not supported by node-oracledb in Thin mode", you need to use Thick mode as described below.
+
+##### Docker
+
+Use `bytebase/dbhub-oracle-thick` instead of `bytebase/dbhub` docker image.
+
+##### npx
+
+1. Download and install [Oracle Instant Client](https://www.oracle.com/database/technologies/instant-client/downloads.html) for your platform
+1. Set the `ORACLE_LIB_DIR` environment variable to the path of your Oracle Instant Client:
+
+```bash
+# Set environment variable to Oracle Instant Client directory
+export ORACLE_LIB_DIR=/path/to/instantclient_19_8
+
+# Then run DBHub
+npx @bytebase/dbhub --dsn "oracle://username:password@localhost:1521/service_name"
+```
+
 #### SQL Server
 
 Extra query parameters:

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 {
@@ -1680,6 +1698,16 @@ var OracleConnector = class {
         }
       }
     };
+    try {
+      if (process.env.ORACLE_LIB_DIR) {
+        oracledb.initOracleClient({ libDir: process.env.ORACLE_LIB_DIR });
+        console.error("Oracle client initialized in Thick mode");
+      } else {
+        console.error("ORACLE_LIB_DIR not specified, will use Thin mode by default");
+      }
+    } catch (err) {
+      console.error("Failed to initialize Oracle client:", err);
+    }
     oracledb.autoCommit = true;
   }
   async connect(dsn, initializationScript) {
@@ -1704,6 +1732,19 @@ var OracleConnector = class {
       }
     } catch (error) {
       console.error("Failed to connect to Oracle database:", error);
+      if (error instanceof Error && error.message.includes("NJS-138")) {
+        const enhancedError = new Error(
+          `${error.message}
+
+This error occurs when your Oracle database version is not supported by node-oracledb in Thin mode.
+To resolve this, you need to use Thick mode:
+1. Download Oracle Instant Client from https://www.oracle.com/database/technologies/instant-client/downloads.html
+2. Set ORACLE_LIB_DIR environment variable to the path of your Oracle Instant Client
+   Example: export ORACLE_LIB_DIR=/path/to/instantclient_19_8
+3. Restart DBHub`
+        );
+        throw enhancedError;
+      }
       throw error;
     }
   }

package/package.json

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