Changeset 34218

Timestamp:

09/15/2015 10:13:51 PM (9 years ago)

Author:

boonebgorges

Message:

Improve validation of user_login and user_nicename length.

The user_login field only allows 60 characters, and user_nicename allows

50. However, there are no protections in the interface, and few in the code,

that prevent the creation of users with values in excess of these limits. Prior
to recent changes in $wpdb, users were generally created anyway, MySQL
having performed the necessary truncation. More recently, the INSERTs and
UPDATEs simply fail, with no real feedback on the nature of the failure.

This changeset addresses the issue in a number of ways:

• On the user-new.php and network/user-new.php panels, don't allow input in excess of the maximum field length.
• In wp_insert_user(), throw an error if the value provided for 'user_login' or 'user_nicename' exceeds the maximum field length.
• In wp_insert_user(), when using 'user_login' to generate a default value for 'user_nicename', ensure that the nicename is properly truncated, even when suffixed for uniqueness (username-2, etc).

Props dipesh.kakadiya, utkarshpatel, tommarshall, boonebgorges.
Fixes #33793.

Location:

trunk

Files:

• src/wp-admin/network/user-new.php (modified) (1 diff)
• src/wp-admin/user-new.php (modified) (1 diff)
• src/wp-includes/user-functions.php (modified) (2 diffs)
• tests/phpunit/tests/user.php (modified) (1 diff)

trunk/src/wp-admin/network/user-new.php

@@ -90 +90 @@
         <tr class="form-field form-required">
             <th scope="row"><label for="username"><?php _e( 'Username' ) ?></label></th>
-            <td><input type="text" class="regular-text" name="user[username]" id="username" autocapitalize="none" autocorrect="off" /></td>
+            <td><input type="text" class="regular-text" name="user[username]" id="username" autocapitalize="none" autocorrect="off" maxlength="60" /></td>
         </tr>
         <tr class="form-field form-required">

trunk/src/wp-admin/user-new.php

@@ -376 +376 @@
     <tr class="form-field form-required">
         <th scope="row"><label for="user_login"><?php _e('Username'); ?> <span class="description"><?php _e('(required)'); ?></span></label></th>
-        <td><input name="user_login" type="text" id="user_login" value="<?php echo esc_attr( $new_user_login ); ?>" aria-required="true" autocapitalize="none" autocorrect="off" /></td>
+        <td><input name="user_login" type="text" id="user_login" value="<?php echo esc_attr( $new_user_login ); ?>" aria-required="true" autocapitalize="none" autocorrect="off" maxlength="60" /></td>
     </tr>
     <tr class="form-field form-required">

trunk/src/wp-includes/user-functions.php

@@ -1246 +1246 @@
     $user_login = trim( $pre_user_login );
 
+    // user_login must be between 0 and 60 characters.
     if ( empty( $user_login ) ) {
         return new WP_Error('empty_user_login', __('Cannot create a user with an empty login name.') );
-    }
+    } elseif ( mb_strlen( $user_login ) > 60 ) {
+        return new WP_Error( 'user_login_too_long', __( 'Username may not be longer than 60 characters.' ) );
+    }
+
     if ( ! $update && username_exists( $user_login ) ) {
         return new WP_Error( 'existing_user_login', __( 'Sorry, that username already exists!' ) );
     }
 
-    // If a nicename is provided, remove unsafe user characters before
-    // using it. Otherwise build a nicename from the user_login.
+    /*
+     * If a nicename is provided, remove unsafe user characters before using it.
+     * Otherwise build a nicename from the user_login.
+     */
     if ( ! empty( $userdata['user_nicename'] ) ) {
         $user_nicename = sanitize_user( $userdata['user_nicename'], true );
+        if ( mb_strlen( $user_nicename ) > 50 ) {
+            return new WP_Error( 'user_nicename_too_long', __( 'Nicename may not be longer than 50 characters.' ) );
+        }
     } else {
-        $user_nicename = $user_login;
+        $user_nicename = mb_substr( $user_login, 0, 50 );
     }
 
