Merge pull request #16052 from craftcms/feature/cms-1346-impersonatin…

…g-user-and-elevated-sessions Feature/cms 1346 impersonating user and elevated sessions
craftcms · Nov 9, 2024 · f27f5a3 · f27f5a3
2 parents 3ec37c3 + f136922
commit f27f5a3
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 12 deletions.
diff --git a/CHANGELOG-WIP.md b/CHANGELOG-WIP.md
@@ -40,6 +40,8 @@
 - It’s now possible to control whether entry types’ Title fields are required. ([#15942](https://github.com/craftcms/cms/pull/15942))
 - Added the “Step Size” Number field setting.
 - Added the “Default View Mode” element source setting. ([#15824](https://github.com/craftcms/cms/pull/15824))
+- User impersonation now requires an elevated session. ([#16052](https://github.com/craftcms/cms/pull/16052))
+- Elevated session prompts now authenticate against the original user, when impersonating a user. ([#16052](https://github.com/craftcms/cms/pull/16052))
 - Added several new icons.
 - Added `pc/*` commands as an alias of `project-config/*`.
 - Added the `resave/all` command.

diff --git a/src/controllers/UsersController.php b/src/controllers/UsersController.php
@@ -243,6 +243,11 @@ public function actionLogin(): ?Response
             return $this->runAction('auth-form');
         }
 
+        // if we're impersonating, pass the user we're impersonating to the complete method
+        if (Session::get(User::IMPERSONATE_KEY) !== null) {
+            $user = Craft::$app->getUser()->getIdentity() ?? $user;
+        }
+
         return $this->_completeLogin($user, $duration);
     }
 
@@ -277,6 +282,11 @@ public function actionLoginWithPasskey(): ?Response
             return $this->_handleLoginFailure($user->authError, $user);
         }
 
+        // if we're impersonating, pass the user we're impersonating to the complete method
+        if (Session::get(User::IMPERSONATE_KEY) !== null) {
+            $user = Craft::$app->getUser()->getIdentity();
+        }
+
         return $this->_completeLogin($user, $duration);
     }
 
@@ -340,6 +350,7 @@ private function _findLoginUser(string $loginName): ?User
     public function actionImpersonate(): ?Response
     {
         $this->requirePostRequest();
+        $this->requireElevatedSession();
 
         $userSession = Craft::$app->getUser();
         $userId = $this->request->getRequiredBodyParam('userId');
@@ -378,6 +389,7 @@ public function actionImpersonate(): ?Response
     public function actionGetImpersonationUrl(): Response
     {
         $this->requirePostRequest();
+        $this->requireElevatedSession();
 
         $userId = $this->request->getBodyParam('userId');
         $user = Craft::$app->getUsers()->getUserById($userId);
@@ -504,10 +516,23 @@ public function actionLoginModal(): Response
         $this->requirePostRequest();
         $this->requireCpRequest();
 
+        $forElevatedSession = (bool)$this->request->getBodyParam('forElevatedSession');
+
+        // If the current user is being impersonated get the "original" user instead
+        if ($forElevatedSession && $previousUserId = Session::get(User::IMPERSONATE_KEY)) {
+            /** @var User $user */
+            $user = User::find()
+                ->id($previousUserId)
+                ->one();
+            $staticEmail = $user->email;
+        } else {
+            $staticEmail = $this->request->getRequiredBodyParam('email');
+        }
+
         $view = $this->getView();
         $html = $view->renderTemplate('_special/login-modal.twig', [
-            'staticEmail' => $this->request->getRequiredBodyParam('email'),
-            'forElevatedSession' => (bool)$this->request->getBodyParam('forElevatedSession'),
+            'staticEmail' => $staticEmail,
+            'forElevatedSession' => $forElevatedSession,
         ]);
 
         return $this->asJson([
@@ -2319,7 +2344,16 @@ private function _handleLoginFailure(?string $authError = null, ?User $user = nu
 
     public function actionAuthForm(): Response
     {
-        $activeMethods = Craft::$app->getAuth()->getActiveMethods();
+        $user = null;
+        // If the current user is being impersonated get the "original" user instead
+        if ($previousUserId = Session::get(User::IMPERSONATE_KEY)) {
+            /** @var User $user */
+            $user = User::find()
+                ->id($previousUserId)
+                ->one();
+        }
+
+        $activeMethods = Craft::$app->getAuth()->getActiveMethods($user);
         $methodClass = $this->request->getParam('method');
 
         if ($methodClass) {

diff --git a/src/elements/User.php b/src/elements/User.php
@@ -610,7 +610,7 @@ public static function findIdentity($id): ?self
             return $user;
         }
 
-        // If the current user is being impersonated by an admin, ignore their status
+        // If the current user is being impersonated, ignore their status
         if ($previousUserId = Session::get(self::IMPERSONATE_KEY)) {
             /** @var self|null $previousUser */
             $previousUser = self::find()
@@ -1974,6 +1974,7 @@ protected function safeActionMenuItems(): array
                         'params' => [
                             'userId' => $this->id,
                         ],
+                        'requireElevatedSession' => true,
                     ];
 
                     $copyImpersonationUrlId = sprintf('action-copy-impersonation-url-%s', mt_rand());
@@ -1985,13 +1986,15 @@ protected function safeActionMenuItems(): array
 
                     $view->registerJsWithVars(fn($id, $userId, $message) => <<<JS
 $('#' + $id).on('activate', () => {
-  Craft.sendActionRequest('POST', 'users/get-impersonation-url', {
-    data: {userId: $userId},
-  }).then((response) => {
-    Craft.ui.createCopyTextPrompt({
-      label: $message,
-      value: response.data.url,
-    });
+  Craft.elevatedSessionManager.requireElevatedSession(() => {
+      Craft.sendActionRequest('POST', 'users/get-impersonation-url', {
+        data: {userId: $userId},
+      }).then((response) => {
+        Craft.ui.createCopyTextPrompt({
+          label: $message,
+          value: response.data.url,
+        });
+      });
   });
 });
 JS, [

diff --git a/src/services/Auth.php b/src/services/Auth.php
@@ -20,6 +20,7 @@
 use craft\helpers\Component as ComponentHelper;
 use craft\helpers\DateTimeHelper;
 use craft\helpers\Json;
+use craft\helpers\Session as SessionHelper;
 use craft\models\UserGroup;
 use craft\records\WebAuthn as WebAuthnRecord;
 use craft\web\Session;
@@ -197,6 +198,13 @@ public function verify(string $methodClass, mixed ...$args): bool
         // success!
         if ($user) {
             $this->setUser(null);
+
+            // if we're impersonating, pass the user we're impersonating to the complete the login
+            if (SessionHelper::get(User::IMPERSONATE_KEY) !== null) {
+                /** @var User $user */
+                $user = Craft::$app->getUser()->getIdentity();
+            }
+
             Craft::$app->getUser()->login($user, $sessionDuration);
         }
 

diff --git a/src/web/assets/cp/CpAsset.php b/src/web/assets/cp/CpAsset.php
@@ -18,6 +18,7 @@
 use craft\helpers\DateTimeHelper;
 use craft\helpers\Html;
 use craft\helpers\Json;
+use craft\helpers\Session;
 use craft\helpers\StringHelper;
 use craft\helpers\UrlHelper;
 use craft\i18n\Locale;
@@ -515,6 +516,15 @@ private function _craftData(): array
             ];
         }
 
+        $impersonator = null;
+        // if we're impersonating, we need to check if the original user has passkey
+        if ($previousUserId = Session::get(User::IMPERSONATE_KEY)) {
+            /** @var User|null $impersonator */
+            $impersonator = User::find()
+                ->id($previousUserId)
+                ->one();
+        }
+
         $data += [
             'allowAdminChanges' => $generalConfig->allowAdminChanges,
             'allowUpdates' => $generalConfig->allowUpdates,
@@ -550,7 +560,7 @@ private function _craftData(): array
             'siteToken' => $generalConfig->siteToken,
             'slugWordSeparator' => $generalConfig->slugWordSeparator,
             'userEmail' => $currentUser->email,
-            'userHasPasskeys' => Craft::$app->getAuth()->hasPasskeys($currentUser),
+            'userHasPasskeys' => Craft::$app->getAuth()->hasPasskeys($impersonator ?? $currentUser),
             'userIsAdmin' => $currentUser->admin,
             'username' => $currentUser->username,
         ];