[Security] Add NativePasswordEncoder #31140

nicolas-grekas · 2019-04-17T09:57:54Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	-
License	MIT
Doc PR	-

This PR adds a new NativePasswordEncoder that defaults to the best available hashing algo to password_hash(). Best is determined by "us" or "php", the goal being that this will change in the future as new algos are published.

This provides a native encoder that we should recommend using by default.

nicolas-grekas · 2019-04-17T10:12:25Z

Todo:

fix tests
update SecurityExtension
find a default cost for Argon2 that is at least as good as 13 for Bcrypt's (any idea?)

src/Symfony/Component/Security/Core/Encoder/NativePasswordEncoder.php

ro0NL · 2019-04-17T10:46:44Z

is there any reason to keep BCryptPasswordEncoder?

nicolas-grekas · 2019-04-17T10:51:12Z

is there any reason to keep BCryptPasswordEncoder?

I don't think so, we should deprecate it in 4.4

nicolas-grekas

PR ready

nicolas-grekas · 2019-04-17T14:13:35Z

src/Symfony/Bundle/SecurityBundle/DependencyInjection/MainConfiguration.php

@@ -416,11 +416,14 @@ private function addEncodersSection(ArrayNodeDefinition $rootNode)
                            ->integerNode('cost')
                                ->min(4)
                                ->max(31)
-                                ->defaultValue(13)
+                                ->defaultNull()


The defaults belong to the implementation now, not to the configuration.

nicolas-grekas · 2019-04-17T14:14:01Z

src/Symfony/Bundle/SecurityBundle/DependencyInjection/MainConfiguration.php

                            ->end()
                            ->scalarNode('memory_cost')->defaultNull()->end()
                            ->scalarNode('time_cost')->defaultNull()->end()
-                            ->scalarNode('threads')->defaultNull()->end()
+                            ->scalarNode('threads')


libsodium hardcodes threads to 1, and this makes sense in PHP too.

nicolas-grekas · 2019-04-17T14:14:36Z

src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php

@@ -532,6 +533,10 @@ private function createEncoder($config, ContainerBuilder $container)
            return new Reference($config['id']);
        }

