Skip to content

[Security] Tell about request_matcher #11574

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

Merged
merged 1 commit into from
Jun 21, 2019
Merged
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
80 changes: 69 additions & 11 deletions security/firewall_restriction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,26 @@
How to Restrict Firewalls to a Specific Request
===============================================

When using the Security component, you can create firewalls that match certain request options.
In most cases, matching against the URL is sufficient, but in special cases you can further
restrict the initialization of a firewall against other options of the request.
When using the Security component, firewalls will decide whether they handle a request based on the
result of a request matcher: the first firewall matching the request will handle it.

The last firewall can be configured without any matcher to handle every incoming request.

Restricting by Configuration
----------------------------

Most of the time you don't need to create matchers yourself as Symfony can do it for you based on the
firewall configuration.

.. note::

You can use any of these restrictions individually or mix them together to get
You can use any of the following restrictions individually or mix them together to get
your desired firewall configuration.

Restricting by Pattern
----------------------
Restricting by Path
~~~~~~~~~~~~~~~~~~~

This is the default restriction and restricts a firewall to only be initialized if the request URL
This is the default restriction and restricts a firewall to only be initialized if the request path
matches the configured ``pattern``.

.. configuration-block::
Expand Down Expand Up @@ -65,12 +72,12 @@ matches the configured ``pattern``.
]);

The ``pattern`` is a regular expression. In this example, the firewall will only be
activated if the URL starts (due to the ``^`` regex character) with ``/admin``. If
the URL does not match this pattern, the firewall will not be activated and subsequent
activated if the path starts (due to the ``^`` regex character) with ``/admin``. If
the path does not match this pattern, the firewall will not be activated and subsequent
firewalls will have the opportunity to be matched for this request.

Restricting by Host
-------------------
~~~~~~~~~~~~~~~~~~~

If matching against the ``pattern`` only is not enough, the request can also be matched against
``host``. When the configuration option ``host`` is set, the firewall will be restricted to
Expand Down Expand Up @@ -129,7 +136,7 @@ and subsequent firewalls will have the opportunity to be matched for this
request.

Restricting by HTTP Methods
---------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~

The configuration option ``methods`` restricts the initialization of the firewall to
the provided HTTP methods.
Expand Down Expand Up @@ -183,3 +190,54 @@ In this example, the firewall will only be activated if the HTTP method of the
request is either ``GET`` or ``POST``. If the method is not in the array of the
allowed methods, the firewall will not be activated and subsequent firewalls will again
have the opportunity to be matched for this request.

Restricting by Service
----------------------

If the above options don't fit your needs you can configure any service implementing
:class:`Symfony\\Component\\HttpFoundation\\RequestMatcherInterface` as ``request_matcher``.

.. configuration-block::

.. code-block:: yaml

# config/packages/security.yaml

# ...
security:
firewalls:
secured_area:
request_matcher: app.firewall.secured_area.request_matcher
# ...

.. code-block:: xml

<!-- 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
https://symfony.com/schema/dic/services/services-1.0.xsd">

<config>
<!-- ... -->
<firewall name="secured_area" request-matcher="app.firewall.secured_area.request_matcher">
<!-- ... -->
</firewall>
</config>
</srv:container>

.. code-block:: php

// config/packages/security.php

// ...
$container->loadFromExtension('security', [
'firewalls' => [
'secured_area' => [
'request_matcher' => 'app.firewall.secured_area.request_matcher',
// ...
],
],
]);