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;
30 use Friendica\Core\Session\Capability\IHandleSessions;
31 use Friendica\Core\System;
32 use Friendica\Database\Database;
33 use Friendica\Database\DBA;
35 use Friendica\Model\User;
36 use Friendica\Network\HTTPException;
37 use Friendica\Security\TwoFactor\Repository\TrustedBrowser;
38 use Friendica\Util\DateTimeFormat;
39 use Friendica\Util\Network;
41 use Friendica\Core\L10n;
42 use Psr\Log\LoggerInterface;
45 * Handle Authentication, Session and Cookies
49 /** @var IManageConfigValues */
53 /** @var App\BaseURL */
59 /** @var LoggerInterface */
61 /** @var User\Cookie */
63 /** @var IHandleSessions */
65 /** @var IManagePersonalConfigValues */
68 private $remoteAddress;
71 * Sets the X-Account-Management-Status header
73 * mainly extracted to make it overridable for tests
75 * @param array $user_record
77 protected function setXAccMgmtStatusHeader(array $user_record)
79 header('X-Account-Management-Status: active; name="' . $user_record['username'] . '"; id="' . $user_record['nickname'] . '"');
83 * Authentication constructor.
85 * @param IManageConfigValues $config
86 * @param App\Mode $mode
87 * @param App\BaseURL $baseUrl
89 * @param Database $dba
90 * @param LoggerInterface $logger
91 * @param User\Cookie $cookie
92 * @param IHandleSessions $session
93 * @param IManagePersonalConfigValues $pConfig
94 * @param App\Request $request
96 public function __construct(IManageConfigValues $config, App\Mode $mode, App\BaseURL $baseUrl, L10n $l10n, Database $dba, LoggerInterface $logger, User\Cookie $cookie, IHandleSessions $session, IManagePersonalConfigValues $pConfig, App\Request $request)
98 $this->config = $config;
100 $this->baseUrl = $baseUrl;
103 $this->logger = $logger;
104 $this->cookie = $cookie;
105 $this->session = $session;
106 $this->pConfig = $pConfig;
107 $this->remoteAddress = $request->getRemoteAddress();
111 * Tries to auth the user from the cookie or session
113 * @param App $a The Friendica Application context
115 * @throws HttpException\InternalServerErrorException In case of Friendica internal exceptions
116 * @throws Exception In case of general exceptions (like SQL Grammar)
118 public function withSession(App $a)
120 // When the "Friendica" cookie is set, take the value to authenticate and renew the cookie.
121 if ($this->cookie->get('uid')) {
122 $user = $this->dba->selectFirst(
126 'uid' => $this->cookie->get('uid'),
128 'account_expired' => false,
129 'account_removed' => false,
133 if ($this->dba->isResult($user)) {
134 if (!$this->cookie->comparePrivateDataHash($this->cookie->get('hash'),
135 $user['password'] ?? '',
136 $user['prvkey'] ?? '')
138 $this->logger->notice("Hash doesn't fit.", ['user' => $this->cookie->get('uid')]);
139 $this->session->clear();
140 $this->cookie->clear();
141 $this->baseUrl->redirect();
145 $this->cookie->send();
147 // Do the authentication if not done by now
148 if (!$this->session->get('authenticated')) {
149 $this->setForUser($a, $user);
151 if ($this->config->get('system', 'paranoia')) {
152 $this->session->set('addr', $this->cookie->get('ip'));
158 if ($this->session->get('authenticated')) {
159 if ($this->session->get('visitor_id') && !$this->session->get('uid')) {
160 $contact = $this->dba->selectFirst('contact', ['id'], ['id' => $this->session->get('visitor_id')]);
161 if ($this->dba->isResult($contact)) {
162 $a->setContactId($contact['id']);
166 if ($this->session->get('uid')) {
167 // already logged in user returning
168 $check = $this->config->get('system', 'paranoia');
169 // extra paranoia - if the IP changed, log them out
170 if ($check && ($this->session->get('addr') != $this->remoteAddress)) {
171 $this->logger->notice('Session address changed. Paranoid setting in effect, blocking session. ', [
172 'addr' => $this->session->get('addr'),
173 'remote_addr' => $this->remoteAddress
176 $this->session->clear();
177 $this->baseUrl->redirect();
180 $user = $this->dba->selectFirst(
184 'uid' => $this->session->get('uid'),
186 'account_expired' => false,
187 'account_removed' => false,
191 if (!$this->dba->isResult($user)) {
192 $this->session->clear();
193 $this->baseUrl->redirect();
196 // Make sure to refresh the last login time for the user if the user
197 // stays logged in for a long time, e.g. with "Remember Me"
198 $login_refresh = false;
199 if (!$this->session->get('last_login_date')) {
200 $this->session->set('last_login_date', DateTimeFormat::utcNow());
202 if (strcmp(DateTimeFormat::utc('now - 12 hours'), $this->session->get('last_login_date')) > 0) {
203 $this->session->set('last_login_date', DateTimeFormat::utcNow());
204 $login_refresh = true;
207 $this->setForUser($a, $user, false, false, $login_refresh);
213 * Attempts to authenticate using OpenId
215 * @param string $openid_url OpenID URL string
216 * @param bool $remember Whether to set the session remember flag
218 * @throws HttpException\InternalServerErrorException In case of Friendica internal exceptions
220 public function withOpenId(string $openid_url, bool $remember)
222 $noid = $this->config->get('system', 'no_openid');
224 // if it's an email address or doesn't resolve to a URL, fail.
225 if ($noid || strpos($openid_url, '@') || !Network::isUrlValid($openid_url)) {
226 notice($this->l10n->t('Login failed.'));
227 $this->baseUrl->redirect();
230 // Otherwise it's probably an openid.
232 $openid = new LightOpenID($this->baseUrl->getHostname());
233 $openid->identity = $openid_url;
234 $this->session->set('openid', $openid_url);
235 $this->session->set('remember', $remember);
236 $openid->returnUrl = $this->baseUrl->get(true) . '/openid';
237 $openid->optional = ['namePerson/friendly', 'contact/email', 'namePerson', 'namePerson/first', 'media/image/aspect11', 'media/image/default'];
238 System::externalRedirect($openid->authUrl());
239 } catch (Exception $e) {
240 notice($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());
245 * Attempts to authenticate using login/password
247 * @param App $a The Friendica Application context
248 * @param string $username User name
249 * @param string $password Clear password
250 * @param bool $remember Whether to set the session remember flag
252 * @throws HttpException\InternalServerErrorException In case of Friendica internal exceptions
253 * @throws Exception A general Exception (like SQL Grammar exceptions)
255 public function withPassword(App $a, string $username, string $password, bool $remember)
260 $record = $this->dba->selectFirst(
263 ['uid' => User::getIdFromPasswordAuthentication($username, $password)]
265 } catch (Exception $e) {
266 $this->logger->warning('authenticate: failed login attempt', ['action' => 'login', 'username' => $username, 'ip' => $this->remoteAddress]);
267 notice($this->l10n->t('Login failed. Please check your credentials.'));
268 $this->baseUrl->redirect();
272 $trusted = $this->cookie->get('2fa_cookie_hash') ?? null;
273 $this->cookie->clear();
275 $this->cookie->set('2fa_cookie_hash', $trusted);
279 // if we haven't failed up this point, log them in.
280 $this->session->set('remember', $remember);
281 $this->session->set('last_login_date', DateTimeFormat::utcNow());
283 $openid_identity = $this->session->get('openid_identity');
284 $openid_server = $this->session->get('openid_server');
286 if (!empty($openid_identity) || !empty($openid_server)) {
287 $this->dba->update('user', ['openid' => $openid_identity, 'openidserver' => $openid_server], ['uid' => $record['uid']]);
290 $this->setForUser($a, $record, true, true);
292 $return_path = $this->session->get('return_path', '');
293 $this->session->remove('return_path');
295 $this->baseUrl->redirect($return_path);
299 * Sets the provided user's authenticated session
301 * @param App $a The Friendica application context
302 * @param array $user_record The current "user" record
303 * @param bool $login_initial
304 * @param bool $interactive
305 * @param bool $login_refresh
307 * @throws HTTPException\FoundException
308 * @throws HTTPException\MovedPermanentlyException
309 * @throws HTTPException\TemporaryRedirectException
310 * @throws HTTPException\ForbiddenException
312 * @throws HTTPException\InternalServerErrorException In case of Friendica specific exceptions
315 public function setForUser(App $a, array $user_record, bool $login_initial = false, bool $interactive = false, bool $login_refresh = false)
317 $this->session->setMultiple([
318 'uid' => $user_record['uid'],
319 'theme' => $user_record['theme'],
320 'mobile-theme' => $this->pConfig->get($user_record['uid'], 'system', 'mobile_theme'),
321 'authenticated' => 1,
322 'page_flags' => $user_record['page-flags'],
323 'my_url' => $this->baseUrl->get() . '/profile/' . $user_record['nickname'],
324 'my_address' => $user_record['nickname'] . '@' . substr($this->baseUrl->get(), strpos($this->baseUrl->get(), '://') + 3),
325 'addr' => $this->remoteAddress,
328 Session::setVisitorsContacts();
330 $member_since = strtotime($user_record['register_date']);
331 $this->session->set('new_member', time() < ($member_since + (60 * 60 * 24 * 14)));
333 if (strlen($user_record['timezone'])) {
334 $a->setTimeZone($user_record['timezone']);
337 $contact = $this->dba->selectFirst('contact', ['id'], ['uid' => $user_record['uid'], 'self' => true]);
338 if ($this->dba->isResult($contact)) {
339 $a->setContactId($contact['id']);
340 $this->session->set('cid', $contact['id']);
343 $this->setXAccMgmtStatusHeader($user_record);
345 if ($login_initial || $login_refresh) {
346 $this->dba->update('user', ['login_date' => DateTimeFormat::utcNow()], ['uid' => $user_record['uid']]);
348 // Set the login date for all identities of the user
349 $this->dba->update('user', ['login_date' => DateTimeFormat::utcNow()],
350 ['parent-uid' => $user_record['uid'], 'account_removed' => false]);
353 if ($login_initial) {
355 * If the user specified to remember the authentication, then set a cookie
356 * that expires after one week (the default is when the browser is closed).
357 * The cookie will be renewed automatically.
358 * The week ensures that sessions will expire after some inactivity.
360 if ($this->session->get('remember')) {
361 $this->logger->info('Injecting cookie for remembered user ' . $user_record['nickname']);
362 $this->cookie->setMultiple([
363 'uid' => $user_record['uid'],
364 'hash' => $this->cookie->hashPrivateData($user_record['password'], $user_record['prvkey']),
366 $this->session->remove('remember');
370 $this->redirectForTwoFactorAuthentication($user_record['uid']);
373 if ($user_record['login_date'] <= DBA::NULL_DATETIME) {
374 info($this->l10n->t('Welcome %s', $user_record['username']));
375 info($this->l10n->t('Please upload a profile photo.'));
376 $this->baseUrl->redirect('settings/profile/photo/new');
380 $a->setLoggedInUserId($user_record['uid']);
381 $a->setLoggedInUserNickname($user_record['nickname']);
383 if ($login_initial) {
384 Hook::callAll('logged_in', $user_record);
386 if (DI::args()->getModuleName() !== 'home' && $this->session->exists('return_path')) {
387 $this->baseUrl->redirect($this->session->get('return_path'));
393 * Decides whether to redirect the user to two-factor authentication.
394 * All return calls in this method skip two-factor authentication
396 * @param int $uid The User Identified
398 * @throws HTTPException\ForbiddenException In case the two factor authentication is forbidden (e.g. for AJAX calls)
399 * @throws HTTPException\InternalServerErrorException
401 private function redirectForTwoFactorAuthentication(int $uid)
403 // Check user setting, if 2FA disabled return
404 if (!$this->pConfig->get($uid, '2fa', 'verified')) {
408 // Check current path, if public or 2fa module return
409 if (DI::args()->getArgc() > 0 && in_array(DI::args()->getArgv()[0], ['2fa', 'view', 'help', 'api', 'proxy', 'logout'])) {
413 // Case 1a: 2FA session already present: return
414 if ($this->session->get('2fa')) {
418 // Case 1b: Check for trusted browser
419 if ($this->cookie->get('2fa_cookie_hash')) {
420 // Retrieve a trusted_browser model based on cookie hash
421 $trustedBrowserRepository = new TrustedBrowser($this->dba, $this->logger);
423 $trustedBrowser = $trustedBrowserRepository->selectOneByHash($this->cookie->get('2fa_cookie_hash'));
424 // Verify record ownership
425 if ($trustedBrowser->uid === $uid) {
426 // Update last_used date
427 $trustedBrowser->recordUse();
429 // Save it to the database
430 $trustedBrowserRepository->save($trustedBrowser);
432 // Only use this entry, if its really trusted, otherwise just update the record and proceed
433 if ($trustedBrowser->trusted) {
434 // Set 2fa session key and return
435 $this->session->set('2fa', true);
440 // Invalid trusted cookie value, removing it
441 $this->cookie->unset('trusted');
443 } catch (\Throwable $e) {
444 // Local trusted browser record was probably removed by the user, we carry on with 2FA
448 // Case 2: No valid 2FA session: redirect to code verification page
449 if ($this->mode->isAjax()) {
450 throw new HTTPException\ForbiddenException();
452 $this->baseUrl->redirect('2fa');