colin
/
bookstack
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

LDAP: Review and testing of mulitple-display-name attr support 

Review of #5295
Added test to cover functionality.
Moved splitting from config to service.
This commit is contained in:
Dan Brown 2024-12-01 18:42:54 +00:00
parent 87242ce6cb
commit 90341e0e00
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
3 changed files with 45 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
app/Access/LdapService.php
View File

@ -72,25 +72,23 @@ class LdapService
} }
/** /**
* Calculate the display name. * Build the user display name from the (potentially multiple) attributes defined by the configuration.
*/ */
protected function getUserDisplayName(array $displayNameAttr, array $userDetails, string $defaultValue): string protected function getUserDisplayName(array $userDetails, array $displayNameAttrs, string $defaultValue): string
{ {
$displayName = []; $displayNameParts = [];
foreach ($displayNameAttr as $dnAttr) { foreach ($displayNameAttrs as $dnAttr) {
$dnComponent = $this->getUserResponseProperty($userDetails, $dnAttr, null); $dnComponent = $this->getUserResponseProperty($userDetails, $dnAttr, null);
if ($dnComponent !== null) { if ($dnComponent) {
$displayName[] = $dnComponent; $displayNameParts[] = $dnComponent;
} }
} }
if (count($displayName) == 0) { if (empty($displayNameParts)) {
$displayName = $defaultValue; return $defaultValue;
} else {
$displayName = implode(' ', $displayName);
} }
return $displayName; return implode(' ', $displayNameParts);
} }
/** /**
@ -103,12 +101,12 @@ class LdapService
{ {
$idAttr = $this->config['id_attribute']; $idAttr = $this->config['id_attribute'];
$emailAttr = $this->config['email_attribute']; $emailAttr = $this->config['email_attribute'];
$displayNameAttr = $this->config['display_name_attribute']; $displayNameAttrs = explode('|', $this->config['display_name_attribute']);
$thumbnailAttr = $this->config['thumbnail_attribute']; $thumbnailAttr = $this->config['thumbnail_attribute'];
$user = $this->getUserWithAttributes($userName, array_filter(array_merge($displayNameAttr, [ $user = $this->getUserWithAttributes($userName, array_filter([
'cn', 'dn', $idAttr, $emailAttr, $thumbnailAttr, 'cn', 'dn', $idAttr, $emailAttr, ...$displayNameAttrs, $thumbnailAttr,
]))); ]));
if (is_null($user)) { if (is_null($user)) {
return null; return null;
@ -117,7 +115,7 @@ class LdapService
$userCn = $this->getUserResponseProperty($user, 'cn', null); $userCn = $this->getUserResponseProperty($user, 'cn', null);
$formatted = [ $formatted = [
'uid' => $this->getUserResponseProperty($user, $idAttr, $user['dn']), 'uid' => $this->getUserResponseProperty($user, $idAttr, $user['dn']),
'name' => $this->getUserDisplayName($displayNameAttr, $user, $userCn), 'name' => $this->getUserDisplayName($user, $displayNameAttrs, $userCn),
'dn' => $user['dn'], 'dn' => $user['dn'],
'email' => $this->getUserResponseProperty($user, $emailAttr, null), 'email' => $this->getUserResponseProperty($user, $emailAttr, null),
'avatar' => $thumbnailAttr ? $this->getUserResponseProperty($user, $thumbnailAttr, null) : null, 'avatar' => $thumbnailAttr ? $this->getUserResponseProperty($user, $thumbnailAttr, null) : null,

2
app/Config/services.php
View File

@ -127,7 +127,7 @@ return [
'version' => env('LDAP_VERSION', false), 'version' => env('LDAP_VERSION', false),
'id_attribute' => env('LDAP_ID_ATTRIBUTE', 'uid'), 'id_attribute' => env('LDAP_ID_ATTRIBUTE', 'uid'),
'email_attribute' => env('LDAP_EMAIL_ATTRIBUTE', 'mail'), 'email_attribute' => env('LDAP_EMAIL_ATTRIBUTE', 'mail'),
'display_name_attribute' => explode('|', env('LDAP_DISPLAY_NAME_ATTRIBUTE', 'cn')), 'display_name_attribute' => env('LDAP_DISPLAY_NAME_ATTRIBUTE', 'cn'),
'follow_referrals' => env('LDAP_FOLLOW_REFERRALS', false), 'follow_referrals' => env('LDAP_FOLLOW_REFERRALS', false),
'user_to_groups' => env('LDAP_USER_TO_GROUPS', false), 'user_to_groups' => env('LDAP_USER_TO_GROUPS', false),
'group_attribute' => env('LDAP_GROUP_ATTRIBUTE', 'memberOf'), 'group_attribute' => env('LDAP_GROUP_ATTRIBUTE', 'memberOf'),

33
tests/Auth/LdapTest.php
View File

@ -29,7 +29,7 @@ class LdapTest extends TestCase
'auth.defaults.guard' => 'ldap', 'auth.defaults.guard' => 'ldap',
'services.ldap.base_dn' => 'dc=ldap,dc=local', 'services.ldap.base_dn' => 'dc=ldap,dc=local',
'services.ldap.email_attribute' => 'mail', 'services.ldap.email_attribute' => 'mail',
'services.ldap.display_name_attribute' => ['cn'], 'services.ldap.display_name_attribute' => 'cn',
'services.ldap.id_attribute' => 'uid', 'services.ldap.id_attribute' => 'uid',
'services.ldap.user_to_groups' => false, 'services.ldap.user_to_groups' => false,
'services.ldap.version' => '3', 'services.ldap.version' => '3',
@ -581,7 +581,7 @@ class LdapTest extends TestCase
public function test_login_uses_specified_display_name_attribute() public function test_login_uses_specified_display_name_attribute()
{ {
app('config')->set([ app('config')->set([
'services.ldap.display_name_attribute' => ['displayName'], 'services.ldap.display_name_attribute' => 'displayName',
]); ]);
$this->commonLdapMocks(1, 1, 2, 4, 2); $this->commonLdapMocks(1, 1, 2, 4, 2);
@ -603,10 +603,37 @@ class LdapTest extends TestCase
$this->assertDatabaseHas('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => $this->mockUser->name, 'name' => 'displayNameAttribute']); $this->assertDatabaseHas('users', ['email' => $this->mockUser->email, 'email_confirmed' => false, 'external_auth_id' => $this->mockUser->name, 'name' => 'displayNameAttribute']);
} }
public function test_login_uses_multiple_display_properties_if_defined()
{
app('config')->set([
'services.ldap.display_name_attribute' => 'firstname|middlename|noname|lastname',
]);
$this->commonLdapMocks(1, 1, 1, 2, 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'),
'firstname' => ['Barry'],
'middlename' => ['Elliott'],
'lastname' => ['Chuckle'],
'mail' => [$this->mockUser->email],
]]);
$this->mockUserLogin();
$this->assertDatabaseHas('users', [
'email' => $this->mockUser->email,
'name' => 'Barry Elliott Chuckle',
]);
}
public function test_login_uses_default_display_name_attribute_if_specified_not_present() public function test_login_uses_default_display_name_attribute_if_specified_not_present()
{ {
app('config')->set([ app('config')->set([
'services.ldap.display_name_attribute' => ['displayName'], 'services.ldap.display_name_attribute' => 'displayName',
]); ]);
$this->commonLdapMocks(1, 1, 2, 4, 2); $this->commonLdapMocks(1, 1, 2, 4, 2);