3 namespace BookStack\Http\Controllers\Auth;
6 use BookStack\Actions\ActivityType;
7 use BookStack\Auth\Access\SocialAuthService;
8 use BookStack\Exceptions\LoginAttemptEmailNeededException;
9 use BookStack\Exceptions\LoginAttemptException;
10 use BookStack\Http\Controllers\Controller;
11 use Illuminate\Foundation\Auth\AuthenticatesUsers;
12 use Illuminate\Http\Request;
14 class LoginController extends Controller
17 |--------------------------------------------------------------------------
19 |--------------------------------------------------------------------------
21 | This controller handles authenticating users for the application and
22 | redirecting them to your home screen. The controller uses a trait
23 | to conveniently provide its functionality to your applications.
27 use AuthenticatesUsers;
32 protected $redirectTo = '/';
33 protected $redirectPath = '/';
34 protected $redirectAfterLogout = '/login';
36 protected $socialAuthService;
39 * Create a new controller instance.
41 public function __construct(SocialAuthService $socialAuthService)
43 $this->middleware('guest', ['only' => ['getLogin', 'login']]);
44 $this->middleware('guard:standard,ldap', ['only' => ['login', 'logout']]);
46 $this->socialAuthService = $socialAuthService;
47 $this->redirectPath = url('/');
48 $this->redirectAfterLogout = url('/login');
51 public function username()
53 return config('auth.method') === 'standard' ? 'email' : 'username';
57 * Get the needed authorization credentials from the request.
59 protected function credentials(Request $request)
61 return $request->only('username', 'email', 'password');
65 * Show the application login form.
67 public function getLogin(Request $request)
69 $socialDrivers = $this->socialAuthService->getActiveDrivers();
70 $authMethod = config('auth.method');
72 if ($request->has('email')) {
73 session()->flashInput([
74 'email' => $request->get('email'),
75 'password' => (config('app.env') === 'demo') ? $request->get('password', '') : ''
79 // Store the previous location for redirect after login
80 $previous = url()->previous('');
81 if ($previous && $previous !== url('/login') && setting('app-public')) {
82 $isPreviousFromInstance = (strpos($previous, url('/')) === 0);
83 if ($isPreviousFromInstance) {
84 redirect()->setIntendedUrl($previous);
88 return view('auth.login', [
89 'socialDrivers' => $socialDrivers,
90 'authMethod' => $authMethod,
95 * Handle a login request to the application.
97 * @param \Illuminate\Http\Request $request
98 * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\Response|\Illuminate\Http\JsonResponse
100 * @throws \Illuminate\Validation\ValidationException
102 public function login(Request $request)
104 $this->validateLogin($request);
105 $username = $request->get($this->username());
107 // If the class is using the ThrottlesLogins trait, we can automatically throttle
108 // the login attempts for this application. We'll key this by the username and
109 // the IP address of the client making these requests into this application.
110 if (method_exists($this, 'hasTooManyLoginAttempts') &&
111 $this->hasTooManyLoginAttempts($request)) {
112 $this->fireLockoutEvent($request);
114 Activity::logFailedLogin($username);
115 return $this->sendLockoutResponse($request);
119 if ($this->attemptLogin($request)) {
120 return $this->sendLoginResponse($request);
122 } catch (LoginAttemptException $exception) {
123 Activity::logFailedLogin($username);
124 return $this->sendLoginAttemptExceptionResponse($exception, $request);
127 // If the login attempt was unsuccessful we will increment the number of attempts
128 // to login and redirect the user back to the login form. Of course, when this
129 // user surpasses their maximum number of attempts they will get locked out.
130 $this->incrementLoginAttempts($request);
132 Activity::logFailedLogin($username);
133 return $this->sendFailedLoginResponse($request);
137 * The user has been authenticated.
139 * @param \Illuminate\Http\Request $request
143 protected function authenticated(Request $request, $user)
145 // Authenticate on all session guards if a likely admin
146 if ($user->can('users-manage') && $user->can('user-roles-manage')) {
147 $guards = ['standard', 'ldap', 'saml2'];
148 foreach ($guards as $guard) {
149 auth($guard)->login($user);
153 $this->logActivity(ActivityType::AUTH_LOGIN, $user);
154 return redirect()->intended($this->redirectPath());
158 * Validate the user login request.
160 * @param \Illuminate\Http\Request $request
163 * @throws \Illuminate\Validation\ValidationException
165 protected function validateLogin(Request $request)
167 $rules = ['password' => 'required|string'];
168 $authMethod = config('auth.method');
170 if ($authMethod === 'standard') {
171 $rules['email'] = 'required|email';
174 if ($authMethod === 'ldap') {
175 $rules['username'] = 'required|string';
176 $rules['email'] = 'email';
179 $request->validate($rules);
183 * Send a response when a login attempt exception occurs.
185 protected function sendLoginAttemptExceptionResponse(LoginAttemptException $exception, Request $request)
187 if ($exception instanceof LoginAttemptEmailNeededException) {
189 session()->flash('request-email', true);
192 if ($message = $exception->getMessage()) {
193 $this->showWarningNotification($message);
196 return redirect('/login');