-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[Cookbook][Security] Added doc for x509 pre authenticated listener #3913
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
6c9a204
[Cookbook][Security] x509 doc for pre authenticated listeners
f5a6d58
Added pre_authenticated to map.rst
83c40e9
Corrected pre_authenticated cookbook entry
01d18fe
fixing last issues in pre_authenticated cookbook entry
57cc957
full xml config, pushed the note at the end of the entry
mdouailin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
.. index:: | ||
single: Security; Pre authenticated providers | ||
|
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd reword this a bit:
|
||
|
||
Enable the x509 authentication for a particular firewall in the security configuration: | ||
|
||
.. configuration-block:: | ||
|
||
.. code-block:: yaml | ||
|
||
# app/config/security.yml | ||
security: | ||
firewalls: | ||
secured_area: | ||
pattern: ^/ | ||
x509: | ||
provider: your_user_provider | ||
|
||
.. code-block:: 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> | ||
|
||
.. code-block:: 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 | ||
:class:`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 | ||
turns that username into a User object of your choice: | ||
|
||
* :doc:`/cookbook/security/custom_provider` | ||
* :doc:`/cookbook/security/entity_provider` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This also needs to be added to
/cookbook/map.rst.inc
.