1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
<?php
/**
* Maintenance script to wrap all old-style passwords in a layered type
*
* 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
*/
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
/**
* Maintenance script to wrap all passwords of a certain type in a specified layered
* type that wraps around the old type.
*
* @since 1.24
* @ingroup Maintenance
*/
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->beginTransaction( $dbw, __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->commitTransaction( $dbw, __METHOD__ );
}
break;
}
/** @var User[] $updateUsers */
$updateUsers = [];
foreach ( $res as $row ) {
$user = User::newFromId( $row->user_id );
/** @var ParameterizedPassword $password */
$password = $passwordFactory->newFromCiphertext( $row->user_password );
'@phan-var ParameterizedPassword $password';
/** @var LayeredParameterizedPassword $layeredPassword */
$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->commitTransaction( $dbw, __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
|
