3 * MediaWiki\Session 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\Session
;
26 use Psr\Log\LoggerInterface
;
36 * This serves as the entry point to the MediaWiki session handling system.
41 final class SessionManager
implements SessionManagerInterface
{
42 /** @var SessionManager|null */
43 private static $instance = null;
45 /** @var Session|null */
46 private static $globalSession = null;
48 /** @var WebRequest|null */
49 private static $globalSessionRequest = null;
51 /** @var LoggerInterface */
57 /** @var CachedBagOStuff|null */
60 /** @var SessionProvider[] */
61 private $sessionProviders = null;
64 private $varyCookies = null;
67 private $varyHeaders = null;
69 /** @var SessionBackend[] */
70 private $allSessionBackends = [];
72 /** @var SessionId[] */
73 private $allSessionIds = [];
76 private $preventUsers = [];
79 * Get the global SessionManager
80 * @return SessionManagerInterface
81 * (really a SessionManager, but this is to make IDEs less confused)
83 public static function singleton() {
84 if ( self
::$instance === null ) {
85 self
::$instance = new self();
87 return self
::$instance;
91 * Get the "global" session
93 * If PHP's session_id() has been set, returns that session. Otherwise
94 * returns the session for RequestContext::getMain()->getRequest().
98 public static function getGlobalSession() {
99 if ( !PHPSessionHandler
::isEnabled() ) {
105 $request = \RequestContext
::getMain()->getRequest();
107 !self
::$globalSession // No global session is set up yet
108 || self
::$globalSessionRequest !== $request // The global WebRequest changed
109 ||
$id !== '' && self
::$globalSession->getId() !== $id // Someone messed with session_id()
111 self
::$globalSessionRequest = $request;
113 // session_id() wasn't used, so fetch the Session from the WebRequest.
114 // We use $request->getSession() instead of $singleton->getSessionForRequest()
115 // because doing the latter would require a public
116 // "$request->getSessionId()" method that would confuse end
117 // users by returning SessionId|null where they'd expect it to
118 // be short for $request->getSession()->getId(), and would
119 // wind up being a duplicate of the code in
120 // $request->getSession() anyway.
121 self
::$globalSession = $request->getSession();
123 // Someone used session_id(), so we need to follow suit.
124 // Note this overwrites whatever session might already be
125 // associated with $request with the one for $id.
126 self
::$globalSession = self
::singleton()->getSessionById( $id, true, $request )
127 ?
: $request->getSession();
130 return self
::$globalSession;
134 * @param array $options
135 * - config: Config to fetch configuration from. Defaults to the default 'main' config.
136 * - logger: LoggerInterface to use for logging. Defaults to the 'session' channel.
137 * - store: BagOStuff to store session data in.
139 public function __construct( $options = [] ) {
140 if ( isset( $options['config'] ) ) {
141 $this->config
= $options['config'];
142 if ( !$this->config
instanceof Config
) {
143 throw new \
InvalidArgumentException(
144 '$options[\'config\'] must be an instance of Config'
148 $this->config
= \ConfigFactory
::getDefaultInstance()->makeConfig( 'main' );
151 if ( isset( $options['logger'] ) ) {
152 if ( !$options['logger'] instanceof LoggerInterface
) {
153 throw new \
InvalidArgumentException(
154 '$options[\'logger\'] must be an instance of LoggerInterface'
157 $this->setLogger( $options['logger'] );
159 $this->setLogger( \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' ) );
162 if ( isset( $options['store'] ) ) {
163 if ( !$options['store'] instanceof BagOStuff
) {
164 throw new \
InvalidArgumentException(
165 '$options[\'store\'] must be an instance of BagOStuff'
168 $store = $options['store'];
170 $store = \ObjectCache
::getInstance( $this->config
->get( 'SessionCacheType' ) );
172 $this->store
= $store instanceof CachedBagOStuff ?
$store : new CachedBagOStuff( $store );
174 register_shutdown_function( [ $this, 'shutdown' ] );
177 public function setLogger( LoggerInterface
$logger ) {
178 $this->logger
= $logger;
181 public function getSessionForRequest( WebRequest
$request ) {
182 $info = $this->getSessionInfoForRequest( $request );
185 $session = $this->getEmptySession( $request );
187 $session = $this->getSessionFromInfo( $info, $request );
192 public function getSessionById( $id, $create = false, WebRequest
$request = null ) {
193 if ( !self
::validateSessionId( $id ) ) {
194 throw new \
InvalidArgumentException( 'Invalid session ID' );
197 $request = new FauxRequest
;
202 // Test this here to provide a better log message for the common case
204 $key = wfMemcKey( 'MWSession', $id );
205 if ( is_array( $this->store
->get( $key ) ) ) {
206 $info = new SessionInfo( SessionInfo
::MIN_PRIORITY
, [ 'id' => $id, 'idIsSafe' => true ] );
207 if ( $this->loadSessionInfoFromStore( $info, $request ) ) {
208 $session = $this->getSessionFromInfo( $info, $request );
212 if ( $create && $session === null ) {
215 $session = $this->getEmptySessionInternal( $request, $id );
216 } catch ( \Exception
$ex ) {
217 $this->logger
->error( 'Failed to create empty session: {exception}',
219 'method' => __METHOD__
,
229 public function getEmptySession( WebRequest
$request = null ) {
230 return $this->getEmptySessionInternal( $request );
234 * @see SessionManagerInterface::getEmptySession
235 * @param WebRequest|null $request
236 * @param string|null $id ID to force on the new session
239 private function getEmptySessionInternal( WebRequest
$request = null, $id = null ) {
240 if ( $id !== null ) {
241 if ( !self
::validateSessionId( $id ) ) {
242 throw new \
InvalidArgumentException( 'Invalid session ID' );
245 $key = wfMemcKey( 'MWSession', $id );
246 if ( is_array( $this->store
->get( $key ) ) ) {
247 throw new \
InvalidArgumentException( 'Session ID already exists' );
251 $request = new FauxRequest
;
255 foreach ( $this->getProviders() as $provider ) {
256 $info = $provider->newSessionInfo( $id );
260 if ( $info->getProvider() !== $provider ) {
261 throw new \
UnexpectedValueException(
262 "$provider returned an empty session info for a different provider: $info"
265 if ( $id !== null && $info->getId() !== $id ) {
266 throw new \
UnexpectedValueException(
267 "$provider returned empty session info with a wrong id: " .
268 $info->getId() . ' != ' . $id
271 if ( !$info->isIdSafe() ) {
272 throw new \
UnexpectedValueException(
273 "$provider returned empty session info with id flagged unsafe"
276 $compare = $infos ? SessionInfo
::compare( $infos[0], $info ) : -1;
277 if ( $compare > 0 ) {
280 if ( $compare === 0 ) {
287 // Make sure there's exactly one
288 if ( count( $infos ) > 1 ) {
289 throw new \
UnexpectedValueException(
290 'Multiple empty sessions tied for top priority: ' . join( ', ', $infos )
292 } elseif ( count( $infos ) < 1 ) {
293 throw new \
UnexpectedValueException( 'No provider could provide an empty session!' );
296 return $this->getSessionFromInfo( $infos[0], $request );
299 public function getVaryHeaders() {
300 if ( $this->varyHeaders
=== null ) {
302 foreach ( $this->getProviders() as $provider ) {
303 foreach ( $provider->getVaryHeaders() as $header => $options ) {
304 if ( !isset( $headers[$header] ) ) {
305 $headers[$header] = [];
307 if ( is_array( $options ) ) {
308 $headers[$header] = array_unique( array_merge( $headers[$header], $options ) );
312 $this->varyHeaders
= $headers;
314 return $this->varyHeaders
;
317 public function getVaryCookies() {
318 if ( $this->varyCookies
=== null ) {
320 foreach ( $this->getProviders() as $provider ) {
321 $cookies = array_merge( $cookies, $provider->getVaryCookies() );
323 $this->varyCookies
= array_values( array_unique( $cookies ) );
325 return $this->varyCookies
;
329 * Validate a session ID
333 public static function validateSessionId( $id ) {
334 return is_string( $id ) && preg_match( '/^[a-zA-Z0-9_-]{32,}$/', $id );
338 * @name Internal methods
343 * Auto-create the given user, if necessary
344 * @private Don't call this yourself. Let Setup.php do it for you at the right time.
345 * @note This more properly belongs in AuthManager, but we need it now.
346 * When AuthManager comes, this will be deprecated and will pass-through
347 * to the corresponding AuthManager method.
348 * @param User $user User to auto-create
349 * @return bool Success
351 public static function autoCreateUser( User
$user ) {
354 $logger = self
::singleton()->logger
;
356 // Much of this code is based on that in CentralAuth
358 // Try the local user from the slave DB
359 $localId = User
::idFromName( $user->getName() );
362 // Fetch the user ID from the master, so that we don't try to create the user
363 // when they already exist, due to replication lag
364 // @codeCoverageIgnoreStart
365 if ( !$localId && wfGetLB()->getReaderIndex() != 0 ) {
366 $localId = User
::idFromName( $user->getName(), User
::READ_LATEST
);
367 $flags = User
::READ_LATEST
;
369 // @codeCoverageIgnoreEnd
372 // User exists after all.
373 $user->setId( $localId );
374 $user->loadFromId( $flags );
378 // Denied by AuthPlugin? But ignore AuthPlugin itself.
379 if ( get_class( $wgAuth ) !== 'AuthPlugin' && !$wgAuth->autoCreate() ) {
380 $logger->debug( __METHOD__
. ': denied by AuthPlugin' );
386 // Wiki is read-only?
387 if ( wfReadOnly() ) {
388 $logger->debug( __METHOD__
. ': denied by wfReadOnly()' );
394 $userName = $user->getName();
396 // Check the session, if we tried to create this user already there's
397 // no point in retrying.
398 $session = self
::getGlobalSession();
399 $reason = $session->get( 'MWSession::AutoCreateBlacklist' );
401 $logger->debug( __METHOD__
. ": blacklisted in session ($reason)" );
407 // Is the IP user able to create accounts?
409 if ( !$anon->isAllowedAny( 'createaccount', 'autocreateaccount' )
410 ||
$anon->isBlockedFromCreateAccount()
412 // Blacklist the user to avoid repeated DB queries subsequently
413 $logger->debug( __METHOD__
. ': user is blocked from this wiki, blacklisting' );
414 $session->set( 'MWSession::AutoCreateBlacklist', 'blocked', 600 );
421 // Check for validity of username
422 if ( !User
::isCreatableName( $userName ) ) {
423 $logger->debug( __METHOD__
. ': Invalid username, blacklisting' );
424 $session->set( 'MWSession::AutoCreateBlacklist', 'invalid username', 600 );
431 // Give other extensions a chance to stop auto creation.
432 $user->loadDefaults( $userName );
434 if ( !\Hooks
::run( 'AbortAutoAccount', [ $user, &$abortMessage ] ) ) {
435 // In this case we have no way to return the message to the user,
436 // but we can log it.
437 $logger->debug( __METHOD__
. ": denied by hook: $abortMessage" );
438 $session->set( 'MWSession::AutoCreateBlacklist', "hook aborted: $abortMessage", 600 );
445 // Make sure the name has not been changed
446 if ( $user->getName() !== $userName ) {
449 throw new \
UnexpectedValueException(
450 'AbortAutoAccount hook tried to change the user name'
454 // Ignore warnings about master connections/writes...hard to avoid here
455 \Profiler
::instance()->getTransactionProfiler()->resetExpectations();
457 $cache = \ObjectCache
::getLocalClusterInstance();
458 $backoffKey = wfMemcKey( 'MWSession', 'autocreate-failed', md5( $userName ) );
459 if ( $cache->get( $backoffKey ) ) {
460 $logger->debug( __METHOD__
. ': denied by prior creation attempt failures' );
466 // Checks passed, create the user...
467 $from = isset( $_SERVER['REQUEST_URI'] ) ?
$_SERVER['REQUEST_URI'] : 'CLI';
468 $logger->info( __METHOD__
. ': creating new user ({username}) - from: {url}',
470 'username' => $userName,
475 // Insert the user into the local DB master
476 $status = $user->addToDatabase();
477 if ( !$status->isOK() ) {
478 // @codeCoverageIgnoreStart
479 // double-check for a race condition (T70012)
480 $id = User
::idFromName( $user->getName(), User
::READ_LATEST
);
482 $logger->info( __METHOD__
. ': tried to autocreate existing user',
484 'username' => $userName,
487 $logger->error( __METHOD__
. ': failed with message ' . $status->getWikiText(),
489 'username' => $userName,
493 $user->loadFromId( User
::READ_LATEST
);
495 // @codeCoverageIgnoreEnd
497 } catch ( \Exception
$ex ) {
498 // @codeCoverageIgnoreStart
499 $logger->error( __METHOD__
. ': failed with exception {exception}', [
501 'username' => $userName,
503 // Do not keep throwing errors for a while
504 $cache->set( $backoffKey, 1, 600 );
505 // Bubble up error; which should normally trigger DB rollbacks
507 // @codeCoverageIgnoreEnd
512 $wgAuth->initUser( $tmpUser, true );
513 if ( $tmpUser !== $user ) {
514 $logger->warning( __METHOD__
. ': ' .
515 get_class( $wgAuth ) . '::initUser() replaced the user object' );
518 # Notify hooks (e.g. Newuserlog)
519 \Hooks
::run( 'AuthPluginAutoCreate', [ $user ] );
520 \Hooks
::run( 'LocalUserCreated', [ $user, true ] );
522 $user->saveSettings();
525 \DeferredUpdates
::addUpdate( new \
SiteStatsUpdate( 0, 0, 0, 0, 1 ) );
527 # Watch user's userpage and talk page
528 $user->addWatch( $user->getUserPage(), \WatchedItem
::IGNORE_USER_RIGHTS
);
534 * Prevent future sessions for the user
536 * The intention is that the named account will never again be usable for
537 * normal login (i.e. there is no way to undo the prevention of access).
539 * @private For use from \\User::newSystemUser only
540 * @param string $username
542 public function preventSessionsForUser( $username ) {
543 $this->preventUsers
[$username] = true;
545 // Instruct the session providers to kill any other sessions too.
546 foreach ( $this->getProviders() as $provider ) {
547 $provider->preventSessionsForUser( $username );
552 * Test if a user is prevented
553 * @private For use from SessionBackend only
554 * @param string $username
557 public function isUserSessionPrevented( $username ) {
558 return !empty( $this->preventUsers
[$username] );
562 * Get the available SessionProviders
563 * @return SessionProvider[]
565 protected function getProviders() {
566 if ( $this->sessionProviders
=== null ) {
567 $this->sessionProviders
= [];
568 foreach ( $this->config
->get( 'SessionProviders' ) as $spec ) {
569 $provider = \ObjectFactory
::getObjectFromSpec( $spec );
570 $provider->setLogger( $this->logger
);
571 $provider->setConfig( $this->config
);
572 $provider->setManager( $this );
573 if ( isset( $this->sessionProviders
[(string)$provider] ) ) {
574 throw new \
UnexpectedValueException( "Duplicate provider name \"$provider\"" );
576 $this->sessionProviders
[(string)$provider] = $provider;
579 return $this->sessionProviders
;
583 * Get a session provider by name
585 * Generally, this will only be used by internal implementation of some
586 * special session-providing mechanism. General purpose code, if it needs
587 * to access a SessionProvider at all, will use Session::getProvider().
589 * @param string $name
590 * @return SessionProvider|null
592 public function getProvider( $name ) {
593 $providers = $this->getProviders();
594 return isset( $providers[$name] ) ?
$providers[$name] : null;
598 * Save all active sessions on shutdown
599 * @private For internal use with register_shutdown_function()
601 public function shutdown() {
602 if ( $this->allSessionBackends
) {
603 $this->logger
->debug( 'Saving all sessions on shutdown' );
604 if ( session_id() !== '' ) {
605 // @codeCoverageIgnoreStart
606 session_write_close();
608 // @codeCoverageIgnoreEnd
609 foreach ( $this->allSessionBackends
as $backend ) {
610 $backend->save( true );
616 * Fetch the SessionInfo(s) for a request
617 * @param WebRequest $request
618 * @return SessionInfo|null
620 private function getSessionInfoForRequest( WebRequest
$request ) {
621 // Call all providers to fetch "the" session
623 foreach ( $this->getProviders() as $provider ) {
624 $info = $provider->provideSessionInfo( $request );
628 if ( $info->getProvider() !== $provider ) {
629 throw new \
UnexpectedValueException(
630 "$provider returned session info for a different provider: $info"
636 // Sort the SessionInfos. Then find the first one that can be
637 // successfully loaded, and then all the ones after it with the same
639 usort( $infos, 'MediaWiki\\Session\\SessionInfo::compare' );
642 $info = array_pop( $infos );
643 if ( $this->loadSessionInfoFromStore( $info, $request ) ) {
646 $info = array_pop( $infos );
647 if ( SessionInfo
::compare( $retInfos[0], $info ) ) {
648 // We hit a lower priority, stop checking.
651 if ( $this->loadSessionInfoFromStore( $info, $request ) ) {
652 // This is going to error out below, but we want to
653 // provide a complete list.
660 if ( count( $retInfos ) > 1 ) {
661 $ex = new \
OverflowException(
662 'Multiple sessions for this request tied for top priority: ' . join( ', ', $retInfos )
664 $ex->sessionInfos
= $retInfos;
668 return $retInfos ?
$retInfos[0] : null;
672 * Load and verify the session info against the store
674 * @param SessionInfo &$info Will likely be replaced with an updated SessionInfo instance
675 * @param WebRequest $request
676 * @return bool Whether the session info matches the stored data (if any)
678 private function loadSessionInfoFromStore( SessionInfo
&$info, WebRequest
$request ) {
679 $key = wfMemcKey( 'MWSession', $info->getId() );
680 $blob = $this->store
->get( $key );
684 if ( $blob !== false ) {
685 // Sanity check: blob must be an array, if it's saved at all
686 if ( !is_array( $blob ) ) {
687 $this->logger
->warning( 'Session "{session}": Bad data', [
690 $this->store
->delete( $key );
694 // Sanity check: blob has data and metadata arrays
695 if ( !isset( $blob['data'] ) ||
!is_array( $blob['data'] ) ||
696 !isset( $blob['metadata'] ) ||
!is_array( $blob['metadata'] )
698 $this->logger
->warning( 'Session "{session}": Bad data structure', [
701 $this->store
->delete( $key );
705 $data = $blob['data'];
706 $metadata = $blob['metadata'];
708 // Sanity check: metadata must be an array and must contain certain
709 // keys, if it's saved at all
710 if ( !array_key_exists( 'userId', $metadata ) ||
711 !array_key_exists( 'userName', $metadata ) ||
712 !array_key_exists( 'userToken', $metadata ) ||
713 !array_key_exists( 'provider', $metadata )
715 $this->logger
->warning( 'Session "{session}": Bad metadata', [
718 $this->store
->delete( $key );
722 // First, load the provider from metadata, or validate it against the metadata.
723 $provider = $info->getProvider();
724 if ( $provider === null ) {
725 $newParams['provider'] = $provider = $this->getProvider( $metadata['provider'] );
727 $this->logger
->warning(
728 'Session "{session}": Unknown provider ' . $metadata['provider'],
733 $this->store
->delete( $key );
736 } elseif ( $metadata['provider'] !== (string)$provider ) {
737 $this->logger
->warning( 'Session "{session}": Wrong provider ' .
738 $metadata['provider'] . ' !== ' . $provider,
745 // Load provider metadata from metadata, or validate it against the metadata
746 $providerMetadata = $info->getProviderMetadata();
747 if ( isset( $metadata['providerMetadata'] ) ) {
748 if ( $providerMetadata === null ) {
749 $newParams['metadata'] = $metadata['providerMetadata'];
752 $newProviderMetadata = $provider->mergeMetadata(
753 $metadata['providerMetadata'], $providerMetadata
755 if ( $newProviderMetadata !== $providerMetadata ) {
756 $newParams['metadata'] = $newProviderMetadata;
758 } catch ( MetadataMergeException
$ex ) {
759 $this->logger
->warning(
760 'Session "{session}": Metadata merge failed: {exception}',
764 ] +
$ex->getContext()
771 // Next, load the user from metadata, or validate it against the metadata.
772 $userInfo = $info->getUserInfo();
774 // For loading, id is preferred to name.
776 if ( $metadata['userId'] ) {
777 $userInfo = UserInfo
::newFromId( $metadata['userId'] );
778 } elseif ( $metadata['userName'] !== null ) { // Shouldn't happen, but just in case
779 $userInfo = UserInfo
::newFromName( $metadata['userName'] );
781 $userInfo = UserInfo
::newAnonymous();
783 } catch ( \InvalidArgumentException
$ex ) {
784 $this->logger
->error( 'Session "{session}": {exception}', [
790 $newParams['userInfo'] = $userInfo;
792 // User validation passes if user ID matches, or if there
793 // is no saved ID and the names match.
794 if ( $metadata['userId'] ) {
795 if ( $metadata['userId'] !== $userInfo->getId() ) {
796 $this->logger
->warning(
797 'Session "{session}": User ID mismatch, {uid_a} !== {uid_b}',
800 'uid_a' => $metadata['userId'],
801 'uid_b' => $userInfo->getId(),
806 // If the user was renamed, probably best to fail here.
807 if ( $metadata['userName'] !== null &&
808 $userInfo->getName() !== $metadata['userName']
810 $this->logger
->warning(
811 'Session "{session}": User ID matched but name didn\'t (rename?), {uname_a} !== {uname_b}',
814 'uname_a' => $metadata['userName'],
815 'uname_b' => $userInfo->getName(),
820 } elseif ( $metadata['userName'] !== null ) { // Shouldn't happen, but just in case
821 if ( $metadata['userName'] !== $userInfo->getName() ) {
822 $this->logger
->warning(
823 'Session "{session}": User name mismatch, {uname_a} !== {uname_b}',
826 'uname_a' => $metadata['userName'],
827 'uname_b' => $userInfo->getName(),
831 } elseif ( !$userInfo->isAnon() ) {
832 // Metadata specifies an anonymous user, but the passed-in
833 // user isn't anonymous.
834 $this->logger
->warning(
835 'Session "{session}": Metadata has an anonymous user, but a non-anon user was provided',
843 // And if we have a token in the metadata, it must match the loaded/provided user.
844 if ( $metadata['userToken'] !== null &&
845 $userInfo->getToken() !== $metadata['userToken']
847 $this->logger
->warning( 'Session "{session}": User token mismatch', [
852 if ( !$userInfo->isVerified() ) {
853 $newParams['userInfo'] = $userInfo->verified();
856 if ( !empty( $metadata['remember'] ) && !$info->wasRemembered() ) {
857 $newParams['remembered'] = true;
859 if ( !empty( $metadata['forceHTTPS'] ) && !$info->forceHTTPS() ) {
860 $newParams['forceHTTPS'] = true;
862 if ( !empty( $metadata['persisted'] ) && !$info->wasPersisted() ) {
863 $newParams['persisted'] = true;
866 if ( !$info->isIdSafe() ) {
867 $newParams['idIsSafe'] = true;
870 // No metadata, so we can't load the provider if one wasn't given.
871 if ( $info->getProvider() === null ) {
872 $this->logger
->warning(
873 'Session "{session}": Null provider and no metadata',
880 // If no user was provided and no metadata, it must be anon.
881 if ( !$info->getUserInfo() ) {
882 if ( $info->getProvider()->canChangeUser() ) {
883 $newParams['userInfo'] = UserInfo
::newAnonymous();
886 'Session "{session}": No user provided and provider cannot set user',
892 } elseif ( !$info->getUserInfo()->isVerified() ) {
893 $this->logger
->warning(
894 'Session "{session}": Unverified user provided and no metadata to auth it',
904 if ( !$info->getProvider()->persistsSessionId() && !$info->isIdSafe() ) {
905 // The ID doesn't come from the user, so it should be safe
906 // (and if not, nothing we can do about it anyway)
907 $newParams['idIsSafe'] = true;
911 // Construct the replacement SessionInfo, if necessary
913 $newParams['copyFrom'] = $info;
914 $info = new SessionInfo( $info->getPriority(), $newParams );
917 // Allow the provider to check the loaded SessionInfo
918 $providerMetadata = $info->getProviderMetadata();
919 if ( !$info->getProvider()->refreshSessionInfo( $info, $request, $providerMetadata ) ) {
922 if ( $providerMetadata !== $info->getProviderMetadata() ) {
923 $info = new SessionInfo( $info->getPriority(), [
924 'metadata' => $providerMetadata,
929 // Give hooks a chance to abort. Combined with the SessionMetadata
930 // hook, this can allow for tying a session to an IP address or the
932 $reason = 'Hook aborted';
935 [ &$reason, $info, $request, $metadata, $data ]
937 $this->logger
->warning( 'Session "{session}": ' . $reason, [
947 * Create a session corresponding to the passed SessionInfo
948 * @private For use by a SessionProvider that needs to specially create its
950 * @param SessionInfo $info
951 * @param WebRequest $request
954 public function getSessionFromInfo( SessionInfo
$info, WebRequest
$request ) {
955 if ( defined( 'MW_NO_SESSION' ) ) {
956 if ( MW_NO_SESSION
=== 'warn' ) {
957 // Undocumented safety case for converting existing entry points
958 $this->logger
->error( 'Sessions are supposed to be disabled for this entry point' );
960 throw new \
BadMethodCallException( 'Sessions are disabled for this entry point' );
964 $id = $info->getId();
966 if ( !isset( $this->allSessionBackends
[$id] ) ) {
967 if ( !isset( $this->allSessionIds
[$id] ) ) {
968 $this->allSessionIds
[$id] = new SessionId( $id );
970 $backend = new SessionBackend(
971 $this->allSessionIds
[$id],
975 $this->config
->get( 'ObjectCacheSessionExpiry' )
977 $this->allSessionBackends
[$id] = $backend;
978 $delay = $backend->delaySave();
980 $backend = $this->allSessionBackends
[$id];
981 $delay = $backend->delaySave();
982 if ( $info->wasPersisted() ) {
985 if ( $info->wasRemembered() ) {
986 $backend->setRememberUser( true );
990 $request->setSessionId( $backend->getSessionId() );
991 $session = $backend->getSession( $request );
993 if ( !$info->isIdSafe() ) {
997 \ScopedCallback
::consume( $delay );
1002 * Deregister a SessionBackend
1003 * @private For use from \\MediaWiki\\Session\\SessionBackend only
1004 * @param SessionBackend $backend
1006 public function deregisterSessionBackend( SessionBackend
$backend ) {
1007 $id = $backend->getId();
1008 if ( !isset( $this->allSessionBackends
[$id] ) ||
!isset( $this->allSessionIds
[$id] ) ||
1009 $this->allSessionBackends
[$id] !== $backend ||
1010 $this->allSessionIds
[$id] !== $backend->getSessionId()
1012 throw new \
InvalidArgumentException( 'Backend was not registered with this SessionManager' );
1015 unset( $this->allSessionBackends
[$id] );
1016 // Explicitly do not unset $this->allSessionIds[$id]
1020 * Change a SessionBackend's ID
1021 * @private For use from \\MediaWiki\\Session\\SessionBackend only
1022 * @param SessionBackend $backend
1024 public function changeBackendId( SessionBackend
$backend ) {
1025 $sessionId = $backend->getSessionId();
1026 $oldId = (string)$sessionId;
1027 if ( !isset( $this->allSessionBackends
[$oldId] ) ||
!isset( $this->allSessionIds
[$oldId] ) ||
1028 $this->allSessionBackends
[$oldId] !== $backend ||
1029 $this->allSessionIds
[$oldId] !== $sessionId
1031 throw new \
InvalidArgumentException( 'Backend was not registered with this SessionManager' );
1034 $newId = $this->generateSessionId();
1036 unset( $this->allSessionBackends
[$oldId], $this->allSessionIds
[$oldId] );
1037 $sessionId->setId( $newId );
1038 $this->allSessionBackends
[$newId] = $backend;
1039 $this->allSessionIds
[$newId] = $sessionId;
1043 * Generate a new random session ID
1046 public function generateSessionId() {
1048 $id = wfBaseConvert( \MWCryptRand
::generateHex( 40 ), 16, 32, 32 );
1049 $key = wfMemcKey( 'MWSession', $id );
1050 } while ( isset( $this->allSessionIds
[$id] ) ||
is_array( $this->store
->get( $key ) ) );
1055 * Call setters on a PHPSessionHandler
1056 * @private Use PhpSessionHandler::install()
1057 * @param PHPSessionHandler $handler
1059 public function setupPHPSessionHandler( PHPSessionHandler
$handler ) {
1060 $handler->setManager( $this, $this->store
, $this->logger
);
1064 * Reset the internal caching for unit testing
1066 public static function resetCache() {
1067 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
1068 // @codeCoverageIgnoreStart
1069 throw new MWException( __METHOD__
. ' may only be called from unit tests!' );
1070 // @codeCoverageIgnoreEnd
1073 self
::$globalSession = null;
1074 self
::$globalSessionRequest = null;
1078 * Do a sanity check to make sure the session is not used from many different IP addresses
1079 * and store some data for later sanity checks.
1080 * FIXME remove this once SessionManager is considered stable
1081 * @private For use in Setup.php only
1082 * @param Session $session Defaults to the global session.
1084 public function checkIpLimits( Session
$session = null ) {
1085 $session = $session ?
: self
::getGlobalSession();
1088 $ip = $session->getRequest()->getIP();
1089 } catch ( \MWException
$e ) {
1092 if ( $ip === '127.0.0.1' || \IP
::isConfiguredProxy( $ip ) ) {
1097 // Record (and possibly log) that the IP is using the current session.
1098 // Don't touch the stored data unless we are adding a new IP or re-adding an expired one.
1099 // This is slightly inaccurate (when an existing IP is seen again, the expiry is not
1100 // extended) but that shouldn't make much difference and limits the session write frequency
1101 // to # of IPs / $wgSuspiciousIpExpiry.
1102 $data = $session->get( 'SessionManager-ip', [] );
1104 !isset( $data[$ip] )
1105 ||
$data[$ip] < $now
1107 $data[$ip] = time() +
$this->config
->get( 'SuspiciousIpExpiry' );
1108 foreach ( $data as $key => $expires ) {
1109 if ( $expires < $now ) {
1110 unset( $data[$key] );
1113 $session->set( 'SessionManager-ip', $data );
1115 $logger = \MediaWiki\Logger\LoggerFactory
::getInstance( 'session-ip' );
1116 $logLevel = count( $data ) >= $this->config
->get( 'SuspiciousIpPerSessionLimit' )
1117 ? LogLevel
::WARNING
: ( count( $data ) === 1 ? LogLevel
::DEBUG
: LogLevel
::INFO
);
1120 'Same session used from {count} IPs',
1122 'count' => count( $data ),
1124 'session' => $session->getId(),
1125 'user' => $session->getUser()->getName(),
1126 'persistent' => $session->isPersistent(),
1131 // Now do the same thing globally for the current user.
1132 // We are using the object cache and assume it is shared between all wikis of a farm,
1133 // and further assume that the same name belongs to the same user on all wikis. (It's either
1134 // that or a central ID lookup which would mean an extra SQL query on every request.)
1135 if ( $session->getUser()->isLoggedIn() ) {
1136 $userKey = 'SessionManager-ip:' . md5( $session->getUser()->getName() );
1137 $data = $this->store
->get( $userKey ) ?
: [];
1139 !isset( $data[$ip] )
1140 ||
$data[$ip] < $now
1142 $data[$ip] = time() +
$this->config
->get( 'SuspiciousIpExpiry' );
1143 foreach ( $data as $key => $expires ) {
1144 if ( $expires < $now ) {
1145 unset( $data[$key] );
1148 $this->store
->set( $userKey, $data, $this->config
->get( 'SuspiciousIpExpiry' ) );
1149 $logger = \MediaWiki\Logger\LoggerFactory
::getInstance( 'session-ip' );
1150 $logLevel = count( $data ) >= $this->config
->get( 'SuspiciousIpPerUserLimit' )
1151 ? LogLevel
::WARNING
: ( count( $data ) === 1 ? LogLevel
::DEBUG
: LogLevel
::INFO
);
1154 'Same user had sessions from {count} IPs',
1156 'count' => count( $data ),
1158 'session' => $session->getId(),
1159 'user' => $session->getUser()->getName(),
1160 'persistent' => $session->isPersistent(),