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
|
<?php
/**
* Creates a bot password for an existing user account.
*
* 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 Alex Dean <wikimedia@mostlyalex.com>
*/
use MediaWiki\User\BotPassword;
use MediaWiki\User\User;
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
class CreateBotPassword extends Maintenance {
/**
* Width of initial column of --showgrants output
*/
private const SHOWGRANTS_COLUMN_WIDTH = 20;
public function __construct() {
parent::__construct();
$this->addDescription(
'Create a bot password for a user. ' .
'See https://www.mediawiki.org/wiki/Manual:Bot_passwords for more information.'
);
$this->addOption( "showgrants",
"Prints a description of available grants and exits."
);
$this->addOption( "appid",
"App id for the new bot password.", false, true
);
$this->addOption( "grants",
"CSV list of permissions to grant.", false, true
);
$this->addArg( "user",
"The username to create a bot password for.", false
);
$this->addArg( "password",
"A password will be generated if this is omitted." .
" If supplied, it must be exactly 32 characters.", false
);
}
public function execute() {
if ( $this->hasOption( 'showgrants' ) ) {
$this->showGrants();
return;
}
$username = $this->getArg( 0 );
$password = $this->getArg( 1 );
$appId = $this->getOption( 'appid' );
$grants = explode( ',', $this->getOption( 'grants', '' ) );
$errors = [];
if ( $username === null ) {
$errors[] = "Argument <user> required!";
}
if ( $appId == null ) {
$errors[] = "Param appid required!";
}
if ( $this->getOption( 'grants' ) === null ) {
$errors[] = "Param grants required!";
}
if ( count( $errors ) > 0 ) {
$this->fatalError( implode( "\n", $errors ) );
}
$services = $this->getServiceContainer();
$grantsInfo = $services->getGrantsInfo();
$invalidGrants = array_diff( $grants, $grantsInfo->getValidGrants() );
if ( count( $invalidGrants ) > 0 ) {
$this->fatalError(
"These grants are invalid: " . implode( ', ', $invalidGrants ) . "\n" .
"Use the --showgrants option for a full list of valid grant names."
);
}
$passwordFactory = $services->getPasswordFactory();
$userIdentity = $services->getUserIdentityLookup()->getUserIdentityByName( $username );
if ( !$userIdentity || !$userIdentity->isRegistered() ) {
$this->fatalError( "Cannot create bot password for non-existent user '$username'." );
}
if ( $password === null ) {
$password = BotPassword::generatePassword( $this->getConfig() );
} else {
$passwordLength = strlen( $password );
if ( $passwordLength < BotPassword::PASSWORD_MINLENGTH ) {
$message = "Bot passwords must have at least " . BotPassword::PASSWORD_MINLENGTH .
" characters. Given password is $passwordLength characters.";
$this->fatalError( $message );
}
}
$bp = BotPassword::newUnsaved( [
'username' => $username,
'appId' => $appId,
'grants' => $grants
] );
if ( $bp === null ) {
$this->fatalError( "Bot password creation failed." );
}
$passwordInstance = $passwordFactory->newFromPlaintext( $password );
$status = $bp->save( 'insert', $passwordInstance );
if ( $status->isGood() ) {
$this->output( "Success.\n" );
$this->output( "Log in using username:'{$username}@{$appId}' and password:'{$password}'.\n" );
} else {
$this->error( "Bot password creation failed. Does this appid already exist for the user perhaps?" );
$this->fatalError( $status );
}
}
public function showGrants() {
$permissions = $this->getServiceContainer()->getGrantsInfo()->getValidGrants();
sort( $permissions );
$this->output( str_pad( 'GRANT', self::SHOWGRANTS_COLUMN_WIDTH ) . " DESCRIPTION\n" );
foreach ( $permissions as $permission ) {
$this->output(
str_pad( $permission, self::SHOWGRANTS_COLUMN_WIDTH ) . " " .
User::getRightDescription( $permission ) . "\n"
);
}
}
}
// @codeCoverageIgnoreStart
$maintClass = CreateBotPassword::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd
|
