Skip to content

[SecurityBundle] inject only compatible token storage implementations for usage tracking #38869

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
Oct 31, 2020
Merged

[SecurityBundle] inject only compatible token storage implementations for usage tracking #38869

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
8 changes: 6 additions & 2 deletions ...ony/Bundle/SecurityBundle/DependencyInjection/Compiler/RegisterTokenUsageTrackingPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,12 @@ public function process(ContainerBuilder $container)
$container->setAlias('security.token_storage', 'security.untracked_token_storage')->setPublic(true);
$container->getDefinition('security.untracked_token_storage')->addTag('kernel.reset', ['method' => 'reset']);
} elseif ($container->hasDefinition('security.context_listener')) {
$container->getDefinition('security.context_listener')
->setArgument(6, [new Reference('security.token_storage'), 'enableUsageTracking']);
$tokenStorageClass = $container->getParameterBag()->resolveValue($container->findDefinition('security.token_storage')->getClass());

if (method_exists($tokenStorageClass, 'enableUsageTracking')) {
$container->getDefinition('security.context_listener')
->setArgument(6, [new Reference('security.token_storage'), 'enableUsageTracking']);
}
}
}
}
89 changes: 89 additions & 0 deletions .../SecurityBundle/Tests/DependencyInjection/Compiler/RegisterTokenUsageTrackingPassTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Bundle\SecurityBundle\Tests\DependencyInjection\Compiler;

use PHPUnit\Framework\TestCase;
use Symfony\Bundle\SecurityBundle\DependencyInjection\Compiler\RegisterTokenUsageTrackingPass;
use Symfony\Component\DependencyInjection\Alias;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
use Symfony\Component\Security\Core\Authentication\Token\Storage\UsageTrackingTokenStorage;
use Symfony\Component\Security\Http\Firewall\ContextListener;

class RegisterTokenUsageTrackingPassTest extends TestCase
{
public function testTokenStorageIsUntrackedIfSessionIsMissing()
{
$container = new ContainerBuilder();
$container->register('security.untracked_token_storage', TokenStorage::class);

$compilerPass = new RegisterTokenUsageTrackingPass();
$compilerPass->process($container);

$this->assertTrue($container->hasAlias('security.token_storage'));
$this->assertEquals(new Alias('security.untracked_token_storage', true), $container->getAlias('security.token_storage'));
}

public function testContextListenerIsNotModifiedIfTokenStorageDoesNotSupportUsageTracking()
{
$container = new ContainerBuilder();

$container->setParameter('security.token_storage.class', TokenStorage::class);
$container->register('session', Session::class);
$container->register('security.context_listener', ContextListener::class)
->setArguments([
new Reference('security.untracked_token_storage'),
[],
'main',
new Reference('logger', ContainerInterface::NULL_ON_INVALID_REFERENCE),
new Reference('event_dispatcher', ContainerInterface::NULL_ON_INVALID_REFERENCE),
new Reference('security.authentication.trust_resolver'),
]);
$container->register('security.token_storage', '%security.token_storage.class%');
$container->register('security.untracked_token_storage', TokenStorage::class);

$compilerPass = new RegisterTokenUsageTrackingPass();
$compilerPass->process($container);

$this->assertCount(6, $container->getDefinition('security.context_listener')->getArguments());
}

public function testContextListenerEnablesUsageTrackingIfSupportedByTokenStorage()
{
$container = new ContainerBuilder();

$container->setParameter('security.token_storage.class', UsageTrackingTokenStorage::class);
$container->register('session', Session::class);
$container->register('security.context_listener', ContextListener::class)
->setArguments([
new Reference('security.untracked_token_storage'),
[],
'main',
new Reference('logger', ContainerInterface::NULL_ON_INVALID_REFERENCE),
new Reference('event_dispatcher', ContainerInterface::NULL_ON_INVALID_REFERENCE),
new Reference('security.authentication.trust_resolver'),
]);
$container->register('security.token_storage', '%security.token_storage.class%');
$container->register('security.untracked_token_storage', TokenStorage::class);

$compilerPass = new RegisterTokenUsageTrackingPass();
$compilerPass->process($container);

$contextListener = $container->getDefinition('security.context_listener');

$this->assertCount(7, $container->getDefinition('security.context_listener')->getArguments());
$this->assertEquals([new Reference('security.token_storage'), 'enableUsageTracking'], $contextListener->getArgument(6));
}
}