MediaWiki  master
BotPassword Class Reference

Utility class for bot passwords. More...

Inheritance diagram for BotPassword:
Collaboration diagram for BotPassword:

Public Member Functions

 delete ()
 Delete the BotPassword from the database. More...
 
 getAppId ()
 Get the app ID. More...
 
 getGrants ()
 Get the grants. More...
 
 getRestrictions ()
 Get the restrictions. More...
 
 getToken ()
 Get the token. More...
 
 getUserCentralId ()
 Get the central user ID. More...
 
 isInvalid ()
 Whether the password is currently invalid. More...
 
 isSaved ()
 Indicate whether this is known to be saved. More...
 
 save ( $operation, Password $password=null)
 Save the BotPassword to the database. More...
 

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". More...
 
static generatePassword ( $config)
 Returns a (raw, unhashed) random password string. More...
 
static getDB ( $db)
 Get a database connection for the bot passwords database. More...
 
static getSeparator ()
 Get the separator for combined user name + app ID. More...
 
static invalidateAllPasswordsForCentralId ( $centralId)
 Invalidate all passwords for a user, by central ID. More...
 
static invalidateAllPasswordsForUser ( $username)
 Invalidate all passwords for a user, by name. More...
 
static login ( $username, $password, WebRequest $request)
 Try to log the user in. More...
 
static newFromCentralId ( $centralId, $appId, $flags=self::READ_NORMAL)
 Load a BotPassword from the database. More...
 
static newFromUser (User $user, $appId, $flags=self::READ_NORMAL)
 Load a BotPassword from the database. More...
 
static newUnsaved (array $data, $flags=self::READ_NORMAL)
 Create an unsaved BotPassword. More...
 
static removeAllPasswordsForCentralId ( $centralId)
 Remove all passwords for a user, by central ID. More...
 
static removeAllPasswordsForUser ( $username)
 Remove all passwords for a user, by name. More...
 

Public Attributes

const APPID_MAXLENGTH = 32
 
- Public Attributes inherited from IDBAccessObject
const READ_LOCKING = self::READ_LATEST | 2
 Constants for object loading bitfield flags (higher => higher QoS) More...
 
const READ_NONE = -1
 

Protected Member Functions

 __construct ( $row, $isSaved, $flags=self::READ_NORMAL)
 
 getPassword ()
 Get the password. More...
 

Static Private Member Functions

static loginHook ( $user, $bp, Status $status)
 Call AuthManagerLoginAuthenticateAudit. More...
 

Private Attributes

string $appId
 
int $centralId
 
int $flags = self::READ_NORMAL
 
string [] $grants
 
bool $isSaved
 
MWRestrictions $restrictions
 
string $token
 

Detailed Description

Utility class for bot passwords.

Since
1.27

Definition at line 30 of file BotPassword.php.

Constructor & Destructor Documentation

◆ __construct()

BotPassword::__construct (   $row,
  $isSaved,
  $flags = self::READ_NORMAL 
)
protected
Parameters
object$rowbot_passwords database row
bool$isSavedWhether the bot password was read from the database
int$flagsIDBAccessObject read flags

Definition at line 60 of file BotPassword.php.

References $flags, $isSaved, FormatJson\decode(), isSaved(), and MWRestrictions\newFromJson().

Member Function Documentation

◆ canonicalizeLoginData()

static 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
array|false

Definition at line 420 of file BotPassword.php.

References $appId, and $username.

Referenced by ApiLogin\execute(), and BotPasswordTest\testCanonicalizeLoginData().

◆ delete()

BotPassword::delete ( )

Delete the BotPassword from the database.

Returns
bool Success

Definition at line 319 of file BotPassword.php.

References $appId, $centralId, DB_MASTER, and isSaved().

◆ generatePassword()

static BotPassword::generatePassword (   $config)
static

Returns a (raw, unhashed) random password string.

Parameters
Config$config
Returns
string

