Utility class for bot passwords. More...

Inheritance diagram for BotPassword:

Collaboration diagram for BotPassword:

Public Member Functions
	__construct ( $row, $isSaved, $flags=self::READ_NORMAL)

	delete ()
	Delete the BotPassword from the database. More...

	getAppId ()

	getGrants ()

	getRestrictions ()

	getToken ()

	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 (UserIdentity $userIdentity, $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	PASSWORD_MINLENGTH = 32
	Minimum length for a bot password. More...

const	RESTRICTIONS_MAXLENGTH = 65535
	Maximum length of the json representation of restrictions. More...

Public Attributes inherited from IDBAccessObject
const	READ_NONE = -1
	Constants for object loading bitfield flags (higher => higher QoS) More...

Detailed Description

Utility class for bot passwords.

Since: 1.27

Definition at line 35 of file BotPassword.php.

Constructor & Destructor Documentation

◆ __construct()

BotPassword::__construct	(	$row,
		$isSaved,
		$flags = `self::READ_NORMAL`
	)

Access: internal: only public for construction in BotPasswordStore

Parameters

stdClass	$row	bot_passwords database row
bool	$isSaved	Whether the bot password was read from the database
int	$flags	IDBAccessObject read flags

Definition at line 84 of file BotPassword.php.

References 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: string[]|false

Definition at line 382 of file BotPassword.php.

References getSeparator().

Referenced by ApiLogin\execute().

◆ delete()

BotPassword::delete ( )

Delete the BotPassword from the database.

Returns: bool Success

Definition at line 276 of file BotPassword.php.

References isSaved().

◆ generatePassword()

static BotPassword::generatePassword ( $config )

static

Returns a (raw, unhashed) random password string.

Parameters

Config $config

Returns: string

Definition at line 368 of file BotPassword.php.

References PasswordFactory\generateRandomPasswordString().

Referenced by CreateBotPassword\execute().

◆ getAppId()

BotPassword::getAppId ( )

Returns: string

Definition at line 169 of file BotPassword.php.

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

◆ getDB()

static BotPassword::getDB ( $db )

static

Get a database connection for the bot passwords database.

Parameters

int $db Index of the connection to get, e.g. DB_PRIMARY or DB_REPLICA.

Returns: IDatabase

Definition at line 100 of file BotPassword.php.

Referenced by MediaWiki\Specials\SpecialBotPasswords\getFormFields(), invalidateAllPasswordsForCentralId(), and removeAllPasswordsForCentralId().

◆ getGrants()

BotPassword::getGrants ( )

Returns: string[]

Definition at line 190 of file BotPassword.php.

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

◆ getRestrictions()

BotPassword::getRestrictions ( )

Returns: MWRestrictions

Definition at line 183 of file BotPassword.php.

◆ getSeparator()

static BotPassword::getSeparator ( )

static

Get the separator for combined user name + app ID.

Returns: string

Definition at line 198 of file BotPassword.php.

Referenced by canonicalizeLoginData(), MediaWiki\Specials\SpecialBotPasswords\getFormFields(), login(), and MediaWiki\Specials\SpecialBotPasswords\onSuccess().

◆ getToken()

BotPassword::getToken ( )

Returns: string

Definition at line 176 of file BotPassword.php.

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

◆ getUserCentralId()

BotPassword::getUserCentralId ( )

Get the central user ID.

Returns: int

Definition at line 162 of file BotPassword.php.

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

◆ invalidateAllPasswordsForCentralId()

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

References DB_PRIMARY, getDB(), PasswordFactory\newInvalidPassword(), and wfDeprecated().

◆ invalidateAllPasswordsForUser()

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

Referenced by InvalidateBotPasswords\execute().

◆ isInvalid()

BotPassword::isInvalid ( )

Whether the password is currently invalid.

Since: 1.32

Returns: bool

Definition at line 234 of file BotPassword.php.

◆ isSaved()

BotPassword::isSaved ( )

Indicate whether this is known to be saved.

Returns: bool

Definition at line 154 of file BotPassword.php.

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

◆ login()

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

static

Try to log the user in.

Parameters

string	$username	Combined user name and app ID
string	$password	Supplied password
WebRequest	$request

Returns: Status On success, the good status's value is the new Session object

Definition at line 408 of file BotPassword.php.

References WebRequest\getIP(), ObjectCache\getLocalClusterInstance(), getSeparator(), StatusValue\newFatal(), User\newFromName(), newFromUser(), StatusValue\newGood(), and wfMessage().

Referenced by ApiLogin\execute().

◆ newFromCentralId()

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

static

Load a BotPassword from the database.

Parameters

int	$centralId	from CentralIdLookup
string	$appId
int	$flags	IDBAccessObject read flags

Returns: BotPassword|null

Definition at line 126 of file BotPassword.php.

Referenced by MediaWiki\Specials\SpecialBotPasswords\getFormFields(), MediaWiki\Specials\SpecialBotPasswords\onSubmit(), and MediaWiki\Session\BotPasswordSessionProvider\refreshSessionInfo().

◆ newFromUser()

static BotPassword::newFromUser	(	UserIdentity	$userIdentity,
			$appId,
			$flags = `self::READ_NORMAL`
	)

static

Load a BotPassword from the database.

Parameters

UserIdentity	$userIdentity
string	$appId
int	$flags	IDBAccessObject read flags

Returns: BotPassword|null

Definition at line 113 of file BotPassword.php.

Referenced by login().

◆ newUnsaved()

static BotPassword::newUnsaved	(	array	$data,
			$flags = `self::READ_NORMAL`
	)

static

Create an unsaved BotPassword.

Parameters

array	$data	Data 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	$flags	IDBAccessObject read flags

Returns: BotPassword|null

Definition at line 144 of file BotPassword.php.

Referenced by CreateBotPassword\execute(), and MediaWiki\Specials\SpecialBotPasswords\getFormFields().

◆ removeAllPasswordsForCentralId()

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

References DB_PRIMARY, getDB(), and wfDeprecated().

◆ removeAllPasswordsForUser()

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

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

◆ save()

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

Save the BotPassword to the database.

Parameters

string	$operation	'update' or 'insert'
Password \| null	$password	Password to set.

Returns: Status

Exceptions

UnexpectedValueException

Definition at line 245 of file BotPassword.php.

References isSaved(), StatusValue\newGood(), and Status\wrap().

Member Data Documentation

◆ APPID_MAXLENGTH

const BotPassword::APPID_MAXLENGTH = 32

Definition at line 37 of file BotPassword.php.

Referenced by MediaWiki\Specials\SpecialBotPasswords\execute(), and MediaWiki\Specials\SpecialBotPasswords\getFormFields().

◆ GRANTS_MAXLENGTH

const BotPassword::GRANTS_MAXLENGTH = 65535

Maximum length of the json representation of grants.

Since: 1.36

Definition at line 54 of file BotPassword.php.

◆ PASSWORD_MINLENGTH

const BotPassword::PASSWORD_MINLENGTH = 32

Minimum length for a bot password.

Definition at line 42 of file BotPassword.php.

Referenced by CreateBotPassword\execute().

◆ RESTRICTIONS_MAXLENGTH

const BotPassword::RESTRICTIONS_MAXLENGTH = 65535

Maximum length of the json representation of restrictions.

Since: 1.36

Definition at line 48 of file BotPassword.php.

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

includes/user/BotPassword.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canonicalizeLoginData()

◆ delete()

◆ generatePassword()

◆ getAppId()

◆ getDB()

◆ getGrants()

◆ getRestrictions()

◆ getSeparator()

◆ getToken()

◆ getUserCentralId()

◆ invalidateAllPasswordsForCentralId()

◆ invalidateAllPasswordsForUser()

◆ isInvalid()

◆ isSaved()

◆ login()

◆ newFromCentralId()

◆ newFromUser()

◆ newUnsaved()

◆ removeAllPasswordsForCentralId()

◆ removeAllPasswordsForUser()

◆ save()

Member Data Documentation

◆ APPID_MAXLENGTH

◆ GRANTS_MAXLENGTH

◆ PASSWORD_MINLENGTH

◆ RESTRICTIONS_MAXLENGTH