The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Reject multi statement queries (#71573)
Riley Thompsonbdda38ff1791
diff --git a/docs/developers-guide/driver-changelog.md b/docs/developers-guide/driver-changelog.mdindex bd6856199cb..95838324cf3 100644--- a/docs/developers-guide/driver-changelog.md+++ b/docs/developers-guide/driver-changelog.md@@ -4,6 +4,11 @@ title: Driver interface changelog# Driver Interface Changelog+## Metabase 0.60.0++- Added `validate-impersonated-query` multimethod. This is used for drivers to perform validation on impersonated native queries.+ It should return the query if it is valid and throw otherwise.+## Metabase 0.59.0- Added `sql-jdbc.execute/db-type-name` multimethod. Override this method to customize how your SQL JDBC driverdiff --git a/e2e/test/scenarios/actions/model-actions.cy.spec.js b/e2e/test/scenarios/actions/model-actions.cy.spec.jsindex b0e8e3b7fe4..02b1cbe6c4c 100644--- a/e2e/test/scenarios/actions/model-actions.cy.spec.js+++ b/e2e/test/scenarios/actions/model-actions.cy.spec.js@@ -773,7 +773,7 @@ describe(cy.button(SAMPLE_QUERY_ACTION.name).click();cy.findByText(- "Error executing Action: Error executing write query: ERROR: permission denied for table scoreboard_actions",+ /Error executing Action:.*Invalid impersonated native query\. Must be a single select statement\./,);});diff --git a/enterprise/backend/src/metabase_enterprise/impersonation/middleware.clj b/enterprise/backend/src/metabase_enterprise/impersonation/middleware.cljindex 6d7f4198c18..8184b717f2f 100644--- a/enterprise/backend/src/metabase_enterprise/impersonation/middleware.clj+++ b/enterprise/backend/src/metabase_enterprise/impersonation/middleware.clj@@ -1,6 +1,7 @@(ns metabase-enterprise.impersonation.middleware(:require[metabase-enterprise.impersonation.driver :as impersonation.driver]+ [metabase.driver :as driver][metabase.lib.metadata :as lib.metadata][metabase.premium-features.core :as premium-features :refer [defenterprise]][metabase.query-processor.interface :as qp.i]@@ -19,7 +20,8 @@(lib.metadata/database (qp.store/metadata-provider))))](do(premium-features/assert-has-feature :advanced-permissions (tru "Advanced Permissions"))- (assoc query :impersonation/role role))+ (-> (driver/validate-impersonated-query driver/*driver* query)+ (assoc :impersonation/role role)))query))(defenterprise apply-impersonation-postprocessingdiff --git a/enterprise/backend/test/metabase_enterprise/impersonation/driver_test.clj b/enterprise/backend/test/metabase_enterprise/impersonation/driver_test.cljindex 978d91fc081..9bfa7e68176 100644--- a/enterprise/backend/test/metabase_enterprise/impersonation/driver_test.clj+++ b/enterprise/backend/test/metabase_enterprise/impersonation/driver_test.clj@@ -1,7 +1,6 @@(ns ^:mb/driver-tests metabase-enterprise.impersonation.driver-test(:require[clojure.java.jdbc :as jdbc]- [clojure.set :as set][clojure.string :as str][clojure.test :refer :all][metabase-enterprise.impersonation.driver :as impersonation.driver]@@ -13,6 +12,9 @@[metabase.driver.settings :as driver.settings][metabase.driver.sql-jdbc.connection :as sql-jdbc.conn][metabase.driver.sql-jdbc.execute :as sql-jdbc.execute]+ [metabase.lib.core :as lib]+ [metabase.lib.metadata :as lib.metadata]+ [metabase.query-processor.compile :as qp.compile][metabase.query-processor.test :as qp][metabase.request.core :as request][metabase.sync.core :as sync]@@ -436,8 +438,7 @@(mt/rows (mt/run-mbql-query venues))))))))))))(deftest conn-impersonation-column-and-row-test- (mt/test-drivers (set/intersection (mt/normal-drivers-with-feature :test/rls-impersonation)- (mt/normal-drivers-with-feature :test/column-impersonation))+ (mt/test-drivers (mt/normal-driver-select {:+features [:test/rls-impersonation :test/column-impersonation]})(mt/with-premium-features #{:advanced-permissions}(let [venues-table (sql.tx/qualify-and-quote driver/*driver* "test-data" "venues")products-table (sql.tx/qualify-and-quote driver/*driver* "test-data" "products")@@ -926,3 +927,47 @@java.lang.Exception(mt/run-mbql-query checkins{:aggregation [[:count]]}))))))))))))++(deftest reject-multiple-and-non-select-statements-impersonation-test+ (testing "Impersonated native queries with multiple or non-select statements are rejected under impersonation"+ (mt/test-drivers (mt/normal-drivers-with-feature :connection-impersonation)+ (mt/with-premium-features #{:advanced-permissions}+ (let [venues-table (sql.tx/qualify-and-quote driver/*driver* "test-data" "venues")+ role-a (u/lower-case-en (mt/random-name))]+ (tx/with-temp-roles! driver/*driver*+ (impersonation-granting-details driver/*driver* (mt/db))+ {role-a {venues-table {}}}+ (impersonation-default-user driver/*driver*)+ (impersonation-default-role driver/*driver*)+ (mt/with-temp [:model/Database database {:engine driver/*driver*,+ :details (impersonation-details driver/*driver* (mt/db))}]+ (mt/with-db database+ (when (driver/database-supports? driver/*driver* :connection-impersonation-requires-role nil)+ (t2/update! :model/Database :id (mt/id) (assoc-in (mt/db) [:details :role] (impersonation-default-role driver/*driver*))))+ (sync/sync-database! database {:scan :schema})+ (impersonation.util-test/with-impersonations! {:impersonations [{:db-id (mt/id) :attribute "impersonation_attr"}]+ :attributes {"impersonation_attr" role-a}}+ (testing "A single SELECT statement works with normal impersonation"+ (let [mp (mt/metadata-provider)+ run-native-query (fn [table] (->> (-> (lib/query mp (lib.metadata/table mp (mt/id table)))+ (lib/aggregate (lib/count)))+ (qp.compile/compile-with-inline-parameters)+ :query+ (lib/native-query mp)+ (qp/process-query)+ (mt/rows)))]+ (is (= [[100]] (run-native-query :venues)))+ (is (thrown? java.lang.Exception (run-native-query :checkins)))))+ (testing "All other queries are rejected"+ (are [sql] (thrown?+ java.lang.Exception+ (-> (lib/native-query (mt/metadata-provider) sql)+ (qp/process-query)+ (mt/rows)))+ "SELECT ("+ "SELECT 1; SELECT 2"+ "SET ROLE NONE"+ "DROP TABLE table"+ "SET ROLE NONE; DROP TABLE table"+ "SELECT set_config('role', 'none', false); DROP TABLE table"+ "DO $$ BEGIN EXECUTE 'SET ROLE NONE; DROP TABLE table'; END $$;")))))))))))diff --git a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.cljindex d80055f350e..db80dcdbba5 100644--- a/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj+++ b/modules/drivers/sqlserver/src/metabase/driver/sqlserver.clj@@ -1181,3 +1181,7 @@(defmethod driver/llm-sql-dialect-resource :sqlserver [_]"metabot/prompts/dialects/sqlserver.md")++(defmethod driver/validate-impersonated-query :sqlserver+ [driver query]+ (driver.sql/validate-impersonated-query* driver query))diff --git a/resources/python-sources/sql_tools.py b/resources/python-sources/sql_tools.pyindex 47069bdb738..c4e7bf7f90e 100644--- a/resources/python-sources/sql_tools.py+++ b/resources/python-sources/sql_tools.py@@ -6,7 +6,8 @@ import sqlglot.lineage as lineageimport sqlglot.optimizer as optimizerimport sqlglot.optimizer.qualify as qualifyfrom sqlglot import exp-from sqlglot.errors import ParseError, OptimizeError+from sqlglot.errors import OptimizeError, ParseError+def is_quoted_identifier(name: str, dialect: str = None) -> bool:if not isinstance(name, str):@@ -1577,7 +1578,7 @@ def transpile_sql(sql: str, from_dialect: str = None, to_dialect: str = None):result['reason'] = 'missing_dialect'else:try:- use_identify = (from_dialect in CASE_SENSITIVE_DIALECTS+ use_identify = (from_dialect in CASE_SENSITIVE_DIALECTSor to_dialect in CASE_SENSITIVE_DIALECTS)transpiled = sqlglot.transpile(@@ -1599,3 +1600,17 @@ def transpile_sql(sql: str, from_dialect: str = None, to_dialect: str = None):result['error_message'] = e.args[0]return json.dumps(result)++def is_single_select_stmt(sql: str, dialect: str = None) -> str:+ """Validates that a query is a single SELECT statement+ and returns the query reconstructed from the parsed AST.+ """+ is_single_select = {"is_single_select?": False}+ try:+ stmts = sqlglot.parse(sql, read=dialect)+ if len(stmts) == 1 and isinstance(stmts[0], exp.Select):+ is_single_select["is_single_select?"] = True+ is_single_select["sql"] = stmts[0].sql(dialect=dialect) if dialect else stmts[0].sql()+ except Exception as e:+ is_single_select["error"] = str(e)+ return json.dumps(is_single_select)diff --git a/src/metabase/driver.clj b/src/metabase/driver.cljindex 71f618f891d..3114635a7e6 100644--- a/src/metabase/driver.clj+++ b/src/metabase/driver.clj@@ -1837,3 +1837,11 @@{:added "0.59.0" :arglists '([driver database test-table])}dispatch-on-initialized-driver:hierarchy #'hierarchy)++(defmulti validate-impersonated-query+ "Validates a query for impersonation. Returns the query if it is valid and throws otherwise."+ {:added "0.60.0" :arglists '([driver query])}+ dispatch-on-initialized-driver+ :hierarchy #'hierarchy)++(defmethod validate-impersonated-query :default [_driver query] query)diff --git a/src/metabase/driver/postgres.clj b/src/metabase/driver/postgres.cljindex ff6077632a2..5fc99fb1a70 100644--- a/src/metabase/driver/postgres.clj+++ b/src/metabase/driver/postgres.clj@@ -1394,3 +1394,7 @@(defmethod driver/llm-sql-dialect-resource :postgres [_]"metabot/prompts/dialects/postgresql.md")++(defmethod driver/validate-impersonated-query :postgres+ [driver query]+ (driver.sql/validate-impersonated-query* driver query))diff --git a/src/metabase/driver/sql.clj b/src/metabase/driver/sql.cljindex 1df1a58c13e..781567b5c34 100644--- a/src/metabase/driver/sql.clj+++ b/src/metabase/driver/sql.clj@@ -1,6 +1,6 @@(ns metabase.driver.sql"Shared code for all drivers that use SQL under the hood."- (:refer-clojure :exclude [some])+ (:refer-clojure :exclude [mapv])(:require[clojure.set :as set][metabase.driver :as driver]@@ -13,9 +13,12 @@[metabase.driver.sql.query-processor :as sql.qp][metabase.driver.sql.util :as sql.u][metabase.driver.util :as driver.u]+ [metabase.lib.util :as lib.util][metabase.sql-tools.core :as sql-tools]+ [metabase.util.i18n :refer [tru]][metabase.util.log :as log][metabase.util.malli :as mu]+ [metabase.util.performance :refer [mapv]][potemkin :as p]))(comment sql.params.substitution/keep-me) ; this is so `cljr-clean-ns` and the linter don't remove the `:require`@@ -238,6 +241,24 @@;;; | Convenience Imports |;;; +----------------------------------------------------------------------------------------------------------------++(defn validate-impersonated-query*+ "Validates a native query by parsing it and ensuring that it is a single select statement."+ [driver query]+ (update query :stages+ (fn [stages]+ (mapv (fn [stage]+ (if (lib.util/native-stage? stage)+ (let [{:keys [is-single-select? sql error]}+ (sql-tools/is-single-select-stmt? driver (:native stage))]+ (when error+ (log/warnf "Failed to parse native query: %s\n: Query: %s" error (:native stage)))+ (if is-single-select?+ (assoc stage :native sql)+ (throw (ex-info (tru "Invalid impersonated native query. Must be a single select statement.")+ {:sql (:native stage)}))))+ stage))+ stages))))+(p/import-vars[sql.params.substitution ->prepared-substitution PreparedStatementSubstitution][sql.normalize default-schema normalize-error normalize-name reserved-literal])diff --git a/src/metabase/sql_parsing/core.clj b/src/metabase/sql_parsing/core.cljindex af35fdf1daa..a8e17231174 100644--- a/src/metabase/sql_parsing/core.clj+++ b/src/metabase/sql_parsing/core.clj@@ -390,6 +390,18 @@(.execute ^Value (object-array [sql (json/encode replacements) dialect])).asString))))+(defn is-single-select-stmt?+ "Validates that a query is a single SELECT statement+ and returns the query reconstructed from the parsed AST."+ [dialect sql]+ (-> (with-open [^Closeable ctx (python.pool/python-context)]+ (with-python-timeout ctx default-timeout-ms+ (-> ^Value (common/eval-python ctx "sql_tools.is_single_select_stmt")+ (.execute ^Value (object-array [sql dialect]))+ .asString)))+ json/decode+kw+ (perf/update-keys (comp keyword u/->kebab-case-en))))+(comment(referenced-tables "postgres" "select * from transactions")diff --git a/src/metabase/sql_tools/core.clj b/src/metabase/sql_tools/core.cljindex 2359ea3148a..1d9b2db5ff2 100644--- a/src/metabase/sql_tools/core.clj+++ b/src/metabase/sql_tools/core.clj@@ -7,10 +7,12 @@Note: Implementation namespaces (macaw.core, sqlglot.core) are loaded viametabase.sql-tools.init to avoid circular dependencies."(:require+ [metabase.sql-parsing.core :as sql-parsing][metabase.sql-tools.common :as common][metabase.sql-tools.interface :as interface][metabase.sql-tools.metrics :as metrics][metabase.sql-tools.settings :as sql-tools.settings]+ [metabase.sql-tools.sqlglot.core :as sqlglot][metabase.util.malli :as mu][metabase.util.malli.registry :as mr][potemkin :as p]))@@ -210,3 +212,8 @@to-dialect :- [:maybe :string]](interface/transpile-sql-impl (sql-tools.settings/sql-tools-parser-backend)sql from-dialect to-dialect))++(defn is-single-select-stmt?+ "Wrapper around `sql-parsing/is-single-select-stmt`."+ [driver sql]+ (sql-parsing/is-single-select-stmt? (sqlglot/driver->dialect driver) sql))diff --git a/src/metabase/sql_tools/sqlglot/core.clj b/src/metabase/sql_tools/sqlglot/core.cljindex 4173c2e297b..1fdd5f6fa56 100644--- a/src/metabase/sql_tools/sqlglot/core.clj+++ b/src/metabase/sql_tools/sqlglot/core.clj@@ -26,6 +26,7 @@;; Fallback: pass through if already in correct format or unknown typeerror))+;; TODO(rileythomp, 2026-03): Should this be a driver multimethod?(defn driver->dialect"Map a Metabase driver keyword to a SQLGlot dialect string.Returns nil for drivers that should use SQLGlot's default dialect (e.g., H2)."@@ -41,6 +42,8 @@:sqlserver "tsql":sparksql "spark":presto-jdbc "presto"+ :starburst "trino"+ :clickhouse "clickhouse":vertica nil:h2 nil;; Default: try using the driver name as dialectdiff --git a/test/metabase/sql_tools/core_test.clj b/test/metabase/sql_tools/core_test.cljindex 2ca90608855..fbb70d0ca0a 100644--- a/test/metabase/sql_tools/core_test.clj+++ b/test/metabase/sql_tools/core_test.clj@@ -1,13 +1,15 @@-(ns metabase.sql-tools.core-test+(ns ^:mb/driver-tests metabase.sql-tools.core-test"Tests for sql-tools that run against both :macaw and :sqlglot backends.These tests verify that both parser implementations produce compatible resultsfor common operations, ensuring we can switch backends without breaking the app."(:require[clojure.string :as str]- [clojure.test :refer [deftest is testing]]+ [clojure.test :refer [deftest is testing are]][metabase.driver :as driver][metabase.lib.core :as lib]+ [metabase.lib.metadata :as lib.metadata]+ [metabase.query-processor.compile :as qp.compile][metabase.sql-tools.core :as sql-tools][metabase.sql-tools.settings :as sql-tools.settings][metabase.sql-tools.test-util :as sql-tools.tu]@@ -172,3 +174,30 @@(let [{:keys [status reason]} (sql-tools/transpile-sql "SELECT 1" nil nil)](is (= :skipped status))(is (= :missing-dialect reason))))))++(deftest ^:parallel is-single-select-stmt?-test+ (mt/test-drivers (mt/normal-drivers-with-feature :connection-impersonation)+ (let [mp (mt/metadata-provider)+ products (lib.metadata/table mp (mt/id :products))+ product-category (lib.metadata/field mp (mt/id :products :category))+ query (-> (lib/query mp products)+ (lib/filter (lib/= product-category "Widget")))+ native-query (:query (qp.compile/compile-with-inline-parameters query))]+ (testing "A single SELECT statement returns true and the reconstructed SQL"+ (are [sql] (=? {:is-single-select? true, :sql string?}+ (sql-tools/is-single-select-stmt? driver/*driver* sql))+ native-query+ "SELECT 1"+ "SELECT * FROM table"+ "WITH x AS (SELECT * FROM foo) SELECT * from x"+ "WITH x AS (SELECT a FROM foo), y AS (SELECT b FROM bar), z AS (SELECT c FROM baz) SELECT x.a, y.b, z.c FROM x, y, z")))+ (testing "All other queries are rejected"+ (are [sql] (=? {:is-single-select? false}+ (sql-tools/is-single-select-stmt? driver/*driver* sql))+ "SELECT ("+ "SELECT 1; SELECT 2"+ "SET ROLE NONE"+ "DROP TABLE table"+ "SET ROLE NONE; DROP TABLE table"+ "SELECT set_config('role', 'none', false); DROP TABLE table"+ "DO $$ BEGIN EXECUTE 'SET ROLE NONE; DROP TABLE table'; END $$;"))))