feature #23882 [Security] Deprecated not being logged out after user change (iltar)

This PR was squashed before being merged into the 3.4 branch (closes #23882).

Discussion
----------

[Security] Deprecated not being logged out after user change

| Q             | A
| ------------- | ---
| Branch?       | 3.4
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | yes
| Tests pass?   | yes
| Fixed tickets | #17023
| License       | MIT
| Doc PR        | ~

This PR is an alternative approach to #19033. Due to a behavioral change that could break a lot of applications and websites, I've decided to trigger a deprecation instead of actually changing the behavior as that can be done for 4.0.

Whenever a user object is considered changed (`AbstractToken::hasUserChanged`) when setting a new user object after refreshing, it will now throw a deprecation, paving the way for a behavioral change in 4.0. The idea is that in 4.0 Symfony will simply trigger a logout when this case is encountered.

Commits
-------

22f525b [Security] Deprecated not being logged out after user change
This commit is contained in:
Robin Chalas 2017-09-26 13:05:27 +02:00
commit 477a24dff9
35 changed files with 161 additions and 21 deletions

View File

@ -269,6 +269,10 @@ SecurityBundle
as first argument. Not passing it is deprecated and will throw a `TypeError`
in 4.0.
* Added `logout_on_user_change` to the firewall options. This config item will
trigger a logout when the user has changed. Should be set to true to avoid
deprecations in the configuration.
Translation
-----------

View File

@ -642,6 +642,9 @@ Security
* Support for defining voters that don't implement the `VoterInterface` has been removed.
* Calling `ContextListener::setLogoutOnUserChange(false)` won't have any
effect anymore.
SecurityBundle
--------------
@ -660,6 +663,9 @@ SecurityBundle
`Symfony\Component\Security\Acl\Model\MutableAclProviderInterfaceConnection`
as first argument.
* The firewall option `logout_on_user_change` is now always true, which will
trigger a logout if the user changes between requests.
Serializer
----------

View File

@ -13,6 +13,9 @@ CHANGELOG
* `SetAclCommand::__construct()` now takes an instance of
`Symfony\Component\Security\Acl\Model\MutableAclProviderInterfaceConnection`
as first argument
* Added `logout_on_user_change` to the firewall options. This config item will
trigger a logout when the user has changed. Should be set to true to avoid
deprecations in the configuration.
3.3.0
-----

View File

@ -252,6 +252,10 @@ class MainConfiguration implements ConfigurationInterface
->scalarNode('provider')->end()
->booleanNode('stateless')->defaultFalse()->end()
->scalarNode('context')->cannotBeEmpty()->end()
->booleanNode('logout_on_user_change')
->defaultFalse()
->info('When true, it will trigger a logout for the user if something has changed. This will be the default behavior as of Syfmony 4.0.')
->end()
->arrayNode('logout')
->treatTrueLike(array())
->canBeUnset()
@ -340,6 +344,17 @@ class MainConfiguration implements ConfigurationInterface
return $firewall;
})
->end()
->validate()
->ifTrue(function ($v) {
return (isset($v['stateless']) && true === $v['stateless']) || (isset($v['security']) && false === $v['security']);
})
->then(function ($v) {
// this option doesn't change behavior when true when stateless, so prevent deprecations
$v['logout_on_user_change'] = true;
return $v;
})
->end()
;
}

View File

