This serves as the entry point to the authentication system. More...

Inheritance diagram for MediaWiki\Auth\AuthManager:

Collaboration diagram for MediaWiki\Auth\AuthManager:

[legend]

Public Member Functions
	__construct (WebRequest $request, Config $config)

	forcePrimaryAuthenticationProviders (array $providers, $why)
	Force certain PrimaryAuthenticationProviders. More...

	getRequest ()

	setLogger (LoggerInterface $logger)

Authentication
	canAuthenticateNow ()
	Indicate whether user authentication is possible. More...

	beginAuthentication (array $reqs, $returnToUrl)
	Start an authentication flow. More...

	continueAuthentication (array $reqs)
	Continue an authentication flow. More...

	securitySensitiveOperationStatus ( $operation)
	Whether security-sensitive operations should proceed. More...

	userCanAuthenticate ( $username)
	Determine whether a username can authenticate. More...

	normalizeUsername ( $username)
	Provide normalized versions of the username for security checks. More...

Authentication data changing
	revokeAccessForUser ( $username)
	Revoke any authentication credentials for a user. More...

	allowsAuthenticationDataChange (AuthenticationRequest $req, $checkData=true)
	Validate a change of authentication data (e.g. More...

	changeAuthenticationData (AuthenticationRequest $req)
	Change authentication data (e.g. More...

Account creation
	canCreateAccounts ()
	Determine whether accounts can be created. More...

	canCreateAccount ( $username, $options=[])
	Determine whether a particular account can be created. More...

	checkAccountCreatePermissions (User $creator)
	Basic permissions checks on whether a user can create accounts. More...

	beginAccountCreation (User $creator, array $reqs, $returnToUrl)
	Start an account creation flow. More...

	continueAccountCreation (array $reqs)
	Continue an account creation flow. More...

	autoCreateUser (User $user, $source, $login=true)
	Auto-create an account, and log into that account. More...

Account linking
	canLinkAccounts ()
	Determine whether accounts can be linked. More...

	beginAccountLink (User $user, array $reqs, $returnToUrl)
	Start an account linking flow. More...

	continueAccountLink (array $reqs)
	Continue an account linking flow. More...

Static Public Member Functions
static	callLegacyAuthPlugin ( $method, array $params, $return=null)
	Call a legacy AuthPlugin method, if necessary. More...

static	singleton ()
	Get the global AuthManager. More...

Public Attributes
const	ACTION_CHANGE = 'change'
	Change a user's credentials. More...

const	ACTION_CREATE = 'create'
	Create a new user. More...

const	ACTION_CREATE_CONTINUE = 'create-continue'
	Continue a user creation process that was interrupted by the need for user input or communication with an external provider. More...

const	ACTION_LINK = 'link'
	Link an existing user to a third-party account. More...

const	ACTION_LINK_CONTINUE = 'link-continue'
	Continue a user linking process that was interrupted by the need for user input or communication with an external provider. More...

const	ACTION_LOGIN = 'login'
	Log in with an existing (not necessarily local) user. More...

const	ACTION_LOGIN_CONTINUE = 'login-continue'
	Continue a login process that was interrupted by the need for user input or communication with an external provider. More...

const	ACTION_REMOVE = 'remove'
	Remove a user's credentials. More...

const	ACTION_UNLINK = 'unlink'
	Like ACTION_REMOVE but for linking providers only. More...

const	AUTOCREATE_SOURCE_SESSION = \MediaWiki\Session\SessionManager::class
	Auto-creation is due to SessionManager. More...

const	SEC_FAIL = 'fail'
	Security-sensitive should not be performed. More...

const	SEC_OK = 'ok'
	Security-sensitive operations are ok. More...

const	SEC_REAUTH = 'reauth'
	Security-sensitive operations should re-authenticate. More...

Private Attributes
AuthenticationProvider[]	$allAuthenticationProviders = []

Config	$config

CreatedAccountAuthenticationRequest[]	$createdAccountAuthenticationRequests = []

LoggerInterface	$logger

PreAuthenticationProvider[]	$preAuthenticationProviders = null

PrimaryAuthenticationProvider[]	$primaryAuthenticationProviders = null

WebRequest	$request

SecondaryAuthenticationProvider[]	$secondaryAuthenticationProviders = null

Static Private Attributes
static AuthManager null	$instance = null

Information methods
	getAuthenticationRequests ( $action, User $user=null)
	Return the applicable list of AuthenticationRequests. More...

	userExists ( $username, $flags=User::READ_NORMAL)
	Determine whether a username exists. More...

	allowsPropertyChange ( $property)
	Determine whether a user property should be allowed to be changed. More...

	getAuthenticationProvider ( $id)
	Get a provider by ID. More...

	getAuthenticationRequestsInternal ( $providerAction, array $options, array $providers, User $user=null)
	Internal request lookup for self::getAuthenticationRequests. More...

	fillRequests (array &$reqs, $action, $username, $forceAction=false)
	Set values in an array of requests. More...

Internal methods
static	resetCache ()
	Reset the internal caching for unit testing. More...

	setAuthenticationSessionData ( $key, $data)
	Store authentication in the current session. More...

	getAuthenticationSessionData ( $key, $default=null)
	Fetch authentication data from the current session. More...

	removeAuthenticationSessionData ( $key)
	Remove authentication data. More...

	getConfiguration ()
	Get the configuration. More...

	setSessionDataForUser ( $user, $remember=null)
	Log the user in. More...

	setDefaultUserOptions (User $user, $useContextLang)

	callMethodOnProviders ( $which, $method, array $args)

	providerArrayFromSpecs ( $class, array $specs)
	Create an array of AuthenticationProviders from an array of ObjectFactory specs. More...

	getPreAuthenticationProviders ()
	Get the list of PreAuthenticationProviders. More...

	getPrimaryAuthenticationProviders ()
	Get the list of PrimaryAuthenticationProviders. More...

	getSecondaryAuthenticationProviders ()
	Get the list of SecondaryAuthenticationProviders. More...

Detailed Description

This serves as the entry point to the authentication system.

In the future, it may also serve as the entry point to the authorization system.

If you are looking at this because you are working on an extension that creates its own login or signup page, then 1) you really shouldn't do that, 2) if you feel you absolutely have to, subclass AuthManagerSpecialPage or build it on the client side using the clientlogin or the createaccount API. Trying to call this class directly will very likely end up in security vulnerabilities or broken UX in edge cases.

If you are working on an extension that needs to integrate with the authentication system (e.g. by providing a new login method, or doing extra permission checks), you'll probably need to write an AuthenticationProvider.

If you want to create a "reserved" user programmatically, User::newSystemUser() might be what you are looking for. If you want to change user data, use User::changeAuthenticationData(). Code that is related to some SessionProvider or PrimaryAuthenticationProvider can create a (non-reserved) user by calling AuthManager::autoCreateUser(); it is then the provider's responsibility to ensure that the user can authenticate somehow (see especially PrimaryAuthenticationProvider::autoCreatedAccount()). If you are writing code that is not associated with such a provider and needs to create accounts programmatically for real users, you should rethink your architecture. There is no good way to do that as such code has no knowledge of what authentication methods are enabled on the wiki and cannot provide any means for users to access the accounts it would create.

The two main control flows when using this class are as follows:

Login, user creation or account linking code will call getAuthenticationRequests(), populate the requests with data (by using them to build a HTMLForm and have the user fill it, or by exposing a form specification via the API, so that the client can build it), and pass them to the appropriate begin* method. That will return either a success/failure response, or more requests to fill (either by building a form or by redirecting the user to some external provider which will send the data back), in which case they need to be submitted to the appropriate continue* method and that step has to be repeated until the response is a success or failure response. AuthManager will use the session to maintain internal state during the process.
Code doing an authentication data change will call getAuthenticationRequests(), select a single request, populate it, and pass it to allowsAuthenticationDataChange() and then changeAuthenticationData(). If the data change is user-initiated, the whole process needs to be preceded by a call to securitySensitiveOperationStatus() and aborted if that returns a non-OK status.

Since: 1.27

See also: https://www.mediawiki.org/wiki/Manual:SessionManager_and_AuthManager

Definition at line 82 of file AuthManager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Auth\AuthManager::__construct	(	WebRequest	$request,
		Config	$config
	)

Parameters

WebRequest	$request
Config	$config

Definition at line 160 of file AuthManager.php.

References MediaWiki\Auth\AuthManager\$config, MediaWiki\Auth\AuthManager\$request, MediaWiki\Logger\LoggerFactory\getInstance(), request, and MediaWiki\Auth\AuthManager\setLogger().

Member Function Documentation

◆ allowsAuthenticationDataChange()

MediaWiki\Auth\AuthManager::allowsAuthenticationDataChange	(	AuthenticationRequest	$req,
			$checkData = `true`
	)

Validate a change of authentication data (e.g.

passwords)

Parameters

AuthenticationRequest	$req
bool	$checkData	If false, $req hasn't been loaded from the submission so checks on user-submitted fields should be skipped. $req->username is considered user-submitted for this purpose, even if it cannot be changed via $req->loadFromSubmission.

Returns: Status

Definition at line 851 of file AuthManager.php.

References $req, as, MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders(), MediaWiki\Auth\AuthManager\getSecondaryAuthenticationProviders(), StatusValue\newGood(), and Status\wrap().

Referenced by MediaWiki\Auth\AuthManager\getAuthenticationRequestsInternal().

◆ allowsPropertyChange()

MediaWiki\Auth\AuthManager::allowsPropertyChange ( $property )

Determine whether a user property should be allowed to be changed.

Supported properties are:

emailaddress
realname
nickname

Parameters

string $property

Returns: bool

Definition at line 2174 of file AuthManager.php.

References $property, as, MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders(), and MediaWiki\Auth\AuthManager\getSecondaryAuthenticationProviders().

◆ autoCreateUser()

MediaWiki\Auth\AuthManager::autoCreateUser	(	User	$user,
			$source,
			$login = `true`
	)

Auto-create an account, and log into that account.

PrimaryAuthenticationProviders can invoke this method by returning a PASS from beginPrimaryAuthentication/continuePrimaryAuthentication with the username of a non-existing user. SessionProviders can invoke it by returning a SessionInfo with the username of a non-existing user from provideSessionInfo(). Calling this method explicitly (e.g. from a maintenance script) is also fine.

Parameters

User	$user	User to auto-create
string	$source	What caused the auto-creation? This must be the ID of a PrimaryAuthenticationProvider or the constant self::AUTOCREATE_SOURCE_SESSION.
bool	$login	Whether to also log the user in

Returns: Status Good if user was created, Ok if user already existed, otherwise Fatal

Definition at line 1538 of file AuthManager.php.

References $cache, $flags, $options, $ret, $source, $user, $username, DeferredUpdates\addCallableUpdate(), DeferredUpdates\addUpdate(), as, MediaWiki\Auth\AuthManager\callMethodOnProviders(), MediaWiki\Auth\AuthManager\getAuthenticationProvider(), ObjectCache\getLocalClusterInstance(), MediaWiki\Auth\AuthManager\getPreAuthenticationProviders(), MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders(), MediaWiki\Auth\AuthManager\getSecondaryAuthenticationProviders(), User\idFromName(), User\IGNORE_USER_RIGHTS, Profiler\instance(), User\isCreatableName(), StatusValue\newFatal(), StatusValue\newGood(), request, Hooks\run(), MediaWiki\Auth\AuthManager\setDefaultUserOptions(), MediaWiki\Auth\AuthManager\setSessionDataForUser(), use, User, wfGetLB(), wfMessage(), wfReadOnly(), wfReadOnlyReason(), and Status\wrap().

Referenced by MediaWiki\Auth\AuthManager\continueAuthentication().

◆ beginAccountCreation()

MediaWiki\Auth\AuthManager::beginAccountCreation	(	User	$creator,
		array	$reqs,
			$returnToUrl
	)

Start an account creation flow.

In addition to the AuthenticationRequests returned by $this->getAuthenticationRequests(), a client might include a CreateFromLoginAuthenticationRequest from a previous login attempt. If $createFromLoginAuthenticationRequest->hasPrimaryStateForAction( AuthManager::ACTION_CREATE ) returns true, any AuthenticationRequest::PRIMARY_REQUIRED requests should be omitted. If the CreateFromLoginAuthenticationRequest has a username set, that username must be used for all other requests.

Parameters

User	$creator	User doing the account creation
AuthenticationRequest[]	$reqs
string	$returnToUrl	Url that REDIRECT responses should eventually return to.

Returns: AuthenticationResponse

Definition at line 1037 of file AuthManager.php.

◆ beginAccountLink()

MediaWiki\Auth\AuthManager::beginAccountLink	(	User	$user,
		array	$reqs,
			$returnToUrl
	)

Start an account linking flow.

Parameters

User	$user	User being linked
AuthenticationRequest[]	$reqs
string	$returnToUrl	Url that REDIRECT responses should eventually return to.

Returns: AuthenticationResponse

Definition at line 1785 of file AuthManager.php.

◆ beginAuthentication()

MediaWiki\Auth\AuthManager::beginAuthentication	(	array	$reqs,
			$returnToUrl
	)

Start an authentication flow.

In addition to the AuthenticationRequests returned by $this->getAuthenticationRequests(), a client might include a CreateFromLoginAuthenticationRequest from a previous login attempt to preserve state.

Instead of the AuthenticationRequests returned by $this->getAuthenticationRequests(), a client might pass a CreatedAccountAuthenticationRequest from an account creation that just succeeded to log in to the just-created account.

Parameters

AuthenticationRequest[]	$reqs
string	$returnToUrl	Url that REDIRECT responses should eventually return to.

Returns: AuthenticationResponse See self::continueAuthentication()

Definition at line 283 of file AuthManager.php.

◆ callLegacyAuthPlugin()

static MediaWiki\Auth\AuthManager::callLegacyAuthPlugin	(		$method,
		array	$params,
			$return = `null`
	)

static

Call a legacy AuthPlugin method, if necessary.

Deprecated:: For backwards compatibility only, should be avoided in new code

Parameters

string	$method	AuthPlugin method to call
array	$params	Parameters to pass
mixed	$return	Return value if AuthPlugin wasn't called

Returns: mixed Return value from the AuthPlugin method, or $return

Definition at line 238 of file AuthManager.php.

References $params, $wgAuth, and global.

Referenced by SpecialChangeEmail\attemptChange(), UserrightsPage\doSaveUserGroups(), MediaWiki\Session\SessionManager\invalidateSessionsForUser(), and Preferences\tryFormSubmit().

◆ callMethodOnProviders()

MediaWiki\Auth\AuthManager::callMethodOnProviders	(		$which,
			$method,
		array	$args
	)

private

Parameters

int	$which	Bitmask: 1 = pre, 2 = primary, 4 = secondary
string	$method
array	$args

Definition at line 2413 of file AuthManager.php.

References $args, as, MediaWiki\Auth\AuthManager\getPreAuthenticationProviders(), MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders(), and MediaWiki\Auth\AuthManager\getSecondaryAuthenticationProviders().

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\beginAccountLink(), MediaWiki\Auth\AuthManager\beginAuthentication(), MediaWiki\Auth\AuthManager\changeAuthenticationData(), MediaWiki\Auth\AuthManager\continueAccountCreation(), MediaWiki\Auth\AuthManager\continueAccountLink(), MediaWiki\Auth\AuthManager\continueAuthentication(), and MediaWiki\Auth\AuthManager\revokeAccessForUser().

◆ canAuthenticateNow()

MediaWiki\Auth\AuthManager::canAuthenticateNow ( )

Indicate whether user authentication is possible.

It may not be if the session is provided by something like OAuth for which each individual request includes authentication data.

Returns: bool

Definition at line 261 of file AuthManager.php.

References request.

Referenced by MediaWiki\Auth\AuthManager\securitySensitiveOperationStatus().

◆ canCreateAccount()

MediaWiki\Auth\AuthManager::canCreateAccount	(	$username,
		$options = `[]`
	)

Determine whether a particular account can be created.

Parameters

string	$username	MediaWiki username
array	$options	flags: (int) Bitfield of User:READ_* constants, default User::READ_NORMAL creating: (bool) For internal use only. Never specify this.

Returns: Status

Definition at line 927 of file AuthManager.php.

References $flags, $options, $user, $username, as, MediaWiki\Auth\AuthManager\canCreateAccounts(), MediaWiki\Auth\AuthManager\getPreAuthenticationProviders(), MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders(), MediaWiki\Auth\AuthManager\getSecondaryAuthenticationProviders(), StatusValue\newFatal(), User\newFromName(), StatusValue\newGood(), MediaWiki\Auth\AuthManager\userExists(), and Status\wrap().

Referenced by MediaWiki\Auth\AuthManager\beginAccountCreation().

◆ canCreateAccounts()

MediaWiki\Auth\AuthManager::canCreateAccounts ( )

Determine whether accounts can be created.

Returns: bool

Definition at line 908 of file AuthManager.php.

References as, MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders(), MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_CREATE, and MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_LINK.

Referenced by MediaWiki\Auth\AuthManager\beginAccountCreation(), MediaWiki\Auth\AuthManager\canCreateAccount(), and MediaWiki\Auth\AuthManager\continueAccountCreation().

◆ canLinkAccounts()

MediaWiki\Auth\AuthManager::canLinkAccounts ( )

Determine whether accounts can be linked.

Returns: bool

Definition at line 1767 of file AuthManager.php.

References as, MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders(), and MediaWiki\Auth\PrimaryAuthenticationProvider\TYPE_LINK.

Referenced by MediaWiki\Auth\AuthManager\beginAccountLink(), and MediaWiki\Auth\AuthManager\continueAccountLink().

◆ changeAuthenticationData()

MediaWiki\Auth\AuthManager::changeAuthenticationData ( AuthenticationRequest $req )

Change authentication data (e.g.

passwords)

If $req was returned for AuthManager::ACTION_CHANGE, using $req should result in a successful login in the future.

If $req was returned for AuthManager::ACTION_REMOVE, using $req should no longer result in a successful login.

This method should only be called if allowsAuthenticationDataChange( $req, true ) returned success.

Parameters

AuthenticationRequest $req

Definition at line 884 of file AuthManager.php.

References $req, MediaWiki\Auth\AuthManager\callMethodOnProviders(), and BotPassword\invalidateAllPasswordsForUser().

◆ checkAccountCreatePermissions()

MediaWiki\Auth\AuthManager::checkAccountCreatePermissions ( User $creator )

Basic permissions checks on whether a user can create accounts.

Parameters

User $creator User doing the account creation

Returns: Status

Definition at line 975 of file AuthManager.php.

References $args, as, MediaWiki\Auth\AuthManager\getRequest(), SpecialPage\getTitleFor(), User\isBlockedFromCreateAccount(), User\isDnsBlacklisted(), StatusValue\newFatal(), StatusValue\newGood(), Block\TYPE_RANGE, wfMessage(), wfReadOnly(), and wfReadOnlyReason().

Referenced by MediaWiki\Auth\AuthManager\beginAccountCreation(), and MediaWiki\Auth\AuthManager\continueAccountCreation().

◆ continueAccountCreation()

MediaWiki\Auth\AuthManager::continueAccountCreation ( array $reqs )

Continue an account creation flow.

Parameters

AuthenticationRequest[] $reqs

Returns: AuthenticationResponse

Definition at line 1138 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\beginAccountCreation().

◆ continueAccountLink()

MediaWiki\Auth\AuthManager::continueAccountLink ( array $reqs )

Continue an account linking flow.

Parameters

AuthenticationRequest[] $reqs

Returns: AuthenticationResponse

Definition at line 1894 of file AuthManager.php.

◆ continueAuthentication()

MediaWiki\Auth\AuthManager::continueAuthentication ( array $reqs )

Continue an authentication flow.

Return values are interpreted as follows:

status FAIL: Authentication failed. If $response->createRequest is set, that may be passed to self::beginAuthentication() or to self::beginAccountCreation() to preserve state.
status REDIRECT: The client should be redirected to the contained URL, new AuthenticationRequests should be made (if any), then AuthManager::continueAuthentication() should be called.
status UI: The client should be presented with a user interface for the fields in the specified AuthenticationRequests, then new AuthenticationRequests should be made, then AuthManager::continueAuthentication() should be called.
status RESTART: The user logged in successfully with a third-party service, but the third-party credentials aren't attached to any local account. This could be treated as a UI or a FAIL.
status PASS: Authentication was successful.

Parameters

AuthenticationRequest[] $reqs

Returns: AuthenticationResponse

Definition at line 407 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\beginAuthentication().

◆ fillRequests()

MediaWiki\Auth\AuthManager::fillRequests	(	array &	$reqs,
			$action,
			$username,
			$forceAction = `false`
	)

private

Set values in an array of requests.

Parameters

AuthenticationRequest[]	&$reqs
string	$action
string \| null	$username
bool	$forceAction

Definition at line 2136 of file AuthManager.php.

References MediaWiki\$action, $req, $username, and as.

Referenced by MediaWiki\Auth\AuthManager\beginAccountLink(), MediaWiki\Auth\AuthManager\continueAccountCreation(), MediaWiki\Auth\AuthManager\continueAccountLink(), MediaWiki\Auth\AuthManager\continueAuthentication(), and MediaWiki\Auth\AuthManager\getAuthenticationRequestsInternal().

◆ forcePrimaryAuthenticationProviders()

MediaWiki\Auth\AuthManager::forcePrimaryAuthenticationProviders	(	array	$providers,
			$why
	)

Force certain PrimaryAuthenticationProviders.

Deprecated:: For backwards compatibility only

Parameters

PrimaryAuthenticationProvider[]	$providers
string	$why

Definition at line 186 of file AuthManager.php.

References as, and request.

◆ getAuthenticationProvider()

MediaWiki\Auth\AuthManager::getAuthenticationProvider ( $id )

Get a provider by ID.

Note: This is public so extensions can check whether their own provider is installed and so they can read its configuration if necessary. Other uses are not recommended.

Parameters

string $id

Returns: AuthenticationProvider|null

Definition at line 2193 of file AuthManager.php.

References MediaWiki\Auth\AuthManager\getPreAuthenticationProviders(), MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders(), and MediaWiki\Auth\AuthManager\getSecondaryAuthenticationProviders().

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\continueAccountCreation(), MediaWiki\Auth\AuthManager\continueAccountLink(), and MediaWiki\Auth\AuthManager\continueAuthentication().

◆ getAuthenticationRequests()

MediaWiki\Auth\AuthManager::getAuthenticationRequests	(		$action,
		User	$user = `null`
	)

Return the applicable list of AuthenticationRequests.

Possible values for $action:

ACTION_LOGIN: Valid for passing to beginAuthentication
ACTION_LOGIN_CONTINUE: Valid for passing to continueAuthentication in the current state
ACTION_CREATE: Valid for passing to beginAccountCreation
ACTION_CREATE_CONTINUE: Valid for passing to continueAccountCreation in the current state
ACTION_LINK: Valid for passing to beginAccountLink
ACTION_LINK_CONTINUE: Valid for passing to continueAccountLink in the current state
ACTION_CHANGE: Valid for passing to changeAuthenticationData to change credentials
ACTION_REMOVE: Valid for passing to changeAuthenticationData to remove credentials.
ACTION_UNLINK: Same as ACTION_REMOVE, but limited to linked accounts.

Parameters

string	$action	One of the AuthManager::ACTION_* constants
User \| null	$user	User being acted on, instead of the current user.

Returns: AuthenticationRequest[]

Definition at line 2006 of file AuthManager.php.

◆ getAuthenticationRequestsInternal()

MediaWiki\Auth\AuthManager::getAuthenticationRequestsInternal	(		$providerAction,
		array	$options,
		array	$providers,
		User	$user = `null`
	)

private

Internal request lookup for self::getAuthenticationRequests.

Parameters

string	$providerAction	Action to pass to providers
array	$options	Options to pass to providers
AuthenticationProvider[]	$providers
User \| null	$user

Returns: AuthenticationRequest[]

Definition at line 2070 of file AuthManager.php.

References $options, $req, $user, MediaWiki\Auth\AuthManager\ACTION_CREATE, MediaWiki\Auth\AuthManager\ACTION_LOGIN, MediaWiki\Auth\AuthManager\allowsAuthenticationDataChange(), as, MediaWiki\Auth\AuthManager\fillRequests(), RequestContext\getMain(), MediaWiki\Auth\AuthenticationRequest\OPTIONAL, MediaWiki\Auth\AuthenticationRequest\PRIMARY_REQUIRED, and MediaWiki\Auth\AuthenticationRequest\REQUIRED.

Referenced by MediaWiki\Auth\AuthManager\continueAuthentication(), and MediaWiki\Auth\AuthManager\getAuthenticationRequests().

◆ getAuthenticationSessionData()

MediaWiki\Auth\AuthManager::getAuthenticationSessionData	(	$key,
		$default = `null`
	)

Fetch authentication data from the current session.

Access:\n protected For use by AuthenticationProviders

Parameters

string	$key
mixed	$default

Returns: mixed

Definition at line 2246 of file AuthManager.php.

References request.

◆ getConfiguration()

MediaWiki\Auth\AuthManager::getConfiguration ( )

private

Get the configuration.

Returns: array

Definition at line 2319 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\getPreAuthenticationProviders(), MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders(), and MediaWiki\Auth\AuthManager\getSecondaryAuthenticationProviders().

◆ getPreAuthenticationProviders()

MediaWiki\Auth\AuthManager::getPreAuthenticationProviders ( )

protected

Get the list of PreAuthenticationProviders.

Returns: PreAuthenticationProvider[]

Definition at line 2327 of file AuthManager.php.

References MediaWiki\Auth\AuthManager\$preAuthenticationProviders, class, MediaWiki\Auth\AuthManager\getConfiguration(), and MediaWiki\Auth\AuthManager\providerArrayFromSpecs().

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\beginAccountLink(), MediaWiki\Auth\AuthManager\beginAuthentication(), MediaWiki\Auth\AuthManager\callMethodOnProviders(), MediaWiki\Auth\AuthManager\canCreateAccount(), MediaWiki\Auth\AuthManager\continueAccountCreation(), MediaWiki\Auth\AuthManager\getAuthenticationProvider(), and MediaWiki\Auth\AuthManager\getAuthenticationRequests().

◆ getPrimaryAuthenticationProviders()

MediaWiki\Auth\AuthManager::getPrimaryAuthenticationProviders ( )

protected

Get the list of PrimaryAuthenticationProviders.

Returns: PrimaryAuthenticationProvider[]

Definition at line 2341 of file AuthManager.php.

References MediaWiki\Auth\AuthManager\$primaryAuthenticationProviders, class, MediaWiki\Auth\AuthManager\getConfiguration(), and MediaWiki\Auth\AuthManager\providerArrayFromSpecs().

◆ getRequest()

MediaWiki\Auth\AuthManager::getRequest ( )

Returns: WebRequest

Definition at line 176 of file AuthManager.php.

References MediaWiki\Auth\AuthManager\$request.

Referenced by MediaWiki\Auth\AuthManager\checkAccountCreatePermissions().

◆ getSecondaryAuthenticationProviders()

MediaWiki\Auth\AuthManager::getSecondaryAuthenticationProviders ( )

protected

Get the list of SecondaryAuthenticationProviders.

Returns: SecondaryAuthenticationProvider[]

Definition at line 2355 of file AuthManager.php.

References MediaWiki\Auth\AuthManager\$secondaryAuthenticationProviders, class, MediaWiki\Auth\AuthManager\getConfiguration(), and MediaWiki\Auth\AuthManager\providerArrayFromSpecs().

Referenced by MediaWiki\Auth\AuthManager\allowsAuthenticationDataChange(), MediaWiki\Auth\AuthManager\allowsPropertyChange(), MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\callMethodOnProviders(), MediaWiki\Auth\AuthManager\canCreateAccount(), MediaWiki\Auth\AuthManager\continueAccountCreation(), MediaWiki\Auth\AuthManager\continueAuthentication(), MediaWiki\Auth\AuthManager\getAuthenticationProvider(), and MediaWiki\Auth\AuthManager\getAuthenticationRequests().

◆ normalizeUsername()

MediaWiki\Auth\AuthManager::normalizeUsername ( $username )

Provide normalized versions of the username for security checks.

Since different providers can normalize the input in different ways, this returns an array of all the different ways the name might be normalized for authentication.

The returned strings should not be revealed to the user, as that might leak private information (e.g. an email address might be normalized to a username).

Parameters

string $username

Returns: string[]

Definition at line 810 of file AuthManager.php.

References $ret, $username, as, and MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders().

◆ providerArrayFromSpecs()

MediaWiki\Auth\AuthManager::providerArrayFromSpecs	(		$class,
		array	$specs
	)

protected

Create an array of AuthenticationProviders from an array of ObjectFactory specs.

Parameters

string	$class
array[]	$specs

Returns: AuthenticationProvider[]

Definition at line 2279 of file AuthManager.php.

References $ret, as, and ObjectFactory\getObjectFromSpec().

Referenced by MediaWiki\Auth\AuthManager\getPreAuthenticationProviders(), MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders(), and MediaWiki\Auth\AuthManager\getSecondaryAuthenticationProviders().

◆ removeAuthenticationSessionData()

MediaWiki\Auth\AuthManager::removeAuthenticationSessionData ( $key )

Remove authentication data.

Access:\n protected For use by AuthenticationProviders

Parameters

string | null $key If null, all data is removed

Definition at line 2260 of file AuthManager.php.

References request.

Referenced by MediaWiki\Auth\AuthManager\beginAccountCreation(), MediaWiki\Auth\AuthManager\beginAccountLink(), MediaWiki\Auth\AuthManager\beginAuthentication(), MediaWiki\Auth\AuthManager\continueAccountCreation(), and MediaWiki\Auth\AuthManager\continueAuthentication().

◆ resetCache()

static MediaWiki\Auth\AuthManager::resetCache ( )

static

Reset the internal caching for unit testing.

Access:\n protected Unit tests only

Definition at line 2433 of file AuthManager.php.

Referenced by ApiTestCase\doApiRequest(), and MediaWikiTestCase\tearDown().

◆ revokeAccessForUser()

MediaWiki\Auth\AuthManager::revokeAccessForUser ( $username )

Revoke any authentication credentials for a user.

After this, the user should no longer be able to log in.

Parameters

string $username

Definition at line 835 of file AuthManager.php.

References $username, and MediaWiki\Auth\AuthManager\callMethodOnProviders().

◆ securitySensitiveOperationStatus()

MediaWiki\Auth\AuthManager::securitySensitiveOperationStatus ( $operation )

Whether security-sensitive operations should proceed.

A "security-sensitive operation" is something like a password or email change, that would normally have a "reenter your password to confirm" box if we only supported password-based authentication.

Parameters

string $operation Operation being checked. This should be a message-key-like string such as 'change-password' or 'change-email'.

Returns: string One of the SEC_* constants.

Definition at line 714 of file AuthManager.php.

References $last, MediaWiki\Auth\AuthManager\canAuthenticateNow(), request, Hooks\run(), MediaWiki\Auth\AuthManager\SEC_FAIL, MediaWiki\Auth\AuthManager\SEC_OK, and MediaWiki\Auth\AuthManager\SEC_REAUTH.

◆ setAuthenticationSessionData()

MediaWiki\Auth\AuthManager::setAuthenticationSessionData	(	$key,
		$data
	)

Store authentication in the current session.

Access:\n protected For use by AuthenticationProviders

Parameters

string	$key
mixed	$data	Must be serializable

Definition at line 2229 of file AuthManager.php.

References request.

◆ setDefaultUserOptions()

MediaWiki\Auth\AuthManager::setDefaultUserOptions	(	User	$user,
			$useContextLang
	)

private

Parameters

User	$user
bool	$useContextLang	Use 'uselang' to set the user's language

Definition at line 2395 of file AuthManager.php.

References $lang, $user, $wgContLang, RequestContext\getMain(), and global.

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), and MediaWiki\Auth\AuthManager\continueAccountCreation().