+        if ('auto' === $config['algorithm']) {


"auto" should be the recommended default - I'm going to submit it as a recipe

nicolas-grekas · 2019-04-17T14:15:32Z

src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php

+                'class' => NativePasswordEncoder::class,
+                'arguments' => [
+                    $config['time_cost'],
+                    (($config['memory_cost'] ?? 0) << 10) ?: null,


memory_cost (from password_hash) is in kib but SodiumPasswordEncoder and NativePasswordEncoder accept bytes - this makes the conversion

nicolas-grekas · 2019-04-17T14:18:20Z

src/Symfony/Component/Security/Core/Encoder/NativePasswordEncoder.php

+    {
+        $cost = $cost ?? 13;
+        $opsLimit = $opsLimit ?? max(6, \defined('SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE') ? \SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE : 6);
+        $memLimit = $memLimit ?? max(64 * 1024 * 1024, \defined('SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE') ? \SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE : 64 * 1024 * 1024);


Argon2 with opslimit = 6 & memlimit=64MiB roughly operate in the same amount of time as BCrypt's cost=13
Also, in PHP7.4 SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE=6 and SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE=32MiB
So our defaults are a bit more strict than PHP 7.4, which matches the fact that a cost=13 for BCrypt is stricter than PHP's default.

Just wondering about using SODIUM Constants in the Native Encoder, as what happens if PHP >7.2 but Sodium is NOT installed. Native should work?

The code above checks that SODUM_* constants are defined before using them, and fallback to sensible defaults (equivalent hardcoded values) otherwise

nicolas-grekas · 2019-04-17T14:18:55Z

src/Symfony/Component/Security/Core/Encoder/NativePasswordEncoder.php

+            throw new \InvalidArgumentException('$cost must be in the range of 4-31.');
+        }
+
+        $this->algo = \defined('PASSWORD_ARGON2I') ? max(PASSWORD_DEFAULT, \defined('PASSWORD_ARGON2ID') ? PASSWORD_ARGON2ID : PASSWORD_ARGON2I) : PASSWORD_DEFAULT;


PASSWORD_ARGON2ID > PASSWORD_ARGON2I > PASSWORD_BCRYPT, unless PASSWORD_DEFAULT is set to an even higher algo in the future

So if the argon algo is available the native encoder and the sodium encoder basically do the same thing?

I am wondering if it would be better for DX to use only PASSWORD_DEFAULT in the native encoder.

Then the config would become:
auto => use best supported / recommended encoder
native => use php default algo
sodium => use best supported / available sodium algo

I think always using the best available algo is required for best security. I don't understand how that relates to DX.

I think always using the best available algo is required for best security.

Agreed.

I don't understand how that relates to DX.

I just think it might be confusing that there are 2 encoders that can do the same thing (encode with the argon algo).

src/Symfony/Bundle/SecurityBundle/DependencyInjection/MainConfiguration.php

src/Symfony/Component/Security/Core/Encoder/NativePasswordEncoder.php

weaverryan · 2019-04-17T14:33:18Z

src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php

@@ -532,6 +533,10 @@ private function createEncoder($config, ContainerBuilder $container)
            return new Reference($config['id']);
        }

+        if ('auto' === $config['algorithm']) {
+            $config['algorithm'] = SodiumPasswordEncoder::isSupported() ? 'sodium' : 'native';


is the sodium encoder superior to our native encoder? Is that why it's preferred?

yes, in two aspects: it is faster for the same cost parameters, and it can be more up to date than the native one, as an extension can move faster to new algos.

being faster for the same cost may not actually be superior. The whole point of a password hashing algorithm is that it should not be too fast.

being faster for the same cost may not actually be superior. The whole point of a password hashing algorithm is that it should not be too fast.

this answer is wrong ;)
what matters is that attackers must spend significant resources to compute password hashes when they leaked. Being faster for the same cost is just improving UX and reducing greenhouse emissions. So yes, it matters a lot.

src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php

src/Symfony/Bundle/SecurityBundle/Tests/DependencyInjection/CompleteConfigurationTest.php

src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php

src/Symfony/Bundle/SecurityBundle/DependencyInjection/MainConfiguration.php

src/Symfony/Component/Security/Core/Encoder/NativePasswordEncoder.php

chalasr · 2019-04-18T13:59:59Z

Thank you @nicolas-grekas.

This PR was merged into the 4.3-dev branch. Discussion ---------- [Security] Add NativePasswordEncoder | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - This PR adds a new `NativePasswordEncoder` that defaults to the best available hashing algo to `password_hash()`. Best is determined by "us" or "php", the goal being that this will change in the future as new algos are published. This provides a native encoder that we should recommend using by default. Commits ------- 28f7961 [Security] Add NativePasswordEncoder

… NativePasswordEncoder (nicolas-grekas) This PR was merged into the 4.3-dev branch. Discussion ---------- [Security] deprecate BCryptPasswordEncoder in favor of NativePasswordEncoder | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Follow up of #31140 Commits ------- e197398 [Security] deprecate BCryptPasswordEncoder in favor of NativePasswordEncoder

nicolas-grekas added this to the next milestone Apr 17, 2019

carsonbot added Status: Needs Review Security Feature labels Apr 17, 2019

chalasr reviewed Apr 17, 2019

View reviewed changes

src/Symfony/Component/Security/Core/Encoder/NativePasswordEncoder.php Outdated Show resolved Hide resolved

nicolas-grekas force-pushed the sec-encoder-native branch 3 times, most recently from adcef7e to 40f1daf Compare April 17, 2019 14:12

nicolas-grekas commented Apr 17, 2019

View reviewed changes

weaverryan reviewed Apr 17, 2019

View reviewed changes

nicolas-grekas force-pushed the sec-encoder-native branch 2 times, most recently from 4fcca31 to 6aa50d1 Compare April 17, 2019 19:19

ro0NL approved these changes Apr 17, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Apr 17, 2019

nicolas-grekas force-pushed the sec-encoder-native branch 2 times, most recently from 1c79f90 to 406660f Compare April 17, 2019 21:04

nicolas-grekas mentioned this pull request Apr 17, 2019

[symfony/security-bundle] set encoder to "auto" for all UserInterface by default symfony/recipes#576

Closed

nicolas-grekas force-pushed the sec-encoder-native branch from 406660f to 04de8fe Compare April 17, 2019 21:15

chalasr reviewed Apr 18, 2019

View reviewed changes

nicolas-grekas force-pushed the sec-encoder-native branch from 04de8fe to 9c1b4ce Compare April 18, 2019 06:52

stof reviewed Apr 18, 2019

View reviewed changes

src/Symfony/Bundle/SecurityBundle/DependencyInjection/MainConfiguration.php Outdated Show resolved Hide resolved

stof reviewed Apr 18, 2019

View reviewed changes

src/Symfony/Component/Security/Core/Encoder/NativePasswordEncoder.php Outdated Show resolved Hide resolved

weaverryan mentioned this pull request Apr 18, 2019

[4.4] NativePasswordEncoder & password re-hashing symfony/maker-bundle#382

Closed

[Security] Add NativePasswordEncoder

28f7961

nicolas-grekas force-pushed the sec-encoder-native branch from 9c1b4ce to 28f7961 Compare April 18, 2019 11:39

chalasr approved these changes Apr 18, 2019

View reviewed changes

weaverryan approved these changes Apr 18, 2019

View reviewed changes

chalasr mentioned this pull request Apr 18, 2019

Document the new "native" and "auto" encoder algorithms symfony/symfony-docs#11452

Closed

chalasr merged commit 28f7961 into symfony:master Apr 18, 2019

nicolas-grekas deleted the sec-encoder-native branch April 18, 2019 14:01

nicolas-grekas mentioned this pull request Apr 18, 2019

[Security] deprecate BCryptPasswordEncoder in favor of NativePasswordEncoder #31170

Merged

nicolas-grekas modified the milestones: next, 4.3 Apr 30, 2019

nicolas-grekas mentioned this pull request May 7, 2019

[4.3] make:user should suggest "auto" instead of Argon2i/BCrypt symfony/maker-bundle#386

Closed

fabpot mentioned this pull request May 9, 2019

Release v4.3.0-BETA1 #31435

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Security] Add NativePasswordEncoder #31140

