3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Security;
26 use Friendica\Core\Config\Capability\IManageConfigValues;
27 use Friendica\Core\PConfig\Capability\IManagePersonalConfigValues;
28 use Friendica\Core\Hook;
29 use Friendica\Core\Session\Capability\IHandleUserSessions;
30 use Friendica\Core\System;
31 use Friendica\Database\Database;
32 use Friendica\Database\DBA;
34 use Friendica\Model\User;
35 use Friendica\Network\HTTPException;
36 use Friendica\Security\TwoFactor\Repository\TrustedBrowser;
37 use Friendica\Util\DateTimeFormat;
38 use Friendica\Util\Network;
40 use Friendica\Core\L10n;
41 use Psr\Log\LoggerInterface;
44 * Handle Authentication, Session and Cookies
48 /** @var IManageConfigValues */
52 /** @var App\BaseURL */
58 /** @var LoggerInterface */
60 /** @var User\Cookie */
62 /** @var IHandleUserSessions */
64 /** @var IManagePersonalConfigValues */
67 private $remoteAddress;
70 * Sets the X-Account-Management-Status header
72 * mainly extracted to make it overridable for tests
74 * @param array $user_record
76 protected function setXAccMgmtStatusHeader(array $user_record)
78 header('X-Account-Management-Status: active; name="' . $user_record['username'] . '"; id="' . $user_record['nickname'] . '"');
82 * Authentication constructor.
84 * @param IManageConfigValues $config
85 * @param App\Mode $mode
86 * @param App\BaseURL $baseUrl
88 * @param Database $dba
89 * @param LoggerInterface $logger
90 * @param User\Cookie $cookie
91 * @param IHandleUserSessions $session
92 * @param IManagePersonalConfigValues $pConfig
93 * @param App\Request $request
95 public function __construct(IManageConfigValues $config, App\Mode $mode, App\BaseURL $baseUrl, L10n $l10n, Database $dba, LoggerInterface $logger, User\Cookie $cookie, IHandleUserSessions $session, IManagePersonalConfigValues $pConfig, App\Request $request)
97 $this->config = $config;
99 $this->baseUrl = $baseUrl;
102 $this->logger = $logger;
103 $this->cookie = $cookie;
104 $this->session = $session;
105 $this->pConfig = $pConfig;
106 $this->remoteAddress = $request->getRemoteAddress();
110 * Tries to auth the user from the cookie or session
112 * @param App $a The Friendica Application context
114 * @throws HttpException\InternalServerErrorException In case of Friendica internal exceptions
115 * @throws Exception In case of general exceptions (like SQL Grammar)
117 public function withSession(App $a)
119 // When the "Friendica" cookie is set, take the value to authenticate and renew the cookie.
120 if ($this->cookie->get('uid')) {
121 $user = $this->dba->selectFirst(
125 'uid' => $this->cookie->get('uid'),
127 'account_expired' => false,
128 'account_removed' => false,
132 if ($this->dba->isResult($user)) {
133 if (!$this->cookie->comparePrivateDataHash($this->cookie->get('hash'),
134 $user['password'] ?? '',
135 $user['prvkey'] ?? '')
137 $this->logger->notice("Hash doesn't fit.", ['user' => $this->cookie->get('uid')]);
138 $this->session->clear();
139 $this->cookie->clear();
140 $this->baseUrl->redirect();
144 $this->cookie->send();
146 // Do the authentication if not done by now
147 if (!$this->session->get('authenticated')) {
148 $this->setForUser($a, $user);
150 if ($this->config->get('system', 'paranoia')) {
151 $this->session->set('addr', $this->cookie->get('ip'));
157 if ($this->session->get('authenticated')) {
158 if ($this->session->get('visitor_id') && !$this->session->get('uid')) {
159 $contact = $this->dba->selectFirst('contact', ['id'], ['id' => $this->session->get('visitor_id')]);
160 if ($this->dba->isResult($contact)) {
161 $a->setContactId($contact['id']);
165 if ($this->session->get('uid')) {
166 // already logged in user returning
167 $check = $this->config->get('system', 'paranoia');
168 // extra paranoia - if the IP changed, log them out
169 if ($check && ($this->session->get('addr') != $this->remoteAddress)) {
170 $this->logger->notice('Session address changed. Paranoid setting in effect, blocking session. ', [
171 'addr' => $this->session->get('addr'),
172 'remote_addr' => $this->remoteAddress
175 $this->session->clear();
176 $this->baseUrl->redirect();
179 $user = $this->dba->selectFirst(
183 'uid' => $this->session->get('uid'),
185 'account_expired' => false,
186 'account_removed' => false,
190 if (!$this->dba->isResult($user)) {
191 $this->session->clear();
192 $this->baseUrl->redirect();
195 // Make sure to refresh the last login time for the user if the user
196 // stays logged in for a long time, e.g. with "Remember Me"
197 $login_refresh = false;
198 if (!$this->session->get('last_login_date')) {
199 $this->session->set('last_login_date', DateTimeFormat::utcNow());
201 if (strcmp(DateTimeFormat::utc('now - 12 hours'), $this->session->get('last_login_date')) > 0) {
202 $this->session->set('last_login_date', DateTimeFormat::utcNow());
203 $login_refresh = true;
206 $this->setForUser($a, $user, false, false, $login_refresh);
212 * Attempts to authenticate using OpenId
214 * @param string $openid_url OpenID URL string
215 * @param bool $remember Whether to set the session remember flag
217 * @throws HttpException\InternalServerErrorException In case of Friendica internal exceptions
219 public function withOpenId(string $openid_url, bool $remember)
221 $noid = $this->config->get('system', 'no_openid');
223 // if it's an email address or doesn't resolve to a URL, fail.
224 if ($noid || strpos($openid_url, '@') || !Network::isUrlValid($openid_url)) {
225 DI::sysmsg()->addNotice($this->l10n->t('Login failed.'));
226 $this->baseUrl->redirect();
229 // Otherwise it's probably an openid.
231 $openid = new LightOpenID($this->baseUrl->getHostname());
232 $openid->identity = $openid_url;
233 $this->session->set('openid', $openid_url);
234 $this->session->set('remember', $remember);
235 $openid->returnUrl = $this->baseUrl->get(true) . '/openid';
236 $openid->optional = ['namePerson/friendly', 'contact/email', 'namePerson', 'namePerson/first', 'media/image/aspect11', 'media/image/default'];
237 System::externalRedirect($openid->authUrl());
238 } catch (Exception $e) {
239 DI::sysmsg()->addNotice($this->l10n->t('We encountered a problem while logging in with the OpenID you provided. Please check the correct spelling of the ID.') . '<br /><br >' . $this->l10n->t('The error message was:') . ' ' . $e->getMessage());
244 * Attempts to authenticate using login/password
246 * @param App $a The Friendica Application context
247 * @param string $username
248 * @param string $password Clear password
249 * @param bool $remember Whether to set the session remember flag
250 * @param string $return_path The relative path to redirect the user to after authentication
252 * @throws HTTPException\ForbiddenException
253 * @throws HTTPException\FoundException
254 * @throws HTTPException\InternalServerErrorException In case of Friendica internal exceptions
255 * @throws HTTPException\MovedPermanentlyException
256 * @throws HTTPException\TemporaryRedirectException
258 public function withPassword(App $a, string $username, string $password, bool $remember, string $return_path = '')
263 $record = $this->dba->selectFirst(
266 ['uid' => User::getIdFromPasswordAuthentication($username, $password)]
268 } catch (Exception $e) {
269 $this->logger->warning('authenticate: failed login attempt', ['action' => 'login', 'username' => $username, 'ip' => $this->remoteAddress]);
270 DI::sysmsg()->addNotice($this->l10n->t('Login failed. Please check your credentials.'));
271 $this->baseUrl->redirect();
275 $trusted = $this->cookie->get('2fa_cookie_hash') ?? null;
276 $this->cookie->clear();
278 $this->cookie->set('2fa_cookie_hash', $trusted);
282 // if we haven't failed up this point, log them in.
283 $this->session->set('remember', $remember);
284 $this->session->set('last_login_date', DateTimeFormat::utcNow());
286 $openid_identity = $this->session->get('openid_identity');
287 $openid_server = $this->session->get('openid_server');
289 if (!empty($openid_identity) || !empty($openid_server)) {
290 $this->dba->update('user', ['openid' => $openid_identity, 'openidserver' => $openid_server], ['uid' => $record['uid']]);
294 * @see User::getPasswordRegExp()
296 if (PASSWORD_DEFAULT === PASSWORD_BCRYPT && strlen($password) > 72) {
297 $return_path = '/security/password_too_long?' . http_build_query(['return_path' => $return_path]);
300 $this->setForUser($a, $record, true, true);
302 $this->baseUrl->redirect($return_path);
306 * Sets the provided user's authenticated session
308 * @param App $a The Friendica application context
309 * @param array $user_record The current "user" record
310 * @param bool $login_initial
311 * @param bool $interactive
312 * @param bool $login_refresh
314 * @throws HTTPException\FoundException
315 * @throws HTTPException\MovedPermanentlyException
316 * @throws HTTPException\TemporaryRedirectException
317 * @throws HTTPException\ForbiddenException
319 * @throws HTTPException\InternalServerErrorException In case of Friendica specific exceptions
322 public function setForUser(App $a, array $user_record, bool $login_initial = false, bool $interactive = false, bool $login_refresh = false)
324 $this->session->setMultiple([
325 'uid' => $user_record['uid'],
326 'theme' => $user_record['theme'],
327 'mobile-theme' => $this->pConfig->get($user_record['uid'], 'system', 'mobile_theme'),
328 'authenticated' => 1,
329 'page_flags' => $user_record['page-flags'],
330 'my_url' => $this->baseUrl->get() . '/profile/' . $user_record['nickname'],
331 'my_address' => $user_record['nickname'] . '@' . substr($this->baseUrl->get(), strpos($this->baseUrl->get(), '://') + 3),
332 'addr' => $this->remoteAddress,
333 'nickname' => $user_record['nickname'],
336 $this->session->setVisitorsContacts();
338 $member_since = strtotime($user_record['register_date']);
339 $this->session->set('new_member', time() < ($member_since + (60 * 60 * 24 * 14)));
341 if (strlen($user_record['timezone'])) {
342 $a->setTimeZone($user_record['timezone']);
345 $contact = $this->dba->selectFirst('contact', ['id'], ['uid' => $user_record['uid'], 'self' => true]);
346 if ($this->dba->isResult($contact)) {
347 $a->setContactId($contact['id']);
348 $this->session->set('cid', $contact['id']);
351 $this->setXAccMgmtStatusHeader($user_record);
353 if ($login_initial || $login_refresh) {
354 $this->dba->update('user', ['login_date' => DateTimeFormat::utcNow()], ['uid' => $user_record['uid']]);
356 // Set the login date for all identities of the user
357 $this->dba->update('user', ['login_date' => DateTimeFormat::utcNow()],
358 ['parent-uid' => $user_record['uid'], 'account_removed' => false]);
361 if ($login_initial) {
363 * If the user specified to remember the authentication, then set a cookie
364 * that expires after one week (the default is when the browser is closed).
365 * The cookie will be renewed automatically.
366 * The week ensures that sessions will expire after some inactivity.
368 if ($this->session->get('remember')) {
369 $this->logger->info('Injecting cookie for remembered user ' . $user_record['nickname']);
370 $this->cookie->setMultiple([
371 'uid' => $user_record['uid'],
372 'hash' => $this->cookie->hashPrivateData($user_record['password'], $user_record['prvkey']),
374 $this->session->remove('remember');
378 $this->redirectForTwoFactorAuthentication($user_record['uid']);
381 if ($user_record['login_date'] <= DBA::NULL_DATETIME) {
382 DI::sysmsg()->addInfo($this->l10n->t('Welcome %s', $user_record['username']));
383 DI::sysmsg()->addInfo($this->l10n->t('Please upload a profile photo.'));
384 $this->baseUrl->redirect('settings/profile/photo/new');
388 $a->setLoggedInUserId($user_record['uid']);
389 $a->setLoggedInUserNickname($user_record['nickname']);
391 if ($login_initial) {
392 Hook::callAll('logged_in', $user_record);
397 * Decides whether to redirect the user to two-factor authentication.
398 * All return calls in this method skip two-factor authentication
400 * @param int $uid The User Identified
402 * @throws HTTPException\ForbiddenException In case the two factor authentication is forbidden (e.g. for AJAX calls)
403 * @throws HTTPException\InternalServerErrorException
405 private function redirectForTwoFactorAuthentication(int $uid)
407 // Check user setting, if 2FA disabled return
408 if (!$this->pConfig->get($uid, '2fa', 'verified')) {
412 // Check current path, if public or 2fa module return
413 if (DI::args()->getArgc() > 0 && in_array(DI::args()->getArgv()[0], ['2fa', 'view', 'help', 'api', 'proxy', 'logout'])) {
417 // Case 1a: 2FA session already present: return
418 if ($this->session->get('2fa')) {
422 // Case 1b: Check for trusted browser
423 if ($this->cookie->get('2fa_cookie_hash')) {
424 // Retrieve a trusted_browser model based on cookie hash
425 $trustedBrowserRepository = new TrustedBrowser($this->dba, $this->logger);
427 $trustedBrowser = $trustedBrowserRepository->selectOneByHash($this->cookie->get('2fa_cookie_hash'));
428 // Verify record ownership
429 if ($trustedBrowser->uid === $uid) {
430 // Update last_used date
431 $trustedBrowser->recordUse();
433 // Save it to the database
434 $trustedBrowserRepository->save($trustedBrowser);
436 // Only use this entry, if its really trusted, otherwise just update the record and proceed
437 if ($trustedBrowser->trusted) {
438 // Set 2fa session key and return
439 $this->session->set('2fa', true);
444 // Invalid trusted cookie value, removing it
445 $this->cookie->unset('trusted');
447 } catch (\Throwable $e) {
448 // Local trusted browser record was probably removed by the user, we carry on with 2FA
452 // Case 2: No valid 2FA session: redirect to code verification page
453 if ($this->mode->isAjax()) {
454 throw new HTTPException\ForbiddenException();
456 $this->baseUrl->redirect('2fa');