Skip to content

Commit 15aab3b

Browse files
SpomkySpomky
committed
[Security] Ability to add roles in form_login_ldap by ldap group
This update allows LDAP to fetch roles for a given user entry by using the new RoleFetcherInterface. The LdapUserProvider class has been adjusted to use this new functionality.
1 parent 9319a0c commit 15aab3b

File tree

12 files changed

+265
-4
lines changed

12 files changed

+265
-4
lines changed

‎src/Symfony/Bundle/SecurityBundle/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ CHANGELOG
88
* Add encryption support to `OidcTokenHandler` (JWE)
99
* Add `expose_security_errors` config option to display `AccountStatusException`
1010
* Deprecate the `security.hide_user_not_found` config option in favor of `security.expose_security_errors`
11+
* Add ability to fetch LDAP roles
1112

1213
7.2
1314
---

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/UserProvider/LdapFactory.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public function create(ContainerBuilder $container, string $id, array $config):
3232
->replaceArgument(1, $config['base_dn'])
3333
->replaceArgument(2, $config['search_dn'])
3434
->replaceArgument(3, $config['search_password'])
35-
->replaceArgument(4, $config['default_roles'])
35+
->replaceArgument(4, $config['role_fetcher'] ? new Reference($config['role_fetcher']) : $config['default_roles'])
3636
->replaceArgument(5, $config['uid_key'])
3737
->replaceArgument(6, $config['filter'])
3838
->replaceArgument(7, $config['password_attribute'])
@@ -63,6 +63,7 @@ public function addConfiguration(NodeDefinition $node): void
6363
->requiresAtLeastOneElement()
6464
->prototype('scalar')->end()
6565
->end()
66+
->scalarNode('role_fetcher')->defaultNull()->end()
6667
->scalarNode('uid_key')->defaultValue('sAMAccountName')->end()
6768
->scalarNode('filter')->defaultValue('({uid_key}={user_identifier})')->end()
6869
->scalarNode('password_attribute')->defaultNull()->end()

‎src/Symfony/Bundle/SecurityBundle/Tests/Functional/Bundle/JsonLdapLoginBundle/Controller/TestController.php

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Bundle\SecurityBundle\Tests\Functional\Bundle\JsonLdapLoginBundle\Controller;
13+
14+
use Symfony\Component\HttpFoundation\JsonResponse;
15+
use Symfony\Component\Security\Core\User\UserInterface;
16+
17+
class TestController
18+
{
19+
public function loginCheckAction(UserInterface $user)
20+
{
21+
return new JsonResponse([
22+
'message' => \sprintf('Welcome @%s!', $user->getUserIdentifier()),
23+
'roles' => $user->getRoles(),
24+
]);
25+
}
26+
}

‎src/Symfony/Bundle/SecurityBundle/Tests/Functional/JsonLoginLdapTest.php

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,14 @@
1111

1212
namespace Symfony\Bundle\SecurityBundle\Tests\Functional;
1313

14+
use Symfony\Component\HttpFoundation\JsonResponse;
1415
use Symfony\Component\HttpKernel\Kernel;
16+
use Symfony\Component\Ldap\Adapter\AdapterInterface;
17+
use Symfony\Component\Ldap\Adapter\CollectionInterface;
18+
use Symfony\Component\Ldap\Adapter\ConnectionInterface;
19+
use Symfony\Component\Ldap\Adapter\ExtLdap\Adapter;
20+
use Symfony\Component\Ldap\Adapter\QueryInterface;
21+
use Symfony\Component\Ldap\Entry;
1522

1623
class JsonLoginLdapTest extends AbstractWebTestCase
1724
{
@@ -22,4 +29,45 @@ public function testKernelBoot()
2229

2330
$this->assertInstanceOf(Kernel::class, $kernel);
2431
}
32+
33+
public function testDefaultJsonLdapLoginSuccess()
34+
{
35+
if (!class_exists(\Symfony\Component\Ldap\Security\RoleFetcherInterface::class)) {
36+
$this->markTestSkipped('The "LDAP" component does not support LDAP roles.');
37+
}
38+
// Given
39+
$client = $this->createClient(['test_case' => 'JsonLoginLdap', 'root_config' => 'config.yml', 'debug' => true]);
40+
$container = $client->getContainer();
41+
$connectionMock = $this->createMock(ConnectionInterface::class);
42+
$collection = new class([new Entry('', ['uid' => ['spomky']])]) extends \ArrayObject implements CollectionInterface {
43+
public function toArray(): array
44+
{
45+
return $this->getArrayCopy();
46+
}
47+
};
48+
$queryMock = $this->createMock(QueryInterface::class);
49+
$queryMock
50+
->method('execute')
51+
->willReturn($collection)
52+
;
53+
$ldapAdapterMock = $this->createMock(AdapterInterface::class);
54+
$ldapAdapterMock
55+
->method('getConnection')
56+
->willReturn($connectionMock)
57+
;
58+
$ldapAdapterMock
59+
->method('createQuery')
60+
->willReturn($queryMock)
61+
;
62+
$container->set(Adapter::class, $ldapAdapterMock);
63+
64+
// When
65+
$client->request('POST', '/login', [], [], ['CONTENT_TYPE' => 'application/json'], '{"user": {"login": "spomky", "password": "foo"}}');
66+
$response = $client->getResponse();
67+
68+
// Then
69+
$this->assertInstanceOf(JsonResponse::class, $response);
70+
$this->assertSame(200, $response->getStatusCode());
71+
$this->assertSame(['message' => 'Welcome @spomky!', 'roles' => ['ROLE_SUPER_ADMIN', 'ROLE_USER']], json_decode($response->getContent(), true));
72+
}
2573
}