[Security] Add NativePasswordEncoder #31140

nicolas-grekas commented Apr 17, 2019

nicolas-grekas commented Apr 17, 2019 •

edited

Loading

ro0NL commented Apr 17, 2019

nicolas-grekas commented Apr 17, 2019

nicolas-grekas left a comment

nicolas-grekas Apr 17, 2019

nicolas-grekas Apr 17, 2019

nicolas-grekas Apr 17, 2019

nicolas-grekas Apr 17, 2019 •

edited

Loading

nicolas-grekas Apr 17, 2019

crayner Apr 22, 2019

chalasr May 31, 2019 •

edited

Loading

nicolas-grekas Apr 17, 2019

rosier Apr 18, 2019

nicolas-grekas Apr 18, 2019

rosier Apr 18, 2019

weaverryan Apr 17, 2019

nicolas-grekas Apr 17, 2019

stof Apr 18, 2019

nicolas-grekas Apr 18, 2019

chalasr commented Apr 18, 2019

[Security] Add NativePasswordEncoder #31140

[Security] Add NativePasswordEncoder #31140

Conversation

nicolas-grekas commented Apr 17, 2019

nicolas-grekas commented Apr 17, 2019 • edited Loading

ro0NL commented Apr 17, 2019

nicolas-grekas commented Apr 17, 2019

nicolas-grekas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas Apr 17, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chalasr May 31, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chalasr commented Apr 18, 2019

nicolas-grekas commented Apr 17, 2019 •

edited

Loading

nicolas-grekas Apr 17, 2019 •

edited

Loading

chalasr May 31, 2019 •

edited

Loading