MediaWiki master
MediaWiki\User\BotPassword Class Reference

Utility class for bot passwords. More...

Inherits IDBAccessObject.

Collaboration diagram for MediaWiki\User\BotPassword:

Public Member Functions

 __construct ( $row, $isSaved, $flags=self::READ_NORMAL)
 
 delete ()
 Delete the BotPassword from the database.
 
 getAppId ()
 
 getGrants ()
 
 getRestrictions ()
 
 getToken ()
 
 getUserCentralId ()
 Get the central user ID.
 
 isInvalid ()
 Whether the password is currently invalid.
 
 isSaved ()
 Indicate whether this is known to be saved.
 
 save ( $operation, Password $password=null)
 Save the BotPassword to the database.
 

Static Public Member Functions

static canonicalizeLoginData ( $username, $password)
 There are two ways to login with a bot password: "username@appId", "password" and "username", "appId@password".
 
static generatePassword ( $config)
 Returns a (raw, unhashed) random password string.
 
static getDB ( $db)
 Get a database connection for the bot passwords database.
 
static getSeparator ()
 Get the separator for combined user name + app ID.
 
static invalidateAllPasswordsForCentralId ( $centralId)
 Invalidate all passwords for a user, by central ID.
 
static invalidateAllPasswordsForUser ( $username)
 Invalidate all passwords for a user, by name.
 
static login ( $username, $password, WebRequest $request)
 Try to log the user in.
 
static newFromCentralId ( $centralId, $appId, $flags=self::READ_NORMAL)
 Load a BotPassword from the database.
 
static newFromUser (UserIdentity $userIdentity, $appId, $flags=self::READ_NORMAL)
 Load a BotPassword from the database.
 
static newUnsaved (array $data, $flags=self::READ_NORMAL)
 Create an unsaved BotPassword.
 
static removeAllPasswordsForCentralId ( $centralId)
 Remove all passwords for a user, by central ID.
 
static removeAllPasswordsForUser ( $username)
 Remove all passwords for a user, by name.
 

Public Attributes

const APPID_MAXLENGTH = 32
 
const GRANTS_MAXLENGTH = 65535
 Maximum length of the json representation of grants.
 
const PASSWORD_MINLENGTH = 32
 Minimum length for a bot password.
 
const RESTRICTIONS_MAXLENGTH = 65535
 Maximum length of the json representation of restrictions.
 
- Public Attributes inherited from IDBAccessObject
const READ_NONE = -1
 Constants for object loading bitfield flags (higher => higher QoS)
 

Detailed Description

Utility class for bot passwords.

Since
1.27

Definition at line 50 of file BotPassword.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\BotPassword::__construct (   $row,
  $isSaved,
  $flags = self::READ_NORMAL 
)
Access: internal
only public for construction in BotPasswordStore
Parameters
stdClass$rowbot_passwords database row
bool$isSavedWhether the bot password was read from the database
int$flagsIDBAccessObject read flags

Definition at line 99 of file BotPassword.php.

References MediaWiki\User\BotPassword\isSaved().

Member Function Documentation

◆ canonicalizeLoginData()

static MediaWiki\User\BotPassword::canonicalizeLoginData (   $username,
  $password 
)
static

There are two ways to login with a bot password: "username@appId", "password" and "username", "appId@password".

Transform it so it is always in the first form. Returns [bot username, bot password]. If this cannot be a bot password login just return false.

Parameters
string$username
string$password
Returns
string[]|false

Definition at line 395 of file BotPassword.php.

References MediaWiki\User\BotPassword\getSeparator().

◆ delete()

MediaWiki\User\BotPassword::delete ( )

Delete the BotPassword from the database.

Returns
bool Success

Definition at line 290 of file BotPassword.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\User\BotPassword\isSaved().

◆ generatePassword()

static MediaWiki\User\BotPassword::generatePassword (   $config)
static

Returns a (raw, unhashed) random password string.