Definition at line 406 of file BotPassword.php.

References PasswordFactory\generateRandomPasswordString().

Referenced by SpecialBotPasswords\save().

◆ getAppId()

BotPassword::getAppId ( )

Get the app ID.

Returns
string

Definition at line 199 of file BotPassword.php.

References $appId.

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

◆ getDB()

static BotPassword::getDB (   $db)
static

Get a database connection for the bot passwords database.

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

Definition at line 76 of file BotPassword.php.

References $wgBotPasswordsCluster, and $wgBotPasswordsDatabase.

Referenced by SpecialBotPasswords\getFormFields().

◆ getGrants()

BotPassword::getGrants ( )

Get the grants.

Returns
string[]

Definition at line 223 of file BotPassword.php.

References $grants.

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

◆ getPassword()

BotPassword::getPassword ( )
protected

Get the password.

Returns
Password

Definition at line 240 of file BotPassword.php.

References $options, DBAccessObjectUtils\getDBOptions(), list, and PasswordFactory\newInvalidPassword().

Referenced by isInvalid().

◆ getRestrictions()

BotPassword::getRestrictions ( )

Get the restrictions.

Returns
MWRestrictions

Definition at line 215 of file BotPassword.php.

References $restrictions.

◆ getSeparator()

static BotPassword::getSeparator ( )
static

Get the separator for combined user name + app ID.

Returns
string

Definition at line 231 of file BotPassword.php.

References $wgUserrightsInterwikiDelimiter.

Referenced by SpecialBotPasswords\getFormFields(), SpecialBotPasswords\onSuccess(), ApiLoginTest\setUpForBotPassword(), and BotPasswordTest\testBasics().

◆ getToken()

BotPassword::getToken ( )

Get the token.

Returns
string

Definition at line 207 of file BotPassword.php.

References $token.

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

◆ getUserCentralId()

BotPassword::getUserCentralId ( )

Get the central user ID.

Returns
int

Definition at line 191 of file BotPassword.php.

References $centralId.

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

◆ invalidateAllPasswordsForCentralId()

static BotPassword::invalidateAllPasswordsForCentralId (   $centralId)
static

Invalidate all passwords for a user, by central ID.

Parameters
int$centralId
Returns
bool Whether any passwords were invalidated

Definition at line 351 of file BotPassword.php.

References $wgEnableBotPasswords, DB_MASTER, and PasswordFactory\newInvalidPassword().

◆ invalidateAllPasswordsForUser()

static BotPassword::invalidateAllPasswordsForUser (   $username)
static

Invalidate all passwords for a user, by name.

Parameters
string$usernameUser name
Returns
bool Whether any passwords were invalidated

Definition at line 339 of file BotPassword.php.

References $username, CentralIdLookup\AUDIENCE_RAW, and CentralIdLookup\factory().

Referenced by MediaWiki\Auth\AuthManager\changeAuthenticationData(), and BotPasswordTest\testInvalidateAllPasswordsForUser().

◆ isInvalid()

BotPassword::isInvalid ( )

Whether the password is currently invalid.

Since
1.32
Returns
bool

Definition at line 267 of file BotPassword.php.

References getPassword().

◆ isSaved()

BotPassword::isSaved ( )

Indicate whether this is known to be saved.

Returns
bool

Definition at line 183 of file BotPassword.php.

References $isSaved.

Referenced by __construct(), delete(), and save().

◆ login()

static 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 446 of file BotPassword.php.

References $name, $user, $username, $wgEnableBotPasswords, $wgPasswordAttemptThrottle, class, WebRequest\getIP(), ObjectCache\getLocalClusterInstance(), list, StatusValue\newFatal(), User\newFromName(), StatusValue\newGood(), null, MediaWiki\Session\SessionManager\singleton(), and wfMessage().

Referenced by ApiLogin\execute(), and BotPasswordTest\testLogin().

◆ loginHook()

