Skip to content

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

GHY-4586: Bind values in user_key_value/db.clj (9 non-id) (#83159)

Eric Normand0af6bce7a7e2
diff --git a/.clj-kondo/config.edn b/.clj-kondo/config.edn
index 20104c75a65..479bbc5828e 100644
--- a/.clj-kondo/config.edn
+++ b/.clj-kondo/config.edn
@@ -990,6 +990,9 @@
metabase.usage-metadata.db
{:linters {:metabase/unsafe-app-db-query {:level :warning}}}
+ metabase.user-key-value.db
+ {:linters {:metabase/unsafe-app-db-query {:level :warning}}}
+
metabase.public-sharing.db
{:linters {:metabase/unsafe-app-db-query {:level :warning}}}
diff --git a/src/metabase/user_key_value/db.clj b/src/metabase/user_key_value/db.clj
index 9eeda5357dc..221cb173926 100644
--- a/src/metabase/user_key_value/db.clj
+++ b/src/metabase/user_key_value/db.clj
@@ -12,7 +12,10 @@
[user-id :- ::lib.schema.id/user
namespace :- :string
k :- :string]
- (t2/select-one :model/UserKeyValue :user_id user-id :namespace namespace :key k))
+ (t2/select-one :model/UserKeyValue
+ :user_id (long user-id)
+ :namespace [:auto/param namespace]
+ :key [:auto/param k]))
(mu/defn update-user-key-value!
"Set the value and expiry of the UserKeyValue of the User with `user-id` for `k` in `namespace`, returning the
@@ -22,7 +25,11 @@
k :- :string
value :- :string
expires-at :- [:maybe ms/TemporalInstant]]
- (t2/update! :model/UserKeyValue :user_id user-id :namespace namespace :key k {:value value, :expires_at expires-at}))
+ (t2/update! :model/UserKeyValue
+ :user_id (long user-id)
+ :namespace [:auto/param namespace]
+ :key [:auto/param k]
+ {:value value, :expires_at expires-at}))
(mu/defn insert-user-key-value!
"Insert a UserKeyValue for the User with `user-id`, returning the number inserted."
@@ -42,7 +49,10 @@
[user-id :- ::lib.schema.id/user
namespace :- :string
k :- :string]
- (t2/delete! :model/UserKeyValue :namespace namespace :user_id user-id :key k))
+ (t2/delete! :model/UserKeyValue
+ :namespace [:auto/param namespace]
+ :user_id (long user-id)
+ :key [:auto/param k]))
(mu/defn unexpired-user-key-value
"The unexpired UserKeyValue of the User with `user-id` for `k` in `namespace`, or nil."
@@ -51,9 +61,9 @@
k :- :string]
(t2/select-one :model/UserKeyValue
{:where [:and
- [:= :user_id user-id]
- [:= :namespace namespace]
- [:= :key k]
+ [:= :user_id (long user-id)]
+ [:= :namespace [:auto/param namespace]]
+ [:= :key [:auto/param k]]
[:or
[:>= :expires_at :%now]
[:= :expires_at nil]]]}))
@@ -64,8 +74,8 @@
namespace :- :string]
(t2/select :model/UserKeyValue
{:where [:and
- [:= :user_id user-id]
- [:= :namespace namespace]
+ [:= :user_id (long user-id)]
+ [:= :namespace [:auto/param namespace]]
[:or
[:>= :expires_at :%now]
[:= :expires_at nil]]]}))
diff --git a/test/metabase/user_key_value/api_test.clj b/test/metabase/user_key_value/api_test.clj
index 03e0dcc8424..34fc68c36f4 100644
--- a/test/metabase/user_key_value/api_test.clj
+++ b/test/metabase/user_key_value/api_test.clj
@@ -3,7 +3,8 @@
[clojure.test :refer :all]
[metabase.test :as mt]
[metabase.user-key-value.init]
- [metabase.user-key-value.models.user-key-value.types :as user-kv.types]))
+ [metabase.user-key-value.models.user-key-value.types :as user-kv.types]
+ [ring.util.codec :as codec]))
(comment metabase.user-key-value.init/keep-me)
@@ -85,3 +86,21 @@
:b "b value"
:c "c value"}
(mt/user-http-request :rasta :get 200 "/user-key-value/namespace/other"))))))
+
+(deftest sql-looking-key-is-a-value-test
+ (testing "GHY-4586: a key that looks like SQL is compared as a value on every read, write and delete"
+ (mt/with-model-cleanup [:model/UserKeyValue]
+ (let [sql-key "a' OR '1'='1"
+ url (str "/user-key-value/namespace/other/key/" (codec/url-encode sql-key))]
+ (mt/user-http-request :rasta :put 200 "/user-key-value/namespace/other/key/a" {:value "a value"})
+ (testing "reading the key matches no other row"
+ (is (= nil (mt/user-http-request :rasta :get 204 url))))
+ (testing "writing the key inserts, then updates, only its own row"
+ (is (= "first" (mt/user-http-request :rasta :put 200 url {:value "first"})))
+ (is (= "second" (mt/user-http-request :rasta :put 200 url {:value "second"})))
+ (is (= {:a "a value", (keyword sql-key) "second"}
+ (mt/user-http-request :rasta :get 200 "/user-key-value/namespace/other"))))
+ (testing "deleting the key deletes only its own row"
+ (mt/user-http-request :rasta :delete 200 url)
+ (is (= {:a "a value"}
+ (mt/user-http-request :rasta :get 200 "/user-key-value/namespace/other"))))))))
diff --git a/test/metabase/user_key_value/db_test.clj b/test/metabase/user_key_value/db_test.clj
new file mode 100644
index 00000000000..86f443e5848
--- /dev/null
+++ b/test/metabase/user_key_value/db_test.clj
@@ -0,0 +1,46 @@
+(ns metabase.user-key-value.db-test
+ (:require
+ [clojure.test :refer :all]
+ [metabase.test :as mt]
+ [metabase.user-key-value.db :as user-key-value.db]
+ [metabase.util.malli :as mu]))
+
+(deftest namespace-and-key-are-values-test
+ (testing "GHY-4586: namespace and key are compared as values, so SQL-looking ones match nothing else"
+ (mt/with-model-cleanup [:model/UserKeyValue]
+ (let [user-id (mt/user->id :rasta)
+ sql "x' OR '1'='1"]
+ (user-key-value.db/insert-user-key-value! user-id "ns" "k" "v" nil)
+ (is (= "v" (:value (user-key-value.db/user-key-value user-id "ns" "k"))))
+ (is (= "v" (:value (user-key-value.db/unexpired-user-key-value user-id "ns" "k"))))
+ (is (= ["k"] (map :key (user-key-value.db/unexpired-user-key-values user-id "ns"))))
+ (is (nil? (user-key-value.db/user-key-value user-id "ns" sql)))
+ (is (nil? (user-key-value.db/unexpired-user-key-value user-id sql "k")))
+ (is (empty? (user-key-value.db/unexpired-user-key-values user-id sql)))
+ (is (= 0 (user-key-value.db/update-user-key-value! user-id "ns" sql "changed" nil)))
+ (is (= 0 (user-key-value.db/delete-user-key-value! user-id sql "k")))
+ (is (= "v" (:value (user-key-value.db/user-key-value user-id "ns" "k"))))
+ (is (= 1 (user-key-value.db/update-user-key-value! user-id "ns" "k" "changed" nil)))
+ (is (= "changed" (:value (user-key-value.db/user-key-value user-id "ns" "k"))))
+ (is (= 1 (user-key-value.db/delete-user-key-value! user-id "ns" "k")))
+ (is (nil? (user-key-value.db/user-key-value user-id "ns" "k")))))))
+
+(deftest namespace-and-key-are-bound-without-the-schema-test
+ (testing "GHY-4586: with the schema off, the marker rejects an operator-shaped namespace or key instead of compiling it into the WHERE"
+ ;; Unmarked, `:namespace [:not= "zzz"]` is a Toucan kv-arg condition that compiles to `namespace <> 'zzz'`,
+ ;; so delete-user-key-value! would delete every key for the user whose namespace differs.
+ (let [user-id (mt/user->id :rasta)
+ op [:not= "zzz"]]
+ (mu/disable-enforcement
+ (doseq [[desc thunk] {"user-key-value ns" #(user-key-value.db/user-key-value user-id op "k")
+ "user-key-value key" #(user-key-value.db/user-key-value user-id "ns" op)
+ "update! ns" #(user-key-value.db/update-user-key-value! user-id op "k" "v" nil)
+ "update! key" #(user-key-value.db/update-user-key-value! user-id "ns" op "v" nil)
+ "delete! ns" #(user-key-value.db/delete-user-key-value! user-id op "k")
+ "delete! key" #(user-key-value.db/delete-user-key-value! user-id "ns" op)
+ "unexpired-user-key-value ns" #(user-key-value.db/unexpired-user-key-value user-id op "k")
+ "unexpired-user-key-value key" #(user-key-value.db/unexpired-user-key-value user-id "ns" op)
+ "unexpired-user-key-values ns" #(doall (user-key-value.db/unexpired-user-key-values user-id op))}]
+ (testing desc
+ (is (thrown-with-msg? clojure.lang.ExceptionInfo #"Marked a whole operator form"
+ (thunk)))))))))