Parameters
Config$config
Returns
string

Definition at line 381 of file BotPassword.php.

References MediaWiki\MainConfigNames\MinimalPasswordLength.

◆ getAppId()

MediaWiki\User\BotPassword::getAppId ( )
Returns
string

Definition at line 184 of file BotPassword.php.

Referenced by MediaWiki\Session\BotPasswordSessionProvider\newSessionForRequest().

◆ getDB()

static MediaWiki\User\BotPassword::getDB (   $db)
static

Get a database connection for the bot passwords database.

Parameters
int$dbIndex of the connection to get, e.g. DB_PRIMARY or DB_REPLICA.
Returns
IDatabase

Definition at line 115 of file BotPassword.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ getGrants()

MediaWiki\User\BotPassword::getGrants ( )
Returns
string[]

Definition at line 205 of file BotPassword.php.

Referenced by MediaWiki\Session\BotPasswordSessionProvider\newSessionForRequest().

◆ getRestrictions()

MediaWiki\User\BotPassword::getRestrictions ( )
Returns
MWRestrictions

Definition at line 198 of file BotPassword.php.

◆ getSeparator()

static MediaWiki\User\BotPassword::getSeparator ( )
static

Get the separator for combined user name + app ID.

Returns
string

Definition at line 213 of file BotPassword.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\MainConfigNames\UserrightsInterwikiDelimiter.

Referenced by MediaWiki\User\BotPassword\canonicalizeLoginData(), and MediaWiki\User\BotPassword\login().

◆ getToken()

MediaWiki\User\BotPassword::getToken ( )
Returns
string

Definition at line 191 of file BotPassword.php.

Referenced by MediaWiki\Session\BotPasswordSessionProvider\newSessionForRequest().

◆ getUserCentralId()

MediaWiki\User\BotPassword::getUserCentralId ( )

Get the central user ID.

Returns
int

Definition at line 177 of file BotPassword.php.

Referenced by MediaWiki\Session\BotPasswordSessionProvider\newSessionForRequest().

◆ invalidateAllPasswordsForCentralId()

static MediaWiki\User\BotPassword::invalidateAllPasswordsForCentralId (   $centralId)
static

Invalidate all passwords for a user, by central ID.

Deprecated:
since 1.37
Parameters
int$centralId
Returns
bool Whether any passwords were invalidated

Definition at line 320 of file BotPassword.php.

References DB_PRIMARY, MediaWiki\MainConfigNames\EnableBotPasswords, getDB(), MediaWiki\MediaWikiServices\getInstance(), and wfDeprecated().

◆ invalidateAllPasswordsForUser()

static MediaWiki\User\BotPassword::invalidateAllPasswordsForUser (   $username)
static

Invalidate all passwords for a user, by name.

Parameters
string$username
Returns
bool Whether any passwords were invalidated

Definition at line 306 of file BotPassword.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ isInvalid()

MediaWiki\User\BotPassword::isInvalid ( )

Whether the password is currently invalid.

Since
1.32
Returns
bool

Definition at line 248 of file BotPassword.php.

◆ isSaved()

MediaWiki\User\BotPassword::isSaved ( )

Indicate whether this is known to be saved.

Returns
bool

Definition at line 169 of file BotPassword.php.

Referenced by MediaWiki\User\BotPassword\__construct(), MediaWiki\User\BotPassword\delete(), and MediaWiki\User\BotPassword\save().

◆ login()

static MediaWiki\User\BotPassword::login (   $username,
  $password,
WebRequest  $request 
)
static

Try to log the user in.

Parameters
string$usernameCombined user name and app ID
string$passwordSupplied password
WebRequest$request
Returns
Status On success, the good status's value is the new Session object

Definition at line 421 of file BotPassword.php.