◆ setLogger()

MediaWiki\Auth\AuthManager::setLogger ( LoggerInterface $logger )

Parameters

LoggerInterface $logger

Definition at line 169 of file AuthManager.php.

References MediaWiki\Auth\AuthManager\$logger.

Referenced by MediaWiki\Auth\AuthManager\__construct().

◆ setSessionDataForUser()

MediaWiki\Auth\AuthManager::setSessionDataForUser	(	$user,
		$remember = `null`
	)

private

Log the user in.

Parameters

User	$user
bool \| null	$remember

Definition at line 2370 of file AuthManager.php.

References $user, request, and Hooks\run().

Referenced by MediaWiki\Auth\AuthManager\autoCreateUser(), MediaWiki\Auth\AuthManager\beginAuthentication(), and MediaWiki\Auth\AuthManager\continueAuthentication().

◆ singleton()

static MediaWiki\Auth\AuthManager::singleton ( )

static

Get the global AuthManager.

Returns: AuthManager

Definition at line 146 of file AuthManager.php.

References MediaWiki\Auth\AuthManager\$instance, MediaWiki\MediaWikiServices\getInstance(), and RequestContext\getMain().

Referenced by MediaWiki\Auth\AuthManagerAuthPlugin\allowPasswordChange(), MediaWiki\Auth\AuthManagerAuthPlugin\allowPropChange(), MediaWiki\Auth\AuthManagerAuthPlugin\authenticate(), MediaWiki\Auth\AuthManagerAuthPlugin\canCreateAccounts(), ApiQueryUsers\execute(), MediaWiki\Auth\AuthManagerAuthPlugin\setPassword(), MediaWiki\Auth\AbstractAuthenticationProviderTest\testAbstractAuthenticationProvider(), MediaWiki\Auth\ThrottlePreAuthenticationProviderTest\testDisabled(), MediaWiki\Auth\ThrottlePreAuthenticationProviderTest\testPostAuthentication(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProviderTest\testRangeBlock(), MediaWiki\Auth\AuthManagerTest\testSingleton(), MediaWiki\Auth\ThrottlePreAuthenticationProviderTest\testTestForAccountCreation(), MediaWiki\Auth\ThrottlePreAuthenticationProviderTest\testTestForAuthentication(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProviderTest\testTestUserForCreation(), and MediaWiki\Auth\AuthManagerAuthPlugin\userExists().

◆ userCanAuthenticate()

MediaWiki\Auth\AuthManager::userCanAuthenticate ( $username )

Determine whether a username can authenticate.

This is mainly for internal purposes and only takes authentication data into account, not things like blocks that can change without the authentication system being aware.

Parameters

string $username MediaWiki username

Returns: bool

Definition at line 787 of file AuthManager.php.

References $username, as, and MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders().

◆ userExists()

MediaWiki\Auth\AuthManager::userExists	(	$username,
		$flags = `User::READ_NORMAL`
	)

Determine whether a username exists.

Parameters

string	$username
int	$flags	Bitfield of User:READ_* constants

Returns: bool

Definition at line 2153 of file AuthManager.php.

References $flags, $username, as, and MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders().

Referenced by MediaWiki\Auth\AuthManager\canCreateAccount().

Member Data Documentation

◆ $allAuthenticationProviders

AuthenticationProvider [] MediaWiki\Auth\AuthManager::$allAuthenticationProviders = []

private

Definition at line 128 of file AuthManager.php.

◆ $config

Config MediaWiki\Auth\AuthManager::$config

private

Definition at line 122 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\__construct().

◆ $createdAccountAuthenticationRequests

CreatedAccountAuthenticationRequest [] MediaWiki\Auth\AuthManager::$createdAccountAuthenticationRequests = []

private

Definition at line 140 of file AuthManager.php.

◆ $instance

AuthManager null MediaWiki\Auth\AuthManager::$instance = null

staticprivate

Definition at line 116 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\singleton().

◆ $logger

LoggerInterface MediaWiki\Auth\AuthManager::$logger

private

Definition at line 125 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\setLogger().

◆ $preAuthenticationProviders

PreAuthenticationProvider [] MediaWiki\Auth\AuthManager::$preAuthenticationProviders = null

private

Definition at line 131 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\getPreAuthenticationProviders().

◆ $primaryAuthenticationProviders

PrimaryAuthenticationProvider [] MediaWiki\Auth\AuthManager::$primaryAuthenticationProviders = null

private

Definition at line 134 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\getPrimaryAuthenticationProviders().

◆ $request

WebRequest MediaWiki\Auth\AuthManager::$request

private

Definition at line 119 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\__construct(), and MediaWiki\Auth\AuthManager\getRequest().

◆ $secondaryAuthenticationProviders

SecondaryAuthenticationProvider [] MediaWiki\Auth\AuthManager::$secondaryAuthenticationProviders = null

private

Definition at line 137 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\getSecondaryAuthenticationProviders().

◆ ACTION_CHANGE

const MediaWiki\Auth\AuthManager::ACTION_CHANGE = 'change'

Change a user's credentials.

Definition at line 99 of file AuthManager.php.

◆ ACTION_CREATE

const MediaWiki\Auth\AuthManager::ACTION_CREATE = 'create'

Create a new user.

Definition at line 89 of file AuthManager.php.

◆ ACTION_CREATE_CONTINUE

const MediaWiki\Auth\AuthManager::ACTION_CREATE_CONTINUE = 'create-continue'

Continue a user creation process that was interrupted by the need for user input or communication with an external provider.

Definition at line 92 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\getAuthenticationRequests(), MediaWiki\Auth\AuthManagerTest\provideGetAuthenticationRequests(), MediaWiki\Auth\AuthManagerTest\testAccountCreation(), and MediaWiki\Auth\AuthManagerTest\testGetAuthenticationRequests().

◆ ACTION_LINK

const MediaWiki\Auth\AuthManager::ACTION_LINK = 'link'

Link an existing user to a third-party account.

Definition at line 94 of file AuthManager.php.

◆ ACTION_LINK_CONTINUE

const MediaWiki\Auth\AuthManager::ACTION_LINK_CONTINUE = 'link-continue'

Continue a user linking process that was interrupted by the need for user input or communication with an external provider.

Definition at line 97 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\getAuthenticationRequests(), MediaWiki\Auth\AuthManagerTest\provideGetAuthenticationRequests(), MediaWiki\Auth\AuthManagerTest\testAccountLink(), and MediaWiki\Auth\AuthManagerTest\testGetAuthenticationRequests().

◆ ACTION_LOGIN

const MediaWiki\Auth\AuthManager::ACTION_LOGIN = 'login'

Log in with an existing (not necessarily local) user.

Definition at line 84 of file AuthManager.php.

◆ ACTION_LOGIN_CONTINUE

const MediaWiki\Auth\AuthManager::ACTION_LOGIN_CONTINUE = 'login-continue'

Continue a login process that was interrupted by the need for user input or communication with an external provider.

Definition at line 87 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\getAuthenticationRequests(), MediaWiki\Auth\AuthManagerTest\provideGetAuthenticationRequests(), MediaWiki\Auth\AuthManagerTest\testAuthentication(), and MediaWiki\Auth\AuthManagerTest\testGetAuthenticationRequests().

◆ ACTION_REMOVE

const MediaWiki\Auth\AuthManager::ACTION_REMOVE = 'remove'

Remove a user's credentials.

Definition at line 101 of file AuthManager.php.

◆ ACTION_UNLINK

const MediaWiki\Auth\AuthManager::ACTION_UNLINK = 'unlink'

Like ACTION_REMOVE but for linking providers only.

Definition at line 103 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\getAuthenticationRequests(), MediaWiki\Auth\AuthManagerTest\provideGetAuthenticationRequests(), and MediaWiki\Auth\AuthManagerTest\testGetAuthenticationRequests().

◆ AUTOCREATE_SOURCE_SESSION

const MediaWiki\Auth\AuthManager::AUTOCREATE_SOURCE_SESSION = \MediaWiki\Session\SessionManager::class

Auto-creation is due to SessionManager.

Definition at line 113 of file AuthManager.php.

◆ SEC_FAIL

const MediaWiki\Auth\AuthManager::SEC_FAIL = 'fail'

Security-sensitive should not be performed.

Definition at line 110 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\securitySensitiveOperationStatus(), and MediaWiki\Auth\AuthManagerTest\testSecuritySensitiveOperationStatus().

◆ SEC_OK

const MediaWiki\Auth\AuthManager::SEC_OK = 'ok'

Security-sensitive operations are ok.

Definition at line 106 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\securitySensitiveOperationStatus(), and MediaWiki\Auth\AuthManagerTest\testSecuritySensitiveOperationStatus().

◆ SEC_REAUTH

const MediaWiki\Auth\AuthManager::SEC_REAUTH = 'reauth'

Security-sensitive operations should re-authenticate.

Definition at line 108 of file AuthManager.php.

Referenced by MediaWiki\Auth\AuthManager\securitySensitiveOperationStatus(), and MediaWiki\Auth\AuthManagerTest\testSecuritySensitiveOperationStatus().

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

includes/auth/AuthManager.php

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Static Private Attributes

Information methods

Internal methods

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allowsAuthenticationDataChange()

◆ allowsPropertyChange()

◆ autoCreateUser()

◆ beginAccountCreation()

◆ beginAccountLink()

◆ beginAuthentication()

◆ callLegacyAuthPlugin()

◆ callMethodOnProviders()

◆ canAuthenticateNow()

◆ canCreateAccount()

◆ canCreateAccounts()

◆ canLinkAccounts()

◆ changeAuthenticationData()

◆ checkAccountCreatePermissions()

◆ continueAccountCreation()

◆ continueAccountLink()

◆ continueAuthentication()

◆ fillRequests()

◆ forcePrimaryAuthenticationProviders()

◆ getAuthenticationProvider()

◆ getAuthenticationRequests()

◆ getAuthenticationRequestsInternal()

◆ getAuthenticationSessionData()

◆ getConfiguration()

◆ getPreAuthenticationProviders()

◆ getPrimaryAuthenticationProviders()

◆ getRequest()

◆ getSecondaryAuthenticationProviders()

◆ normalizeUsername()

◆ providerArrayFromSpecs()

◆ removeAuthenticationSessionData()

◆ resetCache()

◆ revokeAccessForUser()

◆ securitySensitiveOperationStatus()

◆ setAuthenticationSessionData()

◆ setDefaultUserOptions()

◆ setLogger()

◆ setSessionDataForUser()

◆ singleton()

◆ userCanAuthenticate()

◆ userExists()

Member Data Documentation

◆ $allAuthenticationProviders

◆ $config

◆ $createdAccountAuthenticationRequests

◆ $instance

◆ $logger

◆ $preAuthenticationProviders

◆ $primaryAuthenticationProviders

◆ $request

◆ $secondaryAuthenticationProviders

◆ ACTION_CHANGE

◆ ACTION_CREATE

◆ ACTION_CREATE_CONTINUE

◆ ACTION_LINK

◆ ACTION_LINK_CONTINUE

◆ ACTION_LOGIN

◆ ACTION_LOGIN_CONTINUE

◆ ACTION_REMOVE

◆ ACTION_UNLINK

◆ AUTOCREATE_SOURCE_SESSION

◆ SEC_FAIL

◆ SEC_OK

◆ SEC_REAUTH