static BotPassword::loginHook (   $user,
  $bp,
Status  $status 
)
staticprivate

Call AuthManagerLoginAuthenticateAudit.

To facilitate logging all authentications, even ones not via AuthManager, call the AuthManagerLoginAuthenticateAudit hook.

Parameters
User | string$userUser being logged in
BotPassword | null$bpBot sub-account, if it can be identified
Status$statusLogin status
Returns
Status The passed-in status

Definition at line 531 of file BotPassword.php.

References $extraData, $name, $response, $user, Status\getMessage(), StatusValue\isGood(), null, and Hooks\run().

◆ newFromCentralId()

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

◆ newFromUser()

static BotPassword::newFromUser ( User  $user,
  $appId,
  $flags = self::READ_NORMAL 
)
static

◆ newUnsaved()

static 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: (User) User object 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) App ID for the password.
  • restrictions: (MWRestrictions, optional) Restrictions.
  • grants: (string[], optional) Grants.
int$flagsIDBAccessObject read flags
Returns
BotPassword|null

Definition at line 138 of file BotPassword.php.

References $flags, CentralIdLookup\AUDIENCE_RAW, FormatJson\encode(), CentralIdLookup\factory(), MWRestrictions\newDefault(), null, and object.

Referenced by SpecialBotPasswords\getFormFields(), SpecialBotPasswords\save(), BotPasswordTest\testSave(), and BotPasswordTest\testUnsaved().

◆ removeAllPasswordsForCentralId()

static BotPassword::removeAllPasswordsForCentralId (   $centralId)
static

Remove all passwords for a user, by central ID.

Parameters
int$centralId
Returns
bool Whether any passwords were removed

Definition at line 385 of file BotPassword.php.

References $wgEnableBotPasswords, and DB_MASTER.

◆ removeAllPasswordsForUser()

static BotPassword::removeAllPasswordsForUser (   $username)
static

Remove all passwords for a user, by name.

Parameters
string$usernameUser name
Returns
bool Whether any passwords were removed

Definition at line 373 of file BotPassword.php.

References $username, CentralIdLookup\AUDIENCE_RAW, and CentralIdLookup\factory().

Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\preventSessionsForUser(), and BotPasswordTest\testRemoveAllPasswordsForUser().

◆ save()

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

Save the BotPassword to the database.

Parameters
string$operation'update' or 'insert'
Password | null$passwordPassword to set.
Returns
bool Success

Definition at line 277 of file BotPassword.php.

References $appId, $centralId, DB_MASTER, FormatJson\encode(), MWCryptRand\generateHex(), isSaved(), PasswordFactory\newInvalidPassword(), null, and User\TOKEN_LENGTH.

Member Data Documentation

◆ $appId

string BotPassword::$appId
private

Definition at line 41 of file BotPassword.php.

Referenced by canonicalizeLoginData(), delete(), getAppId(), and save().

◆ $centralId

int BotPassword::$centralId
private

Definition at line 38 of file BotPassword.php.

Referenced by delete(), getUserCentralId(), and save().

◆ $flags

int BotPassword::$flags = self::READ_NORMAL
private

Definition at line 53 of file BotPassword.php.

Referenced by __construct(), newFromCentralId(), and newUnsaved().

◆ $grants

string [] BotPassword::$grants
private

Definition at line 50 of file BotPassword.php.

Referenced by getGrants().

◆ $isSaved

bool BotPassword::$isSaved
private

Definition at line 35 of file BotPassword.php.

Referenced by __construct(), and isSaved().

◆ $restrictions

MWRestrictions BotPassword::$restrictions
private

Definition at line 47 of file BotPassword.php.

Referenced by getRestrictions().

◆ $token

string BotPassword::$token
private

Definition at line 44 of file BotPassword.php.

Referenced by getToken().

◆ APPID_MAXLENGTH

const BotPassword::APPID_MAXLENGTH = 32

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