Skip to content

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

Disable sqlserver managed-identity in Metabase cloud (#85767)

metamben9cd685f054da
diff --git a/modules/drivers/sqlserver/resources/metabase/sqlserver/metabase-plugin.yaml b/modules/drivers/sqlserver/resources/metabase/sqlserver/metabase-plugin.yaml
index ec2d2de1ef7..68b76380318 100644
--- a/modules/drivers/sqlserver/resources/metabase/sqlserver/metabase-plugin.yaml
+++ b/modules/drivers/sqlserver/resources/metabase/sqlserver/metabase-plugin.yaml
@@ -31,7 +31,7 @@ driver:
- {name: "SQL Server login", value: "sql"}
- {name: "Azure AD - Service principal", value: "ad-service-principal"}
- {name: "Azure AD - Service principal (certificate)", value: "ad-service-principal-certificate"}
- - {name: "Azure AD - Managed identity", value: "ad-managed-identity"}
+ - {name: "Azure AD - Managed identity", value: "ad-managed-identity", hidden-when-hosted: true}
- merge:
- user
- visible-if:
diff --git a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
index 64f41f9dae8..640f6ee1103 100644
--- a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
+++ b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
@@ -32,7 +32,7 @@
[metabase.sql-tools.core :as sql-tools]
[metabase.util :as u]
[metabase.util.honey-sql-2 :as h2x]
- [metabase.util.i18n :refer [deferred-tru]]
+ [metabase.util.i18n :refer [deferred-tru tru]]
[metabase.util.log :as log]
[metabase.util.malli :as mu]
[metabase.util.match :as match]
@@ -268,11 +268,20 @@
(not (str/blank? key-password)) (assoc :clientKeyPassword key-password)))
;; https://learn.microsoft.com/en-us/sql/connect/jdbc/connecting-using-azure-active-directory-authentication?view=sql-server-ver17#connect-using-activedirectorymanagedidentity-authentication-mode
+ ;; Managed identity pulls a token from the Azure Instance Metadata Service of the Metabase
+ ;; host, i.e. it authenticates as the host's cloud identity rather than something the admin
+ ;; chose. Metabase Cloud runs on AWS, where the endpoint does not exist at all; even on an
+ ;; Azure host it would be ambient-authority auth.
;; Missing :user = default identity; set :user for user-assigned managed identity.
"ad-managed-identity"
- (cond-> {:authentication "ActiveDirectoryManagedIdentity"}
- (not (str/blank? ad-managed-identity-client-id))
- (assoc :user ad-managed-identity-client-id))
+ (do
+ (when (driver-api/is-hosted?)
+ (throw (ex-info (tru (str "Azure AD managed identity is not available on Metabase Cloud. "
+ "Use an Azure AD service principal or SQL Server authentication."))
+ {:auth-mode auth-mode})))
+ (cond-> {:authentication "ActiveDirectoryManagedIdentity"}
+ (not (str/blank? ad-managed-identity-client-id))
+ (assoc :user ad-managed-identity-client-id)))
;; "sql" (default), nil (legacy connections without auth-mode), or any unknown value.
;; apparently specifying `domain` with the official SQLServer driver is done like
diff --git a/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj b/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
index 1a3458e78ed..651d3e33f3c 100644
--- a/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
+++ b/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
@@ -8,6 +8,7 @@
[colorize.core :as colorize]
[honey.sql :as sql]
[java-time.api :as t]
+ [medley.core :as m]
[metabase.config.core :as config]
[metabase.driver :as driver]
[metabase.driver-api.core :as driver-api]
@@ -19,9 +20,11 @@
[metabase.driver.sql-jdbc.sync :as sql-jdbc.sync]
[metabase.driver.sql.query-processor :as sql.qp]
[metabase.driver.sqlserver :as sqlserver]
+ [metabase.driver.util :as driver.u]
[metabase.lib.core :as lib]
[metabase.lib.expression :as lib.expression]
[metabase.lib.metadata :as lib.metadata]
+ [metabase.premium-features.core :as premium-features]
[metabase.query-processor.compile :as qp.compile]
[metabase.query-processor.preprocess :as qp.preprocess]
;; binds mock metadata providers via the ambient store, which the code under test reads
@@ -304,6 +307,44 @@
(is (= "ActiveDirectoryManagedIdentity" (:authentication spec)))
(is (not (contains? spec :user))))))))
+(deftest connection-spec-ad-managed-identity-hosted-rejected-test
+ (testing "auth-mode 'ad-managed-identity' is rejected on Metabase Cloud (ambient Azure identity, not available on AWS hosts)"
+ (mt/with-dynamic-fn-redefs [premium-features/is-hosted? (constantly true)]
+ (doseq [[label details] [["default identity" {:auth-mode "ad-managed-identity"
+ :host "sql.example.com"
+ :db "metabase_test"}]
+ ["user-assigned identity" {:auth-mode "ad-managed-identity"
+ :ad-managed-identity-client-id "4e027ad8-5e10-4e05-b5a6-c071b9b61b37"
+ :host "sql.example.com"
+ :db "metabase_test"}]]]
+ (testing label
+ (is (thrown-with-msg?
+ clojure.lang.ExceptionInfo
+ #"not available on Metabase Cloud"
+ (sql-jdbc.conn/connection-details->spec :sqlserver details)))))))
+ (testing "Off Metabase Cloud, ad-managed-identity continues to work."
+ (mt/with-dynamic-fn-redefs [premium-features/is-hosted? (constantly false)]
+ (let [spec (sql-jdbc.conn/connection-details->spec :sqlserver
+ {:auth-mode "ad-managed-identity"
+ :host "sql.example.com"
+ :db "metabase_test"})]
+ (is (= "ActiveDirectoryManagedIdentity" (:authentication spec)))))))
+
+(deftest auth-mode-options-hidden-when-hosted-test
+ (let [auth-mode-values
+ (fn [] (->> (:details-fields (:sqlserver (driver.u/available-drivers-info)))
+ (m/find-first #(= "auth-mode" (:name %)))
+ :options
+ (mapv :value)))]
+ (testing "On Metabase Cloud, ad-managed-identity is stripped from the auth-mode select."
+ (mt/with-premium-features #{:hosting}
+ (is (= ["sql" "ad-service-principal" "ad-service-principal-certificate"]
+ (auth-mode-values)))))
+ (testing "Off Metabase Cloud, every auth-mode option is offered."
+ (mt/with-premium-features #{}
+ (is (= ["sql" "ad-service-principal" "ad-service-principal-certificate" "ad-managed-identity"]
+ (auth-mode-values)))))))
+
(deftest ^:parallel reject-inherited-disallowed-parameters-in-host-test
(mt/test-driver :sqlserver
(testing "parameters every SQL-JDBC driver disallows are refused in `host` too"