Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Cookie Prefix #6024

Closed
wants to merge 6 commits into from
Closed

Fix Cookie Prefix #6024

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d448857
update cookie
colethorsen May 24, 2022
e601082
Fixes issue with prefixed cookies and session
colethorsen May 24, 2022
b6e970f
update the userguide
colethorsen May 24, 2022
7493420
fix typo
colethorsen May 24, 2022
f1580a9
fix nullable type hint
colethorsen May 24, 2022
9d518f0
change terinary to null coalessing
colethorsen May 24, 2022
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
4 changes: 2 additions & 2 deletions system/Helpers/cookie_helper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ function set_cookie(
*
* @see \CodeIgniter\HTTP\IncomingRequest::getCookie()
*/
function get_cookie($index, bool $xssClean = false)
function get_cookie($index, bool $xssClean = false, ?string $prefix = null)
{
$prefix = isset($_COOKIE[$index]) ? '' : config(App::class)->cookiePrefix;
$prefix ??= config(App::class)->cookiePrefix;
$request = Services::request();
$filter = $xssClean ? FILTER_SANITIZE_FULL_SPECIAL_CHARS : FILTER_DEFAULT;

Expand Down
2 changes: 1 addition & 1 deletion system/Session/Handlers/BaseHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ public function __construct(AppConfig $config, string $ipAddress)
protected function destroyCookie(): bool
{
return setcookie(
$this->cookieName,
config('App')->cookiePrefix . $this->cookieName,
'',
['expires' => 1, 'path' => $this->cookiePath, 'domain' => $this->cookieDomain, 'secure' => $this->cookieSecure, 'httponly' => true]
);
Expand Down
20 changes: 12 additions & 8 deletions system/Session/Session.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,14 +227,16 @@ public function start()
return;
}

$cookieName = $this->cookie->getPrefixedName();

$this->configure();
$this->setSaveHandler();

// Sanitize the cookie, because apparently PHP doesn't do that for userspace handlers
if (isset($_COOKIE[$this->sessionCookieName])
&& (! is_string($_COOKIE[$this->sessionCookieName]) || ! preg_match('#\A' . $this->sidRegexp . '\z#', $_COOKIE[$this->sessionCookieName]))
if (isset($_COOKIE[$cookieName])
&& (! is_string($_COOKIE[$cookieName]) || ! preg_match('#\A' . $this->sidRegexp . '\z#', $_COOKIE[$cookieName]))
) {
unset($_COOKIE[$this->sessionCookieName]);
unset($_COOKIE[$cookieName]);
}

$this->startSession();
Expand All @@ -251,7 +253,7 @@ public function start()
}
// Another work-around ... PHP doesn't seem to send the session cookie
// unless it is being currently created or regenerated
elseif (isset($_COOKIE[$this->sessionCookieName]) && $_COOKIE[$this->sessionCookieName] === session_id()) {
elseif (isset($_COOKIE[$cookieName]) && $_COOKIE[$cookieName] === session_id()) {
$this->setCookie();
}

Expand All @@ -271,7 +273,7 @@ public function start()
public function stop()
{
setcookie(
$this->sessionCookieName,
$this->cookie->getPrefixedName(),
session_id(),
['expires' => 1, 'path' => $this->cookie->getPath(), 'domain' => $this->cookie->getDomain(), 'secure' => $this->cookie->isSecure(), 'httponly' => true]
);
Expand All @@ -286,10 +288,12 @@ public function stop()
*/
protected function configure()
{
if (empty($this->sessionCookieName)) {
$this->sessionCookieName = ini_get('session.name');
$cookieName = $this->cookie->getPrefixedName();

if (empty($cookieName)) {
$cookieName = ini_get('session.name');
} else {
ini_set('session.name', $this->sessionCookieName);
ini_set('session.name', $cookieName);
}

$sameSite = $this->cookie->getSameSite() ?: ucfirst(Cookie::SAMESITE_LAX);
Expand Down
3 changes: 2 additions & 1 deletion user_guide_src/source/helpers/cookie_helper.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,11 @@ The following functions are available:
a description of its use, as this function is an alias for
:php:func:`Response::setCookie() <setCookie>`.

.. php:function:: get_cookie($index[, $xssClean = false])
.. php:function:: get_cookie($index[, $xssClean = false[, $prefix = null]])

:param string $index: Cookie name
:param bool $xssClean: Whether to apply XSS filtering to the returned value
:param string $prefix: A custom prefix to overwrite what is set in the App Config
:returns: The cookie value or null if not found
:rtype: mixed

Expand Down