Utility class for bot passwords. More...

Inheritance diagram for BotPassword:

Collaboration diagram for BotPassword:

[legend]

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)

Private Member Functions
	getPassword ()

Static Private Member Functions
static	loginHook ( $user, $bp, Status $status)
	Call AuthManagerLoginAuthenticateAudit.

Private Attributes
string	$appId

int	$centralId

int	$flags
	Defaults to {.

string[]	$grants

bool	$isSaved

MWRestrictions	$restrictions

string	$token

Detailed Description

Utility class for bot passwords.

Since: 1.27

Definition at line 33 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 82 of file BotPassword.php.

References isSaved().

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

◆ delete()

BotPassword::delete ( )

Delete the BotPassword from the database.

Returns: bool Success

Definition at line 273 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 364 of file BotPassword.php.

◆ getAppId()

BotPassword::getAppId ( )

Returns: string

Definition at line 167 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 98 of file BotPassword.php.

◆ getGrants()

BotPassword::getGrants ( )

Returns: string[]

Definition at line 188 of file BotPassword.php.

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

◆ getPassword()

BotPassword::getPassword ( )

private

Returns: Password

Definition at line 204 of file BotPassword.php.

References getDB().

Referenced by isInvalid().

◆ getRestrictions()

BotPassword::getRestrictions ( )

Returns: MWRestrictions

Definition at line 181 of file BotPassword.php.

◆ getSeparator()

static BotPassword::getSeparator ( )

static

Get the separator for combined user name + app ID.

Returns: string

Definition at line 196 of file BotPassword.php.

References $wgUserrightsInterwikiDelimiter.

◆ getToken()

BotPassword::getToken ( )

Returns: string

Definition at line 174 of file BotPassword.php.

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

◆ getUserCentralId()

BotPassword::getUserCentralId ( )

Get the central user ID.

Returns: int

Definition at line 160 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 303 of file BotPassword.php.

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

◆ invalidateAllPasswordsForUser()

static BotPassword::invalidateAllPasswordsForUser ( $username )

static

Invalidate all passwords for a user, by name.

Parameters

string $username User name

Returns: bool Whether any passwords were invalidated

Definition at line 289 of file BotPassword.php.

◆ isInvalid()

BotPassword::isInvalid ( )

Whether the password is currently invalid.

Since: 1.32

Returns: bool

Definition at line 231 of file BotPassword.php.

References getPassword().

◆ isSaved()

BotPassword::isSaved ( )

Indicate whether this is known to be saved.

Returns: bool

Definition at line 152 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 404 of file BotPassword.php.

References $wgEnableBotPasswords, $wgPasswordAttemptThrottle, WebRequest\getIP(), User\newFromName(), and wfMessage().

◆ 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	$user	User being logged in
BotPassword \| null	$bp	Bot sub-account, if it can be identified
Status	$status	Login status

Returns: Status The passed-in status

Definition at line 489 of file BotPassword.php.

References Status\getMessage(), and StatusValue\isGood().

◆ 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 124 of file BotPassword.php.

◆ 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 111 of file BotPassword.php.

◆ 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 142 of file BotPassword.php.

◆ 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 341 of file BotPassword.php.

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

◆ removeAllPasswordsForUser()

static BotPassword::removeAllPasswordsForUser ( $username )

static

Remove all passwords for a user, by name.

Parameters

string $username User name

Returns: bool Whether any passwords were removed

Definition at line 327 of file BotPassword.php.

◆ 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 242 of file BotPassword.php.

References isSaved().

Member Data Documentation

◆ $appId

string BotPassword::$appId

private

Definition at line 61 of file BotPassword.php.

◆ $centralId

int BotPassword::$centralId

private

Definition at line 58 of file BotPassword.php.

◆ $flags

int BotPassword::$flags

private

Defaults to {.

See also: READ_NORMAL}

Definition at line 73 of file BotPassword.php.

◆ $grants

string [] BotPassword::$grants

private

Definition at line 70 of file BotPassword.php.

◆ $isSaved

bool BotPassword::$isSaved

private

Definition at line 55 of file BotPassword.php.

◆ $restrictions

MWRestrictions BotPassword::$restrictions

private

Definition at line 67 of file BotPassword.php.

◆ $token

string BotPassword::$token

private

Definition at line 64 of file BotPassword.php.

◆ APPID_MAXLENGTH

const BotPassword::APPID_MAXLENGTH = 32

Definition at line 35 of file BotPassword.php.

◆ GRANTS_MAXLENGTH

const BotPassword::GRANTS_MAXLENGTH = 65535

Maximum length of the json representation of grants.

Since: 1.36

Definition at line 52 of file BotPassword.php.

◆ PASSWORD_MINLENGTH

const BotPassword::PASSWORD_MINLENGTH = 32

Minimum length for a bot password.

Definition at line 40 of file BotPassword.php.

◆ RESTRICTIONS_MAXLENGTH

const BotPassword::RESTRICTIONS_MAXLENGTH = 65535

Maximum length of the json representation of restrictions.

Since: 1.36

Definition at line 46 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

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canonicalizeLoginData()

◆ delete()

◆ generatePassword()

◆ getAppId()

◆ getDB()

◆ getGrants()

◆ getPassword()

◆ getRestrictions()

◆ getSeparator()

◆ getToken()

◆ getUserCentralId()

◆ invalidateAllPasswordsForCentralId()

◆ invalidateAllPasswordsForUser()

◆ isInvalid()

◆ isSaved()

◆ login()

◆ loginHook()

◆ newFromCentralId()

◆ newFromUser()

◆ newUnsaved()

◆ removeAllPasswordsForCentralId()

◆ removeAllPasswordsForUser()

◆ save()

Member Data Documentation

◆ $appId

◆ $centralId

◆ $flags

◆ $grants

◆ $isSaved

◆ $restrictions

◆ $token

◆ APPID_MAXLENGTH

◆ GRANTS_MAXLENGTH

◆ PASSWORD_MINLENGTH

◆ RESTRICTIONS_MAXLENGTH