Skip to content

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

Use safe identifier quoting in workspace grant statements (#70869)

Ngoc Khuat8454245aaab7
diff --git a/enterprise/backend/test/metabase_enterprise/workspaces/isolation_test.clj b/enterprise/backend/test/metabase_enterprise/workspaces/isolation_test.clj
index 5a52452fb53..c27165abab2 100644
--- a/enterprise/backend/test/metabase_enterprise/workspaces/isolation_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/workspaces/isolation_test.clj
@@ -7,6 +7,7 @@
[metabase-enterprise.workspaces.util :as ws.u]
[metabase.driver :as driver]
[metabase.driver.sql-jdbc.connection :as sql-jdbc.conn]
+ [metabase.driver.sql.util :as sql.u]
[metabase.driver.util :as driver.u]
[metabase.lib.core :as lib]
[metabase.test :as mt]
@@ -203,3 +204,63 @@
database
nil))
"Should succeed when test-table is nil")))))
+
+;;; Identifier quoting tests for grant-workspace-read-access!
+
+(defn- with-pg-isolation!
+ "Set up Postgres workspace isolation manually and call f with [workspace conn-spec].
+ Tears down isolation resources afterward."
+ [f]
+ (let [database (mt/db)
+ test-ws {:id (str (random-uuid))
+ :name "_test_quoting_"}
+ init-result (driver/init-workspace-isolation! :postgres database test-ws)
+ workspace (merge test-ws init-result)
+ conn-spec (sql-jdbc.conn/db->pooled-connection-spec (:id database))]
+ (try
+ (f workspace conn-spec)
+ (finally
+ (driver/destroy-workspace-isolation! :postgres database workspace)))))
+
+(defn- pg-create-table!
+ "Create a table in Postgres using properly-escaped DDL."
+ [conn-spec schema table-name]
+ (let [qs (sql.u/quote-name :postgres :schema schema)
+ qt (sql.u/quote-name :postgres :table table-name)]
+ (jdbc/execute! conn-spec [(format "CREATE TABLE %s.%s (id INT)" qs qt)])))
+
+(defn- pg-drop-schema!
+ [conn-spec schema]
+ (jdbc/execute! conn-spec [(format "DROP SCHEMA IF EXISTS %s CASCADE"
+ (sql.u/quote-name :postgres :schema schema))]))
+
+(deftest grant-workspace-read-access-escapes-table-names-test
+ (mt/test-driver :postgres
+ (testing "table names with embedded delimiter are properly quoted"
+ (with-pg-isolation!
+ (fn [workspace conn-spec]
+ (let [ws-schema (:schema workspace)
+ evil-name "evil\"table"]
+ (pg-create-table! conn-spec ws-schema evil-name)
+ (is (driver/grant-workspace-read-access!
+ :postgres (mt/db) workspace
+ [{:schema ws-schema :name evil-name}])
+ "GRANT should succeed for table names with embedded quotes")))))))
+
+(deftest grant-workspace-read-access-escapes-schema-names-test
+ (mt/test-driver :postgres
+ (testing "schema names with embedded delimiter are properly quoted"
+ (with-pg-isolation!
+ (fn [workspace conn-spec]
+ (let [evil-schema "evil\"schema"
+ table-name "normal_table"]
+ (jdbc/execute! conn-spec [(format "CREATE SCHEMA %s"
+ (sql.u/quote-name :postgres :schema evil-schema))])
+ (try
+ (pg-create-table! conn-spec evil-schema table-name)
+ (is (driver/grant-workspace-read-access!
+ :postgres (mt/db) workspace
+ [{:schema evil-schema :name table-name}])
+ "GRANT should succeed for schema names with embedded quotes")
+ (finally
+ (pg-drop-schema! conn-spec evil-schema)))))))))
diff --git a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
index 65fbf3605ec..e031bcc5e3d 100644
--- a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
+++ b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
@@ -390,11 +390,12 @@
(defmethod driver/grant-workspace-read-access! :clickhouse
[_driver database workspace tables]
(let [read-user-name (-> workspace :database_details :user)
+ qu (sql.u/quote-name :clickhouse :field read-user-name)
sqls (for [table tables]
- (format "GRANT SELECT ON `%s`.`%s` TO `%s`"
- (:schema table)
- (:name table)
- read-user-name))]
+ (format "GRANT SELECT ON %s.%s TO %s"
+ (sql.u/quote-name :clickhouse :schema (:schema table))
+ (sql.u/quote-name :clickhouse :table (:name table))
+ qu))]
(when-not read-user-name
(throw (ex-info "Workspace isolation is not properly initialized - missing read user name"
{:workspace-id (:id workspace) :step :grant})))
diff --git a/modules/drivers/snowflake/src/metabase/driver/snowflake.clj b/modules/drivers/snowflake/src/metabase/driver/snowflake.clj
index f40151c3e1c..f67233125cc 100644
--- a/modules/drivers/snowflake/src/metabase/driver/snowflake.clj
+++ b/modules/drivers/snowflake/src/metabase/driver/snowflake.clj
@@ -1083,14 +1083,19 @@
(when-not role-name
(throw (ex-info "Workspace isolation is not properly initialized - missing role name"
{:workspace-id (:id workspace) :step :grant})))
- ;; Grant USAGE on each unique schema first (required to access tables within)
- (doseq [schema (distinct (map :schema tables))]
- (jdbc/execute! conn-spec [(format "GRANT USAGE ON SCHEMA \"%s\".\"%s\" TO ROLE \"%s\""
- db-name schema role-name)]))
- ;; Grant SELECT on each specific table
- (doseq [table tables]
- (jdbc/execute! conn-spec [(format "GRANT SELECT ON TABLE \"%s\".\"%s\".\"%s\" TO ROLE \"%s\""
- db-name (:schema table) (:name table) role-name)]))))
+ (let [qdb (sql.u/quote-name :snowflake :schema db-name)
+ qr (sql.u/quote-name :snowflake :field role-name)]
+ ;; Grant USAGE on each unique schema first (required to access tables within)
+ (doseq [schema (distinct (map :schema tables))]
+ (jdbc/execute! conn-spec [(format "GRANT USAGE ON SCHEMA %s.%s TO ROLE %s"
+ qdb (sql.u/quote-name :snowflake :schema schema) qr)]))
+ ;; Grant SELECT on each specific table
+ (doseq [table tables]
+ (jdbc/execute! conn-spec [(format "GRANT SELECT ON TABLE %s.%s.%s TO ROLE %s"
+ qdb
+ (sql.u/quote-name :snowflake :schema (:schema table))
+ (sql.u/quote-name :snowflake :table (:name table))
+ qr)])))))
(defmethod driver/llm-sql-dialect-resource :snowflake [_]
"llm/prompts/dialects/snowflake.md")
diff --git a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
index e5587f124db..182d90349dc 100644
--- a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
+++ b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj
@@ -1172,9 +1172,12 @@
(throw (ex-info "Workspace isolation is not properly initialized - missing read user name"
{:workspace-id (:id workspace) :step :grant})))
;; Grant SELECT on each specific table only - no schema-level grants
- (doseq [table tables]
- (jdbc/execute! conn-spec [(format "GRANT SELECT ON [%s].[%s] TO [%s]"
- (:schema table) (:name table) username)]))))
+ (let [qu (sql.u/quote-name :sqlserver :field username)]
+ (doseq [table tables]
+ (jdbc/execute! conn-spec [(format "GRANT SELECT ON %s.%s TO %s"
+ (sql.u/quote-name :sqlserver :schema (:schema table))
+ (sql.u/quote-name :sqlserver :table (:name table))
+ qu)])))))
(defmethod driver/llm-sql-dialect-resource :sqlserver [_]
"llm/prompts/dialects/sqlserver.md")
diff --git a/src/metabase/driver/h2.clj b/src/metabase/driver/h2.clj
index 3c1fba0c5c8..163a071a532 100644
--- a/src/metabase/driver/h2.clj
+++ b/src/metabase/driver/h2.clj
@@ -21,6 +21,7 @@
[metabase.driver.sql.normalize :as sql.normalize]
[metabase.driver.sql.query-processor :as sql.qp]
[metabase.driver.sql.query-processor.like-escape-char-built-in :as like-escape-char-built-in]
+ [metabase.driver.sql.util :as sql.u]
[metabase.driver.util :as driver.u]
[metabase.lib.schema.id :as lib.schema.id]
[metabase.lib.schema.metadata :as lib.schema.metadata]
@@ -733,18 +734,21 @@
(defmethod driver/grant-workspace-read-access! :h2
[_driver database workspace tables]
(let [username (-> workspace :database_details :db get-user-from-connection-string)
+ qu (sql.u/quote-name :h2 :field username)
schemas (distinct (map :schema tables))]
;; H2 uses GRANT SELECT ON SCHEMA schemaName TO userName
(jdbc/with-db-transaction [t-conn (sql-jdbc.conn/db->pooled-connection-spec (:id database))]
(with-open [^Statement stmt (.createStatement ^Connection (:connection t-conn))]
(doseq [schema schemas]
(.addBatch ^Statement stmt
- ^String (format "GRANT SELECT ON SCHEMA \"%s\" TO \"%s\"" schema username)))
+ ^String (format "GRANT SELECT ON SCHEMA %s TO %s"
+ (sql.u/quote-name :h2 :schema schema) qu)))
;; Also grant on individual tables for more fine-grained access
(doseq [table tables]
(.addBatch ^Statement stmt
- ^String (format "GRANT SELECT ON \"%s\".\"%s\" TO \"%s\""
- (:schema table) (:name table) username)))
+ ^String (format "GRANT SELECT ON %s.%s TO %s"
+ (sql.u/quote-name :h2 :schema (:schema table))
+ (sql.u/quote-name :h2 :table (:name table)) qu)))
(.executeBatch ^Statement stmt)))))
(defmethod driver/llm-sql-dialect-resource :h2 [_]
diff --git a/src/metabase/driver/mysql.clj b/src/metabase/driver/mysql.clj
index 33a6b7d8dc8..6c000236b2e 100644
--- a/src/metabase/driver/mysql.clj
+++ b/src/metabase/driver/mysql.clj
@@ -1277,12 +1277,16 @@
(defmethod driver/grant-workspace-read-access! :mysql
[_driver database workspace tables]
(let [username (-> workspace :database_details :user)
+ qu (sql.u/quote-name :mysql :field username)
;; In MySQL, tables don't have separate schemas within a database,
;; but the :schema field contains the source database name
sqls (for [{db :schema, t :name} tables]
(if (str/blank? db)
- (format "GRANT SELECT ON `%s` TO `%s`@'%%'" t username)
- (format "GRANT SELECT ON `%s`.`%s` TO `%s`@'%%'" db t username)))]
+ (format "GRANT SELECT ON %s TO %s@'%%'"
+ (sql.u/quote-name :mysql :table t) qu)
+ (format "GRANT SELECT ON %s.%s TO %s@'%%'"
+ (sql.u/quote-name :mysql :schema db)
+ (sql.u/quote-name :mysql :table t) qu)))]
(jdbc/with-db-transaction [t-conn (sql-jdbc.conn/db->pooled-connection-spec (:id database))]
(with-open [^Statement stmt (.createStatement ^Connection (:connection t-conn))]
(doseq [sql sqls]
diff --git a/src/metabase/driver/postgres.clj b/src/metabase/driver/postgres.clj
index b283bed12cd..5c12c33551c 100644
--- a/src/metabase/driver/postgres.clj
+++ b/src/metabase/driver/postgres.clj
@@ -1368,6 +1368,7 @@
(defmethod driver/grant-workspace-read-access! :postgres
[_driver database workspace tables]
(let [username (-> workspace :database_details :user)
+ qu (sql.u/quote-name :postgres :field username)
;; Collect all unique source schemas that contain the tables we need to grant access to
source-schemas (into #{} (keep :schema) tables)
;; Grant USAGE on source schemas, then SELECT on each table
@@ -1375,12 +1376,16 @@
sqls (concat
;; USAGE on each source schema containing tables we're granting access to
(for [s source-schemas]
- (format "GRANT USAGE ON SCHEMA \"%s\" TO \"%s\"" s username))
+ (format "GRANT USAGE ON SCHEMA %s TO %s"
+ (sql.u/quote-name :postgres :schema s) qu))
;; SELECT on each table
(for [{s :schema, t :name} tables]
(if (str/blank? s)
- (format "GRANT SELECT ON TABLE \"%s\" TO \"%s\"" t username)
- (format "GRANT SELECT ON TABLE \"%s\".\"%s\" TO \"%s\"" s t username))))]
+ (format "GRANT SELECT ON TABLE %s TO %s"
+ (sql.u/quote-name :postgres :table t) qu)
+ (format "GRANT SELECT ON TABLE %s.%s TO %s"
+ (sql.u/quote-name :postgres :schema s)
+ (sql.u/quote-name :postgres :table t) qu))))]
(jdbc/with-db-transaction [t-conn (sql-jdbc.conn/db->pooled-connection-spec (:id database))]
(with-open [^Statement stmt (.createStatement ^Connection (:connection t-conn))]
(doseq [sql sqls]