Skip to content

Rewrite config form the Security bundle to use ConfigBuilders #15347

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.

Sign up for GitHub

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
May 19, 2021
Merged

Rewrite config form the Security bundle to use ConfigBuilders #15347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions configuration/env_var_processors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,15 +234,15 @@ Symfony provides the following env var processors:
.. code-block:: php

// config/packages/security.php
$container->setParameter('env(HEALTH_CHECK_METHOD)', 'Symfony\Component\HttpFoundation\Request::METHOD_HEAD');
$container->loadFromExtension('security', [
'access_control' => [
[
'path' => '^/health-check$',
'methods' => '%env(const:HEALTH_CHECK_METHOD)%',
],
],
]);
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Config\SecurityConfig;

return static function (ContainerBuilder $container, SecurityConfig $security) {
$container->setParameter('env(HEALTH_CHECK_METHOD)', 'Symfony\Component\HttpFoundation\Request::METHOD_HEAD');
$security->accessControl()
->path('^/health-check$')
->methods(['%env(const:HEALTH_CHECK_METHOD)%']);
};

``env(base64:FOO)``
Decodes the content of ``FOO``, which is a base64 encoded string.
Expand Down
131 changes: 64 additions & 67 deletions reference/configuration/security.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,39 +215,34 @@ hashing algorithm. Also, each algorithm defines different config options:

// config/packages/security.php
use App\Entity\User;
use Symfony\Config\SecurityConfig;

$container->loadFromExtension('security', [
return static function (SecurityConfig $security) {
// ...
'password_hashers' => [
// auto hasher with default options
User::class => [
'algorithm' => 'auto',
],

// auto hasher with custom options
User::class => [
'algorithm' => 'auto',
'cost' => 15,
],

// Sodium hasher with default options
User::class => [
'algorithm' => 'sodium',
],

// Sodium hasher with custom options
User::class => [
'algorithm' => 'sodium',
'memory_cost' => 16384, // Amount in KiB. (16384 = 16 MiB)
'time_cost' => 2, // Number of iterations
],

// MessageDigestPasswordHasher hasher using SHA512 hashing with default options
User::class => [
'algorithm' => 'sha512',
],
],
]);

// auto hasher with default options
$security->passwordHasher(User::class)
->algorithm('auto');

// auto hasher with custom options
$security->passwordHasher(User::class)
->algorithm('auto')
->cost(15);

// Sodium hasher with default options
$security->passwordHasher(User::class)
->algorithm('sodium');

// Sodium hasher with custom options
$security->passwordHasher(User::class)
->algorithm('sodium')
->memoryCost(16384) // Amount in KiB. (16384 = 16 MiB)
->timeCost(2); // Number of iterations

// MessageDigestPasswordHasher hasher using SHA512 hashing with default options
$security->passwordHasher(User::class)
->algorithm('sha512');
};

.. versionadded:: 5.3

Expand Down Expand Up @@ -310,18 +305,19 @@ hashing algorithm. Also, each algorithm defines different config options:

// config/packages/test/security.php
use App\Entity\User;
use Symfony\Config\SecurityConfig;

return static function (SecurityConfig $security) {
// ...

$container->loadFromExtension('security', [
'password_hashers' => [
// Use your user class name here
User::class => [
'algorithm' => 'auto', // This should be the same value as in config/packages/security.yaml
'cost' => 4, // Lowest possible value for bcrypt
'time_cost' => 3, // Lowest possible value for argon
'memory_cost' => 10, // Lowest possible value for argon
]
],
]);
// Use your user class name here
$security->passwordHasher(User::class)
->algorithm('auto') // This should be the same value as in config/packages/security.yaml
->cost(4) // Lowest possible value for bcrypt
->timeCost(2) // Lowest possible value for argon
->memoryCost(10) // Lowest possible value for argon
;
};

.. _reference-security-sodium:
.. _using-the-argon2i-password-encoder:
Expand Down Expand Up @@ -432,20 +428,20 @@ application:
.. code-block:: php

// config/packages/security.php
use Symfony\Config\SecurityConfig;

return static function (SecurityConfig $security) {
// ...

// ...
$container->loadFromExtension('security', [
'firewalls' => [
// 'main' is the name of the firewall (can be chosen freely)
'main' => [
// 'pattern' is a regular expression matched against the incoming
// request URL. If there's a match, authentication is triggered
'pattern' => '^/admin',
// the rest of options depend on the authentication mechanism
// ...
],
],
]);
// 'main' is the name of the firewall (can be chosen freely)
$security->firewall('main')
// 'pattern' is a regular expression matched against the incoming
// request URL. If there's a match, authentication is triggered
->pattern('^/admin')
// the rest of options depend on the authentication mechanism
// ...
;
};

.. seealso::

Expand Down Expand Up @@ -807,18 +803,19 @@ multiple firewalls, the "context" could actually be shared:
.. code-block:: php

// config/packages/security.php
$container->loadFromExtension('security', [
'firewalls' => [
'somename' => [
// ...
'context' => 'my_context',
],
'othername' => [
// ...
'context' => 'my_context',
],
],
]);
use Symfony\Config\SecurityConfig;

return static function (SecurityConfig $security) {
$security->firewall('somename')
// ...
->context('my_context')
;

$security->firewall('othername')
// ...
->context('my_context')
;
};

.. note::

Expand Down
Loading