WARNING: You are browsing the documentation for Symfony 4.1 which is not maintained anymore. Consider upgrading your projects to Symfony 5.0.

The Firewall and Authorization

4.1 version

Maintained

3.4 4.3 4.4 5.0 current 5.1 master

Unmaintained

2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 4.0 4.2

The Firewall and Authorization
- A Firewall for HTTP Requests
- Flow: Firewall, Authentication, Authorization

The Firewall and Authorization¶

Central to the Security component is authorization. This is handled by an instance of AuthorizationCheckerInterface. When all steps in the process of authenticating the user have been taken successfully, you can ask the authorization checker if the authenticated user has access to a certain action or resource of the application:

use Symfony\Component\Security\Core\Authorization\AuthorizationChecker;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;

// instance of Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface
$tokenStorage = ...;

// instance of Symfony\Component\Security\Core\Authentication\AuthenticationManagerInterface
$authenticationManager = ...;

// instance of Symfony\Component\Security\Core\Authorization\AccessDecisionManagerInterface
$accessDecisionManager = ...;

$authorizationChecker = new AuthorizationChecker(
    $tokenStorage,
    $authenticationManager,
    $accessDecisionManager
);

// ... authenticate the user

if (!$authorizationChecker->isGranted('ROLE_ADMIN')) {
    throw new AccessDeniedException();
}

Note

Read the dedicated articles to learn more about Authentication and Authorization.

A Firewall for HTTP Requests¶

Authenticating a user is done by the firewall. An application may have multiple secured areas, so the firewall is configured using a map of these secured areas. For each of these areas, the map contains a request matcher and a collection of listeners. The request matcher gives the firewall the ability to find out if the current request points to a secured area. The listeners are then asked if the current request can be used to authenticate the user:

use Symfony\Component\Security\Http\FirewallMap;
use Symfony\Component\HttpFoundation\RequestMatcher;
use Symfony\Component\Security\Http\Firewall\ExceptionListener;

$firewallMap = new FirewallMap();

$requestMatcher = new RequestMatcher('^/secured-area/');

// instances of Symfony\Component\Security\Http\Firewall\ListenerInterface
$listeners = [...];

$exceptionListener = new ExceptionListener(...);

$firewallMap->add($requestMatcher, $listeners, $exceptionListener);

The firewall map will be given to the firewall as its first argument, together with the event dispatcher that is used by the HttpKernel:

use Symfony\Component\Security\Http\Firewall;
use Symfony\Component\HttpKernel\KernelEvents;

// the EventDispatcher used by the HttpKernel
$dispatcher = ...;

$firewall = new Firewall($firewallMap, $dispatcher);

$dispatcher->addListener(
    KernelEvents::REQUEST,
    [$firewall, 'onKernelRequest']
);

The firewall is registered to listen to the kernel.request event that will be dispatched by the HttpKernel at the beginning of each request it processes. This way, the firewall may prevent the user from going any further than allowed.

Firewall Config¶

The information about a given firewall, such as its name, provider, context, entry point and access denied URL, is provided by instances of the FirewallConfig class.

This object can be accessed through the getFirewallConfig(Request $request) method of the FirewallMap class and through the getConfig() method of the FirewallContext class.

Firewall Listeners¶

When the firewall gets notified of the kernel.request event, it asks the firewall map if the request matches one of the secured areas. The first secured area that matches the request will return a set of corresponding firewall listeners (which each implement ListenerInterface). These listeners will all be asked to handle the current request. This basically means: find out if the current request contains any information by which the user might be authenticated (for instance the Basic HTTP authentication listener checks if the request has a header called PHP_AUTH_USER).

Exception Listener¶

If any of the listeners throws an AuthenticationException, the exception listener that was provided when adding secured areas to the firewall map will jump in.

The exception listener determines what happens next, based on the arguments it received when it was created. It may start the authentication procedure, perhaps ask the user to supply their credentials again (when they have only been authenticated based on a "remember-me" cookie), or transform the exception into an AccessDeniedHttpException, which will eventually result in an "HTTP/1.1 403: Access Denied" response.

Entry Points¶

When the user is not authenticated at all (i.e. when the token storage has no token yet), the firewall's entry point will be called to "start" the authentication process. An entry point should implement AuthenticationEntryPointInterface, which has only one method: start(). This method receives the current Request object and the exception by which the exception listener was triggered. The method should return a Response object. This could be, for instance, the page containing the login form or, in the case of Basic HTTP authentication, a response with a WWW-Authenticate header, which will prompt the user to supply their username and password.

Flow: Firewall, Authentication, Authorization¶

Hopefully you can now see a little bit about how the "flow" of the security context works:

The Firewall is registered as a listener on the kernel.request event;
At the beginning of the request, the Firewall checks the firewall map to see if any firewall should be active for this URL;
If a firewall is found in the map for this URL, its listeners are notified;
Each listener checks to see if the current request contains any authentication information - a listener may (a) authenticate a user, (b) throw an AuthenticationException, or (c) do nothing (because there is no authentication information on the request);
Once a user is authenticated, you'll use Authorization to deny access to certain resources.

Read the next articles to find out more about Authentication and Authorization.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.