‎src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/JsonLoginLdap/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ imports:
33
services:
44
Symfony\Component\Ldap\Ldap:
55
arguments: ['@Symfony\Component\Ldap\Adapter\ExtLdap\Adapter']
6+
tags: [ 'ldap' ]
67

78
Symfony\Component\Ldap\Adapter\ExtLdap\Adapter:
89
arguments:
@@ -21,7 +22,6 @@ security:
2122
search_password: ''
2223
default_roles: ROLE_USER
2324
uid_key: uid
24-
extra_fields: ['email']
2525

2626
firewalls:
2727
main:

‎src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/JsonLoginLdap/routing.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
login_check:
2+
path: /login
3+
defaults: { _controller: Symfony\Bundle\SecurityBundle\Tests\Functional\Bundle\JsonLdapLoginBundle\Controller\TestController::loginCheckAction }

‎src/Symfony/Component/Ldap/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ CHANGELOG
55
---
66

77
* Deprecate `LdapUser::eraseCredentials()` in favor of `__serialize()`
8+
* Add `RoleFetcherInterface` to allow roles fetching at user loading
9+
* Add ability to fetch LDAP roles
810

911
7.2
1012
---

‎src/Symfony/Component/Ldap/Security/AssignDefaultRoles.php

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Ldap\Security;
13+
14+
use Symfony\Component\Ldap\Entry;
15+
16+
final readonly class AssignDefaultRoles implements RoleFetcherInterface
17+
{
18+
/**
19+
* @param string[] $roles
20+
*/
21+
public function __construct(
22+
private array $roles,
23+
) {
24+
}
25+
26+
/**
27+
* @return string[]
28+
*/
29+
public function fetchRoles(Entry $entry): array
30+
{
31+
return $this->roles;
32+
}
33+
}

‎src/Symfony/Component/Ldap/Security/LdapUserProvider.php

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,14 @@ class LdapUserProvider implements UserProviderInterface, PasswordUpgraderInterfa
3737
{
3838
private string $uidKey;
3939
private string $defaultSearch;
40+
private RoleFetcherInterface $roleFetcher;
4041

4142
public function __construct(
4243
private LdapInterface $ldap,
4344
private string $baseDn,
4445
private ?string $searchDn = null,
4546
#[\SensitiveParameter] private ?string $searchPassword = null,
46-
private array $defaultRoles = [],
47+
array|RoleFetcherInterface $defaultRoles = [],
4748
?string $uidKey = null,
4849
?string $filter = null,
4950
private ?string $passwordAttribute = null,
@@ -54,6 +55,7 @@ public function __construct(
5455

5556
$this->uidKey = $uidKey;
5657
$this->defaultSearch = str_replace('{uid_key}', $uidKey, $filter);
58+
$this->roleFetcher = is_array($defaultRoles) ? new AssignDefaultRoles($defaultRoles) : $defaultRoles;
5759
}
5860

5961
public function loadUserByIdentifier(string $identifier): UserInterface
@@ -147,7 +149,9 @@ protected function loadUser(string $identifier, Entry $entry): UserInterface
147149
$extraFields[$field] = $this->getAttributeValue($entry, $field);
148150
}
149151

150-
return new LdapUser($entry, $identifier, $password, $this->defaultRoles, $extraFields);
152+
$roles = $this->roleFetcher->fetchRoles($entry);
153+
154+
return new LdapUser($entry, $identifier, $password, $roles, $extraFields);
151155
}
152156

153157
private function getAttributeValue(Entry $entry, string $attribute): mixed

