3 * Authentication (and possibly Authorization in the future) system entry point
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 namespace MediaWiki\Auth
;
27 use MediaWiki\MediaWikiServices
;
28 use Psr\Log\LoggerAwareInterface
;
29 use Psr\Log\LoggerInterface
;
34 use Wikimedia\ObjectFactory
;
37 * This serves as the entry point to the authentication system.
39 * In the future, it may also serve as the entry point to the authorization
42 * If you are looking at this because you are working on an extension that creates its own
43 * login or signup page, then 1) you really shouldn't do that, 2) if you feel you absolutely
44 * have to, subclass AuthManagerSpecialPage or build it on the client side using the clientlogin
45 * or the createaccount API. Trying to call this class directly will very likely end up in
46 * security vulnerabilities or broken UX in edge cases.
48 * If you are working on an extension that needs to integrate with the authentication system
49 * (e.g. by providing a new login method, or doing extra permission checks), you'll probably
50 * need to write an AuthenticationProvider.
52 * If you want to create a "reserved" user programmatically, User::newSystemUser() might be what
53 * you are looking for. If you want to change user data, use User::changeAuthenticationData().
54 * Code that is related to some SessionProvider or PrimaryAuthenticationProvider can
55 * create a (non-reserved) user by calling AuthManager::autoCreateUser(); it is then the provider's
56 * responsibility to ensure that the user can authenticate somehow (see especially
57 * PrimaryAuthenticationProvider::autoCreatedAccount()).
58 * If you are writing code that is not associated with such a provider and needs to create accounts
59 * programmatically for real users, you should rethink your architecture. There is no good way to
60 * do that as such code has no knowledge of what authentication methods are enabled on the wiki and
61 * cannot provide any means for users to access the accounts it would create.
63 * The two main control flows when using this class are as follows:
64 * * Login, user creation or account linking code will call getAuthenticationRequests(), populate
65 * the requests with data (by using them to build a HTMLForm and have the user fill it, or by
66 * exposing a form specification via the API, so that the client can build it), and pass them to
67 * the appropriate begin* method. That will return either a success/failure response, or more
68 * requests to fill (either by building a form or by redirecting the user to some external
69 * provider which will send the data back), in which case they need to be submitted to the
70 * appropriate continue* method and that step has to be repeated until the response is a success
71 * or failure response. AuthManager will use the session to maintain internal state during the
73 * * Code doing an authentication data change will call getAuthenticationRequests(), select
74 * a single request, populate it, and pass it to allowsAuthenticationDataChange() and then
75 * changeAuthenticationData(). If the data change is user-initiated, the whole process needs
76 * to be preceded by a call to securitySensitiveOperationStatus() and aborted if that returns
81 * @see https://www.mediawiki.org/wiki/Manual:SessionManager_and_AuthManager
83 class AuthManager
implements LoggerAwareInterface
{
84 /** Log in with an existing (not necessarily local) user */
85 const ACTION_LOGIN
= 'login';
86 /** Continue a login process that was interrupted by the need for user input or communication
87 * with an external provider */
88 const ACTION_LOGIN_CONTINUE
= 'login-continue';
89 /** Create a new user */
90 const ACTION_CREATE
= 'create';
91 /** Continue a user creation process that was interrupted by the need for user input or
92 * communication with an external provider */
93 const ACTION_CREATE_CONTINUE
= 'create-continue';
94 /** Link an existing user to a third-party account */
95 const ACTION_LINK
= 'link';
96 /** Continue a user linking process that was interrupted by the need for user input or
97 * communication with an external provider */
98 const ACTION_LINK_CONTINUE
= 'link-continue';
99 /** Change a user's credentials */
100 const ACTION_CHANGE
= 'change';
101 /** Remove a user's credentials */
102 const ACTION_REMOVE
= 'remove';
103 /** Like ACTION_REMOVE but for linking providers only */
104 const ACTION_UNLINK
= 'unlink';
106 /** Security-sensitive operations are ok. */
108 /** Security-sensitive operations should re-authenticate. */
109 const SEC_REAUTH
= 'reauth';
110 /** Security-sensitive should not be performed. */
111 const SEC_FAIL
= 'fail';
113 /** Auto-creation is due to SessionManager */
114 const AUTOCREATE_SOURCE_SESSION
= \MediaWiki\Session\SessionManager
::class;
116 /** @var AuthManager|null */
117 private static $instance = null;
119 /** @var WebRequest */
125 /** @var LoggerInterface */
128 /** @var AuthenticationProvider[] */
129 private $allAuthenticationProviders = [];
131 /** @var PreAuthenticationProvider[] */
132 private $preAuthenticationProviders = null;
134 /** @var PrimaryAuthenticationProvider[] */
135 private $primaryAuthenticationProviders = null;
137 /** @var SecondaryAuthenticationProvider[] */
138 private $secondaryAuthenticationProviders = null;
140 /** @var CreatedAccountAuthenticationRequest[] */
141 private $createdAccountAuthenticationRequests = [];
144 * Get the global AuthManager
145 * @return AuthManager
147 public static function singleton() {
148 if ( self
::$instance === null ) {
149 self
::$instance = new self(
150 \RequestContext
::getMain()->getRequest(),
151 MediaWikiServices
::getInstance()->getMainConfig()
154 return self
::$instance;
158 * @param WebRequest $request
159 * @param Config $config
161 public function __construct( WebRequest
$request, Config
$config ) {
162 $this->request
= $request;
163 $this->config
= $config;
164 $this->setLogger( \MediaWiki\Logger\LoggerFactory
::getInstance( 'authentication' ) );
168 * @param LoggerInterface $logger
170 public function setLogger( LoggerInterface
$logger ) {
171 $this->logger
= $logger;
177 public function getRequest() {
178 return $this->request
;
182 * Force certain PrimaryAuthenticationProviders
183 * @deprecated For backwards compatibility only
184 * @param PrimaryAuthenticationProvider[] $providers
187 public function forcePrimaryAuthenticationProviders( array $providers, $why ) {
188 $this->logger
->warning( "Overriding AuthManager primary authn because $why" );
190 if ( $this->primaryAuthenticationProviders
!== null ) {
191 $this->logger
->warning(
192 'PrimaryAuthenticationProviders have already been accessed! I hope nothing breaks.'
195 $this->allAuthenticationProviders
= array_diff_key(
196 $this->allAuthenticationProviders
,
197 $this->primaryAuthenticationProviders
199 $session = $this->request
->getSession();
200 $session->remove( 'AuthManager::authnState' );
201 $session->remove( 'AuthManager::accountCreationState' );
202 $session->remove( 'AuthManager::accountLinkState' );
203 $this->createdAccountAuthenticationRequests
= [];
206 $this->primaryAuthenticationProviders
= [];
207 foreach ( $providers as $provider ) {
208 if ( !$provider instanceof PrimaryAuthenticationProvider
) {
209 throw new \
RuntimeException(
210 'Expected instance of MediaWiki\\Auth\\PrimaryAuthenticationProvider, got ' .
211 get_class( $provider )
214 $provider->setLogger( $this->logger
);
215 $provider->setManager( $this );
216 $provider->setConfig( $this->config
);
217 $id = $provider->getUniqueId();
218 if ( isset( $this->allAuthenticationProviders
[$id] ) ) {
219 throw new \
RuntimeException(
220 "Duplicate specifications for id $id (classes " .
221 get_class( $provider ) . ' and ' .
222 get_class( $this->allAuthenticationProviders
[$id] ) . ')'
225 $this->allAuthenticationProviders
[$id] = $provider;
226 $this->primaryAuthenticationProviders
[$id] = $provider;
231 * Call a legacy AuthPlugin method, if necessary
232 * @codeCoverageIgnore
233 * @deprecated For backwards compatibility only, should be avoided in new code
234 * @param string $method AuthPlugin method to call
235 * @param array $params Parameters to pass
236 * @param mixed $return Return value if AuthPlugin wasn't called
237 * @return mixed Return value from the AuthPlugin method, or $return
239 public static function callLegacyAuthPlugin( $method, array $params, $return = null ) {
242 if ( $wgAuth && !$wgAuth instanceof AuthManagerAuthPlugin
) {
243 return $wgAuth->$method( ...$params );
250 * @name Authentication
255 * Indicate whether user authentication is possible
257 * It may not be if the session is provided by something like OAuth
258 * for which each individual request includes authentication data.
262 public function canAuthenticateNow() {
263 return $this->request
->getSession()->canSetUser();
267 * Start an authentication flow
269 * In addition to the AuthenticationRequests returned by
270 * $this->getAuthenticationRequests(), a client might include a
271 * CreateFromLoginAuthenticationRequest from a previous login attempt to
274 * Instead of the AuthenticationRequests returned by
275 * $this->getAuthenticationRequests(), a client might pass a
276 * CreatedAccountAuthenticationRequest from an account creation that just
277 * succeeded to log in to the just-created account.
279 * @param AuthenticationRequest[] $reqs
280 * @param string $returnToUrl Url that REDIRECT responses should eventually
282 * @return AuthenticationResponse See self::continueAuthentication()
284 public function beginAuthentication( array $reqs, $returnToUrl ) {
285 $session = $this->request
->getSession();
286 if ( !$session->canSetUser() ) {
287 // Caller should have called canAuthenticateNow()
288 $session->remove( 'AuthManager::authnState' );
289 throw new \
LogicException( 'Authentication is not possible now' );
292 $guessUserName = null;
293 foreach ( $reqs as $req ) {
294 $req->returnToUrl
= $returnToUrl;
295 // @codeCoverageIgnoreStart
296 if ( $req->username
!== null && $req->username
!== '' ) {
297 if ( $guessUserName === null ) {
298 $guessUserName = $req->username
;
299 } elseif ( $guessUserName !== $req->username
) {
300 $guessUserName = null;
304 // @codeCoverageIgnoreEnd
307 // Check for special-case login of a just-created account
308 $req = AuthenticationRequest
::getRequestByClass(
309 $reqs, CreatedAccountAuthenticationRequest
::class
312 if ( !in_array( $req, $this->createdAccountAuthenticationRequests
, true ) ) {
313 throw new \
LogicException(
314 'CreatedAccountAuthenticationRequests are only valid on ' .
315 'the same AuthManager that created the account'
319 $user = User
::newFromName( $req->username
);
320 // @codeCoverageIgnoreStart
322 throw new \
UnexpectedValueException(
323 "CreatedAccountAuthenticationRequest had invalid username \"{$req->username}\""
325 } elseif ( $user->getId() != $req->id
) {
326 throw new \
UnexpectedValueException(
327 "ID for \"{$req->username}\" was {$user->getId()}, expected {$req->id}"
330 // @codeCoverageIgnoreEnd
332 $this->logger
->info( 'Logging in {user} after account creation', [
333 'user' => $user->getName(),
335 $ret = AuthenticationResponse
::newPass( $user->getName() );
336 $this->setSessionDataForUser( $user );
337 $this->callMethodOnProviders( 7, 'postAuthentication', [ $user, $ret ] );
338 $session->remove( 'AuthManager::authnState' );
339 \Hooks
::run( 'AuthManagerLoginAuthenticateAudit', [ $ret, $user, $user->getName() ] );
343 $this->removeAuthenticationSessionData( null );
345 foreach ( $this->getPreAuthenticationProviders() as $provider ) {
346 $status = $provider->testForAuthentication( $reqs );
347 if ( !$status->isGood() ) {
348 $this->logger
->debug( 'Login failed in pre-authentication by ' . $provider->getUniqueId() );
349 $ret = AuthenticationResponse
::newFail(
350 Status
::wrap( $status )->getMessage()
352 $this->callMethodOnProviders( 7, 'postAuthentication',
353 [ User
::newFromName( $guessUserName ) ?
: null, $ret ]
355 \Hooks
::run( 'AuthManagerLoginAuthenticateAudit', [ $ret, null, $guessUserName ] );
362 'returnToUrl' => $returnToUrl,
363 'guessUserName' => $guessUserName,
365 'primaryResponse' => null,
368 'continueRequests' => [],
371 // Preserve state from a previous failed login
372 $req = AuthenticationRequest
::getRequestByClass(
373 $reqs, CreateFromLoginAuthenticationRequest
::class
376 $state['maybeLink'] = $req->maybeLink
;
379 $session = $this->request
->getSession();
380 $session->setSecret( 'AuthManager::authnState', $state );
383 return $this->continueAuthentication( $reqs );
387 * Continue an authentication flow
389 * Return values are interpreted as follows:
390 * - status FAIL: Authentication failed. If $response->createRequest is
391 * set, that may be passed to self::beginAuthentication() or to
392 * self::beginAccountCreation() to preserve state.
393 * - status REDIRECT: The client should be redirected to the contained URL,
394 * new AuthenticationRequests should be made (if any), then
395 * AuthManager::continueAuthentication() should be called.
396 * - status UI: The client should be presented with a user interface for
397 * the fields in the specified AuthenticationRequests, then new
398 * AuthenticationRequests should be made, then
399 * AuthManager::continueAuthentication() should be called.
400 * - status RESTART: The user logged in successfully with a third-party
401 * service, but the third-party credentials aren't attached to any local
402 * account. This could be treated as a UI or a FAIL.
403 * - status PASS: Authentication was successful.
405 * @param AuthenticationRequest[] $reqs
406 * @return AuthenticationResponse
408 public function continueAuthentication( array $reqs ) {
409 $session = $this->request
->getSession();
411 if ( !$session->canSetUser() ) {
412 // Caller should have called canAuthenticateNow()
413 // @codeCoverageIgnoreStart
414 throw new \
LogicException( 'Authentication is not possible now' );
415 // @codeCoverageIgnoreEnd
418 $state = $session->getSecret( 'AuthManager::authnState' );
419 if ( !is_array( $state ) ) {
420 return AuthenticationResponse
::newFail(
421 wfMessage( 'authmanager-authn-not-in-progress' )
424 $state['continueRequests'] = [];
426 $guessUserName = $state['guessUserName'];
428 foreach ( $reqs as $req ) {
429 $req->returnToUrl
= $state['returnToUrl'];
432 // Step 1: Choose an primary authentication provider, and call it until it succeeds.
434 if ( $state['primary'] === null ) {
435 // We haven't picked a PrimaryAuthenticationProvider yet
436 // @codeCoverageIgnoreStart
437 $guessUserName = null;
438 foreach ( $reqs as $req ) {
439 if ( $req->username
!== null && $req->username
!== '' ) {
440 if ( $guessUserName === null ) {
441 $guessUserName = $req->username
;
442 } elseif ( $guessUserName !== $req->username
) {
443 $guessUserName = null;
448 $state['guessUserName'] = $guessUserName;
449 // @codeCoverageIgnoreEnd
450 $state['reqs'] = $reqs;
452 foreach ( $this->getPrimaryAuthenticationProviders() as $id => $provider ) {
453 $res = $provider->beginPrimaryAuthentication( $reqs );
454 switch ( $res->status
) {
455 case AuthenticationResponse
::PASS
;
456 $state['primary'] = $id;
457 $state['primaryResponse'] = $res;
458 $this->logger
->debug( "Primary login with $id succeeded" );
460 case AuthenticationResponse
::FAIL
;
461 $this->logger
->debug( "Login failed in primary authentication by $id" );
462 if ( $res->createRequest ||
$state['maybeLink'] ) {
463 $res->createRequest
= new CreateFromLoginAuthenticationRequest(
464 $res->createRequest
, $state['maybeLink']
467 $this->callMethodOnProviders( 7, 'postAuthentication',
468 [ User
::newFromName( $guessUserName ) ?
: null, $res ]
470 $session->remove( 'AuthManager::authnState' );
471 \Hooks
::run( 'AuthManagerLoginAuthenticateAudit', [ $res, null, $guessUserName ] );
473 case AuthenticationResponse
::ABSTAIN
;
476 case AuthenticationResponse
::REDIRECT
;
477 case AuthenticationResponse
::UI
;
478 $this->logger
->debug( "Primary login with $id returned $res->status" );
479 $this->fillRequests( $res->neededRequests
, self
::ACTION_LOGIN
, $guessUserName );
480 $state['primary'] = $id;
481 $state['continueRequests'] = $res->neededRequests
;
482 $session->setSecret( 'AuthManager::authnState', $state );
485 // @codeCoverageIgnoreStart
487 throw new \
DomainException(
488 get_class( $provider ) . "::beginPrimaryAuthentication() returned $res->status"
490 // @codeCoverageIgnoreEnd
493 if ( $state['primary'] === null ) {
494 $this->logger
->debug( 'Login failed in primary authentication because no provider accepted' );
495 $ret = AuthenticationResponse
::newFail(
496 wfMessage( 'authmanager-authn-no-primary' )
498 $this->callMethodOnProviders( 7, 'postAuthentication',
499 [ User
::newFromName( $guessUserName ) ?
: null, $ret ]
501 $session->remove( 'AuthManager::authnState' );
504 } elseif ( $state['primaryResponse'] === null ) {
505 $provider = $this->getAuthenticationProvider( $state['primary'] );
506 if ( !$provider instanceof PrimaryAuthenticationProvider
) {
507 // Configuration changed? Force them to start over.
508 // @codeCoverageIgnoreStart
509 $ret = AuthenticationResponse
::newFail(
510 wfMessage( 'authmanager-authn-not-in-progress' )
512 $this->callMethodOnProviders( 7, 'postAuthentication',
513 [ User
::newFromName( $guessUserName ) ?
: null, $ret ]
515 $session->remove( 'AuthManager::authnState' );
517 // @codeCoverageIgnoreEnd
519 $id = $provider->getUniqueId();
520 $res = $provider->continuePrimaryAuthentication( $reqs );
521 switch ( $res->status
) {
522 case AuthenticationResponse
::PASS
;
523 $state['primaryResponse'] = $res;
524 $this->logger
->debug( "Primary login with $id succeeded" );
526 case AuthenticationResponse
::FAIL
;
527 $this->logger
->debug( "Login failed in primary authentication by $id" );
528 if ( $res->createRequest ||
$state['maybeLink'] ) {
529 $res->createRequest
= new CreateFromLoginAuthenticationRequest(
530 $res->createRequest
, $state['maybeLink']
533 $this->callMethodOnProviders( 7, 'postAuthentication',
534 [ User
::newFromName( $guessUserName ) ?
: null, $res ]
536 $session->remove( 'AuthManager::authnState' );
537 \Hooks
::run( 'AuthManagerLoginAuthenticateAudit', [ $res, null, $guessUserName ] );
539 case AuthenticationResponse
::REDIRECT
;
540 case AuthenticationResponse
::UI
;
541 $this->logger
->debug( "Primary login with $id returned $res->status" );
542 $this->fillRequests( $res->neededRequests
, self
::ACTION_LOGIN
, $guessUserName );
543 $state['continueRequests'] = $res->neededRequests
;
544 $session->setSecret( 'AuthManager::authnState', $state );
547 throw new \
DomainException(
548 get_class( $provider ) . "::continuePrimaryAuthentication() returned $res->status"
553 $res = $state['primaryResponse'];
554 if ( $res->username
=== null ) {
555 $provider = $this->getAuthenticationProvider( $state['primary'] );
556 if ( !$provider instanceof PrimaryAuthenticationProvider
) {
557 // Configuration changed? Force them to start over.
558 // @codeCoverageIgnoreStart
559 $ret = AuthenticationResponse
::newFail(
560 wfMessage( 'authmanager-authn-not-in-progress' )
562 $this->callMethodOnProviders( 7, 'postAuthentication',
563 [ User
::newFromName( $guessUserName ) ?
: null, $ret ]
565 $session->remove( 'AuthManager::authnState' );
567 // @codeCoverageIgnoreEnd
570 if ( $provider->accountCreationType() === PrimaryAuthenticationProvider
::TYPE_LINK
&&
572 // don't confuse the user with an incorrect message if linking is disabled
573 $this->getAuthenticationProvider( ConfirmLinkSecondaryAuthenticationProvider
::class )
575 $state['maybeLink'][$res->linkRequest
->getUniqueId()] = $res->linkRequest
;
576 $msg = 'authmanager-authn-no-local-user-link';
578 $msg = 'authmanager-authn-no-local-user';
580 $this->logger
->debug(
581 "Primary login with {$provider->getUniqueId()} succeeded, but returned no user"
583 $ret = AuthenticationResponse
::newRestart( wfMessage( $msg ) );
584 $ret->neededRequests
= $this->getAuthenticationRequestsInternal(
587 $this->getPrimaryAuthenticationProviders() +
$this->getSecondaryAuthenticationProviders()
589 if ( $res->createRequest ||
$state['maybeLink'] ) {
590 $ret->createRequest
= new CreateFromLoginAuthenticationRequest(
591 $res->createRequest
, $state['maybeLink']
593 $ret->neededRequests
[] = $ret->createRequest
;
595 $this->fillRequests( $ret->neededRequests
, self
::ACTION_LOGIN
, null, true );
596 $session->setSecret( 'AuthManager::authnState', [
597 'reqs' => [], // Will be filled in later
599 'primaryResponse' => null,
601 'continueRequests' => $ret->neededRequests
,
606 // Step 2: Primary authentication succeeded, create the User object
607 // (and add the user locally if necessary)
609 $user = User
::newFromName( $res->username
, 'usable' );
611 $provider = $this->getAuthenticationProvider( $state['primary'] );
612 throw new \
DomainException(
613 get_class( $provider ) . " returned an invalid username: {$res->username}"
616 if ( $user->getId() === 0 ) {
617 // User doesn't exist locally. Create it.
618 $this->logger
->info( 'Auto-creating {user} on login', [
619 'user' => $user->getName(),
621 $status = $this->autoCreateUser( $user, $state['primary'], false );
622 if ( !$status->isGood() ) {
623 $ret = AuthenticationResponse
::newFail(
624 Status
::wrap( $status )->getMessage( 'authmanager-authn-autocreate-failed' )
626 $this->callMethodOnProviders( 7, 'postAuthentication', [ $user, $ret ] );
627 $session->remove( 'AuthManager::authnState' );
628 \Hooks
::run( 'AuthManagerLoginAuthenticateAudit', [ $ret, $user, $user->getName() ] );
633 // Step 3: Iterate over all the secondary authentication providers.
635 $beginReqs = $state['reqs'];
637 foreach ( $this->getSecondaryAuthenticationProviders() as $id => $provider ) {
638 if ( !isset( $state['secondary'][$id] ) ) {
639 // This provider isn't started yet, so we pass it the set
640 // of reqs from beginAuthentication instead of whatever
641 // might have been used by a previous provider in line.
642 $func = 'beginSecondaryAuthentication';
643 $res = $provider->beginSecondaryAuthentication( $user, $beginReqs );
644 } elseif ( !$state['secondary'][$id] ) {
645 $func = 'continueSecondaryAuthentication';
646 $res = $provider->continueSecondaryAuthentication( $user, $reqs );
650 switch ( $res->status
) {
651 case AuthenticationResponse
::PASS
;
652 $this->logger
->debug( "Secondary login with $id succeeded" );
654 case AuthenticationResponse
::ABSTAIN
;
655 $state['secondary'][$id] = true;
657 case AuthenticationResponse
::FAIL
;
658 $this->logger
->debug( "Login failed in secondary authentication by $id" );
659 $this->callMethodOnProviders( 7, 'postAuthentication', [ $user, $res ] );
660 $session->remove( 'AuthManager::authnState' );
661 \Hooks
::run( 'AuthManagerLoginAuthenticateAudit', [ $res, $user, $user->getName() ] );
663 case AuthenticationResponse
::REDIRECT
;
664 case AuthenticationResponse
::UI
;
665 $this->logger
->debug( "Secondary login with $id returned " . $res->status
);
666 $this->fillRequests( $res->neededRequests
, self
::ACTION_LOGIN
, $user->getName() );
667 $state['secondary'][$id] = false;
668 $state['continueRequests'] = $res->neededRequests
;
669 $session->setSecret( 'AuthManager::authnState', $state );
672 // @codeCoverageIgnoreStart
674 throw new \
DomainException(
675 get_class( $provider ) . "::{$func}() returned $res->status"
677 // @codeCoverageIgnoreEnd
681 // Step 4: Authentication complete! Set the user in the session and
684 $this->logger
->info( 'Login for {user} succeeded', [
685 'user' => $user->getName(),
687 /** @var RememberMeAuthenticationRequest $req */
688 $req = AuthenticationRequest
::getRequestByClass(
689 $beginReqs, RememberMeAuthenticationRequest
::class
691 $this->setSessionDataForUser( $user, $req && $req->rememberMe
);
692 $ret = AuthenticationResponse
::newPass( $user->getName() );
693 $this->callMethodOnProviders( 7, 'postAuthentication', [ $user, $ret ] );
694 $session->remove( 'AuthManager::authnState' );
695 $this->removeAuthenticationSessionData( null );
696 \Hooks
::run( 'AuthManagerLoginAuthenticateAudit', [ $ret, $user, $user->getName() ] );
698 } catch ( \Exception
$ex ) {
699 $session->remove( 'AuthManager::authnState' );
705 * Whether security-sensitive operations should proceed.
707 * A "security-sensitive operation" is something like a password or email
708 * change, that would normally have a "reenter your password to confirm"
709 * box if we only supported password-based authentication.
711 * @param string $operation Operation being checked. This should be a
712 * message-key-like string such as 'change-password' or 'change-email'.
713 * @return string One of the SEC_* constants.
715 public function securitySensitiveOperationStatus( $operation ) {
716 $status = self
::SEC_OK
;
718 $this->logger
->debug( __METHOD__
. ": Checking $operation" );
720 $session = $this->request
->getSession();
721 $aId = $session->getUser()->getId();
723 // User isn't authenticated. DWIM?
724 $status = $this->canAuthenticateNow() ? self
::SEC_REAUTH
: self
::SEC_FAIL
;
725 $this->logger
->info( __METHOD__
. ": Not logged in! $operation is $status" );
729 if ( $session->canSetUser() ) {
730 $id = $session->get( 'AuthManager:lastAuthId' );
731 $last = $session->get( 'AuthManager:lastAuthTimestamp' );
732 if ( $id !== $aId ||
$last === null ) {
733 $timeSinceLogin = PHP_INT_MAX
; // Forever ago
735 $timeSinceLogin = max( 0, time() - $last );
738 $thresholds = $this->config
->get( 'ReauthenticateTime' );
739 if ( isset( $thresholds[$operation] ) ) {
740 $threshold = $thresholds[$operation];
741 } elseif ( isset( $thresholds['default'] ) ) {
742 $threshold = $thresholds['default'];
744 throw new \
UnexpectedValueException( '$wgReauthenticateTime lacks a default' );
747 if ( $threshold >= 0 && $timeSinceLogin > $threshold ) {
748 $status = self
::SEC_REAUTH
;
751 $timeSinceLogin = -1;
753 $pass = $this->config
->get( 'AllowSecuritySensitiveOperationIfCannotReauthenticate' );
754 if ( isset( $pass[$operation] ) ) {
755 $status = $pass[$operation] ? self
::SEC_OK
: self
::SEC_FAIL
;
756 } elseif ( isset( $pass['default'] ) ) {
757 $status = $pass['default'] ? self
::SEC_OK
: self
::SEC_FAIL
;
759 throw new \
UnexpectedValueException(
760 '$wgAllowSecuritySensitiveOperationIfCannotReauthenticate lacks a default'
765 \Hooks
::run( 'SecuritySensitiveOperationStatus', [
766 &$status, $operation, $session, $timeSinceLogin
769 // If authentication is not possible, downgrade from "REAUTH" to "FAIL".
770 if ( !$this->canAuthenticateNow() && $status === self
::SEC_REAUTH
) {
771 $status = self
::SEC_FAIL
;
774 $this->logger
->info( __METHOD__
. ": $operation is $status for '{user}'",
776 'user' => $session->getUser()->getName(),
777 'clientip' => $this->getRequest()->getIP(),
785 * Determine whether a username can authenticate
787 * This is mainly for internal purposes and only takes authentication data into account,
788 * not things like blocks that can change without the authentication system being aware.
790 * @param string $username MediaWiki username
793 public function userCanAuthenticate( $username ) {
794 foreach ( $this->getPrimaryAuthenticationProviders() as $provider ) {
795 if ( $provider->testUserCanAuthenticate( $username ) ) {
803 * Provide normalized versions of the username for security checks
805 * Since different providers can normalize the input in different ways,
806 * this returns an array of all the different ways the name might be
807 * normalized for authentication.
809 * The returned strings should not be revealed to the user, as that might
810 * leak private information (e.g. an email address might be normalized to a
813 * @param string $username
816 public function normalizeUsername( $username ) {
818 foreach ( $this->getPrimaryAuthenticationProviders() as $provider ) {
819 $normalized = $provider->providerNormalizeUsername( $username );
820 if ( $normalized !== null ) {
821 $ret[$normalized] = true;
824 return array_keys( $ret );
830 * @name Authentication data changing
835 * Revoke any authentication credentials for a user
837 * After this, the user should no longer be able to log in.
839 * @param string $username
841 public function revokeAccessForUser( $username ) {
842 $this->logger
->info( 'Revoking access for {user}', [
845 $this->callMethodOnProviders( 6, 'providerRevokeAccessForUser', [ $username ] );
849 * Validate a change of authentication data (e.g. passwords)
850 * @param AuthenticationRequest $req
851 * @param bool $checkData If false, $req hasn't been loaded from the
852 * submission so checks on user-submitted fields should be skipped. $req->username is
853 * considered user-submitted for this purpose, even if it cannot be changed via
854 * $req->loadFromSubmission.
857 public function allowsAuthenticationDataChange( AuthenticationRequest
$req, $checkData = true ) {
859 $providers = $this->getPrimaryAuthenticationProviders() +
860 $this->getSecondaryAuthenticationProviders();
861 foreach ( $providers as $provider ) {
862 $status = $provider->providerAllowsAuthenticationDataChange( $req, $checkData );
863 if ( !$status->isGood() ) {
864 return Status
::wrap( $status );
866 $any = $any ||
$status->value
!== 'ignored';
869 $status = Status
::newGood( 'ignored' );
870 $status->warning( 'authmanager-change-not-supported' );
873 return Status
::newGood();
877 * Change authentication data (e.g. passwords)
879 * If $req was returned for AuthManager::ACTION_CHANGE, using $req should
880 * result in a successful login in the future.
882 * If $req was returned for AuthManager::ACTION_REMOVE, using $req should
883 * no longer result in a successful login.
885 * This method should only be called if allowsAuthenticationDataChange( $req, true )
888 * @param AuthenticationRequest $req
890 public function changeAuthenticationData( AuthenticationRequest
$req ) {
891 $this->logger
->info( 'Changing authentication data for {user} class {what}', [
892 'user' => is_string( $req->username
) ?
$req->username
: '<no name>',
893 'what' => get_class( $req ),
896 $this->callMethodOnProviders( 6, 'providerChangeAuthenticationData', [ $req ] );
898 // When the main account's authentication data is changed, invalidate
899 // all BotPasswords too.
900 \BotPassword
::invalidateAllPasswordsForUser( $req->username
);
906 * @name Account creation
911 * Determine whether accounts can be created
914 public function canCreateAccounts() {
915 foreach ( $this->getPrimaryAuthenticationProviders() as $provider ) {
916 switch ( $provider->accountCreationType() ) {
917 case PrimaryAuthenticationProvider
::TYPE_CREATE
:
918 case PrimaryAuthenticationProvider
::TYPE_LINK
:
926 * Determine whether a particular account can be created
927 * @param string $username MediaWiki username
928 * @param array $options
929 * - flags: (int) Bitfield of User:READ_* constants, default User::READ_NORMAL
930 * - creating: (bool) For internal use only. Never specify this.
933 public function canCreateAccount( $username, $options = [] ) {
935 if ( is_int( $options ) ) {
936 $options = [ 'flags' => $options ];
939 'flags' => User
::READ_NORMAL
,
942 $flags = $options['flags'];
944 if ( !$this->canCreateAccounts() ) {
945 return Status
::newFatal( 'authmanager-create-disabled' );
948 if ( $this->userExists( $username, $flags ) ) {
949 return Status
::newFatal( 'userexists' );
952 $user = User
::newFromName( $username, 'creatable' );
953 if ( !is_object( $user ) ) {
954 return Status
::newFatal( 'noname' );
956 $user->load( $flags ); // Explicitly load with $flags, auto-loading always uses READ_NORMAL
957 if ( $user->getId() !== 0 ) {
958 return Status
::newFatal( 'userexists' );
962 // Denied by providers?
963 $providers = $this->getPreAuthenticationProviders() +
964 $this->getPrimaryAuthenticationProviders() +
965 $this->getSecondaryAuthenticationProviders();
966 foreach ( $providers as $provider ) {
967 $status = $provider->testUserForCreation( $user, false, $options );
968 if ( !$status->isGood() ) {
969 return Status
::wrap( $status );
973 return Status
::newGood();
977 * Basic permissions checks on whether a user can create accounts
978 * @param User $creator User doing the account creation
981 public function checkAccountCreatePermissions( User
$creator ) {
982 // Wiki is read-only?
983 if ( wfReadOnly() ) {
984 return Status
::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
987 // This is awful, this permission check really shouldn't go through Title.
988 $permErrors = \SpecialPage
::getTitleFor( 'CreateAccount' )
989 ->getUserPermissionsErrors( 'createaccount', $creator, 'secure' );
991 $status = Status
::newGood();
992 foreach ( $permErrors as $args ) {
993 $status->fatal( ...$args );
998 $block = $creator->isBlockedFromCreateAccount();
1001 $block->getTarget(),
1002 $block->mReason ?
: wfMessage( 'blockednoreason' )->text(),
1006 if ( $block->getType() === \Block
::TYPE_RANGE
) {
1007 $errorMessage = 'cantcreateaccount-range-text';
1008 $errorParams[] = $this->getRequest()->getIP();
1010 $errorMessage = 'cantcreateaccount-text';
1013 return Status
::newFatal( wfMessage( $errorMessage, $errorParams ) );
1016 $ip = $this->getRequest()->getIP();
1017 if ( $creator->isDnsBlacklisted( $ip, true /* check $wgProxyWhitelist */ ) ) {
1018 return Status
::newFatal( 'sorbs_create_account_reason' );
1021 return Status
::newGood();
1025 * Start an account creation flow
1027 * In addition to the AuthenticationRequests returned by
1028 * $this->getAuthenticationRequests(), a client might include a
1029 * CreateFromLoginAuthenticationRequest from a previous login attempt. If
1031 * $createFromLoginAuthenticationRequest->hasPrimaryStateForAction( AuthManager::ACTION_CREATE )
1033 * returns true, any AuthenticationRequest::PRIMARY_REQUIRED requests
1034 * should be omitted. If the CreateFromLoginAuthenticationRequest has a
1035 * username set, that username must be used for all other requests.
1037 * @param User $creator User doing the account creation
1038 * @param AuthenticationRequest[] $reqs
1039 * @param string $returnToUrl Url that REDIRECT responses should eventually
1041 * @return AuthenticationResponse
1043 public function beginAccountCreation( User
$creator, array $reqs, $returnToUrl ) {
1044 $session = $this->request
->getSession();
1045 if ( !$this->canCreateAccounts() ) {
1046 // Caller should have called canCreateAccounts()
1047 $session->remove( 'AuthManager::accountCreationState' );
1048 throw new \
LogicException( 'Account creation is not possible' );
1052 $username = AuthenticationRequest
::getUsernameFromRequests( $reqs );
1053 } catch ( \UnexpectedValueException
$ex ) {
1056 if ( $username === null ) {
1057 $this->logger
->debug( __METHOD__
. ': No username provided' );
1058 return AuthenticationResponse
::newFail( wfMessage( 'noname' ) );
1061 // Permissions check
1062 $status = $this->checkAccountCreatePermissions( $creator );
1063 if ( !$status->isGood() ) {
1064 $this->logger
->debug( __METHOD__
. ': {creator} cannot create users: {reason}', [
1065 'user' => $username,
1066 'creator' => $creator->getName(),
1067 'reason' => $status->getWikiText( null, null, 'en' )
1069 return AuthenticationResponse
::newFail( $status->getMessage() );
1072 $status = $this->canCreateAccount(
1073 $username, [ 'flags' => User
::READ_LOCKING
, 'creating' => true ]
1075 if ( !$status->isGood() ) {
1076 $this->logger
->debug( __METHOD__
. ': {user} cannot be created: {reason}', [
1077 'user' => $username,
1078 'creator' => $creator->getName(),
1079 'reason' => $status->getWikiText( null, null, 'en' )
1081 return AuthenticationResponse
::newFail( $status->getMessage() );
1084 $user = User
::newFromName( $username, 'creatable' );
1085 foreach ( $reqs as $req ) {
1086 $req->username
= $username;
1087 $req->returnToUrl
= $returnToUrl;
1088 if ( $req instanceof UserDataAuthenticationRequest
) {
1089 $status = $req->populateUser( $user );
1090 if ( !$status->isGood() ) {
1091 $status = Status
::wrap( $status );
1092 $session->remove( 'AuthManager::accountCreationState' );
1093 $this->logger
->debug( __METHOD__
. ': UserData is invalid: {reason}', [
1094 'user' => $user->getName(),
1095 'creator' => $creator->getName(),
1096 'reason' => $status->getWikiText( null, null, 'en' ),
1098 return AuthenticationResponse
::newFail( $status->getMessage() );
1103 $this->removeAuthenticationSessionData( null );
1106 'username' => $username,
1108 'creatorid' => $creator->getId(),
1109 'creatorname' => $creator->getName(),
1111 'returnToUrl' => $returnToUrl,
1113 'primaryResponse' => null,
1115 'continueRequests' => [],
1117 'ranPreTests' => false,
1120 // Special case: converting a login to an account creation
1121 $req = AuthenticationRequest
::getRequestByClass(
1122 $reqs, CreateFromLoginAuthenticationRequest
::class
1125 $state['maybeLink'] = $req->maybeLink
;
1127 if ( $req->createRequest
) {
1128 $reqs[] = $req->createRequest
;
1129 $state['reqs'][] = $req->createRequest
;
1133 $session->setSecret( 'AuthManager::accountCreationState', $state );
1134 $session->persist();
1136 return $this->continueAccountCreation( $reqs );
1140 * Continue an account creation flow
1141 * @param AuthenticationRequest[] $reqs
1142 * @return AuthenticationResponse
1144 public function continueAccountCreation( array $reqs ) {
1145 $session = $this->request
->getSession();
1147 if ( !$this->canCreateAccounts() ) {
1148 // Caller should have called canCreateAccounts()
1149 $session->remove( 'AuthManager::accountCreationState' );
1150 throw new \
LogicException( 'Account creation is not possible' );
1153 $state = $session->getSecret( 'AuthManager::accountCreationState' );
1154 if ( !is_array( $state ) ) {
1155 return AuthenticationResponse
::newFail(
1156 wfMessage( 'authmanager-create-not-in-progress' )
1159 $state['continueRequests'] = [];
1161 // Step 0: Prepare and validate the input
1163 $user = User
::newFromName( $state['username'], 'creatable' );
1164 if ( !is_object( $user ) ) {
1165 $session->remove( 'AuthManager::accountCreationState' );
1166 $this->logger
->debug( __METHOD__
. ': Invalid username', [
1167 'user' => $state['username'],
1169 return AuthenticationResponse
::newFail( wfMessage( 'noname' ) );
1172 if ( $state['creatorid'] ) {
1173 $creator = User
::newFromId( $state['creatorid'] );
1175 $creator = new User
;
1176 $creator->setName( $state['creatorname'] );
1179 // Avoid account creation races on double submissions
1180 $cache = \ObjectCache
::getLocalClusterInstance();
1181 $lock = $cache->getScopedLock( $cache->makeGlobalKey( 'account', md5( $user->getName() ) ) );
1183 // Don't clear AuthManager::accountCreationState for this code
1184 // path because the process that won the race owns it.
1185 $this->logger
->debug( __METHOD__
. ': Could not acquire account creation lock', [
1186 'user' => $user->getName(),
1187 'creator' => $creator->getName(),
1189 return AuthenticationResponse
::newFail( wfMessage( 'usernameinprogress' ) );
1192 // Permissions check
1193 $status = $this->checkAccountCreatePermissions( $creator );
1194 if ( !$status->isGood() ) {
1195 $this->logger
->debug( __METHOD__
. ': {creator} cannot create users: {reason}', [
1196 'user' => $user->getName(),
1197 'creator' => $creator->getName(),
1198 'reason' => $status->getWikiText( null, null, 'en' )
1200 $ret = AuthenticationResponse
::newFail( $status->getMessage() );
1201 $this->callMethodOnProviders( 7, 'postAccountCreation', [ $user, $creator, $ret ] );
1202 $session->remove( 'AuthManager::accountCreationState' );
1206 // Load from master for existence check
1207 $user->load( User
::READ_LOCKING
);
1209 if ( $state['userid'] === 0 ) {
1210 if ( $user->getId() != 0 ) {
1211 $this->logger
->debug( __METHOD__
. ': User exists locally', [
1212 'user' => $user->getName(),
1213 'creator' => $creator->getName(),
1215 $ret = AuthenticationResponse
::newFail( wfMessage( 'userexists' ) );
1216 $this->callMethodOnProviders( 7, 'postAccountCreation', [ $user, $creator, $ret ] );
1217 $session->remove( 'AuthManager::accountCreationState' );
1221 if ( $user->getId() == 0 ) {
1222 $this->logger
->debug( __METHOD__
. ': User does not exist locally when it should', [
1223 'user' => $user->getName(),
1224 'creator' => $creator->getName(),
1225 'expected_id' => $state['userid'],
1227 throw new \
UnexpectedValueException(
1228 "User \"{$state['username']}\" should exist now, but doesn't!"
1231 if ( $user->getId() != $state['userid'] ) {
1232 $this->logger
->debug( __METHOD__
. ': User ID/name mismatch', [
1233 'user' => $user->getName(),
1234 'creator' => $creator->getName(),
1235 'expected_id' => $state['userid'],
1236 'actual_id' => $user->getId(),
1238 throw new \
UnexpectedValueException(
1239 "User \"{$state['username']}\" exists, but " .
1240 "ID {$user->getId()} != {$state['userid']}!"
1244 foreach ( $state['reqs'] as $req ) {
1245 if ( $req instanceof UserDataAuthenticationRequest
) {
1246 $status = $req->populateUser( $user );
1247 if ( !$status->isGood() ) {
1248 // This should never happen...
1249 $status = Status
::wrap( $status );
1250 $this->logger
->debug( __METHOD__
. ': UserData is invalid: {reason}', [
1251 'user' => $user->getName(),
1252 'creator' => $creator->getName(),
1253 'reason' => $status->getWikiText( null, null, 'en' ),
1255 $ret = AuthenticationResponse
::newFail( $status->getMessage() );
1256 $this->callMethodOnProviders( 7, 'postAccountCreation', [ $user, $creator, $ret ] );
1257 $session->remove( 'AuthManager::accountCreationState' );
1263 foreach ( $reqs as $req ) {
1264 $req->returnToUrl
= $state['returnToUrl'];
1265 $req->username
= $state['username'];
1268 // Run pre-creation tests, if we haven't already
1269 if ( !$state['ranPreTests'] ) {
1270 $providers = $this->getPreAuthenticationProviders() +
1271 $this->getPrimaryAuthenticationProviders() +
1272 $this->getSecondaryAuthenticationProviders();
1273 foreach ( $providers as $id => $provider ) {
1274 $status = $provider->testForAccountCreation( $user, $creator, $reqs );
1275 if ( !$status->isGood() ) {
1276 $this->logger
->debug( __METHOD__
. ": Fail in pre-authentication by $id", [
1277 'user' => $user->getName(),
1278 'creator' => $creator->getName(),
1280 $ret = AuthenticationResponse
::newFail(
1281 Status
::wrap( $status )->getMessage()
1283 $this->callMethodOnProviders( 7, 'postAccountCreation', [ $user, $creator, $ret ] );
1284 $session->remove( 'AuthManager::accountCreationState' );
1289 $state['ranPreTests'] = true;
1292 // Step 1: Choose a primary authentication provider and call it until it succeeds.
1294 if ( $state['primary'] === null ) {
1295 // We haven't picked a PrimaryAuthenticationProvider yet
1296 foreach ( $this->getPrimaryAuthenticationProviders() as $id => $provider ) {
1297 if ( $provider->accountCreationType() === PrimaryAuthenticationProvider
::TYPE_NONE
) {
1300 $res = $provider->beginPrimaryAccountCreation( $user, $creator, $reqs );
1301 switch ( $res->status
) {
1302 case AuthenticationResponse
::PASS
;
1303 $this->logger
->debug( __METHOD__
. ": Primary creation passed by $id", [
1304 'user' => $user->getName(),
1305 'creator' => $creator->getName(),
1307 $state['primary'] = $id;
1308 $state['primaryResponse'] = $res;
1310 case AuthenticationResponse
::FAIL
;
1311 $this->logger
->debug( __METHOD__
. ": Primary creation failed by $id", [
1312 'user' => $user->getName(),
1313 'creator' => $creator->getName(),
1315 $this->callMethodOnProviders( 7, 'postAccountCreation', [ $user, $creator, $res ] );
1316 $session->remove( 'AuthManager::accountCreationState' );
1318 case AuthenticationResponse
::ABSTAIN
;
1321 case AuthenticationResponse
::REDIRECT
;
1322 case AuthenticationResponse
::UI
;
1323 $this->logger
->debug( __METHOD__
. ": Primary creation $res->status by $id", [
1324 'user' => $user->getName(),
1325 'creator' => $creator->getName(),
1327 $this->fillRequests( $res->neededRequests
, self
::ACTION_CREATE
, null );
1328 $state['primary'] = $id;
1329 $state['continueRequests'] = $res->neededRequests
;
1330 $session->setSecret( 'AuthManager::accountCreationState', $state );
1333 // @codeCoverageIgnoreStart
1335 throw new \
DomainException(
1336 get_class( $provider ) . "::beginPrimaryAccountCreation() returned $res->status"
1338 // @codeCoverageIgnoreEnd
1341 if ( $state['primary'] === null ) {
1342 $this->logger
->debug( __METHOD__
. ': Primary creation failed because no provider accepted', [
1343 'user' => $user->getName(),
1344 'creator' => $creator->getName(),
1346 $ret = AuthenticationResponse
::newFail(
1347 wfMessage( 'authmanager-create-no-primary' )
1349 $this->callMethodOnProviders( 7, 'postAccountCreation', [ $user, $creator, $ret ] );
1350 $session->remove( 'AuthManager::accountCreationState' );
1353 } elseif ( $state['primaryResponse'] === null ) {
1354 $provider = $this->getAuthenticationProvider( $state['primary'] );
1355 if ( !$provider instanceof PrimaryAuthenticationProvider
) {
1356 // Configuration changed? Force them to start over.
1357 // @codeCoverageIgnoreStart
1358 $ret = AuthenticationResponse
::newFail(
1359 wfMessage( 'authmanager-create-not-in-progress' )
1361 $this->callMethodOnProviders( 7, 'postAccountCreation', [ $user, $creator, $ret ] );
1362 $session->remove( 'AuthManager::accountCreationState' );
1364 // @codeCoverageIgnoreEnd
1366 $id = $provider->getUniqueId();
1367 $res = $provider->continuePrimaryAccountCreation( $user, $creator, $reqs );
1368 switch ( $res->status
) {
1369 case AuthenticationResponse
::PASS
;
1370 $this->logger
->debug( __METHOD__
. ": Primary creation passed by $id", [
1371 'user' => $user->getName(),
1372 'creator' => $creator->getName(),
1374 $state['primaryResponse'] = $res;
1376 case AuthenticationResponse
::FAIL
;
1377 $this->logger
->debug( __METHOD__
. ": Primary creation failed by $id", [
1378 'user' => $user->getName(),
1379 'creator' => $creator->getName(),
1381 $this->callMethodOnProviders( 7, 'postAccountCreation', [ $user, $creator, $res ] );
1382 $session->remove( 'AuthManager::accountCreationState' );
1384 case AuthenticationResponse
::REDIRECT
;
1385 case AuthenticationResponse
::UI
;
1386 $this->logger
->debug( __METHOD__
. ": Primary creation $res->status by $id", [
1387 'user' => $user->getName(),
1388 'creator' => $creator->getName(),
1390 $this->fillRequests( $res->neededRequests
, self
::ACTION_CREATE
, null );
1391 $state['continueRequests'] = $res->neededRequests
;
1392 $session->setSecret( 'AuthManager::accountCreationState', $state );
1395 throw new \
DomainException(
1396 get_class( $provider ) . "::continuePrimaryAccountCreation() returned $res->status"
1401 // Step 2: Primary authentication succeeded, create the User object
1402 // and add the user locally.
1404 if ( $state['userid'] === 0 ) {
1405 $this->logger
->info( 'Creating user {user} during account creation', [
1406 'user' => $user->getName(),
1407 'creator' => $creator->getName(),
1409 $status = $user->addToDatabase();
1410 if ( !$status->isOK() ) {
1411 // @codeCoverageIgnoreStart
1412 $ret = AuthenticationResponse
::newFail( $status->getMessage() );
1413 $this->callMethodOnProviders( 7, 'postAccountCreation', [ $user, $creator, $ret ] );
1414 $session->remove( 'AuthManager::accountCreationState' );
1416 // @codeCoverageIgnoreEnd
1418 $this->setDefaultUserOptions( $user, $creator->isAnon() );
1419 \Hooks
::run( 'LocalUserCreated', [ $user, false ] );
1420 $user->saveSettings();
1421 $state['userid'] = $user->getId();
1423 // Update user count
1424 \DeferredUpdates
::addUpdate( \SiteStatsUpdate
::factory( [ 'users' => 1 ] ) );
1426 // Watch user's userpage and talk page
1427 $user->addWatch( $user->getUserPage(), User
::IGNORE_USER_RIGHTS
);
1429 // Inform the provider
1430 $logSubtype = $provider->finishAccountCreation( $user, $creator, $state['primaryResponse'] );
1433 if ( $this->config
->get( 'NewUserLog' ) ) {
1434 $isAnon = $creator->isAnon();
1435 $logEntry = new \
ManualLogEntry(
1437 $logSubtype ?
: ( $isAnon ?
'create' : 'create2' )
1439 $logEntry->setPerformer( $isAnon ?
$user : $creator );
1440 $logEntry->setTarget( $user->getUserPage() );
1441 /** @var CreationReasonAuthenticationRequest $req */
1442 $req = AuthenticationRequest
::getRequestByClass(
1443 $state['reqs'], CreationReasonAuthenticationRequest
::class
1445 $logEntry->setComment( $req ?
$req->reason
: '' );
1446 $logEntry->setParameters( [
1447 '4::userid' => $user->getId(),
1449 $logid = $logEntry->insert();
1450 $logEntry->publish( $logid );
1454 // Step 3: Iterate over all the secondary authentication providers.
1456 $beginReqs = $state['reqs'];
1458 foreach ( $this->getSecondaryAuthenticationProviders() as $id => $provider ) {
1459 if ( !isset( $state['secondary'][$id] ) ) {
1460 // This provider isn't started yet, so we pass it the set
1461 // of reqs from beginAuthentication instead of whatever
1462 // might have been used by a previous provider in line.
1463 $func = 'beginSecondaryAccountCreation';
1464 $res = $provider->beginSecondaryAccountCreation( $user, $creator, $beginReqs );
1465 } elseif ( !$state['secondary'][$id] ) {
1466 $func = 'continueSecondaryAccountCreation';
1467 $res = $provider->continueSecondaryAccountCreation( $user, $creator, $reqs );
1471 switch ( $res->status
) {
1472 case AuthenticationResponse
::PASS
;
1473 $this->logger
->debug( __METHOD__
. ": Secondary creation passed by $id", [
1474 'user' => $user->getName(),
1475 'creator' => $creator->getName(),
1478 case AuthenticationResponse
::ABSTAIN
;
1479 $state['secondary'][$id] = true;
1481 case AuthenticationResponse
::REDIRECT
;
1482 case AuthenticationResponse
::UI
;
1483 $this->logger
->debug( __METHOD__
. ": Secondary creation $res->status by $id", [
1484 'user' => $user->getName(),
1485 'creator' => $creator->getName(),
1487 $this->fillRequests( $res->neededRequests
, self
::ACTION_CREATE
, null );
1488 $state['secondary'][$id] = false;
1489 $state['continueRequests'] = $res->neededRequests
;
1490 $session->setSecret( 'AuthManager::accountCreationState', $state );
1492 case AuthenticationResponse
::FAIL
;
1493 throw new \
DomainException(
1494 get_class( $provider ) . "::{$func}() returned $res->status." .
1495 ' Secondary providers are not allowed to fail account creation, that' .
1496 ' should have been done via testForAccountCreation().'
1498 // @codeCoverageIgnoreStart
1500 throw new \
DomainException(
1501 get_class( $provider ) . "::{$func}() returned $res->status"
1503 // @codeCoverageIgnoreEnd
1507 $id = $user->getId();
1508 $name = $user->getName();
1509 $req = new CreatedAccountAuthenticationRequest( $id, $name );
1510 $ret = AuthenticationResponse
::newPass( $name );
1511 $ret->loginRequest
= $req;
1512 $this->createdAccountAuthenticationRequests
[] = $req;
1514 $this->logger
->info( __METHOD__
. ': Account creation succeeded for {user}', [
1515 'user' => $user->getName(),
1516 'creator' => $creator->getName(),
1519 $this->callMethodOnProviders( 7, 'postAccountCreation', [ $user, $creator, $ret ] );
1520 $session->remove( 'AuthManager::accountCreationState' );
1521 $this->removeAuthenticationSessionData( null );
1523 } catch ( \Exception
$ex ) {
1524 $session->remove( 'AuthManager::accountCreationState' );
1530 * Auto-create an account, and log into that account
1532 * PrimaryAuthenticationProviders can invoke this method by returning a PASS from
1533 * beginPrimaryAuthentication/continuePrimaryAuthentication with the username of a
1534 * non-existing user. SessionProviders can invoke it by returning a SessionInfo with
1535 * the username of a non-existing user from provideSessionInfo(). Calling this method
1536 * explicitly (e.g. from a maintenance script) is also fine.
1538 * @param User $user User to auto-create
1539 * @param string $source What caused the auto-creation? This must be the ID
1540 * of a PrimaryAuthenticationProvider or the constant self::AUTOCREATE_SOURCE_SESSION.
1541 * @param bool $login Whether to also log the user in
1542 * @return Status Good if user was created, Ok if user already existed, otherwise Fatal
1544 public function autoCreateUser( User
$user, $source, $login = true ) {
1545 if ( $source !== self
::AUTOCREATE_SOURCE_SESSION
&&
1546 !$this->getAuthenticationProvider( $source ) instanceof PrimaryAuthenticationProvider
1548 throw new \
InvalidArgumentException( "Unknown auto-creation source: $source" );
1551 $username = $user->getName();
1553 // Try the local user from the replica DB
1554 $localId = User
::idFromName( $username );
1555 $flags = User
::READ_NORMAL
;
1557 // Fetch the user ID from the master, so that we don't try to create the user
1558 // when they already exist, due to replication lag
1559 // @codeCoverageIgnoreStart
1562 MediaWikiServices
::getInstance()->getDBLoadBalancer()->getReaderIndex() != 0
1564 $localId = User
::idFromName( $username, User
::READ_LATEST
);
1565 $flags = User
::READ_LATEST
;
1567 // @codeCoverageIgnoreEnd
1570 $this->logger
->debug( __METHOD__
. ': {username} already exists locally', [
1571 'username' => $username,
1573 $user->setId( $localId );
1574 $user->loadFromId( $flags );
1576 $this->setSessionDataForUser( $user );
1578 $status = Status
::newGood();
1579 $status->warning( 'userexists' );
1583 // Wiki is read-only?
1584 if ( wfReadOnly() ) {
1585 $this->logger
->debug( __METHOD__
. ': denied by wfReadOnly(): {reason}', [
1586 'username' => $username,
1587 'reason' => wfReadOnlyReason(),
1590 $user->loadFromId();
1591 return Status
::newFatal( wfMessage( 'readonlytext', wfReadOnlyReason() ) );
1594 // Check the session, if we tried to create this user already there's
1595 // no point in retrying.
1596 $session = $this->request
->getSession();
1597 if ( $session->get( 'AuthManager::AutoCreateBlacklist' ) ) {
1598 $this->logger
->debug( __METHOD__
. ': blacklisted in session {sessionid}', [
1599 'username' => $username,
1600 'sessionid' => $session->getId(),
1603 $user->loadFromId();
1604 $reason = $session->get( 'AuthManager::AutoCreateBlacklist' );
1605 if ( $reason instanceof StatusValue
) {
1606 return Status
::wrap( $reason );
1608 return Status
::newFatal( $reason );
1612 // Is the username creatable?
1613 if ( !User
::isCreatableName( $username ) ) {
1614 $this->logger
->debug( __METHOD__
. ': name "{username}" is not creatable', [
1615 'username' => $username,
1617 $session->set( 'AuthManager::AutoCreateBlacklist', 'noname' );
1619 $user->loadFromId();
1620 return Status
::newFatal( 'noname' );
1623 // Is the IP user able to create accounts?
1625 if ( !$anon->isAllowedAny( 'createaccount', 'autocreateaccount' ) ) {
1626 $this->logger
->debug( __METHOD__
. ': IP lacks the ability to create or autocreate accounts', [
1627 'username' => $username,
1628 'ip' => $anon->getName(),
1630 $session->set( 'AuthManager::AutoCreateBlacklist', 'authmanager-autocreate-noperm' );
1631 $session->persist();
1633 $user->loadFromId();
1634 return Status
::newFatal( 'authmanager-autocreate-noperm' );
1637 // Avoid account creation races on double submissions
1638 $cache = \ObjectCache
::getLocalClusterInstance();
1639 $lock = $cache->getScopedLock( $cache->makeGlobalKey( 'account', md5( $username ) ) );
1641 $this->logger
->debug( __METHOD__
. ': Could not acquire account creation lock', [
1642 'user' => $username,
1645 $user->loadFromId();
1646 return Status
::newFatal( 'usernameinprogress' );
1649 // Denied by providers?
1651 'flags' => User
::READ_LATEST
,
1654 $providers = $this->getPreAuthenticationProviders() +
1655 $this->getPrimaryAuthenticationProviders() +
1656 $this->getSecondaryAuthenticationProviders();
1657 foreach ( $providers as $provider ) {
1658 $status = $provider->testUserForCreation( $user, $source, $options );
1659 if ( !$status->isGood() ) {
1660 $ret = Status
::wrap( $status );
1661 $this->logger
->debug( __METHOD__
. ': Provider denied creation of {username}: {reason}', [
1662 'username' => $username,
1663 'reason' => $ret->getWikiText( null, null, 'en' ),
1665 $session->set( 'AuthManager::AutoCreateBlacklist', $status );
1667 $user->loadFromId();
1672 $backoffKey = $cache->makeKey( 'AuthManager', 'autocreate-failed', md5( $username ) );
1673 if ( $cache->get( $backoffKey ) ) {
1674 $this->logger
->debug( __METHOD__
. ': {username} denied by prior creation attempt failures', [
1675 'username' => $username,
1678 $user->loadFromId();
1679 return Status
::newFatal( 'authmanager-autocreate-exception' );
1682 // Checks passed, create the user...
1683 $from = $_SERVER['REQUEST_URI'] ??
'CLI';
1684 $this->logger
->info( __METHOD__
. ': creating new user ({username}) - from: {from}', [
1685 'username' => $username,
1689 // Ignore warnings about master connections/writes...hard to avoid here
1690 $trxProfiler = \Profiler
::instance()->getTransactionProfiler();
1691 $old = $trxProfiler->setSilenced( true );
1693 $status = $user->addToDatabase();
1694 if ( !$status->isOK() ) {
1695 // Double-check for a race condition (T70012). We make use of the fact that when
1696 // addToDatabase fails due to the user already existing, the user object gets loaded.
1697 if ( $user->getId() ) {
1698 $this->logger
->info( __METHOD__
. ': {username} already exists locally (race)', [
1699 'username' => $username,
1702 $this->setSessionDataForUser( $user );
1704 $status = Status
::newGood();
1705 $status->warning( 'userexists' );
1707 $this->logger
->error( __METHOD__
. ': {username} failed with message {msg}', [
1708 'username' => $username,
1709 'msg' => $status->getWikiText( null, null, 'en' )
1712 $user->loadFromId();
1716 } catch ( \Exception
$ex ) {
1717 $trxProfiler->setSilenced( $old );
1718 $this->logger
->error( __METHOD__
. ': {username} failed with exception {exception}', [
1719 'username' => $username,
1722 // Do not keep throwing errors for a while
1723 $cache->set( $backoffKey, 1, 600 );
1724 // Bubble up error; which should normally trigger DB rollbacks
1728 $this->setDefaultUserOptions( $user, false );
1730 // Inform the providers
1731 $this->callMethodOnProviders( 6, 'autoCreatedAccount', [ $user, $source ] );
1733 \Hooks
::run( 'AuthPluginAutoCreate', [ $user ], '1.27' );
1734 \Hooks
::run( 'LocalUserCreated', [ $user, true ] );
1735 $user->saveSettings();
1737 // Update user count
1738 \DeferredUpdates
::addUpdate( \SiteStatsUpdate
::factory( [ 'users' => 1 ] ) );
1739 // Watch user's userpage and talk page
1740 \DeferredUpdates
::addCallableUpdate( function () use ( $user ) {
1741 $user->addWatch( $user->getUserPage(), User
::IGNORE_USER_RIGHTS
);
1745 if ( $this->config
->get( 'NewUserLog' ) ) {
1746 $logEntry = new \
ManualLogEntry( 'newusers', 'autocreate' );
1747 $logEntry->setPerformer( $user );
1748 $logEntry->setTarget( $user->getUserPage() );
1749 $logEntry->setComment( '' );
1750 $logEntry->setParameters( [
1751 '4::userid' => $user->getId(),
1753 $logEntry->insert();
1756 $trxProfiler->setSilenced( $old );
1759 $this->setSessionDataForUser( $user );
1762 return Status
::newGood();
1768 * @name Account linking
1773 * Determine whether accounts can be linked
1776 public function canLinkAccounts() {
1777 foreach ( $this->getPrimaryAuthenticationProviders() as $provider ) {
1778 if ( $provider->accountCreationType() === PrimaryAuthenticationProvider
::TYPE_LINK
) {
1786 * Start an account linking flow
1788 * @param User $user User being linked
1789 * @param AuthenticationRequest[] $reqs
1790 * @param string $returnToUrl Url that REDIRECT responses should eventually
1792 * @return AuthenticationResponse
1794 public function beginAccountLink( User
$user, array $reqs, $returnToUrl ) {
1795 $session = $this->request
->getSession();
1796 $session->remove( 'AuthManager::accountLinkState' );
1798 if ( !$this->canLinkAccounts() ) {
1799 // Caller should have called canLinkAccounts()
1800 throw new \
LogicException( 'Account linking is not possible' );
1803 if ( $user->getId() === 0 ) {
1804 if ( !User
::isUsableName( $user->getName() ) ) {
1805 $msg = wfMessage( 'noname' );
1807 $msg = wfMessage( 'authmanager-userdoesnotexist', $user->getName() );
1809 return AuthenticationResponse
::newFail( $msg );
1811 foreach ( $reqs as $req ) {
1812 $req->username
= $user->getName();
1813 $req->returnToUrl
= $returnToUrl;
1816 $this->removeAuthenticationSessionData( null );
1818 $providers = $this->getPreAuthenticationProviders();
1819 foreach ( $providers as $id => $provider ) {
1820 $status = $provider->testForAccountLink( $user );
1821 if ( !$status->isGood() ) {
1822 $this->logger
->debug( __METHOD__
. ": Account linking pre-check failed by $id", [
1823 'user' => $user->getName(),
1825 $ret = AuthenticationResponse
::newFail(
1826 Status
::wrap( $status )->getMessage()
1828 $this->callMethodOnProviders( 3, 'postAccountLink', [ $user, $ret ] );
1834 'username' => $user->getName(),
1835 'userid' => $user->getId(),
1836 'returnToUrl' => $returnToUrl,
1838 'continueRequests' => [],
1841 $providers = $this->getPrimaryAuthenticationProviders();
1842 foreach ( $providers as $id => $provider ) {
1843 if ( $provider->accountCreationType() !== PrimaryAuthenticationProvider
::TYPE_LINK
) {
1847 $res = $provider->beginPrimaryAccountLink( $user, $reqs );
1848 switch ( $res->status
) {
1849 case AuthenticationResponse
::PASS
;
1850 $this->logger
->info( "Account linked to {user} by $id", [
1851 'user' => $user->getName(),
1853 $this->callMethodOnProviders( 3, 'postAccountLink', [ $user, $res ] );
1856 case AuthenticationResponse
::FAIL
;
1857 $this->logger
->debug( __METHOD__
. ": Account linking failed by $id", [
1858 'user' => $user->getName(),
1860 $this->callMethodOnProviders( 3, 'postAccountLink', [ $user, $res ] );
1863 case AuthenticationResponse
::ABSTAIN
;
1867 case AuthenticationResponse
::REDIRECT
;
1868 case AuthenticationResponse
::UI
;
1869 $this->logger
->debug( __METHOD__
. ": Account linking $res->status by $id", [
1870 'user' => $user->getName(),
1872 $this->fillRequests( $res->neededRequests
, self
::ACTION_LINK
, $user->getName() );
1873 $state['primary'] = $id;
1874 $state['continueRequests'] = $res->neededRequests
;
1875 $session->setSecret( 'AuthManager::accountLinkState', $state );
1876 $session->persist();
1879 // @codeCoverageIgnoreStart
1881 throw new \
DomainException(
1882 get_class( $provider ) . "::beginPrimaryAccountLink() returned $res->status"
1884 // @codeCoverageIgnoreEnd
1888 $this->logger
->debug( __METHOD__
. ': Account linking failed because no provider accepted', [
1889 'user' => $user->getName(),
1891 $ret = AuthenticationResponse
::newFail(
1892 wfMessage( 'authmanager-link-no-primary' )
1894 $this->callMethodOnProviders( 3, 'postAccountLink', [ $user, $ret ] );
1899 * Continue an account linking flow
1900 * @param AuthenticationRequest[] $reqs
1901 * @return AuthenticationResponse
1903 public function continueAccountLink( array $reqs ) {
1904 $session = $this->request
->getSession();
1906 if ( !$this->canLinkAccounts() ) {
1907 // Caller should have called canLinkAccounts()
1908 $session->remove( 'AuthManager::accountLinkState' );
1909 throw new \
LogicException( 'Account linking is not possible' );
1912 $state = $session->getSecret( 'AuthManager::accountLinkState' );
1913 if ( !is_array( $state ) ) {
1914 return AuthenticationResponse
::newFail(
1915 wfMessage( 'authmanager-link-not-in-progress' )
1918 $state['continueRequests'] = [];
1920 // Step 0: Prepare and validate the input
1922 $user = User
::newFromName( $state['username'], 'usable' );
1923 if ( !is_object( $user ) ) {
1924 $session->remove( 'AuthManager::accountLinkState' );
1925 return AuthenticationResponse
::newFail( wfMessage( 'noname' ) );
1927 if ( $user->getId() != $state['userid'] ) {
1928 throw new \
UnexpectedValueException(
1929 "User \"{$state['username']}\" is valid, but " .
1930 "ID {$user->getId()} != {$state['userid']}!"
1934 foreach ( $reqs as $req ) {
1935 $req->username
= $state['username'];
1936 $req->returnToUrl
= $state['returnToUrl'];
1939 // Step 1: Call the primary again until it succeeds
1941 $provider = $this->getAuthenticationProvider( $state['primary'] );
1942 if ( !$provider instanceof PrimaryAuthenticationProvider
) {
1943 // Configuration changed? Force them to start over.
1944 // @codeCoverageIgnoreStart
1945 $ret = AuthenticationResponse
::newFail(
1946 wfMessage( 'authmanager-link-not-in-progress' )
1948 $this->callMethodOnProviders( 3, 'postAccountLink', [ $user, $ret ] );
1949 $session->remove( 'AuthManager::accountLinkState' );
1951 // @codeCoverageIgnoreEnd
1953 $id = $provider->getUniqueId();
1954 $res = $provider->continuePrimaryAccountLink( $user, $reqs );
1955 switch ( $res->status
) {
1956 case AuthenticationResponse
::PASS
;
1957 $this->logger
->info( "Account linked to {user} by $id", [
1958 'user' => $user->getName(),
1960 $this->callMethodOnProviders( 3, 'postAccountLink', [ $user, $res ] );
1961 $session->remove( 'AuthManager::accountLinkState' );
1963 case AuthenticationResponse
::FAIL
;
1964 $this->logger
->debug( __METHOD__
. ": Account linking failed by $id", [
1965 'user' => $user->getName(),
1967 $this->callMethodOnProviders( 3, 'postAccountLink', [ $user, $res ] );
1968 $session->remove( 'AuthManager::accountLinkState' );
1970 case AuthenticationResponse
::REDIRECT
;
1971 case AuthenticationResponse
::UI
;
1972 $this->logger
->debug( __METHOD__
. ": Account linking $res->status by $id", [
1973 'user' => $user->getName(),
1975 $this->fillRequests( $res->neededRequests
, self
::ACTION_LINK
, $user->getName() );
1976 $state['continueRequests'] = $res->neededRequests
;
1977 $session->setSecret( 'AuthManager::accountLinkState', $state );
1980 throw new \
DomainException(
1981 get_class( $provider ) . "::continuePrimaryAccountLink() returned $res->status"
1984 } catch ( \Exception
$ex ) {
1985 $session->remove( 'AuthManager::accountLinkState' );
1993 * @name Information methods
1998 * Return the applicable list of AuthenticationRequests
2000 * Possible values for $action:
2001 * - ACTION_LOGIN: Valid for passing to beginAuthentication
2002 * - ACTION_LOGIN_CONTINUE: Valid for passing to continueAuthentication in the current state
2003 * - ACTION_CREATE: Valid for passing to beginAccountCreation
2004 * - ACTION_CREATE_CONTINUE: Valid for passing to continueAccountCreation in the current state
2005 * - ACTION_LINK: Valid for passing to beginAccountLink
2006 * - ACTION_LINK_CONTINUE: Valid for passing to continueAccountLink in the current state
2007 * - ACTION_CHANGE: Valid for passing to changeAuthenticationData to change credentials
2008 * - ACTION_REMOVE: Valid for passing to changeAuthenticationData to remove credentials.
2009 * - ACTION_UNLINK: Same as ACTION_REMOVE, but limited to linked accounts.
2011 * @param string $action One of the AuthManager::ACTION_* constants
2012 * @param User|null $user User being acted on, instead of the current user.
2013 * @return AuthenticationRequest[]
2015 public function getAuthenticationRequests( $action, User
$user = null ) {
2017 $providerAction = $action;
2019 // Figure out which providers to query
2020 switch ( $action ) {
2021 case self
::ACTION_LOGIN
:
2022 case self
::ACTION_CREATE
:
2023 $providers = $this->getPreAuthenticationProviders() +
2024 $this->getPrimaryAuthenticationProviders() +
2025 $this->getSecondaryAuthenticationProviders();
2028 case self
::ACTION_LOGIN_CONTINUE
:
2029 $state = $this->request
->getSession()->getSecret( 'AuthManager::authnState' );
2030 return is_array( $state ) ?
$state['continueRequests'] : [];
2032 case self
::ACTION_CREATE_CONTINUE
:
2033 $state = $this->request
->getSession()->getSecret( 'AuthManager::accountCreationState' );
2034 return is_array( $state ) ?
$state['continueRequests'] : [];
2036 case self
::ACTION_LINK
:
2037 $providers = array_filter( $this->getPrimaryAuthenticationProviders(), function ( $p ) {
2038 return $p->accountCreationType() === PrimaryAuthenticationProvider
::TYPE_LINK
;
2042 case self
::ACTION_UNLINK
:
2043 $providers = array_filter( $this->getPrimaryAuthenticationProviders(), function ( $p ) {
2044 return $p->accountCreationType() === PrimaryAuthenticationProvider
::TYPE_LINK
;
2047 // To providers, unlink and remove are identical.
2048 $providerAction = self
::ACTION_REMOVE
;
2051 case self
::ACTION_LINK_CONTINUE
:
2052 $state = $this->request
->getSession()->getSecret( 'AuthManager::accountLinkState' );
2053 return is_array( $state ) ?
$state['continueRequests'] : [];
2055 case self
::ACTION_CHANGE
:
2056 case self
::ACTION_REMOVE
:
2057 $providers = $this->getPrimaryAuthenticationProviders() +
2058 $this->getSecondaryAuthenticationProviders();
2061 // @codeCoverageIgnoreStart
2063 throw new \
DomainException( __METHOD__
. ": Invalid action \"$action\"" );
2065 // @codeCoverageIgnoreEnd
2067 return $this->getAuthenticationRequestsInternal( $providerAction, $options, $providers, $user );
2071 * Internal request lookup for self::getAuthenticationRequests
2073 * @param string $providerAction Action to pass to providers
2074 * @param array $options Options to pass to providers
2075 * @param AuthenticationProvider[] $providers
2076 * @param User|null $user
2077 * @return AuthenticationRequest[]
2079 private function getAuthenticationRequestsInternal(
2080 $providerAction, array $options, array $providers, User
$user = null
2082 $user = $user ?
: \RequestContext
::getMain()->getUser();
2083 $options['username'] = $user->isAnon() ?
null : $user->getName();
2085 // Query them and merge results
2087 foreach ( $providers as $provider ) {
2088 $isPrimary = $provider instanceof PrimaryAuthenticationProvider
;
2089 foreach ( $provider->getAuthenticationRequests( $providerAction, $options ) as $req ) {
2090 $id = $req->getUniqueId();
2092 // If a required request if from a Primary, mark it as "primary-required" instead
2094 if ( $req->required
) {
2095 $req->required
= AuthenticationRequest
::PRIMARY_REQUIRED
;
2100 !isset( $reqs[$id] )
2101 ||
$req->required
=== AuthenticationRequest
::REQUIRED
2102 ||
$reqs[$id] === AuthenticationRequest
::OPTIONAL
2109 // AuthManager has its own req for some actions
2110 switch ( $providerAction ) {
2111 case self
::ACTION_LOGIN
:
2112 $reqs[] = new RememberMeAuthenticationRequest
;
2115 case self
::ACTION_CREATE
:
2116 $reqs[] = new UsernameAuthenticationRequest
;
2117 $reqs[] = new UserDataAuthenticationRequest
;
2118 if ( $options['username'] !== null ) {
2119 $reqs[] = new CreationReasonAuthenticationRequest
;
2120 $options['username'] = null; // Don't fill in the username below
2125 // Fill in reqs data
2126 $this->fillRequests( $reqs, $providerAction, $options['username'], true );
2128 // For self::ACTION_CHANGE, filter out any that something else *doesn't* allow changing
2129 if ( $providerAction === self
::ACTION_CHANGE ||
$providerAction === self
::ACTION_REMOVE
) {
2130 $reqs = array_filter( $reqs, function ( $req ) {
2131 return $this->allowsAuthenticationDataChange( $req, false )->isGood();
2135 return array_values( $reqs );
2139 * Set values in an array of requests
2140 * @param AuthenticationRequest[] &$reqs
2141 * @param string $action
2142 * @param string|null $username
2143 * @param bool $forceAction
2145 private function fillRequests( array &$reqs, $action, $username, $forceAction = false ) {
2146 foreach ( $reqs as $req ) {
2147 if ( !$req->action ||
$forceAction ) {
2148 $req->action
= $action;
2150 if ( $req->username
=== null ) {
2151 $req->username
= $username;
2157 * Determine whether a username exists
2158 * @param string $username
2159 * @param int $flags Bitfield of User:READ_* constants
2162 public function userExists( $username, $flags = User
::READ_NORMAL
) {
2163 foreach ( $this->getPrimaryAuthenticationProviders() as $provider ) {
2164 if ( $provider->testUserExists( $username, $flags ) ) {
2173 * Determine whether a user property should be allowed to be changed.
2175 * Supported properties are:
2180 * @param string $property
2183 public function allowsPropertyChange( $property ) {
2184 $providers = $this->getPrimaryAuthenticationProviders() +
2185 $this->getSecondaryAuthenticationProviders();
2186 foreach ( $providers as $provider ) {
2187 if ( !$provider->providerAllowsPropertyChange( $property ) ) {
2195 * Get a provider by ID
2196 * @note This is public so extensions can check whether their own provider
2197 * is installed and so they can read its configuration if necessary.
2198 * Other uses are not recommended.
2200 * @return AuthenticationProvider|null
2202 public function getAuthenticationProvider( $id ) {
2204 if ( isset( $this->allAuthenticationProviders
[$id] ) ) {
2205 return $this->allAuthenticationProviders
[$id];
2208 // Slow version: instantiate each kind and check
2209 $providers = $this->getPrimaryAuthenticationProviders();
2210 if ( isset( $providers[$id] ) ) {
2211 return $providers[$id];
2213 $providers = $this->getSecondaryAuthenticationProviders();
2214 if ( isset( $providers[$id] ) ) {
2215 return $providers[$id];
2217 $providers = $this->getPreAuthenticationProviders();
2218 if ( isset( $providers[$id] ) ) {
2219 return $providers[$id];
2228 * @name Internal methods
2233 * Store authentication in the current session
2234 * @protected For use by AuthenticationProviders
2235 * @param string $key
2236 * @param mixed $data Must be serializable
2238 public function setAuthenticationSessionData( $key, $data ) {
2239 $session = $this->request
->getSession();
2240 $arr = $session->getSecret( 'authData' );
2241 if ( !is_array( $arr ) ) {
2245 $session->setSecret( 'authData', $arr );
2249 * Fetch authentication data from the current session
2250 * @protected For use by AuthenticationProviders
2251 * @param string $key
2252 * @param mixed|null $default
2255 public function getAuthenticationSessionData( $key, $default = null ) {
2256 $arr = $this->request
->getSession()->getSecret( 'authData' );
2257 if ( is_array( $arr ) && array_key_exists( $key, $arr ) ) {
2265 * Remove authentication data
2266 * @protected For use by AuthenticationProviders
2267 * @param string|null $key If null, all data is removed
2269 public function removeAuthenticationSessionData( $key ) {
2270 $session = $this->request
->getSession();
2271 if ( $key === null ) {
2272 $session->remove( 'authData' );
2274 $arr = $session->getSecret( 'authData' );
2275 if ( is_array( $arr ) && array_key_exists( $key, $arr ) ) {
2276 unset( $arr[$key] );
2277 $session->setSecret( 'authData', $arr );
2283 * Create an array of AuthenticationProviders from an array of ObjectFactory specs
2284 * @param string $class
2285 * @param array[] $specs
2286 * @return AuthenticationProvider[]
2288 protected function providerArrayFromSpecs( $class, array $specs ) {
2290 foreach ( $specs as &$spec ) {
2291 $spec = [ 'sort2' => $i++
] +
$spec +
[ 'sort' => 0 ];
2294 // Sort according to the 'sort' field, and if they are equal, according to 'sort2'
2295 usort( $specs, function ( $a, $b ) {
2296 return $a['sort'] <=> $b['sort']
2297 ?
: $a['sort2'] <=> $b['sort2'];
2301 foreach ( $specs as $spec ) {
2302 $provider = ObjectFactory
::getObjectFromSpec( $spec );
2303 if ( !$provider instanceof $class ) {
2304 throw new \
RuntimeException(
2305 "Expected instance of $class, got " . get_class( $provider )
2308 $provider->setLogger( $this->logger
);
2309 $provider->setManager( $this );
2310 $provider->setConfig( $this->config
);
2311 $id = $provider->getUniqueId();
2312 if ( isset( $this->allAuthenticationProviders
[$id] ) ) {
2313 throw new \
RuntimeException(
2314 "Duplicate specifications for id $id (classes " .
2315 get_class( $provider ) . ' and ' .
2316 get_class( $this->allAuthenticationProviders
[$id] ) . ')'
2319 $this->allAuthenticationProviders
[$id] = $provider;
2320 $ret[$id] = $provider;
2326 * Get the configuration
2329 private function getConfiguration() {
2330 return $this->config
->get( 'AuthManagerConfig' ) ?
: $this->config
->get( 'AuthManagerAutoConfig' );
2334 * Get the list of PreAuthenticationProviders
2335 * @return PreAuthenticationProvider[]
2337 protected function getPreAuthenticationProviders() {
2338 if ( $this->preAuthenticationProviders
=== null ) {
2339 $conf = $this->getConfiguration();
2340 $this->preAuthenticationProviders
= $this->providerArrayFromSpecs(
2341 PreAuthenticationProvider
::class, $conf['preauth']
2344 return $this->preAuthenticationProviders
;
2348 * Get the list of PrimaryAuthenticationProviders
2349 * @return PrimaryAuthenticationProvider[]
2351 protected function getPrimaryAuthenticationProviders() {
2352 if ( $this->primaryAuthenticationProviders
=== null ) {
2353 $conf = $this->getConfiguration();
2354 $this->primaryAuthenticationProviders
= $this->providerArrayFromSpecs(
2355 PrimaryAuthenticationProvider
::class, $conf['primaryauth']
2358 return $this->primaryAuthenticationProviders
;
2362 * Get the list of SecondaryAuthenticationProviders
2363 * @return SecondaryAuthenticationProvider[]
2365 protected function getSecondaryAuthenticationProviders() {
2366 if ( $this->secondaryAuthenticationProviders
=== null ) {
2367 $conf = $this->getConfiguration();
2368 $this->secondaryAuthenticationProviders
= $this->providerArrayFromSpecs(
2369 SecondaryAuthenticationProvider
::class, $conf['secondaryauth']
2372 return $this->secondaryAuthenticationProviders
;
2378 * @param bool|null $remember
2380 private function setSessionDataForUser( $user, $remember = null ) {
2381 $session = $this->request
->getSession();
2382 $delay = $session->delaySave();
2384 $session->resetId();
2385 $session->resetAllTokens();
2386 if ( $session->canSetUser() ) {
2387 $session->setUser( $user );
2389 if ( $remember !== null ) {
2390 $session->setRememberUser( $remember );
2392 $session->set( 'AuthManager:lastAuthId', $user->getId() );
2393 $session->set( 'AuthManager:lastAuthTimestamp', time() );
2394 $session->persist();
2396 \Wikimedia\ScopedCallback
::consume( $delay );
2398 \Hooks
::run( 'UserLoggedIn', [ $user ] );
2403 * @param bool $useContextLang Use 'uselang' to set the user's language
2405 private function setDefaultUserOptions( User
$user, $useContextLang ) {
2410 $lang = $useContextLang ? \RequestContext
::getMain()->getLanguage() : $wgContLang;
2411 $user->setOption( 'language', $lang->getPreferredVariant() );
2413 if ( $wgContLang->hasVariants() ) {
2414 $user->setOption( 'variant', $wgContLang->getPreferredVariant() );
2419 * @param int $which Bitmask: 1 = pre, 2 = primary, 4 = secondary
2420 * @param string $method
2421 * @param array $args
2423 private function callMethodOnProviders( $which, $method, array $args ) {
2426 $providers +
= $this->getPreAuthenticationProviders();
2429 $providers +
= $this->getPrimaryAuthenticationProviders();
2432 $providers +
= $this->getSecondaryAuthenticationProviders();
2434 foreach ( $providers as $provider ) {
2435 $provider->$method( ...$args );
2440 * Reset the internal caching for unit testing
2441 * @protected Unit tests only
2443 public static function resetCache() {
2444 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
2445 // @codeCoverageIgnoreStart
2446 throw new \
MWException( __METHOD__
. ' may only be called from unit tests!' );
2447 // @codeCoverageIgnoreEnd
2450 self
::$instance = null;
2458 * For really cool vim folding this needs to be at the end:
2459 * vim: foldmarker=@{,@} foldmethod=marker