wiki.techinc.nl/includes/api/ApiRemoveAuthenticationData.php
Aryeh Gregor 666ca1bdf3 Use MainConfigNames instead of string literals, #2
This covers all occurrences of /onfig->.*get( '/ in includes/.
Undoubtedly there are still plenty more to go.

Change-Id: I33196c4153437778496f40436bcde399638ac361
2022-04-13 18:55:46 +03:00

128 lines
3.7 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\AuthenticationRequest;
use MediaWiki\Auth\AuthManager;
use MediaWiki\MainConfigNames;
/**
* Remove authentication data from AuthManager
*
* @ingroup API
*/
class ApiRemoveAuthenticationData extends ApiBase {
private $authAction;
private $operation;
/** @var AuthManager */
private $authManager;
/**
* @param ApiMain $main
* @param string $action
* @param AuthManager $authManager
*/
public function __construct(
ApiMain $main,
$action,
AuthManager $authManager
) {
parent::__construct( $main, $action );
$this->authAction = $action === 'unlinkaccount'
? AuthManager::ACTION_UNLINK
: AuthManager::ACTION_REMOVE;
$this->operation = $action === 'unlinkaccount'
? 'UnlinkAccount'
: 'RemoveCredentials';
$this->authManager = $authManager;
}
public function execute() {
if ( !$this->getUser()->isRegistered() ) {
$this->dieWithError( 'apierror-mustbeloggedin-removeauth', 'notloggedin' );
}
$params = $this->extractRequestParams();
// Check security-sensitive operation status
ApiAuthManagerHelper::newForModule( $this, $this->authManager )
->securitySensitiveOperation( $this->operation );
// Fetch the request. No need to load from the request, so don't use
// ApiAuthManagerHelper's method.
$remove = $this->authAction === AuthManager::ACTION_REMOVE
? array_fill_keys( $this->getConfig()->get(
MainConfigNames::RemoveCredentialsBlacklist ), true )
: [];
$reqs = array_filter(
$this->authManager->getAuthenticationRequests( $this->authAction, $this->getUser() ),
static function ( AuthenticationRequest $req ) use ( $params, $remove ) {
return $req->getUniqueId() === $params['request'] &&
!isset( $remove[get_class( $req )] );
}
);
if ( count( $reqs ) !== 1 ) {
$this->dieWithError( 'apierror-changeauth-norequest', 'badrequest' );
}
$req = reset( $reqs );
// Perform the removal
$status = $this->authManager->allowsAuthenticationDataChange( $req, true );
$this->getHookRunner()->onChangeAuthenticationDataAudit( $req, $status );
if ( !$status->isGood() ) {
$this->dieStatus( $status );
}
$this->authManager->changeAuthenticationData( $req );
$this->getResult()->addValue( null, $this->getModuleName(), [ 'status' => 'success' ] );
}
public function isWriteMode() {
return true;
}
public function needsToken() {
return 'csrf';
}
public function getAllowedParams() {
return ApiAuthManagerHelper::getStandardParams( $this->authAction,
'request'
);
}
protected function getExamplesMessages() {
$path = $this->getModulePath();
$action = $this->getModuleName();
return [
"action={$action}&request=FooAuthenticationRequest&token=123ABC"
=> "apihelp-{$path}-example-simple",
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Manage_authentication_data';
}
}