<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[59633] trunk: Users: Retain the current session when a user changes their password.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/59633">59633</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/59633","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-01-16 15:33:31 +0000 (Thu, 16 Jan 2025)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Users: Retain the current session when a user changes their password.
Prior to this change a new session was unnecessarily created when a user changed their own password.
Existing authentication cookies for the user will still be invalidated regardless of whether they share the same session token because session cookie keys contain a substring of the password hash.
Props snicco, narenin, johnbillion
Fixes <a href="https://core.trac.wordpress.org/ticket/61366">#61366</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
<li><a href="#trunktestsphpunittestsuserphp">trunk/tests/phpunit/tests/user.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesuserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php 2025-01-16 12:02:24 UTC (rev 59632)
+++ trunk/src/wp-includes/user.php 2025-01-16 15:33:31 UTC (rev 59633)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2780,8 +2780,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $current_user = wp_get_current_user();
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $current_user->ID === $user_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $plaintext_pass ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_clear_auth_cookie();
-
</del><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Here we calculate the expiration length of the current auth cookie and compare it to the default expiration.
</span><span class="cx" style="display: block; padding: 0 10px"> * If it's greater than this, then we know the user checked 'Remember Me' when they logged in.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2790,13 +2788,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/pluggable.php */
</span><span class="cx" style="display: block; padding: 0 10px"> $default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $user_id, false );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_clear_auth_cookie();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $remember = false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $token = '';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false !== $logged_in_cookie ) {
+ $token = $logged_in_cookie['token'];
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $logged_in_cookie && ( (int) $logged_in_cookie['expiration'] - time() ) > $default_cookie_life ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $remember = true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_set_auth_cookie( $user_id, $remember );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_set_auth_cookie( $user_id, $remember, '', $token );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsuserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user.php 2025-01-16 12:02:24 UTC (rev 59632)
+++ trunk/tests/phpunit/tests/user.php 2025-01-16 15:33:31 UTC (rev 59633)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -63,9 +63,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function set_up() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::set_up();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'set_auth_cookie', array( $this, 'action_set_auth_cookie' ), 10, 6 );
+ add_action( 'set_logged_in_cookie', array( $this, 'action_set_logged_in_cookie' ), 10 );
+ add_action( 'clear_auth_cookie', array( $this, 'action_clear_auth_cookie' ) );
+
+ $_COOKIE = array();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->author = clone self::$_author;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ final public function action_set_auth_cookie(
+ string $cookie,
+ int $expire,
+ int $expiration,
+ int $user_id,
+ string $scheme,
+ string $token
+ ): void {
+ $_COOKIE[ SECURE_AUTH_COOKIE ] = $cookie;
+ $_COOKIE[ AUTH_COOKIE ] = $cookie;
+ }
+
+ final public function action_set_logged_in_cookie( string $cookie ): void {
+ $_COOKIE[ LOGGED_IN_COOKIE ] = $cookie;
+ }
+
+ final public function action_clear_auth_cookie(): void {
+ unset( $_COOKIE[ LOGGED_IN_COOKIE ] );
+ unset( $_COOKIE[ SECURE_AUTH_COOKIE ] );
+ unset( $_COOKIE[ AUTH_COOKIE ] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_users_of_blog() {
</span><span class="cx" style="display: block; padding: 0 10px"> // Add one of each user role.
</span><span class="cx" style="display: block; padding: 0 10px"> $nusers = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1122,6 +1150,50 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEmpty( $user->user_activation_key );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 61366
+ * @dataProvider data_remember_user
+ */
+ public function test_changing_own_password_retains_current_session( bool $remember ) {
+ $user = $this->author;
+ $manager = WP_Session_Tokens::get_instance( $user->ID );
+ $expiry = $remember ? ( 2 * WEEK_IN_SECONDS ) : ( 2 * DAY_IN_SECONDS );
+ $token = $manager->create( time() + $expiry );
+ $pass = $user->user_pass;
+
+ wp_set_current_user( $user->ID );
+ wp_set_auth_cookie( $user->ID, $remember, '', $token );
+
+ $cookie = $_COOKIE[ AUTH_COOKIE ];
+ $userdata = array(
+ 'ID' => $user->ID,
+ 'user_pass' => 'my_new_password',
+ );
+ $updated = wp_update_user( $userdata, $manager );
+ $parsed = wp_parse_auth_cookie();
+
+ // Check the prerequisites:
+ $this->assertNotWPError( $updated );
+ $this->assertNotSame( $pass, get_userdata( $user->ID )->user_pass );
+
+ // Check the session token:
+ $this->assertSame( $token, $parsed['token'] );
+ $this->assertCount( 1, $manager->get_all() );
+
+ // Check that the newly set auth cookie is valid:
+ $this->assertSame( $user->ID, wp_validate_auth_cookie() );
+
+ // Check that, despite the session token reuse, the old auth cookie should now be invalid because the password changed:
+ $this->assertFalse( wp_validate_auth_cookie( $cookie ) );
+ }
+
+ public function data_remember_user() {
+ return array(
+ array( true ),
+ array( false ),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_search_users_login() {
</span><span class="cx" style="display: block; padding: 0 10px"> $users = get_users(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre>
</div>
</div>
</body>
</html>