includes/session/SessionManager.php

   1 <?php
   2 /**
   3  * MediaWiki\Session entry point
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Session
  22  */
  23
  24 namespace MediaWiki\Session;
  25
  26 use Psr\Log\LoggerInterface;
  27 use Psr\Log\LogLevel;
  28 use BagOStuff;
  29 use CachedBagOStuff;
  30 use Config;
  31 use FauxRequest;
  32 use User;
  33 use WebRequest;
  34
  35 /**
  36  * This serves as the entry point to the MediaWiki session handling system.
  37  *
  38  * @ingroup Session
  39  * @since 1.27
  40  */
  41 final class SessionManager implements SessionManagerInterface {
  42         /** @var SessionManager|null */
  43         private static $instance = null;
  44
  45         /** @var Session|null */
  46         private static $globalSession = null;
  47
  48         /** @var WebRequest|null */
  49         private static $globalSessionRequest = null;
  50
  51         /** @var LoggerInterface */
  52         private $logger;
  53
  54         /** @var Config */
  55         private $config;
  56
  57         /** @var CachedBagOStuff|null */
  58         private $store;
  59
  60         /** @var SessionProvider[] */
  61         private $sessionProviders = null;
  62
  63         /** @var string[] */
  64         private $varyCookies = null;
  65
  66         /** @var array */
  67         private $varyHeaders = null;
  68
  69         /** @var SessionBackend[] */
  70         private $allSessionBackends = [];
  71
  72         /** @var SessionId[] */
  73         private $allSessionIds = [];
  74
  75         /** @var string[] */
  76         private $preventUsers = [];
  77
  78         /**
  79          * Get the global SessionManager
  80          * @return SessionManagerInterface
  81          *  (really a SessionManager, but this is to make IDEs less confused)
  82          */
  83         public static function singleton() {
  84                 if ( self::$instance === null ) {
  85                         self::$instance = new self();
  86                 }
  87                 return self::$instance;
  88         }
  89
  90         /**
  91          * Get the "global" session
  92          *
  93          * If PHP's session_id() has been set, returns that session. Otherwise
  94          * returns the session for RequestContext::getMain()->getRequest().
  95          *
  96          * @return Session
  97          */
  98         public static function getGlobalSession() {
  99                 if ( !PHPSessionHandler::isEnabled() ) {
 100                         $id = '';
 101                 } else {
 102                         $id = session_id();
 103                 }
 104
 105                 $request = \RequestContext::getMain()->getRequest();
 106                 if (
 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()
 110                 ) {
 111                         self::$globalSessionRequest = $request;
 112                         if ( $id === '' ) {
 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();
 122                         } else {
 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();
 128                         }
 129                 }
 130                 return self::$globalSession;
 131         }
 132
 133         /**
 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.
 138          */
 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'
 145                                 );
 146                         }
 147                 } else {
 148                         $this->config = \ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
 149                 }
 150
 151                 if ( isset( $options['logger'] ) ) {
 152                         if ( !$options['logger'] instanceof LoggerInterface ) {
 153                                 throw new \InvalidArgumentException(
 154                                         '$options[\'logger\'] must be an instance of LoggerInterface'
 155                                 );
 156                         }
 157                         $this->setLogger( $options['logger'] );
 158                 } else {
 159                         $this->setLogger( \MediaWiki\Logger\LoggerFactory::getInstance( 'session' ) );
 160                 }
 161
 162                 if ( isset( $options['store'] ) ) {
 163                         if ( !$options['store'] instanceof BagOStuff ) {
 164                                 throw new \InvalidArgumentException(
 165                                         '$options[\'store\'] must be an instance of BagOStuff'
 166                                 );
 167                         }
 168                         $store = $options['store'];
 169                 } else {
 170                         $store = \ObjectCache::getInstance( $this->config->get( 'SessionCacheType' ) );
 171                         $store->setLogger( $this->logger );
 172                 }
 173                 $this->store = $store instanceof CachedBagOStuff ? $store : new CachedBagOStuff( $store );
 174
 175                 register_shutdown_function( [ $this, 'shutdown' ] );
 176         }
 177
 178         public function setLogger( LoggerInterface $logger ) {
 179                 $this->logger = $logger;
 180         }
 181
 182         public function getSessionForRequest( WebRequest $request ) {
 183                 $info = $this->getSessionInfoForRequest( $request );
 184
 185                 if ( !$info ) {
 186                         $session = $this->getEmptySession( $request );
 187                 } else {
 188                         $session = $this->getSessionFromInfo( $info, $request );
 189                 }
 190                 return $session;
 191         }
 192
 193         public function getSessionById( $id, $create = false, WebRequest $request = null ) {
 194                 if ( !self::validateSessionId( $id ) ) {
 195                         throw new \InvalidArgumentException( 'Invalid session ID' );
 196                 }
 197                 if ( !$request ) {
 198                         $request = new FauxRequest;
 199                 }
 200
 201                 $session = null;
 202
 203                 // Test this here to provide a better log message for the common case
 204                 // of "no such ID"
 205                 $key = wfMemcKey( 'MWSession', $id );
 206                 if ( is_array( $this->store->get( $key ) ) ) {
 207                         $info = new SessionInfo( SessionInfo::MIN_PRIORITY, [ 'id' => $id, 'idIsSafe' => true ] );
 208                         if ( $this->loadSessionInfoFromStore( $info, $request ) ) {
 209                                 $session = $this->getSessionFromInfo( $info, $request );
 210                         }
 211                 }
 212
 213                 if ( $create && $session === null ) {
 214                         $ex = null;
 215                         try {
 216                                 $session = $this->getEmptySessionInternal( $request, $id );
 217                         } catch ( \Exception $ex ) {
 218                                 $this->logger->error( 'Failed to create empty session: {exception}',
 219                                         [
 220                                                 'method' => __METHOD__,
 221                                                 'exception' => $ex,
 222                                 ] );
 223                                 $session = null;
 224                         }
 225                 }
 226
 227                 return $session;
 228         }
 229
 230         public function getEmptySession( WebRequest $request = null ) {
 231                 return $this->getEmptySessionInternal( $request );
 232         }
 233
 234         /**
 235          * @see SessionManagerInterface::getEmptySession
 236          * @param WebRequest|null $request
 237          * @param string|null $id ID to force on the new session
 238          * @return Session
 239          */
 240         private function getEmptySessionInternal( WebRequest $request = null, $id = null ) {
 241                 if ( $id !== null ) {
 242                         if ( !self::validateSessionId( $id ) ) {
 243                                 throw new \InvalidArgumentException( 'Invalid session ID' );
 244                         }
 245
 246                         $key = wfMemcKey( 'MWSession', $id );
 247                         if ( is_array( $this->store->get( $key ) ) ) {
 248                                 throw new \InvalidArgumentException( 'Session ID already exists' );
 249                         }
 250                 }
 251                 if ( !$request ) {
 252                         $request = new FauxRequest;
 253                 }
 254
 255                 $infos = [];
 256                 foreach ( $this->getProviders() as $provider ) {
 257                         $info = $provider->newSessionInfo( $id );
 258                         if ( !$info ) {
 259                                 continue;
 260                         }
 261                         if ( $info->getProvider() !== $provider ) {
 262                                 throw new \UnexpectedValueException(
 263                                         "$provider returned an empty session info for a different provider: $info"
 264                                 );
 265                         }
 266                         if ( $id !== null && $info->getId() !== $id ) {
 267                                 throw new \UnexpectedValueException(
 268                                         "$provider returned empty session info with a wrong id: " .
 269                                                 $info->getId() . ' != ' . $id
 270                                 );
 271                         }
 272                         if ( !$info->isIdSafe() ) {
 273                                 throw new \UnexpectedValueException(
 274                                         "$provider returned empty session info with id flagged unsafe"
 275                                 );
 276                         }
 277                         $compare = $infos ? SessionInfo::compare( $infos[0], $info ) : -1;
 278                         if ( $compare > 0 ) {
 279                                 continue;
 280                         }
 281                         if ( $compare === 0 ) {
 282                                 $infos[] = $info;
 283                         } else {
 284                                 $infos = [ $info ];
 285                         }
 286                 }
 287
 288                 // Make sure there's exactly one
 289                 if ( count( $infos ) > 1 ) {
 290                         throw new \UnexpectedValueException(
 291                                 'Multiple empty sessions tied for top priority: ' . join( ', ', $infos )
 292                         );
 293                 } elseif ( count( $infos ) < 1 ) {
 294                         throw new \UnexpectedValueException( 'No provider could provide an empty session!' );
 295                 }
 296
 297                 return $this->getSessionFromInfo( $infos[0], $request );
 298         }
 299
 300         public function getVaryHeaders() {
 301                 if ( $this->varyHeaders === null ) {
 302                         $headers = [];
 303                         foreach ( $this->getProviders() as $provider ) {
 304                                 foreach ( $provider->getVaryHeaders() as $header => $options ) {
 305                                         if ( !isset( $headers[$header] ) ) {
 306                                                 $headers[$header] = [];
 307                                         }
 308                                         if ( is_array( $options ) ) {
 309                                                 $headers[$header] = array_unique( array_merge( $headers[$header], $options ) );
 310                                         }
 311                                 }
 312                         }
 313                         $this->varyHeaders = $headers;
 314                 }
 315                 return $this->varyHeaders;
 316         }
 317
 318         public function getVaryCookies() {
 319                 if ( $this->varyCookies === null ) {
 320                         $cookies = [];
 321                         foreach ( $this->getProviders() as $provider ) {
 322                                 $cookies = array_merge( $cookies, $provider->getVaryCookies() );
 323                         }
 324                         $this->varyCookies = array_values( array_unique( $cookies ) );
 325                 }
 326                 return $this->varyCookies;
 327         }
 328
 329         /**
 330          * Validate a session ID
 331          * @param string $id
 332          * @return bool
 333          */
 334         public static function validateSessionId( $id ) {
 335                 return is_string( $id ) && preg_match( '/^[a-zA-Z0-9_-]{32,}$/', $id );
 336         }
 337
 338         /**
 339          * @name Internal methods
 340          * @{
 341          */
 342
 343         /**
 344          * Auto-create the given user, if necessary
 345          * @private Don't call this yourself. Let Setup.php do it for you at the right time.
 346          * @note This more properly belongs in AuthManager, but we need it now.
 347          *  When AuthManager comes, this will be deprecated and will pass-through
 348          *  to the corresponding AuthManager method.
 349          * @param User $user User to auto-create
 350          * @return bool Success
 351          */
 352         public static function autoCreateUser( User $user ) {
 353                 global $wgAuth;
 354
 355                 $logger = self::singleton()->logger;
 356
 357                 // Much of this code is based on that in CentralAuth
 358
 359                 // Try the local user from the slave DB
 360                 $localId = User::idFromName( $user->getName() );
 361
 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                 }
 368                 // @codeCoverageIgnoreEnd
 369
 370                 if ( $localId ) {
 371                         // User exists after all.
 372                         $user->setId( $localId );
 373                         $user->loadFromId();
 374                         return false;
 375                 }
 376
 377                 // Denied by AuthPlugin? But ignore AuthPlugin itself.
 378                 if ( get_class( $wgAuth ) !== 'AuthPlugin' && !$wgAuth->autoCreate() ) {
 379                         $logger->debug( __METHOD__ . ': denied by AuthPlugin' );
 380                         $user->setId( 0 );
 381                         $user->loadFromId();
 382                         return false;
 383                 }
 384
 385                 // Wiki is read-only?
 386                 if ( wfReadOnly() ) {
 387                         $logger->debug( __METHOD__ . ': denied by wfReadOnly()' );
 388                         $user->setId( 0 );
 389                         $user->loadFromId();
 390                         return false;
 391                 }
 392
 393                 $userName = $user->getName();
 394
 395                 // Check the session, if we tried to create this user already there's
 396                 // no point in retrying.
 397                 $session = self::getGlobalSession();
 398                 $reason = $session->get( 'MWSession::AutoCreateBlacklist' );
 399                 if ( $reason ) {
 400                         $logger->debug( __METHOD__ . ": blacklisted in session ($reason)" );
 401                         $user->setId( 0 );
 402                         $user->loadFromId();
 403                         return false;
 404                 }
 405
 406                 // Is the IP user able to create accounts?
 407                 $anon = new User;
 408                 if ( !$anon->isAllowedAny( 'createaccount', 'autocreateaccount' )
 409                         || $anon->isBlockedFromCreateAccount()
 410                 ) {
 411                         // Blacklist the user to avoid repeated DB queries subsequently
 412                         $logger->debug( __METHOD__ . ': user is blocked from this wiki, blacklisting' );
 413                         $session->set( 'MWSession::AutoCreateBlacklist', 'blocked', 600 );
 414                         $session->persist();
 415                         $user->setId( 0 );
 416                         $user->loadFromId();
 417                         return false;
 418                 }
 419
 420                 // Check for validity of username
 421                 if ( !User::isCreatableName( $userName ) ) {
 422                         $logger->debug( __METHOD__ . ': Invalid username, blacklisting' );
 423                         $session->set( 'MWSession::AutoCreateBlacklist', 'invalid username', 600 );
 424                         $session->persist();
 425                         $user->setId( 0 );
 426                         $user->loadFromId();
 427                         return false;
 428                 }
 429
 430                 // Give other extensions a chance to stop auto creation.
 431                 $user->loadDefaults( $userName );
 432                 $abortMessage = '';
 433                 if ( !\Hooks::run( 'AbortAutoAccount', [ $user, &$abortMessage ] ) ) {
 434                         // In this case we have no way to return the message to the user,
 435                         // but we can log it.
 436                         $logger->debug( __METHOD__ . ": denied by hook: $abortMessage" );
 437                         $session->set( 'MWSession::AutoCreateBlacklist', "hook aborted: $abortMessage", 600 );
 438                         $session->persist();
 439                         $user->setId( 0 );
 440                         $user->loadFromId();
 441                         return false;
 442                 }
 443
 444                 // Make sure the name has not been changed
 445                 if ( $user->getName() !== $userName ) {
 446                         $user->setId( 0 );
 447                         $user->loadFromId();
 448                         throw new \UnexpectedValueException(
 449                                 'AbortAutoAccount hook tried to change the user name'
 450                         );
 451                 }
 452
 453                 // Ignore warnings about master connections/writes...hard to avoid here
 454                 \Profiler::instance()->getTransactionProfiler()->resetExpectations();
 455
 456                 $cache = \ObjectCache::getLocalClusterInstance();
 457                 $backoffKey = wfMemcKey( 'MWSession', 'autocreate-failed', md5( $userName ) );
 458                 if ( $cache->get( $backoffKey ) ) {
 459                         $logger->debug( __METHOD__ . ': denied by prior creation attempt failures' );
 460                         $user->setId( 0 );
 461                         $user->loadFromId();
 462                         return false;
 463                 }
 464
 465                 // Checks passed, create the user...
 466                 $from = isset( $_SERVER['REQUEST_URI'] ) ? $_SERVER['REQUEST_URI'] : 'CLI';
 467                 $logger->info( __METHOD__ . ': creating new user ({username}) - from: {url}',
 468                         [
 469                                 'username' => $userName,
 470                                 'url' => $from,
 471                 ] );
 472
 473                 try {
 474                         // Insert the user into the local DB master
 475                         $status = $user->addToDatabase();
 476                         if ( !$status->isOK() ) {
 477                                 // @codeCoverageIgnoreStart
 478                                 // double-check for a race condition (T70012)
 479                                 $id = User::idFromName( $user->getName(), User::READ_LATEST );
 480                                 if ( $id ) {
 481                                         $logger->info( __METHOD__ . ': tried to autocreate existing user',
 482                                                 [
 483                                                         'username' => $userName,
 484                                                 ] );
 485                                 } else {
 486                                         $logger->error( __METHOD__ . ': failed with message ' . $status->getWikiText(),
 487                                                 [
 488                                                         'username' => $userName,
 489                                                 ] );
 490                                 }
 491                                 $user->setId( $id );
 492                                 $user->loadFromId( User::READ_LATEST );
 493                                 return false;
 494                                 // @codeCoverageIgnoreEnd
 495                         }
 496                 } catch ( \Exception $ex ) {
 497                         // @codeCoverageIgnoreStart
 498                         $logger->error( __METHOD__ . ': failed with exception {exception}', [
 499                                 'exception' => $ex,
 500                                 'username' => $userName,
 501                         ] );
 502                         // Do not keep throwing errors for a while
 503                         $cache->set( $backoffKey, 1, 600 );
 504                         // Bubble up error; which should normally trigger DB rollbacks
 505                         throw $ex;
 506                         // @codeCoverageIgnoreEnd
 507                 }
 508
 509                 # Notify AuthPlugin
 510                 $tmpUser = $user;
 511                 $wgAuth->initUser( $tmpUser, true );
 512                 if ( $tmpUser !== $user ) {
 513                         $logger->warning( __METHOD__ . ': ' .
 514                                 get_class( $wgAuth ) . '::initUser() replaced the user object' );
 515                 }
 516
 517                 # Notify hooks (e.g. Newuserlog)
 518                 \Hooks::run( 'AuthPluginAutoCreate', [ $user ] );
 519                 \Hooks::run( 'LocalUserCreated', [ $user, true ] );
 520
 521                 $user->saveSettings();
 522
 523                 # Update user count
 524                 \DeferredUpdates::addUpdate( new \SiteStatsUpdate( 0, 0, 0, 0, 1 ) );
 525
 526                 # Watch user's userpage and talk page
 527                 $user->addWatch( $user->getUserPage(), \WatchedItem::IGNORE_USER_RIGHTS );
 528
 529                 return true;
 530         }
 531
 532         /**
 533          * Prevent future sessions for the user
 534          *
 535          * The intention is that the named account will never again be usable for
 536          * normal login (i.e. there is no way to undo the prevention of access).
 537          *
 538          * @private For use from \\User::newSystemUser only
 539          * @param string $username
 540          */
 541         public function preventSessionsForUser( $username ) {
 542                 $this->preventUsers[$username] = true;
 543
 544                 // Instruct the session providers to kill any other sessions too.
 545                 foreach ( $this->getProviders() as $provider ) {
 546                         $provider->preventSessionsForUser( $username );
 547                 }
 548         }
 549
 550         /**
 551          * Test if a user is prevented
 552          * @private For use from SessionBackend only
 553          * @param string $username
 554          * @return bool
 555          */
 556         public function isUserSessionPrevented( $username ) {
 557                 return !empty( $this->preventUsers[$username] );
 558         }
 559
 560         /**
 561          * Get the available SessionProviders
 562          * @return SessionProvider[]
 563          */
 564         protected function getProviders() {
 565                 if ( $this->sessionProviders === null ) {
 566                         $this->sessionProviders = [];
 567                         foreach ( $this->config->get( 'SessionProviders' ) as $spec ) {
 568                                 $provider = \ObjectFactory::getObjectFromSpec( $spec );
 569                                 $provider->setLogger( $this->logger );
 570                                 $provider->setConfig( $this->config );
 571                                 $provider->setManager( $this );
 572                                 if ( isset( $this->sessionProviders[(string)$provider] ) ) {
 573                                         throw new \UnexpectedValueException( "Duplicate provider name \"$provider\"" );
 574                                 }
 575                                 $this->sessionProviders[(string)$provider] = $provider;
 576                         }
 577                 }
 578                 return $this->sessionProviders;
 579         }
 580
 581         /**
 582          * Get a session provider by name
 583          *
 584          * Generally, this will only be used by internal implementation of some
 585          * special session-providing mechanism. General purpose code, if it needs
 586          * to access a SessionProvider at all, will use Session::getProvider().
 587          *
 588          * @param string $name
 589          * @return SessionProvider|null
 590          */
 591         public function getProvider( $name ) {
 592                 $providers = $this->getProviders();
 593                 return isset( $providers[$name] ) ? $providers[$name] : null;
 594         }
 595
 596         /**
 597          * Save all active sessions on shutdown
 598          * @private For internal use with register_shutdown_function()
 599          */
 600         public function shutdown() {
 601                 if ( $this->allSessionBackends ) {
 602                         $this->logger->debug( 'Saving all sessions on shutdown' );
 603                         if ( session_id() !== '' ) {
 604                                 // @codeCoverageIgnoreStart
 605                                 session_write_close();
 606                         }
 607                         // @codeCoverageIgnoreEnd
 608                         foreach ( $this->allSessionBackends as $backend ) {
 609                                 $backend->save( true );
 610                         }
 611                 }
 612         }
 613
 614         /**
 615          * Fetch the SessionInfo(s) for a request
 616          * @param WebRequest $request
 617          * @return SessionInfo|null
 618          */
 619         private function getSessionInfoForRequest( WebRequest $request ) {
 620                 // Call all providers to fetch "the" session
 621                 $infos = [];
 622                 foreach ( $this->getProviders() as $provider ) {
 623                         $info = $provider->provideSessionInfo( $request );
 624                         if ( !$info ) {
 625                                 continue;
 626                         }
 627                         if ( $info->getProvider() !== $provider ) {
 628                                 throw new \UnexpectedValueException(
 629                                         "$provider returned session info for a different provider: $info"
 630                                 );
 631                         }
 632                         $infos[] = $info;
 633                 }
 634
 635                 // Sort the SessionInfos. Then find the first one that can be
 636                 // successfully loaded, and then all the ones after it with the same
 637                 // priority.
 638                 usort( $infos, 'MediaWiki\\Session\\SessionInfo::compare' );
 639                 $retInfos = [];
 640                 while ( $infos ) {
 641                         $info = array_pop( $infos );
 642                         if ( $this->loadSessionInfoFromStore( $info, $request ) ) {
 643                                 $retInfos[] = $info;
 644                                 while ( $infos ) {
 645                                         $info = array_pop( $infos );
 646                                         if ( SessionInfo::compare( $retInfos[0], $info ) ) {
 647                                                 // We hit a lower priority, stop checking.
 648                                                 break;
 649                                         }
 650                                         if ( $this->loadSessionInfoFromStore( $info, $request ) ) {
 651                                                 // This is going to error out below, but we want to
 652                                                 // provide a complete list.
 653                                                 $retInfos[] = $info;
 654                                         }
 655                                 }
 656                         }
 657                 }
 658
 659                 if ( count( $retInfos ) > 1 ) {
 660                         $ex = new \OverflowException(
 661                                 'Multiple sessions for this request tied for top priority: ' . join( ', ', $retInfos )
 662                         );
 663                         $ex->sessionInfos = $retInfos;
 664                         throw $ex;
 665                 }
 666
 667                 return $retInfos ? $retInfos[0] : null;
 668         }
 669
 670         /**
 671          * Load and verify the session info against the store
 672          *
 673          * @param SessionInfo &$info Will likely be replaced with an updated SessionInfo instance
 674          * @param WebRequest $request
 675          * @return bool Whether the session info matches the stored data (if any)
 676          */
 677         private function loadSessionInfoFromStore( SessionInfo &$info, WebRequest $request ) {
 678                 $key = wfMemcKey( 'MWSession', $info->getId() );
 679                 $blob = $this->store->get( $key );
 680
 681                 $newParams = [];
 682
 683                 if ( $blob !== false ) {
 684                         // Sanity check: blob must be an array, if it's saved at all
 685                         if ( !is_array( $blob ) ) {
 686                                 $this->logger->warning( 'Session "{session}": Bad data', [
 687                                         'session' => $info,
 688                                 ] );
 689                                 $this->store->delete( $key );
 690                                 return false;
 691                         }
 692
 693                         // Sanity check: blob has data and metadata arrays
 694                         if ( !isset( $blob['data'] ) || !is_array( $blob['data'] ) ||
 695                                 !isset( $blob['metadata'] ) || !is_array( $blob['metadata'] )
 696                         ) {
 697                                 $this->logger->warning( 'Session "{session}": Bad data structure', [
 698                                         'session' => $info,
 699                                 ] );
 700                                 $this->store->delete( $key );
 701                                 return false;
 702                         }
 703
 704                         $data = $blob['data'];
 705                         $metadata = $blob['metadata'];
 706
 707                         // Sanity check: metadata must be an array and must contain certain
 708                         // keys, if it's saved at all
 709                         if ( !array_key_exists( 'userId', $metadata ) ||
 710                                 !array_key_exists( 'userName', $metadata ) ||
 711                                 !array_key_exists( 'userToken', $metadata ) ||
 712                                 !array_key_exists( 'provider', $metadata )
 713                         ) {
 714                                 $this->logger->warning( 'Session "{session}": Bad metadata', [
 715                                         'session' => $info,
 716                                 ] );
 717                                 $this->store->delete( $key );
 718                                 return false;
 719                         }
 720
 721                         // First, load the provider from metadata, or validate it against the metadata.
 722                         $provider = $info->getProvider();
 723                         if ( $provider === null ) {
 724                                 $newParams['provider'] = $provider = $this->getProvider( $metadata['provider'] );
 725                                 if ( !$provider ) {
 726                                         $this->logger->warning(
 727                                                 'Session "{session}": Unknown provider ' . $metadata['provider'],
 728                                                 [
 729                                                         'session' => $info,
 730                                                 ]
 731                                         );
 732                                         $this->store->delete( $key );
 733                                         return false;
 734                                 }
 735                         } elseif ( $metadata['provider'] !== (string)$provider ) {
 736                                 $this->logger->warning( 'Session "{session}": Wrong provider ' .
 737                                         $metadata['provider'] . ' !== ' . $provider,
 738                                         [
 739                                                 'session' => $info,
 740                                 ] );
 741                                 return false;
 742                         }
 743
 744                         // Load provider metadata from metadata, or validate it against the metadata
 745                         $providerMetadata = $info->getProviderMetadata();
 746                         if ( isset( $metadata['providerMetadata'] ) ) {
 747                                 if ( $providerMetadata === null ) {
 748                                         $newParams['metadata'] = $metadata['providerMetadata'];
 749                                 } else {
 750                                         try {
 751                                                 $newProviderMetadata = $provider->mergeMetadata(
 752                                                         $metadata['providerMetadata'], $providerMetadata
 753                                                 );
 754                                                 if ( $newProviderMetadata !== $providerMetadata ) {
 755                                                         $newParams['metadata'] = $newProviderMetadata;
 756                                                 }
 757                                         } catch ( MetadataMergeException $ex ) {
 758                                                 $this->logger->warning(
 759                                                         'Session "{session}": Metadata merge failed: {exception}',
 760                                                         [
 761                                                                 'session' => $info,
 762                                                                 'exception' => $ex,
 763                                                         ] + $ex->getContext()
 764                                                 );
 765                                                 return false;
 766                                         }
 767                                 }
 768                         }
 769
 770                         // Next, load the user from metadata, or validate it against the metadata.
 771                         $userInfo = $info->getUserInfo();
 772                         if ( !$userInfo ) {
 773                                 // For loading, id is preferred to name.
 774                                 try {
 775                                         if ( $metadata['userId'] ) {
 776                                                 $userInfo = UserInfo::newFromId( $metadata['userId'] );
 777                                         } elseif ( $metadata['userName'] !== null ) { // Shouldn't happen, but just in case
 778                                                 $userInfo = UserInfo::newFromName( $metadata['userName'] );
 779                                         } else {
 780                                                 $userInfo = UserInfo::newAnonymous();
 781                                         }
 782                                 } catch ( \InvalidArgumentException $ex ) {
 783                                         $this->logger->error( 'Session "{session}": {exception}', [
 784                                                 'session' => $info,
 785                                                 'exception' => $ex,
 786                                         ] );
 787                                         return false;
 788                                 }
 789                                 $newParams['userInfo'] = $userInfo;
 790                         } else {
 791                                 // User validation passes if user ID matches, or if there
 792                                 // is no saved ID and the names match.
 793                                 if ( $metadata['userId'] ) {
 794                                         if ( $metadata['userId'] !== $userInfo->getId() ) {
 795                                                 $this->logger->warning(
 796                                                         'Session "{session}": User ID mismatch, {uid_a} !== {uid_b}',
 797                                                         [
 798                                                                 'session' => $info,
 799                                                                 'uid_a' => $metadata['userId'],
 800                                                                 'uid_b' => $userInfo->getId(),
 801                                                 ] );
 802                                                 return false;
 803                                         }
 804
 805                                         // If the user was renamed, probably best to fail here.
 806                                         if ( $metadata['userName'] !== null &&
 807                                                 $userInfo->getName() !== $metadata['userName']
 808                                         ) {
 809                                                 $this->logger->warning(
 810                                                         'Session "{session}": User ID matched but name didn\'t (rename?), {uname_a} !== {uname_b}',
 811                                                         [
 812                                                                 'session' => $info,
 813                                                                 'uname_a' => $metadata['userName'],
 814                                                                 'uname_b' => $userInfo->getName(),
 815                                                 ] );
 816                                                 return false;
 817                                         }
 818
 819                                 } elseif ( $metadata['userName'] !== null ) { // Shouldn't happen, but just in case
 820                                         if ( $metadata['userName'] !== $userInfo->getName() ) {
 821                                                 $this->logger->warning(
 822                                                         'Session "{session}": User name mismatch, {uname_a} !== {uname_b}',
 823                                                         [
 824                                                                 'session' => $info,
 825                                                                 'uname_a' => $metadata['userName'],
 826                                                                 'uname_b' => $userInfo->getName(),
 827                                                 ] );
 828                                                 return false;
 829                                         }
 830                                 } elseif ( !$userInfo->isAnon() ) {
 831                                         // Metadata specifies an anonymous user, but the passed-in
 832                                         // user isn't anonymous.
 833                                         $this->logger->warning(
 834                                                 'Session "{session}": Metadata has an anonymous user, but a non-anon user was provided',
 835                                                 [
 836                                                         'session' => $info,
 837                                         ] );
 838                                         return false;
 839                                 }
 840                         }
 841
 842                         // And if we have a token in the metadata, it must match the loaded/provided user.
 843                         if ( $metadata['userToken'] !== null &&
 844                                 $userInfo->getToken() !== $metadata['userToken']
 845                         ) {
 846                                 $this->logger->warning( 'Session "{session}": User token mismatch', [
 847                                         'session' => $info,
 848                                 ] );
 849                                 return false;
 850                         }
 851                         if ( !$userInfo->isVerified() ) {
 852                                 $newParams['userInfo'] = $userInfo->verified();
 853                         }
 854
 855                         if ( !empty( $metadata['remember'] ) && !$info->wasRemembered() ) {
 856                                 $newParams['remembered'] = true;
 857                         }
 858                         if ( !empty( $metadata['forceHTTPS'] ) && !$info->forceHTTPS() ) {
 859                                 $newParams['forceHTTPS'] = true;
 860                         }
 861                         if ( !empty( $metadata['persisted'] ) && !$info->wasPersisted() ) {
 862                                 $newParams['persisted'] = true;
 863                         }
 864
 865                         if ( !$info->isIdSafe() ) {
 866                                 $newParams['idIsSafe'] = true;
 867                         }
 868                 } else {
 869                         // No metadata, so we can't load the provider if one wasn't given.
 870                         if ( $info->getProvider() === null ) {
 871                                 $this->logger->warning(
 872                                         'Session "{session}": Null provider and no metadata',
 873                                         [
 874                                                 'session' => $info,
 875                                 ] );
 876                                 return false;
 877                         }
 878
 879                         // If no user was provided and no metadata, it must be anon.
 880                         if ( !$info->getUserInfo() ) {
 881                                 if ( $info->getProvider()->canChangeUser() ) {
 882                                         $newParams['userInfo'] = UserInfo::newAnonymous();
 883                                 } else {
 884                                         $this->logger->info(
 885                                                 'Session "{session}": No user provided and provider cannot set user',
 886                                                 [
 887                                                         'session' => $info,
 888                                         ] );
 889                                         return false;
 890                                 }
 891                         } elseif ( !$info->getUserInfo()->isVerified() ) {
 892                                 $this->logger->warning(
 893                                         'Session "{session}": Unverified user provided and no metadata to auth it',
 894                                         [
 895                                                 'session' => $info,
 896                                 ] );
 897                                 return false;
 898                         }
 899
 900                         $data = false;
 901                         $metadata = false;
 902
 903                         if ( !$info->getProvider()->persistsSessionId() && !$info->isIdSafe() ) {
 904                                 // The ID doesn't come from the user, so it should be safe
 905                                 // (and if not, nothing we can do about it anyway)
 906                                 $newParams['idIsSafe'] = true;
 907                         }
 908                 }
 909
 910                 // Construct the replacement SessionInfo, if necessary
 911                 if ( $newParams ) {
 912                         $newParams['copyFrom'] = $info;
 913                         $info = new SessionInfo( $info->getPriority(), $newParams );
 914                 }
 915
 916                 // Allow the provider to check the loaded SessionInfo
 917                 $providerMetadata = $info->getProviderMetadata();
 918                 if ( !$info->getProvider()->refreshSessionInfo( $info, $request, $providerMetadata ) ) {
 919                         return false;
 920                 }
 921                 if ( $providerMetadata !== $info->getProviderMetadata() ) {
 922                         $info = new SessionInfo( $info->getPriority(), [
 923                                 'metadata' => $providerMetadata,
 924                                 'copyFrom' => $info,
 925                         ] );
 926                 }
 927
 928                 // Give hooks a chance to abort. Combined with the SessionMetadata
 929                 // hook, this can allow for tying a session to an IP address or the
 930                 // like.
 931                 $reason = 'Hook aborted';
 932                 if ( !\Hooks::run(
 933                         'SessionCheckInfo',
 934                         [ &$reason, $info, $request, $metadata, $data ]
 935                 ) ) {
 936                         $this->logger->warning( 'Session "{session}": ' . $reason, [
 937                                 'session' => $info,
 938                         ] );
 939                         return false;
 940                 }
 941
 942                 return true;
 943         }
 944
 945         /**
 946          * Create a session corresponding to the passed SessionInfo
 947          * @private For use by a SessionProvider that needs to specially create its
 948          *  own session.
 949          * @param SessionInfo $info
 950          * @param WebRequest $request
 951          * @return Session
 952          */
 953         public function getSessionFromInfo( SessionInfo $info, WebRequest $request ) {
 954                 $id = $info->getId();
 955
 956                 if ( !isset( $this->allSessionBackends[$id] ) ) {
 957                         if ( !isset( $this->allSessionIds[$id] ) ) {
 958                                 $this->allSessionIds[$id] = new SessionId( $id );
 959                         }
 960                         $backend = new SessionBackend(
 961                                 $this->allSessionIds[$id],
 962                                 $info,
 963                                 $this->store,
 964                                 $this->logger,
 965                                 $this->config->get( 'ObjectCacheSessionExpiry' )
 966                         );
 967                         $this->allSessionBackends[$id] = $backend;
 968                         $delay = $backend->delaySave();
 969                 } else {
 970                         $backend = $this->allSessionBackends[$id];
 971                         $delay = $backend->delaySave();
 972                         if ( $info->wasPersisted() ) {
 973                                 $backend->persist();
 974                         }
 975                         if ( $info->wasRemembered() ) {
 976                                 $backend->setRememberUser( true );
 977                         }
 978                 }
 979
 980                 $request->setSessionId( $backend->getSessionId() );
 981                 $session = $backend->getSession( $request );
 982
 983                 if ( !$info->isIdSafe() ) {
 984                         $session->resetId();
 985                 }
 986
 987                 \ScopedCallback::consume( $delay );
 988                 return $session;
 989         }
 990
 991         /**
 992          * Deregister a SessionBackend
 993          * @private For use from \\MediaWiki\\Session\\SessionBackend only
 994          * @param SessionBackend $backend
 995          */
 996         public function deregisterSessionBackend( SessionBackend $backend ) {
 997                 $id = $backend->getId();
 998                 if ( !isset( $this->allSessionBackends[$id] ) || !isset( $this->allSessionIds[$id] ) ||
 999                         $this->allSessionBackends[$id] !== $backend ||
1000                         $this->allSessionIds[$id] !== $backend->getSessionId()
1001                 ) {
1002                         throw new \InvalidArgumentException( 'Backend was not registered with this SessionManager' );
1003                 }
1004
1005                 unset( $this->allSessionBackends[$id] );
1006                 // Explicitly do not unset $this->allSessionIds[$id]
1007         }
1008
1009         /**
1010          * Change a SessionBackend's ID
1011          * @private For use from \\MediaWiki\\Session\\SessionBackend only
1012          * @param SessionBackend $backend
1013          */
1014         public function changeBackendId( SessionBackend $backend ) {
1015                 $sessionId = $backend->getSessionId();
1016                 $oldId = (string)$sessionId;
1017                 if ( !isset( $this->allSessionBackends[$oldId] ) || !isset( $this->allSessionIds[$oldId] ) ||
1018                         $this->allSessionBackends[$oldId] !== $backend ||
1019                         $this->allSessionIds[$oldId] !== $sessionId
1020                 ) {
1021                         throw new \InvalidArgumentException( 'Backend was not registered with this SessionManager' );
1022                 }
1023
1024                 $newId = $this->generateSessionId();
1025
1026                 unset( $this->allSessionBackends[$oldId], $this->allSessionIds[$oldId] );
1027                 $sessionId->setId( $newId );
1028                 $this->allSessionBackends[$newId] = $backend;
1029                 $this->allSessionIds[$newId] = $sessionId;
1030         }
1031
1032         /**
1033          * Generate a new random session ID
1034          * @return string
1035          */
1036         public function generateSessionId() {
1037                 do {
1038                         $id = wfBaseConvert( \MWCryptRand::generateHex( 40 ), 16, 32, 32 );
1039                         $key = wfMemcKey( 'MWSession', $id );
1040                 } while ( isset( $this->allSessionIds[$id] ) || is_array( $this->store->get( $key ) ) );
1041                 return $id;
1042         }
1043
1044         /**
1045          * Call setters on a PHPSessionHandler
1046          * @private Use PhpSessionHandler::install()
1047          * @param PHPSessionHandler $handler
1048          */
1049         public function setupPHPSessionHandler( PHPSessionHandler $handler ) {
1050                 $handler->setManager( $this, $this->store, $this->logger );
1051         }
1052
1053         /**
1054          * Reset the internal caching for unit testing
1055          */
1056         public static function resetCache() {
1057                 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
1058                         // @codeCoverageIgnoreStart
1059                         throw new MWException( __METHOD__ . ' may only be called from unit tests!' );
1060                         // @codeCoverageIgnoreEnd
1061                 }
1062
1063                 self::$globalSession = null;
1064                 self::$globalSessionRequest = null;
1065         }
1066
1067         /**
1068          * Do a sanity check to make sure the session is not used from many different IP addresses
1069          * and store some data for later sanity checks.
1070          * FIXME remove this once SessionManager is considered stable
1071          * @private For use in Setup.php only
1072          * @param Session $session Defaults to the global session.
1073          */
1074         public function checkIpLimits( Session $session = null ) {
1075                 $session = $session ?: self::getGlobalSession();
1076
1077                 try {
1078                         $ip = $session->getRequest()->getIP();
1079                 } catch ( \MWException $e ) {
1080                         return;
1081                 }
1082                 if ( $ip === '127.0.0.1' || \IP::isConfiguredProxy( $ip ) ) {
1083                         return;
1084                 }
1085                 $now = time();
1086
1087                 // Record (and possibly log) that the IP is using the current session.
1088                 // Don't touch the stored data unless we are adding a new IP or re-adding an expired one.
1089                 // This is slightly inaccurate (when an existing IP is seen again, the expiry is not
1090                 // extended) but that shouldn't make much difference and limits the session write frequency
1091                 // to # of IPs / $wgSuspiciousIpExpiry.
1092                 $data = $session->get( 'SessionManager-ip', [] );
1093                 if (
1094                         !isset( $data[$ip] )
1095                         || $data[$ip] < $now
1096                 ) {
1097                         $data[$ip] = time() + $this->config->get( 'SuspiciousIpExpiry' );
1098                         foreach ( $data as $key => $expires ) {
1099                                 if ( $expires < $now ) {
1100                                         unset( $data[$key] );
1101                                 }
1102                         }
1103                         $session->set( 'SessionManager-ip', $data );
1104
1105                         $logger = \MediaWiki\Logger\LoggerFactory::getInstance( 'session-ip' );
1106                         $logLevel = count( $data ) >= $this->config->get( 'SuspiciousIpPerSessionLimit' )
1107                                 ? LogLevel::WARNING : ( count( $data ) === 1 ? LogLevel::DEBUG : LogLevel::INFO );
1108                         $logger->log(
1109                                 $logLevel,
1110                                 'Same session used from {count} IPs',
1111                                 [
1112                                         'count' => count( $data ),
1113                                         'ips' => $data,
1114                                         'session' => $session->getId(),
1115                                         'user' => $session->getUser()->getName(),
1116                                         'persistent' => $session->isPersistent(),
1117                                 ]
1118                         );
1119                 }
1120
1121                 // Now do the same thing globally for the current user.
1122                 // We are using the object cache and assume it is shared between all wikis of a farm,
1123                 // and further assume that the same name belongs to the same user on all wikis. (It's either
1124                 // that or a central ID lookup which would mean an extra SQL query on every request.)
1125                 if ( $session->getUser()->isLoggedIn() ) {
1126                         $userKey = 'SessionManager-ip:' . md5( $session->getUser()->getName() );
1127                         $data = $this->store->get( $userKey ) ?: [];
1128                         if (
1129                                 !isset( $data[$ip] )
1130                                 || $data[$ip] < $now
1131                         ) {
1132                                 $data[$ip] = time() + $this->config->get( 'SuspiciousIpExpiry' );
1133                                 foreach ( $data as $key => $expires ) {
1134                                         if ( $expires < $now ) {
1135                                                 unset( $data[$key] );
1136                                         }
1137                                 }
1138                                 $this->store->set( $userKey, $data, $this->config->get( 'SuspiciousIpExpiry' ) );
1139                                 $logger = \MediaWiki\Logger\LoggerFactory::getInstance( 'session-ip' );
1140                                 $logLevel = count( $data ) >= $this->config->get( 'SuspiciousIpPerUserLimit' )
1141                                         ? LogLevel::WARNING : ( count( $data ) === 1 ? LogLevel::DEBUG : LogLevel::INFO );
1142                                 $logger->log(
1143                                         $logLevel,
1144                                         'Same user had sessions from {count} IPs',
1145                                         [
1146                                                 'count' => count( $data ),
1147                                                 'ips' => $data,
1148                                                 'session' => $session->getId(),
1149                                                 'user' => $session->getUser()->getName(),
1150                                                 'persistent' => $session->isPersistent(),
1151                                         ]
1152                                 );
1153                         }
1154                 }
1155         }
1156
1157         /**@}*/
1158
1159 }