MediaWiki  1.28.0
ApiAuthManagerHelper.php
Go to the documentation of this file.
1 <?php
29 
37 
39  private $module;
40 
42  private $messageFormat;
43 
47  public function __construct( ApiBase $module ) {
48  $this->module = $module;
49 
50  $params = $module->extractRequestParams();
51  $this->messageFormat = isset( $params['messageformat'] ) ? $params['messageformat'] : 'wikitext';
52  }
53 
59  public static function newForModule( ApiBase $module ) {
60  return new self( $module );
61  }
62 
69  private function formatMessage( array &$res, $key, Message $message ) {
70  switch ( $this->messageFormat ) {
71  case 'none':
72  break;
73 
74  case 'wikitext':
75  $res[$key] = $message->setContext( $this->module )->text();
76  break;
77 
78  case 'html':
79  $res[$key] = $message->setContext( $this->module )->parseAsBlock();
80  $res[$key] = Parser::stripOuterParagraph( $res[$key] );
81  break;
82 
83  case 'raw':
84  $res[$key] = [
85  'key' => $message->getKey(),
86  'params' => $message->getParams(),
87  ];
88  ApiResult::setIndexedTagName( $res[$key]['params'], 'param' );
89  break;
90  }
91  }
92 
98  public function securitySensitiveOperation( $operation ) {
99  $status = AuthManager::singleton()->securitySensitiveOperationStatus( $operation );
100  switch ( $status ) {
101  case AuthManager::SEC_OK:
102  return;
103 
104  case AuthManager::SEC_REAUTH:
105  $this->module->dieUsage(
106  'You have not authenticated recently in this session, please reauthenticate.', 'reauthenticate'
107  );
108 
109  case AuthManager::SEC_FAIL:
110  $this->module->dieUsage(
111  'This action is not available as your identify cannot be verified.', 'cannotreauthenticate'
112  );
113 
114  default:
115  throw new UnexpectedValueException( "Unknown status \"$status\"" );
116  }
117  }
118 
125  public static function blacklistAuthenticationRequests( array $reqs, array $blacklist ) {
126  if ( $blacklist ) {
127  $blacklist = array_flip( $blacklist );
128  $reqs = array_filter( $reqs, function ( $req ) use ( $blacklist ) {
129  return !isset( $blacklist[get_class( $req )] );
130  } );
131  }
132  return $reqs;
133  }
134 
140  public function loadAuthenticationRequests( $action ) {
141  $params = $this->module->extractRequestParams();
142 
143  $manager = AuthManager::singleton();
144  $reqs = $manager->getAuthenticationRequests( $action, $this->module->getUser() );
145 
146  // Filter requests, if requested to do so
147  $wantedRequests = null;
148  if ( isset( $params['requests'] ) ) {
149  $wantedRequests = array_flip( $params['requests'] );
150  } elseif ( isset( $params['request'] ) ) {
151  $wantedRequests = [ $params['request'] => true ];
152  }
153  if ( $wantedRequests !== null ) {
154  $reqs = array_filter( $reqs, function ( $req ) use ( $wantedRequests ) {
155  return isset( $wantedRequests[$req->getUniqueId()] );
156  } );
157  }
158 
159  // Collect the fields for all the requests
160  $fields = [];
161  $sensitive = [];
162  foreach ( $reqs as $req ) {
163  $info = (array)$req->getFieldInfo();
164  $fields += $info;
165  $sensitive += array_filter( $info, function ( $opts ) {
166  return !empty( $opts['sensitive'] );
167  } );
168  }
169 
170  // Extract the request data for the fields and mark those request
171  // parameters as used
172  $data = array_intersect_key( $this->module->getRequest()->getValues(), $fields );
173  $this->module->getMain()->markParamsUsed( array_keys( $data ) );
174 
175  if ( $sensitive ) {
176  try {
177  $this->module->requirePostedParameters( array_keys( $sensitive ), 'noprefix' );
178  } catch ( UsageException $ex ) {
179  // Make this a warning for now, upgrade to an error in 1.29.
180  $this->module->setWarning( $ex->getMessage() );
181  $this->module->logFeatureUsage( $this->module->getModuleName() . '-params-in-query-string' );
182  }
183  }
184 
185  return AuthenticationRequest::loadRequestsFromSubmission( $reqs, $data );
186  }
187 
194  $ret = [
195  'status' => $res->status,
196  ];
197 
198  if ( $res->status === AuthenticationResponse::PASS && $res->username !== null ) {
199  $ret['username'] = $res->username;
200  }
201 
202  if ( $res->status === AuthenticationResponse::REDIRECT ) {
203  $ret['redirecttarget'] = $res->redirectTarget;
204  if ( $res->redirectApiData !== null ) {
205  $ret['redirectdata'] = $res->redirectApiData;
206  }
207  }
208 
209  if ( $res->status === AuthenticationResponse::REDIRECT ||
210  $res->status === AuthenticationResponse::UI ||
211  $res->status === AuthenticationResponse::RESTART
212  ) {
213  $ret += $this->formatRequests( $res->neededRequests );
214  }
215 
216  if ( $res->status === AuthenticationResponse::FAIL ||
217  $res->status === AuthenticationResponse::UI ||
218  $res->status === AuthenticationResponse::RESTART
219  ) {
220  $this->formatMessage( $ret, 'message', $res->message );
221  }
222 
223  if ( $res->status === AuthenticationResponse::FAIL ||
224  $res->status === AuthenticationResponse::RESTART
225  ) {
226  $this->module->getRequest()->getSession()->set(
227  'ApiAuthManagerHelper::createRequest',
228  $res->createRequest
229  );
230  $ret['canpreservestate'] = $res->createRequest !== null;
231  } else {
232  $this->module->getRequest()->getSession()->remove( 'ApiAuthManagerHelper::createRequest' );
233  }
234 
235  return $ret;
236  }
237 
243  public function logAuthenticationResult( $event, $result ) {
244  if ( is_string( $result ) ) {
246  } elseif ( $result->status === AuthenticationResponse::PASS ) {
248  } elseif ( $result->status === AuthenticationResponse::FAIL ) {
249  $status = Status::newFatal( $result->message );
250  } else {
251  return;
252  }
253 
254  $module = $this->module->getModuleName();
255  LoggerFactory::getInstance( 'authevents' )->info( "$module API attempt", [
256  'event' => $event,
257  'status' => $status,
258  'module' => $module,
259  ] );
260  }
261 
266  public function getPreservedRequest() {
267  $ret = $this->module->getRequest()->getSession()->get( 'ApiAuthManagerHelper::createRequest' );
268  return $ret instanceof CreateFromLoginAuthenticationRequest ? $ret : null;
269  }
270 
277  public function formatRequests( array $reqs ) {
278  $params = $this->module->extractRequestParams();
279  $mergeFields = !empty( $params['mergerequestfields'] );
280 
281  $ret = [ 'requests' => [] ];
282  foreach ( $reqs as $req ) {
283  $describe = $req->describeCredentials();
284  $reqInfo = [
285  'id' => $req->getUniqueId(),
286  'metadata' => $req->getMetadata() + [ ApiResult::META_TYPE => 'assoc' ],
287  ];
288  switch ( $req->required ) {
289  case AuthenticationRequest::OPTIONAL:
290  $reqInfo['required'] = 'optional';
291  break;
292  case AuthenticationRequest::REQUIRED:
293  $reqInfo['required'] = 'required';
294  break;
295  case AuthenticationRequest::PRIMARY_REQUIRED:
296  $reqInfo['required'] = 'primary-required';
297  break;
298  }
299  $this->formatMessage( $reqInfo, 'provider', $describe['provider'] );
300  $this->formatMessage( $reqInfo, 'account', $describe['account'] );
301  if ( !$mergeFields ) {
302  $reqInfo['fields'] = $this->formatFields( (array)$req->getFieldInfo() );
303  }
304  $ret['requests'][] = $reqInfo;
305  }
306 
307  if ( $mergeFields ) {
308  $fields = AuthenticationRequest::mergeFieldInfo( $reqs );
309  $ret['fields'] = $this->formatFields( $fields );
310  }
311 
312  return $ret;
313  }
314 
322  private function formatFields( array $fields ) {
323  static $copy = [
324  'type' => true,
325  'value' => true,
326  ];
327 
329  $retFields = [];
330 
331  foreach ( $fields as $name => $field ) {
332  $ret = array_intersect_key( $field, $copy );
333 
334  if ( isset( $field['options'] ) ) {
335  $ret['options'] = array_map( function ( $msg ) use ( $module ) {
336  return $msg->setContext( $module )->plain();
337  }, $field['options'] );
338  ApiResult::setArrayType( $ret['options'], 'assoc' );
339  }
340  $this->formatMessage( $ret, 'label', $field['label'] );
341  $this->formatMessage( $ret, 'help', $field['help'] );
342  $ret['optional'] = !empty( $field['optional'] );
343  $ret['sensitive'] = !empty( $field['sensitive'] );
344 
345  $retFields[$name] = $ret;
346  }
347 
348  ApiResult::setArrayType( $retFields, 'assoc' );
349 
350  return $retFields;
351  }
352 
359  public static function getStandardParams( $action, $param /* ... */ ) {
360  $params = [
361  'requests' => [
362  ApiBase::PARAM_TYPE => 'string',
363  ApiBase::PARAM_ISMULTI => true,
364  ApiBase::PARAM_HELP_MSG => [ 'api-help-authmanagerhelper-requests', $action ],
365  ],
366  'request' => [
367  ApiBase::PARAM_TYPE => 'string',
368  ApiBase::PARAM_REQUIRED => true,
369  ApiBase::PARAM_HELP_MSG => [ 'api-help-authmanagerhelper-request', $action ],
370  ],
371  'messageformat' => [
372  ApiBase::PARAM_DFLT => 'wikitext',
373  ApiBase::PARAM_TYPE => [ 'html', 'wikitext', 'raw', 'none' ],
374  ApiBase::PARAM_HELP_MSG => 'api-help-authmanagerhelper-messageformat',
375  ],
376  'mergerequestfields' => [
377  ApiBase::PARAM_DFLT => false,
378  ApiBase::PARAM_HELP_MSG => 'api-help-authmanagerhelper-mergerequestfields',
379  ],
380  'preservestate' => [
381  ApiBase::PARAM_DFLT => false,
382  ApiBase::PARAM_HELP_MSG => 'api-help-authmanagerhelper-preservestate',
383  ],
384  'returnurl' => [
385  ApiBase::PARAM_TYPE => 'string',
386  ApiBase::PARAM_HELP_MSG => 'api-help-authmanagerhelper-returnurl',
387  ],
388  'continue' => [
389  ApiBase::PARAM_DFLT => false,
390  ApiBase::PARAM_HELP_MSG => 'api-help-authmanagerhelper-continue',
391  ],
392  ];
393 
394  $ret = [];
395  $wantedParams = func_get_args();
396  array_shift( $wantedParams );
397  foreach ( $wantedParams as $name ) {
398  if ( isset( $params[$name] ) ) {
399  $ret[$name] = $params[$name];
400  }
401  }
402  return $ret;
403  }
404 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
getKey()
Returns the message key.
Definition: Message.php:329
This transfers state between the login and account creation flows.
static getStandardParams($action, $param)
Fetch the standard parameters this helper recognizes.
the array() calling protocol came about after MediaWiki 1.4rc1.
static newForModule(ApiBase $module)
Static version of the constructor, for chaining.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1936
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static newFatal($message)
Factory function for fatal errors.
Definition: StatusValue.php:63
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:112
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
const META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:108
This is a value object to hold authentication response data.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1934
formatRequests(array $reqs)
Format an array of AuthenticationRequests for return.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1936
getParams()
Returns the message parameters.
Definition: Message.php:340
static stripOuterParagraph($html)
Strip outer.
Definition: Parser.php:6034
logAuthenticationResult($event, $result)
Logs successful or failed authentication.
ApiBase $module
API module, for context and parameters.
formatMessage(array &$res, $key, Message $message)
Format a message for output.
$res
Definition: database.txt:21
$params
setContext(IContextSource $context)
Set the language and the title from a context object.
Definition: Message.php:679
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:457
static newGood($value=null)
Factory function for good results.
Definition: StatusValue.php:76
getPreservedRequest()
Fetch the preserved CreateFromLoginAuthenticationRequest, if any.
__construct(ApiBase $module)
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
this hook is for auditing only $req
Definition: hooks.txt:1007
formatFields(array $fields)
Clean up a field array for output.
static blacklistAuthenticationRequests(array $reqs, array $blacklist)
Filter out authentication requests by class name.
securitySensitiveOperation($operation)
Call $manager->securitySensitiveOperationStatus()
formatAuthenticationResponse(AuthenticationResponse $res)
Format an AuthenticationResponse for return.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method.MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances.The"Spi"in MediaWiki\Logger\Spi stands for"service provider interface".An SPI is an API intended to be implemented or extended by a third party.This software design pattern is intended to enable framework extension and replaceable components.It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki.The service provider interface allows the backend logging library to be implemented in multiple ways.The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime.This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance.Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
string $messageFormat
Message output format.
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
Definition: ApiResult.php:730
Helper class for AuthManager-using API modules.
This exception will be thrown when dieUsage is called to stop module execution.
Definition: ApiMain.php:1837
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300
loadAuthenticationRequests($action)
Fetch and load the AuthenticationRequests for an action.