MediaWiki  master
ApiRemoveAuthenticationData.php
Go to the documentation of this file.
1 <?php
26 
33 
34  private $authAction;
35  private $operation;
36 
37  private AuthManager $authManager;
38 
44  public function __construct(
45  ApiMain $main,
46  $action,
47  AuthManager $authManager
48  ) {
49  parent::__construct( $main, $action );
50 
51  $this->authAction = $action === 'unlinkaccount'
52  ? AuthManager::ACTION_UNLINK
53  : AuthManager::ACTION_REMOVE;
54  $this->operation = $action === 'unlinkaccount'
55  ? 'UnlinkAccount'
56  : 'RemoveCredentials';
57 
58  $this->authManager = $authManager;
59  }
60 
61  public function execute() {
62  if ( !$this->getUser()->isNamed() ) {
63  $this->dieWithError( 'apierror-mustbeloggedin-removeauth', 'notloggedin' );
64  }
65 
66  $params = $this->extractRequestParams();
67 
68  // Check security-sensitive operation status
69  ApiAuthManagerHelper::newForModule( $this, $this->authManager )
70  ->securitySensitiveOperation( $this->operation );
71 
72  // Fetch the request. No need to load from the request, so don't use
73  // ApiAuthManagerHelper's method.
74  $remove = $this->authAction === AuthManager::ACTION_REMOVE
75  ? array_fill_keys( $this->getConfig()->get(
76  MainConfigNames::RemoveCredentialsBlacklist ), true )
77  : [];
78  $reqs = array_filter(
79  $this->authManager->getAuthenticationRequests( $this->authAction, $this->getUser() ),
80  static function ( AuthenticationRequest $req ) use ( $params, $remove ) {
81  return $req->getUniqueId() === $params['request'] &&
82  !isset( $remove[get_class( $req )] );
83  }
84  );
85  if ( count( $reqs ) !== 1 ) {
86  $this->dieWithError( 'apierror-changeauth-norequest', 'badrequest' );
87  }
88  $req = reset( $reqs );
89 
90  // Perform the removal
91  $status = $this->authManager->allowsAuthenticationDataChange( $req, true );
92  $this->getHookRunner()->onChangeAuthenticationDataAudit( $req, $status );
93  if ( !$status->isGood() ) {
94  $this->dieStatus( $status );
95  }
96  $this->authManager->changeAuthenticationData( $req );
97 
98  $this->getResult()->addValue( null, $this->getModuleName(), [ 'status' => 'success' ] );
99  }
100 
101  public function isWriteMode() {
102  return true;
103  }
104 
105  public function needsToken() {
106  return 'csrf';
107  }
108 
109  public function getAllowedParams() {
110  return ApiAuthManagerHelper::getStandardParams( $this->authAction,
111  'request'
112  );
113  }
114 
115  protected function getExamplesMessages() {
116  $path = $this->getModulePath();
117  $action = $this->getModuleName();
118  return [
119  "action={$action}&request=FooAuthenticationRequest&token=123ABC"
120  => "apihelp-{$path}-example-simple",
121  ];
122  }
123 
124  public function getHelpUrls() {
125  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Manage_authentication_data';
126  }
127 }
static newForModule(ApiBase $module, AuthManager $authManager=null)
Static version of the constructor, for chaining.
static getStandardParams( $action,... $wantedParams)
Fetch the standard parameters this helper recognizes.
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:63
dieWithError( $msg, $code=null, $data=null, $httpCode=0)
Abort execution with an error.
Definition: ApiBase.php:1516
getResult()
Get the result object.
Definition: ApiBase.php:668
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:808
getModulePath()
Get the path to this module.
Definition: ApiBase.php:608
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:529
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition: ApiBase.php:1571
getHookRunner()
Get an ApiHookRunner for running core API hooks.
Definition: ApiBase.php:753
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:64
Remove authentication data from AuthManager.
__construct(ApiMain $main, $action, AuthManager $authManager)
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
isWriteMode()
Indicates whether this module requires write mode.
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
getHelpUrls()
Return links to more detailed help pages about the module.
getExamplesMessages()
Returns usage examples for this module.
needsToken()
Returns the token type this module requires in order to execute.
This serves as the entry point to the authentication system.
This is a value object for authentication requests.
getUniqueId()
Supply a unique key for deduplication.
A class containing constants representing the names of configuration variables.