MediaWiki  REL1_31
wrapOldPasswords.php
Go to the documentation of this file.
1 <?php
2 
4 
26 require_once __DIR__ . '/Maintenance.php';
27 
36  public function __construct() {
37  parent::__construct();
38  $this->addDescription( 'Wrap all passwords of a certain type in a new layered type' );
39  $this->addOption( 'type',
40  'Password type to wrap passwords in (must inherit LayeredParameterizedPassword)', true, true );
41  $this->addOption( 'verbose', 'Enables verbose output', false, false, 'v' );
42  $this->setBatchSize( 100 );
43  }
44 
45  public function execute() {
46  $passwordFactory = new PasswordFactory();
47  $passwordFactory->init( RequestContext::getMain()->getConfig() );
48 
49  $typeInfo = $passwordFactory->getTypes();
50  $layeredType = $this->getOption( 'type' );
51 
52  // Check that type exists and is a layered type
53  if ( !isset( $typeInfo[$layeredType] ) ) {
54  $this->fatalError( 'Undefined password type' );
55  }
56 
57  $passObj = $passwordFactory->newFromType( $layeredType );
58  if ( !$passObj instanceof LayeredParameterizedPassword ) {
59  $this->fatalError( 'Layered parameterized password type must be used.' );
60  }
61 
62  // Extract the first layer type
63  $typeConfig = $typeInfo[$layeredType];
64  $firstType = $typeConfig['types'][0];
65 
66  // Get a list of password types that are applicable
67  $dbw = $this->getDB( DB_MASTER );
68  $typeCond = 'user_password' . $dbw->buildLike( ":$firstType:", $dbw->anyString() );
69 
70  $minUserId = 0;
71  $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
72  do {
73  $this->beginTransaction( $dbw, __METHOD__ );
74 
75  $res = $dbw->select( 'user',
76  [ 'user_id', 'user_name', 'user_password' ],
77  [
78  'user_id > ' . $dbw->addQuotes( $minUserId ),
79  $typeCond
80  ],
81  __METHOD__,
82  [
83  'ORDER BY' => 'user_id',
84  'LIMIT' => $this->getBatchSize(),
85  'LOCK IN SHARE MODE',
86  ]
87  );
88 
90  $updateUsers = [];
91  foreach ( $res as $row ) {
92  if ( $this->hasOption( 'verbose' ) ) {
93  $this->output( "Updating password for user {$row->user_name} ({$row->user_id}).\n" );
94  }
95 
96  $user = User::newFromId( $row->user_id );
98  $password = $passwordFactory->newFromCiphertext( $row->user_password );
100  $layeredPassword = $passwordFactory->newFromType( $layeredType );
101  $layeredPassword->partialCrypt( $password );
102 
103  $updateUsers[] = $user;
104  $dbw->update( 'user',
105  [ 'user_password' => $layeredPassword->toString() ],
106  [ 'user_id' => $row->user_id ],
107  __METHOD__
108  );
109 
110  $minUserId = $row->user_id;
111  }
112 
113  $this->commitTransaction( $dbw, __METHOD__ );
114  $lbFactory->waitForReplication();
115 
116  // Clear memcached so old passwords are wiped out
117  foreach ( $updateUsers as $user ) {
118  $user->clearSharedCache();
119  }
120  } while ( $res->numRows() );
121  }
122 }
123 
125 require_once RUN_MAINTENANCE_IF_MAIN;
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
WrapOldPasswords
Maintenance script to wrap all passwords of a certain type in a specified layered type that wraps aro...
Definition: wrapOldPasswords.php:35
User\newFromId
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:614
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:439
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
$res
$res
Definition: database.txt:21
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
WrapOldPasswords\__construct
__construct()
Default constructor.
Definition: wrapOldPasswords.php:36
WrapOldPasswords\execute
execute()
Do the actual work.
Definition: wrapOldPasswords.php:45
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
Maintenance\beginTransaction
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.
Definition: Maintenance.php:1336
Maintenance\getConfig
getConfig()
Definition: Maintenance.php:547
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
DB_MASTER
const DB_MASTER
Definition: defines.php:29
$maintClass
$maintClass
Definition: wrapOldPasswords.php:124
LayeredParameterizedPassword
This password hash type layers one or more parameterized password types on top of each other.
Definition: LayeredParameterizedPassword.php:33
Maintenance\commitTransaction
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for replica DBs to catch up.
Definition: Maintenance.php:1351
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:434
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:254
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
Maintenance\getDB
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1309
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
PasswordFactory
Factory class for creating and checking Password objects.
Definition: PasswordFactory.php:28
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:25
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:240
Maintenance\setBatchSize
setBatchSize( $s=0)
Set the batch size.
Definition: Maintenance.php:329