Skip to content

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

Use explicit hierarchy for auth identity providers (#79463)

Ben Grabowca2c34152210
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.edn
index 71a3f08720f..a06251dbb8b 100644
--- a/.clj-kondo/config/modules/config.edn
+++ b/.clj-kondo/config/modules/config.edn
@@ -3542,6 +3542,7 @@
metabase-enterprise.mfa.routes}
:uses #{api
appearance
+ auth-identity
channel
config
events
diff --git a/enterprise/backend/src/metabase_enterprise/mfa/init.clj b/enterprise/backend/src/metabase_enterprise/mfa/init.clj
index 8198859a93f..5b456aa4abe 100644
--- a/enterprise/backend/src/metabase_enterprise/mfa/init.clj
+++ b/enterprise/backend/src/metabase_enterprise/mfa/init.clj
@@ -4,7 +4,7 @@
;; core loads gate transitively
[metabase-enterprise.mfa.core]
[metabase-enterprise.mfa.settings]
- ;; verification carries the (derive :provider/totp ...) that AuthIdentity validation needs;
+ ;; verification carries the (derive! :provider/totp ...) that AuthIdentity validation needs;
;; require it explicitly: core requires verification, but an explicit require is more
;; robust and clearly documents the side-effect dependency
[metabase-enterprise.mfa.verification]))
diff --git a/enterprise/backend/src/metabase_enterprise/mfa/verification.clj b/enterprise/backend/src/metabase_enterprise/mfa/verification.clj
index eb33f310e47..23b059f2d2e 100644
--- a/enterprise/backend/src/metabase_enterprise/mfa/verification.clj
+++ b/enterprise/backend/src/metabase_enterprise/mfa/verification.clj
@@ -16,6 +16,7 @@
[metabase-enterprise.mfa.db :as mfa.db]
[metabase-enterprise.mfa.recovery-codes :as recovery-codes]
[metabase-enterprise.mfa.totp :as totp]
+ [metabase.auth-identity.core :as auth-identity]
[metabase.util.password :as u.password]
[toucan2.core :as t2])
(:import
@@ -25,7 +26,7 @@
;; Register "totp" in the AuthIdentity provider hierarchy so the model's before-insert/-update
;; validation accepts its rows (the default `validate` method applies).
-(derive :provider/totp :metabase.auth-identity.provider/provider)
+(auth-identity/derive! :provider/totp :metabase.auth-identity.provider/provider)
(defn totp-identity
"The AuthIdentity row for `user-id`'s TOTP enrollment, or nil."
diff --git a/enterprise/backend/src/metabase_enterprise/sso/providers/jwt.clj b/enterprise/backend/src/metabase_enterprise/sso/providers/jwt.clj
index 20f2d2b8bf9..e9b2c97cd37 100644
--- a/enterprise/backend/src/metabase_enterprise/sso/providers/jwt.clj
+++ b/enterprise/backend/src/metabase_enterprise/sso/providers/jwt.clj
@@ -16,9 +16,9 @@
(set! *warn-on-reflection* true)
;; Register JWT provider
-(derive :provider/jwt :metabase.auth-identity.provider/provider)
-(derive :provider/jwt :metabase.auth-identity.provider/create-user-if-not-exists)
-(derive :provider/jwt :metabase-enterprise.tenants.auth-provider/create-tenant-if-not-exists)
+(auth-identity/derive! :provider/jwt :metabase.auth-identity.provider/provider)
+(auth-identity/derive! :provider/jwt :metabase.auth-identity.provider/create-user-if-not-exists)
+(auth-identity/derive! :provider/jwt :metabase-enterprise.tenants.auth-provider/create-tenant-if-not-exists)
;; JWTs use seconds since Epoch, not milliseconds since Epoch for the `iat` and `max_age` time.
;; 3 minutes is the time used by Zendesk for their JWT SSO
diff --git a/enterprise/backend/src/metabase_enterprise/sso/providers/oidc.clj b/enterprise/backend/src/metabase_enterprise/sso/providers/oidc.clj
index bc87c0944ce..24d80e84181 100644
--- a/enterprise/backend/src/metabase_enterprise/sso/providers/oidc.clj
+++ b/enterprise/backend/src/metabase_enterprise/sso/providers/oidc.clj
@@ -14,7 +14,7 @@
;;; -------------------------------------------------- Provider Registration --------------------------------------------------
-(derive :provider/custom-oidc :provider/oidc)
+(auth-identity/derive! :provider/custom-oidc :provider/oidc)
;;; -------------------------------------------------- Configuration --------------------------------------------------
diff --git a/enterprise/backend/src/metabase_enterprise/sso/providers/saml.clj b/enterprise/backend/src/metabase_enterprise/sso/providers/saml.clj
index 6c83e768d4f..dae81d9f6d9 100644
--- a/enterprise/backend/src/metabase_enterprise/sso/providers/saml.clj
+++ b/enterprise/backend/src/metabase_enterprise/sso/providers/saml.clj
@@ -17,9 +17,9 @@
(set! *warn-on-reflection* true)
;; Register SAML provider
-(derive :provider/saml :metabase.auth-identity.provider/provider)
-(derive :provider/saml :metabase.auth-identity.provider/create-user-if-not-exists)
-(derive :provider/saml :metabase-enterprise.tenants.auth-provider/create-tenant-if-not-exists)
+(auth-identity/derive! :provider/saml :metabase.auth-identity.provider/provider)
+(auth-identity/derive! :provider/saml :metabase.auth-identity.provider/create-user-if-not-exists)
+(auth-identity/derive! :provider/saml :metabase-enterprise.tenants.auth-provider/create-tenant-if-not-exists)
(defn- acs-url
"Get the Assertion Consumer Service URL."
diff --git a/enterprise/backend/src/metabase_enterprise/support_access_grants/provider.clj b/enterprise/backend/src/metabase_enterprise/support_access_grants/provider.clj
index b2fef0910bc..2e62fb29769 100644
--- a/enterprise/backend/src/metabase_enterprise/support_access_grants/provider.clj
+++ b/enterprise/backend/src/metabase_enterprise/support_access_grants/provider.clj
@@ -86,7 +86,7 @@
;;; -------------------------------------------------- Provider Registration --------------------------------------------------
;; Register support-access-grant provider in the hierarchy, deriving from emailed-secret
-(derive :provider/support-access-grant :provider/emailed-secret)
+(auth-identity/derive! :provider/support-access-grant :provider/emailed-secret)
;;; -------------------------------------------------- Multimethod Implementations --------------------------------------------------
diff --git a/enterprise/backend/test/metabase_enterprise/mfa/gate_test.clj b/enterprise/backend/test/metabase_enterprise/mfa/gate_test.clj
index 93e6a9e8a47..5e4e3124081 100644
--- a/enterprise/backend/test/metabase_enterprise/mfa/gate_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/mfa/gate_test.clj
@@ -4,6 +4,7 @@
[java-time.api :as t]
[metabase-enterprise.mfa.settings :as mfa.settings]
[metabase-enterprise.mfa.totp :as totp]
+ [metabase.auth-identity.core :as auth-identity]
[metabase.auth-identity.provider :as auth-identity.provider]
[metabase.test :as mt]))
@@ -109,7 +110,7 @@
:provider/totp :exempt}]
(testing "every registered provider has a deliberate MFA classification"
(is (= (set (keys classification))
- (set (descendants :metabase.auth-identity.provider/provider)))))
+ (set (auth-identity/descendants :metabase.auth-identity.provider/provider)))))
(testing "the gate's behavior matches each classification for an enrolled user"
(mt/with-premium-features #{:multi-factor-auth}
(mt/with-temporary-setting-values [mfa-enforcement :optional]
diff --git a/enterprise/backend/test/metabase_enterprise/sso/integrations/oidc_test.clj b/enterprise/backend/test/metabase_enterprise/sso/integrations/oidc_test.clj
index 714b3a2403a..bf4db998c54 100644
--- a/enterprise/backend/test/metabase_enterprise/sso/integrations/oidc_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/sso/integrations/oidc_test.clj
@@ -72,11 +72,11 @@
(defmacro ^:private with-successful-oidc! [& body]
`(do
- (derive :provider/custom-oidc :provider/test-oidc-successful)
+ (auth-identity/derive! :provider/custom-oidc :provider/test-oidc-successful)
(try
~@body
(finally
- (underive :provider/custom-oidc :provider/test-oidc-successful)))))
+ (auth-identity/underive! :provider/custom-oidc :provider/test-oidc-successful)))))
(defmacro ^:private with-oidc-default-setup! [& body]
`(mt/test-helpers-set-global-values!
@@ -215,11 +215,11 @@
(defmacro ^:private with-group-sync-oidc! [& body]
`(do
- (derive :provider/custom-oidc :provider/test-oidc-with-groups)
+ (auth-identity/derive! :provider/custom-oidc :provider/test-oidc-with-groups)
(try
~@body
(finally
- (underive :provider/custom-oidc :provider/test-oidc-with-groups)))))
+ (auth-identity/underive! :provider/custom-oidc :provider/test-oidc-with-groups)))))
(defn- do-with-group-sync-login!
"Helper that sets up the OIDC provider with group sync config, performs a login, and calls `f`
diff --git a/src/metabase/auth_identity/core.clj b/src/metabase/auth_identity/core.clj
index 2633be0472d..8d7493b3add 100644
--- a/src/metabase/auth_identity/core.clj
+++ b/src/metabase/auth_identity/core.clj
@@ -1,7 +1,9 @@
(ns metabase.auth-identity.core
"Public API for the auth_identity module. This namespace provides the interface for managing
authentication identities for users."
+ (:refer-clojure :exclude [descendants isa?])
(:require
+ [metabase.auth-identity.hierarchy :as auth-identity.hierarchy]
[metabase.auth-identity.models.auth-identity :as auth-identity]
[metabase.auth-identity.provider :as provider]
[metabase.auth-identity.providers.emailed-secret :as emailed-secret]
@@ -29,8 +31,8 @@
;; ## Implementing a New Provider
;;
;; 1. Create a namespace for your provider (e.g., metabase.sso.providers.my-provider)
-;; 2. Declare hierarchy: (derive :provider/my-provider ::provider/provider)
-;; 3. For SSO providers: (derive :provider/my-provider ::provider/create-user-if-not-exists)
+;; 2. Declare hierarchy: (auth-identity/derive! :provider/my-provider ::provider/provider)
+;; 3. For SSO providers: (auth-identity/derive! :provider/my-provider ::provider/create-user-if-not-exists)
;; 4. Implement authenticate multimethod (required)
;; 5. Optionally implement validate for credential validation
;;
@@ -46,6 +48,11 @@
;; ==============================================================================
(p/import-vars
+ [auth-identity.hierarchy
+ derive!
+ descendants
+ isa?
+ underive!]
[provider
validate
authenticate
diff --git a/src/metabase/auth_identity/hierarchy.clj b/src/metabase/auth_identity/hierarchy.clj
new file mode 100644
index 00000000000..0dd56d3b00e
--- /dev/null
+++ b/src/metabase/auth_identity/hierarchy.clj
@@ -0,0 +1,37 @@
+(ns metabase.auth-identity.hierarchy
+ "Keyword hierarchy relating auth provider keywords to the keywords `validate`, `authenticate` and `login!` methods
+ dispatch on.
+
+ Every provider must reach `:metabase.auth-identity.provider/provider` through this hierarchy to get the default
+ method implementations. Kept separate from Clojure's global hierarchy so that provider relationships are visible in
+ one place and cannot collide with other users of the global hierarchy.
+
+ (derive! :provider/saml :metabase.auth-identity.provider/provider)
+ (derive! :provider/saml :metabase.auth-identity.provider/create-user-if-not-exists)"
+ (:refer-clojure :exclude [descendants isa?]))
+
+(defonce ^{:doc "The auth provider hierarchy. A var holding a hierarchy map, mutated by [[derive!]] and [[underive!]]."}
+ hierarchy
+ (make-hierarchy))
+
+(defn derive!
+ "Make `parent` an ancestor of `tag` in the provider [[hierarchy]]."
+ [tag parent]
+ (alter-var-root #'hierarchy derive tag parent)
+ nil)
+
+(defn underive!
+ "Remove `parent` as an immediate ancestor of `tag` in the provider [[hierarchy]]."
+ [tag parent]
+ (alter-var-root #'hierarchy underive tag parent)
+ nil)
+
+(defn isa?
+ "Whether `child` is `parent` or descends from it in the provider [[hierarchy]]."
+ [child parent]
+ (clojure.core/isa? hierarchy child parent))
+
+(defn descendants
+ "The set of keywords that descend from `parent` in the provider [[hierarchy]], or `nil` if there are none."
+ [parent]
+ (clojure.core/descendants hierarchy parent))
diff --git a/src/metabase/auth_identity/provider.clj b/src/metabase/auth_identity/provider.clj
index 9aa63410fcd..99a9786a283 100644
--- a/src/metabase/auth_identity/provider.clj
+++ b/src/metabase/auth_identity/provider.clj
@@ -15,21 +15,23 @@
Each provider implementation should:
1. Use a keyword in the :provider namespace (e.g., :provider/password)
- 2. Declare hierarchy with (derive :provider/name ::provider/provider)
- 3. For SSO providers that auto-create users, also (derive :provider/name ::provider/create-user-if-not-exists)
+ 2. Declare hierarchy with (auth-identity/derive! :provider/name ::provider/provider)
+ 3. For SSO providers that auto-create users, also
+ (auth-identity/derive! :provider/name ::provider/create-user-if-not-exists)
4. Implement the authenticate multimethod (required)
5. Optionally implement validate for credential validation
Example:
(ns metabase.sso.providers.my-provider
- (:require [metabase.auth-identity.provider :as provider]
+ (:require [metabase.auth-identity.core :as auth-identity]
+ [metabase.auth-identity.provider :as provider]
[methodical.core :as methodical]))
;; Declare this provider derives from ::provider/provider
- (derive :provider/my-provider ::provider/provider)
+ (auth-identity/derive! :provider/my-provider ::provider/provider)
;; For SSO providers that auto-create users:
- (derive :provider/my-provider ::provider/create-user-if-not-exists)
+ (auth-identity/derive! :provider/my-provider ::provider/create-user-if-not-exists)
;; Implement authentication
(methodical/defmethod provider/authenticate :provider/my-provider
@@ -53,6 +55,7 @@
(:require
[java-time.api :as t]
[metabase.auth-identity.db :as auth-identity.db]
+ [metabase.auth-identity.hierarchy :as auth-identity.hierarchy]
[metabase.auth-identity.session :as auth-session]
[metabase.events.core :as events]
[metabase.notification.core :as notification]
@@ -69,8 +72,8 @@
;;; -------------------------------------------------- Provider Hierarchy --------------------------------------------------
-;; Provider hierarchy is defined by individual provider implementations
-;; Each provider namespace should use (derive :provider/name ::provider/provider)
+;; Provider relationships live in [[metabase.auth-identity.hierarchy]] and are declared by individual provider
+;; implementations. Each provider namespace should use (auth-identity/derive! :provider/name ::provider/provider).
;; SSO providers that auto-provision users should also derive from ::provider/create-user-if-not-exists
;;; -------------------------------------------------- Shared Error Messages --------------------------------------------------
@@ -107,7 +110,8 @@
=> throws ExceptionInfo"
{:arglists '([provider auth-identity-data])}
(fn [provider _auth-identity-data]
- provider))
+ provider)
+ :hierarchy #'auth-identity.hierarchy/hierarchy)
(methodical/defmethod validate ::provider
[_provider _auth-identity-data]
@@ -175,7 +179,8 @@
=> {:success? false :error :invalid-credentials :message \"Password did not match stored password.\"}"
{:arglists '([provider request])}
(fn [provider _request]
- provider))
+ provider)
+ :hierarchy #'auth-identity.hierarchy/hierarchy)
(methodical/defmethod authenticate ::provider
[provider _request]
@@ -246,7 +251,8 @@
=> {:success? false :error :invalid-credentials :message \"...\"}"
{:arglists '([provider request])}
(fn [provider _request]
- provider))
+ provider)
+ :hierarchy #'auth-identity.hierarchy/hierarchy)
(mu/defn- create-session!
"Create a new session for a user with the given provider.
diff --git a/src/metabase/auth_identity/providers/emailed_secret.clj b/src/metabase/auth_identity/providers/emailed_secret.clj
index 2f53cada7e9..756311364f9 100644
--- a/src/metabase/auth_identity/providers/emailed_secret.clj
+++ b/src/metabase/auth_identity/providers/emailed_secret.clj
@@ -3,6 +3,7 @@
(:require
[java-time.api :as t]
[metabase.auth-identity.db :as auth-identity.db]
+ [metabase.auth-identity.hierarchy :as auth-identity.hierarchy]
[metabase.auth-identity.models.auth-identity :as auth-identity]
[metabase.auth-identity.provider :as provider]
[metabase.channel.email.messages :as messages]
@@ -119,8 +120,8 @@
;;; -------------------------------------------------- Provider Registration --------------------------------------------------
;; Register emailed_secret provider in the hierarchy
-(derive :provider/emailed-secret :metabase.auth-identity.provider/provider)
-(derive :provider/emailed-secret-password-reset :provider/emailed-secret)
+(auth-identity.hierarchy/derive! :provider/emailed-secret :metabase.auth-identity.provider/provider)
+(auth-identity.hierarchy/derive! :provider/emailed-secret-password-reset :provider/emailed-secret)
;;; -------------------------------------------------- Multimethod Implementations --------------------------------------------------
diff --git a/src/metabase/auth_identity/providers/password.clj b/src/metabase/auth_identity/providers/password.clj
index 1f1d78f5fd7..0b2df38a4c7 100644
--- a/src/metabase/auth_identity/providers/password.clj
+++ b/src/metabase/auth_identity/providers/password.clj
@@ -2,6 +2,7 @@
"Password authentication provider implementation."
(:require
[metabase.auth-identity.db :as auth-identity.db]
+ [metabase.auth-identity.hierarchy :as auth-identity.hierarchy]
[metabase.auth-identity.provider :as provider]
[metabase.util.log :as log]
[metabase.util.malli :as mu]
@@ -14,7 +15,7 @@
;;; -------------------------------------------------- Provider Registration --------------------------------------------------
;; Register password provider in the hierarchy
-(derive :provider/password ::provider/provider)
+(auth-identity.hierarchy/derive! :provider/password ::provider/provider)
;;; -------------------------------------------------- Multimethod Implementations --------------------------------------------------
diff --git a/src/metabase/sso/providers/google.clj b/src/metabase/sso/providers/google.clj
index 9781a5e2279..1cb857c3e9b 100644
--- a/src/metabase/sso/providers/google.clj
+++ b/src/metabase/sso/providers/google.clj
@@ -11,8 +11,8 @@
(set! *warn-on-reflection* true)
;; Register Google OAuth provider
-(derive :provider/google :metabase.auth-identity.provider/provider)
-(derive :provider/google :metabase.auth-identity.provider/create-user-if-not-exists)
+(auth-identity/derive! :provider/google :metabase.auth-identity.provider/provider)
+(auth-identity/derive! :provider/google :metabase.auth-identity.provider/create-user-if-not-exists)
(def ^:private google-auth-token-info-url "https://www.googleapis.com/oauth2/v3/tokeninfo?id_token=%s")
diff --git a/src/metabase/sso/providers/ldap.clj b/src/metabase/sso/providers/ldap.clj
index b4355949f71..eb6f58f357c 100644
--- a/src/metabase/sso/providers/ldap.clj
+++ b/src/metabase/sso/providers/ldap.clj
@@ -15,10 +15,10 @@
;;; -------------------------------------------------- Provider Registration --------------------------------------------------
;; Register LDAP provider in the hierarchy
-(derive :provider/ldap :metabase.auth-identity.provider/provider)
+(auth-identity/derive! :provider/ldap :metabase.auth-identity.provider/provider)
;; LDAP is an SSO provider that auto-creates users
-(derive :provider/ldap :metabase.auth-identity.provider/create-user-if-not-exists)
+(auth-identity/derive! :provider/ldap :metabase.auth-identity.provider/create-user-if-not-exists)
;;; -------------------------------------------------- Multimethod Implementations --------------------------------------------------
diff --git a/src/metabase/sso/providers/oidc.clj b/src/metabase/sso/providers/oidc.clj
index 8edad805f8b..2c9fb514b3c 100644
--- a/src/metabase/sso/providers/oidc.clj
+++ b/src/metabase/sso/providers/oidc.clj
@@ -15,8 +15,8 @@
;;; -------------------------------------------------- Provider Registration --------------------------------------------------
;; Register the OIDC provider in the hierarchy
-(derive :provider/oidc :metabase.auth-identity.provider/provider)
-(derive :provider/oidc :metabase.auth-identity.provider/create-user-if-not-exists)
+(auth-identity/derive! :provider/oidc :metabase.auth-identity.provider/provider)
+(auth-identity/derive! :provider/oidc :metabase.auth-identity.provider/create-user-if-not-exists)
;;; -------------------------------------------------- Configuration Handling --------------------------------------------------
diff --git a/src/metabase/sso/providers/slack_connect.clj b/src/metabase/sso/providers/slack_connect.clj
index 2a360e715d7..937cdf73a00 100644
--- a/src/metabase/sso/providers/slack_connect.clj
+++ b/src/metabase/sso/providers/slack_connect.clj
@@ -13,7 +13,7 @@
;;; -------------------------------------------------- Provider Registration --------------------------------------------------
-(derive :provider/slack-connect :provider/oidc)
+(auth-identity/derive! :provider/slack-connect :provider/oidc)
;;; -------------------------------------------------- Constants --------------------------------------------------
diff --git a/test/metabase/auth_identity/provider_test.clj b/test/metabase/auth_identity/provider_test.clj
index 861f4613684..f14c8bacbac 100644
--- a/test/metabase/auth_identity/provider_test.clj
+++ b/test/metabase/auth_identity/provider_test.clj
@@ -2,24 +2,25 @@
(:require
[clojure.test :refer :all]
[java-time.api :as t]
+ [metabase.auth-identity.core :as auth-identity]
[metabase.auth-identity.provider :as provider]
[metabase.test :as mt]
[methodical.core :as methodical]))
;; Set up test providers for testing the hierarchy
-(derive :provider/test-password ::provider/provider)
-(derive :provider/test-ldap ::provider/provider)
-(derive :provider/test-ldap ::provider/create-user-if-not-exists)
+(auth-identity/derive! :provider/test-password ::provider/provider)
+(auth-identity/derive! :provider/test-ldap ::provider/provider)
+(auth-identity/derive! :provider/test-ldap ::provider/create-user-if-not-exists)
(deftest ^:parallel provider-hierarchy-test
(testing "Provider hierarchy works correctly"
(testing "Providers can derive from ::provider/provider"
- (is (isa? :provider/test-password ::provider/provider))
- (is (isa? :provider/test-ldap ::provider/provider)))
+ (is (auth-identity/isa? :provider/test-password ::provider/provider))
+ (is (auth-identity/isa? :provider/test-ldap ::provider/provider)))
(testing "SSO providers can derive from ::provider/create-user-if-not-exists"
- (is (isa? :provider/test-ldap ::provider/create-user-if-not-exists)))
+ (is (auth-identity/isa? :provider/test-ldap ::provider/create-user-if-not-exists)))
(testing "Password providers do NOT derive from create-user-if-not-exists"
- (is (not (isa? :provider/test-password ::provider/create-user-if-not-exists))))))
+ (is (not (auth-identity/isa? :provider/test-password ::provider/create-user-if-not-exists))))))
(deftest ^:parallel validate-multimethod-test
(testing "validate multimethod has default implementation"
@@ -61,7 +62,7 @@
(testing "login! default implementation handles redirect responses"
(testing "Returns redirect response unchanged when authenticate returns :redirect"
;; Create a test provider that returns redirect
- (derive :provider/test-redirect ::provider/provider)
+ (auth-identity/derive! :provider/test-redirect ::provider/provider)
(methodical/defmethod provider/authenticate :provider/test-redirect
[_provider _request]
{:success? :redirect
@@ -77,7 +78,7 @@
(testing "login! default implementation handles failure responses"
(testing "Returns error response unchanged when authenticate fails"
;; Create a test provider that returns error
- (derive :provider/test-error ::provider/provider)
+ (auth-identity/derive! :provider/test-error ::provider/provider)
(methodical/defmethod provider/authenticate :provider/test-error
[_provider _request]
{:success? false
@@ -115,10 +116,10 @@
(testing "Success state: false"
(is (false? (:success? {:success? false :error :invalid-credentials}))))))
+(auth-identity/derive! :provider/test-custom ::provider/provider)
+
(deftest ^:parallel ^:parallel multimethod-dispatch-test
(testing "Multimethod dispatch works with provider hierarchy"
- ;; Create a test provider that inherits from ::provider/provider
- (derive :provider/test-custom ::provider/provider)
(testing "Custom provider inherits default validate implementation"
(is (nil? (provider/validate :provider/test-custom {:credentials {:foo "bar"}}))))
(testing "Custom provider inherits default authenticate implementation"
@@ -127,15 +128,17 @@
#"Authentication not implemented"
(provider/authenticate :provider/test-custom {:token "test"}))))))
+(auth-identity/derive! :provider/test-with-provider-id ::provider/provider)
+
+(methodical/defmethod provider/authenticate :provider/test-with-provider-id
+ [_provider {:keys [email] :as _request}]
+ {:success? true
+ :user-id 123
+ :provider-id email})
+
(deftest ^:parallel provider-id-in-authenticate-response-test
(testing "authenticate method returns :provider-id in success response"
(testing "Provider returns :provider-id for successful authentication"
- (derive :provider/test-with-provider-id ::provider/provider)
- (methodical/defmethod provider/authenticate :provider/test-with-provider-id
- [_provider {:keys [email] :as _request}]
- {:success? true
- :user-id 123
- :provider-id email})
(let [result (provider/authenticate :provider/test-with-provider-id {:email "[email protected]" :password "secret"})]
(is (true? (:success? result)))
(is (= 123 (:user-id result)))
@@ -145,18 +148,20 @@
(is (string? docstring))
(is (re-find #":provider-id" docstring)))))
+(auth-identity/derive! :provider/test-provider-id-flow ::provider/provider)
+
+(methodical/defmethod provider/authenticate :provider/test-provider-id-flow
+ [_provider _request]
+ {:success? true
+ :user-data {:email "[email protected]"
+ :first_name "Test"
+ :last_name "User"
+ :sso_source :test}
+ :provider-id "[email protected]"})
+
(deftest ^:parallel provider-id-flow-in-login-test
(testing "login! :around flows :provider-id to user-data"
(testing "When authenticate returns :provider-id and :user-data, it gets merged into :user-data"
- (derive :provider/test-provider-id-flow ::provider/provider)
- (methodical/defmethod provider/authenticate :provider/test-provider-id-flow
- [_provider _request]
- {:success? true
- :user-data {:email "[email protected]"
- :first_name "Test"
- :last_name "User"
- :sso_source :test}
- :provider-id "[email protected]"})
;; Test that the :around method merges :provider-id into :user-data
(let [auth-result (provider/authenticate :provider/test-provider-id-flow {:token "test"})]
(is (true? (:success? auth-result)))
@@ -169,17 +174,19 @@
(assoc-in [:user-data :provider-id] (:provider-id auth-result)))]
(is (= "[email protected]" (get-in merged-request [:user-data :provider-id]))))))))
+(auth-identity/derive! :provider/test-expired ::provider/provider)
+
+(methodical/defmethod provider/authenticate :provider/test-expired
+ [_provider _request]
+ {:success? true
+ :user-id 123
+ :auth-identity {:id 1
+ :user_id 123
+ :provider "test-expired"
+ :expires_at (t/minus (t/offset-date-time) (t/hours 1))}})
+
(deftest ^:parallel authenticate-expired-auth-identity-test
(testing "Authentication fails when auth-identity has expired"
- (derive :provider/test-expired ::provider/provider)
- (methodical/defmethod provider/authenticate :provider/test-expired
- [_provider _request]
- {:success? true
- :user-id 123
- :auth-identity {:id 1
- :user_id 123
- :provider "test-expired"
- :expires_at (t/minus (t/offset-date-time) (t/hours 1))}})
(let [result (provider/authenticate :provider/test-expired {:email "[email protected]"})]
(is (false? (:success? result))
"Authentication should fail for expired auth-identity")
@@ -188,17 +195,19 @@
(is (some? (:message result))
"Should have error message"))))
+(auth-identity/derive! :provider/test-not-expired ::provider/provider)
+
+(methodical/defmethod provider/authenticate :provider/test-not-expired
+ [_provider _request]
+ {:success? true
+ :user-id 123
+ :auth-identity {:id 1
+ :user_id 123
+ :provider "test-not-expired"
+ :expires_at (t/plus (t/offset-date-time) (t/hours 24))}})
+
(deftest ^:parallel authenticate-not-expired-auth-identity-test
(testing "Authentication succeeds when auth-identity has not expired"
- (derive :provider/test-not-expired ::provider/provider)
- (methodical/defmethod provider/authenticate :provider/test-not-expired
- [_provider _request]
- {:success? true
- :user-id 123
- :auth-identity {:id 1
- :user_id 123
- :provider "test-not-expired"
- :expires_at (t/plus (t/offset-date-time) (t/hours 24))}})
(let [result (provider/authenticate :provider/test-not-expired {:email "[email protected]"})]
(is (true? (:success? result))
"Authentication should succeed for non-expired auth-identity")
@@ -207,17 +216,19 @@
(is (= 123 (:user-id result))
"Should return user-id"))))
+(auth-identity/derive! :provider/test-no-expiration ::provider/provider)
+
+(methodical/defmethod provider/authenticate :provider/test-no-expiration
+ [_provider _request]
+ {:success? true
+ :user-id 123
+ :auth-identity {:id 1
+ :user_id 123
+ :provider "test-no-expiration"
+ :expires_at nil}})
+
(deftest ^:parallel authenticate-no-expiration-test
(testing "Authentication succeeds when auth-identity has no expiration (nil expires_at)"
- (derive :provider/test-no-expiration ::provider/provider)
- (methodical/defmethod provider/authenticate :provider/test-no-expiration
- [_provider _request]
- {:success? true
- :user-id 123
- :auth-identity {:id 1
- :user_id 123
- :provider "test-no-expiration"
- :expires_at nil}})
(let [result (provider/authenticate :provider/test-no-expiration {:email "[email protected]"})]
(is (true? (:success? result))
"Authentication should succeed when no expiration set")
@@ -226,15 +237,17 @@
(is (= 123 (:user-id result))
"Should return user-id"))))
+(auth-identity/derive! :provider/test-no-auth-identity ::provider/provider)
+
+(methodical/defmethod provider/authenticate :provider/test-no-auth-identity
+ [_provider _request]
+ {:success? true
+ :user-data {:email "[email protected]"
+ :first_name "New"
+ :last_name "User"}})
+
(deftest ^:parallel authenticate-no-auth-identity-test
(testing "Authentication with no auth-identity bypasses expiration check"
- (derive :provider/test-no-auth-identity ::provider/provider)
- (methodical/defmethod provider/authenticate :provider/test-no-auth-identity
- [_provider _request]
- {:success? true
- :user-data {:email "[email protected]"
- :first_name "New"
- :last_name "User"}})
(let [result (provider/authenticate :provider/test-no-auth-identity {:token "abc123"})]
(is (true? (:success? result))
"Authentication should succeed without auth-identity")
@@ -243,14 +256,16 @@
(is (some? (:user-data result))
"Should have user-data for new user creation"))))
+(auth-identity/derive! :provider/test-auth-failure ::provider/provider)
+
+(methodical/defmethod provider/authenticate :provider/test-auth-failure
+ [_provider _request]
+ {:success? false
+ :error :invalid-credentials
+ :message "Invalid password"})
+
(deftest ^:parallel authenticate-failure-bypasses-expiration-check-test
(testing "Failed authentication bypasses expiration check"
- (derive :provider/test-auth-failure ::provider/provider)
- (methodical/defmethod provider/authenticate :provider/test-auth-failure
- [_provider _request]
- {:success? false
- :error :invalid-credentials
- :message "Invalid password"})
(let [result (provider/authenticate :provider/test-auth-failure {:email "[email protected]" :password "wrong"})]
(is (false? (:success? result))
"Authentication should fail")
diff --git a/test/metabase/sso/integrations/slack_connect_test.clj b/test/metabase/sso/integrations/slack_connect_test.clj
index 9e0ba80c03d..618fb086856 100644
--- a/test/metabase/sso/integrations/slack_connect_test.clj
+++ b/test/metabase/sso/integrations/slack_connect_test.clj
@@ -63,9 +63,9 @@
(defmacro with-successful-oidc! [& body]
`(do
- (derive :provider/slack-connect :provider/test-successful-oidc)
+ (auth-identity/derive! :provider/slack-connect :provider/test-successful-oidc)
~@body
- (underive :provider/slack-connect :provider/test-successful-oidc)))
+ (auth-identity/underive! :provider/slack-connect :provider/test-successful-oidc)))
;;; -------------------------------------------------- Prerequisites Tests --------------------------------------------------
diff --git a/test/metabase/sso/providers/oidc_test.clj b/test/metabase/sso/providers/oidc_test.clj
index 09885056e35..06fa14fe308 100644
--- a/test/metabase/sso/providers/oidc_test.clj
+++ b/test/metabase/sso/providers/oidc_test.clj
@@ -3,6 +3,7 @@
[clj-http.client :as http]
[clojure.string :as str]
[clojure.test :refer :all]
+ [metabase.auth-identity.core :as auth-identity]
[metabase.auth-identity.provider :as provider]
[metabase.sso.oidc.discovery :as oidc.discovery]
[metabase.sso.oidc.tokens :as oidc.tokens]
@@ -325,6 +326,6 @@
(deftest provider-hierarchy-test
(testing "OIDC provider derives from base provider"
- (is (isa? :provider/oidc ::provider/provider)))
+ (is (auth-identity/isa? :provider/oidc ::provider/provider)))
(testing "OIDC provider derives from create-user-if-not-exists"
- (is (isa? :provider/oidc ::provider/create-user-if-not-exists))))
+ (is (auth-identity/isa? :provider/oidc ::provider/create-user-if-not-exists))))
diff --git a/test/metabase/sso/providers/slack_connect_test.clj b/test/metabase/sso/providers/slack_connect_test.clj
index 0cb513ab10d..445ecb24de0 100644
--- a/test/metabase/sso/providers/slack_connect_test.clj
+++ b/test/metabase/sso/providers/slack_connect_test.clj
@@ -27,9 +27,9 @@
(deftest ^:parallel provider-hierarchy-test
(testing "Slack Connect provider derives from OIDC provider"
- (is (isa? :provider/slack-connect :provider/oidc)))
+ (is (auth-identity/isa? :provider/slack-connect :provider/oidc)))
(testing "Slack Connect provider derives from create-user-if-not-exists"
- (is (isa? :provider/slack-connect ::provider/create-user-if-not-exists))))
+ (is (auth-identity/isa? :provider/slack-connect ::provider/create-user-if-not-exists))))
;;; -------------------------------------------------- Configuration Tests --------------------------------------------------