Skip to content

[Security] Remove CSRF deprecations #42142

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
Jul 15, 2021
Merged

[Security] Remove CSRF deprecations #42142

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
6 changes: 6 additions & 0 deletions src/Symfony/Component/Security/Csrf/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
CHANGELOG
=========

6.0
---

* Remove the `SessionInterface $session` constructor argument of `SessionTokenStorage`, inject a `\Symfony\Component\HttpFoundation\RequestStack $requestStack` instead
* Using `SessionTokenStorage` outside a request context throws a `SessionNotFoundException`

5.3
---

Expand Down
49 changes: 0 additions & 49 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,7 +12,6 @@
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 @@ -25,8 +24,6 @@
*/
class SessionTokenStorageTest extends TestCase
{
use ExpectDeprecationTrait;

private const SESSION_NAMESPACE = 'foobar';

/**
Expand Down Expand Up @@ -162,50 +159,4 @@ 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'));
}
}
31 changes: 6 additions & 25 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 @@ -12,11 +12,8 @@
namespace Symfony\Component\Security\Csrf\TokenStorage;

use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\HttpFoundation\Session\SessionInterface;
use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;
use Symfony\Component\Security\Csrf\Exception\TokenNotFoundException;

/**
Expand All @@ -33,27 +30,14 @@ class SessionTokenStorage implements ClearableTokenStorageInterface

private $requestStack;
private $namespace;
/**
* To be removed in Symfony 6.0.
*/
private $session;

/**
* Initializes the storage with a RequestStack object and a session namespace.
*
* @param RequestStack $requestStack
* @param string $namespace The namespace under which the token is stored in the requestStack
* @param string $namespace The namespace under which the token is stored in the requestStack
*/
public function __construct(/* RequestStack*/ $requestStack, string $namespace = self::SESSION_NAMESPACE)
public function __construct(RequestStack $requestStack, string $namespace = self::SESSION_NAMESPACE)
{
if ($requestStack instanceof SessionInterface) {
trigger_deprecation('symfony/security-csrf', '5.3', 'Passing a "%s" to "%s" is deprecated, use a "%s" instead.', SessionInterface::class, __CLASS__, RequestStack::class);
$request = new Request();
$request->setSession($requestStack);

$requestStack = new RequestStack();
$requestStack->push($request);
}
$this->requestStack = $requestStack;
$this->namespace = $namespace;
}
Expand Down Expand Up @@ -127,14 +111,11 @@ public function clear()
}
}

/**
* @throws SessionNotFoundException
*/
private function getSession(): SessionInterface
{
try {
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);

return $this->session ?? $this->session = new Session(new MockArraySessionStorage());
}
return $this->requestStack->getSession();
}
}