wrapOldPasswords.php

Go to the documentation of this file.

<?php
use MediaWiki\Maintenance\Maintenance;
use MediaWiki\Password\LayeredParameterizedPassword;
use MediaWiki\Password\ParameterizedPassword;
use MediaWiki\User\User;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\LikeValue;
 
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
 
class WrapOldPasswords extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Wrap all passwords of a certain type in a new layered type. '
                    . 'The script runs in dry-run mode by default (use --update to update rows)' );
        $this->addOption( 'type',
            'Password type to wrap passwords in (must inherit LayeredParameterizedPassword)', true, true );
        $this->addOption( 'verbose', 'Enables verbose output', false, false, 'v' );
        $this->addOption( 'update', 'Actually wrap passwords', false, false, 'u' );
        $this->setBatchSize( 3 );
    }
 
    public function execute() {
        $passwordFactory = $this->getServiceContainer()->getPasswordFactory();
 
        $typeInfo = $passwordFactory->getTypes();
        $layeredType = $this->getOption( 'type' );
 
        // Check that type exists and is a layered type
        if ( !isset( $typeInfo[$layeredType] ) ) {
            $this->fatalError( 'Undefined password type' );
        }
 
        $passObj = $passwordFactory->newFromType( $layeredType );
        if ( !$passObj instanceof LayeredParameterizedPassword ) {
            $this->fatalError( 'Layered parameterized password type must be used.' );
        }
 
        // Extract the first layer type
        $typeConfig = $typeInfo[$layeredType];
        $firstType = $typeConfig['types'][0];
 
        $update = $this->hasOption( 'update' );
 
        // Get a list of password types that are applicable
        $dbw = $this->getPrimaryDB();
 
        $count = 0;
        $minUserId = 0;
        while ( true ) {
            if ( $update ) {
                $this->beginTransactionRound( __METHOD__ );
            }
 
            $start = microtime( true );
            $res = $dbw->newSelectQueryBuilder()
                ->select( [ 'user_id', 'user_name', 'user_password' ] )
                ->lockInShareMode()
                ->from( 'user' )
                ->where( [
                    $dbw->expr( 'user_id', '>', $minUserId ),
                    $dbw->expr(
                        'user_password',
                        IExpression::LIKE,
                        new LikeValue( ":$firstType:", $dbw->anyString() )
                    ),
                ] )
                ->orderBy( 'user_id' )
                ->limit( $this->getBatchSize() )
                ->caller( __METHOD__ )->fetchResultSet();
 
            if ( $res->numRows() === 0 ) {
                if ( $update ) {
                    $this->commitTransactionRound( __METHOD__ );
                }
                break;
            }
 
            $updateUsers = [];
            foreach ( $res as $row ) {
                $user = User::newFromId( $row->user_id );
                $password = $passwordFactory->newFromCiphertext( $row->user_password );
                '@phan-var ParameterizedPassword $password';
                $layeredPassword = $passwordFactory->newFromType( $layeredType );
                '@phan-var LayeredParameterizedPassword $layeredPassword';
                $layeredPassword->partialCrypt( $password );
 
                if ( $this->hasOption( 'verbose' ) ) {
                    $this->output(
                        "Updating password for user {$row->user_name} ({$row->user_id}) from " .
                        "type {$password->getType()} to {$layeredPassword->getType()}.\n"
                    );
                }
 
                $count++;
                if ( $update ) {
                    $updateUsers[] = $user;
                    $dbw->newUpdateQueryBuilder()
                        ->update( 'user' )
                        ->set( [ 'user_password' => $layeredPassword->toString() ] )
                        ->where( [ 'user_id' => $row->user_id ] )
                        ->caller( __METHOD__ )
                        ->execute();
                }
 
                $minUserId = $row->user_id;
            }
 
            if ( $update ) {
                $this->commitTransactionRound( __METHOD__ );
 
                // Clear memcached so old passwords are wiped out
                foreach ( $updateUsers as $user ) {
                    $user->clearSharedCache( 'refresh' );
                }
            }
 
            $this->output( "Last id processed: $minUserId; Actually updated: $count...\n" );
            $delta = microtime( true ) - $start;
            $this->output( sprintf(
                "%4d passwords wrapped in %6.2fms (%6.2fms each)\n",
                $res->numRows(),
                $delta * 1000.0,
                ( $delta / $res->numRows() ) * 1000.0
            ) );
        }
 
        if ( $update ) {
            $this->output( "$count users rows updated.\n" );
        } else {
            $this->output( "$count user rows found using old password formats. "
                . "Run script again with --update to update these rows.\n" );
        }
    }
}
 
// @codeCoverageIgnoreStart
$maintClass = WrapOldPasswords::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd