[DX] [Security] Renamed Token#getKey() to getSecret()

Author: wouterj

CHANGELOG.md

@@ -1,12 +1,18 @@
 CHANGELOG
 =========
 
+2.8.0
+-----
+
+ * deprecated the `key` setting of `anonymous` and `remember_me` in favor of the
+   `secret` setting.
+
 2.6.0
 -----
 
  * Added the possibility to override the default success/failure handler
    to get the provider key and the options injected
- * Deprecated the `security.context` service for the `security.token_storage` and 
+ * Deprecated the `security.context` service for the `security.token_storage` and
    `security.authorization_checker` services.
 
 2.4.0

DependencyInjection/MainConfiguration.php

@@ -285,8 +285,22 @@ private function addFirewallsSection(ArrayNodeDefinition $rootNode, array $facto
             ->end()
             ->arrayNode('anonymous')
                 ->canBeUnset()
+                ->beforeNormalization()
+                    ->ifTrue(function ($v) { return isset($v['key']); })
+                    ->then(function ($v) {
+                        if (isset($v['secret'])) {
+                            throw new \LogicException('Cannot set both key and secret options for security.firewall.anonymous, use only secret instead.');
+                        }
+
+                        @trigger_error('security.firewall.anonymous.key is deprecated since version 2.8 and will be removed in 3.0. Use security.firewall.anonymous.secret instead.', E_USER_DEPRECATED);
+
+                        $v['secret'] = $v['key'];
+
+                        unset($v['key']);
+                    })
+                ->end()
                 ->children()
-                    ->scalarNode('key')->defaultValue(uniqid())->end()
+                    ->scalarNode('secret')->defaultValue(uniqid())->end()
                 ->end()
             ->end()
             ->arrayNode('switch_user')

DependencyInjection/Security/Factory/RememberMeFactory.php

@@ -35,7 +35,7 @@ public function create(ContainerBuilder $container, $id, $config, $userProvider,
         $authProviderId = 'security.authentication.provider.rememberme.'.$id;
         $container
             ->setDefinition($authProviderId, new DefinitionDecorator('security.authentication.provider.rememberme'))
-            ->addArgument($config['key'])
+            ->addArgument($config['secret'])
             ->addArgument($id)
         ;
 
@@ -56,7 +56,7 @@ public function create(ContainerBuilder $container, $id, $config, $userProvider,
         }
 
         $rememberMeServices = $container->setDefinition($rememberMeServicesId, new DefinitionDecorator($templateId));
-        $rememberMeServices->replaceArgument(1, $config['key']);
+        $rememberMeServices->replaceArgument(1, $config['secret']);
         $rememberMeServices->replaceArgument(2, $id);
 
         if (isset($config['token_provider'])) {
@@ -120,10 +120,25 @@ public function getKey()
     public function addConfiguration(NodeDefinition $node)
     {
         $node->fixXmlConfig('user_provider');
-        $builder = $node->children();
+        $builder = $node
+            ->beforeNormalization()
+                ->ifTrue(function ($v) { return isset($v['key']); })
+                ->then(function ($v) {
+                    if (isset($v['secret'])) {
+                        throw new \LogicException('Cannot set both key and secret options for remember_me, use only secret instead.');
+                    }
+
+                    @trigger_error('remember_me.key is deprecated since version 2.8 and will be removed in 3.0. Use remember_me.secret instead.', E_USER_DEPRECATED);
+
+                    $v['secret'] = $v['key'];
+
+                    unset($v['key']);
+                })
+                ->end()
+            ->children();
 
         $builder
-            ->scalarNode('key')->isRequired()->cannotBeEmpty()->end()
+            ->scalarNode('secret')->isRequired()->cannotBeEmpty()->end()
             ->scalarNode('token_provider')->end()
             ->arrayNode('user_providers')
                 ->beforeNormalization()

DependencyInjection/SecurityExtension.php

@@ -410,15 +410,15 @@ private function createAuthenticationListeners($container, $id, $firewall, &$aut
             $listenerId = 'security.authentication.listener.anonymous.'.$id;
             $container
                 ->setDefinition($listenerId, new DefinitionDecorator('security.authentication.listener.anonymous'))
-                ->replaceArgument(1, $firewall['anonymous']['key'])
+                ->replaceArgument(1, $firewall['anonymous']['secret'])
             ;
 
             $listeners[] = new Reference($listenerId);
 
             $providerId = 'security.authentication.provider.anonymous.'.$id;
             $container
                 ->setDefinition($providerId, new DefinitionDecorator('security.authentication.provider.anonymous'))
-                ->replaceArgument(0, $firewall['anonymous']['key'])
+                ->replaceArgument(0, $firewall['anonymous']['secret'])
             ;
 
             $authenticationProviders[] = $providerId;

Tests/DependencyInjection/Fixtures/php/container1.php

@@ -71,7 +71,7 @@
             'x509' => true,
             'remote_user' => true,
             'logout' => true,
-            'remember_me' => array('key' => 'TheKey'),
+            'remember_me' => array('secret' => 'TheSecret'),
         ),
         'host' => array(
             'pattern' => '/test',

Tests/DependencyInjection/Fixtures/php/remember_me_options.php

@@ -1,4 +1,5 @@
 <?php
+
 $container->loadFromExtension('security', array(
     'providers' => array(
         'default' => array('id' => 'foo'),
@@ -8,7 +9,7 @@
         'main' => array(
             'form_login' => true,
             'remember_me' => array(
-                'key' => 'TheyKey',
+                'secret' => 'TheSecret',
                 'catch_exceptions' => false,
                 'token_provider' => 'token_provider_id',
             ),

Tests/DependencyInjection/Fixtures/xml/container1.xml

@@ -56,7 +56,7 @@
             <x509 />
             <remote-user />
             <logout />
-            <remember-me key="TheyKey"/>
+            <remember-me secret="TheSecret"/>
         </firewall>
 
         <firewall name="host" pattern="/test" host="foo\.example\.org" methods="GET,POST">

Tests/DependencyInjection/Fixtures/xml/remember_me_options.xml

@@ -11,7 +11,7 @@
         </sec:providers>
         <sec:firewall name="main">
             <sec:form-login/>
-            <sec:remember-me key="TheKey" catch-exceptions="false" token-provider="token_provider_id" />
+            <sec:remember-me secret="TheSecret" catch-exceptions="false" token-provider="token_provider_id" />
         </sec:firewall>
     </sec:config>
 

Tests/DependencyInjection/Fixtures/yml/container1.yml

@@ -55,7 +55,7 @@ security:
             remote_user: true
             logout: true
             remember_me:
-                key: TheKey
+                secret: TheSecret
         host:
             pattern: /test
             host: foo\.example\.org

Tests/DependencyInjection/Fixtures/yml/remember_me_options.yml

@@ -7,6 +7,6 @@ security:
         main:
             form_login: true
             remember_me:
-                key: TheKey
+                secret: TheSecret
                 catch_exceptions: false
                 token_provider: token_provider_id