1
0
Fork 0
mirror of synced 2024-06-03 03:14:50 +12:00
appwrite/app/controllers/api/account.php

1674 lines
72 KiB
PHP
Raw Normal View History

2019-05-09 18:54:39 +12:00
<?php
2021-06-13 07:37:19 +12:00
use Ahc\Jwt\JWT;
use Appwrite\Auth\Auth;
use Appwrite\Auth\Validator\Password;
2021-08-05 17:06:38 +12:00
use Appwrite\Database\Validator\CustomId;
2021-02-15 06:28:54 +13:00
use Appwrite\Detector\Detector;
2021-05-07 10:31:05 +12:00
use Appwrite\Network\Validator\Email;
use Appwrite\Network\Validator\Host;
use Appwrite\Network\Validator\URL;
2021-08-05 17:06:38 +12:00
use Appwrite\OpenSSL\OpenSSL;
use Appwrite\Template\Template;
use Appwrite\URL\URL as URLParser;
use Appwrite\Utopia\Response;
2021-05-07 10:31:05 +12:00
use Utopia\App;
use Utopia\Audit\Audit;
2021-08-05 17:06:38 +12:00
use Utopia\Config\Config;
2021-05-07 10:31:05 +12:00
use Utopia\Database\Document;
use Utopia\Database\Exception\Duplicate;
use Utopia\Database\Query;
use Utopia\Database\Validator\Authorization;
use Utopia\Database\Validator\UID;
2021-08-05 17:06:38 +12:00
use Utopia\Exception;
use Utopia\Validator\ArrayList;
use Utopia\Validator\Assoc;
use Utopia\Validator\Text;
use Utopia\Validator\WhiteList;
2019-05-09 18:54:39 +12:00
2021-08-05 17:06:38 +12:00
$oauthDefaultSuccess = App::getEnv('_APP_HOME') . '/auth/oauth2/success';
$oauthDefaultFailure = App::getEnv('_APP_HOME') . '/auth/oauth2/failure';
2020-04-09 01:38:36 +12:00
2020-06-29 05:31:21 +12:00
App::post('/v1/account')
2020-01-23 12:32:10 +13:00
->desc('Create Account')
2021-03-01 07:36:13 +13:00
->groups(['api', 'account', 'auth'])
2020-10-31 08:53:27 +13:00
->label('event', 'account.create')
2020-01-06 00:29:42 +13:00
->label('scope', 'public')
2021-03-01 07:36:13 +13:00
->label('auth.type', 'emailPassword')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [])
2020-01-04 10:00:53 +13:00
->label('sdk.namespace', 'account')
2020-01-31 05:18:46 +13:00
->label('sdk.method', 'create')
2020-01-06 00:29:42 +13:00
->label('sdk.description', '/docs/references/account/create.md')
2020-11-12 10:02:24 +13:00
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_USER)
2020-01-04 10:00:53 +13:00
->label('abuse-limit', 10)
2021-08-05 17:02:55 +12:00
->param('userId', '', new CustomId(), 'Unique Id. Choose your own unique ID or pass the string `unique()` to auto generate it. Valid chars are a-z, A-Z, 0-9, and underscore. Can\'t start with a leading underscore. Max length is 36 chars.')
2020-09-11 02:40:14 +12:00
->param('email', '', new Email(), 'User email.')
->param('password', '', new Password(), 'User password. Must be between 6 to 32 chars.')
->param('name', '', new Text(128), 'User name. Max length: 128 chars.', true)
2020-12-27 03:31:53 +13:00
->inject('request')
->inject('response')
->inject('project')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('audits')
2021-08-05 17:02:55 +12:00
->action(function ($userId, $email, $password, $name, $request, $response, $project, $dbForInternal, $audits) {
/** @var Utopia\Swoole\Request $request */
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-07-26 02:47:18 +12:00
/** @var Utopia\Database\Document $project */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Database $dbForInternal */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2020-06-30 09:43:34 +12:00
$email = \strtolower($email);
2020-06-30 09:43:34 +12:00
if ('console' === $project->getId()) {
$whitelistEmails = $project->getAttribute('authWhitelistEmails');
$whitelistIPs = $project->getAttribute('authWhitelistIPs');
2020-06-30 09:43:34 +12:00
if (!empty($whitelistEmails) && !\in_array($email, $whitelistEmails)) {
2020-06-30 09:43:34 +12:00
throw new Exception('Console registration is restricted to specific emails. Contact your administrator for more information.', 401);
2020-01-04 10:00:53 +13:00
}
if (!empty($whitelistIPs) && !\in_array($request->getIP(), $whitelistIPs)) {
2020-06-30 09:43:34 +12:00
throw new Exception('Console registration is restricted to specific IPs. Contact your administrator for more information.', 401);
2020-01-04 10:00:53 +13:00
}
2020-06-30 09:43:34 +12:00
}
2020-01-04 10:00:53 +13:00
2021-03-01 07:36:13 +13:00
$limit = $project->getAttribute('usersAuthLimit', 0);
if ($limit !== 0) {
2021-05-10 06:37:47 +12:00
$sum = $dbForInternal->count('users', [], APP_LIMIT_USERS);
2021-03-01 07:36:13 +13:00
2021-08-05 17:06:38 +12:00
if ($sum >= $limit) {
2021-03-01 07:36:13 +13:00
throw new Exception('Project registration is restricted. Contact your administrator for more information.', 501);
}
}
2020-06-30 09:43:34 +12:00
Authorization::disable();
2020-01-04 10:00:53 +13:00
2020-06-30 09:43:34 +12:00
try {
2021-08-05 17:02:55 +12:00
$userId = $userId == 'unique()' ? $dbForInternal->getId() : $userId;
2021-05-07 10:31:05 +12:00
$user = $dbForInternal->createDocument('users', new Document([
'$id' => $userId,
2021-06-12 06:23:16 +12:00
'$read' => ['role:all'],
2021-08-05 17:06:38 +12:00
'$write' => ['user:' . $userId],
2020-06-30 09:43:34 +12:00
'email' => $email,
'emailVerification' => false,
'status' => true,
2020-06-30 09:43:34 +12:00
'password' => Auth::passwordHash($password),
'passwordUpdate' => \time(),
2020-06-30 09:43:34 +12:00
'registration' => \time(),
'reset' => false,
'name' => $name,
2021-05-07 10:31:05 +12:00
'prefs' => [],
'sessions' => [],
'tokens' => [],
'memberships' => [],
]));
2020-06-30 09:43:34 +12:00
} catch (Duplicate $th) {
throw new Exception('Account already exists', 409);
}
2020-01-04 10:00:53 +13:00
2021-02-17 21:47:07 +13:00
Authorization::reset();
2020-01-04 10:00:53 +13:00
2021-08-05 17:06:38 +12:00
Authorization::unsetRole('role:' . Auth::USER_ROLE_GUEST);
Authorization::setRole('user:' . $user->getId());
Authorization::setRole('role:' . Auth::USER_ROLE_MEMBER);
2020-11-21 10:02:26 +13:00
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $user->getId())
->setParam('event', 'account.create')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $user->getId())
2020-06-30 09:43:34 +12:00
;
2021-05-07 10:31:05 +12:00
$response->setStatusCode(Response::STATUS_CODE_CREATED);
2021-07-26 02:47:18 +12:00
$response->dynamic($user, Response::MODEL_USER);
2020-12-27 03:31:53 +13:00
});
2020-06-29 05:31:21 +12:00
App::post('/v1/account/sessions')
2020-01-06 00:29:42 +13:00
->desc('Create Account Session')
2021-03-01 10:22:03 +13:00
->groups(['api', 'account', 'auth'])
2020-10-31 08:53:27 +13:00
->label('event', 'account.sessions.create')
2020-01-06 00:29:42 +13:00
->label('scope', 'public')
2021-03-01 10:22:03 +13:00
->label('auth.type', 'emailPassword')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [])
->label('sdk.namespace', 'account')
2020-01-31 05:18:46 +13:00
->label('sdk.method', 'createSession')
2020-01-06 00:29:42 +13:00
->label('sdk.description', '/docs/references/account/create-session.md')
2020-11-12 10:02:24 +13:00
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_SESSION)
->label('abuse-limit', 10)
->label('abuse-key', 'url:{url},email:{param-email}')
2020-09-11 02:40:14 +12:00
->param('email', '', new Email(), 'User email.')
->param('password', '', new Password(), 'User password. Must be between 6 to 32 chars.')
2020-12-27 03:31:53 +13:00
->inject('request')
->inject('response')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('locale')
->inject('geodb')
->inject('audits')
2021-08-06 21:35:28 +12:00
->action(function ($email, $password, $request, $response, $dbForInternal, $locale, $geodb, $audits) {
/** @var Utopia\Swoole\Request $request */
2020-07-03 09:48:02 +12:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Database $dbForInternal */
2020-10-31 08:53:27 +13:00
/** @var Utopia\Locale\Locale $locale */
/** @var MaxMind\Db\Reader $geodb */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2020-06-30 09:43:34 +12:00
$email = \strtolower($email);
2020-06-30 23:09:28 +12:00
$protocol = $request->getProtocol();
2021-08-05 17:06:38 +12:00
2021-08-04 08:22:03 +12:00
$profile = $dbForInternal->findOne('users', [new Query('email', Query::TYPE_EQUAL, [$email])]); // Get user by email address
2020-06-30 09:43:34 +12:00
2021-05-07 10:31:05 +12:00
if (!$profile || !Auth::passwordVerify($password, $profile->getAttribute('password'))) {
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
//->setParam('userId', $profile->getId())
->setParam('event', 'account.sessions.failed')
2020-06-30 09:43:34 +12:00
->setParam('resource', 'users/'.($profile ? $profile->getId() : ''))
;
2020-01-04 10:00:53 +13:00
2020-06-30 09:43:34 +12:00
throw new Exception('Invalid credentials', 401); // Wrong password or username
}
2020-01-04 10:00:53 +13:00
if (false === $profile->getAttribute('status')) { // Account is blocked
throw new Exception('Invalid credentials. User is blocked', 401); // User is in status blocked
}
2021-02-15 06:28:54 +13:00
$detector = new Detector($request->getUserAgent('UNKNOWN'));
$record = $geodb->get($request->getIP());
2020-06-30 09:43:34 +12:00
$expiry = \time() + Auth::TOKEN_EXPIRATION_LOGIN_LONG;
$secret = Auth::tokenGenerator();
2021-02-15 06:28:54 +13:00
$session = new Document(array_merge(
[
2021-08-06 21:35:28 +12:00
'$id' => $dbForInternal->getId(),
2021-06-13 08:44:25 +12:00
'userId' => $profile->getId(),
2021-02-20 01:12:47 +13:00
'provider' => Auth::SESSION_PROVIDER_EMAIL,
2021-02-19 23:02:02 +13:00
'providerUid' => $email,
2021-02-15 06:28:54 +13:00
'secret' => Auth::hash($secret), // One way hash encryption to protect DB leak
'expire' => $expiry,
'userAgent' => $request->getUserAgent('UNKNOWN'),
'ip' => $request->getIP(),
'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--',
2021-02-15 21:16:23 +13:00
], $detector->getOS(), $detector->getClient(), $detector->getDevice()
2021-02-15 06:28:54 +13:00
));
2020-10-31 08:53:27 +13:00
2021-08-05 17:06:38 +12:00
Authorization::setRole('user:' . $profile->getId());
2020-01-04 10:00:53 +13:00
2021-07-17 22:04:43 +12:00
$session = $dbForInternal->createDocument('sessions', $session
2021-08-05 17:06:38 +12:00
->setAttribute('$read', ['user:' . $profile->getId()])
->setAttribute('$write', ['user:' . $profile->getId()])
2021-07-17 22:04:43 +12:00
);
2020-01-12 02:58:02 +13:00
2021-07-17 22:04:43 +12:00
$profile->setAttribute('sessions', $session, Document::SET_TYPE_APPEND);
2021-05-07 10:31:05 +12:00
$profile = $dbForInternal->updateDocument('users', $profile->getId(), $profile);
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $profile->getId())
->setParam('event', 'account.sessions.create')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $profile->getId())
2020-06-30 09:43:34 +12:00
;
2020-06-30 09:43:34 +12:00
if (!Config::getParam('domainVerification')) {
2020-01-04 10:00:53 +13:00
$response
2020-06-30 09:43:34 +12:00
->addHeader('X-Fallback-Cookies', \json_encode([Auth::$cookieName => Auth::encodeSession($profile->getId(), $secret)]))
2020-01-12 02:58:02 +13:00
;
2020-01-04 10:00:53 +13:00
}
2021-08-05 17:06:38 +12:00
2020-06-30 09:43:34 +12:00
$response
2021-08-05 17:06:38 +12:00
->addCookie(Auth::$cookieName . '_legacy', Auth::encodeSession($profile->getId(), $secret), $expiry, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
2020-07-01 18:35:57 +12:00
->addCookie(Auth::$cookieName, Auth::encodeSession($profile->getId(), $secret), $expiry, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'))
2020-06-30 09:43:34 +12:00
->setStatusCode(Response::STATUS_CODE_CREATED)
2020-07-03 09:48:02 +12:00
;
2020-10-31 08:53:27 +13:00
2021-07-23 08:15:01 +12:00
$countryName = $locale->getText('countries.'.strtolower($session->getAttribute('countryCode')), $locale->getText('locale.country.unknown'));
2021-06-17 21:33:57 +12:00
2020-10-31 08:53:27 +13:00
$session
->setAttribute('current', true)
2021-06-17 21:33:57 +12:00
->setAttribute('countryName', $countryName)
2020-10-31 08:53:27 +13:00
;
2021-08-05 17:06:38 +12:00
2021-07-26 02:47:18 +12:00
$response->dynamic($session, Response::MODEL_SESSION);
2020-12-27 03:31:53 +13:00
});
2020-01-04 10:00:53 +13:00
2020-06-29 05:31:21 +12:00
App::get('/v1/account/sessions/oauth2/:provider')
2020-02-17 00:41:03 +13:00
->desc('Create Account Session with OAuth2')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2021-08-05 17:06:38 +12:00
->label('error', __DIR__ . '/../../views/general/error.phtml')
2020-01-06 00:29:42 +13:00
->label('scope', 'public')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [])
2020-01-06 00:29:42 +13:00
->label('sdk.namespace', 'account')
2020-02-17 00:41:03 +13:00
->label('sdk.method', 'createOAuth2Session')
->label('sdk.description', '/docs/references/account/create-session-oauth2.md')
2021-03-05 18:30:34 +13:00
->label('sdk.response.code', Response::STATUS_CODE_MOVED_PERMANENTLY)
->label('sdk.response.type', Response::CONTENT_TYPE_HTML)
2020-04-11 06:59:14 +12:00
->label('sdk.methodType', 'webAuth')
2020-01-06 00:29:42 +13:00
->label('abuse-limit', 50)
->label('abuse-key', 'ip:{ip}')
2021-08-05 17:06:38 +12:00
->param('provider', '', new WhiteList(\array_keys(Config::getParam('providers')), true), 'OAuth2 Provider. Currently, supported providers are: ' . \implode(', ', \array_keys(\array_filter(Config::getParam('providers'), function ($node) {return (!$node['mock']);}))) . '.')
->param('success', $oauthDefaultSuccess, function ($clients) {return new Host($clients);}, 'URL to redirect back to your app after a successful login attempt. 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, ['clients'])
->param('failure', $oauthDefaultFailure, function ($clients) {return new Host($clients);}, 'URL to redirect back to your app after a failed login attempt. 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, ['clients'])
2020-09-11 02:40:14 +12:00
->param('scopes', [], new ArrayList(new Text(128)), 'A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes.', true)
2020-12-27 03:31:53 +13:00
->inject('request')
->inject('response')
->inject('project')
2020-06-30 09:43:34 +12:00
->action(function ($provider, $success, $failure, $scopes, $request, $response, $project) {
/** @var Utopia\Swoole\Request $request */
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-07-26 02:47:18 +12:00
/** @var Utopia\Database\Document $project */
2020-01-06 00:29:42 +13:00
2020-06-30 23:09:28 +12:00
$protocol = $request->getProtocol();
2021-08-05 17:06:38 +12:00
$callback = $protocol . '://' . $request->getHostname() . '/v1/account/sessions/oauth2/callback/' . $provider . '/' . $project->getId();
$appId = $project->getAttribute('usersOauth2' . \ucfirst($provider) . 'Appid', '');
$appSecret = $project->getAttribute('usersOauth2' . \ucfirst($provider) . 'Secret', '{}');
2020-01-06 00:29:42 +13:00
2020-06-30 09:43:34 +12:00
if (!empty($appSecret) && isset($appSecret['version'])) {
2021-08-05 17:06:38 +12:00
$key = App::getEnv('_APP_OPENSSL_KEY_V' . $appSecret['version']);
2020-06-30 09:43:34 +12:00
$appSecret = OpenSSL::decrypt($appSecret['data'], $appSecret['method'], $key, 0, \hex2bin($appSecret['iv']), \hex2bin($appSecret['tag']));
}
2020-01-06 00:29:42 +13:00
2020-06-30 09:43:34 +12:00
if (empty($appId) || empty($appSecret)) {
2021-08-05 17:06:38 +12:00
throw new Exception('This provider is disabled. Please configure the provider app ID and app secret key from your ' . APP_NAME . ' console to continue.', 412);
2020-06-30 09:43:34 +12:00
}
2020-01-06 00:29:42 +13:00
2021-08-06 22:48:50 +12:00
$className = 'Appwrite\\Auth\\OAuth2\\'.\ucfirst($provider);
2020-06-30 09:43:34 +12:00
2021-08-06 22:48:50 +12:00
if (!\class_exists($className)) {
2020-06-30 09:43:34 +12:00
throw new Exception('Provider is not supported', 501);
2020-01-06 00:29:42 +13:00
}
2020-06-30 09:43:34 +12:00
2021-08-06 22:48:50 +12:00
$oauth2 = new $className($appId, $appSecret, $callback, ['success' => $success, 'failure' => $failure], $scopes);
2020-06-30 09:43:34 +12:00
$response
->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, max-age=0')
->addHeader('Pragma', 'no-cache')
->redirect($oauth2->getLoginURL());
2020-12-27 03:31:53 +13:00
});
2020-01-06 00:29:42 +13:00
2020-06-29 05:31:21 +12:00
App::get('/v1/account/sessions/oauth2/callback/:provider/:projectId')
2020-02-17 00:41:03 +13:00
->desc('OAuth2 Callback')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2021-08-05 17:06:38 +12:00
->label('error', __DIR__ . '/../../views/general/error.phtml')
2020-01-06 00:29:42 +13:00
->label('scope', 'public')
->label('docs', false)
2020-09-11 02:40:14 +12:00
->param('projectId', '', new Text(1024), 'Project unique ID.')
->param('provider', '', new WhiteList(\array_keys(Config::getParam('providers')), true), 'OAuth2 provider.')
->param('code', '', new Text(1024), 'OAuth2 code.')
->param('state', '', new Text(2048), 'Login state params.', true)
2020-12-27 03:31:53 +13:00
->inject('request')
->inject('response')
2020-06-30 23:09:28 +12:00
->action(function ($projectId, $provider, $code, $state, $request, $response) {
/** @var Utopia\Swoole\Request $request */
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2020-06-30 23:09:28 +12:00
2020-07-03 09:48:02 +12:00
$domain = $request->getHostname();
2020-06-30 23:09:28 +12:00
$protocol = $request->getProtocol();
2021-08-05 17:06:38 +12:00
2020-06-30 09:43:34 +12:00
$response
->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, max-age=0')
->addHeader('Pragma', 'no-cache')
2021-08-05 17:06:38 +12:00
->redirect($protocol . '://' . $domain . '/v1/account/sessions/oauth2/' . $provider . '/redirect?'
. \http_build_query(['project' => $projectId, 'code' => $code, 'state' => $state]));
2020-12-27 03:31:53 +13:00
});
2020-01-06 00:29:42 +13:00
2020-06-29 05:31:21 +12:00
App::post('/v1/account/sessions/oauth2/callback/:provider/:projectId')
->desc('OAuth2 Callback')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2021-08-05 17:06:38 +12:00
->label('error', __DIR__ . '/../../views/general/error.phtml')
->label('scope', 'public')
->label('origin', '*')
->label('docs', false)
2020-09-11 02:40:14 +12:00
->param('projectId', '', new Text(1024), 'Project unique ID.')
->param('provider', '', new WhiteList(\array_keys(Config::getParam('providers')), true), 'OAuth2 provider.')
->param('code', '', new Text(1024), 'OAuth2 code.')
->param('state', '', new Text(2048), 'Login state params.', true)
2020-12-27 03:31:53 +13:00
->inject('request')
->inject('response')
2020-06-30 23:09:28 +12:00
->action(function ($projectId, $provider, $code, $state, $request, $response) {
/** @var Utopia\Swoole\Request $request */
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2020-06-30 23:09:28 +12:00
2020-07-03 09:48:02 +12:00
$domain = $request->getHostname();
2020-06-30 23:09:28 +12:00
$protocol = $request->getProtocol();
2021-08-05 17:06:38 +12:00
2020-06-30 09:43:34 +12:00
$response
->addHeader('Cache-Control', 'no-store, no-cache, must-revalidate, max-age=0')
->addHeader('Pragma', 'no-cache')
2021-08-05 17:06:38 +12:00
->redirect($protocol . '://' . $domain . '/v1/account/sessions/oauth2/' . $provider . '/redirect?'
. \http_build_query(['project' => $projectId, 'code' => $code, 'state' => $state]));
2020-12-27 03:31:53 +13:00
});
2020-06-29 05:31:21 +12:00
App::get('/v1/account/sessions/oauth2/:provider/redirect')
2020-02-17 00:41:03 +13:00
->desc('OAuth2 Redirect')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2021-08-05 17:06:38 +12:00
->label('error', __DIR__ . '/../../views/general/error.phtml')
2020-10-31 08:53:27 +13:00
->label('event', 'account.sessions.create')
2020-01-06 00:29:42 +13:00
->label('scope', 'public')
->label('abuse-limit', 50)
->label('abuse-key', 'ip:{ip}')
->label('docs', false)
2020-09-11 02:40:14 +12:00
->param('provider', '', new WhiteList(\array_keys(Config::getParam('providers')), true), 'OAuth2 provider.')
->param('code', '', new Text(1024), 'OAuth2 code.')
->param('state', '', new Text(2048), 'OAuth2 state params.', true)
2020-12-27 03:31:53 +13:00
->inject('request')
->inject('response')
->inject('project')
->inject('user')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('geodb')
->inject('audits')
->inject('events')
->action(function ($provider, $code, $state, $request, $response, $project, $user, $dbForInternal, $geodb, $audits, $events) use ($oauthDefaultSuccess) {
/** @var Utopia\Swoole\Request $request */
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-07-26 02:47:18 +12:00
/** @var Utopia\Database\Document $project */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
/** @var Utopia\Database\Database $dbForInternal */
2020-10-31 08:53:27 +13:00
/** @var MaxMind\Db\Reader $geodb */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2021-08-05 17:06:38 +12:00
2020-06-30 23:09:28 +12:00
$protocol = $request->getProtocol();
2021-08-05 17:06:38 +12:00
$callback = $protocol . '://' . $request->getHostname() . '/v1/account/sessions/oauth2/callback/' . $provider . '/' . $project->getId();
2020-06-30 09:43:34 +12:00
$defaultState = ['success' => $project->getAttribute('url', ''), 'failure' => ''];
$validateURL = new URL();
2021-08-05 17:06:38 +12:00
$appId = $project->getAttribute('usersOauth2' . \ucfirst($provider) . 'Appid', '');
$appSecret = $project->getAttribute('usersOauth2' . \ucfirst($provider) . 'Secret', '{}');
2020-06-30 09:43:34 +12:00
if (!empty($appSecret) && isset($appSecret['version'])) {
2021-08-05 17:06:38 +12:00
$key = App::getEnv('_APP_OPENSSL_KEY_V' . $appSecret['version']);
2020-06-30 09:43:34 +12:00
$appSecret = OpenSSL::decrypt($appSecret['data'], $appSecret['method'], $key, 0, \hex2bin($appSecret['iv']), \hex2bin($appSecret['tag']));
}
2020-01-06 00:29:42 +13:00
2021-08-05 17:06:38 +12:00
$classname = 'Appwrite\\Auth\\OAuth2\\' . \ucfirst($provider);
2020-01-06 00:29:42 +13:00
2021-08-06 22:48:50 +12:00
if (!\class_exists($className)) {
2020-06-30 09:43:34 +12:00
throw new Exception('Provider is not supported', 501);
}
2020-01-06 00:29:42 +13:00
2021-08-06 22:48:50 +12:00
$oauth2 = new $className($appId, $appSecret, $callback);
2020-01-06 00:29:42 +13:00
2020-06-30 09:43:34 +12:00
if (!empty($state)) {
try {
$state = \array_merge($defaultState, $oauth2->parseState($state));
2021-08-05 17:06:38 +12:00
} catch (\Exception$exception) {
2020-06-30 09:43:34 +12:00
throw new Exception('Failed to parse login state params as passed from OAuth2 provider');
2020-01-06 00:29:42 +13:00
}
2020-06-30 09:43:34 +12:00
} else {
$state = $defaultState;
}
2020-01-06 00:29:42 +13:00
2020-06-30 09:43:34 +12:00
if (!$validateURL->isValid($state['success'])) {
throw new Exception('Invalid redirect URL for success login', 400);
}
2020-01-06 00:29:42 +13:00
2020-06-30 09:43:34 +12:00
if (!empty($state['failure']) && !$validateURL->isValid($state['failure'])) {
throw new Exception('Invalid redirect URL for failure login', 400);
}
2021-08-05 17:06:38 +12:00
2020-06-30 09:43:34 +12:00
$state['failure'] = null;
$accessToken = $oauth2->getAccessToken($code);
2020-01-06 00:29:42 +13:00
2020-06-30 09:43:34 +12:00
if (empty($accessToken)) {
if (!empty($state['failure'])) {
$response->redirect($state['failure'], 301, 0);
2020-01-06 00:29:42 +13:00
}
2020-06-30 09:43:34 +12:00
throw new Exception('Failed to obtain access token');
}
2020-01-06 00:29:42 +13:00
2020-06-30 09:43:34 +12:00
$oauth2ID = $oauth2->getUserID($accessToken);
2021-08-05 17:06:38 +12:00
2020-06-30 09:43:34 +12:00
if (empty($oauth2ID)) {
if (!empty($state['failure'])) {
$response->redirect($state['failure'], 301, 0);
2020-01-06 00:29:42 +13:00
}
2020-06-30 09:43:34 +12:00
throw new Exception('Missing ID from OAuth2 provider', 400);
}
2020-01-06 00:29:42 +13:00
2021-05-07 10:31:05 +12:00
$sessions = $user->getAttribute('sessions', []);
$current = Auth::sessionVerify($sessions, Auth::$secret);
2020-01-06 00:29:42 +13:00
2021-08-05 17:06:38 +12:00
if ($current) { // Delete current session of new one.
foreach ($sessions as $key => $session) {/** @var Document $session */
2021-05-07 10:31:05 +12:00
if ($current === $session['$id']) {
unset($sessions[$key]);
2021-08-05 17:06:38 +12:00
2021-07-17 22:04:43 +12:00
$dbForInternal->deleteDocument('sessions', $session->getId());
2021-05-07 10:31:05 +12:00
$dbForInternal->updateDocument('users', $user->getId(), $user->setAttribute('sessions', $sessions));
}
}
2020-06-30 09:43:34 +12:00
}
2020-01-06 00:29:42 +13:00
2021-08-04 08:22:03 +12:00
$user = ($user->isEmpty()) ? $dbForInternal->findOne('sessions', [ // Get user by provider id
2021-07-18 09:21:33 +12:00
new Query('provider', QUERY::TYPE_EQUAL, [$provider]),
new Query('providerUid', QUERY::TYPE_EQUAL, [$oauth2ID]),
2021-08-04 08:22:03 +12:00
]) : $user;
2020-01-06 00:29:42 +13:00
2021-07-18 09:21:33 +12:00
if ($user === false || $user->isEmpty()) { // No user logged in or with OAuth2 provider ID, create new one or connect with account with same email
2020-06-30 09:43:34 +12:00
$name = $oauth2->getUserName($accessToken);
$email = $oauth2->getUserEmail($accessToken);
2020-01-06 00:29:42 +13:00
2021-08-04 08:22:03 +12:00
$user = $dbForInternal->findOne('users', [new Query('email', Query::TYPE_EQUAL, [$email])]); // Get user by email address
2020-01-06 00:29:42 +13:00
2021-07-18 09:21:33 +12:00
if ($user === false || $user->isEmpty()) { // Last option -> create the user, generate random password
2021-03-01 07:36:13 +13:00
$limit = $project->getAttribute('usersAuthLimit', 0);
2021-08-05 17:06:38 +12:00
2021-03-01 07:36:13 +13:00
if ($limit !== 0) {
2021-05-10 06:37:47 +12:00
$sum = $dbForInternal->count('users', [], APP_LIMIT_COUNT);
2021-07-18 09:21:33 +12:00
2021-08-05 17:06:38 +12:00
if ($sum >= $limit) {
2021-03-01 07:36:13 +13:00
throw new Exception('Project registration is restricted. Contact your administrator for more information.', 501);
}
}
2021-08-05 17:06:38 +12:00
2020-06-30 09:43:34 +12:00
Authorization::disable();
2020-01-06 00:29:42 +13:00
2020-06-30 09:43:34 +12:00
try {
2021-05-07 10:31:05 +12:00
$userId = $dbForInternal->getId();
$user = $dbForInternal->createDocument('users', new Document([
'$id' => $userId,
2021-06-12 06:23:16 +12:00
'$read' => ['role:all'],
2021-08-05 17:06:38 +12:00
'$write' => ['user:' . $userId],
2020-06-30 09:43:34 +12:00
'email' => $email,
'emailVerification' => true,
'status' => true, // Email should already be authenticated by OAuth2 provider
2020-06-30 09:43:34 +12:00
'password' => Auth::passwordHash(Auth::passwordGenerator()),
'passwordUpdate' => 0,
2020-06-30 09:43:34 +12:00
'registration' => \time(),
'reset' => false,
'name' => $name,
2021-05-09 11:10:13 +12:00
'prefs' => [],
'sessions' => [],
'tokens' => [],
'memberships' => [],
2021-05-07 10:31:05 +12:00
]));
2020-06-30 09:43:34 +12:00
} catch (Duplicate $th) {
throw new Exception('Account already exists', 409);
}
2020-01-06 00:29:42 +13:00
2021-02-17 21:47:07 +13:00
Authorization::reset();
2020-01-06 00:29:42 +13:00
}
2020-06-30 09:43:34 +12:00
}
2020-01-06 00:29:42 +13:00
if (false === $user->getAttribute('status')) { // Account is blocked
throw new Exception('Invalid credentials. User is blocked', 401); // User is in status blocked
}
2020-06-30 09:43:34 +12:00
// Create session token, verify user account and update OAuth2 ID and Access Token
2021-02-15 06:28:54 +13:00
$detector = new Detector($request->getUserAgent('UNKNOWN'));
$record = $geodb->get($request->getIP());
2020-06-30 09:43:34 +12:00
$secret = Auth::tokenGenerator();
$expiry = \time() + Auth::TOKEN_EXPIRATION_LOGIN_LONG;
2021-02-15 06:28:54 +13:00
$session = new Document(array_merge([
2021-05-07 10:31:05 +12:00
'$id' => $dbForInternal->getId(),
2021-06-13 08:44:25 +12:00
'userId' => $user->getId(),
2021-02-19 23:02:02 +13:00
'provider' => $provider,
'providerUid' => $oauth2ID,
'providerToken' => $accessToken,
2020-11-13 00:54:16 +13:00
'secret' => Auth::hash($secret), // One way hash encryption to protect DB leak
2020-06-30 09:43:34 +12:00
'expire' => $expiry,
2020-07-04 03:14:51 +12:00
'userAgent' => $request->getUserAgent('UNKNOWN'),
2020-06-30 09:43:34 +12:00
'ip' => $request->getIP(),
2021-02-15 06:28:54 +13:00
'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--',
2021-02-15 21:16:23 +13:00
], $detector->getOS(), $detector->getClient(), $detector->getDevice()));
2020-10-31 08:53:27 +13:00
2021-02-17 04:51:08 +13:00
$isAnonymousUser = is_null($user->getAttribute('email')) && is_null($user->getAttribute('password'));
if ($isAnonymousUser) {
$user
->setAttribute('name', $oauth2->getUserName($accessToken))
->setAttribute('email', $oauth2->getUserEmail($accessToken))
;
}
2020-06-30 09:43:34 +12:00
$user
->setAttribute('status', true)
2021-02-20 01:12:47 +13:00
->setAttribute('sessions', $session, Document::SET_TYPE_APPEND)
2020-06-30 09:43:34 +12:00
;
2021-08-05 17:06:38 +12:00
Authorization::setRole('user:' . $user->getId());
2020-06-30 09:43:34 +12:00
2021-07-18 09:21:33 +12:00
$session = $dbForInternal->createDocument('sessions', $session
2021-08-05 17:06:38 +12:00
->setAttribute('$read', ['user:' . $user->getId()])
->setAttribute('$write', ['user:' . $user->getId()])
2021-07-18 09:21:33 +12:00
);
2021-05-07 10:31:05 +12:00
$user = $dbForInternal->updateDocument('users', $user->getId(), $user);
2020-06-30 09:43:34 +12:00
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $user->getId())
->setParam('event', 'account.sessions.create')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $user->getId())
2020-06-30 09:43:34 +12:00
->setParam('data', ['provider' => $provider])
;
2020-04-09 01:38:36 +12:00
2021-07-26 02:47:18 +12:00
$events->setParam('eventData', $response->output($session, Response::MODEL_SESSION));
2020-06-30 09:43:34 +12:00
if (!Config::getParam('domainVerification')) {
2020-01-06 00:29:42 +13:00
$response
2020-06-30 09:43:34 +12:00
->addHeader('X-Fallback-Cookies', \json_encode([Auth::$cookieName => Auth::encodeSession($user->getId(), $secret)]))
2020-01-06 00:29:42 +13:00
;
}
2021-08-05 17:06:38 +12:00
2020-06-30 09:43:34 +12:00
// Add keys for non-web platforms - TODO - add verification phase to aviod session sniffing
2020-10-31 08:53:27 +13:00
if (parse_url($state['success'], PHP_URL_PATH) === parse_url($oauthDefaultSuccess, PHP_URL_PATH)) {
2020-06-30 09:43:34 +12:00
$state['success'] = URLParser::parse($state['success']);
$query = URLParser::parseQuery($state['success']['query']);
$query['project'] = $project->getId();
2020-07-01 18:35:57 +12:00
$query['domain'] = Config::getParam('cookieDomain');
2020-06-30 09:43:34 +12:00
$query['key'] = Auth::$cookieName;
$query['secret'] = Auth::encodeSession($user->getId(), $secret);
$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')
2021-08-05 17:06:38 +12:00
->addCookie(Auth::$cookieName . '_legacy', Auth::encodeSession($user->getId(), $secret), $expiry, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
2020-07-01 18:35:57 +12:00
->addCookie(Auth::$cookieName, Auth::encodeSession($user->getId(), $secret), $expiry, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'))
2020-06-30 09:43:34 +12:00
->redirect($state['success'])
;
2020-12-27 03:31:53 +13:00
});
2020-01-06 00:29:42 +13:00
2021-02-17 02:46:30 +13:00
App::post('/v1/account/sessions/anonymous')
2021-02-19 03:52:27 +13:00
->desc('Create Anonymous Session')
2021-04-03 21:56:32 +13:00
->groups(['api', 'account', 'auth'])
2021-02-17 02:46:30 +13:00
->label('event', 'account.sessions.create')
->label('scope', 'public')
2021-04-03 21:56:32 +13:00
->label('auth.type', 'anonymous')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [])
2021-02-17 02:46:30 +13:00
->label('sdk.namespace', 'account')
2021-02-19 03:52:27 +13:00
->label('sdk.method', 'createAnonymousSession')
->label('sdk.description', '/docs/references/account/create-session-anonymous.md')
2021-02-17 02:46:30 +13:00
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_SESSION)
->label('abuse-limit', 50)
->label('abuse-key', 'ip:{ip}')
->inject('request')
->inject('response')
->inject('locale')
->inject('user')
2021-02-24 11:43:05 +13:00
->inject('project')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2021-02-17 02:46:30 +13:00
->inject('geodb')
->inject('audits')
2021-05-07 10:31:05 +12:00
->action(function ($request, $response, $locale, $user, $project, $dbForInternal, $geodb, $audits) {
2021-02-17 02:46:30 +13:00
/** @var Utopia\Swoole\Request $request */
/** @var Appwrite\Utopia\Response $response */
/** @var Utopia\Locale\Locale $locale */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
2021-07-26 02:47:18 +12:00
/** @var Utopia\Database\Document $project */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Database $dbForInternal */
2021-02-17 02:46:30 +13:00
/** @var MaxMind\Db\Reader $geodb */
/** @var Appwrite\Event\Event $audits */
$protocol = $request->getProtocol();
if ('console' === $project->getId()) {
2021-02-17 02:46:30 +13:00
throw new Exception('Failed to create anonymous user.', 401);
}
2021-06-12 08:39:00 +12:00
if (!$user->isEmpty()) {
throw new Exception('Cannot create an anonymous user when logged in.', 401);
}
2021-04-03 21:56:32 +13:00
$limit = $project->getAttribute('usersAuthLimit', 0);
if ($limit !== 0) {
2021-05-10 06:37:47 +12:00
$sum = $dbForInternal->count('users', [], APP_LIMIT_COUNT);
2021-04-03 21:56:32 +13:00
2021-08-05 17:06:38 +12:00
if ($sum >= $limit) {
2021-04-03 21:56:32 +13:00
throw new Exception('Project registration is restricted. Contact your administrator for more information.', 501);
}
}
2021-02-17 02:46:30 +13:00
Authorization::disable();
2021-05-10 08:34:32 +12:00
$userId = $dbForInternal->getId();
$user = $dbForInternal->createDocument('users', new Document([
'$id' => $userId,
2021-08-05 17:06:38 +12:00
'$read' => ['role:all'],
'$write' => ['user:' . $userId],
2021-05-10 08:34:32 +12:00
'email' => null,
'emailVerification' => false,
'status' => true,
2021-05-10 08:34:32 +12:00
'password' => null,
'passwordUpdate' => \time(),
'registration' => \time(),
'reset' => false,
'name' => null,
'prefs' => [],
'sessions' => [],
'tokens' => [],
'memberships' => [],
]));
Authorization::reset();
2021-02-17 02:46:30 +13:00
2021-02-17 03:16:09 +13:00
// Create session token
2021-02-17 02:46:30 +13:00
$detector = new Detector($request->getUserAgent('UNKNOWN'));
$record = $geodb->get($request->getIP());
$secret = Auth::tokenGenerator();
$expiry = \time() + Auth::TOKEN_EXPIRATION_LOGIN_LONG;
$session = new Document(array_merge(
[
2021-05-07 10:31:05 +12:00
'$id' => $dbForInternal->getId(),
2021-06-13 08:44:25 +12:00
'userId' => $user->getId(),
2021-03-29 22:16:56 +13:00
'provider' => Auth::SESSION_PROVIDER_ANONYMOUS,
2021-02-17 02:46:30 +13:00
'secret' => Auth::hash($secret), // One way hash encryption to protect DB leak
'expire' => $expiry,
'userAgent' => $request->getUserAgent('UNKNOWN'),
'ip' => $request->getIP(),
'countryCode' => ($record) ? \strtolower($record['country']['iso_code']) : '--',
],
$detector->getOS(),
$detector->getClient(),
$detector->getDevice()
));
2021-08-05 17:06:38 +12:00
Authorization::setRole('user:' . $user->getId());
2021-02-17 02:46:30 +13:00
2021-07-17 22:04:43 +12:00
$session = $dbForInternal->createDocument('sessions', $session
2021-08-05 17:06:38 +12:00
->setAttribute('$read', ['user:' . $user->getId()])
->setAttribute('$write', ['user:' . $user->getId()])
2021-07-17 22:04:43 +12:00
);
2021-08-05 17:06:38 +12:00
2021-06-12 08:39:00 +12:00
$user = $dbForInternal->updateDocument('users', $user->getId(),
$user->setAttribute('sessions', $session, Document::SET_TYPE_APPEND));
2021-02-17 02:46:30 +13:00
$audits
->setParam('userId', $user->getId())
->setParam('event', 'account.sessions.create')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $user->getId())
2021-02-17 02:46:30 +13:00
;
if (!Config::getParam('domainVerification')) {
$response
->addHeader('X-Fallback-Cookies', \json_encode([Auth::$cookieName => Auth::encodeSession($user->getId(), $secret)]))
;
}
$response
2021-08-05 17:06:38 +12:00
->addCookie(Auth::$cookieName . '_legacy', Auth::encodeSession($user->getId(), $secret), $expiry, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
2021-02-17 02:46:30 +13:00
->addCookie(Auth::$cookieName, Auth::encodeSession($user->getId(), $secret), $expiry, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'))
->setStatusCode(Response::STATUS_CODE_CREATED)
;
2021-06-17 21:41:04 +12:00
$countryName = (isset($countries[strtoupper($session->getAttribute('countryCode'))]))
2021-06-17 21:33:57 +12:00
? $countries[strtoupper($session->getAttribute('countryCode'))]
: $locale->getText('locale.country.unknown');
2021-02-17 02:46:30 +13:00
$session
->setAttribute('current', true)
2021-06-17 21:33:57 +12:00
->setAttribute('countryName', $countryName)
2021-02-17 02:46:30 +13:00
;
2021-07-26 02:47:18 +12:00
$response->dynamic($session, Response::MODEL_SESSION);
2021-02-17 02:46:30 +13:00
});
2020-12-29 09:31:55 +13:00
App::post('/v1/account/jwt')
2020-10-18 06:49:09 +13:00
->desc('Create Account JWT')
2021-03-01 07:36:13 +13:00
->groups(['api', 'account', 'auth'])
2020-10-18 06:49:09 +13:00
->label('scope', 'account')
2021-03-01 07:36:13 +13:00
->label('auth.type', 'jwt')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION])
2020-10-18 06:49:09 +13:00
->label('sdk.namespace', 'account')
->label('sdk.method', 'createJWT')
->label('sdk.description', '/docs/references/account/create-jwt.md')
2021-05-20 20:52:19 +12:00
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_JWT)
2020-10-18 06:49:09 +13:00
->label('abuse-limit', 10)
2021-07-27 23:07:39 +12:00
->label('abuse-key', 'url:{url},userId:{userId}')
2020-12-29 06:03:27 +13:00
->inject('response')
->inject('user')
->action(function ($response, $user) {
2020-10-18 06:49:09 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
2021-08-05 17:06:38 +12:00
2021-02-20 01:12:47 +13:00
$sessions = $user->getAttribute('sessions', []);
$current = new Document();
2020-12-29 06:03:27 +13:00
2021-08-05 17:06:38 +12:00
foreach ($sessions as $session) {
2021-07-26 02:47:18 +12:00
/** @var Utopia\Database\Document $session */
2020-12-29 06:03:27 +13:00
2021-02-20 01:12:47 +13:00
if ($session->getAttribute('secret') == Auth::hash(Auth::$secret)) { // If current session delete the cookies too
$current = $session;
2020-12-29 06:03:27 +13:00
}
}
2020-10-18 06:49:09 +13:00
2021-08-05 17:06:38 +12:00
if ($current->isEmpty()) {
2020-12-29 06:03:27 +13:00
throw new Exception('No valid session found', 401);
}
2021-08-05 17:06:38 +12:00
2020-12-29 10:23:09 +13:00
$jwt = new JWT(App::getEnv('_APP_OPENSSL_KEY_V1'), 'HS256', 900, 10); // Instantiate with key, algo, maxAge and leeway.
2020-12-29 06:03:27 +13:00
2021-05-07 10:31:05 +12:00
$response->setStatusCode(Response::STATUS_CODE_CREATED);
2021-07-26 02:47:18 +12:00
$response->dynamic(new Document(['jwt' => $jwt->encode([
2021-05-07 10:31:05 +12:00
// 'uid' => 1,
// 'aud' => 'http://site.com',
// 'scopes' => ['user'],
// 'iss' => 'http://api.mysite.com',
'userId' => $user->getId(),
'sessionId' => $current->getId(),
])]), Response::MODEL_JWT);
2020-12-29 06:03:27 +13:00
});
2020-01-06 00:29:42 +13:00
2020-06-29 05:31:21 +12:00
App::get('/v1/account')
2020-02-01 11:34:07 +13:00
->desc('Get Account')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-02-01 11:34:07 +13:00
->label('scope', 'account')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2020-02-01 11:34:07 +13:00
->label('sdk.namespace', 'account')
->label('sdk.method', 'get')
->label('sdk.description', '/docs/references/account/get.md')
2020-11-12 10:02:24 +13:00
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_USER)
2020-12-27 07:11:18 +13:00
->inject('response')
->inject('user')
2020-10-31 08:53:27 +13:00
->action(function ($response, $user) {
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
2020-06-30 09:43:34 +12:00
2021-07-26 02:47:18 +12:00
$response->dynamic($user, Response::MODEL_USER);
2020-12-27 03:31:53 +13:00
});
2020-02-01 11:34:07 +13:00
2020-06-29 05:31:21 +12:00
App::get('/v1/account/prefs')
2020-02-01 11:34:07 +13:00
->desc('Get Account Preferences')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-02-01 11:34:07 +13:00
->label('scope', 'account')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2020-02-01 11:34:07 +13:00
->label('sdk.namespace', 'account')
->label('sdk.method', 'getPrefs')
->label('sdk.description', '/docs/references/account/get-prefs.md')
2020-11-13 00:54:16 +13:00
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
2021-04-22 01:37:51 +12:00
->label('sdk.response.model', Response::MODEL_PREFERENCES)
2020-12-27 03:31:53 +13:00
->inject('response')
->inject('user')
2020-06-30 09:43:34 +12:00
->action(function ($response, $user) {
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
2020-02-01 11:34:07 +13:00
2021-01-11 00:55:59 +13:00
$prefs = $user->getAttribute('prefs', new \stdClass());
2020-06-30 09:43:34 +12:00
2021-07-26 02:47:18 +12:00
$response->dynamic(new Document($prefs), Response::MODEL_PREFERENCES);
2020-12-27 03:31:53 +13:00
});
2020-02-01 11:34:07 +13:00
2020-06-29 05:31:21 +12:00
App::get('/v1/account/sessions')
2020-02-01 11:34:07 +13:00
->desc('Get Account Sessions')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-02-01 11:34:07 +13:00
->label('scope', 'account')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2020-02-01 11:34:07 +13:00
->label('sdk.namespace', 'account')
->label('sdk.method', 'getSessions')
->label('sdk.description', '/docs/references/account/get-sessions.md')
2020-11-12 10:02:24 +13:00
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_SESSION_LIST)
2020-12-27 03:31:53 +13:00
->inject('response')
->inject('user')
->inject('locale')
2020-10-31 08:53:27 +13:00
->action(function ($response, $user, $locale) {
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
2020-06-30 09:43:34 +12:00
/** @var Utopia\Locale\Locale $locale */
2021-02-20 01:12:47 +13:00
$sessions = $user->getAttribute('sessions', []);
$current = Auth::sessionVerify($sessions, Auth::$secret);
2020-06-30 09:43:34 +12:00
2021-08-05 17:06:38 +12:00
foreach ($sessions as $key => $session) {/** @var Document $session */
2021-07-23 08:15:01 +12:00
$countryName = $locale->getText('countries.'.strtolower($session->getAttribute('countryCode')), $locale->getText('locale.country.unknown'));
2021-06-17 21:08:01 +12:00
$session->setAttribute('countryName', $countryName);
2021-02-20 01:12:47 +13:00
$session->setAttribute('current', ($current == $session->getId()) ? true : false);
2020-02-01 11:34:07 +13:00
2021-02-20 01:12:47 +13:00
$sessions[$key] = $session;
2020-02-01 11:34:07 +13:00
}
2020-06-30 09:43:34 +12:00
2021-07-26 02:47:18 +12:00
$response->dynamic(new Document([
2021-05-27 22:09:14 +12:00
'sessions' => $sessions,
2020-10-31 08:53:27 +13:00
'sum' => count($sessions),
]), Response::MODEL_SESSION_LIST);
2020-12-27 03:31:53 +13:00
});
2020-02-01 11:34:07 +13:00
2020-06-29 05:31:21 +12:00
App::get('/v1/account/logs')
2020-02-01 11:34:07 +13:00
->desc('Get Account Logs')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-02-01 11:34:07 +13:00
->label('scope', 'account')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2020-02-01 11:34:07 +13:00
->label('sdk.namespace', 'account')
->label('sdk.method', 'getLogs')
->label('sdk.description', '/docs/references/account/get-logs.md')
2020-11-12 10:02:24 +13:00
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_LOG_LIST)
2020-12-27 03:31:53 +13:00
->inject('response')
->inject('user')
->inject('locale')
->inject('geodb')
2021-06-07 17:17:29 +12:00
->inject('dbForInternal')
->action(function ($response, $user, $locale, $geodb, $dbForInternal) {
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-07-26 02:47:18 +12:00
/** @var Utopia\Database\Document $project */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
2020-06-30 09:43:34 +12:00
/** @var Utopia\Locale\Locale $locale */
2020-10-25 19:15:36 +13:00
/** @var MaxMind\Db\Reader $geodb */
2021-06-07 17:17:29 +12:00
/** @var Utopia\Database\Database $dbForInternal */
2020-06-30 09:43:34 +12:00
2021-06-07 17:17:29 +12:00
$audit = new Audit($dbForInternal);
2020-06-30 09:43:34 +12:00
2021-06-18 06:21:22 +12:00
$logs = $audit->getLogsByUserAndEvents($user->getId(), [
2020-06-30 09:43:34 +12:00
'account.create',
'account.delete',
'account.update.name',
'account.update.email',
'account.update.password',
'account.update.prefs',
'account.sessions.create',
'account.sessions.delete',
'account.recovery.create',
'account.recovery.update',
'account.verification.create',
'account.verification.update',
'teams.membership.create',
'teams.membership.update',
'teams.membership.delete',
]);
$output = [];
foreach ($logs as $i => &$log) {
$log['userAgent'] = (!empty($log['userAgent'])) ? $log['userAgent'] : 'UNKNOWN';
2021-02-15 06:28:54 +13:00
$detector = new Detector($log['userAgent']);
2020-06-30 09:43:34 +12:00
2021-02-15 06:28:54 +13:00
$output[$i] = new Document(array_merge([
2020-06-30 09:43:34 +12:00
'event' => $log['event'],
'ip' => $log['ip'],
2021-06-13 06:39:59 +12:00
'time' => $log['time'],
2021-02-15 06:28:54 +13:00
], $detector->getOS(), $detector->getClient(), $detector->getDevice()));
2020-10-31 08:53:27 +13:00
$record = $geodb->get($log['ip']);
if ($record) {
2021-07-26 19:05:08 +12:00
$output[$i]['countryCode'] = $locale->getText('countries.'.strtolower($record['country']['iso_code']), false) ? \strtolower($record['country']['iso_code']) : '--';
2021-07-23 08:15:01 +12:00
$output[$i]['countryName'] = $locale->getText('countries.'.strtolower($record['country']['iso_code']), $locale->getText('locale.country.unknown'));
2020-10-31 08:53:27 +13:00
} else {
$output[$i]['countryCode'] = '--';
$output[$i]['countryName'] = $locale->getText('locale.country.unknown');
2020-02-01 11:34:07 +13:00
}
2020-10-31 08:53:27 +13:00
2020-02-01 11:34:07 +13:00
}
2020-06-30 09:43:34 +12:00
2021-07-26 02:47:18 +12:00
$response->dynamic(new Document(['logs' => $output]), Response::MODEL_LOG_LIST);
2020-12-27 03:31:53 +13:00
});
2020-02-01 11:34:07 +13:00
2021-06-16 22:14:08 +12:00
App::get('/v1/account/sessions/:sessionId')
->desc('Get Session By ID')
->groups(['api', 'account'])
->label('scope', 'account')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
->label('sdk.namespace', 'account')
2021-06-16 22:48:12 +12:00
->label('sdk.method', 'getSession')
->label('sdk.description', '/docs/references/account/get-session.md')
2021-06-16 22:14:08 +12:00
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
2021-06-16 22:48:12 +12:00
->label('sdk.response.model', Response::MODEL_SESSION)
2021-06-16 22:14:08 +12:00
->param('sessionId', null, new UID(), 'Session unique ID. Use the string \'current\' to get the current device session.')
->inject('response')
->inject('user')
->inject('locale')
->inject('dbForInternal')
->action(function ($sessionId, $response, $user, $locale, $dbForInternal) {
2021-06-16 22:14:08 +12:00
/** @var Appwrite\Utopia\Response $response */
2021-07-26 02:47:18 +12:00
/** @var Utopia\Database\Document $user */
2021-06-16 22:14:08 +12:00
/** @var Utopia\Locale\Locale $locale */
/** @var Utopia\Database\Database $dbForInternal */
2021-06-16 22:14:08 +12:00
2021-08-05 17:06:38 +12:00
$sessions = $user->getAttribute('sessions', []);
$sessionId = ($sessionId === 'current')
? Auth::sessionVerify($user->getAttribute('sessions'), Auth::$secret)
: $sessionId;
2021-06-16 22:14:08 +12:00
2021-08-05 17:06:38 +12:00
foreach ($sessions as $session) {/** @var Document $session */
if ($sessionId == $session->getId()) {
2021-06-16 22:14:08 +12:00
$countryName = (isset($countries[strtoupper($session->getAttribute('countryCode'))]))
2021-08-05 17:06:38 +12:00
? $countries[strtoupper($session->getAttribute('countryCode'))]
: $locale->getText('locale.country.unknown');
2021-06-17 21:33:57 +12:00
$session
->setAttribute('current', ($session->getAttribute('secret') == Auth::hash(Auth::$secret)))
->setAttribute('countryName', $countryName)
;
2021-08-05 17:06:38 +12:00
2021-07-26 02:47:18 +12:00
return $response->dynamic($session, Response::MODEL_SESSION);
}
}
2021-06-16 22:48:12 +12:00
throw new Exception('Session not found', 404);
2021-06-16 22:14:08 +12:00
});
2020-06-29 05:31:21 +12:00
App::patch('/v1/account/name')
2019-05-09 18:54:39 +12:00
->desc('Update Account Name')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-10-31 08:53:27 +13:00
->label('event', 'account.update.name')
2019-05-09 18:54:39 +12:00
->label('scope', 'account')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2019-05-09 18:54:39 +12:00
->label('sdk.namespace', 'account')
2020-01-31 05:18:46 +13:00
->label('sdk.method', 'updateName')
2020-01-06 12:22:02 +13:00
->label('sdk.description', '/docs/references/account/update-name.md')
2020-11-12 10:02:24 +13:00
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_USER)
2020-09-11 02:40:14 +12:00
->param('name', '', new Text(128), 'User name. Max length: 128 chars.')
2020-12-27 03:31:53 +13:00
->inject('response')
->inject('user')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('audits')
2021-05-07 10:31:05 +12:00
->action(function ($name, $response, $user, $dbForInternal, $audits) {
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
/** @var Utopia\Database\Database $dbForInternal */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2020-06-30 09:43:34 +12:00
2021-05-07 10:31:05 +12:00
$user = $dbForInternal->updateDocument('users', $user->getId(), $user->setAttribute('name', $name));
2020-06-30 09:43:34 +12:00
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $user->getId())
->setParam('event', 'account.update.name')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $user->getId())
2020-06-30 09:43:34 +12:00
;
2021-07-26 02:47:18 +12:00
$response->dynamic($user, Response::MODEL_USER);
2020-12-27 03:31:53 +13:00
});
2019-05-09 18:54:39 +12:00
2020-06-29 05:31:21 +12:00
App::patch('/v1/account/password')
2019-05-09 18:54:39 +12:00
->desc('Update Account Password')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-10-31 08:53:27 +13:00
->label('event', 'account.update.password')
2019-05-09 18:54:39 +12:00
->label('scope', 'account')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2019-05-09 18:54:39 +12:00
->label('sdk.namespace', 'account')
2020-01-31 05:18:46 +13:00
->label('sdk.method', 'updatePassword')
2020-01-06 12:22:02 +13:00
->label('sdk.description', '/docs/references/account/update-password.md')
2020-11-12 10:02:24 +13:00
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_USER)
2020-09-11 02:40:14 +12:00
->param('password', '', new Password(), 'New user password. Must be between 6 to 32 chars.')
->param('oldPassword', '', new Password(), 'Old user password. Must be between 6 to 32 chars.', true)
2020-12-27 03:31:53 +13:00
->inject('response')
->inject('user')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('audits')
2021-05-07 10:31:05 +12:00
->action(function ($password, $oldPassword, $response, $user, $dbForInternal, $audits) {
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
/** @var Utopia\Database\Database $dbForInternal */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2020-06-30 09:43:34 +12:00
// Check old password only if its an existing user.
if ($user->getAttribute('passwordUpdate') !== 0 && !Auth::passwordVerify($oldPassword, $user->getAttribute('password'))) { // Double check user password
2020-06-30 09:43:34 +12:00
throw new Exception('Invalid credentials', 401);
}
2019-05-09 18:54:39 +12:00
$user = $dbForInternal->updateDocument('users', $user->getId(), $user
2021-08-05 17:06:38 +12:00
->setAttribute('password', Auth::passwordHash($password))
->setAttribute('passwordUpdate', \time())
);
2020-06-30 09:43:34 +12:00
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $user->getId())
->setParam('event', 'account.update.password')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $user->getId())
2020-06-30 09:43:34 +12:00
;
2021-07-26 02:47:18 +12:00
$response->dynamic($user, Response::MODEL_USER);
2020-12-27 03:31:53 +13:00
});
2019-05-09 18:54:39 +12:00
2020-06-29 05:31:21 +12:00
App::patch('/v1/account/email')
2019-05-09 18:54:39 +12:00
->desc('Update Account Email')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-10-31 08:53:27 +13:00
->label('event', 'account.update.email')
2019-05-09 18:54:39 +12:00
->label('scope', 'account')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2019-05-09 18:54:39 +12:00
->label('sdk.namespace', 'account')
->label('sdk.method', 'updateEmail')
2019-10-08 20:21:54 +13:00
->label('sdk.description', '/docs/references/account/update-email.md')
2020-11-12 10:02:24 +13:00
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_USER)
2020-09-11 02:40:14 +12:00
->param('email', '', new Email(), 'User email.')
->param('password', '', new Password(), 'User password. Must be between 6 to 32 chars.')
2020-12-27 03:31:53 +13:00
->inject('response')
->inject('user')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('audits')
2021-05-07 10:31:05 +12:00
->action(function ($email, $password, $response, $user, $dbForInternal, $audits) {
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
/** @var Utopia\Database\Database $dbForInternal */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2020-06-30 09:43:34 +12:00
2021-02-17 02:46:30 +13:00
$isAnonymousUser = is_null($user->getAttribute('email')) && is_null($user->getAttribute('password')); // Check if request is from an anonymous account for converting
if (
!$isAnonymousUser &&
!Auth::passwordVerify($password, $user->getAttribute('password'))
) { // Double check user password
2020-06-30 09:43:34 +12:00
throw new Exception('Invalid credentials', 401);
}
2019-07-21 23:43:06 +12:00
$email = \strtolower($email);
2021-08-04 08:22:03 +12:00
$profile = $dbForInternal->findOne('users', [new Query('email', Query::TYPE_EQUAL, [\strtolower($email)])]); // Get user by email address
2019-05-09 18:54:39 +12:00
2021-05-07 10:31:05 +12:00
if ($profile) {
2020-06-30 09:43:34 +12:00
throw new Exception('User already registered', 400);
}
2019-05-09 18:54:39 +12:00
2021-05-07 10:31:05 +12:00
$user = $dbForInternal->updateDocument('users', $user->getId(), $user
2021-08-05 17:06:38 +12:00
->setAttribute('password', $isAnonymousUser ? Auth::passwordHash($password) : $user->getAttribute('password', ''))
->setAttribute('email', $email)
->setAttribute('emailVerification', false) // After this user needs to confirm mail again
2021-05-07 10:31:05 +12:00
);
2019-05-09 18:54:39 +12:00
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $user->getId())
->setParam('event', 'account.update.email')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $user->getId())
2020-06-30 09:43:34 +12:00
;
2021-07-26 02:47:18 +12:00
$response->dynamic($user, Response::MODEL_USER);
2020-12-27 03:31:53 +13:00
});
2019-05-09 18:54:39 +12:00
2020-06-29 05:31:21 +12:00
App::patch('/v1/account/prefs')
2020-01-06 00:29:42 +13:00
->desc('Update Account Preferences')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-10-31 08:53:27 +13:00
->label('event', 'account.update.prefs')
2019-05-09 18:54:39 +12:00
->label('scope', 'account')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2019-05-09 18:54:39 +12:00
->label('sdk.namespace', 'account')
->label('sdk.method', 'updatePrefs')
2019-10-08 20:21:54 +13:00
->label('sdk.description', '/docs/references/account/update-prefs.md')
2020-11-13 00:54:16 +13:00
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
2021-04-22 01:37:51 +12:00
->label('sdk.response.model', Response::MODEL_USER)
2020-10-31 08:53:27 +13:00
->param('prefs', [], new Assoc(), 'Prefs key-value JSON object.')
2020-12-27 03:31:53 +13:00
->inject('response')
->inject('user')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('audits')
2021-05-07 10:31:05 +12:00
->action(function ($prefs, $response, $user, $dbForInternal, $audits) {
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
/** @var Utopia\Database\Database $dbForInternal */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2019-05-09 18:54:39 +12:00
2021-05-07 10:31:05 +12:00
$user = $dbForInternal->updateDocument('users', $user->getId(), $user->setAttribute('prefs', $prefs));
2019-05-09 18:54:39 +12:00
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('event', 'account.update.prefs')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $user->getId())
2020-06-30 09:43:34 +12:00
;
2020-01-12 02:58:02 +13:00
2021-07-26 02:47:18 +12:00
$response->dynamic($user, Response::MODEL_USER);
2020-12-27 03:31:53 +13:00
});
2019-05-09 18:54:39 +12:00
2020-06-29 05:31:21 +12:00
App::delete('/v1/account')
2019-05-09 18:54:39 +12:00
->desc('Delete Account')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-10-31 08:53:27 +13:00
->label('event', 'account.delete')
2019-05-09 18:54:39 +12:00
->label('scope', 'account')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2019-05-09 18:54:39 +12:00
->label('sdk.namespace', 'account')
->label('sdk.method', 'delete')
2019-10-08 20:21:54 +13:00
->label('sdk.description', '/docs/references/account/delete.md')
2020-11-12 10:02:24 +13:00
->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
->label('sdk.response.model', Response::MODEL_NONE)
2020-12-27 03:31:53 +13:00
->inject('request')
->inject('response')
->inject('user')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('audits')
->inject('events')
2021-05-07 10:31:05 +12:00
->action(function ($request, $response, $user, $dbForInternal, $audits, $events) {
/** @var Utopia\Swoole\Request $request */
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
/** @var Utopia\Database\Database $dbForInternal */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2020-12-07 11:14:57 +13:00
/** @var Appwrite\Event\Event $events */
2020-06-30 09:43:34 +12:00
2020-06-30 23:09:28 +12:00
$protocol = $request->getProtocol();
$user = $dbForInternal->updateDocument('users', $user->getId(), $user->setAttribute('status', false));
2021-05-07 10:31:05 +12:00
2021-07-28 02:16:12 +12:00
// TODO delete all tokens or only current session?
// TODO delete all user data according to GDPR. Make sure everything is backed up and backups are deleted later
2020-06-30 09:43:34 +12:00
/*
2021-08-05 17:06:38 +12:00
* Data to delete
* * Tokens
* * Memberships
*/
2020-06-30 09:43:34 +12:00
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $user->getId())
->setParam('event', 'account.delete')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $user->getId())
2020-06-30 09:43:34 +12:00
->setParam('data', $user->getArrayCopy())
;
2020-12-07 11:14:57 +13:00
$events
2021-07-26 02:47:18 +12:00
->setParam('eventData', $response->output($user, Response::MODEL_USER))
2020-06-30 09:43:34 +12:00
;
if (!Config::getParam('domainVerification')) {
2019-05-09 18:54:39 +12:00
$response
2020-06-30 09:43:34 +12:00
->addHeader('X-Fallback-Cookies', \json_encode([]))
2020-01-12 02:58:02 +13:00
;
2019-05-09 18:54:39 +12:00
}
2020-06-30 09:43:34 +12:00
$response
2021-08-05 17:06:38 +12:00
->addCookie(Auth::$cookieName . '_legacy', '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
2020-07-01 18:35:57 +12:00
->addCookie(Auth::$cookieName, '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'))
2020-06-30 09:43:34 +12:00
->noContent()
;
2020-12-27 03:31:53 +13:00
});
2020-01-06 00:29:42 +13:00
2020-06-29 05:31:21 +12:00
App::delete('/v1/account/sessions/:sessionId')
2020-01-06 00:29:42 +13:00
->desc('Delete Account Session')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-01-06 00:29:42 +13:00
->label('scope', 'account')
2020-10-31 08:53:27 +13:00
->label('event', 'account.sessions.delete')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2020-01-06 00:29:42 +13:00
->label('sdk.namespace', 'account')
2020-01-31 05:18:46 +13:00
->label('sdk.method', 'deleteSession')
2020-01-06 12:07:41 +13:00
->label('sdk.description', '/docs/references/account/delete-session.md')
2020-11-12 10:02:24 +13:00
->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
->label('sdk.response.model', Response::MODEL_NONE)
2020-01-06 00:29:42 +13:00
->label('abuse-limit', 100)
2020-09-11 02:40:14 +12:00
->param('sessionId', null, new UID(), 'Session unique ID. Use the string \'current\' to delete the current device session.')
2020-12-27 03:31:53 +13:00
->inject('request')
->inject('response')
->inject('user')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2021-06-13 08:44:25 +12:00
->inject('locale')
2020-12-27 03:31:53 +13:00
->inject('audits')
->inject('events')
2021-06-13 08:44:25 +12:00
->action(function ($sessionId, $request, $response, $user, $dbForInternal, $locale, $audits, $events) {
/** @var Utopia\Swoole\Request $request */
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
/** @var Utopia\Database\Database $dbForInternal */
2021-06-13 08:44:25 +12:00
/** @var Utopia\Locale\Locale $locale */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2020-12-07 11:14:57 +13:00
/** @var Appwrite\Event\Event $events */
2020-06-30 09:43:34 +12:00
2020-06-30 23:09:28 +12:00
$protocol = $request->getProtocol();
2020-06-30 09:43:34 +12:00
$sessionId = ($sessionId === 'current')
2021-08-05 17:06:38 +12:00
? Auth::sessionVerify($user->getAttribute('sessions'), Auth::$secret)
: $sessionId;
2021-02-20 01:12:47 +13:00
$sessions = $user->getAttribute('sessions', []);
2020-01-24 11:33:44 +13:00
2021-08-05 17:06:38 +12:00
foreach ($sessions as $key => $session) {/** @var Document $session */
2021-05-07 10:31:05 +12:00
if ($sessionId == $session->getId()) {
unset($sessions[$key]);
2020-01-24 11:33:44 +13:00
2021-07-17 22:04:43 +12:00
$dbForInternal->deleteDocument('sessions', $session->getId());
2020-07-06 02:19:59 +12:00
$audits
2020-02-17 20:16:11 +13:00
->setParam('userId', $user->getId())
2020-01-24 11:33:44 +13:00
->setParam('event', 'account.sessions.delete')
2021-08-05 17:06:38 +12:00
->setParam('resource', '/user/' . $user->getId())
2020-01-24 11:33:44 +13:00
;
2021-02-20 01:12:47 +13:00
$session->setAttribute('current', false);
2021-08-05 17:06:38 +12:00
2021-02-20 01:12:47 +13:00
if ($session->getAttribute('secret') == Auth::hash(Auth::$secret)) { // If current session delete the cookies too
2021-06-13 08:44:25 +12:00
$session
->setAttribute('current', true)
->setAttribute('countryName', (isset($countries[strtoupper($session->getAttribute('countryCode'))])) ? $countries[strtoupper($session->getAttribute('countryCode'))] : $locale->getText('locale.country.unknown'))
;
2021-08-05 17:06:38 +12:00
if (!Config::getParam('domainVerification')) {
$response
->addHeader('X-Fallback-Cookies', \json_encode([]))
;
}
2020-11-21 10:02:26 +13:00
2020-01-24 11:33:44 +13:00
$response
2021-08-05 17:06:38 +12:00
->addCookie(Auth::$cookieName . '_legacy', '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
2020-07-01 18:35:57 +12:00
->addCookie(Auth::$cookieName, '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'))
2020-01-24 11:33:44 +13:00
;
}
2020-06-30 09:43:34 +12:00
2021-05-07 10:31:05 +12:00
$dbForInternal->updateDocument('users', $user->getId(), $user->setAttribute('sessions', $sessions));
2020-12-07 11:14:57 +13:00
$events
2021-07-26 02:47:18 +12:00
->setParam('eventData', $response->output($session, Response::MODEL_SESSION))
2020-11-21 10:02:26 +13:00
;
2020-06-30 09:43:34 +12:00
return $response->noContent();
}
}
throw new Exception('Session not found', 404);
2020-12-27 03:31:53 +13:00
});
2020-06-30 09:43:34 +12:00
App::delete('/v1/account/sessions')
->desc('Delete All Account Sessions')
->groups(['api', 'account'])
->label('scope', 'account')
2020-10-31 08:53:27 +13:00
->label('event', 'account.sessions.delete')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2020-06-30 09:43:34 +12:00
->label('sdk.namespace', 'account')
->label('sdk.method', 'deleteSessions')
->label('sdk.description', '/docs/references/account/delete-sessions.md')
2020-11-12 10:02:24 +13:00
->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
->label('sdk.response.model', Response::MODEL_NONE)
2020-06-30 09:43:34 +12:00
->label('abuse-limit', 100)
2020-12-27 03:31:53 +13:00
->inject('request')
->inject('response')
->inject('user')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2021-06-13 08:44:25 +12:00
->inject('locale')
2020-12-27 03:31:53 +13:00
->inject('audits')
->inject('events')
2021-06-13 08:44:25 +12:00
->action(function ($request, $response, $user, $dbForInternal, $locale, $audits, $events) {
/** @var Utopia\Swoole\Request $request */
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
/** @var Utopia\Database\Database $dbForInternal */
2021-06-13 08:44:25 +12:00
/** @var Utopia\Locale\Locale $locale */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2020-12-07 11:14:57 +13:00
/** @var Appwrite\Event\Event $events */
2020-06-30 09:43:34 +12:00
2020-06-30 23:09:28 +12:00
$protocol = $request->getProtocol();
2021-02-20 02:59:36 +13:00
$sessions = $user->getAttribute('sessions', []);
2020-06-30 09:43:34 +12:00
2021-08-05 17:06:38 +12:00
foreach ($sessions as $session) {/** @var Document $session */
2021-07-17 22:04:43 +12:00
$dbForInternal->deleteDocument('sessions', $session->getId());
2020-06-30 09:43:34 +12:00
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $user->getId())
->setParam('event', 'account.sessions.delete')
2021-08-05 17:06:38 +12:00
->setParam('resource', '/user/' . $user->getId())
2020-06-30 09:43:34 +12:00
;
if (!Config::getParam('domainVerification')) {
$response
->addHeader('X-Fallback-Cookies', \json_encode([]))
;
}
2021-06-13 08:44:25 +12:00
$session
->setAttribute('current', false)
->setAttribute('countryName', (isset($countries[strtoupper($session->getAttribute('countryCode'))])) ? $countries[strtoupper($session->getAttribute('countryCode'))] : $locale->getText('locale.country.unknown'))
;
2020-11-21 10:02:26 +13:00
2021-02-20 02:59:36 +13:00
if ($session->getAttribute('secret') == Auth::hash(Auth::$secret)) { // If current session delete the cookies too
$session->setAttribute('current', true);
2020-06-30 09:43:34 +12:00
$response
2021-08-05 17:06:38 +12:00
->addCookie(Auth::$cookieName . '_legacy', '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, null)
2020-07-01 18:35:57 +12:00
->addCookie(Auth::$cookieName, '', \time() - 3600, '/', Config::getParam('cookieDomain'), ('https' == $protocol), true, Config::getParam('cookieSamesite'))
2020-06-30 09:43:34 +12:00
;
}
2020-01-24 11:33:44 +13:00
}
2021-05-07 10:31:05 +12:00
$dbForInternal->updateDocument('users', $user->getId(), $user->setAttribute('sessions', []));
2021-08-05 17:06:38 +12:00
2020-12-07 11:14:57 +13:00
$events
2021-07-26 02:47:18 +12:00
->setParam('eventData', $response->output(new Document([
2021-05-27 22:09:14 +12:00
'sessions' => $sessions,
2021-02-20 02:59:36 +13:00
'sum' => count($sessions),
2020-11-21 10:02:26 +13:00
]), Response::MODEL_SESSION_LIST))
;
2020-06-30 09:43:34 +12:00
$response->noContent();
2020-12-27 03:31:53 +13:00
});
2020-01-24 11:33:44 +13:00
2020-06-29 05:31:21 +12:00
App::post('/v1/account/recovery')
2020-02-09 07:51:49 +13:00
->desc('Create Password Recovery')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-01-06 12:07:41 +13:00
->label('scope', 'public')
2020-11-19 08:38:31 +13:00
->label('event', 'account.recovery.create')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2020-01-06 12:07:41 +13:00
->label('sdk.namespace', 'account')
2020-01-31 05:18:46 +13:00
->label('sdk.method', 'createRecovery')
2020-01-06 12:07:41 +13:00
->label('sdk.description', '/docs/references/account/create-recovery.md')
2020-11-13 11:50:53 +13:00
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_TOKEN)
2020-01-06 12:07:41 +13:00
->label('abuse-limit', 10)
->label('abuse-key', 'url:{url},email:{param-email}')
2020-09-11 02:40:14 +12:00
->param('email', '', new Email(), 'User email.')
2021-08-05 17:06:38 +12:00
->param('url', '', function ($clients) {return new Host($clients);}, '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, ['clients'])
2020-12-27 03:31:53 +13:00
->inject('request')
->inject('response')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('project')
->inject('locale')
->inject('mails')
->inject('audits')
->inject('events')
2021-05-07 10:31:05 +12:00
->action(function ($email, $url, $request, $response, $dbForInternal, $project, $locale, $mails, $audits, $events) {
/** @var Utopia\Swoole\Request $request */
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Database $dbForInternal */
2021-07-26 02:47:18 +12:00
/** @var Utopia\Database\Document $project */
2020-06-30 09:43:34 +12:00
/** @var Utopia\Locale\Locale $locale */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $mails */
/** @var Appwrite\Event\Event $audits */
2020-12-07 11:14:57 +13:00
/** @var Appwrite\Event\Event $events */
2020-11-21 01:35:16 +13:00
2021-03-02 10:04:53 +13:00
$isPrivilegedUser = Auth::isPrivilegedUser(Authorization::$roles);
2020-11-21 01:35:16 +13:00
$isAppUser = Auth::isAppUser(Authorization::$roles);
2020-06-30 09:43:34 +12:00
$email = \strtolower($email);
2021-08-04 08:22:03 +12:00
$profile = $dbForInternal->findOne('users', [new Query('email', Query::TYPE_EQUAL, [$email])]); // Get user by email address
2020-06-30 09:43:34 +12:00
2021-05-07 10:31:05 +12:00
if (!$profile) {
2021-07-16 16:39:31 +12:00
throw new Exception('User not found', 404);
2020-06-30 09:43:34 +12:00
}
2020-01-12 02:58:02 +13:00
if (false === $profile->getAttribute('status')) { // Account is blocked
throw new Exception('Invalid credentials. User is blocked', 401);
}
2021-07-07 00:18:55 +12:00
$expire = \time() + Auth::TOKEN_EXPIRATION_RECOVERY;
2020-06-30 09:43:34 +12:00
$secret = Auth::tokenGenerator();
$recovery = new Document([
2021-05-07 10:31:05 +12:00
'$id' => $dbForInternal->getId(),
2021-06-13 08:44:25 +12:00
'userId' => $profile->getId(),
2020-06-30 09:43:34 +12:00
'type' => Auth::TOKEN_TYPE_RECOVERY,
2020-11-13 00:54:16 +13:00
'secret' => Auth::hash($secret), // One way hash encryption to protect DB leak
2021-07-07 00:18:55 +12:00
'expire' => $expire,
2020-07-04 03:14:51 +12:00
'userAgent' => $request->getUserAgent('UNKNOWN'),
2020-06-30 09:43:34 +12:00
'ip' => $request->getIP(),
]);
2021-08-05 17:06:38 +12:00
Authorization::setRole('user:' . $profile->getId());
2020-01-12 02:58:02 +13:00
2020-06-30 09:43:34 +12:00
$profile->setAttribute('tokens', $recovery, Document::SET_TYPE_APPEND);
2020-01-06 12:07:41 +13:00
2021-05-07 10:31:05 +12:00
$profile = $dbForInternal->updateDocument('users', $profile->getId(), $profile);
2020-06-30 09:43:34 +12:00
$url = Template::parseURL($url);
2021-07-07 00:18:55 +12:00
$url['query'] = Template::mergeQuery(((isset($url['query'])) ? $url['query'] : ''), ['userId' => $profile->getId(), 'secret' => $secret, 'expire' => $expire]);
2020-06-30 09:43:34 +12:00
$url = Template::unParseURL($url);
2020-07-06 02:19:59 +12:00
$mails
2020-06-30 09:43:34 +12:00
->setParam('event', 'account.recovery.create')
->setParam('from', $project->getId())
2020-06-30 09:43:34 +12:00
->setParam('recipient', $profile->getAttribute('email', ''))
->setParam('name', $profile->getAttribute('name', ''))
->setParam('url', $url)
->setParam('locale', $locale->default)
->setParam('project', $project->getAttribute('name', ['[APP-NAME]']))
->setParam('type', MAIL_TYPE_RECOVERY)
2020-06-30 09:43:34 +12:00
->trigger();
;
2020-12-07 11:14:57 +13:00
$events
2021-03-30 07:00:10 +13:00
->setParam('eventData',
2021-07-26 02:47:18 +12:00
$response->output($recovery->setAttribute('secret', $secret),
2021-08-05 17:06:38 +12:00
Response::MODEL_TOKEN
))
2020-11-19 08:38:31 +13:00
;
2021-08-05 17:06:38 +12:00
$recovery // Hide secret for clients, sp
2020-11-19 08:38:31 +13:00
->setAttribute('secret',
2021-03-02 10:04:53 +13:00
($isPrivilegedUser || $isAppUser) ? $secret : '');
2020-11-19 08:38:31 +13:00
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $profile->getId())
->setParam('event', 'account.recovery.create')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $profile->getId())
2020-06-30 09:43:34 +12:00
;
2021-05-07 10:31:05 +12:00
$response->setStatusCode(Response::STATUS_CODE_CREATED);
2021-07-26 02:47:18 +12:00
$response->dynamic($recovery, Response::MODEL_TOKEN);
2020-12-27 03:31:53 +13:00
});
2020-01-06 12:07:41 +13:00
2020-06-29 05:31:21 +12:00
App::put('/v1/account/recovery')
2020-02-09 07:51:49 +13:00
->desc('Complete Password Recovery')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-01-06 12:07:41 +13:00
->label('scope', 'public')
2020-11-19 08:38:31 +13:00
->label('event', 'account.recovery.update')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2020-01-06 12:07:41 +13:00
->label('sdk.namespace', 'account')
2020-01-31 05:18:46 +13:00
->label('sdk.method', 'updateRecovery')
2020-01-06 12:07:41 +13:00
->label('sdk.description', '/docs/references/account/update-recovery.md')
2020-11-13 11:50:53 +13:00
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_TOKEN)
2020-01-06 12:07:41 +13:00
->label('abuse-limit', 10)
->label('abuse-key', 'url:{url},userId:{param-userId}')
2020-09-11 02:40:14 +12:00
->param('userId', '', new UID(), 'User account UID address.')
->param('secret', '', new Text(256), 'Valid reset token.')
->param('password', '', new Password(), 'New password. Must be between 6 to 32 chars.')
->param('passwordAgain', '', new Password(), 'New password again. Must be between 6 to 32 chars.')
2020-12-27 03:31:53 +13:00
->inject('response')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('audits')
2021-05-07 10:31:05 +12:00
->action(function ($userId, $secret, $password, $passwordAgain, $response, $dbForInternal, $audits) {
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Database $dbForInternal */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2021-08-05 17:06:38 +12:00
2020-06-30 09:43:34 +12:00
if ($password !== $passwordAgain) {
throw new Exception('Passwords must match', 400);
}
2020-01-06 12:07:41 +13:00
2021-05-07 10:31:05 +12:00
$profile = $dbForInternal->getDocument('users', $userId);
2020-01-06 12:07:41 +13:00
2021-05-07 10:31:05 +12:00
if ($profile->isEmpty()) {
2021-07-16 16:39:31 +12:00
throw new Exception('User not found', 404);
2020-06-30 09:43:34 +12:00
}
2020-01-06 12:07:41 +13:00
2021-05-07 10:31:05 +12:00
$tokens = $profile->getAttribute('tokens', []);
$recovery = Auth::tokenVerify($tokens, Auth::TOKEN_TYPE_RECOVERY, $secret);
2020-01-06 12:07:41 +13:00
2020-06-30 09:43:34 +12:00
if (!$recovery) {
throw new Exception('Invalid recovery token', 401);
}
2020-01-06 12:07:41 +13:00
2021-08-05 17:06:38 +12:00
Authorization::setRole('user:' . $profile->getId());
2020-01-06 12:07:41 +13:00
2021-05-07 10:31:05 +12:00
$profile = $dbForInternal->updateDocument('users', $profile->getId(), $profile
2021-08-05 17:06:38 +12:00
->setAttribute('password', Auth::passwordHash($password))
->setAttribute('passwordUpdate', \time())
->setAttribute('emailVerification', true)
2021-05-07 10:31:05 +12:00
);
2020-01-06 12:07:41 +13:00
2020-06-30 09:43:34 +12:00
/**
2021-08-05 17:06:38 +12:00
* We act like we're updating and validating
* the recovery token but actually we don't need it anymore.
*/
2021-05-07 10:31:05 +12:00
foreach ($tokens as $key => $token) {
2021-08-05 17:06:38 +12:00
if ($recovery === $token->getId()) {
2021-05-07 10:31:05 +12:00
$recovery = $token;
unset($tokens[$key]);
}
2020-06-30 09:43:34 +12:00
}
2020-01-06 12:07:41 +13:00
2021-05-07 10:31:05 +12:00
$dbForInternal->updateDocument('users', $profile->getId(), $profile->setAttribute('tokens', $tokens));
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $profile->getId())
->setParam('event', 'account.recovery.update')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $profile->getId())
2020-06-30 09:43:34 +12:00
;
2020-01-06 12:07:41 +13:00
2021-07-26 02:47:18 +12:00
$response->dynamic($recovery, Response::MODEL_TOKEN);
2020-12-27 03:31:53 +13:00
});
2020-01-12 13:20:35 +13:00
2020-06-29 05:31:21 +12:00
App::post('/v1/account/verification')
2020-02-10 10:37:28 +13:00
->desc('Create Email Verification')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-01-12 13:20:35 +13:00
->label('scope', 'account')
2020-11-21 10:02:26 +13:00
->label('event', 'account.verification.create')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2020-01-12 13:20:35 +13:00
->label('sdk.namespace', 'account')
2020-01-31 05:18:46 +13:00
->label('sdk.method', 'createVerification')
2020-01-12 13:20:35 +13:00
->label('sdk.description', '/docs/references/account/create-verification.md')
2020-11-13 11:50:53 +13:00
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_TOKEN)
2020-01-12 13:20:35 +13:00
->label('abuse-limit', 10)
2021-07-27 23:21:26 +12:00
->label('abuse-key', 'url:{url},userId:{userId}')
2020-06-30 09:43:34 +12:00
->param('url', '', function ($clients) { return new Host($clients); }, '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, ['clients']) // TODO add built-in confirm page
2020-12-27 03:31:53 +13:00
->inject('request')
->inject('response')
->inject('project')
->inject('user')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('locale')
->inject('audits')
->inject('events')
->inject('mails')
2021-05-07 10:31:05 +12:00
->action(function ($url, $request, $response, $project, $user, $dbForInternal, $locale, $audits, $events, $mails) {
/** @var Utopia\Swoole\Request $request */
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-07-26 02:47:18 +12:00
/** @var Utopia\Database\Document $project */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
/** @var Utopia\Database\Database $dbForInternal */
2020-06-30 09:43:34 +12:00
/** @var Utopia\Locale\Locale $locale */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2020-12-07 11:14:57 +13:00
/** @var Appwrite\Event\Event $events */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $mails */
2020-11-21 01:35:16 +13:00
2021-03-02 10:04:53 +13:00
$isPrivilegedUser = Auth::isPrivilegedUser(Authorization::$roles);
2020-11-21 01:35:16 +13:00
$isAppUser = Auth::isAppUser(Authorization::$roles);
2020-06-30 09:43:34 +12:00
$verificationSecret = Auth::tokenGenerator();
2021-07-07 00:18:55 +12:00
$expire = \time() + Auth::TOKEN_EXPIRATION_CONFIRM;
2021-08-05 17:06:38 +12:00
2020-06-30 09:43:34 +12:00
$verification = new Document([
2021-05-07 10:31:05 +12:00
'$id' => $dbForInternal->getId(),
2021-06-13 08:44:25 +12:00
'userId' => $user->getId(),
2020-06-30 09:43:34 +12:00
'type' => Auth::TOKEN_TYPE_VERIFICATION,
2020-11-13 00:54:16 +13:00
'secret' => Auth::hash($verificationSecret), // One way hash encryption to protect DB leak
2021-07-07 00:18:55 +12:00
'expire' => $expire,
2020-07-04 03:14:51 +12:00
'userAgent' => $request->getUserAgent('UNKNOWN'),
2020-06-30 09:43:34 +12:00
'ip' => $request->getIP(),
]);
2021-08-05 17:06:38 +12:00
Authorization::setRole('user:' . $user->getId());
2020-01-12 13:20:35 +13:00
2020-06-30 09:43:34 +12:00
$user->setAttribute('tokens', $verification, Document::SET_TYPE_APPEND);
2020-01-12 13:20:35 +13:00
2021-05-07 10:31:05 +12:00
$user = $dbForInternal->updateDocument('users', $user->getId(), $user);
2020-06-30 09:43:34 +12:00
$url = Template::parseURL($url);
2021-07-07 00:18:55 +12:00
$url['query'] = Template::mergeQuery(((isset($url['query'])) ? $url['query'] : ''), ['userId' => $user->getId(), 'secret' => $verificationSecret, 'expire' => $expire]);
2020-06-30 09:43:34 +12:00
$url = Template::unParseURL($url);
2020-07-06 02:19:59 +12:00
$mails
2020-06-30 09:43:34 +12:00
->setParam('event', 'account.verification.create')
->setParam('from', $project->getId())
2020-06-30 09:43:34 +12:00
->setParam('recipient', $user->getAttribute('email'))
->setParam('name', $user->getAttribute('name'))
->setParam('url', $url)
->setParam('locale', $locale->default)
->setParam('project', $project->getAttribute('name', ['[APP-NAME]']))
->setParam('type', MAIL_TYPE_VERIFICATION)
2020-06-30 09:43:34 +12:00
->trigger()
;
2020-12-07 11:14:57 +13:00
$events
2021-03-30 07:00:10 +13:00
->setParam('eventData',
2021-07-26 02:47:18 +12:00
$response->output($verification->setAttribute('secret', $verificationSecret),
2021-08-05 17:06:38 +12:00
Response::MODEL_TOKEN
))
2020-11-19 08:38:31 +13:00
;
2021-08-05 17:06:38 +12:00
$verification // Hide secret for clients, sp
2020-11-19 08:38:31 +13:00
->setAttribute('secret',
2021-03-02 10:04:53 +13:00
($isPrivilegedUser || $isAppUser) ? $verificationSecret : '');
2020-11-19 08:38:31 +13:00
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $user->getId())
->setParam('event', 'account.verification.create')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $user->getId())
2020-06-30 09:43:34 +12:00
;
2021-05-07 10:31:05 +12:00
$response->setStatusCode(Response::STATUS_CODE_CREATED);
2021-07-26 02:47:18 +12:00
$response->dynamic($verification, Response::MODEL_TOKEN);
2020-12-27 03:31:53 +13:00
});
2020-01-12 13:20:35 +13:00
2020-06-29 05:31:21 +12:00
App::put('/v1/account/verification')
2020-02-10 10:37:28 +13:00
->desc('Complete Email Verification')
2020-06-26 06:32:12 +12:00
->groups(['api', 'account'])
2020-01-12 13:20:35 +13:00
->label('scope', 'public')
2020-11-21 10:02:26 +13:00
->label('event', 'account.verification.update')
2021-04-16 19:22:17 +12:00
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
2020-01-12 13:20:35 +13:00
->label('sdk.namespace', 'account')
2020-01-31 05:18:46 +13:00
->label('sdk.method', 'updateVerification')
2020-01-12 13:20:35 +13:00
->label('sdk.description', '/docs/references/account/update-verification.md')
2020-11-13 11:50:53 +13:00
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_TOKEN)
2020-01-12 13:20:35 +13:00
->label('abuse-limit', 10)
->label('abuse-key', 'url:{url},userId:{param-userId}')
2020-09-11 02:40:14 +12:00
->param('userId', '', new UID(), 'User unique ID.')
->param('secret', '', new Text(256), 'Valid verification token.')
2020-12-27 03:31:53 +13:00
->inject('response')
->inject('user')
2021-05-07 10:31:05 +12:00
->inject('dbForInternal')
2020-12-27 03:31:53 +13:00
->inject('audits')
2021-05-07 10:31:05 +12:00
->action(function ($userId, $secret, $response, $user, $dbForInternal, $audits) {
2020-10-30 02:50:49 +13:00
/** @var Appwrite\Utopia\Response $response */
2021-05-07 10:31:05 +12:00
/** @var Utopia\Database\Document $user */
/** @var Utopia\Database\Database $dbForInternal */
2020-07-06 02:19:59 +12:00
/** @var Appwrite\Event\Event $audits */
2020-06-30 09:43:34 +12:00
2021-05-07 10:31:05 +12:00
$profile = $dbForInternal->getDocument('users', $userId);
2020-06-30 09:43:34 +12:00
2021-05-07 10:31:05 +12:00
if ($profile->isEmpty()) {
2021-07-16 16:39:31 +12:00
throw new Exception('User not found', 404);
2020-06-30 09:43:34 +12:00
}
2020-01-12 13:20:35 +13:00
2021-05-07 10:31:05 +12:00
$tokens = $profile->getAttribute('tokens', []);
$verification = Auth::tokenVerify($tokens, Auth::TOKEN_TYPE_VERIFICATION, $secret);
2020-01-12 13:20:35 +13:00
2020-06-30 09:43:34 +12:00
if (!$verification) {
throw new Exception('Invalid verification token', 401);
}
2020-01-12 13:20:35 +13:00
2021-08-05 17:06:38 +12:00
Authorization::setRole('user:' . $profile->getId());
2020-01-12 13:20:35 +13:00
2021-05-07 10:31:05 +12:00
$profile = $dbForInternal->updateDocument('users', $profile->getId(), $profile->setAttribute('emailVerification', true));
2020-01-12 13:20:35 +13:00
2020-06-30 09:43:34 +12:00
/**
2021-08-05 17:06:38 +12:00
* We act like we're updating and validating
* the verification token but actually we don't need it anymore.
*/
2021-05-07 10:31:05 +12:00
foreach ($tokens as $key => $token) {
2021-08-05 17:06:38 +12:00
if ($token->getId() === $verification) {
2021-05-07 10:31:05 +12:00
$verification = $token;
unset($tokens[$key]);
}
2020-06-30 09:43:34 +12:00
}
2020-01-12 13:20:35 +13:00
2021-05-07 10:31:05 +12:00
$dbForInternal->updateDocument('users', $profile->getId(), $profile->setAttribute('tokens', $tokens));
2020-07-06 02:19:59 +12:00
$audits
2020-06-30 09:43:34 +12:00
->setParam('userId', $profile->getId())
->setParam('event', 'account.verification.update')
2021-08-05 17:06:38 +12:00
->setParam('resource', 'users/' . $user->getId())
2020-06-30 09:43:34 +12:00
;
2020-01-12 13:20:35 +13:00
2021-07-26 02:47:18 +12:00
$response->dynamic($verification, Response::MODEL_TOKEN);
});