Skip to content

BUG-10807: session_regenerate_id fails to check results of validateId… #10813

New issue

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

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

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
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
4 changes: 2 additions & 2 deletions ext/session/session.c
Original file line number Diff line number Diff line change
Expand Up @@ -2295,7 +2295,7 @@ PHP_FUNCTION(session_regenerate_id)
if ((!PS(mod_user_implemented) && PS(mod)->s_validate_sid) || !Z_ISUNDEF(PS(mod_user_names).ps_validate_sid)) {
int limit = 3;
/* Try to generate non-existing ID */
while (limit-- && PS(mod)->s_validate_sid(&PS(mod_data), PS(id)) == SUCCESS) {
while (limit-- && PS(mod)->s_validate_sid(&PS(mod_data), PS(id)) == FAILURE) {
Copy link
Member

Choose a reason for hiding this comment

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

This change is definitely incorrect.

I know the method name is terrible, but validateId() MUST only return true if a session with this ID already exists.

Symfony seems to have hit that mistake too and fixed it: symfony/symfony#47843

zend_string_release_ex(PS(id), 0);
PS(id) = PS(mod)->s_create_sid(&PS(mod_data));
if (!PS(id)) {
Expand Down Expand Up @@ -2362,7 +2362,7 @@ PHP_FUNCTION(session_create_id)
break;
} else {
/* Detect collision and retry */
if (PS(mod)->s_validate_sid(&PS(mod_data), new_id) == SUCCESS) {
if (PS(mod)->s_validate_sid(&PS(mod_data), new_id) == FAILURE) {
Copy link
Member

Choose a reason for hiding this comment

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

Similarly, this change is also incorrect. As this allows you to create two sessions with the same ID, which is a massive issue.

zend_string_release_ex(new_id, 0);
new_id = NULL;
continue;
Expand Down
83 changes: 83 additions & 0 deletions ext/session/tests/gh10807.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
--TEST--
GH-10807 (session_regenerate_id with custom handler and use_strict_mode generates three new session ids)
--EXTENSIONS--
session
--INI--
html_errors=0
session.save_handler=files
session.use_strict_mode=1
--FILE--
<?php

/**
* This class will return a number for the session id, incrementing each time a new
* session is generated
*/
class Bug10807SessionHandler implements SessionHandlerInterface, SessionIdInterface {

private int $fail_validation;
private int $sid_counter;

public function __construct() {
$this->fail_validation = 0;
$this->sid_counter = 1;

session_set_save_handler($this, FALSE);
}

public function setFailValidation(int $fail) {
$this->fail_validation = $fail;
}

public function create_sid() : string {
return strval($this->sid_counter++);
}

public function validateId(string $id) : bool {

if ($this->fail_validation > 0 && intval($id)< $this->fail_validation) {
return FALSE;
}

return TRUE;

}
Comment on lines +36 to +44
Copy link
Member

Choose a reason for hiding this comment

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

The logic of this is nonsensical.

Validations about the "shape" of the ID must happen in the create_sid() method.

The purpose of the validateId() method is only to validate that the given ID exists in the data storage.

Please read the Limitation and Compatibility sections of the RFC that introduced those features, which describes the behaviour of this method: https://wiki.php.net/rfc/strict_sessions#limitation

The rationale as to why uninitialized sessions should be discarded is explained in the RFC here

Copy link
Author

Choose a reason for hiding this comment

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

Yes, my validateId contents above are not a real world scenario, it is there to confirm that my change did not break the scenario where validateId returns false


public function close(): bool { return TRUE; }
public function destroy(string $id): bool { return TRUE; }
public function gc(int $max_lifetime): int|false { return TRUE; }
public function open(string $path, string $name): bool { return TRUE; }
public function read(string $id): string|false { return ''; }
public function write(string $id, string $data): bool { return TRUE; }

}

ob_start();

$save_handler = new Bug10807SessionHandler();
session_start(); //session id = 1
session_regenerate_id(); //session id = 2
var_dump(session_id());

$save_handler->setFailValidation(4);
session_regenerate_id(); //should invoke create_sid twice as session id 3 will be invalid
var_dump(session_id());

$save_handler->setFailValidation(8);
$new_id = session_create_id(); //Should cause an error due to failing validation 3 times
print("\n"); //This is required to get the EXPECTF to work below
var_dump($new_id);

$save_handler->setFailValidation(0);
$new_id = session_create_id(); //Should succeed
var_dump($new_id);

?>
--EXPECTF--
string(1) "2"
string(1) "4"

Warning: session_create_id(): Failed to create new ID in %s on line %d

bool(false)
string(1) "8"