includes/api/ApiLogin.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 19, 2006
   6  *
   7  * Copyright © 2006-2007 Yuri Astrakhan "<Firstname><Lastname>@gmail.com",
   8  * Daniel Cannon (cannon dot danielc at gmail dot com)
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  *
  25  * @file
  26  */
  27
  28 use MediaWiki\Auth\AuthManager;
  29 use MediaWiki\Auth\AuthenticationRequest;
  30 use MediaWiki\Auth\AuthenticationResponse;
  31 use MediaWiki\Logger\LoggerFactory;
  32
  33 /**
  34  * Unit to authenticate log-in attempts to the current wiki.
  35  *
  36  * @ingroup API
  37  */
  38 class ApiLogin extends ApiBase {
  39
  40         public function __construct( ApiMain $main, $action ) {
  41                 parent::__construct( $main, $action, 'lg' );
  42         }
  43
  44         protected function getExtendedDescription() {
  45                 if ( $this->getConfig()->get( 'EnableBotPasswords' ) ) {
  46                         return 'apihelp-login-extended-description';
  47                 } else {
  48                         return 'apihelp-login-extended-description-nobotpasswords';
  49                 }
  50         }
  51
  52         /**
  53          * Format a message for the response
  54          * @param Message|string|array $message
  55          * @return string|array
  56          */
  57         private function formatMessage( $message ) {
  58                 $message = Message::newFromSpecifier( $message );
  59                 $errorFormatter = $this->getErrorFormatter();
  60                 if ( $errorFormatter instanceof ApiErrorFormatter_BackCompat ) {
  61                         return ApiErrorFormatter::stripMarkup(
  62                                 $message->useDatabase( false )->inLanguage( 'en' )->text()
  63                         );
  64                 } else {
  65                         return $errorFormatter->formatMessage( $message );
  66                 }
  67         }
  68
  69         /**
  70          * Executes the log-in attempt using the parameters passed. If
  71          * the log-in succeeds, it attaches a cookie to the session
  72          * and outputs the user id, username, and session token. If a
  73          * log-in fails, as the result of a bad password, a nonexistent
  74          * user, or any other reason, the host is cached with an expiry
  75          * and no log-in attempts will be accepted until that expiry
  76          * is reached. The expiry is $this->mLoginThrottle.
  77          */
  78         public function execute() {
  79                 // If we're in a mode that breaks the same-origin policy, no tokens can
  80                 // be obtained
  81                 if ( $this->lacksSameOriginSecurity() ) {
  82                         $this->getResult()->addValue( null, 'login', [
  83                                 'result' => 'Aborted',
  84                                 'reason' => $this->formatMessage( 'api-login-fail-sameorigin' ),
  85                         ] );
  86
  87                         return;
  88                 }
  89
  90                 $this->requirePostedParameters( [ 'password', 'token' ] );
  91
  92                 $params = $this->extractRequestParams();
  93
  94                 $result = [];
  95
  96                 // Make sure session is persisted
  97                 $session = MediaWiki\Session\SessionManager::getGlobalSession();
  98                 $session->persist();
  99
 100                 // Make sure it's possible to log in
 101                 if ( !$session->canSetUser() ) {
 102                         $this->getResult()->addValue( null, 'login', [
 103                                 'result' => 'Aborted',
 104                                 'reason' => $this->formatMessage( [
 105                                         'api-login-fail-badsessionprovider',
 106                                         $session->getProvider()->describe( $this->getErrorFormatter()->getLanguage() ),
 107                                 ] )
 108                         ] );
 109
 110                         return;
 111                 }
 112
 113                 $authRes = false;
 114                 $context = new DerivativeContext( $this->getContext() );
 115                 $loginType = 'N/A';
 116
 117                 // Check login token
 118                 $token = $session->getToken( '', 'login' );
 119                 if ( $token->wasNew() || !$params['token'] ) {
 120                         $authRes = 'NeedToken';
 121                 } elseif ( !$token->match( $params['token'] ) ) {
 122                         $authRes = 'WrongToken';
 123                 }
 124
 125                 // Try bot passwords
 126                 if (
 127                         $authRes === false && $this->getConfig()->get( 'EnableBotPasswords' ) &&
 128                         ( $botLoginData = BotPassword::canonicalizeLoginData( $params['name'], $params['password'] ) )
 129                 ) {
 130                         $status = BotPassword::login(
 131                                 $botLoginData[0], $botLoginData[1], $this->getRequest()
 132                         );
 133                         if ( $status->isOK() ) {
 134                                 $session = $status->getValue();
 135                                 $authRes = 'Success';
 136                                 $loginType = 'BotPassword';
 137                         } elseif ( !$botLoginData[2] ) {
 138                                 $authRes = 'Failed';
 139                                 $message = $status->getMessage();
 140                                 LoggerFactory::getInstance( 'authentication' )->info(
 141                                         'BotPassword login failed: ' . $status->getWikiText( false, false, 'en' )
 142                                 );
 143                         }
 144                 }
 145
 146                 if ( $authRes === false ) {
 147                         // Simplified AuthManager login, for backwards compatibility
 148                         $manager = AuthManager::singleton();
 149                         $reqs = AuthenticationRequest::loadRequestsFromSubmission(
 150                                 $manager->getAuthenticationRequests( AuthManager::ACTION_LOGIN, $this->getUser() ),
 151                                 [
 152                                         'username' => $params['name'],
 153                                         'password' => $params['password'],
 154                                         'domain' => $params['domain'],
 155                                         'rememberMe' => true,
 156                                 ]
 157                         );
 158                         $res = AuthManager::singleton()->beginAuthentication( $reqs, 'null:' );
 159                         switch ( $res->status ) {
 160                                 case AuthenticationResponse::PASS:
 161                                         if ( $this->getConfig()->get( 'EnableBotPasswords' ) ) {
 162                                                 $this->addDeprecation( 'apiwarn-deprecation-login-botpw', 'main-account-login' );
 163                                         } else {
 164                                                 $this->addDeprecation( 'apiwarn-deprecation-login-nobotpw', 'main-account-login' );
 165                                         }
 166                                         $authRes = 'Success';
 167                                         $loginType = 'AuthManager';
 168                                         break;
 169
 170                                 case AuthenticationResponse::FAIL:
 171                                         // Hope it's not a PreAuthenticationProvider that failed...
 172                                         $authRes = 'Failed';
 173                                         $message = $res->message;
 174                                         \MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )
 175                                                 ->info( __METHOD__ . ': Authentication failed: '
 176                                                 . $message->inLanguage( 'en' )->plain() );
 177                                         break;
 178
 179                                 default:
 180                                         \MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )
 181                                                 ->info( __METHOD__ . ': Authentication failed due to unsupported response type: '
 182                                                 . $res->status, $this->getAuthenticationResponseLogData( $res ) );
 183                                         $authRes = 'Aborted';
 184                                         break;
 185                         }
 186                 }
 187
 188                 $result['result'] = $authRes;
 189                 switch ( $authRes ) {
 190                         case 'Success':
 191                                 $user = $session->getUser();
 192
 193                                 ApiQueryInfo::resetTokenCache();
 194
 195                                 // Deprecated hook
 196                                 $injected_html = '';
 197                                 Hooks::run( 'UserLoginComplete', [ &$user, &$injected_html, true ] );
 198
 199                                 $result['lguserid'] = intval( $user->getId() );
 200                                 $result['lgusername'] = $user->getName();
 201                                 break;
 202
 203                         case 'NeedToken':
 204                                 $result['token'] = $token->toString();
 205                                 $this->addDeprecation( 'apiwarn-deprecation-login-token', 'action=login&!lgtoken' );
 206                                 break;
 207
 208                         case 'WrongToken':
 209                                 break;
 210
 211                         case 'Failed':
 212                                 $result['reason'] = $this->formatMessage( $message );
 213                                 break;
 214
 215                         case 'Aborted':
 216                                 $result['reason'] = $this->formatMessage(
 217                                         $this->getConfig()->get( 'EnableBotPasswords' )
 218                                                 ? 'api-login-fail-aborted'
 219                                                 : 'api-login-fail-aborted-nobotpw'
 220                                 );
 221                                 break;
 222
 223                         default:
 224                                 ApiBase::dieDebug( __METHOD__, "Unhandled case value: {$authRes}" );
 225                 }
 226
 227                 $this->getResult()->addValue( null, 'login', $result );
 228
 229                 if ( $loginType === 'LoginForm' && isset( LoginForm::$statusCodes[$authRes] ) ) {
 230                         $authRes = LoginForm::$statusCodes[$authRes];
 231                 }
 232                 LoggerFactory::getInstance( 'authevents' )->info( 'Login attempt', [
 233                         'event' => 'login',
 234                         'successful' => $authRes === 'Success',
 235                         'loginType' => $loginType,
 236                         'status' => $authRes,
 237                 ] );
 238         }
 239
 240         public function isDeprecated() {
 241                 return !$this->getConfig()->get( 'EnableBotPasswords' );
 242         }
 243
 244         public function mustBePosted() {
 245                 return true;
 246         }
 247
 248         public function isReadMode() {
 249                 return false;
 250         }
 251
 252         public function getAllowedParams() {
 253                 return [
 254                         'name' => null,
 255                         'password' => [
 256                                 ApiBase::PARAM_TYPE => 'password',
 257                         ],
 258                         'domain' => null,
 259                         'token' => [
 260                                 ApiBase::PARAM_TYPE => 'string',
 261                                 ApiBase::PARAM_REQUIRED => false, // for BC
 262                                 ApiBase::PARAM_SENSITIVE => true,
 263                                 ApiBase::PARAM_HELP_MSG => [ 'api-help-param-token', 'login' ],
 264                         ],
 265                 ];
 266         }
 267
 268         protected function getExamplesMessages() {
 269                 return [
 270                         'action=login&lgname=user&lgpassword=password'
 271                                 => 'apihelp-login-example-gettoken',
 272                         'action=login&lgname=user&lgpassword=password&lgtoken=123ABC'
 273                                 => 'apihelp-login-example-login',
 274                 ];
 275         }
 276
 277         public function getHelpUrls() {
 278                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Login';
 279         }
 280
 281         /**
 282          * Turns an AuthenticationResponse into a hash suitable for passing to Logger
 283          * @param AuthenticationResponse $response
 284          * @return array
 285          */
 286         protected function getAuthenticationResponseLogData( AuthenticationResponse $response ) {
 287                 $ret = [
 288                         'status' => $response->status,
 289                 ];
 290                 if ( $response->message ) {
 291                         $ret['message'] = $response->message->inLanguage( 'en' )->plain();
 292                 };
 293                 $reqs = [
 294                         'neededRequests' => $response->neededRequests,
 295                         'createRequest' => $response->createRequest,
 296                         'linkRequest' => $response->linkRequest,
 297                 ];
 298                 foreach ( $reqs as $k => $v ) {
 299                         if ( $v ) {
 300                                 $v = is_array( $v ) ? $v : [ $v ];
 301                                 $reqClasses = array_unique( array_map( 'get_class', $v ) );
 302                                 sort( $reqClasses );
 303                                 $ret[$k] = implode( ', ', $reqClasses );
 304                         }
 305                 }
 306                 return $ret;
 307         }
 308 }