Skip to content

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

Escape quotes in identifiers in set role statements (#73248)

Cam Sauld7959c966039
diff --git a/docs/developers-guide/driver-changelog.md b/docs/developers-guide/driver-changelog.md
index a8642d437cc..7f8f7044c22 100644
--- a/docs/developers-guide/driver-changelog.md
+++ b/docs/developers-guide/driver-changelog.md
@@ -8,6 +8,10 @@ title: Driver interface changelog
- `driver/field-reference-mlv2`, deprecated in 0.57.0, has now been removed.
+- `metabase.driver.sql/set-role-statement` has been deprecated in favor of
+ `metabase.driver.sql-jdbc/set-role-statement`, which takes an additional `java.sql.Connection` parameter, so you use
+ the connection to call `quote_ident()` or similar for identifier quoting/escaping purposes.
+
## Metabase 0.60.0
- Added `validate-impersonated-query` multimethod. This is used for drivers to perform validation on impersonated native queries.
diff --git a/enterprise/backend/test/metabase_enterprise/impersonation/driver_test.clj b/enterprise/backend/test/metabase_enterprise/impersonation/driver_test.clj
index 7a7f40f22e3..1f624c74939 100644
--- a/enterprise/backend/test/metabase_enterprise/impersonation/driver_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/impersonation/driver_test.clj
@@ -469,10 +469,12 @@
:filter [:= $id 2]}))))
(is (thrown?
clojure.lang.ExceptionInfo
- (mt/rows (mt/run-mbql-query venues {:fields [$id $name]}))))
+ (mt/rows (mt/run-mbql-query venues {:fields [$id $name]})))
+ "Should throw permission denied exception")
(is (thrown?
clojure.lang.ExceptionInfo
- (mt/rows (mt/run-mbql-query products)))))
+ (mt/rows (mt/run-mbql-query products)))
+ "Should throw permission denied exception"))
(impersonation.util-test/with-impersonations! {:impersonations [{:db-id (mt/id) :attribute "impersonation_attr"}]
:attributes {"impersonation_attr" role-b}}
(is (= [[1 "Gizmo"]]
diff --git a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
index ea817d7bdf3..33e6d5f4383 100644
--- a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
+++ b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
@@ -314,18 +314,35 @@
(clickhouse-version/is-at-least? 24 4 db)
false))
-(defmethod driver.sql/set-role-statement :clickhouse
- [_ role]
- (let [default-role (driver.sql/default-database-role :clickhouse nil)
- quote-if-needed (fn [r]
- (if (or (re-matches #"\".*\"" r) (= role default-role))
- r
- (format "\"%s\"" r)))
- quoted-role (->> (str/split role #",")
- (map quote-if-needed)
- (str/join ","))
- statement (format "SET ROLE %s" quoted-role)]
- statement))
+(defmethod sql-jdbc/set-role-statement :clickhouse
+ [_driver _conn role]
+ ;; Since Clickhouse does not truly support prepared statements with protocol-level safety and has no
+ ;; `quote_ident()` function or similar, escape/quote the identifier client-side.
+ (let [default-role (driver.sql/default-database-role :clickhouse nil)
+ quote-if-needed (fn [role]
+ (if (or (and (str/starts-with? role "\"")
+ (str/ends-with? role "\""))
+ (= role default-role))
+ role
+ (str \" role \")))
+ escape-double-quotes #(str/replace % #"(?!^)\"(?<!$)" "\"\"")
+ quoted-role (->> (str/split role #",")
+ (map quote-if-needed)
+ (map escape-double-quotes)
+ (str/join ","))]
+ (format "SET ROLE %s" quoted-role)))
+
+(defmethod driver/set-role! :clickhouse
+ [driver ^Connection conn role]
+ (let [sql (sql-jdbc/set-role-statement driver conn role)]
+ ;; there seems to be something weird going on with ClickHouse when using `next.jdbc/execute!` in the default impl
+ ;; to set the role (I'm guessing it's a `PreparedStatement` versus `Statement` issue? So just fall back to doing
+ ;; it this way
+ (when-not (string? sql)
+ (throw (UnsupportedOperationException.
+ "The Clickhouse implementation of metabase.driver/set-role! does not support parameterized statements")))
+ (with-open [stmt (.createStatement ^Connection conn)]
+ (.execute stmt ^String sql))))
(defmethod driver.sql/default-database-role :clickhouse
[_ _]
diff --git a/modules/drivers/clickhouse/test/metabase/driver/clickhouse_impersonation_test.clj b/modules/drivers/clickhouse/test/metabase/driver/clickhouse_impersonation_test.clj
index 4ad1939f635..7008f66be62 100644
--- a/modules/drivers/clickhouse/test/metabase/driver/clickhouse_impersonation_test.clj
+++ b/modules/drivers/clickhouse/test/metabase/driver/clickhouse_impersonation_test.clj
@@ -166,7 +166,6 @@
(ctd/exec-statements grant-statements cluster-port {"wait_end_of_query" "1"})
(t2.with-temp/with-temp [:model/Database db cluster-details]
(mt/with-db db (sync.core/sync-database! db)
-
(letfn [(check-impersonation! [roles expected]
(impersonation.tu/with-impersonations!
{:impersonations [{:db-id (mt/id) :attribute "impersonation_attr"}]
@@ -176,13 +175,11 @@
mt/native-query
mt/process-query
mt/rows)))))]
-
(is (= [["a"] ["b"] ["c"]]
(-> {:query select-query}
mt/native-query
mt/process-query
mt/rows)))
-
(check-impersonation! "row_a" [["a"]])
(check-impersonation! "row_b" [["b"]])
(check-impersonation! "row_c" [["c"]])
diff --git a/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj b/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
index a50a99c7361..4c6913829a2 100644
--- a/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
+++ b/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
@@ -529,3 +529,17 @@
(driver/native-result-metadata :clickhouse broken-query)))
(is (thrown-with-msg? Exception #"SQL parsing failed."
(driver/validate-native-query-fields :clickhouse broken-query)))))))))
+
+(deftest ^:parallel set-role-statement-escape-quotes-test
+ (are [role sql] (= sql
+ (sql-jdbc/set-role-statement :clickhouse nil role))
+ "x" "SET ROLE \"x\""
+ ;; don't re-quote something that already has quotes
+ "\"x\"" "SET ROLE \"x\""
+ ;; split on commas and quote separately
+ "x,y" "SET ROLE \"x\",\"y\""
+ ;; default database role, don't quote
+ "NONE" "SET ROLE NONE"
+ ;; escape double-quotes in the role
+ "x\"; SELECT sleep(10); --" "SET ROLE \"x\"\"; SELECT sleep(10); --\""
+ "\"x\"; SELECT sleep(10); --\"" "SET ROLE \"x\"\"; SELECT sleep(10); --\""))
diff --git a/modules/drivers/redshift/src/metabase/driver/redshift.clj b/modules/drivers/redshift/src/metabase/driver/redshift.clj
index a4e04016d2a..1e6462640c0 100644
--- a/modules/drivers/redshift/src/metabase/driver/redshift.clj
+++ b/modules/drivers/redshift/src/metabase/driver/redshift.clj
@@ -7,6 +7,7 @@
[java-time.api :as t]
[metabase.driver :as driver]
[metabase.driver-api.core :as driver-api]
+ [metabase.driver.postgres :as driver.postgres]
[metabase.driver.sql :as driver.sql]
[metabase.driver.sql-jdbc :as sql-jdbc]
[metabase.driver.sql-jdbc.common :as sql-jdbc.common]
@@ -656,13 +657,13 @@
;;; ----------------------------------------------- Connection Impersonation ------------------------------------------
-(defmethod driver.sql/set-role-statement :redshift
- [_ role]
+(defmethod sql-jdbc/set-role-statement :redshift
+ [driver conn role]
(let [special-chars-pattern #"[^a-zA-Z0-9_]"
- needs-quote (re-find special-chars-pattern role)]
- (if needs-quote
- (format "SET SESSION AUTHORIZATION \"%s\";" role)
- (format "SET SESSION AUTHORIZATION %s;" role))))
+ needs-quote? (re-find special-chars-pattern role)
+ quoted-role (cond->> role
+ needs-quote? (driver.postgres/memoized-quote-identifier driver conn))]
+ (format "SET SESSION AUTHORIZATION %s;" quoted-role)))
(defmethod driver.sql/default-database-role :redshift
[_ _]
diff --git a/modules/drivers/redshift/test/metabase/driver/redshift_test.clj b/modules/drivers/redshift/test/metabase/driver/redshift_test.clj
index c4380ee62a7..cacf46ffc47 100644
--- a/modules/drivers/redshift/test/metabase/driver/redshift_test.clj
+++ b/modules/drivers/redshift/test/metabase/driver/redshift_test.clj
@@ -4,6 +4,7 @@
[clojure.string :as str]
[clojure.test :refer :all]
[metabase.driver :as driver]
+ [metabase.driver.sql-jdbc :as driver.sql-jdbc]
[metabase.driver.sql-jdbc.connection :as sql-jdbc.conn]
[metabase.driver.sql-jdbc.execute :as sql-jdbc.execute]
[metabase.driver.sql-jdbc.sync.describe-table :as sql-jdbc.describe-table]
@@ -711,3 +712,21 @@
(let [multi-field (nth fields 2)]
(is (= "SUPER" (:database_type multi-field)))
(is (= :type/JSON (:effective_type multi-field))))))))
+
+(deftest ^:parallel set-role-statement-test
+ (testing "set-role-statement should return a SET ROLE command, with the role quoted if it contains special characters"
+ (mt/test-driver :redshift
+ (sql-jdbc.execute/do-with-connection-with-options
+ :redshift (mt/id) nil
+ (fn [conn]
+ (are [role expected] (= expected
+ (driver.sql-jdbc/set-role-statement :redshift conn role))
+ "MY_ROLE" "SET SESSION AUTHORIZATION MY_ROLE;"
+ "ROLE123" "SET SESSION AUTHORIZATION ROLE123;"
+ "lowercase_role" "SET SESSION AUTHORIZATION lowercase_role;"
+ "Role.123" "SET SESSION AUTHORIZATION \"Role.123\";"
+ "$role" "SET SESSION AUTHORIZATION \"$role\";"
+ "role\"; SELECT sleep(10); --" "SET SESSION AUTHORIZATION \"role\"\"; SELECT sleep(10); --\";"
+ ;; None (special role in Postgres to revert back to login role; should not be quoted)
+ "none" "SET SESSION AUTHORIZATION none;"
+ "NONE" "SET SESSION AUTHORIZATION NONE;"))))))
diff --git a/modules/drivers/snowflake/src/metabase/driver/snowflake.clj b/modules/drivers/snowflake/src/metabase/driver/snowflake.clj
index 2f3d258bf7d..1cf0882ee8d 100644
--- a/modules/drivers/snowflake/src/metabase/driver/snowflake.clj
+++ b/modules/drivers/snowflake/src/metabase/driver/snowflake.clj
@@ -959,13 +959,9 @@
;;; ------------------------------------------------- User Impersonation --------------------------------------------------
-(defmethod driver.sql/set-role-statement :snowflake
- [_ role]
- (let [special-chars-pattern #"[^a-zA-Z0-9_]"
- needs-quote (re-find special-chars-pattern role)]
- (if needs-quote
- (format "USE ROLE \"%s\";" role)
- (format "USE ROLE %s;" role))))
+(defmethod sql-jdbc/set-role-statement :snowflake
+ [_driver _conn role]
+ ["USE ROLE identifier(?);" role])
(defmethod driver.sql/default-database-role :snowflake
[_ database]
diff --git a/modules/drivers/snowflake/test/metabase/driver/snowflake_test.clj b/modules/drivers/snowflake/test/metabase/driver/snowflake_test.clj
index 1ce354eaff8..399b92f6ff0 100644
--- a/modules/drivers/snowflake/test/metabase/driver/snowflake_test.clj
+++ b/modules/drivers/snowflake/test/metabase/driver/snowflake_test.clj
@@ -11,7 +11,7 @@
[metabase.driver :as driver]
^{:clj-kondo/ignore [:deprecated-namespace]} [metabase.driver.common.parameters :as params]
[metabase.driver.snowflake :as driver.snowflake]
- [metabase.driver.sql :as driver.sql]
+ [metabase.driver.sql-jdbc :as driver.sql-jdbc]
[metabase.driver.sql-jdbc.connection :as sql-jdbc.conn]
[metabase.driver.sql-jdbc.execute :as sql-jdbc.execute]
[metabase.driver.sql-jdbc.sync :as sql-jdbc.sync]
@@ -984,15 +984,14 @@
(:write_data_details db))))))))
(deftest ^:parallel set-role-statement-test
- (testing "set-role-statement should return a USE ROLE command, with the role quoted if it contains special characters"
- ;; No special characters
- (is (= "USE ROLE MY_ROLE;" (driver.sql/set-role-statement :snowflake "MY_ROLE")))
- (is (= "USE ROLE ROLE123;" (driver.sql/set-role-statement :snowflake "ROLE123")))
- (is (= "USE ROLE lowercase_role;" (driver.sql/set-role-statement :snowflake "lowercase_role")))
-
- ;; Special characters
- (is (= "USE ROLE \"Role.123\";" (driver.sql/set-role-statement :snowflake "Role.123")))
- (is (= "USE ROLE \"$role\";" (driver.sql/set-role-statement :snowflake "$role")))))
+ (testing "set-role-statement should return a parameterized USE ROLE command"
+ (are [role expected] (= expected
+ (driver.sql-jdbc/set-role-statement :snowflake nil role))
+ "MY_ROLE" ["USE ROLE identifier(?);" "MY_ROLE"]
+ "ROLE123" ["USE ROLE identifier(?);" "ROLE123"]
+ "lowercase_role" ["USE ROLE identifier(?);" "lowercase_role"]
+ "Role.123" ["USE ROLE identifier(?);" "Role.123"]
+ "$role" ["USE ROLE identifier(?);" "$role"])))
(deftest remark-test
(testing "Queries should have a remark formatted as JSON appended to them with additional metadata"
diff --git a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
index 83e07a7309f..938a860b34c 100644
--- a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
+++ b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
@@ -33,7 +33,9 @@
[metabase.util.json :as json]
[metabase.util.log :as log]
[metabase.util.malli :as mu]
- [metabase.util.performance :as perf :refer [mapv get-in]])
+ [metabase.util.memoize :as memoize]
+ [metabase.util.performance :as perf :refer [mapv get-in]]
+ [next.jdbc :as next.jdbc])
(:import
(java.sql Connection DatabaseMetaData PreparedStatement ResultSet Time)
(java.time LocalDate LocalDateTime LocalTime OffsetDateTime OffsetTime ZonedDateTime)
@@ -1037,10 +1039,19 @@
;; valid database user for impersonation (see issue #60665).
(:role (driver.conn/effective-details database)))
-(defmethod driver.sql/set-role-statement :sqlserver
- [_driver role]
+(def ^{:arglists '([conn s])} memoized-quote-string-literal
+ "Call quotename(?, '''') on SQL Server to quote a string literal, and escape any embedded single quotes, for use
+ with [[sql-jdbc/set-role-statement]] below; presumably this should never change so use a bounded cache to avoid the
+ overhead of calling this on every query."
+ (memoize/bounded
+ (-> (fn [conn s]
+ (:s (next.jdbc/execute-one! conn ["SELECT quotename(?, '''') AS s;" s])))
+ (vary-meta assoc :clojure.core.memoize/args-fn (fn [[_conn s]] s)))))
+
+(defmethod sql-jdbc/set-role-statement :sqlserver
+ [_driver conn role]
;; REVERT to handle the case where the users role attribute has changed
- (format "REVERT; EXECUTE AS USER = '%s';" role))
+ (format "REVERT; EXECUTE AS USER = %s;" (memoized-quote-string-literal conn role)))
(defmethod sql-jdbc/impl-table-known-to-not-exist? :sqlserver
[_ e]
diff --git a/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj b/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
index 3dbaae87801..437ea7219c7 100644
--- a/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
+++ b/modules/drivers/sqlserver/test/metabase/driver/sqlserver_test.clj
@@ -10,6 +10,7 @@
[metabase.driver-api.core :as driver-api]
[metabase.driver.common :as driver.common]
[metabase.driver.sql :as driver.sql]
+ [metabase.driver.sql-jdbc :as driver.sql-jdbc]
[metabase.driver.sql-jdbc.connection :as sql-jdbc.conn]
[metabase.driver.sql-jdbc.execute :as sql-jdbc.execute]
[metabase.driver.sql-jdbc.sync :as sql-jdbc.sync]
@@ -912,3 +913,11 @@
privileges)]
(when (seq dbo-orders)
(is (every? :select dbo-orders)))))))))))
+
+(deftest ^:parallel set-role-statement-escape-quotes-test
+ (mt/test-driver :sqlserver
+ (is (= "REVERT; EXECUTE AS USER = 'role''; SELECT sleep(10); --';"
+ (sql-jdbc.execute/do-with-connection-with-options
+ :sqlserver (mt/id) nil
+ (fn [conn]
+ (driver.sql-jdbc/set-role-statement :sqlserver conn "role'; SELECT sleep(10); --")))))))
diff --git a/src/metabase/driver.clj b/src/metabase/driver.clj
index d4906419a2b..da8ebb373a0 100644
--- a/src/metabase/driver.clj
+++ b/src/metabase/driver.clj
@@ -1394,6 +1394,8 @@
dispatch-on-initialized-driver
:hierarchy #'hierarchy)
+;;; TODO (Cam 2026-05-04) -- this is JDBC-specific, should be moved to [[metabase.driver.sql-jdbc]] or one of its
+;;; sub-namespaces
(defmulti set-role!
"Sets the database role used on a connection. Called prior to query execution for drivers that support connection
impersonation (an EE-only feature)."
diff --git a/src/metabase/driver/mysql.clj b/src/metabase/driver/mysql.clj
index d88a26a4ff7..490aafc7544 100644
--- a/src/metabase/driver/mysql.clj
+++ b/src/metabase/driver/mysql.clj
@@ -34,7 +34,9 @@
[metabase.util.i18n :refer [deferred-tru tru]]
[metabase.util.log :as log]
[metabase.util.malli :as mu]
- [metabase.util.performance :as perf :refer [get-in not-empty some]])
+ [metabase.util.memoize :as memoize]
+ [metabase.util.performance :as perf :refer [get-in not-empty some]]
+ [next.jdbc :as next.jdbc])
(:import
(java.io File)
(java.sql Connection DatabaseMetaData ResultSet ResultSetMetaData SQLException Statement Types)
@@ -1206,9 +1208,27 @@
[_driver database]
(-> database driver.conn/effective-details :role))
-(defmethod driver.sql/set-role-statement :mysql
- [_driver role]
- (format "SET ROLE '%s';" role))
+(def ^{:arglists '([conn s])} memoized-quote-string-literal
+ "Call quotename(?, '''') on MySQL to quote a string literal, and escape any embedded single quotes, for use
+ with [[sql-jdbc/set-role-statement]] below; presumably this should never change so use a bounded cache to avoid the
+ overhead of calling this on every query."
+ (memoize/bounded
+ (-> (fn [conn s]
+ (:s (next.jdbc/execute-one! conn ["SELECT quote(?) AS s;" s])))
+ (vary-meta assoc :clojure.core.memoize/args-fn (fn [[_conn s]] s)))))
+
+(defn- quote-role
+ "MySQL allows roles like `webapp@localhost`, and the correct way to quote that is `'webapp'@'localhost'."
+ [conn role]
+ (let [parts (->> (str/split role #"@" 2)
+ (map (partial memoized-quote-string-literal conn)))]
+ (if (= (count parts) 2)
+ (str (first parts) \@ (second parts))
+ (first parts))))
+
+(defmethod sql-jdbc/set-role-statement :mysql
+ [_driver conn role]
+ (format "SET ROLE %s;" (quote-role conn role)))
(defmethod sql-jdbc/impl-table-known-to-not-exist? :mysql
[_ e]
diff --git a/src/metabase/driver/postgres.clj b/src/metabase/driver/postgres.clj
index d7611d74148..a13ec8b6b1d 100644
--- a/src/metabase/driver/postgres.clj
+++ b/src/metabase/driver/postgres.clj
@@ -21,8 +21,7 @@
[metabase.driver.sql-jdbc.common :as sql-jdbc.common]
[metabase.driver.sql-jdbc.connection :as sql-jdbc.conn]
[metabase.driver.sql-jdbc.execute :as sql-jdbc.execute]
- [metabase.driver.sql-jdbc.quoting :refer [quote-columns quote-identifier
- with-quoting]]
+ [metabase.driver.sql-jdbc.quoting :refer [quote-columns quote-identifier with-quoting]]
[metabase.driver.sql-jdbc.sync :as sql-jdbc.sync]
[metabase.driver.sql-jdbc.sync.describe-database :as sql-jdbc.describe-database]
[metabase.driver.sql.query-processor :as sql.qp]
@@ -35,16 +34,13 @@
[metabase.util.i18n :refer [trs tru]]
[metabase.util.log :as log]
[metabase.util.malli :as mu]
- [metabase.util.performance :as perf :refer [some select-keys mapv not-empty]]
+ [metabase.util.memoize :as memoize]
+ [metabase.util.performance :as perf :refer [mapv not-empty select-keys some]]
+ [next.jdbc :as next.jdbc]
[taoensso.nippy :as nippy])
(:import
(java.io DataInput DataOutput StringReader)
- (java.sql
- Connection
- ResultSet
- ResultSetMetaData
- Statement
- Types)
+ (java.sql Connection ResultSet ResultSetMetaData Statement Types)
(java.time LocalDateTime OffsetDateTime OffsetTime)
(org.apache.commons.codec.binary Hex)
(org.postgresql.copy CopyManager)
@@ -1284,13 +1280,23 @@
;;; ------------------------------------------------- User Impersonation --------------------------------------------------
-(defmethod driver.sql/set-role-statement :postgres
- [_ role]
+(def ^{:arglists '([driver conn role])} memoized-quote-identifier
+ "Call `quote_ident(?) on Postgres to quote an identifier; presumably this should never change so use a bounded cache
+ to avoid the overhead of calling this on every query.
+
+ Takes `driver` as a parameter so this function can also be used by Redshift without sharing the same cache."
+ (memoize/bounded
+ (-> (fn [_driver conn role]
+ (:quote_ident (next.jdbc/execute-one! conn ["SELECT quote_ident(?);" role])))
+ (vary-meta assoc :clojure.core.memoize/args-fn (fn [[driver _conn role]] [driver role])))))
+
+(defmethod sql-jdbc/set-role-statement :postgres
+ [driver conn role]
(let [special-chars-pattern #"[^a-zA-Z0-9_]"
- needs-quote (re-find special-chars-pattern role)]
- (if needs-quote
- (format "SET ROLE \"%s\";" role)
- (format "SET ROLE %s;" role))))
+ needs-quote? (re-find special-chars-pattern role)
+ quoted-role (cond->> role
+ needs-quote? (memoized-quote-identifier driver conn))]
+ (format "SET ROLE %s;" quoted-role)))
(defmethod driver.sql/default-database-role :postgres
[_ _]
diff --git a/src/metabase/driver/sql.clj b/src/metabase/driver/sql.clj
index db907fc8a00..0971d402e07 100644
--- a/src/metabase/driver/sql.clj
+++ b/src/metabase/driver/sql.clj
@@ -100,13 +100,16 @@
;;; +----------------------------------------------------------------------------------------------------------------+
(defmulti set-role-statement
- "SQL for setting the active role for a connection, such as USE ROLE or equivalent, for the given driver."
- {:added "0.47.0" :arglists '([driver role])}
+ "SQL for setting the active role for a connection, such as USE ROLE or equivalent, for the given driver.
+
+ DEPRECATED: prefer [[metabase.driver.sql-jdbc/set-role-statement]] going forward."
+ {:added "0.47.0", :deprecated "0.61.0", :arglists '([driver role])}
driver/dispatch-on-initialized-driver
:hierarchy #'driver/hierarchy)
+#_{:clj-kondo/ignore [:deprecated-var]}
(defmethod set-role-statement :default
- [_ _ _]
+ [_driver _role]
nil)
(defmulti default-database-role
diff --git a/src/metabase/driver/sql/util.clj b/src/metabase/driver/sql/util.clj
index 3625dc657d2..765c0fae3ee 100644
--- a/src/metabase/driver/sql/util.clj
+++ b/src/metabase/driver/sql/util.clj
@@ -104,6 +104,7 @@
:else
(recur (conj already-seen alias) (conj acc [col alias]) more)))))
+;;; TODO (Cam 2026-04-27) -- rename this to `escape-single-quotes` to make it clearer what we're escaping
(defn escape-sql
"Escape single quotes in a SQL string. `escape-style` is either `:ansi` (escape a single quote with two single quotes)
or `:backslashes` (escape a single quote with a backslash).
diff --git a/src/metabase/driver/sql_jdbc.clj b/src/metabase/driver/sql_jdbc.clj
index 6c34d12a442..6fe05c585e3 100644
--- a/src/metabase/driver/sql_jdbc.clj
+++ b/src/metabase/driver/sql_jdbc.clj
@@ -22,7 +22,8 @@
[metabase.util.honey-sql-2 :as h2x]
[metabase.util.i18n :refer [tru]]
[metabase.util.malli :as mu]
- [metabase.util.performance :refer [mapv]])
+ [metabase.util.performance :refer [mapv]]
+ [next.jdbc])
(:import
(java.sql Connection SQLException SQLTimeoutException)))
@@ -300,11 +301,36 @@
exclusion-patterns] (driver.s/db-details->schema-filter-patterns database)]
(into #{} (sql-jdbc.sync/filtered-syncable-schemas driver conn (.getMetaData conn) inclusion-patterns exclusion-patterns))))))
+(defmulti set-role-statement
+ "SQL for setting the active role for a Connection, such as USE ROLE or equivalent, for the given driver.
+
+ The currently open `java.sql.Connection` is provided so we can use things like
+
+ ```sql
+ SELECT quote_ident(?)
+ ```
+
+ to quote identifiers as needed.
+
+ This may either return a raw SQL string, or `[sql & args]` to be passed in to a parameterized statement. It is
+ preferable to pass the role separately whenever possible to prevent possible SQL injection issues."
+ {:added "0.61.0" :arglists '([driver ^java.sql.Connection connection ^String role])}
+ driver/dispatch-on-initialized-driver
+ :hierarchy #'driver/hierarchy)
+
+(defmethod set-role-statement :default
+ [driver _connection role]
+ ;; fall back to implementations of the deprecated `:sql` driver method
+ #_{:clj-kondo/ignore [:deprecated-var]}
+ (driver.sql/set-role-statement driver role))
+
(defmethod driver/set-role! :sql-jdbc
- [driver conn role]
- (let [sql (driver.sql/set-role-statement driver role)]
- (with-open [stmt (.createStatement ^Connection conn)]
- (.execute stmt sql))))
+ [driver ^Connection conn role]
+ (let [sql-args (set-role-statement driver conn role)
+ sql-args (if (string? sql-args)
+ [sql-args]
+ sql-args)]
+ (next.jdbc/execute! conn sql-args)))
(defmethod driver/current-user-table-privileges :sql-jdbc
[driver database & {:as args}]
diff --git a/src/metabase/driver/sql_jdbc/execute.clj b/src/metabase/driver/sql_jdbc/execute.clj
index 78d6c2e0352..3c18f5b7fb9 100644
--- a/src/metabase/driver/sql_jdbc/execute.clj
+++ b/src/metabase/driver/sql_jdbc/execute.clj
@@ -63,7 +63,7 @@
;; a string like 'US/Pacific' or something like that.
[:session-timezone {:optional true} [:maybe [:ref driver-api/schema.expression.temporal.timezone-id]]]
;; whether this Connection should NOT be read-only, e.g. for DDL stuff or inserting data or whatever.
- [:write? {:optional true} [:maybe :boolean]]
+ [:write? {:optional true, :default false} [:maybe :boolean]]
[:download? {:optional true} [:maybe :boolean]]
;; true if called from table-rows-sample-query
[:sample? {:optional true} [:maybe :boolean]]
@@ -246,7 +246,7 @@
(defenterprise set-role-if-supported!
"OSS no-op implementation of `set-role-if-supported!`."
metabase-enterprise.impersonation.driver
- [_ _ _])
+ [_driver _conn _database])
;; TODO - since we're not running the queries in a transaction, does this make any difference at all? (metabase#40012)
(defn set-best-transaction-level!
diff --git a/test/metabase/driver/mysql_test.clj b/test/metabase/driver/mysql_test.clj
index 0501376237c..75347183a00 100644
--- a/test/metabase/driver/mysql_test.clj
+++ b/test/metabase/driver/mysql_test.clj
@@ -13,6 +13,7 @@
[metabase.driver.mysql :as mysql]
[metabase.driver.mysql.actions :as mysql.actions]
[metabase.driver.mysql.ddl :as mysql.ddl]
+ [metabase.driver.sql-jdbc :as driver.sql-jdbc]
[metabase.driver.sql-jdbc.actions :as sql-jdbc.actions]
[metabase.driver.sql-jdbc.actions-test :as sql-jdbc.actions-test]
[metabase.driver.sql-jdbc.connection :as sql-jdbc.conn]
@@ -1056,3 +1057,16 @@
"allowUrlInLocalInfile=1"
"autoDeserialize=1"
"serverRSAPublicKeyFile=/path/to/file")))
+
+(deftest ^:parallel set-role-statement-escape-quotes-test
+ (mt/test-driver :mysql
+ (sql-jdbc.execute/do-with-connection-with-options
+ :mysql (mt/id) nil
+ (fn [conn]
+ (are [role expected] (= expected
+ (driver.sql-jdbc/set-role-statement :mysql conn role))
+ "role'; SELECT sleep(10); --"
+ "SET ROLE 'role\\'; SELECT sleep(10); --';"
+
+ "webapp@localhost"
+ "SET ROLE 'webapp'@'localhost';")))))
diff --git a/test/metabase/driver/postgres_test.clj b/test/metabase/driver/postgres_test.clj
index 76972a9ef58..882a28d0113 100644
--- a/test/metabase/driver/postgres_test.clj
+++ b/test/metabase/driver/postgres_test.clj
@@ -16,7 +16,7 @@
[metabase.driver.postgres :as postgres]
[metabase.driver.postgres.actions :as postgres.actions]
[metabase.driver.settings :as driver.settings]
- [metabase.driver.sql :as driver.sql]
+ [metabase.driver.sql-jdbc :as driver.sql-jdbc]
[metabase.driver.sql-jdbc.actions :as sql-jdbc.actions]
[metabase.driver.sql-jdbc.actions-test :as sql-jdbc.actions-test]
[metabase.driver.sql-jdbc.connection :as sql-jdbc.conn]
@@ -1724,18 +1724,21 @@
(deftest ^:parallel set-role-statement-test
(testing "set-role-statement should return a SET ROLE command, with the role quoted if it contains special characters"
- ;; No special characters
- (is (= "SET ROLE MY_ROLE;" (driver.sql/set-role-statement :postgres "MY_ROLE")))
- (is (= "SET ROLE ROLE123;" (driver.sql/set-role-statement :postgres "ROLE123")))
- (is (= "SET ROLE lowercase_role;" (driver.sql/set-role-statement :postgres "lowercase_role")))
-
- ;; None (special role in Postgres to revert back to login role; should not be quoted)
- (is (= "SET ROLE none;" (driver.sql/set-role-statement :postgres "none")))
- (is (= "SET ROLE NONE;" (driver.sql/set-role-statement :postgres "NONE")))
-
- ;; Special characters
- (is (= "SET ROLE \"Role.123\";" (driver.sql/set-role-statement :postgres "Role.123")))
- (is (= "SET ROLE \"$role\";" (driver.sql/set-role-statement :postgres "$role")))))
+ (mt/test-driver :postgres
+ (sql-jdbc.execute/do-with-connection-with-options
+ :postgres (mt/id) nil
+ (fn [conn]
+ (are [role expected] (= expected
+ (driver.sql-jdbc/set-role-statement :postgres conn role))
+ "MY_ROLE" "SET ROLE MY_ROLE;"
+ "ROLE123" "SET ROLE ROLE123;"
+ "lowercase_role" "SET ROLE lowercase_role;"
+ "Role.123" "SET ROLE \"Role.123\";"
+ "$role" "SET ROLE \"$role\";"
+ "role\"; SELECT sleep(10); --" "SET ROLE \"role\"\"; SELECT sleep(10); --\";"
+ ;; None (special role in Postgres to revert back to login role; should not be quoted)
+ "none" "SET ROLE none;"
+ "NONE" "SET ROLE NONE;"))))))
(deftest get-tables-parity-with-jdbc-test
(testing "make sure our get-tables return result consistent with jdbc getTables"
@@ -2226,9 +2229,7 @@
(.execute stmt "SELECT pg_sleep(6)")))))))))
(deftest ^:parallel parse-final-identifier-test
- (mt/test-driver
- :postgres
-
+ (mt/test-driver :postgres
(testing "`final` is allowed as identifier and parsed correctly"
(mt/with-temp [:model/Database db {:engine "postgres"
:name "final"
diff --git a/test/metabase/test/data/interface.clj b/test/metabase/test/data/interface.clj
index ed4ec77341b..ce18c05ec72 100644
--- a/test/metabase/test/data/interface.clj
+++ b/test/metabase/test/data/interface.clj
@@ -449,6 +449,7 @@
(defmacro with-temp-roles!
"Creates the given roles and permissions for the database user, and drops them after execution"
+ {:style/indent :defn}
[driver details roles db-user default-role & body]
`(with-temp-roles-fn!
~driver