References MediaWiki\MainConfigNames\EnableBotPasswords, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Request\WebRequest\getIP(), MediaWiki\User\BotPassword\getSeparator(), MediaWiki\User\User\newFromName(), MediaWiki\User\BotPassword\newFromUser(), MediaWiki\MainConfigNames\PasswordAttemptThrottle, and wfMessage().

◆ newFromCentralId()

static MediaWiki\User\BotPassword::newFromCentralId (   $centralId,
  $appId,
  $flags = self::READ_NORMAL 
)
static

Load a BotPassword from the database.

Parameters
int$centralIdfrom CentralIdLookup
string$appId
int$flagsIDBAccessObject read flags
Returns
BotPassword|null

Definition at line 141 of file BotPassword.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ newFromUser()

static MediaWiki\User\BotPassword::newFromUser ( UserIdentity  $userIdentity,
  $appId,
  $flags = self::READ_NORMAL 
)
static

Load a BotPassword from the database.

Parameters
UserIdentity$userIdentity
string$appId
int$flagsIDBAccessObject read flags
Returns
BotPassword|null

Definition at line 128 of file BotPassword.php.

References MediaWiki\MediaWikiServices\getInstance().

Referenced by MediaWiki\User\BotPassword\login().

◆ newUnsaved()

static MediaWiki\User\BotPassword::newUnsaved ( array  $data,
  $flags = self::READ_NORMAL 
)
static

Create an unsaved BotPassword.

Parameters
array$dataData to use to create the bot password. Keys are:
  • user: (UserIdentity) UserIdentity to create the password for. Overrides username and centralId.
  • username: (string) Username to create the password for. Overrides centralId.
  • centralId: (int) User central ID to create the password for.
  • appId: (string, required) App ID for the password.
  • restrictions: (MWRestrictions, optional) Restrictions.
  • grants: (string[], optional) Grants.
int$flagsIDBAccessObject read flags
Returns
BotPassword|null

Definition at line 159 of file BotPassword.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ removeAllPasswordsForCentralId()

static MediaWiki\User\BotPassword::removeAllPasswordsForCentralId (   $centralId)
static

Remove all passwords for a user, by central ID.

Deprecated:
since 1.37
Parameters
int$centralId
Returns
bool Whether any passwords were removed

Definition at line 358 of file BotPassword.php.

References DB_PRIMARY, MediaWiki\MainConfigNames\EnableBotPasswords, getDB(), MediaWiki\MediaWikiServices\getInstance(), and wfDeprecated().

◆ removeAllPasswordsForUser()

static MediaWiki\User\BotPassword::removeAllPasswordsForUser (   $username)
static

Remove all passwords for a user, by name.

Parameters
string$username
Returns
bool Whether any passwords were removed

Definition at line 344 of file BotPassword.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ save()

MediaWiki\User\BotPassword::save (   $operation,
Password  $password = null 
)

Save the BotPassword to the database.

Parameters
string$operation'update' or 'insert'
Password | null$passwordPassword to set.
Returns
Status
Exceptions
UnexpectedValueException

Definition at line 259 of file BotPassword.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\User\BotPassword\isSaved().

Member Data Documentation

◆ APPID_MAXLENGTH

const MediaWiki\User\BotPassword::APPID_MAXLENGTH = 32

Definition at line 52 of file BotPassword.php.

◆ GRANTS_MAXLENGTH

const MediaWiki\User\BotPassword::GRANTS_MAXLENGTH = 65535

Maximum length of the json representation of grants.

Since
1.36

Definition at line 69 of file BotPassword.php.

◆ PASSWORD_MINLENGTH

const MediaWiki\User\BotPassword::PASSWORD_MINLENGTH = 32

Minimum length for a bot password.

Definition at line 57 of file BotPassword.php.

◆ RESTRICTIONS_MAXLENGTH

const MediaWiki\User\BotPassword::RESTRICTIONS_MAXLENGTH = 65535

Maximum length of the json representation of restrictions.

Since
1.36

Definition at line 63 of file BotPassword.php.


The documentation for this class was generated from the following file: