5 * Created on Sep 19, 2006
7 * Copyright © 2006-2007 Yuri Astrakhan "<Firstname><Lastname>@gmail.com",
8 * Daniel Cannon (cannon dot danielc at gmail dot com)
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.
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.
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
29 * Unit to authenticate log-in attempts to the current wiki.
33 class ApiLogin
extends ApiBase
{
35 public function __construct( $main, $action ) {
36 parent
::__construct( $main, $action, 'lg' );
40 * Executes the log-in attempt using the parameters passed. If
41 * the log-in succeeds, it attaches a cookie to the session
42 * and outputs the user id, username, and session token. If a
43 * log-in fails, as the result of a bad password, a nonexistent
44 * user, or any other reason, the host is cached with an expiry
45 * and no log-in attempts will be accepted until that expiry
46 * is reached. The expiry is $this->mLoginThrottle.
48 public function execute() {
49 // If we're in JSON callback mode, no tokens can be obtained
50 if ( !is_null( $this->getMain()->getRequest()->getVal( 'callback' ) ) ) {
51 $this->getResult()->addValue( null, 'login', array(
52 'result' => 'Aborted',
53 'reason' => 'Cannot log in when using a callback',
59 $params = $this->extractRequestParams();
63 // Init session if necessary
64 if ( session_id() == '' ) {
68 $context = new DerivativeContext( $this->getContext() );
69 $context->setRequest( new DerivativeRequest(
70 $this->getContext()->getRequest(),
72 'wpName' => $params['name'],
73 'wpPassword' => $params['password'],
74 'wpDomain' => $params['domain'],
75 'wpLoginToken' => $params['token'],
79 $loginForm = new LoginForm();
80 $loginForm->setContext( $context );
82 global $wgCookiePrefix, $wgPasswordAttemptThrottle;
84 $authRes = $loginForm->authenticateUserData();
86 case LoginForm
::SUCCESS
:
87 $user = $context->getUser();
88 $this->getContext()->setUser( $user );
89 $user->setOption( 'rememberpassword', 1 );
90 $user->setCookies( $this->getRequest() );
92 ApiQueryInfo
::resetTokenCache();
95 // @todo FIXME: Split back and frontend from this hook.
96 // @todo FIXME: This hook should be placed in the backend
98 wfRunHooks( 'UserLoginComplete', array( &$user, &$injected_html ) );
100 $result['result'] = 'Success';
101 $result['lguserid'] = intval( $user->getId() );
102 $result['lgusername'] = $user->getName();
103 $result['lgtoken'] = $user->getToken();
104 $result['cookieprefix'] = $wgCookiePrefix;
105 $result['sessionid'] = session_id();
108 case LoginForm
::NEED_TOKEN
:
109 $result['result'] = 'NeedToken';
110 $result['token'] = $loginForm->getLoginToken();
111 $result['cookieprefix'] = $wgCookiePrefix;
112 $result['sessionid'] = session_id();
115 case LoginForm
::WRONG_TOKEN
:
116 $result['result'] = 'WrongToken';
119 case LoginForm
::NO_NAME
:
120 $result['result'] = 'NoName';
123 case LoginForm
::ILLEGAL
:
124 $result['result'] = 'Illegal';
127 case LoginForm
::WRONG_PLUGIN_PASS
:
128 $result['result'] = 'WrongPluginPass';
131 case LoginForm
::NOT_EXISTS
:
132 $result['result'] = 'NotExists';
135 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;"
136 case LoginForm
::WRONG_PASS
:
137 $result['result'] = 'WrongPass';
140 case LoginForm
::EMPTY_PASS
:
141 $result['result'] = 'EmptyPass';
144 case LoginForm
::CREATE_BLOCKED
:
145 $result['result'] = 'CreateBlocked';
146 $result['details'] = 'Your IP address is blocked from account creation';
149 case LoginForm
::THROTTLED
:
150 $result['result'] = 'Throttled';
151 $result['wait'] = intval( $wgPasswordAttemptThrottle['seconds'] );
154 case LoginForm
::USER_BLOCKED
:
155 $result['result'] = 'Blocked';
158 case LoginForm
::ABORTED
:
159 $result['result'] = 'Aborted';
160 $result['reason'] = $loginForm->mAbortLoginErrorMsg
;
164 ApiBase
::dieDebug( __METHOD__
, "Unhandled case value: {$authRes}" );
167 $this->getResult()->addValue( null, 'login', $result );
170 public function mustBePosted() {
174 public function isReadMode() {
178 public function getAllowedParams() {
187 public function getParamDescription() {
189 'name' => 'User Name',
190 'password' => 'Password',
191 'domain' => 'Domain (optional)',
192 'token' => 'Login token obtained in first request',
196 public function getResultProperties() {
200 ApiBase
::PROP_TYPE
=> array(
217 ApiBase
::PROP_TYPE
=> 'integer',
218 ApiBase
::PROP_NULLABLE
=> true
220 'lgusername' => array(
221 ApiBase
::PROP_TYPE
=> 'string',
222 ApiBase
::PROP_NULLABLE
=> true
225 ApiBase
::PROP_TYPE
=> 'string',
226 ApiBase
::PROP_NULLABLE
=> true
228 'cookieprefix' => array(
229 ApiBase
::PROP_TYPE
=> 'string',
230 ApiBase
::PROP_NULLABLE
=> true
232 'sessionid' => array(
233 ApiBase
::PROP_TYPE
=> 'string',
234 ApiBase
::PROP_NULLABLE
=> true
237 ApiBase
::PROP_TYPE
=> 'string',
238 ApiBase
::PROP_NULLABLE
=> true
241 ApiBase
::PROP_TYPE
=> 'string',
242 ApiBase
::PROP_NULLABLE
=> true
245 ApiBase
::PROP_TYPE
=> 'integer',
246 ApiBase
::PROP_NULLABLE
=> true
249 ApiBase
::PROP_TYPE
=> 'string',
250 ApiBase
::PROP_NULLABLE
=> true
256 public function getDescription() {
258 'Log in and get the authentication tokens.',
259 'In the event of a successful log-in, a cookie will be attached',
260 'to your session. In the event of a failed log-in, you will not',
261 'be able to attempt another log-in through this method for 5 seconds.',
262 'This is to prevent password guessing by automated password crackers'
266 public function getPossibleErrors() {
267 return array_merge( parent
::getPossibleErrors(), array(
268 array( 'code' => 'NeedToken', 'info' => 'You need to resubmit your login with the specified token. See https://bugzilla.wikimedia.org/show_bug.cgi?id=23076' ),
269 array( 'code' => 'WrongToken', 'info' => 'You specified an invalid token' ),
270 array( 'code' => 'NoName', 'info' => 'You didn\'t set the lgname parameter' ),
271 array( 'code' => 'Illegal', 'info' => 'You provided an illegal username' ),
272 array( 'code' => 'NotExists', 'info' => 'The username you provided doesn\'t exist' ),
273 array( 'code' => 'EmptyPass', 'info' => 'You didn\'t set the lgpassword parameter or you left it empty' ),
274 array( 'code' => 'WrongPass', 'info' => 'The password you provided is incorrect' ),
275 array( 'code' => 'WrongPluginPass', 'info' => 'Same as "WrongPass", returned when an authentication plugin rather than MediaWiki itself rejected the password' ),
276 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' ),
277 array( 'code' => 'Throttled', 'info' => 'You\'ve logged in too many times in a short time' ),
278 array( 'code' => 'Blocked', 'info' => 'User is blocked' ),
282 public function getExamples() {
284 'api.php?action=login&lgname=user&lgpassword=password'
288 public function getHelpUrls() {
289 return 'https://www.mediawiki.org/wiki/API:Login';