<!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>[59904] trunk: Security: Reduce the length of the hash returned by `wp_fast_hash()` so it can be used in the `user_activation_key` field when a legacy database schema is still in use.</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/59904">59904</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/59904","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-03-03 09:49:36 +0000 (Mon, 03 Mar 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'>Security: Reduce the length of the hash returned by `wp_fast_hash()` so it can be used in the `user_activation_key` field when a legacy database schema is still in use.
This reduces the hash length from 32 bytes to 30 so the overall length of an activation key after encoding, prefixing, and prepending a timestamp fits into 60 bytes.
A key is also introduced for domain separation. This doesn't affect the output length.
Props dd32, paragoninitiativeenterprises, peterwilsoncc, johnbillion
Fixes <a href="https://core.trac.wordpress.org/ticket/21022">#21022</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunktestsphpunittestsauthphp">trunk/tests/phpunit/tests/auth.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></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/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2025-03-03 09:03:26 UTC (rev 59903)
+++ trunk/src/wp-includes/functions.php 2025-03-03 09:49:36 UTC (rev 59904)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9142,7 +9142,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> #[\SensitiveParameter]
</span><span class="cx" style="display: block; padding: 0 10px"> string $message
</span><span class="cx" style="display: block; padding: 0 10px"> ): string {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return '$generic$' . sodium_bin2hex( sodium_crypto_generichash( $message ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $hashed = sodium_crypto_generichash( $message, 'wp_fast_hash_6.8+', 30 );
+ return '$generic$' . sodium_bin2base64( $hashed, SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING );
</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="trunktestsphpunittestsauthphp"></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/auth.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/auth.php 2025-03-03 09:03:26 UTC (rev 59903)
+++ trunk/tests/phpunit/tests/auth.php 2025-03-03 09:49:36 UTC (rev 59904)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -473,9 +473,102 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( self::$user_id, $user->ID );
</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">+ public function data_passwords(): array {
+ return array(
+ array( 'a' ),
+ array( 'password' ),
+ array( str_repeat( 'a', self::$password_length_limit ) ),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Ensure the hash of the user password remains less than 64 characters in length to account for the old users table schema.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 21022
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @dataProvider data_passwords
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_user_password_against_old_users_table_schema( string $password ) {
+ // Mimic the schema of the users table prior to WordPress 4.4.
+ add_filter( 'wp_pre_insert_user_data', array( $this, 'mimic_users_schema_prior_to_44' ) );
+
+ $username = 'old-schema-user';
+
+ // Create a user.
+ $user_id = $this->factory()->user->create(
+ array(
+ 'user_login' => $username,
+ 'user_email' => 'old-schema-user@example.com',
+ 'user_pass' => $password,
+ )
+ );
+
+ // Check the user can authenticate.
+ $user = wp_authenticate( $username, $password );
+
+ $this->assertNotWPError( $user );
+ $this->assertInstanceOf( 'WP_User', $user );
+ $this->assertSame( $user_id, $user->ID, 'User should be able to authenticate' );
+ $this->assertNotSame( self::$user_id, $user->ID, 'A unique user must be created for this test, the shared fixture must not be used' );
+ }
+
+ /**
+ * Ensure the hash of the user activation key remains less than 60 characters in length to account for the old users table schema.
+ *
+ * @ticket 21022
+ */
+ public function test_user_activation_key_against_old_users_table_schema() {
+ // Mimic the schema of the users table prior to WordPress 4.4.
+ add_filter( 'wp_pre_insert_user_data', array( $this, 'mimic_users_schema_prior_to_44' ) );
+
+ $username = 'old-schema-user';
+
+ // Create a user.
+ $user_id = $this->factory()->user->create(
+ array(
+ 'user_login' => $username,
+ 'user_email' => 'old-schema-user@example.com',
+ )
+ );
+
+ $user = get_userdata( $user_id );
+ $key = get_password_reset_key( $user );
+
+ // A correctly saved key should be accepted.
+ $check = check_password_reset_key( $key, $user->user_login );
+
+ $this->assertNotWPError( $check );
+ $this->assertInstanceOf( 'WP_User', $check );
+ $this->assertSame( $user->ID, $check->ID );
+ $this->assertNotSame( self::$user_id, $user->ID, 'A unique user must be created for this test, the shared fixture must not be used' );
+ }
+
+ /*
+ * Fake the schema of the users table prior to WordPress 4.4 to mimic sites that are using the
+ * `DO_NOT_UPGRADE_GLOBAL_TABLES` constant and have not updated the users table schema.
+ *
+ * The schema of the wp_users table on wordpress.org has not been updated since the schema was changed in [35638]
+ * for WordPress 4.4, which means the `user_activation_key` field remains at 60 characters length and the `user_pass`
+ * field remains at 64 characters length instead of the expected 255. Although this is unlikely to affect other
+ * sites, this can be accommodated for in the codebase.
+ *
+ * Actually altering the database schema during tests will commit the transaction and break subsequent tests, hence
+ * the use of this filter.
+ */
+ public function mimic_users_schema_prior_to_44( array $data ): array {
+ if ( isset( $data['user_pass'] ) ) {
+ $this->assertLessThanOrEqual( 64, strlen( $data['user_pass'] ) );
+ }
+
+ if ( isset( $data['user_activation_key'] ) ) {
+ $this->assertLessThanOrEqual( 60, strlen( $data['user_activation_key'] ) );
+ }
+
+ return $data;
+ }
+
+ /**
+ * @ticket 21022
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_invalid_password_at_bcrypt_length_limit_is_rejected() {
</span><span class="cx" style="display: block; padding: 0 10px"> $limit = str_repeat( 'a', self::$bcrypt_length_limit );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>