includes/user/PasswordReset.php

   1 <?php
   2 /**
   3  * User password reset helper for MediaWiki.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 use MediaWiki\Auth\AuthManager;
  24 use MediaWiki\Auth\TemporaryPasswordAuthenticationRequest;
  25 use MediaWiki\Config\ServiceOptions;
  26 use MediaWiki\Logger\LoggerFactory;
  27 use MediaWiki\MediaWikiServices;
  28 use MediaWiki\Permissions\PermissionManager;
  29 use Psr\Log\LoggerAwareInterface;
  30 use Psr\Log\LoggerAwareTrait;
  31 use Psr\Log\LoggerInterface;
  32 use Wikimedia\Rdbms\ILoadBalancer;
  33
  34 /**
  35  * Helper class for the password reset functionality shared by the web UI and the API.
  36  *
  37  * Requires the TemporaryPasswordPrimaryAuthenticationProvider and the
  38  * EmailNotificationSecondaryAuthenticationProvider (or something providing equivalent
  39  * functionality) to be enabled.
  40  */
  41 class PasswordReset implements LoggerAwareInterface {
  42         use LoggerAwareTrait;
  43
  44         /** @var ServiceOptions|Config */
  45         protected $config;
  46
  47         /** @var AuthManager */
  48         protected $authManager;
  49
  50         /** @var PermissionManager */
  51         protected $permissionManager;
  52
  53         /** @var ILoadBalancer */
  54         protected $loadBalancer;
  55
  56         /**
  57          * In-process cache for isAllowed lookups, by username.
  58          * Contains a StatusValue object
  59          * @var MapCacheLRU
  60          */
  61         private $permissionCache;
  62
  63         public const CONSTRUCTOR_OPTIONS = [
  64                 'AllowRequiringEmailForResets',
  65                 'EnableEmail',
  66                 'PasswordResetRoutes',
  67         ];
  68
  69         /**
  70          * This class is managed by MediaWikiServices, don't instantiate directly.
  71          *
  72          * @param ServiceOptions|Config $config
  73          * @param AuthManager $authManager
  74          * @param PermissionManager $permissionManager
  75          * @param ILoadBalancer|null $loadBalancer
  76          * @param LoggerInterface|null $logger
  77          */
  78         public function __construct(
  79                 $config,
  80                 AuthManager $authManager,
  81                 PermissionManager $permissionManager,
  82                 ILoadBalancer $loadBalancer = null,
  83                 LoggerInterface $logger = null
  84         ) {
  85                 $this->config = $config;
  86                 $this->authManager = $authManager;
  87                 $this->permissionManager = $permissionManager;
  88
  89                 if ( !$loadBalancer ) {
  90                         wfDeprecated( 'Not passing LoadBalancer to ' . __METHOD__, '1.34' );
  91                         $loadBalancer = MediaWikiServices::getInstance()->getDBLoadBalancer();
  92                 }
  93                 $this->loadBalancer = $loadBalancer;
  94
  95                 if ( !$logger ) {
  96                         wfDeprecated( 'Not passing LoggerInterface to ' . __METHOD__, '1.34' );
  97                         $logger = LoggerFactory::getInstance( 'authentication' );
  98                 }
  99                 $this->logger = $logger;
 100
 101                 $this->permissionCache = new MapCacheLRU( 1 );
 102         }
 103
 104         /**
 105          * Check if a given user has permission to use this functionality.
 106          * @param User $user
 107          * @since 1.29 Second argument for displayPassword removed.
 108          * @return StatusValue
 109          */
 110         public function isAllowed( User $user ) {
 111                 $status = $this->permissionCache->get( $user->getName() );
 112                 if ( !$status ) {
 113                         $resetRoutes = $this->config->get( 'PasswordResetRoutes' );
 114                         $status = StatusValue::newGood();
 115
 116                         if ( !is_array( $resetRoutes ) || !in_array( true, $resetRoutes, true ) ) {
 117                                 // Maybe password resets are disabled, or there are no allowable routes
 118                                 $status = StatusValue::newFatal( 'passwordreset-disabled' );
 119                         } elseif (
 120                                 ( $providerStatus = $this->authManager->allowsAuthenticationDataChange(
 121                                         new TemporaryPasswordAuthenticationRequest(), false ) )
 122                                 && !$providerStatus->isGood()
 123                         ) {
 124                                 // Maybe the external auth plugin won't allow local password changes
 125                                 $status = StatusValue::newFatal( 'resetpass_forbidden-reason',
 126                                         $providerStatus->getMessage() );
 127                         } elseif ( !$this->config->get( 'EnableEmail' ) ) {
 128                                 // Maybe email features have been disabled
 129                                 $status = StatusValue::newFatal( 'passwordreset-emaildisabled' );
 130                         } elseif ( !$this->permissionManager->userHasRight( $user, 'editmyprivateinfo' ) ) {
 131                                 // Maybe not all users have permission to change private data
 132                                 $status = StatusValue::newFatal( 'badaccess' );
 133                         } elseif ( $this->isBlocked( $user ) ) {
 134                                 // Maybe the user is blocked (check this here rather than relying on the parent
 135                                 // method as we have a more specific error message to use here and we want to
 136                                 // ignore some types of blocks)
 137                                 $status = StatusValue::newFatal( 'blocked-mailpassword' );
 138                         }
 139
 140                         $this->permissionCache->set( $user->getName(), $status );
 141                 }
 142
 143                 return $status;
 144         }
 145
 146         /**
 147          * Do a password reset. Authorization is the caller's responsibility.
 148          *
 149          * Process the form.  At this point we know that the user passes all the criteria in
 150          * userCanExecute(), and if the data array contains 'Username', etc, then Username
 151          * resets are allowed.
 152          *
 153          * @since 1.29 Fourth argument for displayPassword removed.
 154          * @param User $performingUser The user that does the password reset
 155          * @param string|null $username The user whose password is reset
 156          * @param string|null $email Alternative way to specify the user
 157          * @return StatusValue Will contain the passwords as a username => password array if the
 158          *   $displayPassword flag was set
 159          * @throws LogicException When the user is not allowed to perform the action
 160          * @throws MWException On unexpected DB errors
 161          */
 162         public function execute(
 163                 User $performingUser, $username = null, $email = null
 164         ) {
 165                 if ( !$this->isAllowed( $performingUser )->isGood() ) {
 166                         throw new LogicException( 'User ' . $performingUser->getName()
 167                                 . ' is not allowed to reset passwords' );
 168                 }
 169
 170                 $username = $username ?? '';
 171                 $email = $email ?? '';
 172
 173                 $resetRoutes = $this->config->get( 'PasswordResetRoutes' )
 174                         + [ 'username' => false, 'email' => false ];
 175                 if ( $resetRoutes['username'] && $username ) {
 176                         $method = 'username';
 177                         $users = [ $this->lookupUser( $username ) ];
 178                 } elseif ( $resetRoutes['email'] && $email ) {
 179                         if ( !Sanitizer::validateEmail( $email ) ) {
 180                                 return StatusValue::newFatal( 'passwordreset-invalidemail' );
 181                         }
 182                         $method = 'email';
 183                         $users = $this->getUsersByEmail( $email );
 184                         $username = null;
 185                 } else {
 186                         // The user didn't supply any data
 187                         return StatusValue::newFatal( 'passwordreset-nodata' );
 188                 }
 189
 190                 // Check for hooks (captcha etc), and allow them to modify the users list
 191                 $error = [];
 192                 $data = [
 193                         'Username' => $username,
 194                         // Email gets set to null for backward compatibility
 195                         'Email' => $method === 'email' ? $email : null,
 196                 ];
 197                 if ( !Hooks::run( 'SpecialPasswordResetOnSubmit', [ &$users, $data, &$error ] ) ) {
 198                         return StatusValue::newFatal( Message::newFromSpecifier( $error ) );
 199                 }
 200
 201                 $firstUser = $users[0] ?? null;
 202                 $requireEmail = $this->config->get( 'AllowRequiringEmailForResets' )
 203                         && $method === 'username'
 204                         && $firstUser
 205                         && $firstUser->getBoolOption( 'requireemail' );
 206                 if ( $requireEmail ) {
 207                         if ( $email === '' ) {
 208                                 return StatusValue::newFatal( 'passwordreset-username-email-required' );
 209                         }
 210
 211                         if ( !Sanitizer::validateEmail( $email ) ) {
 212                                 return StatusValue::newFatal( 'passwordreset-invalidemail' );
 213                         }
 214                 }
 215
 216                 // Check against the rate limiter
 217                 if ( $performingUser->pingLimiter( 'mailpassword' ) ) {
 218                         return StatusValue::newFatal( 'actionthrottledtext' );
 219                 }
 220
 221                 if ( !$users ) {
 222                         if ( $method === 'email' ) {
 223                                 // Don't reveal whether or not an email address is in use
 224                                 return StatusValue::newGood( [] );
 225                         } else {
 226                                 return StatusValue::newFatal( 'noname' );
 227                         }
 228                 }
 229
 230                 if ( !$firstUser instanceof User || !$firstUser->getId() ) {
 231                         // Don't parse username as wikitext (T67501)
 232                         return StatusValue::newFatal( wfMessage( 'nosuchuser', wfEscapeWikiText( $username ) ) );
 233                 }
 234
 235                 // All the users will have the same email address
 236                 if ( !$firstUser->getEmail() ) {
 237                         // This won't be reachable from the email route, so safe to expose the username
 238                         return StatusValue::newFatal( wfMessage( 'noemail',
 239                                 wfEscapeWikiText( $firstUser->getName() ) ) );
 240                 }
 241
 242                 if ( $requireEmail && $firstUser->getEmail() !== $email ) {
 243                         // Pretend everything's fine to avoid disclosure
 244                         return StatusValue::newGood();
 245                 }
 246
 247                 // We need to have a valid IP address for the hook, but per T20347, we should
 248                 // send the user's name if they're logged in.
 249                 $ip = $performingUser->getRequest()->getIP();
 250                 if ( !$ip ) {
 251                         return StatusValue::newFatal( 'badipaddress' );
 252                 }
 253
 254                 Hooks::run( 'User::mailPasswordInternal', [ &$performingUser, &$ip, &$firstUser ] );
 255
 256                 $result = StatusValue::newGood();
 257                 $reqs = [];
 258                 foreach ( $users as $user ) {
 259                         $req = TemporaryPasswordAuthenticationRequest::newRandom();
 260                         $req->username = $user->getName();
 261                         $req->mailpassword = true;
 262                         $req->caller = $performingUser->getName();
 263                         $status = $this->authManager->allowsAuthenticationDataChange( $req, true );
 264                         if ( $status->isGood() && $status->getValue() !== 'ignored' ) {
 265                                 $reqs[] = $req;
 266                         } elseif ( $result->isGood() ) {
 267                                 // only record the first error, to avoid exposing the number of users having the
 268                                 // same email address
 269                                 if ( $status->getValue() === 'ignored' ) {
 270                                         $status = StatusValue::newFatal( 'passwordreset-ignored' );
 271                                 }
 272                                 $result->merge( $status );
 273                         }
 274                 }
 275
 276                 $logContext = [
 277                         'requestingIp' => $ip,
 278                         'requestingUser' => $performingUser->getName(),
 279                         'targetUsername' => $username,
 280                         'targetEmail' => $email,
 281                         'actualUser' => $firstUser->getName(),
 282                 ];
 283
 284                 if ( !$result->isGood() ) {
 285                         $this->logger->info(
 286                                 "{requestingUser} attempted password reset of {actualUser} but failed",
 287                                 $logContext + [ 'errors' => $result->getErrors() ]
 288                         );
 289                         return $result;
 290                 }
 291
 292                 $passwords = [];
 293                 foreach ( $reqs as $req ) {
 294                         // This is adding a new temporary password, not intentionally changing anything
 295                         // (even though it might technically invalidate an old temporary password).
 296                         $this->authManager->changeAuthenticationData( $req, /* $isAddition */ true );
 297                 }
 298
 299                 $this->logger->info(
 300                         "{requestingUser} did password reset of {actualUser}",
 301                         $logContext
 302                 );
 303
 304                 return StatusValue::newGood( $passwords );
 305         }
 306
 307         /**
 308          * Check whether the user is blocked.
 309          * Ignores certain types of system blocks that are only meant to force users to log in.
 310          * @param User $user
 311          * @return bool
 312          * @since 1.30
 313          */
 314         protected function isBlocked( User $user ) {
 315                 $block = $user->getBlock() ?: $user->getGlobalBlock();
 316                 if ( !$block ) {
 317                         return false;
 318                 }
 319                 return $block->appliesToPasswordReset();
 320         }
 321
 322         /**
 323          * @param string $email
 324          * @return User[]
 325          * @throws MWException On unexpected database errors
 326          */
 327         protected function getUsersByEmail( $email ) {
 328                 $userQuery = User::getQueryInfo();
 329                 $res = $this->loadBalancer->getConnectionRef( DB_REPLICA )->select(
 330                         $userQuery['tables'],
 331                         $userQuery['fields'],
 332                         [ 'user_email' => $email ],
 333                         __METHOD__,
 334                         [],
 335                         $userQuery['joins']
 336                 );
 337
 338                 if ( !$res ) {
 339                         // Some sort of database error, probably unreachable
 340                         throw new MWException( 'Unknown database error in ' . __METHOD__ );
 341                 }
 342
 343                 $users = [];
 344                 foreach ( $res as $row ) {
 345                         $users[] = User::newFromRow( $row );
 346                 }
 347                 return $users;
 348         }
 349
 350         /**
 351          * User object creation helper for testability
 352          * @codeCoverageIgnore
 353          *
 354          * @param string $username
 355          * @return User|false
 356          */
 357         protected function lookupUser( $username ) {
 358                 return User::newFromName( $username );
 359         }
 360 }