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 if ( !defined( 'MEDIAWIKI' ) ) {
  29         // Eclipse helper - will be ignored in production
  30         require_once( 'ApiBase.php' );
  31 }
  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( $main, $action ) {
  41                 parent::__construct( $main, $action, 'lg' );
  42         }
  43
  44         /**
  45          * Executes the log-in attempt using the parameters passed. If
  46          * the log-in succeeeds, it attaches a cookie to the session
  47          * and outputs the user id, username, and session token. If a
  48          * log-in fails, as the result of a bad password, a nonexistent
  49          * user, or any other reason, the host is cached with an expiry
  50          * and no log-in attempts will be accepted until that expiry
  51          * is reached. The expiry is $this->mLoginThrottle.
  52          */
  53         public function execute() {
  54                 $params = $this->extractRequestParams();
  55
  56                 $result = array();
  57
  58                 $req = new FauxRequest( array(
  59                         'wpName' => $params['name'],
  60                         'wpPassword' => $params['password'],
  61                         'wpDomain' => $params['domain'],
  62                         'wpLoginToken' => $params['token'],
  63                 ) );
  64
  65                 if ( $params['rememberme'] ) {
  66                         $req['wpRemember'] = '';
  67                 }
  68
  69                 // Init session if necessary
  70                 if ( session_id() == '' ) {
  71                         wfSetupSession();
  72                 }
  73
  74                 $loginForm = new LoginForm( $req );
  75
  76                 global $wgCookiePrefix, $wgUser, $wgPasswordAttemptThrottle;
  77
  78                 $authRes = $loginForm->authenticateUserData();
  79                 switch ( $authRes ) {
  80                         case LoginForm::SUCCESS:
  81                                 $wgUser->setOption( 'rememberpassword', 1 );
  82                                 $wgUser->setCookies( $this->getMain()->getRequest() );
  83
  84                                 // Run hooks.
  85                                 // @todo FIXME: Split back and frontend from this hook.
  86                                 // @todo FIXME: This hook should be placed in the backend
  87                                 $injected_html = '';
  88                                 wfRunHooks( 'UserLoginComplete', array( &$wgUser, &$injected_html ) );
  89
  90                                 $result['result'] = 'Success';
  91                                 $result['lguserid'] = intval( $wgUser->getId() );
  92                                 $result['lgusername'] = $wgUser->getName();
  93                                 $result['lgtoken'] = $wgUser->getToken();
  94                                 $result['cookieprefix'] = $wgCookiePrefix;
  95                                 $result['sessionid'] = session_id();
  96                                 break;
  97
  98                         case LoginForm::NEED_TOKEN:
  99                                 $result['result'] = 'NeedToken';
 100                                 $result['token'] = $loginForm->getLoginToken();
 101                                 $result['cookieprefix'] = $wgCookiePrefix;
 102                                 $result['sessionid'] = session_id();
 103                                 break;
 104
 105                         case LoginForm::WRONG_TOKEN:
 106                                 $result['result'] = 'WrongToken';
 107                                 break;
 108
 109                         case LoginForm::NO_NAME:
 110                                 $result['result'] = 'NoName';
 111                                 break;
 112
 113                         case LoginForm::ILLEGAL:
 114                                 $result['result'] = 'Illegal';
 115                                 break;
 116
 117                         case LoginForm::WRONG_PLUGIN_PASS:
 118                                 $result['result'] = 'WrongPluginPass';
 119                                 break;
 120
 121                         case LoginForm::NOT_EXISTS:
 122                                 $result['result'] = 'NotExists';
 123                                 break;
 124
 125                         case LoginForm::RESET_PASS: // bug 20223 - Treat a temporary password as wrong. Per SpecialUserLogin - "The e-mailed temporary password should not be used for actual logins;"
 126                         case LoginForm::WRONG_PASS:
 127                                 $result['result'] = 'WrongPass';
 128                                 break;
 129
 130                         case LoginForm::EMPTY_PASS:
 131                                 $result['result'] = 'EmptyPass';
 132                                 break;
 133
 134                         case LoginForm::CREATE_BLOCKED:
 135                                 $result['result'] = 'CreateBlocked';
 136                                 $result['details'] = 'Your IP address is blocked from account creation';
 137                                 break;
 138
 139                         case LoginForm::THROTTLED:
 140                                 $result['result'] = 'Throttled';
 141                                 $result['wait'] = intval( $wgPasswordAttemptThrottle['seconds'] );
 142                                 break;
 143
 144                         case LoginForm::USER_BLOCKED:
 145                                 $result['result'] = 'Blocked';
 146                                 break;
 147
 148                         case LoginForm::ABORTED:
 149                                 $result['result'] = 'Aborted';
 150                                 $result['reason'] =  $loginForm->mAbortLoginErrorMsg;
 151                                 break;
 152
 153                         default:
 154                                 ApiBase::dieDebug( __METHOD__, "Unhandled case value: {$authRes}" );
 155                 }
 156
 157                 $this->getResult()->addValue( null, 'login', $result );
 158         }
 159
 160         public function mustBePosted() {
 161                 return true;
 162         }
 163
 164         public function isReadMode() {
 165                 return false;
 166         }
 167
 168         public function getAllowedParams() {
 169                 return array(
 170                         'name' => null,
 171                         'password' => null,
 172                         'domain' => null,
 173                         'token' => null,
 174                         'rememberme'  => array(
 175                                 ApiBase::PARAM_TYPE => 'boolean',
 176                                 ApiBase::PARAM_DFLT => true,
 177                         ),
 178                 );
 179         }
 180
 181         public function getParamDescription() {
 182                 return array(
 183                         'name' => 'User Name',
 184                         'password' => 'Password',
 185                         'domain' => 'Domain (optional)',
 186                         'token' => 'Login token obtained in first request',
 187                         'rememberme' => 'Make the cookies persistant'
 188                 );
 189         }
 190
 191         public function getDescription() {
 192                 return array(
 193                         'Log in and get the authentication tokens. ',
 194                         'In the event of a successful log-in, a cookie will be attached',
 195                         'to your session. In the event of a failed log-in, you will not ',
 196                         'be able to attempt another log-in through this method for 5 seconds.',
 197                         'This is to prevent password guessing by automated password crackers'
 198                 );
 199         }
 200
 201         public function getPossibleErrors() {
 202                 return array_merge( parent::getPossibleErrors(), array(
 203                         array( 'code' => 'NeedToken', 'info' => 'You need to resubmit your login with the specified token. See https://bugzilla.wikimedia.org/show_bug.cgi?id=23076' ),
 204                         array( 'code' => 'WrongToken', 'info' => 'You specified an invalid token' ),
 205                         array( 'code' => 'NoName', 'info' => 'You didn\'t set the lgname parameter' ),
 206                         array( 'code' => 'Illegal', 'info' => ' You provided an illegal username' ),
 207                         array( 'code' => 'NotExists', 'info' => ' The username you provided doesn\'t exist' ),
 208                         array( 'code' => 'EmptyPass', 'info' => ' You didn\'t set the lgpassword parameter or you left it empty' ),
 209                         array( 'code' => 'WrongPass', 'info' => ' The password you provided is incorrect' ),
 210                         array( 'code' => 'WrongPluginPass', 'info' => 'Same as `WrongPass", returned when an authentication plugin rather than MediaWiki itself rejected the password' ),
 211                         array( 'code' => 'CreateBlocked', 'info' => 'The wiki tried to automatically create a new account for you, but your IP address has been blocked from account creation' ),
 212                         array( 'code' => 'Throttled', 'info' => 'You\'ve logged in too many times in a short time' ),
 213                         array( 'code' => 'Blocked', 'info' => 'User is blocked' ),
 214                 ) );
 215         }
 216
 217         protected function getExamples() {
 218                 return array(
 219                         'api.php?action=login&lgname=user&lgpassword=password'
 220                 );
 221         }
 222
 223         public function getVersion() {
 224                 return __CLASS__ . ': $Id$';
 225         }
 226 }