Skip to content

Fix SessionTokenStorage reuse with Request #41881

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
Jun 30, 2021
Merged

Fix SessionTokenStorage reuse with Request #41881

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
49 changes: 49 additions & 0 deletions src/Symfony/Component/Security/Csrf/Tests/TokenStorage/SessionTokenStorageTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
namespace Symfony\Component\Security\Csrf\Tests\TokenStorage;

use PHPUnit\Framework\TestCase;
use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpFoundation\Session\Session;
Expand All @@ -24,6 +25,8 @@
*/
class SessionTokenStorageTest extends TestCase
{
use ExpectDeprecationTrait;

private const SESSION_NAMESPACE = 'foobar';

/**
Expand Down Expand Up @@ -159,4 +162,50 @@ public function testClearDoesNotRemoveNonNamespacedSessionValues()
$this->assertTrue($this->session->has('foo'));
$this->assertSame('baz', $this->session->get('foo'));
}

/**
* @group legacy
*/
public function testMockSessionIsCreatedWhenMissing()
{
$this->expectDeprecation('Since symfony/security-csrf 5.3: Using the "Symfony\Component\Security\Csrf\TokenStorage\SessionTokenStorage" without a session has no effect and is deprecated. It will throw a "Symfony\Component\HttpFoundation\Exception\SessionNotFoundException" in Symfony 6.0');

$this->storage->setToken('token_id', 'TOKEN');

$requestStack = new RequestStack();
$storage = new SessionTokenStorage($requestStack, self::SESSION_NAMESPACE);

$this->assertFalse($storage->hasToken('foo'));
$storage->setToken('foo', 'bar');
$this->assertTrue($storage->hasToken('foo'));
$this->assertSame('bar', $storage->getToken('foo'));

$session = new Session(new MockArraySessionStorage());
$request = new Request();
$request->setSession($session);
$requestStack->push($request);
}

/**
* @group legacy
*/
public function testMockSessionIsReusedEvenWhenRequestHasSession()
{
$this->expectDeprecation('Since symfony/security-csrf 5.3: Using the "Symfony\Component\Security\Csrf\TokenStorage\SessionTokenStorage" without a session has no effect and is deprecated. It will throw a "Symfony\Component\HttpFoundation\Exception\SessionNotFoundException" in Symfony 6.0');

$this->storage->setToken('token_id', 'TOKEN');

$requestStack = new RequestStack();
$storage = new SessionTokenStorage($requestStack, self::SESSION_NAMESPACE);

$storage->setToken('foo', 'bar');
$this->assertSame('bar', $storage->getToken('foo'));

$session = new Session(new MockArraySessionStorage());
$request = new Request();
$request->setSession($session);
$requestStack->push($request);

$this->assertSame('bar', $storage->getToken('foo'));
}
}
4 changes: 2 additions & 2 deletions src/Symfony/Component/Security/Csrf/TokenStorage/SessionTokenStorage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class SessionTokenStorage implements ClearableTokenStorageInterface
private $requestStack;
private $namespace;
/**
* Tp be remove in Symfony 6.0
* To be removed in Symfony 6.0.
*/
private $session;

Expand Down Expand Up @@ -130,7 +130,7 @@ public function clear()
private function getSession(): SessionInterface
{
try {
return $this->requestStack->getSession();
return $this->session ?? $this->requestStack->getSession();
} catch (SessionNotFoundException $e) {
trigger_deprecation('symfony/security-csrf', '5.3', 'Using the "%s" without a session has no effect and is deprecated. It will throw a "%s" in Symfony 6.0', __CLASS__, SessionNotFoundException::class);

Expand Down