<!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>[25696] trunk/src: Hash password reset keys in the database.</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 { 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/25696">25696</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2013-10-06 11:28:42 +0000 (Sun, 06 Oct 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Hash password reset keys in the database.
All existing, unused password reset keys are now considered "expired" and the user will be told they should try again.
Introduces a password_reset_key_expired filter to allow plugins to introduce a grace period.
fixes <a href="http://core.trac.wordpress.org/ticket/24783">#24783</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
<li><a href="#trunksrcwploginphp">trunk/src/wp-login.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesuserphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/user.php (25695 => 25696)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/user.php 2013-10-06 10:55:42 UTC (rev 25695)
+++ trunk/src/wp-includes/user.php 2013-10-06 11:28:42 UTC (rev 25696)
</span><span class="lines">@@ -1587,29 +1587,58 @@
</span><span class="cx"> /**
</span><span class="cx"> * Retrieves a user row based on password reset key and login
</span><span class="cx"> *
</span><ins>+ * A key is considered 'expired' if it exactly matches the value of the
+ * user_activation_key field, rather than being matched after going through the
+ * hashing process. This field is now hashed; old values are no longer accepted
+ * but have a different WP_Error code so good user feedback can be provided.
+ *
</ins><span class="cx"> * @uses $wpdb WordPress Database object
</span><span class="cx"> *
</span><del>- * @param string $key Hash to validate sending user's password
- * @param string $login The user login
- * @return object|WP_Error User's database row on success, error object for invalid keys
</del><ins>+ * @param string $key Hash to validate sending user's password.
+ * @param string $login The user login.
+ * @return WP_User|WP_Error WP_User object on success, WP_Error object for invalid or expired keys.
</ins><span class="cx"> */
</span><del>-function check_password_reset_key( $key, $login ) {
- global $wpdb;
</del><ins>+function check_password_reset_key($key, $login) {
+ global $wpdb, $wp_hasher;
</ins><span class="cx">
</span><del>- $key = preg_replace( '/[^a-z0-9]/i', '', $key );
</del><ins>+ $key = preg_replace('/[^a-z0-9]/i', '', $key);
</ins><span class="cx">
</span><del>- if ( empty( $key ) || ! is_string( $key ) )
- return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
</del><ins>+ if ( empty( $key ) || !is_string( $key ) )
+ return new WP_Error('invalid_key', __('Invalid key'));
</ins><span class="cx">
</span><del>- if ( empty( $login ) || ! is_string( $login ) )
- return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
</del><ins>+ if ( empty($login) || !is_string($login) )
+ return new WP_Error('invalid_key', __('Invalid key'));
</ins><span class="cx">
</span><del>- $user = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->users WHERE user_activation_key = %s AND user_login = %s", $key, $login ) );
</del><ins>+ $row = $wpdb->get_row( $wpdb->prepare( "SELECT ID, user_activation_key FROM $wpdb->users WHERE user_login = %s", $login ) );
+ if ( ! $row )
+ return new WP_Error('invalid_key', __('Invalid key'));
</ins><span class="cx">
</span><del>- if ( empty( $user ) )
- return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
</del><ins>+ if ( empty( $wp_hasher ) ) {
+ require_once ABSPATH . 'wp-includes/class-phpass.php';
+ $wp_hasher = new PasswordHash( 8, true );
+ }
</ins><span class="cx">
</span><del>- return $user;
</del><ins>+ if ( $wp_hasher->CheckPassword( $key, $row->user_activation_key ) )
+ return get_userdata( $row->ID );
+
+ if ( $key === $row->user_activation_key ) {
+ $return = new WP_Error( 'expired_key', __( 'Invalid key' ) );
+ $user_id = $row->ID;
+
+ /**
+ * Filter the return value of check_password_reset_key() when an
+ * old-style key is used (plain-text key was stored in the database).
+ *
+ * @since 3.7.0
+ *
+ * @param WP_Error $return A WP_Error object denoting an expired key.
+ * Return a WP_User object to validate the key.
+ * @param int $user_id The matched user ID.
+ */
+ return apply_filters( 'password_reset_key_expired', $return, $user_id );
+ }
+
+ return new WP_Error( 'invalid_key', __( 'Invalid key' ) );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunksrcwploginphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-login.php (25695 => 25696)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-login.php 2013-10-06 10:55:42 UTC (rev 25695)
+++ trunk/src/wp-login.php 2013-10-06 11:28:42 UTC (rev 25696)
</span><span class="lines">@@ -202,7 +202,7 @@
</span><span class="cx"> * @return bool|WP_Error True: when finish. WP_Error on error
</span><span class="cx"> */
</span><span class="cx"> function retrieve_password() {
</span><del>- global $wpdb, $current_site;
</del><ins>+ global $wpdb, $current_site, $wp_hasher;
</ins><span class="cx">
</span><span class="cx"> $errors = new WP_Error();
</span><span class="cx">
</span><span class="lines">@@ -241,14 +241,27 @@
</span><span class="cx"> else if ( is_wp_error($allow) )
</span><span class="cx"> return $allow;
</span><span class="cx">
</span><del>- $key = $wpdb->get_var($wpdb->prepare("SELECT user_activation_key FROM $wpdb->users WHERE user_login = %s", $user_login));
- if ( empty($key) ) {
- // Generate something random for a key...
- $key = wp_generate_password(20, false);
- do_action('retrieve_password_key', $user_login, $key);
- // Now insert the new md5 key into the db
- $wpdb->update($wpdb->users, array('user_activation_key' => $key), array('user_login' => $user_login));
</del><ins>+ // Generate something random for a password reset key.
+ $key = wp_generate_password( 20, false );
+
+ /**
+ * Fires when a password reset key is generated.
+ *
+ * @since 2.5.0
+ *
+ * @param string $user_login The username for the user.
+ * @param string $key The generated password reset key.
+ */
+ do_action( 'retrieve_password_key', $user_login, $key );
+
+ // Now insert the key, hashed, into the DB.
+ if ( empty( $wp_hasher ) ) {
+ require_once ABSPATH . 'wp-includes/class-phpass.php';
+ $wp_hasher = new PasswordHash( 8, true );
</ins><span class="cx"> }
</span><ins>+ $hashed = $wp_hasher->HashPassword( $key );
+ $wpdb->update( $wpdb->users, array( 'user_activation_key' => $hashed ), array( 'user_login' => $user_login ) );
+
</ins><span class="cx"> $message = __('Someone requested that the password be reset for the following account:') . "\r\n\r\n";
</span><span class="cx"> $message .= network_home_url( '/' ) . "\r\n\r\n";
</span><span class="cx"> $message .= sprintf(__('Username: %s'), $user_login) . "\r\n\r\n";
</span><span class="lines">@@ -358,7 +371,13 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( isset($_GET['error']) && 'invalidkey' == $_GET['error'] ) $errors->add('invalidkey', __('Sorry, that key does not appear to be valid.'));
</del><ins>+ if ( isset( $_GET['error'] ) ) {
+ if ( 'invalidkey' == $_GET['error'] )
+ $errors->add( 'invalidkey', __( 'Sorry, that key does not appear to be valid.' ) );
+ elseif ( 'expiredkey' == $_GET['error'] )
+ $errors->add( 'expiredkey', __( 'Sorry, that key has expired. Please try again.' ) );
+ }
+
</ins><span class="cx"> $redirect_to = apply_filters( 'lostpassword_redirect', !empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '' );
</span><span class="cx">
</span><span class="cx"> do_action('lost_password');
</span><span class="lines">@@ -394,7 +413,10 @@
</span><span class="cx"> $user = check_password_reset_key($_GET['key'], $_GET['login']);
</span><span class="cx">
</span><span class="cx"> if ( is_wp_error($user) ) {
</span><del>- wp_redirect( site_url('wp-login.php?action=lostpassword&error=invalidkey') );
</del><ins>+ if ( $user->get_error_code() === 'expired_key' )
+ wp_redirect( site_url( 'wp-login.php?action=lostpassword&error=expiredkey' ) );
+ else
+ wp_redirect( site_url( 'wp-login.php?action=lostpassword&error=invalidkey' ) );
</ins><span class="cx"> exit;
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>