@@ -1396 +1405 @@
         $suffix = 2;
         while ($user_nicename_check) {
-            $alt_user_nicename = $user_nicename . "-$suffix";
+            // user_nicename allows 50 chars. Subtract one for a hyphen, plus the length of the suffix.
+            $base_length = 49 - mb_strlen( $suffix );
+            $alt_user_nicename = mb_substr( $user_nicename, 0, $base_length ) . "-$suffix";
             $user_nicename_check = $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->users WHERE user_nicename = %s AND user_login != %s LIMIT 1" , $alt_user_nicename, $user_login));
             $suffix++;

trunk/tests/phpunit/tests/user.php

@@ -573 +573 @@
 
         $this->assertSame( $user->user_nicename, $updated_user->user_nicename );
+    }
+
+    /**
+     * @ticket 33793
+     */
+    public function test_wp_insert_user_should_reject_user_login_over_60_characters() {
+        $user_login = str_repeat( 'a', 61 );
+        $u = wp_insert_user( array(
+            'user_login' => $user_login,
+            'user_email' => $user_login . '@example.com',
+            'user_pass' => 'password',
+            'user_nicename' => 'something-short',
+        ) );
+
+        $this->assertWPError( $u );
+        $this->assertSame( 'user_login_too_long', $u->get_error_code() );
+    }
+
+    /**
+     * @ticket 33793
+     */
+    public function test_wp_insert_user_should_reject_user_nicename_over_50_characters() {
+        $user_nicename = str_repeat( 'a', 51 );
+        $u = wp_insert_user( array(
+            'user_login' => 'mynicenamehas50chars',
+            'user_email' => $user_nicename . '@example.com',
+            'user_pass' => 'password',
+            'user_nicename' => $user_nicename,
+        ) );
+
+        $this->assertWPError( $u );
+        $this->assertSame( 'user_nicename_too_long', $u->get_error_code() );
+    }
+
+    /**
+     * @ticket 33793
+     */
+    public function test_wp_insert_user_should_not_generate_user_nicename_longer_than_50_chars() {
+        $user_login = str_repeat( 'a', 55 );
+        $u = wp_insert_user( array(
+            'user_login' => $user_login,
+            'user_email' => $user_login . '@example.com',
+            'user_pass' => 'password',
+        ) );
+
+        $this->assertNotEmpty( $u );
+        $user = new WP_User( $u );
+        $expected = str_repeat( 'a', 50 );
+        $this->assertSame( $expected, $user->user_nicename );
+    }
+
+    /**
+     * @ticket 33793
+     */
+    public function test_wp_insert_user_should_not_truncate_to_a_duplicate_user_nicename() {
+        $u1 = $this->factory->user->create( array(
+            'user_nicename' => str_repeat( 'a', 50 ),
+        ) );
+
+        $user_login = str_repeat( 'a', 55 );
+        $u = wp_insert_user( array(
+            'user_login' => $user_login,
+            'user_email' => $user_login . '@example.com',
+            'user_pass' => 'password',
+        ) );
+
+        $this->assertNotEmpty( $u );
+        $user = new WP_User( $u );
+        $expected = str_repeat( 'a', 48 ) . '-2';
+        $this->assertSame( $expected, $user->user_nicename );
+    }
+
+    /**
+     * @ticket 33793
+     */
+    public function test_wp_insert_user_should_not_truncate_to_a_duplicate_user_nicename_when_suffix_has_more_than_one_character() {
+        $users = $this->factory->user->create_many( 9, array(
+            'user_nicename' => str_repeat( 'a', 50 ),
+        ) );
+
+        $user_login = str_repeat( 'a', 55 );
+        $u = wp_insert_user( array(
+            'user_login' => $user_login,
+            'user_email' => $user_login . '@example.com',
+            'user_pass' => 'password',
+        ) );
+
+        $this->assertNotEmpty( $u );
+        $user = new WP_User( $u );
+        $expected = str_repeat( 'a', 47 ) . '-10';
+        $this->assertSame( $expected, $user->user_nicename );
     }