Skip to content

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

Notify admins when SSO users are provisioned (#85099)

Ethan McCuec6909dd08f5d
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.edn
index bfe852a7117..941075ec692 100644
--- a/.clj-kondo/config/modules/config.edn
+++ b/.clj-kondo/config/modules/config.edn
@@ -2806,6 +2806,7 @@
request
request.schema
session.login-history
+ settings
users
util}
:model-exports #{:model/AuthIdentity}
@@ -3220,7 +3221,6 @@
:uses #{analytics
api
batch-processing
- channel
events
lib.schema
models
diff --git a/src/metabase/auth_identity/provider.clj b/src/metabase/auth_identity/provider.clj
index 547ae698f17..b9db2e78226 100644
--- a/src/metabase/auth_identity/provider.clj
+++ b/src/metabase/auth_identity/provider.clj
@@ -58,10 +58,12 @@
[metabase.auth-identity.hierarchy :as auth-identity.hierarchy]
[metabase.auth-identity.schema :as auth-identity.schema]
[metabase.auth-identity.session :as auth-session]
+ [metabase.channel.email.messages :as messages]
[metabase.events.core :as events]
[metabase.notification.core :as notification]
[metabase.premium-features.core :refer [defenterprise]]
[metabase.request.schema :as request.schema]
+ [metabase.settings.core :as setting]
[metabase.users.schema :as users.schema]
[metabase.util :as u]
[metabase.util.i18n :refer [deferred-tru]]
@@ -293,6 +295,7 @@
[:authenticated-user {:optional true} [:maybe (ms/InstanceOfClass clojure.lang.IDeref)]]
[:claims {:optional true} [:maybe ms/JWTClaims]]
[:code {:optional true} [:maybe :string]]
+ [:created-new-user? {:optional true} [:maybe :boolean]]
[:device-info {:optional true} [:maybe DeviceInfo]]
[:email {:optional true} [:maybe :string]]
[:error {:optional true} [:maybe :keyword]]
@@ -418,7 +421,17 @@
[:user-id :user_id :user :user-data :auth-identity :provider-id :success? :session
:error :message :mfa/enroll? :mfa/pending? :mfa/methods :mfa/first-factor :session/provider
:jwt-data :claims
- :tenant-slug :tenant-attributes :user-provisioning-enabled?])
+ :tenant-slug :tenant-attributes :user-provisioning-enabled? :created-new-user?])
+
+(defn- notify-admins-of-new-sso-user!
+ "Email admins that an SSO login provisioned a new user, if `send-new-sso-user-admin-email?` is enabled. A failure
+ to send is logged rather than failing a login whose user has already been committed."
+ [{user-id :id}]
+ (when (setting/get :send-new-sso-user-admin-email?)
+ (try
+ (messages/send-user-joined-admin-notification-email! (auth-identity.db/user user-id) :sso-auth? true)
+ (catch Exception e
+ (log/errorf e "Error sending new SSO user notification to admins for user %d" user-id)))))
(methodical/defmethod login! :around ::provider
[provider request]
@@ -443,6 +456,8 @@
;; user's tenant assignment was lost) must not leave a half-provisioned account behind (UXW-4898)
(t2/with-transaction [_]
(next-method provider $))
+ (cond-> $
+ (:created-new-user? $) (u/prog1 (notify-admins-of-new-sso-user! (:user <>))))
(apply-inactive-check $)
(apply-mfa-gate provider $)
(cond-> $
@@ -498,18 +513,32 @@
(events/publish-event! :event/user-invited {:object (assoc (auth-identity.db/user (:id <>))
:sso_source (name provider))}))))))
+(defn- create-or-update-user!
+ [provider request]
+ (let [existing-user (:user request)
+ user-data (:user-data request)]
+ (cond
+ existing-user
+ {:user (cond-> existing-user
+ user-data (update-user! user-data provider))
+ :created-new-user? false}
+
+ user-data
+ {:user (create-user! user-data provider)
+ :created-new-user? true}
+
+ :else
+ {:user nil
+ :created-new-user? false})))
+
(methodical/defmethod login! ::create-user-if-not-exists
[provider request]
- (let [user (or (when-let [user (:user request)]
- (cond-> user
- (:user-data request) (update-user! (:user-data request) provider)))
- (when-let [user-data (:user-data request)]
- (create-user! user-data provider)))
- redirect-url (or (:redirect-url request) "/")]
+ (let [{:keys [user created-new-user?]} (create-or-update-user! provider request)]
(assoc request
- :success? true
- :user user
- :redirect-url redirect-url)))
+ :success? true
+ :user user
+ :redirect-url (or (:redirect-url request) "/")
+ :created-new-user? created-new-user?)))
(methodical/prefer-method! #'login! ::provider ::create-user-if-not-exists)
diff --git a/src/metabase/channel/email/messages.clj b/src/metabase/channel/email/messages.clj
index a4e6e746618..30d0d32d30e 100644
--- a/src/metabase/channel/email/messages.clj
+++ b/src/metabase/channel/email/messages.clj
@@ -167,11 +167,11 @@
(defn send-user-joined-admin-notification-email!
"Send an email to the `invitor` (the Admin who invited `new-user`) letting them know `new-user` has joined."
- [new-user & {:keys [google-auth?]}]
+ [new-user & {:keys [sso-auth?]}]
{:pre [(map? new-user)]}
(let [recipients (all-admin-recipients)]
(send-email-with-logo!
- {:subject (str (if google-auth?
+ {:subject (str (if sso-auth?
(trs "{0} created a {1} account" (:common_name new-user) (app-name-trs))
(trs "{0} accepted their {1} invite" (:common_name new-user) (app-name-trs))))
:recipients recipients
@@ -183,7 +183,7 @@
:site_url (system/site-url)}
:payload {:style {:color_text_dark channel.render/color-text-dark}}
:joinedUserName (or (:first_name new-user) (:email new-user))
- :joinedViaSSO google-auth?
+ :joinedViaSSO sso-auth?
:joinedUserEmail (:email new-user)
:joinedDate (t/format "EEEE, MMMM d" (t/zoned-date-time)) ; e.g. "Wednesday, July 13".
:joinedUserEditUrl (str (system/site-url) "/admin/people")})})))
diff --git a/src/metabase/users/models/user.clj b/src/metabase/users/models/user.clj
index 348f583625e..39a836f29b4 100644
--- a/src/metabase/users/models/user.clj
+++ b/src/metabase/users/models/user.clj
@@ -395,16 +395,6 @@
invite-target (assoc :invite_target invite-target))
:details {:invitor (select-keys invitor [:email :first_name])}}))))
-;;; TODO -- this should probably be moved into [[metabase.sso.google]]
-(mu/defn create-new-google-auth-user!
- "Convenience for creating a new user via Google Auth. This account is considered active immediately; thus all active
- admins will receive an email right away."
- [new-user :- users.schema/NewUser]
- (u/prog1 (users.db/insert-user! new-user)
- ;; send an email to everyone including the site admin if that's set
- (when (setting/get :send-new-sso-user-admin-email?)
- ((requiring-resolve 'metabase.channel.email.messages/send-user-joined-admin-notification-email!) <>, :google-auth? true))))
-
(defn form-password-reset-url
"Generate a properly formed password reset url given a password reset token."
[reset-token]
diff --git a/test/metabase/auth_identity/provider_test.clj b/test/metabase/auth_identity/provider_test.clj
index f5033bda1ab..fa727f9fa18 100644
--- a/test/metabase/auth_identity/provider_test.clj
+++ b/test/metabase/auth_identity/provider_test.clj
@@ -344,3 +344,63 @@
"Authentication should fail")
(is (= :invalid-credentials (:error result))
"Should have original error, not expiration error"))))
+
+;;; Provisions whatever `*sso-user-data*` holds, so tests can drive the real `login!` pipeline.
+(def ^:private ^:dynamic *sso-user-data* nil)
+
+(methodical/defmethod provider/authenticate :provider/test-sso-notify
+ [_provider _request]
+ {:success? true :user-data *sso-user-data*})
+
+;;; Fails after provisioning, the way a rejected group sync would, so the whole login rolls back.
+(methodical/defmethod provider/login! :after :provider/test-sso-notify-rollback
+ [_provider _result]
+ (throw (ex-info "group sync failed" {})))
+
+(defn- do-with-test-sso-providers!
+ "Run `thunk` with `:provider/test-sso-notify` and `:provider/test-sso-notify-rollback` in the auth-identity
+ hierarchy, removing them afterwards so tests that check every registered provider (e.g. the MFA gate's) never see
+ them."
+ [thunk]
+ (let [edges [[:provider/test-sso-notify ::provider/provider]
+ [:provider/test-sso-notify ::provider/create-user-if-not-exists]
+ [:provider/test-sso-notify-rollback :provider/test-sso-notify]]]
+ (doseq [[tag parent] edges]
+ (auth-identity/derive! tag parent))
+ (try
+ (thunk)
+ (finally
+ (doseq [[tag parent] (reverse edges)]
+ (auth-identity/underive! tag parent))))))
+
+(defn- sso-login-and-check-inboxes!
+ "Log in through `:provider/test-sso-notify` as `email` and return the subjects of the emails `admin-email` got."
+ [admin-email email]
+ (mt/with-fake-inbox
+ (binding [*sso-user-data* {:email email :first_name "Sso" :last_name "User" :sso_source :jwt}]
+ (provider/login! :provider/test-sso-notify {:session/skip? true}))
+ (map :subject (get @mt/inbox admin-email))))
+
+(deftest sso-provisioning-notifies-admins-test
+ (do-with-test-sso-providers!
+ (fn []
+ (mt/with-temporary-setting-values [site-name "Metabase"]
+ (mt/with-temporary-raw-setting-values [send-new-sso-user-admin-email? "true"]
+ (mt/with-temp [:model/User admin {:is_superuser true :last_login :%now}]
+ (let [email (mt/random-email)]
+ (try
+ (testing "provisioning a new user emails admins"
+ (is (= ["Sso User created a Metabase account"]
+ (sso-login-and-check-inboxes! (:email admin) email))))
+ (testing "a later login by the same user does not"
+ (is (empty? (sso-login-and-check-inboxes! (:email admin) email))))
+ (finally
+ (t2/delete! :model/User :email email))))
+ (testing "no email goes out when provisioning rolls back"
+ (let [email (mt/random-email)]
+ (mt/with-fake-inbox
+ (binding [*sso-user-data* {:email email :first_name "Sso" :last_name "User" :sso_source :jwt}]
+ (is (thrown-with-msg? clojure.lang.ExceptionInfo #"group sync failed"
+ (provider/login! :provider/test-sso-notify-rollback {:session/skip? true}))))
+ (is (not (t2/exists? :model/User :email email)))
+ (is (empty? (get @mt/inbox (:email admin)))))))))))))
diff --git a/test/metabase/users/models/user_test.clj b/test/metabase/users/models/user_test.clj
index 9fce48ccddb..195d765dcd1 100644
--- a/test/metabase/users/models/user_test.clj
+++ b/test/metabase/users/models/user_test.clj
@@ -4,6 +4,8 @@
[clojure.test :refer :all]
[metabase.app-db.core :as mdb]
[metabase.app-db.schema-migrations-test.impl :as schema-migrations-test.impl]
+ [metabase.auth-identity.core :as auth-identity]
+ [metabase.auth-identity.provider :as provider]
[metabase.config.core :as config]
[metabase.notification.test-util :as notification.tu]
[metabase.permissions.core :as perms]
@@ -21,6 +23,7 @@
[metabase.util :as u]
[metabase.util.encryption :as encryption]
[metabase.util.log.capture :as log.capture]
+ [methodical.core :as methodical]
[toucan2.core :as t2]))
(set! *warn-on-reflection* true)
@@ -29,7 +32,7 @@
:once
(fixtures/initialize :test-users :notifications))
-;;; Tests for invite-user and create-new-google-auth-user!
+;;; Tests for invite-user and SSO user provisioning
(defn- maybe-accept-invite!
"Accept an invite if applicable. Look in the body of the content of the invite email for the reset token since this is
@@ -51,10 +54,29 @@
[address (for [{subject :subject} emails]
(str/replace subject (str new-user-first-name " " new-user-last-name) "<New User>"))])))
+(def ^:private ^:dynamic *sso-user-data* nil)
+
+(methodical/defmethod provider/authenticate :provider/test-sso
+ [_provider _request]
+ {:success? true :user-data *sso-user-data*})
+
+(defn- sso-login!
+ "Provision `user-data` by logging in through `:provider/test-sso`. The provider joins the auth-identity hierarchy only
+ for this call, so tests that check every registered provider (e.g. the MFA gate's) never see it."
+ [user-data]
+ (auth-identity/derive! :provider/test-sso ::provider/provider)
+ (auth-identity/derive! :provider/test-sso ::provider/create-user-if-not-exists)
+ (try
+ (binding [*sso-user-data* user-data]
+ (provider/login! :provider/test-sso {:session/skip? true}))
+ (finally
+ (auth-identity/underive! :provider/test-sso ::provider/create-user-if-not-exists)
+ (auth-identity/underive! :provider/test-sso ::provider/provider))))
+
(defn- invite-user-accept-and-check-inboxes!
- "Create user by passing `invite-user-args` to `create-and-invite-user!` or `create-new-google-auth-user!`,
- and return a map of addresses emails were sent to to the email subjects."
- [& {:keys [google-auth? accept-invite? password invitor]
+ "Create user by passing `invite-user-args` to `create-and-invite-user!`, or via a dummy sso provider,
+ and return a map of each email address to the subjects of the emails sent to it."
+ [& {:keys [sso-auth? accept-invite? password invitor]
:or {accept-invite? true}}]
(mt/with-temporary-setting-values [site-name "Metabase"]
(mt/with-fake-inbox
@@ -66,8 +88,8 @@
:email new-user-email
:password password}]
(try
- (if google-auth?
- (user/create-new-google-auth-user! (dissoc new-user :password))
+ (if sso-auth?
+ (sso-login! (-> new-user (dissoc :password) (assoc :sso_source :google)))
(user/create-and-invite-user! new-user invitor false))
(when accept-invite?
(maybe-accept-invite! new-user-email))
@@ -156,7 +178,7 @@
(t2/update! :model/User (:id admin-2) {:last_login :%now})
(is (= {(:email admin-1) ["<New User> created a Metabase account"]
(:email admin-2) ["<New User> created a Metabase account"]}
- (-> (invite-user-accept-and-check-inboxes! :google-auth? true)
+ (-> (invite-user-accept-and-check-inboxes! :sso-auth? true)
(select-keys [(:email admin-1) (:email admin-2)])))))))))
(deftest google-auth-site-admin-email-test
@@ -168,7 +190,7 @@
(fn [admin]
(is (= {(:email admin) ["<New User> created a Metabase account"]
"[email protected]" ["<New User> created a Metabase account"]}
- (-> (invite-user-accept-and-check-inboxes! :google-auth? true)
+ (-> (invite-user-accept-and-check-inboxes! :sso-auth? true)
(select-keys [(:email admin) "[email protected]"])))))))))))
(deftest google-auth-inactive-admin-no-email-test
@@ -179,7 +201,7 @@
(fn [admin]
(mt/with-temp [:model/User inactive {:is_superuser true, :is_active false}]
(is (= {(:email admin) ["<New User> created a Metabase account"]}
- (-> (invite-user-accept-and-check-inboxes! :google-auth? true)
+ (-> (invite-user-accept-and-check-inboxes! :sso-auth? true)
(select-keys [(:email admin) (:email inactive)])))))))))))
(deftest google-auth-setting-disabled-test
@@ -192,7 +214,7 @@
(is (= (if config/ee-available?
{}
{(:email admin) ["<New User> created a Metabase account"]})
- (-> (invite-user-accept-and-check-inboxes! :google-auth? true)
+ (-> (invite-user-accept-and-check-inboxes! :sso-auth? true)
(select-keys [(:email admin)])))))))))))
(deftest sso-login-link-email-test