138 lines
4.5 KiB
PHP
138 lines
4.5 KiB
PHP
<?php
|
|
/**
|
|
* Copyright © 2016 Wikimedia Foundation and contributors
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
use MediaWiki\Auth\AuthenticationResponse;
|
|
use MediaWiki\Auth\AuthManager;
|
|
use MediaWiki\Auth\CreateFromLoginAuthenticationRequest;
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
/**
|
|
* Log in to the wiki with AuthManager
|
|
*
|
|
* @ingroup API
|
|
*/
|
|
class ApiClientLogin extends ApiBase {
|
|
|
|
public function __construct( ApiMain $main, $action ) {
|
|
parent::__construct( $main, $action, 'login' );
|
|
}
|
|
|
|
public function getFinalDescription() {
|
|
// A bit of a hack to append 'api-help-authmanager-general-usage'
|
|
$msgs = parent::getFinalDescription();
|
|
$msgs[] = ApiBase::makeMessage( 'api-help-authmanager-general-usage', $this->getContext(), [
|
|
$this->getModulePrefix(),
|
|
$this->getModuleName(),
|
|
$this->getModulePath(),
|
|
AuthManager::ACTION_LOGIN,
|
|
$this->needsToken(),
|
|
] );
|
|
return $msgs;
|
|
}
|
|
|
|
public function execute() {
|
|
$params = $this->extractRequestParams();
|
|
|
|
$this->requireAtLeastOneParameter( $params, 'continue', 'returnurl' );
|
|
|
|
if ( $params['returnurl'] !== null ) {
|
|
$bits = wfParseUrl( $params['returnurl'] );
|
|
if ( !$bits || $bits['scheme'] === '' ) {
|
|
$encParamName = $this->encodeParamName( 'returnurl' );
|
|
$this->dieWithError(
|
|
[ 'apierror-badurl', $encParamName, wfEscapeWikiText( $params['returnurl'] ) ],
|
|
"badurl_{$encParamName}"
|
|
);
|
|
}
|
|
}
|
|
|
|
$manager = MediaWikiServices::getInstance()->getAuthManager();
|
|
$helper = new ApiAuthManagerHelper( $this, $manager );
|
|
|
|
// Make sure it's possible to log in
|
|
if ( !$manager->canAuthenticateNow() ) {
|
|
$this->getResult()->addValue( null, 'clientlogin', $helper->formatAuthenticationResponse(
|
|
AuthenticationResponse::newFail( $this->msg( 'userlogin-cannot-' . AuthManager::ACTION_LOGIN ) )
|
|
) );
|
|
$helper->logAuthenticationResult( 'login', 'userlogin-cannot-' . AuthManager::ACTION_LOGIN );
|
|
return;
|
|
}
|
|
|
|
// Perform the login step
|
|
if ( $params['continue'] ) {
|
|
$reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_LOGIN_CONTINUE );
|
|
$res = $manager->continueAuthentication( $reqs );
|
|
} else {
|
|
$reqs = $helper->loadAuthenticationRequests( AuthManager::ACTION_LOGIN );
|
|
if ( $params['preservestate'] ) {
|
|
$req = $helper->getPreservedRequest();
|
|
if ( $req ) {
|
|
$reqs[] = $req;
|
|
}
|
|
}
|
|
$res = $manager->beginAuthentication( $reqs, $params['returnurl'] );
|
|
}
|
|
|
|
// Remove CreateFromLoginAuthenticationRequest from $res->neededRequests.
|
|
// It's there so a RESTART treated as UI will work right, but showing
|
|
// it to the API client is just confusing.
|
|
$res->neededRequests = ApiAuthManagerHelper::blacklistAuthenticationRequests(
|
|
$res->neededRequests, [ CreateFromLoginAuthenticationRequest::class ]
|
|
);
|
|
|
|
$this->getResult()->addValue( null, 'clientlogin',
|
|
$helper->formatAuthenticationResponse( $res ) );
|
|
$helper->logAuthenticationResult( 'login', $res );
|
|
}
|
|
|
|
public function isReadMode() {
|
|
return false;
|
|
}
|
|
|
|
public function needsToken() {
|
|
return 'login';
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
return ApiAuthManagerHelper::getStandardParams( AuthManager::ACTION_LOGIN,
|
|
'requests', 'messageformat', 'mergerequestfields', 'preservestate', 'returnurl', 'continue'
|
|
);
|
|
}
|
|
|
|
public function dynamicParameterDocumentation() {
|
|
return [ 'api-help-authmanagerhelper-additional-params', AuthManager::ACTION_LOGIN ];
|
|
}
|
|
|
|
protected function getExamplesMessages() {
|
|
return [
|
|
'action=clientlogin&username=Example&password=ExamplePassword&'
|
|
. 'loginreturnurl=http://example.org/&logintoken=123ABC'
|
|
=> 'apihelp-clientlogin-example-login',
|
|
'action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC'
|
|
=> 'apihelp-clientlogin-example-login2',
|
|
];
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Login';
|
|
}
|
|
}
|