-<?php namespace Tests;
+<?php namespace Tests\Auth;
+
+use BookStack\Auth\Access\LdapService;
use BookStack\Auth\Role;
use BookStack\Auth\Access\Ldap;
use BookStack\Auth\User;
use Mockery\MockInterface;
+use Tests\BrowserKitTest;
class LdapTest extends BrowserKitTest
{
{
parent::setUp();
if (!defined('LDAP_OPT_REFERRALS')) define('LDAP_OPT_REFERRALS', 1);
- app('config')->set([
+ config()->set([
'auth.method' => 'ldap',
+ 'auth.defaults.guard' => 'ldap',
'services.ldap.base_dn' => 'dc=ldap,dc=local',
'services.ldap.email_attribute' => 'mail',
'services.ldap.display_name_attribute' => 'cn',
+ 'services.ldap.id_attribute' => 'uid',
'services.ldap.user_to_groups' => false,
- 'auth.providers.users.driver' => 'ldap',
+ 'services.ldap.version' => '3',
+ 'services.ldap.user_filter' => '(&(uid=${user}))',
+ 'services.ldap.follow_referrals' => false,
+ 'services.ldap.tls_insecure' => false,
]);
$this->mockLdap = \Mockery::mock(Ldap::class);
$this->app[Ldap::class] = $this->mockLdap;
{
$this->mockLdap->shouldReceive('connect')->once()->andReturn($this->resourceId);
$this->mockLdap->shouldReceive('setVersion')->once();
- $this->mockLdap->shouldReceive('setOption')->times(4);
- $this->mockLdap->shouldReceive('searchAndGetEntries')->times(4)
+ $this->mockLdap->shouldReceive('setOption')->times(2);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(2)
->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
->andReturn(['count' => 1, 0 => [
'uid' => [$this->mockUser->name],
'cn' => [$this->mockUser->name],
'dn' => ['dc=test' . config('services.ldap.base_dn')]
]]);
- $this->mockLdap->shouldReceive('bind')->times(6)->andReturn(true);
- $this->mockEscapes(4);
+ $this->mockLdap->shouldReceive('bind')->times(4)->andReturn(true);
+ $this->mockEscapes(2);
$this->mockUserLogin()
->seePageIs('/login')->see('Please enter an email to use for this account.');
->seeInDatabase('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => $this->mockUser->name]);
}
- public function test_login_works_when_no_uid_provided_by_ldap_server()
+ public function test_email_domain_restriction_active_on_new_ldap_login()
{
+ $this->setSettings([
+ 'registration-restrict' => 'testing.com'
+ ]);
+
$this->mockLdap->shouldReceive('connect')->once()->andReturn($this->resourceId);
$this->mockLdap->shouldReceive('setVersion')->once();
- $ldapDn = 'cn=test-user,dc=test' . config('services.ldap.base_dn');
$this->mockLdap->shouldReceive('setOption')->times(2);
$this->mockLdap->shouldReceive('searchAndGetEntries')->times(2)
+ ->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
+ ->andReturn(['count' => 1, 0 => [
+ 'uid' => [$this->mockUser->name],
+ 'cn' => [$this->mockUser->name],
+ 'dn' => ['dc=test' . config('services.ldap.base_dn')]
+ ]]);
+ $this->mockLdap->shouldReceive('bind')->times(4)->andReturn(true);
+ $this->mockEscapes(2);
+
+ $this->mockUserLogin()
+ ->seePageIs('/login')
+ ->see('Please enter an email to use for this account.');
+
+
+ $this->type($email, '#email')
+ ->press('Log In')
+ ->seePageIs('/login')
+ ->see('That email domain does not have access to this application')
+ ->dontSeeInDatabase('users', ['email' => $email]);
+ }
+
+ public function test_login_works_when_no_uid_provided_by_ldap_server()
+ {
+ $this->mockLdap->shouldReceive('connect')->once()->andReturn($this->resourceId);
+ $this->mockLdap->shouldReceive('setVersion')->once();
+ $ldapDn = 'cn=test-user,dc=test' . config('services.ldap.base_dn');
+ $this->mockLdap->shouldReceive('setOption')->times(1);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(1)
->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
->andReturn(['count' => 1, 0 => [
'cn' => [$this->mockUser->name],
'dn' => $ldapDn,
'mail' => [$this->mockUser->email]
]]);
- $this->mockLdap->shouldReceive('bind')->times(3)->andReturn(true);
- $this->mockEscapes(2);
+ $this->mockLdap->shouldReceive('bind')->times(2)->andReturn(true);
+ $this->mockEscapes(1);
$this->mockUserLogin()
->seePageIs('/')
->seeInDatabase('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => $ldapDn]);
}
- public function test_initial_incorrect_details()
+ public function test_a_custom_uid_attribute_can_be_specified_and_is_used_properly()
{
+ config()->set(['services.ldap.id_attribute' => 'my_custom_id']);
$this->mockLdap->shouldReceive('connect')->once()->andReturn($this->resourceId);
$this->mockLdap->shouldReceive('setVersion')->once();
- $this->mockLdap->shouldReceive('setOption')->times(2);
- $this->mockLdap->shouldReceive('searchAndGetEntries')->times(2)
+ $ldapDn = 'cn=test-user,dc=test' . config('services.ldap.base_dn');
+ $this->mockLdap->shouldReceive('setOption')->times(1);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(1)
+ ->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
+ ->andReturn(['count' => 1, 0 => [
+ 'cn' => [$this->mockUser->name],
+ 'dn' => $ldapDn,
+ 'my_custom_id' => ['cooluser456'],
+ 'mail' => [$this->mockUser->email]
+ ]]);
+
+
+ $this->mockLdap->shouldReceive('bind')->times(2)->andReturn(true);
+ $this->mockEscapes(1);
+
+ $this->mockUserLogin()
+ ->seePageIs('/')
+ ->see($this->mockUser->name)
+ ->seeInDatabase('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => 'cooluser456']);
+ }
+
+ public function test_initial_incorrect_credentials()
+ {
+ $this->mockLdap->shouldReceive('connect')->once()->andReturn($this->resourceId);
+ $this->mockLdap->shouldReceive('setVersion')->once();
+ $this->mockLdap->shouldReceive('setOption')->times(1);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(1)
->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
->andReturn(['count' => 1, 0 => [
'uid' => [$this->mockUser->name],
'cn' => [$this->mockUser->name],
'dn' => ['dc=test' . config('services.ldap.base_dn')]
]]);
- $this->mockLdap->shouldReceive('bind')->times(3)->andReturn(true, true, false);
- $this->mockEscapes(2);
+ $this->mockLdap->shouldReceive('bind')->times(2)->andReturn(true, false);
+ $this->mockEscapes(1);
+
+ $this->mockUserLogin()
+ ->seePageIs('/login')->see('These credentials do not match our records.')
+ ->dontSeeInDatabase('users', ['external_auth_id' => $this->mockUser->name]);
+ }
+
+ public function test_login_not_found_username()
+ {
+ $this->mockLdap->shouldReceive('connect')->once()->andReturn($this->resourceId);
+ $this->mockLdap->shouldReceive('setVersion')->once();
+ $this->mockLdap->shouldReceive('setOption')->times(1);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(1)
+ ->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
+ ->andReturn(['count' => 0]);
+ $this->mockLdap->shouldReceive('bind')->times(1)->andReturn(true, false);
+ $this->mockEscapes(1);
$this->mockUserLogin()
->seePageIs('/login')->see('These credentials do not match our records.')
->dontSeeInDatabase('users', ['external_auth_id' => $this->mockUser->name]);
}
+
public function test_create_user_form()
{
$this->asAdmin()->visit('/settings/users/create')
'services.ldap.group_attribute' => 'memberOf',
'services.ldap.remove_from_groups' => false,
]);
- $this->mockLdap->shouldReceive('connect')->times(2)->andReturn($this->resourceId);
- $this->mockLdap->shouldReceive('setVersion')->times(2);
- $this->mockLdap->shouldReceive('setOption')->times(5);
- $this->mockLdap->shouldReceive('searchAndGetEntries')->times(5)
+ $this->mockLdap->shouldReceive('connect')->times(1)->andReturn($this->resourceId);
+ $this->mockLdap->shouldReceive('setVersion')->times(1);
+ $this->mockLdap->shouldReceive('setOption')->times(4);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(4)
->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
->andReturn(['count' => 1, 0 => [
'uid' => [$this->mockUser->name],
1 => "cn=ldaptester-second,ou=groups,dc=example,dc=com",
]
]]);
- $this->mockLdap->shouldReceive('bind')->times(6)->andReturn(true);
- $this->mockEscapes(5);
+ $this->mockLdap->shouldReceive('bind')->times(5)->andReturn(true);
+ $this->mockEscapes(4);
$this->mockExplodes(6);
$this->mockUserLogin()->seePageIs('/');
'services.ldap.group_attribute' => 'memberOf',
'services.ldap.remove_from_groups' => true,
]);
- $this->mockLdap->shouldReceive('connect')->times(2)->andReturn($this->resourceId);
- $this->mockLdap->shouldReceive('setVersion')->times(2);
- $this->mockLdap->shouldReceive('setOption')->times(4);
- $this->mockLdap->shouldReceive('searchAndGetEntries')->times(4)
+ $this->mockLdap->shouldReceive('connect')->times(1)->andReturn($this->resourceId);
+ $this->mockLdap->shouldReceive('setVersion')->times(1);
+ $this->mockLdap->shouldReceive('setOption')->times(3);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(3)
->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
->andReturn(['count' => 1, 0 => [
'uid' => [$this->mockUser->name],
0 => "cn=ldaptester,ou=groups,dc=example,dc=com",
]
]]);
- $this->mockLdap->shouldReceive('bind')->times(5)->andReturn(true);
- $this->mockEscapes(4);
+ $this->mockLdap->shouldReceive('bind')->times(4)->andReturn(true);
+ $this->mockEscapes(3);
$this->mockExplodes(2);
$this->mockUserLogin()->seePageIs('/');
'services.ldap.group_attribute' => 'memberOf',
'services.ldap.remove_from_groups' => true,
]);
- $this->mockLdap->shouldReceive('connect')->times(2)->andReturn($this->resourceId);
- $this->mockLdap->shouldReceive('setVersion')->times(2);
- $this->mockLdap->shouldReceive('setOption')->times(4);
- $this->mockLdap->shouldReceive('searchAndGetEntries')->times(4)
+ $this->mockLdap->shouldReceive('connect')->times(1)->andReturn($this->resourceId);
+ $this->mockLdap->shouldReceive('setVersion')->times(1);
+ $this->mockLdap->shouldReceive('setOption')->times(3);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(3)
->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
->andReturn(['count' => 1, 0 => [
'uid' => [$this->mockUser->name],
0 => "cn=ex-auth-a,ou=groups,dc=example,dc=com",
]
]]);
- $this->mockLdap->shouldReceive('bind')->times(5)->andReturn(true);
- $this->mockEscapes(4);
+ $this->mockLdap->shouldReceive('bind')->times(4)->andReturn(true);
+ $this->mockEscapes(3);
$this->mockExplodes(2);
$this->mockUserLogin()->seePageIs('/');
'services.ldap.group_attribute' => 'memberOf',
'services.ldap.remove_from_groups' => true,
]);
- $this->mockLdap->shouldReceive('connect')->times(2)->andReturn($this->resourceId);
- $this->mockLdap->shouldReceive('setVersion')->times(2);
- $this->mockLdap->shouldReceive('setOption')->times(5);
- $this->mockLdap->shouldReceive('searchAndGetEntries')->times(5)
+ $this->mockLdap->shouldReceive('connect')->times(1)->andReturn($this->resourceId);
+ $this->mockLdap->shouldReceive('setVersion')->times(1);
+ $this->mockLdap->shouldReceive('setOption')->times(4);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(4)
->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
->andReturn(['count' => 1, 0 => [
'uid' => [$this->mockUser->name],
1 => "cn=ldaptester-second,ou=groups,dc=example,dc=com",
]
]]);
- $this->mockLdap->shouldReceive('bind')->times(6)->andReturn(true);
- $this->mockEscapes(5);
+ $this->mockLdap->shouldReceive('bind')->times(5)->andReturn(true);
+ $this->mockEscapes(4);
$this->mockExplodes(6);
$this->mockUserLogin()->seePageIs('/');
$this->mockLdap->shouldReceive('connect')->once()->andReturn($this->resourceId);
$this->mockLdap->shouldReceive('setVersion')->once();
- $this->mockLdap->shouldReceive('setOption')->times(4);
- $this->mockLdap->shouldReceive('searchAndGetEntries')->times(4)
+ $this->mockLdap->shouldReceive('setOption')->times(2);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(2)
->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
->andReturn(['count' => 1, 0 => [
'uid' => [$this->mockUser->name],
'cn' => [$this->mockUser->name],
'dn' => ['dc=test' . config('services.ldap.base_dn')],
- 'displayName' => 'displayNameAttribute'
+ 'displayname' => 'displayNameAttribute'
]]);
- $this->mockLdap->shouldReceive('bind')->times(6)->andReturn(true);
- $this->mockEscapes(4);
+ $this->mockLdap->shouldReceive('bind')->times(4)->andReturn(true);
+ $this->mockEscapes(2);
$this->mockUserLogin()
->seePageIs('/login')->see('Please enter an email to use for this account.');
$this->mockLdap->shouldReceive('connect')->once()->andReturn($this->resourceId);
$this->mockLdap->shouldReceive('setVersion')->once();
- $this->mockLdap->shouldReceive('setOption')->times(4);
- $this->mockLdap->shouldReceive('searchAndGetEntries')->times(4)
+ $this->mockLdap->shouldReceive('setOption')->times(2);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(2)
->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
->andReturn(['count' => 1, 0 => [
'uid' => [$this->mockUser->name],
'cn' => [$this->mockUser->name],
'dn' => ['dc=test' . config('services.ldap.base_dn')]
]]);
- $this->mockLdap->shouldReceive('bind')->times(6)->andReturn(true);
- $this->mockEscapes(4);
+ $this->mockLdap->shouldReceive('bind')->times(4)->andReturn(true);
+ $this->mockEscapes(2);
$this->mockUserLogin()
->seePageIs('/login')->see('Please enter an email to use for this account.');
// Standard mocks
$this->mockLdap->shouldReceive('setVersion')->once();
- $this->mockLdap->shouldReceive('setOption')->times(2);
- $this->mockLdap->shouldReceive('searchAndGetEntries')->times(2)->andReturn(['count' => 1, 0 => [
+ $this->mockLdap->shouldReceive('setOption')->times(1);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(1)->andReturn(['count' => 1, 0 => [
'uid' => [$this->mockUser->name],
'cn' => [$this->mockUser->name],
'dn' => ['dc=test' . config('services.ldap.base_dn')]
]]);
- $this->mockLdap->shouldReceive('bind')->times(3)->andReturn(true);
- $this->mockEscapes(2);
+ $this->mockLdap->shouldReceive('bind')->times(2)->andReturn(true);
+ $this->mockEscapes(1);
$this->mockLdap->shouldReceive('connect')->once()
->with($expectedHost, $expectedPort)->andReturn($this->resourceId);
{
$this->checkLdapReceivesCorrectDetails('ldap.bookstack.com', 'ldap.bookstack.com', 389);
}
+
+ public function test_forgot_password_routes_inaccessible()
+ {
+ $resp = $this->get('/password/email');
+ $this->assertPermissionError($resp);
+
+ $resp = $this->post('/password/email');
+ $this->assertPermissionError($resp);
+
+ $resp = $this->get('/password/reset/abc123');
+ $this->assertPermissionError($resp);
+
+ $resp = $this->post('/password/reset');
+ $this->assertPermissionError($resp);
+ }
+
+ public function test_user_invite_routes_inaccessible()
+ {
+ $resp = $this->get('/register/invite/abc123');
+ $this->assertPermissionError($resp);
+
+ $resp = $this->post('/register/invite/abc123');
+ $this->assertPermissionError($resp);
+ }
+
+ public function test_user_register_routes_inaccessible()
+ {
+ $resp = $this->get('/register');
+ $this->assertPermissionError($resp);
+
+ $resp = $this->post('/register');
+ $this->assertPermissionError($resp);
+ }
+
+ public function test_dump_user_details_option_works()
+ {
+ config()->set(['services.ldap.dump_user_details' => true]);
+
+ $this->mockLdap->shouldReceive('connect')->once()->andReturn($this->resourceId);
+ $this->mockLdap->shouldReceive('setVersion')->once();
+ $this->mockLdap->shouldReceive('setOption')->times(1);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(1)
+ ->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), \Mockery::type('array'))
+ ->andReturn(['count' => 1, 0 => [
+ 'uid' => [$this->mockUser->name],
+ 'cn' => [$this->mockUser->name],
+ 'dn' => ['dc=test' . config('services.ldap.base_dn')]
+ ]]);
+ $this->mockLdap->shouldReceive('bind')->times(1)->andReturn(true);
+ $this->mockEscapes(1);
+
+ $this->post('/login', [
+ 'username' => $this->mockUser->name,
+ 'password' => $this->mockUser->password,
+ ]);
+ $this->seeJsonStructure([
+ 'details_from_ldap' => [],
+ 'details_bookstack_parsed' => [],
+ ]);
+ }
+
+ public function test_ldap_attributes_can_be_binary_decoded_if_marked()
+ {
+ config()->set(['services.ldap.id_attribute' => 'BIN;uid']);
+ $ldapService = app()->make(LdapService::class);
+
+ $this->mockLdap->shouldReceive('connect')->once()->andReturn($this->resourceId);
+ $this->mockLdap->shouldReceive('setVersion')->once();
+ $this->mockLdap->shouldReceive('setOption')->times(1);
+ $this->mockLdap->shouldReceive('searchAndGetEntries')->times(1)
+ ->with($this->resourceId, config('services.ldap.base_dn'), \Mockery::type('string'), ['cn', 'dn', 'uid', 'mail', 'cn'])
+ ->andReturn(['count' => 1, 0 => [
+ 'uid' => [hex2bin('FFF8F7')],
+ 'cn' => [$this->mockUser->name],
+ 'dn' => ['dc=test' . config('services.ldap.base_dn')]
+ ]]);
+ $this->mockLdap->shouldReceive('bind')->times(1)->andReturn(true);
+ $this->mockEscapes(1);
+
+ $details = $ldapService->getUserDetails('test');
+ $this->assertEquals('fff8f7', $details['uid']);
+ }
}
projects / bookstack / blobdiff