BotPassword.php

Go to the documentation of this file.

<?php
use MediaWiki\Auth\AuthenticationResponse;
use MediaWiki\Auth\Throttler;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Session\BotPasswordSessionProvider;
use MediaWiki\Session\SessionManager;
use MediaWiki\User\UserIdentity;
use Wikimedia\Rdbms\IDatabase;
 
class BotPassword implements IDBAccessObject {
 
    public const APPID_MAXLENGTH = 32;
 
    public const PASSWORD_MINLENGTH = 32;
 
    public const RESTRICTIONS_MAXLENGTH = 65535;
 
    public const GRANTS_MAXLENGTH = 65535;
 
    private $isSaved;
 
    private $centralId;
 
    private $appId;
 
    private $token;
 
    private $restrictions;
 
    private $grants;
 
    private $flags;
 
    public function __construct( $row, $isSaved, $flags = self::READ_NORMAL ) {
        $this->isSaved = $isSaved;
        $this->flags = $flags;
 
        $this->centralId = (int)$row->bp_user;
        $this->appId = $row->bp_app_id;
        $this->token = $row->bp_token;
        $this->restrictions = MWRestrictions::newFromJson( $row->bp_restrictions );
        $this->grants = FormatJson::decode( $row->bp_grants );
    }
 
    public static function getDB( $db ) {
        return MediaWikiServices::getInstance()
            ->getBotPasswordStore()
            ->getDatabase( $db );
    }
 
    public static function newFromUser( UserIdentity $userIdentity, $appId, $flags = self::READ_NORMAL ) {
        return MediaWikiServices::getInstance()
            ->getBotPasswordStore()
            ->getByUser( $userIdentity, (string)$appId, (int)$flags );
    }
 
    public static function newFromCentralId( $centralId, $appId, $flags = self::READ_NORMAL ) {
        return MediaWikiServices::getInstance()
            ->getBotPasswordStore()
            ->getByCentralId( (int)$centralId, (string)$appId, (int)$flags );
    }
 
    public static function newUnsaved( array $data, $flags = self::READ_NORMAL ) {
        return MediaWikiServices::getInstance()
            ->getBotPasswordStore()
            ->newUnsavedBotPassword( $data, (int)$flags );
    }
 
    public function isSaved() {
        return $this->isSaved;
    }
 
    public function getUserCentralId() {
        return $this->centralId;
    }
 
    public function getAppId() {
        return $this->appId;
    }
 
    public function getToken() {
        return $this->token;
    }
 
    public function getRestrictions() {
        return $this->restrictions;
    }
 
    public function getGrants() {
        return $this->grants;
    }
 
    public static function getSeparator() {
        $userrightsInterwikiDelimiter = MediaWikiServices::getInstance()
            ->getMainConfig()->get( MainConfigNames::UserrightsInterwikiDelimiter );
        return $userrightsInterwikiDelimiter;
    }
 
    private function getPassword() {
        [ $index, $options ] = DBAccessObjectUtils::getDBOptions( $this->flags );
        $db = self::getDB( $index );
        $password = $db->selectField(
            'bot_passwords',
            'bp_password',
            [ 'bp_user' => $this->centralId, 'bp_app_id' => $this->appId ],
            __METHOD__,
            $options
        );
        if ( $password === false ) {
            return PasswordFactory::newInvalidPassword();
        }
 
        $passwordFactory = MediaWikiServices::getInstance()->getPasswordFactory();
        try {
            return $passwordFactory->newFromCiphertext( $password );
        } catch ( PasswordError $ex ) {
            return PasswordFactory::newInvalidPassword();
        }
    }
 
    public function isInvalid() {
        return $this->getPassword() instanceof InvalidPassword;
    }
 
    public function save( $operation, Password $password = null ) {
        // Ensure operation is valid
        if ( $operation !== 'insert' && $operation !== 'update' ) {
            throw new UnexpectedValueException(
                "Expected 'insert' or 'update'; got '{$operation}'."
            );
        }
 
        $store = MediaWikiServices::getInstance()->getBotPasswordStore();
        if ( $operation === 'insert' ) {
            $statusValue = $store->insertBotPassword( $this, $password );
        } else {
            // Must be update, already checked above
            $statusValue = $store->updateBotPassword( $this, $password );
        }
 
        if ( $statusValue->isGood() ) {
            $this->token = $statusValue->getValue();
            $this->isSaved = true;
            return Status::newGood();
        }
 
        // Action failed, status will have code botpasswords-insert-failed or
        // botpasswords-update-failed depending on which action we tried
        return Status::wrap( $statusValue );
    }
 
    public function delete() {
        $ok = MediaWikiServices::getInstance()
            ->getBotPasswordStore()
            ->deleteBotPassword( $this );
        if ( $ok ) {
            $this->token = '**unsaved**';
            $this->isSaved = false;
        }
        return $ok;
    }
 
    public static function invalidateAllPasswordsForUser( $username ) {
        return MediaWikiServices::getInstance()
            ->getBotPasswordStore()
            ->invalidateUserPasswords( (string)$username );
    }
 
    public static function invalidateAllPasswordsForCentralId( $centralId ) {
        wfDeprecated( __METHOD__, '1.37' );
 
        $enableBotPasswords = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::EnableBotPasswords );
 
        if ( !$enableBotPasswords ) {
            return false;
        }
 