@ -265,14 +265,14 @@ class SecurityExtension extends Extension
$providerIds = $this->createUserProviders($config, $container);
// make the ContextListener aware of the configured user providers
$definition = $container->getDefinition('security.context_listener');
$arguments = $definition->getArguments();
$contextListenerDefinition = $container->getDefinition('security.context_listener');
$arguments = $contextListenerDefinition->getArguments();
$userProviders = array();
foreach ($providerIds as $userProviderId) {
$userProviders[] = new Reference($userProviderId);
}
$arguments[1] = new IteratorArgument($userProviders);
$definition->setArguments($arguments);
$contextListenerDefinition->setArguments($arguments);
$customUserChecker = false;
@ -284,6 +284,12 @@ class SecurityExtension extends Extension
$customUserChecker = true;
}
if (!isset($firewall['logout_on_user_change']) || !$firewall['logout_on_user_change']) {
@trigger_error('Setting logout_on_user_change to false is deprecated as of 3.4 and will always be true in 4.0. Set logout_on_user_change to true in your firewall configuration.', E_USER_DEPRECATED);
}
$contextListenerDefinition->addMethodCall('setLogoutOnUserChange', array($firewall['logout_on_user_change']));
$configId = 'security.firewall.map.config.'.$name;
list($matcher, $listeners, $exceptionListener) = $this->createFirewall($container, $name, $firewall, $authenticationProviders, $providerIds, $configId);

View File

@ -73,6 +73,7 @@ $container->loadFromExtension('security', array(
'logout' => true,
'remember_me' => array('secret' => 'TheSecret'),
'user_checker' => null,
'logout_on_user_change' => true,
),
'host' => array(
'pattern' => '/test',
@ -80,11 +81,13 @@ $container->loadFromExtension('security', array(
'methods' => array('GET', 'POST'),
'anonymous' => true,
'http_basic' => true,
'logout_on_user_change' => true,
),
'with_user_checker' => array(
'user_checker' => 'app.user_checker',
'anonymous' => true,
'http_basic' => true,
'logout_on_user_change' => true,
),
),

View File

@ -15,10 +15,12 @@ $container->loadFromExtension('security', array(
'main' => array(
'provider' => 'default',
'form_login' => true,
'logout_on_user_change' => true,
),
'other' => array(
'provider' => 'with-dash',
'form_login' => true,
'logout_on_user_change' => true,
),
),
));

View File

@ -12,6 +12,7 @@ $container->loadFromExtension('security', array(
'main' => array(
'provider' => 'undefined',
'form_login' => true,
'logout_on_user_change' => true,
),
),
));

View File

@ -11,6 +11,7 @@ $container->loadFromExtension('security', array(
'firewalls' => array(
'main' => array(
'form_login' => array('provider' => 'default'),
'logout_on_user_change' => true,
),
),
));

View File

@ -11,6 +11,7 @@ $container->loadFromExtension('security', array(
'firewalls' => array(
'main' => array(
'form_login' => array('provider' => 'undefined'),
'logout_on_user_change' => true,
),
),
));

View File

