MediaWiki  1.29.1
BotPassword.php
Go to the documentation of this file.
1 <?php
23 
28 class BotPassword implements IDBAccessObject {
29 
30  const APPID_MAXLENGTH = 32;
31 
33  private $isSaved;
34 
36  private $centralId;
37 
39  private $appId;
40 
42  private $token;
43 
45  private $restrictions;
46 
48  private $grants;
49 
51  private $flags = self::READ_NORMAL;
52 
58  protected function __construct( $row, $isSaved, $flags = self::READ_NORMAL ) {
59  $this->isSaved = $isSaved;
60  $this->flags = $flags;
61 
62  $this->centralId = (int)$row->bp_user;
63  $this->appId = $row->bp_app_id;
64  $this->token = $row->bp_token;
65  $this->restrictions = MWRestrictions::newFromJson( $row->bp_restrictions );
66  $this->grants = FormatJson::decode( $row->bp_grants );
67  }
68 
74  public static function getDB( $db ) {
75  global $wgBotPasswordsCluster, $wgBotPasswordsDatabase;
76 
77  $lb = $wgBotPasswordsCluster
78  ? wfGetLBFactory()->getExternalLB( $wgBotPasswordsCluster )
79  : wfGetLB( $wgBotPasswordsDatabase );
80  return $lb->getConnectionRef( $db, [], $wgBotPasswordsDatabase );
81  }
82 
90  public static function newFromUser( User $user, $appId, $flags = self::READ_NORMAL ) {
91  $centralId = CentralIdLookup::factory()->centralIdFromLocalUser(
93  );
95  }
96 
104  public static function newFromCentralId( $centralId, $appId, $flags = self::READ_NORMAL ) {
105  global $wgEnableBotPasswords;
106 
107  if ( !$wgEnableBotPasswords ) {
108  return null;
109  }
110 
112  $db = self::getDB( $index );
113  $row = $db->selectRow(
114  'bot_passwords',
115  [ 'bp_user', 'bp_app_id', 'bp_token', 'bp_restrictions', 'bp_grants' ],
116  [ 'bp_user' => $centralId, 'bp_app_id' => $appId ],
117  __METHOD__,
118  $options
119  );
120  return $row ? new self( $row, true, $flags ) : null;
121  }
122 
135  public static function newUnsaved( array $data, $flags = self::READ_NORMAL ) {
136  $row = (object)[
137  'bp_user' => 0,
138  'bp_app_id' => isset( $data['appId'] ) ? trim( $data['appId'] ) : '',
139  'bp_token' => '**unsaved**',
140  'bp_restrictions' => isset( $data['restrictions'] )
141  ? $data['restrictions']
143  'bp_grants' => isset( $data['grants'] ) ? $data['grants'] : [],
144  ];
145 
146  if (
147  $row->bp_app_id === '' || strlen( $row->bp_app_id ) > self::APPID_MAXLENGTH ||
148  !$row->bp_restrictions instanceof MWRestrictions ||
149  !is_array( $row->bp_grants )
150  ) {
151  return null;
152  }
153 
154  $row->bp_restrictions = $row->bp_restrictions->toJson();
155  $row->bp_grants = FormatJson::encode( $row->bp_grants );
156 
157  if ( isset( $data['user'] ) ) {
158  if ( !$data['user'] instanceof User ) {
159  return null;
160  }
161  $row->bp_user = CentralIdLookup::factory()->centralIdFromLocalUser(
162  $data['user'], CentralIdLookup::AUDIENCE_RAW, $flags
163  );
164  } elseif ( isset( $data['username'] ) ) {
165  $row->bp_user = CentralIdLookup::factory()->centralIdFromName(
166  $data['username'], CentralIdLookup::AUDIENCE_RAW, $flags
167  );
168  } elseif ( isset( $data['centralId'] ) ) {
169  $row->bp_user = $data['centralId'];
170  }
171  if ( !$row->bp_user ) {
172  return null;
173  }
174 
175  return new self( $row, false, $flags );
176  }
177 
182  public function isSaved() {
183  return $this->isSaved;
184  }
185 
190  public function getUserCentralId() {
191  return $this->centralId;
192  }
193 
198  public function getAppId() {
199  return $this->appId;
200  }
201 
206  public function getToken() {
207  return $this->token;
208  }
209 
214  public function getRestrictions() {
215  return $this->restrictions;
216  }
217 
222  public function getGrants() {
223  return $this->grants;
224  }
225 
230  public static function getSeparator() {
231  global $wgUserrightsInterwikiDelimiter;
232  return $wgUserrightsInterwikiDelimiter;
233  }
234 
239  protected function getPassword() {
240  list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $this->flags );
241  $db = self::getDB( $index );
242  $password = $db->selectField(
243  'bot_passwords',
244  'bp_password',
245  [ 'bp_user' => $this->centralId, 'bp_app_id' => $this->appId ],
246  __METHOD__,
247  $options
248  );
249  if ( $password === false ) {
251  }
252 
253  $passwordFactory = new \PasswordFactory();
254  $passwordFactory->init( \RequestContext::getMain()->getConfig() );
255  try {
256  return $passwordFactory->newFromCiphertext( $password );
257  } catch ( PasswordError $ex ) {
259  }
260  }
261 
268  public function save( $operation, Password $password = null ) {
269  $conds = [
270  'bp_user' => $this->centralId,
271  'bp_app_id' => $this->appId,
272  ];
273  $fields = [
275  'bp_restrictions' => $this->restrictions->toJson(),
276  'bp_grants' => FormatJson::encode( $this->grants ),
277  ];
278 
279  if ( $password !== null ) {
280  $fields['bp_password'] = $password->toString();
281  } elseif ( $operation === 'insert' ) {
282  $fields['bp_password'] = PasswordFactory::newInvalidPassword()->toString();
283  }
284 
285  $dbw = self::getDB( DB_MASTER );
286  switch ( $operation ) {
287  case 'insert':
288  $dbw->insert( 'bot_passwords', $fields + $conds, __METHOD__, [ 'IGNORE' ] );
289  break;
290 
291  case 'update':
292  $dbw->update( 'bot_passwords', $fields, $conds, __METHOD__ );
293  break;
294 
295  default:
296  return false;
297  }
298  $ok = (bool)$dbw->affectedRows();
299  if ( $ok ) {
300  $this->token = $dbw->selectField( 'bot_passwords', 'bp_token', $conds, __METHOD__ );
301  $this->isSaved = true;
302  }
303  return $ok;
304  }
305 
310  public function delete() {
311  $conds = [
312  'bp_user' => $this->centralId,
313  'bp_app_id' => $this->appId,
314  ];
315  $dbw = self::getDB( DB_MASTER );
316  $dbw->delete( 'bot_passwords', $conds, __METHOD__ );
317  $ok = (bool)$dbw->affectedRows();
318  if ( $ok ) {
319  $this->token = '**unsaved**';
320  $this->isSaved = false;
321  }
322  return $ok;
323  }
324 
330  public static function invalidateAllPasswordsForUser( $username ) {
331  $centralId = CentralIdLookup::factory()->centralIdFromName(
332  $username, CentralIdLookup::AUDIENCE_RAW, CentralIdLookup::READ_LATEST
333  );
335  }
336 
342  public static function invalidateAllPasswordsForCentralId( $centralId ) {
343  global $wgEnableBotPasswords;
344 
345  if ( !$wgEnableBotPasswords ) {
346  return false;
347  }
348 
349  $dbw = self::getDB( DB_MASTER );
350  $dbw->update(
351  'bot_passwords',
352  [ 'bp_password' => PasswordFactory::newInvalidPassword()->toString() ],
353  [ 'bp_user' => $centralId ],
354  __METHOD__
355  );
356  return (bool)$dbw->affectedRows();
357  }
358 
364  public static function removeAllPasswordsForUser( $username ) {
365  $centralId = CentralIdLookup::factory()->centralIdFromName(
366  $username, CentralIdLookup::AUDIENCE_RAW, CentralIdLookup::READ_LATEST
367  );
369  }
370 
376  public static function removeAllPasswordsForCentralId( $centralId ) {
377  global $wgEnableBotPasswords;
378 
379  if ( !$wgEnableBotPasswords ) {
380  return false;
381  }
382 
383  $dbw = self::getDB( DB_MASTER );
384  $dbw->delete(
385  'bot_passwords',
386  [ 'bp_user' => $centralId ],
387  __METHOD__
388  );
389  return (bool)$dbw->affectedRows();
390  }
391 
397  public static function generatePassword( $config ) {
399  max( 32, $config->get( 'MinimalPasswordLength' ) ) );
400  }
401 
413  public static function canonicalizeLoginData( $username, $password ) {
414  $sep = BotPassword::getSeparator();
415  // the strlen check helps minimize the password information obtainable from timing
416  if ( strlen( $password ) >= 32 && strpos( $username, $sep ) !== false ) {
417  // the separator is not valid in new usernames but might appear in legacy ones
418  if ( preg_match( '/^[0-9a-w]{32,}$/', $password ) ) {
419  return [ $username, $password, true ];
420  }
421  } elseif ( strlen( $password ) > 32 && strpos( $password, $sep ) !== false ) {
422  $segments = explode( $sep, $password );
423  $password = array_pop( $segments );
424  $appId = implode( $sep, $segments );
425  if ( preg_match( '/^[0-9a-w]{32,}$/', $password ) ) {
426  return [ $username . $sep . $appId, $password, true ];
427  }
428  }
429  return false;
430  }
431 
439  public static function login( $username, $password, WebRequest $request ) {
440  global $wgEnableBotPasswords;
441 
442  if ( !$wgEnableBotPasswords ) {
443  return Status::newFatal( 'botpasswords-disabled' );
444  }
445 
447  $provider = $manager->getProvider( BotPasswordSessionProvider::class );
448  if ( !$provider ) {
449  return Status::newFatal( 'botpasswords-no-provider' );
450  }
451 
452  // Split name into name+appId
453  $sep = self::getSeparator();
454  if ( strpos( $username, $sep ) === false ) {
455  return Status::newFatal( 'botpasswords-invalid-name', $sep );
456  }
457  list( $name, $appId ) = explode( $sep, $username, 2 );
458 
459  // Find the named user
461  if ( !$user || $user->isAnon() ) {
462  return Status::newFatal( 'nosuchuser', $name );
463  }
464 
465  // Get the bot password
466  $bp = self::newFromUser( $user, $appId );
467  if ( !$bp ) {
468  return Status::newFatal( 'botpasswords-not-exist', $name, $appId );
469  }
470 
471  // Check restrictions
472  $status = $bp->getRestrictions()->check( $request );
473  if ( !$status->isOK() ) {
474  return Status::newFatal( 'botpasswords-restriction-failed' );
475  }
476 
477  // Check the password
478  if ( !$bp->getPassword()->equals( $password ) ) {
479  return Status::newFatal( 'wrongpassword' );
480  }
481 
482  // Ok! Create the session.
483  return Status::newGood( $provider->newSessionForRequest( $user, $bp, $request ) );
484  }
485 }
MWRestrictions
A class to check request restrictions expressed as a JSON object.
Definition: MWRestrictions.php:24
BotPassword\getRestrictions
getRestrictions()
Get the restrictions.
Definition: BotPassword.php:214
object
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php For a description of the see design txt $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition: globals.txt:25
$request
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2612
BotPassword\getUserCentralId
getUserCentralId()
Get the central user ID.
Definition: BotPassword.php:190
MediaWiki\Session\Session\BotPasswordSessionProvider
Session provider for bot passwords.
Definition: BotPasswordSessionProvider.php:34
BotPassword\$flags
int $flags
Definition: BotPassword.php:51
BotPassword\canonicalizeLoginData
static canonicalizeLoginData( $username, $password)
There are two ways to login with a bot password: "username@appId", "password" and "username",...
Definition: BotPassword.php:413
wfGetLB
wfGetLB( $wiki=false)
Get a load balancer object.
Definition: GlobalFunctions.php:3073
BotPassword
Utility class for bot passwords.
Definition: BotPassword.php:28
BotPassword\getSeparator
static getSeparator()
Get the separator for combined user name + app ID.
Definition: BotPassword.php:230
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
BotPassword\generatePassword
static generatePassword( $config)
Returns a (raw, unhashed) random password string.
Definition: BotPassword.php:397
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$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:246
BotPassword\$grants
string[] $grants
Definition: BotPassword.php:48
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:63
PasswordError
Show an error when any operation involving passwords fails to run.
Definition: PasswordError.php:26
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:556
BotPassword\getAppId
getAppId()
Get the app ID.
Definition: BotPassword.php:198
PasswordFactory\generateRandomPasswordString
static generateRandomPasswordString( $minLength=10)
Generate a random string suitable for a password.
Definition: PasswordFactory.php:198
MWCryptRand\generateHex
static generateHex( $chars, $forceStrong=false)
Generate a run of (ideally) cryptographically random data and return it in hexadecimal string format.
Definition: MWCryptRand.php:76
DBAccessObjectUtils\getDBOptions
static getDBOptions( $bitfield)
Get an appropriate DB index, options, and fallback DB index for a query.
Definition: DBAccessObjectUtils.php:52
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
BotPassword\getToken
getToken()
Get the token.
Definition: BotPassword.php:206
BotPassword\getDB
static getDB( $db)
Get a database connection for the bot passwords database.
Definition: BotPassword.php:74
BotPassword\invalidateAllPasswordsForCentralId
static invalidateAllPasswordsForCentralId( $centralId)
Invalidate all passwords for a user, by central ID.
Definition: BotPassword.php:342
BotPassword\APPID_MAXLENGTH
const APPID_MAXLENGTH
Definition: BotPassword.php:30
BotPassword\$isSaved
bool $isSaved
Definition: BotPassword.php:33
IDBAccessObject
Interface for database access objects.
Definition: IDBAccessObject.php:55
BotPassword\__construct
__construct( $row, $isSaved, $flags=self::READ_NORMAL)
Definition: BotPassword.php:58
BotPassword\save
save( $operation, Password $password=null)
Save the BotPassword to the database.
Definition: BotPassword.php:268
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:35
flags
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database etc For and for historical it also represents a few features of articles that don t involve their such as access rights See also title txt Article Encapsulates access to the page table of the database The object represents a an and maintains state such as flags
Definition: design.txt:34
BotPassword\$token
string $token
Definition: BotPassword.php:42
FormatJson\decode
static decode( $value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:187
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
BotPassword\isSaved
isSaved()
Indicate whether this is known to be saved.
Definition: BotPassword.php:182
BotPassword\newUnsaved
static newUnsaved(array $data, $flags=self::READ_NORMAL)
Create an unsaved BotPassword.
Definition: BotPassword.php:135
BotPassword\$appId
string $appId
Definition: BotPassword.php:39
MediaWiki\Session\SessionManager\singleton
static singleton()
Get the global SessionManager.
Definition: SessionManager.php:91
User\TOKEN_LENGTH
const TOKEN_LENGTH
@const int Number of characters in user_token field.
Definition: User.php:54
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
DB_MASTER
const DB_MASTER
Definition: defines.php:26
MWRestrictions\newDefault
static newDefault()
Definition: MWRestrictions.php:41
BotPassword\newFromUser
static newFromUser(User $user, $appId, $flags=self::READ_NORMAL)
Load a BotPassword from the database.
Definition: BotPassword.php:90
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
BotPassword\getPassword
getPassword()
Get the password.
Definition: BotPassword.php:239
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:76
BotPassword\invalidateAllPasswordsForUser
static invalidateAllPasswordsForUser( $username)
Invalidate all passwords for a user, by name.
Definition: BotPassword.php:330
BotPassword\$centralId
int $centralId
Definition: BotPassword.php:36
RequestContext\getMain
static getMain()
Static methods.
Definition: RequestContext.php:468
wfGetLBFactory
wfGetLBFactory()
Get the load balancer factory object.
Definition: GlobalFunctions.php:3089
BotPassword\newFromCentralId
static newFromCentralId( $centralId, $appId, $flags=self::READ_NORMAL)
Load a BotPassword from the database.
Definition: BotPassword.php:104
BotPassword\login
static login( $username, $password, WebRequest $request)
Try to log the user in.
Definition: BotPassword.php:439
WebRequest
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition: WebRequest.php:38
BotPassword\getGrants
getGrants()
Get the grants.
Definition: BotPassword.php:222
PasswordFactory\newInvalidPassword
static newInvalidPassword()
Create an InvalidPassword.
Definition: PasswordFactory.php:214
MWRestrictions\newFromJson
static newFromJson( $json)
Definition: MWRestrictions.php:59
true
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1956
BotPassword\removeAllPasswordsForUser
static removeAllPasswordsForUser( $username)
Remove all passwords for a user, by name.
Definition: BotPassword.php:364
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:52
CentralIdLookup\AUDIENCE_RAW
const AUDIENCE_RAW
Definition: CentralIdLookup.php:32
Password
Represents a password hash for use in authentication.
Definition: Password.php:66
CentralIdLookup\factory
static factory( $providerId=null)
Fetch a CentralIdLookup.
Definition: CentralIdLookup.php:45
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:50
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:783
Wikimedia\Rdbms\IMaintainableDatabase
Advanced database interface for IDatabase handles that include maintenance methods.
Definition: IMaintainableDatabase.php:39
BotPassword\removeAllPasswordsForCentralId
static removeAllPasswordsForCentralId( $centralId)
Remove all passwords for a user, by central ID.
Definition: BotPassword.php:376
$options
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1049
BotPassword\$restrictions
MWRestrictions $restrictions
Definition: BotPassword.php:45
array
the array() calling protocol came about after MediaWiki 1.4rc1.