‎src/Symfony/Component/Ldap/Security/MemberOfRoles.php

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Ldap\Security;
13+
14+
use Symfony\Component\Ldap\Entry;
15+
16+
final readonly class MemberOfRoles implements RoleFetcherInterface
17+
{
18+
/**
19+
* @param array<string, string> $mapping
20+
*/
21+
public function __construct(
22+
private array $mapping,
23+
private string $attributeName = 'ismemberof',
24+
private string $groupNameRegex = '/^CN=(?P<group>[^,]+),ou.*$/i',
25+
) {
26+
}
27+
28+
/**
29+
* @return string[]
30+
*/
31+
public function fetchRoles(Entry $entry): array
32+
{
33+
if (!$entry->hasAttribute($this->attributeName)) {
34+
return [];
35+
}
36+
37+
$roles = [];
38+
foreach ($entry->getAttribute($this->attributeName) as $group) {
39+
$groupName = $this->getGroupName($group);
40+
if (\array_key_exists($groupName, $this->mapping)) {
41+
$roles[] = $this->mapping[$groupName];
42+
}
43+
}
44+
45+
return array_unique($roles);
46+
}
47+
48+
private function getGroupName(string $group): string
49+
{
50+
if (preg_match($this->groupNameRegex, $group, $matches)) {
51+
return $matches['group'];
52+
}
53+
54+
return $group;
55+
}
56+
}

‎src/Symfony/Component/Ldap/Security/RoleFetcherInterface.php

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Ldap\Security;
13+
14+
use Symfony\Component\Ldap\Entry;
15+
16+
/**
17+
* Fetches LDAP roles for a given entry.
18+
*/
19+
interface RoleFetcherInterface
20+
{
21+
/**
22+
* @return string[] The list of roles
23+
*/
24+
public function fetchRoles(Entry $entry): array;
25+
}

‎src/Symfony/Component/Ldap/Tests/Security/LdapUserProviderTest.php

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
use Symfony\Component\Ldap\LdapInterface;
2020
use Symfony\Component\Ldap\Security\LdapUser;
2121
use Symfony\Component\Ldap\Security\LdapUserProvider;
22+
use Symfony\Component\Ldap\Security\MemberOfRoles;
23+
use Symfony\Component\Ldap\Security\RoleFetcherInterface;
2224
use Symfony\Component\Security\Core\Exception\InvalidArgumentException;
2325
use Symfony\Component\Security\Core\Exception\UserNotFoundException;
2426

@@ -388,4 +390,64 @@ public function testRefreshUserShouldReturnUserWithSameProperties()
388390

389391
$this->assertEquals($user, $provider->refreshUser($user));
390392
}
393+
394+
public function testLoadUserWithCorrectRoles()
395+
{
396+
// Given
397+
$result = $this->createMock(CollectionInterface::class);
398+
$query = $this->createMock(QueryInterface::class);
399+
$query
400+
->method('execute')
401+
->willReturn($result)
402+
;
403+
$ldap = $this->createMock(LdapInterface::class);
404+
$result
405+
->method('offsetGet')
406+
->with(0)
407+
->willReturn(new Entry('foo', ['sAMAccountName' => ['foo']]))
408+
;
409+
$result
410+
->method('count')
411+
->willReturn(1)
412+
;
413+
$ldap
414+
->method('escape')
415+
->willReturn('foo')
416+
;
417+
$ldap
418+
->method('query')
419+
->willReturn($query)
420+
;
421+
$roleFetcher = $this->createMock(RoleFetcherInterface::class);
422+
$roleFetcher
423+
->method('fetchRoles')
424+
->willReturn(['ROLE_FOO', 'ROLE_BAR'])
425+
;
426+
427+
$provider = new LdapUserProvider($ldap, 'ou=MyBusiness,dc=symfony,dc=com', defaultRoles: $roleFetcher);
428+
429+
// When
430+
$user = $provider->loadUserByIdentifier('foo');
431+
432+
// Then
433+
$this->assertInstanceOf(LdapUser::class, $user);
434+
$this->assertSame(['ROLE_FOO', 'ROLE_BAR'], $user->getRoles());
435+
}
436+
437+
public function testMemberOfRoleFetch()
438+
{
439+
// Given
440+
$roleFetcher = new MemberOfRoles(
441+
['Staff' => 'ROLE_STAFF', 'Admin' => 'ROLE_ADMIN'],
442+
'memberOf'
443+
);
444+
445+
$entry = new Entry('uid=elliot.alderson,ou=staff,ou=people,dc=example,dc=com', ['memberOf' => ['cn=Staff,ou=Groups,dc=example,dc=com', 'cn=Admin,ou=Groups,dc=example,dc=com']]);
446+
447+
// When
448+
$roles = $roleFetcher->fetchRoles($entry);
449+
450+
// Then
451+
$this->assertSame(['ROLE_STAFF', 'ROLE_ADMIN'], $roles);
452+
}
391453
}

0 commit comments

Comments
 (0)