MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / maintenance / resetUserTokens.php

diff --git a/maintenance/resetUserTokens.php b/maintenance/resetUserTokens.php
new file mode 100644 (file)
index 0000000..481da98
--- /dev/null
+++ b/maintenance/resetUserTokens.php
@@ -0,0 +1,120 @@
+<?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';
+
+/**
+ * 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() {
+               $this->nullsOnly = $this->getOption( 'nulls' );
+
+               if ( !$this->getOption( 'nowarn' ) ) {
+                       if ( $this->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) ... " );
+                       wfCountDown( 5 );
+               }
+
+               // We list user by user_id from one of the replica DBs
+               // We list user by user_id from one of the slave database
+               $dbr = $this->getDB( DB_REPLICA );
+
+               $where = [];
+               if ( $this->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->mBatchSize;
+
+               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->mBatchSize;
+
+                       wfWaitForSlaves();
+               } 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";
+require_once RUN_MAINTENANCE_IF_MAIN;