Warning: You are browsing the documentation for Symfony 2.4, which is no longer maintained.

Read the updated version of this page for Symfony 5.3 (the current stable version).

Using pre Authenticated Security Firewalls

2.4 version

Maintained

4.4 5.3 current 5.4 dev 6.0

Unmaintained

2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1 5.2

Using pre Authenticated Security Firewalls
- X.509 Client Certificate Authentication

Using pre Authenticated Security Firewalls¶

A lot of authentication modules are already provided by some web servers, including Apache. These modules generally set some environment variables that can be used to determine which user is accessing your application. Out of the box, Symfony supports most authentication mechanisms. These requests are called pre authenticated requests because the user is already authenticated when reaching your application.

X.509 Client Certificate Authentication¶

When using client certificates, your webserver is doing all the authentication process itself. With Apache, for example, you would use the SSLVerifyClient Require directive.

Enable the x509 authentication for a particular firewall in the security configuration:

YAML

# app/config/security.yml
security:
    firewalls:
        secured_area:
            pattern: ^/
            x509:
                provider: your_user_provider

XML

<?xml version="1.0" ?>
<!-- app/config/security.xml -->
<srv:container xmlns="http://symfony.com/schema/dic/security"
    xmlns:srv="http://symfony.com/schema/dic/services">

    <config>
        <firewall name="secured_area" pattern="^/">
            <x509 provider="your_user_provider"/>
        </firewall>
    </config>
</srv:container>

PHP

// app/config/security.php
$container->loadFromExtension('security', array(
    'firewalls' => array(
        'secured_area' => array(
            'pattern' => '^/'
            'x509'    => array(
                'provider' => 'your_user_provider',
            ),
        ),
    ),
));

By default, the firewall provides the SSL_CLIENT_S_DN_Email variable to the user provider, and sets the SSL_CLIENT_S_DN as credentials in the Symfony\Component\Security\Core\Authentication\Token\PreAuthenticatedToken. You can override these by setting the user and the credentials keys in the x509 firewall configuration respectively.

Note

An authentication provider will only inform the user provider of the username that made the request. You will need to create (or use) a “user provider” that is referenced by the provider configuration parameter (your_user_provider in the configuration example). This provider will turn the username into a User object of your choice. For more information on creating or configuring a user provider, see:

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