mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 02:36:28 +00:00
143 lines
3.9 KiB
PHP
143 lines
3.9 KiB
PHP
<?php
|
|
|
|
/**
|
|
* RemoteUserGuard.php
|
|
* Copyright (c) 2020 james@firefly-iii.org
|
|
*
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Support\Authentication;
|
|
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\User;
|
|
use Illuminate\Contracts\Auth\Authenticatable;
|
|
use Illuminate\Contracts\Auth\Guard;
|
|
use Illuminate\Contracts\Auth\UserProvider;
|
|
use Illuminate\Contracts\Foundation\Application;
|
|
use Log;
|
|
/**
|
|
* Class RemoteUserGuard
|
|
*/
|
|
class RemoteUserGuard implements Guard
|
|
{
|
|
protected Application $application;
|
|
protected $provider;
|
|
protected $user;
|
|
|
|
/**
|
|
* Create a new authentication guard.
|
|
*
|
|
* @param UserProvider $provider
|
|
* @param Application $app
|
|
*/
|
|
// @phpstan-ignore-next-line
|
|
public function __construct(UserProvider $provider, Application $app) // @phpstan-ignore-line
|
|
{
|
|
$this->application = $app;
|
|
$this->provider = $provider;
|
|
$this->user = null;
|
|
}
|
|
|
|
/**
|
|
*
|
|
*/
|
|
public function authenticate(): void
|
|
{
|
|
Log::debug(sprintf('Now at %s', __METHOD__));
|
|
if (!is_null($this->user)) {
|
|
Log::debug('User is found.');
|
|
|
|
return;
|
|
}
|
|
// Get the user identifier from $_SERVER or apache filtered headers
|
|
$header = config('auth.guard_header', 'REMOTE_USER');
|
|
$userID = request()->server($header) ?? apache_request_headers()[$header] ?? null;
|
|
if (null === $userID) {
|
|
Log::error(sprintf('No user in header "%s".', $header));
|
|
throw new FireflyException('The guard header was unexpectedly empty. See the logs.');
|
|
}
|
|
|
|
/** @var User $retrievedUser */
|
|
$retrievedUser = $this->provider->retrieveById($userID);
|
|
|
|
// store email address if present in header and not already set.
|
|
$header = config('auth.guard_email');
|
|
|
|
if (null !== $header) {
|
|
$emailAddress = (string)(request()->server($header) ?? null);
|
|
$preference = app('preferences')->getForUser($retrievedUser, 'remote_guard_alt_email');
|
|
|
|
if (null !== $emailAddress && null === $preference && $emailAddress !== $userID) {
|
|
app('preferences')->setForUser($retrievedUser, 'remote_guard_alt_email', $emailAddress);
|
|
}
|
|
}
|
|
|
|
Log::debug(sprintf('Result of getting user from provider: %s', $retrievedUser->email));
|
|
$this->user = $retrievedUser;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function check(): bool
|
|
{
|
|
return !is_null($this->user());
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function guest(): bool
|
|
{
|
|
return !$this->check();
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function id(): ?User
|
|
{
|
|
return $this->user;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function setUser(Authenticatable $user)
|
|
{
|
|
$this->user = $user;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function user(): ?User
|
|
{
|
|
return $this->user;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function validate(array $credentials = [])
|
|
{
|
|
throw new FireflyException('Did not implement RemoteUserGuard::validate()');
|
|
}
|
|
}
|