mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-11-03 20:55:05 +00:00
267 lines
8.8 KiB
PHP
267 lines
8.8 KiB
PHP
<?php
|
|
/**
|
|
* LoginController.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\Http\Controllers\Auth;
|
|
|
|
use Adldap;
|
|
use Cookie;
|
|
use DB;
|
|
use FireflyIII\Events\ActuallyLoggedIn;
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\Http\Controllers\Controller;
|
|
use FireflyIII\Providers\RouteServiceProvider;
|
|
use Illuminate\Contracts\Foundation\Application;
|
|
use Illuminate\Contracts\View\Factory;
|
|
use Illuminate\Contracts\View\View;
|
|
use Illuminate\Foundation\Auth\AuthenticatesUsers;
|
|
use Illuminate\Foundation\Auth\ThrottlesLogins;
|
|
use Illuminate\Http\JsonResponse;
|
|
use Illuminate\Http\RedirectResponse;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Http\Response;
|
|
use Illuminate\Routing\Redirector;
|
|
use Illuminate\Validation\ValidationException;
|
|
use Log;
|
|
|
|
/**
|
|
* Class LoginController
|
|
*
|
|
* This controller handles authenticating users for the application and
|
|
* redirecting them to your home screen. The controller uses a trait
|
|
* to conveniently provide its functionality to your applications.
|
|
*
|
|
* @codeCoverageIgnore
|
|
*/
|
|
class LoginController extends Controller
|
|
{
|
|
use AuthenticatesUsers, ThrottlesLogins;
|
|
|
|
/**
|
|
* Where to redirect users after login.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected string $redirectTo = RouteServiceProvider::HOME;
|
|
|
|
private string $username;
|
|
|
|
/**
|
|
* Create a new controller instance.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
$this->username = 'email';
|
|
$this->middleware('guest')->except('logout');
|
|
}
|
|
|
|
/**
|
|
* Handle a login request to the application.
|
|
*
|
|
* @param Request $request
|
|
*
|
|
* @return JsonResponse|RedirectResponse
|
|
*
|
|
* @throws ValidationException
|
|
*/
|
|
public function login(Request $request)
|
|
{
|
|
Log::channel('audit')->info(sprintf('User is trying to login using "%s"', $request->get($this->username())));
|
|
Log::info('User is trying to login.');
|
|
|
|
$guard = config('auth.defaults.guard');
|
|
|
|
// if the user logs in using LDAP the field is also changed (per LDAP config)
|
|
if ('ldap' === $guard) {
|
|
Log::debug('User wishes to login using LDAP.');
|
|
$this->username = config('firefly.ldap_auth_field');
|
|
}
|
|
|
|
|
|
$this->validateLogin($request);
|
|
Log::debug('Login data is valid.');
|
|
|
|
/** Copied directly from AuthenticatesUsers, but with logging added: */
|
|
// If the class is using the ThrottlesLogins trait, we can automatically throttle
|
|
// the login attempts for this application. We'll key this by the username and
|
|
// the IP address of the client making these requests into this application.
|
|
if (method_exists($this, 'hasTooManyLoginAttempts') && $this->hasTooManyLoginAttempts($request)) {
|
|
Log::channel('audit')->info(sprintf('Login for user "%s" was locked out.', $request->get($this->username())));
|
|
Log::error(sprintf('Login for user "%s" was locked out.', $request->get($this->username())));
|
|
$this->fireLockoutEvent($request);
|
|
|
|
$this->sendLockoutResponse($request);
|
|
}
|
|
/** Copied directly from AuthenticatesUsers, but with logging added: */
|
|
if ($this->attemptLogin($request)) {
|
|
Log::channel('audit')->info(sprintf('User "%s" has been logged in.', $request->get($this->username())));
|
|
Log::debug(sprintf('Redirect after login is %s.', $this->redirectPath()));
|
|
|
|
// if you just logged in, it can't be that you have a valid 2FA cookie.
|
|
|
|
// send a custom login event because laravel will also fire a login event if a "remember me"-cookie
|
|
// restores the event.
|
|
event(new ActuallyLoggedIn($this->guard()->user()));
|
|
|
|
return $this->sendLoginResponse($request);
|
|
}
|
|
Log::warning('Login attempt failed.');
|
|
|
|
/** Copied directly from AuthenticatesUsers, but with logging added: */
|
|
// If the login attempt was unsuccessful we will increment the number of attempts
|
|
// to login and redirect the user back to the login form. Of course, when this
|
|
// user surpasses their maximum number of attempts they will get locked out.
|
|
$this->incrementLoginAttempts($request);
|
|
Log::channel('audit')->info(sprintf('Login failed. Attempt for user "%s" failed.', $request->get($this->username())));
|
|
|
|
$this->sendFailedLoginResponse($request);
|
|
}
|
|
|
|
/**
|
|
* Log the user out of the application.
|
|
*
|
|
* @param Request $request
|
|
*
|
|
* @return Response
|
|
*/
|
|
public function logout(Request $request)
|
|
{
|
|
$authGuard = config('firefly.authentication_guard');
|
|
$logoutUri = config('firefly.custom_logout_url');
|
|
if ('remote_user_guard' === $authGuard && '' !== $logoutUri) {
|
|
return redirect($logoutUri);
|
|
}
|
|
if ('remote_user_guard' === $authGuard && '' === $logoutUri) {
|
|
session()->flash('error', trans('firefly.cant_logout_guard'));
|
|
}
|
|
|
|
// also logout current 2FA tokens.
|
|
$cookieName = config('google2fa.cookie_name', 'google2fa_token');
|
|
Cookie::forget($cookieName);
|
|
|
|
$this->guard()->logout();
|
|
|
|
$request->session()->invalidate();
|
|
|
|
$request->session()->regenerateToken();
|
|
|
|
if ($response = $this->loggedOut($request)) {
|
|
return $response;
|
|
}
|
|
|
|
return $request->wantsJson()
|
|
? new Response('', 204)
|
|
: redirect('/');
|
|
}
|
|
|
|
/**
|
|
* Get the failed login response instance.
|
|
*
|
|
* @param Request $request
|
|
*
|
|
* @return void
|
|
*
|
|
* @throws ValidationException
|
|
*/
|
|
protected function sendFailedLoginResponse(Request $request)
|
|
{
|
|
$exception = ValidationException::withMessages(
|
|
[
|
|
$this->username() => [trans('auth.failed')],
|
|
]
|
|
);
|
|
$exception->redirectTo = route('login');
|
|
|
|
throw $exception;
|
|
}
|
|
|
|
/**
|
|
* Show the application's login form.
|
|
*
|
|
* @param Request $request
|
|
*
|
|
* @return Factory|Application|View|Redirector|RedirectResponse
|
|
* @throws FireflyException
|
|
*/
|
|
public function showLoginForm(Request $request)
|
|
{
|
|
Log::channel('audit')->info('Show login form (1.1).');
|
|
|
|
$count = DB::table('users')->count();
|
|
$guard = config('auth.defaults.guard');
|
|
$title = (string)trans('firefly.login_page_title');
|
|
|
|
if (0 === $count && 'web' === $guard) {
|
|
return redirect(route('register'));
|
|
}
|
|
|
|
// switch to LDAP settings:
|
|
if ('ldap' === $guard) {
|
|
Log::debug('User wishes to login using LDAP.');
|
|
$this->username = config('firefly.ldap_auth_field');
|
|
}
|
|
|
|
// throw warning if still using login_provider
|
|
$ldapWarning = false;
|
|
if ('ldap' === config('firefly.login_provider')) {
|
|
$ldapWarning = true;
|
|
}
|
|
// is allowed to register, etc.
|
|
$singleUserMode = app('fireflyconfig')->get('single_user_mode', config('firefly.configuration.single_user_mode'))->data;
|
|
$allowRegistration = true;
|
|
$allowReset = true;
|
|
if (true === $singleUserMode && $count > 0) {
|
|
$allowRegistration = false;
|
|
}
|
|
|
|
// single user mode is ignored when the user is not using eloquent:
|
|
if ('web' !== $guard) {
|
|
$allowRegistration = false;
|
|
$allowReset = false;
|
|
}
|
|
|
|
$email = $request->old('email');
|
|
$remember = $request->old('remember');
|
|
|
|
$storeInCookie = config('google2fa.store_in_cookie', false);
|
|
if (false !== $storeInCookie) {
|
|
$cookieName = config('google2fa.cookie_name', 'google2fa_token');
|
|
request()->cookies->set($cookieName, 'invalid');
|
|
}
|
|
$usernameField = $this->username();
|
|
|
|
return prefixView('auth.login', compact('allowRegistration', 'email', 'remember', 'ldapWarning', 'allowReset', 'title', 'usernameField'));
|
|
}
|
|
|
|
/**
|
|
* Get the login username to be used by the controller.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function username()
|
|
{
|
|
return $this->username;
|
|
}
|
|
}
|