includes/user/BotPassword.php

   1 <?php
   2 /**
   3  * Utility class for bot passwords
   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
  21 use MediaWiki\MediaWikiServices;
  22 use MediaWiki\Session\BotPasswordSessionProvider;
  23 use Wikimedia\Rdbms\IMaintainableDatabase;
  24
  25 /**
  26  * Utility class for bot passwords
  27  * @since 1.27
  28  */
  29 class BotPassword implements IDBAccessObject {
  30
  31         const APPID_MAXLENGTH = 32;
  32
  33         /** @var bool */
  34         private $isSaved;
  35
  36         /** @var int */
  37         private $centralId;
  38
  39         /** @var string */
  40         private $appId;
  41
  42         /** @var string */
  43         private $token;
  44
  45         /** @var MWRestrictions */
  46         private $restrictions;
  47
  48         /** @var string[] */
  49         private $grants;
  50
  51         /** @var int */
  52         private $flags = self::READ_NORMAL;
  53
  54         /**
  55          * @param object $row bot_passwords database row
  56          * @param bool $isSaved Whether the bot password was read from the database
  57          * @param int $flags IDBAccessObject read flags
  58          */
  59         protected function __construct( $row, $isSaved, $flags = self::READ_NORMAL ) {
  60                 $this->isSaved = $isSaved;
  61                 $this->flags = $flags;
  62
  63                 $this->centralId = (int)$row->bp_user;
  64                 $this->appId = $row->bp_app_id;
  65                 $this->token = $row->bp_token;
  66                 $this->restrictions = MWRestrictions::newFromJson( $row->bp_restrictions );
  67                 $this->grants = FormatJson::decode( $row->bp_grants );
  68         }
  69
  70         /**
  71          * Get a database connection for the bot passwords database
  72          * @param int $db Index of the connection to get, e.g. DB_MASTER or DB_REPLICA.
  73          * @return IMaintainableDatabase
  74          */
  75         public static function getDB( $db ) {
  76                 global $wgBotPasswordsCluster, $wgBotPasswordsDatabase;
  77
  78                 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
  79                 $lb = $wgBotPasswordsCluster
  80                         ? $lbFactory->getExternalLB( $wgBotPasswordsCluster )
  81                         : $lbFactory->getMainLB( $wgBotPasswordsDatabase );
  82                 return $lb->getConnectionRef( $db, [], $wgBotPasswordsDatabase );
  83         }
  84
  85         /**
  86          * Load a BotPassword from the database
  87          * @param User $user
  88          * @param string $appId
  89          * @param int $flags IDBAccessObject read flags
  90          * @return BotPassword|null
  91          */
  92         public static function newFromUser( User $user, $appId, $flags = self::READ_NORMAL ) {
  93                 $centralId = CentralIdLookup::factory()->centralIdFromLocalUser(
  94                         $user, CentralIdLookup::AUDIENCE_RAW, $flags
  95                 );
  96                 return $centralId ? self::newFromCentralId( $centralId, $appId, $flags ) : null;
  97         }
  98
  99         /**
 100          * Load a BotPassword from the database
 101          * @param int $centralId from CentralIdLookup
 102          * @param string $appId
 103          * @param int $flags IDBAccessObject read flags
 104          * @return BotPassword|null
 105          */
 106         public static function newFromCentralId( $centralId, $appId, $flags = self::READ_NORMAL ) {
 107                 global $wgEnableBotPasswords;
 108
 109                 if ( !$wgEnableBotPasswords ) {
 110                         return null;
 111                 }
 112
 113                 list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
 114                 $db = self::getDB( $index );
 115                 $row = $db->selectRow(
 116                         'bot_passwords',
 117                         [ 'bp_user', 'bp_app_id', 'bp_token', 'bp_restrictions', 'bp_grants' ],
 118                         [ 'bp_user' => $centralId, 'bp_app_id' => $appId ],
 119                         __METHOD__,
 120                         $options
 121                 );
 122                 return $row ? new self( $row, true, $flags ) : null;
 123         }
 124
 125         /**
 126          * Create an unsaved BotPassword
 127          * @param array $data Data to use to create the bot password. Keys are:
 128          *  - user: (User) User object to create the password for. Overrides username and centralId.
 129          *  - username: (string) Username to create the password for. Overrides centralId.
 130          *  - centralId: (int) User central ID to create the password for.
 131          *  - appId: (string) App ID for the password.
 132          *  - restrictions: (MWRestrictions, optional) Restrictions.
 133          *  - grants: (string[], optional) Grants.
 134          * @param int $flags IDBAccessObject read flags
 135          * @return BotPassword|null
 136          */
 137         public static function newUnsaved( array $data, $flags = self::READ_NORMAL ) {
 138                 $row = (object)[
 139                         'bp_user' => 0,
 140                         'bp_app_id' => isset( $data['appId'] ) ? trim( $data['appId'] ) : '',
 141                         'bp_token' => '**unsaved**',
 142                         'bp_restrictions' => $data['restrictions'] ?? MWRestrictions::newDefault(),
 143                         'bp_grants' => $data['grants'] ?? [],
 144                 ];
 145
 146                 if (
 147                         $row->bp_app_id === '' || strlen( $row->bp_app_id ) > self::APPID_MAXLENGTH ||
 148                         !$row->bp_restrictions instanceof MWRestrictions ||
 149                         !is_array( $row->bp_grants )
 150                 ) {
 151                         return null;
 152                 }
 153
 154                 $row->bp_restrictions = $row->bp_restrictions->toJson();
 155                 $row->bp_grants = FormatJson::encode( $row->bp_grants );
 156
 157                 if ( isset( $data['user'] ) ) {
 158                         if ( !$data['user'] instanceof User ) {
 159                                 return null;
 160                         }
 161                         $row->bp_user = CentralIdLookup::factory()->centralIdFromLocalUser(
 162                                 $data['user'], CentralIdLookup::AUDIENCE_RAW, $flags
 163                         );
 164                 } elseif ( isset( $data['username'] ) ) {
 165                         $row->bp_user = CentralIdLookup::factory()->centralIdFromName(
 166                                 $data['username'], CentralIdLookup::AUDIENCE_RAW, $flags
 167                         );
 168                 } elseif ( isset( $data['centralId'] ) ) {
 169                         $row->bp_user = $data['centralId'];
 170                 }
 171                 if ( !$row->bp_user ) {
 172                         return null;
 173                 }
 174
 175                 return new self( $row, false, $flags );
 176         }
 177
 178         /**
 179          * Indicate whether this is known to be saved
 180          * @return bool
 181          */
 182         public function isSaved() {
 183                 return $this->isSaved;
 184         }
 185
 186         /**
 187          * Get the central user ID
 188          * @return int
 189          */
 190         public function getUserCentralId() {
 191                 return $this->centralId;
 192         }
 193
 194         /**
 195          * Get the app ID
 196          * @return string
 197          */
 198         public function getAppId() {
 199                 return $this->appId;
 200         }
 201
 202         /**
 203          * Get the token
 204          * @return string
 205          */
 206         public function getToken() {
 207                 return $this->token;
 208         }
 209
 210         /**
 211          * Get the restrictions
 212          * @return MWRestrictions
 213          */
 214         public function getRestrictions() {
 215                 return $this->restrictions;
 216         }
 217
 218         /**
 219          * Get the grants
 220          * @return string[]
 221          */
 222         public function getGrants() {
 223                 return $this->grants;
 224         }
 225
 226         /**
 227          * Get the separator for combined user name + app ID
 228          * @return string
 229          */
 230         public static function getSeparator() {
 231                 global $wgUserrightsInterwikiDelimiter;
 232                 return $wgUserrightsInterwikiDelimiter;
 233         }
 234
 235         /**
 236          * Get the password
 237          * @return Password
 238          */
 239         protected function getPassword() {
 240                 list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $this->flags );
 241                 $db = self::getDB( $index );
 242                 $password = $db->selectField(
 243                         'bot_passwords',
 244                         'bp_password',
 245                         [ 'bp_user' => $this->centralId, 'bp_app_id' => $this->appId ],
 246                         __METHOD__,
 247                         $options
 248                 );
 249                 if ( $password === false ) {
 250                         return PasswordFactory::newInvalidPassword();
 251                 }
 252
 253                 $passwordFactory = MediaWikiServices::getInstance()->getPasswordFactory();
 254                 try {
 255                         return $passwordFactory->newFromCiphertext( $password );
 256                 } catch ( PasswordError $ex ) {
 257                         return PasswordFactory::newInvalidPassword();
 258                 }
 259         }
 260
 261         /**
 262          * Whether the password is currently invalid
 263          * @since 1.32
 264          * @return bool
 265          */
 266         public function isInvalid() {
 267                 return $this->getPassword() instanceof InvalidPassword;
 268         }
 269
 270         /**
 271          * Save the BotPassword to the database
 272          * @param string $operation 'update' or 'insert'
 273          * @param Password|null $password Password to set.
 274          * @return bool Success
 275          */
 276         public function save( $operation, Password $password = null ) {
 277                 $conds = [
 278                         'bp_user' => $this->centralId,
 279                         'bp_app_id' => $this->appId,
 280                 ];
 281                 $fields = [
 282                         'bp_token' => MWCryptRand::generateHex( User::TOKEN_LENGTH ),
 283                         'bp_restrictions' => $this->restrictions->toJson(),
 284                         'bp_grants' => FormatJson::encode( $this->grants ),
 285                 ];
 286
 287                 if ( $password !== null ) {
 288                         $fields['bp_password'] = $password->toString();
 289                 } elseif ( $operation === 'insert' ) {
 290                         $fields['bp_password'] = PasswordFactory::newInvalidPassword()->toString();
 291                 }
 292
 293                 $dbw = self::getDB( DB_MASTER );
 294                 switch ( $operation ) {
 295                         case 'insert':
 296                                 $dbw->insert( 'bot_passwords', $fields + $conds, __METHOD__, [ 'IGNORE' ] );
 297                                 break;
 298
 299                         case 'update':
 300                                 $dbw->update( 'bot_passwords', $fields, $conds, __METHOD__ );
 301                                 break;
 302
 303                         default:
 304                                 return false;
 305                 }
 306                 $ok = (bool)$dbw->affectedRows();
 307                 if ( $ok ) {
 308                         $this->token = $dbw->selectField( 'bot_passwords', 'bp_token', $conds, __METHOD__ );
 309                         $this->isSaved = true;
 310                 }
 311                 return $ok;
 312         }
 313
 314         /**
 315          * Delete the BotPassword from the database
 316          * @return bool Success
 317          */
 318         public function delete() {
 319                 $conds = [
 320                         'bp_user' => $this->centralId,
 321                         'bp_app_id' => $this->appId,
 322                 ];
 323                 $dbw = self::getDB( DB_MASTER );
 324                 $dbw->delete( 'bot_passwords', $conds, __METHOD__ );
 325                 $ok = (bool)$dbw->affectedRows();
 326                 if ( $ok ) {
 327                         $this->token = '**unsaved**';
 328                         $this->isSaved = false;
 329                 }
 330                 return $ok;
 331         }
 332
 333         /**
 334          * Invalidate all passwords for a user, by name
 335          * @param string $username User name
 336          * @return bool Whether any passwords were invalidated
 337          */
 338         public static function invalidateAllPasswordsForUser( $username ) {
 339                 $centralId = CentralIdLookup::factory()->centralIdFromName(
 340                         $username, CentralIdLookup::AUDIENCE_RAW, CentralIdLookup::READ_LATEST
 341                 );
 342                 return $centralId && self::invalidateAllPasswordsForCentralId( $centralId );
 343         }
 344
 345         /**
 346          * Invalidate all passwords for a user, by central ID
 347          * @param int $centralId
 348          * @return bool Whether any passwords were invalidated
 349          */
 350         public static function invalidateAllPasswordsForCentralId( $centralId ) {
 351                 global $wgEnableBotPasswords;
 352
 353                 if ( !$wgEnableBotPasswords ) {
 354                         return false;
 355                 }
 356
 357                 $dbw = self::getDB( DB_MASTER );
 358                 $dbw->update(
 359                         'bot_passwords',
 360                         [ 'bp_password' => PasswordFactory::newInvalidPassword()->toString() ],
 361                         [ 'bp_user' => $centralId ],
 362                         __METHOD__
 363                 );
 364                 return (bool)$dbw->affectedRows();
 365         }
 366
 367         /**
 368          * Remove all passwords for a user, by name
 369          * @param string $username User name
 370          * @return bool Whether any passwords were removed
 371          */
 372         public static function removeAllPasswordsForUser( $username ) {
 373                 $centralId = CentralIdLookup::factory()->centralIdFromName(
 374                         $username, CentralIdLookup::AUDIENCE_RAW, CentralIdLookup::READ_LATEST
 375                 );
 376                 return $centralId && self::removeAllPasswordsForCentralId( $centralId );
 377         }
 378
 379         /**
 380          * Remove all passwords for a user, by central ID
 381          * @param int $centralId
 382          * @return bool Whether any passwords were removed
 383          */
 384         public static function removeAllPasswordsForCentralId( $centralId ) {
 385                 global $wgEnableBotPasswords;
 386
 387                 if ( !$wgEnableBotPasswords ) {
 388                         return false;
 389                 }
 390
 391                 $dbw = self::getDB( DB_MASTER );
 392                 $dbw->delete(
 393                         'bot_passwords',
 394                         [ 'bp_user' => $centralId ],
 395                         __METHOD__
 396                 );
 397                 return (bool)$dbw->affectedRows();
 398         }
 399
 400         /**
 401          * Returns a (raw, unhashed) random password string.
 402          * @param Config $config
 403          * @return string
 404          */
 405         public static function generatePassword( $config ) {
 406                 return PasswordFactory::generateRandomPasswordString(
 407                         max( 32, $config->get( 'MinimalPasswordLength' ) ) );
 408         }
 409
 410         /**
 411          * There are two ways to login with a bot password: "username@appId", "password" and
 412          * "username", "appId@password". Transform it so it is always in the first form.
 413          * Returns [bot username, bot password, could be normal password?] where the last one is a flag
 414          * meaning this could either be a bot password or a normal password, it cannot be decided for
 415          * certain (although in such cases it almost always will be a bot password).
 416          * If this cannot be a bot password login just return false.
 417          * @param string $username
 418          * @param string $password
 419          * @return array|false
 420          */
 421         public static function canonicalizeLoginData( $username, $password ) {
 422                 $sep = self::getSeparator();
 423                 // the strlen check helps minimize the password information obtainable from timing
 424                 if ( strlen( $password ) >= 32 && strpos( $username, $sep ) !== false ) {
 425                         // the separator is not valid in new usernames but might appear in legacy ones
 426                         if ( preg_match( '/^[0-9a-w]{32,}$/', $password ) ) {
 427                                 return [ $username, $password, true ];
 428                         }
 429                 } elseif ( strlen( $password ) > 32 && strpos( $password, $sep ) !== false ) {
 430                         $segments = explode( $sep, $password );
 431                         $password = array_pop( $segments );
 432                         $appId = implode( $sep, $segments );
 433                         if ( preg_match( '/^[0-9a-w]{32,}$/', $password ) ) {
 434                                 return [ $username . $sep . $appId, $password, true ];
 435                         }
 436                 }
 437                 return false;
 438         }
 439
 440         /**
 441          * Try to log the user in
 442          * @param string $username Combined user name and app ID
 443          * @param string $password Supplied password
 444          * @param WebRequest $request
 445          * @return Status On success, the good status's value is the new Session object
 446          */
 447         public static function login( $username, $password, WebRequest $request ) {
 448                 global $wgEnableBotPasswords, $wgPasswordAttemptThrottle;
 449
 450                 if ( !$wgEnableBotPasswords ) {
 451                         return Status::newFatal( 'botpasswords-disabled' );
 452                 }
 453
 454                 $manager = MediaWiki\Session\SessionManager::singleton();
 455                 $provider = $manager->getProvider( BotPasswordSessionProvider::class );
 456                 if ( !$provider ) {
 457                         return Status::newFatal( 'botpasswords-no-provider' );
 458                 }
 459
 460                 // Split name into name+appId
 461                 $sep = self::getSeparator();
 462                 if ( strpos( $username, $sep ) === false ) {
 463                         return Status::newFatal( 'botpasswords-invalid-name', $sep );
 464                 }
 465                 list( $name, $appId ) = explode( $sep, $username, 2 );
 466
 467                 // Find the named user
 468                 $user = User::newFromName( $name );
 469                 if ( !$user || $user->isAnon() ) {
 470                         return Status::newFatal( 'nosuchuser', $name );
 471                 }
 472
 473                 if ( $user->isLocked() ) {
 474                         return Status::newFatal( 'botpasswords-locked' );
 475                 }
 476
 477                 // Throttle
 478                 $throttle = null;
 479                 if ( !empty( $wgPasswordAttemptThrottle ) ) {
 480                         $throttle = new MediaWiki\Auth\Throttler( $wgPasswordAttemptThrottle, [
 481                                 'type' => 'botpassword',
 482                                 'cache' => ObjectCache::getLocalClusterInstance(),
 483                         ] );
 484                         $result = $throttle->increase( $user->getName(), $request->getIP(), __METHOD__ );
 485                         if ( $result ) {
 486                                 $msg = wfMessage( 'login-throttled' )->durationParams( $result['wait'] );
 487                                 return Status::newFatal( $msg );
 488                         }
 489                 }
 490
 491                 // Get the bot password
 492                 $bp = self::newFromUser( $user, $appId );
 493                 if ( !$bp ) {
 494                         return Status::newFatal( 'botpasswords-not-exist', $name, $appId );
 495                 }
 496
 497                 // Check restrictions
 498                 $status = $bp->getRestrictions()->check( $request );
 499                 if ( !$status->isOK() ) {
 500                         return Status::newFatal( 'botpasswords-restriction-failed' );
 501                 }
 502
 503                 // Check the password
 504                 $passwordObj = $bp->getPassword();
 505                 if ( $passwordObj instanceof InvalidPassword ) {
 506                         return Status::newFatal( 'botpasswords-needs-reset', $name, $appId );
 507                 }
 508                 if ( !$passwordObj->equals( $password ) ) {
 509                         return Status::newFatal( 'wrongpassword' );
 510                 }
 511
 512                 // Ok! Create the session.
 513                 if ( $throttle ) {
 514                         $throttle->clear( $user->getName(), $request->getIP() );
 515                 }
 516                 return Status::newGood( $provider->newSessionForRequest( $user, $bp, $request ) );
 517         }
 518 }