@ -11,6 +11,7 @@ $container->loadFromExtension('security', array(
'main' => array(
'form_login' => false,
'http_basic' => null,
'logout_on_user_change' => true,
),
),

View File

@ -6,6 +6,7 @@ $container->loadFromExtension('security', array(
'form_login' => array(
'login_path' => '/login',
),
'logout_on_user_change' => true,
),
),
'role_hierarchy' => array(

View File

@ -12,7 +12,8 @@ $container->loadFromExtension('security', array(
),
'firewalls' => array(
'simple' => array('pattern' => '/login', 'security' => false),
'secure' => array('stateless' => true,
'secure' => array(
'stateless' => true,
'http_basic' => true,
'http_digest' => array('secret' => 'TheSecret'),
'form_login' => true,

View File

@ -13,6 +13,7 @@ $container->loadFromExtension('security', array(
'catch_exceptions' => false,
'token_provider' => 'token_provider_id',
),
'logout_on_user_change' => true,
),
),
));

View File

@ -60,12 +60,12 @@
<remember-me secret="TheSecret"/>
</firewall>
<firewall name="host" pattern="/test" host="foo\.example\.org" methods="GET,POST">
<firewall name="host" pattern="/test" host="foo\.example\.org" methods="GET,POST" logout-on-user-change="true">
<anonymous />
<http-basic />
</firewall>
<firewall name="with_user_checker">
<firewall name="with_user_checker" logout-on-user-change="true">
<anonymous />
<http-basic />
<user-checker>app.user_checker</user-checker>

View File

@ -11,7 +11,7 @@
</sec:providers>
<sec:firewalls>
<sec:firewall name="main" provider="with-dash">
<sec:firewall name="main" provider="with-dash" logout-on-user-change="true">
<sec:form_login />
</sec:firewall>
</sec:firewalls>

View File

@ -11,7 +11,7 @@
</sec:providers>
<sec:firewalls>
<sec:firewall name="main" provider="undefined">
<sec:firewall name="main" provider="undefined" logout-on-user-change="true">
<sec:form_login />
</sec:firewall>
</sec:firewalls>

View File

@ -11,7 +11,7 @@
</sec:providers>
<sec:firewalls>
<sec:firewall name="main">
<sec:firewall name="main" logout-on-user-change="true">
<sec:form_login provider="default" />
</sec:firewall>
</sec:firewalls>

View File

@ -11,7 +11,7 @@
</sec:providers>
<sec:firewalls>
<sec:firewall name="main">
<sec:firewall name="main" logout-on-user-change="true">
<sec:form_login provider="undefined" />
</sec:firewall>
</sec:firewalls>

View File

@ -12,7 +12,7 @@
<sec:config>
<sec:provider name="default" id="foo" />
<sec:firewall name="main" form-login="false">
<sec:firewall name="main" form-login="false" logout-on-user-change="true">
<sec:http-basic />
</sec:firewall>

View File

@ -6,7 +6,7 @@
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
<config>
<firewall name="main">
<firewall name="main" logout-on-user-change="true">
<form-login login-path="/login" />
</firewall>

View File

@ -9,7 +9,7 @@
<sec:providers>
<sec:default id="foo"/>
</sec:providers>
<sec:firewall name="main">
<sec:firewall name="main" logout-on-user-change="true">
<sec:form-login/>
<sec:remember-me secret="TheSecret" catch-exceptions="false" token-provider="token_provider_id" />
</sec:firewall>

View File

@ -64,11 +64,13 @@ security:
methods: [GET,POST]
anonymous: true
http_basic: true
logout_on_user_change: true
with_user_checker:
anonymous: ~
http_basic: ~
user_checker: app.user_checker
logout_on_user_change: true
role_hierarchy:
ROLE_ADMIN: ROLE_USER

View File

@ -11,6 +11,8 @@ security:
main:
provider: default
form_login: true
logout_on_user_change: true
other:
provider: with-dash
form_login: true
logout_on_user_change: true

View File

@ -8,3 +8,4 @@ security:
main:
provider: undefined
form_login: true
logout_on_user_change: true

View File

@ -8,3 +8,4 @@ security:
main:
form_login:
provider: default
logout_on_user_change: true

View File

@ -8,3 +8,4 @@ security:
main:
form_login:
provider: undefined
logout_on_user_change: true

View File

@ -9,6 +9,7 @@ security:
main:
form_login: false
http_basic: ~
logout_on_user_change: true
role_hierarchy:
FOO: [MOO]

View File

@ -3,6 +3,7 @@ security:
main:
form_login:
login_path: /login
logout_on_user_change: true
role_hierarchy:
FOO: BAR

View File

@ -10,3 +10,4 @@ security:
secret: TheSecret
catch_exceptions: false
token_provider: token_provider_id
logout_on_user_change: true

View File

@ -31,6 +31,7 @@ class MainConfigurationTest extends TestCase
),
'firewalls' => array(
'stub' => array(),
'logout_on_user_change' => true,
),
);
@ -78,6 +79,7 @@ class MainConfigurationTest extends TestCase
'csrf_token_generator' => 'a_token_generator',
'csrf_token_id' => 'a_token_id',
),
'logout_on_user_change' => true,
),
),
);
@ -107,6 +109,7 @@ class MainConfigurationTest extends TestCase
'firewalls' => array(
'stub' => array(
'user_checker' => 'app.henk_checker',
'logout_on_user_change' => true,
),
),
);

View File

