diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php index 5ecae9c635..36ff0256a2 100644 --- a/app/controllers/api/account.php +++ b/app/controllers/api/account.php @@ -447,13 +447,13 @@ Http::get('/v1/account') contentType: ContentType::JSON )) ->inject('response') - ->inject('user') - ->action(function (Response $response, Document $user) { - if ($user->isEmpty()) { + ->inject('targetUser') + ->action(function (Response $response, User $targetUser) { + if ($targetUser->isEmpty()) { throw new Exception(Exception::USER_NOT_FOUND); } - $response->dynamic($user, Response::MODEL_ACCOUNT); + $response->dynamic($targetUser, Response::MODEL_ACCOUNT); }); Http::delete('/v1/account') @@ -476,20 +476,20 @@ Http::delete('/v1/account') ], contentType: ContentType::NONE )) - ->inject('user') + ->inject('targetUser') ->inject('project') ->inject('response') ->inject('dbForProject') ->inject('queueForEvents') ->inject('publisherForDeletes') ->inject('authorization') - ->action(function (Document $user, Document $project, Response $response, Database $dbForProject, Event $queueForEvents, DeletePublisher $publisherForDeletes, Authorization $authorization) { - if ($user->isEmpty()) { + ->action(function (User $targetUser, Document $project, Response $response, Database $dbForProject, Event $queueForEvents, DeletePublisher $publisherForDeletes, Authorization $authorization) { + if ($targetUser->isEmpty()) { throw new Exception(Exception::USER_NOT_FOUND); } if ($project->getId() === 'console') { - $memberships = $user->getAttribute('memberships', []); + $memberships = $targetUser->getAttribute('memberships', []); foreach ($memberships as $membership) { if (!$membership->getAttribute('confirm', false)) { continue; @@ -505,17 +505,17 @@ Http::delete('/v1/account') } } - $dbForProject->deleteDocument('users', $user->getId()); + $dbForProject->deleteDocument('users', $targetUser->getId()); $publisherForDeletes->enqueue(new DeleteMessage( project: $project, type: DELETE_TYPE_DOCUMENT, - document: $user, + document: $targetUser, )); $queueForEvents - ->setParam('userId', $user->getId()) - ->setPayload($response->output($user, Response::MODEL_USER)); + ->setParam('userId', $targetUser->getId()) + ->setPayload($response->output($targetUser, Response::MODEL_USER)); $response->noContent(); }); diff --git a/app/controllers/shared/api.php b/app/controllers/shared/api.php index 4b5f7170ff..30377334d0 100644 --- a/app/controllers/shared/api.php +++ b/app/controllers/shared/api.php @@ -99,7 +99,9 @@ Http::init() ->inject('team') ->inject('apiKey') ->inject('authorization') - ->action(function (Route $route, Request $request, Database $dbForPlatform, Database $dbForProject, AuditContext $auditContext, Document $project, User $user, ?Document $session, array $servers, string $mode, Document $team, ?Key $apiKey, Authorization $authorization) { + ->inject('impersonatorUser') + ->inject('targetUser') + ->action(function (Route $route, Request $request, Database $dbForPlatform, Database $dbForProject, AuditContext $auditContext, Document $project, User $user, ?Document $session, array $servers, string $mode, Document $team, ?Key $apiKey, Authorization $authorization, Document $impersonatorUser, User $targetUser) { /** * Handle user authentication and session validation. @@ -353,7 +355,7 @@ Http::init() !$user->isEmpty() && ( $user->getAttribute('impersonator', false) - || $user->getAttribute('impersonatorUserId') + || !$impersonatorUser->isEmpty() ) ) { $scopes[] = 'users.read'; @@ -361,10 +363,16 @@ Http::init() } $authorization->addRole($role); - foreach ($user->getRoles($authorization) as $authRole) { + $rolesSource = $impersonatorUser->isEmpty() ? $user : $targetUser; + foreach ($rolesSource->getRoles($authorization) as $authRole) { $authorization->addRole($authRole); } + if (!$impersonatorUser->isEmpty() && !$targetUser->isEmpty()) { + $dbForProject->setMetadata('user', $targetUser->getId()); + $dbForPlatform->setMetadata('user', $targetUser->getId()); + } + /** * We disable authorization checks above to ensure other endpoints (list teams, members, etc.) will continue working. * But, for actions on resources (sites, functions, etc.) in a non-console project, we explicitly check @@ -391,11 +399,10 @@ Http::init() } if (! empty($user->getId())) { - $impersonatorUserId = $user->getAttribute('impersonatorUserId'); $accessedAt = $user->getAttribute('accessedAt', 0); // Skip updating accessedAt for impersonated requests so we don't attribute activity to the target user. - if (! $impersonatorUserId && DateTime::formatTz(DateTime::addSeconds(new \DateTime(), -APP_USER_ACCESS)) > $accessedAt) { + if ($impersonatorUser->isEmpty() && DateTime::formatTz(DateTime::addSeconds(new \DateTime(), -APP_USER_ACCESS)) > $accessedAt) { $user->setAttribute('accessedAt', DateTime::now()); if ($project->getId() !== 'console' && $mode !== APP_MODE_ADMIN) { @@ -410,6 +417,8 @@ Http::init() } } + $rolesSource = $impersonatorUser->isEmpty() ? $user : $targetUser; + // Steps 7-9: Access Control - Method, Namespace and Scope Validation $method = $route->getLabel('sdk', false); @@ -425,7 +434,7 @@ Http::init() if ( array_key_exists($namespace, $project->getAttribute('services', [])) && ! $project->getAttribute('services', [])[$namespace] - && ! ($user->isPrivileged($authorization->getRoles()) || $user->isKey($authorization->getRoles())) + && ! ($rolesSource->isPrivileged($authorization->getRoles()) || $rolesSource->isKey($authorization->getRoles())) ) { throw new Exception(Exception::GENERAL_SERVICE_DISABLED); } @@ -435,7 +444,7 @@ Http::init() if ( array_key_exists('rest', $project->getAttribute('apis', [])) && ! $project->getAttribute('apis', [])['rest'] - && ! ($user->isPrivileged($authorization->getRoles()) || $user->isKey($authorization->getRoles())) + && ! ($rolesSource->isPrivileged($authorization->getRoles()) || $rolesSource->isKey($authorization->getRoles())) ) { throw new AppwriteException(AppwriteException::GENERAL_API_DISABLED); } @@ -447,20 +456,20 @@ Http::init() } // Step 10: Check if user is blocked - if ($user->getAttribute('status') === false) { // Account is blocked + if ($rolesSource->getAttribute('status') === false) { // Account is blocked throw new Exception(Exception::USER_BLOCKED); } // Step 11: Verify password status - if ($user->getAttribute('reset')) { + if ($rolesSource->getAttribute('reset')) { throw new Exception(Exception::USER_PASSWORD_RESET_REQUIRED); } // Step 12: Validate MFA requirements - $mfaEnabled = $user->getAttribute('mfa', false); - $hasVerifiedEmail = $user->getAttribute('emailVerification', false); - $hasVerifiedPhone = $user->getAttribute('phoneVerification', false); - $hasVerifiedAuthenticator = TOTP::getAuthenticatorFromUser($user)?->getAttribute('verified') ?? false; + $mfaEnabled = $rolesSource->getAttribute('mfa', false); + $hasVerifiedEmail = $rolesSource->getAttribute('emailVerification', false); + $hasVerifiedPhone = $rolesSource->getAttribute('phoneVerification', false); + $hasVerifiedAuthenticator = TOTP::getAuthenticatorFromUser($rolesSource)?->getAttribute('verified') ?? false; $hasMoreFactors = $hasVerifiedEmail || $hasVerifiedPhone || $hasVerifiedAuthenticator; $minimumFactors = ($mfaEnabled && $hasMoreFactors) ? 2 : 1; @@ -566,10 +575,13 @@ Http::init() ->inject('platform') ->inject('authorization') ->inject('cacheControlForStorage') - ->action(function (Route $route, Request $request, Response $response, Document $project, User $user, Event $queueForEvents, AuditContext $auditContext, Context $usage, FunctionPublisher $publisherForFunctions, Database $dbForProject, Document $resourceToken, string $mode, ?Key $apiKey, array $plan, Telemetry $telemetry, array $platform, Authorization $authorization, callable $cacheControlForStorage) { + ->inject('impersonatorUser') + ->inject('targetUser') + ->action(function (Route $route, Request $request, Response $response, Document $project, User $user, Event $queueForEvents, AuditContext $auditContext, Context $usage, FunctionPublisher $publisherForFunctions, Database $dbForProject, Document $resourceToken, string $mode, ?Key $apiKey, array $plan, Telemetry $telemetry, array $platform, Authorization $authorization, callable $cacheControlForStorage, Document $impersonatorUser, User $targetUser) { - $response->setUser($user); - $request->setUser($user); + $response->setUser($targetUser); + $response->setImpersonatorUser($impersonatorUser); + $request->setUser($targetUser); $path = $route->getPath(); $databaseType = match (true) { @@ -588,7 +600,7 @@ Http::init() $queueForEvents ->setEvent($route->getLabel('event', '')) ->setProject($project) - ->setUser($user); + ->setUser($targetUser); $auditContext->mode = $mode; $auditContext->userAgent = $request->getUserAgent(''); @@ -596,24 +608,27 @@ Http::init() $auditContext->hostname = $request->getHostname(); $auditContext->event = $route->getLabel('audits.event', ''); $auditContext->project = $project; + $auditContext->impersonatorUser = $impersonatorUser->isEmpty() ? null : $impersonatorUser; - /* If a session exists, use the user associated with the session */ - if (! $user->isEmpty()) { - $userClone = clone $user; + /* If a session exists, use the target user (impersonated target or actor) for audit */ + if (! $targetUser->isEmpty()) { + $userClone = clone $targetUser; // $user doesn't support `type` and can cause unintended effects. - if (empty($user->getAttribute('type'))) { + if (empty($targetUser->getAttribute('type'))) { $userClone->setAttribute('type', $mode === APP_MODE_ADMIN ? ACTOR_TYPE_ADMIN : ACTOR_TYPE_USER); } $auditContext->user = $userClone; } + $rolesSource = $impersonatorUser->isEmpty() ? $user : $targetUser; + $useCache = $route->getLabel('cache', false); $storageCacheOperationsCounter = $telemetry->createCounter('storage.cache.operations.load'); if ($useCache) { $roles = $authorization->getRoles(); - $isAppUser = $user->isKey($roles); + $isAppUser = $rolesSource->isKey($roles); $isImageTransformation = $route->getPath() === '/v1/storage/buckets/:bucketId/files/:fileId/preview'; - $isDisabled = isset($plan['imageTransformations']) && $plan['imageTransformations'] === -1 && ! $user->isPrivileged($roles); + $isDisabled = isset($plan['imageTransformations']) && $plan['imageTransformations'] === -1 && ! $rolesSource->isPrivileged($roles); $key = $request->cacheIdentifier(); Span::add('storage.cache.key', $key); @@ -903,24 +918,25 @@ Http::shutdown() ->inject('response') ->inject('project') ->inject('user') + ->inject('targetUser') ->inject('auditContext') ->inject('publisherForAudits') ->inject('mode') - ->action(function (Route $route, array $params, Request $request, Response $response, Document $project, User $user, AuditContext $auditContext, Audit $publisherForAudits, string $mode) use ($parseLabel) { + ->action(function (Route $route, array $params, Request $request, Response $response, Document $project, User $user, User $targetUser, AuditContext $auditContext, Audit $publisherForAudits, string $mode) use ($parseLabel) { $responsePayload = $response->getPayload(); $pattern = $route->getLabel('audits.resource', null); if (! empty($pattern)) { - $resource = $parseLabel($pattern, $responsePayload, $params, $user, $project); + $resource = $parseLabel($pattern, $responsePayload, $params, $targetUser, $project); if (! empty($resource) && $resource !== $pattern) { $auditContext->resource = $resource; } } - if (! $user->isEmpty()) { - $userClone = clone $user; + if (! $targetUser->isEmpty()) { + $userClone = clone $targetUser; // $user doesn't support `type` and can cause unintended effects. - if (empty($user->getAttribute('type'))) { + if (empty($targetUser->getAttribute('type'))) { $userClone->setAttribute('type', $mode === APP_MODE_ADMIN ? ACTOR_TYPE_ADMIN : ACTOR_TYPE_USER); } $auditContext->user = $userClone; diff --git a/app/init/realtime/connection.php b/app/init/realtime/connection.php index 571b5dfc77..2a0b97bfdd 100644 --- a/app/init/realtime/connection.php +++ b/app/init/realtime/connection.php @@ -327,42 +327,76 @@ return function (Container $container): void { } } + $dbForPlatform->setMetadata('user', $user->getId()); + $dbForProject->setMetadata('user', $user->getId()); + + return $user; + }, ['request', 'project', 'console', 'authorization']); + + $container->set('impersonatorUser', function (Request $request, Document $project, Document $user, Authorization $authorization) use ($getMode, $getDbForPlatform, $getDbForProject) { + if ($user->isEmpty() || !$user->getAttribute('impersonator', false)) { + return new Document(); + } + // Query params mirror the header fallback pattern used by ?project= and ?devKey=, // allowing Console to embed impersonation in direct file/image URLs where headers cannot be set. $impersonateUserId = $request->getHeaderLine('x-appwrite-impersonate-user-id', (string)($request->getParam('impersonateuserid', '') ?: $request->getParam('impersonateUserId', ''))); $impersonateEmail = $request->getHeaderLine('x-appwrite-impersonate-user-email', (string)($request->getParam('impersonateemail', '') ?: $request->getParam('impersonateEmail', ''))); $impersonatePhone = $request->getHeaderLine('x-appwrite-impersonate-user-phone', (string)($request->getParam('impersonatephone', '') ?: $request->getParam('impersonatePhone', ''))); - if (!$user->isEmpty() && $user->getAttribute('impersonator', false)) { - $userDb = ($mode === APP_MODE_ADMIN || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; - $targetUser = null; - - if (!empty($impersonateUserId)) { - $targetUser = $authorization->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); - } elseif (!empty($impersonateEmail)) { - $targetUser = $authorization->skip(fn () => $userDb->findOne('users', [ - Query::equal('email', [\strtolower($impersonateEmail)]), - ])); - } elseif (!empty($impersonatePhone)) { - $targetUser = $authorization->skip(fn () => $userDb->findOne('users', [ - Query::equal('phone', [$impersonatePhone]), - ])); - } - - if ($targetUser !== null && !$targetUser->isEmpty()) { - $impersonator = clone $user; - $user = clone $targetUser; - $user->setAttribute('impersonatorUserId', $impersonator->getId()); - $user->setAttribute('impersonatorUserInternalId', $impersonator->getSequence()); - $user->setAttribute('impersonatorUserName', $impersonator->getAttribute('name', '')); - $user->setAttribute('impersonatorUserEmail', $impersonator->getAttribute('email', '')); - $user->setAttribute('impersonatorAccessedAt', $impersonator->getAttribute('accessedAt', 0)); - } + if (empty($impersonateUserId) && empty($impersonateEmail) && empty($impersonatePhone)) { + return new Document(); } - $dbForPlatform->setMetadata('user', $user->getId()); - $dbForProject->setMetadata('user', $user->getId()); + $mode = $getMode($request, $project); + $dbForPlatform = $getDbForPlatform($authorization); + $dbForProject = $getDbForProject($project, $authorization); + $userDb = ($mode === APP_MODE_ADMIN || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; + + $targetUser = null; + if (!empty($impersonateUserId)) { + $targetUser = $authorization->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); + } elseif (!empty($impersonateEmail)) { + $targetUser = $authorization->skip(fn () => $userDb->findOne('users', [Query::equal('email', [\strtolower($impersonateEmail)])])); + } elseif (!empty($impersonatePhone)) { + $targetUser = $authorization->skip(fn () => $userDb->findOne('users', [Query::equal('phone', [$impersonatePhone])])); + } + + if ($targetUser === null || $targetUser->isEmpty()) { + return new Document(); + } + + return new Document([ + '$id' => $user->getId(), + '$sequence' => $user->getSequence(), + 'name' => $user->getAttribute('name', ''), + 'email' => $user->getAttribute('email', ''), + 'type' => $user->getAttribute('type', $mode === APP_MODE_ADMIN ? ACTOR_TYPE_ADMIN : ACTOR_TYPE_USER), + ]); + }, ['request', 'project', 'user', 'authorization']); + + $container->set('targetUser', function (Request $request, Document $project, Document $user, Document $impersonatorUser, Authorization $authorization) use ($getMode, $getDbForPlatform, $getDbForProject) { + if ($impersonatorUser->isEmpty()) { + return $user; + } + + $impersonateUserId = $request->getHeaderLine('x-appwrite-impersonate-user-id', (string)($request->getParam('impersonateuserid', '') ?: $request->getParam('impersonateUserId', ''))); + $impersonateEmail = $request->getHeaderLine('x-appwrite-impersonate-user-email', (string)($request->getParam('impersonateemail', '') ?: $request->getParam('impersonateEmail', ''))); + $impersonatePhone = $request->getHeaderLine('x-appwrite-impersonate-user-phone', (string)($request->getParam('impersonatephone', '') ?: $request->getParam('impersonatePhone', ''))); + + $mode = $getMode($request, $project); + $dbForPlatform = $getDbForPlatform($authorization); + $dbForProject = $getDbForProject($project, $authorization); + $userDb = ($mode === APP_MODE_ADMIN || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; + + if (!empty($impersonateUserId)) { + return $authorization->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); + } elseif (!empty($impersonateEmail)) { + return $authorization->skip(fn () => $userDb->findOne('users', [Query::equal('email', [\strtolower($impersonateEmail)])])); + } elseif (!empty($impersonatePhone)) { + return $authorization->skip(fn () => $userDb->findOne('users', [Query::equal('phone', [$impersonatePhone])])); + } return $user; - }, ['request', 'project', 'console', 'authorization']); + }, ['request', 'project', 'user', 'impersonatorUser', 'authorization']); }; diff --git a/app/init/resources/request.php b/app/init/resources/request.php index 958f1a211a..ded4f735a6 100644 --- a/app/init/resources/request.php +++ b/app/init/resources/request.php @@ -110,6 +110,66 @@ return function (Container $context): void { $context->set('queueForRealtime', fn () => new Realtime(), []); $context->set('usage', fn () => new UsageContext(), []); $context->set('auditContext', fn () => new AuditContext(), []); + + $context->set('impersonatorUser', function (string $mode, Document $project, Document $user, Request $request, Database $dbForProject, Database $dbForPlatform) { + if ($user->isEmpty() || !$user->getAttribute('impersonator', false)) { + return new Document(); + } + + // Query params mirror the header fallback pattern used by ?project= and ?devKey=, + // allowing Console to embed impersonation in direct file/image URLs where headers cannot be set. + $impersonateUserId = $request->getHeaderLine('x-appwrite-impersonate-user-id', (string)($request->getParam('impersonateuserid', '') ?: $request->getParam('impersonateUserId', ''))); + $impersonateEmail = $request->getHeaderLine('x-appwrite-impersonate-user-email', (string)($request->getParam('impersonateemail', '') ?: $request->getParam('impersonateEmail', ''))); + $impersonatePhone = $request->getHeaderLine('x-appwrite-impersonate-user-phone', (string)($request->getParam('impersonatephone', '') ?: $request->getParam('impersonatePhone', ''))); + + if (empty($impersonateUserId) && empty($impersonateEmail) && empty($impersonatePhone)) { + return new Document(); + } + + $userDb = (APP_MODE_ADMIN === $mode || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; + $targetUser = null; + if (!empty($impersonateUserId)) { + $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); + } elseif (!empty($impersonateEmail)) { + $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('email', [\strtolower($impersonateEmail)])])); + } elseif (!empty($impersonatePhone)) { + $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('phone', [$impersonatePhone])])); + } + + if ($targetUser === null || $targetUser->isEmpty()) { + return new Document(); + } + + return new Document([ + '$id' => $user->getId(), + '$sequence' => $user->getSequence(), + 'name' => $user->getAttribute('name', ''), + 'email' => $user->getAttribute('email', ''), + 'type' => $user->getAttribute('type', $mode === APP_MODE_ADMIN ? ACTOR_TYPE_ADMIN : ACTOR_TYPE_USER), + ]); + }, ['mode', 'project', 'user', 'request', 'dbForProject', 'dbForPlatform']); + + $context->set('targetUser', function (Document $user, Document $impersonatorUser, string $mode, Document $project, Request $request, Database $dbForProject, Database $dbForPlatform) { + if ($impersonatorUser->isEmpty()) { + return $user; + } + + $impersonateUserId = $request->getHeaderLine('x-appwrite-impersonate-user-id', (string)($request->getParam('impersonateuserid', '') ?: $request->getParam('impersonateUserId', ''))); + $impersonateEmail = $request->getHeaderLine('x-appwrite-impersonate-user-email', (string)($request->getParam('impersonateemail', '') ?: $request->getParam('impersonateEmail', ''))); + $impersonatePhone = $request->getHeaderLine('x-appwrite-impersonate-user-phone', (string)($request->getParam('impersonatephone', '') ?: $request->getParam('impersonatePhone', ''))); + + $userDb = (APP_MODE_ADMIN === $mode || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; + if (!empty($impersonateUserId)) { + return $userDb->getAuthorization()->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); + } elseif (!empty($impersonateEmail)) { + return $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('email', [\strtolower($impersonateEmail)])])); + } elseif (!empty($impersonatePhone)) { + return $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('phone', [$impersonatePhone])])); + } + + return $user; + }, ['user', 'impersonatorUser', 'mode', 'project', 'request', 'dbForProject', 'dbForPlatform']); + $context->set('publisherForFunctions', fn (Publisher $publisher) => new FunctionPublisher( $publisher, new Queue(System::getEnv('_APP_FUNCTIONS_QUEUE_NAME', Event::FUNCTIONS_QUEUE_NAME), 'utopia-queue', Event::FUNCTIONS_QUEUE_TTL) @@ -488,33 +548,6 @@ return function (Container $context): void { } } - // Impersonation: if current user has impersonator capability and headers/params are set, act as another user - // Query params mirror the header fallback pattern used by ?project= and ?devKey=, - // allowing Console to embed impersonation in direct file/image URLs where headers cannot be set. - $impersonateUserId = $request->getHeaderLine('x-appwrite-impersonate-user-id', (string)($request->getParam('impersonateuserid', '') ?: $request->getParam('impersonateUserId', ''))); - $impersonateEmail = $request->getHeaderLine('x-appwrite-impersonate-user-email', (string)($request->getParam('impersonateemail', '') ?: $request->getParam('impersonateEmail', ''))); - $impersonatePhone = $request->getHeaderLine('x-appwrite-impersonate-user-phone', (string)($request->getParam('impersonatephone', '') ?: $request->getParam('impersonatePhone', ''))); - if (!$user->isEmpty() && $user->getAttribute('impersonator', false)) { - $userDb = (APP_MODE_ADMIN === $mode || $project->getId() === 'console') ? $dbForPlatform : $dbForProject; - $targetUser = null; - if (!empty($impersonateUserId)) { - $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->getDocument('users', $impersonateUserId)); - } elseif (!empty($impersonateEmail)) { - $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('email', [\strtolower($impersonateEmail)])])); - } elseif (!empty($impersonatePhone)) { - $targetUser = $userDb->getAuthorization()->skip(fn () => $userDb->findOne('users', [Query::equal('phone', [$impersonatePhone])])); - } - if ($targetUser !== null && !$targetUser->isEmpty()) { - $impersonator = clone $user; - $user = clone $targetUser; - $user->setAttribute('impersonatorUserId', $impersonator->getId()); - $user->setAttribute('impersonatorUserInternalId', $impersonator->getSequence()); - $user->setAttribute('impersonatorUserName', $impersonator->getAttribute('name', '')); - $user->setAttribute('impersonatorUserEmail', $impersonator->getAttribute('email', '')); - $user->setAttribute('impersonatorAccessedAt', $impersonator->getAttribute('accessedAt', 0)); - } - } - $dbForProject->setMetadata('user', $user->getId()); $dbForPlatform->setMetadata('user', $user->getId()); diff --git a/app/realtime.php b/app/realtime.php index b2b7e5fa46..88cb7404d4 100644 --- a/app/realtime.php +++ b/app/realtime.php @@ -686,6 +686,7 @@ $server->onWorkerStart(function (int $workerId) use ($server, $register, $stats, foreach (\array_keys($connections) as $connection) { $subscriptionsBefore = \count($realtime->getSubscriptionMetadata($connection)); $authorization = $realtime->connections[$connection]['authorization'] ?? null; + $impersonatedUserId = $realtime->connections[$connection]['impersonatedUserId'] ?? null; $previousUserId = $realtime->connections[$connection]['userId'] ?? ''; $meta = $realtime->getSubscriptionMetadata($connection); @@ -720,6 +721,7 @@ $server->onWorkerStart(function (int $workerId) use ($server, $register, $stats, } if ($authorization !== null && isset($realtime->connections[$connection])) { $realtime->connections[$connection]['authorization'] = $authorization; + $realtime->connections[$connection]['impersonatedUserId'] = $impersonatedUserId; } $subscriptionsAfter = \count($realtime->getSubscriptionMetadata($connection)); @@ -908,14 +910,21 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, $timelimit = $connectionContainer->get('timelimit'); $user = $connectionContainer->get('user'); /** @var User $user */ + $impersonatorUser = $connectionContainer->get('impersonatorUser'); /** @var Document $impersonatorUser */ + $targetUser = $connectionContainer->get('targetUser'); /** @var User $targetUser */ + if (!$impersonatorUser->isEmpty()) { + getConsoleDB()->setMetadata('user', $targetUser->getId()); + getProjectDB($project)->setMetadata('user', $targetUser->getId()); + } $logUser = $user; $apis = $project->getAttribute('apis', []); // Websocket is what to check, but realtime is checked too for backwards compatibility $websocketEnabled = $apis['websocket'] ?? $apis['realtime'] ?? true; + $effectiveUser = $impersonatorUser->isEmpty() ? $user : $targetUser; if ( !$websocketEnabled - && !($user->isPrivileged($authorization->getRoles()) || $user->isKey($authorization->getRoles())) + && !($effectiveUser->isPrivileged($authorization->getRoles()) || $effectiveUser->isKey($authorization->getRoles())) ) { throw new AppwriteException(AppwriteException::GENERAL_API_DISABLED); } @@ -958,9 +967,9 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, throw new Exception(Exception::REALTIME_POLICY_VIOLATION, $originValidator->getDescription()); } - $roles = $user->getRoles($authorization); + $roles = $targetUser->getRoles($authorization); - $channels = Realtime::convertChannels($request->getQuery('channels', []), $user->getId()); + $channels = Realtime::convertChannels($request->getQuery('channels', []), $targetUser->getId()); $channelCount = \count($channels); $updateStats = static function (string $projectId, ?string $teamId) use ($register, $stats): void { @@ -985,7 +994,7 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, */ if (empty($channels)) { // in case of message based 'subscribe' channels will be empty at first and only projectId and roles will be available - $sanitizedUser = empty($user->getId()) ? null : $response->output($user, Response::MODEL_ACCOUNT); + $sanitizedUser = empty($targetUser->getId()) ? null : $response->output($targetUser, Response::MODEL_ACCOUNT); $connectedPayloadJson = json_encode([ 'type' => 'connected', 'data' => [ @@ -995,8 +1004,9 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, ] ]); - $realtime->subscribe($project->getId(), $connection, '', $roles, [], [], $user->getId()); + $realtime->subscribe($project->getId(), $connection, '', $roles, [], [], $targetUser->getId()); $realtime->connections[$connection]['authorization'] = $authorization; + $realtime->connections[$connection]['impersonatedUserId'] = $impersonatorUser->isEmpty() ? null : $targetUser->getId(); $updateStats($project->getId(), $project->getAttribute('teamId')); $server->send([$connection], $connectedPayloadJson); $outboundBytes += \strlen($connectedPayloadJson); @@ -1020,7 +1030,7 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, throw new Exception(Exception::REALTIME_POLICY_VIOLATION, $e->getMessage()); } - $sanitizedUser = empty($user->getId()) ? null : $response->output($user, Response::MODEL_ACCOUNT); + $sanitizedUser = empty($targetUser->getId()) ? null : $response->output($targetUser, Response::MODEL_ACCOUNT); $mapping = []; foreach ($subscriptions as $index => $subscription) { @@ -1033,13 +1043,14 @@ $server->onOpen(function (int $connection, SwooleRequest $request) use ($server, $roles, $subscription['channels'], $subscription['queries'], - $user->getId() + $targetUser->getId() ); $mapping[$index] = $subscriptionId; } $realtime->connections[$connection]['authorization'] = $authorization; + $realtime->connections[$connection]['impersonatedUserId'] = $impersonatorUser->isEmpty() ? null : $targetUser->getId(); $updateStats($project->getId(), $project->getAttribute('teamId')); $subscriptionCount = \count($subscriptions); @@ -1164,8 +1175,13 @@ $server->onMessage(function (int $connection, string $message) use ($container, $authorization->addRole($role); } + $impersonatedUserId = $realtime->connections[$connection]['impersonatedUserId'] ?? null; + $database = getConsoleDB(); $database->setAuthorization($authorization); + if ($impersonatedUserId !== null) { + $database->setMetadata('user', $impersonatedUserId); + } if (!empty($projectId) && $projectId !== 'console') { // Negative-cache race: if any prior code path queried projects:$projectId @@ -1186,6 +1202,9 @@ $server->onMessage(function (int $connection, string $message) use ($container, $database = getProjectDB($project); $database->setAuthorization($authorization); + if ($impersonatedUserId !== null) { + $database->setMetadata('user', $impersonatedUserId); + } } else { $project = null; } diff --git a/src/Appwrite/Event/Context/Audit.php b/src/Appwrite/Event/Context/Audit.php index 1d41890476..cb2eab2a1a 100644 --- a/src/Appwrite/Event/Context/Audit.php +++ b/src/Appwrite/Event/Context/Audit.php @@ -9,6 +9,7 @@ class Audit public function __construct( public ?Document $project = null, public ?Document $user = null, + public ?Document $impersonatorUser = null, public string $mode = '', public string $userAgent = '', public string $ip = '', @@ -23,6 +24,7 @@ class Audit { return $this->project === null && $this->user === null + && $this->impersonatorUser === null && $this->mode === '' && $this->userAgent === '' && $this->ip === '' diff --git a/src/Appwrite/Event/Message/Audit.php b/src/Appwrite/Event/Message/Audit.php index ae5831c3b9..20cac964cb 100644 --- a/src/Appwrite/Event/Message/Audit.php +++ b/src/Appwrite/Event/Message/Audit.php @@ -12,6 +12,7 @@ final class Audit extends Base public readonly array $payload, public readonly Document $project = new Document(), public readonly Document $user = new Document(), + public readonly Document $impersonatorUser = new Document(), public readonly string $resource = '', public readonly string $mode = '', public readonly string $ip = '', @@ -29,6 +30,7 @@ final class Audit extends Base 'database' => $this->project->getAttribute('database', ''), ], 'user' => $this->user->getArrayCopy(), + 'impersonatorUser' => $this->impersonatorUser->getArrayCopy(), 'payload' => $this->payload, 'resource' => $this->resource, 'mode' => $this->mode, @@ -46,6 +48,7 @@ final class Audit extends Base payload: $data['payload'] ?? [], project: new Document($data['project'] ?? []), user: new Document($data['user'] ?? []), + impersonatorUser: new Document($data['impersonatorUser'] ?? []), resource: $data['resource'] ?? '', mode: $data['mode'] ?? '', ip: $data['ip'] ?? '', @@ -61,6 +64,7 @@ final class Audit extends Base payload: $context->payload, project: $context->project ?? new Document(), user: $context->user ?? new Document(), + impersonatorUser: $context->impersonatorUser ?? new Document(), resource: $context->resource, mode: $context->mode, ip: $context->ip, diff --git a/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php b/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php index 67f019e9af..45706ad2a1 100644 --- a/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php +++ b/src/Appwrite/Platform/Modules/Teams/Http/Memberships/Status/Update.php @@ -67,7 +67,7 @@ class Update extends Action ->param('secret', '', new Text(256), 'Secret key.') ->inject('request') ->inject('response') - ->inject('user') + ->inject('targetUser') ->inject('dbForProject') ->inject('authorization') ->inject('project') @@ -80,7 +80,7 @@ class Update extends Action ->callback($this->action(...)); } - public function action(string $teamId, string $membershipId, string $userId, string $secret, Request $request, Response $response, Document $user, Database $dbForProject, Authorization $authorization, $project, Reader $geodb, Event $queueForEvents, Store $store, Token $proofForToken, bool $domainVerification, ?string $cookieDomain) + public function action(string $teamId, string $membershipId, string $userId, string $secret, Request $request, Response $response, Document $targetUser, Database $dbForProject, Authorization $authorization, $project, Reader $geodb, Event $queueForEvents, Store $store, Token $proofForToken, bool $domainVerification, ?string $cookieDomain) { $protocol = $request->getProtocol(); @@ -105,16 +105,16 @@ class Update extends Action } if ($userId !== $membership->getAttribute('userId')) { - throw new Exception(Exception::TEAM_INVITE_MISMATCH, 'Invite does not belong to current user (' . $user->getAttribute('email') . ')'); + throw new Exception(Exception::TEAM_INVITE_MISMATCH, 'Invite does not belong to current user (' . $targetUser->getAttribute('email') . ')'); } - $hasSession = !$user->isEmpty(); + $hasSession = !$targetUser->isEmpty(); if (!$hasSession) { - $user->setAttributes($dbForProject->getDocument('users', $userId)->getArrayCopy()); // Get user + $targetUser->setAttributes($dbForProject->getDocument('users', $userId)->getArrayCopy()); // Get user } - if ($membership->getAttribute('userInternalId') !== $user->getSequence()) { - throw new Exception(Exception::TEAM_INVITE_MISMATCH, 'Invite does not belong to current user (' . $user->getAttribute('email') . ')'); + if ($membership->getAttribute('userInternalId') !== $targetUser->getSequence()) { + throw new Exception(Exception::TEAM_INVITE_MISMATCH, 'Invite does not belong to current user (' . $targetUser->getAttribute('email') . ')'); } if ($membership->getAttribute('confirm') === true) { @@ -126,11 +126,12 @@ class Update extends Action ->setAttribute('confirm', true) ; - $authorization->skip(fn () => $dbForProject->updateDocument('users', $user->getId(), $user->setAttribute('emailVerification', true))); + $targetUser->setAttribute('emailVerification', true); + $authorization->skip(fn () => $dbForProject->updateDocument('users', $targetUser->getId(), new Document(['emailVerification' => true]))); // Create session for the user if not logged in if (!$hasSession) { - $authorization->addRole(Role::user($user->getId())->toString()); + $authorization->addRole(Role::user($targetUser->getId())->toString()); $detector = new Detector($request->getUserAgent('UNKNOWN')); $record = $geodb->get($request->getIP()); @@ -140,14 +141,14 @@ class Update extends Action $session = new Document(array_merge([ '$id' => ID::unique(), '$permissions' => [ - Permission::read(Role::user($user->getId())), - Permission::update(Role::user($user->getId())), - Permission::delete(Role::user($user->getId())), + Permission::read(Role::user($targetUser->getId())), + Permission::update(Role::user($targetUser->getId())), + Permission::delete(Role::user($targetUser->getId())), ], - 'userId' => $user->getId(), - 'userInternalId' => $user->getSequence(), + 'userId' => $targetUser->getId(), + 'userInternalId' => $targetUser->getSequence(), 'provider' => SESSION_PROVIDER_EMAIL, - 'providerUid' => $user->getAttribute('email'), + 'providerUid' => $targetUser->getAttribute('email'), 'secret' => $proofForToken->hash($secret), // One way hash encryption to protect DB leak 'userAgent' => $request->getUserAgent('UNKNOWN'), 'ip' => $request->getIP(), @@ -161,7 +162,7 @@ class Update extends Action $authorization->addRole(Role::user($userId)->toString()); $encoded = $store - ->setProperty('id', $user->getId()) + ->setProperty('id', $targetUser->getId()) ->setProperty('secret', $secret) ->encode(); @@ -194,12 +195,12 @@ class Update extends Action $membership = $dbForProject->updateDocument('memberships', $membership->getId(), new Document(['joined' => $membership->getAttribute('joined'), 'confirm' => true])); - $dbForProject->purgeCachedDocument('users', $user->getId()); + $dbForProject->purgeCachedDocument('users', $targetUser->getId()); $authorization->skip(fn () => $dbForProject->increaseDocumentAttribute('teams', $team->getId(), 'total', 1)); $queueForEvents - ->setParam('userId', $user->getId()) + ->setParam('userId', $targetUser->getId()) ->setParam('teamId', $team->getId()) ->setParam('membershipId', $membership->getId()) ; @@ -207,8 +208,8 @@ class Update extends Action $response->dynamic( $membership ->setAttribute('teamName', $team->getAttribute('name')) - ->setAttribute('userName', $user->getAttribute('name')) - ->setAttribute('userEmail', $user->getAttribute('email')), + ->setAttribute('userName', $targetUser->getAttribute('name')) + ->setAttribute('userEmail', $targetUser->getAttribute('email')), Response::MODEL_MEMBERSHIP ); } diff --git a/src/Appwrite/Platform/Workers/Audits.php b/src/Appwrite/Platform/Workers/Audits.php index 6c45aa63f3..27d2629ce6 100644 --- a/src/Appwrite/Platform/Workers/Audits.php +++ b/src/Appwrite/Platform/Workers/Audits.php @@ -74,19 +74,14 @@ class Audits extends Action $userAgent = $auditMessage->userAgent; $ip = $auditMessage->ip; $user = $auditMessage->user; + $impersonatorUser = $auditMessage->impersonatorUser; - $impersonatorUserId = $user->getAttribute('impersonatorUserId'); - $actorUserId = $impersonatorUserId ?: $user->getId(); - $actorUserInternalId = $impersonatorUserId - ? $user->getAttribute('impersonatorUserInternalId') - : $user->getSequence(); - $actorUserName = $impersonatorUserId - ? $user->getAttribute('impersonatorUserName', '') - : $user->getAttribute('name', ''); - $actorUserEmail = $impersonatorUserId - ? $user->getAttribute('impersonatorUserEmail', '') - : $user->getAttribute('email', ''); - $userType = $user->getAttribute('type', ACTOR_TYPE_USER); + $isImpersonated = !$impersonatorUser->isEmpty(); + $actorUserId = $isImpersonated ? $impersonatorUser->getId() : $user->getId(); + $actorUserInternalId = $isImpersonated ? $impersonatorUser->getSequence() : $user->getSequence(); + $actorUserName = $isImpersonated ? $impersonatorUser->getAttribute('name', '') : $user->getAttribute('name', ''); + $actorUserEmail = $isImpersonated ? $impersonatorUser->getAttribute('email', '') : $user->getAttribute('email', ''); + $userType = $isImpersonated ? $impersonatorUser->getAttribute('type', ACTOR_TYPE_USER) : $user->getAttribute('type', ACTOR_TYPE_USER); // Create event data $eventData = [ @@ -106,7 +101,7 @@ class Audits extends Action 'time' => date("Y-m-d H:i:s", $message->getTimestamp()), ]; - if (!empty($impersonatorUserId)) { + if ($isImpersonated) { $eventData['data']['data'] = \is_array($auditPayload) ? \array_merge($auditPayload, [ 'impersonatedUserId' => $user->getId(), diff --git a/src/Appwrite/Realtime/Message/Handlers/Authentication.php b/src/Appwrite/Realtime/Message/Handlers/Authentication.php index 9065e586d3..cf46f7ccb7 100644 --- a/src/Appwrite/Realtime/Message/Handlers/Authentication.php +++ b/src/Appwrite/Realtime/Message/Handlers/Authentication.php @@ -69,7 +69,12 @@ class Authentication extends Action $roles = $user->getRoles($database->getAuthorization()); $authorization = $realtime->connections[$connectionId]['authorization'] ?? null; + $impersonatedUserId = $realtime->connections[$connectionId]['impersonatedUserId'] ?? null; $projectId = $realtime->connections[$connectionId]['projectId'] ?? null; + + if ($impersonatedUserId !== null) { + throw new Exception(Exception::REALTIME_MESSAGE_FORMAT_INVALID, 'Cannot re-authenticate on an impersonated connection.'); + } // Capture the pre-auth userId before unsubscribe() clears the connection entry, // so we can rebind any account channels that were stored under it. $previousUserId = $realtime->connections[$connectionId]['userId'] ?? ''; @@ -102,6 +107,7 @@ class Authentication extends Action if ($authorization !== null) { $realtime->connections[$connectionId]['authorization'] = $authorization; + $realtime->connections[$connectionId]['impersonatedUserId'] = $impersonatedUserId; } $subscriptionsAfter = \count($realtime->getSubscriptionMetadata($connectionId)); diff --git a/src/Appwrite/Utopia/Response.php b/src/Appwrite/Utopia/Response.php index d6b57990a4..45d0b5dc25 100644 --- a/src/Appwrite/Utopia/Response.php +++ b/src/Appwrite/Utopia/Response.php @@ -471,6 +471,16 @@ class Response extends SwooleResponse */ public function dynamic(Document $document, string $model): void { + if ( + $this->impersonatorUser !== null + && $model === self::MODEL_ACCOUNT + && $this->user !== null + && $document->getId() === $this->user->getId() + ) { + $document = clone $document; + $document->setAttribute('impersonatorUserId', $this->impersonatorUser->getId()); + } + $output = $this->output(clone $document, $model); $output = $this->applyFilters($output, $model, raw: clone $document); @@ -775,6 +785,7 @@ class Response extends SwooleResponse private ?Authorization $authorization = null; private ?DBUser $user = null; + private ?Document $impersonatorUser = null; public function setAuthorization(Authorization $authorization): void { @@ -785,4 +796,14 @@ class Response extends SwooleResponse { $this->user = $user; } + + public function setImpersonatorUser(Document $impersonatorUser): void + { + $this->impersonatorUser = $impersonatorUser->isEmpty() ? null : $impersonatorUser; + } + + public function getImpersonatorUser(): ?Document + { + return $this->impersonatorUser; + } } diff --git a/src/Appwrite/Utopia/Response/Model/Account.php b/src/Appwrite/Utopia/Response/Model/Account.php index fb03bdb155..769284d714 100644 --- a/src/Appwrite/Utopia/Response/Model/Account.php +++ b/src/Appwrite/Utopia/Response/Model/Account.php @@ -155,7 +155,7 @@ class Account extends Model 'type' => self::TYPE_STRING, 'description' => 'ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.', 'required' => false, - 'default' => '', + 'default' => null, 'example' => '5e5ea5c16897e', ]) ; diff --git a/src/Appwrite/Utopia/Response/Model/User.php b/src/Appwrite/Utopia/Response/Model/User.php index f255519bfd..da1f7fe5fc 100644 --- a/src/Appwrite/Utopia/Response/Model/User.php +++ b/src/Appwrite/Utopia/Response/Model/User.php @@ -185,7 +185,7 @@ class User extends Model 'type' => self::TYPE_STRING, 'description' => 'ID of the original actor performing the impersonation. Present only when the current request is impersonating another user. Internal audit logs attribute the action to this user, while the impersonated target is recorded only in internal audit payload data.', 'required' => false, - 'default' => '', + 'default' => null, 'example' => '5e5ea5c16897e', ]) ;