Skip to content

[HttpFoundation] Support samesite cookies in response #26478

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.

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

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions src/Symfony/Component/HttpFoundation/Response.php
Original file line number Diff line number Diff line change
Expand Up @@ -338,10 +338,11 @@ public function sendHeaders()

// cookies
foreach ($this->headers->getCookies() as $cookie) {
$path = $cookie->getPath().(null !== $cookie->getSameSite() ? ('; samesite='.$cookie->getSameSite()) : '');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand that this is a hack needed because of the lack of support of samesite in PHP cookie functions. However, wouldn't it be better to hack this into $cookie->getDomain() instead of $cookie->getPath() ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@javiereguiluz the issue is, domain can be null while path will always be something

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK then 👍 ... but @nicolas-grekas proposal may be a better way to solve this? What do you think?

if ($cookie->isRaw()) {
setrawcookie($cookie->getName(), $cookie->getValue(), $cookie->getExpiresTime(), $cookie->getPath(), $cookie->getDomain(), $cookie->isSecure(), $cookie->isHttpOnly());
setrawcookie($cookie->getName(), $cookie->getValue(), $cookie->getExpiresTime(), $path, $cookie->getDomain(), $cookie->isSecure(), $cookie->isHttpOnly());
} else {
setcookie($cookie->getName(), $cookie->getValue(), $cookie->getExpiresTime(), $cookie->getPath(), $cookie->getDomain(), $cookie->isSecure(), $cookie->isHttpOnly());
setcookie($cookie->getName(), $cookie->getValue(), $cookie->getExpiresTime(), $path, $cookie->getDomain(), $cookie->isSecure(), $cookie->isHttpOnly());
}
}

Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/HttpFoundation/ResponseHeaderBag.php
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ public function removeCookie($name, $path = '/', $domain = null)
*
* @param string $format
*
* @return array
* @return Cookie[]
*
* @throws \InvalidArgumentException When the $format is invalid
*/
Expand Down
32 changes: 32 additions & 0 deletions src/Symfony/Component/HttpFoundation/Tests/Fixtures/server.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?php

namespace Symfony\Component\HttpFoundation\Tests;

use Symfony\Component\HttpFoundation\Cookie;
use Symfony\Component\HttpFoundation\Response;

require_once __DIR__.'/../../../../../../vendor/autoload.php';

$uri = $_SERVER['REQUEST_URI'];

switch ($uri) {
case '/ping':
$response = new Response('pong');
break;

case '/cookie/samesite-lax':
$response = new Response($uri);
$response->headers->setCookie(new Cookie('SF', 'V', 0, '/cookie', 'example.org', true, true, false, Cookie::SAMESITE_LAX));
break;

case '/cookie/samesite-strict':
$response = new Response($uri);
$response->headers->setCookie(new Cookie('SF', 'V', 0, null, null, true, true, false, Cookie::SAMESITE_STRICT));
break;

default:
$response = new Response('', Response::HTTP_NOT_IMPLEMENTED);
break;
}

$response->send();
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
<?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\Component\HttpFoundation\Tests;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Process\Process;

class HttpFoundationIntegrationTest extends TestCase
{
private $host = 'localhost:55876';

/** @var Process */
private $process;

protected function setUp()
{
$this->startServer();
}

protected function tearDown()
{
$this->stopServer();
}

public function testLaxSameSiteCookieIsProperlySent()
{
$cookieHeader = array_filter(
get_headers('http://'.$this->host.'/cookie/samesite-lax'),
function ($header) {
return 0 === strpos($header, 'Set-Cookie: ');
}
);

self::assertCount(1, $cookieHeader);
self::assertSame(
'Set-Cookie: SF=V; path=/cookie; samesite=lax; domain=example.org; secure; HttpOnly',
current($cookieHeader)
);
}

public function testStrictSameSiteCookieIsProperlySent()
{
$cookieHeader = array_filter(
get_headers('http://'.$this->host.'/cookie/samesite-strict'),
function ($header) {
return 0 === strpos($header, 'Set-Cookie: ');
}
);

self::assertCount(1, $cookieHeader);
self::assertSame(
'Set-Cookie: SF=V; path=/; samesite=strict; secure; HttpOnly',
current($cookieHeader)
);
}

private function startServer()
{
$this->process = new Process('php -S '.$this->host.' '.__DIR__.'/Fixtures/server.php&>/dev/null');
$this->process->start();

$count = 0;
do {
$result = @file_get_contents('http://'.$this->host.'/ping');
usleep(100);
} while ('pong' !== $result && ++$count < 10);
}

private function stopServer()
{
$this->process->stop();
}
}