Merge pull request #21526 from nextcloud/backport/21479/stable19

[stable19] Allow to specify the cookie type for appframework responses
This commit is contained in:
Roeland Jago Douma 2020-06-23 14:04:53 +02:00 committed by GitHub
commit 6b5db20fc9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 36 additions and 12 deletions

View File

@ -151,6 +151,8 @@ class App {
if ($value['expireDate'] instanceof \DateTime) {
$expireDate = $value['expireDate']->getTimestamp();
}
$sameSite = $value['sameSite'] ?? 'Lax';
$io->setCookie(
$name,
$value['value'],
@ -158,7 +160,8 @@ class App {
$container->getServer()->getWebRoot(),
null,
$container->getServer()->getRequest()->getServerProtocol() === 'https',
true
true,
$sameSite
);
}

View File

@ -92,8 +92,20 @@ class Output implements IOutput {
* @param bool $secure
* @param bool $httpOnly
*/
public function setCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly) {
public function setCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly, $sameSite = 'Lax') {
$path = $this->webRoot ? : '/';
if (PHP_VERSION_ID < 70300) {
setcookie($name, $value, $expire, $path, $domain, $secure, $httpOnly);
} else {
setcookie($name, $value, [
'expires' => $expire,
'path' => $path,
'domain' => $domain,
'secure' => $secure,
'httponly' => $httpOnly,
'samesite' => $sameSite
]);
}
}
}

View File

@ -72,7 +72,8 @@ interface IOutput {
* @param string $domain
* @param bool $secure
* @param bool $httpOnly
* @param string $sameSite (added in 19.0.1)
* @since 8.1.0
*/
public function setCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly);
public function setCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly, $sameSite = 'Lax');
}

View File

@ -133,11 +133,12 @@ class Response {
* @param \DateTime|null $expireDate Date on that the cookie should expire, if set
* to null cookie will be considered as session
* cookie.
* @param string $sameSite The samesite value of the cookie. Defaults to Lax. Other possibilities are Strict or None
* @return $this
* @since 8.0.0
*/
public function addCookie($name, $value, \DateTime $expireDate = null) {
$this->cookies[$name] = ['value' => $value, 'expireDate' => $expireDate];
public function addCookie($name, $value, \DateTime $expireDate = null, $sameSite = 'Lax') {
$this->cookies[$name] = ['value' => $value, 'expireDate' => $expireDate, 'sameSite' => $sameSite];
return $this;
}

View File

@ -108,10 +108,12 @@ class ResponseTest extends \Test\TestCase {
'foo' => [
'value' => 'bar',
'expireDate' => null,
'sameSite' => 'Lax',
],
'bar' => [
'value' => 'foo',
'expireDate' => new \DateTime('1970-01-01')
'expireDate' => new \DateTime('1970-01-01'),
'sameSite' => 'Lax',
]
];
$this->assertEquals($expectedResponse, $this->childResponse->getCookies());
@ -143,7 +145,8 @@ class ResponseTest extends \Test\TestCase {
$expected = [
'foo' => [
'value' => 'expired',
'expireDate' => new \DateTime('1971-01-01')
'expireDate' => new \DateTime('1971-01-01'),
'sameSite' => 'Lax',
]
];
@ -159,11 +162,13 @@ class ResponseTest extends \Test\TestCase {
$expected = [
'foo' => [
'value' => 'bar',
'expireDate' => null
'expireDate' => null,
'sameSite' => 'Lax',
],
'bar' => [
'value' => 'foo',
'expireDate' => null
'expireDate' => null,
'sameSite' => 'Lax',
]
];
$cookies = $this->childResponse->getCookies();
@ -173,11 +178,13 @@ class ResponseTest extends \Test\TestCase {
$expected = [
'foo' => [
'value' => 'expired',
'expireDate' => new \DateTime('1971-01-01')
'expireDate' => new \DateTime('1971-01-01'),
'sameSite' => 'Lax',
],
'bar' => [
'value' => 'expired',
'expireDate' => new \DateTime('1971-01-01')
'expireDate' => new \DateTime('1971-01-01'),
'sameSite' => 'Lax',
]
];