MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
38 class ApiLogin extends ApiBase {
40  public function __construct( ApiMain $main, $action ) {
41  parent::__construct( $main, $action, 'lg' );
42  }
44  protected function getDescriptionMessage() {
45  if ( $this->getConfig()->get( 'EnableBotPasswords' ) ) {
46  return 'apihelp-login-description';
47  } else {
48  return 'apihelp-login-description-nobotpasswords';
49  }
50  }
61  public function execute() {
62  // If we're in a mode that breaks the same-origin policy, no tokens can
63  // be obtained
64  if ( $this->lacksSameOriginSecurity() ) {
65  $this->getResult()->addValue( null, 'login', [
66  'result' => 'Aborted',
67  'reason' => 'Cannot log in when the same-origin policy is not applied',
68  ] );
70  return;
71  }
73  try {
74  $this->requirePostedParameters( [ 'password', 'token' ] );
75  } catch ( UsageException $ex ) {
76  // Make this a warning for now, upgrade to an error in 1.29.
77  $this->setWarning( $ex->getMessage() );
78  $this->logFeatureUsage( 'login-params-in-query-string' );
79  }
81  $params = $this->extractRequestParams();
83  $result = [];
85  // Make sure session is persisted
87  $session->persist();
89  // Make sure it's possible to log in
90  if ( !$session->canSetUser() ) {
91  $this->getResult()->addValue( null, 'login', [
92  'result' => 'Aborted',
93  'reason' => 'Cannot log in when using ' .
94  $session->getProvider()->describe( Language::factory( 'en' ) ),
95  ] );
97  return;
98  }
100  $authRes = false;
101  $context = new DerivativeContext( $this->getContext() );
102  $loginType = 'N/A';
104  // Check login token
105  $token = $session->getToken( '', 'login' );
106  if ( $token->wasNew() || !$params['token'] ) {
107  $authRes = 'NeedToken';
108  } elseif ( !$token->match( $params['token'] ) ) {
109  $authRes = 'WrongToken';
110  }
112  // Try bot passwords
113  if (
114  $authRes === false && $this->getConfig()->get( 'EnableBotPasswords' ) &&
115  ( $botLoginData = BotPassword::canonicalizeLoginData( $params['name'], $params['password'] ) )
116  ) {
118  $botLoginData[0], $botLoginData[1], $this->getRequest()
119  );
120  if ( $status->isOK() ) {
121  $session = $status->getValue();
122  $authRes = 'Success';
123  $loginType = 'BotPassword';
124  } elseif ( !$botLoginData[2] ) {
125  $authRes = 'Failed';
126  $message = $status->getMessage();
127  LoggerFactory::getInstance( 'authentication' )->info(
128  'BotPassword login failed: ' . $status->getWikiText( false, false, 'en' )
129  );
130  }
131  }
133  if ( $authRes === false ) {
134  // Simplified AuthManager login, for backwards compatibility
135  $manager = AuthManager::singleton();
136  $reqs = AuthenticationRequest::loadRequestsFromSubmission(
137  $manager->getAuthenticationRequests( AuthManager::ACTION_LOGIN, $this->getUser() ),
138  [
139  'username' => $params['name'],
140  'password' => $params['password'],
141  'domain' => $params['domain'],
142  'rememberMe' => true,
143  ]
144  );
145  $res = AuthManager::singleton()->beginAuthentication( $reqs, 'null:' );
146  switch ( $res->status ) {
147  case AuthenticationResponse::PASS:
148  if ( $this->getConfig()->get( 'EnableBotPasswords' ) ) {
149  $warn = 'Main-account login via action=login is deprecated and may stop working ' .
150  'without warning.';
151  $warn .= ' To continue login with action=login, see [[Special:BotPasswords]].';
152  $warn .= ' To safely continue using main-account login, see action=clientlogin.';
153  } else {
154  $warn = 'Login via action=login is deprecated and may stop working without warning.';
155  $warn .= ' To safely log in, see action=clientlogin.';
156  }
157  $this->setWarning( $warn );
158  $authRes = 'Success';
159  $loginType = 'AuthManager';
160  break;
162  case AuthenticationResponse::FAIL:
163  // Hope it's not a PreAuthenticationProvider that failed...
164  $authRes = 'Failed';
165  $message = $res->message;
167  ->info( __METHOD__ . ': Authentication failed: '
168  . $message->inLanguage( 'en' )->plain() );
169  break;
171  default:
173  ->info( __METHOD__ . ': Authentication failed due to unsupported response type: '
174  . $res->status, $this->getAuthenticationResponseLogData( $res ) );
175  $authRes = 'Aborted';
176  break;
177  }
178  }
180  $result['result'] = $authRes;
181  switch ( $authRes ) {
182  case 'Success':
183  $user = $session->getUser();
187  // Deprecated hook
188  $injected_html = '';
189  Hooks::run( 'UserLoginComplete', [ &$user, &$injected_html, true ] );
191  $result['lguserid'] = intval( $user->getId() );
192  $result['lgusername'] = $user->getName();
193  break;
195  case 'NeedToken':
196  $result['token'] = $token->toString();
197  $this->setWarning( 'Fetching a token via action=login is deprecated. ' .
198  'Use action=query&meta=tokens&type=login instead.' );
199  $this->logFeatureUsage( 'action=login&!lgtoken' );
200  break;
202  case 'WrongToken':
203  break;
205  case 'Failed':
206  $result['reason'] = $message->useDatabase( 'false' )->inLanguage( 'en' )->text();
207  break;
209  case 'Aborted':
210  $result['reason'] = 'Authentication requires user interaction, ' .
211  'which is not supported by action=login.';
212  if ( $this->getConfig()->get( 'EnableBotPasswords' ) ) {
213  $result['reason'] .= ' To be able to login with action=login, see [[Special:BotPasswords]].';
214  $result['reason'] .= ' To continue using main-account login, see action=clientlogin.';
215  } else {
216  $result['reason'] .= ' To log in, see action=clientlogin.';
217  }
218  break;
220  default:
221  ApiBase::dieDebug( __METHOD__, "Unhandled case value: {$authRes}" );
222  }
224  $this->getResult()->addValue( null, 'login', $result );
226  if ( $loginType === 'LoginForm' && isset( LoginForm::$statusCodes[$authRes] ) ) {
227  $authRes = LoginForm::$statusCodes[$authRes];
228  }
229  LoggerFactory::getInstance( 'authevents' )->info( 'Login attempt', [
230  'event' => 'login',
231  'successful' => $authRes === 'Success',
232  'loginType' => $loginType,
233  'status' => $authRes,
234  ] );
235  }
237  public function isDeprecated() {
238  return !$this->getConfig()->get( 'EnableBotPasswords' );
239  }
241  public function mustBePosted() {
242  return true;
243  }
245  public function isReadMode() {
246  return false;
247  }
249  public function getAllowedParams() {
250  return [
251  'name' => null,
252  'password' => [
253  ApiBase::PARAM_TYPE => 'password',
254  ],
255  'domain' => null,
256  'token' => [
257  ApiBase::PARAM_TYPE => 'string',
258  ApiBase::PARAM_REQUIRED => false, // for BC
259  ApiBase::PARAM_SENSITIVE => true,
260  ApiBase::PARAM_HELP_MSG => [ 'api-help-param-token', 'login' ],
261  ],
262  ];
263  }
265  protected function getExamplesMessages() {
266  return [
267  'action=login&lgname=user&lgpassword=password'
268  => 'apihelp-login-example-gettoken',
269  'action=login&lgname=user&lgpassword=password&lgtoken=123ABC'
270  => 'apihelp-login-example-login',
271  ];
272  }
274  public function getHelpUrls() {
275  return '';
276  }
284  $ret = [
285  'status' => $response->status,
286  ];
287  if ( $response->message ) {
288  $ret['message'] = $response->message->inLanguage( 'en' )->plain();
289  };
290  $reqs = [
291  'neededRequests' => $response->neededRequests,
292  'createRequest' => $response->createRequest,
293  'linkRequest' => $response->linkRequest,
294  ];
295  foreach ( $reqs as $k => $v ) {
296  if ( $v ) {
297  $v = is_array( $v ) ? $v : [ $v ];
298  $reqClasses = array_unique( array_map( 'get_class', $v ) );
299  sort( $reqClasses );
300  $ret[$k] = implode( ', ', $reqClasses );
301  }
302  }
303  return $ret;
304  }
305 }
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
Get the result object.
Definition: ApiBase.php:584
getAuthenticationResponseLogData(AuthenticationResponse $response)
Turns an AuthenticationResponse into a hash suitable for passing to Logger.
Definition: ApiLogin.php:283
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
Definition: ApiLogin.php:249
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getInstance($channel)
Get a named logger instance from the currently configured logger factory.
An IContextSource implementation which will inherit context from another source but allow individual ...
(boolean) Is the parameter required?
Definition: ApiBase.php:112
Returns true if the current request breaks the same-origin policy.
Definition: ApiBase.php:512
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:685
This is a value object to hold authentication response data.
this hook is for auditing only $response
Definition: hooks.txt:802
Definition: ApiLogin.php:237
IContextSource $context
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
Get the WebRequest object.
Unit to authenticate log-in attempts to the current wiki.
Definition: ApiLogin.php:38
__construct(ApiMain $main, $action)
Definition: ApiLogin.php:40
Definition: ApiLogin.php:44
Definition: database.txt:21
Get the Config object.
Get the base IContextSource object.
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
Definition: ApiLogin.php:241
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
Set warning section for this module.
Definition: ApiBase.php:1554
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
requirePostedParameters($params, $prefix= 'prefix')
Die if any of the specified parameters were found in the query part of the URL rather than the post b...
Definition: ApiBase.php:793
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
(boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of ...
Definition: ApiBase.php:179
static getGlobalSession()
Get the "global" session.
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
static canonicalizeLoginData($username, $password)
There are two ways to login with a bot password: "username@appId", "password" and "username"...
Definition: ApiLogin.php:265
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
static dieDebug($method, $message)
Internal code errors should be reported with this method.
Definition: ApiBase.php:2295
Write logging information for API features to a debug log, for usage analysis.
Definition: ApiBase.php:2304
static login($username, $password, WebRequest $request)
Try to log the user in.
static factory($code)
Get a cached or new language object for a given language code.
Definition: Language.php:181
Definition: ApiLogin.php:274
static resetTokenCache()
Definition: ApiLogin.php:245
Executes the log-in attempt using the parameters passed.
Definition: ApiLogin.php:61
This exception will be thrown when dieUsage is called to stop module execution.
Definition: ApiMain.php:1860