        $dbw = self::getDB( DB_PRIMARY );
        $dbw->update(
            'bot_passwords',
            [ 'bp_password' => PasswordFactory::newInvalidPassword()->toString() ],
            [ 'bp_user' => $centralId ],
            __METHOD__
        );
        return (bool)$dbw->affectedRows();
    }
 
    public static function removeAllPasswordsForUser( $username ) {
        return MediaWikiServices::getInstance()
            ->getBotPasswordStore()
            ->removeUserPasswords( (string)$username );
    }
 
    public static function removeAllPasswordsForCentralId( $centralId ) {
        wfDeprecated( __METHOD__, '1.37' );
 
        $enableBotPasswords = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::EnableBotPasswords );
 
        if ( !$enableBotPasswords ) {
            return false;
        }
 
        $dbw = self::getDB( DB_PRIMARY );
        $dbw->delete(
            'bot_passwords',
            [ 'bp_user' => $centralId ],
            __METHOD__
        );
        return (bool)$dbw->affectedRows();
    }
 
    public static function generatePassword( $config ) {
        return PasswordFactory::generateRandomPasswordString( max(
            self::PASSWORD_MINLENGTH, $config->get( MainConfigNames::MinimalPasswordLength ) ) );
    }
 
    public static function canonicalizeLoginData( $username, $password ) {
        $sep = self::getSeparator();
        // the strlen check helps minimize the password information obtainable from timing
        if ( strlen( $password ) >= self::PASSWORD_MINLENGTH && str_contains( $username, $sep ) ) {
            // the separator is not valid in new usernames but might appear in legacy ones
            if ( preg_match( '/^[0-9a-w]{' . self::PASSWORD_MINLENGTH . ',}$/', $password ) ) {
                return [ $username, $password ];
            }
        } elseif ( strlen( $password ) > self::PASSWORD_MINLENGTH && str_contains( $password, $sep ) ) {
            $segments = explode( $sep, $password );
            $password = array_pop( $segments );
            $appId = implode( $sep, $segments );
            if ( preg_match( '/^[0-9a-w]{' . self::PASSWORD_MINLENGTH . ',}$/', $password ) ) {
                return [ $username . $sep . $appId, $password ];
            }
        }
        return false;
    }
 
    public static function login( $username, $password, WebRequest $request ) {
        $enableBotPasswords = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::EnableBotPasswords );
        $passwordAttemptThrottle = MediaWikiServices::getInstance()->getMainConfig()
            ->get( MainConfigNames::PasswordAttemptThrottle );
        if ( !$enableBotPasswords ) {
            return Status::newFatal( 'botpasswords-disabled' );
        }
 
        $provider = SessionManager::singleton()->getProvider( BotPasswordSessionProvider::class );
        if ( !$provider ) {
            return Status::newFatal( 'botpasswords-no-provider' );
        }
 
        // Split name into name+appId
        $sep = self::getSeparator();
        if ( !str_contains( $username, $sep ) ) {
            return self::loginHook( $username, null, Status::newFatal( 'botpasswords-invalid-name', $sep ) );
        }
        [ $name, $appId ] = explode( $sep, $username, 2 );
 
        // Find the named user
        $user = User::newFromName( $name );
        if ( !$user || $user->isAnon() ) {
            return self::loginHook( $user ?: $name, null, Status::newFatal( 'nosuchuser', $name ) );
        }
 
        if ( $user->isLocked() ) {
            return Status::newFatal( 'botpasswords-locked' );
        }
 
        $throttle = null;
        if ( !empty( $passwordAttemptThrottle ) ) {
            $throttle = new Throttler( $passwordAttemptThrottle, [
                'type' => 'botpassword',
                'cache' => ObjectCache::getLocalClusterInstance(),
            ] );
            $result = $throttle->increase( $user->getName(), $request->getIP(), __METHOD__ );
            if ( $result ) {
                $msg = wfMessage( 'login-throttled' )->durationParams( $result['wait'] );
                return self::loginHook( $user, null, Status::newFatal( $msg ) );
            }
        }
 
        // Get the bot password
        $bp = self::newFromUser( $user, $appId );
        if ( !$bp ) {
            return self::loginHook( $user, $bp,
                Status::newFatal( 'botpasswords-not-exist', $name, $appId ) );
        }
 
        // Check restrictions
        $status = $bp->getRestrictions()->check( $request );
        if ( !$status->isOK() ) {
            return self::loginHook( $user, $bp, Status::newFatal( 'botpasswords-restriction-failed' ) );
        }
 
        // Check the password
        $passwordObj = $bp->getPassword();
        if ( $passwordObj instanceof InvalidPassword ) {
            return self::loginHook( $user, $bp,
                Status::newFatal( 'botpasswords-needs-reset', $name, $appId ) );
        }
        if ( !$passwordObj->verify( $password ) ) {
            return self::loginHook( $user, $bp, Status::newFatal( 'wrongpassword' ) );
        }
 
        // Ok! Create the session.
        if ( $throttle ) {
            $throttle->clear( $user->getName(), $request->getIP() );
        }
        return self::loginHook( $user, $bp,
            // @phan-suppress-next-line PhanUndeclaredMethod
            Status::newGood( $provider->newSessionForRequest( $user, $bp, $request ) ) );
    }
 
    private static function loginHook( $user, $bp, Status $status ) {
        $extraData = [];
        if ( $user instanceof User ) {
            $name = $user->getName();
            if ( $bp ) {
                $extraData['appId'] = $name . self::getSeparator() . $bp->getAppId();
            }
        } else {
            $name = $user;
            $user = null;
        }
 
        if ( $status->isGood() ) {
            $response = AuthenticationResponse::newPass( $name );
        } else {
            $response = AuthenticationResponse::newFail( $status->getMessage() );
        }
        Hooks::runner()->onAuthManagerLoginAuthenticateAudit( $response, $user, $name, $extraData );
 
        return $status;
    }
}