@ -38,6 +38,7 @@ class SecurityExtensionTest extends TestCase
'form_login' => array(
'check_path' => '/some_area/login_check',
),
'logout_on_user_change' => true,
),
),
));
@ -61,6 +62,7 @@ class SecurityExtensionTest extends TestCase
'firewalls' => array(
'some_firewall' => array(
'pattern' => '/.*',
'logout_on_user_change' => true,
),
),
));
@ -88,6 +90,7 @@ class SecurityExtensionTest extends TestCase
'some_firewall' => array(
'pattern' => '/.*',
'http_basic' => array(),
'logout_on_user_change' => true,
),
),
));
@ -110,6 +113,7 @@ class SecurityExtensionTest extends TestCase
'some_firewall' => array(
'pattern' => '/.*',
'http_basic' => null,
'logout_on_user_change' => true,
),
),
));
@ -119,6 +123,31 @@ class SecurityExtensionTest extends TestCase
$this->assertFalse($container->hasDefinition('security.access.role_hierarchy_voter'));
}
/**
* @group legacy
* @expectedDeprecation Setting logout_on_user_change to false is deprecated as of 3.4 and will always be true in 4.0. Set logout_on_user_change to true in your firewall configuration.
*/
public function testDeprecationForUserLogout()
{
$container = $this->getRawContainer();
$container->loadFromExtension('security', array(
'providers' => array(
'default' => array('id' => 'foo'),
),
'firewalls' => array(
'some_firewall' => array(
'pattern' => '/.*',
'http_basic' => null,
'logout_on_user_change' => false,
),
),
));
$container->compile();
}
protected function getRawContainer()
{
$container = new ContainerBuilder();

View File

@ -6,6 +6,10 @@ CHANGELOG
* Using voters that do not implement the `VoterInterface`is now deprecated in
the `AccessDecisionManager` and this functionality will be removed in 4.0.
* Using the `ContextListener` without setting the `logoutOnUserChange`
property will trigger a deprecation when the user has changed. As of 4.0
the user will always be logged out when the user has changed between
requests.
3.3.0
-----

View File

@ -44,6 +44,7 @@ class ContextListener implements ListenerInterface
private $dispatcher;
private $registered;
private $trustResolver;
private $logoutOnUserChange = false;
/**
* @param TokenStorageInterface $tokenStorage
@ -68,6 +69,16 @@ class ContextListener implements ListenerInterface
$this->trustResolver = $trustResolver ?: new AuthenticationTrustResolver(AnonymousToken::class, RememberMeToken::class);
}
/**
* Enables deauthentication during refreshUser when the user has changed.
*
* @param bool $logoutOnUserChange
*/
public function setLogoutOnUserChange($logoutOnUserChange)
{
$this->logoutOnUserChange = (bool) $logoutOnUserChange;
}
/**
* Reads the Security Token from the session.
*
@ -122,14 +133,14 @@ class ContextListener implements ListenerInterface
return;
}
if (!$event->getRequest()->hasSession()) {
$request = $event->getRequest();
if (!$request->hasSession()) {
return;
}
$this->dispatcher->removeListener(KernelEvents::RESPONSE, array($this, 'onKernelResponse'));
$this->registered = false;
$request = $event->getRequest();
$session = $request->getSession();
if ((null === $token = $this->tokenStorage->getToken()) || $this->trustResolver->isAnonymous($token)) {
@ -172,6 +183,19 @@ class ContextListener implements ListenerInterface
$refreshedUser = $provider->refreshUser($user);
$token->setUser($refreshedUser);
// tokens can be deauthenticated if the user has been changed.
if (!$token->isAuthenticated()) {
if ($this->logoutOnUserChange) {
if (null !== $this->logger) {
$this->logger->debug('Token was deauthenticated after trying to refresh it.', array('username' => $refreshedUser->getUsername(), 'provider' => get_class($provider)));
}
return null;
}
@trigger_error('Refreshing a deauthenticated user is deprecated as of 3.4 and will trigger a logout in 4.0.', E_USER_DEPRECATED);
}
if (null !== $this->logger) {
$context = array('provider' => get_class($provider), 'username' => $refreshedUser->getUsername());

View File

@ -249,7 +249,11 @@ class ContextListenerTest extends TestCase
$listener->handle($event);
}
public function testTryAllUserProvidersUntilASupportingUserProviderIsFound()
/**
* @group legacy
* @expectedDeprecation Refreshing a deauthenticated user is deprecated as of 3.4 and will trigger a logout in 4.0.
*/
public function testIfTokenIsDeauthenticatedTriggersDeprecations()
{
$tokenStorage = new TokenStorage();
$refreshedUser = new User('foobar', 'baz');
@ -258,11 +262,29 @@ class ContextListenerTest extends TestCase
$this->assertSame($refreshedUser, $tokenStorage->getToken()->getUser());
}
public function testIfTokenIsDeauthenticated()
{
$tokenStorage = new TokenStorage();
$refreshedUser = new User('foobar', 'baz');
$this->handleEventWithPreviousSession($tokenStorage, array(new NotSupportingUserProvider(), new SupportingUserProvider($refreshedUser)), null, true);
$this->assertNull($tokenStorage->getToken());
}
public function testTryAllUserProvidersUntilASupportingUserProviderIsFound()
{
$tokenStorage = new TokenStorage();
$refreshedUser = new User('foobar', 'baz');
$this->handleEventWithPreviousSession($tokenStorage, array(new NotSupportingUserProvider(), new SupportingUserProvider($refreshedUser)), $refreshedUser);
$this->assertSame($refreshedUser, $tokenStorage->getToken()->getUser());
}
public function testNextSupportingUserProviderIsTriedIfPreviousSupportingUserProviderDidNotLoadTheUser()
{
$tokenStorage = new TokenStorage();
$refreshedUser = new User('foobar', 'baz');
$this->handleEventWithPreviousSession($tokenStorage, array(new SupportingUserProvider(), new SupportingUserProvider($refreshedUser)));
$this->handleEventWithPreviousSession($tokenStorage, array(new SupportingUserProvider(), new SupportingUserProvider($refreshedUser)), $refreshedUser);
$this->assertSame($refreshedUser, $tokenStorage->getToken()->getUser());
}
@ -287,7 +309,7 @@ class ContextListenerTest extends TestCase
{
$tokenStorage = new TokenStorage();
$refreshedUser = new User('foobar', 'baz');
$this->handleEventWithPreviousSession($tokenStorage, new \ArrayObject(array(new NotSupportingUserProvider(), new SupportingUserProvider($refreshedUser))));
$this->handleEventWithPreviousSession($tokenStorage, new \ArrayObject(array(new NotSupportingUserProvider(), new SupportingUserProvider($refreshedUser))), $refreshedUser);
$this->assertSame($refreshedUser, $tokenStorage->getToken()->getUser());
}
@ -320,16 +342,18 @@ class ContextListenerTest extends TestCase
return $session;
}
private function handleEventWithPreviousSession(TokenStorageInterface $tokenStorage, $userProviders)
private function handleEventWithPreviousSession(TokenStorageInterface $tokenStorage, $userProviders, UserInterface $user = null, $logoutOnUserChange = false)
{
$user = $user ?: new User('foo', 'bar');
$session = new Session(new MockArraySessionStorage());
$session->set('_security_context_key', serialize(new UsernamePasswordToken(new User('foo', 'bar'), '', 'context_key')));
$session->set('_security_context_key', serialize(new UsernamePasswordToken($user, '', 'context_key', array('ROLE_USER'))));
$request = new Request();
$request->setSession($session);
$request->cookies->set('MOCKSESSID', true);
$listener = new ContextListener($tokenStorage, $userProviders, 'context_key');
$listener->setLogoutOnUserChange($logoutOnUserChange);
$listener->handle(new GetResponseEvent($this->getMockBuilder('Symfony\Component\HttpKernel\HttpKernelInterface')->getMock(), $request, HttpKernelInterface::MASTER_REQUEST));
}
}