Skip to content

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

Ring middleware for public sharing endpoints (#70153)

Noah Moss4ab19dce4d16
diff --git a/src/metabase/api_routes/routes.clj b/src/metabase/api_routes/routes.clj
index e7b4ca95da3..12aad1b7447 100644
--- a/src/metabase/api_routes/routes.clj
+++ b/src/metabase/api_routes/routes.clj
@@ -185,7 +185,7 @@
"/premium-features" (+auth metabase.premium-features.api/routes)
"/preview_embed" (+auth metabase.embedding-rest.api/preview-embedding-routes)
"/product-feedback" 'metabase.product-feedback.api
- "/public" (+public-exceptions 'metabase.public-sharing-rest.api)
+ "/public" (+public-exceptions metabase.public-sharing-rest.api/routes)
"/pulse" metabase.pulse.api/pulse-routes
"/revision" (+auth 'metabase.revisions.api)
"/search" (+auth metabase.search.api/routes)
diff --git a/src/metabase/public_sharing/validation.clj b/src/metabase/public_sharing/validation.clj
index 7d9a07755a6..2d373617111 100644
--- a/src/metabase/public_sharing/validation.clj
+++ b/src/metabase/public_sharing/validation.clj
@@ -1,6 +1,7 @@
(ns metabase.public-sharing.validation
(:require
[metabase.api.common :as api]
+ [metabase.api.routes.common :as routes.common]
[metabase.public-sharing.settings :as public-sharing.settings]
[metabase.util.i18n :refer [tru]]))
@@ -9,3 +10,15 @@
[]
(api/check (public-sharing.settings/enable-public-sharing)
[400 (tru "Public sharing is not enabled.")]))
+
+(defn enforce-public-sharing-enabled
+ "Ring middleware that checks public sharing is enabled site-wide before handling the request to a public endpoint."
+ [handler]
+ (fn [request respond raise]
+ (if (public-sharing.settings/enable-public-sharing)
+ (handler request respond raise)
+ (raise (ex-info (tru "Public sharing is not enabled.") {:status-code 400})))))
+
+(def ^{:arglists '([handler])} +public-sharing-enabled
+ "Wrap `routes` so they may only be accessed when public sharing is enabled."
+ (routes.common/wrap-middleware-for-open-api-spec-generation enforce-public-sharing-enabled))
diff --git a/src/metabase/public_sharing_rest/api.clj b/src/metabase/public_sharing_rest/api.clj
index bff27eb314b..e6b5fa813db 100644
--- a/src/metabase/public_sharing_rest/api.clj
+++ b/src/metabase/public_sharing_rest/api.clj
@@ -515,6 +515,7 @@
[:uuid ms/UUIDString]
[:param-key ms/NonBlankString]]
{:keys [value]} :- [:map [:value :any]]]
+ (public-sharing.validation/check-public-sharing-enabled)
(let [card (t2/select-one :model/Card :public_uuid uuid, :archived false)]
(request/as-admin
(queries/card-param-remapped-value card param-key (codec/url-decode value)))))
@@ -529,6 +530,7 @@
[:uuid ms/UUIDString]
[:param-key ms/NonBlankString]]
constraint-param-key->value :- [:map-of string? any?]]
+ (public-sharing.validation/check-public-sharing-enabled)
(let [dashboard (dashboard-with-uuid uuid)]
(request/as-admin
(binding [qp.perms/*param-values-query* true]
@@ -545,6 +547,7 @@
[:param-key ms/NonBlankString]
[:query ms/NonBlankString]]
constraint-param-key->value]
+ (public-sharing.validation/check-public-sharing-enabled)
(let [dashboard (dashboard-with-uuid uuid)]
(request/as-admin
(binding [qp.perms/*param-values-query* true]
@@ -560,6 +563,7 @@
[:uuid ms/UUIDString]
[:param-key ms/NonBlankString]]
{:keys [value]} :- [:map [:value :any]]]
+ (public-sharing.validation/check-public-sharing-enabled)
(let [dashboard (dashboard-with-uuid uuid)]
(request/as-admin
(binding [qp.perms/*param-values-query* true]
@@ -824,9 +828,10 @@
;;; ----------------------------------------- Route Definitions & Complaints -----------------------------------------
-;; TODO - why don't we just make these routes have a bit of middleware that includes the
-;; `public-sharing.validation/check-public-sharing-enabled` check in each of them? That way we don't need to remember to include the line in
-;; every single endpoint definition here? Wouldn't that be 100x better?!
-;;
-;; TODO - also a smart person would probably just parse the UUIDs automatically in middleware as appropriate for
+;; TODO - a smart person would probably just parse the UUIDs automatically in middleware as appropriate for
;;`/dashboard` vs `/card`
+
+(def ^{:arglists '([request respond raise])} routes
+ "`/api/public` routes. Enforces public-sharing-enabled check via middleware, in addition to
+ per-endpoint checks."
+ (api.macros/ns-handler *ns* public-sharing.validation/+public-sharing-enabled))
diff --git a/test/metabase/documents/api/document_test.clj b/test/metabase/documents/api/document_test.clj
index faa8161ae89..5183da1d354 100644
--- a/test/metabase/documents/api/document_test.clj
+++ b/test/metabase/documents/api/document_test.clj
@@ -2214,8 +2214,8 @@
(testing "Shouldn't be able to fetch a public Document if public sharing is disabled"
(mt/with-temporary-setting-values [enable-public-sharing false]
(mt/with-temp [:model/Document document (document-with-public-link {})]
- (is (= "API endpoint does not exist."
- (mt/client :get 404 (str "public/document/" (:public_uuid document))))))))
+ (is (= "An error occurred."
+ (mt/client :get 400 (str "public/document/" (:public_uuid document))))))))
(testing "Should get a 404 if the Document doesn't exist"
(mt/with-temporary-setting-values [enable-public-sharing true]
diff --git a/test/metabase/public_sharing_rest/api_documents_test.clj b/test/metabase/public_sharing_rest/api_documents_test.clj
index 3efa392f0d2..6473bddd60a 100644
--- a/test/metabase/public_sharing_rest/api_documents_test.clj
+++ b/test/metabase/public_sharing_rest/api_documents_test.clj
@@ -96,8 +96,8 @@
(testing "Cannot fetch a public Document if public sharing is disabled"
(mt/with-temporary-setting-values [enable-public-sharing false]
(mt/with-temp [:model/Document document (document-with-public-link {})]
- (is (= "API endpoint does not exist."
- (mt/client :get 404 (str "public/document/" (:public_uuid document)))))))))
+ (is (= "An error occurred."
+ (mt/client :get 400 (str "public/document/" (:public_uuid document)))))))))
(testing "Returns 404 if the Document doesn't exist"
(mt/with-temporary-setting-values [enable-public-sharing true]
diff --git a/test/metabase/public_sharing_rest/api_test.clj b/test/metabase/public_sharing_rest/api_test.clj
index 8cab8f6b08f..9ad5c317216 100644
--- a/test/metabase/public_sharing_rest/api_test.clj
+++ b/test/metabase/public_sharing_rest/api_test.clj
@@ -590,8 +590,45 @@
(client/client :get 200 (str "public/card/" uuid "/query/csv"), :format :csv)
(is (= :public-csv-download (:context (qe)))))))))))
+(deftest card-endpoints-require-public-sharing-enabled-test
+ (testing "Card endpoints return 400 when public sharing is disabled"
+ (mt/with-temporary-setting-values [enable-public-sharing true]
+ (with-temp-public-card [{uuid :public_uuid}]
+ (let [endpoints [[:get (format "public/card/%s" uuid)]
+ [:get (format "public/card/%s/query" uuid)]
+ [:get (format "public/card/%s/query/json" uuid)]
+ [:get (format "public/card/%s/params/_STATIC_CATEGORY_/values" uuid)]
+ [:get (format "public/card/%s/params/_STATIC_CATEGORY_/search/A" uuid)]
+ [:get (format "public/card/%s/params/_STATIC_CATEGORY_/remapping" uuid)
+ :value "foo"]]]
+ (mt/with-temporary-setting-values [enable-public-sharing false]
+ (doseq [[method url & kvs] endpoints]
+ (testing (str (name method) " " url)
+ (is (= "An error occurred."
+ (apply client/client method 400 url kvs)))))))))))
+
;;; ---------------------------------------- GET /api/public/dashboard/:uuid -----------------------------------------
+(deftest dashboard-endpoints-require-public-sharing-enabled-test
+ (testing "Dashboard endpoints return 400 when public sharing is disabled"
+ (mt/with-temporary-setting-values [enable-public-sharing true]
+ (with-temp-public-dashboard-and-card [dash card dashcard]
+ (let [dash-uuid (:public_uuid dash)
+ dashcard-id (u/the-id dashcard)
+ card-id (u/the-id card)
+ endpoints [[:get (format "public/dashboard/%s" dash-uuid)]
+ [:get (format "public/dashboard/%s/dashcard/%d/card/%d" dash-uuid dashcard-id card-id)]
+ [:post (format "public/dashboard/%s/dashcard/%d/card/%d/json" dash-uuid dashcard-id card-id)]
+ [:get (format "public/dashboard/%s/params/_VENUE_ID_/values" dash-uuid)]
+ [:get (format "public/dashboard/%s/params/_VENUE_ID_/search/foo" dash-uuid)]
+ [:get (format "public/dashboard/%s/params/_VENUE_ID_/remapping" dash-uuid)
+ :value "1"]]]
+ (mt/with-temporary-setting-values [enable-public-sharing false]
+ (doseq [[method url & kvs] endpoints]
+ (testing (str (name method) " " url)
+ (is (= "An error occurred."
+ (apply client/client method 400 url kvs)))))))))))
+
(deftest get-public-dashboard-errors-test
(testing "GET /api/public/dashboard/:uuid"
(testing "Shouldn't be able to fetch a public Dashboard if public sharing is disabled"
@@ -1730,6 +1767,7 @@
(deftest oembed-test
(testing "GET /oembed"
- (let [response (client/client :get 200 "public/oembed?url=path/to/url&format=json")]
- (is (= "1.0" (:version response)))
- (is (= "rich" (:type response))))))
+ (mt/with-temporary-setting-values [enable-public-sharing true]
+ (let [response (client/client :get 200 "public/oembed?url=path/to/url&format=json")]
+ (is (= "1.0" (:version response)))
+ (is (= "rich" (:type response)))))))