MediaWiki
REL1_31
|
Utility class for bot passwords. More...
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 |
const | GRANTS_MAXLENGTH = 65535 |
Maximum length of the json representation of grants. More... | |
const | RESTRICTIONS_MAXLENGTH = 65535 |
Maximum length of the json representation of restrictions. More... | |
![]() | |
const | READ_LOCKING = 3 |
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... | |
Private Attributes | |
string | $appId |
int | $centralId |
int | $flags = self::READ_NORMAL |
string[] | $grants |
bool | $isSaved |
MWRestrictions | $restrictions |
string | $token |
|
protected |
object | $row | bot_passwords database row |
bool | $isSaved | Whether the bot password was read from the database |
int | $flags | IDBAccessObject read flags |
Definition at line 71 of file BotPassword.php.
References $flags, $isSaved, FormatJson\decode(), flags, isSaved(), and MWRestrictions\newFromJson().
|
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, could be normal password?] where the last one is a flag meaning this could either be a bot password or a normal password, it cannot be decided for certain (although in such cases it almost always will be a bot password). If this cannot be a bot password login just return false.
string | $username | |
string | $password |
Definition at line 463 of file BotPassword.php.
References $appId, $username, getSeparator(), and true.
Referenced by ApiLogin\execute(), and BotPasswordTest\testCanonicalizeLoginData().
BotPassword::delete | ( | ) |
Delete the BotPassword from the database.
Definition at line 360 of file BotPassword.php.
References $appId, $centralId, DB_MASTER, getDB(), and isSaved().
|
static |
Returns a (raw, unhashed) random password string.
Config | $config |
Definition at line 447 of file BotPassword.php.
References PasswordFactory\generateRandomPasswordString().
Referenced by SpecialBotPasswords\save().
BotPassword::getAppId | ( | ) |
Get the app ID.
Definition at line 212 of file BotPassword.php.
References $appId.
Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\newSessionForRequest().
|
static |
Get a database connection for the bot passwords database.
int | $db | Index of the connection to get, e.g. DB_MASTER or DB_REPLICA. |
Definition at line 87 of file BotPassword.php.
References $wgBotPasswordsCluster, $wgBotPasswordsDatabase, and global.
Referenced by delete(), SpecialBotPasswords\getFormFields(), getPassword(), invalidateAllPasswordsForCentralId(), newFromCentralId(), removeAllPasswordsForCentralId(), and save().
BotPassword::getGrants | ( | ) |
Get the grants.
Definition at line 236 of file BotPassword.php.
References $grants.
Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\newSessionForRequest().
|
protected |
Get the password.
Definition at line 253 of file BotPassword.php.
References $options, flags, getDB(), DBAccessObjectUtils\getDBOptions(), RequestContext\getMain(), list, and PasswordFactory\newInvalidPassword().
Referenced by isInvalid().
BotPassword::getRestrictions | ( | ) |
Get the restrictions.
Definition at line 228 of file BotPassword.php.
References $restrictions.
|
static |
Get the separator for combined user name + app ID.
Definition at line 244 of file BotPassword.php.
References $wgUserrightsInterwikiDelimiter, and global.
Referenced by canonicalizeLoginData(), SpecialBotPasswords\getFormFields(), login(), SpecialBotPasswords\onSuccess(), BotPasswordTest\testBasics(), and ApiLoginTest\testBotPassword().
BotPassword::getToken | ( | ) |
Get the token.
Definition at line 220 of file BotPassword.php.
References $token.
Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\newSessionForRequest().
BotPassword::getUserCentralId | ( | ) |
Get the central user ID.
Definition at line 204 of file BotPassword.php.
References $centralId.
Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\newSessionForRequest().
|
static |
Invalidate all passwords for a user, by central ID.
int | $centralId |
Definition at line 392 of file BotPassword.php.
References $centralId, $wgEnableBotPasswords, DB_MASTER, getDB(), global, and PasswordFactory\newInvalidPassword().
Referenced by invalidateAllPasswordsForUser().
|
static |
Invalidate all passwords for a user, by name.
string | $username | User name |
Definition at line 380 of file BotPassword.php.
References $centralId, $username, CentralIdLookup\AUDIENCE_RAW, CentralIdLookup\factory(), and invalidateAllPasswordsForCentralId().
Referenced by MediaWiki\Auth\AuthManager\changeAuthenticationData(), and BotPasswordTest\testInvalidateAllPasswordsForUser().
BotPassword::isInvalid | ( | ) |
Whether the password is currently invalid.
Definition at line 281 of file BotPassword.php.
References getPassword().
BotPassword::isSaved | ( | ) |
Indicate whether this is known to be saved.
Definition at line 196 of file BotPassword.php.
References $isSaved.
Referenced by __construct(), delete(), and save().
|
static |
Try to log the user in.
string | $username | Combined user name and app ID |
string | $password | Supplied password |
WebRequest | $request |
Definition at line 489 of file BotPassword.php.
References $appId, $name, $request, $user, $username, $wgEnableBotPasswords, $wgPasswordAttemptThrottle, class, ObjectCache\getLocalClusterInstance(), getSeparator(), global, list, StatusValue\newFatal(), User\newFromName(), newFromUser(), StatusValue\newGood(), MediaWiki\Session\SessionManager\singleton(), and wfMessage().
Referenced by ApiLogin\execute(), and BotPasswordTest\testLogin().
|
static |
Load a BotPassword from the database.
int | $centralId | from CentralIdLookup |
string | $appId | |
int | $flags | IDBAccessObject read flags |
Definition at line 118 of file BotPassword.php.
References $appId, $centralId, $flags, $options, $wgEnableBotPasswords, getDB(), DBAccessObjectUtils\getDBOptions(), global, and list.
Referenced by SpecialBotPasswords\getFormFields(), newFromUser(), SpecialBotPasswords\onSubmit(), MediaWiki\Session\Session\BotPasswordSessionProvider\refreshSessionInfo(), BotPasswordTest\testGetPassword(), BotPasswordTest\testInvalidateAllPasswordsForUser(), BotPasswordTest\testRemoveAllPasswordsForUser(), and BotPasswordTest\testSave().
|
static |
Load a BotPassword from the database.
User | $user | |
string | $appId | |
int | $flags | IDBAccessObject read flags |
Definition at line 104 of file BotPassword.php.
References $appId, $centralId, $flags, $user, CentralIdLookup\AUDIENCE_RAW, CentralIdLookup\factory(), and newFromCentralId().
Referenced by login(), BotPasswordTest\testBasics(), MediaWiki\Session\BotPasswordSessionProviderTest\testCheckSessionInfo(), and MediaWiki\Session\BotPasswordSessionProviderTest\testNewSessionInfoForRequest().
|
static |
Create an unsaved BotPassword.
array | $data | Data to use to create the bot password. Keys are:
|
int | $flags | IDBAccessObject read flags |
Definition at line 149 of file BotPassword.php.
References $flags, CentralIdLookup\AUDIENCE_RAW, FormatJson\encode(), CentralIdLookup\factory(), MWRestrictions\newDefault(), and object.
Referenced by SpecialBotPasswords\getFormFields(), SpecialBotPasswords\save(), BotPasswordTest\testSave(), BotPasswordTest\testSaveValidation(), and BotPasswordTest\testUnsaved().
|
static |
Remove all passwords for a user, by central ID.
int | $centralId |
Definition at line 426 of file BotPassword.php.
References $centralId, $wgEnableBotPasswords, DB_MASTER, getDB(), and global.
Referenced by removeAllPasswordsForUser().
|
static |
Remove all passwords for a user, by name.
string | $username | User name |
Definition at line 414 of file BotPassword.php.
References $centralId, $username, CentralIdLookup\AUDIENCE_RAW, CentralIdLookup\factory(), and removeAllPasswordsForCentralId().
Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\preventSessionsForUser(), and BotPasswordTest\testRemoveAllPasswordsForUser().
BotPassword::save | ( | $operation, | |
Password | $password = null |
||
) |
Save the BotPassword to the database.
UnexpectedValueException |
Definition at line 292 of file BotPassword.php.
References $appId, $centralId, $grants, $res, $restrictions, DB_MASTER, FormatJson\encode(), MWCryptRand\generateHex(), getDB(), isSaved(), StatusValue\newFatal(), StatusValue\newGood(), PasswordFactory\newInvalidPassword(), MWRestrictions\toJson(), and User\TOKEN_LENGTH.
|
private |
Definition at line 52 of file BotPassword.php.
Referenced by canonicalizeLoginData(), delete(), getAppId(), login(), newFromCentralId(), newFromUser(), and save().
|
private |
Definition at line 49 of file BotPassword.php.
Referenced by delete(), getUserCentralId(), invalidateAllPasswordsForCentralId(), invalidateAllPasswordsForUser(), newFromCentralId(), newFromUser(), removeAllPasswordsForCentralId(), removeAllPasswordsForUser(), and save().
|
private |
Definition at line 64 of file BotPassword.php.
Referenced by __construct(), newFromCentralId(), newFromUser(), and newUnsaved().
|
private |
Definition at line 61 of file BotPassword.php.
Referenced by getGrants(), and save().
|
private |
Definition at line 46 of file BotPassword.php.
Referenced by __construct(), and isSaved().
|
private |
Definition at line 58 of file BotPassword.php.
Referenced by getRestrictions(), and save().
|
private |
Definition at line 55 of file BotPassword.php.
Referenced by getToken().
const BotPassword::APPID_MAXLENGTH = 32 |
Definition at line 31 of file BotPassword.php.
Referenced by SpecialBotPasswords\execute(), SpecialBotPasswords\getFormFields(), and BotPasswordTest\testUnsaved().
const BotPassword::GRANTS_MAXLENGTH = 65535 |
Maximum length of the json representation of grants.
Definition at line 43 of file BotPassword.php.
const BotPassword::RESTRICTIONS_MAXLENGTH = 65535 |
Maximum length of the json representation of restrictions.
Definition at line 37 of file BotPassword.php.
Referenced by BotPasswordTest\testSaveValidation().