archwiki/maintenance/resetUserTokens.php

123 lines
3.7 KiB
PHP

<?php
/**
* Reset the user_token for all users on the wiki. Useful if you believe
* that your user table was acidentally leaked to an external source.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
* @author Daniel Friesen <mediawiki@danielfriesen.name>
* @author Chris Steipp <csteipp@wikimedia.org>
*/
require_once __DIR__ . '/Maintenance.php';
use MediaWiki\MediaWikiServices;
/**
* Maintenance script to reset the user_token for all users on the wiki.
*
* @ingroup Maintenance
* @deprecated since 1.27, use $wgAuthenticationTokenVersion instead.
*/
class ResetUserTokens extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription(
"Reset the user_token of all users on the wiki. Note that this may log some of them out.\n"
. "Deprecated, use \$wgAuthenticationTokenVersion instead."
);
$this->addOption( 'nowarn', "Hides the 5 seconds warning", false, false );
$this->addOption(
'nulls',
'Only reset tokens that are currently null (string of \x00\'s)',
false,
false
);
$this->setBatchSize( 1000 );
}
public function execute() {
$nullsOnly = $this->getOption( 'nulls' );
if ( !$this->getOption( 'nowarn' ) ) {
if ( $nullsOnly ) {
$this->output( "The script is about to reset the user_token "
. "for USERS WITH NULL TOKENS in the database.\n" );
} else {
$this->output( "The script is about to reset the user_token for ALL USERS in the database.\n" );
$this->output( "This may log some of them out and is not necessary unless you believe your\n" );
$this->output( "user table has been compromised.\n" );
}
$this->output( "\n" );
$this->output( "Abort with control-c in the next five seconds "
. "(skip this countdown with --nowarn) ..." );
$this->countDown( 5 );
}
// We list user by user_id from one of the replica DBs
$dbr = $this->getDB( DB_REPLICA );
$where = [];
if ( $nullsOnly ) {
// Have to build this by hand, because \ is escaped in helper functions
$where = [ 'user_token = \'' . str_repeat( '\0', 32 ) . '\'' ];
}
$maxid = $dbr->selectField( 'user', 'MAX(user_id)', [], __METHOD__ );
$min = 0;
$max = $this->getBatchSize();
$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
do {
$result = $dbr->select( 'user',
[ 'user_id' ],
array_merge(
$where,
[ 'user_id > ' . $dbr->addQuotes( $min ),
'user_id <= ' . $dbr->addQuotes( $max )
]
),
__METHOD__
);
foreach ( $result as $user ) {
$this->updateUser( $user->user_id );
}
$min = $max;
$max = $min + $this->getBatchSize();
$lbFactory->waitForReplication();
} while ( $min <= $maxid );
}
private function updateUser( $userid ) {
$user = User::newFromId( $userid );
$username = $user->getName();
$this->output( 'Resetting user_token for "' . $username . '": ' );
// Change value
$user->setToken();
$user->saveSettings();
$this->output( " OK\n" );
}
}
$maintClass = ResetUserTokens::class;
require_once RUN_MAINTENANCE_IF_MAIN;