8000 [2.8] Add "How to Use Multiple Guard Authenticators" cookbook documentation by marek-pietrzak-tg · Pull Request #5886 · symfony/symfony-docs · GitHub
[go: up one dir, main page]

Skip to content

[2.8] Add "How to Use Multiple Guard Authenticators" cookbook documentation #5886

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cookbook/map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@
* :doc:`/cookbook/security/csrf_in_login_form`
* :doc:`/cookbook/security/named_encoders`
* :doc:`/cookbook/security/multiple_user_providers`
* :doc:`/cookbook/security/multiple_guard_authenticators`
* :doc:`/cookbook/security/firewall_restriction`
* :doc:`/cookbook/security/host_restriction`
* :doc:`/cookbook/security/user_checkers`
Expand Down
1 change: 1 addition & 0 deletions cookbook/security/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Authentication (Identifying/Logging in the User)
csrf_in_login_form
named_encoders
multiple_user_providers
multiple_guard_authenticators
firewall_restriction
host_restriction
user_checkers
Expand Down
172 changes: 172 additions & 0 deletions cookbook/security/multiple_guard_authenticators.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
How to Use Multiple Guard Authenticators
========================================

.. versionadded:: 2.8
The ``Guard`` component was introduced in Symfony 2.8.

The Guard authentication component allows you to easily use many different
authenticators at a time.

An entry point is a service id (of one of your authenticators) whose
``start()`` method is called to start the authentication process.

Multiple Authenticators with Shared Entry Point
-----------------------------------------------

Sometimes you want to offer your users different authentication mechanisms like
a form login and a Facebook login while both entry points redirect the user to
the same login page.
However, in your configuration you have to explicitly say which entry point
you want to use.

This is how your security configuration can look in action:

.. configuration-block::

.. code-block:: yaml

# app/config/security.yml
security:
# ...
firewalls:
default:
anonymous: ~
guard:
authenticators:
- app.form_login_authenticator
- app.facebook_connect_authenticator
entry_point: app.form_login_authenticator

.. code-block:: xml

<!-- app/config/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="default">
<anonymous />
<guard entry-point="app.form_login_authenticator">
<authenticator>app.form_login_authenticator</authenticator>
<authenticator>app.facebook_connect_authenticator</authenticator>
</guard>
</firewall>
</config>
</srv:container>

.. code-block:: php

// app/config/security.php
$container->loadFromExtension('security', array(
// ...
'firewalls' => array(
'default' => array(
'anonymous' => null,
'guard' => array(
'entry_point' => 'app.form_login_authenticator',
'authenticators' => array(
'app.form_login_authenticator',
'app.facebook_connect_authenticator'
),
),
),
),
));

There is one limitation with this approach - you have to use exactly one entry point.

Multiple Authenticators with Separate Entry Points
--------------------------------------------------

However, there are use cases where you have authenticators that protect different
parts of your application. For example, you have a login form that protects
the secured area of your application front-end and API end points that are
protected with API tokens. As you can only configure one entry point per firewall,
the solution is to split the configuration into two separate firewalls:

.. configuration-block::

.. code-block:: yaml

# app/config/security.yml
security:
# ...
firewalls:
api:
pattern: ^/api/
guard:
authenticators:
- app.api_token_authenticator
default:
anonymous: ~
guard:
authenticators:
- app.form_login_authenticator
access_control:
- { path: ^/login, roles: IS_AUTHENTICATED_ANONYMOUSLY }
- { path: ^/api, roles: ROLE_API_USER }
- { path: ^/, roles: ROLE_USER }

.. code-block:: xml

<!-- app/config/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-insta 8000 nce"
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="api" pattern="^/api/">
<guard>
<authenticator>app.api_token_authenticator</authenticator>
</guard>
</firewall>
<firewall name="default">
<anonymous />
<guard>
<authenticator>app.form_login_authenticator</authenticator>
</guard>
</firewall>
<rule path="^/login" role="IS_AUTHENTICATED_ANONYMOUSLY" />
<rule path="^/api" role="ROLE_API_USER" />
<rule path="^/" role="ROLE_USER" />
</config>
</srv:container>

.. code-block:: php

// app/config/security.php
$container->loadFromExtension('security', array(
// ...
'firewalls' => array(
'api' => array(
'pattern' => '^/api',
'guard' => array(
'authenticators' => array(
'app.api_token_authenticator',
),
),
),
'default' => array(
'anonymous' => null,
'guard' => array(
'authenticators' => array(
'app.form_login_authenticator',
),
),
),
),
'access_control' => array(
array('path' => '^/login', 'role' => 'IS_AUTHENTICATED_ANONYMOUSLY'),
array('path' => '^/api', 'role' => 'ROLE_API_USER'),
array('path' => '^/', 'role' => 'ROLE_USER'),
),
));
0