Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F581497
AuthManager.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
107 KB
Referenced Files
None
Subscribers
None
AuthManager.php
View Options
<?php
/**
* @license GPL-2.0-or-later
* @file
*/
namespace
MediaWiki\Auth
;
use
InvalidArgumentException
;
use
LogicException
;
use
MediaWiki\Auth\Hook\AuthManagerVerifyAuthenticationHook
;
use
MediaWiki\Block\AbstractBlock
;
use
MediaWiki\Block\BlockManager
;
use
MediaWiki\Config\Config
;
use
MediaWiki\Context\RequestContext
;
use
MediaWiki\Deferred\DeferredUpdates
;
use
MediaWiki\Deferred\SiteStatsUpdate
;
use
MediaWiki\Exception\MWExceptionHandler
;
use
MediaWiki\HookContainer\HookContainer
;
use
MediaWiki\HookContainer\HookRunner
;
use
MediaWiki\Language\Language
;
use
MediaWiki\Languages\LanguageConverterFactory
;
use
MediaWiki\Logging\ManualLogEntry
;
use
MediaWiki\MainConfigNames
;
use
MediaWiki\MediaWikiServices
;
use
MediaWiki\Notification\NotificationService
;
use
MediaWiki\Notification\RecipientSet
;
use
MediaWiki\Page\PageIdentity
;
use
MediaWiki\Permissions\Authority
;
use
MediaWiki\Permissions\PermissionStatus
;
use
MediaWiki\Request\WebRequest
;
use
MediaWiki\Session\SessionManager
;
use
MediaWiki\Session\SessionManagerInterface
;
use
MediaWiki\SpecialPage\SpecialPage
;
use
MediaWiki\Status\Status
;
use
MediaWiki\StubObject\StubGlobalUser
;
use
MediaWiki\User\BotPasswordStore
;
use
MediaWiki\User\Options\UserOptionsManager
;
use
MediaWiki\User\TempUser\TempUserCreator
;
use
MediaWiki\User\User
;
use
MediaWiki\User\UserFactory
;
use
MediaWiki\User\UserIdentity
;
use
MediaWiki\User\UserIdentityLookup
;
use
MediaWiki\User\UserNameUtils
;
use
MediaWiki\User\UserRigorOptions
;
use
MediaWiki\User\WelcomeNotification
;
use
MediaWiki\Watchlist\WatchlistManager
;
use
Profiler
;
use
Psr\Log\LoggerAwareInterface
;
use
Psr\Log\LoggerInterface
;
use
Psr\Log\NullLogger
;
use
StatusValue
;
use
Wikimedia\NormalizedException\NormalizedException
;
use
Wikimedia\ObjectFactory\ObjectFactory
;
use
Wikimedia\Rdbms\IDBAccessObject
;
use
Wikimedia\Rdbms\ILoadBalancer
;
use
Wikimedia\Rdbms\ReadOnlyMode
;
/**
* AuthManager is the authentication system in MediaWiki and serves entry point for authentication.
*
* 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()). The same functionality can also be used
* from Maintenance scripts such as createAndPromote.php.
* 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.
*
* @ingroup Auth
* @since 1.27
* @see https://www.mediawiki.org/wiki/Manual:SessionManager_and_AuthManager
*/
class
AuthManager
implements
LoggerAwareInterface
{
/**
* @internal
* Key in the user's session data for storing login state.
*/
public
const
AUTHN_STATE
=
'AuthManager::authnState'
;
/**
* @internal
* Key in the user's session data for storing account creation state.
*/
public
const
ACCOUNT_CREATION_STATE
=
'AuthManager::accountCreationState'
;
/**
* @internal
* Key in the user's session data for storing account linking state.
*/
public
const
ACCOUNT_LINK_STATE
=
'AuthManager::accountLinkState'
;
/**
* @internal
* Key in the user's session data for storing autocreation failures,
* to avoid re-attempting expensive autocreation checks on every request.
*/
public
const
AUTOCREATE_BLOCKLIST
=
'AuthManager::AutoCreateBlacklist'
;
/** Log in with an existing (not necessarily local) user */
public
const
ACTION_LOGIN
=
'login'
;
/** Continue a login process that was interrupted by the need for user input or communication
* with an external provider
*/
public
const
ACTION_LOGIN_CONTINUE
=
'login-continue'
;
/** Create a new user */
public
const
ACTION_CREATE
=
'create'
;
/** Continue a user creation process that was interrupted by the need for user input or
* communication with an external provider
*/
public
const
ACTION_CREATE_CONTINUE
=
'create-continue'
;
/** Link an existing user to a third-party account */
public
const
ACTION_LINK
=
'link'
;
/** Continue a user linking process that was interrupted by the need for user input or
* communication with an external provider
*/
public
const
ACTION_LINK_CONTINUE
=
'link-continue'
;
/** Change a user's credentials */
public
const
ACTION_CHANGE
=
'change'
;
/** Remove a user's credentials */
public
const
ACTION_REMOVE
=
'remove'
;
/** Like ACTION_REMOVE but for linking providers only */
public
const
ACTION_UNLINK
=
'unlink'
;
/** Security-sensitive operations are ok. */
public
const
SEC_OK
=
'ok'
;
/** Security-sensitive operations should re-authenticate. */
public
const
SEC_REAUTH
=
'reauth'
;
/** Security-sensitive should not be performed. */
public
const
SEC_FAIL
=
'fail'
;
/** Auto-creation is due to SessionManager */
public
const
AUTOCREATE_SOURCE_SESSION
=
SessionManager
::
class
;
/** Auto-creation is due to a Maintenance script */
public
const
AUTOCREATE_SOURCE_MAINT
=
'::Maintenance::'
;
/** Auto-creation is due to temporary account creation on page save */
public
const
AUTOCREATE_SOURCE_TEMP
=
TempUserCreator
::
class
;
/**
* @internal To be used by primary authentication providers only.
* @var string "Remember me" status flag shared between auth providers
*/
public
const
REMEMBER_ME
=
'rememberMe'
;
/**
* @internal To be used by primary authentication providers only.
* @var string Primary providers can set this to false after login to prevent the
* login from being considered user interaction. This is important for some security
* features which generally interpret a recent login as proof of account ownership
* (vs. a stolen session).
*/
public
const
LOGIN_WAS_INTERACTIVE
=
'loginWasInteractive'
;
/** Call pre-authentication providers */
private
const
CALL_PRE
=
1
;
/** Call primary authentication providers */
private
const
CALL_PRIMARY
=
2
;
/** Call secondary authentication providers */
private
const
CALL_SECONDARY
=
4
;
/** Call all authentication providers */
private
const
CALL_ALL
=
self
::
CALL_PRE
|
self
::
CALL_PRIMARY
|
self
::
CALL_SECONDARY
;
/** @var AuthenticationProvider[] */
private
$allAuthenticationProviders
=
[];
/** @var PreAuthenticationProvider[] */
private
$preAuthenticationProviders
=
null
;
/** @var PrimaryAuthenticationProvider[] */
private
$primaryAuthenticationProviders
=
null
;
/** @var SecondaryAuthenticationProvider[] */
private
$secondaryAuthenticationProviders
=
null
;
/** @var CreatedAccountAuthenticationRequest[] */
private
$createdAccountAuthenticationRequests
=
[];
private
WebRequest
$request
;
private
Config
$config
;
private
ObjectFactory
$objectFactory
;
private
LoggerInterface
$logger
;
private
UserNameUtils
$userNameUtils
;
private
HookContainer
$hookContainer
;
private
HookRunner
$hookRunner
;
private
ReadOnlyMode
$readOnlyMode
;
private
BlockManager
$blockManager
;
private
WatchlistManager
$watchlistManager
;
private
ILoadBalancer
$loadBalancer
;
private
Language
$contentLanguage
;
private
LanguageConverterFactory
$languageConverterFactory
;
private
BotPasswordStore
$botPasswordStore
;
private
UserFactory
$userFactory
;
private
UserIdentityLookup
$userIdentityLookup
;
private
UserOptionsManager
$userOptionsManager
;
private
NotificationService
$notificationService
;
private
SessionManagerInterface
$sessionManager
;
public
function
__construct
(
WebRequest
$request
,
Config
$config
,
ObjectFactory
$objectFactory
,
HookContainer
$hookContainer
,
ReadOnlyMode
$readOnlyMode
,
UserNameUtils
$userNameUtils
,
BlockManager
$blockManager
,
WatchlistManager
$watchlistManager
,
ILoadBalancer
$loadBalancer
,
Language
$contentLanguage
,
LanguageConverterFactory
$languageConverterFactory
,
BotPasswordStore
$botPasswordStore
,
UserFactory
$userFactory
,
UserIdentityLookup
$userIdentityLookup
,
UserOptionsManager
$userOptionsManager
,
NotificationService
$notificationService
,
SessionManagerInterface
$sessionManager
)
{
$this
->
request
=
$request
;
$this
->
config
=
$config
;
$this
->
objectFactory
=
$objectFactory
;
$this
->
hookContainer
=
$hookContainer
;
$this
->
hookRunner
=
new
HookRunner
(
$hookContainer
);
$this
->
setLogger
(
new
NullLogger
()
);
$this
->
readOnlyMode
=
$readOnlyMode
;
$this
->
userNameUtils
=
$userNameUtils
;
$this
->
blockManager
=
$blockManager
;
$this
->
watchlistManager
=
$watchlistManager
;
$this
->
loadBalancer
=
$loadBalancer
;
$this
->
contentLanguage
=
$contentLanguage
;
$this
->
languageConverterFactory
=
$languageConverterFactory
;
$this
->
botPasswordStore
=
$botPasswordStore
;
$this
->
userFactory
=
$userFactory
;
$this
->
userIdentityLookup
=
$userIdentityLookup
;
$this
->
userOptionsManager
=
$userOptionsManager
;
$this
->
notificationService
=
$notificationService
;
$this
->
sessionManager
=
$sessionManager
;
}
public
function
setLogger
(
LoggerInterface
$logger
):
void
{
$this
->
logger
=
$logger
;
}
/**
* @return WebRequest
*/
public
function
getRequest
()
{
return
$this
->
request
;
}
/***************************************************************************/
// region Authentication
/** @name Authentication */
/**
* 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.
*
* @return bool
*/
public
function
canAuthenticateNow
()
{
return
$this
->
request
->
getSession
()->
canSetUser
();
}
/**
* 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.
*
* @param AuthenticationRequest[] $reqs
* @param string $returnToUrl Url that REDIRECT responses should eventually
* return to.
* @return AuthenticationResponse See self::continueAuthentication()
*/
public
function
beginAuthentication
(
array
$reqs
,
$returnToUrl
)
{
$session
=
$this
->
request
->
getSession
();
if
(
!
$session
->
canSetUser
()
)
{
// Caller should have called canAuthenticateNow()
$session
->
remove
(
self
::
AUTHN_STATE
);
throw
new
LogicException
(
'Authentication is not possible now'
);
}
$guessUserName
=
null
;
foreach
(
$reqs
as
$req
)
{
$req
->
returnToUrl
=
$returnToUrl
;
// @codeCoverageIgnoreStart
if
(
$req
->
username
!==
null
&&
$req
->
username
!==
''
)
{
if
(
$guessUserName
===
null
)
{
$guessUserName
=
$req
->
username
;
}
elseif
(
$guessUserName
!==
$req
->
username
)
{
$guessUserName
=
null
;
break
;
}
}
// @codeCoverageIgnoreEnd
}
// Check for special-case login of a just-created account
$req
=
AuthenticationRequest
::
getRequestByClass
(
$reqs
,
CreatedAccountAuthenticationRequest
::
class
);
if
(
$req
)
{
if
(
!
in_array
(
$req
,
$this
->
createdAccountAuthenticationRequests
,
true
)
)
{
throw
new
LogicException
(
'CreatedAccountAuthenticationRequests are only valid on '
.
'the same AuthManager that created the account'
);
}
$user
=
$this
->
userFactory
->
newFromName
(
(
string
)
$req
->
username
);
// @codeCoverageIgnoreStart
if
(
!
$user
)
{
throw
new
\UnexpectedValueException
(
"CreatedAccountAuthenticationRequest had invalid username
\"
{$req->username}
\"
"
);
}
elseif
(
$user
->
getId
()
!=
$req
->
id
)
{
throw
new
\UnexpectedValueException
(
"ID for
\"
{$req->username}
\"
was {$user->getId()}, expected {$req->id}"
);
}
// @codeCoverageIgnoreEnd
$this
->
logger
->
info
(
'Logging in {user} after account creation'
,
[
'user'
=>
$user
->
getName
(),
]
);
$ret
=
AuthenticationResponse
::
newPass
(
$user
->
getName
()
);
$performer
=
$session
->
getUser
();
$this
->
setSessionDataForUser
(
$user
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$user
,
$ret
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
$this
->
getHookRunner
()->
onAuthManagerLoginAuthenticateAudit
(
$ret
,
$user
,
$user
->
getName
(),
[
'performer'
=>
$performer
]
);
return
$ret
;
}
$this
->
removeAuthenticationSessionData
(
null
);
foreach
(
$this
->
getPreAuthenticationProviders
()
as
$provider
)
{
$status
=
$provider
->
testForAuthentication
(
$reqs
);
if
(
!
$status
->
isGood
()
)
{
$this
->
logger
->
debug
(
'Login failed in pre-authentication by {providerUniqueId}'
,
[
'providerUniqueId'
=>
$provider
->
getUniqueId
(),
]
);
$ret
=
AuthenticationResponse
::
newFail
(
Status
::
wrap
(
$status
)->
getMessage
()
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$this
->
userFactory
->
newFromName
(
(
string
)
$guessUserName
),
$ret
]
);
$this
->
getHookRunner
()->
onAuthManagerLoginAuthenticateAudit
(
$ret
,
null
,
$guessUserName
,
[
'performer'
=>
$session
->
getUser
()
]
);
return
$ret
;
}
}
$state
=
[
'reqs'
=>
$reqs
,
'returnToUrl'
=>
$returnToUrl
,
'guessUserName'
=>
$guessUserName
,
'providerIds'
=>
$this
->
getProviderIds
(),
'primary'
=>
null
,
'primaryResponse'
=>
null
,
'secondary'
=>
[],
'maybeLink'
=>
[],
'continueRequests'
=>
[],
];
// Preserve state from a previous failed login
$req
=
AuthenticationRequest
::
getRequestByClass
(
$reqs
,
CreateFromLoginAuthenticationRequest
::
class
);
if
(
$req
)
{
$state
[
'maybeLink'
]
=
$req
->
maybeLink
;
}
$session
=
$this
->
request
->
getSession
();
$session
->
setSecret
(
self
::
AUTHN_STATE
,
$state
);
$session
->
persist
();
return
$this
->
continueAuthentication
(
$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.
*
* @param AuthenticationRequest[] $reqs
* @return AuthenticationResponse
*/
public
function
continueAuthentication
(
array
$reqs
)
{
$session
=
$this
->
request
->
getSession
();
try
{
if
(
!
$session
->
canSetUser
()
)
{
// Caller should have called canAuthenticateNow()
// @codeCoverageIgnoreStart
throw
new
LogicException
(
'Authentication is not possible now'
);
// @codeCoverageIgnoreEnd
}
$state
=
$session
->
getSecret
(
self
::
AUTHN_STATE
);
if
(
!
is_array
(
$state
)
)
{
return
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-authn-not-in-progress'
)
);
}
if
(
$state
[
'providerIds'
]
!==
$this
->
getProviderIds
()
)
{
// An inconsistent AuthManagerFilterProviders hook, or site configuration changed
// while the user was in the middle of authentication. The first is a bug, the
// second is rare but expected when deploying a config change. Try handle in a way
// that's useful for both cases.
// @codeCoverageIgnoreStart
MWExceptionHandler
::
logException
(
new
NormalizedException
(
'Authentication failed because of inconsistent provider array'
,
[
'old'
=>
json_encode
(
$state
[
'providerIds'
]
),
'new'
=>
json_encode
(
$this
->
getProviderIds
()
)
]
)
);
$response
=
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-authn-not-in-progress'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$this
->
userFactory
->
newFromName
(
(
string
)
$state
[
'guessUserName'
]
),
$response
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
return
$response
;
// @codeCoverageIgnoreEnd
}
$state
[
'continueRequests'
]
=
[];
$guessUserName
=
$state
[
'guessUserName'
];
foreach
(
$reqs
as
$req
)
{
$req
->
returnToUrl
=
$state
[
'returnToUrl'
];
}
// Step 1: Choose a primary authentication provider, and call it until it succeeds.
if
(
$state
[
'primary'
]
===
null
)
{
// We haven't picked a PrimaryAuthenticationProvider yet
// @codeCoverageIgnoreStart
$guessUserName
=
null
;
foreach
(
$reqs
as
$req
)
{
if
(
$req
->
username
!==
null
&&
$req
->
username
!==
''
)
{
if
(
$guessUserName
===
null
)
{
$guessUserName
=
$req
->
username
;
}
elseif
(
$guessUserName
!==
$req
->
username
)
{
$guessUserName
=
null
;
break
;
}
}
}
$state
[
'guessUserName'
]
=
$guessUserName
;
// @codeCoverageIgnoreEnd
$state
[
'reqs'
]
=
$reqs
;
foreach
(
$this
->
getPrimaryAuthenticationProviders
()
as
$id
=>
$provider
)
{
$res
=
$provider
->
beginPrimaryAuthentication
(
$reqs
);
switch
(
$res
->
status
)
{
case
AuthenticationResponse
::
PASS
:
$state
[
'primary'
]
=
$id
;
$state
[
'primaryResponse'
]
=
$res
;
$this
->
logger
->
debug
(
'Primary login with {id} succeeded'
,
[
'id'
=>
$id
,
]
);
break
2
;
case
AuthenticationResponse
::
FAIL
:
$this
->
logger
->
debug
(
'Login failed in primary authentication by {id}'
,
[
'id'
=>
$id
,
]
);
if
(
$res
->
createRequest
||
$state
[
'maybeLink'
]
)
{
$res
->
createRequest
=
new
CreateFromLoginAuthenticationRequest
(
$res
->
createRequest
,
$state
[
'maybeLink'
]
);
}
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$this
->
userFactory
->
newFromName
(
(
string
)
$guessUserName
),
$res
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
$this
->
getHookRunner
()->
onAuthManagerLoginAuthenticateAudit
(
$res
,
null
,
$guessUserName
,
[
'performer'
=>
$session
->
getUser
()
]
);
return
$res
;
case
AuthenticationResponse
::
ABSTAIN
:
// Continue loop
break
;
case
AuthenticationResponse
::
REDIRECT
:
case
AuthenticationResponse
::
UI
:
$this
->
logger
->
debug
(
'Primary login with {id} returned {status}'
,
[
'id'
=>
$id
,
'status'
=>
$res
->
status
,
]
);
$this
->
fillRequests
(
$res
->
neededRequests
,
self
::
ACTION_LOGIN
,
$guessUserName
);
$state
[
'primary'
]
=
$id
;
$state
[
'continueRequests'
]
=
$res
->
neededRequests
;
$session
->
setSecret
(
self
::
AUTHN_STATE
,
$state
);
return
$res
;
// @codeCoverageIgnoreStart
default
:
throw
new
\DomainException
(
get_class
(
$provider
)
.
"::beginPrimaryAuthentication() returned $res->status"
);
// @codeCoverageIgnoreEnd
}
}
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset Always set in loop before, if passed
if
(
$state
[
'primary'
]
===
null
)
{
$this
->
logger
->
debug
(
'Login failed in primary authentication because no provider accepted'
);
$response
=
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-authn-no-primary'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$this
->
userFactory
->
newFromName
(
(
string
)
$guessUserName
),
$response
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
return
$response
;
}
}
elseif
(
$state
[
'primaryResponse'
]
===
null
)
{
$provider
=
$this
->
getAuthenticationProvider
(
$state
[
'primary'
]
);
if
(
!
$provider
instanceof
PrimaryAuthenticationProvider
)
{
// Configuration changed? Force them to start over.
// @codeCoverageIgnoreStart
$response
=
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-authn-not-in-progress'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$this
->
userFactory
->
newFromName
(
(
string
)
$guessUserName
),
$response
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
return
$response
;
// @codeCoverageIgnoreEnd
}
$id
=
$provider
->
getUniqueId
();
$res
=
$provider
->
continuePrimaryAuthentication
(
$reqs
);
switch
(
$res
->
status
)
{
case
AuthenticationResponse
::
PASS
:
$state
[
'primaryResponse'
]
=
$res
;
$this
->
logger
->
debug
(
'Primary login with {id} succeeded'
,
[
'id'
=>
$id
,
]
);
break
;
case
AuthenticationResponse
::
FAIL
:
$this
->
logger
->
debug
(
'Login failed in primary authentication by {id}'
,
[
'id'
=>
$id
,
]
);
if
(
$res
->
createRequest
||
$state
[
'maybeLink'
]
)
{
$res
->
createRequest
=
new
CreateFromLoginAuthenticationRequest
(
$res
->
createRequest
,
$state
[
'maybeLink'
]
);
}
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$this
->
userFactory
->
newFromName
(
(
string
)
$guessUserName
),
$res
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
$this
->
getHookRunner
()->
onAuthManagerLoginAuthenticateAudit
(
$res
,
null
,
$guessUserName
,
[
'performer'
=>
$session
->
getUser
()
]
);
return
$res
;
case
AuthenticationResponse
::
REDIRECT
:
case
AuthenticationResponse
::
UI
:
$this
->
logger
->
debug
(
'Primary login with {id} returned {status}'
,
[
'id'
=>
$id
,
'status'
=>
$res
->
status
,
]
);
$this
->
fillRequests
(
$res
->
neededRequests
,
self
::
ACTION_LOGIN
,
$guessUserName
);
$state
[
'continueRequests'
]
=
$res
->
neededRequests
;
$session
->
setSecret
(
self
::
AUTHN_STATE
,
$state
);
return
$res
;
default
:
throw
new
\DomainException
(
get_class
(
$provider
)
.
"::continuePrimaryAuthentication() returned $res->status"
);
}
}
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset Always set in loop before, if passed
$res
=
$state
[
'primaryResponse'
];
if
(
$res
->
username
===
null
)
{
$provider
=
$this
->
getAuthenticationProvider
(
$state
[
'primary'
]
);
if
(
!
$provider
instanceof
PrimaryAuthenticationProvider
)
{
// Configuration changed? Force them to start over.
// @codeCoverageIgnoreStart
$response
=
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-authn-not-in-progress'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$this
->
userFactory
->
newFromName
(
(
string
)
$guessUserName
),
$response
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
return
$response
;
// @codeCoverageIgnoreEnd
}
if
(
$provider
->
accountCreationType
()
===
PrimaryAuthenticationProvider
::
TYPE_LINK
&&
$res
->
linkRequest
&&
// don't confuse the user with an incorrect message if linking is disabled
$this
->
getAuthenticationProvider
(
ConfirmLinkSecondaryAuthenticationProvider
::
class
)
)
{
$state
[
'maybeLink'
][
$res
->
linkRequest
->
getUniqueId
()]
=
$res
->
linkRequest
;
$msg
=
'authmanager-authn-no-local-user-link'
;
}
else
{
$msg
=
'authmanager-authn-no-local-user'
;
}
$this
->
logger
->
debug
(
'Primary login with {providerUniqueId} succeeded, but returned no user'
,
[
'providerUniqueId'
=>
$provider
->
getUniqueId
()
]
);
$response
=
AuthenticationResponse
::
newRestart
(
wfMessage
(
$msg
)
);
$response
->
neededRequests
=
$this
->
getAuthenticationRequestsInternal
(
self
::
ACTION_LOGIN
,
[],
$this
->
getPrimaryAuthenticationProviders
()
+
$this
->
getSecondaryAuthenticationProviders
()
);
if
(
$res
->
createRequest
||
$state
[
'maybeLink'
]
)
{
$response
->
createRequest
=
new
CreateFromLoginAuthenticationRequest
(
$res
->
createRequest
,
$state
[
'maybeLink'
]
);
$response
->
neededRequests
[]
=
$response
->
createRequest
;
}
$this
->
fillRequests
(
$response
->
neededRequests
,
self
::
ACTION_LOGIN
,
null
,
true
);
$session
->
setSecret
(
self
::
AUTHN_STATE
,
[
'reqs'
=>
[],
// Will be filled in later
'primary'
=>
null
,
'primaryResponse'
=>
null
,
'secondary'
=>
[],
'continueRequests'
=>
$response
->
neededRequests
,
]
+
$state
);
// Give the AuthManagerVerifyAuthentication hook a chance to interrupt - even though
// RESTART does not immediately result in a successful login, the response and session
// state can hold information identifying a (remote) user, and that could be turned
// into access to that user's account in a follow-up request.
if
(
!
$this
->
runVerifyHook
(
self
::
ACTION_LOGIN
,
null
,
$response
,
$state
[
'primary'
]
)
)
{
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
null
,
$response
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
$this
->
getHookRunner
()->
onAuthManagerLoginAuthenticateAudit
(
$response
,
null
,
null
,
[
'performer'
=>
$session
->
getUser
()
]
);
return
$response
;
}
return
$response
;
}
// Step 2: Primary authentication succeeded, create the User object
// (and add the user locally if necessary)
$user
=
$this
->
userFactory
->
newFromName
(
(
string
)
$res
->
username
,
UserRigorOptions
::
RIGOR_USABLE
);
if
(
!
$user
)
{
$provider
=
$this
->
getAuthenticationProvider
(
$state
[
'primary'
]
);
throw
new
\DomainException
(
get_class
(
$provider
)
.
" returned an invalid username: {$res->username}"
);
}
if
(
!
$user
->
isRegistered
()
)
{
// User doesn't exist locally. Create it.
$this
->
logger
->
info
(
'Auto-creating {user} on login'
,
[
'user'
=>
$user
->
getName
(),
]
);
// Also use $user as performer, because the performer will be used for permission
// checks and global rights extensions might add rights based on the username,
// even if the user doesn't exist at this point.
$status
=
$this
->
autoCreateUser
(
$user
,
$state
[
'primary'
],
false
,
true
,
$user
);
if
(
!
$status
->
isGood
()
)
{
$response
=
AuthenticationResponse
::
newFail
(
Status
::
wrap
(
$status
)->
getMessage
(
'authmanager-authn-autocreate-failed'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$user
,
$response
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
// T390051: Don't use the $user provided to ::autoCreateUser for the "user being authenticated
// against" for the user provided in the AuthManagerLoginAuthenticateAudit hook run, as
// ::autoCreateUser may reset $user to an anon user.
$userForHook
=
$this
->
userFactory
->
newFromName
(
(
string
)
$res
->
username
,
UserRigorOptions
::
RIGOR_USABLE
);
$this
->
getHookRunner
()->
onAuthManagerLoginAuthenticateAudit
(
$response
,
$userForHook
,
$userForHook
->
getName
(),
[
'performer'
=>
$session
->
getUser
()
]
);
return
$response
;
}
}
// Step 3: Iterate over all the secondary authentication providers.
$beginReqs
=
$state
[
'reqs'
];
foreach
(
$this
->
getSecondaryAuthenticationProviders
()
as
$id
=>
$provider
)
{
if
(
!
isset
(
$state
[
'secondary'
][
$id
]
)
)
{
// This provider isn't started yet, so we pass it the set
// of reqs from beginAuthentication instead of whatever
// might have been used by a previous provider in line.
$func
=
'beginSecondaryAuthentication'
;
$res
=
$provider
->
beginSecondaryAuthentication
(
$user
,
$beginReqs
);
}
elseif
(
!
$state
[
'secondary'
][
$id
]
)
{
$func
=
'continueSecondaryAuthentication'
;
$res
=
$provider
->
continueSecondaryAuthentication
(
$user
,
$reqs
);
}
else
{
continue
;
}
switch
(
$res
->
status
)
{
case
AuthenticationResponse
::
PASS
:
$this
->
logger
->
debug
(
'Secondary login with {id} succeeded'
,
[
'id'
=>
$id
,
]
);
// fall through
case
AuthenticationResponse
::
ABSTAIN
:
$state
[
'secondary'
][
$id
]
=
true
;
break
;
case
AuthenticationResponse
::
FAIL
:
$this
->
logger
->
debug
(
'Login failed in secondary authentication by {id}'
,
[
'id'
=>
$id
,
]
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$user
,
$res
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
$this
->
getHookRunner
()->
onAuthManagerLoginAuthenticateAudit
(
$res
,
$user
,
$user
->
getName
(),
[
'performer'
=>
$session
->
getUser
()
]
);
return
$res
;
case
AuthenticationResponse
::
REDIRECT
:
case
AuthenticationResponse
::
UI
:
$this
->
logger
->
debug
(
'Secondary login with {id} returned {status}'
,
[
'id'
=>
$id
,
'status'
=>
$res
->
status
,
]
);
$this
->
fillRequests
(
$res
->
neededRequests
,
self
::
ACTION_LOGIN
,
$user
->
getName
()
);
$state
[
'secondary'
][
$id
]
=
false
;
$state
[
'continueRequests'
]
=
$res
->
neededRequests
;
$session
->
setSecret
(
self
::
AUTHN_STATE
,
$state
);
return
$res
;
// @codeCoverageIgnoreStart
default
:
throw
new
\DomainException
(
get_class
(
$provider
)
.
"::{$func}() returned $res->status"
);
// @codeCoverageIgnoreEnd
}
}
// Step 4: Authentication complete! Give hook handlers a chance to interrupt, then
// set the user in the session and clean up.
$response
=
AuthenticationResponse
::
newPass
(
$user
->
getName
()
);
if
(
!
$this
->
runVerifyHook
(
self
::
ACTION_LOGIN
,
$user
,
$response
,
$state
[
'primary'
]
)
)
{
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$user
,
$response
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
$this
->
getHookRunner
()->
onAuthManagerLoginAuthenticateAudit
(
$response
,
$user
,
$user
->
getName
(),
[
'performer'
=>
$session
->
getUser
(),
]
);
return
$response
;
}
$this
->
logger
->
info
(
'Login for {user} succeeded from {clientIp}'
,
$this
->
request
->
getSecurityLogContext
(
$user
)
);
$rememberMeConfig
=
$this
->
config
->
get
(
MainConfigNames
::
RememberMe
);
if
(
$rememberMeConfig
===
RememberMeAuthenticationRequest
::
ALWAYS_REMEMBER
)
{
$rememberMe
=
true
;
}
elseif
(
$rememberMeConfig
===
RememberMeAuthenticationRequest
::
NEVER_REMEMBER
)
{
$rememberMe
=
false
;
}
else
{
/** @var RememberMeAuthenticationRequest $req */
$req
=
AuthenticationRequest
::
getRequestByClass
(
$beginReqs
,
RememberMeAuthenticationRequest
::
class
);
// T369668: Before we conclude, let's make sure the user hasn't specified
// that they want their login remembered elsewhere like in the central domain.
// If the user clicked "remember me" in the central domain, then we should
// prioritise that when we call continuePrimaryAuthentication() in the provider
// that makes calls continuePrimaryAuthentication(). NOTE: It is the responsibility
// of the provider to refresh the "remember me" state that will be applied to
// the local wiki.
$rememberMe
=
(
$req
&&
$req
->
rememberMe
)
||
$this
->
getAuthenticationSessionData
(
self
::
REMEMBER_ME
);
}
$loginWasInteractive
=
$this
->
getAuthenticationSessionData
(
self
::
LOGIN_WAS_INTERACTIVE
,
true
);
$performer
=
$session
->
getUser
();
// If the session is associated with a temporary account user, invalidate its
// session and remove the TempUser:name property from the session
// This is necessary in order to ensure that the temporary account session is exited
// when the user transitions to a logged-in named account
if
(
$session
->
getUser
()->
isTemp
()
)
{
$this
->
sessionManager
->
invalidateSessionsForUser
(
$session
->
getUser
()
);
$session
->
remove
(
'TempUser:name'
);
$performer
=
new
User
();
}
$this
->
setSessionDataForUser
(
$user
,
$rememberMe
,
$loginWasInteractive
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAuthentication'
,
[
$user
,
$response
]
);
$session
->
remove
(
self
::
AUTHN_STATE
);
$this
->
removeAuthenticationSessionData
(
null
);
$this
->
getHookRunner
()->
onAuthManagerLoginAuthenticateAudit
(
$response
,
$user
,
$user
->
getName
(),
[
'performer'
=>
$performer
]
);
return
$response
;
}
catch
(
\Exception
$ex
)
{
$session
->
remove
(
self
::
AUTHN_STATE
);
throw
$ex
;
}
}
/**
* 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.
*
* @param string $operation Operation being checked. This should be a
* message-key-like string such as 'change-password' or 'change-email'.
* @return string One of the SEC_* constants.
*/
public
function
securitySensitiveOperationStatus
(
$operation
)
{
$status
=
self
::
SEC_OK
;
$this
->
logger
->
debug
(
__METHOD__
.
': Checking {operation}'
,
[
'operation'
=>
$operation
,
]
);
$session
=
$this
->
request
->
getSession
();
$aId
=
$session
->
getUser
()->
getId
();
if
(
$aId
===
0
)
{
// User isn't authenticated. DWIM?
$status
=
$this
->
canAuthenticateNow
()
?
self
::
SEC_REAUTH
:
self
::
SEC_FAIL
;
$this
->
logger
->
info
(
__METHOD__
.
': Not logged in! {operation} is {status}'
,
[
'operation'
=>
$operation
,
'status'
=>
$status
,
]
);
return
$status
;
}
if
(
$session
->
canSetUser
()
)
{
$id
=
$session
->
get
(
'AuthManager:lastAuthId'
);
$last
=
$session
->
get
(
'AuthManager:lastAuthTimestamp'
);
if
(
$id
!==
$aId
||
$last
===
null
)
{
$timeSinceLogin
=
PHP_INT_MAX
;
// Forever ago
}
else
{
$timeSinceLogin
=
max
(
0
,
time
()
-
$last
);
}
$thresholds
=
$this
->
config
->
get
(
MainConfigNames
::
ReauthenticateTime
);
if
(
isset
(
$thresholds
[
$operation
]
)
)
{
$threshold
=
$thresholds
[
$operation
];
}
elseif
(
isset
(
$thresholds
[
'default'
]
)
)
{
$threshold
=
$thresholds
[
'default'
];
}
else
{
throw
new
\UnexpectedValueException
(
'$wgReauthenticateTime lacks a default'
);
}
if
(
$threshold
>=
0
&&
$timeSinceLogin
>
$threshold
)
{
$status
=
self
::
SEC_REAUTH
;
}
}
else
{
$timeSinceLogin
=
-
1
;
$pass
=
$this
->
config
->
get
(
MainConfigNames
::
AllowSecuritySensitiveOperationIfCannotReauthenticate
);
if
(
isset
(
$pass
[
$operation
]
)
)
{
$status
=
$pass
[
$operation
]
?
self
::
SEC_OK
:
self
::
SEC_FAIL
;
}
elseif
(
isset
(
$pass
[
'default'
]
)
)
{
$status
=
$pass
[
'default'
]
?
self
::
SEC_OK
:
self
::
SEC_FAIL
;
}
else
{
throw
new
\UnexpectedValueException
(
'$wgAllowSecuritySensitiveOperationIfCannotReauthenticate lacks a default'
);
}
}
$this
->
getHookRunner
()->
onSecuritySensitiveOperationStatus
(
$status
,
$operation
,
$session
,
$timeSinceLogin
);
// If authentication is not possible, downgrade from "REAUTH" to "FAIL".
if
(
!
$this
->
canAuthenticateNow
()
&&
$status
===
self
::
SEC_REAUTH
)
{
$status
=
self
::
SEC_FAIL
;
}
$this
->
logger
->
info
(
__METHOD__
.
': {operation} is {status} for {user}'
,
[
'operation'
=>
$operation
,
'status'
=>
$status
,
]
+
$this
->
getRequest
()->
getSecurityLogContext
(
$session
->
getUser
()
)
);
return
$status
;
}
/**
* 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.
*
* @param string $username MediaWiki username
* @return bool
*/
public
function
userCanAuthenticate
(
$username
)
{
foreach
(
$this
->
getPrimaryAuthenticationProviders
()
as
$provider
)
{
if
(
$provider
->
testUserCanAuthenticate
(
$username
)
)
{
return
true
;
}
}
return
false
;
}
/**
* 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).
*
* @param string $username
* @return string[]
*/
public
function
normalizeUsername
(
$username
)
{
$ret
=
[];
foreach
(
$this
->
getPrimaryAuthenticationProviders
()
as
$provider
)
{
$normalized
=
$provider
->
providerNormalizeUsername
(
$username
);
if
(
$normalized
!==
null
)
{
$ret
[
$normalized
]
=
true
;
}
}
return
array_keys
(
$ret
);
}
/**
* Call this method to set the request context user for the current request
* from the context session user.
*
* Useful in cases where we need to make sure that a MediaWiki request outputs
* correct context data for a user who has just been logged-in.
*
* The method will also update the global language variable based on the
* session's user's context language.
*
* This won't affect objects which already made a copy of the user or the
* context, so it shouldn't be relied on too heavily, but can help to make the
* UI more consistent after changing the user. Typically used after a successful
* AuthManager action that changed the session user (e.g.
* AuthManager::autoCreateUser() with the login flag set).
*/
public
function
setRequestContextUserFromSessionUser
():
void
{
$context
=
RequestContext
::
getMain
();
$user
=
$context
->
getRequest
()->
getSession
()->
getUser
();
StubGlobalUser
::
setUser
(
$user
);
$context
->
setUser
(
$user
);
// phpcs:ignore MediaWiki.Usage.ExtendClassUsage.FunctionVarUsage
global
$wgLang
;
// phpcs:ignore MediaWiki.Usage.ExtendClassUsage.FunctionVarUsage
$wgLang
=
$context
->
getLanguage
();
}
// endregion -- end of Authentication
/***************************************************************************/
// region Authentication data changing
/** @name Authentication data changing */
/**
* Revoke any authentication credentials for a user
*
* After this, the user should no longer be able to log in.
*
* @param string $username
*/
public
function
revokeAccessForUser
(
$username
)
{
$this
->
logger
->
info
(
'Revoking access for {user}'
,
[
'user'
=>
$username
,
]
);
$this
->
callMethodOnProviders
(
self
::
CALL_PRIMARY
|
self
::
CALL_SECONDARY
,
'providerRevokeAccessForUser'
,
[
$username
]
);
}
/**
* Validate a change of authentication data (e.g. passwords)
* @param AuthenticationRequest $req
* @param 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.
* @return Status
*/
public
function
allowsAuthenticationDataChange
(
AuthenticationRequest
$req
,
$checkData
=
true
)
{
$any
=
false
;
$providers
=
$this
->
getPrimaryAuthenticationProviders
()
+
$this
->
getSecondaryAuthenticationProviders
();
foreach
(
$providers
as
$provider
)
{
$status
=
$provider
->
providerAllowsAuthenticationDataChange
(
$req
,
$checkData
);
if
(
!
$status
->
isGood
()
)
{
// If status is not good because reset email password last attempt was within
// $wgPasswordReminderResendTime then return good status with throttled-mailpassword value;
// otherwise, return the $status wrapped.
return
$status
->
hasMessage
(
'throttled-mailpassword'
)
?
Status
::
newGood
(
'throttled-mailpassword'
)
:
Status
::
wrap
(
$status
);
}
$any
=
$any
||
$status
->
value
!==
'ignored'
;
}
if
(
!
$any
)
{
return
Status
::
newGood
(
'ignored'
)
->
warning
(
'authmanager-change-not-supported'
);
}
return
Status
::
newGood
();
}
/**
* 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.
*
* @param AuthenticationRequest $req
* @param bool $isAddition Set true if this represents an addition of
* credentials rather than a change. The main difference is that additions
* should not invalidate BotPasswords. If you're not sure, leave it false.
*/
public
function
changeAuthenticationData
(
AuthenticationRequest
$req
,
$isAddition
=
false
)
{
$this
->
logger
->
info
(
'Changing authentication data for {user} class {what}'
,
[
'user'
=>
is_string
(
$req
->
username
)
?
$req
->
username
:
'<no name>'
,
'what'
=>
get_class
(
$req
),
]
);
$this
->
callMethodOnProviders
(
self
::
CALL_PRIMARY
|
self
::
CALL_SECONDARY
,
'providerChangeAuthenticationData'
,
[
$req
]
);
// When the main account's authentication data is changed, invalidate
// all BotPasswords too.
if
(
!
$isAddition
)
{
$this
->
botPasswordStore
->
invalidateUserPasswords
(
(
string
)
$req
->
username
);
}
}
// endregion -- end of Authentication data changing
/***************************************************************************/
// region Account creation
/** @name Account creation */
/**
* Determine whether accounts can be created
* @return bool
*/
public
function
canCreateAccounts
()
{
foreach
(
$this
->
getPrimaryAuthenticationProviders
()
as
$provider
)
{
switch
(
$provider
->
accountCreationType
()
)
{
case
PrimaryAuthenticationProvider
::
TYPE_CREATE
:
case
PrimaryAuthenticationProvider
::
TYPE_LINK
:
return
true
;
}
}
return
false
;
}
/**
* Determine whether a particular account can be created
* @param string $username MediaWiki username
* @param array $options
* - flags: (int) Bitfield of IDBAccessObject::READ_* constants, default IDBAccessObject::READ_NORMAL
* - creating: (bool) For internal use only. Never specify this.
* @return Status
*/
public
function
canCreateAccount
(
$username
,
$options
=
[]
)
{
// Back compat
if
(
is_int
(
$options
)
)
{
$options
=
[
'flags'
=>
$options
];
}
$options
+=
[
'flags'
=>
IDBAccessObject
::
READ_NORMAL
,
'creating'
=>
false
,
];
$flags
=
$options
[
'flags'
];
if
(
!
$this
->
canCreateAccounts
()
)
{
return
Status
::
newFatal
(
'authmanager-create-disabled'
);
}
if
(
$this
->
userExists
(
$username
,
$flags
)
)
{
return
Status
::
newFatal
(
'userexists'
);
}
$user
=
$this
->
userFactory
->
newFromName
(
(
string
)
$username
,
UserRigorOptions
::
RIGOR_CREATABLE
);
if
(
!
is_object
(
$user
)
)
{
return
Status
::
newFatal
(
'noname'
);
}
else
{
$user
->
load
(
$flags
);
// Explicitly load with $flags, auto-loading always uses READ_NORMAL
if
(
$user
->
isRegistered
()
)
{
return
Status
::
newFatal
(
'userexists'
);
}
}
// Denied by providers?
$providers
=
$this
->
getPreAuthenticationProviders
()
+
$this
->
getPrimaryAuthenticationProviders
()
+
$this
->
getSecondaryAuthenticationProviders
();
foreach
(
$providers
as
$provider
)
{
$status
=
$provider
->
testUserForCreation
(
$user
,
false
,
$options
);
if
(
!
$status
->
isGood
()
)
{
return
Status
::
wrap
(
$status
);
}
}
return
Status
::
newGood
();
}
/**
* @param callable $authorizer ( string $action, PageIdentity $target, PermissionStatus $status )
* @param string $action
* @return StatusValue
*/
private
function
authorizeInternal
(
callable
$authorizer
,
string
$action
):
StatusValue
{
// Wiki is read-only?
if
(
$this
->
readOnlyMode
->
isReadOnly
()
)
{
return
StatusValue
::
newFatal
(
wfMessage
(
'readonlytext'
,
$this
->
readOnlyMode
->
getReason
()
)
);
}
$permStatus
=
new
PermissionStatus
();
if
(
!
$authorizer
(
$action
,
SpecialPage
::
getTitleFor
(
'CreateAccount'
),
$permStatus
)
)
{
return
$permStatus
;
}
$ip
=
$this
->
getRequest
()->
getIP
();
if
(
$this
->
blockManager
->
isDnsBlacklisted
(
$ip
,
true
/* check $wgProxyWhitelist */
)
)
{
return
StatusValue
::
newFatal
(
'sorbs_create_account_reason'
);
}
return
StatusValue
::
newGood
();
}
/**
* Check whether $creator can create accounts.
*
* @note this method does not guarantee full permissions check, so it should only
* be used to to decide whether to show a form. To authorize the account creation
* action use {@link self::authorizeCreateAccount} instead.
*
* @since 1.39
* @param Authority $creator
* @return StatusValue
*/
public
function
probablyCanCreateAccount
(
Authority
$creator
):
StatusValue
{
return
$this
->
authorizeInternal
(
static
function
(
string
$action
,
PageIdentity
$target
,
PermissionStatus
$status
)
use
(
$creator
)
{
return
$creator
->
probablyCan
(
$action
,
$target
,
$status
);
},
'createaccount'
);
}
/**
* Authorize the account creation by $creator
*
* @note this method should be used right before the account is created.
* To check whether a current performer has the potential to create accounts,
* use {@link self::probablyCanCreateAccount} instead.
*
* @since 1.39
* @param Authority $creator
* @return StatusValue
*/
public
function
authorizeCreateAccount
(
Authority
$creator
):
StatusValue
{
return
$this
->
authorizeInternal
(
static
function
(
string
$action
,
PageIdentity
$target
,
PermissionStatus
$status
)
use
(
$creator
)
{
return
$creator
->
authorizeWrite
(
$action
,
$target
,
$status
);
},
'createaccount'
);
}
/**
* 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
* <code>
* $createFromLoginAuthenticationRequest->hasPrimaryStateForAction( AuthManager::ACTION_CREATE )
* </code>
* 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.
*
* @param Authority $creator User doing the account creation
* @param AuthenticationRequest[] $reqs
* @param string $returnToUrl Url that REDIRECT responses should eventually
* return to.
* @return AuthenticationResponse
*/
public
function
beginAccountCreation
(
Authority
$creator
,
array
$reqs
,
$returnToUrl
)
{
$session
=
$this
->
request
->
getSession
();
if
(
$creator
->
isTemp
()
)
{
// For a temp account creating a permanent account, we do not want the temporary
// account to be associated with the created permanent account. To avoid this,
// invalidate their sessions, set the session user to a new anonymous user, save it,
// set the request context from the new session user account. (T393628)
$creatorUser
=
$this
->
userFactory
->
newFromUserIdentity
(
$creator
->
getUser
()
);
$this
->
sessionManager
->
invalidateSessionsForUser
(
$creatorUser
);
$creator
=
$this
->
userFactory
->
newAnonymous
();
$session
->
setUser
(
$creator
);
// Ensure the temporary account username is also cleared from the session, this is set
// in TempUserCreator::acquireAndStashName
$session
->
remove
(
'TempUser:name'
);
$session
->
save
();
$this
->
setRequestContextUserFromSessionUser
();
}
if
(
!
$this
->
canCreateAccounts
()
)
{
// Caller should have called canCreateAccounts()
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
throw
new
LogicException
(
'Account creation is not possible'
);
}
try
{
$username
=
AuthenticationRequest
::
getUsernameFromRequests
(
$reqs
);
}
catch
(
\UnexpectedValueException
)
{
$username
=
null
;
}
if
(
$username
===
null
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': No username provided'
);
return
AuthenticationResponse
::
newFail
(
wfMessage
(
'noname'
)
);
}
// Permissions check
$status
=
Status
::
wrap
(
$this
->
authorizeCreateAccount
(
$creator
)
);
if
(
!
$status
->
isGood
()
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': {creator} cannot create users: {reason}'
,
[
'user'
=>
$username
,
'creator'
=>
$creator
->
getUser
()->
getName
(),
'reason'
=>
$status
->
getWikiText
(
false
,
false
,
'en'
)
]
);
return
AuthenticationResponse
::
newFail
(
$status
->
getMessage
()
);
}
// Avoid deadlocks by placing no shared or exclusive gap locks (T199393)
// As defense in-depth, PrimaryAuthenticationProvider::testUserExists only
// supports READ_NORMAL/READ_LATEST (no support for recency query flags).
$status
=
$this
->
canCreateAccount
(
$username
,
[
'flags'
=>
IDBAccessObject
::
READ_LATEST
,
'creating'
=>
true
]
);
if
(
!
$status
->
isGood
()
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': {user} cannot be created: {reason}'
,
[
'user'
=>
$username
,
'creator'
=>
$creator
->
getUser
()->
getName
(),
'reason'
=>
$status
->
getWikiText
(
false
,
false
,
'en'
)
]
);
return
AuthenticationResponse
::
newFail
(
$status
->
getMessage
()
);
}
$user
=
$this
->
userFactory
->
newFromName
(
(
string
)
$username
,
UserRigorOptions
::
RIGOR_CREATABLE
);
foreach
(
$reqs
as
$req
)
{
$req
->
username
=
$username
;
$req
->
returnToUrl
=
$returnToUrl
;
if
(
$req
instanceof
UserDataAuthenticationRequest
)
{
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable user should be checked and valid here
$status
=
$req
->
populateUser
(
$user
);
if
(
!
$status
->
isGood
()
)
{
$status
=
Status
::
wrap
(
$status
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
$this
->
logger
->
debug
(
__METHOD__
.
': UserData is invalid: {reason}'
,
[
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getUser
()->
getName
(),
'reason'
=>
$status
->
getWikiText
(
false
,
false
,
'en'
),
]
);
return
AuthenticationResponse
::
newFail
(
$status
->
getMessage
()
);
}
}
}
$this
->
removeAuthenticationSessionData
(
null
);
$state
=
[
'username'
=>
$username
,
'userid'
=>
0
,
'creatorid'
=>
$creator
->
getUser
()->
getId
(),
'creatorname'
=>
$creator
->
getUser
()->
getName
(),
'reqs'
=>
$reqs
,
'returnToUrl'
=>
$returnToUrl
,
'providerIds'
=>
$this
->
getProviderIds
(),
'primary'
=>
null
,
'primaryResponse'
=>
null
,
'secondary'
=>
[],
'continueRequests'
=>
[],
'maybeLink'
=>
[],
'ranPreTests'
=>
false
,
];
// Special case: converting a login to an account creation
$req
=
AuthenticationRequest
::
getRequestByClass
(
$reqs
,
CreateFromLoginAuthenticationRequest
::
class
);
if
(
$req
)
{
$state
[
'maybeLink'
]
=
$req
->
maybeLink
;
if
(
$req
->
createRequest
)
{
$reqs
[]
=
$req
->
createRequest
;
$state
[
'reqs'
][]
=
$req
->
createRequest
;
}
}
$session
->
setSecret
(
self
::
ACCOUNT_CREATION_STATE
,
$state
);
$session
->
persist
();
$this
->
logger
->
debug
(
__METHOD__
.
': Proceeding with account creation for {username} by {creator}'
,
[
'username'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getUser
()->
getName
(),
]
);
return
$this
->
continueAccountCreation
(
$reqs
);
}
/**
* Continue an account creation flow
* @param AuthenticationRequest[] $reqs
* @return AuthenticationResponse
*/
public
function
continueAccountCreation
(
array
$reqs
)
{
$session
=
$this
->
request
->
getSession
();
try
{
if
(
!
$this
->
canCreateAccounts
()
)
{
// Caller should have called canCreateAccounts()
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
throw
new
LogicException
(
'Account creation is not possible'
);
}
$state
=
$session
->
getSecret
(
self
::
ACCOUNT_CREATION_STATE
);
if
(
!
is_array
(
$state
)
)
{
return
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-create-not-in-progress'
)
);
}
$state
[
'continueRequests'
]
=
[];
// Step 0: Prepare and validate the input
$user
=
$this
->
userFactory
->
newFromName
(
(
string
)
$state
[
'username'
],
UserRigorOptions
::
RIGOR_CREATABLE
);
if
(
!
is_object
(
$user
)
)
{
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
$this
->
logger
->
debug
(
__METHOD__
.
': Invalid username'
,
[
'user'
=>
$state
[
'username'
],
]
);
return
AuthenticationResponse
::
newFail
(
wfMessage
(
'noname'
)
);
}
if
(
$state
[
'creatorid'
]
)
{
$creator
=
$this
->
userFactory
->
newFromId
(
(
int
)
$state
[
'creatorid'
]
);
}
else
{
$creator
=
$this
->
userFactory
->
newAnonymous
();
$creator
->
setName
(
$state
[
'creatorname'
]
);
}
if
(
$state
[
'providerIds'
]
!==
$this
->
getProviderIds
()
)
{
// An inconsistent AuthManagerFilterProviders hook, or site configuration changed
// while the user was in the middle of authentication. The first is a bug, the
// second is rare but expected when deploying a config change. Try handle in a way
// that's useful for both cases.
// @codeCoverageIgnoreStart
MWExceptionHandler
::
logException
(
new
NormalizedException
(
'Authentication failed because of inconsistent provider array'
,
[
'old'
=>
json_encode
(
$state
[
'providerIds'
]
),
'new'
=>
json_encode
(
$this
->
getProviderIds
()
)
]
)
);
$ret
=
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-create-not-in-progress'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$ret
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
return
$ret
;
// @codeCoverageIgnoreEnd
}
// Avoid account creation races on double submissions
$cache
=
MediaWikiServices
::
getInstance
()->
getObjectCacheFactory
()->
getLocalClusterInstance
();
$lock
=
$cache
->
getScopedLock
(
$cache
->
makeGlobalKey
(
'account'
,
md5
(
$user
->
getName
()
)
)
);
if
(
!
$lock
)
{
// Don't clear AuthManager::accountCreationState for this code
// path because the process that won the race owns it.
$this
->
logger
->
debug
(
__METHOD__
.
': Could not acquire account creation lock'
,
[
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
return
AuthenticationResponse
::
newFail
(
wfMessage
(
'usernameinprogress'
)
);
}
// Permissions check
$status
=
Status
::
wrap
(
$this
->
authorizeCreateAccount
(
$creator
)
);
if
(
!
$status
->
isGood
()
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': {creator} cannot create users: {reason}'
,
[
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
'reason'
=>
$status
->
getWikiText
(
false
,
false
,
'en'
)
]
);
$ret
=
AuthenticationResponse
::
newFail
(
$status
->
getMessage
()
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$ret
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
return
$ret
;
}
// Load from primary DB for existence check
$user
->
load
(
IDBAccessObject
::
READ_LATEST
);
if
(
$state
[
'userid'
]
===
0
)
{
if
(
$user
->
isRegistered
()
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': User exists locally'
,
[
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$ret
=
AuthenticationResponse
::
newFail
(
wfMessage
(
'userexists'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$ret
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
return
$ret
;
}
}
else
{
if
(
!
$user
->
isRegistered
()
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': User does not exist locally when it should'
,
[
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
'expected_id'
=>
$state
[
'userid'
],
]
);
throw
new
\UnexpectedValueException
(
"User
\"
{$state['username']}
\"
should exist now, but doesn't!"
);
}
if
(
$user
->
getId
()
!==
$state
[
'userid'
]
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': User ID/name mismatch'
,
[
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
'expected_id'
=>
$state
[
'userid'
],
'actual_id'
=>
$user
->
getId
(),
]
);
throw
new
\UnexpectedValueException
(
"User
\"
{$state['username']}
\"
exists, but "
.
"ID {$user->getId()} !== {$state['userid']}!"
);
}
}
foreach
(
$state
[
'reqs'
]
as
$req
)
{
if
(
$req
instanceof
UserDataAuthenticationRequest
)
{
$status
=
$req
->
populateUser
(
$user
);
if
(
!
$status
->
isGood
()
)
{
// This should never happen...
$status
=
Status
::
wrap
(
$status
);
$this
->
logger
->
debug
(
__METHOD__
.
': UserData is invalid: {reason}'
,
[
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
'reason'
=>
$status
->
getWikiText
(
false
,
false
,
'en'
),
]
);
$ret
=
AuthenticationResponse
::
newFail
(
$status
->
getMessage
()
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$ret
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
return
$ret
;
}
}
}
foreach
(
$reqs
as
$req
)
{
$req
->
returnToUrl
=
$state
[
'returnToUrl'
];
$req
->
username
=
$state
[
'username'
];
}
// Run pre-creation tests, if we haven't already
if
(
!
$state
[
'ranPreTests'
]
)
{
$providers
=
$this
->
getPreAuthenticationProviders
()
+
$this
->
getPrimaryAuthenticationProviders
()
+
$this
->
getSecondaryAuthenticationProviders
();
foreach
(
$providers
as
$id
=>
$provider
)
{
$status
=
$provider
->
testForAccountCreation
(
$user
,
$creator
,
$reqs
);
if
(
!
$status
->
isGood
()
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': Fail in pre-authentication by {id}'
,
[
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$ret
=
AuthenticationResponse
::
newFail
(
Status
::
wrap
(
$status
)->
getMessage
()
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$ret
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
return
$ret
;
}
}
$state
[
'ranPreTests'
]
=
true
;
}
// Step 1: Choose a primary authentication provider and call it until it succeeds.
if
(
$state
[
'primary'
]
===
null
)
{
// We haven't picked a PrimaryAuthenticationProvider yet
foreach
(
$this
->
getPrimaryAuthenticationProviders
()
as
$id
=>
$provider
)
{
if
(
$provider
->
accountCreationType
()
===
PrimaryAuthenticationProvider
::
TYPE_NONE
)
{
continue
;
}
$res
=
$provider
->
beginPrimaryAccountCreation
(
$user
,
$creator
,
$reqs
);
switch
(
$res
->
status
)
{
case
AuthenticationResponse
::
PASS
:
$this
->
logger
->
debug
(
__METHOD__
.
': Primary creation passed by {id}'
,
[
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$state
[
'primary'
]
=
$id
;
$state
[
'primaryResponse'
]
=
$res
;
break
2
;
case
AuthenticationResponse
::
FAIL
:
$this
->
logger
->
debug
(
__METHOD__
.
': Primary creation failed by {id}'
,
[
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$res
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
return
$res
;
case
AuthenticationResponse
::
ABSTAIN
:
// Continue loop
break
;
case
AuthenticationResponse
::
REDIRECT
:
case
AuthenticationResponse
::
UI
:
$this
->
logger
->
debug
(
__METHOD__
.
': Primary creation {status} by {id}'
,
[
'status'
=>
$res
->
status
,
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$this
->
fillRequests
(
$res
->
neededRequests
,
self
::
ACTION_CREATE
,
null
);
$state
[
'primary'
]
=
$id
;
$state
[
'continueRequests'
]
=
$res
->
neededRequests
;
$session
->
setSecret
(
self
::
ACCOUNT_CREATION_STATE
,
$state
);
return
$res
;
// @codeCoverageIgnoreStart
default
:
throw
new
\DomainException
(
get_class
(
$provider
)
.
"::beginPrimaryAccountCreation() returned $res->status"
);
// @codeCoverageIgnoreEnd
}
}
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset Always set in loop before, if passed
if
(
$state
[
'primary'
]
===
null
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': Primary creation failed because no provider accepted'
,
[
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$ret
=
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-create-no-primary'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$ret
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
return
$ret
;
}
}
elseif
(
$state
[
'primaryResponse'
]
===
null
)
{
$provider
=
$this
->
getAuthenticationProvider
(
$state
[
'primary'
]
);
if
(
!
$provider
instanceof
PrimaryAuthenticationProvider
)
{
// Configuration changed? Force them to start over.
// @codeCoverageIgnoreStart
$ret
=
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-create-not-in-progress'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$ret
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
return
$ret
;
// @codeCoverageIgnoreEnd
}
$id
=
$provider
->
getUniqueId
();
$res
=
$provider
->
continuePrimaryAccountCreation
(
$user
,
$creator
,
$reqs
);
switch
(
$res
->
status
)
{
case
AuthenticationResponse
::
PASS
:
$this
->
logger
->
debug
(
__METHOD__
.
': Primary creation passed by {id}'
,
[
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$state
[
'primaryResponse'
]
=
$res
;
break
;
case
AuthenticationResponse
::
FAIL
:
$this
->
logger
->
debug
(
__METHOD__
.
': Primary creation failed by {id}'
,
[
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$res
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
return
$res
;
case
AuthenticationResponse
::
REDIRECT
:
case
AuthenticationResponse
::
UI
:
$this
->
logger
->
debug
(
__METHOD__
.
': Primary creation {status} by {id}'
,
[
'status'
=>
$res
->
status
,
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$this
->
fillRequests
(
$res
->
neededRequests
,
self
::
ACTION_CREATE
,
null
);
$state
[
'continueRequests'
]
=
$res
->
neededRequests
;
$session
->
setSecret
(
self
::
ACCOUNT_CREATION_STATE
,
$state
);
return
$res
;
default
:
throw
new
\DomainException
(
get_class
(
$provider
)
.
"::continuePrimaryAccountCreation() returned $res->status"
);
}
}
// Step 2: Primary authentication succeeded. Give hook handlers a chance to interrupt,
// then create the User object and add the user locally.
if
(
$state
[
'userid'
]
===
0
)
{
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset Always set if we passed step 1
$response
=
$state
[
'primaryResponse'
];
if
(
!
$this
->
runVerifyHook
(
self
::
ACTION_CREATE
,
$user
,
$response
,
$state
[
'primary'
]
)
)
{
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$response
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
return
$response
;
}
$this
->
logger
->
info
(
'Creating user {user} during account creation'
,
[
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$status
=
$user
->
addToDatabase
();
if
(
!
$status
->
isOK
()
)
{
// @codeCoverageIgnoreStart
$ret
=
AuthenticationResponse
::
newFail
(
$status
->
getMessage
()
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$ret
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
return
$ret
;
// @codeCoverageIgnoreEnd
}
$this
->
setDefaultUserOptions
(
$user
,
$creator
->
isAnon
()
);
$this
->
getHookRunner
()->
onLocalUserCreated
(
$user
,
false
);
$this
->
notificationService
->
notify
(
new
WelcomeNotification
(
$user
),
new
RecipientSet
(
[
$user
]
)
);
$user
->
saveSettings
();
$state
[
'userid'
]
=
$user
->
getId
();
// Update user count
DeferredUpdates
::
addUpdate
(
SiteStatsUpdate
::
factory
(
[
'users'
=>
1
]
)
);
// Watch user's userpage and talk page
$this
->
watchlistManager
->
addWatchIgnoringRights
(
$user
,
$user
->
getUserPage
()
);
// Inform the provider
// @phan-suppress-next-next-line PhanPossiblyUndeclaredVariable
// @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset Always set in loop before, if passed
$logSubtype
=
$provider
->
finishAccountCreation
(
$user
,
$creator
,
$state
[
'primaryResponse'
]
);
// Log the creation
if
(
$this
->
config
->
get
(
MainConfigNames
::
NewUserLog
)
)
{
$isNamed
=
$creator
->
isNamed
();
$logEntry
=
new
ManualLogEntry
(
'newusers'
,
$logSubtype
?:
(
$isNamed
?
'create2'
:
'create'
)
);
$logEntry
->
setPerformer
(
$isNamed
?
$creator
:
$user
);
$logEntry
->
setTarget
(
$user
->
getUserPage
()
);
/** @var CreationReasonAuthenticationRequest $req */
$req
=
AuthenticationRequest
::
getRequestByClass
(
$state
[
'reqs'
],
CreationReasonAuthenticationRequest
::
class
);
$logEntry
->
setComment
(
$req
?
$req
->
reason
:
''
);
$logEntry
->
setParameters
(
[
'4::userid'
=>
$user
->
getId
(),
]
);
$logid
=
$logEntry
->
insert
();
$logEntry
->
publish
(
$logid
);
}
}
// Step 3: Iterate over all the secondary authentication providers.
$beginReqs
=
$state
[
'reqs'
];
foreach
(
$this
->
getSecondaryAuthenticationProviders
()
as
$id
=>
$provider
)
{
if
(
!
isset
(
$state
[
'secondary'
][
$id
]
)
)
{
// This provider isn't started yet, so we pass it the set
// of reqs from beginAuthentication instead of whatever
// might have been used by a previous provider in line.
$func
=
'beginSecondaryAccountCreation'
;
$res
=
$provider
->
beginSecondaryAccountCreation
(
$user
,
$creator
,
$beginReqs
);
}
elseif
(
!
$state
[
'secondary'
][
$id
]
)
{
$func
=
'continueSecondaryAccountCreation'
;
$res
=
$provider
->
continueSecondaryAccountCreation
(
$user
,
$creator
,
$reqs
);
}
else
{
continue
;
}
switch
(
$res
->
status
)
{
case
AuthenticationResponse
::
PASS
:
$this
->
logger
->
debug
(
__METHOD__
.
': Secondary creation passed by {id}'
,
[
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
// fall through
case
AuthenticationResponse
::
ABSTAIN
:
$state
[
'secondary'
][
$id
]
=
true
;
break
;
case
AuthenticationResponse
::
REDIRECT
:
case
AuthenticationResponse
::
UI
:
$this
->
logger
->
debug
(
__METHOD__
.
': Secondary creation {status} by {id}'
,
[
'status'
=>
$res
->
status
,
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$this
->
fillRequests
(
$res
->
neededRequests
,
self
::
ACTION_CREATE
,
null
);
$state
[
'secondary'
][
$id
]
=
false
;
$state
[
'continueRequests'
]
=
$res
->
neededRequests
;
$session
->
setSecret
(
self
::
ACCOUNT_CREATION_STATE
,
$state
);
return
$res
;
case
AuthenticationResponse
::
FAIL
:
throw
new
\DomainException
(
get_class
(
$provider
)
.
"::{$func}() returned $res->status."
.
' Secondary providers are not allowed to fail account creation, that'
.
' should have been done via testForAccountCreation().'
);
// @codeCoverageIgnoreStart
default
:
throw
new
\DomainException
(
get_class
(
$provider
)
.
"::{$func}() returned $res->status"
);
// @codeCoverageIgnoreEnd
}
}
$id
=
$user
->
getId
();
$name
=
$user
->
getName
();
$req
=
new
CreatedAccountAuthenticationRequest
(
$id
,
$name
);
$ret
=
AuthenticationResponse
::
newPass
(
$name
);
$ret
->
loginRequest
=
$req
;
$this
->
createdAccountAuthenticationRequests
[]
=
$req
;
$this
->
logger
->
info
(
__METHOD__
.
': Account creation succeeded for {user}'
,
[
'user'
=>
$user
->
getName
(),
'creator'
=>
$creator
->
getName
(),
]
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$creator
,
$ret
]
);
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
$this
->
removeAuthenticationSessionData
(
null
);
return
$ret
;
}
catch
(
\Exception
$ex
)
{
$session
->
remove
(
self
::
ACCOUNT_CREATION_STATE
);
throw
$ex
;
}
}
/**
* @param Status $status
* @param User $targetUser
* @param string $source What caused the auto-creation, see {@link autoCreateUser}
* @param bool $login Whether to also log the user in
* @return void
* @todo Inject both identityUtils and logger
*/
private
function
logAutocreationAttempt
(
Status
$status
,
User
$targetUser
,
$source
,
$login
)
{
if
(
$status
->
isOK
()
&&
!
$status
->
isGood
()
)
{
return
;
// user already existed, no need to log
}
$firstMessage
=
$status
->
getMessages
(
'error'
)[
0
]
??
$status
->
getMessages
(
'warning'
)[
0
]
??
null
;
$identityUtils
=
MediaWikiServices
::
getInstance
()->
getUserIdentityUtils
();
\MediaWiki\Logger\LoggerFactory
::
getInstance
(
'authevents'
)->
info
(
'Autocreation attempt'
,
[
'event'
=>
'autocreate'
,
'successful'
=>
$status
->
isGood
(),
'status'
=>
$firstMessage
?
$firstMessage
->
getKey
()
:
'-'
,
'accountType'
=>
$identityUtils
->
getShortUserTypeInternal
(
$targetUser
),
'source'
=>
$source
,
'login'
=>
$login
,
]
);
}
/**
* Determine whether the attempted autocreation is of a temporary user from Special:MyTalk
* using a blocked IP that is allowed to edit their own talk page. This is a legitimate
* avenue to appeal a block, so allow temporary user creation in this situation.
*
* @param StatusValue $status
* @param string $source
* @param User $performer
* @return bool
*/
private
function
autocreatingTempUserToAppealBlock
(
StatusValue
$status
,
string
$source
,
User
$performer
):
bool
{
$block
=
$status
instanceof
PermissionStatus
?
$status
->
getBlock
()
:
null
;
if
(
!(
$block
instanceof
AbstractBlock
)
)
{
return
false
;
}
$title
=
RequestContext
::
getMain
()->
getTitle
();
return
$title
&&
$title
->
isSpecial
(
'Mytalk'
)
&&
$source
===
self
::
AUTOCREATE_SOURCE_TEMP
&&
$performer
->
isAnon
()
&&
count
(
$status
->
getErrors
()
)
===
1
&&
!
$block
->
appliesToUsertalk
(
$performer
->
getTalkPage
()
);
}
/**
* Auto-create an account, and optionally 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.
*
* @param User $user User to auto-create
* @param string $source What caused the auto-creation? This must be one of:
* - the ID of a PrimaryAuthenticationProvider,
* - one of the self::AUTOCREATE_SOURCE_* constants
* @param bool $login Whether to also log the user in
* @param bool $log Whether to generate a user creation log entry (since 1.36)
* @param Authority|null $performer The performer of the action to use for user rights
* checking. Normally null to indicate an anonymous performer. Added in 1.42 for
* Special:CreateLocalAccount (T234371).
*
* @return Status Good if user was created, Ok if user already existed, otherwise Fatal
*/
public
function
autoCreateUser
(
User
$user
,
$source
,
$login
=
true
,
$log
=
true
,
?
Authority
$performer
=
null
)
{
$validSources
=
[
self
::
AUTOCREATE_SOURCE_SESSION
,
self
::
AUTOCREATE_SOURCE_MAINT
,
self
::
AUTOCREATE_SOURCE_TEMP
];
if
(
!
in_array
(
$source
,
$validSources
,
true
)
&&
!
$this
->
getAuthenticationProvider
(
$source
)
instanceof
PrimaryAuthenticationProvider
)
{
throw
new
InvalidArgumentException
(
"Unknown auto-creation source: $source"
);
}
$username
=
$user
->
getName
();
// Try the local user from the replica DB, then fall back to the primary.
$localUserIdentity
=
$this
->
userIdentityLookup
->
getUserIdentityByName
(
$username
);
// @codeCoverageIgnoreStart
if
(
(
!
$localUserIdentity
||
!
$localUserIdentity
->
isRegistered
()
)
&&
$this
->
loadBalancer
->
getReaderIndex
()
!==
0
)
{
$localUserIdentity
=
$this
->
userIdentityLookup
->
getUserIdentityByName
(
$username
,
IDBAccessObject
::
READ_LATEST
);
}
// @codeCoverageIgnoreEnd
$localId
=
(
$localUserIdentity
&&
$localUserIdentity
->
isRegistered
()
)
?
$localUserIdentity
->
getId
()
:
null
;
if
(
$localId
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': {username} already exists locally'
,
[
'username'
=>
$username
,
]
);
$user
->
setId
(
$localId
);
// Can't rely on a replica read, not even when getUserIdentityByName() used
// READ_NORMAL, because that method has an in-process cache not shared
// with loadFromId.
$user
->
loadFromId
(
IDBAccessObject
::
READ_LATEST
);
if
(
$login
)
{
$remember
=
$source
===
self
::
AUTOCREATE_SOURCE_TEMP
;
$this
->
setSessionDataForUser
(
$user
,
$remember
,
false
);
}
return
Status
::
newGood
()->
warning
(
'userexists'
);
}
// Wiki is read-only?
if
(
$this
->
readOnlyMode
->
isReadOnly
()
)
{
$reason
=
$this
->
readOnlyMode
->
getReason
();
$this
->
logger
->
debug
(
__METHOD__
.
': denied because of read only mode: {reason}'
,
[
'username'
=>
$username
,
'reason'
=>
$reason
,
]
);
$user
->
setId
(
0
);
$user
->
loadFromId
();
$fatalStatus
=
Status
::
newFatal
(
wfMessage
(
'readonlytext'
,
$reason
)
);
$this
->
logAutocreationAttempt
(
$fatalStatus
,
$user
,
$source
,
$login
);
return
$fatalStatus
;
}
// If there is a non-anonymous performer, don't use their session
$session
=
null
;
if
(
!
$performer
||
$performer
->
getUser
()->
equals
(
$user
)
)
{
$session
=
$this
->
request
->
getSession
();
}
// Check the session, if we tried to create this user already there's
// no point in retrying.
if
(
$session
&&
$session
->
get
(
self
::
AUTOCREATE_BLOCKLIST
)
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': blacklisted in session {sessionid}'
,
[
'username'
=>
$username
,
'sessionid'
=>
$session
->
getId
(),
]
);
$user
->
setId
(
0
);
$user
->
loadFromId
();
$reason
=
$session
->
get
(
self
::
AUTOCREATE_BLOCKLIST
);
$status
=
$reason
instanceof
StatusValue
?
Status
::
wrap
(
$reason
)
:
Status
::
newFatal
(
$reason
);
$this
->
logAutocreationAttempt
(
$status
,
$user
,
$source
,
$login
);
return
$status
;
}
// Is the username usable? (Previously isCreatable() was checked here but
// that doesn't work with auto-creation of TempUser accounts by CentralAuth)
if
(
!
$this
->
userNameUtils
->
isUsable
(
$username
)
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': name "{username}" is not usable'
,
[
'username'
=>
$username
,
]
);
if
(
$session
)
{
$session
->
set
(
self
::
AUTOCREATE_BLOCKLIST
,
'noname'
);
}
$user
->
setId
(
0
);
$user
->
loadFromId
();
$fatalStatus
=
Status
::
newFatal
(
'noname'
);
$this
->
logAutocreationAttempt
(
$fatalStatus
,
$user
,
$source
,
$login
);
return
$fatalStatus
;
}
// Is the IP user able to create accounts?
$performer
??=
$this
->
userFactory
->
newAnonymous
();
$bypassAuthorization
=
$session
?
$session
->
getProvider
()->
canAlwaysAutocreate
()
:
false
;
if
(
$source
!==
self
::
AUTOCREATE_SOURCE_MAINT
&&
!
$bypassAuthorization
)
{
$status
=
$this
->
authorizeAutoCreateAccount
(
$performer
);
if
(
!
$status
->
isOk
()
)
{
if
(
$this
->
autocreatingTempUserToAppealBlock
(
$status
,
$source
,
$performer
)
)
{
$this
->
logger
->
info
(
__METHOD__
.
': autocreating temporary user to appeal a block'
,
[
'username'
=>
$username
,
'creator'
=>
$performer
->
getUser
()->
getName
(),
]
);
}
else
{
$this
->
logger
->
debug
(
__METHOD__
.
': cannot create or autocreate accounts'
,
[
'username'
=>
$username
,
'creator'
=>
$performer
->
getUser
()->
getName
(),
]
);
if
(
$session
)
{
$session
->
set
(
self
::
AUTOCREATE_BLOCKLIST
,
$status
);
$session
->
persist
();
}
$user
->
setId
(
0
);
$user
->
loadFromId
();
$statusWrapped
=
Status
::
wrap
(
$status
);
$this
->
logAutocreationAttempt
(
$statusWrapped
,
$user
,
$source
,
$login
);
return
$statusWrapped
;
}
}
}
// Avoid account creation races on double submissions
$cache
=
MediaWikiServices
::
getInstance
()->
getObjectCacheFactory
()->
getLocalClusterInstance
();
$lock
=
$cache
->
getScopedLock
(
$cache
->
makeGlobalKey
(
'account'
,
md5
(
$username
)
)
);
if
(
!
$lock
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': Could not acquire account creation lock'
,
[
'user'
=>
$username
,
]
);
$user
->
setId
(
0
);
$user
->
loadFromId
();
$status
=
Status
::
newFatal
(
'usernameinprogress'
);
$this
->
logAutocreationAttempt
(
$status
,
$user
,
$source
,
$login
);
return
$status
;
}
// Denied by providers?
$options
=
[
'flags'
=>
IDBAccessObject
::
READ_LATEST
,
'creating'
=>
true
,
'canAlwaysAutocreate'
=>
$session
&&
$session
->
getProvider
()->
canAlwaysAutocreate
(),
];
$providers
=
$this
->
getPreAuthenticationProviders
()
+
$this
->
getPrimaryAuthenticationProviders
()
+
$this
->
getSecondaryAuthenticationProviders
();
foreach
(
$providers
as
$provider
)
{
$status
=
$provider
->
testUserForCreation
(
$user
,
$source
,
$options
);
if
(
!
$status
->
isGood
()
)
{
$ret
=
Status
::
wrap
(
$status
);
$this
->
logger
->
debug
(
__METHOD__
.
': Provider denied creation of {username}: {reason}'
,
[
'username'
=>
$username
,
'reason'
=>
$ret
->
getWikiText
(
false
,
false
,
'en'
),
]
);
if
(
$session
)
{
$session
->
set
(
self
::
AUTOCREATE_BLOCKLIST
,
$status
);
}
$user
->
setId
(
0
);
$user
->
loadFromId
();
$this
->
logAutocreationAttempt
(
$ret
,
$user
,
$source
,
$login
);
return
$ret
;
}
}
$backoffKey
=
$cache
->
makeKey
(
'AuthManager'
,
'autocreate-failed'
,
md5
(
$username
)
);
if
(
$cache
->
get
(
$backoffKey
)
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': {username} denied by prior creation attempt failures'
,
[
'username'
=>
$username
,
]
);
$user
->
setId
(
0
);
$user
->
loadFromId
();
$status
=
Status
::
newFatal
(
'authmanager-autocreate-exception'
);
$this
->
logAutocreationAttempt
(
$status
,
$user
,
$source
,
$login
);
return
$status
;
}
// Checks passed, create the user...
$from
=
$_SERVER
[
'REQUEST_URI'
]
??
'CLI'
;
$this
->
logger
->
info
(
__METHOD__
.
': creating new user ({username}) - from: {from}'
,
[
'username'
=>
$username
,
'from'
=>
$from
,
]
);
// Ignore warnings about primary connections/writes...hard to avoid here
$fname
=
__METHOD__
;
$trxLimits
=
$this
->
config
->
get
(
MainConfigNames
::
TrxProfilerLimits
);
$trxProfiler
=
Profiler
::
instance
()->
getTransactionProfiler
();
$trxProfiler
->
redefineExpectations
(
$trxLimits
[
'POST'
],
$fname
);
DeferredUpdates
::
addCallableUpdate
(
static
function
()
use
(
$trxProfiler
,
$trxLimits
,
$fname
)
{
$trxProfiler
->
redefineExpectations
(
$trxLimits
[
'PostSend-POST'
],
$fname
);
}
);
try
{
$status
=
$user
->
addToDatabase
();
if
(
!
$status
->
isOK
()
)
{
// Double-check for a race condition (T70012). We make use of the fact that when
// addToDatabase fails due to the user already existing, the user object gets loaded.
if
(
$user
->
getId
()
)
{
$this
->
logger
->
info
(
__METHOD__
.
': {username} already exists locally (race)'
,
[
'username'
=>
$username
,
]
);
if
(
$login
)
{
$remember
=
$source
===
self
::
AUTOCREATE_SOURCE_TEMP
;
$this
->
setSessionDataForUser
(
$user
,
$remember
,
false
);
}
$status
=
Status
::
newGood
()->
warning
(
'userexists'
);
}
else
{
$this
->
logger
->
error
(
__METHOD__
.
': {username} failed with message {msg}'
,
[
'username'
=>
$username
,
'msg'
=>
$status
->
getWikiText
(
false
,
false
,
'en'
)
]
);
$user
->
setId
(
0
);
$user
->
loadFromId
();
}
$this
->
logAutocreationAttempt
(
$status
,
$user
,
$source
,
$login
);
return
$status
;
}
}
catch
(
\Exception
$ex
)
{
$this
->
logger
->
error
(
__METHOD__
.
': {username} failed with exception {exception}'
,
[
'username'
=>
$username
,
'exception'
=>
$ex
,
]
);
// Do not keep throwing errors for a while
$cache
->
set
(
$backoffKey
,
1
,
600
);
// Bubble up error; which should normally trigger DB rollbacks
throw
$ex
;
}
$this
->
setDefaultUserOptions
(
$user
,
false
);
// Inform the providers
$this
->
callMethodOnProviders
(
self
::
CALL_PRIMARY
|
self
::
CALL_SECONDARY
,
'autoCreatedAccount'
,
[
$user
,
$source
]
);
$this
->
getHookRunner
()->
onLocalUserCreated
(
$user
,
true
);
$user
->
saveSettings
();
// Update user count
DeferredUpdates
::
addUpdate
(
SiteStatsUpdate
::
factory
(
[
'users'
=>
1
]
)
);
// Watch user's userpage and talk page (except temp users)
if
(
$source
!==
self
::
AUTOCREATE_SOURCE_TEMP
)
{
DeferredUpdates
::
addCallableUpdate
(
function
()
use
(
$user
)
{
$this
->
watchlistManager
->
addWatchIgnoringRights
(
$user
,
$user
->
getUserPage
()
);
}
);
}
// Log the creation
if
(
$this
->
config
->
get
(
MainConfigNames
::
NewUserLog
)
&&
$log
)
{
$logEntry
=
new
ManualLogEntry
(
'newusers'
,
'autocreate'
);
$logEntry
->
setPerformer
(
$user
);
$logEntry
->
setTarget
(
$user
->
getUserPage
()
);
$logEntry
->
setComment
(
''
);
$logEntry
->
setParameters
(
[
'4::userid'
=>
$user
->
getId
(),
]
);
$logEntry
->
insert
();
}
if
(
$login
)
{
$remember
=
$source
===
self
::
AUTOCREATE_SOURCE_TEMP
;
$this
->
setSessionDataForUser
(
$user
,
$remember
,
false
);
}
$retStatus
=
Status
::
newGood
();
$this
->
logAutocreationAttempt
(
$retStatus
,
$user
,
$source
,
$login
);
return
$retStatus
;
}
/**
* Authorize automatic account creation. This is like account creation but
* checks the autocreateaccount right instead of the createaccount right.
*
* @param Authority $creator
* @return StatusValue
*/
private
function
authorizeAutoCreateAccount
(
Authority
$creator
)
{
return
$this
->
authorizeInternal
(
static
function
(
string
$action
,
PageIdentity
$target
,
PermissionStatus
$status
)
use
(
$creator
)
{
return
$creator
->
authorizeWrite
(
$action
,
$target
,
$status
);
},
'autocreateaccount'
);
}
// endregion -- end of Account creation
/***************************************************************************/
// region Account linking
/** @name Account linking */
/**
* Determine whether accounts can be linked
* @return bool
*/
public
function
canLinkAccounts
()
{
foreach
(
$this
->
getPrimaryAuthenticationProviders
()
as
$provider
)
{
if
(
$provider
->
accountCreationType
()
===
PrimaryAuthenticationProvider
::
TYPE_LINK
)
{
return
true
;
}
}
return
false
;
}
/**
* Start an account linking flow
*
* @param User $user User being linked
* @param AuthenticationRequest[] $reqs
* @param string $returnToUrl Url that REDIRECT responses should eventually
* return to.
* @return AuthenticationResponse
*/
public
function
beginAccountLink
(
User
$user
,
array
$reqs
,
$returnToUrl
)
{
$session
=
$this
->
request
->
getSession
();
$session
->
remove
(
self
::
ACCOUNT_LINK_STATE
);
if
(
!
$this
->
canLinkAccounts
()
)
{
// Caller should have called canLinkAccounts()
throw
new
LogicException
(
'Account linking is not possible'
);
}
if
(
!
$user
->
isRegistered
()
)
{
if
(
!
$this
->
userNameUtils
->
isUsable
(
$user
->
getName
()
)
)
{
$msg
=
wfMessage
(
'noname'
);
}
else
{
$msg
=
wfMessage
(
'authmanager-userdoesnotexist'
,
$user
->
getName
()
);
}
return
AuthenticationResponse
::
newFail
(
$msg
);
}
foreach
(
$reqs
as
$req
)
{
$req
->
username
=
$user
->
getName
();
$req
->
returnToUrl
=
$returnToUrl
;
}
$this
->
removeAuthenticationSessionData
(
null
);
$providers
=
$this
->
getPreAuthenticationProviders
();
foreach
(
$providers
as
$id
=>
$provider
)
{
$status
=
$provider
->
testForAccountLink
(
$user
);
if
(
!
$status
->
isGood
()
)
{
$this
->
logger
->
debug
(
__METHOD__
.
': Account linking pre-check failed by {id}'
,
[
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
]
);
$ret
=
AuthenticationResponse
::
newFail
(
Status
::
wrap
(
$status
)->
getMessage
()
);
$this
->
callMethodOnProviders
(
self
::
CALL_PRE
|
self
::
CALL_PRIMARY
,
'postAccountLink'
,
[
$user
,
$ret
]
);
return
$ret
;
}
}
$state
=
[
'username'
=>
$user
->
getName
(),
'userid'
=>
$user
->
getId
(),
'returnToUrl'
=>
$returnToUrl
,
'providerIds'
=>
$this
->
getProviderIds
(),
'primary'
=>
null
,
'continueRequests'
=>
[],
];
$providers
=
$this
->
getPrimaryAuthenticationProviders
();
foreach
(
$providers
as
$id
=>
$provider
)
{
if
(
$provider
->
accountCreationType
()
!==
PrimaryAuthenticationProvider
::
TYPE_LINK
)
{
continue
;
}
$res
=
$provider
->
beginPrimaryAccountLink
(
$user
,
$reqs
);
switch
(
$res
->
status
)
{
case
AuthenticationResponse
::
PASS
:
$this
->
logger
->
info
(
'Account linked to {user} by {id}'
,
[
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
]
);
$this
->
callMethodOnProviders
(
self
::
CALL_PRE
|
self
::
CALL_PRIMARY
,
'postAccountLink'
,
[
$user
,
$res
]
);
return
$res
;
case
AuthenticationResponse
::
FAIL
:
$this
->
logger
->
debug
(
__METHOD__
.
': Account linking failed by {id}'
,
[
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
]
);
$this
->
callMethodOnProviders
(
self
::
CALL_PRE
|
self
::
CALL_PRIMARY
,
'postAccountLink'
,
[
$user
,
$res
]
);
return
$res
;
case
AuthenticationResponse
::
ABSTAIN
:
// Continue loop
break
;
case
AuthenticationResponse
::
REDIRECT
:
case
AuthenticationResponse
::
UI
:
$this
->
logger
->
debug
(
__METHOD__
.
': Account linking {status} by {id}'
,
[
'status'
=>
$res
->
status
,
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
]
);
$this
->
fillRequests
(
$res
->
neededRequests
,
self
::
ACTION_LINK
,
$user
->
getName
()
);
$state
[
'primary'
]
=
$id
;
$state
[
'continueRequests'
]
=
$res
->
neededRequests
;
$session
->
setSecret
(
self
::
ACCOUNT_LINK_STATE
,
$state
);
$session
->
persist
();
return
$res
;
// @codeCoverageIgnoreStart
default
:
throw
new
\DomainException
(
get_class
(
$provider
)
.
"::beginPrimaryAccountLink() returned $res->status"
);
// @codeCoverageIgnoreEnd
}
}
$this
->
logger
->
debug
(
__METHOD__
.
': Account linking failed because no provider accepted'
,
[
'user'
=>
$user
->
getName
(),
]
);
$ret
=
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-link-no-primary'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_PRE
|
self
::
CALL_PRIMARY
,
'postAccountLink'
,
[
$user
,
$ret
]
);
return
$ret
;
}
/**
* Continue an account linking flow
* @param AuthenticationRequest[] $reqs
* @return AuthenticationResponse
*/
public
function
continueAccountLink
(
array
$reqs
)
{
$session
=
$this
->
request
->
getSession
();
try
{
if
(
!
$this
->
canLinkAccounts
()
)
{
// Caller should have called canLinkAccounts()
$session
->
remove
(
self
::
ACCOUNT_LINK_STATE
);
throw
new
LogicException
(
'Account linking is not possible'
);
}
$state
=
$session
->
getSecret
(
self
::
ACCOUNT_LINK_STATE
);
if
(
!
is_array
(
$state
)
)
{
return
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-link-not-in-progress'
)
);
}
$state
[
'continueRequests'
]
=
[];
// Step 0: Prepare and validate the input
$user
=
$this
->
userFactory
->
newFromName
(
(
string
)
$state
[
'username'
],
UserRigorOptions
::
RIGOR_USABLE
);
if
(
!
is_object
(
$user
)
)
{
$session
->
remove
(
self
::
ACCOUNT_LINK_STATE
);
return
AuthenticationResponse
::
newFail
(
wfMessage
(
'noname'
)
);
}
if
(
$user
->
getId
()
!==
$state
[
'userid'
]
)
{
throw
new
\UnexpectedValueException
(
"User
\"
{$state['username']}
\"
is valid, but "
.
"ID {$user->getId()} !== {$state['userid']}!"
);
}
if
(
$state
[
'providerIds'
]
!==
$this
->
getProviderIds
()
)
{
// An inconsistent AuthManagerFilterProviders hook, or site configuration changed
// while the user was in the middle of authentication. The first is a bug, the
// second is rare but expected when deploying a config change. Try handle in a way
// that's useful for both cases.
// @codeCoverageIgnoreStart
MWExceptionHandler
::
logException
(
new
NormalizedException
(
'Authentication failed because of inconsistent provider array'
,
[
'old'
=>
json_encode
(
$state
[
'providerIds'
]
),
'new'
=>
json_encode
(
$this
->
getProviderIds
()
)
]
)
);
$ret
=
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-link-not-in-progress'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_ALL
,
'postAccountCreation'
,
[
$user
,
$ret
]
);
$session
->
remove
(
self
::
ACCOUNT_LINK_STATE
);
return
$ret
;
// @codeCoverageIgnoreEnd
}
foreach
(
$reqs
as
$req
)
{
$req
->
username
=
$state
[
'username'
];
$req
->
returnToUrl
=
$state
[
'returnToUrl'
];
}
// Step 1: Call the primary again until it succeeds
$provider
=
$this
->
getAuthenticationProvider
(
$state
[
'primary'
]
);
if
(
!
$provider
instanceof
PrimaryAuthenticationProvider
)
{
// Configuration changed? Force them to start over.
// @codeCoverageIgnoreStart
$ret
=
AuthenticationResponse
::
newFail
(
wfMessage
(
'authmanager-link-not-in-progress'
)
);
$this
->
callMethodOnProviders
(
self
::
CALL_PRE
|
self
::
CALL_PRIMARY
,
'postAccountLink'
,
[
$user
,
$ret
]
);
$session
->
remove
(
self
::
ACCOUNT_LINK_STATE
);
return
$ret
;
// @codeCoverageIgnoreEnd
}
$id
=
$provider
->
getUniqueId
();
$res
=
$provider
->
continuePrimaryAccountLink
(
$user
,
$reqs
);
switch
(
$res
->
status
)
{
case
AuthenticationResponse
::
PASS
:
$this
->
logger
->
info
(
'Account linked to {user} by {id}'
,
[
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
]
);
$this
->
callMethodOnProviders
(
self
::
CALL_PRE
|
self
::
CALL_PRIMARY
,
'postAccountLink'
,
[
$user
,
$res
]
);
$session
->
remove
(
self
::
ACCOUNT_LINK_STATE
);
return
$res
;
case
AuthenticationResponse
::
FAIL
:
$this
->
logger
->
debug
(
__METHOD__
.
': Account linking failed by {id}'
,
[
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
]
);
$this
->
callMethodOnProviders
(
self
::
CALL_PRE
|
self
::
CALL_PRIMARY
,
'postAccountLink'
,
[
$user
,
$res
]
);
$session
->
remove
(
self
::
ACCOUNT_LINK_STATE
);
return
$res
;
case
AuthenticationResponse
::
REDIRECT
:
case
AuthenticationResponse
::
UI
:
$this
->
logger
->
debug
(
__METHOD__
.
': Account linking {status} by {id}'
,
[
'status'
=>
$res
->
status
,
'id'
=>
$id
,
'user'
=>
$user
->
getName
(),
]
);
$this
->
fillRequests
(
$res
->
neededRequests
,
self
::
ACTION_LINK
,
$user
->
getName
()
);
$state
[
'continueRequests'
]
=
$res
->
neededRequests
;
$session
->
setSecret
(
self
::
ACCOUNT_LINK_STATE
,
$state
);
return
$res
;
default
:
throw
new
\DomainException
(
get_class
(
$provider
)
.
"::continuePrimaryAccountLink() returned $res->status"
);
}
}
catch
(
\Exception
$ex
)
{
$session
->
remove
(
self
::
ACCOUNT_LINK_STATE
);
throw
$ex
;
}
}
// endregion -- end of Account linking
/***************************************************************************/
// region Information methods
/** @name Information methods */
/**
* 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.
*
* @param string $action One of the AuthManager::ACTION_* constants
* @param UserIdentity|null $user User being acted on, instead of the current user.
* @return AuthenticationRequest[]
*/
public
function
getAuthenticationRequests
(
$action
,
?
UserIdentity
$user
=
null
)
{
$options
=
[];
$providerAction
=
$action
;
// Figure out which providers to query
switch
(
$action
)
{
case
self
::
ACTION_LOGIN
:
case
self
::
ACTION_CREATE
:
$providers
=
$this
->
getPreAuthenticationProviders
()
+
$this
->
getPrimaryAuthenticationProviders
()
+
$this
->
getSecondaryAuthenticationProviders
();
break
;
case
self
::
ACTION_LOGIN_CONTINUE
:
$state
=
$this
->
request
->
getSession
()->
getSecret
(
self
::
AUTHN_STATE
);
return
is_array
(
$state
)
?
$state
[
'continueRequests'
]
:
[];
case
self
::
ACTION_CREATE_CONTINUE
:
$state
=
$this
->
request
->
getSession
()->
getSecret
(
self
::
ACCOUNT_CREATION_STATE
);
return
is_array
(
$state
)
?
$state
[
'continueRequests'
]
:
[];
case
self
::
ACTION_LINK
:
$providers
=
[];
foreach
(
$this
->
getPrimaryAuthenticationProviders
()
as
$p
)
{
if
(
$p
->
accountCreationType
()
===
PrimaryAuthenticationProvider
::
TYPE_LINK
)
{
$providers
[]
=
$p
;
}
}
break
;
case
self
::
ACTION_UNLINK
:
$providers
=
[];
foreach
(
$this
->
getPrimaryAuthenticationProviders
()
as
$p
)
{
if
(
$p
->
accountCreationType
()
===
PrimaryAuthenticationProvider
::
TYPE_LINK
)
{
$providers
[]
=
$p
;
}
}
// To providers, unlink and remove are identical.
$providerAction
=
self
::
ACTION_REMOVE
;
break
;
case
self
::
ACTION_LINK_CONTINUE
:
$state
=
$this
->
request
->
getSession
()->
getSecret
(
self
::
ACCOUNT_LINK_STATE
);
return
is_array
(
$state
)
?
$state
[
'continueRequests'
]
:
[];
case
self
::
ACTION_CHANGE
:
case
self
::
ACTION_REMOVE
:
$providers
=
$this
->
getPrimaryAuthenticationProviders
()
+
$this
->
getSecondaryAuthenticationProviders
();
break
;
// @codeCoverageIgnoreStart
default
:
throw
new
\DomainException
(
__METHOD__
.
": Invalid action
\"
$action
\"
"
);
}
// @codeCoverageIgnoreEnd
return
$this
->
getAuthenticationRequestsInternal
(
$providerAction
,
$options
,
$providers
,
$user
);
}
/**
* Internal request lookup for self::getAuthenticationRequests
*
* @param string $providerAction Action to pass to providers
* @param array $options Options to pass to providers
* @param AuthenticationProvider[] $providers
* @param UserIdentity|null $user being acted on
* @return AuthenticationRequest[]
*/
private
function
getAuthenticationRequestsInternal
(
$providerAction
,
array
$options
,
array
$providers
,
?
UserIdentity
$user
=
null
)
{
$user
=
$user
?:
RequestContext
::
getMain
()->
getUser
();
$options
[
'username'
]
=
$user
->
isRegistered
()
?
$user
->
getName
()
:
null
;
// Query them and merge results
$reqs
=
[];
foreach
(
$providers
as
$provider
)
{
$isPrimary
=
$provider
instanceof
PrimaryAuthenticationProvider
;
foreach
(
$provider
->
getAuthenticationRequests
(
$providerAction
,
$options
)
as
$req
)
{
$id
=
$req
->
getUniqueId
();
// If a required request if from a Primary, mark it as "primary-required" instead
if
(
$isPrimary
&&
$req
->
required
)
{
$req
->
required
=
AuthenticationRequest
::
PRIMARY_REQUIRED
;
}
if
(
!
isset
(
$reqs
[
$id
]
)
||
$req
->
required
===
AuthenticationRequest
::
REQUIRED
||
$reqs
[
$id
]->
required
===
AuthenticationRequest
::
OPTIONAL
)
{
$reqs
[
$id
]
=
$req
;
}
}
}
// AuthManager has its own req for some actions
switch
(
$providerAction
)
{
case
self
::
ACTION_LOGIN
:
$reqs
[]
=
new
RememberMeAuthenticationRequest
(
$this
->
config
->
get
(
MainConfigNames
::
RememberMe
)
);
$options
[
'username'
]
=
null
;
// Don't fill in the username below
break
;
case
self
::
ACTION_CREATE
:
$reqs
[]
=
new
UsernameAuthenticationRequest
;
$reqs
[]
=
new
UserDataAuthenticationRequest
;
// Registered users should be prompted to provide a rationale for account creations,
// except for the case of a temporary user registering a full account (T328718).
if
(
$options
[
'username'
]
!==
null
&&
!
$this
->
userNameUtils
->
isTemp
(
$options
[
'username'
]
)
)
{
$reqs
[]
=
new
CreationReasonAuthenticationRequest
;
$options
[
'username'
]
=
null
;
// Don't fill in the username below
}
break
;
}
// Fill in reqs data
$this
->
fillRequests
(
$reqs
,
$providerAction
,
$options
[
'username'
],
true
);
// For self::ACTION_CHANGE, filter out any that something else *doesn't* allow changing
if
(
$providerAction
===
self
::
ACTION_CHANGE
||
$providerAction
===
self
::
ACTION_REMOVE
)
{
$reqs
=
array_filter
(
$reqs
,
function
(
$req
)
{
return
$this
->
allowsAuthenticationDataChange
(
$req
,
false
)->
isGood
();
}
);
}
return
array_values
(
$reqs
);
}
/**
* Set values in an array of requests
* @param AuthenticationRequest[] &$reqs
* @param string $action
* @param string|null $username
* @param bool $forceAction
*/
private
function
fillRequests
(
array
&
$reqs
,
$action
,
$username
,
$forceAction
=
false
)
{
foreach
(
$reqs
as
$req
)
{
if
(
!
$req
->
action
||
$forceAction
)
{
$req
->
action
=
$action
;
}
$req
->
username
??=
$username
;
}
}
/**
* Determine whether a username exists
* @param string $username
* @param int $flags Bitfield of IDBAccessObject::READ_* constants
* @return bool
*/
public
function
userExists
(
$username
,
$flags
=
IDBAccessObject
::
READ_NORMAL
)
{
foreach
(
$this
->
getPrimaryAuthenticationProviders
()
as
$provider
)
{
if
(
$provider
->
testUserExists
(
$username
,
$flags
)
)
{
return
true
;
}
}
return
false
;
}
/**
* Determine whether a user property should be allowed to be changed.
*
* Supported properties are:
* - emailaddress
* - realname
* - nickname
*
* @param string $property
* @return bool
*/
public
function
allowsPropertyChange
(
$property
)
{
$providers
=
$this
->
getPrimaryAuthenticationProviders
()
+
$this
->
getSecondaryAuthenticationProviders
();
foreach
(
$providers
as
$provider
)
{
if
(
!
$provider
->
providerAllowsPropertyChange
(
$property
)
)
{
return
false
;
}
}
return
true
;
}
/**
* 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.
* @param string $id
* @return AuthenticationProvider|null
*/
public
function
getAuthenticationProvider
(
$id
)
{
// Fast version
if
(
isset
(
$this
->
allAuthenticationProviders
[
$id
]
)
)
{
return
$this
->
allAuthenticationProviders
[
$id
];
}
// Slow version: instantiate each kind and check
$providers
=
$this
->
getPrimaryAuthenticationProviders
();
if
(
isset
(
$providers
[
$id
]
)
)
{
return
$providers
[
$id
];
}
$providers
=
$this
->
getSecondaryAuthenticationProviders
();
if
(
isset
(
$providers
[
$id
]
)
)
{
return
$providers
[
$id
];
}
$providers
=
$this
->
getPreAuthenticationProviders
();
if
(
isset
(
$providers
[
$id
]
)
)
{
return
$providers
[
$id
];
}
return
null
;
}
// endregion -- end of Information methods
/***************************************************************************/
// region Internal methods
/** @name Internal methods */
/**
* Store authentication in the current session
* @note For use by AuthenticationProviders only
* @param string $key
* @param mixed $data Must be serializable
*/
public
function
setAuthenticationSessionData
(
$key
,
$data
)
{
$session
=
$this
->
request
->
getSession
();
$arr
=
$session
->
getSecret
(
'authData'
);
if
(
!
is_array
(
$arr
)
)
{
$arr
=
[];
}
$arr
[
$key
]
=
$data
;
$session
->
setSecret
(
'authData'
,
$arr
);
}
/**
* Fetch authentication data from the current session
* @note For use by AuthenticationProviders only
* @param string $key
* @param mixed|null $default
* @return mixed
*/
public
function
getAuthenticationSessionData
(
$key
,
$default
=
null
)
{
$arr
=
$this
->
request
->
getSession
()->
getSecret
(
'authData'
);
if
(
is_array
(
$arr
)
&&
array_key_exists
(
$key
,
$arr
)
)
{
return
$arr
[
$key
];
}
else
{
return
$default
;
}
}
/**
* Remove authentication data
* @note For use by AuthenticationProviders
* @param string|null $key If null, all data is removed
*/
public
function
removeAuthenticationSessionData
(
$key
)
{
$session
=
$this
->
request
->
getSession
();
if
(
$key
===
null
)
{
$session
->
remove
(
'authData'
);
}
else
{
$arr
=
$session
->
getSecret
(
'authData'
);
if
(
is_array
(
$arr
)
&&
array_key_exists
(
$key
,
$arr
)
)
{
unset
(
$arr
[
$key
]
);
$session
->
setSecret
(
'authData'
,
$arr
);
}
}
}
/**
* Create an array of AuthenticationProviders from an array of ObjectFactory specs
* @param class-string<AuthenticationProvider> $class
* @param array[] $specs
* @return AuthenticationProvider[]
*/
protected
function
providerArrayFromSpecs
(
$class
,
array
$specs
)
{
$i
=
0
;
foreach
(
$specs
as
&
$spec
)
{
$spec
=
[
'sort2'
=>
$i
++
]
+
$spec
+
[
'sort'
=>
0
];
}
unset
(
$spec
);
// Sort according to the 'sort' field, and if they are equal, according to 'sort2'
usort
(
$specs
,
static
function
(
$a
,
$b
)
{
return
$a
[
'sort'
]
<=>
$b
[
'sort'
]
?:
$a
[
'sort2'
]
<=>
$b
[
'sort2'
];
}
);
$ret
=
[];
foreach
(
$specs
as
$spec
)
{
/** @var AbstractAuthenticationProvider $provider */
$provider
=
$this
->
objectFactory
->
createObject
(
$spec
,
[
'assertClass'
=>
$class
]
);
$provider
->
init
(
$this
->
logger
,
$this
,
$this
->
getHookContainer
(),
$this
->
config
,
$this
->
userNameUtils
);
$id
=
$provider
->
getUniqueId
();
if
(
isset
(
$this
->
allAuthenticationProviders
[
$id
]
)
)
{
throw
new
\RuntimeException
(
"Duplicate specifications for id $id (classes "
.
get_class
(
$provider
)
.
' and '
.
get_class
(
$this
->
allAuthenticationProviders
[
$id
]
)
.
')'
);
}
$this
->
allAuthenticationProviders
[
$id
]
=
$provider
;
$ret
[
$id
]
=
$provider
;
}
return
$ret
;
}
/**
* Get the list of PreAuthenticationProviders
* @return PreAuthenticationProvider[]
*/
protected
function
getPreAuthenticationProviders
()
{
if
(
$this
->
preAuthenticationProviders
===
null
)
{
$this
->
initializeAuthenticationProviders
();
}
return
$this
->
preAuthenticationProviders
;
}
/**
* Get the list of PrimaryAuthenticationProviders
* @return PrimaryAuthenticationProvider[]
*/
protected
function
getPrimaryAuthenticationProviders
()
{
if
(
$this
->
primaryAuthenticationProviders
===
null
)
{
$this
->
initializeAuthenticationProviders
();
}
return
$this
->
primaryAuthenticationProviders
;
}
/**
* Get the list of SecondaryAuthenticationProviders
* @return SecondaryAuthenticationProvider[]
*/
protected
function
getSecondaryAuthenticationProviders
()
{
if
(
$this
->
secondaryAuthenticationProviders
===
null
)
{
$this
->
initializeAuthenticationProviders
();
}
return
$this
->
secondaryAuthenticationProviders
;
}
private
function
getProviderIds
():
array
{
return
[
'preauth'
=>
array_keys
(
$this
->
getPreAuthenticationProviders
()
),
'primaryauth'
=>
array_keys
(
$this
->
getPrimaryAuthenticationProviders
()
),
'secondaryauth'
=>
array_keys
(
$this
->
getSecondaryAuthenticationProviders
()
),
];
}
private
function
initializeAuthenticationProviders
()
{
$conf
=
$this
->
config
->
get
(
MainConfigNames
::
AuthManagerConfig
)
?:
$this
->
config
->
get
(
MainConfigNames
::
AuthManagerAutoConfig
);
$providers
=
array_map
(
static
fn
(
$stepConf
)
=>
array_fill_keys
(
array_keys
(
$stepConf
),
true
),
$conf
);
$this
->
getHookRunner
()->
onAuthManagerFilterProviders
(
$providers
);
foreach
(
$conf
as
$step
=>
$stepConf
)
{
$conf
[
$step
]
=
array_intersect_key
(
$stepConf
,
array_filter
(
$providers
[
$step
]
)
);
}
$this
->
preAuthenticationProviders
=
$this
->
providerArrayFromSpecs
(
PreAuthenticationProvider
::
class
,
$conf
[
'preauth'
]
);
$this
->
primaryAuthenticationProviders
=
$this
->
providerArrayFromSpecs
(
PrimaryAuthenticationProvider
::
class
,
$conf
[
'primaryauth'
]
);
$this
->
secondaryAuthenticationProviders
=
$this
->
providerArrayFromSpecs
(
SecondaryAuthenticationProvider
::
class
,
$conf
[
'secondaryauth'
]
);
}
/**
* Log the user in
* @param User $user
* @param bool|null $remember The "remember me" flag.
* @param bool $isReauthentication Whether creating this session should count as a recent
* authentication for $wgReauthenticateTime checks.
*/
private
function
setSessionDataForUser
(
$user
,
$remember
=
null
,
$isReauthentication
=
true
)
{
$session
=
$this
->
request
->
getSession
();
$delay
=
$session
->
delaySave
();
$session
->
resetId
();
$session
->
resetAllTokens
();
if
(
$session
->
canSetUser
()
)
{
$session
->
setUser
(
$user
);
}
if
(
$remember
!==
null
)
{
$session
->
setRememberUser
(
$remember
);
}
if
(
$isReauthentication
)
{
$session
->
set
(
'AuthManager:lastAuthId'
,
$user
->
getId
()
);
$session
->
set
(
'AuthManager:lastAuthTimestamp'
,
time
()
);
}
$session
->
persist
();
\Wikimedia\ScopedCallback
::
consume
(
$delay
);
$this
->
getHookRunner
()->
onUserLoggedIn
(
$user
);
}
/**
* @param User $user
* @param bool $useContextLang Use 'uselang' to set the user's language
*/
private
function
setDefaultUserOptions
(
User
$user
,
$useContextLang
)
{
$user
->
setToken
();
$lang
=
$useContextLang
?
RequestContext
::
getMain
()->
getLanguage
()
:
$this
->
contentLanguage
;
$this
->
userOptionsManager
->
setOption
(
$user
,
'language'
,
$this
->
languageConverterFactory
->
getLanguageConverter
(
$lang
)->
getPreferredVariant
()
);
$contLangConverter
=
$this
->
languageConverterFactory
->
getLanguageConverter
(
$this
->
contentLanguage
);
if
(
$contLangConverter
->
hasVariants
()
)
{
$this
->
userOptionsManager
->
setOption
(
$user
,
'variant'
,
$contLangConverter
->
getPreferredVariant
()
);
}
}
/**
* @see AuthManagerVerifyAuthenticationHook::onAuthManagerVerifyAuthentication()
*/
private
function
runVerifyHook
(
string
$action
,
?
UserIdentity
$user
,
AuthenticationResponse
&
$response
,
string
$primaryId
):
bool
{
$oldResponse
=
$response
;
$info
=
[
'action'
=>
$action
,
'primaryId'
=>
$primaryId
,
];
$proceed
=
$this
->
getHookRunner
()->
onAuthManagerVerifyAuthentication
(
$user
,
$response
,
$this
,
$info
);
if
(
!(
$response
instanceof
AuthenticationResponse
)
)
{
throw
new
LogicException
(
'$response must be an AuthenticationResponse'
);
}
elseif
(
$proceed
&&
$response
!==
$oldResponse
)
{
throw
new
LogicException
(
'AuthManagerVerifyAuthenticationHook must not modify the response unless it returns false'
);
}
elseif
(
!
$proceed
&&
$response
->
status
!==
AuthenticationResponse
::
FAIL
)
{
throw
new
LogicException
(
'AuthManagerVerifyAuthenticationHook must set the response to FAIL if it returns false'
);
}
if
(
!
$proceed
)
{
$this
->
logger
->
info
(
$action
.
' action for {user} from {clientIp} prevented by '
.
'AuthManagerVerifyAuthentication hook: {reason}'
,
[
'user'
=>
$user
?
$user
->
getName
()
:
'<null>'
,
'reason'
=>
$response
->
message
->
getKey
(),
'primaryId'
=>
$primaryId
,
]
+
$this
->
request
->
getSecurityLogContext
(
$user
)
);
}
return
$proceed
;
}
/**
* @param int $which Bitmask of values of the self::CALL_* constants
* @param string $method
* @param array $args
*/
private
function
callMethodOnProviders
(
$which
,
$method
,
array
$args
)
{
$providers
=
[];
if
(
$which
&
self
::
CALL_PRE
)
{
$providers
+=
$this
->
getPreAuthenticationProviders
();
}
if
(
$which
&
self
::
CALL_PRIMARY
)
{
$providers
+=
$this
->
getPrimaryAuthenticationProviders
();
}
if
(
$which
&
self
::
CALL_SECONDARY
)
{
$providers
+=
$this
->
getSecondaryAuthenticationProviders
();
}
foreach
(
$providers
as
$provider
)
{
$provider
->
$method
(
...
$args
);
}
}
/**
* @return HookContainer
*/
private
function
getHookContainer
()
{
return
$this
->
hookContainer
;
}
/**
* @return HookRunner
*/
private
function
getHookRunner
()
{
return
$this
->
hookRunner
;
}
// endregion -- end of Internal methods
}
/*
* This file uses VisualStudio style region/endregion fold markers which are
* recognised by PHPStorm. If modelines are enabled, the following editor
* configuration will also enable folding in vim, if it is in the last 5 lines
* of the file. We also use "@name" which creates sections in Doxygen.
*
* vim: foldmarker=//\ region,//\ endregion foldmethod=marker
*/
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Tue, Mar 31, 06:20 (1 d, 2 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
6d/cc/b8c5eaf62470e2c0bda588b9c3da
Default Alt Text
AuthManager.php (107 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment