Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Additional jdbc validation (#82785)

Nathan Voxland76e91225be0b
diff --git a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
index 72c29cc8966..15315877cd1 100644
--- a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
+++ b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
@@ -190,6 +190,8 @@
(defmethod driver/can-connect? :clickhouse
[driver details]
+ ;; run the shared connection-property denylist before opening any connection, on both paths below
+ (driver/validate-db-details! driver details)
(if driver-api/is-test?
(try
;; Default SELECT 1 is not enough for Metabase test suite,
diff --git a/modules/drivers/databricks/src/metabase/driver/databricks.clj b/modules/drivers/databricks/src/metabase/driver/databricks.clj
index 9ba1c92b972..4f8815d993d 100644
--- a/modules/drivers/databricks/src/metabase/driver/databricks.clj
+++ b/modules/drivers/databricks/src/metabase/driver/databricks.clj
@@ -71,6 +71,7 @@
(defmethod driver/validate-db-details! :databricks
[_driver details]
+ (sql-jdbc/reject-dangerous-additional-options! details)
(when-let [opts (not-empty (:additional-options details))]
(when (re-find #"(?i)VolumeOperationAllowedLocalPaths" opts)
(throw (Exception. "Potentially dangerous keys in connection details")))))
diff --git a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
index ce006f777c0..7b79dd93ebb 100644
--- a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
+++ b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
@@ -262,9 +262,10 @@
#"(?i)(?:socketFactoryClass|socketFactoryConstructorArg|trustManagerClass|trustManagerConstructorArg|accessTokenCallbackClass)")
(defmethod driver/validate-db-details! :sqlserver
- [_driver {:keys [host additional-options]}]
+ [_driver {:keys [host additional-options] :as details}]
(when-let [match (some->> (str host ";" additional-options) (re-find disallowed-additional-opts))]
- (throw (ex-info "Potentially dangerous keys in connection details" {:disallowed-key match}))))
+ (throw (ex-info "Potentially dangerous keys in connection details" {:disallowed-key match})))
+ (sql-jdbc/reject-dangerous-additional-options! details))
(defmethod driver/can-connect? :sqlserver
[driver details]
diff --git a/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj b/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
index 46acfd18141..8d246613050 100644
--- a/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
+++ b/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
@@ -258,6 +258,24 @@
"trustServerCertificate=false"
"trustStore=/path/to/store;trustStorePassword=password;trustStoreType=pkcs12")))))
+(deftest ^:parallel validate-db-details-inherits-shared-denylist-test
+ (testing "SQL Server also inherits the shared SQL-JDBC denylist, not just its own keys"
+ (doseq [opt ["socketFactory=evil.Factory" ; shared list, distinct from sqlserver's socketFactoryClass
+ "sslfactory=evil.Factory"
+ "dnsResolver=evil.Resolver"
+ "queryInterceptors=evil.Interceptor"]]
+ (testing opt
+ (is (thrown-with-msg?
+ java.lang.Exception #"[Dd]angerous keys"
+ (driver/validate-db-details! :sqlserver {:additional-options opt}))))))
+ (testing "sqlserver's own denylist keys are still rejected"
+ (doseq [opt ["socketFactoryClass=evil.Factory"
+ "accessTokenCallbackClass=evil.Callback"]]
+ (testing opt
+ (is (thrown-with-msg?
+ java.lang.Exception #"[Dd]angerous keys"
+ (driver/validate-db-details! :sqlserver {:additional-options opt})))))))
+
(deftest ^:parallel add-max-results-limit-test
(mt/test-driver :sqlserver
(testing (str "SQL Server doesn't let you use ORDER BY in nested SELECTs unless you also specify a TOP (their "
diff --git a/src/metabase/driver/mysql.clj b/src/metabase/driver/mysql.clj
index d67332c9562..d0871e92901 100644
--- a/src/metabase/driver/mysql.clj
+++ b/src/metabase/driver/mysql.clj
@@ -227,6 +227,7 @@
(defmethod driver/validate-db-details! :mysql
[_driver details]
+ (sql-jdbc/reject-dangerous-additional-options! details)
(when-let [match (some->> (:additional-options details) (re-find disallowed-additional-opts))]
(throw (ex-info "Potentially dangerous keys in additional options" {:disallowed-key match}))))
diff --git a/src/metabase/driver/sql_jdbc.clj b/src/metabase/driver/sql_jdbc.clj
index 0ae821dfc76..3f30881315c 100644
--- a/src/metabase/driver/sql_jdbc.clj
+++ b/src/metabase/driver/sql_jdbc.clj
@@ -55,13 +55,25 @@
(def ^:private disallowed-additional-opts
"JDBC connection properties that are not needed to connect to a warehouse and are rejected for every
- SQL-JDBC driver. Matched case-insensitively against the raw `additional-options` string."
- #"(?i)(?:socketFactory|sslfactory|sslhostnameverifier|sslpasswordcallback|xmlFactoryFactory|loggerFile)")
+ SQL-JDBC driver. Matched case-insensitively as substrings of the raw `additional-options` string, so a token here
+ also catches its longer spellings (`socketFactory` covers `socketFactoryClass`, `socketfactoryname`,
+ `sslsocketfactoryname`; `hostnameverifier` covers `sslhostnameverifier`).
+
+ These are all properties whose value a JDBC driver loads and instantiates as a Java class -- a no-arg constructor
+ and/or static initializer runs inside the Metabase process -- which is arbitrary-class-instantiation leading to
+ code execution when a gadget is on the classpath. None is needed to reach a data warehouse."
+ #"(?i)(?:socketFactory|sslfactory|hostnameverifier|sslpasswordcallback|xmlFactoryFactory|loggerFile|queryInterceptors|dnsResolver)")
+
+(defn reject-dangerous-additional-options!
+ "Throw if `details` name a JDBC connection property on the shared SQL-JDBC denylist. Drivers that override
+ `validate-db-details!` must call this themselves."
+ [details]
+ (when-let [match (some->> (:additional-options details) (re-find disallowed-additional-opts))]
+ (throw (ex-info "Potentially dangerous keys in additional options" {:disallowed-key match}))))
(defmethod driver/validate-db-details! :sql-jdbc
[_driver details]
- (when-let [match (some->> (:additional-options details) (re-find disallowed-additional-opts))]
- (throw (ex-info "Potentially dangerous keys in additional options" {:disallowed-key match}))))
+ (reject-dangerous-additional-options! details))
(defmethod driver/can-connect? :sql-jdbc
[driver details]
diff --git a/test/metabase/driver/mysql_test.clj b/test/metabase/driver/mysql_test.clj
index 3a86701af71..fcfd91f00d0 100644
--- a/test/metabase/driver/mysql_test.clj
+++ b/test/metabase/driver/mysql_test.clj
@@ -422,6 +422,22 @@
;; the driver lets a later duplicate win, so ours has to be appended after whatever the user wrote
"allowLocalInfile=false&allowLocalInfile=true")))
+(deftest ^:parallel validate-db-details-rejects-dangerous-additional-options-test
+ (testing "MySQL inherits the shared SQL-JDBC denylist: socketFactory et al. are rejected"
+ (doseq [opt ["socketFactory=evil.SocketFactory"
+ "sslfactory=evil.Factory"
+ "hostnameverifier=evil.Verifier"
+ ;; the driver's own denylist still applies too
+ "autoDeserialize=true"
+ "allowLoadLocalInfile=true"]]
+ (testing opt
+ (is (thrown-with-msg?
+ clojure.lang.ExceptionInfo #"dangerous"
+ (driver/validate-db-details! :mysql {:additional-options opt}))))))
+ (testing "benign additional options are still allowed"
+ (doseq [opt [nil "tinyInt1isBit=false" "useSSL=true&trustServerCertificate=true"]]
+ (is (nil? (driver/validate-db-details! :mysql {:additional-options opt}))))))
+
(deftest ^:synchronized local-infile-blocked-for-write-queries-test
(mt/test-driver :mysql
(testing "a write query cannot make the driver read a file off the Metabase host"
diff --git a/test/metabase/driver/sql_jdbc_test.clj b/test/metabase/driver/sql_jdbc_test.clj
index de232b92aaf..96f1aa44b0c 100644
--- a/test/metabase/driver/sql_jdbc_test.clj
+++ b/test/metabase/driver/sql_jdbc_test.clj
@@ -115,7 +115,17 @@
"sslhostnameverifier=a.b.C"
"sslpasswordcallback=a.b.C"
"xmlFactoryFactory=a.b.C"
- "loggerFile=a/b"]]
+ "loggerFile=a/b"
+ ;; class-instantiation sinks on drivers that inherit this method:
+ "queryInterceptors=a.b.C" ; presto-jdbc
+ "dnsResolver=a.b.C" ; starburst / trino
+ "hostnameverifier=a.b.C" ; vertica (bare, not just the ssl-prefixed form)
+ "socketfactoryname=a.b.C" ; vertica
+ "sslsocketfactoryname=a.b.C" ; vertica
+ "socketFactoryClass=a.b.C" ; sqlserver-style spelling
+ ;; matching is case-insensitive
+ "SOCKETFACTORY=a.b.C"
+ "DnsResolver=a.b.C"]]
(testing opt
(is (thrown-with-msg?
clojure.lang.ExceptionInfo #"dangerous"