8000 [Security] Allow in memory user to have extra fields · symfony/symfony@abf3545 · GitHub
[go: up one dir, main page]
Skip to content

Commit abf3545

Browse files
noniagriconomienoniagriconomie
committed
[Security] Allow in memory user to have extra fields
1 parent a8dcc92 commit abf3545

File tree

5 files changed

+19
-7
lines changed

5 files changed

+19
-7
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CHANGELOG
22
=========
33

4+
5.3.0
5+
-----
6+
7+
* Add a new `extra_fields` for the `memory` provider to allow extra fields for users
8+
49
5.2.0
510
-----
611

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/MainConfiguration.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ private function addProvidersSection(ArrayNodeDefinition $rootNode)
301301
'memory' => [
302302
'users' => [
303303
'foo' => ['password' => 'foo', 'roles' => 'ROLE_USER'],
304-
'bar' => ['password' => 'bar', 'roles' => '[ROLE_USER, ROLE_ADMIN]'],
304+
'bar' => ['password' => 'bar', 'roles' => ['ROLE_USER', 'ROLE_ADMIN'], 'extraFields' => ['name' => 'John', 'age' => 77]],
305305
],
306306
],
307307
],

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public function create(ContainerBuilder $container, string $id, array $config)
3131
$users = [];
3232

3333
foreach ($config['users'] as $username => $user) {
34-
$users[$username] = ['password' => null !== $user['password'] ? (string) $user['password'] : $defaultPassword, 'roles' => $user['roles']];
34+
$users[$username] = ['password' => null !== $user['password'] ? (string) $user['password'] : $defaultPassword, 'roles' => $user['roles'], 'extra_fields' => $user['extra_fields']];
3535
}
3636

3737
$definition->addArgument($users);
@@ -57,6 +57,9 @@ public function addConfiguration(NodeDefinition $node)
5757
->beforeNormalization()->ifString()->then(function ($v) { return preg_split('/\s*,\s*/', $v); })->end()
5858
->prototype('scalar')->end()
5959
->end()
60+
->arrayNode('extra_fields')
61+
->prototype('scalar')->end()
62+
->end()
6063
->end()
6164
->end()
6265
->end()

‎src/Symfony/Component/Security/Core/Tests/User/InMemoryUserProviderTest.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ public function testConstructor()
2525
$user = $provider->loadUserByUsername('fabien');
2626
$this->assertEquals('foo', $user->getPassword());
2727
$this->assertEquals(['ROLE_USER'], $user->getRoles());
28+
$this->assertEquals(['name' => 'John', 'age' => 77], $user->getExtraFields());
2829
$this->assertFalse($user->isEnabled());
2930
}
3031

@@ -37,6 +38,7 @@ public function testRefresh()
3738
$refreshedUser = $provider->refreshUser($user);
3839
$this->assertEquals('foo', $refreshedUser->getPassword());
3940
$this->assertEquals(['ROLE_USER'], $refreshedUser->getRoles());
41+
$this->assertEquals(['name' => 'John', 'age' => 77], $refreshedUser->getExtraFields());
4042
$this->assertFalse($refreshedUser->isEnabled());
4143
$this->assertFalse($refreshedUser->isCredentialsNonExpired());
4244
}
@@ -48,6 +50,7 @@ protected function createProvider(): InMemoryUserProvider
4850
'password' => 'foo',
4951
'enabled' => false,
5052
'roles' => ['ROLE_USER'],
53+
'extra_fields' => ['name' => 'John', 'age' => 77],
5154
],
5255
]);
5356
}

‎src/Symfony/Component/Security/Core/User/InMemoryUserProvider.php

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class InMemoryUserProvider implements UserProviderInterface
2828

2929
/**
3030
* The user array is a hash where the keys are usernames and the values are
31-
* an array of attributes: 'password', 'enabled', and 'roles'.
31+
* an array of attributes: 'password', 'enabled', 'roles' and 'extra_fields'.
3232
*
3333
* @param array $users An array of users
3434
*/
@@ -38,7 +38,8 @@ public function __construct(array $users = [])
3838
$password = $attributes['password'] ?? null;
3939
$enabled = $attributes['enabled'] ?? true;
4040
$roles = $attributes['roles'] ?? [];
41-
$user = new User($username, $password, $roles, $enabled, true, true, true);
41+
$extraFields = $attributes['extra_fields'] ?? [];
42+
$user = new User($username, $password, $roles, $enabled, true, true, true, $extraFields);
4243

4344
$this->createUser($user);
4445
}
@@ -65,7 +66,7 @@ public function loadUserByUsername(string $username)
6566
{
6667
$user = $this->getUser($username);
6768

68-
return new User($user->getUsername(), $user->getPassword(), $user->getRoles(), $user->isEnabled(), $user->isAccountNonExpired(), $user->isCredentialsNonExpired(), $user->isAccountNonLocked());
69+
return new User($user->getUsername(), $user->getPassword(), $user->getRoles(), $user->isEnabled(), $user->isAccountNonExpired(), $user->isCredentialsNonExpired(), $user->isAccountNonLocked(), $user->getExtraFields());
6970
}
7071

7172
/**
@@ -79,15 +80,15 @@ public function refreshUser(UserInterface $user)
7980

8081
$storedUser = $this->getUser($user->getUsername());
8182

82-
return new User($storedUser->getUsername(), $storedUser->getPassword(), $storedUser->getRoles(), $storedUser->isEnabled(), $storedUser->isAccountNonExpired(), $storedUser->isCredentialsNonExpired() && $storedUser->getPassword() === $user->getPassword(), $storedUser->isAccountNonLocked());
83+
return new User($storedUser->getUsername(), $storedUser->getPassword(), $storedUser->getRoles(), $storedUser->isEnabled(), $storedUser->isAccountNonExpired(), $storedUser->isCredentialsNonExpired() && $storedUser->getPassword() === $user->getPassword(), $storedUser->isAccountNonLocked(), $storedUser->getExtraFields());
8384
}
8485

8586
/**
8687
* {@inheritdoc}
8788
*/
8889
public function supportsClass(string $class)
8990
{
90-
return 'Symfony\Component\Security\Core\User\User' === $class;
91+
return User::class === $class;
9192
}
9293

9394
/**

0 commit comments

Comments
 (0)
0