Page MenuHomeWickedGov Phorge
Files F4078396

ApiRemoveAuthenticationData.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ApiRemoveAuthenticationData.php
View Options

<?php
/**
* Copyright © 2016 Wikimedia Foundation and contributors
*
* @license GPL-2.0-or-later
* @file
*/
namespace MediaWiki\Api;
use MediaWiki\Auth\AuthenticationRequest;
use MediaWiki\Auth\AuthManager;
use MediaWiki\MainConfigNames;
/**
* Remove authentication data from AuthManager
*
* @ingroup API
*/
class ApiRemoveAuthenticationData extends ApiBase {
/** @var string */
private $authAction;
/** @var string */
private $operation;
private AuthManager $authManager;
public function __construct(
ApiMain $main,
string $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()->isNamed() ) {
$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' ] );
}
/** @inheritDoc */
public function isWriteMode() {
return true;
}
/** @inheritDoc */
public function needsToken() {
return 'csrf';
}
/** @inheritDoc */
public function getAllowedParams() {
return ApiAuthManagerHelper::getStandardParams( $this->authAction,
'request'
);
}
/** @inheritDoc */
protected function getExamplesMessages() {
$path = $this->getModulePath();
$action = $this->getModuleName();
return [
"action={$action}&request=FooAuthenticationRequest&token=123ABC"
=> "apihelp-{$path}-example-simple",
];
}
/** @inheritDoc */
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Manage_authentication_data';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiRemoveAuthenticationData::class, 'ApiRemoveAuthenticationData' );

File Metadata

Mime Type
text/x-php
Expires
Aug 18 2026, 04:06 (8 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
29/fd/b7c07de60d6c561e7c28887f561f
Default Alt Text
ApiRemoveAuthenticationData.php (3 KB)

Event Timeline