mirror of
https://github.com/appwrite/appwrite
synced 2026-04-21 21:47:16 +00:00
4672 lines
199 KiB
PHP
4672 lines
199 KiB
PHP
<?php
|
|
|
|
use Ahc\Jwt\JWT;
|
|
use Appwrite\Auth\MFA\Type;
|
|
use Appwrite\Auth\OAuth2\Exception as OAuth2Exception;
|
|
use Appwrite\Auth\Phrase;
|
|
use Appwrite\Auth\Validator\Password;
|
|
use Appwrite\Auth\Validator\PasswordDictionary;
|
|
use Appwrite\Auth\Validator\PasswordHistory;
|
|
use Appwrite\Auth\Validator\PersonalData;
|
|
use Appwrite\Auth\Validator\Phone;
|
|
use Appwrite\Detector\Detector;
|
|
use Appwrite\Event\Delete;
|
|
use Appwrite\Event\Event;
|
|
use Appwrite\Event\Mail;
|
|
use Appwrite\Event\Messaging;
|
|
use Appwrite\Event\StatsUsage;
|
|
use Appwrite\Extend\Exception;
|
|
use Appwrite\Hooks\Hooks;
|
|
use Appwrite\Network\Validator\Email as EmailValidator;
|
|
use Appwrite\Network\Validator\Redirect;
|
|
use Appwrite\OpenSSL\OpenSSL;
|
|
use Appwrite\SDK\AuthType;
|
|
use Appwrite\SDK\ContentType;
|
|
use Appwrite\SDK\Deprecated;
|
|
use Appwrite\SDK\Method;
|
|
use Appwrite\SDK\MethodType;
|
|
use Appwrite\SDK\Response as SDKResponse;
|
|
use Appwrite\Template\Template;
|
|
use Appwrite\URL\URL as URLParser;
|
|
use Appwrite\Utopia\Database\Documents\User;
|
|
use Appwrite\Utopia\Database\Validator\CustomId;
|
|
use Appwrite\Utopia\Database\Validator\Queries\Identities;
|
|
use Appwrite\Utopia\Request;
|
|
use Appwrite\Utopia\Response;
|
|
use libphonenumber\NumberParseException;
|
|
use libphonenumber\PhoneNumberUtil;
|
|
use MaxMind\Db\Reader;
|
|
use Utopia\Audit\Audit;
|
|
use Utopia\Auth\Hashes\Sha;
|
|
use Utopia\Auth\Proofs\Code as ProofsCode;
|
|
use Utopia\Auth\Proofs\Password as ProofsPassword;
|
|
use Utopia\Auth\Proofs\Token as ProofsToken;
|
|
use Utopia\Auth\Store;
|
|
use Utopia\Config\Config;
|
|
use Utopia\Database\Database;
|
|
use Utopia\Database\DateTime;
|
|
use Utopia\Database\Document;
|
|
use Utopia\Database\Exception\Duplicate;
|
|
use Utopia\Database\Exception\Order as OrderException;
|
|
use Utopia\Database\Exception\Query as QueryException;
|
|
use Utopia\Database\Helpers\ID;
|
|
use Utopia\Database\Helpers\Permission;
|
|
use Utopia\Database\Helpers\Role;
|
|
use Utopia\Database\Query;
|
|
use Utopia\Database\Validator\Authorization;
|
|
use Utopia\Database\Validator\Queries;
|
|
use Utopia\Database\Validator\Query\Cursor;
|
|
use Utopia\Database\Validator\Query\Limit;
|
|
use Utopia\Database\Validator\Query\Offset;
|
|
use Utopia\Database\Validator\UID;
|
|
use Utopia\Emails\Email;
|
|
use Utopia\Http;
|
|
use Utopia\Locale\Locale;
|
|
use Utopia\Storage\Validator\FileName;
|
|
use Utopia\System\System;
|
|
use Utopia\Validator;
|
|
use Utopia\Validator\ArrayList;
|
|
use Utopia\Validator\Assoc;
|
|
use Utopia\Validator\Boolean;
|
|
use Utopia\Validator\Range;
|
|
use Utopia\Validator\Text;
|
|
use Utopia\Validator\WhiteList;
|
|
|
|
$oauthDefaultSuccess = '/console/auth/oauth2/success';
|
|
$oauthDefaultFailure = '/console/auth/oauth2/failure';
|
|
|
|
function sendSessionAlert(Locale $locale, Document $user, Document $project, array $platform, Document $session, Mail $queueForMails)
|
|
{
|
|
$subject = $locale->getText("emails.sessionAlert.subject");
|
|
$preview = $locale->getText("emails.sessionAlert.preview");
|
|
$customTemplate = $project->getAttribute('templates', [])['email.sessionAlert-' . $locale->default] ?? [];
|
|
$smtpBaseTemplate = $project->getAttribute('smtpBaseTemplate', 'email-base');
|
|
|
|
$validator = new FileName();
|
|
if (!$validator->isValid($smtpBaseTemplate)) {
|
|
throw new Exception(Exception::GENERAL_BAD_REQUEST, 'Invalid template path');
|
|
}
|
|
|
|
$bodyTemplate = __DIR__ . '/../../config/locale/templates/' . $smtpBaseTemplate . '.tpl';
|
|
|
|
$message = Template::fromFile(__DIR__ . '/../../config/locale/templates/email-session-alert.tpl');
|
|
$message
|
|
->setParam('{{hello}}', $locale->getText("emails.sessionAlert.hello"))
|
|
->setParam('{{body}}', $locale->getText("emails.sessionAlert.body"))
|
|
->setParam('{{listDevice}}', $locale->getText("emails.sessionAlert.listDevice"))
|
|
->setParam('{{listIpAddress}}', $locale->getText("emails.sessionAlert.listIpAddress"))
|
|
->setParam('{{listCountry}}', $locale->getText("emails.sessionAlert.listCountry"))
|
|
->setParam('{{footer}}', $locale->getText("emails.sessionAlert.footer"))
|
|
->setParam('{{thanks}}', $locale->getText("emails.sessionAlert.thanks"))
|
|
->setParam('{{signature}}', $locale->getText("emails.sessionAlert.signature"));
|
|
|
|
$body = $message->render();
|
|
|
|
$smtp = $project->getAttribute('smtp', []);
|
|
$smtpEnabled = $smtp['enabled'] ?? false;
|
|
|
|
$senderEmail = System::getEnv('_APP_SYSTEM_EMAIL_ADDRESS', APP_EMAIL_TEAM);
|
|
$senderName = System::getEnv('_APP_SYSTEM_EMAIL_NAME', APP_NAME . ' Server');
|
|
$replyTo = "";
|
|
|
|
if ($smtpEnabled) {
|
|
if (!empty($smtp['senderEmail'])) {
|
|
$senderEmail = $smtp['senderEmail'];
|
|
}
|
|
if (!empty($smtp['senderName'])) {
|
|
$senderName = $smtp['senderName'];
|
|
}
|
|
if (!empty($smtp['replyTo'])) {
|
|
$replyTo = $smtp['replyTo'];
|
|
}
|
|
|
|
$queueForMails
|
|
->setSmtpHost($smtp['host'] ?? '')
|
|
->setSmtpPort($smtp['port'] ?? '')
|
|
->setSmtpUsername($smtp['username'] ?? '')
|
|
->setSmtpPassword($smtp['password'] ?? '')
|
|
->setSmtpSecure($smtp['secure'] ?? '');
|
|
|
|
if (!empty($customTemplate)) {
|
|
if (!empty($customTemplate['senderEmail'])) {
|
|
$senderEmail = $customTemplate['senderEmail'];
|
|
}
|
|
if (!empty($customTemplate['senderName'])) {
|
|
$senderName = $customTemplate['senderName'];
|
|
}
|
|
if (!empty($customTemplate['replyTo'])) {
|
|
$replyTo = $customTemplate['replyTo'];
|
|
}
|
|
|
|
$body = $customTemplate['message'] ?? '';
|
|
$subject = $customTemplate['subject'] ?? $subject;
|
|
}
|
|
|
|
$queueForMails
|
|
->setSmtpReplyTo($replyTo)
|
|
->setSmtpSenderEmail($senderEmail)
|
|
->setSmtpSenderName($senderName);
|
|
}
|
|
|
|
// session alerts should always have a client name!
|
|
$clientName = $session->getAttribute('clientName');
|
|
if (empty($clientName)) {
|
|
// fallback to the user agent and then unknown!
|
|
$userAgent = $session->getAttribute('userAgent');
|
|
$clientName = !empty($userAgent) ? $userAgent : 'UNKNOWN';
|
|
|
|
$session->setAttribute('clientName', $clientName);
|
|
}
|
|
|
|
$projectName = $project->getAttribute('name');
|
|
if ($project->getId() === 'console') {
|
|
$projectName = $platform['platformName'];
|
|
}
|
|
|
|
$emailVariables = [
|
|
'direction' => $locale->getText('settings.direction'),
|
|
'date' => (new \DateTime())->format('F j'),
|
|
'year' => (new \DateTime())->format('YYYY'),
|
|
'time' => (new \DateTime())->format('H:i:s'),
|
|
'user' => $user->getAttribute('name'),
|
|
'project' => $projectName,
|
|
'device' => $session->getAttribute('clientName'),
|
|
'ipAddress' => $session->getAttribute('ip'),
|
|
'country' => $locale->getText('countries.' . $session->getAttribute('countryCode'), $locale->getText('locale.country.unknown')),
|
|
];
|
|
|
|
if ($smtpBaseTemplate === APP_BRANDED_EMAIL_BASE_TEMPLATE) {
|
|
$emailVariables = array_merge($emailVariables, [
|
|
'accentColor' => $platform['accentColor'],
|
|
'logoUrl' => $platform['logoUrl'],
|
|
'twitter' => $platform['twitterUrl'],
|
|
'discord' => $platform['discordUrl'],
|
|
'github' => $platform['githubUrl'],
|
|
'terms' => $platform['termsUrl'],
|
|
'privacy' => $platform['privacyUrl'],
|
|
'platform' => $platform['platformName'],
|
|
]);
|
|
}
|
|
|
|
$email = $user->getAttribute('email');
|
|
|
|
$queueForMails
|
|
->setSubject($subject)
|
|
->setPreview($preview)
|
|
->setBody($body)
|
|
->setBodyTemplate($bodyTemplate)
|
|
->appendVariables($emailVariables)
|
|
->setRecipient($email);
|
|
|
|
// since this is console project, set email sender name!
|
|
if ($smtpBaseTemplate === APP_BRANDED_EMAIL_BASE_TEMPLATE) {
|
|
$queueForMails->setSenderName($platform['emailSenderName']);
|
|
}
|
|
|
|
$queueForMails->trigger();
|
|
}
|
|
|
|
|
|
$createSession = function (string $userId, string $secret, Request $request, Response $response, User $user, Database $dbForProject, Document $project, array $platform, Locale $locale, Reader $geodb, Event $queueForEvents, Mail $queueForMails, Store $store, ProofsToken $proofForToken, ProofsCode $proofForCode, Authorization $authorization) {
|
|
|
|
/** @var Appwrite\Utopia\Database\Documents\User $userFromRequest */
|
|
$userFromRequest = $authorization->skip(fn () => $dbForProject->getDocument('users', $userId));
|
|
|
|
if ($userFromRequest->isEmpty()) {
|
|
throw new Exception(Exception::USER_INVALID_TOKEN);
|
|
}
|
|
|
|
$verifiedToken = $userFromRequest->tokenVerify(null, $secret, $proofForToken)
|
|
?: $userFromRequest->tokenVerify(null, $secret, $proofForCode);
|
|
|
|
if (!$verifiedToken) {
|
|
throw new Exception(Exception::USER_INVALID_TOKEN);
|
|
}
|
|
|
|
$user->setAttributes($userFromRequest->getArrayCopy());
|
|
|
|
$duration = $project->getAttribute('auths', [])['duration'] ?? TOKEN_EXPIRATION_LOGIN_LONG;
|
|
$detector = new Detector($request->getUserAgent('UNKNOWN'));
|
|
$record = $geodb->get($request->getIP());
|
|
$sessionSecret = $proofForToken->generate();
|
|
|
|
$factor = (match ($verifiedToken->getAttribute('type')) {
|
|
TOKEN_TYPE_MAGIC_URL,
|
|
TOKEN_TYPE_OAUTH2,
|
|
TOKEN_TYPE_EMAIL => Type::EMAIL,
|
|
TOKEN_TYPE_PHONE => Type::PHONE,
|
|
TOKEN_TYPE_GENERIC => 'token',
|
|
default => throw new Exception(Exception::USER_INVALID_TOKEN)
|
|
});
|
|
|
|
$provider = match ($verifiedToken->getAttribute('type')) {
|
|
TOKEN_TYPE_VERIFICATION,
|
|
TOKEN_TYPE_RECOVERY,
|
|
TOKEN_TYPE_INVITE => SESSION_PROVIDER_EMAIL,
|
|
TOKEN_TYPE_MAGIC_URL => SESSION_PROVIDER_MAGIC_URL,
|
|
TOKEN_TYPE_PHONE => SESSION_PROVIDER_PHONE,
|
|
TOKEN_TYPE_OAUTH2 => SESSION_PROVIDER_OAUTH2,
|
|
default => SESSION_PROVIDER_TOKEN,
|
|
};
|
|
$session = new Document(array_merge(
|
|
[
|
|
'$id' => ID::unique(),
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'provider' => $provider,
|
|
'secret' => $proofForToken->hash($sessionSecret), // One way hash encryption to protect DB leak
|
|
'userAgent' => $request->getUserAgent('UNKNOWN'),
|
|
'ip' => $request->getIP(),
|
|
'factors' => [$factor],
|
|
'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--',
|
|
'expire' => DateTime::addSeconds(new \DateTime(), $duration)
|
|
],
|
|
$detector->getOS(),
|
|
$detector->getClient(),
|
|
$detector->getDevice()
|
|
));
|
|
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
|
|
$session = $dbForProject->createDocument('sessions', $session
|
|
->setAttribute('$permissions', [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
]));
|
|
|
|
$authorization->skip(fn () => $dbForProject->deleteDocument('tokens', $verifiedToken->getId()));
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
// Magic URL + Email OTP
|
|
if ($verifiedToken->getAttribute('type') === TOKEN_TYPE_MAGIC_URL || $verifiedToken->getAttribute('type') === TOKEN_TYPE_EMAIL) {
|
|
$user->setAttribute('emailVerification', true);
|
|
}
|
|
|
|
if ($verifiedToken->getAttribute('type') === TOKEN_TYPE_PHONE) {
|
|
$user->setAttribute('phoneVerification', true);
|
|
}
|
|
|
|
try {
|
|
$dbForProject->updateDocument('users', $user->getId(), $user);
|
|
} catch (\Throwable $th) {
|
|
throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Failed saving user to DB');
|
|
}
|
|
|
|
$isAllowedTokenType = match ($verifiedToken->getAttribute('type')) {
|
|
TOKEN_TYPE_MAGIC_URL,
|
|
TOKEN_TYPE_EMAIL => false,
|
|
default => true
|
|
};
|
|
|
|
$hasUserEmail = $user->getAttribute('email', false) !== false;
|
|
|
|
$isSessionAlertsEnabled = $project->getAttribute('auths', [])['sessionAlerts'] ?? false;
|
|
|
|
$isNotFirstSession = $dbForProject->count('sessions', [
|
|
Query::equal('userId', [$user->getId()]),
|
|
]) !== 1;
|
|
|
|
if ($isAllowedTokenType && $hasUserEmail && $isSessionAlertsEnabled && $isNotFirstSession) {
|
|
sendSessionAlert($locale, $user, $project, $platform, $session, $queueForMails);
|
|
}
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('sessionId', $session->getId());
|
|
|
|
$encoded = $store
|
|
->setProperty('id', $user->getId())
|
|
->setProperty('secret', $sessionSecret)
|
|
->encode();
|
|
|
|
if (!Config::getParam('domainVerification')) {
|
|
$response->addHeader('X-Fallback-Cookies', \json_encode([$store->getKey() => $encoded]));
|
|
}
|
|
|
|
$expire = DateTime::formatTz(DateTime::addSeconds(new \DateTime(), $duration));
|
|
$protocol = $request->getProtocol();
|
|
|
|
$response
|
|
->addCookie($store->getKey() . '_legacy', $encoded, (new \DateTime($expire))->getTimestamp(), '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
|
|
->addCookie($store->getKey(), $encoded, (new \DateTime($expire))->getTimestamp(), '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'))
|
|
->setStatusCode(Response::STATUS_CODE_CREATED);
|
|
|
|
$countryName = $locale->getText('countries.' . strtolower($session->getAttribute('countryCode')), $locale->getText('locale.country.unknown'));
|
|
|
|
$session
|
|
->setAttribute('current', true)
|
|
->setAttribute('countryName', $countryName)
|
|
->setAttribute('expire', $expire)
|
|
->setAttribute('secret', $encoded)
|
|
;
|
|
|
|
$response->dynamic($session, Response::MODEL_SESSION);
|
|
};
|
|
|
|
Http::post('/v1/account')
|
|
->desc('Create account')
|
|
->groups(['api', 'account', 'auth'])
|
|
->label('scope', 'sessions.write')
|
|
->label('auth.type', 'email-password')
|
|
->label('audits.event', 'user.create')
|
|
->label('audits.resource', 'user/{response.$id}')
|
|
->label('audits.userId', '{response.$id}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'account',
|
|
name: 'create',
|
|
description: '/docs/references/account/create.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_USER,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->param('userId', '', new CustomId(), 'User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.')
|
|
->param('email', '', new EmailValidator(), 'User email.')
|
|
->param('password', '', fn ($project, $passwordsDictionary) => new PasswordDictionary($passwordsDictionary, $project->getAttribute('auths', [])['passwordDictionary'] ?? false), 'New user password. Must be between 8 and 256 chars.', false, ['project', 'passwordsDictionary'])
|
|
->param('name', '', new Text(128), 'User name. Max length: 128 chars.', true)
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('project')
|
|
->inject('dbForProject')
|
|
->inject('authorization')
|
|
->inject('hooks')
|
|
->action(function (string $userId, string $email, string $password, string $name, Request $request, Response $response, Document $user, Document $project, Database $dbForProject, Authorization $authorization, Hooks $hooks) {
|
|
|
|
$email = \strtolower($email);
|
|
if ('console' === $project->getId()) {
|
|
$whitelistEmails = $project->getAttribute('authWhitelistEmails');
|
|
$whitelistIPs = $project->getAttribute('authWhitelistIPs');
|
|
|
|
if (!empty($whitelistEmails) && !\in_array($email, $whitelistEmails) && !\in_array(strtoupper($email), $whitelistEmails)) {
|
|
throw new Exception(Exception::USER_EMAIL_NOT_WHITELISTED);
|
|
}
|
|
|
|
if (!empty($whitelistIPs) && !\in_array($request->getIP(), $whitelistIPs)) {
|
|
throw new Exception(Exception::USER_IP_NOT_WHITELISTED);
|
|
}
|
|
}
|
|
|
|
$limit = $project->getAttribute('auths', [])['limit'] ?? 0;
|
|
|
|
if ($limit !== 0) {
|
|
$total = $dbForProject->count('users', max: APP_LIMIT_USERS);
|
|
|
|
if ($total >= $limit) {
|
|
if ('console' === $project->getId()) {
|
|
throw new Exception(Exception::USER_CONSOLE_COUNT_EXCEEDED);
|
|
}
|
|
throw new Exception(Exception::USER_COUNT_EXCEEDED);
|
|
}
|
|
}
|
|
|
|
// Makes sure this email is not already used in another identity
|
|
$identityWithMatchingEmail = $dbForProject->findOne('identities', [
|
|
Query::equal('providerEmail', [$email]),
|
|
]);
|
|
if (!$identityWithMatchingEmail->isEmpty()) {
|
|
throw new Exception(Exception::GENERAL_BAD_REQUEST); /** Return a generic bad request to prevent exposing existing accounts */
|
|
}
|
|
|
|
if ($project->getAttribute('auths', [])['personalDataCheck'] ?? false) {
|
|
$personalDataValidator = new PersonalData($userId, $email, $name, null);
|
|
if (!$personalDataValidator->isValid($password)) {
|
|
throw new Exception(Exception::USER_PASSWORD_PERSONAL_DATA);
|
|
}
|
|
}
|
|
|
|
$hooks->trigger('passwordValidator', [$dbForProject, $project, $password, &$user, true]);
|
|
|
|
$passwordHistory = $project->getAttribute('auths', [])['passwordHistory'] ?? 0;
|
|
$proof = new ProofsPassword();
|
|
$hash = $proof->hash($password);
|
|
|
|
try {
|
|
$emailCanonical = new Email($email);
|
|
} catch (Throwable) {
|
|
$emailCanonical = null;
|
|
}
|
|
|
|
try {
|
|
$userId = $userId == 'unique()' ? ID::unique() : $userId;
|
|
$user->setAttributes([
|
|
'$id' => $userId,
|
|
'$permissions' => [
|
|
Permission::read(Role::any()),
|
|
Permission::update(Role::user($userId)),
|
|
Permission::delete(Role::user($userId)),
|
|
],
|
|
'email' => $email,
|
|
'emailVerification' => false,
|
|
'status' => true,
|
|
'password' => $hash,
|
|
'passwordHistory' => $passwordHistory > 0 ? [$hash] : [],
|
|
'passwordUpdate' => DateTime::now(),
|
|
'hash' => $proof->getHash()->getName(),
|
|
'hashOptions' => $proof->getHash()->getOptions(),
|
|
'registration' => DateTime::now(),
|
|
'reset' => false,
|
|
'name' => $name,
|
|
'mfa' => false,
|
|
'prefs' => new \stdClass(),
|
|
'sessions' => null,
|
|
'tokens' => null,
|
|
'memberships' => null,
|
|
'authenticators' => null,
|
|
'search' => implode(' ', [$userId, $email, $name]),
|
|
'accessedAt' => DateTime::now(),
|
|
'emailCanonical' => $emailCanonical?->getCanonical(),
|
|
'emailIsCanonical' => $emailCanonical?->isCanonicalSupported(),
|
|
'emailIsCorporate' => $emailCanonical?->isCorporate(),
|
|
'emailIsDisposable' => $emailCanonical?->isDisposable(),
|
|
'emailIsFree' => $emailCanonical?->isFree(),
|
|
]);
|
|
|
|
$user->removeAttribute('$sequence');
|
|
$user = $authorization->skip(fn () => $dbForProject->createDocument('users', $user));
|
|
try {
|
|
$target = $authorization->skip(fn () => $dbForProject->createDocument('targets', new Document([
|
|
'$permissions' => [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
],
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'providerType' => MESSAGE_TYPE_EMAIL,
|
|
'identifier' => $email,
|
|
])));
|
|
$user->setAttribute('targets', [...$user->getAttribute('targets', []), $target]);
|
|
} catch (Duplicate) {
|
|
$existingTarget = $dbForProject->findOne('targets', [
|
|
Query::equal('identifier', [$email]),
|
|
]);
|
|
if (!$existingTarget->isEmpty()) {
|
|
$user->setAttribute('targets', $existingTarget, Document::SET_TYPE_APPEND);
|
|
}
|
|
}
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
} catch (Duplicate) {
|
|
throw new Exception(Exception::USER_ALREADY_EXISTS);
|
|
}
|
|
|
|
$authorization->removeRole(Role::guests()->toString());
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
$authorization->addRole(Role::users()->toString());
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_CREATED)
|
|
->dynamic($user, Response::MODEL_ACCOUNT);
|
|
});
|
|
|
|
Http::get('/v1/account')
|
|
->desc('Get account')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'account')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'account',
|
|
name: 'get',
|
|
description: '/docs/references/account/get.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_USER,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->inject('response')
|
|
->inject('user')
|
|
->action(function (Response $response, Document $user) {
|
|
if ($user->isEmpty()) {
|
|
throw new Exception(Exception::USER_NOT_FOUND);
|
|
}
|
|
|
|
$response->dynamic($user, Response::MODEL_ACCOUNT);
|
|
});
|
|
|
|
Http::delete('/v1/account')
|
|
->desc('Delete account')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'account')
|
|
->label('audits.event', 'user.delete')
|
|
->label('audits.resource', 'user/{response.$id}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'account',
|
|
name: 'delete',
|
|
description: '/docs/references/account/delete.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_NOCONTENT,
|
|
model: Response::MODEL_NONE,
|
|
)
|
|
],
|
|
contentType: ContentType::NONE
|
|
))
|
|
->inject('user')
|
|
->inject('project')
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->inject('queueForDeletes')
|
|
->action(function (Document $user, Document $project, Response $response, Database $dbForProject, Event $queueForEvents, Delete $queueForDeletes) {
|
|
if ($user->isEmpty()) {
|
|
throw new Exception(Exception::USER_NOT_FOUND);
|
|
}
|
|
|
|
if ($project->getId() === 'console') {
|
|
// get all memberships
|
|
$memberships = $user->getAttribute('memberships', []);
|
|
foreach ($memberships as $membership) {
|
|
// prevent deletion if at least one active membership
|
|
if ($membership->getAttribute('confirm', false)) {
|
|
throw new Exception(Exception::USER_DELETION_PROHIBITED);
|
|
}
|
|
}
|
|
}
|
|
|
|
$dbForProject->deleteDocument('users', $user->getId());
|
|
|
|
$queueForDeletes
|
|
->setType(DELETE_TYPE_DOCUMENT)
|
|
->setDocument($user);
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setPayload($response->output($user, Response::MODEL_USER));
|
|
|
|
$response->noContent();
|
|
});
|
|
|
|
Http::get('/v1/account/sessions')
|
|
->desc('List sessions')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'account')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'sessions',
|
|
name: 'listSessions',
|
|
description: '/docs/references/account/list-sessions.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_SESSION_LIST,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
))
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('locale')
|
|
->inject('store')
|
|
->inject('proofForToken')
|
|
->action(function (Response $response, User $user, Locale $locale, Store $store, ProofsToken $proofForToken) {
|
|
|
|
|
|
$sessions = $user->getAttribute('sessions', []);
|
|
$current = $user->sessionVerify($store->getProperty('secret', ''), $proofForToken);
|
|
|
|
foreach ($sessions as $key => $session) {/** @var Document $session */
|
|
$countryName = $locale->getText('countries.' . strtolower($session->getAttribute('countryCode')), $locale->getText('locale.country.unknown'));
|
|
|
|
$session->setAttribute('countryName', $countryName);
|
|
$session->setAttribute('current', ($current == $session->getId()) ? true : false);
|
|
$session->setAttribute('secret', $session->getAttribute('secret', ''));
|
|
|
|
$sessions[$key] = $session;
|
|
}
|
|
|
|
$response->dynamic(new Document([
|
|
'sessions' => $sessions,
|
|
'total' => count($sessions),
|
|
]), Response::MODEL_SESSION_LIST);
|
|
});
|
|
|
|
Http::delete('/v1/account/sessions')
|
|
->desc('Delete sessions')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'account')
|
|
->label('event', 'users.[userId].sessions.[sessionId].delete')
|
|
->label('audits.event', 'session.delete')
|
|
->label('audits.resource', 'user/{user.$id}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'sessions',
|
|
name: 'deleteSessions',
|
|
description: '/docs/references/account/delete-sessions.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_NOCONTENT,
|
|
model: Response::MODEL_NONE,
|
|
)
|
|
],
|
|
contentType: ContentType::NONE
|
|
))
|
|
->label('abuse-limit', 100)
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('locale')
|
|
->inject('queueForEvents')
|
|
->inject('queueForDeletes')
|
|
->inject('store')
|
|
->inject('proofForToken')
|
|
->action(function (Request $request, Response $response, User $user, Database $dbForProject, Locale $locale, Event $queueForEvents, Delete $queueForDeletes, Store $store, ProofsToken $proofForToken) {
|
|
|
|
$protocol = $request->getProtocol();
|
|
$sessions = $user->getAttribute('sessions', []);
|
|
|
|
foreach ($sessions as $session) {/** @var Document $session */
|
|
$dbForProject->deleteDocument('sessions', $session->getId());
|
|
|
|
if (!Config::getParam('domainVerification')) {
|
|
$response->addHeader('X-Fallback-Cookies', \json_encode([]));
|
|
}
|
|
|
|
$session
|
|
->setAttribute('current', false)
|
|
->setAttribute('countryName', $locale->getText('countries.' . strtolower($session->getAttribute('countryCode')), $locale->getText('locale.country.unknown')));
|
|
|
|
if ($proofForToken->verify($store->getProperty('secret', ''), $session->getAttribute('secret'))) {
|
|
$session->setAttribute('current', true);
|
|
|
|
// If current session delete the cookies too
|
|
$response
|
|
->addCookie($store->getKey() . '_legacy', '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
|
|
->addCookie($store->getKey(), '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'));
|
|
|
|
// Use current session for events.
|
|
$queueForEvents
|
|
->setPayload($response->output($session, Response::MODEL_SESSION));
|
|
|
|
$queueForDeletes
|
|
->setType(DELETE_TYPE_SESSION_TARGETS)
|
|
->setDocument($session)
|
|
->trigger();
|
|
}
|
|
}
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('sessionId', $session->getId());
|
|
|
|
$response->noContent();
|
|
});
|
|
|
|
Http::get('/v1/account/sessions/:sessionId')
|
|
->desc('Get session')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'account')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'sessions',
|
|
name: 'getSession',
|
|
description: '/docs/references/account/get-session.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_SESSION,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->param('sessionId', '', new UID(), 'Session ID. Use the string \'current\' to get the current device session.')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('locale')
|
|
->inject('store')
|
|
->inject('proofForToken')
|
|
->action(function (?string $sessionId, Response $response, User $user, Locale $locale, Store $store, ProofsToken $proofForToken) {
|
|
|
|
$sessions = $user->getAttribute('sessions', []);
|
|
$sessionId = ($sessionId === 'current')
|
|
? $user->sessionVerify($store->getProperty('secret', ''), $proofForToken)
|
|
: $sessionId;
|
|
|
|
foreach ($sessions as $session) {/** @var Document $session */
|
|
if ($sessionId === $session->getId()) {
|
|
$countryName = $locale->getText('countries.' . strtolower($session->getAttribute('countryCode')), $locale->getText('locale.country.unknown'));
|
|
|
|
$session
|
|
->setAttribute('current', ($proofForToken->verify($store->getProperty('secret', ''), $session->getAttribute('secret'))))
|
|
->setAttribute('countryName', $countryName)
|
|
->setAttribute('secret', $session->getAttribute('secret', ''))
|
|
;
|
|
|
|
return $response->dynamic($session, Response::MODEL_SESSION);
|
|
}
|
|
}
|
|
|
|
throw new Exception(Exception::USER_SESSION_NOT_FOUND);
|
|
});
|
|
|
|
Http::delete('/v1/account/sessions/:sessionId')
|
|
->desc('Delete session')
|
|
->groups(['api', 'account', 'mfa'])
|
|
->label('scope', 'account')
|
|
->label('event', 'users.[userId].sessions.[sessionId].delete')
|
|
->label('audits.event', 'session.delete')
|
|
->label('audits.resource', 'user/{user.$id}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'sessions',
|
|
name: 'deleteSession',
|
|
description: '/docs/references/account/delete-session.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_NOCONTENT,
|
|
model: Response::MODEL_NONE,
|
|
)
|
|
],
|
|
contentType: ContentType::NONE
|
|
))
|
|
->label('abuse-limit', 100)
|
|
->param('sessionId', '', new UID(), 'Session ID. Use the string \'current\' to delete the current device session.')
|
|
->inject('requestTimestamp')
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('locale')
|
|
->inject('queueForEvents')
|
|
->inject('queueForDeletes')
|
|
->inject('store')
|
|
->inject('proofForToken')
|
|
->action(function (?string $sessionId, ?\DateTime $requestTimestamp, Request $request, Response $response, User $user, Database $dbForProject, Locale $locale, Event $queueForEvents, Delete $queueForDeletes, Store $store, ProofsToken $proofForToken) {
|
|
|
|
$protocol = $request->getProtocol();
|
|
$sessionId = ($sessionId === 'current')
|
|
? $user->sessionVerify($store->getProperty('secret', ''), $proofForToken)
|
|
: $sessionId;
|
|
|
|
$sessions = $user->getAttribute('sessions', []);
|
|
|
|
foreach ($sessions as $key => $session) {
|
|
/** @var Document $session */
|
|
if ($sessionId !== $session->getId()) {
|
|
continue;
|
|
}
|
|
|
|
$dbForProject->deleteDocument('sessions', $session->getId());
|
|
|
|
unset($sessions[$key]);
|
|
|
|
$session->setAttribute('current', false);
|
|
|
|
if ($proofForToken->verify($store->getProperty('secret', ''), $session->getAttribute('secret'))) { // If current session delete the cookies too
|
|
$session
|
|
->setAttribute('current', true)
|
|
->setAttribute('countryName', $locale->getText('countries.' . strtolower($session->getAttribute('countryCode')), $locale->getText('locale.country.unknown')));
|
|
|
|
if (!Config::getParam('domainVerification')) {
|
|
$response->addHeader('X-Fallback-Cookies', \json_encode([]));
|
|
}
|
|
|
|
$response
|
|
->addCookie($store->getKey() . '_legacy', '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
|
|
->addCookie($store->getKey(), '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'));
|
|
}
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('sessionId', $session->getId())
|
|
->setPayload($response->output($session, Response::MODEL_SESSION));
|
|
|
|
$queueForDeletes
|
|
->setType(DELETE_TYPE_SESSION_TARGETS)
|
|
->setDocument($session)
|
|
->trigger();
|
|
|
|
$response->noContent();
|
|
return;
|
|
}
|
|
|
|
throw new Exception(Exception::USER_SESSION_NOT_FOUND);
|
|
});
|
|
|
|
Http::patch('/v1/account/sessions/:sessionId')
|
|
->desc('Update session')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'account')
|
|
->label('event', 'users.[userId].sessions.[sessionId].update')
|
|
->label('audits.event', 'session.update')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('audits.userId', '{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'sessions',
|
|
name: 'updateSession',
|
|
description: '/docs/references/account/update-session.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_SESSION,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->param('sessionId', '', new UID(), 'Session ID. Use the string \'current\' to update the current device session.')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('queueForEvents')
|
|
->inject('store')
|
|
->inject('proofForToken')
|
|
->action(function (?string $sessionId, Response $response, User $user, Database $dbForProject, Document $project, Event $queueForEvents, Store $store, ProofsToken $proofForToken) {
|
|
|
|
$sessionId = ($sessionId === 'current')
|
|
? $user->sessionVerify($store->getProperty('secret', ''), $proofForToken)
|
|
: $sessionId;
|
|
$sessions = $user->getAttribute('sessions', []);
|
|
|
|
$session = null;
|
|
foreach ($sessions as $key => $value) {
|
|
if ($sessionId === $value->getId()) {
|
|
$session = $value;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if ($session === null) {
|
|
throw new Exception(Exception::USER_SESSION_NOT_FOUND);
|
|
}
|
|
|
|
// Extend session
|
|
$authDuration = $project->getAttribute('auths', [])['duration'] ?? TOKEN_EXPIRATION_LOGIN_LONG;
|
|
$session->setAttribute('expire', DateTime::addSeconds(new \DateTime(), $authDuration));
|
|
|
|
// Refresh OAuth access token
|
|
$provider = $session->getAttribute('provider', '');
|
|
$refreshToken = $session->getAttribute('providerRefreshToken', '');
|
|
$oAuthProviders = Config::getParam('oAuthProviders');
|
|
$className = $oAuthProviders[$provider]['class'];
|
|
if (!\class_exists($className)) {
|
|
throw new Exception(Exception::PROJECT_PROVIDER_UNSUPPORTED);
|
|
}
|
|
|
|
if (!empty($provider) && \class_exists($className)) {
|
|
$appId = $project->getAttribute('oAuthProviders', [])[$provider . 'Appid'] ?? '';
|
|
$appSecret = $project->getAttribute('oAuthProviders', [])[$provider . 'Secret'] ?? '{}';
|
|
|
|
$oauth2 = new $className($appId, $appSecret, '', [], []);
|
|
$oauth2->refreshTokens($refreshToken);
|
|
|
|
$session
|
|
->setAttribute('providerAccessToken', $oauth2->getAccessToken(''))
|
|
->setAttribute('providerRefreshToken', $oauth2->getRefreshToken(''))
|
|
->setAttribute('providerAccessTokenExpiry', DateTime::addSeconds(new \DateTime(), (int) $oauth2->getAccessTokenExpiry('')));
|
|
}
|
|
|
|
// Save changes
|
|
$dbForProject->updateDocument('sessions', $sessionId, $session);
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('sessionId', $session->getId())
|
|
->setPayload($response->output($session, Response::MODEL_SESSION))
|
|
;
|
|
|
|
return $response->dynamic($session, Response::MODEL_SESSION);
|
|
});
|
|
|
|
Http::post('/v1/account/sessions/email')
|
|
->alias('/v1/account/sessions')
|
|
->desc('Create email password session')
|
|
->groups(['api', 'account', 'auth', 'session'])
|
|
->label('event', 'users.[userId].sessions.[sessionId].create')
|
|
->label('scope', 'sessions.write')
|
|
->label('auth.type', 'email-password')
|
|
->label('audits.event', 'session.create')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('audits.userId', '{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'sessions',
|
|
name: 'createEmailPasswordSession',
|
|
description: '/docs/references/account/create-session-email-password.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_SESSION,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', 'url:{url},email:{param-email}')
|
|
->label('abuse-reset', [201])
|
|
->param('email', '', new EmailValidator(), 'User email.')
|
|
->param('password', '', new Password(), 'User password. Must be at least 8 chars.')
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('locale')
|
|
->inject('geodb')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMails')
|
|
->inject('hooks')
|
|
->inject('store')
|
|
->inject('proofForPassword')
|
|
->inject('proofForToken')
|
|
->inject('authorization')
|
|
->action(function (string $email, string $password, Request $request, Response $response, User $user, Database $dbForProject, Document $project, array $platform, Locale $locale, Reader $geodb, Event $queueForEvents, Mail $queueForMails, Hooks $hooks, Store $store, ProofsPassword $proofForPassword, ProofsToken $proofForToken, Authorization $authorization) {
|
|
$email = \strtolower($email);
|
|
$protocol = $request->getProtocol();
|
|
|
|
$profile = $dbForProject->findOne('users', [
|
|
Query::equal('email', [$email]),
|
|
]);
|
|
|
|
$userProofForPassword = ProofsPassword::createHash($profile->getAttribute('hash', $proofForPassword->getHash()->getName()), $profile->getAttribute('hashOptions', $proofForPassword->getHash()->getOptions()));
|
|
|
|
if ($profile->isEmpty() || empty($profile->getAttribute('passwordUpdate')) || !$userProofForPassword->verify($password, $profile->getAttribute('password'))) {
|
|
throw new Exception(Exception::USER_INVALID_CREDENTIALS);
|
|
}
|
|
|
|
if (false === $profile->getAttribute('status')) { // Account is blocked
|
|
throw new Exception(Exception::USER_BLOCKED); // User is in status blocked
|
|
}
|
|
|
|
$user->setAttributes($profile->getArrayCopy());
|
|
|
|
$hooks->trigger('passwordValidator', [$dbForProject, $project, $password, &$user, false]);
|
|
|
|
$duration = $project->getAttribute('auths', [])['duration'] ?? TOKEN_EXPIRATION_LOGIN_LONG;
|
|
$detector = new Detector($request->getUserAgent('UNKNOWN'));
|
|
$record = $geodb->get($request->getIP());
|
|
$secret = $proofForToken->generate();
|
|
$session = new Document(array_merge(
|
|
[
|
|
'$id' => ID::unique(),
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'provider' => SESSION_PROVIDER_EMAIL,
|
|
'providerUid' => $email,
|
|
'secret' => $proofForToken->hash($secret), // One way hash encryption to protect DB leak
|
|
'userAgent' => $request->getUserAgent('UNKNOWN'),
|
|
'ip' => $request->getIP(),
|
|
'factors' => ['password'],
|
|
'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--',
|
|
'expire' => DateTime::addSeconds(new \DateTime(), $duration)
|
|
],
|
|
$detector->getOS(),
|
|
$detector->getClient(),
|
|
$detector->getDevice()
|
|
));
|
|
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
|
|
// Re-hash if not using recommended algo
|
|
if ($user->getAttribute('hash') !== $proofForPassword->getHash()->getName()) {
|
|
$proofForPasswordUpdated = new ProofsPassword();
|
|
$user
|
|
->setAttribute('password', $proofForPasswordUpdated->hash($password))
|
|
->setAttribute('hash', $proofForPasswordUpdated->getHash()->getName())
|
|
->setAttribute('hashOptions', $proofForPasswordUpdated->getHash()->getOptions());
|
|
$dbForProject->updateDocument('users', $user->getId(), $user);
|
|
}
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
$session = $dbForProject->createDocument('sessions', $session->setAttribute('$permissions', [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
]));
|
|
|
|
$encoded = $store
|
|
->setProperty('id', $user->getId())
|
|
->setProperty('secret', $secret)
|
|
->encode();
|
|
|
|
if (!Config::getParam('domainVerification')) {
|
|
$response->addHeader('X-Fallback-Cookies', \json_encode([$store->getKey() => $encoded]));
|
|
}
|
|
|
|
$expire = DateTime::formatTz(DateTime::addSeconds(new \DateTime(), $duration));
|
|
|
|
$response
|
|
->addCookie($store->getKey() . '_legacy', $encoded, (new \DateTime($expire))->getTimestamp(), '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
|
|
->addCookie($store->getKey(), $encoded, (new \DateTime($expire))->getTimestamp(), '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'))
|
|
->setStatusCode(Response::STATUS_CODE_CREATED)
|
|
;
|
|
|
|
$countryName = $locale->getText('countries.' . strtolower($session->getAttribute('countryCode')), $locale->getText('locale.country.unknown'));
|
|
|
|
$session
|
|
->setAttribute('current', true)
|
|
->setAttribute('countryName', $countryName)
|
|
->setAttribute('secret', $encoded)
|
|
;
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('sessionId', $session->getId())
|
|
;
|
|
|
|
if ($project->getAttribute('auths', [])['sessionAlerts'] ?? false) {
|
|
if (
|
|
$dbForProject->count('sessions', [
|
|
Query::equal('userId', [$user->getId()]),
|
|
]) !== 1
|
|
) {
|
|
sendSessionAlert($locale, $user, $project, $platform, $session, $queueForMails);
|
|
}
|
|
}
|
|
|
|
$response->dynamic($session, Response::MODEL_SESSION);
|
|
});
|
|
|
|
Http::post('/v1/account/sessions/anonymous')
|
|
->desc('Create anonymous session')
|
|
->groups(['api', 'account', 'auth', 'session'])
|
|
->label('event', 'users.[userId].sessions.[sessionId].create')
|
|
->label('scope', 'sessions.write')
|
|
->label('auth.type', 'anonymous')
|
|
->label('audits.event', 'session.create')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('audits.userId', '{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'sessions',
|
|
name: 'createAnonymousSession',
|
|
description: '/docs/references/account/create-session-anonymous.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_SESSION,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->label('abuse-limit', 50)
|
|
->label('abuse-key', 'ip:{ip}')
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('locale')
|
|
->inject('user')
|
|
->inject('project')
|
|
->inject('dbForProject')
|
|
->inject('geodb')
|
|
->inject('queueForEvents')
|
|
->inject('store')
|
|
->inject('proofForPassword')
|
|
->inject('proofForToken')
|
|
->inject('authorization')
|
|
->action(function (Request $request, Response $response, Locale $locale, User $user, Document $project, Database $dbForProject, Reader $geodb, Event $queueForEvents, Store $store, ProofsPassword $proofForPassword, ProofsToken $proofForToken, Authorization $authorization) {
|
|
$protocol = $request->getProtocol();
|
|
|
|
if ('console' === $project->getId()) {
|
|
throw new Exception(Exception::USER_ANONYMOUS_CONSOLE_PROHIBITED, 'Failed to create anonymous user');
|
|
}
|
|
|
|
$limit = $project->getAttribute('auths', [])['limit'] ?? 0;
|
|
|
|
if ($limit !== 0) {
|
|
$total = $dbForProject->count('users', max: APP_LIMIT_USERS);
|
|
|
|
if ($total >= $limit) {
|
|
throw new Exception(Exception::USER_COUNT_EXCEEDED);
|
|
}
|
|
}
|
|
|
|
$userId = ID::unique();
|
|
$user->setAttributes([
|
|
'$id' => $userId,
|
|
'$permissions' => [
|
|
Permission::read(Role::any()),
|
|
Permission::update(Role::user($userId)),
|
|
Permission::delete(Role::user($userId)),
|
|
],
|
|
'email' => null,
|
|
'emailVerification' => false,
|
|
'status' => true,
|
|
'password' => null,
|
|
'hash' => $proofForPassword->getHash()->getName(),
|
|
'hashOptions' => $proofForPassword->getHash()->getOptions(),
|
|
'passwordUpdate' => null,
|
|
'registration' => DateTime::now(),
|
|
'reset' => false,
|
|
'name' => null,
|
|
'mfa' => false,
|
|
'prefs' => new \stdClass(),
|
|
'sessions' => null,
|
|
'tokens' => null,
|
|
'memberships' => null,
|
|
'authenticators' => null,
|
|
'search' => $userId,
|
|
'accessedAt' => DateTime::now(),
|
|
]);
|
|
$user->removeAttribute('$sequence');
|
|
$user = $authorization->skip(fn () => $dbForProject->createDocument('users', $user));
|
|
|
|
// Create session token
|
|
$duration = $project->getAttribute('auths', [])['duration'] ?? TOKEN_EXPIRATION_LOGIN_LONG;
|
|
$detector = new Detector($request->getUserAgent('UNKNOWN'));
|
|
$record = $geodb->get($request->getIP());
|
|
$secret = $proofForToken->generate();
|
|
|
|
$session = new Document(array_merge(
|
|
[
|
|
'$id' => ID::unique(),
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'provider' => SESSION_PROVIDER_ANONYMOUS,
|
|
'secret' => $proofForToken->hash($secret), // One way hash encryption to protect DB leak
|
|
'userAgent' => $request->getUserAgent('UNKNOWN'),
|
|
'ip' => $request->getIP(),
|
|
'factors' => ['anonymous'],
|
|
'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--',
|
|
'expire' => DateTime::addSeconds(new \DateTime(), $duration)
|
|
],
|
|
$detector->getOS(),
|
|
$detector->getClient(),
|
|
$detector->getDevice()
|
|
));
|
|
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
|
|
$session = $dbForProject->createDocument('sessions', $session->setAttribute('$permissions', [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
]));
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('sessionId', $session->getId())
|
|
;
|
|
|
|
$encoded = $store
|
|
->setProperty('id', $user->getId())
|
|
->setProperty('secret', $secret)
|
|
->encode();
|
|
|
|
if (!Config::getParam('domainVerification')) {
|
|
$response->addHeader('X-Fallback-Cookies', \json_encode([$store->getKey() => $encoded]));
|
|
}
|
|
|
|
$expire = DateTime::formatTz(DateTime::addSeconds(new \DateTime(), $duration));
|
|
|
|
$response
|
|
->addCookie($store->getKey() . '_legacy', $encoded, (new \DateTime($expire))->getTimestamp(), '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
|
|
->addCookie($store->getKey(), $encoded, (new \DateTime($expire))->getTimestamp(), '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'))
|
|
->setStatusCode(Response::STATUS_CODE_CREATED)
|
|
;
|
|
|
|
$countryName = $locale->getText('countries.' . strtolower($session->getAttribute('countryCode')), $locale->getText('locale.country.unknown'));
|
|
|
|
$session
|
|
->setAttribute('current', true)
|
|
->setAttribute('countryName', $countryName)
|
|
->setAttribute('secret', $encoded)
|
|
;
|
|
|
|
$response->dynamic($session, Response::MODEL_SESSION);
|
|
});
|
|
|
|
Http::post('/v1/account/sessions/token')
|
|
->desc('Create session')
|
|
->label('event', 'users.[userId].sessions.[sessionId].create')
|
|
->groups(['api', 'account', 'session'])
|
|
->label('scope', 'sessions.write')
|
|
->label('audits.event', 'session.create')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('audits.userId', '{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'sessions',
|
|
name: 'createSession',
|
|
description: '/docs/references/account/create-session.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_SESSION,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', 'ip:{ip},userId:{param-userId}')
|
|
->label('abuse-reset', [201])
|
|
->param('userId', '', new CustomId(), 'User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.')
|
|
->param('secret', '', new Text(256), 'Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.')
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('locale')
|
|
->inject('geodb')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMails')
|
|
->inject('store')
|
|
->inject('proofForToken')
|
|
->inject('proofForCode')
|
|
->inject('authorization')
|
|
->action($createSession);
|
|
|
|
Http::get('/v1/account/sessions/oauth2/:provider')
|
|
->desc('Create OAuth2 session')
|
|
->groups(['api', 'account'])
|
|
->label('error', __DIR__ . '/../../views/general/error.phtml')
|
|
->label('scope', 'sessions.write')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'sessions',
|
|
name: 'createOAuth2Session',
|
|
description: '/docs/references/account/create-session-oauth2.md',
|
|
type: MethodType::WEBAUTH,
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_MOVED_PERMANENTLY,
|
|
model: Response::MODEL_NONE,
|
|
)
|
|
],
|
|
contentType: ContentType::HTML,
|
|
hide: [APP_SDK_PLATFORM_SERVER],
|
|
))
|
|
->label('abuse-limit', 50)
|
|
->label('abuse-key', 'ip:{ip}')
|
|
->param('provider', '', new WhiteList(\array_keys(Config::getParam('oAuthProviders')), true), 'OAuth2 Provider. Currently, supported providers are: ' . \implode(', ', \array_keys(\array_filter(Config::getParam('oAuthProviders'), fn ($node) => (!$node['mock'])))) . '.')
|
|
->param('success', '', fn ($redirectValidator) => $redirectValidator, 'URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project\'s platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.', true, ['redirectValidator'])
|
|
->param('failure', '', fn ($redirectValidator) => $redirectValidator, 'URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project\'s platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.', true, ['redirectValidator'])
|
|
->param('scopes', [], new ArrayList(new Text(APP_LIMIT_ARRAY_ELEMENT_SIZE), APP_LIMIT_ARRAY_PARAMS_SIZE), 'A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of ' . APP_LIMIT_ARRAY_PARAMS_SIZE . ' scopes are allowed, each ' . APP_LIMIT_ARRAY_ELEMENT_SIZE . ' characters long.', true)
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->action(function (string $provider, string $success, string $failure, array $scopes, Request $request, Response $response, Document $project, array $platform) use ($oauthDefaultSuccess, $oauthDefaultFailure) {
|
|
$protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') === 'disabled' ? 'http' : 'https';
|
|
$port = $request->getPort();
|
|
$callbackBase = $protocol . '://' . $request->getHostname();
|
|
if ($protocol === 'https' && $port !== '443') {
|
|
$callbackBase .= ':' . $port;
|
|
} elseif ($protocol === 'http' && $port !== '80') {
|
|
$callbackBase .= ':' . $port;
|
|
}
|
|
|
|
$callback = $callbackBase . '/v1/account/sessions/oauth2/callback/' . $provider . '/' . $project->getId();
|
|
$providerEnabled = $project->getAttribute('oAuthProviders', [])[$provider . 'Enabled'] ?? false;
|
|
|
|
if (!$providerEnabled) {
|
|
throw new Exception(Exception::PROJECT_PROVIDER_DISABLED, 'This provider is disabled. Please enable the provider from your ' . APP_NAME . ' console to continue.');
|
|
}
|
|
|
|
$appId = $project->getAttribute('oAuthProviders', [])[$provider . 'Appid'] ?? '';
|
|
$appSecret = $project->getAttribute('oAuthProviders', [])[$provider . 'Secret'] ?? '{}';
|
|
|
|
if (!empty($appSecret) && isset($appSecret['version'])) {
|
|
$key = System::getEnv('_APP_OPENSSL_KEY_V' . $appSecret['version']);
|
|
$appSecret = OpenSSL::decrypt($appSecret['data'], $appSecret['method'], $key, 0, \hex2bin($appSecret['iv']), \hex2bin($appSecret['tag']));
|
|
}
|
|
|
|
if (empty($appId) || empty($appSecret)) {
|
|
throw new Exception(Exception::PROJECT_PROVIDER_DISABLED, 'This provider is disabled. Please configure the provider app ID and app secret key from your ' . APP_NAME . ' console to continue.');
|
|
}
|
|
|
|
$oAuthProviders = Config::getParam('oAuthProviders');
|
|
$className = $oAuthProviders[$provider]['class'];
|
|
if (!\class_exists($className)) {
|
|
throw new Exception(Exception::PROJECT_PROVIDER_UNSUPPORTED);
|
|
}
|
|
|
|
$host = $platform['consoleHostname'] ?? '';
|
|
$redirectBase = $protocol . '://' . $host;
|
|
if ($protocol === 'https' && $port !== '443') {
|
|
$redirectBase .= ':' . $port;
|
|
} elseif ($protocol === 'http' && $port !== '80') {
|
|
$redirectBase .= ':' . $port;
|
|
}
|
|
|
|
if (empty($success)) {
|
|
$success = $redirectBase . $oauthDefaultSuccess;
|
|
}
|
|
|
|
if (empty($failure)) {
|
|
$failure = $redirectBase . $oauthDefaultFailure;
|
|
}
|
|
|
|
$oauth2 = new $className($appId, $appSecret, $callback, [
|
|
'success' => $success,
|
|
'failure' => $failure,
|
|
'token' => false,
|
|
], $scopes);
|
|
|
|
$response
|
|
->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, max-age=0')
|
|
->addHeader('Pragma', 'no-cache')
|
|
->redirect($oauth2->getLoginURL());
|
|
});
|
|
|
|
Http::get('/v1/account/sessions/oauth2/callback/:provider/:projectId')
|
|
->desc('Get OAuth2 callback')
|
|
->groups(['account'])
|
|
->label('error', __DIR__ . '/../../views/general/error.phtml')
|
|
->label('scope', 'public')
|
|
->label('docs', false)
|
|
->param('projectId', '', new Text(1024), 'Project ID.')
|
|
->param('provider', '', new WhiteList(\array_keys(Config::getParam('oAuthProviders')), true), 'OAuth2 provider.')
|
|
->param('code', '', new Text(2048, 0), 'OAuth2 code. This is a temporary code that the will be later exchanged for an access token.', true)
|
|
->param('state', '', new Text(2048), 'Login state params.', true)
|
|
->param('error', '', new Text(2048, 0), 'Error code returned from the OAuth2 provider.', true)
|
|
->param('error_description', '', new Text(2048, 0), 'Human-readable text providing additional information about the error returned from the OAuth2 provider.', true)
|
|
->inject('request')
|
|
->inject('response')
|
|
->action(function (string $projectId, string $provider, string $code, string $state, string $error, string $error_description, Request $request, Response $response) {
|
|
$protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') === 'disabled' ? 'http' : 'https';
|
|
$port = $request->getPort();
|
|
$callbackBase = $protocol . '://' . $request->getHostname();
|
|
if ($protocol === 'https' && $port !== '443') {
|
|
$callbackBase .= ':' . $port;
|
|
} elseif ($protocol === 'http' && $port !== '80') {
|
|
$callbackBase .= ':' . $port;
|
|
}
|
|
|
|
$params = $request->getParams();
|
|
$params['project'] = $projectId;
|
|
unset($params['projectId']);
|
|
|
|
$response
|
|
->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, max-age=0')
|
|
->addHeader('Pragma', 'no-cache')
|
|
->redirect($callbackBase . '/v1/account/sessions/oauth2/' . $provider . '/redirect?'
|
|
. \http_build_query($params));
|
|
});
|
|
|
|
Http::post('/v1/account/sessions/oauth2/callback/:provider/:projectId')
|
|
->desc('Create OAuth2 callback')
|
|
->groups(['account'])
|
|
->label('error', __DIR__ . '/../../views/general/error.phtml')
|
|
->label('scope', 'public')
|
|
->label('origin', '*')
|
|
->label('docs', false)
|
|
->param('projectId', '', new Text(1024), 'Project ID.')
|
|
->param('provider', '', new WhiteList(\array_keys(Config::getParam('oAuthProviders')), true), 'OAuth2 provider.')
|
|
->param('code', '', new Text(2048, 0), 'OAuth2 code. This is a temporary code that the will be later exchanged for an access token.', true)
|
|
->param('state', '', new Text(2048), 'Login state params.', true)
|
|
->param('error', '', new Text(2048, 0), 'Error code returned from the OAuth2 provider.', true)
|
|
->param('error_description', '', new Text(2048, 0), 'Human-readable text providing additional information about the error returned from the OAuth2 provider.', true)
|
|
->inject('request')
|
|
->inject('response')
|
|
->action(function (string $projectId, string $provider, string $code, string $state, string $error, string $error_description, Request $request, Response $response) {
|
|
$protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') === 'disabled' ? 'http' : 'https';
|
|
$port = $request->getPort();
|
|
$callbackBase = $protocol . '://' . $request->getHostname();
|
|
if ($protocol === 'https' && $port !== '443') {
|
|
$callbackBase .= ':' . $port;
|
|
} elseif ($protocol === 'http' && $port !== '80') {
|
|
$callbackBase .= ':' . $port;
|
|
}
|
|
|
|
$params = $request->getParams();
|
|
$params['project'] = $projectId;
|
|
unset($params['projectId']);
|
|
|
|
$response
|
|
->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, max-age=0')
|
|
->addHeader('Pragma', 'no-cache')
|
|
->redirect($callbackBase . '/v1/account/sessions/oauth2/' . $provider . '/redirect?'
|
|
. \http_build_query($params));
|
|
});
|
|
|
|
Http::get('/v1/account/sessions/oauth2/:provider/redirect')
|
|
->desc('Get OAuth2 redirect')
|
|
->groups(['api', 'account', 'session'])
|
|
->label('error', __DIR__ . '/../../views/general/error.phtml')
|
|
->label('event', 'users.[userId].sessions.[sessionId].create')
|
|
->label('scope', 'public')
|
|
->label('audits.event', 'session.create')
|
|
->label('audits.resource', 'user/{user.$id}')
|
|
->label('audits.userId', '{user.$id}')
|
|
->label('abuse-limit', 50)
|
|
->label('abuse-key', 'ip:{ip}')
|
|
->label('docs', false)
|
|
->param('provider', '', new WhiteList(\array_keys(Config::getParam('oAuthProviders')), true), 'OAuth2 provider.')
|
|
->param('code', '', new Text(2048, 0), 'OAuth2 code. This is a temporary code that the will be later exchanged for an access token.', true)
|
|
->param('state', '', new Text(2048), 'OAuth2 state params.', true)
|
|
->param('error', '', new Text(2048, 0), 'Error code returned from the OAuth2 provider.', true)
|
|
->param('error_description', '', new Text(2048, 0), 'Human-readable text providing additional information about the error returned from the OAuth2 provider.', true)
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('project')
|
|
->inject('redirectValidator')
|
|
->inject('devKey')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('dbForPlatform')
|
|
->inject('geodb')
|
|
->inject('queueForEvents')
|
|
->inject('store')
|
|
->inject('proofForPassword')
|
|
->inject('proofForToken')
|
|
->inject('authorization')
|
|
->action(function (string $provider, string $code, string $state, string $error, string $error_description, Request $request, Response $response, Document $project, Validator $redirectValidator, Document $devKey, User $user, Database $dbForProject, Database $dbForPlatform, Reader $geodb, Event $queueForEvents, Store $store, ProofsPassword $proofForPassword, ProofsToken $proofForToken, Authorization $authorization) use ($oauthDefaultSuccess) {
|
|
$protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') === 'disabled' ? 'http' : 'https';
|
|
$port = $request->getPort();
|
|
$callbackBase = $protocol . '://' . $request->getHostname();
|
|
if ($protocol === 'https' && $port !== '443') {
|
|
$callbackBase .= ':' . $port;
|
|
} elseif ($protocol === 'http' && $port !== '80') {
|
|
$callbackBase .= ':' . $port;
|
|
}
|
|
$callback = $callbackBase . '/v1/account/sessions/oauth2/callback/' . $provider . '/' . $project->getId();
|
|
$defaultState = ['success' => $project->getAttribute('url', ''), 'failure' => ''];
|
|
$appId = $project->getAttribute('oAuthProviders', [])[$provider . 'Appid'] ?? '';
|
|
$appSecret = $project->getAttribute('oAuthProviders', [])[$provider . 'Secret'] ?? '{}';
|
|
$providerEnabled = $project->getAttribute('oAuthProviders', [])[$provider . 'Enabled'] ?? false;
|
|
|
|
$oAuthProviders = Config::getParam('oAuthProviders');
|
|
$className = $oAuthProviders[$provider]['class'];
|
|
if (!\class_exists($className)) {
|
|
throw new Exception(Exception::PROJECT_PROVIDER_UNSUPPORTED);
|
|
}
|
|
|
|
$providers = Config::getParam('oAuthProviders');
|
|
$providerName = $providers[$provider]['name'] ?? '';
|
|
|
|
/** @var Appwrite\Auth\OAuth2 $oauth2 */
|
|
$oauth2 = new $className($appId, $appSecret, $callback);
|
|
|
|
if (!empty($state)) {
|
|
try {
|
|
$state = \array_merge($defaultState, $oauth2->parseState($state));
|
|
} catch (\Throwable $exception) {
|
|
throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Failed to parse login state params as passed from OAuth2 provider');
|
|
}
|
|
} else {
|
|
$state = $defaultState;
|
|
}
|
|
|
|
// Allow redirect to rule URL if related to project
|
|
//Check if $redirectValidator is instance of Redirect class
|
|
if ($redirectValidator instanceof Redirect) {
|
|
$rules = $authorization->skip(fn () => $dbForPlatform->find('rules', [
|
|
Query::equal('domain', [
|
|
parse_url($state['success'], PHP_URL_HOST),
|
|
parse_url($state['failure'], PHP_URL_HOST)
|
|
]),
|
|
Query::equal('projectInternalId', [$project->getSequence()]),
|
|
Query::limit(2)
|
|
]));
|
|
|
|
foreach ($rules as $rule) {
|
|
$allowedHostnames = $redirectValidator->getAllowedHostnames();
|
|
$allowedHostnames[] = $rule->getAttribute('domain', '');
|
|
$redirectValidator->setAllowedHostnames($allowedHostnames);
|
|
}
|
|
}
|
|
|
|
if ($devKey->isEmpty() && !$redirectValidator->isValid($state['success'])) {
|
|
throw new Exception(Exception::PROJECT_INVALID_SUCCESS_URL);
|
|
}
|
|
|
|
if ($devKey->isEmpty() && !empty($state['failure']) && !$redirectValidator->isValid($state['failure'])) {
|
|
throw new Exception(Exception::PROJECT_INVALID_FAILURE_URL);
|
|
}
|
|
$failure = [];
|
|
if (!empty($state['failure'])) {
|
|
$failure = URLParser::parse($state['failure']);
|
|
}
|
|
$failureRedirect = (function (string $type, ?string $message = null, ?int $code = null) use ($failure, $response) {
|
|
$exception = new Exception($type, $message, $code);
|
|
if (!empty($failure)) {
|
|
$query = URLParser::parseQuery($failure['query']);
|
|
$query['error'] = json_encode([
|
|
'message' => $exception->getMessage(),
|
|
'type' => $exception->getType(),
|
|
'code' => !\is_null($code) ? $code : $exception->getCode(),
|
|
]);
|
|
$failure['query'] = URLParser::unparseQuery($query);
|
|
$response->redirect(URLParser::unparse($failure), 301);
|
|
}
|
|
|
|
throw $exception;
|
|
});
|
|
|
|
if (!$providerEnabled) {
|
|
$failureRedirect(Exception::PROJECT_PROVIDER_DISABLED, 'This provider is disabled. Please enable the provider from your ' . APP_NAME . ' console to continue.');
|
|
}
|
|
|
|
if (!empty($error)) {
|
|
$message = 'The ' . $providerName . ' OAuth2 provider returned an error: ' . $error;
|
|
if (!empty($error_description)) {
|
|
$message .= ': ' . $error_description;
|
|
}
|
|
$failureRedirect(Exception::USER_OAUTH2_PROVIDER_ERROR, $message);
|
|
}
|
|
|
|
if (empty($code)) {
|
|
$failureRedirect(Exception::USER_OAUTH2_PROVIDER_ERROR, 'Missing OAuth2 code. Please contact the Appwrite team for additional support.');
|
|
}
|
|
|
|
if (!empty($appSecret) && isset($appSecret['version'])) {
|
|
$key = System::getEnv('_APP_OPENSSL_KEY_V' . $appSecret['version']);
|
|
$appSecret = OpenSSL::decrypt($appSecret['data'], $appSecret['method'], $key, 0, \hex2bin($appSecret['iv']), \hex2bin($appSecret['tag']));
|
|
}
|
|
|
|
$accessToken = '';
|
|
$refreshToken = '';
|
|
$accessTokenExpiry = 0;
|
|
|
|
try {
|
|
$accessToken = $oauth2->getAccessToken($code);
|
|
$refreshToken = $oauth2->getRefreshToken($code);
|
|
$accessTokenExpiry = $oauth2->getAccessTokenExpiry($code);
|
|
} catch (OAuth2Exception $ex) {
|
|
$failureRedirect(
|
|
$ex->getType(),
|
|
'Failed to obtain access token. The ' . $providerName . ' OAuth2 provider returned an error: ' . $ex->getMessage(),
|
|
$ex->getCode(),
|
|
);
|
|
}
|
|
|
|
$oauth2ID = $oauth2->getUserID($accessToken);
|
|
if (empty($oauth2ID)) {
|
|
$failureRedirect(Exception::USER_MISSING_ID);
|
|
}
|
|
|
|
$name = '';
|
|
$nameOAuth = $oauth2->getUserName($accessToken);
|
|
$userParam = $request->getParam('user');
|
|
if (!empty($nameOAuth)) {
|
|
$name = $nameOAuth;
|
|
} elseif ($userParam !== null) {
|
|
$userDecoded = \json_decode($userParam, true);
|
|
if (isset($userDecoded['name']['firstName']) && isset($userDecoded['name']['lastName'])) {
|
|
$name = $userDecoded['name']['firstName'] . ' ' . $userDecoded['name']['lastName'];
|
|
}
|
|
}
|
|
$email = $oauth2->getUserEmail($accessToken);
|
|
|
|
// Check if this identity is connected to a different user
|
|
if (!$user->isEmpty()) {
|
|
$userId = $user->getId();
|
|
|
|
$identityWithMatchingEmail = $dbForProject->findOne('identities', [
|
|
Query::equal('providerEmail', [$email]),
|
|
Query::notEqual('userInternalId', $user->getSequence()),
|
|
]);
|
|
if (!$identityWithMatchingEmail->isEmpty()) {
|
|
$failureRedirect(Exception::USER_ALREADY_EXISTS);
|
|
}
|
|
|
|
$userWithMatchingEmail = $dbForProject->find('users', [
|
|
Query::equal('email', [$email]),
|
|
Query::notEqual('$id', $userId),
|
|
]);
|
|
if (!empty($userWithMatchingEmail)) {
|
|
$failureRedirect(Exception::USER_ALREADY_EXISTS);
|
|
}
|
|
|
|
$sessionUpgrade = true;
|
|
}
|
|
|
|
$current = $user->sessionVerify($store->getProperty('secret', ''), $proofForToken);
|
|
|
|
if ($current) { // Delete current session of new one.
|
|
$currentDocument = $dbForProject->getDocument('sessions', $current);
|
|
if (!$currentDocument->isEmpty()) {
|
|
$dbForProject->deleteDocument('sessions', $currentDocument->getId());
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
}
|
|
}
|
|
|
|
if ($user->isEmpty()) {
|
|
$session = $dbForProject->findOne('sessions', [ // Get user by provider id
|
|
Query::equal('provider', [$provider]),
|
|
Query::equal('providerUid', [$oauth2ID]),
|
|
]);
|
|
if (!$session->isEmpty()) {
|
|
$user->setAttributes($dbForProject->getDocument('users', $session->getAttribute('userId'))->getArrayCopy());
|
|
}
|
|
}
|
|
|
|
if ($user === false || $user->isEmpty()) { // No user logged in or with OAuth2 provider ID, create new one or connect with account with same email
|
|
if (empty($email)) {
|
|
$failureRedirect(Exception::USER_UNAUTHORIZED, 'OAuth provider failed to return email.');
|
|
}
|
|
|
|
$isVerified = $oauth2->isEmailVerified($accessToken);
|
|
|
|
$identity = $dbForProject->findOne('identities', [
|
|
Query::equal('provider', [$provider]),
|
|
Query::equal('providerUid', [$oauth2ID]),
|
|
]);
|
|
|
|
if (!$identity->isEmpty()) {
|
|
$user = $dbForProject->getDocument('users', $identity->getAttribute('userId'));
|
|
}
|
|
|
|
// If user is not found, check if there is a user with the same email
|
|
if ($user === false || $user->isEmpty()) {
|
|
$userWithEmail = $dbForProject->findOne('users', [
|
|
Query::equal('email', [$email]),
|
|
]);
|
|
if (!$userWithEmail->isEmpty()) {
|
|
if (!$isVerified) {
|
|
$failureRedirect(Exception::GENERAL_BAD_REQUEST);
|
|
}
|
|
$user->setAttributes($userWithEmail->getArrayCopy());
|
|
}
|
|
}
|
|
|
|
// If user is not found, check if there is an identity with the same email
|
|
if ($user === false || $user->isEmpty()) {
|
|
$identityWithMatchingEmail = $dbForProject->findOne('identities', [
|
|
Query::equal('providerEmail', [$email]),
|
|
]);
|
|
if (!$identityWithMatchingEmail->isEmpty()) {
|
|
if (!$isVerified) {
|
|
$failureRedirect(Exception::GENERAL_BAD_REQUEST);
|
|
}
|
|
$user->setAttributes($dbForProject->getDocument('users', $identityWithMatchingEmail->getAttribute('userId'))->getArrayCopy());
|
|
}
|
|
}
|
|
|
|
if ($user === false || $user->isEmpty()) { // Last option -> create the user
|
|
$limit = $project->getAttribute('auths', [])['limit'] ?? 0;
|
|
|
|
if ($limit !== 0) {
|
|
$total = $dbForProject->count('users', max: APP_LIMIT_USERS);
|
|
|
|
if ($total >= $limit) {
|
|
$failureRedirect(Exception::USER_COUNT_EXCEEDED);
|
|
}
|
|
}
|
|
|
|
try {
|
|
$emailCanonical = new Email($email);
|
|
} catch (Throwable) {
|
|
$emailCanonical = null;
|
|
}
|
|
|
|
try {
|
|
$userId = ID::unique();
|
|
$user->setAttributes([
|
|
'$id' => $userId,
|
|
'$permissions' => [
|
|
Permission::read(Role::any()),
|
|
Permission::update(Role::user($userId)),
|
|
Permission::delete(Role::user($userId)),
|
|
],
|
|
'email' => $email,
|
|
'emailVerification' => true,
|
|
'status' => true, // Email should already be authenticated by OAuth2 provider
|
|
'password' => null,
|
|
'hash' => $proofForPassword->getHash()->getName(),
|
|
'hashOptions' => $proofForPassword->getHash()->getOptions(),
|
|
'passwordUpdate' => null,
|
|
'registration' => DateTime::now(),
|
|
'reset' => false,
|
|
'name' => $name,
|
|
'mfa' => false,
|
|
'prefs' => new \stdClass(),
|
|
'sessions' => null,
|
|
'tokens' => null,
|
|
'memberships' => null,
|
|
'authenticators' => null,
|
|
'search' => implode(' ', [$userId, $email, $name]),
|
|
'accessedAt' => DateTime::now(),
|
|
'emailCanonical' => $emailCanonical?->getCanonical(),
|
|
'emailIsCanonical' => $emailCanonical?->isCanonicalSupported(),
|
|
'emailIsCorporate' => $emailCanonical?->isCorporate(),
|
|
'emailIsDisposable' => $emailCanonical?->isDisposable(),
|
|
'emailIsFree' => $emailCanonical?->isFree(),
|
|
]);
|
|
|
|
$user->removeAttribute('$sequence');
|
|
$userDoc = $authorization->skip(fn () => $dbForProject->createDocument('users', $user));
|
|
$dbForProject->createDocument('targets', new Document([
|
|
'$permissions' => [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
],
|
|
'userId' => $userDoc->getId(),
|
|
'userInternalId' => $userDoc->getSequence(),
|
|
'providerType' => MESSAGE_TYPE_EMAIL,
|
|
'identifier' => $email,
|
|
]));
|
|
} catch (Duplicate) {
|
|
$failureRedirect(Exception::USER_ALREADY_EXISTS);
|
|
}
|
|
}
|
|
}
|
|
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
$authorization->addRole(Role::users()->toString());
|
|
|
|
if (false === $user->getAttribute('status')) { // Account is blocked
|
|
$failureRedirect(Exception::USER_BLOCKED); // User is in status blocked
|
|
}
|
|
|
|
$identity = $dbForProject->findOne('identities', [
|
|
Query::equal('userInternalId', [$user->getSequence()]),
|
|
Query::equal('provider', [$provider]),
|
|
Query::equal('providerUid', [$oauth2ID]),
|
|
]);
|
|
if ($identity->isEmpty()) {
|
|
// Before creating the identity, check if the email is already associated with another user
|
|
$userId = $user->getId();
|
|
|
|
$identitiesWithMatchingEmail = $dbForProject->find('identities', [
|
|
Query::equal('providerEmail', [$email]),
|
|
Query::notEqual('userInternalId', $user->getSequence()),
|
|
]);
|
|
if (!empty($identitiesWithMatchingEmail)) {
|
|
$failureRedirect(Exception::GENERAL_BAD_REQUEST); /** Return a generic bad request to prevent exposing existing accounts */
|
|
}
|
|
|
|
$dbForProject->createDocument('identities', new Document([
|
|
'$id' => ID::unique(),
|
|
'$permissions' => [
|
|
Permission::read(Role::any()),
|
|
Permission::update(Role::user($userId)),
|
|
Permission::delete(Role::user($userId)),
|
|
],
|
|
'userInternalId' => $user->getSequence(),
|
|
'userId' => $userId,
|
|
'provider' => $provider,
|
|
'providerUid' => $oauth2ID,
|
|
'providerEmail' => $email,
|
|
'providerAccessToken' => $accessToken,
|
|
'providerRefreshToken' => $refreshToken,
|
|
'providerAccessTokenExpiry' => DateTime::addSeconds(new \DateTime(), (int) $accessTokenExpiry),
|
|
]));
|
|
} else {
|
|
$identity
|
|
->setAttribute('providerAccessToken', $accessToken)
|
|
->setAttribute('providerRefreshToken', $refreshToken)
|
|
->setAttribute('providerAccessTokenExpiry', DateTime::addSeconds(new \DateTime(), (int) $accessTokenExpiry));
|
|
$dbForProject->updateDocument('identities', $identity->getId(), $identity);
|
|
}
|
|
|
|
if (empty($user->getAttribute('email'))) {
|
|
$user->setAttribute('email', $oauth2->getUserEmail($accessToken));
|
|
|
|
try {
|
|
$emailCanonical = new Email($user->getAttribute('email'));
|
|
} catch (Throwable) {
|
|
$emailCanonical = null;
|
|
}
|
|
|
|
$user->setAttribute('emailCanonical', $emailCanonical?->getCanonical());
|
|
$user->setAttribute('emailIsCanonical', $emailCanonical?->isCanonicalSupported());
|
|
$user->setAttribute('emailIsCorporate', $emailCanonical?->isCorporate());
|
|
$user->setAttribute('emailIsDisposable', $emailCanonical?->isDisposable());
|
|
$user->setAttribute('emailIsFree', $emailCanonical?->isFree());
|
|
}
|
|
|
|
if (empty($user->getAttribute('name'))) {
|
|
$user->setAttribute('name', $oauth2->getUserName($accessToken));
|
|
}
|
|
|
|
$user->setAttribute('status', true);
|
|
|
|
$dbForProject->updateDocument('users', $user->getId(), $user);
|
|
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
|
|
$state['success'] = URLParser::parse($state['success']);
|
|
$query = URLParser::parseQuery($state['success']['query']);
|
|
|
|
$duration = $project->getAttribute('auths', [])['duration'] ?? TOKEN_EXPIRATION_LOGIN_LONG;
|
|
$expire = DateTime::formatTz(DateTime::addSeconds(new \DateTime(), $duration));
|
|
|
|
$proofForTokenOAuth2 = new ProofsToken(TOKEN_LENGTH_OAUTH2);
|
|
$proofForTokenOAuth2->setHash(new Sha());
|
|
// If the `token` param is set, we will return the token in the query string
|
|
if ($state['token']) {
|
|
$secret = $proofForTokenOAuth2->generate();
|
|
$token = new Document([
|
|
'$id' => ID::unique(),
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'type' => TOKEN_TYPE_OAUTH2,
|
|
'secret' => $proofForTokenOAuth2->hash($secret), // One way hash encryption to protect DB leak
|
|
'expire' => $expire,
|
|
'userAgent' => $request->getUserAgent('UNKNOWN'),
|
|
'ip' => $request->getIP(),
|
|
]);
|
|
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
|
|
$token = $dbForProject->createDocument('tokens', $token
|
|
->setAttribute('$permissions', [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
]));
|
|
|
|
$queueForEvents
|
|
->setEvent('users.[userId].tokens.[tokenId].create')
|
|
->setParam('userId', $user->getId())
|
|
->setParam('tokenId', $token->getId())
|
|
;
|
|
|
|
$query['secret'] = $secret;
|
|
$query['userId'] = $user->getId();
|
|
|
|
// If the `token` param is not set, we persist the session in a cookie
|
|
} else {
|
|
$detector = new Detector($request->getUserAgent('UNKNOWN'));
|
|
$record = $geodb->get($request->getIP());
|
|
$secret = $proofForToken->generate();
|
|
|
|
$session = new Document(array_merge([
|
|
'$id' => ID::unique(),
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'provider' => $provider,
|
|
'providerUid' => $oauth2ID,
|
|
'providerAccessToken' => $accessToken,
|
|
'providerRefreshToken' => $refreshToken,
|
|
'providerAccessTokenExpiry' => DateTime::addSeconds(new \DateTime(), (int)$accessTokenExpiry),
|
|
'secret' => $proofForToken->hash($secret), // One way hash encryption to protect DB leak
|
|
'userAgent' => $request->getUserAgent('UNKNOWN'),
|
|
'ip' => $request->getIP(),
|
|
'factors' => [TYPE::EMAIL, 'oauth2'], // include a special oauth2 factor to bypass MFA checks
|
|
'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--',
|
|
'expire' => DateTime::addSeconds(new \DateTime(), $duration)
|
|
], $detector->getOS(), $detector->getClient(), $detector->getDevice()));
|
|
|
|
$session = $dbForProject->createDocument('sessions', $session->setAttribute('$permissions', [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
]));
|
|
|
|
$session->setAttribute('expire', $expire);
|
|
|
|
$encoded = $store
|
|
->setProperty('id', $user->getId())
|
|
->setProperty('secret', $secret)
|
|
->encode();
|
|
|
|
if (!Config::getParam('domainVerification')) {
|
|
$response->addHeader('X-Fallback-Cookies', \json_encode([$store->getKey() => $encoded]));
|
|
}
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('sessionId', $session->getId())
|
|
->setPayload($response->output($session, Response::MODEL_SESSION))
|
|
;
|
|
|
|
// TODO: Remove this deprecated workaround - support only token
|
|
if ($state['success']['path'] == $oauthDefaultSuccess) {
|
|
$query['project'] = $project->getId();
|
|
$query['domain'] = Config::getParam('cookieDomain');
|
|
$query['key'] = $store->getKey();
|
|
$query['secret'] = $encoded;
|
|
}
|
|
|
|
$response
|
|
->addCookie($store->getKey() . '_legacy', $encoded, (new \DateTime($expire))->getTimestamp(), '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
|
|
->addCookie($store->getKey(), $encoded, (new \DateTime($expire))->getTimestamp(), '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'));
|
|
}
|
|
|
|
if (isset($sessionUpgrade) && $sessionUpgrade) {
|
|
foreach ($user->getAttribute('targets', []) as $target) {
|
|
if ($target->getAttribute('providerType') !== MESSAGE_TYPE_PUSH) {
|
|
continue;
|
|
}
|
|
|
|
$target
|
|
->setAttribute('sessionId', $session->getId())
|
|
->setAttribute('sessionInternalId', $session->getSequence());
|
|
|
|
$dbForProject->updateDocument('targets', $target->getId(), $target);
|
|
}
|
|
}
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
$state['success']['query'] = URLParser::unparseQuery($query);
|
|
$state['success'] = URLParser::unparse($state['success']);
|
|
|
|
$response
|
|
->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, max-age=0')
|
|
->addHeader('Pragma', 'no-cache')
|
|
->redirect($state['success'])
|
|
;
|
|
});
|
|
|
|
Http::get('/v1/account/tokens/oauth2/:provider')
|
|
->desc('Create OAuth2 token')
|
|
->groups(['api', 'account'])
|
|
->label('error', __DIR__ . '/../../views/general/error.phtml')
|
|
->label('scope', 'sessions.write')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'tokens',
|
|
name: 'createOAuth2Token',
|
|
description: '/docs/references/account/create-token-oauth2.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_MOVED_PERMANENTLY,
|
|
model: Response::MODEL_NONE,
|
|
)
|
|
],
|
|
contentType: ContentType::HTML,
|
|
type: MethodType::WEBAUTH,
|
|
))
|
|
->label('abuse-limit', 50)
|
|
->label('abuse-key', 'ip:{ip}')
|
|
->param('provider', '', new WhiteList(\array_keys(Config::getParam('oAuthProviders')), true), 'OAuth2 Provider. Currently, supported providers are: ' . \implode(', ', \array_keys(\array_filter(Config::getParam('oAuthProviders'), fn ($node) => (!$node['mock'])))) . '.')
|
|
->param('success', '', fn ($redirectValidator) => $redirectValidator, 'URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project\'s platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.', true, ['redirectValidator'])
|
|
->param('failure', '', fn ($redirectValidator) => $redirectValidator, 'URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project\'s platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.', true, ['redirectValidator'])
|
|
->param('scopes', [], new ArrayList(new Text(APP_LIMIT_ARRAY_ELEMENT_SIZE), APP_LIMIT_ARRAY_PARAMS_SIZE), 'A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of ' . APP_LIMIT_ARRAY_PARAMS_SIZE . ' scopes are allowed, each ' . APP_LIMIT_ARRAY_ELEMENT_SIZE . ' characters long.', true)
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->action(function (string $provider, string $success, string $failure, array $scopes, Request $request, Response $response, Document $project, array $platform) use ($oauthDefaultSuccess, $oauthDefaultFailure) {
|
|
$protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') === 'disabled' ? 'http' : 'https';
|
|
$port = $request->getPort();
|
|
$callbackBase = $protocol . '://' . $request->getHostname();
|
|
if ($protocol === 'https' && $port !== '443') {
|
|
$callbackBase .= ':' . $port;
|
|
} elseif ($protocol === 'http' && $port !== '80') {
|
|
$callbackBase .= ':' . $port;
|
|
}
|
|
|
|
$callback = $callbackBase . '/v1/account/sessions/oauth2/callback/' . $provider . '/' . $project->getId();
|
|
$providerEnabled = $project->getAttribute('oAuthProviders', [])[$provider . 'Enabled'] ?? false;
|
|
|
|
if (!$providerEnabled) {
|
|
throw new Exception(Exception::PROJECT_PROVIDER_DISABLED, 'This provider is disabled. Please enable the provider from your ' . APP_NAME . ' console to continue.');
|
|
}
|
|
|
|
$appId = $project->getAttribute('oAuthProviders', [])[$provider . 'Appid'] ?? '';
|
|
$appSecret = $project->getAttribute('oAuthProviders', [])[$provider . 'Secret'] ?? '{}';
|
|
|
|
if (!empty($appSecret) && isset($appSecret['version'])) {
|
|
$key = System::getEnv('_APP_OPENSSL_KEY_V' . $appSecret['version']);
|
|
$appSecret = OpenSSL::decrypt($appSecret['data'], $appSecret['method'], $key, 0, \hex2bin($appSecret['iv']), \hex2bin($appSecret['tag']));
|
|
}
|
|
|
|
if (empty($appId) || empty($appSecret)) {
|
|
throw new Exception(Exception::PROJECT_PROVIDER_DISABLED, 'This provider is disabled. Please configure the provider app ID and app secret key from your ' . APP_NAME . ' console to continue.');
|
|
}
|
|
|
|
$oAuthProviders = Config::getParam('oAuthProviders');
|
|
$className = $oAuthProviders[$provider]['class'];
|
|
if (!\class_exists($className)) {
|
|
throw new Exception(Exception::PROJECT_PROVIDER_UNSUPPORTED);
|
|
}
|
|
|
|
$host = $platform['consoleHostname'] ?? '';
|
|
$protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') == 'disabled' ? 'http' : 'https';
|
|
$port = $request->getPort();
|
|
$redirectBase = $protocol . '://' . $host;
|
|
if ($protocol === 'https' && $port !== '443') {
|
|
$redirectBase .= ':' . $port;
|
|
} elseif ($protocol === 'http' && $port !== '80') {
|
|
$redirectBase .= ':' . $port;
|
|
}
|
|
|
|
if (empty($success)) {
|
|
$success = $redirectBase . $oauthDefaultSuccess;
|
|
}
|
|
|
|
if (empty($failure)) {
|
|
$failure = $redirectBase . $oauthDefaultFailure;
|
|
}
|
|
|
|
$oauth2 = new $className($appId, $appSecret, $callback, [
|
|
'success' => $success,
|
|
'failure' => $failure,
|
|
'token' => true,
|
|
], $scopes);
|
|
|
|
$response
|
|
->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, max-age=0')
|
|
->addHeader('Pragma', 'no-cache')
|
|
->redirect($oauth2->getLoginURL());
|
|
});
|
|
|
|
Http::post('/v1/account/tokens/magic-url')
|
|
->alias('/v1/account/sessions/magic-url')
|
|
->desc('Create magic URL token')
|
|
->groups(['api', 'account', 'auth'])
|
|
->label('scope', 'sessions.write')
|
|
->label('auth.type', 'magic-url')
|
|
->label('audits.event', 'session.create')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('audits.userId', '{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'tokens',
|
|
name: 'createMagicURLToken',
|
|
description: '/docs/references/account/create-token-magic-url.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_TOKEN,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
))
|
|
->label('abuse-limit', 60)
|
|
->label('abuse-key', ['url:{url},email:{param-email}', 'url:{url},ip:{ip}'])
|
|
->param('userId', '', new CustomId(), 'Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.')
|
|
->param('email', '', new EmailValidator(), 'User email.')
|
|
->param('url', '', fn ($redirectValidator) => $redirectValidator, 'URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.', true, ['redirectValidator'])
|
|
->param('phrase', false, new Boolean(), 'Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.', true)
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('project')
|
|
->inject('dbForProject')
|
|
->inject('locale')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMails')
|
|
->inject('proofForPassword')
|
|
->inject('platform')
|
|
->inject('authorization')
|
|
->action(function (string $userId, string $email, string $url, bool $phrase, Request $request, Response $response, Document $user, Document $project, Database $dbForProject, Locale $locale, Event $queueForEvents, Mail $queueForMails, ProofsPassword $proofForPassword, array $platform, Authorization $authorization) {
|
|
if (empty(System::getEnv('_APP_SMTP_HOST'))) {
|
|
throw new Exception(Exception::GENERAL_SMTP_DISABLED, 'SMTP disabled');
|
|
}
|
|
$url = htmlentities($url);
|
|
|
|
if ($phrase === true) {
|
|
$phrase = Phrase::generate();
|
|
}
|
|
|
|
|
|
$result = $dbForProject->findOne('users', [Query::equal('email', [$email])]);
|
|
if (!$result->isEmpty()) {
|
|
$user->setAttributes($result->getArrayCopy());
|
|
} else {
|
|
$limit = $project->getAttribute('auths', [])['limit'] ?? 0;
|
|
|
|
if ($limit !== 0) {
|
|
$total = $dbForProject->count('users', max: APP_LIMIT_USERS);
|
|
|
|
if ($total >= $limit) {
|
|
throw new Exception(Exception::USER_COUNT_EXCEEDED);
|
|
}
|
|
}
|
|
|
|
// Makes sure this email is not already used in another identity
|
|
$identityWithMatchingEmail = $dbForProject->findOne('identities', [
|
|
Query::equal('providerEmail', [$email]),
|
|
]);
|
|
if (!$identityWithMatchingEmail->isEmpty()) {
|
|
throw new Exception(Exception::USER_EMAIL_ALREADY_EXISTS);
|
|
}
|
|
|
|
$userId = $userId === 'unique()' ? ID::unique() : $userId;
|
|
|
|
try {
|
|
$emailCanonical = new Email($email);
|
|
} catch (Throwable) {
|
|
$emailCanonical = null;
|
|
}
|
|
|
|
$user->setAttributes([
|
|
'$id' => $userId,
|
|
'$permissions' => [
|
|
Permission::read(Role::any()),
|
|
Permission::update(Role::user($userId)),
|
|
Permission::delete(Role::user($userId)),
|
|
],
|
|
'email' => $email,
|
|
'emailVerification' => false,
|
|
'status' => true,
|
|
'password' => null,
|
|
'hash' => $proofForPassword->getHash()->getName(),
|
|
'hashOptions' => $proofForPassword->getHash()->getOptions(),
|
|
'passwordUpdate' => null,
|
|
'registration' => DateTime::now(),
|
|
'reset' => false,
|
|
'mfa' => false,
|
|
'prefs' => new \stdClass(),
|
|
'sessions' => null,
|
|
'tokens' => null,
|
|
'memberships' => null,
|
|
'authenticators' => null,
|
|
'search' => implode(' ', [$userId, $email]),
|
|
'accessedAt' => DateTime::now(),
|
|
'emailCanonical' => $emailCanonical?->getCanonical(),
|
|
'emailIsCanonical' => $emailCanonical?->isCanonicalSupported(),
|
|
'emailIsCorporate' => $emailCanonical?->isCorporate(),
|
|
'emailIsDisposable' => $emailCanonical?->isDisposable(),
|
|
'emailIsFree' => $emailCanonical?->isFree(),
|
|
]);
|
|
|
|
$user->removeAttribute('$sequence');
|
|
$user = $authorization->skip(fn () => $dbForProject->createDocument('users', $user));
|
|
}
|
|
|
|
$proofForToken = new ProofsToken(TOKEN_LENGTH_MAGIC_URL);
|
|
$proofForToken->setHash(new Sha());
|
|
|
|
$tokenSecret = $proofForToken->generate();
|
|
$expire = DateTime::formatTz(DateTime::addSeconds(new \DateTime(), TOKEN_EXPIRATION_CONFIRM));
|
|
|
|
$token = new Document([
|
|
'$id' => ID::unique(),
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'type' => TOKEN_TYPE_MAGIC_URL,
|
|
'secret' => $proofForToken->hash($tokenSecret), // One way hash encryption to protect DB leak
|
|
'expire' => $expire,
|
|
'userAgent' => $request->getUserAgent('UNKNOWN'),
|
|
'ip' => $request->getIP(),
|
|
]);
|
|
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
|
|
$token = $dbForProject->createDocument('tokens', $token
|
|
->setAttribute('$permissions', [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
]));
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
if (empty($url)) {
|
|
$protocol = System::getEnv('_APP_OPTIONS_FORCE_HTTPS') === 'disabled' ? 'http' : 'https';
|
|
$host = $platform['consoleHostname'] ?? '';
|
|
$port = $request->getPort();
|
|
$callbackBase = $protocol . '://' . $host;
|
|
if ($protocol === 'https' && $port !== '443') {
|
|
$callbackBase .= ':' . $port;
|
|
} elseif ($protocol === 'http' && $port !== '80') {
|
|
$callbackBase .= ':' . $port;
|
|
}
|
|
$url = $callbackBase . '/console/auth/magic-url';
|
|
}
|
|
|
|
$url = Template::parseURL($url);
|
|
$url['query'] = Template::mergeQuery(((isset($url['query'])) ? $url['query'] : ''), ['userId' => $user->getId(), 'secret' => $tokenSecret, 'expire' => $expire, 'project' => $project->getId()]);
|
|
$url = Template::unParseURL($url);
|
|
|
|
$subject = $locale->getText("emails.magicSession.subject");
|
|
$preview = $locale->getText("emails.magicSession.preview");
|
|
$customTemplate = $project->getAttribute('templates', [])['email.magicSession-' . $locale->default] ?? [];
|
|
|
|
$detector = new Detector($request->getUserAgent('UNKNOWN'));
|
|
$agentOs = $detector->getOS();
|
|
$agentClient = $detector->getClient();
|
|
$agentDevice = $detector->getDevice();
|
|
|
|
$message = Template::fromFile(__DIR__ . '/../../config/locale/templates/email-magic-url.tpl');
|
|
$message
|
|
->setParam('{{hello}}', $locale->getText("emails.magicSession.hello"))
|
|
->setParam('{{optionButton}}', $locale->getText("emails.magicSession.optionButton"))
|
|
->setParam('{{buttonText}}', $locale->getText("emails.magicSession.buttonText"))
|
|
->setParam('{{optionUrl}}', $locale->getText("emails.magicSession.optionUrl"))
|
|
->setParam('{{clientInfo}}', $locale->getText("emails.magicSession.clientInfo"))
|
|
->setParam('{{thanks}}', $locale->getText("emails.magicSession.thanks"))
|
|
->setParam('{{signature}}', $locale->getText("emails.magicSession.signature"));
|
|
|
|
if (!empty($phrase)) {
|
|
$message->setParam('{{securityPhrase}}', $locale->getText("emails.magicSession.securityPhrase"));
|
|
} else {
|
|
$message->setParam('{{securityPhrase}}', '');
|
|
}
|
|
|
|
$body = $message->render();
|
|
|
|
$smtp = $project->getAttribute('smtp', []);
|
|
$smtpEnabled = $smtp['enabled'] ?? false;
|
|
|
|
$senderEmail = System::getEnv('_APP_SYSTEM_EMAIL_ADDRESS', APP_EMAIL_TEAM);
|
|
$senderName = System::getEnv('_APP_SYSTEM_EMAIL_NAME', APP_NAME . ' Server');
|
|
|
|
$replyTo = "";
|
|
|
|
if ($smtpEnabled) {
|
|
if (!empty($smtp['senderEmail'])) {
|
|
$senderEmail = $smtp['senderEmail'];
|
|
}
|
|
if (!empty($smtp['senderName'])) {
|
|
$senderName = $smtp['senderName'];
|
|
}
|
|
if (!empty($smtp['replyTo'])) {
|
|
$replyTo = $smtp['replyTo'];
|
|
}
|
|
|
|
$queueForMails
|
|
->setSmtpHost($smtp['host'] ?? '')
|
|
->setSmtpPort($smtp['port'] ?? '')
|
|
->setSmtpUsername($smtp['username'] ?? '')
|
|
->setSmtpPassword($smtp['password'] ?? '')
|
|
->setSmtpSecure($smtp['secure'] ?? '');
|
|
|
|
if (!empty($customTemplate)) {
|
|
if (!empty($customTemplate['senderEmail'])) {
|
|
$senderEmail = $customTemplate['senderEmail'];
|
|
}
|
|
if (!empty($customTemplate['senderName'])) {
|
|
$senderName = $customTemplate['senderName'];
|
|
}
|
|
if (!empty($customTemplate['replyTo'])) {
|
|
$replyTo = $customTemplate['replyTo'];
|
|
}
|
|
|
|
$body = $customTemplate['message'] ?? '';
|
|
$subject = $customTemplate['subject'] ?? $subject;
|
|
}
|
|
|
|
$queueForMails
|
|
->setSmtpReplyTo($replyTo)
|
|
->setSmtpSenderEmail($senderEmail)
|
|
->setSmtpSenderName($senderName);
|
|
}
|
|
|
|
$projectName = $project->getAttribute('name');
|
|
if ($project->getId() === 'console') {
|
|
$projectName = $platform['platformName'];
|
|
}
|
|
|
|
$emailVariables = [
|
|
'direction' => $locale->getText('settings.direction'),
|
|
// {{user}}, {{redirect}} and {{project}} are required in default and custom templates
|
|
'user' => $user->getAttribute('name'),
|
|
'project' => $projectName,
|
|
'redirect' => $url,
|
|
'agentDevice' => $agentDevice['deviceBrand'] ?? $agentDevice['deviceBrand'] ?? 'UNKNOWN',
|
|
'agentClient' => $agentClient['clientName'] ?? 'UNKNOWN',
|
|
'agentOs' => $agentOs['osName'] ?? 'UNKNOWN',
|
|
'phrase' => !empty($phrase) ? $phrase : '',
|
|
// TODO: remove unnecessary team variable from this email
|
|
'team' => '',
|
|
];
|
|
|
|
$queueForMails
|
|
->setSubject($subject)
|
|
->setPreview($preview)
|
|
->setBody($body)
|
|
->appendVariables($emailVariables)
|
|
->setRecipient($email);
|
|
|
|
if ($project->getId() === 'console') {
|
|
$queueForMails->setSenderName($platform['emailSenderName']);
|
|
}
|
|
|
|
$queueForMails->trigger();
|
|
|
|
$token->setAttribute('secret', $tokenSecret);
|
|
|
|
$queueForEvents
|
|
->setPayload($response->output($token, Response::MODEL_TOKEN), sensitive: ['secret']);
|
|
|
|
if (!empty($phrase)) {
|
|
$token->setAttribute('phrase', $phrase);
|
|
}
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_CREATED)
|
|
->dynamic($token, Response::MODEL_TOKEN);
|
|
});
|
|
|
|
Http::post('/v1/account/tokens/email')
|
|
->desc('Create email token (OTP)')
|
|
->groups(['api', 'account', 'auth'])
|
|
->label('scope', 'sessions.write')
|
|
->label('auth.type', 'email-otp')
|
|
->label('audits.event', 'session.create')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('audits.userId', '{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'tokens',
|
|
name: 'createEmailToken',
|
|
description: '/docs/references/account/create-token-email.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_TOKEN,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', ['url:{url},email:{param-email}', 'url:{url},ip:{ip}'])
|
|
->param('userId', '', new CustomId(), 'User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.')
|
|
->param('email', '', new EmailValidator(), 'User email.')
|
|
->param('phrase', false, new Boolean(), 'Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.', true)
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('dbForProject')
|
|
->inject('locale')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMails')
|
|
->inject('proofForPassword')
|
|
->inject('proofForCode')
|
|
->inject('authorization')
|
|
->action(function (string $userId, string $email, bool $phrase, Request $request, Response $response, User $user, Document $project, array $platform, Database $dbForProject, Locale $locale, Event $queueForEvents, Mail $queueForMails, ProofsPassword $proofForPassword, ProofsCode $proofForCode, Authorization $authorization) {
|
|
if (empty(System::getEnv('_APP_SMTP_HOST'))) {
|
|
throw new Exception(Exception::GENERAL_SMTP_DISABLED, 'SMTP disabled');
|
|
}
|
|
|
|
if ($phrase === true) {
|
|
$phrase = Phrase::generate();
|
|
}
|
|
|
|
$result = $dbForProject->findOne('users', [Query::equal('email', [$email])]);
|
|
if (!$result->isEmpty()) {
|
|
$user->setAttributes($result->getArrayCopy());
|
|
} else {
|
|
$limit = $project->getAttribute('auths', [])['limit'] ?? 0;
|
|
|
|
if ($limit !== 0) {
|
|
$total = $dbForProject->count('users', max: APP_LIMIT_USERS);
|
|
|
|
if ($total >= $limit) {
|
|
throw new Exception(Exception::USER_COUNT_EXCEEDED);
|
|
}
|
|
}
|
|
|
|
// Makes sure this email is not already used in another identity
|
|
$identityWithMatchingEmail = $dbForProject->findOne('identities', [
|
|
Query::equal('providerEmail', [$email]),
|
|
]);
|
|
if (!$identityWithMatchingEmail->isEmpty()) {
|
|
throw new Exception(Exception::GENERAL_BAD_REQUEST); /** Return a generic bad request to prevent exposing existing accounts */
|
|
}
|
|
|
|
$userId = $userId === 'unique()' ? ID::unique() : $userId;
|
|
|
|
try {
|
|
$emailCanonical = new Email($email);
|
|
} catch (Throwable) {
|
|
$emailCanonical = null;
|
|
}
|
|
|
|
$user->setAttributes([
|
|
'$id' => $userId,
|
|
'$permissions' => [
|
|
Permission::read(Role::any()),
|
|
Permission::update(Role::user($userId)),
|
|
Permission::delete(Role::user($userId)),
|
|
],
|
|
'email' => $email,
|
|
'emailVerification' => false,
|
|
'status' => true,
|
|
'password' => null,
|
|
'hash' => $proofForPassword->getHash()->getName(),
|
|
'hashOptions' => $proofForPassword->getHash()->getOptions(),
|
|
'passwordUpdate' => null,
|
|
'registration' => DateTime::now(),
|
|
'reset' => false,
|
|
'prefs' => new \stdClass(),
|
|
'sessions' => null,
|
|
'tokens' => null,
|
|
'memberships' => null,
|
|
'search' => implode(' ', [$userId, $email]),
|
|
'accessedAt' => DateTime::now(),
|
|
'emailCanonical' => $emailCanonical?->getCanonical(),
|
|
'emailIsCanonical' => $emailCanonical?->isCanonicalSupported(),
|
|
'emailIsCorporate' => $emailCanonical?->isCorporate(),
|
|
'emailIsDisposable' => $emailCanonical?->isDisposable(),
|
|
'emailIsFree' => $emailCanonical?->isFree(),
|
|
]);
|
|
|
|
$user->removeAttribute('$sequence');
|
|
$user = $authorization->skip(fn () => $dbForProject->createDocument('users', $user));
|
|
try {
|
|
$target = $authorization->skip(fn () => $dbForProject->createDocument('targets', new Document([
|
|
'$permissions' => [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
],
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'providerType' => MESSAGE_TYPE_EMAIL,
|
|
'identifier' => $email,
|
|
])));
|
|
$user->setAttribute('targets', [...$user->getAttribute('targets', []), $target]);
|
|
} catch (Duplicate) {
|
|
$existingTarget = $dbForProject->findOne('targets', [
|
|
Query::equal('identifier', [$email]),
|
|
]);
|
|
if (!$existingTarget->isEmpty()) {
|
|
$user->setAttribute('targets', $existingTarget, Document::SET_TYPE_APPEND);
|
|
}
|
|
}
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
}
|
|
|
|
$tokenSecret = $proofForCode->generate();
|
|
$expire = DateTime::formatTz(DateTime::addSeconds(new \DateTime(), TOKEN_EXPIRATION_OTP));
|
|
|
|
$token = new Document([
|
|
'$id' => ID::unique(),
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'type' => TOKEN_TYPE_EMAIL,
|
|
'secret' => $proofForCode->hash($tokenSecret), // One way hash encryption to protect DB leak
|
|
'expire' => $expire,
|
|
'userAgent' => $request->getUserAgent('UNKNOWN'),
|
|
'ip' => $request->getIP(),
|
|
]);
|
|
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
|
|
$token = $dbForProject->createDocument('tokens', $token
|
|
->setAttribute('$permissions', [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
]));
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
$subject = $locale->getText("emails.otpSession.subject");
|
|
$preview = $locale->getText("emails.otpSession.preview");
|
|
$heading = $locale->getText("emails.otpSession.heading");
|
|
|
|
$customTemplate = $project->getAttribute('templates', [])['email.otpSession-' . $locale->default] ?? [];
|
|
$smtpBaseTemplate = $project->getAttribute('smtpBaseTemplate', 'email-base');
|
|
|
|
$validator = new FileName();
|
|
if (!$validator->isValid($smtpBaseTemplate)) {
|
|
throw new Exception(Exception::GENERAL_BAD_REQUEST, 'Invalid template path');
|
|
}
|
|
|
|
$bodyTemplate = __DIR__ . '/../../config/locale/templates/' . $smtpBaseTemplate . '.tpl';
|
|
|
|
$detector = new Detector($request->getUserAgent('UNKNOWN'));
|
|
$agentOs = $detector->getOS();
|
|
$agentClient = $detector->getClient();
|
|
$agentDevice = $detector->getDevice();
|
|
|
|
$message = Template::fromFile(__DIR__ . '/../../config/locale/templates/email-otp.tpl');
|
|
$message
|
|
->setParam('{{hello}}', $locale->getText("emails.otpSession.hello"))
|
|
->setParam('{{description}}', $locale->getText("emails.otpSession.description"))
|
|
->setParam('{{clientInfo}}', $locale->getText("emails.otpSession.clientInfo"))
|
|
->setParam('{{thanks}}', $locale->getText("emails.otpSession.thanks"))
|
|
->setParam('{{signature}}', $locale->getText("emails.otpSession.signature"));
|
|
|
|
if (!empty($phrase)) {
|
|
$message->setParam('{{securityPhrase}}', $locale->getText("emails.otpSession.securityPhrase"));
|
|
} else {
|
|
$message->setParam('{{securityPhrase}}', '');
|
|
}
|
|
|
|
$body = $message->render();
|
|
|
|
$smtp = $project->getAttribute('smtp', []);
|
|
$smtpEnabled = $smtp['enabled'] ?? false;
|
|
|
|
$senderEmail = System::getEnv('_APP_SYSTEM_EMAIL_ADDRESS', APP_EMAIL_TEAM);
|
|
$senderName = System::getEnv('_APP_SYSTEM_EMAIL_NAME', APP_NAME . ' Server');
|
|
$replyTo = "";
|
|
|
|
if ($smtpEnabled) {
|
|
if (!empty($smtp['senderEmail'])) {
|
|
$senderEmail = $smtp['senderEmail'];
|
|
}
|
|
if (!empty($smtp['senderName'])) {
|
|
$senderName = $smtp['senderName'];
|
|
}
|
|
if (!empty($smtp['replyTo'])) {
|
|
$replyTo = $smtp['replyTo'];
|
|
}
|
|
|
|
$queueForMails
|
|
->setSmtpHost($smtp['host'] ?? '')
|
|
->setSmtpPort($smtp['port'] ?? '')
|
|
->setSmtpUsername($smtp['username'] ?? '')
|
|
->setSmtpPassword($smtp['password'] ?? '')
|
|
->setSmtpSecure($smtp['secure'] ?? '');
|
|
|
|
if (!empty($customTemplate)) {
|
|
if (!empty($customTemplate['senderEmail'])) {
|
|
$senderEmail = $customTemplate['senderEmail'];
|
|
}
|
|
if (!empty($customTemplate['senderName'])) {
|
|
$senderName = $customTemplate['senderName'];
|
|
}
|
|
if (!empty($customTemplate['replyTo'])) {
|
|
$replyTo = $customTemplate['replyTo'];
|
|
}
|
|
|
|
$body = $customTemplate['message'] ?? '';
|
|
$subject = $customTemplate['subject'] ?? $subject;
|
|
}
|
|
|
|
$queueForMails
|
|
->setSmtpReplyTo($replyTo)
|
|
->setSmtpSenderEmail($senderEmail)
|
|
->setSmtpSenderName($senderName);
|
|
}
|
|
|
|
$projectName = $project->getAttribute('name');
|
|
if ($project->getId() === 'console') {
|
|
$projectName = $platform['platformName'];
|
|
}
|
|
|
|
$emailVariables = [
|
|
'heading' => $heading,
|
|
'direction' => $locale->getText('settings.direction'),
|
|
// {{user}}, {{project}} and {{otp}} are required in the templates
|
|
'user' => $user->getAttribute('name'),
|
|
'project' => $projectName,
|
|
'otp' => $tokenSecret,
|
|
'agentDevice' => $agentDevice['deviceBrand'] ?? $agentDevice['deviceBrand'] ?? 'UNKNOWN',
|
|
'agentClient' => $agentClient['clientName'] ?? 'UNKNOWN',
|
|
'agentOs' => $agentOs['osName'] ?? 'UNKNOWN',
|
|
'phrase' => !empty($phrase) ? $phrase : '',
|
|
// TODO: remove unnecessary team variable from this email
|
|
'team' => '',
|
|
];
|
|
|
|
if ($smtpBaseTemplate === APP_BRANDED_EMAIL_BASE_TEMPLATE) {
|
|
$emailVariables = array_merge($emailVariables, [
|
|
'accentColor' => $platform['accentColor'],
|
|
'logoUrl' => $platform['logoUrl'],
|
|
'twitter' => $platform['twitterUrl'],
|
|
'discord' => $platform['discordUrl'],
|
|
'github' => $platform['githubUrl'],
|
|
'terms' => $platform['termsUrl'],
|
|
'privacy' => $platform['privacyUrl'],
|
|
'platform' => $platform['platformName'],
|
|
]);
|
|
}
|
|
|
|
$queueForMails
|
|
->setSubject($subject)
|
|
->setPreview($preview)
|
|
->setBody($body)
|
|
->setBodyTemplate($bodyTemplate)
|
|
->appendVariables($emailVariables)
|
|
->setRecipient($email);
|
|
|
|
// since this is console project, set email sender name!
|
|
if ($smtpBaseTemplate === APP_BRANDED_EMAIL_BASE_TEMPLATE) {
|
|
$queueForMails->setSenderName($platform['emailSenderName']);
|
|
}
|
|
|
|
$queueForMails->trigger();
|
|
|
|
$token->setAttribute('secret', $tokenSecret);
|
|
|
|
$queueForEvents
|
|
->setPayload($response->output($token, Response::MODEL_TOKEN), sensitive: ['secret']);
|
|
|
|
if (!empty($phrase)) {
|
|
$token->setAttribute('phrase', $phrase);
|
|
}
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_CREATED)
|
|
->dynamic($token, Response::MODEL_TOKEN);
|
|
});
|
|
|
|
Http::put('/v1/account/sessions/magic-url')
|
|
->desc('Update magic URL session')
|
|
->label('event', 'users.[userId].sessions.[sessionId].create')
|
|
->groups(['api', 'account', 'session'])
|
|
->label('scope', 'sessions.write')
|
|
->label('audits.event', 'session.create')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('audits.userId', '{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'sessions',
|
|
name: 'updateMagicURLSession',
|
|
description: '/docs/references/account/create-session.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_SESSION,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
deprecated: new Deprecated(
|
|
since: '1.6.0',
|
|
replaceWith: 'account.createSession'
|
|
),
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', 'ip:{ip},userId:{param-userId}')
|
|
->label('abuse-reset', [201])
|
|
->param('userId', '', new CustomId(), 'User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.')
|
|
->param('secret', '', new Text(256), 'Valid verification token.')
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('locale')
|
|
->inject('geodb')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMails')
|
|
->inject('store')
|
|
->inject('proofForCode')
|
|
->inject('authorization')
|
|
->action(function ($userId, $secret, $request, $response, $user, $dbForProject, $project, $platform, $locale, $geodb, $queueForEvents, $queueForMails, $store, $proofForCode, $authorization) use ($createSession) {
|
|
$proofForToken = new ProofsToken(TOKEN_LENGTH_MAGIC_URL);
|
|
$proofForToken->setHash(new Sha());
|
|
$createSession($userId, $secret, $request, $response, $user, $dbForProject, $project, $platform, $locale, $geodb, $queueForEvents, $queueForMails, $store, $proofForToken, $proofForCode, $authorization);
|
|
});
|
|
|
|
Http::put('/v1/account/sessions/phone')
|
|
->desc('Update phone session')
|
|
->label('event', 'users.[userId].sessions.[sessionId].create')
|
|
->groups(['api', 'account', 'session'])
|
|
->label('scope', 'sessions.write')
|
|
->label('audits.event', 'session.create')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('audits.userId', '{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'sessions',
|
|
name: 'updatePhoneSession',
|
|
description: '/docs/references/account/create-session.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_SESSION,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
deprecated: new Deprecated(
|
|
since: '1.6.0',
|
|
replaceWith: 'account.createSession'
|
|
),
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', 'ip:{ip},userId:{param-userId}')
|
|
->param('userId', '', new CustomId(), 'User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.')
|
|
->param('secret', '', new Text(256), 'Valid verification token.')
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('locale')
|
|
->inject('geodb')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMails')
|
|
->inject('store')
|
|
->inject('proofForToken')
|
|
->inject('proofForCode')
|
|
->inject('authorization')
|
|
->action($createSession);
|
|
|
|
Http::post('/v1/account/tokens/phone')
|
|
->alias('/v1/account/sessions/phone')
|
|
->desc('Create phone token')
|
|
->groups(['api', 'account', 'auth'])
|
|
->label('scope', 'sessions.write')
|
|
->label('auth.type', 'phone')
|
|
->label('audits.event', 'session.create')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('audits.userId', '{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'tokens',
|
|
name: 'createPhoneToken',
|
|
description: '/docs/references/account/create-token-phone.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_TOKEN,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', ['url:{url},phone:{param-phone}', 'url:{url},ip:{ip}'])
|
|
->param('userId', '', new CustomId(), 'Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.')
|
|
->param('phone', '', new Phone(), 'Phone number. Format this number with a leading \'+\' and a country code, e.g., +16175551212.')
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMessaging')
|
|
->inject('locale')
|
|
->inject('timelimit')
|
|
->inject('queueForStatsUsage')
|
|
->inject('plan')
|
|
->inject('store')
|
|
->inject('proofForCode')
|
|
->inject('authorization')
|
|
->action(function (string $userId, string $phone, Request $request, Response $response, User $user, Document $project, array $platform, Database $dbForProject, Event $queueForEvents, Messaging $queueForMessaging, Locale $locale, callable $timelimit, StatsUsage $queueForStatsUsage, array $plan, Store $store, ProofsCode $proofForCode, Authorization $authorization) {
|
|
if (empty(System::getEnv('_APP_SMS_PROVIDER'))) {
|
|
throw new Exception(Exception::GENERAL_PHONE_DISABLED, 'Phone provider not configured');
|
|
}
|
|
|
|
$result = $dbForProject->findOne('users', [Query::equal('phone', [$phone])]);
|
|
if (!$result->isEmpty()) {
|
|
$user->setAttributes($result->getArrayCopy());
|
|
} else {
|
|
$limit = $project->getAttribute('auths', [])['limit'] ?? 0;
|
|
|
|
if ($limit !== 0) {
|
|
$total = $dbForProject->count('users', max: APP_LIMIT_USERS);
|
|
|
|
if ($total >= $limit) {
|
|
throw new Exception(Exception::USER_COUNT_EXCEEDED);
|
|
}
|
|
}
|
|
|
|
$userId = $userId == 'unique()' ? ID::unique() : $userId;
|
|
$user->setAttributes([
|
|
'$id' => $userId,
|
|
'$permissions' => [
|
|
Permission::read(Role::any()),
|
|
Permission::update(Role::user($userId)),
|
|
Permission::delete(Role::user($userId)),
|
|
],
|
|
'email' => null,
|
|
'phone' => $phone,
|
|
'emailVerification' => false,
|
|
'phoneVerification' => false,
|
|
'status' => true,
|
|
'password' => null,
|
|
'passwordUpdate' => null,
|
|
'registration' => DateTime::now(),
|
|
'reset' => false,
|
|
'prefs' => new \stdClass(),
|
|
'sessions' => null,
|
|
'tokens' => null,
|
|
'memberships' => null,
|
|
'search' => implode(' ', [$userId, $phone]),
|
|
'accessedAt' => DateTime::now(),
|
|
'emailCanonical' => null,
|
|
'emailIsCanonical' => null,
|
|
'emailIsCorporate' => null,
|
|
'emailIsDisposable' => null,
|
|
'emailIsFree' => null,
|
|
]);
|
|
|
|
$user->removeAttribute('$sequence');
|
|
$user = $authorization->skip(fn () => $dbForProject->createDocument('users', $user));
|
|
try {
|
|
$target = $authorization->skip(fn () => $dbForProject->createDocument('targets', new Document([
|
|
'$permissions' => [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
],
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'providerType' => MESSAGE_TYPE_SMS,
|
|
'identifier' => $phone,
|
|
])));
|
|
$user->setAttribute('targets', [...$user->getAttribute('targets', []), $target]);
|
|
} catch (Duplicate) {
|
|
$existingTarget = $dbForProject->findOne('targets', [
|
|
Query::equal('identifier', [$phone]),
|
|
]);
|
|
$user->setAttribute('targets', [...$user->getAttribute('targets', []), $existingTarget->isEmpty() ? false : $existingTarget]);
|
|
}
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
}
|
|
|
|
$secret = null;
|
|
$sendSMS = true;
|
|
$mockNumbers = $project->getAttribute('auths', [])['mockNumbers'] ?? [];
|
|
foreach ($mockNumbers as $mockNumber) {
|
|
if ($mockNumber['phone'] === $phone) {
|
|
$secret = $mockNumber['otp'];
|
|
$sendSMS = false;
|
|
break;
|
|
}
|
|
}
|
|
|
|
$secret ??= $proofForCode->generate();
|
|
$expire = DateTime::formatTz(DateTime::addSeconds(new \DateTime(), TOKEN_EXPIRATION_OTP));
|
|
|
|
$token = new Document([
|
|
'$id' => ID::unique(),
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'type' => TOKEN_TYPE_PHONE,
|
|
'secret' => $proofForCode->hash($secret),
|
|
'expire' => $expire,
|
|
'userAgent' => $request->getUserAgent('UNKNOWN'),
|
|
'ip' => $request->getIP(),
|
|
]);
|
|
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
|
|
$token = $dbForProject->createDocument('tokens', $token
|
|
->setAttribute('$permissions', [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
]));
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
if ($sendSMS) {
|
|
$message = Template::fromFile(__DIR__ . '/../../config/locale/templates/sms-base.tpl');
|
|
|
|
$customTemplate = $project->getAttribute('templates', [])['sms.login-' . $locale->default] ?? [];
|
|
if (!empty($customTemplate)) {
|
|
$message = $customTemplate['message'] ?? $message;
|
|
}
|
|
|
|
$projectName = $project->getAttribute('name');
|
|
if ($project->getId() === 'console') {
|
|
$projectName = $platform['platformName'];
|
|
}
|
|
|
|
$messageContent = Template::fromString($locale->getText("sms.verification.body"));
|
|
$messageContent
|
|
->setParam('{{project}}', $projectName)
|
|
->setParam('{{secret}}', $secret);
|
|
$messageContent = \strip_tags($messageContent->render());
|
|
$message = $message->setParam('{{token}}', $messageContent);
|
|
|
|
$message = $message->render();
|
|
|
|
$messageDoc = new Document([
|
|
'$id' => $token->getId(),
|
|
'data' => [
|
|
'content' => $message,
|
|
],
|
|
]);
|
|
|
|
$queueForMessaging
|
|
->setType(MESSAGE_SEND_TYPE_INTERNAL)
|
|
->setMessage($messageDoc)
|
|
->setRecipients([$phone])
|
|
->setProviderType(MESSAGE_TYPE_SMS);
|
|
|
|
$helper = PhoneNumberUtil::getInstance();
|
|
try {
|
|
$countryCode = $helper->parse($phone)->getCountryCode();
|
|
|
|
if (!empty($countryCode)) {
|
|
$queueForStatsUsage
|
|
->addMetric(str_replace('{countryCode}', $countryCode, METRIC_AUTH_METHOD_PHONE_COUNTRY_CODE), 1);
|
|
}
|
|
} catch (NumberParseException $e) {
|
|
// Ignore invalid phone number for country code stats
|
|
}
|
|
$queueForStatsUsage
|
|
->addMetric(METRIC_AUTH_METHOD_PHONE, 1)
|
|
->setProject($project)
|
|
->trigger();
|
|
}
|
|
|
|
$token->setAttribute('secret', $secret);
|
|
|
|
$queueForEvents
|
|
->setPayload($response->output($token, Response::MODEL_TOKEN), sensitive: ['secret']);
|
|
|
|
// Encode secret for clients
|
|
$encoded = $store
|
|
->setProperty('id', $user->getId())
|
|
->setProperty('secret', $secret)
|
|
->encode();
|
|
$token->setAttribute('secret', $encoded);
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_CREATED)
|
|
->dynamic($token, Response::MODEL_TOKEN);
|
|
});
|
|
|
|
Http::post('/v1/account/jwts')
|
|
->alias('/v1/account/jwt')
|
|
->desc('Create JWT')
|
|
->groups(['api', 'account', 'auth'])
|
|
->label('scope', 'account')
|
|
->label('auth.type', 'jwt')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'tokens',
|
|
name: 'createJWT',
|
|
description: '/docs/references/account/create-jwt.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_JWT,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
))
|
|
->param('duration', 900, new Range(0, 3600), 'Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.', true)
|
|
->label('abuse-limit', APP_LIMIT_WRITE_RATE_DEFAULT * 2)
|
|
->label('abuse-time', APP_LIMIT_WRITE_RATE_PERIOD_DEFAULT)
|
|
->label('abuse-key', 'url:{url},userId:{userId}')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('store')
|
|
->inject('proofForToken')
|
|
->action(function (int $duration, Response $response, User $user, Store $store, ProofsToken $proofForToken) {
|
|
$sessionId = $user->sessionVerify($store->getProperty('secret', ''), $proofForToken);
|
|
|
|
if (!$sessionId) {
|
|
throw new Exception(Exception::USER_SESSION_NOT_FOUND);
|
|
}
|
|
|
|
$jwt = new JWT(System::getEnv('_APP_OPENSSL_KEY_V1'), 'HS256', $duration, 0);
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_CREATED)
|
|
->dynamic(new Document([
|
|
'jwt' => $jwt->encode([
|
|
'userId' => $user->getId(),
|
|
'sessionId' => $sessionId,
|
|
])
|
|
]), Response::MODEL_JWT);
|
|
});
|
|
|
|
Http::get('/v1/account/prefs')
|
|
->desc('Get account preferences')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'account')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'account',
|
|
name: 'getPrefs',
|
|
description: '/docs/references/account/get-prefs.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_PREFERENCES,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->inject('response')
|
|
->inject('user')
|
|
->action(function (Response $response, Document $user) {
|
|
|
|
$prefs = $user->getAttribute('prefs', []);
|
|
|
|
$response->dynamic(new Document($prefs), Response::MODEL_PREFERENCES);
|
|
});
|
|
|
|
Http::get('/v1/account/logs')
|
|
->desc('List logs')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'account')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'logs',
|
|
name: 'listLogs',
|
|
description: '/docs/references/account/list-logs.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_LOG_LIST,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
))
|
|
->param('queries', [], new Queries([new Limit(), new Offset()]), 'Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset', true)
|
|
->param('total', true, new Boolean(true), 'When set to false, the total count returned will be 0 and will not be calculated.', true)
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('locale')
|
|
->inject('geodb')
|
|
->inject('dbForProject')
|
|
->inject('audit')
|
|
->action(function (array $queries, bool $includeTotal, Response $response, Document $user, Locale $locale, Reader $geodb, Database $dbForProject, Audit $audit) {
|
|
|
|
try {
|
|
$queries = Query::parseQueries($queries);
|
|
} catch (QueryException $e) {
|
|
throw new Exception(Exception::GENERAL_QUERY_INVALID, $e->getMessage());
|
|
}
|
|
|
|
$grouped = Query::groupByType($queries);
|
|
$limit = $grouped['limit'] ?? 25;
|
|
$offset = $grouped['offset'] ?? 0;
|
|
$logs = $audit->getLogsByUser($user->getSequence(), offset: $offset, limit: $limit);
|
|
|
|
$output = [];
|
|
|
|
foreach ($logs as $i => &$log) {
|
|
$log['userAgent'] = (!empty($log['userAgent'])) ? $log['userAgent'] : 'UNKNOWN';
|
|
|
|
$detector = new Detector($log['userAgent']);
|
|
|
|
$output[$i] = new Document(array_merge(
|
|
$log->getArrayCopy(),
|
|
$log['data'],
|
|
$detector->getOS(),
|
|
$detector->getClient(),
|
|
$detector->getDevice()
|
|
));
|
|
|
|
$record = $geodb->get($log['ip']);
|
|
|
|
if ($record) {
|
|
$output[$i]['countryCode'] = $locale->getText('countries.' . strtolower($record['country']['iso_code']), false) ? \strtolower($record['country']['iso_code']) : '--';
|
|
$output[$i]['countryName'] = $locale->getText('countries.' . strtolower($record['country']['iso_code']), $locale->getText('locale.country.unknown'));
|
|
} else {
|
|
$output[$i]['countryCode'] = '--';
|
|
$output[$i]['countryName'] = $locale->getText('locale.country.unknown');
|
|
}
|
|
}
|
|
|
|
$response->dynamic(new Document([
|
|
'total' => $includeTotal ? $audit->countLogsByUser($user->getSequence()) : 0,
|
|
'logs' => $output,
|
|
]), Response::MODEL_LOG_LIST);
|
|
});
|
|
|
|
Http::patch('/v1/account/name')
|
|
->desc('Update name')
|
|
->groups(['api', 'account'])
|
|
->label('event', 'users.[userId].update.name')
|
|
->label('scope', 'account')
|
|
->label('audits.event', 'user.update')
|
|
->label('audits.resource', 'user/{response.$id}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'account',
|
|
name: 'updateName',
|
|
description: '/docs/references/account/update-name.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_USER,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->param('name', '', new Text(128), 'User name. Max length: 128 chars.')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->action(function (string $name, Response $response, Document $user, Database $dbForProject, Event $queueForEvents) {
|
|
|
|
$user->setAttribute('name', $name);
|
|
|
|
$user = $dbForProject->updateDocument('users', $user->getId(), $user);
|
|
|
|
$queueForEvents->setParam('userId', $user->getId());
|
|
|
|
$response->dynamic($user, Response::MODEL_ACCOUNT);
|
|
});
|
|
|
|
Http::patch('/v1/account/password')
|
|
->desc('Update password')
|
|
->groups(['api', 'account'])
|
|
->label('event', 'users.[userId].update.password')
|
|
->label('scope', 'account')
|
|
->label('audits.event', 'user.update')
|
|
->label('audits.resource', 'user/{response.$id}')
|
|
->label('audits.userId', '{response.$id}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'account',
|
|
name: 'updatePassword',
|
|
description: '/docs/references/account/update-password.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_USER,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->param('password', '', fn ($project, $passwordsDictionary) => new PasswordDictionary($passwordsDictionary, $project->getAttribute('auths', [])['passwordDictionary'] ?? false), 'New user password. Must be at least 8 chars.', false, ['project', 'passwordsDictionary'])
|
|
->param('oldPassword', '', new Password(), 'Current user password. Must be at least 8 chars.', true)
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('project')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->inject('hooks')
|
|
->inject('store')
|
|
->inject('proofForPassword')
|
|
->inject('proofForToken')
|
|
->action(function (string $password, string $oldPassword, Response $response, User $user, Document $project, Database $dbForProject, Event $queueForEvents, Hooks $hooks, Store $store, ProofsPassword $proofForPassword, ProofsToken $proofForToken) {
|
|
$userProofForPassword = ProofsPassword::createHash($user->getAttribute('hash'), $user->getAttribute('hashOptions'));
|
|
// Check old password only if its an existing user.
|
|
if (!empty($user->getAttribute('passwordUpdate')) && !$userProofForPassword->verify($oldPassword, $user->getAttribute('password'))) { // Double check user password
|
|
throw new Exception(Exception::USER_INVALID_CREDENTIALS);
|
|
}
|
|
|
|
$newPassword = $proofForPassword->hash($password);
|
|
$historyLimit = $project->getAttribute('auths', [])['passwordHistory'] ?? 0;
|
|
$hash = ProofsPassword::createHash($user->getAttribute('hash'), $user->getAttribute('hashOptions'));
|
|
$history = $user->getAttribute('passwordHistory', []);
|
|
|
|
if ($historyLimit > 0) {
|
|
$validator = new PasswordHistory($history, $hash);
|
|
if (!$validator->isValid($password)) {
|
|
throw new Exception(Exception::USER_PASSWORD_RECENTLY_USED);
|
|
}
|
|
|
|
$history[] = $newPassword;
|
|
$history = array_slice($history, (count($history) - $historyLimit), $historyLimit);
|
|
}
|
|
|
|
if ($project->getAttribute('auths', [])['personalDataCheck'] ?? false) {
|
|
$personalDataValidator = new PersonalData($user->getId(), $user->getAttribute('email'), $user->getAttribute('name'), $user->getAttribute('phone'));
|
|
if (!$personalDataValidator->isValid($password)) {
|
|
throw new Exception(Exception::USER_PASSWORD_PERSONAL_DATA);
|
|
}
|
|
}
|
|
|
|
$hooks->trigger('passwordValidator', [$dbForProject, $project, $password, &$user, true]);
|
|
|
|
$user
|
|
->setAttribute('password', $newPassword)
|
|
->setAttribute('passwordHistory', $history)
|
|
->setAttribute('passwordUpdate', DateTime::now())
|
|
->setAttribute('hash', $proofForPassword->getHash()->getName())
|
|
->setAttribute('hashOptions', $proofForPassword->getHash()->getOptions());
|
|
|
|
$sessions = $user->getAttribute('sessions', []);
|
|
|
|
$current = $user->sessionVerify($store->getProperty('secret', ''), $proofForToken);
|
|
|
|
$invalidate = $project->getAttribute('auths', default: [])['invalidateSessions'] ?? false;
|
|
if ($invalidate && !empty($current)) {
|
|
foreach ($sessions as $session) {
|
|
/** @var Document $session */
|
|
if ($session->getId() !== $current) {
|
|
$dbForProject->deleteDocument('sessions', $session->getId());
|
|
}
|
|
}
|
|
}
|
|
|
|
$user = $dbForProject->updateDocument('users', $user->getId(), $user);
|
|
|
|
$queueForEvents->setParam('userId', $user->getId());
|
|
|
|
$response->dynamic($user, Response::MODEL_ACCOUNT);
|
|
});
|
|
|
|
Http::patch('/v1/account/email')
|
|
->desc('Update email')
|
|
->groups(['api', 'account'])
|
|
->label('event', 'users.[userId].update.email')
|
|
->label('scope', 'account')
|
|
->label('audits.event', 'user.update')
|
|
->label('audits.resource', 'user/{response.$id}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'account',
|
|
name: 'updateEmail',
|
|
description: '/docs/references/account/update-email.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_USER,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->param('email', '', new EmailValidator(), 'User email.')
|
|
->param('password', '', new Password(), 'User password. Must be at least 8 chars.')
|
|
->inject('requestTimestamp')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->inject('project')
|
|
->inject('hooks')
|
|
->inject('proofForPassword')
|
|
->inject('authorization')
|
|
->action(function (string $email, string $password, ?\DateTime $requestTimestamp, Response $response, User $user, Database $dbForProject, Event $queueForEvents, Document $project, Hooks $hooks, ProofsPassword $proofForPassword, Authorization $authorization) {
|
|
// passwordUpdate will be empty if the user has never set a password
|
|
$passwordUpdate = $user->getAttribute('passwordUpdate');
|
|
|
|
$userProofForPassword = ProofsPassword::createHash($user->getAttribute('hash'), $user->getAttribute('hashOptions'));
|
|
|
|
if (
|
|
!empty($passwordUpdate) &&
|
|
!$userProofForPassword->verify($password, $user->getAttribute('password'))
|
|
) { // Double check user password
|
|
throw new Exception(Exception::USER_INVALID_CREDENTIALS);
|
|
}
|
|
|
|
$hooks->trigger('passwordValidator', [$dbForProject, $project, $password, &$user, false]);
|
|
|
|
$oldEmail = $user->getAttribute('email');
|
|
|
|
$email = \strtolower($email);
|
|
|
|
// Makes sure this email is not already used in another identity
|
|
$identityWithMatchingEmail = $dbForProject->findOne('identities', [
|
|
Query::equal('providerEmail', [$email]),
|
|
Query::notEqual('userInternalId', $user->getSequence()),
|
|
]);
|
|
if (!$identityWithMatchingEmail->isEmpty()) {
|
|
throw new Exception(Exception::GENERAL_BAD_REQUEST); /** Return a generic bad request to prevent exposing existing accounts */
|
|
}
|
|
|
|
try {
|
|
$emailCanonical = new Email($email);
|
|
} catch (Throwable) {
|
|
$emailCanonical = null;
|
|
}
|
|
|
|
$user
|
|
->setAttribute('email', $email)
|
|
->setAttribute('emailVerification', false) // After this user needs to confirm mail again
|
|
->setAttribute('emailCanonical', $emailCanonical?->getCanonical())
|
|
->setAttribute('emailIsCanonical', $emailCanonical?->isCanonicalSupported())
|
|
->setAttribute('emailIsCorporate', $emailCanonical?->isCorporate())
|
|
->setAttribute('emailIsDisposable', $emailCanonical?->isDisposable())
|
|
->setAttribute('emailIsFree', $emailCanonical?->isFree())
|
|
;
|
|
|
|
if (empty($passwordUpdate)) {
|
|
$user
|
|
->setAttribute('password', $proofForPassword->hash($password))
|
|
->setAttribute('hash', $proofForPassword->getHash()->getName())
|
|
->setAttribute('hashOptions', $proofForPassword->getHash()->getOptions())
|
|
->setAttribute('passwordUpdate', DateTime::now());
|
|
}
|
|
|
|
$target = $authorization->skip(fn () => $dbForProject->findOne('targets', [
|
|
Query::equal('identifier', [$email]),
|
|
]));
|
|
|
|
if (!$target->isEmpty()) {
|
|
throw new Exception(Exception::USER_TARGET_ALREADY_EXISTS);
|
|
}
|
|
|
|
try {
|
|
$user = $dbForProject->updateDocument('users', $user->getId(), $user);
|
|
/**
|
|
* @var Document $oldTarget
|
|
*/
|
|
$oldTarget = $user->find('identifier', $oldEmail, 'targets');
|
|
|
|
if ($oldTarget instanceof Document && !$oldTarget->isEmpty()) {
|
|
$authorization->skip(fn () => $dbForProject->updateDocument('targets', $oldTarget->getId(), $oldTarget->setAttribute('identifier', $email)));
|
|
}
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
} catch (Duplicate) {
|
|
throw new Exception(Exception::GENERAL_BAD_REQUEST); /** Return a generic bad request to prevent exposing existing accounts */
|
|
}
|
|
|
|
$queueForEvents->setParam('userId', $user->getId());
|
|
|
|
$response->dynamic($user, Response::MODEL_ACCOUNT);
|
|
});
|
|
|
|
Http::patch('/v1/account/phone')
|
|
->desc('Update phone')
|
|
->groups(['api', 'account'])
|
|
->label('event', 'users.[userId].update.phone')
|
|
->label('scope', 'account')
|
|
->label('audits.event', 'user.update')
|
|
->label('audits.resource', 'user/{response.$id}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'account',
|
|
name: 'updatePhone',
|
|
description: '/docs/references/account/update-phone.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_USER,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->param('phone', '', new Phone(), 'Phone number. Format this number with a leading \'+\' and a country code, e.g., +16175551212.')
|
|
->param('password', '', new Password(), 'User password. Must be at least 8 chars.')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->inject('project')
|
|
->inject('hooks')
|
|
->inject('proofForPassword')
|
|
->inject('authorization')
|
|
->action(function (string $phone, string $password, Response $response, Document $user, Database $dbForProject, Event $queueForEvents, Document $project, Hooks $hooks, ProofsPassword $proofForPassword, Authorization $authorization) {
|
|
// passwordUpdate will be empty if the user has never set a password
|
|
$passwordUpdate = $user->getAttribute('passwordUpdate');
|
|
|
|
$userProofForPassword = ProofsPassword::createHash($user->getAttribute('hash'), $user->getAttribute('hashOptions'));
|
|
|
|
if (
|
|
!empty($passwordUpdate) &&
|
|
!$userProofForPassword->verify($password, $user->getAttribute('password'))
|
|
) { // Double check user password
|
|
throw new Exception(Exception::USER_INVALID_CREDENTIALS);
|
|
}
|
|
|
|
$hooks->trigger('passwordValidator', [$dbForProject, $project, $password, &$user, false]);
|
|
|
|
$target = $authorization->skip(fn () => $dbForProject->findOne('targets', [
|
|
Query::equal('identifier', [$phone]),
|
|
]));
|
|
|
|
if (!$target->isEmpty()) {
|
|
throw new Exception(Exception::USER_TARGET_ALREADY_EXISTS);
|
|
}
|
|
|
|
$oldPhone = $user->getAttribute('phone');
|
|
|
|
$user
|
|
->setAttribute('phone', $phone)
|
|
->setAttribute('phoneVerification', false) // After this user needs to confirm phone number again
|
|
;
|
|
|
|
if (empty($passwordUpdate)) {
|
|
$user
|
|
->setAttribute('password', $proofForPassword->hash($password))
|
|
->setAttribute('hash', $proofForPassword->getHash()->getName())
|
|
->setAttribute('hashOptions', $proofForPassword->getHash()->getOptions())
|
|
->setAttribute('passwordUpdate', DateTime::now());
|
|
}
|
|
|
|
try {
|
|
$user = $dbForProject->updateDocument('users', $user->getId(), $user);
|
|
/**
|
|
* @var Document $oldTarget
|
|
*/
|
|
$oldTarget = $user->find('identifier', $oldPhone, 'targets');
|
|
|
|
if ($oldTarget instanceof Document && !$oldTarget->isEmpty()) {
|
|
$authorization->skip(fn () => $dbForProject->updateDocument('targets', $oldTarget->getId(), $oldTarget->setAttribute('identifier', $phone)));
|
|
}
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
} catch (Duplicate $th) {
|
|
throw new Exception(Exception::USER_PHONE_ALREADY_EXISTS);
|
|
}
|
|
|
|
$queueForEvents->setParam('userId', $user->getId());
|
|
|
|
$response->dynamic($user, Response::MODEL_ACCOUNT);
|
|
});
|
|
|
|
Http::patch('/v1/account/prefs')
|
|
->desc('Update preferences')
|
|
->groups(['api', 'account'])
|
|
->label('event', 'users.[userId].update.prefs')
|
|
->label('scope', 'account')
|
|
->label('audits.event', 'user.update')
|
|
->label('audits.resource', 'user/{response.$id}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'account',
|
|
name: 'updatePrefs',
|
|
description: '/docs/references/account/update-prefs.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_USER,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->param('prefs', [], new Assoc(), 'Prefs key-value JSON object.', example: '{"language":"en","timezone":"UTC","darkTheme":true}')
|
|
->inject('requestTimestamp')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->action(function (array $prefs, ?\DateTime $requestTimestamp, Response $response, Document $user, Database $dbForProject, Event $queueForEvents) {
|
|
|
|
$user->setAttribute('prefs', $prefs);
|
|
|
|
$user = $dbForProject->updateDocument('users', $user->getId(), $user);
|
|
|
|
$queueForEvents->setParam('userId', $user->getId());
|
|
|
|
$response->dynamic($user, Response::MODEL_ACCOUNT);
|
|
});
|
|
|
|
Http::patch('/v1/account/status')
|
|
->desc('Update status')
|
|
->groups(['api', 'account'])
|
|
->label('event', 'users.[userId].update.status')
|
|
->label('scope', 'account')
|
|
->label('audits.event', 'user.update')
|
|
->label('audits.resource', 'user/{response.$id}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'account',
|
|
name: 'updateStatus',
|
|
description: '/docs/references/account/update-status.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_USER,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
))
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->inject('store')
|
|
->action(function (Request $request, Response $response, Document $user, Database $dbForProject, Event $queueForEvents, Store $store) {
|
|
|
|
$user->setAttribute('status', false);
|
|
|
|
$user = $dbForProject->updateDocument('users', $user->getId(), $user);
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setPayload($response->output($user, Response::MODEL_ACCOUNT));
|
|
|
|
if (!Config::getParam('domainVerification')) {
|
|
$response->addHeader('X-Fallback-Cookies', \json_encode([]));
|
|
}
|
|
|
|
$protocol = $request->getProtocol();
|
|
$response
|
|
->addCookie($store->getKey() . '_legacy', '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
|
|
->addCookie($store->getKey(), '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'))
|
|
;
|
|
|
|
$response->dynamic($user, Response::MODEL_ACCOUNT);
|
|
});
|
|
|
|
Http::post('/v1/account/recovery')
|
|
->desc('Create password recovery')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'sessions.write')
|
|
->label('event', 'users.[userId].recovery.[tokenId].create')
|
|
->label('audits.event', 'recovery.create')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('audits.userId', '{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'recovery',
|
|
name: 'createRecovery',
|
|
description: '/docs/references/account/create-recovery.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_TOKEN,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', ['url:{url},email:{param-email}', 'url:{url},ip:{ip}'])
|
|
->param('email', '', new EmailValidator(), 'User email.')
|
|
->param('url', '', fn ($redirectValidator) => $redirectValidator, 'URL to redirect the user back to your app from the recovery email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.', false, ['redirectValidator'])
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('locale')
|
|
->inject('queueForMails')
|
|
->inject('queueForEvents')
|
|
->inject('proofForToken')
|
|
->inject('authorization')
|
|
->action(function (string $email, string $url, Request $request, Response $response, User $user, Database $dbForProject, Document $project, array $platform, Locale $locale, Mail $queueForMails, Event $queueForEvents, ProofsToken $proofForToken, Authorization $authorization) {
|
|
|
|
if (empty(System::getEnv('_APP_SMTP_HOST'))) {
|
|
throw new Exception(Exception::GENERAL_SMTP_DISABLED, 'SMTP Disabled');
|
|
}
|
|
|
|
$url = htmlentities($url);
|
|
$email = \strtolower($email);
|
|
|
|
$profile = $dbForProject->findOne('users', [
|
|
Query::equal('email', [$email]),
|
|
]);
|
|
|
|
if ($profile->isEmpty()) {
|
|
throw new Exception(Exception::USER_NOT_FOUND);
|
|
}
|
|
|
|
$user->setAttributes($profile->getArrayCopy());
|
|
|
|
if (false === $profile->getAttribute('status')) { // Account is blocked
|
|
throw new Exception(Exception::USER_BLOCKED);
|
|
}
|
|
|
|
$expire = DateTime::formatTz(DateTime::addSeconds(new \DateTime(), TOKEN_EXPIRATION_RECOVERY));
|
|
|
|
$secret = $proofForToken->generate();
|
|
$recovery = new Document([
|
|
'$id' => ID::unique(),
|
|
'userId' => $profile->getId(),
|
|
'userInternalId' => $profile->getSequence(),
|
|
'type' => TOKEN_TYPE_RECOVERY,
|
|
'secret' => $proofForToken->hash($secret), // One way hash encryption to protect DB leak
|
|
'expire' => $expire,
|
|
'userAgent' => $request->getUserAgent('UNKNOWN'),
|
|
'ip' => $request->getIP(),
|
|
]);
|
|
|
|
$authorization->addRole(Role::user($profile->getId())->toString());
|
|
|
|
$recovery = $dbForProject->createDocument('tokens', $recovery
|
|
->setAttribute('$permissions', [
|
|
Permission::read(Role::user($profile->getId())),
|
|
Permission::update(Role::user($profile->getId())),
|
|
Permission::delete(Role::user($profile->getId())),
|
|
]));
|
|
|
|
$dbForProject->purgeCachedDocument('users', $profile->getId());
|
|
|
|
$url = Template::parseURL($url);
|
|
$url['query'] = Template::mergeQuery(((isset($url['query'])) ? $url['query'] : ''), ['userId' => $profile->getId(), 'secret' => $secret, 'expire' => $expire]);
|
|
$url = Template::unParseURL($url);
|
|
|
|
$projectName = $project->isEmpty()
|
|
? 'Console'
|
|
: $project->getAttribute('name', '[APP-NAME]');
|
|
|
|
if ($project->getId() === 'console') {
|
|
$projectName = $platform['platformName'];
|
|
}
|
|
|
|
$body = $locale->getText("emails.recovery.body");
|
|
$subject = $locale->getText("emails.recovery.subject");
|
|
$preview = $locale->getText("emails.recovery.preview");
|
|
$customTemplate = $project->getAttribute('templates', [])['email.recovery-' . $locale->default] ?? [];
|
|
|
|
$message = Template::fromFile(__DIR__ . '/../../config/locale/templates/email-inner-base.tpl');
|
|
$message
|
|
->setParam('{{body}}', $body, escapeHtml: false)
|
|
->setParam('{{hello}}', $locale->getText("emails.recovery.hello"))
|
|
->setParam('{{footer}}', $locale->getText("emails.recovery.footer"))
|
|
->setParam('{{thanks}}', $locale->getText("emails.recovery.thanks"))
|
|
->setParam('{{buttonText}}', $locale->getText("emails.recovery.buttonText"))
|
|
->setParam('{{signature}}', $locale->getText("emails.recovery.signature"));
|
|
$body = $message->render();
|
|
|
|
$smtp = $project->getAttribute('smtp', []);
|
|
$smtpEnabled = $smtp['enabled'] ?? false;
|
|
|
|
$senderEmail = System::getEnv('_APP_SYSTEM_EMAIL_ADDRESS', APP_EMAIL_TEAM);
|
|
$senderName = System::getEnv('_APP_SYSTEM_EMAIL_NAME', APP_NAME . ' Server');
|
|
$replyTo = "";
|
|
|
|
if ($smtpEnabled) {
|
|
if (!empty($smtp['senderEmail'])) {
|
|
$senderEmail = $smtp['senderEmail'];
|
|
}
|
|
if (!empty($smtp['senderName'])) {
|
|
$senderName = $smtp['senderName'];
|
|
}
|
|
if (!empty($smtp['replyTo'])) {
|
|
$replyTo = $smtp['replyTo'];
|
|
}
|
|
|
|
$queueForMails
|
|
->setSmtpHost($smtp['host'] ?? '')
|
|
->setSmtpPort($smtp['port'] ?? '')
|
|
->setSmtpUsername($smtp['username'] ?? '')
|
|
->setSmtpPassword($smtp['password'] ?? '')
|
|
->setSmtpSecure($smtp['secure'] ?? '');
|
|
|
|
if (!empty($customTemplate)) {
|
|
if (!empty($customTemplate['senderEmail'])) {
|
|
$senderEmail = $customTemplate['senderEmail'];
|
|
}
|
|
if (!empty($customTemplate['senderName'])) {
|
|
$senderName = $customTemplate['senderName'];
|
|
}
|
|
if (!empty($customTemplate['replyTo'])) {
|
|
$replyTo = $customTemplate['replyTo'];
|
|
}
|
|
|
|
$body = $customTemplate['message'] ?? '';
|
|
$subject = $customTemplate['subject'] ?? $subject;
|
|
}
|
|
|
|
$queueForMails
|
|
->setSmtpReplyTo($replyTo)
|
|
->setSmtpSenderEmail($senderEmail)
|
|
->setSmtpSenderName($senderName);
|
|
}
|
|
|
|
$emailVariables = [
|
|
'direction' => $locale->getText('settings.direction'),
|
|
// {{user}}, {{redirect}} and {{project}} are required in default and custom templates
|
|
'user' => $profile->getAttribute('name'),
|
|
'redirect' => $url,
|
|
'project' => $projectName,
|
|
// TODO: remove unnecessary team variable from this email
|
|
'team' => ''
|
|
];
|
|
|
|
$queueForMails
|
|
->setRecipient($profile->getAttribute('email', ''))
|
|
->setName($profile->getAttribute('name', ''))
|
|
->setBody($body)
|
|
->appendVariables($emailVariables)
|
|
->setSubject($subject)
|
|
->setPreview($preview);
|
|
|
|
if ($project->getId() === 'console') {
|
|
$queueForMails->setSenderName($platform['emailSenderName']);
|
|
}
|
|
|
|
$queueForMails->trigger();
|
|
|
|
$recovery->setAttribute('secret', $secret);
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $profile->getId())
|
|
->setParam('tokenId', $recovery->getId())
|
|
->setUser($profile)
|
|
->setPayload(Response::showSensitive(fn () => $response->output($recovery, Response::MODEL_TOKEN)), sensitive: ['secret']);
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_CREATED)
|
|
->dynamic($recovery, Response::MODEL_TOKEN);
|
|
});
|
|
|
|
Http::put('/v1/account/recovery')
|
|
->desc('Update password recovery (confirmation)')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'sessions.write')
|
|
->label('event', 'users.[userId].recovery.[tokenId].update')
|
|
->label('audits.event', 'recovery.update')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('audits.userId', '{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'recovery',
|
|
name: 'updateRecovery',
|
|
description: '/docs/references/account/update-recovery.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_TOKEN,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', 'url:{url},userId:{param-userId}')
|
|
->param('userId', '', new UID(), 'User ID.')
|
|
->param('secret', '', new Text(256), 'Valid reset token.')
|
|
->param('password', '', fn ($project, $passwordsDictionary) => new PasswordDictionary($passwordsDictionary, $project->getAttribute('auths', [])['passwordDictionary'] ?? false), 'New user password. Must be between 8 and 256 chars.', false, ['project', 'passwordsDictionary'])
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('queueForEvents')
|
|
->inject('hooks')
|
|
->inject('proofForPassword')
|
|
->inject('proofForToken')
|
|
->inject('authorization')
|
|
->action(function (string $userId, string $secret, string $password, Response $response, User $user, Database $dbForProject, Document $project, Event $queueForEvents, Hooks $hooks, ProofsPassword $proofForPassword, ProofsToken $proofForToken, Authorization $authorization) {
|
|
/** @var Appwrite\Utopia\Database\Documents\User $profile */
|
|
$profile = $dbForProject->getDocument('users', $userId);
|
|
|
|
if ($profile->isEmpty()) {
|
|
throw new Exception(Exception::USER_NOT_FOUND);
|
|
}
|
|
|
|
$verifiedToken = $profile->tokenVerify(TOKEN_TYPE_RECOVERY, $secret, $proofForToken);
|
|
|
|
if (!$verifiedToken) {
|
|
throw new Exception(Exception::USER_INVALID_TOKEN);
|
|
}
|
|
|
|
$authorization->addRole(Role::user($profile->getId())->toString());
|
|
|
|
$newPassword = $proofForPassword->hash($password);
|
|
|
|
$hash = ProofsPassword::createHash($profile->getAttribute('hash'), $profile->getAttribute('hashOptions'));
|
|
$historyLimit = $project->getAttribute('auths', [])['passwordHistory'] ?? 0;
|
|
$history = $profile->getAttribute('passwordHistory', []);
|
|
|
|
if ($historyLimit > 0) {
|
|
$validator = new PasswordHistory($history, $hash);
|
|
if (!$validator->isValid($password)) {
|
|
throw new Exception(Exception::USER_PASSWORD_RECENTLY_USED);
|
|
}
|
|
|
|
$history[] = $newPassword;
|
|
$history = array_slice($history, (count($history) - $historyLimit), $historyLimit);
|
|
}
|
|
|
|
$hooks->trigger('passwordValidator', [$dbForProject, $project, $password, &$user, true]);
|
|
|
|
$profile = $dbForProject->updateDocument('users', $profile->getId(), $profile
|
|
->setAttribute('password', $newPassword)
|
|
->setAttribute('passwordHistory', $history)
|
|
->setAttribute('passwordUpdate', DateTime::now())
|
|
->setAttribute('hash', $proofForPassword->getHash()->getName())
|
|
->setAttribute('hashOptions', $proofForPassword->getHash()->getOptions())
|
|
->setAttribute('emailVerification', true));
|
|
|
|
$user->setAttributes($profile->getArrayCopy());
|
|
|
|
$recoveryDocument = $dbForProject->getDocument('tokens', $verifiedToken->getId());
|
|
|
|
/**
|
|
* We act like we're updating and validating
|
|
* the recovery token but actually we don't need it anymore.
|
|
*/
|
|
$dbForProject->deleteDocument('tokens', $verifiedToken->getId());
|
|
$dbForProject->purgeCachedDocument('users', $profile->getId());
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $profile->getId())
|
|
->setParam('tokenId', $recoveryDocument->getId())
|
|
->setPayload(Response::showSensitive(fn () => $response->output($recoveryDocument, Response::MODEL_TOKEN)), sensitive: ['secret']);
|
|
|
|
$response->dynamic($recoveryDocument, Response::MODEL_TOKEN);
|
|
});
|
|
|
|
Http::post('/v1/account/verifications/email')
|
|
->alias('/v1/account/verification')
|
|
->desc('Create email verification')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'account')
|
|
->label('event', 'users.[userId].verification.[tokenId].create')
|
|
->label('audits.event', 'verification.create')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('sdk', [
|
|
new Method(
|
|
namespace: 'account',
|
|
group: 'verification',
|
|
name: 'createEmailVerification',
|
|
description: '/docs/references/account/create-email-verification.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_TOKEN,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
),
|
|
new Method(
|
|
namespace: 'account',
|
|
group: 'verification',
|
|
name: 'createVerification',
|
|
description: '/docs/references/account/create-email-verification.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_TOKEN,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
deprecated: new Deprecated(
|
|
since: '1.8.0',
|
|
replaceWith: 'account.createEmailVerification'
|
|
),
|
|
public: false,
|
|
)
|
|
])
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', 'url:{url},userId:{userId}')
|
|
->param('url', '', fn ($redirectValidator) => $redirectValidator, 'URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.', false, ['redirectValidator']) // TODO add built-in confirm page
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('locale')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMails')
|
|
->inject('proofForToken')
|
|
->inject('authorization')
|
|
->action(function (string $url, Request $request, Response $response, Document $project, array $platform, User $user, Database $dbForProject, Locale $locale, Event $queueForEvents, Mail $queueForMails, ProofsToken $proofForToken, Authorization $authorization) {
|
|
|
|
if (empty(System::getEnv('_APP_SMTP_HOST'))) {
|
|
throw new Exception(Exception::GENERAL_SMTP_DISABLED, 'SMTP Disabled');
|
|
}
|
|
|
|
if (empty($user->getAttribute('email'))) {
|
|
throw new Exception(Exception::USER_EMAIL_NOT_FOUND);
|
|
}
|
|
|
|
$url = htmlentities($url);
|
|
if ($user->getAttribute('emailVerification')) {
|
|
throw new Exception(Exception::USER_EMAIL_ALREADY_VERIFIED);
|
|
}
|
|
|
|
$verificationSecret = $proofForToken->generate();
|
|
$expire = DateTime::formatTz(DateTime::addSeconds(new \DateTime(), TOKEN_EXPIRATION_CONFIRM));
|
|
|
|
$verification = new Document([
|
|
'$id' => ID::unique(),
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'type' => TOKEN_TYPE_VERIFICATION,
|
|
'secret' => $proofForToken->hash($verificationSecret), // One way hash encryption to protect DB leak
|
|
'expire' => $expire,
|
|
'userAgent' => $request->getUserAgent('UNKNOWN'),
|
|
'ip' => $request->getIP(),
|
|
]);
|
|
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
|
|
$verification = $dbForProject->createDocument('tokens', $verification
|
|
->setAttribute('$permissions', [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
]));
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
$url = Template::parseURL($url);
|
|
$url['query'] = Template::mergeQuery(((isset($url['query'])) ? $url['query'] : ''), ['userId' => $user->getId(), 'secret' => $verificationSecret, 'expire' => $expire]);
|
|
$url = Template::unParseURL($url);
|
|
|
|
$projectName = $project->isEmpty()
|
|
? 'Console'
|
|
: $project->getAttribute('name', '[APP-NAME]');
|
|
|
|
if ($project->getId() === 'console') {
|
|
$projectName = $platform['platformName'];
|
|
}
|
|
|
|
|
|
$body = $locale->getText("emails.verification.body");
|
|
$preview = $locale->getText("emails.verification.preview");
|
|
$subject = $locale->getText("emails.verification.subject");
|
|
$heading = $locale->getText("emails.verification.heading");
|
|
|
|
$customTemplate = $project->getAttribute('templates', [])['email.verification-' . $locale->default] ?? [];
|
|
$smtpBaseTemplate = $project->getAttribute('smtpBaseTemplate', 'email-base');
|
|
|
|
$validator = new FileName();
|
|
if (!$validator->isValid($smtpBaseTemplate)) {
|
|
throw new Exception(Exception::GENERAL_BAD_REQUEST, 'Invalid template path');
|
|
}
|
|
|
|
$bodyTemplate = __DIR__ . '/../../config/locale/templates/' . $smtpBaseTemplate . '.tpl';
|
|
|
|
$message = Template::fromFile(__DIR__ . '/../../config/locale/templates/email-inner-base.tpl');
|
|
$message
|
|
->setParam('{{body}}', $body, escapeHtml: false)
|
|
->setParam('{{hello}}', $locale->getText("emails.verification.hello"))
|
|
->setParam('{{footer}}', $locale->getText("emails.verification.footer"))
|
|
->setParam('{{thanks}}', $locale->getText("emails.verification.thanks"))
|
|
->setParam('{{buttonText}}', $locale->getText("emails.verification.buttonText"))
|
|
->setParam('{{signature}}', $locale->getText("emails.verification.signature"));
|
|
|
|
$body = $message->render();
|
|
|
|
$smtp = $project->getAttribute('smtp', []);
|
|
$smtpEnabled = $smtp['enabled'] ?? false;
|
|
|
|
$senderEmail = System::getEnv('_APP_SYSTEM_EMAIL_ADDRESS', APP_EMAIL_TEAM);
|
|
$senderName = System::getEnv('_APP_SYSTEM_EMAIL_NAME', APP_NAME . ' Server');
|
|
$replyTo = "";
|
|
|
|
if ($smtpEnabled) {
|
|
if (!empty($smtp['senderEmail'])) {
|
|
$senderEmail = $smtp['senderEmail'];
|
|
}
|
|
if (!empty($smtp['senderName'])) {
|
|
$senderName = $smtp['senderName'];
|
|
}
|
|
if (!empty($smtp['replyTo'])) {
|
|
$replyTo = $smtp['replyTo'];
|
|
}
|
|
|
|
$queueForMails
|
|
->setSmtpHost($smtp['host'] ?? '')
|
|
->setSmtpPort($smtp['port'] ?? '')
|
|
->setSmtpUsername($smtp['username'] ?? '')
|
|
->setSmtpPassword($smtp['password'] ?? '')
|
|
->setSmtpSecure($smtp['secure'] ?? '');
|
|
|
|
if (!empty($customTemplate)) {
|
|
if (!empty($customTemplate['senderEmail'])) {
|
|
$senderEmail = $customTemplate['senderEmail'];
|
|
}
|
|
if (!empty($customTemplate['senderName'])) {
|
|
$senderName = $customTemplate['senderName'];
|
|
}
|
|
if (!empty($customTemplate['replyTo'])) {
|
|
$replyTo = $customTemplate['replyTo'];
|
|
}
|
|
|
|
$body = $customTemplate['message'] ?? '';
|
|
$subject = $customTemplate['subject'] ?? $subject;
|
|
}
|
|
|
|
$queueForMails
|
|
->setSmtpReplyTo($replyTo)
|
|
->setSmtpSenderEmail($senderEmail)
|
|
->setSmtpSenderName($senderName);
|
|
}
|
|
|
|
$emailVariables = [
|
|
'heading' => $heading,
|
|
'direction' => $locale->getText('settings.direction'),
|
|
// {{user}}, {{redirect}} and {{project}} are required in default and custom templates
|
|
'user' => $user->getAttribute('name'),
|
|
'redirect' => $url,
|
|
'project' => $projectName,
|
|
// TODO: remove unnecessary team variable from this email
|
|
'team' => '',
|
|
];
|
|
|
|
if ($smtpBaseTemplate === APP_BRANDED_EMAIL_BASE_TEMPLATE) {
|
|
$emailVariables = array_merge($emailVariables, [
|
|
'accentColor' => $platform['accentColor'],
|
|
'logoUrl' => $platform['logoUrl'],
|
|
'twitter' => $platform['twitterUrl'],
|
|
'discord' => $platform['discordUrl'],
|
|
'github' => $platform['githubUrl'],
|
|
'terms' => $platform['termsUrl'],
|
|
'privacy' => $platform['privacyUrl'],
|
|
'platform' => $platform['platformName'],
|
|
]);
|
|
}
|
|
|
|
$queueForMails
|
|
->setSubject($subject)
|
|
->setPreview($preview)
|
|
->setBody($body)
|
|
->setBodyTemplate($bodyTemplate)
|
|
->appendVariables($emailVariables)
|
|
->setRecipient($user->getAttribute('email'))
|
|
->setName($user->getAttribute('name') ?? '');
|
|
|
|
if ($project->getId() === 'console') {
|
|
$queueForMails->setSenderName($platform['emailSenderName']);
|
|
}
|
|
|
|
$queueForMails->trigger();
|
|
|
|
$verification->setAttribute('secret', $verificationSecret);
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('tokenId', $verification->getId())
|
|
->setPayload(Response::showSensitive(fn () => $response->output($verification, Response::MODEL_TOKEN)), sensitive: ['secret']);
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_CREATED)
|
|
->dynamic($verification, Response::MODEL_TOKEN);
|
|
});
|
|
|
|
Http::put('/v1/account/verifications/email')
|
|
->alias('/v1/account/verification')
|
|
->desc('Update email verification (confirmation)')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'public')
|
|
->label('event', 'users.[userId].verification.[tokenId].update')
|
|
->label('audits.event', 'verification.update')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('sdk', [
|
|
new Method(
|
|
namespace: 'account',
|
|
group: 'verification',
|
|
name: 'updateEmailVerification',
|
|
description: '/docs/references/account/update-email-verification.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_TOKEN,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
),
|
|
new Method(
|
|
namespace: 'account',
|
|
group: 'verification',
|
|
name: 'updateVerification',
|
|
description: '/docs/references/account/update-email-verification.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_TOKEN,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
deprecated: new Deprecated(
|
|
since: '1.8.0',
|
|
replaceWith: 'account.updateEmailVerification'
|
|
),
|
|
public: false,
|
|
)
|
|
])
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', 'url:{url},userId:{param-userId}')
|
|
->param('userId', '', new UID(), 'User ID.')
|
|
->param('secret', '', new Text(256), 'Valid verification token.')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->inject('proofForToken')
|
|
->inject('authorization')
|
|
->action(function (string $userId, string $secret, Response $response, User $user, Database $dbForProject, Event $queueForEvents, ProofsToken $proofForToken, Authorization $authorization) {
|
|
/** @var Appwrite\Utopia\Database\Documents\User $profile */
|
|
$profile = $authorization->skip(fn () => $dbForProject->getDocument('users', $userId));
|
|
|
|
if ($profile->isEmpty()) {
|
|
throw new Exception(Exception::USER_NOT_FOUND);
|
|
}
|
|
|
|
$verifiedToken = $profile->tokenVerify(TOKEN_TYPE_VERIFICATION, $secret, $proofForToken);
|
|
|
|
if (!$verifiedToken) {
|
|
throw new Exception(Exception::USER_INVALID_TOKEN);
|
|
}
|
|
|
|
$authorization->addRole(Role::user($profile->getId())->toString());
|
|
|
|
$profile = $dbForProject->updateDocument('users', $profile->getId(), $profile->setAttribute('emailVerification', true));
|
|
|
|
$user->setAttributes($profile->getArrayCopy());
|
|
|
|
$verification = $dbForProject->getDocument('tokens', $verifiedToken->getId());
|
|
|
|
/**
|
|
* We act like we're updating and validating
|
|
* the verification token but actually we don't need it anymore.
|
|
*/
|
|
$dbForProject->deleteDocument('tokens', $verifiedToken->getId());
|
|
$dbForProject->purgeCachedDocument('users', $profile->getId());
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $userId)
|
|
->setParam('tokenId', $verification->getId())
|
|
->setPayload(Response::showSensitive(fn () => $response->output($verification, Response::MODEL_TOKEN)), sensitive: ['secret']);
|
|
|
|
$response->dynamic($verification, Response::MODEL_TOKEN);
|
|
});
|
|
|
|
Http::post('/v1/account/verifications/phone')
|
|
->alias('/v1/account/verification/phone')
|
|
->desc('Create phone verification')
|
|
->groups(['api', 'account', 'auth'])
|
|
->label('scope', 'account')
|
|
->label('auth.type', 'phone')
|
|
->label('event', 'users.[userId].verification.[tokenId].create')
|
|
->label('audits.event', 'verification.create')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'verification',
|
|
name: 'createPhoneVerification',
|
|
description: '/docs/references/account/create-phone-verification.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_TOKEN,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON,
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', ['url:{url},userId:{userId}', 'url:{url},ip:{ip}'])
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMessaging')
|
|
->inject('project')
|
|
->inject('locale')
|
|
->inject('timelimit')
|
|
->inject('queueForStatsUsage')
|
|
->inject('plan')
|
|
->inject('proofForCode')
|
|
->inject('authorization')
|
|
->action(function (Request $request, Response $response, User $user, Database $dbForProject, Event $queueForEvents, Messaging $queueForMessaging, Document $project, Locale $locale, callable $timelimit, StatsUsage $queueForStatsUsage, array $plan, ProofsCode $proofForCode, Authorization $authorization) {
|
|
if (empty(System::getEnv('_APP_SMS_PROVIDER'))) {
|
|
throw new Exception(Exception::GENERAL_PHONE_DISABLED, 'Phone provider not configured');
|
|
}
|
|
|
|
$phone = $user->getAttribute('phone');
|
|
if (empty($phone)) {
|
|
throw new Exception(Exception::USER_PHONE_NOT_FOUND);
|
|
}
|
|
|
|
if ($user->getAttribute('phoneVerification')) {
|
|
throw new Exception(Exception::USER_PHONE_ALREADY_VERIFIED);
|
|
}
|
|
|
|
$secret = null;
|
|
$sendSMS = true;
|
|
$mockNumbers = $project->getAttribute('auths', [])['mockNumbers'] ?? [];
|
|
foreach ($mockNumbers as $mockNumber) {
|
|
if ($mockNumber['phone'] === $phone) {
|
|
$secret = $mockNumber['otp'];
|
|
$sendSMS = false;
|
|
break;
|
|
}
|
|
}
|
|
|
|
$secret ??= $proofForCode->generate();
|
|
$expire = DateTime::formatTz(DateTime::addSeconds(new \DateTime(), TOKEN_EXPIRATION_CONFIRM));
|
|
|
|
$verification = new Document([
|
|
'$id' => ID::unique(),
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'type' => TOKEN_TYPE_PHONE,
|
|
'secret' => $proofForCode->hash($secret),
|
|
'expire' => $expire,
|
|
'userAgent' => $request->getUserAgent('UNKNOWN'),
|
|
'ip' => $request->getIP(),
|
|
]);
|
|
|
|
$authorization->addRole(Role::user($user->getId())->toString());
|
|
|
|
$verification = $dbForProject->createDocument('tokens', $verification
|
|
->setAttribute('$permissions', [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
]));
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
if ($sendSMS) {
|
|
$message = Template::fromFile(__DIR__ . '/../../config/locale/templates/sms-base.tpl');
|
|
|
|
$customTemplate = $project->getAttribute('templates', [])['sms.verification-' . $locale->default] ?? [];
|
|
if (!empty($customTemplate)) {
|
|
$message = $customTemplate['message'] ?? $message;
|
|
}
|
|
|
|
$messageContent = Template::fromString($locale->getText("sms.verification.body"));
|
|
$messageContent
|
|
->setParam('{{project}}', $project->getAttribute('name'))
|
|
->setParam('{{secret}}', $secret);
|
|
$messageContent = \strip_tags($messageContent->render());
|
|
$message = $message->setParam('{{token}}', $messageContent);
|
|
|
|
$message = $message->render();
|
|
|
|
$messageDoc = new Document([
|
|
'$id' => $verification->getId(),
|
|
'data' => [
|
|
'content' => $message,
|
|
],
|
|
]);
|
|
|
|
$queueForMessaging
|
|
->setType(MESSAGE_SEND_TYPE_INTERNAL)
|
|
->setMessage($messageDoc)
|
|
->setRecipients([$user->getAttribute('phone')])
|
|
->setProviderType(MESSAGE_TYPE_SMS);
|
|
|
|
$helper = PhoneNumberUtil::getInstance();
|
|
try {
|
|
$countryCode = $helper->parse($phone)->getCountryCode();
|
|
|
|
if (!empty($countryCode)) {
|
|
$queueForStatsUsage
|
|
->addMetric(str_replace('{countryCode}', $countryCode, METRIC_AUTH_METHOD_PHONE_COUNTRY_CODE), 1);
|
|
}
|
|
} catch (NumberParseException $e) {
|
|
// Ignore invalid phone number for country code stats
|
|
}
|
|
$queueForStatsUsage
|
|
->addMetric(METRIC_AUTH_METHOD_PHONE, 1)
|
|
->setProject($project)
|
|
->trigger();
|
|
}
|
|
|
|
$verification->setAttribute('secret', $secret);
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('tokenId', $verification->getId())
|
|
->setPayload($response->output($verification, Response::MODEL_TOKEN), sensitive: ['secret']);
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_CREATED)
|
|
->dynamic($verification, Response::MODEL_TOKEN);
|
|
});
|
|
|
|
Http::put('/v1/account/verifications/phone')
|
|
->alias('/v1/account/verification/phone')
|
|
->desc('Update phone verification (confirmation)')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'public')
|
|
->label('event', 'users.[userId].verification.[tokenId].update')
|
|
->label('audits.event', 'verification.update')
|
|
->label('audits.resource', 'user/{response.userId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'verification',
|
|
name: 'updatePhoneVerification',
|
|
description: '/docs/references/account/update-phone-verification.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_TOKEN,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->label('abuse-limit', 10)
|
|
->label('abuse-key', 'userId:{param-userId}')
|
|
->param('userId', '', new UID(), 'User ID.')
|
|
->param('secret', '', new Text(256), 'Valid verification token.')
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->inject('proofForCode')
|
|
->inject('authorization')
|
|
->action(function (string $userId, string $secret, Response $response, User $user, Database $dbForProject, Event $queueForEvents, ProofsCode $proofForCode, Authorization $authorization) {
|
|
/** @var Appwrite\Utopia\Database\Documents\User $profile */
|
|
$profile = $authorization->skip(fn () => $dbForProject->getDocument('users', $userId));
|
|
|
|
if ($profile->isEmpty()) {
|
|
throw new Exception(Exception::USER_NOT_FOUND);
|
|
}
|
|
|
|
$verifiedToken = $profile->tokenVerify(TOKEN_TYPE_PHONE, $secret, $proofForCode);
|
|
|
|
if (!$verifiedToken) {
|
|
throw new Exception(Exception::USER_INVALID_TOKEN);
|
|
}
|
|
|
|
$authorization->addRole(Role::user($profile->getId())->toString());
|
|
|
|
$profile = $dbForProject->updateDocument('users', $profile->getId(), $profile->setAttribute('phoneVerification', true));
|
|
|
|
$user->setAttributes($profile->getArrayCopy());
|
|
|
|
$verificationDocument = $dbForProject->getDocument('tokens', $verifiedToken->getId());
|
|
|
|
/**
|
|
* We act like we're updating and validating the verification token but actually we don't need it anymore.
|
|
*/
|
|
$dbForProject->deleteDocument('tokens', $verifiedToken->getId());
|
|
$dbForProject->purgeCachedDocument('users', $profile->getId());
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('tokenId', $verificationDocument->getId())
|
|
;
|
|
|
|
$response->dynamic($verificationDocument, Response::MODEL_TOKEN);
|
|
});
|
|
|
|
Http::post('/v1/account/targets/push')
|
|
->desc('Create push target')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'targets.write')
|
|
->label('audits.event', 'target.create')
|
|
->label('audits.resource', 'target/response.$id')
|
|
->label('event', 'users.[userId].targets.[targetId].create')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'pushTargets',
|
|
name: 'createPushTarget',
|
|
description: '/docs/references/account/create-push-target.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_CREATED,
|
|
model: Response::MODEL_TARGET,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->param('targetId', '', new CustomId(), 'Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.')
|
|
->param('identifier', '', new Text(Database::LENGTH_KEY), 'The target identifier (token, email, phone etc.)')
|
|
->param('providerId', '', new UID(), 'Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.', true)
|
|
->inject('queueForEvents')
|
|
->inject('user')
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('store')
|
|
->inject('proofForToken')
|
|
->inject('authorization')
|
|
->action(function (string $targetId, string $identifier, string $providerId, Event $queueForEvents, User $user, Request $request, Response $response, Database $dbForProject, Store $store, ProofsToken $proofForToken, Authorization $authorization) {
|
|
$targetId = $targetId == 'unique()' ? ID::unique() : $targetId;
|
|
|
|
$provider = $authorization->skip(fn () => $dbForProject->getDocument('providers', $providerId));
|
|
|
|
$target = $authorization->skip(fn () => $dbForProject->getDocument('targets', $targetId));
|
|
|
|
if (!$target->isEmpty()) {
|
|
throw new Exception(Exception::USER_TARGET_ALREADY_EXISTS);
|
|
}
|
|
|
|
$detector = new Detector($request->getUserAgent());
|
|
$detector->skipBotDetection(); // OPTIONAL: If called, bot detection will completely be skipped (bots will be detected as regular devices then)
|
|
|
|
$device = $detector->getDevice();
|
|
|
|
$sessionId = $user->sessionVerify($store->getProperty('secret', ''), $proofForToken);
|
|
$session = $dbForProject->getDocument('sessions', $sessionId);
|
|
|
|
try {
|
|
$target = $dbForProject->createDocument('targets', new Document([
|
|
'$id' => $targetId,
|
|
'$permissions' => [
|
|
Permission::read(Role::user($user->getId())),
|
|
Permission::update(Role::user($user->getId())),
|
|
Permission::delete(Role::user($user->getId())),
|
|
],
|
|
'providerId' => !empty($providerId) ? $providerId : null,
|
|
'providerInternalId' => !empty($providerId) ? $provider->getSequence() : null,
|
|
'providerType' => MESSAGE_TYPE_PUSH,
|
|
'userId' => $user->getId(),
|
|
'userInternalId' => $user->getSequence(),
|
|
'sessionId' => $session->getId(),
|
|
'sessionInternalId' => $session->getSequence(),
|
|
'identifier' => $identifier,
|
|
'name' => "{$device['deviceBrand']} {$device['deviceModel']}"
|
|
]));
|
|
} catch (Duplicate) {
|
|
throw new Exception(Exception::USER_TARGET_ALREADY_EXISTS);
|
|
}
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('targetId', $target->getId());
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_CREATED)
|
|
->dynamic($target, Response::MODEL_TARGET);
|
|
});
|
|
|
|
Http::put('/v1/account/targets/:targetId/push')
|
|
->desc('Update push target')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'targets.write')
|
|
->label('audits.event', 'target.update')
|
|
->label('audits.resource', 'target/response.$id')
|
|
->label('event', 'users.[userId].targets.[targetId].update')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'pushTargets',
|
|
name: 'updatePushTarget',
|
|
description: '/docs/references/account/update-push-target.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_TARGET,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->param('targetId', '', new UID(), 'Target ID.')
|
|
->param('identifier', '', new Text(Database::LENGTH_KEY), 'The target identifier (token, email, phone etc.)')
|
|
->inject('queueForEvents')
|
|
->inject('user')
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('authorization')
|
|
->action(function (string $targetId, string $identifier, Event $queueForEvents, Document $user, Request $request, Response $response, Database $dbForProject, Authorization $authorization) {
|
|
|
|
$target = $authorization->skip(fn () => $dbForProject->getDocument('targets', $targetId));
|
|
|
|
if ($target->isEmpty()) {
|
|
throw new Exception(Exception::USER_TARGET_NOT_FOUND);
|
|
}
|
|
|
|
if ($user->getId() !== $target->getAttribute('userId')) {
|
|
throw new Exception(Exception::USER_TARGET_NOT_FOUND);
|
|
}
|
|
|
|
if ($identifier) {
|
|
$target
|
|
->setAttribute('identifier', $identifier)
|
|
->setAttribute('expired', false);
|
|
}
|
|
|
|
$detector = new Detector($request->getUserAgent());
|
|
$detector->skipBotDetection(); // OPTIONAL: If called, bot detection will completely be skipped (bots will be detected as regular devices then)
|
|
|
|
$device = $detector->getDevice();
|
|
|
|
$target->setAttribute('name', "{$device['deviceBrand']} {$device['deviceModel']}");
|
|
|
|
$target = $dbForProject->updateDocument('targets', $target->getId(), $target);
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('targetId', $target->getId());
|
|
|
|
$response
|
|
->dynamic($target, Response::MODEL_TARGET);
|
|
});
|
|
|
|
Http::delete('/v1/account/targets/:targetId/push')
|
|
->desc('Delete push target')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'targets.write')
|
|
->label('audits.event', 'target.delete')
|
|
->label('audits.resource', 'target/response.$id')
|
|
->label('event', 'users.[userId].targets.[targetId].delete')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'pushTargets',
|
|
name: 'deletePushTarget',
|
|
description: '/docs/references/account/delete-push-target.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_NOCONTENT,
|
|
model: Response::MODEL_NONE,
|
|
)
|
|
],
|
|
contentType: ContentType::NONE
|
|
))
|
|
->param('targetId', '', new UID(), 'Target ID.')
|
|
->inject('queueForEvents')
|
|
->inject('queueForDeletes')
|
|
->inject('user')
|
|
->inject('request')
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('authorization')
|
|
->action(function (string $targetId, Event $queueForEvents, Delete $queueForDeletes, Document $user, Request $request, Response $response, Database $dbForProject, Authorization $authorization) {
|
|
$target = $authorization->skip(fn () => $dbForProject->getDocument('targets', $targetId));
|
|
|
|
if ($target->isEmpty()) {
|
|
throw new Exception(Exception::USER_TARGET_NOT_FOUND);
|
|
}
|
|
|
|
if ($user->getSequence() !== $target->getAttribute('userInternalId')) {
|
|
throw new Exception(Exception::USER_TARGET_NOT_FOUND);
|
|
}
|
|
|
|
$dbForProject->deleteDocument('targets', $target->getId());
|
|
|
|
$dbForProject->purgeCachedDocument('users', $user->getId());
|
|
|
|
$queueForDeletes
|
|
->setType(DELETE_TYPE_TARGET)
|
|
->setDocument($target);
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $user->getId())
|
|
->setParam('targetId', $target->getId())
|
|
->setPayload($response->output($target, Response::MODEL_TARGET));
|
|
|
|
$response->noContent();
|
|
});
|
|
Http::get('/v1/account/identities')
|
|
->desc('List identities')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'account')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'identities',
|
|
name: 'listIdentities',
|
|
description: '/docs/references/account/list-identities.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_IDENTITY_LIST,
|
|
)
|
|
],
|
|
contentType: ContentType::JSON
|
|
))
|
|
->param('queries', [], new Identities(), 'Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of ' . APP_LIMIT_ARRAY_PARAMS_SIZE . ' queries are allowed, each ' . APP_LIMIT_ARRAY_ELEMENT_SIZE . ' characters long. You may filter on the following attributes: ' . implode(', ', Identities::ALLOWED_ATTRIBUTES), true)
|
|
->param('total', true, new Boolean(true), 'When set to false, the total count returned will be 0 and will not be calculated.', true)
|
|
->inject('response')
|
|
->inject('user')
|
|
->inject('dbForProject')
|
|
->action(function (array $queries, bool $includeTotal, Response $response, User $user, Database $dbForProject) {
|
|
|
|
try {
|
|
$queries = Query::parseQueries($queries);
|
|
} catch (QueryException $e) {
|
|
throw new Exception(Exception::GENERAL_QUERY_INVALID, $e->getMessage());
|
|
}
|
|
|
|
$queries[] = Query::equal('userInternalId', [$user->getSequence()]);
|
|
|
|
$cursor = Query::getCursorQueries($queries, false);
|
|
$cursor = \reset($cursor);
|
|
|
|
if ($cursor !== false) {
|
|
$validator = new Cursor();
|
|
if (!$validator->isValid($cursor)) {
|
|
throw new Exception(Exception::GENERAL_QUERY_INVALID, $validator->getDescription());
|
|
}
|
|
|
|
$identityId = $cursor->getValue();
|
|
$cursorDocument = $dbForProject->getDocument('identities', $identityId);
|
|
|
|
if ($cursorDocument->isEmpty()) {
|
|
throw new Exception(Exception::GENERAL_CURSOR_NOT_FOUND, "Identity '{$identityId}' for the 'cursor' value not found.");
|
|
}
|
|
|
|
$cursor->setValue($cursorDocument);
|
|
}
|
|
|
|
$filterQueries = Query::groupByType($queries)['filters'];
|
|
try {
|
|
$results = $dbForProject->find('identities', $queries);
|
|
} catch (OrderException $e) {
|
|
throw new Exception(Exception::DATABASE_QUERY_ORDER_NULL, "The order attribute '{$e->getAttribute()}' had a null value. Cursor pagination requires all documents order attribute values are non-null.");
|
|
}
|
|
$total = $includeTotal ? $dbForProject->count('identities', $filterQueries, APP_LIMIT_COUNT) : 0;
|
|
|
|
$response->dynamic(new Document([
|
|
'identities' => $results,
|
|
'total' => $total,
|
|
]), Response::MODEL_IDENTITY_LIST);
|
|
});
|
|
|
|
Http::delete('/v1/account/identities/:identityId')
|
|
->desc('Delete identity')
|
|
->groups(['api', 'account'])
|
|
->label('scope', 'account')
|
|
->label('event', 'users.[userId].identities.[identityId].delete')
|
|
->label('audits.event', 'identity.delete')
|
|
->label('audits.resource', 'identity/{request.$identityId}')
|
|
->label('audits.userId', '{user.$id}')
|
|
->label('sdk', new Method(
|
|
namespace: 'account',
|
|
group: 'identities',
|
|
name: 'deleteIdentity',
|
|
description: '/docs/references/account/delete-identity.md',
|
|
auth: [AuthType::ADMIN, AuthType::SESSION, AuthType::JWT],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_NOCONTENT,
|
|
model: Response::MODEL_NONE,
|
|
)
|
|
],
|
|
contentType: ContentType::NONE
|
|
))
|
|
->param('identityId', '', new UID(), 'Identity ID.')
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->action(function (string $identityId, Response $response, Database $dbForProject, Event $queueForEvents) {
|
|
|
|
$identity = $dbForProject->getDocument('identities', $identityId);
|
|
|
|
if ($identity->isEmpty()) {
|
|
throw new Exception(Exception::USER_IDENTITY_NOT_FOUND);
|
|
}
|
|
|
|
$dbForProject->deleteDocument('identities', $identityId);
|
|
|
|
$queueForEvents
|
|
->setParam('userId', $identity->getAttribute('userId'))
|
|
->setParam('identityId', $identity->getId())
|
|
->setPayload($response->output($identity, Response::MODEL_IDENTITY));
|
|
|
|
return $response->noContent();
|
|
});
|