How to Use multiple User Providers
How to Use multiple User Providers¶
Note
It’s always better to use a specific user provider for each authentication mechanism. Chaining user providers should be avoided in most applications and used only to solve edge cases.
Each authentication mechanism (e.g. HTTP Authentication, form login, etc.) uses exactly one user provider. But what if you want to specify a few users via configuration and the rest of your users in the database? This is possible by creating a new provider that chains the two together:
- YAML
1 2 3 4 5 6 7 8 9 10 11 12
# config/packages/security.yaml security: providers: chain_provider: chain: providers: [in_memory, user_db] in_memory: memory: users: foo: { password: test } user_db: entity: { class: App\Entity\User, property: username }
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
<!-- config/packages/security.xml --> <?xml version="1.0" encoding="UTF-8"?> <srv:container xmlns="http://symfony.com/schema/dic/security" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:srv="http://symfony.com/schema/dic/services" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd"> <config> <provider name="chain_provider"> <chain> <provider>in_memory</provider> <provider>user_db</provider> </chain> </provider> <provider name="in_memory"> <memory> <user name="foo" password="test" /> </memory> </provider> <provider name="user_db"> <entity class="App\Entity\User" property="username" /> </provider> </config> </srv:container>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
// config/packages/security.php use App\Entity\User; $container->loadFromExtension('security', array( 'providers' => array( 'chain_provider' => array( 'chain' => array( 'providers' => array('in_memory', 'user_db'), ), ), 'in_memory' => array( 'memory' => array( 'users' => array( 'foo' => array('password' => 'test'), ), ), ), 'user_db' => array( 'entity' => array( 'class' => User::class, 'property' => 'username', ), ), ), ));
Now, all firewalls that define chain_provider
as their user provider will,
in turn, try to load the user from both the in_memory
and user_db
providers.
You can also configure the firewall or individual authentication mechanisms to use a specific provider:
- YAML
1 2 3 4 5 6 7 8 9 10 11
# config/packages/security.yaml security: firewalls: secured_area: # ... pattern: ^/ provider: user_db http_basic: realm: 'Secured Demo Area' provider: in_memory form_login: ~
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
<!-- config/packages/security.xml --> <?xml version="1.0" encoding="UTF-8"?> <srv:container xmlns="http://symfony.com/schema/dic/security" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:srv="http://symfony.com/schema/dic/services" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd"> <config> <firewall name="secured_area" pattern="^/" provider="user_db"> <!-- ... --> <http-basic realm="Secured Demo Area" provider="in_memory" /> <form-login /> </firewall> </config> </srv:container>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
// config/packages/security.php $container->loadFromExtension('security', array( 'firewalls' => array( 'secured_area' => array( // ... 'pattern' => '^/', 'provider' => 'user_db', 'http_basic' => array( // ... 'realm' => 'Secured Demo Area', 'provider' => 'in_memory', ), 'form_login' => array(), ), ), ));
In this example, if a user tries to log in via HTTP authentication, the
authentication system will use the in_memory
user provider. But if the user
tries to log in via the form login, the user_db
provider will be used (since
it’s the default for the firewall as a whole).
If you need to check that the user being returned by your provider is a allowed to authenticate, check the returned user object:
use Symfony\Component\Security\Core\User;
// ...
public function loadUserByUsername($username)
{
// ...
// you can, for example, test that the returned user is an object of a
// particular class or check for certain attributes of your user objects
if ($user instance User) {
// the user was loaded from the main security config file. Do something.
// ...
}
return $user;
}
For more information about user provider and firewall configuration, see the Security Configuration Reference (SecurityBundle).
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.