Skip to content

[Security][Testing] Moved a performance tip to the main performance article #14864

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

Closed
wants to merge 1 commit into from
Closed

[Security][Testing] Moved a performance tip to the main performance article #14864

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
68 changes: 68 additions & 0 deletions performance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ for maximum performance:
* **Symfony Application Checklist**:

#. :ref:`Install APCu Polyfill if your server uses APC <performance-install-apcu-polyfill>`
#. :ref:`Hash passwords faster only for tests <performance-hash-passwords-faster>`

* **Production Server Checklist**:

Expand All @@ -37,6 +38,73 @@ OPcache, install the `APCu Polyfill component`_ in your application to enable
compatibility with `APCu PHP functions`_ and unlock support for advanced Symfony
features, such as the APCu Cache adapter.

.. _performance-hash-passwords-faster:

Hash Passwords Faster Only for Tests
------------------------------------

By default, :ref:`password encoders <security-encoding-user-password>` are
resource intensive and take time. This is important to generate secure password
hashes. In tests however, secure hashes are not important, so you can make your
tests faster changing the encoders configuration to generate password hashes as
fast as possible:

.. configuration-block::

.. code-block:: yaml

# config/packages/test/security.yaml
encoders:
# Use your user class name here
App\Entity\User:
algorithm: auto # This should be the same value as in config/packages/security.yaml
Copy link
Contributor

@OskarStark OskarStark Jan 21, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not proposing plaintext here, like done in @fabpot 's tweet? 🧐

cost: 4 # Lowest possible value for bcrypt
time_cost: 3 # Lowest possible value for argon
memory_cost: 10 # Lowest possible value for argon

.. code-block:: xml

<!-- config/packages/test/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>
<!-- class: Use your user class name here -->
<!-- algorithm: This should be the same value as in config/packages/security.yaml -->
<!-- cost: Lowest possible value for bcrypt -->
<!-- time_cost: Lowest possible value for argon -->
<!-- memory_cost: Lowest possible value for argon -->
<encoder
class="App\Entity\User"
algorithm="auto"
cost="4"
time_cost="3"
memory_cost="10"
/>
</config>
</srv:container>

.. code-block:: php

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

$container->loadFromExtension('security', [
'encoders' => [
// 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
]
],
]);

.. _performance-service-container-single-file:

Dump the Service Container into a Single File
Expand Down
64 changes: 0 additions & 64 deletions testing/http_authentication.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,70 +12,6 @@ OAuth authentication services.
This article explains some of the most popular techniques to avoid these issues
and create fast tests when using authentication.

Hashing Passwords Faster Only for Tests
---------------------------------------

By default, :ref:`password encoders <security-encoding-user-password>` are
resource intensive and take time. This is important to generate secure password
hashes. In tests however, secure hashes are not important, so you can change the
encoders configuration to generate password hashes as fast as possible:

.. configuration-block::

.. code-block:: yaml

# config/packages/test/security.yaml
encoders:
# Use your user class name here
App\Entity\User:
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

.. code-block:: xml

<!-- config/packages/test/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>
<!-- class: Use your user class name here -->
<!-- algorithm: This should be the same value as in config/packages/security.yaml -->
<!-- cost: Lowest possible value for bcrypt -->
<!-- time_cost: Lowest possible value for argon -->
<!-- memory_cost: Lowest possible value for argon -->
<encoder
class="App\Entity\User"
algorithm="auto"
cost="4"
time_cost="3"
memory_cost="10"
/>
</config>
</srv:container>

.. code-block:: php

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

$container->loadFromExtension('security', [
'encoders' => [
// 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
]
],
]);

Using a Faster Authentication Mechanism Only for Tests
------------------------------------------------------

Expand Down