Merged
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
1 change: 1 addition & 0 deletions depfile.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,6 +172,7 @@ ruleset:
HTTP:
- Cookie
- Files
- Security
- URI
Images:
- Files
Expand Down
6 changes: 6 additions & 0 deletions system/Cookie/CookieStore.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,8 @@ public function remove(string $name, string $prefix = '')

/**
* Dispatches all cookies in store.
*
* @deprecated Response should dispatch cookies.
*/
public function dispatch(): void
{
Expand DownExpand Up@@ -232,6 +234,8 @@ protected function validateCookies(array $cookies): void
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setRawCookie(string $name, string $value, array $options): void
{
Expand All@@ -242,6 +246,8 @@ protected function setRawCookie(string $name, string $value, array $options): vo
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setCookie(string $name, string $value, array $options): void
{
Expand Down
75 changes: 63 additions & 12 deletions system/HTTP/ResponseTrait.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,13 +16,14 @@
use CodeIgniter\Cookie\Exceptions\CookieException;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\Services;
use DateTime;
use DateTimeZone;
use InvalidArgumentException;

/**
* Request Trait
* Response Trait
*
* Additional methods to make a PSR-7 Response class
* compliant with the framework's own ResponseInterface.
Expand DownExpand Up@@ -446,7 +447,7 @@ public function send()
}

/**
* Sends the headers of this HTTP request to the browser.
* Sends the headers of this HTTP response to the browser.
*
* @return Response
*/
Expand DownExpand Up@@ -535,15 +536,15 @@ public function redirect(string $uri, string $method = 'auto', ?int $code = null
* Accepts an arbitrary number of binds (up to 7) or an associative
* array in the first parameter containing all the values.
*
* @param array|string $name Cookie name or array containing binds
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
* @param array|Cookie|string $name Cookie name / array containing binds / Cookie object
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
*
* @return $this
*/
Expand All@@ -558,6 +559,12 @@ public function setCookie(
$httponly = false,
$samesite = null
) {
if ($name instanceof Cookie) {
$this->cookieStore = $this->cookieStore->put($name);

return $this;
}

if (is_array($name)) {
// always leave 'name' in last place, as the loop will break otherwise, due to $$item
foreach (['samesite', 'value', 'expire', 'domain', 'path', 'prefix', 'secure', 'httponly', 'name'] as $item) {
Expand DownExpand Up@@ -689,7 +696,51 @@ protected function sendCookies()
return;
}

$this->cookieStore->dispatch();
$this->dispatchCookies();
}

private function dispatchCookies(): void
{
/** @var IncomingRequest $request */
$request = Services::request();

foreach ($this->cookieStore->display() as $cookie) {
if ($cookie->isSecure() && ! $request->isSecure()) {
throw SecurityException::forDisallowedAction();
}

$name = $cookie->getPrefixedName();
$value = $cookie->getValue();
$options = $cookie->getOptions();

if ($cookie->isRaw()) {
$this->doSetRawCookie($name, $value, $options);
} else {
$this->doSetCookie($name, $value, $options);
}
}

$this->cookieStore->clear();
}

/**
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetRawCookie(string $name, string $value, array $options): void
{
setrawcookie($name, $value, $options);
}

/**
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetCookie(string $name, string $value, array $options): void
{
setcookie($name, $value, $options);
}

/**
Expand Down
10 changes: 9 additions & 1 deletion system/Security/Security.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\Response;
use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Session\Session;
use Config\App;
Expand DownExpand Up@@ -528,13 +529,18 @@ private function saveHashInCookie(): void
'expires' => $this->expires === 0 ? 0 : time() + $this->expires,
]
);
$this->sendCookie($this->request);

/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Comment on lines +533 to +535

@mostafakhudairmostafakhudairDec 7, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Any point of storing response service in a variable?

Suggested change
/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Services::response()->setCookie($this->cookie);

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

To explicitly indicate dependency.
This is also to avoid disabling the deptrac check.

You may like the short code, but it hides the dependency Response.
deptrac can't detect it.

Services::response()->setCookie($this->cookie);

}

/**
* CSRF Send Cookie
*
* @return false|Security
*
* @deprecated Set cookies to Response object instead.
*/
protected function sendCookie(RequestInterface $request)
{
Expand All@@ -553,6 +559,8 @@ protected function sendCookie(RequestInterface $request)
* Extracted for this to be unit tested.
*
* @codeCoverageIgnore
*
* @deprecated Set cookies to Response object instead.
*/
protected function doSendCookie(): void
{
Expand Down
6 changes: 3 additions & 3 deletions tests/system/CommonFunctionsTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,10 @@ final class CommonFunctionsTest extends CIUnitTestCase
{
protected function setUp(): void
{
parent::setUp();
$renderer = Services::renderer();
$renderer->resetData();
unset($_ENV['foo'], $_SERVER['foo']);
Services::reset();

parent::setUp();
}

public function testStringifyAttributes()
Expand Down
11 changes: 11 additions & 0 deletions tests/system/HTTP/ResponseCookieTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,17 @@ public function testCookiesAll()
$this->assertTrue($response->hasCookie('bee'));
}

public function testSetCookieObject()
{
$cookie = new Cookie('foo', 'bar');
$response = new Response(new App());

$response->setCookie($cookie);

$this->assertCount(1, $response->getCookies());
$this->assertTrue($response->hasCookie('foo'));
}

public function testCookieGet()
{
$response = new Response(new App());
Expand Down
36 changes: 36 additions & 0 deletions tests/system/HTTP/ResponseSendTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,8 +11,10 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Test\CIUnitTestCase;
use Config\App;
use Config\Services;

/**
* This test suite has been created separately from
Expand DownExpand Up@@ -135,4 +137,38 @@ public function testRedirectResponseCookies()
$this->assertHeaderEmitted('Set-Cookie: foo=bar;');
$this->assertHeaderEmitted('Set-Cookie: login_time');
}

/**
* Make sure secure cookies are not sent with HTTP request
*
* @ runInSeparateProcess
* @ preserveGlobalState disabled
*/
public function testDoNotSendUnSecureCookie(): void
{
$this->expectException(SecurityException::class);
$this->expectExceptionMessage('The action you requested is not allowed');

$request = $this->createMock(IncomingRequest::class);
$request->method('isSecure')->willReturn(false);
Services::injectMock('request', $request);

$response = new Response(new App());
$response->pretend(false);
$body = 'Hello';
$response->setBody($body);

$response->setCookie(
'foo',
'bar',
'',
'',
'/',
'',
true
);

// send it
$response->send();
}
}
8 changes: 6 additions & 2 deletions tests/system/HTTP/ResponseTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,14 +30,18 @@ final class ResponseTest extends CIUnitTestCase

protected function setUp(): void
{
parent::setUp();
$this->server = $_SERVER;

Services::reset();

parent::setUp();
}

protected function tearDown(): void
{
$_SERVER = $this->server;
Factories::reset('config');

$_SERVER = $this->server;
}

public function testCanSetStatusCode()
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
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
1 change: 1 addition & 0 deletions depfile.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,6 +172,7 @@ ruleset:
HTTP:
- Cookie
- Files
- Security
- URI
Images:
- Files
Expand Down
6 changes: 6 additions & 0 deletions system/Cookie/CookieStore.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,8 @@ public function remove(string $name, string $prefix = '')

/**
* Dispatches all cookies in store.
*
* @deprecated Response should dispatch cookies.
*/
public function dispatch(): void
{
Expand DownExpand Up@@ -232,6 +234,8 @@ protected function validateCookies(array $cookies): void
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setRawCookie(string $name, string $value, array $options): void
{
Expand All@@ -242,6 +246,8 @@ protected function setRawCookie(string $name, string $value, array $options): vo
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setCookie(string $name, string $value, array $options): void
{
Expand Down
75 changes: 63 additions & 12 deletions system/HTTP/ResponseTrait.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,13 +16,14 @@
use CodeIgniter\Cookie\Exceptions\CookieException;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\Services;
use DateTime;
use DateTimeZone;
use InvalidArgumentException;

/**
* Request Trait
* Response Trait
*
* Additional methods to make a PSR-7 Response class
* compliant with the framework's own ResponseInterface.
Expand DownExpand Up@@ -446,7 +447,7 @@ public function send()
}

/**
* Sends the headers of this HTTP request to the browser.
* Sends the headers of this HTTP response to the browser.
*
* @return Response
*/
Expand DownExpand Up@@ -535,15 +536,15 @@ public function redirect(string $uri, string $method = 'auto', ?int $code = null
* Accepts an arbitrary number of binds (up to 7) or an associative
* array in the first parameter containing all the values.
*
* @param array|string $name Cookie name or array containing binds
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
* @param array|Cookie|string $name Cookie name / array containing binds / Cookie object
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
*
* @return $this
*/
Expand All@@ -558,6 +559,12 @@ public function setCookie(
$httponly = false,
$samesite = null
) {
if ($name instanceof Cookie) {
$this->cookieStore = $this->cookieStore->put($name);

return $this;
}

if (is_array($name)) {
// always leave 'name' in last place, as the loop will break otherwise, due to $$item
foreach (['samesite', 'value', 'expire', 'domain', 'path', 'prefix', 'secure', 'httponly', 'name'] as $item) {
Expand DownExpand Up@@ -689,7 +696,51 @@ protected function sendCookies()
return;
}

$this->cookieStore->dispatch();
$this->dispatchCookies();
}

private function dispatchCookies(): void
{
/** @var IncomingRequest $request */
$request = Services::request();

foreach ($this->cookieStore->display() as $cookie) {
if ($cookie->isSecure() && ! $request->isSecure()) {
throw SecurityException::forDisallowedAction();
}

$name = $cookie->getPrefixedName();
$value = $cookie->getValue();
$options = $cookie->getOptions();

if ($cookie->isRaw()) {
$this->doSetRawCookie($name, $value, $options);
} else {
$this->doSetCookie($name, $value, $options);
}
}

$this->cookieStore->clear();
}

/**
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetRawCookie(string $name, string $value, array $options): void
{
setrawcookie($name, $value, $options);
}

/**
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetCookie(string $name, string $value, array $options): void
{
setcookie($name, $value, $options);
}

/**
Expand Down
10 changes: 9 additions & 1 deletion system/Security/Security.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\Response;
use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Session\Session;
use Config\App;
Expand DownExpand Up@@ -528,13 +529,18 @@ private function saveHashInCookie(): void
'expires' => $this->expires === 0 ? 0 : time() + $this->expires,
]
);
$this->sendCookie($this->request);

/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Comment on lines +533 to +535

@mostafakhudairmostafakhudairDec 7, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Any point of storing response service in a variable?

Suggested change
/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Services::response()->setCookie($this->cookie);

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

To explicitly indicate dependency.
This is also to avoid disabling the deptrac check.

You may like the short code, but it hides the dependency Response.
deptrac can't detect it.

Services::response()->setCookie($this->cookie);

}

/**
* CSRF Send Cookie
*
* @return false|Security
*
* @deprecated Set cookies to Response object instead.
*/
protected function sendCookie(RequestInterface $request)
{
Expand All@@ -553,6 +559,8 @@ protected function sendCookie(RequestInterface $request)
* Extracted for this to be unit tested.
*
* @codeCoverageIgnore
*
* @deprecated Set cookies to Response object instead.
*/
protected function doSendCookie(): void
{
Expand Down
6 changes: 3 additions & 3 deletions tests/system/CommonFunctionsTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,10 @@ final class CommonFunctionsTest extends CIUnitTestCase
{
protected function setUp(): void
{
parent::setUp();
$renderer = Services::renderer();
$renderer->resetData();
unset($_ENV['foo'], $_SERVER['foo']);
Services::reset();

parent::setUp();
}

public function testStringifyAttributes()
Expand Down
11 changes: 11 additions & 0 deletions tests/system/HTTP/ResponseCookieTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,17 @@ public function testCookiesAll()
$this->assertTrue($response->hasCookie('bee'));
}

public function testSetCookieObject()
{
$cookie = new Cookie('foo', 'bar');
$response = new Response(new App());

$response->setCookie($cookie);

$this->assertCount(1, $response->getCookies());
$this->assertTrue($response->hasCookie('foo'));
}

public function testCookieGet()
{
$response = new Response(new App());
Expand Down
36 changes: 36 additions & 0 deletions tests/system/HTTP/ResponseSendTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,8 +11,10 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Test\CIUnitTestCase;
use Config\App;
use Config\Services;

/**
* This test suite has been created separately from
Expand DownExpand Up@@ -135,4 +137,38 @@ public function testRedirectResponseCookies()
$this->assertHeaderEmitted('Set-Cookie: foo=bar;');
$this->assertHeaderEmitted('Set-Cookie: login_time');
}

/**
* Make sure secure cookies are not sent with HTTP request
*
* @ runInSeparateProcess
* @ preserveGlobalState disabled
*/
public function testDoNotSendUnSecureCookie(): void
{
$this->expectException(SecurityException::class);
$this->expectExceptionMessage('The action you requested is not allowed');

$request = $this->createMock(IncomingRequest::class);
$request->method('isSecure')->willReturn(false);
Services::injectMock('request', $request);

$response = new Response(new App());
$response->pretend(false);
$body = 'Hello';
$response->setBody($body);

$response->setCookie(
'foo',
'bar',
'',
'',
'/',
'',
true
);

// send it
$response->send();
}
}
8 changes: 6 additions & 2 deletions tests/system/HTTP/ResponseTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,14 +30,18 @@ final class ResponseTest extends CIUnitTestCase

protected function setUp(): void
{
parent::setUp();
$this->server = $_SERVER;

Services::reset();

parent::setUp();
}

protected function tearDown(): void
{
$_SERVER = $this->server;
Factories::reset('config');

$_SERVER = $this->server;
}

public function testCanSetStatusCode()
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
1 change: 1 addition & 0 deletions depfile.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,6 +172,7 @@ ruleset:
HTTP:
- Cookie
- Files
- Security
- URI
Images:
- Files
Expand Down
6 changes: 6 additions & 0 deletions system/Cookie/CookieStore.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,8 @@ public function remove(string $name, string $prefix = '')

/**
* Dispatches all cookies in store.
*
* @deprecated Response should dispatch cookies.
*/
public function dispatch(): void
{
Expand DownExpand Up@@ -232,6 +234,8 @@ protected function validateCookies(array $cookies): void
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setRawCookie(string $name, string $value, array $options): void
{
Expand All@@ -242,6 +246,8 @@ protected function setRawCookie(string $name, string $value, array $options): vo
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setCookie(string $name, string $value, array $options): void
{
Expand Down
75 changes: 63 additions & 12 deletions system/HTTP/ResponseTrait.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,13 +16,14 @@
use CodeIgniter\Cookie\Exceptions\CookieException;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\Services;
use DateTime;
use DateTimeZone;
use InvalidArgumentException;

/**
* Request Trait
* Response Trait
*
* Additional methods to make a PSR-7 Response class
* compliant with the framework's own ResponseInterface.
Expand DownExpand Up@@ -446,7 +447,7 @@ public function send()
}

/**
* Sends the headers of this HTTP request to the browser.
* Sends the headers of this HTTP response to the browser.
*
* @return Response
*/
Expand DownExpand Up@@ -535,15 +536,15 @@ public function redirect(string $uri, string $method = 'auto', ?int $code = null
* Accepts an arbitrary number of binds (up to 7) or an associative
* array in the first parameter containing all the values.
*
* @param array|string $name Cookie name or array containing binds
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
* @param array|Cookie|string $name Cookie name / array containing binds / Cookie object
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
*
* @return $this
*/
Expand All@@ -558,6 +559,12 @@ public function setCookie(
$httponly = false,
$samesite = null
) {
if ($name instanceof Cookie) {
$this->cookieStore = $this->cookieStore->put($name);

return $this;
}

if (is_array($name)) {
// always leave 'name' in last place, as the loop will break otherwise, due to $$item
foreach (['samesite', 'value', 'expire', 'domain', 'path', 'prefix', 'secure', 'httponly', 'name'] as $item) {
Expand DownExpand Up@@ -689,7 +696,51 @@ protected function sendCookies()
return;
}

$this->cookieStore->dispatch();
$this->dispatchCookies();
}

private function dispatchCookies(): void
{
/** @var IncomingRequest $request */
$request = Services::request();

foreach ($this->cookieStore->display() as $cookie) {
if ($cookie->isSecure() && ! $request->isSecure()) {
throw SecurityException::forDisallowedAction();
}

$name = $cookie->getPrefixedName();
$value = $cookie->getValue();
$options = $cookie->getOptions();

if ($cookie->isRaw()) {
$this->doSetRawCookie($name, $value, $options);
} else {
$this->doSetCookie($name, $value, $options);
}
}

$this->cookieStore->clear();
}

/**
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetRawCookie(string $name, string $value, array $options): void
{
setrawcookie($name, $value, $options);
}

/**
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetCookie(string $name, string $value, array $options): void
{
setcookie($name, $value, $options);
}

/**
Expand Down
10 changes: 9 additions & 1 deletion system/Security/Security.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\Response;
use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Session\Session;
use Config\App;
Expand DownExpand Up@@ -528,13 +529,18 @@ private function saveHashInCookie(): void
'expires' => $this->expires === 0 ? 0 : time() + $this->expires,
]
);
$this->sendCookie($this->request);

/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Comment on lines +533 to +535

@mostafakhudairmostafakhudairDec 7, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Any point of storing response service in a variable?

Suggested change
/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Services::response()->setCookie($this->cookie);

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

To explicitly indicate dependency.
This is also to avoid disabling the deptrac check.

You may like the short code, but it hides the dependency Response.
deptrac can't detect it.

Services::response()->setCookie($this->cookie);

}

/**
* CSRF Send Cookie
*
* @return false|Security
*
* @deprecated Set cookies to Response object instead.
*/
protected function sendCookie(RequestInterface $request)
{
Expand All@@ -553,6 +559,8 @@ protected function sendCookie(RequestInterface $request)
* Extracted for this to be unit tested.
*
* @codeCoverageIgnore
*
* @deprecated Set cookies to Response object instead.
*/
protected function doSendCookie(): void
{
Expand Down
6 changes: 3 additions & 3 deletions tests/system/CommonFunctionsTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,10 @@ final class CommonFunctionsTest extends CIUnitTestCase
{
protected function setUp(): void
{
parent::setUp();
$renderer = Services::renderer();
$renderer->resetData();
unset($_ENV['foo'], $_SERVER['foo']);
Services::reset();

parent::setUp();
}

public function testStringifyAttributes()
Expand Down
11 changes: 11 additions & 0 deletions tests/system/HTTP/ResponseCookieTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,17 @@ public function testCookiesAll()
$this->assertTrue($response->hasCookie('bee'));
}

public function testSetCookieObject()
{
$cookie = new Cookie('foo', 'bar');
$response = new Response(new App());

$response->setCookie($cookie);

$this->assertCount(1, $response->getCookies());
$this->assertTrue($response->hasCookie('foo'));
}

public function testCookieGet()
{
$response = new Response(new App());
Expand Down
36 changes: 36 additions & 0 deletions tests/system/HTTP/ResponseSendTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,8 +11,10 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Test\CIUnitTestCase;
use Config\App;
use Config\Services;

/**
* This test suite has been created separately from
Expand DownExpand Up@@ -135,4 +137,38 @@ public function testRedirectResponseCookies()
$this->assertHeaderEmitted('Set-Cookie: foo=bar;');
$this->assertHeaderEmitted('Set-Cookie: login_time');
}

/**
* Make sure secure cookies are not sent with HTTP request
*
* @ runInSeparateProcess
* @ preserveGlobalState disabled
*/
public function testDoNotSendUnSecureCookie(): void
{
$this->expectException(SecurityException::class);
$this->expectExceptionMessage('The action you requested is not allowed');

$request = $this->createMock(IncomingRequest::class);
$request->method('isSecure')->willReturn(false);
Services::injectMock('request', $request);

$response = new Response(new App());
$response->pretend(false);
$body = 'Hello';
$response->setBody($body);

$response->setCookie(
'foo',
'bar',
'',
'',
'/',
'',
true
);

// send it
$response->send();
}
}
8 changes: 6 additions & 2 deletions tests/system/HTTP/ResponseTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,14 +30,18 @@ final class ResponseTest extends CIUnitTestCase

protected function setUp(): void
{
parent::setUp();
$this->server = $_SERVER;

Services::reset();

parent::setUp();
}

protected function tearDown(): void
{
$_SERVER = $this->server;
Factories::reset('config');

$_SERVER = $this->server;
}

public function testCanSetStatusCode()
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
1 change: 1 addition & 0 deletions depfile.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,6 +172,7 @@ ruleset:
HTTP:
- Cookie
- Files
- Security
- URI
Images:
- Files
Expand Down
6 changes: 6 additions & 0 deletions system/Cookie/CookieStore.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,8 @@ public function remove(string $name, string $prefix = '')

/**
* Dispatches all cookies in store.
*
* @deprecated Response should dispatch cookies.
*/
public function dispatch(): void
{
Expand DownExpand Up@@ -232,6 +234,8 @@ protected function validateCookies(array $cookies): void
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setRawCookie(string $name, string $value, array $options): void
{
Expand All@@ -242,6 +246,8 @@ protected function setRawCookie(string $name, string $value, array $options): vo
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setCookie(string $name, string $value, array $options): void
{
Expand Down
75 changes: 63 additions & 12 deletions system/HTTP/ResponseTrait.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,13 +16,14 @@
use CodeIgniter\Cookie\Exceptions\CookieException;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\Services;
use DateTime;
use DateTimeZone;
use InvalidArgumentException;

/**
* Request Trait
* Response Trait
*
* Additional methods to make a PSR-7 Response class
* compliant with the framework's own ResponseInterface.
Expand DownExpand Up@@ -446,7 +447,7 @@ public function send()
}

/**
* Sends the headers of this HTTP request to the browser.
* Sends the headers of this HTTP response to the browser.
*
* @return Response
*/
Expand DownExpand Up@@ -535,15 +536,15 @@ public function redirect(string $uri, string $method = 'auto', ?int $code = null
* Accepts an arbitrary number of binds (up to 7) or an associative
* array in the first parameter containing all the values.
*
* @param array|string $name Cookie name or array containing binds
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
* @param array|Cookie|string $name Cookie name / array containing binds / Cookie object
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
*
* @return $this
*/
Expand All@@ -558,6 +559,12 @@ public function setCookie(
$httponly = false,
$samesite = null
) {
if ($name instanceof Cookie) {
$this->cookieStore = $this->cookieStore->put($name);

return $this;
}

if (is_array($name)) {
// always leave 'name' in last place, as the loop will break otherwise, due to $$item
foreach (['samesite', 'value', 'expire', 'domain', 'path', 'prefix', 'secure', 'httponly', 'name'] as $item) {
Expand DownExpand Up@@ -689,7 +696,51 @@ protected function sendCookies()
return;
}

$this->cookieStore->dispatch();
$this->dispatchCookies();
}

private function dispatchCookies(): void
{
/** @var IncomingRequest $request */
$request = Services::request();

foreach ($this->cookieStore->display() as $cookie) {
if ($cookie->isSecure() && ! $request->isSecure()) {
throw SecurityException::forDisallowedAction();
}

$name = $cookie->getPrefixedName();
$value = $cookie->getValue();
$options = $cookie->getOptions();

if ($cookie->isRaw()) {
$this->doSetRawCookie($name, $value, $options);
} else {
$this->doSetCookie($name, $value, $options);
}
}

$this->cookieStore->clear();
}

/**
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetRawCookie(string $name, string $value, array $options): void
{
setrawcookie($name, $value, $options);
}

/**
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetCookie(string $name, string $value, array $options): void
{
setcookie($name, $value, $options);
}

/**
Expand Down
10 changes: 9 additions & 1 deletion system/Security/Security.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\Response;
use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Session\Session;
use Config\App;
Expand DownExpand Up@@ -528,13 +529,18 @@ private function saveHashInCookie(): void
'expires' => $this->expires === 0 ? 0 : time() + $this->expires,
]
);
$this->sendCookie($this->request);

/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Comment on lines +533 to +535

@mostafakhudairmostafakhudairDec 7, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Any point of storing response service in a variable?

Suggested change
/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Services::response()->setCookie($this->cookie);

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

To explicitly indicate dependency.
This is also to avoid disabling the deptrac check.

You may like the short code, but it hides the dependency Response.
deptrac can't detect it.

Services::response()->setCookie($this->cookie);

}

/**
* CSRF Send Cookie
*
* @return false|Security
*
* @deprecated Set cookies to Response object instead.
*/
protected function sendCookie(RequestInterface $request)
{
Expand All@@ -553,6 +559,8 @@ protected function sendCookie(RequestInterface $request)
* Extracted for this to be unit tested.
*
* @codeCoverageIgnore
*
* @deprecated Set cookies to Response object instead.
*/
protected function doSendCookie(): void
{
Expand Down
6 changes: 3 additions & 3 deletions tests/system/CommonFunctionsTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,10 @@ final class CommonFunctionsTest extends CIUnitTestCase
{
protected function setUp(): void
{
parent::setUp();
$renderer = Services::renderer();
$renderer->resetData();
unset($_ENV['foo'], $_SERVER['foo']);
Services::reset();

parent::setUp();
}

public function testStringifyAttributes()
Expand Down
11 changes: 11 additions & 0 deletions tests/system/HTTP/ResponseCookieTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,17 @@ public function testCookiesAll()
$this->assertTrue($response->hasCookie('bee'));
}

public function testSetCookieObject()
{
$cookie = new Cookie('foo', 'bar');
$response = new Response(new App());

$response->setCookie($cookie);

$this->assertCount(1, $response->getCookies());
$this->assertTrue($response->hasCookie('foo'));
}

public function testCookieGet()
{
$response = new Response(new App());
Expand Down
36 changes: 36 additions & 0 deletions tests/system/HTTP/ResponseSendTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,8 +11,10 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Test\CIUnitTestCase;
use Config\App;
use Config\Services;

/**
* This test suite has been created separately from
Expand DownExpand Up@@ -135,4 +137,38 @@ public function testRedirectResponseCookies()
$this->assertHeaderEmitted('Set-Cookie: foo=bar;');
$this->assertHeaderEmitted('Set-Cookie: login_time');
}

/**
* Make sure secure cookies are not sent with HTTP request
*
* @ runInSeparateProcess
* @ preserveGlobalState disabled
*/
public function testDoNotSendUnSecureCookie(): void
{
$this->expectException(SecurityException::class);
$this->expectExceptionMessage('The action you requested is not allowed');

$request = $this->createMock(IncomingRequest::class);
$request->method('isSecure')->willReturn(false);
Services::injectMock('request', $request);

$response = new Response(new App());
$response->pretend(false);
$body = 'Hello';
$response->setBody($body);

$response->setCookie(
'foo',
'bar',
'',
'',
'/',
'',
true
);

// send it
$response->send();
}
}
8 changes: 6 additions & 2 deletions tests/system/HTTP/ResponseTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,14 +30,18 @@ final class ResponseTest extends CIUnitTestCase

protected function setUp(): void
{
parent::setUp();
$this->server = $_SERVER;

Services::reset();

parent::setUp();
}

protected function tearDown(): void
{
$_SERVER = $this->server;
Factories::reset('config');

$_SERVER = $this->server;
}

public function testCanSetStatusCode()
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
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
1 change: 1 addition & 0 deletions depfile.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,6 +172,7 @@ ruleset:
HTTP:
- Cookie
- Files
- Security
- URI
Images:
- Files
Expand Down
6 changes: 6 additions & 0 deletions system/Cookie/CookieStore.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,8 @@ public function remove(string $name, string $prefix = '')

/**
* Dispatches all cookies in store.
*
* @deprecated Response should dispatch cookies.
*/
public function dispatch(): void
{
Expand DownExpand Up@@ -232,6 +234,8 @@ protected function validateCookies(array $cookies): void
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setRawCookie(string $name, string $value, array $options): void
{
Expand All@@ -242,6 +246,8 @@ protected function setRawCookie(string $name, string $value, array $options): vo
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setCookie(string $name, string $value, array $options): void
{
Expand Down
75 changes: 63 additions & 12 deletions system/HTTP/ResponseTrait.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,13 +16,14 @@
use CodeIgniter\Cookie\Exceptions\CookieException;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\Services;
use DateTime;
use DateTimeZone;
use InvalidArgumentException;

/**
* Request Trait
* Response Trait
*
* Additional methods to make a PSR-7 Response class
* compliant with the framework's own ResponseInterface.
Expand DownExpand Up@@ -446,7 +447,7 @@ public function send()
}

/**
* Sends the headers of this HTTP request to the browser.
* Sends the headers of this HTTP response to the browser.
*
* @return Response
*/
Expand DownExpand Up@@ -535,15 +536,15 @@ public function redirect(string $uri, string $method = 'auto', ?int $code = null
* Accepts an arbitrary number of binds (up to 7) or an associative
* array in the first parameter containing all the values.
*
* @param array|string $name Cookie name or array containing binds
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
* @param array|Cookie|string $name Cookie name / array containing binds / Cookie object
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
*
* @return $this
*/
Expand All@@ -558,6 +559,12 @@ public function setCookie(
$httponly = false,
$samesite = null
) {
if ($name instanceof Cookie) {
$this->cookieStore = $this->cookieStore->put($name);

return $this;
}

if (is_array($name)) {
// always leave 'name' in last place, as the loop will break otherwise, due to $$item
foreach (['samesite', 'value', 'expire', 'domain', 'path', 'prefix', 'secure', 'httponly', 'name'] as $item) {
Expand DownExpand Up@@ -689,7 +696,51 @@ protected function sendCookies()
return;
}

$this->cookieStore->dispatch();
$this->dispatchCookies();
}

private function dispatchCookies(): void
{
/** @var IncomingRequest $request */
$request = Services::request();

foreach ($this->cookieStore->display() as $cookie) {
if ($cookie->isSecure() && ! $request->isSecure()) {
throw SecurityException::forDisallowedAction();
}

$name = $cookie->getPrefixedName();
$value = $cookie->getValue();
$options = $cookie->getOptions();

if ($cookie->isRaw()) {
$this->doSetRawCookie($name, $value, $options);
} else {
$this->doSetCookie($name, $value, $options);
}
}

$this->cookieStore->clear();
}

/**
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetRawCookie(string $name, string $value, array $options): void
{
setrawcookie($name, $value, $options);
}

/**
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetCookie(string $name, string $value, array $options): void
{
setcookie($name, $value, $options);
}

/**
Expand Down
10 changes: 9 additions & 1 deletion system/Security/Security.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\Response;
use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Session\Session;
use Config\App;
Expand DownExpand Up@@ -528,13 +529,18 @@ private function saveHashInCookie(): void
'expires' => $this->expires === 0 ? 0 : time() + $this->expires,
]
);
$this->sendCookie($this->request);

/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Comment on lines +533 to +535

@mostafakhudairmostafakhudairDec 7, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Any point of storing response service in a variable?

Suggested change
/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Services::response()->setCookie($this->cookie);

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

To explicitly indicate dependency.
This is also to avoid disabling the deptrac check.

You may like the short code, but it hides the dependency Response.
deptrac can't detect it.

Services::response()->setCookie($this->cookie);

}

/**
* CSRF Send Cookie
*
* @return false|Security
*
* @deprecated Set cookies to Response object instead.
*/
protected function sendCookie(RequestInterface $request)
{
Expand All@@ -553,6 +559,8 @@ protected function sendCookie(RequestInterface $request)
* Extracted for this to be unit tested.
*
* @codeCoverageIgnore
*
* @deprecated Set cookies to Response object instead.
*/
protected function doSendCookie(): void
{
Expand Down
6 changes: 3 additions & 3 deletions tests/system/CommonFunctionsTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,10 @@ final class CommonFunctionsTest extends CIUnitTestCase
{
protected function setUp(): void
{
parent::setUp();
$renderer = Services::renderer();
$renderer->resetData();
unset($_ENV['foo'], $_SERVER['foo']);
Services::reset();

parent::setUp();
}

public function testStringifyAttributes()
Expand Down
11 changes: 11 additions & 0 deletions tests/system/HTTP/ResponseCookieTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,17 @@ public function testCookiesAll()
$this->assertTrue($response->hasCookie('bee'));
}

public function testSetCookieObject()
{
$cookie = new Cookie('foo', 'bar');
$response = new Response(new App());

$response->setCookie($cookie);

$this->assertCount(1, $response->getCookies());
$this->assertTrue($response->hasCookie('foo'));
}

public function testCookieGet()
{
$response = new Response(new App());
Expand Down
36 changes: 36 additions & 0 deletions tests/system/HTTP/ResponseSendTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,8 +11,10 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Test\CIUnitTestCase;
use Config\App;
use Config\Services;

/**
* This test suite has been created separately from
Expand DownExpand Up@@ -135,4 +137,38 @@ public function testRedirectResponseCookies()
$this->assertHeaderEmitted('Set-Cookie: foo=bar;');
$this->assertHeaderEmitted('Set-Cookie: login_time');
}

/**
* Make sure secure cookies are not sent with HTTP request
*
* @ runInSeparateProcess
* @ preserveGlobalState disabled
*/
public function testDoNotSendUnSecureCookie(): void
{
$this->expectException(SecurityException::class);
$this->expectExceptionMessage('The action you requested is not allowed');

$request = $this->createMock(IncomingRequest::class);
$request->method('isSecure')->willReturn(false);
Services::injectMock('request', $request);

$response = new Response(new App());
$response->pretend(false);
$body = 'Hello';
$response->setBody($body);

$response->setCookie(
'foo',
'bar',
'',
'',
'/',
'',
true
);

// send it
$response->send();
}
}
8 changes: 6 additions & 2 deletions tests/system/HTTP/ResponseTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,14 +30,18 @@ final class ResponseTest extends CIUnitTestCase

protected function setUp(): void
{
parent::setUp();
$this->server = $_SERVER;

Services::reset();

parent::setUp();
}

protected function tearDown(): void
{
$_SERVER = $this->server;
Factories::reset('config');

$_SERVER = $this->server;
}

public function testCanSetStatusCode()
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
1 change: 1 addition & 0 deletions depfile.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,6 +172,7 @@ ruleset:
HTTP:
- Cookie
- Files
- Security
- URI
Images:
- Files
Expand Down
6 changes: 6 additions & 0 deletions system/Cookie/CookieStore.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,8 @@ public function remove(string $name, string $prefix = '')

/**
* Dispatches all cookies in store.
*
* @deprecated Response should dispatch cookies.
*/
public function dispatch(): void
{
Expand DownExpand Up@@ -232,6 +234,8 @@ protected function validateCookies(array $cookies): void
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setRawCookie(string $name, string $value, array $options): void
{
Expand All@@ -242,6 +246,8 @@ protected function setRawCookie(string $name, string $value, array $options): vo
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setCookie(string $name, string $value, array $options): void
{
Expand Down
75 changes: 63 additions & 12 deletions system/HTTP/ResponseTrait.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,13 +16,14 @@
use CodeIgniter\Cookie\Exceptions\CookieException;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\Services;
use DateTime;
use DateTimeZone;
use InvalidArgumentException;

/**
* Request Trait
* Response Trait
*
* Additional methods to make a PSR-7 Response class
* compliant with the framework's own ResponseInterface.
Expand DownExpand Up@@ -446,7 +447,7 @@ public function send()
}

/**
* Sends the headers of this HTTP request to the browser.
* Sends the headers of this HTTP response to the browser.
*
* @return Response
*/
Expand DownExpand Up@@ -535,15 +536,15 @@ public function redirect(string $uri, string $method = 'auto', ?int $code = null
* Accepts an arbitrary number of binds (up to 7) or an associative
* array in the first parameter containing all the values.
*
* @param array|string $name Cookie name or array containing binds
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
* @param array|Cookie|string $name Cookie name / array containing binds / Cookie object
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
*
* @return $this
*/
Expand All@@ -558,6 +559,12 @@ public function setCookie(
$httponly = false,
$samesite = null
) {
if ($name instanceof Cookie) {
$this->cookieStore = $this->cookieStore->put($name);

return $this;
}

if (is_array($name)) {
// always leave 'name' in last place, as the loop will break otherwise, due to $$item
foreach (['samesite', 'value', 'expire', 'domain', 'path', 'prefix', 'secure', 'httponly', 'name'] as $item) {
Expand DownExpand Up@@ -689,7 +696,51 @@ protected function sendCookies()
return;
}

$this->cookieStore->dispatch();
$this->dispatchCookies();
}

private function dispatchCookies(): void
{
/** @var IncomingRequest $request */
$request = Services::request();

foreach ($this->cookieStore->display() as $cookie) {
if ($cookie->isSecure() && ! $request->isSecure()) {
throw SecurityException::forDisallowedAction();
}

$name = $cookie->getPrefixedName();
$value = $cookie->getValue();
$options = $cookie->getOptions();

if ($cookie->isRaw()) {
$this->doSetRawCookie($name, $value, $options);
} else {
$this->doSetCookie($name, $value, $options);
}
}

$this->cookieStore->clear();
}

/**
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetRawCookie(string $name, string $value, array $options): void
{
setrawcookie($name, $value, $options);
}

/**
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetCookie(string $name, string $value, array $options): void
{
setcookie($name, $value, $options);
}

/**
Expand Down
10 changes: 9 additions & 1 deletion system/Security/Security.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\Response;
use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Session\Session;
use Config\App;
Expand DownExpand Up@@ -528,13 +529,18 @@ private function saveHashInCookie(): void
'expires' => $this->expires === 0 ? 0 : time() + $this->expires,
]
);
$this->sendCookie($this->request);

/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Comment on lines +533 to +535

@mostafakhudairmostafakhudairDec 7, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Any point of storing response service in a variable?

Suggested change
/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Services::response()->setCookie($this->cookie);

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

To explicitly indicate dependency.
This is also to avoid disabling the deptrac check.

You may like the short code, but it hides the dependency Response.
deptrac can't detect it.

Services::response()->setCookie($this->cookie);

}

/**
* CSRF Send Cookie
*
* @return false|Security
*
* @deprecated Set cookies to Response object instead.
*/
protected function sendCookie(RequestInterface $request)
{
Expand All@@ -553,6 +559,8 @@ protected function sendCookie(RequestInterface $request)
* Extracted for this to be unit tested.
*
* @codeCoverageIgnore
*
* @deprecated Set cookies to Response object instead.
*/
protected function doSendCookie(): void
{
Expand Down
6 changes: 3 additions & 3 deletions tests/system/CommonFunctionsTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,10 @@ final class CommonFunctionsTest extends CIUnitTestCase
{
protected function setUp(): void
{
parent::setUp();
$renderer = Services::renderer();
$renderer->resetData();
unset($_ENV['foo'], $_SERVER['foo']);
Services::reset();

parent::setUp();
}

public function testStringifyAttributes()
Expand Down
11 changes: 11 additions & 0 deletions tests/system/HTTP/ResponseCookieTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,17 @@ public function testCookiesAll()
$this->assertTrue($response->hasCookie('bee'));
}

public function testSetCookieObject()
{
$cookie = new Cookie('foo', 'bar');
$response = new Response(new App());

$response->setCookie($cookie);

$this->assertCount(1, $response->getCookies());
$this->assertTrue($response->hasCookie('foo'));
}

public function testCookieGet()
{
$response = new Response(new App());
Expand Down
36 changes: 36 additions & 0 deletions tests/system/HTTP/ResponseSendTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,8 +11,10 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Test\CIUnitTestCase;
use Config\App;
use Config\Services;

/**
* This test suite has been created separately from
Expand DownExpand Up@@ -135,4 +137,38 @@ public function testRedirectResponseCookies()
$this->assertHeaderEmitted('Set-Cookie: foo=bar;');
$this->assertHeaderEmitted('Set-Cookie: login_time');
}

/**
* Make sure secure cookies are not sent with HTTP request
*
* @ runInSeparateProcess
* @ preserveGlobalState disabled
*/
public function testDoNotSendUnSecureCookie(): void
{
$this->expectException(SecurityException::class);
$this->expectExceptionMessage('The action you requested is not allowed');

$request = $this->createMock(IncomingRequest::class);
$request->method('isSecure')->willReturn(false);
Services::injectMock('request', $request);

$response = new Response(new App());
$response->pretend(false);
$body = 'Hello';
$response->setBody($body);

$response->setCookie(
'foo',
'bar',
'',
'',
'/',
'',
true
);

// send it
$response->send();
}
}
8 changes: 6 additions & 2 deletions tests/system/HTTP/ResponseTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,14 +30,18 @@ final class ResponseTest extends CIUnitTestCase

protected function setUp(): void
{
parent::setUp();
$this->server = $_SERVER;

Services::reset();

parent::setUp();
}

protected function tearDown(): void
{
$_SERVER = $this->server;
Factories::reset('config');

$_SERVER = $this->server;
}

public function testCanSetStatusCode()
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
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
1 change: 1 addition & 0 deletions depfile.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,6 +172,7 @@ ruleset:
HTTP:
- Cookie
- Files
- Security
- URI
Images:
- Files
Expand Down
6 changes: 6 additions & 0 deletions system/Cookie/CookieStore.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,8 @@ public function remove(string $name, string $prefix = '')

/**
* Dispatches all cookies in store.
*
* @deprecated Response should dispatch cookies.
*/
public function dispatch(): void
{
Expand DownExpand Up@@ -232,6 +234,8 @@ protected function validateCookies(array $cookies): void
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setRawCookie(string $name, string $value, array $options): void
{
Expand All@@ -242,6 +246,8 @@ protected function setRawCookie(string $name, string $value, array $options): vo
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setCookie(string $name, string $value, array $options): void
{
Expand Down
75 changes: 63 additions & 12 deletions system/HTTP/ResponseTrait.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,13 +16,14 @@
use CodeIgniter\Cookie\Exceptions\CookieException;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\Services;
use DateTime;
use DateTimeZone;
use InvalidArgumentException;

/**
* Request Trait
* Response Trait
*
* Additional methods to make a PSR-7 Response class
* compliant with the framework's own ResponseInterface.
Expand DownExpand Up@@ -446,7 +447,7 @@ public function send()
}

/**
* Sends the headers of this HTTP request to the browser.
* Sends the headers of this HTTP response to the browser.
*
* @return Response
*/
Expand DownExpand Up@@ -535,15 +536,15 @@ public function redirect(string $uri, string $method = 'auto', ?int $code = null
* Accepts an arbitrary number of binds (up to 7) or an associative
* array in the first parameter containing all the values.
*
* @param array|string $name Cookie name or array containing binds
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
* @param array|Cookie|string $name Cookie name / array containing binds / Cookie object
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
*
* @return $this
*/
Expand All@@ -558,6 +559,12 @@ public function setCookie(
$httponly = false,
$samesite = null
) {
if ($name instanceof Cookie) {
$this->cookieStore = $this->cookieStore->put($name);

return $this;
}

if (is_array($name)) {
// always leave 'name' in last place, as the loop will break otherwise, due to $$item
foreach (['samesite', 'value', 'expire', 'domain', 'path', 'prefix', 'secure', 'httponly', 'name'] as $item) {
Expand DownExpand Up@@ -689,7 +696,51 @@ protected function sendCookies()
return;
}

$this->cookieStore->dispatch();
$this->dispatchCookies();
}

private function dispatchCookies(): void
{
/** @var IncomingRequest $request */
$request = Services::request();

foreach ($this->cookieStore->display() as $cookie) {
if ($cookie->isSecure() && ! $request->isSecure()) {
throw SecurityException::forDisallowedAction();
}

$name = $cookie->getPrefixedName();
$value = $cookie->getValue();
$options = $cookie->getOptions();

if ($cookie->isRaw()) {
$this->doSetRawCookie($name, $value, $options);
} else {
$this->doSetCookie($name, $value, $options);
}
}

$this->cookieStore->clear();
}

/**
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetRawCookie(string $name, string $value, array $options): void
{
setrawcookie($name, $value, $options);
}

/**
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetCookie(string $name, string $value, array $options): void
{
setcookie($name, $value, $options);
}

/**
Expand Down
10 changes: 9 additions & 1 deletion system/Security/Security.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\Response;
use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Session\Session;
use Config\App;
Expand DownExpand Up@@ -528,13 +529,18 @@ private function saveHashInCookie(): void
'expires' => $this->expires === 0 ? 0 : time() + $this->expires,
]
);
$this->sendCookie($this->request);

/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Comment on lines +533 to +535

@mostafakhudairmostafakhudairDec 7, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Any point of storing response service in a variable?

Suggested change
/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Services::response()->setCookie($this->cookie);

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

To explicitly indicate dependency.
This is also to avoid disabling the deptrac check.

You may like the short code, but it hides the dependency Response.
deptrac can't detect it.

Services::response()->setCookie($this->cookie);

}

/**
* CSRF Send Cookie
*
* @return false|Security
*
* @deprecated Set cookies to Response object instead.
*/
protected function sendCookie(RequestInterface $request)
{
Expand All@@ -553,6 +559,8 @@ protected function sendCookie(RequestInterface $request)
* Extracted for this to be unit tested.
*
* @codeCoverageIgnore
*
* @deprecated Set cookies to Response object instead.
*/
protected function doSendCookie(): void
{
Expand Down
6 changes: 3 additions & 3 deletions tests/system/CommonFunctionsTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,10 @@ final class CommonFunctionsTest extends CIUnitTestCase
{
protected function setUp(): void
{
parent::setUp();
$renderer = Services::renderer();
$renderer->resetData();
unset($_ENV['foo'], $_SERVER['foo']);
Services::reset();

parent::setUp();
}

public function testStringifyAttributes()
Expand Down
11 changes: 11 additions & 0 deletions tests/system/HTTP/ResponseCookieTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,17 @@ public function testCookiesAll()
$this->assertTrue($response->hasCookie('bee'));
}

public function testSetCookieObject()
{
$cookie = new Cookie('foo', 'bar');
$response = new Response(new App());

$response->setCookie($cookie);

$this->assertCount(1, $response->getCookies());
$this->assertTrue($response->hasCookie('foo'));
}

public function testCookieGet()
{
$response = new Response(new App());
Expand Down
36 changes: 36 additions & 0 deletions tests/system/HTTP/ResponseSendTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,8 +11,10 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Test\CIUnitTestCase;
use Config\App;
use Config\Services;

/**
* This test suite has been created separately from
Expand DownExpand Up@@ -135,4 +137,38 @@ public function testRedirectResponseCookies()
$this->assertHeaderEmitted('Set-Cookie: foo=bar;');
$this->assertHeaderEmitted('Set-Cookie: login_time');
}

/**
* Make sure secure cookies are not sent with HTTP request
*
* @ runInSeparateProcess
* @ preserveGlobalState disabled
*/
public function testDoNotSendUnSecureCookie(): void
{
$this->expectException(SecurityException::class);
$this->expectExceptionMessage('The action you requested is not allowed');

$request = $this->createMock(IncomingRequest::class);
$request->method('isSecure')->willReturn(false);
Services::injectMock('request', $request);

$response = new Response(new App());
$response->pretend(false);
$body = 'Hello';
$response->setBody($body);

$response->setCookie(
'foo',
'bar',
'',
'',
'/',
'',
true
);

// send it
$response->send();
}
}
8 changes: 6 additions & 2 deletions tests/system/HTTP/ResponseTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,14 +30,18 @@ final class ResponseTest extends CIUnitTestCase

protected function setUp(): void
{
parent::setUp();
$this->server = $_SERVER;

Services::reset();

parent::setUp();
}

protected function tearDown(): void
{
$_SERVER = $this->server;
Factories::reset('config');

$_SERVER = $this->server;
}

public function testCanSetStatusCode()
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
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
1 change: 1 addition & 0 deletions depfile.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,6 +172,7 @@ ruleset:
HTTP:
- Cookie
- Files
- Security
- URI
Images:
- Files
Expand Down
6 changes: 6 additions & 0 deletions system/Cookie/CookieStore.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,8 @@ public function remove(string $name, string $prefix = '')

/**
* Dispatches all cookies in store.
*
* @deprecated Response should dispatch cookies.
*/
public function dispatch(): void
{
Expand DownExpand Up@@ -232,6 +234,8 @@ protected function validateCookies(array $cookies): void
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setRawCookie(string $name, string $value, array $options): void
{
Expand All@@ -242,6 +246,8 @@ protected function setRawCookie(string $name, string $value, array $options): vo
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
protected function setCookie(string $name, string $value, array $options): void
{
Expand Down
75 changes: 63 additions & 12 deletions system/HTTP/ResponseTrait.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,13 +16,14 @@
use CodeIgniter\Cookie\Exceptions\CookieException;
use CodeIgniter\HTTP\Exceptions\HTTPException;
use CodeIgniter\Pager\PagerInterface;
use CodeIgniter\Security\Exceptions\SecurityException;
use Config\Services;
use DateTime;
use DateTimeZone;
use InvalidArgumentException;

/**
* Request Trait
* Response Trait
*
* Additional methods to make a PSR-7 Response class
* compliant with the framework's own ResponseInterface.
Expand DownExpand Up@@ -446,7 +447,7 @@ public function send()
}

/**
* Sends the headers of this HTTP request to the browser.
* Sends the headers of this HTTP response to the browser.
*
* @return Response
*/
Expand DownExpand Up@@ -535,15 +536,15 @@ public function redirect(string $uri, string $method = 'auto', ?int $code = null
* Accepts an arbitrary number of binds (up to 7) or an associative
* array in the first parameter containing all the values.
*
* @param array|string $name Cookie name or array containing binds
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
* @param array|Cookie|string $name Cookie name / array containing binds / Cookie object
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
*
* @return $this
*/
Expand All@@ -558,6 +559,12 @@ public function setCookie(
$httponly = false,
$samesite = null
) {
if ($name instanceof Cookie) {
$this->cookieStore = $this->cookieStore->put($name);

return $this;
}

if (is_array($name)) {
// always leave 'name' in last place, as the loop will break otherwise, due to $$item
foreach (['samesite', 'value', 'expire', 'domain', 'path', 'prefix', 'secure', 'httponly', 'name'] as $item) {
Expand DownExpand Up@@ -689,7 +696,51 @@ protected function sendCookies()
return;
}

$this->cookieStore->dispatch();
$this->dispatchCookies();
}

private function dispatchCookies(): void
{
/** @var IncomingRequest $request */
$request = Services::request();

foreach ($this->cookieStore->display() as $cookie) {
if ($cookie->isSecure() && ! $request->isSecure()) {
throw SecurityException::forDisallowedAction();
}

$name = $cookie->getPrefixedName();
$value = $cookie->getValue();
$options = $cookie->getOptions();

if ($cookie->isRaw()) {
$this->doSetRawCookie($name, $value, $options);
} else {
$this->doSetCookie($name, $value, $options);
}
}

$this->cookieStore->clear();
}

/**
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetRawCookie(string $name, string $value, array $options): void
{
setrawcookie($name, $value, $options);
}

/**
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
private function doSetCookie(string $name, string $value, array $options): void
{
setcookie($name, $value, $options);
}

/**
Expand Down
10 changes: 9 additions & 1 deletion system/Security/Security.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

use CodeIgniter\Cookie\Cookie;
use CodeIgniter\HTTP\RequestInterface;
use CodeIgniter\HTTP\Response;
use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Session\Session;
use Config\App;
Expand DownExpand Up@@ -528,13 +529,18 @@ private function saveHashInCookie(): void
'expires' => $this->expires === 0 ? 0 : time() + $this->expires,
]
);
$this->sendCookie($this->request);

/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Comment on lines +533 to +535

@mostafakhudairmostafakhudairDec 7, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Any point of storing response service in a variable?

Suggested change
/** @var Response $response */
$response = Services::response();
$response->setCookie($this->cookie);
Services::response()->setCookie($this->cookie);

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

To explicitly indicate dependency.
This is also to avoid disabling the deptrac check.

You may like the short code, but it hides the dependency Response.
deptrac can't detect it.

Services::response()->setCookie($this->cookie);

}

/**
* CSRF Send Cookie
*
* @return false|Security
*
* @deprecated Set cookies to Response object instead.
*/
protected function sendCookie(RequestInterface $request)
{
Expand All@@ -553,6 +559,8 @@ protected function sendCookie(RequestInterface $request)
* Extracted for this to be unit tested.
*
* @codeCoverageIgnore
*
* @deprecated Set cookies to Response object instead.
*/
protected function doSendCookie(): void
{
Expand Down
6 changes: 3 additions & 3 deletions tests/system/CommonFunctionsTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,10 +41,10 @@ final class CommonFunctionsTest extends CIUnitTestCase
{
protected function setUp(): void
{
parent::setUp();
$renderer = Services::renderer();
$renderer->resetData();
unset($_ENV['foo'], $_SERVER['foo']);
Services::reset();

parent::setUp();
}

public function testStringifyAttributes()
Expand Down
11 changes: 11 additions & 0 deletions tests/system/HTTP/ResponseCookieTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,6 +65,17 @@ public function testCookiesAll()
$this->assertTrue($response->hasCookie('bee'));
}

public function testSetCookieObject()
{
$cookie = new Cookie('foo', 'bar');
$response = new Response(new App());

$response->setCookie($cookie);

$this->assertCount(1, $response->getCookies());
$this->assertTrue($response->hasCookie('foo'));
}

public function testCookieGet()
{
$response = new Response(new App());
Expand Down
36 changes: 36 additions & 0 deletions tests/system/HTTP/ResponseSendTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,8 +11,10 @@

namespace CodeIgniter\HTTP;

use CodeIgniter\Security\Exceptions\SecurityException;
use CodeIgniter\Test\CIUnitTestCase;
use Config\App;
use Config\Services;

/**
* This test suite has been created separately from
Expand DownExpand Up@@ -135,4 +137,38 @@ public function testRedirectResponseCookies()
$this->assertHeaderEmitted('Set-Cookie: foo=bar;');
$this->assertHeaderEmitted('Set-Cookie: login_time');
}

/**
* Make sure secure cookies are not sent with HTTP request
*
* @ runInSeparateProcess
* @ preserveGlobalState disabled
*/
public function testDoNotSendUnSecureCookie(): void
{
$this->expectException(SecurityException::class);
$this->expectExceptionMessage('The action you requested is not allowed');

$request = $this->createMock(IncomingRequest::class);
$request->method('isSecure')->willReturn(false);
Services::injectMock('request', $request);

$response = new Response(new App());
$response->pretend(false);
$body = 'Hello';
$response->setBody($body);

$response->setCookie(
'foo',
'bar',
'',
'',
'/',
'',
true
);

// send it
$response->send();
}
}
8 changes: 6 additions & 2 deletions tests/system/HTTP/ResponseTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,14 +30,18 @@ final class ResponseTest extends CIUnitTestCase

protected function setUp(): void
{
parent::setUp();
$this->server = $_SERVER;

Services::reset();

parent::setUp();
}

protected function tearDown(): void
{
$_SERVER = $this->server;
Factories::reset('config');

$_SERVER = $this->server;
}

public function testCanSetStatusCode()
Expand Down
Loading