-<?php namespace Tests\Auth;
+<?php
-use BookStack\Auth\User;
-use BookStack\Entities\Page;
-use BookStack\Notifications\ConfirmEmail;
-use BookStack\Settings\SettingService;
-use Illuminate\Support\Facades\Notification;
-use Tests\BrowserKitTest;
+namespace Tests\Auth;
-class AuthTest extends BrowserKitTest
-{
+use BookStack\Access\Mfa\MfaSession;
+use Illuminate\Support\Facades\Hash;
+use Illuminate\Testing\TestResponse;
+use Tests\TestCase;
+class AuthTest extends TestCase
+{
public function test_auth_working()
{
- $this->visit('/')
- ->seePageIs('/login');
+ $this->get('/')->assertRedirect('/login');
}
public function test_login()
{
- ->seePageIs('/');
}
public function test_public_viewing()
{
- $settings = app(SettingService::class);
- $settings->put('app-public', 'true');
- $this->visit('/')
- ->seePageIs('/')
- ->see('Log In');
+ $this->setSettings(['app-public' => 'true']);
+ $this->get('/')
+ ->assertOk()
+ ->assertSee('Log in');
}
- public function test_registration_showing()
+ public function test_sign_up_link_on_login()
{
- // Ensure registration form is showing
+ $this->get('/login')->assertDontSee('Sign up');
+
$this->setSettings(['registration-enabled' => 'true']);
- $this->visit('/login')
- ->see('Sign up')
- ->click('Sign up')
- ->seePageIs('/register');
+
+ $this->get('/login')->assertSee('Sign up');
}
- public function test_normal_registration()
+ public function test_logout()
{
- // Set settings and get user instance
- $this->setSettings(['registration-enabled' => 'true']);
- $user = factory(User::class)->make();
-
- // Test form and ensure user is created
- $this->visit('/register')
- ->see('Sign Up')
- ->type($user->name, '#name')
- ->type($user->email, '#email')
- ->type($user->password, '#password')
- ->press('Create Account')
- ->seePageIs('/')
- ->see($user->name)
- ->seeInDatabase('users', ['name' => $user->name, 'email' => $user->email]);
+ $this->asAdmin()->get('/')->assertOk();
+ $this->post('/logout')->assertRedirect('/');
+ $this->get('/')->assertRedirect('/login');
}
- public function test_empty_registration_redirects_back_with_errors()
+ public function test_mfa_session_cleared_on_logout()
{
- // Set settings and get user instance
- $this->setSettings(['registration-enabled' => 'true']);
+ $user = $this->users->editor();
+ $mfaSession = $this->app->make(MfaSession::class);
- // Test form and ensure user is created
- $this->visit('/register')
- ->press('Create Account')
- ->see('The name field is required')
- ->seePageIs('/register');
+ $mfaSession->markVerifiedForUser($user);
+ $this->assertTrue($mfaSession->isVerifiedForUser($user));
+
+ $this->asAdmin()->post('/logout');
+ $this->assertFalse($mfaSession->isVerifiedForUser($user));
}
- public function test_registration_validation()
+ public function test_login_redirects_to_initially_requested_url_correctly()
{
- $this->setSettings(['registration-enabled' => 'true']);
+ config()->set('app.url', 'http://localhost');
+ $page = $this->entities->page();
- $this->visit('/register')
- ->type('1', '#name')
- ->type('1', '#email')
- ->type('1', '#password')
- ->press('Create Account')
- ->see('The name must be at least 2 characters.')
- ->see('The email must be a valid email address.')
- ->see('The password must be at least 8 characters.')
- ->seePageIs('/register');
+ $this->get($page->getUrl())->assertRedirect(url('/login'));
+ ->assertRedirect($page->getUrl());
}
- public function test_sign_up_link_on_login()
+ public function test_login_intended_redirect_does_not_redirect_to_external_pages()
{
- $this->visit('/login')
- ->dontSee('Sign up');
+ config()->set('app.url', 'http://localhost');
+ $this->setSettings(['app-public' => true]);
- $this->setSettings(['registration-enabled' => 'true']);
+ $this->get('/login', ['referer' => 'https://example.com']);
+ $login = $this->post('/login', ['email' => '
[email protected]', 'password' => 'password']);
- $this->visit('/login')
- ->see('Sign up');
+ $login->assertRedirect('http://localhost');
}
- public function test_confirmed_registration()
+ public function test_login_intended_redirect_does_not_factor_mfa_routes()
{
- // Fake notifications
- Notification::fake();
-
- // Set settings and get user instance
- $this->setSettings(['registration-enabled' => 'true', 'registration-confirmation' => 'true']);
- $user = factory(User::class)->make();
-
- // Go through registration process
- $this->visit('/register')
- ->see('Sign Up')
- ->type($user->name, '#name')
- ->type($user->email, '#email')
- ->type($user->password, '#password')
- ->press('Create Account')
- ->seePageIs('/register/confirm')
- ->seeInDatabase('users', ['name' => $user->name, 'email' => $user->email, 'email_confirmed' => false]);
-
- // Ensure notification sent
- $dbUser = User::where('email', '=', $user->email)->first();
- Notification::assertSentTo($dbUser, ConfirmEmail::class);
-
- // Test access and resend confirmation email
- $this->login($user->email, $user->password)
- ->seePageIs('/register/confirm/awaiting')
- ->see('Resend')
- ->visit('/books')
- ->seePageIs('/register/confirm/awaiting')
- ->press('Resend Confirmation Email');
-
- // Get confirmation and confirm notification matches
- $emailConfirmation = \DB::table('email_confirmations')->where('user_id', '=', $dbUser->id)->first();
- Notification::assertSentTo($dbUser, ConfirmEmail::class, function($notification, $channels) use ($emailConfirmation) {
- return $notification->token === $emailConfirmation->token;
- });
-
- // Check confirmation email confirmation activation.
- $this->visit('/register/confirm/' . $emailConfirmation->token)
- ->seePageIs('/')
- ->see($user->name)
- ->notSeeInDatabase('email_confirmations', ['token' => $emailConfirmation->token])
- ->seeInDatabase('users', ['name' => $dbUser->name, 'email' => $dbUser->email, 'email_confirmed' => true]);
+ $this->get('/books')->assertRedirect('/login');
+ $this->get('/mfa/setup')->assertRedirect('/login');
+ $login = $this->post('/login', ['email' => '
[email protected]', 'password' => 'password']);
+ $login->assertRedirect('/books');
}
- public function test_restricted_registration()
+ public function test_login_authenticates_admins_on_all_guards()
{
- $this->setSettings(['registration-enabled' => 'true', 'registration-confirmation' => 'true', 'registration-restrict' => 'example.com']);
- $user = factory(User::class)->make();
- // Go through registration process
- $this->visit('/register')
- ->type($user->name, '#name')
- ->type($user->email, '#email')
- ->type($user->password, '#password')
- ->press('Create Account')
- ->seePageIs('/register')
- ->dontSeeInDatabase('users', ['email' => $user->email])
- ->see('That email domain does not have access to this application');
-
-
- $this->visit('/register')
- ->type($user->name, '#name')
- ->type($user->email, '#email')
- ->type($user->password, '#password')
- ->press('Create Account')
- ->seePageIs('/register/confirm')
- ->seeInDatabase('users', ['name' => $user->name, 'email' => $user->email, 'email_confirmed' => false]);
-
- $this->visit('/')->seePageIs('/login')
- ->type($user->email, '#email')
- ->type($user->password, '#password')
- ->press('Log In')
- ->seePageIs('/register/confirm/awaiting')
- ->seeText('Email Address Not Confirmed');
+ $this->assertTrue(auth()->check());
+ $this->assertTrue(auth('ldap')->check());
+ $this->assertTrue(auth('saml2')->check());
+ $this->assertTrue(auth('oidc')->check());
}
- public function test_restricted_registration_with_confirmation_disabled()
+ public function test_login_authenticates_nonadmins_on_default_guard_only()
{
- $this->setSettings(['registration-enabled' => 'true', 'registration-confirmation' => 'false', 'registration-restrict' => 'example.com']);
- $user = factory(User::class)->make();
- // Go through registration process
- $this->visit('/register')
- ->type($user->name, '#name')
- ->type($user->email, '#email')
- ->type($user->password, '#password')
- ->press('Create Account')
- ->seePageIs('/register')
- ->dontSeeInDatabase('users', ['email' => $user->email])
- ->see('That email domain does not have access to this application');
-
-
- $this->visit('/register')
- ->type($user->name, '#name')
- ->type($user->email, '#email')
- ->type($user->password, '#password')
- ->press('Create Account')
- ->seePageIs('/register/confirm')
- ->seeInDatabase('users', ['name' => $user->name, 'email' => $user->email, 'email_confirmed' => false]);
-
- $this->visit('/')->seePageIs('/login')
- ->type($user->email, '#email')
- ->type($user->password, '#password')
- ->press('Log In')
- ->seePageIs('/register/confirm/awaiting')
- ->seeText('Email Address Not Confirmed');
- }
+ $editor = $this->users->editor();
+ $editor->password = bcrypt('password');
+ $editor->save();
- public function test_user_creation()
- {
- $user = factory(User::class)->make();
-
- $this->asAdmin()
- ->visit('/settings/users')
- ->click('Add New User')
- ->type($user->name, '#name')
- ->type($user->email, '#email')
- ->check('roles[admin]')
- ->type($user->password, '#password')
- ->type($user->password, '#password-confirm')
- ->press('Save')
- ->seePageIs('/settings/users')
- ->seeInDatabase('users', $user->toArray())
- ->see($user->name);
+ $this->post('/login', ['email' => $editor->email, 'password' => 'password']);
+ $this->assertTrue(auth()->check());
+ $this->assertFalse(auth('ldap')->check());
+ $this->assertFalse(auth('saml2')->check());
+ $this->assertFalse(auth('oidc')->check());
}
- public function test_user_updating()
+ public function test_failed_logins_are_logged_when_message_configured()
{
- $user = $this->getNormalUser();
- $password = $user->password;
- $this->asAdmin()
- ->visit('/settings/users')
- ->click($user->name)
- ->seePageIs('/settings/users/' . $user->id)
- ->see($user->email)
- ->type('Barry Scott', '#name')
- ->press('Save')
- ->seePageIs('/settings/users')
- ->seeInDatabase('users', ['id' => $user->id, 'name' => 'Barry Scott', 'password' => $password])
- ->notSeeInDatabase('users', ['name' => $user->name]);
- }
+ $log = $this->withTestLogger();
+ config()->set(['logging.failed_login.message' => 'Failed login for %u']);
- public function test_user_password_update()
- {
- $user = $this->getNormalUser();
- $userProfilePage = '/settings/users/' . $user->id;
- $this->asAdmin()
- ->visit($userProfilePage)
- ->type('newpassword', '#password')
- ->press('Save')
- ->seePageIs($userProfilePage)
- ->see('Password confirmation required')
-
- ->type('newpassword', '#password')
- ->type('newpassword', '#password-confirm')
- ->press('Save')
- ->seePageIs('/settings/users');
-
- $userPassword = User::find($user->id)->password;
- $this->assertTrue(\Hash::check('newpassword', $userPassword));
- }
+ $this->post('/login', ['email' => '
[email protected]', 'password' => 'cattreedog']);
+ $this->assertTrue($log->hasWarningThatContains('Failed login for
[email protected]'));
- public function test_user_deletion()
- {
- $userDetails = factory(User::class)->make();
- $user = $this->getEditor($userDetails->toArray());
-
- $this->asAdmin()
- ->visit('/settings/users/' . $user->id)
- ->click('Delete User')
- ->see($user->name)
- ->press('Confirm')
- ->seePageIs('/settings/users')
- ->notSeeInDatabase('users', ['name' => $user->name]);
+ $this->assertFalse($log->hasWarningThatContains('Failed login for
[email protected]'));
}
- public function test_user_cannot_be_deleted_if_last_admin()
+ public function test_logged_in_user_with_unconfirmed_email_is_logged_out()
{
- $adminRole = \BookStack\Auth\Role::getRole('admin');
-
- // Delete all but one admin user if there are more than one
- $adminUsers = $adminRole->users;
- if (count($adminUsers) > 1) {
- foreach ($adminUsers->splice(1) as $user) {
- $user->delete();
- }
- }
+ $this->setSettings(['registration-confirmation' => 'true']);
+ $user = $this->users->editor();
+ $user->email_confirmed = false;
+ $user->save();
- // Ensure we currently only have 1 admin user
- $this->assertEquals(1, $adminRole->users()->count());
- $user = $adminRole->users->first();
-
- $this->asAdmin()->visit('/settings/users/' . $user->id)
- ->click('Delete User')
- ->press('Confirm')
- ->seePageIs('/settings/users/' . $user->id)
- ->see('You cannot delete the only admin');
- }
+ auth()->login($user);
+ $this->assertTrue(auth()->check());
- public function test_logout()
- {
- $this->asAdmin()
- ->visit('/')
- ->seePageIs('/')
- ->visit('/logout')
- ->visit('/')
- ->seePageIs('/login');
+ $this->get('/books')->assertRedirect('/');
+ $this->assertFalse(auth()->check());
}
- public function test_reset_password_flow()
+ public function test_login_attempts_are_rate_limited()
{
+ for ($i = 0; $i < 5; $i++) {
+ }
+ $resp = $this->followRedirects($resp);
+ $resp->assertSee('These credentials do not match our records.');
- Notification::fake();
-
- $this->visit('/login')->click('Forgot Password?')
- ->seePageIs('/password/email')
- ->press('Send Reset Link')
-
- $this->seeInDatabase('password_resets', [
- ]);
-
-
- Notification::assertSentTo($user, \BookStack\Notifications\ResetPassword::class);
- $n = Notification::sent($user, \BookStack\Notifications\ResetPassword::class);
-
- $this->visit('/password/reset/' . $n->first()->token)
- ->see('Reset Password')
- ->submitForm('Reset Password', [
- 'password' => 'randompass',
- 'password_confirmation' => 'randompass'
- ])->seePageIs('/')
- ->see('Your password has been successfully reset');
+ // Check the fifth attempt provides a lockout response
+ $resp->assertSee('Too many login attempts. Please try again in');
}
- public function test_reset_password_page_shows_sign_links()
+ public function test_login_specifically_disabled_for_guest_account()
{
- $this->setSettings(['registration-enabled' => 'true']);
- $this->visit('/password/email')
- ->seeLink('Log in')
- ->seeLink('Sign up');
- }
+ $guest = $this->users->guest();
- public function test_login_redirects_to_initially_requested_url_correctly()
- {
- config()->set('app.url', 'http://localhost');
- $page = Page::query()->first();
+ $resp = $this->post('/login', ['email' => $guest->email, 'password' => 'password']);
+ $resp->assertRedirect('/login');
+ $resp = $this->followRedirects($resp);
+ $resp->assertSee('These credentials do not match our records.');
- $this->visit($page->getUrl())
- ->seePageUrlIs(url('/login'));
- ->seePageUrlIs($page->getUrl());
+ // Test login even with password somehow set
+ $guest->password = Hash::make('password');
+ $guest->save();
+
+ $resp = $this->post('/login', ['email' => $guest->email, 'password' => 'password']);
+ $resp->assertRedirect('/login');
+ $resp = $this->followRedirects($resp);
+ $resp->assertSee('These credentials do not match our records.');
}
/**
- * Perform a login
- * @param string $email
- * @param string $password
- * @return $this
+ * Perform a login.
*/
- protected function login($email, $password)
+ protected function login(string $email, string $password): TestResponse
{
- return $this->visit('/login')
- ->type($email, '#email')
- ->type($password, '#password')
- ->press('Log In');
+ return $this->post('/login', compact('email', 'password'));
}
}