Skip to content

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

Validate sqlserver additional options when connecting (#76293)

Riley Thompson74aa95064bfe
diff --git a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
index 6124bb908e4..aec4b20eb93 100644
--- a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
+++ b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
@@ -207,6 +207,19 @@
(merge (when port {:port port}))
(sql-jdbc.common/handle-additional-options details, :seperator-style :semicolon)))
+(def ^:private disallowed-additional-opts
+ #"(?i)(?:socketFactoryClass|socketFactoryConstructorArg|trustManagerClass|trustManagerConstructorArg|accessTokenCallbackClass)")
+
+(defmethod driver/validate-db-details! :sqlserver
+ [_driver {:keys [host additional-options]}]
+ (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}))))
+
+(defmethod driver/can-connect? :sqlserver
+ [driver details]
+ (driver/validate-db-details! driver details)
+ ((get-method driver/can-connect? :sql-jdbc) driver details))
+
(def ^:private ^:dynamic *field-options*
"The options part of the `:field` clause we're currently compiling."
nil)
diff --git a/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj b/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
index d539ed7884f..de6fdce082b 100644
--- a/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
+++ b/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
@@ -132,6 +132,37 @@
:port 1433
:additional-options "trustServerCertificate=false"})))))
+(deftest ^:parallel reject-details-with-dangerous-additional-options-test
+ (mt/test-driver :sqlserver
+ (let [details (:details (mt/db))]
+ (testing "db details with potentially dangerous additional options are rejected"
+ (are [bad-option] (let [bad-opts-details (assoc details :additional-options bad-option)
+ bad-host-details (update details :host str ";" bad-option)]
+ (is (thrown-with-msg? java.lang.Exception
+ #"Potentially dangerous keys in connection details"
+ (driver/can-connect? :sqlserver bad-opts-details)))
+ (is (thrown-with-msg? java.lang.Exception
+ #"Potentially dangerous keys in connection details"
+ (driver/can-connect? :sqlserver bad-host-details))))
+ "socketFactoryClass=bad.Factory"
+ "socketFactoryConstructorArg=bad"
+ "trustManagerClass=bad.TrustManager"
+ "trustManagerConstructorArg=/etc/passwd"
+ "accessTokenCallbackClass=bad.Callback"
+ "socketfactoryclass=bad.Factory"
+ "SOCKETFACTORYCLASS=bad.Factory"
+ "socketFactoryClass=bad.Factory;socketFactoryConstructorArg=bad"
+ "socketFactoryClass=bad.Factory;trustServerCertificate=false"
+ "trustServerCertificate=false;socketFactoryClass=bad.Factory"))
+ (testing "db details without potentially dangerous options are accepted"
+ (are [options] (let [details (assoc details :additional-options options)]
+ (is (true? (driver/can-connect? :sqlserver details))))
+ nil
+ ""
+ " "
+ "trustServerCertificate=false"
+ "trustStore=/path/to/store;trustStorePassword=password;trustStoreType=pkcs12")))))
+
(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 "